Skip to main content

VectorEngine

Struct VectorEngine 

Source
pub struct VectorEngine {
    pub config: VectorConfig,
    pub collections: Arc<CollectionManager>,
    pub ann_searcher: Arc<AnnSearcher>,
    pub hybrid_searcher: Arc<HybridSearcher>,
    pub embedding_client: Arc<dyn EmbeddingProvider>,
}
Expand description

High-level engine that manages collections, search, and embeddings.

Fields§

§config: VectorConfig

Runtime configuration.

§collections: Arc<CollectionManager>

Collection lifecycle and persistence manager.

§ann_searcher: Arc<AnnSearcher>

ANN search service.

§hybrid_searcher: Arc<HybridSearcher>

Hybrid vector + keyword search service.

§embedding_client: Arc<dyn EmbeddingProvider>

Embedding provider used for text ingestion and search.

Implementations§

Source§

impl VectorEngine

Source

pub async fn new(config: VectorConfig) -> VectorResult<Self>

Create a new engine using the configured gRPC embedding service.

Source

pub async fn open_default() -> VectorResult<Self>

Open an engine using the default configuration.

Source

pub async fn with_embedding_provider( config: VectorConfig, embedding_client: Arc<dyn EmbeddingProvider>, ) -> VectorResult<Self>

Create a new engine with a caller-supplied embedding provider.

Source

pub async fn create_collection( &self, name: &str, dimensions: usize, distance: DistanceMetric, ) -> VectorResult<Collection>

Create a collection with the provided dimensions and distance metric.

Source

pub async fn create_collection_in_workspace( &self, workspace_id: &str, name: &str, dimensions: usize, distance: DistanceMetric, ) -> VectorResult<Collection>

Create a collection inside a specific workspace.

Source

pub async fn delete_collection(&self, name: &str) -> VectorResult<()>

Delete a collection and all of its persisted state.

Source

pub async fn delete_collection_in_workspace( &self, workspace_id: &str, name: &str, ) -> VectorResult<()>

Delete a collection inside a specific workspace.

Source

pub async fn list_collections(&self) -> VectorResult<Vec<Collection>>

List all collections.

Source

pub async fn list_collections_in_workspace( &self, workspace_id: &str, ) -> VectorResult<Vec<Collection>>

List collections scoped to a workspace.

Source

pub async fn upsert( &self, collection: &str, text: &str, metadata: Value, ) -> VectorResult<Uuid>

Embed text, persist the record, and return its UUID.

Source

pub async fn upsert_in_workspace( &self, workspace_id: &str, collection: &str, text: &str, metadata: Value, ) -> VectorResult<Uuid>

Embed and insert a record in a workspace-scoped collection.

Source

pub async fn upsert_batch( &self, collection: &str, items: Vec<(String, Value)>, ) -> VectorResult<Vec<Uuid>>

Embed and insert multiple text records.

Source

pub async fn upsert_batch_in_workspace( &self, workspace_id: &str, collection: &str, items: Vec<(String, Value)>, ) -> VectorResult<Vec<Uuid>>

Embed and insert multiple records in a workspace-scoped collection.

Source

pub async fn upsert_vector( &self, collection: &str, vector: Vec<f32>, metadata: Value, ) -> VectorResult<Uuid>

Insert a raw vector directly.

Source

pub async fn upsert_vector_in_workspace( &self, workspace_id: &str, collection: &str, vector: Vec<f32>, metadata: Value, ) -> VectorResult<Uuid>

Insert a raw vector directly into a workspace-scoped collection.

Source

pub async fn search(&self, query: SearchQuery) -> VectorResult<SearchResponse>

Execute ANN search.

Source

pub async fn search_in_workspace( &self, workspace_id: &str, query: SearchQuery, ) -> VectorResult<SearchResponse>

Execute ANN search scoped to a workspace.

Source

pub async fn search_text( &self, collection: &str, text: &str, top_k: usize, ) -> VectorResult<SearchResponse>

Execute ANN search from raw text.

Source

pub async fn search_text_in_workspace( &self, workspace_id: &str, collection: &str, text: &str, top_k: usize, ) -> VectorResult<SearchResponse>

Execute ANN search from raw text scoped to a workspace.

Execute hybrid search.

Source

pub async fn delete(&self, collection: &str, id: Uuid) -> VectorResult<bool>

Delete a vector record by UUID.

Source

pub async fn delete_in_workspace( &self, workspace_id: &str, collection: &str, id: Uuid, ) -> VectorResult<bool>

Delete a vector by UUID from a workspace-scoped collection.

Source

pub async fn get( &self, collection: &str, id: Uuid, ) -> VectorResult<VectorRecord>

Fetch a vector record by UUID.

Source

pub async fn get_in_workspace( &self, workspace_id: &str, collection: &str, id: Uuid, ) -> VectorResult<VectorRecord>

Fetch a vector by UUID from a workspace-scoped collection.

Source

pub async fn close(&self) -> VectorResult<()>

Persist indexes and close the underlying store.

Source

pub async fn stats(&self) -> EngineStats

Return runtime statistics for the engine.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more