Struct GenerationSchema 

pub struct GenerationSchema {
    pub name: GenerationSchemaName,
    pub description: Option<SchemaDescription>,
    pub properties: Vec<GenerationSchemaProperty>,
}

Describes the JSON object shape that the model must produce for structured generation.

Build one using the builder methods, then pass it to LanguageModelSession::generate_object.

use aimx::{GenerationSchema, GenerationSchemaProperty, GenerationSchemaPropertyType};

let schema = GenerationSchema::new("Point")
    .property(GenerationSchemaProperty::new("x", GenerationSchemaPropertyType::Double))
    .property(GenerationSchemaProperty::new("y", GenerationSchemaPropertyType::Double));

Fields

name: GenerationSchemaName

Internal type name used by the model’s structured generation system.

description: Option<SchemaDescription>

Optional description of what this type represents.

properties: Vec<GenerationSchemaProperty>

The properties the model must populate.

Implementations

impl GenerationSchema

pub fn new(name: impl Into<GenerationSchemaName>) -> Self

Creates a new empty schema with the given type name.

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

Attaches a description of this type.

pub fn property(self, property: GenerationSchemaProperty) -> Self

Adds a property to this schema.

Trait Implementations

impl Clone for GenerationSchema

fn clone(&self) -> GenerationSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerationSchema

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

Formats the value using the given formatter.

impl Serialize for GenerationSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.