Struct GoldQuery 

pub struct GoldQuery {
    pub query_id: String,
    pub query: String,
    pub relevant_docs: HashMap<String, u8>,
    pub reference_answer: Option<String>,
}

A single labeled query in a retrieval dataset.

Field order is stable for downstream serialization; do not reorder without bumping the dataset schema version in Qrels.

Fields

query_id: String

Stable opaque identifier for the query.

query: String

Natural-language query text to send to the retriever.

relevant_docs: HashMap<String, u8>

Map of doc_id -> graded_relevance. Documents not listed are treated as non-relevant (grade 0). Grades are typically 1–3.

reference_answer: Option<String>

Optional reference / “gold” answer used by answer-level evaluators. Retrieval-only metrics ignore this.

Implementations

impl GoldQuery

pub fn is_relevant(&self, doc_id: &str) -> bool

Returns true if doc_id is labeled relevant (grade ≥ 1).

pub fn grade(&self, doc_id: &str) -> u8

Returns the graded relevance for doc_id, or 0 if unlabeled.

pub fn relevant_count(&self) -> usize

Number of distinct documents labeled relevant (grade ≥ 1).

Trait Implementations

impl Clone for GoldQuery

fn clone(&self) -> GoldQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoldQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GoldQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GoldQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.