Enum DynamicGenerationSchema 

pub enum DynamicGenerationSchema {
    Object {
        name: String,
        description: Option<String>,
        represent_nil_explicitly_in_generated_content: bool,
        properties: BTreeMap<String, DynamicGenerationProperty>,
    },
    Array {
        item: Box<DynamicGenerationSchema>,
        minimum_elements: Option<usize>,
        maximum_elements: Option<usize>,
        guides: Vec<GenerationGuide>,
    },
    AnyOf {
        name: String,
        description: Option<String>,
        choices: Vec<DynamicGenerationSchema>,
    },
    AnyOfStrings {
        name: String,
        description: Option<String>,
        choices: Vec<String>,
    },
    String {
        description: Option<String>,
        guides: Vec<GenerationGuide>,
    },
    Integer {
        description: Option<String>,
        guides: Vec<GenerationGuide>,
    },
    Float {
        description: Option<String>,
        guides: Vec<GenerationGuide>,
    },
    Number {
        description: Option<String>,
        guides: Vec<GenerationGuide>,
    },
    Decimal {
        description: Option<String>,
        guides: Vec<GenerationGuide>,
    },
    Boolean {
        description: Option<String>,
    },
    GeneratedContent {
        description: Option<String>,
    },
    Reference {
        name: String,
    },
    Null,
}

A dynamic FoundationModels schema description.

Variants

Object

Fields

name: String

description: Option<String>

represent_nil_explicitly_in_generated_content: bool

properties: BTreeMap<String, DynamicGenerationProperty>

Array

Fields

item: Box<DynamicGenerationSchema>

minimum_elements: Option<usize>

maximum_elements: Option<usize>

guides: Vec<GenerationGuide>

AnyOf

Fields

name: String

description: Option<String>

choices: Vec<DynamicGenerationSchema>

AnyOfStrings

Fields

name: String

description: Option<String>

choices: Vec<String>

String

Fields

description: Option<String>

guides: Vec<GenerationGuide>

Integer

Fields

description: Option<String>

guides: Vec<GenerationGuide>

Float

Fields

description: Option<String>

guides: Vec<GenerationGuide>

Number

Fields

description: Option<String>

guides: Vec<GenerationGuide>

Decimal

Fields

description: Option<String>

guides: Vec<GenerationGuide>

Boolean

Fields

description: Option<String>

GeneratedContent

Fields

description: Option<String>

Reference

Fields

name: String

Null

Implementations

impl DynamicGenerationSchema

pub const NULL: Self = Self::Null

The SDK’s typed DynamicGenerationSchema.null marker.

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

Create an object schema.

pub fn new_with_nil_repr( name: impl Into<String>, description: Option<String>, represent_nil_explicitly_in_generated_content: bool, properties: impl IntoIterator<Item = (impl Into<String>, DynamicGenerationProperty)>, ) -> Self

Create an object schema that keeps optional properties as explicit nulls.

pub const fn null() -> Self

Create the SDK’s typed DynamicGenerationSchema.null marker.

pub fn string() -> Self

Create a string schema.

pub fn integer() -> Self

Create an integer schema.

pub fn float() -> Self

Create a floating-point schema.

pub fn number() -> Self

Create a number schema.

pub fn decimal() -> Self

Create a decimal schema.

pub fn boolean() -> Self

Create a boolean schema.

pub fn generated_content() -> Self

Create an arbitrary-JSON schema.

pub fn array_of(item: Self) -> Self

Create an array schema.

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

Create a reference to a named dependency.

pub fn any_of(name: impl Into<String>, choices: Vec<Self>) -> Self

Create a named union of schemas.

pub fn any_of_strings( name: impl Into<String>, choices: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Create a named union of constant string choices.

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

Attach a description.

pub fn with_property( self, name: impl Into<String>, property: DynamicGenerationProperty, ) -> Self

Add a property to an object schema.

pub fn with_element_bounds( self, minimum: Option<usize>, maximum: Option<usize>, ) -> Self

Set the array bounds.

pub fn with_guides( self, guides: impl IntoIterator<Item = GenerationGuide>, ) -> Self

Attach FoundationModels generation guides.

Trait Implementations

impl Clone for DynamicGenerationSchema

fn clone(&self) -> DynamicGenerationSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicGenerationSchema

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

Formats the value using the given formatter.

impl PartialEq for DynamicGenerationSchema

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