Struct LanceDbVectorIndex 

pub struct LanceDbVectorIndex<M: EmbeddingModel> { /* private fields */ }

Type on which vector searches can be performed for a lanceDb table.

Example

use rig_lancedb::{LanceDbVectorIndex, SearchParams};
use rig_core::client::ProviderClient;
use rig_core::providers::openai::{Client, TEXT_EMBEDDING_ADA_002, EmbeddingModel};

let openai_client = Client::from_env()?;

let table: lancedb::Table = db.create_table(""); // <-- Replace with your lancedb table here.
let model: EmbeddingModel = openai_client.embedding_model(TEXT_EMBEDDING_ADA_002); // <-- Replace with your embedding model here.
let vector_store_index = LanceDbVectorIndex::new(table, model, "id", SearchParams::default()).await?;

Implementations

impl<M> LanceDbVectorIndex<M>

where M: EmbeddingModel,

pub async fn new( table: Table, model: M, id_field: &str, search_params: SearchParams, ) -> Result<Self, Error>

Create an instance of LanceDbVectorIndex with an existing table and model. Define the id field name of the table. Define search parameters that will be used to perform vector searches on the table.

Trait Implementations

impl<M> VectorStoreIndex for LanceDbVectorIndex<M>

where M: EmbeddingModel + Sync + Send,

async fn top_n<T: for<'a> Deserialize<'a> + Send>( &self, req: VectorSearchRequest<LanceDBFilter>, ) -> Result<Vec<(f64, String, T)>, VectorStoreError>

Implement the top_n method of the VectorStoreIndex trait for LanceDbVectorIndex.

Example

use rig_lancedb::{LanceDbVectorIndex, SearchParams};
use rig_core::client::ProviderClient;
use rig_core::providers::openai::{EmbeddingModel, Client, TEXT_EMBEDDING_ADA_002};

let openai_client = Client::from_env()?;

let table: lancedb::Table = db.create_table("fake_definitions"); // <-- Replace with your lancedb table here.
let model: EmbeddingModel = openai_client.embedding_model(TEXT_EMBEDDING_ADA_002); // <-- Replace with your embedding model here.
let vector_store_index = LanceDbVectorIndex::new(table, model, "id", SearchParams::default()).await?;

// Query the index
let result = vector_store_index
    .top_n::<String>("My boss says I zindle too much, what does that mean?", 1)
    .await?;

async fn top_n_ids( &self, req: VectorSearchRequest<LanceDBFilter>, ) -> Result<Vec<(f64, String)>, VectorStoreError>

Implement the top_n_ids method of the VectorStoreIndex trait for LanceDbVectorIndex.

Example

use rig_lancedb::{LanceDbVectorIndex, SearchParams};
use rig_core::client::ProviderClient;
use rig_core::providers::openai::{Client, TEXT_EMBEDDING_ADA_002, EmbeddingModel};

let openai_client = Client::from_env()?;

let table: lancedb::Table = db.create_table(""); // <-- Replace with your lancedb table here.
let model: EmbeddingModel = openai_client.embedding_model(TEXT_EMBEDDING_ADA_002); // <-- Replace with your embedding model here.
let vector_store_index = LanceDbVectorIndex::new(table, model, "id", SearchParams::default()).await?;

// Query the index
let result = vector_store_index
    .top_n_ids("My boss says I zindle too much, what does that mean?", 1)
    .await?;

type Filter = LanceDBFilter

The filter type for this backend.