Skip to content

Update docs to account for system_prompt in structured_output #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zastrowm merged 1 commit into from
Jul 15, 2025
Merged

Update docs to account for system_prompt in structured_output #158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/user-guide/concepts/model-providers/custom_model_provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,21 +332,26 @@ T = TypeVar('T', bound=BaseModel)

@override
async def structured_output(
self, output_model: Type[T], prompt: Messages, **kwargs: Any
self,
output_model: Type[T],
prompt: Messages,
system_prompt: Optional[str] = None,
**kwargs: Any
) -> Generator[dict[str, Union[T, Any]], None, None]:
"""Get structured output using tool calling.

Args:
output_model: The output model to use for the agent.
prompt: The prompt messages to use for the agent.
system_prompt: The system prompt to use for the agent.
**kwargs: Additional keyword arguments for future extensibility.
"""

# Convert Pydantic model to tool specification
tool_spec = convert_pydantic_to_tool_spec(output_model)

# Use the stream method with tool specification
response = await self.stream(messages=prompt, tool_specs=[tool_spec], **kwargs)
response = await self.stream(messages=prompt, tool_specs=[tool_spec], system_prompt=system_prompt, **kwargs)

# Process streaming response
async for event in process_stream(response, prompt):
Expand Down
Loading