Struct Document 

pub struct Document {
    pub id: PointId,
    pub text: String,
    pub metadata: JsonObject,
}

A text document with a typed ID and optional JSON metadata.

Fields

id: PointId

Stable document identifier.

text: String

Text embedded for similarity search.

metadata: JsonObject

Application-defined metadata stored with the text.

Implementations

impl Document

pub fn new(id: impl Into<PointId>, text: impl Into<String>) -> Self

Creates a document with empty metadata.

Examples found in repository

examples/text.rs (line 30)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let db = open(temporary.path().join("documents.git"))?;
    let docs = db.text_collection("docs", ExampleEmbedder)?;
    docs.upsert_documents([
        Document::new("east", "A document about the east"),
        Document::new("north", "A document about the north"),
    ])?;
    assert_eq!(
        docs.search_text("north wind", 1)?[0].id.to_string(),
        "north"
    );
    Ok(())
}

examples/text_fastembed.rs (line 10)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let db = open(temporary.path().join("documents.git"))?;
    let docs = db.text_collection("docs", FastEmbedder::try_new()?)?;
    docs.upsert_documents([
        Document::new("git", "Git-native vector search"),
        Document::new("fruit", "Fresh fruit at the market"),
    ])?;
    let hits = docs.search_text("versioned database search", 1)?;
    println!("{}", hits[0].id);
    Ok(())
}

pub fn with_metadata(self, metadata: impl Serialize) -> Result<Self>

Serializes object-shaped document metadata.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

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 PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document