Struct EvaluationCorpus 

pub struct EvaluationCorpus {
    pub name: String,
    pub documents: Vec<Document>,
    pub queries: Vec<QueryWithJudgments>,
}

Evaluation corpus containing documents and queries with ground truth.

Fields

name: String

Corpus name/identifier.

documents: Vec<Document>

Documents in the corpus.

queries: Vec<QueryWithJudgments>

Queries with ground truth judgments.

Implementations

impl EvaluationCorpus

pub fn new(name: &str) -> Self

Create a new empty corpus.

pub fn add_document(&mut self, id: &str, content: &str)

Add a document to the corpus.

pub fn add_query(&mut self, query: &str, judgments: Vec<(&str, f64)>)

Add a query with judgments.

pub fn compute_hash(&self) -> String

Compute a hash of the corpus for reproducibility.

pub fn code_search_sample() -> Self

Create a sample corpus for testing embedders on code search scenarios.

Trait Implementations

impl Clone for EvaluationCorpus

fn clone(&self) -> EvaluationCorpus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EvaluationCorpus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EvaluationCorpus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EvaluationCorpus

fn eq(&self, other: &EvaluationCorpus) -> 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 EvaluationCorpus

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 EvaluationCorpus