FunctionToolParam interface
model interface FunctionToolParam
Properties
| allowed_callers | The callers that may invoke this function tool, either directly or programmatically. |
| async | Whether the tool response can be returned asynchronously versus immediately returned on next response creation. |
| defer_loading | Whether this function should be deferred and discovered via tool search. |
| description | A description of the function that helps the model decide when and how to call it. |
| name | The name used to identify the function in tool calls. |
| output_schema | The JSON Schema describing the function output. |
| parameters | The JSON Schema describing the arguments accepted by the function. |
| strict | Whether function arguments must strictly match the parameters schema. |
| type | The type of the function tool. Always |
Property Details
allowed_callers
The callers that may invoke this function tool, either directly or programmatically.
allowed_callers?: CallableToolAllowedCaller[]Property Value
async
Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
async?: booleanProperty Value
boolean
defer_loading
Whether this function should be deferred and discovered via tool search.
defer_loading?: booleanProperty Value
boolean
description
A description of the function that helps the model decide when and how to call it.
description?: stringProperty Value
string
name
The name used to identify the function in tool calls.
name: stringProperty Value
string
output_schema
The JSON Schema describing the function output.
output_schema?: Record<string, any>Property Value
Record<string, any>
parameters
The JSON Schema describing the arguments accepted by the function.
parameters?: EmptyModelParamProperty Value
strict
Whether function arguments must strictly match the parameters schema.
strict?: booleanProperty Value
boolean
type
The type of the function tool. Always function.
type: "function"Property Value
"function"