Skip to main content

SchemaProperty

aimx

Type Alias SchemaProperty 

Source 
pub type SchemaProperty = GenerationSchemaProperty;
Expand description

Compatibility alias for the oldest structured-generation property name.

Aliased Type§

pub struct SchemaProperty {
    pub name: GenerationSchemaPropertyName,
    pub description: Option<SchemaDescription>,
    pub property_type: GenerationSchemaPropertyType,
    pub requirement: GenerationSchemaPropertyRequirement,
}

Fields§

§name: GenerationSchemaPropertyName

Property name (matches the JSON key in the model output).

§description: Option<SchemaDescription>

Optional human-readable hint that guides the model.

§property_type: GenerationSchemaPropertyType

The expected type of this property.

§requirement: GenerationSchemaPropertyRequirement

Whether the model must include or may omit this property.