Enum Error 

#[non_exhaustive]
pub enum Error {
    ClientBuild(TransportError),
    #[non_exhaustive]
    MissingApiKey {
        provider: &'static str,
        env: &'static str,
    },
    #[non_exhaustive]
    Request {
        provider: &'static str,
        source: TransportError,
    },
    #[non_exhaustive]
    Api {
        provider: &'static str,
        status: u16,
        body: String,
    },
    #[non_exhaustive]
    Decode {
        provider: &'static str,
        source: TransportError,
    },
    #[non_exhaustive]
    CountMismatch {
        provider: &'static str,
        got: usize,
        expected: usize,
    },
    #[non_exhaustive]
    DimMismatch {
        provider: &'static str,
        got: usize,
        expected: usize,
    },
}

Everything that can go wrong producing embeddings. Each variant carries the provider that raised it so a caller can log or match without string-scraping.

The struct variants are #[non_exhaustive] so fields can be added (e.g. a retry_after on Error::Api) without a breaking release; match them with a trailing ...

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.

ClientBuild(TransportError)

Building the underlying HTTP client failed (bad TLS config, etc.).

#[non_exhaustive]

MissingApiKey

Voyage was selected but no API key was supplied and the environment variable is unset.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

provider: &'static str

The provider that needed a key ("voyage").

env: &'static str

The environment variable that was consulted (VOYAGE_API_KEY_ENV).

#[non_exhaustive]

Request

The HTTP request never completed (connection refused, timeout, DNS, …). For Ollama this usually means the server is not running.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

provider: &'static str

The provider the request targeted.

source: TransportError

The underlying transport error.

#[non_exhaustive]

Api

The provider answered with a non-success status; body is its message.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

provider: &'static str

The provider that returned the error.

status: u16

The HTTP status code.

body: String

The response body (the provider’s error message).

#[non_exhaustive]

Decode

The success response could not be decoded into the expected shape.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

provider: &'static str

The provider whose response failed to decode.

source: TransportError

The underlying transport error.

#[non_exhaustive]

CountMismatch

The provider returned a different number of vectors than inputs given.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

provider: &'static str

The provider that returned the wrong count.

got: usize

How many vectors came back.

expected: usize

How many were expected (one per input).

#[non_exhaustive]

DimMismatch

An output_dimension was pinned but a returned vector had a different width - a schema-desync guard for callers that store into a fixed-width column (e.g. pgvector vector(1024)).

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

provider: &'static str

The provider that returned the wrong width.

got: usize

The width actually returned.

expected: usize

The pinned ClientBuilder::output_dimension.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.