Class ResponseOutputItem
-
- All Implemented Interfaces:
public final class ResponseOutputItemAn output message from the model.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceResponseOutputItem.VisitorAn interface that defines how to map each variant of ResponseOutputItem to a value of type T.
-
Method Summary
Modifier and Type Method Description final Optional<ResponseOutputMessage>message()An output message from the model. final Optional<ResponseFileSearchToolCall>fileSearchCall()The results of a file search tool call. final Optional<ResponseFunctionToolCall>functionCall()A tool call to run a function. final Optional<ResponseFunctionWebSearch>webSearchCall()The results of a web search tool call. final Optional<ResponseComputerToolCall>computerCall()A tool call to a computer use tool. final Optional<ResponseReasoningItem>reasoning()A description of the chain of thought used by a reasoning model while generating a response. final BooleanisMessage()final BooleanisFileSearchCall()final BooleanisFunctionCall()final BooleanisWebSearchCall()final BooleanisComputerCall()final BooleanisReasoning()final ResponseOutputMessageasMessage()An output message from the model. final ResponseFileSearchToolCallasFileSearchCall()The results of a file search tool call. final ResponseFunctionToolCallasFunctionCall()A tool call to run a function. final ResponseFunctionWebSearchasWebSearchCall()The results of a web search tool call. final ResponseComputerToolCallasComputerCall()A tool call to a computer use tool. final ResponseReasoningItemasReasoning()A description of the chain of thought used by a reasoning model while generating a response. final Optional<JsonValue>_json()final <T extends Any> Taccept(ResponseOutputItem.Visitor<T> visitor)final ResponseOutputItemvalidate()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseOutputItemofMessage(ResponseOutputMessage message)An output message from the model. final static ResponseOutputItemofFileSearchCall(ResponseFileSearchToolCall fileSearchCall)The results of a file search tool call. final static ResponseOutputItemofFunctionCall(ResponseFunctionToolCall functionCall)A tool call to run a function. final static ResponseOutputItemofWebSearchCall(ResponseFunctionWebSearch webSearchCall)The results of a web search tool call. final static ResponseOutputItemofComputerCall(ResponseComputerToolCall computerCall)A tool call to a computer use tool. final static ResponseOutputItemofReasoning(ResponseReasoningItem reasoning)A description of the chain of thought used by a reasoning model while generating a response. -
-
Method Detail
-
message
final Optional<ResponseOutputMessage> message()
An output message from the model.
-
fileSearchCall
final Optional<ResponseFileSearchToolCall> fileSearchCall()
The results of a file search tool call. See the file search guide for more information.
-
functionCall
final Optional<ResponseFunctionToolCall> functionCall()
A tool call to run a function. See the function calling guide for more information.
-
webSearchCall
final Optional<ResponseFunctionWebSearch> webSearchCall()
The results of a web search tool call. See the web search guide for more information.
-
computerCall
final Optional<ResponseComputerToolCall> computerCall()
A tool call to a computer use tool. See the computer use guide for more information.
-
reasoning
final Optional<ResponseReasoningItem> reasoning()
A description of the chain of thought used by a reasoning model while generating a response.
-
isFileSearchCall
final Boolean isFileSearchCall()
-
isFunctionCall
final Boolean isFunctionCall()
-
isWebSearchCall
final Boolean isWebSearchCall()
-
isComputerCall
final Boolean isComputerCall()
-
isReasoning
final Boolean isReasoning()
-
asMessage
final ResponseOutputMessage asMessage()
An output message from the model.
-
asFileSearchCall
final ResponseFileSearchToolCall asFileSearchCall()
The results of a file search tool call. See the file search guide for more information.
-
asFunctionCall
final ResponseFunctionToolCall asFunctionCall()
A tool call to run a function. See the function calling guide for more information.
-
asWebSearchCall
final ResponseFunctionWebSearch asWebSearchCall()
The results of a web search tool call. See the web search guide for more information.
-
asComputerCall
final ResponseComputerToolCall asComputerCall()
A tool call to a computer use tool. See the computer use guide for more information.
-
asReasoning
final ResponseReasoningItem asReasoning()
A description of the chain of thought used by a reasoning model while generating a response.
-
accept
final <T extends Any> T accept(ResponseOutputItem.Visitor<T> visitor)
-
validate
final ResponseOutputItem validate()
-
ofMessage
final static ResponseOutputItem ofMessage(ResponseOutputMessage message)
An output message from the model.
-
ofFileSearchCall
final static ResponseOutputItem ofFileSearchCall(ResponseFileSearchToolCall fileSearchCall)
The results of a file search tool call. See the file search guide for more information.
-
ofFunctionCall
final static ResponseOutputItem ofFunctionCall(ResponseFunctionToolCall functionCall)
A tool call to run a function. See the function calling guide for more information.
-
ofWebSearchCall
final static ResponseOutputItem ofWebSearchCall(ResponseFunctionWebSearch webSearchCall)
The results of a web search tool call. See the web search guide for more information.
-
ofComputerCall
final static ResponseOutputItem ofComputerCall(ResponseComputerToolCall computerCall)
A tool call to a computer use tool. See the computer use guide for more information.
-
ofReasoning
final static ResponseOutputItem ofReasoning(ResponseReasoningItem reasoning)
A description of the chain of thought used by a reasoning model while generating a response.
-
-
-
-