Enum AssistantsApiResponseFormatOption

pub enum AssistantsApiResponseFormatOption {
    Text(ResponseFormatText),
    Object(ResponseFormatJsonObject),
    Schema(ResponseFormatJsonSchema),
}

on openapi.yaml

AssistantsApiResponseFormatOption:
  description: >
    Specifies the format that the model must output. Compatible with
    [GPT-4o](/docs/models#gpt-4o), [GPT-4
    Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models
    since `gpt-3.5-turbo-1106`.


    Setting to `{ "type": "json_schema", "json_schema": {...} }` enables
    Structured Outputs which ensures the model will match your supplied JSON
    schema. Learn more in the [Structured Outputs
    guide](/docs/guides/structured-outputs).


    Setting to `{ "type": "json_object" }` enables JSON mode, which ensures
    the message the model generates is valid JSON.


    **Important:** when using JSON mode, you **must** also instruct the
    model to produce JSON yourself via a system or user message. Without
    this, the model may generate an unending stream of whitespace until the
    generation reaches the token limit, resulting in a long-running and
    seemingly "stuck" request. Also note that the message content may be
    partially cut off if `finish_reason="length"`, which indicates the
    generation exceeded `max_tokens` or the conversation exceeded the max
    context length.
  oneOf:
    - type: string
      description: |
        `auto` is the default value
      enum:
        - auto
      x-stainless-const: true
    - $ref: "#/components/schemas/ResponseFormatText"
    - $ref: "#/components/schemas/ResponseFormatJsonObject"
    - $ref: "#/components/schemas/ResponseFormatJsonSchema"

Variants

Text(ResponseFormatText)

Object(ResponseFormatJsonObject)

Schema(ResponseFormatJsonSchema)

Trait Implementations

impl Debug for AssistantsApiResponseFormatOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AssistantsApiResponseFormatOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AssistantsApiResponseFormatOption

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

where __S: Serializer,

Serialize this value into the given Serde serializer.