Skip to main content

Python client library for the OpenPipe service

Project description

OpenPipe Python Client

This client allows you automatically report your OpenAI calls to OpenPipe. OpenPipe

Installation

pip install openpipe

Usage

  1. Create a project at https://app.openpipe.ai
  2. Find your project's API key at https://app.openpipe.ai/project/settings
  3. Configure the OpenPipe client as shown below.
from openpipe import openai, configure_openpipe
import os

# Set the OpenPipe API key you got in step (2) above.
# If you have the `OPENPIPE_API_KEY` environment variable set we'll read from it by default.
configure_openpipe(api_key=os.getenv("OPENPIPE_API_KEY"))

# Configure OpenAI the same way you would normally
openai.api_key = os.getenv("OPENAI_API_KEY")

You can now use your new OpenAI client, which functions identically to the generic OpenAI client while also reporting calls to your OpenPipe instance.

Special Features

Tagging

OpenPipe has a concept of "tagging." This is very useful for grouping a certain set of completions together. When you're using a dataset for fine-tuning, you can select all the prompts that match a certain set of tags. Here's how you can use the tagging feature:

completion = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[{"role": "system", "content": "count to 10"}],
    openpipe={"tags": {"prompt_id": "counting"}},
)

Project details


Release history Release notifications | RSS feed

This version

3.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openpipe-3.1.0.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openpipe-3.1.0-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file openpipe-3.1.0.tar.gz.

File metadata

  • Download URL: openpipe-3.1.0.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.11 Darwin/22.5.0

File hashes

Hashes for openpipe-3.1.0.tar.gz
Algorithm Hash digest
SHA256 73413a6c0ac7e457bea1d848dced9a0ccbea72dff68b97378cdd971b20353a53
MD5 a70db02f7641266fe9cf7e7e98a38d5e
BLAKE2b-256 13979504c644cb7031fca3fff1b6a8af668364ce0ab213fb1cd74ab99e85b1f3

See more details on using hashes here.

File details

Details for the file openpipe-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: openpipe-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.11 Darwin/22.5.0

File hashes

Hashes for openpipe-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e07823843d51835cc618e02a55b727038976f0f050460b845a608b8a7f04d3e0
MD5 51a3779383d8452864ac79bd6e990317
BLAKE2b-256 2430ce53b6c7988e1e10a057195947037689842c25a0cd8401884aab7b956f4d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page