Enum StructuredOutputCapability 

pub enum StructuredOutputCapability {
    NativeJsonSchema,
    NativeFunctionSchema,
    GrammarConstrained,
    JsonObject,
    PromptOnly,
    None,
}

How a model can be made to emit structured output (spec §20.3).

Ordered from strongest to weakest guarantee.

Variants

NativeJsonSchema

The provider enforces a supplied JSON Schema on the output.

NativeFunctionSchema

The provider enforces the schema of a declared function; the call is used only as a transport for the structured payload, never executed.

GrammarConstrained

Constrained decoding against a grammar derived from the schema.

JsonObject

The provider guarantees syntactically valid JSON but not the schema.

PromptOnly

The schema is only described in the prompt.

None

No structured-output support at all.

Implementations

impl StructuredOutputCapability

pub const ALL: [Self; 6]

Every capability, strongest first.

pub const fn as_str(self) -> &'static str

Stable snake-case label.

pub const fn enforces_schema(self) -> bool

Returns true when the provider enforces the schema (not just JSON syntax) on the wire.

Trait Implementations

impl Clone for StructuredOutputCapability

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StructuredOutputCapability

impl Debug for StructuredOutputCapability

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructuredOutputCapability

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StructuredOutputCapability

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

Formats the value using the given formatter.

impl Eq for StructuredOutputCapability

impl Hash for StructuredOutputCapability

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 Ord for StructuredOutputCapability

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for StructuredOutputCapability

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StructuredOutputCapability

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for StructuredOutputCapability

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 StructuredOutputCapability