Struct VSimOptions

pub struct VSimOptions { /* private fields */ }

Available on crate feature vector-sets only.

Options for the VSIM command

Example

use redis::{Commands, RedisResult, VSimOptions};
fn search_similar_vectors(
    con: &mut redis::Connection,
    key: &str,
    element: &str,
) -> RedisResult<redis::Value> {
    let opts = VSimOptions::default()
        .set_with_scores(true)
        .set_count(10)
        .set_search_exploration_factor(100)
        .set_filter_expression(".size == \"large\"")
        .set_max_filtering_effort(10)
        .set_truth(true)
        .set_no_thread(true);
    con.vsim_options(key, redis::VectorSimilaritySearchInput::Element(element), &opts)
}

Implementations

impl VSimOptions

pub fn set_with_scores(self, enabled: bool) -> Self

Include similarity scores in the results

pub fn set_count(self, count: usize) -> Self

Limit the number of results returned

pub fn set_search_exploration_factor(self, factor: usize) -> Self

Set the search exploration factor

pub fn set_filter_expression<S: Into<String>>(self, expression: S) -> Self

Set a JSON filter expression

pub fn set_max_filtering_effort(self, effort: usize) -> Self

Set the maximum filtering effort

pub fn set_truth(self, enabled: bool) -> Self

Enable/disable exact linear scan of all elements

pub fn set_no_thread(self, enabled: bool) -> Self

Enable/disable multi-threading

Trait Implementations

impl Clone for VSimOptions

fn clone(&self) -> VSimOptions

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for VSimOptions

fn default() -> VSimOptions

Returns the “default value” for a type.

impl ToRedisArgs for VSimOptions

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

This writes the value into a vector of bytes. Each item is a single argument. Most items generate a single item.

fn to_redis_args(&self) -> Vec<Vec<u8>>

This converts the value into a vector of bytes. Each item is a single argument. Most items generate a vector of a single item.

fn describe_numeric_behavior(&self) -> NumericBehavior

Returns an information about the contained value with regards to it’s numeric behavior in a redis context. This is used in some high level concepts to switch between different implementations of redis functions (for instance INCR vs INCRBYFLOAT).

fn num_of_args(&self) -> usize

Returns the number of arguments this value will generate.