Package com.openai.models.responses
Class StructuredResponseOutputItem
-
- 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)
-
Method Summary
-
-
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()
-
webSearchCall
final Optional<ResponseFunctionWebSearch> webSearchCall()
-
computerCall
final Optional<ResponseComputerToolCall> computerCall()
-
reasoning
final Optional<ResponseReasoningItem> reasoning()
-
codeInterpreterCall
final Optional<ResponseCodeInterpreterToolCall> codeInterpreterCall()
-
imageGenerationCall
final Optional<ResponseOutputItem.ImageGenerationCall> imageGenerationCall()
-
localShellCall
final Optional<ResponseOutputItem.LocalShellCall> localShellCall()
-
mcpApprovalRequest
final Optional<ResponseOutputItem.McpApprovalRequest> mcpApprovalRequest()
-
mcpCall
final Optional<ResponseOutputItem.McpCall> mcpCall()
-
mcpListTools
final Optional<ResponseOutputItem.McpListTools> mcpListTools()
-
isFileSearchCall
final Boolean isFileSearchCall()
-
isFunctionCall
final Boolean isFunctionCall()
-
isWebSearchCall
final Boolean isWebSearchCall()
-
isComputerCall
final Boolean isComputerCall()
-
isReasoning
final Boolean isReasoning()
-
isCodeInterpreterCall
final Boolean isCodeInterpreterCall()
-
isImageGenerationCall
final Boolean isImageGenerationCall()
-
isLocalShellCall
final Boolean isLocalShellCall()
-
isMcpApprovalRequest
final Boolean isMcpApprovalRequest()
-
isMcpListTools
final Boolean isMcpListTools()
-
asMessage
final StructuredResponseOutputMessage<T> asMessage()
-
asFileSearchCall
final ResponseFileSearchToolCall asFileSearchCall()
-
asFunctionCall
final ResponseFunctionToolCall asFunctionCall()
-
asWebSearchCall
final ResponseFunctionWebSearch asWebSearchCall()
-
asComputerCall
final ResponseComputerToolCall asComputerCall()
-
asReasoning
final ResponseReasoningItem asReasoning()
-
asCodeInterpreterCall
final ResponseCodeInterpreterToolCall asCodeInterpreterCall()
-
asImageGenerationCall
final ResponseOutputItem.ImageGenerationCall asImageGenerationCall()
-
asLocalShellCall
final ResponseOutputItem.LocalShellCall asLocalShellCall()
-
asMcpApprovalRequest
final ResponseOutputItem.McpApprovalRequest asMcpApprovalRequest()
-
asMcpCall
final ResponseOutputItem.McpCall asMcpCall()
-
asMcpListTools
final ResponseOutputItem.McpListTools asMcpListTools()
-
validate
final StructuredResponseOutputItem<T> validate()
-
-
-
-