Struct StructuredOutputFormat

pub struct StructuredOutputFormat {
    pub name: String,
    pub description: Option<String>,
    pub schema: Option<Value>,
    pub strict: Option<bool>,
}

Defines rules for structured output responses based on OpenAI’s structured output requirements. Individual providers may have additional requirements or restrictions, but these should be handled by each provider’s backend implementation.

If you plan on deserializing into this struct, make sure the source text has a "name" field, since that’s technically the only thing required by OpenAI.

Example

use llm::chat::StructuredOutputFormat;
use serde_json::json;

let response_format = r#"
    {
        "name": "Student",
        "description": "A student object",
        "schema": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string"
                },
                "age": {
                    "type": "integer"
                },
                "is_student": {
                    "type": "boolean"
                }
            },
            "required": ["name", "age", "is_student"]
        }
    }
"#;
let structured_output: StructuredOutputFormat = serde_json::from_str(response_format).unwrap();
assert_eq!(structured_output.name, "Student");
assert_eq!(structured_output.description, Some("A student object".to_string()));

Fields

name: String

Name of the schema

description: Option<String>

The description of the schema

schema: Option<Value>

The JSON schema for the structured output

strict: Option<bool>

Whether to enable strict schema adherence

Trait Implementations

impl Clone for StructuredOutputFormat

fn clone(&self) -> StructuredOutputFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredOutputFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructuredOutputFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StructuredOutputFormat

fn eq(&self, other: &StructuredOutputFormat) -> 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 StructuredOutputFormat

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 StructuredOutputFormat