Interface ResponseOutputItem.Visitor
-
- All Implemented Interfaces:
public interface ResponseOutputItem.Visitor<T extends Object>
An interface that defines how to map each variant of ResponseOutputItem to a value of type T.
-
-
Method Summary
Modifier and Type Method Description abstract T
visitMessage(ResponseOutputMessage message)
An output message from the model. abstract T
visitFileSearchCall(ResponseFileSearchToolCall fileSearchCall)
The results of a file search tool call. abstract T
visitFunctionCall(ResponseFunctionToolCall functionCall)
A tool call to run a function. abstract T
visitWebSearchCall(ResponseFunctionWebSearch webSearchCall)
The results of a web search tool call. abstract T
visitComputerCall(ResponseComputerToolCall computerCall)
A tool call to a computer use tool. abstract T
visitReasoning(ResponseReasoningItem reasoning)
A description of the chain of thought used by a reasoning model while generating a response. abstract T
visitImageGenerationCall(ResponseOutputItem.ImageGenerationCall imageGenerationCall)
An image generation request made by the model. abstract T
visitCodeInterpreterCall(ResponseCodeInterpreterToolCall codeInterpreterCall)
A tool call to run code. abstract T
visitLocalShellCall(ResponseOutputItem.LocalShellCall localShellCall)
A tool call to run a command on the local shell. abstract T
visitMcpCall(ResponseOutputItem.McpCall mcpCall)
An invocation of a tool on an MCP server. abstract T
visitMcpListTools(ResponseOutputItem.McpListTools mcpListTools)
A list of tools available on an MCP server. abstract T
visitMcpApprovalRequest(ResponseOutputItem.McpApprovalRequest mcpApprovalRequest)
A request for human approval of a tool invocation. T
unknown(JsonValue json)
Maps an unknown variant of ResponseOutputItem to a value of type T. -
-
Method Detail
-
visitMessage
abstract T visitMessage(ResponseOutputMessage message)
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.
-
visitFunctionCall
abstract T visitFunctionCall(ResponseFunctionToolCall functionCall)
A tool call to run a function. See the function calling guide for more information.
-
visitWebSearchCall
abstract T visitWebSearchCall(ResponseFunctionWebSearch webSearchCall)
The results of a web search tool call. See the web 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.
-
visitReasoning
abstract T visitReasoning(ResponseReasoningItem reasoning)
A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your
input
to the Responses API for subsequent turns of a conversation if you are manually managing context.
-
visitImageGenerationCall
abstract T visitImageGenerationCall(ResponseOutputItem.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(ResponseOutputItem.LocalShellCall localShellCall)
A tool call to run a command on the local shell.
-
visitMcpCall
abstract T visitMcpCall(ResponseOutputItem.McpCall mcpCall)
An invocation of a tool on an MCP server.
-
visitMcpListTools
abstract T visitMcpListTools(ResponseOutputItem.McpListTools mcpListTools)
A list of tools available on an MCP server.
-
visitMcpApprovalRequest
abstract T visitMcpApprovalRequest(ResponseOutputItem.McpApprovalRequest mcpApprovalRequest)
A request for human approval of a tool invocation.
-
unknown
T unknown(JsonValue json)
Maps an unknown variant of ResponseOutputItem to a value of type T.
An instance of ResponseOutputItem 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.
-
-
-
-