Enum OutputFormat 

#[non_exhaustive]
pub enum OutputFormat {
    Text,
    Json,
    JsonSchema {
        name: String,
        schema: Value,
        strict: bool,
    },
}

Desired final-output format.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text

Unconstrained text.

Json

Any valid JSON value.

JsonSchema

JSON constrained by a schema.

Fields

name: String

Schema name sent to providers that require one.

schema: Value

JSON Schema.

strict: bool

Whether the provider should enforce its strictest mode.

Implementations

impl OutputFormat

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

where T: JsonSchema,

Builds a strict JSON-schema format from a Rust type.

Provider enforcement is only one boundary. Callers should still decode the response locally with crate::ModelResponse::structured.

pub fn typed_with_strictness<T>(name: impl Into<String>, strict: bool) -> Self

where T: JsonSchema,

Builds a JSON-schema format from a Rust type with explicit provider strictness.

Trait Implementations

impl Clone for OutputFormat

fn clone(&self) -> OutputFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputFormat

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

Formats the value using the given formatter.

impl Default for OutputFormat

fn default() -> OutputFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OutputFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OutputFormat

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OutputFormat

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 OutputFormat