Interface ResponseInputItem.Visitor
-
- All Implemented Interfaces:
public interface ResponseInputItem.Visitor<T extends Object>
An interface that defines how to map each variant of ResponseInputItem to a value of type T.
-
-
Method Summary
Modifier and Type Method Description abstract T
visitEasyInputMessage(EasyInputMessage easyInputMessage)
A message input to the model with a role indicating instruction following hierarchy. abstract T
visitMessage(ResponseInputItem.Message message)
A message input to the model with a role indicating instruction following hierarchy. 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(ResponseInputItem.ComputerCallOutput computerCallOutput)
The output of a computer tool call. abstract T
visitWebSearchCall(ResponseFunctionWebSearch webSearchCall)
The results of a web search tool call. abstract T
visitFunctionCall(ResponseFunctionToolCall functionCall)
A tool call to run a function. abstract T
visitFunctionCallOutput(ResponseInputItem.FunctionCallOutput functionCallOutput)
The output of a function tool call. abstract T
visitReasoning(ResponseReasoningItem reasoning)
A description of the chain of thought used by a reasoning model while generating a response. abstract T
visitImageGenerationCall(ResponseInputItem.ImageGenerationCall imageGenerationCall)
An image generation request made by the model. abstract T
visitCodeInterpreterCall(ResponseCodeInterpreterToolCall codeInterpreterCall)
A tool call to run code. abstract T
visitLocalShellCall(ResponseInputItem.LocalShellCall localShellCall)
A tool call to run a command on the local shell. abstract T
visitLocalShellCallOutput(ResponseInputItem.LocalShellCallOutput localShellCallOutput)
The output of a local shell tool call. abstract T
visitMcpListTools(ResponseInputItem.McpListTools mcpListTools)
A list of tools available on an MCP server. abstract T
visitMcpApprovalRequest(ResponseInputItem.McpApprovalRequest mcpApprovalRequest)
A request for human approval of a tool invocation. abstract T
visitMcpApprovalResponse(ResponseInputItem.McpApprovalResponse mcpApprovalResponse)
A response to an MCP approval request. abstract T
visitMcpCall(ResponseInputItem.McpCall mcpCall)
An invocation of a tool on an MCP server. abstract T
visitItemReference(ResponseInputItem.ItemReference itemReference)
An internal identifier for an item to reference. T
unknown(JsonValue json)
Maps an unknown variant of ResponseInputItem to a value of type T. -
-
Method Detail
-
visitEasyInputMessage
abstract T visitEasyInputMessage(EasyInputMessage easyInputMessage)
A message input to the model with a role indicating instruction following hierarchy. Instructions given with the
developer
orsystem
role take precedence over instructions given with theuser
role. Messages with theassistant
role are presumed to have been generated by the model in previous interactions.
-
visitMessage
abstract T visitMessage(ResponseInputItem.Message message)
A message input to the model with a role indicating instruction following hierarchy. Instructions given with the
developer
orsystem
role take precedence over instructions given with theuser
role.
-
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(ResponseInputItem.ComputerCallOutput computerCallOutput)
The output of a computer tool call.
-
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(ResponseFunctionToolCall functionCall)
A tool call to run a function. See the function calling guide for more information.
-
visitFunctionCallOutput
abstract T visitFunctionCallOutput(ResponseInputItem.FunctionCallOutput functionCallOutput)
The output of a function tool call.
-
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(ResponseInputItem.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(ResponseInputItem.LocalShellCall localShellCall)
A tool call to run a command on the local shell.
-
visitLocalShellCallOutput
abstract T visitLocalShellCallOutput(ResponseInputItem.LocalShellCallOutput localShellCallOutput)
The output of a local shell tool call.
-
visitMcpListTools
abstract T visitMcpListTools(ResponseInputItem.McpListTools mcpListTools)
A list of tools available on an MCP server.
-
visitMcpApprovalRequest
abstract T visitMcpApprovalRequest(ResponseInputItem.McpApprovalRequest mcpApprovalRequest)
A request for human approval of a tool invocation.
-
visitMcpApprovalResponse
abstract T visitMcpApprovalResponse(ResponseInputItem.McpApprovalResponse mcpApprovalResponse)
A response to an MCP approval request.
-
visitMcpCall
abstract T visitMcpCall(ResponseInputItem.McpCall mcpCall)
An invocation of a tool on an MCP server.
-
visitItemReference
abstract T visitItemReference(ResponseInputItem.ItemReference itemReference)
An internal identifier for an item to reference.
-
unknown
T unknown(JsonValue json)
Maps an unknown variant of ResponseInputItem to a value of type T.
An instance of ResponseInputItem 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.
-
-
-
-