Enum ResponseFormat 

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

Provider-agnostic output-format hint.

Variants

Text

JsonObject

JsonSchema

Strict JSON Schema output (OpenAI json_schema mode). schema should be a schemars::schema_for!(T) value serialized to Value.

Fields

name: String

Name for the schema (shown in API responses).

schema: Value

The JSON Schema object.

strict: bool

Whether to enforce strict schema adherence.

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 Default for ResponseFormat

fn default() -> ResponseFormat

Returns the “default value” for a type.

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 From<ResponseFormat> for ResponseFormat

fn from(f: ResponseFormat) -> Self

Converts to this type from the input type.

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.