Get typed output from an agent

from pydantic import BaseModel

from agentor import Agentor


class Report(BaseModel):
    city: str
    readings: list[int]


agent = Agentor(name="Reporter", model="gpt-4o-mini", output_type=Report)

result = agent.run("City: Berlin. Readings: 3, 5, 8. Return them.")

print(type(result.final_output))  # <class '__main__.Report'>
print(result.final_output.city)   # Berlin
print(sum(result.final_output.readings))  # 16

from typing import Optional

from pydantic import BaseModel

from agentor import Agentor


class Reading(BaseModel):
    label: str
    celsius: float


class Forecast(BaseModel):
    city: str
    readings: list[Reading]
    warning: Optional[str] = None


agent = Agentor(
    name="Forecaster",
    model="gpt-4o-mini",
    instructions="Return a forecast for the city the user names.",
    output_type=Forecast,
)

result = agent.run("Berlin: today 18C, tomorrow 21C. No warnings.")

print(result.final_output)
# city='Berlin' readings=[Reading(label='Today', celsius=18.0),
#                         Reading(label='Tomorrow', celsius=21.0)] warning=None
print(result.final_output.readings[0].celsius)  # 18.0

class Bad(BaseModel):
    values: dict[str, int]


Agentor(name="Agent", output_type=Bad)

TypeError: output_type contains a dict/mapping field, which OpenAI strict
structured output cannot express. Model the keys explicitly, or use a list of
key/value objects.

class Scores(BaseModel):
    accuracy: float
    latency: float

class Score(BaseModel):
    name: str
    value: float


class Scores(BaseModel):
    entries: list[Score]

ValueError: Model output did not match Report: 1 validation error for Report
...
Raw output: {"city": "Berlin", "readings": "three, five"}

from pydantic import BaseModel

from agentor import Agentor, function_tool


@function_tool
def get_weather(city: str) -> str:
    """Get the current weather for a city.

    Args:
        city: The city to look up.
    """
    return f"The weather in {city} is sunny and 22C."


class Weather(BaseModel):
    city: str
    celsius: float


agent = Agentor(
    name="Analyst",
    model="gpt-4o-mini",
    tools=[get_weather],
    output_type=Weather,
)

result = agent.run("What is the weather in Berlin?")
print(result.final_output)   # city='Berlin' celsius=22.0
print([call.name for call in result.tool_calls])  # ['get_weather']

async for event in agent.stream_chat("City: Berlin. Readings 1,2,3."):
    print(event)
# {"type": "run_item_stream_event", "message": "{\"city\":\"Berlin\",\"readings\":[1,2,3]}", ...}