ResponseToolDefinition

@Serializable
data class ResponseToolDefinition(val type: String, val name: String? = null, val description: String? = null, val parameters: Parameters? = null, val strict: Boolean? = null, val searchContextSize: SearchContextSize? = null, val userLocation: UserLocation? = null, val vectorStoreIds: List<String>? = null, val filters: JsonElement? = null, val rankingOptions: ResponseRankingOptions? = null, val maxNumResults: Int? = null, val serverLabel: String? = null, val serverUrl: String? = null, val connectorId: String? = null, val serverDescription: String? = null, val headers: Map<String, String>? = null, val authorization: String? = null, val allowedTools: JsonElement? = null, val requireApproval: JsonElement? = null, val container: JsonElement? = null, val format: JsonElement? = null, val background: String? = null, val quality: String? = null, val size: String? = null, val outputFormat: String? = null, val outputCompression: Int? = null, val partialImages: Int? = null, val moderation: String? = null, val model: String? = null, val allowedCallers: List<String>? = null, val async: Boolean? = null, val deferLoading: Boolean? = null, val outputSchema: JsonElement? = null, val displayHeight: Int? = null, val displayWidth: Int? = null, val environment: JsonElement? = null, val externalWebAccess: Boolean? = null, val tunnelId: String? = null, val action: String? = null, val inputFidelity: String? = null, val inputImageMask: ResponseImageMask? = null, val tools: List<ResponseToolDefinition>? = null, val execution: String? = null, val searchContentTypes: List<String>? = null)

Tool declaration for response requests.

Constructors

Link copied to clipboard
constructor(type: String, name: String? = null, description: String? = null, parameters: Parameters? = null, strict: Boolean? = null, searchContextSize: SearchContextSize? = null, userLocation: UserLocation? = null, vectorStoreIds: List<String>? = null, filters: JsonElement? = null, rankingOptions: ResponseRankingOptions? = null, maxNumResults: Int? = null, serverLabel: String? = null, serverUrl: String? = null, connectorId: String? = null, serverDescription: String? = null, headers: Map<String, String>? = null, authorization: String? = null, allowedTools: JsonElement? = null, requireApproval: JsonElement? = null, container: JsonElement? = null, format: JsonElement? = null, background: String? = null, quality: String? = null, size: String? = null, outputFormat: String? = null, outputCompression: Int? = null, partialImages: Int? = null, moderation: String? = null, model: String? = null, allowedCallers: List<String>? = null, async: Boolean? = null, deferLoading: Boolean? = null, outputSchema: JsonElement? = null, displayHeight: Int? = null, displayWidth: Int? = null, environment: JsonElement? = null, externalWebAccess: Boolean? = null, tunnelId: String? = null, action: String? = null, inputFidelity: String? = null, inputImageMask: ResponseImageMask? = null, tools: List<ResponseToolDefinition>? = null, execution: String? = null, searchContentTypes: List<String>? = null)

Properties

Link copied to clipboard
@SerialName(value = "action")
val action: String? = null

Image generation action.

Link copied to clipboard
@SerialName(value = "allowed_callers")
val allowedCallers: List<String>? = null

Callers allowed to invoke this tool.

Link copied to clipboard
@SerialName(value = "allowed_tools")
val allowedTools: JsonElement? = null

MCP tool names or filter.

Link copied to clipboard
@SerialName(value = "async")
val async: Boolean? = null

Whether tool execution can be asynchronous.

Link copied to clipboard
@SerialName(value = "authorization")
val authorization: String? = null

MCP authorization token.

Link copied to clipboard
@SerialName(value = "background")
val background: String? = null

Image background mode.

Link copied to clipboard
@SerialName(value = "connector_id")
val connectorId: String? = null

MCP connector identifier.

Link copied to clipboard
@SerialName(value = "container")
val container: JsonElement? = null

Code interpreter container ID or configuration.

Link copied to clipboard
@SerialName(value = "defer_loading")
val deferLoading: Boolean? = null

Defer loading until tool search selects the tool.

Link copied to clipboard
@SerialName(value = "description")
val description: String? = null
Link copied to clipboard
@SerialName(value = "display_height")
val displayHeight: Int? = null

Computer display height.

Link copied to clipboard
@SerialName(value = "display_width")
val displayWidth: Int? = null

Computer display width.

Link copied to clipboard
@SerialName(value = "environment")
val environment: JsonElement? = null

Computer environment name or shell environment configuration.

Link copied to clipboard
@SerialName(value = "execution")
val execution: String? = null

Tool search execution location.

Link copied to clipboard
@SerialName(value = "external_web_access")
val externalWebAccess: Boolean? = null

Whether web search can access external sources.

Link copied to clipboard
@SerialName(value = "filters")
val filters: JsonElement? = null

Search filter expression.

Link copied to clipboard
@SerialName(value = "format")
val format: JsonElement? = null

Custom tool input format.

Link copied to clipboard
@SerialName(value = "headers")
val headers: Map<String, String>? = null

MCP server request headers; may contain credentials.

Link copied to clipboard
@SerialName(value = "input_fidelity")
val inputFidelity: String? = null

Image edit fidelity.

Link copied to clipboard
@SerialName(value = "input_image_mask")
val inputImageMask: ResponseImageMask? = null

Mask for image editing.

Link copied to clipboard
@SerialName(value = "max_num_results")
val maxNumResults: Int? = null

Maximum search results.

Link copied to clipboard
@SerialName(value = "model")
val model: String? = null

Image generation model.

Link copied to clipboard
@SerialName(value = "moderation")
val moderation: String? = null

Image moderation level.

Link copied to clipboard
@SerialName(value = "name")
val name: String? = null
Link copied to clipboard
@SerialName(value = "output_compression")
val outputCompression: Int? = null

Generated image compression.

Link copied to clipboard
@SerialName(value = "output_format")
val outputFormat: String? = null

Generated image format.

Link copied to clipboard
@SerialName(value = "output_schema")
val outputSchema: JsonElement? = null

Function output JSON schema.

Link copied to clipboard
@SerialName(value = "parameters")
val parameters: Parameters? = null
Link copied to clipboard
@SerialName(value = "partial_images")
val partialImages: Int? = null

Number of streamed partial images.

Link copied to clipboard
@SerialName(value = "quality")
val quality: String? = null

Image quality.

Link copied to clipboard
@SerialName(value = "ranking_options")
val rankingOptions: ResponseRankingOptions? = null

File search ranking controls.

Link copied to clipboard
@SerialName(value = "require_approval")
val requireApproval: JsonElement? = null

MCP approval policy.

Link copied to clipboard
@SerialName(value = "search_content_types")
val searchContentTypes: List<String>? = null

Web search result content types.

Link copied to clipboard
@SerialName(value = "search_context_size")
val searchContextSize: SearchContextSize? = null
Link copied to clipboard
@SerialName(value = "server_description")
val serverDescription: String? = null

MCP server description.

Link copied to clipboard
@SerialName(value = "server_label")
val serverLabel: String? = null

MCP server label.

Link copied to clipboard
@SerialName(value = "server_url")
val serverUrl: String? = null

Remote MCP server URL.

Link copied to clipboard
@SerialName(value = "size")
val size: String? = null

Image dimensions.

Link copied to clipboard
@SerialName(value = "strict")
val strict: Boolean? = null
Link copied to clipboard
@SerialName(value = "tools")
val tools: List<ResponseToolDefinition>? = null

Functions or custom tools in a namespace.

Link copied to clipboard
@SerialName(value = "tunnel_id")
val tunnelId: String? = null

Secure MCP tunnel identifier.

Link copied to clipboard
@SerialName(value = "type")
val type: String
Link copied to clipboard
@SerialName(value = "user_location")
val userLocation: UserLocation? = null
Link copied to clipboard
@SerialName(value = "vector_store_ids")
val vectorStoreIds: List<String>? = null

Vector stores searched by file search.