Enum SchemaTransform 

#[non_exhaustive]
pub enum SchemaTransform {
    AdditionalPropertiesFalse,
    RemovePropertyNames,
    OpenAiStrict,
}

A rewrite applied to a JSON Schema before it is sent to a provider.

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.

AdditionalPropertiesFalse

Set additionalProperties: false on every object schema.

Applied by default to schemas derived from Rust types, so that models cannot invent properties the type does not declare.

RemovePropertyNames

Remove propertyNames keywords everywhere.

OpenAiStrict

OpenAI strict mode: additionalProperties: false, no propertyNames, every property required, previously optional properties nullable.

Implementations

impl SchemaTransform

pub fn openai_strict() -> Self

The OpenAI strict-mode transform.

pub fn additional_properties_false() -> Self

The additionalProperties: false transform.

pub fn apply(self, schema: &mut Value) -> Result<(), SchemaError>

Applies the transform in place, leaving the input unchanged on error.

Errors

Returns SchemaError::UnsupportedTransform for dictionaries that OpenAI strict mode cannot represent.

pub fn applied(self, schema: Value) -> Result<Value, SchemaError>

Applies the transform to an owned schema and returns it.

Errors

Returns SchemaError::UnsupportedTransform for dictionaries that OpenAI strict mode cannot represent.

Trait Implementations

impl Clone for SchemaTransform

fn clone(&self) -> SchemaTransform

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SchemaTransform

impl Debug for SchemaTransform

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

Formats the value using the given formatter.

impl Eq for SchemaTransform

impl Hash for SchemaTransform

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SchemaTransform

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SchemaTransform