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.21.tar.gz.

File metadata

File hashes

Hashes for openinference_instrumentation_pydantic_ai-0.1.21.tar.gz
Algorithm Hash digest
SHA256 63f8f49193b6e747ad9aba79ad2f07fb767e31cce7a37f0b43ee286c5aebc175
MD5 0eda6ba5a2a77073826604cb03f62190
BLAKE2b-256 be47ab5328be2604624eabc5d6ede58eb76d3929d69727891c882291b9c7b576

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_pydantic_ai-0.1.21.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.21-py3-none-any.whl.

File metadata

File hashes

Hashes for openinference_instrumentation_pydantic_ai-0.1.21-py3-none-any.whl
Algorithm Hash digest
SHA256 28cd91eab019265def38b990d4a538c9b059993be44520355fb88efecf0e240e
MD5 8f1894c59fe9109b2b7acfdb53b8fa79
BLAKE2b-256 c4d9e968fcf642cfad0716b1772f636854dbec9f36da5bfd3a46cb4b09b86d1b

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_pydantic_ai-0.1.21-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.

Release history Release notifications | RSS feed

0.1.22

2 files

This release

0.1.21 This release

2 files

0.1.20

2 files

0.1.19

2 files

0.1.18

2 files

0.1.17

2 files

0.1.16

2 files

0.1.15

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

Supported by

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