Skip to main content

OpenInference PydanticAI

pypi

Python auto-instrumentation library for PydanticAI. These traces are fully OpenTelemetry compatible and can be sent to an OpenTelemetry collector for viewing, such as Arize Phoenix or Arize AX.

Installation

pip install openinference-instrumentation-pydantic-ai

Quickstart

This quickstart shows you how to instrument your PydanticAI agents.

Install required packages.

pip install pydantic-ai arize-phoenix opentelemetry-sdk opentelemetry-exporter-otlp

Start Phoenix in the background as a collector. By default, it listens on http://localhost:6006. You can visit the app via a browser at the same address. (Phoenix does not send data over the internet. It only operates locally on your machine.)

phoenix serve

Here's a simple example that demonstrates how to use PydanticAI with OpenInference instrumentation:

import os
from pydantic import BaseModel
from pydantic_ai import Agent
from pydantic_ai.models.instrumented import InstrumentationSettings
from pydantic_ai.models.openai import OpenAIModel
from pydantic_ai.providers.openai import OpenAIProvider
from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.trace import TracerProvider
from openinference.instrumentation.pydantic_ai import OpenInferenceSpanProcessor
from opentelemetry.sdk.trace.export import SimpleSpanProcessor

# Set your OpenAI API key
os.environ["OPENAI_API_KEY"] = "YOUR_OPENAI_API_KEY"

# Set up the tracer provider
tracer_provider = TracerProvider()
trace.set_tracer_provider(tracer_provider)

# Add the OpenInference span processor
endpoint = "http://127.0.0.1:6006/v1/traces"
exporter = OTLPSpanExporter(endpoint=endpoint)
tracer_provider.add_span_processor(OpenInferenceSpanProcessor())
tracer_provider.add_span_processor(SimpleSpanProcessor(exporter))


# Define your Pydantic model
class LocationModel(BaseModel):
    city: str
    country: str

instrumentation = InstrumentationSettings(version=2)

# Create and configure the agent
model = OpenAIModel("gpt-4", provider=OpenAIProvider())
agent = Agent(model, output_type=LocationModel, instrument=instrumentation)

# Run the agent
result = agent.run_sync("The windy city in the US of A.")
print(result)

This example:

  1. Sets up OpenTelemetry tracing with Phoenix
  2. Defines a simple Pydantic model for location data
  3. Creates a PydanticAI agent with instrumentation enabled
  4. Runs a query and gets structured output

The traces will be visible in the Phoenix UI at http://localhost:6006.

More Info

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

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

File details

Details for the file openinference_instrumentation_pydantic_ai-0.1.18.tar.gz.

File metadata

File hashes

Hashes for openinference_instrumentation_pydantic_ai-0.1.18.tar.gz
Algorithm Hash digest
SHA256 6866eadeba756a2f98beb3af3714062d3e1a5407749ced1a3f86824ea4b6e577
MD5 f5442b37a792928cdd72153749a8df27
BLAKE2b-256 ac6ecb274a30811351970838d5471c08c30ae8f4f3eb4ca766ca1b02bea9757e

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_pydantic_ai-0.1.18.tar.gz:

Publisher: publish.yaml on Arize-ai/openinference

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openinference_instrumentation_pydantic_ai-0.1.18-py3-none-any.whl.

File metadata

File hashes

Hashes for openinference_instrumentation_pydantic_ai-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 0a8b883059c713abb0ae83d6610c45aa8260c49754162a92228d9cbb8002002d
MD5 f410d919f6d2e223cad82eaac1afce02
BLAKE2b-256 b8bac401cd6397282ee3bec8ca86fbbb2aba81b1cd93dbe1c8c38c16ad0f240f

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_pydantic_ai-0.1.18-py3-none-any.whl:

Publisher: publish.yaml on Arize-ai/openinference

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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