Struct Document 

pub struct Document {
    pub doc_id: Option<DocumentId>,
    pub content: String,
    pub metadata: Value,
    pub score: Option<f32>,
}

One retrieved document with optional similarity score.

Fields

doc_id: Option<DocumentId>

Backend-assigned stable id, when the originating VectorStore mints one. Pass back to VectorStore::update / VectorStore::delete to mutate or remove this document. None for embedded usages where stable identity isn’t tracked.

content: String

Body text. Implementations may store any UTF-8 payload.

metadata: Value

Free-form metadata — stored alongside the document for filtering / display. Use a JSON object by convention.

score: Option<f32>

Similarity score from the retriever, if available. Higher = better match. Comparable only within a single query’s result set.

Implementations

impl Document

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

Convenience: build a document with empty metadata and no score.

pub fn with_metadata(self, metadata: Value) -> Self

Builder-style metadata setter.

pub fn with_doc_id(self, id: impl Into<DocumentId>) -> Self

Builder-style doc_id setter — backends use this when surfacing previously-indexed documents so callers can mutate or delete via the same id.

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.

impl<'de> Deserialize<'de> for Document

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Document

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

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 Document