Skip to main content

VectorSearchPlugin

Struct VectorSearchPlugin 

Source
pub struct VectorSearchPlugin { /* private fields */ }

Implementations§

Source§

impl VectorSearchPlugin

Source

pub fn new() -> Self

Source

pub fn with_persist_path(self, path: impl Into<PathBuf>) -> Self

Persist the index to disk on every write. Useful for restart safety. Loads existing data from path if it exists.

Source

pub fn index( &self, entity: &str, row_id: &str, vector: Vec<f32>, metadata: Option<Value>, )

Upsert a vector for (entity, row_id).

Source

pub fn search( &self, query: &[f32], k: usize, entity_filter: Option<&str>, ) -> Vec<VectorHit>

Find the k most similar vectors. Optionally restrict to one entity.

Source

pub fn len(&self) -> usize

Number of indexed vectors.

Source

pub fn is_empty(&self) -> bool

True when the index is empty.

Trait Implementations§

Source§

impl Default for VectorSearchPlugin

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Plugin for VectorSearchPlugin

Source§

fn name(&self) -> &str

Unique name for this plugin.
Source§

fn after_delete(&self, entity: &str, id: &str, _auth: &AuthContext)

Called after a successful delete.
Source§

fn on_init(&self, _ctx: &PluginContext)

Called once when the plugin is registered.
Source§

fn routes(&self) -> Vec<PluginRoute>

Custom API routes this plugin handles.
Source§

fn before_insert( &self, _entity: &str, _data: &mut Value, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity insert. Return Err to reject.
Source§

fn after_insert( &self, _entity: &str, _id: &str, _data: &Value, _auth: &AuthContext, )

Called after a successful insert.
Source§

fn before_update( &self, _entity: &str, _id: &str, _data: &mut Value, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity update. Return Err to reject.
Source§

fn after_update( &self, _entity: &str, _id: &str, _data: &Value, _auth: &AuthContext, )

Called after a successful update.
Source§

fn before_delete( &self, _entity: &str, _id: &str, _auth: &AuthContext, ) -> Result<(), PluginError>

Called before an entity delete. Return Err to reject.
Source§

fn on_request( &self, _method: &str, _path: &str, _auth: &AuthContext, ) -> Result<(), PluginError>

Called on every incoming request (middleware).
Source§

fn on_request_with_meta( &self, method: &str, path: &str, auth: &AuthContext, _meta: &RequestMeta<'_>, ) -> Result<(), PluginError>

Richer variant of [on_request] that also receives per-request metadata (peer IP today; more fields may be added later). The default implementation delegates to on_request so existing plugins keep working without changes. Plugins that care about IP — notably rate limiting — override this hook.
Source§

fn on_session_create(&self, _user_id: &str, _token: &str)

Called when a new session is created.
Source§

fn entities(&self) -> Vec<ManifestEntity>

Additional manifest entities this plugin contributes.

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, 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> 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