All Implemented Interfaces:
```
public final class StructuredResponseOutputItem<T extends Object>

                    
```
A wrapper for ResponseOutputItem that provides type-safe access to the message when using the Structured Outputs feature to deserialize a JSON response to an instance of an arbitrary class. See the SDK documentation for more details on Structured Outputs.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`StructuredResponseOutputItem.Visitor`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Class<T>`	`responseType`
`private final ResponseOutputItem`	`rawOutputItem`

Constructor Summary

Constructors
Constructor	Description
`StructuredResponseOutputItem(Class<T> responseType, ResponseOutputItem rawOutputItem)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Class<T>`	`responseType()`
`final ResponseOutputItem`	`rawOutputItem()`
`final Optional<StructuredResponseOutputMessage<T>>`	`message()`
`final Optional<ResponseFileSearchToolCall>`	`fileSearchCall()`
`final Optional<ResponseFunctionToolCall>`	`functionCall()`
`final Optional<ResponseFunctionToolCallOutputItem>`	`functionCallOutput()`
`final Optional<ResponseToolSearchCall>`	`toolSearchCall()`
`final Optional<ResponseToolSearchOutputItem>`	`toolSearchOutput()`
`final Optional<ResponseOutputItem.AdditionalTools>`	`additionalTools()`
`final Optional<ResponseFunctionWebSearch>`	`webSearchCall()`
`final Optional<ResponseComputerToolCall>`	`computerCall()`
`final Optional<ResponseComputerToolCallOutputItem>`	`computerCallOutput()`
`final Optional<ResponseReasoningItem>`	`reasoning()`
`final Optional<ResponseCompactionItem>`	`compaction()`
`final Optional<ResponseCodeInterpreterToolCall>`	`codeInterpreterCall()`
`final Optional<ResponseOutputItem.ImageGenerationCall>`	`imageGenerationCall()`
`final Optional<ResponseOutputItem.LocalShellCall>`	`localShellCall()`
`final Optional<ResponseOutputItem.LocalShellCallOutput>`	`localShellCallOutput()`
`final Optional<ResponseFunctionShellToolCall>`	`shellCall()`
`final Optional<ResponseFunctionShellToolCallOutput>`	`shellCallOutput()`
`final Optional<ResponseApplyPatchToolCall>`	`applyPatchCall()`
`final Optional<ResponseApplyPatchToolCallOutput>`	`applyPatchCallOutput()`
`final Optional<ResponseOutputItem.McpApprovalRequest>`	`mcpApprovalRequest()`
`final Optional<ResponseOutputItem.McpApprovalResponse>`	`mcpApprovalResponse()`
`final Optional<ResponseOutputItem.McpCall>`	`mcpCall()`
`final Optional<ResponseOutputItem.McpListTools>`	`mcpListTools()`
`final Optional<ResponseCustomToolCall>`	`customToolCall()`
`final Optional<ResponseCustomToolCallOutputItem>`	`customToolCallOutput()`
`final Boolean`	`isMessage()`
`final Boolean`	`isFileSearchCall()`
`final Boolean`	`isFunctionCall()`
`final Boolean`	`isFunctionCallOutput()`
`final Boolean`	`isToolSearchCall()`
`final Boolean`	`isToolSearchOutput()`
`final Boolean`	`isAdditionalTools()`
`final Boolean`	`isWebSearchCall()`
`final Boolean`	`isComputerCall()`
`final Boolean`	`isComputerCallOutput()`
`final Boolean`	`isReasoning()`
`final Boolean`	`isCompaction()`
`final Boolean`	`isCodeInterpreterCall()`
`final Boolean`	`isImageGenerationCall()`
`final Boolean`	`isLocalShellCall()`
`final Boolean`	`isLocalShellCallOutput()`
`final Boolean`	`isShellCall()`
`final Boolean`	`isShellCallOutput()`
`final Boolean`	`isApplyPatchCall()`
`final Boolean`	`isApplyPatchCallOutput()`
`final Boolean`	`isMcpApprovalRequest()`
`final Boolean`	`isMcpApprovalResponse()`
`final Boolean`	`isMcpCall()`
`final Boolean`	`isMcpListTools()`
`final Boolean`	`isCustomToolCall()`
`final Boolean`	`isCustomToolCallOutput()`
`final StructuredResponseOutputMessage<T>`	`asMessage()`
`final ResponseFileSearchToolCall`	`asFileSearchCall()`
`final ResponseFunctionToolCall`	`asFunctionCall()`
`final ResponseFunctionToolCallOutputItem`	`asFunctionCallOutput()`
`final ResponseToolSearchCall`	`asToolSearchCall()`
`final ResponseToolSearchOutputItem`	`asToolSearchOutput()`
`final ResponseOutputItem.AdditionalTools`	`asAdditionalTools()`
`final ResponseFunctionWebSearch`	`asWebSearchCall()`
`final ResponseComputerToolCall`	`asComputerCall()`
`final ResponseComputerToolCallOutputItem`	`asComputerCallOutput()`
`final ResponseReasoningItem`	`asReasoning()`
`final ResponseCompactionItem`	`asCompaction()`
`final ResponseCodeInterpreterToolCall`	`asCodeInterpreterCall()`
`final ResponseOutputItem.ImageGenerationCall`	`asImageGenerationCall()`
`final ResponseOutputItem.LocalShellCall`	`asLocalShellCall()`
`final ResponseOutputItem.LocalShellCallOutput`	`asLocalShellCallOutput()`
`final ResponseFunctionShellToolCall`	`asShellCall()`
`final ResponseFunctionShellToolCallOutput`	`asShellCallOutput()`
`final ResponseApplyPatchToolCall`	`asApplyPatchCall()`
`final ResponseApplyPatchToolCallOutput`	`asApplyPatchCallOutput()`
`final ResponseOutputItem.McpApprovalRequest`	`asMcpApprovalRequest()`
`final ResponseOutputItem.McpApprovalResponse`	`asMcpApprovalResponse()`
`final ResponseOutputItem.McpCall`	`asMcpCall()`
`final ResponseOutputItem.McpListTools`	`asMcpListTools()`
`final ResponseCustomToolCall`	`asCustomToolCall()`
`final ResponseCustomToolCallOutputItem`	`asCustomToolCallOutput()`
`final Optional<JsonValue>`	`_json()`
`final <R extends Any> R`	`accept(StructuredResponseOutputItem.Visitor<T, R> visitor)`
`final StructuredResponseOutputItem<T>`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`

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

Constructor Detail

StructuredResponseOutputItem

StructuredResponseOutputItem(Class<T> responseType, ResponseOutputItem rawOutputItem)

Method Detail

responseType
```
 final Class<T> responseType()
```

rawOutputItem

 final ResponseOutputItem rawOutputItem()

message

 final Optional<StructuredResponseOutputMessage<T>> message()

fileSearchCall

 final Optional<ResponseFileSearchToolCall> fileSearchCall()

functionCall

 final Optional<ResponseFunctionToolCall> functionCall()

functionCallOutput

 final Optional<ResponseFunctionToolCallOutputItem> functionCallOutput()

toolSearchCall

 final Optional<ResponseToolSearchCall> toolSearchCall()

toolSearchOutput

 final Optional<ResponseToolSearchOutputItem> toolSearchOutput()

additionalTools

 final Optional<ResponseOutputItem.AdditionalTools> additionalTools()

webSearchCall

 final Optional<ResponseFunctionWebSearch> webSearchCall()

computerCall

 final Optional<ResponseComputerToolCall> computerCall()

computerCallOutput

 final Optional<ResponseComputerToolCallOutputItem> computerCallOutput()

reasoning

 final Optional<ResponseReasoningItem> reasoning()

compaction

 final Optional<ResponseCompactionItem> compaction()

codeInterpreterCall

 final Optional<ResponseCodeInterpreterToolCall> codeInterpreterCall()

imageGenerationCall

 final Optional<ResponseOutputItem.ImageGenerationCall> imageGenerationCall()

localShellCall

 final Optional<ResponseOutputItem.LocalShellCall> localShellCall()

localShellCallOutput

 final Optional<ResponseOutputItem.LocalShellCallOutput> localShellCallOutput()

shellCall

 final Optional<ResponseFunctionShellToolCall> shellCall()

shellCallOutput

 final Optional<ResponseFunctionShellToolCallOutput> shellCallOutput()

applyPatchCall

 final Optional<ResponseApplyPatchToolCall> applyPatchCall()

applyPatchCallOutput

 final Optional<ResponseApplyPatchToolCallOutput> applyPatchCallOutput()

mcpApprovalRequest

 final Optional<ResponseOutputItem.McpApprovalRequest> mcpApprovalRequest()

mcpApprovalResponse

 final Optional<ResponseOutputItem.McpApprovalResponse> mcpApprovalResponse()

mcpCall

 final Optional<ResponseOutputItem.McpCall> mcpCall()

mcpListTools

 final Optional<ResponseOutputItem.McpListTools> mcpListTools()

customToolCall

 final Optional<ResponseCustomToolCall> customToolCall()

customToolCallOutput

 final Optional<ResponseCustomToolCallOutputItem> customToolCallOutput()

isMessage
```
 final Boolean isMessage()
```

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

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

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

isToolSearchCall
```
 final Boolean isToolSearchCall()
```

isToolSearchOutput
```
 final Boolean isToolSearchOutput()
```

isAdditionalTools
```
 final Boolean isAdditionalTools()
```

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

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

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

isReasoning
```
 final Boolean isReasoning()
```

isCompaction
```
 final Boolean isCompaction()
```

isCodeInterpreterCall
```
 final Boolean isCodeInterpreterCall()
```

isImageGenerationCall
```
 final Boolean isImageGenerationCall()
```

isLocalShellCall
```
 final Boolean isLocalShellCall()
```

isLocalShellCallOutput
```
 final Boolean isLocalShellCallOutput()
```

isShellCall
```
 final Boolean isShellCall()
```

isShellCallOutput
```
 final Boolean isShellCallOutput()
```

isApplyPatchCall
```
 final Boolean isApplyPatchCall()
```

isApplyPatchCallOutput
```
 final Boolean isApplyPatchCallOutput()
```

isMcpApprovalRequest
```
 final Boolean isMcpApprovalRequest()
```

isMcpApprovalResponse
```
 final Boolean isMcpApprovalResponse()
```

isMcpCall
```
 final Boolean isMcpCall()
```

isMcpListTools
```
 final Boolean isMcpListTools()
```

isCustomToolCall
```
 final Boolean isCustomToolCall()
```

isCustomToolCallOutput
```
 final Boolean isCustomToolCallOutput()
```

asMessage

 final StructuredResponseOutputMessage<T> asMessage()

asFileSearchCall

 final ResponseFileSearchToolCall asFileSearchCall()

asFunctionCall

 final ResponseFunctionToolCall asFunctionCall()

asFunctionCallOutput

 final ResponseFunctionToolCallOutputItem asFunctionCallOutput()

asToolSearchCall

 final ResponseToolSearchCall asToolSearchCall()

asToolSearchOutput

 final ResponseToolSearchOutputItem asToolSearchOutput()

asAdditionalTools

 final ResponseOutputItem.AdditionalTools asAdditionalTools()

asWebSearchCall

 final ResponseFunctionWebSearch asWebSearchCall()

asComputerCall

 final ResponseComputerToolCall asComputerCall()

asComputerCallOutput

 final ResponseComputerToolCallOutputItem asComputerCallOutput()

asReasoning

 final ResponseReasoningItem asReasoning()

asCompaction

 final ResponseCompactionItem asCompaction()

asCodeInterpreterCall

 final ResponseCodeInterpreterToolCall asCodeInterpreterCall()

asImageGenerationCall

 final ResponseOutputItem.ImageGenerationCall asImageGenerationCall()

asLocalShellCall

 final ResponseOutputItem.LocalShellCall asLocalShellCall()

asLocalShellCallOutput

 final ResponseOutputItem.LocalShellCallOutput asLocalShellCallOutput()

asShellCall

 final ResponseFunctionShellToolCall asShellCall()

asShellCallOutput

 final ResponseFunctionShellToolCallOutput asShellCallOutput()

asApplyPatchCall

 final ResponseApplyPatchToolCall asApplyPatchCall()

asApplyPatchCallOutput

 final ResponseApplyPatchToolCallOutput asApplyPatchCallOutput()

asMcpApprovalRequest

 final ResponseOutputItem.McpApprovalRequest asMcpApprovalRequest()

asMcpApprovalResponse

 final ResponseOutputItem.McpApprovalResponse asMcpApprovalResponse()

asMcpCall

 final ResponseOutputItem.McpCall asMcpCall()

asMcpListTools

 final ResponseOutputItem.McpListTools asMcpListTools()

asCustomToolCall

 final ResponseCustomToolCall asCustomToolCall()

asCustomToolCallOutput

 final ResponseCustomToolCallOutputItem asCustomToolCallOutput()

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

accept

 final <R extends Any> R accept(StructuredResponseOutputItem.Visitor<T, R> visitor)

validate

 final StructuredResponseOutputItem<T> validate()

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

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

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

Class StructuredResponseOutputItem

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StructuredResponseOutputItem

Method Detail

responseType

rawOutputItem

message

fileSearchCall

functionCall

functionCallOutput

toolSearchCall

toolSearchOutput

additionalTools

webSearchCall

computerCall

computerCallOutput

reasoning

compaction

codeInterpreterCall

imageGenerationCall

localShellCall

localShellCallOutput

shellCall

shellCallOutput

applyPatchCall

applyPatchCallOutput

mcpApprovalRequest

mcpApprovalResponse

mcpCall

mcpListTools

customToolCall

customToolCallOutput

isMessage

isFileSearchCall

isFunctionCall

isFunctionCallOutput

isToolSearchCall

isToolSearchOutput

isAdditionalTools

isWebSearchCall

isComputerCall

isComputerCallOutput

isReasoning

isCompaction

isCodeInterpreterCall

isImageGenerationCall

isLocalShellCall

isLocalShellCallOutput

isShellCall

isShellCallOutput

isApplyPatchCall

isApplyPatchCallOutput

isMcpApprovalRequest

isMcpApprovalResponse

isMcpCall

isMcpListTools

isCustomToolCall

isCustomToolCallOutput

asMessage

asFileSearchCall

asFunctionCall

asFunctionCallOutput

asToolSearchCall

asToolSearchOutput

asAdditionalTools

asWebSearchCall

asComputerCall

asComputerCallOutput

asReasoning

asCompaction

asCodeInterpreterCall

asImageGenerationCall

asLocalShellCall

asLocalShellCallOutput