Struct OutputSchema 

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

Structured output schema passed to the model and used for runtime parsing.

Fields

name: String

Output schema name.

description: Option<String>

Output schema description.

schema: Value

JSON schema for the final output value.

strict: bool

Whether schema validation should be strict when provider support exists.

Implementations

impl OutputSchema

pub fn new(name: impl Into<String>, schema: Value) -> Self

Build a named output schema.

pub fn typed<T>() -> Self

where T: JsonSchema,

Build an output schema from a Rust type.

The generated schema name is derived from the Rust type name and normalized for provider request formats. Use Self::typed_named when the public schema name needs to be stable across type renames.

pub fn typed_named<T>(name: impl Into<String>) -> Self

where T: JsonSchema,

Build a named output schema from a Rust type.

pub fn with_description(self, description: impl Into<String>) -> Self

Add a description.

pub const fn with_strict(self, strict: bool) -> Self

Set strict provider validation preference.

pub fn request_schema(&self) -> Value

Return provider-neutral request schema metadata.

Trait Implementations

impl Clone for OutputSchema

fn clone(&self) -> OutputSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OutputSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OutputSchema

impl PartialEq for OutputSchema

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

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 OutputSchema