Struct Document 

pub struct Document {
    pub content: String,
    pub metadata: HashMap<String, Value>,
    pub score: Option<f64>,
}

A retrieved document fragment with optional metadata and relevance score.

Fields

content: String

The text content of the document.

metadata: HashMap<String, Value>

Arbitrary key-value metadata (e.g., source URL, page number, title).

score: Option<f64>

Relevance score assigned by the retrieval backend (higher = more relevant). None if the backend does not provide scores.

Implementations

impl Document

pub fn new(content: impl Into<String>) -> Self

Creates a document with only text content.

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Adds a metadata entry.

pub fn with_score(self, score: f64) -> Self

Sets the relevance score.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.