Structured Output Tracking for Instructor with Opik

1
import os
2
import getpass
3
4
if "OPENAI_API_KEY" not in os.environ:
5
    os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter your OpenAI API key: ")
6
7
if "ANTHROPIC_API_KEY" not in os.environ:
8
    os.environ["ANTHROPIC_API_KEY"] = getpass.getpass("Enter your Anthropic API key: ")
9
10
if "GOOGLE_API_KEY" not in os.environ:
11
    os.environ["GOOGLE_API_KEY"] = getpass.getpass("Enter your Google API key: ")

1
from opik.integrations.openai import track_openai
2
import instructor
3
from pydantic import BaseModel
4
from openai import OpenAI
5
6
# We will first create the OpenAI client and add the `track_openai`
7
# method to log data to Opik
8
openai_client = track_openai(OpenAI())
9
10
# Patch the OpenAI client for Instructor
11
client = instructor.from_openai(openai_client)
12
13
# Define your desired output structure
14
class UserInfo(BaseModel):
15
    name: str
16
    age: int
17
18
user_info = client.chat.completions.create(
19
    model="gpt-4o-mini",
20
    response_model=UserInfo,
21
    messages=[{"role": "user", "content": "John Doe is 30 years old."}],
22
)
23
24
print(user_info)

1
from opik.integrations.anthropic import track_anthropic
2
import instructor
3
from anthropic import Anthropic
4
5
# Add Opik tracking
6
anthropic_client = track_anthropic(Anthropic())
7
8
# Patch the Anthropic client for Instructor
9
client = instructor.from_anthropic(
10
    anthropic_client, mode=instructor.Mode.ANTHROPIC_JSON
11
)
12
13
user_info = client.chat.completions.create(
14
    model="claude-3-5-sonnet-20241022",
15
    response_model=UserInfo,
16
    messages=[{"role": "user", "content": "John Doe is 30 years old."}],
17
    max_tokens=1000,
18
)
19
20
print(user_info)

1
from opik.integrations.genai import track_genai
2
import instructor
3
from google import genai
4
5
# Add Opik tracking
6
gemini_client = track_genai(genai.Client())
7
8
# Patch the GenAI client for Instructor
9
client = instructor.from_genai(
10
    gemini_client, mode=instructor.Mode.GENAI_STRUCTURED_OUTPUTS
11
)
12
13
user_info = client.chat.completions.create(
14
    model="gemini-2.0-flash-001",
15
    response_model=UserInfo,
16
    messages=[{"role": "user", "content": "John Doe is 30 years old."}],
17
)
18
19
print(user_info)