Add Agent.output_json_schema() method

[g-eoj]

This PR adds a method to get the json schema for agent output.

It aims to support all output types, including special ones:

• text only
• BinaryImage
• DeferredToolRequests

Simple example:

agent = Agent('test')
agent.output_json_schema()

{'type': 'string'}

Override agent output types:

agent = Agent('test')
agent.output_json_schema(output_type=bool)

{'type': 'bool'}

Closes #3225

[g-eoj]

@DouweM is there a source of truth I can reference for what the schema output should be for tests? I think I will get stuck figuring this out so any guidance will be appreciated.

Edit: I added snapshots of expected output to the tests. Please review them carefully as I'm guessing what they are supposed to be.

[g-eoj]

@DouweM thanks for the reviews so far.

Fixed: The PR has an issue where it always adds str to the output schema if the AutoOutputSchema is selected. However I think this is due to a bug not caused by the PR. I think it is because

pydantic-ai/pydantic_ai_slim/pydantic_ai/_output.py

Line 398 in bcd3d83

text_processor=processor,

will always set allows_text to True. This doesn't seem right but I'll wait for confirmation.

[g-eoj]

@DouweM how should duplicate tool output types be handled? For example:

output_type=[ToolOutput(bool, name='one'), ToolOutput(bool, name='two'), ToolOutput(bool, name='three')]

Can it be:

{'anyOf': [{'type': 'boolean'}, {'type': 'boolean'}, {'type': 'boolean'}]}  

Or should duplicates be removed?

[g-eoj]

@DouweM ready for review. The test failure doesn't appear to be from this PR. I have one question about whether we should remove duplicate output types: #3454 (comment)

[DouweM]

@g-eoj Yeah that's fine to be deduplicated. The code using agent.run(...).output wouldn't be able to tell the different bools apart either (except by inspecting the message history for tool call parts).

I'll do another review later or early next week, I have some some more PRs to get through :)

[DouweM]

Hmm, we really should only have this type in this case, as BinaryImage is essentially a BinaryContent with is_image guaranteed to be true. Fixing this may require tweaking of BinaryImage though.

[g-eoj]

Should try to tweak BinaryImage in this PR? Or make a separate issue?

[DouweM]

@g-eoj I'd like to do it in this PR if it's not too complicated

[g-eoj]

I'll give it a try

[g-eoj]

@DouweM can you look at the approach I'm taking now? I'm not getting any info from _output_schema and instead am using Agent.output_type. Is this safe?

[DouweM]

@g-eoj This is so much cleaner that I'm a little embarrassed I didn't come up with it before.