Struct FirestoreFindNearestOptions 

pub struct FirestoreFindNearestOptions {
    pub field_name: String,
    pub query_vector: FirestoreVector,
    pub distance_measure: FirestoreFindNearestDistanceMeasure,
    pub neighbors_limit: u32,
    pub distance_result_field: Option<String>,
    pub distance_threshold: Option<f64>,
}

Re-exports all public items from the db module.

The db module contains the core FirestoreDb client and functionalities for interacting with the Firestore database, such as CRUD operations, queries, and transactions. Options for performing a vector similarity search (find nearest neighbors).

This is used to find documents whose vector field is closest to a given query vector.

Fields

field_name: String

The path to the vector field in your documents to search against.

query_vector: FirestoreVector

The query vector to find nearest neighbors for.

distance_measure: FirestoreFindNearestDistanceMeasure

The distance measure to use for comparing vectors.

neighbors_limit: u32

The maximum number of nearest neighbors to return.

distance_result_field: Option<String>

An optional field name to store the calculated distance in the query results. If provided, each returned document will include this field with the distance value.

distance_threshold: Option<f64>

An optional threshold for the distance. Only neighbors within this distance will be returned.

Implementations

impl FirestoreFindNearestOptions

pub fn new( field_name: String, query_vector: FirestoreVector, distance_measure: FirestoreFindNearestDistanceMeasure, neighbors_limit: u32, ) -> Self

pub fn field_name(&mut self, value: String) -> &mut Self

pub fn with_field_name(self, value: String) -> Self

pub fn query_vector(&mut self, value: FirestoreVector) -> &mut Self

pub fn with_query_vector(self, value: FirestoreVector) -> Self

pub fn distance_measure( &mut self, value: FirestoreFindNearestDistanceMeasure, ) -> &mut Self

pub fn with_distance_measure( self, value: FirestoreFindNearestDistanceMeasure, ) -> Self

pub fn neighbors_limit(&mut self, value: u32) -> &mut Self

pub fn with_neighbors_limit(self, value: u32) -> Self

pub fn distance_result_field(&mut self, value: String) -> &mut Self

pub fn reset_distance_result_field(&mut self) -> &mut Self

pub fn mopt_distance_result_field(&mut self, value: Option<String>) -> &mut Self

pub fn with_distance_result_field(self, value: String) -> Self

pub fn without_distance_result_field(self) -> Self

pub fn opt_distance_result_field(self, value: Option<String>) -> Self

pub fn distance_threshold(&mut self, value: f64) -> &mut Self

pub fn reset_distance_threshold(&mut self) -> &mut Self

pub fn mopt_distance_threshold(&mut self, value: Option<f64>) -> &mut Self

pub fn with_distance_threshold(self, value: f64) -> Self

pub fn without_distance_threshold(self) -> Self

pub fn opt_distance_threshold(self, value: Option<f64>) -> Self

Trait Implementations

impl Clone for FirestoreFindNearestOptions

fn clone(&self) -> FirestoreFindNearestOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirestoreFindNearestOptions

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

Formats the value using the given formatter.

impl From<FirestoreFindNearestOptionsInit> for FirestoreFindNearestOptions

fn from(value: FirestoreFindNearestOptionsInit) -> Self

Converts to this type from the input type.

impl PartialEq for FirestoreFindNearestOptions

fn eq(&self, other: &FirestoreFindNearestOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FirestoreFindNearestOptions

impl TryFrom<FirestoreFindNearestOptions> for FindNearest

type Error = FirestoreError

The type returned in the event of a conversion error.

fn try_from(options: FirestoreFindNearestOptions) -> Result<Self, Self::Error>

Performs the conversion.