Enum RetrievalEvaluationError 

#[non_exhaustive]
pub enum RetrievalEvaluationError {
    EmptyCaseId,
    EmptyRelevantDocuments,
    ZeroCutoff,
    CountOutOfRange,
    Retrieval(RetrievalError),
}

Invalid dataset or failed retrieval evaluation.

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.

EmptyCaseId

A case identity was blank.

EmptyRelevantDocuments

A case had no relevant documents.

ZeroCutoff

A case requested no ranked results.

CountOutOfRange

A collection size could not be represented by the metric format.

Retrieval(RetrievalError)

The retriever failed.

Trait Implementations

impl Debug for RetrievalEvaluationError

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

Formats the value using the given formatter.

impl Display for RetrievalEvaluationError

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

Formats the value using the given formatter.

impl Error for RetrievalEvaluationError

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<RetrievalError> for RetrievalEvaluationError

fn from(source: RetrievalError) -> Self

Converts to this type from the input type.