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

                    
```
A wrapper for Response that provides type-safe access to the output 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

Field Summary

Fields
Modifier and Type	Field	Description
`private final Class<T>`	`responseType`
`private final Response`	`rawResponse`

Constructor Summary

Constructors
Constructor	Description
`StructuredResponse(Class<T> responseType, Response rawResponse)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Class<T>`	`responseType()`
`final Response`	`rawResponse()`
`final String`	`id()`
`final Double`	`createdAt()`
`final Optional<ResponseError>`	`error()`
`final Optional<Response.IncompleteDetails>`	`incompleteDetails()`
`final Optional<Response.Instructions>`	`instructions()`
`final Optional<Response.Metadata>`	`metadata()`
`final ResponsesModel`	`model()`
`final JsonValue`	`_object_()`
`final List<StructuredResponseOutputItem<T>>`	`output()`
`final Boolean`	`parallelToolCalls()`
`final Optional<Double>`	`temperature()`
`final Response.ToolChoice`	`toolChoice()`
`final List<Tool>`	`tools()`
`final Optional<Double>`	`topP()`
`final Optional<Long>`	`maxToolCalls()`
`final Optional<Long>`	`topLogprobs()`
`final Optional<Long>`	`maxOutputTokens()`
`final Optional<String>`	`previousResponseId()`
`final Optional<ResponsePrompt>`	`prompt()`
`final Optional<String>`	`promptCacheKey()`
`final Optional<Reasoning>`	`reasoning()`
`final Optional<String>`	`safetyIdentifier()`
`final Optional<Response.ServiceTier>`	`serviceTier()`
`final Optional<ResponseStatus>`	`status()`
`final Optional<ResponseTextConfig>`	`text()`
`final Optional<Response.Truncation>`	`truncation()`
`final Optional<ResponseUsage>`	`usage()`
`final Optional<String>`	`user()`
`final Optional<Boolean>`	`background()`
`final Optional<Response.Conversation>`	`conversation()`
`final JsonField<String>`	`_id()`
`final JsonField<Double>`	`_createdAt()`
`final JsonField<ResponseError>`	`_error()`
`final JsonField<Response.IncompleteDetails>`	`_incompleteDetails()`
`final JsonField<Response.Instructions>`	`_instructions()`
`final JsonField<Response.Metadata>`	`_metadata()`
`final JsonField<ResponsesModel>`	`_model()`
`final JsonField<List<StructuredResponseOutputItem<T>>>`	`_output()`
`final JsonField<Boolean>`	`_parallelToolCalls()`
`final JsonField<Double>`	`_temperature()`
`final JsonField<Response.ToolChoice>`	`_toolChoice()`
`final JsonField<List<Tool>>`	`_tools()`
`final JsonField<Double>`	`_topP()`
`final JsonField<Long>`	`_maxToolCalls()`
`final JsonField<Long>`	`_topLogprobs()`
`final JsonField<Long>`	`_maxOutputTokens()`
`final JsonField<String>`	`_previousResponseId()`
`final JsonField<ResponsePrompt>`	`_prompt()`
`final JsonField<String>`	`_promptCacheKey()`
`final JsonField<Reasoning>`	`_reasoning()`
`final JsonField<String>`	`_safetyIdentifier()`
`final JsonField<Response.ServiceTier>`	`_serviceTier()`
`final JsonField<ResponseStatus>`	`_status()`
`final JsonField<ResponseTextConfig>`	`_text()`
`final JsonField<Response.Truncation>`	`_truncation()`
`final JsonField<ResponseUsage>`	`_usage()`
`final JsonField<String>`	`_user()`
`final JsonField<Boolean>`	`_background()`
`final JsonField<Response.Conversation>`	`_conversation()`
`final Map<String, JsonValue>`	`_additionalProperties()`
`final StructuredResponse<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

StructuredResponse

StructuredResponse(Class<T> responseType, Response rawResponse)

Method Detail

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

rawResponse
```
 final Response rawResponse()
```

id
```
 final String id()
```

createdAt
```
 final Double createdAt()
```

error
```
 final Optional<ResponseError> error()
```

incompleteDetails

 final Optional<Response.IncompleteDetails> incompleteDetails()

instructions

 final Optional<Response.Instructions> instructions()

metadata

 final Optional<Response.Metadata> metadata()

model
```
 final ResponsesModel model()
```

_object_
```
 final JsonValue _object_()
```

output

 final List<StructuredResponseOutputItem<T>> output()

parallelToolCalls
```
 final Boolean parallelToolCalls()
```

temperature
```
 final Optional<Double> temperature()
```

toolChoice
```
 final Response.ToolChoice toolChoice()
```

tools
```
 final List<Tool> tools()
```

topP
```
 final Optional<Double> topP()
```

maxToolCalls
```
 final Optional<Long> maxToolCalls()
```

topLogprobs
```
 final Optional<Long> topLogprobs()
```

maxOutputTokens
```
 final Optional<Long> maxOutputTokens()
```

previousResponseId

 final Optional<String> previousResponseId()

prompt

 final Optional<ResponsePrompt> prompt()

promptCacheKey

 final Optional<String> promptCacheKey()

reasoning
```
 final Optional<Reasoning> reasoning()
```

safetyIdentifier

 final Optional<String> safetyIdentifier()

serviceTier

 final Optional<Response.ServiceTier> serviceTier()

status

 final Optional<ResponseStatus> status()

text

 final Optional<ResponseTextConfig> text()

truncation

 final Optional<Response.Truncation> truncation()

usage
```
 final Optional<ResponseUsage> usage()
```

user
```
 final Optional<String> user()
```

background
```
 final Optional<Boolean> background()
```

conversation

 final Optional<Response.Conversation> conversation()

_id
```
 final JsonField<String> _id()
```

_createdAt
```
 final JsonField<Double> _createdAt()
```

_error

 final JsonField<ResponseError> _error()

_incompleteDetails

 final JsonField<Response.IncompleteDetails> _incompleteDetails()

_instructions

 final JsonField<Response.Instructions> _instructions()

_metadata

 final JsonField<Response.Metadata> _metadata()

_model

 final JsonField<ResponsesModel> _model()

_output

 final JsonField<List<StructuredResponseOutputItem<T>>> _output()

_parallelToolCalls

 final JsonField<Boolean> _parallelToolCalls()

_temperature
```
 final JsonField<Double> _temperature()
```

_toolChoice

 final JsonField<Response.ToolChoice> _toolChoice()

_tools
```
 final JsonField<List<Tool>> _tools()
```

_topP
```
 final JsonField<Double> _topP()
```

_maxToolCalls
```
 final JsonField<Long> _maxToolCalls()
```

_topLogprobs
```
 final JsonField<Long> _topLogprobs()
```

_maxOutputTokens

 final JsonField<Long> _maxOutputTokens()

_previousResponseId

 final JsonField<String> _previousResponseId()

_prompt

 final JsonField<ResponsePrompt> _prompt()

_promptCacheKey

 final JsonField<String> _promptCacheKey()

_reasoning

 final JsonField<Reasoning> _reasoning()

_safetyIdentifier

 final JsonField<String> _safetyIdentifier()

_serviceTier

 final JsonField<Response.ServiceTier> _serviceTier()

_status

 final JsonField<ResponseStatus> _status()

_text

 final JsonField<ResponseTextConfig> _text()

_truncation

 final JsonField<Response.Truncation> _truncation()

_usage

 final JsonField<ResponseUsage> _usage()

_user
```
 final JsonField<String> _user()
```

_background
```
 final JsonField<Boolean> _background()
```

_conversation

 final JsonField<Response.Conversation> _conversation()

_additionalProperties

 final Map<String, JsonValue> _additionalProperties()

validate
```
 final StructuredResponse<T> validate()
```

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

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

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

Class StructuredResponse

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StructuredResponse

Method Detail

responseType

rawResponse

id

createdAt

error

incompleteDetails

instructions

metadata

model

_object_

output

parallelToolCalls

temperature

toolChoice

tools

topP

maxToolCalls

topLogprobs

maxOutputTokens

previousResponseId

prompt

promptCacheKey

reasoning

safetyIdentifier

serviceTier

status

text

truncation

usage

user

background

conversation

_id

_createdAt

_error

_incompleteDetails

_instructions

_metadata

_model

_output

_parallelToolCalls

_temperature

_toolChoice

_tools

_topP

_maxToolCalls

_topLogprobs

_maxOutputTokens

_previousResponseId

_prompt

_promptCacheKey

_reasoning

_safetyIdentifier

_serviceTier

_status

_text

_truncation

_usage

_user

_background

_conversation

_additionalProperties

validate

isValid

equals

hashCode

toString