Struct TextCollection 

pub struct TextCollection<E> { /* private fields */ }

A collection that embeds documents and text queries with one model.

Implementations

impl<E: Embedder> TextCollection<E>

pub fn upsert_documents( &self, documents: impl IntoIterator<Item = Document>, ) -> Result<WriteResult>

Embeds and upserts documents, retaining their text in each payload.

Examples found in repository

examples/text.rs (lines 29-32)

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 (lines 9-12)

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 replace_documents( &self, filter: Filter, documents: impl IntoIterator<Item = Document>, ) -> Result<MutationResult>

Atomically replaces documents matching filter with a new document set.

The collection must already exist. Use TextCollection::upsert_documents for the first write, then this method for repeatable source synchronization.

pub fn delete(&self, selector: DeleteSelector) -> Result<WriteResult>

Deletes text documents selected by IDs, metadata, or document filters.

pub fn search_text( &self, text: impl Into<String>, limit: usize, ) -> Result<Vec<ScoredPoint>>

Embeds one text query and returns nearest documents with payloads.

Examples found in repository

examples/text.rs (line 34)

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 13)

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 query(&self, query: TextQuery) -> Result<Vec<DocumentHit>>

Embeds and executes one filtered text query, returning typed documents.

pub fn query_batch( &self, queries: impl IntoIterator<Item = TextQuery>, ) -> Result<Vec<Vec<DocumentHit>>>

Embeds and executes text queries in input order as one embedding batch.

pub fn vectors(&self) -> &CollectionHandle

Returns the underlying vector collection handle.

Trait Implementations

impl<E: Clone> Clone for TextCollection<E>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for TextCollection<E>

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

Formats the value using the given formatter.