Struct Schema 

pub struct Schema {
    pub type_field: JSONType,
    pub properties: IndexMap<String, SchemaPropertyType>,
    pub required: Vec<String>,
    pub additional_properties: bool,
    pub description: Option<String>,
}

Defines the shape of a JSON object for the LLM, used both for structured output and for the parameters of a tool definition.

Fields

type_field: JSONType

Type of the schema, should be Object

properties: IndexMap<String, SchemaPropertyType>

Order-preserving, and deliberately not a HashMap: RandomState reseeds per map instance, so a HashMap here serializes its keys in a different order on nearly every request. Tool definitions and structured output schemas sit at the front of the prompt, and Azure’s prompt cache matches an exact prefix, so that alone misses the cache on every request.

required: Vec<String>

All ‘properties’ keys must be included in this ‘required’ list

additional_properties: bool

additionalProperties should always be ‘false’

description: Option<String>

Explains the object to the LLM.

Implementations

impl Schema

pub fn strict_object( properties: IndexMap<String, SchemaPropertyType>, description: Option<&str>, ) -> Self

A strict-mode object schema with every property key required.

Azure’s strict: true tool/response schemas have no notion of an optional property — a property a tool doesn’t strictly need still has to be listed here, with “Optional” said in its own description instead.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Schema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Schema

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

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 Schema