Struct EvaluationCase 

pub struct EvaluationCase {
    pub id: String,
    pub kind: EvaluationCaseKind,
    pub query: String,
    pub expected_result_ids: Vec<String>,
    pub forbidden_result_ids: Vec<String>,
    pub required_sources: Vec<RetrieverSource>,
    pub expected_stale: Option<bool>,
}

Expected behavior for one evaluation query or workflow.

Fields

id: String

kind: EvaluationCaseKind

query: String

expected_result_ids: Vec<String>

forbidden_result_ids: Vec<String>

required_sources: Vec<RetrieverSource>

expected_stale: Option<bool>

Implementations

impl EvaluationCase

pub fn new( id: impl Into<String>, kind: EvaluationCaseKind, query: impl Into<String>, ) -> Result<Self, EvaluationError>

Validates a case and keeps expected result IDs deterministic.

pub fn requiring_results(self, ids: &[&str]) -> Result<Self, EvaluationError>

Adds result IDs that must be present in the observation.

pub fn forbidding_results(self, ids: &[&str]) -> Result<Self, EvaluationError>

Adds result IDs that must not appear in the observation.

pub fn requiring_sources(self, sources: &[RetrieverSource]) -> Self

Requires at least one observed retrieval hit from each listed source.

pub const fn expecting_stale(self, stale: bool) -> Self

Requires the response stale flag to match the expected value.

Trait Implementations

impl Clone for EvaluationCase

fn clone(&self) -> EvaluationCase

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EvaluationCase

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EvaluationCase

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EvaluationCase

impl PartialEq for EvaluationCase

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EvaluationCase

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 EvaluationCase