TextResponseFormat interface
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. Using json_schema
is preferred for models that support it.
Properties
| type | The output format requested from the model, such as plain text or structured JSON. |
Property Details
type
The output format requested from the model, such as plain text or structured JSON.
type: TextResponseFormatConfigurationType