Code
cookbook/models/ibm/watsonx/structured_output.py
from typing import List
from agno.agent import Agent, RunResponse
from agno.models.ibm import WatsonX
from pydantic import BaseModel, Field
from rich.pretty import pprint
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="ibm/granite-20b-code-instruct"),
description="You help people write movie scripts.",
response_model=MovieScript,
)
# Get the response in a variable
# movie_agent: RunResponse = movie_agent.run("New York")
# pprint(movie_agent.content)
movie_agent.print_response("New York")
Usage
Create a virtual environment
Open the Terminal
and create a python virtual environment.
python3 -m venv .venv
source .venv/bin/activate
Set your API key
export IBM_WATSONX_API_KEY=xxx
export IBM_WATSONX_PROJECT_ID=xxx
Install libraries
pip install -U ibm-watsonx-ai pydantic rich agno
Run Agent
python cookbook/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 response_model
. The model’s output will be parsed into this structured format.