Struct ResponseFormat 

pub struct ResponseFormat {
    pub name: String,
    pub schema: Value,
}

Schema specification for structured JSON output.

When you need the LLM to return data in a specific JSON format, define a ResponseFormat with a JSON Schema. The model will attempt to conform its output to this schema.

Example

use multi_llm::ResponseFormat;

let format = ResponseFormat {
    name: "person_info".to_string(),
    schema: serde_json::json!({
        "type": "object",
        "properties": {
            "name": {"type": "string"},
            "age": {"type": "integer"},
            "email": {"type": "string", "format": "email"}
        },
        "required": ["name", "age"]
    }),
};

Fields

name: String

Name identifier for this schema.

Used for logging and debugging. Should be descriptive of the expected output.

schema: Value

JSON Schema specification defining the expected output structure.

The model will attempt to return JSON that validates against this schema. Include type, properties, required, and description fields.

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