Constructor Detail

Method Detail

• maxCompletionTokens

   final Optional<Long> maxCompletionTokens()

  The maximum number of tokens in the generated output.

• reasoningEffort

   final Optional<ReasoningEffort> reasoningEffort()

  Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

  • gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.

  • All models before gpt-5.1 default to medium reasoning effort, and do not support none.

  • The gpt-5-pro model defaults to (and only supports) high reasoning effort.

  • xhigh is supported for all models after gpt-5.1-codex-max.

• seed

   final Optional<Long> seed()

  A seed value to initialize the randomness, during sampling.

• temperature

   final Optional<Double> temperature()

  A higher temperature increases randomness in the outputs.

• text

   final Optional<RunRetrieveResponse.DataSource.Responses.SamplingParams.Text> text()

  Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

  • Text inputs and outputs

  • Structured * Outputs

• tools

   final Optional<List<Tool>> tools()

  An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.

  The two categories of tools you can provide the model are:

  • Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools.

  • Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code. Learn more about function calling.

• topP

   final Optional<Double> topP()

  An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

• _maxCompletionTokens

   final JsonField<Long> _maxCompletionTokens()

  Returns the raw JSON value of maxCompletionTokens.

  Unlike maxCompletionTokens, this method doesn't throw if the JSON field has an unexpected type.

• _reasoningEffort

   final JsonField<ReasoningEffort> _reasoningEffort()

  Returns the raw JSON value of reasoningEffort.

  Unlike reasoningEffort, this method doesn't throw if the JSON field has an unexpected type.

• _seed

   final JsonField<Long> _seed()

  Returns the raw JSON value of seed.

  Unlike seed, this method doesn't throw if the JSON field has an unexpected type.

• _temperature

   final JsonField<Double> _temperature()

  Returns the raw JSON value of temperature.

  Unlike temperature, this method doesn't throw if the JSON field has an unexpected type.

• _text

   final JsonField<RunRetrieveResponse.DataSource.Responses.SamplingParams.Text> _text()

  Returns the raw JSON value of text.

  Unlike text, this method doesn't throw if the JSON field has an unexpected type.

• _tools

   final JsonField<List<Tool>> _tools()

  Returns the raw JSON value of tools.

  Unlike tools, this method doesn't throw if the JSON field has an unexpected type.

• _topP

   final JsonField<Double> _topP()

  Returns the raw JSON value of topP.

  Unlike topP, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final RunRetrieveResponse.DataSource.Responses.SamplingParams.Builder toBuilder()

• validate

   final RunRetrieveResponse.DataSource.Responses.SamplingParams 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.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static RunRetrieveResponse.DataSource.Responses.SamplingParams.Builder builder()

  Returns a mutable builder for constructing an instance of SamplingParams.