Struct InvertedIndexPlugin 

pub struct InvertedIndexPlugin;

Implementations

impl InvertedIndexPlugin

pub async fn train_inverted_index( data: SendableRecordBatchStream, index_store: &dyn IndexStore, params: InvertedIndexParams, fragment_ids: Option<Vec<u32>>, ) -> Result<CreatedIndex>

Trait Implementations

impl Debug for InvertedIndexPlugin

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

Formats the value using the given formatter.

impl Default for InvertedIndexPlugin

fn default() -> InvertedIndexPlugin

Returns the “default value” for a type.

impl ScalarIndexPlugin for InvertedIndexPlugin

fn train_index<'life0, 'life1, 'async_trait>( &'life0 self, data: SendableRecordBatchStream, index_store: &'life1 dyn IndexStore, request: Box<dyn TrainingRequest>, fragment_ids: Option<Vec<u32>>, ) -> Pin<Box<dyn Future<Output = Result<CreatedIndex>> + Send + 'async_trait>>

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

Train a new index

The provided data must fulfill all the criteria returned by training_criteria. It is the caller’s responsibility to ensure this.

Returns index details that describe the index. These details can potentially be useful for planning (although this will currently require inside information on the index type) and they will need to be provided when loading the index.

It is the caller’s responsibility to store these details somewhere.

fn load_index<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, index_store: Arc<dyn IndexStore>, _index_details: &'life1 Any, frag_reuse_index: Option<Arc<FragReuseIndex>>, cache: &'life2 LanceCache, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn ScalarIndex>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Load an index from storage

The index details should match the details that were returned when the index was originally trained.

fn name(&self) -> &str

A short name for the index

fn new_training_request( &self, params: &str, field: &Field, ) -> Result<Box<dyn TrainingRequest>>

Creates a new training request from the given parameters

fn provides_exact_answer(&self) -> bool

Returns true if the index returns an exact answer (e.g. not AtMost)

fn version(&self) -> u32

The version of the index plugin

fn new_query_parser( &self, index_name: String, _index_details: &Any, ) -> Option<Box<dyn ScalarQueryParser>>

Returns a new query parser for the index

fn details_as_json(&self, details: &Any) -> Result<Value>

Returns a JSON string representation of the provided index details

fn attach_registry(&self, _registry: Arc<IndexPluginRegistry>)

Optional hook that plugins can use if they need to be aware of the registry