Agent with Structured Output

Code

cookbook/11_models/ibm/watsonx/structured_output.py

from typing import List

from agno.agent import Agent, RunOutput  # noqa
from agno.models.ibm import WatsonX
from pydantic import BaseModel, Field
from rich.pretty import pprint  # noqa

class MovieScript(BaseModel):
    setting: str = Field(
        ..., description="Provide a nice setting for a blockbuster movie."
    )
    ending: str = Field(
        ...,
        description="Ending of the movie. If not available, provide a happy ending.",
    )
    genre: str = Field(
        ...,
        description="Genre of the movie. If not available, select action, thriller or romantic comedy.",
    )
    name: str = Field(..., description="Give a name to this movie")
    characters: List[str] = Field(..., description="Name of characters for this movie.")
    storyline: str = Field(
        ..., description="3 sentence storyline for the movie. Make it exciting!"
    )

movie_agent = Agent(
    model=WatsonX(id="mistralai/mistral-small-3-1-24b-instruct-2503"),
    description="You help people write movie scripts.",
    output_schema=MovieScript,
)

# Get the response in a variable
# movie_agent: RunOutput = movie_agent.run("New York")
# pprint(movie_agent.content)

movie_agent.print_response("New York")

Usage

1. Set up your virtual environment

   Mac

   uv venv --python 3.12
   source .venv/bin/activate
   

   uv venv --python 3.12
   .venv\Scripts\activate
   
2. Set your API key

   export IBM_WATSONX_API_KEY=xxx
   export IBM_WATSONX_PROJECT_ID=xxx
   
3. Install dependencies

   uv pip install -U ibm-watsonx-ai pydantic rich agno
   
4. Run Agent

   python cookbook/11_models/ibm/watsonx/structured_output.py
   

This example shows how to use structured output with IBM WatsonX. It defines a Pydantic model MovieScript with various fields and their descriptions, then creates an agent using this model as the output_schema. The model’s output will be parsed into this structured format.