Base Params

ParameterTypeDefaultDescription
idstr-ID of the model to use. Alias: "model"
nameOptional[str]NoneName for this Model. Not sent to the Model API.
providerOptional[str]NoneProvider for this Model. Not sent to the Model API.
metricsDict[str, Any]{}Metrics collected for this Model. Not sent to the Model API.
response_formatOptional[Any]NoneFormat of the response.
toolsOptional[List[Union[Tool, Dict]]]NoneA list of tools provided to the Model.
tool_choiceOptional[Union[str, Dict[str, Any]]]NoneControls which (if any) function is called by the model.
run_toolsboolTrueIf True, runs the tool before sending back the response content.
show_tool_callsOptional[bool]NoneIf True, shows function calls in the response.
tool_call_limitOptional[int]NoneMaximum number of tool calls allowed.
functionsOptional[Dict[str, Function]]NoneFunctions extracted from the tools. Not sent to the Model API.
function_call_stackOptional[List[FunctionCall]]NoneFunction call stack.
system_promptOptional[str]NoneSystem prompt from the model added to the Agent.
instructionsOptional[List[str]]NoneInstructions from the model added to the Agent.
session_idOptional[str]NoneSession ID of the calling Agent or Workflow.
structured_outputsOptional[bool]NoneWhether to use the structured outputs with this Model.
supports_structured_outputsboolFalseWhether the Model supports structured outputs.
add_images_to_message_contentboolFalseWhether to add images to the message content.