All Implemented Interfaces:


public final class ResponseItem

Content item used to generate a response.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`ResponseItem.Visitor`	An interface that defines how to map each variant of ResponseItem to a value of type T.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<ResponseInputMessageItem>`	`responseInputMessageItem()`
`final Optional<ResponseOutputMessage>`	`responseOutputMessage()`	An output message from the model.
`final Optional<ResponseFileSearchToolCall>`	`fileSearchCall()`	The results of a file search tool call.
`final Optional<ResponseComputerToolCall>`	`computerCall()`	A tool call to a computer use tool.
`final Optional<ResponseComputerToolCallOutputItem>`	`computerCallOutput()`
`final Optional<ResponseFunctionWebSearch>`	`webSearchCall()`	The results of a web search tool call.
`final Optional<ResponseFunctionToolCallItem>`	`functionCall()`	A tool call to run a function.
`final Optional<ResponseFunctionToolCallOutputItem>`	`functionCallOutput()`
`final Boolean`	`isResponseInputMessageItem()`
`final Boolean`	`isResponseOutputMessage()`
`final Boolean`	`isFileSearchCall()`
`final Boolean`	`isComputerCall()`
`final Boolean`	`isComputerCallOutput()`
`final Boolean`	`isWebSearchCall()`
`final Boolean`	`isFunctionCall()`
`final Boolean`	`isFunctionCallOutput()`
`final ResponseInputMessageItem`	`asResponseInputMessageItem()`
`final ResponseOutputMessage`	`asResponseOutputMessage()`	An output message from the model.
`final ResponseFileSearchToolCall`	`asFileSearchCall()`	The results of a file search tool call.
`final ResponseComputerToolCall`	`asComputerCall()`	A tool call to a computer use tool.
`final ResponseComputerToolCallOutputItem`	`asComputerCallOutput()`
`final ResponseFunctionWebSearch`	`asWebSearchCall()`	The results of a web search tool call.
`final ResponseFunctionToolCallItem`	`asFunctionCall()`	A tool call to run a function.
`final ResponseFunctionToolCallOutputItem`	`asFunctionCallOutput()`
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(ResponseItem.Visitor<T> visitor)`
`final ResponseItem`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ResponseItem`	`ofResponseInputMessageItem(ResponseInputMessageItem responseInputMessageItem)`
`final static ResponseItem`	`ofResponseOutputMessage(ResponseOutputMessage responseOutputMessage)`	An output message from the model.
`final static ResponseItem`	`ofFileSearchCall(ResponseFileSearchToolCall fileSearchCall)`	The results of a file search tool call.
`final static ResponseItem`	`ofComputerCall(ResponseComputerToolCall computerCall)`	A tool call to a computer use tool.
`final static ResponseItem`	`ofComputerCallOutput(ResponseComputerToolCallOutputItem computerCallOutput)`
`final static ResponseItem`	`ofWebSearchCall(ResponseFunctionWebSearch webSearchCall)`	The results of a web search tool call.
`final static ResponseItem`	`ofFunctionCall(ResponseFunctionToolCallItem functionCall)`	A tool call to run a function.
`final static ResponseItem`	`ofFunctionCallOutput(ResponseFunctionToolCallOutputItem functionCallOutput)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Method Detail

responseInputMessageItem

 final Optional<ResponseInputMessageItem> responseInputMessageItem()

responseOutputMessage

 final Optional<ResponseOutputMessage> responseOutputMessage()

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.

computerCall
```
 final Optional<ResponseComputerToolCall> computerCall()
```
A tool call to a computer use tool. See the computer use guide for more information.

computerCallOutput

 final Optional<ResponseComputerToolCallOutputItem> computerCallOutput()

webSearchCall
```
 final Optional<ResponseFunctionWebSearch> webSearchCall()
```
The results of a web search tool call. See the web search guide for more information.

functionCall
```
 final Optional<ResponseFunctionToolCallItem> functionCall()
```
A tool call to run a function. See the function calling guide for more information.

functionCallOutput

 final Optional<ResponseFunctionToolCallOutputItem> functionCallOutput()

isResponseInputMessageItem

 final Boolean isResponseInputMessageItem()

isResponseOutputMessage

 final Boolean isResponseOutputMessage()

isFileSearchCall
```
 final Boolean isFileSearchCall()
```

isComputerCall
```
 final Boolean isComputerCall()
```

isComputerCallOutput
```
 final Boolean isComputerCallOutput()
```

isWebSearchCall
```
 final Boolean isWebSearchCall()
```

isFunctionCall
```
 final Boolean isFunctionCall()
```

isFunctionCallOutput
```
 final Boolean isFunctionCallOutput()
```

asResponseInputMessageItem

 final ResponseInputMessageItem asResponseInputMessageItem()

asResponseOutputMessage

 final ResponseOutputMessage asResponseOutputMessage()

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.

asComputerCall
```
 final ResponseComputerToolCall asComputerCall()
```
A tool call to a computer use tool. See the computer use guide for more information.

asComputerCallOutput

 final ResponseComputerToolCallOutputItem asComputerCallOutput()

asWebSearchCall
```
 final ResponseFunctionWebSearch asWebSearchCall()
```
The results of a web search tool call. See the web search guide for more information.

asFunctionCall
```
 final ResponseFunctionToolCallItem asFunctionCall()
```
A tool call to run a function. See the function calling guide for more information.

asFunctionCallOutput

 final ResponseFunctionToolCallOutputItem asFunctionCallOutput()

_json
```
 final Optional<JsonValue> _json()
```

accept

 final <T extends Any> T accept(ResponseItem.Visitor<T> visitor)

validate
```
 final ResponseItem validate()
```

isValid
```
 final Boolean isValid()
```

equals
```
 Boolean equals(Object other)
```

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

ofResponseInputMessageItem

 final static ResponseItem ofResponseInputMessageItem(ResponseInputMessageItem responseInputMessageItem)

ofResponseOutputMessage

 final static ResponseItem ofResponseOutputMessage(ResponseOutputMessage responseOutputMessage)

An output message from the model.

ofFileSearchCall
```
 final static ResponseItem ofFileSearchCall(ResponseFileSearchToolCall fileSearchCall)
```
The results of a file search tool call. See the file search guide for more information.

ofComputerCall
```
 final static ResponseItem ofComputerCall(ResponseComputerToolCall computerCall)
```
A tool call to a computer use tool. See the computer use guide for more information.

ofComputerCallOutput

 final static ResponseItem ofComputerCallOutput(ResponseComputerToolCallOutputItem computerCallOutput)

ofWebSearchCall
```
 final static ResponseItem ofWebSearchCall(ResponseFunctionWebSearch webSearchCall)
```
The results of a web search tool call. See the web search guide for more information.

ofFunctionCall
```
 final static ResponseItem ofFunctionCall(ResponseFunctionToolCallItem functionCall)
```
A tool call to run a function. See the function calling guide for more information.

ofFunctionCallOutput

 final static ResponseItem ofFunctionCallOutput(ResponseFunctionToolCallOutputItem functionCallOutput)

Class ResponseItem

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

responseInputMessageItem

responseOutputMessage

fileSearchCall

computerCall

computerCallOutput

webSearchCall

functionCall

functionCallOutput

isResponseInputMessageItem

isResponseOutputMessage

isFileSearchCall

isComputerCall

isComputerCallOutput

isWebSearchCall

isFunctionCall

isFunctionCallOutput

asResponseInputMessageItem

asResponseOutputMessage

asFileSearchCall

asComputerCall

asComputerCallOutput

asWebSearchCall

asFunctionCall

asFunctionCallOutput

_json

accept

validate

isValid

equals

hashCode

toString

ofResponseInputMessageItem

ofResponseOutputMessage

ofFileSearchCall

ofComputerCall

ofComputerCallOutput

ofWebSearchCall

ofFunctionCall

ofFunctionCallOutput