Class BetaResponseReasoningItem
-
- All Implemented Interfaces:
public final class BetaResponseReasoningItemA description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your
inputto the Responses API for subsequent turns of a conversation if you are manually managing context.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseReasoningItem.BuilderA builder for BetaResponseReasoningItem.
public final classBetaResponseReasoningItem.SummaryA summary text from the model.
public final classBetaResponseReasoningItem.AgentThe agent that produced this item.
public final classBetaResponseReasoningItem.ContentReasoning text from the model.
public final classBetaResponseReasoningItem.StatusThe status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API.
-
Method Summary
Modifier and Type Method Description final Stringid()The unique identifier of the reasoning content. final List<BetaResponseReasoningItem.Summary>summary()Reasoning summary content. final JsonValue_type()The type of the object. final Optional<BetaResponseReasoningItem.Agent>agent()The agent that produced this item. final Optional<List<BetaResponseReasoningItem.Content>>content()Reasoning text content. final Optional<String>encryptedContent()The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_contentin theincludeparameter.final Optional<BetaResponseReasoningItem.Status>status()The status of the item. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<List<BetaResponseReasoningItem.Summary>>_summary()Returns the raw JSON value of summary. final JsonField<BetaResponseReasoningItem.Agent>_agent()Returns the raw JSON value of agent. final JsonField<List<BetaResponseReasoningItem.Content>>_content()Returns the raw JSON value of content. final JsonField<String>_encryptedContent()Returns the raw JSON value of encryptedContent. final JsonField<BetaResponseReasoningItem.Status>_status()Returns the raw JSON value of status. final Map<String, JsonValue>_additionalProperties()final BetaResponseReasoningItem.BuildertoBuilder()final BetaResponseReasoningItemvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseReasoningItem.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseReasoningItem. -
-
Method Detail
-
summary
final List<BetaResponseReasoningItem.Summary> summary()
Reasoning summary content.
-
_type
final JsonValue _type()
The type of the object. Always
reasoning.Expected to always return the following:
JsonValue.from("reasoning")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
agent
final Optional<BetaResponseReasoningItem.Agent> agent()
The agent that produced this item.
-
content
final Optional<List<BetaResponseReasoningItem.Content>> content()
Reasoning text content.
-
encryptedContent
final Optional<String> encryptedContent()
The encrypted content of the reasoning item - populated when a response is generated with
reasoning.encrypted_contentin theincludeparameter.
-
status
final Optional<BetaResponseReasoningItem.Status> status()
The status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_summary
final JsonField<List<BetaResponseReasoningItem.Summary>> _summary()
Returns the raw JSON value of summary.
Unlike summary, this method doesn't throw if the JSON field has an unexpected type.
-
_agent
final JsonField<BetaResponseReasoningItem.Agent> _agent()
Returns the raw JSON value of agent.
Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
-
_content
final JsonField<List<BetaResponseReasoningItem.Content>> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_encryptedContent
final JsonField<String> _encryptedContent()
Returns the raw JSON value of encryptedContent.
Unlike encryptedContent, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<BetaResponseReasoningItem.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaResponseReasoningItem.Builder toBuilder()
-
validate
final BetaResponseReasoningItem validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static BetaResponseReasoningItem.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseReasoningItem.
The following fields are required:
.id() .summary()
-
-
-
-