Interface ResponseItem.Visitor
-
- All Implemented Interfaces:
public interface ResponseItem.Visitor<T extends Object>
An interface that defines how to map each variant of ResponseItem to a value of type T.
-
-
Method Summary
Modifier and Type Method Description abstract T
visitResponseInputMessageItem(ResponseInputMessageItem responseInputMessageItem)
abstract T
visitResponseOutputMessage(ResponseOutputMessage responseOutputMessage)
An output message from the model. abstract T
visitFileSearchCall(ResponseFileSearchToolCall fileSearchCall)
The results of a file search tool call. abstract T
visitComputerCall(ResponseComputerToolCall computerCall)
A tool call to a computer use tool. abstract T
visitComputerCallOutput(ResponseComputerToolCallOutputItem computerCallOutput)
abstract T
visitWebSearchCall(ResponseFunctionWebSearch webSearchCall)
The results of a web search tool call. abstract T
visitFunctionCall(ResponseFunctionToolCallItem functionCall)
A tool call to run a function. abstract T
visitFunctionCallOutput(ResponseFunctionToolCallOutputItem functionCallOutput)
abstract T
visitImageGenerationCall(ResponseItem.ImageGenerationCall imageGenerationCall)
An image generation request made by the model. abstract T
visitCodeInterpreterCall(ResponseCodeInterpreterToolCall codeInterpreterCall)
A tool call to run code. abstract T
visitLocalShellCall(ResponseItem.LocalShellCall localShellCall)
A tool call to run a command on the local shell. abstract T
visitLocalShellCallOutput(ResponseItem.LocalShellCallOutput localShellCallOutput)
The output of a local shell tool call. abstract T
visitMcpListTools(ResponseItem.McpListTools mcpListTools)
A list of tools available on an MCP server. abstract T
visitMcpApprovalRequest(ResponseItem.McpApprovalRequest mcpApprovalRequest)
A request for human approval of a tool invocation. abstract T
visitMcpApprovalResponse(ResponseItem.McpApprovalResponse mcpApprovalResponse)
A response to an MCP approval request. abstract T
visitMcpCall(ResponseItem.McpCall mcpCall)
An invocation of a tool on an MCP server. T
unknown(JsonValue json)
Maps an unknown variant of ResponseItem to a value of type T. -
-
Method Detail
-
visitResponseInputMessageItem
abstract T visitResponseInputMessageItem(ResponseInputMessageItem responseInputMessageItem)
-
visitResponseOutputMessage
abstract T visitResponseOutputMessage(ResponseOutputMessage responseOutputMessage)
An output message from the model.
-
visitFileSearchCall
abstract T visitFileSearchCall(ResponseFileSearchToolCall fileSearchCall)
The results of a file search tool call. See the file search guide for more information.
-
visitComputerCall
abstract T visitComputerCall(ResponseComputerToolCall computerCall)
A tool call to a computer use tool. See the computer use guide for more information.
-
visitComputerCallOutput
abstract T visitComputerCallOutput(ResponseComputerToolCallOutputItem computerCallOutput)
-
visitWebSearchCall
abstract T visitWebSearchCall(ResponseFunctionWebSearch webSearchCall)
The results of a web search tool call. See the web search guide for more information.
-
visitFunctionCall
abstract T visitFunctionCall(ResponseFunctionToolCallItem functionCall)
A tool call to run a function. See the function calling guide for more information.
-
visitFunctionCallOutput
abstract T visitFunctionCallOutput(ResponseFunctionToolCallOutputItem functionCallOutput)
-
visitImageGenerationCall
abstract T visitImageGenerationCall(ResponseItem.ImageGenerationCall imageGenerationCall)
An image generation request made by the model.
-
visitCodeInterpreterCall
abstract T visitCodeInterpreterCall(ResponseCodeInterpreterToolCall codeInterpreterCall)
A tool call to run code.
-
visitLocalShellCall
abstract T visitLocalShellCall(ResponseItem.LocalShellCall localShellCall)
A tool call to run a command on the local shell.
-
visitLocalShellCallOutput
abstract T visitLocalShellCallOutput(ResponseItem.LocalShellCallOutput localShellCallOutput)
The output of a local shell tool call.
-
visitMcpListTools
abstract T visitMcpListTools(ResponseItem.McpListTools mcpListTools)
A list of tools available on an MCP server.
-
visitMcpApprovalRequest
abstract T visitMcpApprovalRequest(ResponseItem.McpApprovalRequest mcpApprovalRequest)
A request for human approval of a tool invocation.
-
visitMcpApprovalResponse
abstract T visitMcpApprovalResponse(ResponseItem.McpApprovalResponse mcpApprovalResponse)
A response to an MCP approval request.
-
visitMcpCall
abstract T visitMcpCall(ResponseItem.McpCall mcpCall)
An invocation of a tool on an MCP server.
-
unknown
T unknown(JsonValue json)
Maps an unknown variant of ResponseItem to a value of type T.
An instance of ResponseItem can contain an unknown variant if it was deserialized from data that doesn't match any known variant. For example, if the SDK is on an older version than the API, then the API may respond with new variants that the SDK is unaware of.
-
-
-
-