Enum ResponseFormat 

pub enum ResponseFormat {
    Text,
    JsonObject,
    JsonSchema {
        name: String,
        description: Option<String>,
        schema: Value,
        strict: Option<bool>,
    },
}

The requested structured-output format for a response.

Mirrors the Python ChatOptions.response_format / .NET ChatResponseFormat. The serialized form matches the OpenAI response_format request object, so a provider can map it with serde_json::to_value(&format):

• ResponseFormat::Text → {"type":"text"}
• ResponseFormat::JsonObject → {"type":"json_object"}
• ResponseFormat::JsonSchema → {"type":"json_schema","json_schema":{"name":…,"schema":…}}

Variants

Text

Free-form text (the default provider behavior).

JsonObject

A syntactically valid JSON object, without an enforced schema.

JsonSchema

A JSON object conforming to the given JSON Schema.

Fields

name: String

description: Option<String>

schema: Value

strict: Option<bool>

Implementations

impl ResponseFormat

pub fn json_schema(name: impl Into<String>, schema: Value) -> ResponseFormat

Build a ResponseFormat::JsonSchema from a name and schema.

pub fn to_json(&self) -> Value

The provider-facing wire object (same as serde_json::to_value(self)).

Trait Implementations

impl Clone for ResponseFormat

fn clone(&self) -> ResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseFormat

fn deserialize<D>( d: D, ) -> Result<ResponseFormat, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponseFormat

fn eq(&self, other: &ResponseFormat) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ResponseFormat

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResponseFormat