Class InputTokenCountParams.Text
-
- All Implemented Interfaces:
public final class InputTokenCountParams.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 classInputTokenCountParams.Text.BuilderA builder for Text.
public final classInputTokenCountParams.Text.VerbosityConstrains 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<InputTokenCountParams.Text.Verbosity>verbosity()Constrains the verbosity of the model's response. final JsonField<ResponseFormatTextConfig>_format()Returns the raw JSON value of format. final JsonField<InputTokenCountParams.Text.Verbosity>_verbosity()Returns the raw JSON value of verbosity. final Map<String, JsonValue>_additionalProperties()final InputTokenCountParams.Text.BuildertoBuilder()final InputTokenCountParams.Textvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static InputTokenCountParams.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.
-
verbosity
final Optional<InputTokenCountParams.Text.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<InputTokenCountParams.Text.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 InputTokenCountParams.Text.Builder toBuilder()
-
validate
final InputTokenCountParams.Text validate()
-
builder
final static InputTokenCountParams.Text.Builder builder()
Returns a mutable builder for constructing an instance of Text.
-
-
-
-