Struct EmbeddingVectorIndexWriter 

pub struct EmbeddingVectorIndexWriter { /* private fields */ }

A wrapper around a VectorIndexWriter that automatically handles content embedding.

Implementations

impl EmbeddingVectorIndexWriter

pub fn new( inner: Box<dyn VectorIndexWriter>, embedder: Arc<dyn Embedder>, ) -> Self

Create a new embedding vector index writer.

pub async fn add_value( &mut self, doc_id: u64, field_name: String, value: DataValue, ) -> Result<()>

Add a value (Text, ImageBytes, etc.) to the index, embedding it automatically.

Trait Implementations

impl Debug for EmbeddingVectorIndexWriter

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

Formats the value using the given formatter.

impl VectorIndexWriter for EmbeddingVectorIndexWriter

fn next_vector_id(&self) -> u64

Get the next available vector ID (for automatic ID assignment).

fn add_value<'life0, 'async_trait>( &'life0 mut self, doc_id: u64, field_name: String, value: DataValue, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Add a value to the index, embedding it automatically if supported.

fn build(&mut self, vectors: Vec<(u64, String, Vector)>) -> Result<()>

Build an index from a collection of vectors with field names. Each vector is a tuple of (vec_id, field_name, Vector).

fn add_vectors(&mut self, vectors: Vec<(u64, String, Vector)>) -> Result<()>

Add vectors incrementally during construction. Each vector is a tuple of (vec_id, field_name, Vector). This allows field-specific vector search similar to lexical field search.

fn finalize(&mut self) -> Result<()>

Finalize the index construction.

fn progress(&self) -> f32

Get build progress (0.0 to 1.0).

fn estimated_memory_usage(&self) -> usize

Get estimated memory usage.

fn vectors(&self) -> &[(u64, String, Vector)]

Get access to the stored vectors with field names. Returns a reference to the vectors with their field names stored in the writer.

fn write(&self) -> Result<()>

Write the index to storage. This method must be called after finalize() to persist the index.

fn has_storage(&self) -> bool

Check if this writer has storage configured.

fn delete_document(&mut self, doc_id: u64) -> Result<()>

Delete a document by its ID.

fn commit(&mut self) -> Result<()>

Commit pending changes to the index.

fn rollback(&mut self) -> Result<()>

Rollback pending changes.

fn pending_docs(&self) -> u64

Get the number of pending documents not yet committed.

fn close(&mut self) -> Result<()>

Close the writer and release resources.

fn is_closed(&self) -> bool

Check if the writer is closed.

fn build_reader(&self) -> Result<Arc<dyn VectorIndexReader>>

Build a reader from the written index.

fn delete_documents(&mut self, field: &str, value: &str) -> Result<usize>

Delete documents matching a metadata field value.

fn optimize(&mut self) -> Result<()>

Optimize the index.