Struct VSimOptions 

pub struct VSimOptions<'a> { /* private fields */ }

Options for the vsim command.

Implementations

impl<'a> VSimOptions<'a>

pub fn with_scores(self) -> Self

returns the similarity score (from 1 to 0) alongside each result. A score of 1 is identical; 0 is the opposite.

pub fn with_attributes(self) -> Self

returns, for each element, the JSON attribute associated with the element or NULL when no attributes are present.

pub fn count(self, num: u32) -> Self

Limits the number of returned results to num.

pub fn epsilon(self, delta: f32) -> Self

is a floating point number between 0 and 1. It is used to retrieve elements that have a distance that is no further than the specified delta. In vector sets, returned elements have a similarity score (when compared to the query vector) that is between 1 and 0, where 1 means identical and 0 means opposite vectors. For example, if the EPSILON option is specified with an argument of 0.2, it means only elements that have a similarity of 0.8 or better (a distance < 0.2) are returned. This is useful when you specify a large COUNT, but you don’t want elements that are too far away from the query vector.

pub fn ef(self, search_exploration_factor: u32) -> Self

Controls the search effort.

Higher values explore more nodes, improving recall at the cost of speed. Typical values range from 50 to 1000.

pub fn filter(self, expression: &'a str) -> Self

Applies a filter expression to restrict matching elements. See the filtered search section for syntax details.

pub fn filter_ef(self, max_filtering_effort: u32) -> Self

Limits the number of filtering attempts for the FILTER expression.

See the filtered search section for more.

pub fn truth(self) -> Self

Forces an exact linear scan of all elements, bypassing the HNSW graph.

Use for benchmarking or to calculate recall. This is significantly slower (O(N)).

pub fn no_thread(self) -> Self

Executes the search in the main thread instead of a background thread.

Useful for small vector sets or benchmarks. This may block the server during execution.

Trait Implementations

impl<'a> Default for VSimOptions<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Serialize for VSimOptions<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.