Models
Model Base
Base Params
Parameter | Type | Default | Description |
---|---|---|---|
id | str | - | ID of the model to use. Alias: "model" |
name | Optional[str] | None | Name for this Model. Not sent to the Model API. |
provider | Optional[str] | None | Provider for this Model. Not sent to the Model API. |
metrics | Dict[str, Any] | {} | Metrics collected for this Model. Not sent to the Model API. |
response_format | Optional[Any] | None | Format of the response. |
tools | Optional[List[Union[Tool, Dict]]] | None | A list of tools provided to the Model. |
tool_choice | Optional[Union[str, Dict[str, Any]]] | None | Controls which (if any) function is called by the model. |
run_tools | bool | True | If True, runs the tool before sending back the response content. |
show_tool_calls | Optional[bool] | None | If True, shows function calls in the response. |
tool_call_limit | Optional[int] | None | Maximum number of tool calls allowed. |
functions | Optional[Dict[str, Function]] | None | Functions extracted from the tools. Not sent to the Model API. |
function_call_stack | Optional[List[FunctionCall]] | None | Function call stack. |
system_prompt | Optional[str] | None | System prompt from the model added to the Agent. |
instructions | Optional[List[str]] | None | Instructions from the model added to the Agent. |
session_id | Optional[str] | None | Session ID of the calling Agent or Workflow. |
structured_outputs | Optional[bool] | None | Whether to use the structured outputs with this Model. |
supports_structured_outputs | bool | False | Whether the Model supports structured outputs. |
add_images_to_message_content | bool | False | Whether to add images to the message content. |