Enum ResponseFormat 

pub enum ResponseFormat {
    Text,
    JsonObject,
    JsonSchema {
        json_schema: Value,
    },
}

The format the model’s response must take, mirroring OpenAI’s response_format field.

Serializes to OpenAI’s wire format, e.g. {"type":"text"}, {"type":"json_object"}, or {"type":"json_schema","json_schema":{...}}.

Variants

Text

Plain text (the provider default).

JsonObject

Constrain the output to a syntactically valid JSON object (“JSON mode”).

JsonSchema

Constrain the output to a specific JSON Schema (structured outputs).

Fields

json_schema: Value

The OpenAI json_schema object (typically {name, schema, strict}).

Implementations

impl ResponseFormat

pub fn json_object() -> Self

JSON mode: any syntactically valid JSON object.

pub fn json_schema(json_schema: Value) -> Self

Structured outputs constrained to the given json_schema object.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponseFormat

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ResponseFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResponseFormat