Class ResponseReasoningItem
-
- All Implemented Interfaces:
public final class ResponseReasoningItemA 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 classResponseReasoningItem.BuilderA builder for ResponseReasoningItem.
public final classResponseReasoningItem.Summarypublic final classResponseReasoningItem.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<ResponseReasoningItem.Summary>summary()Reasoning text contents. final JsonValue_type()The type of the object. final Optional<String>encryptedContent()The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_contentin theincludeparameter.final Optional<ResponseReasoningItem.Status>status()The status of the item. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<List<ResponseReasoningItem.Summary>>_summary()Returns the raw JSON value of summary. final JsonField<String>_encryptedContent()Returns the raw JSON value of encryptedContent. final JsonField<ResponseReasoningItem.Status>_status()Returns the raw JSON value of status. final Map<String, JsonValue>_additionalProperties()final ResponseReasoningItem.BuildertoBuilder()final ResponseReasoningItemvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseReasoningItem.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseReasoningItem. -
-
Method Detail
-
summary
final List<ResponseReasoningItem.Summary> summary()
Reasoning text contents.
-
_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).
-
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<ResponseReasoningItem.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<ResponseReasoningItem.Summary>> _summary()
Returns the raw JSON value of summary.
Unlike summary, 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<ResponseReasoningItem.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 ResponseReasoningItem.Builder toBuilder()
-
validate
final ResponseReasoningItem validate()
-
builder
final static ResponseReasoningItem.Builder builder()
Returns a mutable builder for constructing an instance of ResponseReasoningItem.
The following fields are required:
.id() .summary()
-
-
-
-