Enum TextResponseFormatConfiguration 

pub enum TextResponseFormatConfiguration {
    ResponseFormatText(ResponseFormatText),
    TextResponseFormatJsonSchema(TextResponseFormatJsonSchema),
    ResponseFormatJsonObject(ResponseFormatJsonObject),
}

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.

JSON schema

{
 "description": "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n",
 "oneOf": [
   {
     "$ref": "#/components/schemas/ResponseFormatText"
   },
   {
     "$ref": "#/components/schemas/TextResponseFormatJsonSchema"
   },
   {
     "$ref": "#/components/schemas/ResponseFormatJsonObject"
   }
 ]
}

Variants

ResponseFormatText(ResponseFormatText)

TextResponseFormatJsonSchema(TextResponseFormatJsonSchema)

ResponseFormatJsonObject(ResponseFormatJsonObject)

Trait Implementations

impl Clone for TextResponseFormatConfiguration

fn clone(&self) -> TextResponseFormatConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextResponseFormatConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextResponseFormatConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResponseFormatJsonObject> for TextResponseFormatConfiguration

fn from(value: ResponseFormatJsonObject) -> Self

Converts to this type from the input type.

impl From<ResponseFormatText> for TextResponseFormatConfiguration

fn from(value: ResponseFormatText) -> Self

Converts to this type from the input type.

impl From<TextResponseFormatJsonSchema> for TextResponseFormatConfiguration

fn from(value: TextResponseFormatJsonSchema) -> Self

Converts to this type from the input type.

impl Serialize for TextResponseFormatConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.