Enum StructuredOutputError 

pub enum StructuredOutputError {
    PromptError(Box<PromptError>),
    DeserializationError(Error),
    EmptyResponse,
}

Errors that can occur when using typed structured output via TypedPrompt::prompt_typed.

When the failure wraps PromptError that in turn wraps a CompletionError exposing a provider response, Self::provider_response_body, Self::provider_response_json, and Self::provider_response_status forward through the chain.

Variants

PromptError(Box<PromptError>)

An error occurred during the prompt execution.

DeserializationError(Error)

Failed to deserialize the model’s response into the target type.

EmptyResponse

The model returned an empty response.

Implementations

impl StructuredOutputError

pub fn provider_response_body(&self) -> Option<&str>

Returns the provider response body when this wraps a prompt error that exposes one.

pub fn provider_response_json(&self) -> Result<Option<Value>, Error>

Parses the provider response body as JSON when available through a wrapped prompt error.

Returns:

• Ok(Some(value)) when a body is present and valid JSON.
• Ok(None) when no provider response body is available.
• Err(error) when a body is present but isn’t valid JSON.

pub fn provider_response_status(&self) -> Option<StatusCode>

Returns the HTTP status when this wraps a prompt error that preserves one.

Trait Implementations

impl Debug for StructuredOutputError

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

Formats the value using the given formatter.

impl Display for StructuredOutputError

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

Formats the value using the given formatter.

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<Box<PromptError>> for StructuredOutputError

fn from(source: Box<PromptError>) -> Self

Converts to this type from the input type.

impl From<Error> for StructuredOutputError

fn from(source: Error) -> Self

Converts to this type from the input type.