Enum OutputSpec 

#[non_exhaustive]
pub enum OutputSpec {
    FreeText,
    Json {
        schema: Value,
        name: String,
        strict: bool,
    },
    ToolCalls,
}

The shape the answer must have (spec §20.3, §20.4).

Json is what a critical stage asks for. Whether the provider enforces the schema on the wire or only sees it in a prompt is the difference between StructuredOutputCapability::NativeJsonSchema and PromptOnly; the router refuses to serve an understanding task with the latter, and the adapter must never pretend otherwise.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

FreeText

Prose, for a request that needs no document back.

Json

A single JSON document matching schema.

Fields

schema: Value

The JSON Schema the answer must satisfy. Also the schema parse_structured validates against, so it is never merely decorative.

name: String

Name the provider labels the schema with.

strict: bool

Whether the provider must reject non-conforming output rather than producing a best effort. Adapters that cannot honour strict must declare a weaker StructuredOutputCapability.

ToolCalls

One or more tool calls, taken as the answer.

Implementations

impl OutputSpec

pub fn json(name: impl Into<String>, schema: Value) -> Self

A strict JSON-schema output.

pub fn schema(&self) -> Option<&Value>

Borrows the schema, when there is one.

pub const fn is_structured(&self) -> bool

Returns true when the answer is expected to be JSON.

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

Stable snake-case label.

Trait Implementations

impl Clone for OutputSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OutputSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OutputSpec

impl PartialEq for OutputSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OutputSpec

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 OutputSpec