Enum StructuredOutputError 

#[non_exhaustive]
pub enum StructuredOutputError {
    NoOutput,
    NotJson {
        detail: String,
    },
    SchemaViolation {
        pointer: String,
        keyword: String,
    },
    UnknownField {
        pointer: String,
        field: String,
    },
    MissingField {
        pointer: String,
        field: String,
    },
    MultipleCandidates {
        candidates: usize,
    },
    Refusal,
}

Why a structured response was rejected.

Every variant means the same thing operationally: nothing from this response is used.

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.

NoOutput

The response carried nothing parseable: empty content, or an answer cut short by a token cap or a content filter.

NotJson

The candidate document is not JSON.

Fields

detail: String

serde_json’s positional complaint ("expected value at line 1 column 1"). Positions and expectations only — never the input.

SchemaViolation

The document is JSON but breaks the schema.

Fields

pointer: String

JSON pointer into the instance, e.g. /acts/1/operation.

keyword: String

The schema keyword that failed, e.g. type or enum.

UnknownField

The document carries a field the schema or the target type does not know. Never dropped silently for a critical stage.

Fields

pointer: String

JSON pointer to the object holding it.

field: String

The field’s name, sanitized.

MissingField

A required field is missing. Never filled in with a default.

Fields

pointer: String

JSON pointer to the object that should hold it.

field: String

The field’s name, sanitized.

MultipleCandidates

The response offered several documents where the stage expects one.

Fields

candidates: usize

How many were found.

Refusal

The model declined to answer.

Implementations

impl StructuredOutputError

pub fn not_json(error: Error) -> Self

Wraps a serde_json parse failure, keeping only its positional message.

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

Stable snake-case label for metrics and reports.

Trait Implementations

impl Clone for StructuredOutputError

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 StructuredOutputError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructuredOutputError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StructuredOutputError

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

Formats the value using the given formatter.

impl Eq for StructuredOutputError

impl Error for StructuredOutputError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<StructuredOutputError> for ProviderError

fn from(value: StructuredOutputError) -> Self

A rejected structured response is a Refusal when the model declined, and Malformed otherwise — so a re-roll is the classified remedy.

impl PartialEq for StructuredOutputError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StructuredOutputError

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 StructuredOutputError