Class ResponseCreateParams.Reasoning
-
- All Implemented Interfaces:
public final class ResponseCreateParams.Reasoninggpt-5 and o-series models only
Configuration options for reasoning models.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseCreateParams.Reasoning.BuilderA builder for Reasoning.
public final classResponseCreateParams.Reasoning.ContextControls which reasoning items are rendered back to the model on later turns. When returned on a response, this is the effective reasoning context mode used for the response.
public final classResponseCreateParams.Reasoning.EffortConstrains effort on reasoning for reasoning models. Currently supported values are
none,minimal,low,medium,high,xhigh, andmax. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.public final classResponseCreateParams.Reasoning.GenerateSummaryDeprecated: use
summaryinstead.A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of
auto,concise, ordetailed.public final classResponseCreateParams.Reasoning.ModeControls the reasoning execution mode for the request.
When returned on a response, this is the effective execution mode.
public final classResponseCreateParams.Reasoning.SummaryA summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of
auto,concise, ordetailed.conciseis supported forcomputer-use-previewmodels and all reasoning models aftergpt-5.
-
Method Summary
-
-
Method Detail
-
context
final Optional<ResponseCreateParams.Reasoning.Context> context()
Controls which reasoning items are rendered back to the model on later turns. When returned on a response, this is the effective reasoning context mode used for the response.
-
effort
final Optional<ResponseCreateParams.Reasoning.Effort> effort()
Constrains effort on reasoning for reasoning models. Currently supported values are
none,minimal,low,medium,high,xhigh, andmax. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.
-
generateSummary
@Deprecated(message = "deprecated") final Optional<ResponseCreateParams.Reasoning.GenerateSummary> generateSummary()
Deprecated: use
summaryinstead.A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of
auto,concise, ordetailed.
-
mode
final Optional<ResponseCreateParams.Reasoning.Mode> mode()
Controls the reasoning execution mode for the request.
When returned on a response, this is the effective execution mode.
-
summary
final Optional<ResponseCreateParams.Reasoning.Summary> summary()
A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of
auto,concise, ordetailed.conciseis supported forcomputer-use-previewmodels and all reasoning models aftergpt-5.
-
_context
final JsonField<ResponseCreateParams.Reasoning.Context> _context()
Returns the raw JSON value of context.
Unlike context, this method doesn't throw if the JSON field has an unexpected type.
-
_effort
final JsonField<ResponseCreateParams.Reasoning.Effort> _effort()
Returns the raw JSON value of effort.
Unlike effort, this method doesn't throw if the JSON field has an unexpected type.
-
_generateSummary
@Deprecated(message = "deprecated") final JsonField<ResponseCreateParams.Reasoning.GenerateSummary> _generateSummary()
Returns the raw JSON value of generateSummary.
Unlike generateSummary, this method doesn't throw if the JSON field has an unexpected type.
-
_mode
final JsonField<ResponseCreateParams.Reasoning.Mode> _mode()
Returns the raw JSON value of mode.
Unlike mode, this method doesn't throw if the JSON field has an unexpected type.
-
_summary
final JsonField<ResponseCreateParams.Reasoning.Summary> _summary()
Returns the raw JSON value of summary.
Unlike summary, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseCreateParams.Reasoning.Builder toBuilder()
-
validate
final ResponseCreateParams.Reasoning 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 ResponseCreateParams.Reasoning.Builder builder()
Returns a mutable builder for constructing an instance of Reasoning.
-
-
-
-