Class ResponseTextConfig
-
- All Implemented Interfaces:
public final class ResponseTextConfig
Configuration 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 class
ResponseTextConfig.Builder
A builder for ResponseTextConfig.
public final class
ResponseTextConfig.Verbosity
Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are
low
,medium
, andhigh
.
-
Method Summary
Modifier and Type Method Description final Optional<ResponseFormatTextConfig>
format()
An object specifying the format that the model must output. final Optional<ResponseTextConfig.Verbosity>
verbosity()
Constrains the verbosity of the model's response. final JsonField<ResponseFormatTextConfig>
_format()
Returns the raw JSON value of format. final JsonField<ResponseTextConfig.Verbosity>
_verbosity()
Returns the raw JSON value of verbosity. final Map<String, JsonValue>
_additionalProperties()
final ResponseTextConfig.Builder
toBuilder()
final ResponseTextConfig
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseTextConfig.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseTextConfig. -
-
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_schema
is preferred for models that support it.
-
verbosity
final Optional<ResponseTextConfig.Verbosity> verbosity()
Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are
low
,medium
, andhigh
.
-
_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.
-
_verbosity
final JsonField<ResponseTextConfig.Verbosity> _verbosity()
Returns the raw JSON value of verbosity.
Unlike verbosity, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseTextConfig.Builder toBuilder()
-
validate
final ResponseTextConfig validate()
-
builder
final static ResponseTextConfig.Builder builder()
Returns a mutable builder for constructing an instance of ResponseTextConfig.
-
-
-
-