OpenInference OpenAI Instrumentation
Project description
OpenInference OpenAI Instrumentation
Python auto-instrumentation library for OpenAI's python SDK.
The traces emitted by this instrumentation are fully OpenTelemetry compatible and can be sent to an OpenTelemetry collector for viewing, such as arize-phoenix
Installation
pip install openinference-instrumentation-openai
Quickstart
In this example we will instrument a small program that uses OpenAI and observe the traces via arize-phoenix
.
Install packages.
pip install openinference-instrumentation-openai openai arize-phoenix opentelemetry-sdk opentelemetry-exporter-otlp
Start the phoenix server so that it is ready to collect traces. The Phoenix server runs entirely on your machine and does not send data over the internet.
python -m phoenix.server.main serve
In a python file, setup the OpenAIInstrumentor
and configure the tracer to send traces to Phoenix.
import openai
from openinference.instrumentation.openai import OpenAIInstrumentor
from opentelemetry import trace as trace_api
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk import trace as trace_sdk
from opentelemetry.sdk.trace.export import ConsoleSpanExporter, SimpleSpanProcessor
endpoint = "http://127.0.0.1:6006/v1/traces"
tracer_provider = trace_sdk.TracerProvider()
tracer_provider.add_span_processor(SimpleSpanProcessor(OTLPSpanExporter(endpoint)))
# Optionally, you can also print the spans to the console.
tracer_provider.add_span_processor(SimpleSpanProcessor(ConsoleSpanExporter()))
trace_api.set_tracer_provider(tracer_provider)
OpenAIInstrumentor().instrument()
if __name__ == "__main__":
client = openai.OpenAI()
response = client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "Write a haiku."}],
max_tokens=20,
)
print(response.choices[0].message.content)
Since we are using OpenAI, we must set the OPENAI_API_KEY
environment variable to authenticate with the OpenAI API.
export OPENAI_API_KEY=your-api-key
Now simply run the python file and observe the traces in Phoenix.
python your_file.py
More Info
Fore details about tracing with OpenInference and Phoenix, consult the Phoenix documentation.
For AI/ML observability solutions in production, check out the docs on Arize.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openinference_instrumentation_openai-0.1.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f025ec203d3f8a5bf75b3b87d471ce33cad0650439005a17492366e537e75e5 |
|
MD5 | 301190e2084fe38710cf4315baf0ac2e |
|
BLAKE2b-256 | 72a6c580d616e5c0ca6a76497771e3581df674cab5eeff77f6077ed68a92fd2a |
Hashes for openinference_instrumentation_openai-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e7f81d38b8495cd5b98857896a351d888fd81dbc1b30426104422d90458c27e |
|
MD5 | 738ca1d9c240c2bdda1e728a43b0b148 |
|
BLAKE2b-256 | 03497c4446298ec774090af46bdca469e1ed2fc63b1398c0741ca1ccb2e56536 |