Class RunCancelResponse.DataSource.Responses.SamplingParams.Text
-
- All Implemented Interfaces:
public final class RunCancelResponse.DataSource.Responses.SamplingParams.TextConfiguration options for a text response from the model. Can be plain text or structured JSON data. Learn more:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRunCancelResponse.DataSource.Responses.SamplingParams.Text.BuilderA builder for Text.
-
Method Summary
Modifier and Type Method Description final Optional<ResponseFormatTextConfig>format()An object specifying the format that the model must output. final JsonField<ResponseFormatTextConfig>_format()Returns the raw JSON value of format. final Map<String, JsonValue>_additionalProperties()final RunCancelResponse.DataSource.Responses.SamplingParams.Text.BuildertoBuilder()final RunCancelResponse.DataSource.Responses.SamplingParams.Textvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RunCancelResponse.DataSource.Responses.SamplingParams.Text.Builderbuilder()Returns a mutable builder for constructing an instance of Text. -
-
Method Detail
-
format
final Optional<ResponseFormatTextConfig> format()
An object specifying the format that the model must output.
Configuring
{ "type": "json_schema" }enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.The default format is
{ "type": "text" }with no additional options.Not recommended for gpt-4o and newer models:
Setting to
{ "type": "json_object" }enables the older JSON mode, which ensures the message the model generates is valid JSON. Usingjson_schemais preferred for models that support it.
-
_format
final JsonField<ResponseFormatTextConfig> _format()
Returns the raw JSON value of format.
Unlike format, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RunCancelResponse.DataSource.Responses.SamplingParams.Text.Builder toBuilder()
-
validate
final RunCancelResponse.DataSource.Responses.SamplingParams.Text 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 RunCancelResponse.DataSource.Responses.SamplingParams.Text.Builder builder()
Returns a mutable builder for constructing an instance of Text.
-
-
-
-