Enum ProviderError 

#[non_exhaustive]
pub enum ProviderError {
    ApiCall(Box<ApiCallError>),
    EmptyResponseBody(EmptyResponseBodyError),
    InvalidArgument(InvalidArgumentError),
    InvalidPrompt(Box<InvalidPromptError>),
    InvalidResponseData(Box<InvalidResponseDataError>),
    JsonParse(Box<JsonParseError>),
    LoadApiKey(LoadApiKeyError),
    LoadSetting(LoadSettingError),
    NoContentGenerated(NoContentGeneratedError),
    NoSuchModel(Box<NoSuchModelError>),
    NoSuchProviderReference(Box<NoSuchProviderReferenceError>),
    TooManyEmbeddingValues(Box<TooManyEmbeddingValuesForCallError>),
    TypeValidation(TypeValidationError),
    UnsupportedFunctionality(UnsupportedFunctionalityError),
    Cancelled,
    Other(BoxError),
}

Error returned by provider adapters.

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.

ApiCall(Box<ApiCallError>)

An HTTP call to the provider failed.

EmptyResponseBody(EmptyResponseBodyError)

The provider returned an empty body where one was required.

InvalidArgument(InvalidArgumentError)

A call argument is invalid.

InvalidPrompt(Box<InvalidPromptError>)

The prompt cannot be converted for this provider.

InvalidResponseData(Box<InvalidResponseDataError>)

The response has an unexpected shape.

JsonParse(Box<JsonParseError>)

Response text is not valid JSON.

LoadApiKey(LoadApiKeyError)

The API key could not be loaded.

LoadSetting(LoadSettingError)

A required setting could not be loaded.

NoContentGenerated(NoContentGeneratedError)

The provider produced no content.

NoSuchModel(Box<NoSuchModelError>)

The requested model does not exist.

NoSuchProviderReference(Box<NoSuchProviderReferenceError>)

A provider reference has no entry for this provider.

TooManyEmbeddingValues(Box<TooManyEmbeddingValuesForCallError>)

Too many values were passed to a single embedding call.

TypeValidation(TypeValidationError)

A value failed schema or type validation.

UnsupportedFunctionality(UnsupportedFunctionalityError)

The provider or model does not support the requested functionality.

Cancelled

The call was cancelled through its cancellation token.

Other(BoxError)

Any other error.

Implementations

impl ProviderError

pub fn other(error: impl Error + Send + Sync + 'static) -> Self

Wraps an arbitrary error in ProviderError::Other.

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

Creates an ProviderError::Other from a message.

pub fn unsupported(functionality: impl Into<String>) -> Self

Creates an ProviderError::UnsupportedFunctionality error.

pub fn is_retryable(&self) -> bool

Returns true when retrying the call may succeed.

Only ProviderError::ApiCall carries retry information; every other variant is not retryable.

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

Returns the HTTP status code of an API call error.

pub fn as_api_call(&self) -> Option<&ApiCallError>

Returns the API call error, if this is ProviderError::ApiCall.

pub fn kind_name(&self) -> &'static str

Returns a stable, low-cardinality name of the variant for telemetry.

Trait Implementations

impl Debug for ProviderError

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

Formats the value using the given formatter.

impl Display for ProviderError

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

Formats the value using the given formatter.

impl Error for ProviderError

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<ApiCallError> for ProviderError

fn from(error: ApiCallError) -> Self

Converts to this type from the input type.

impl From<Box<ApiCallError>> for ProviderError

fn from(error: Box<ApiCallError>) -> Self

Converts to this type from the input type.

impl From<Box<InvalidPromptError>> for ProviderError

fn from(error: Box<InvalidPromptError>) -> Self

Converts to this type from the input type.

impl From<Box<InvalidResponseDataError>> for ProviderError

fn from(error: Box<InvalidResponseDataError>) -> Self

Converts to this type from the input type.

impl From<Box<JsonParseError>> for ProviderError

fn from(error: Box<JsonParseError>) -> Self

Converts to this type from the input type.

impl From<Box<NoSuchModelError>> for ProviderError

fn from(error: Box<NoSuchModelError>) -> Self

Converts to this type from the input type.

impl From<Box<NoSuchProviderReferenceError>> for ProviderError

fn from(error: Box<NoSuchProviderReferenceError>) -> Self

Converts to this type from the input type.

impl From<Box<TooManyEmbeddingValuesForCallError>> for ProviderError

fn from(error: Box<TooManyEmbeddingValuesForCallError>) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error + Sync + Send>> for ProviderError

fn from(source: BoxError) -> Self

Converts to this type from the input type.

impl From<EmptyResponseBodyError> for ProviderError

fn from(source: EmptyResponseBodyError) -> Self

Converts to this type from the input type.

impl From<InvalidArgumentError> for ProviderError

fn from(source: InvalidArgumentError) -> Self

Converts to this type from the input type.

impl From<InvalidPromptError> for ProviderError

fn from(error: InvalidPromptError) -> Self

Converts to this type from the input type.

impl From<InvalidResponseDataError> for ProviderError

fn from(error: InvalidResponseDataError) -> Self

Converts to this type from the input type.

impl From<JsonParseError> for ProviderError

fn from(error: JsonParseError) -> Self

Converts to this type from the input type.

impl From<LoadApiKeyError> for ProviderError

fn from(source: LoadApiKeyError) -> Self

Converts to this type from the input type.

impl From<LoadSettingError> for ProviderError

fn from(source: LoadSettingError) -> Self

Converts to this type from the input type.

impl From<NoContentGeneratedError> for ProviderError

fn from(source: NoContentGeneratedError) -> Self

Converts to this type from the input type.

impl From<NoSuchModelError> for ProviderError

fn from(error: NoSuchModelError) -> Self

Converts to this type from the input type.

impl From<NoSuchProviderReferenceError> for ProviderError

fn from(error: NoSuchProviderReferenceError) -> Self

Converts to this type from the input type.

impl From<TooManyEmbeddingValuesForCallError> for ProviderError

fn from(error: TooManyEmbeddingValuesForCallError) -> Self

Converts to this type from the input type.

impl From<TypeValidationError> for ProviderError

fn from(source: TypeValidationError) -> Self

Converts to this type from the input type.

impl From<UnsupportedFunctionalityError> for ProviderError

fn from(source: UnsupportedFunctionalityError) -> Self

Converts to this type from the input type.