Struct google_api_proto::google::firestore::v1::structured_query::FindNearest

pub struct FindNearest {
    pub vector_field: Option<FieldReference>,
    pub query_vector: Option<Value>,
    pub distance_measure: i32,
    pub limit: Option<i32>,
    pub distance_result_field: String,
    pub distance_threshold: Option<f64>,
}

Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.

Fields

vector_field: Option<FieldReference>

Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

query_vector: Option<Value>

Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

distance_measure: i32

Required. The distance measure to use, required.

limit: Option<i32>

Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.

distance_result_field: String

Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to [document field name][google.firestore.v1.Document.fields] limitations.

distance_threshold: Option<f64>

Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified distance_measure will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted.

For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold

Implementations

impl FindNearest

pub fn distance_measure(&self) -> DistanceMeasure

Returns the enum value of distance_measure, or the default if the field is set to an invalid enum value.

pub fn set_distance_measure(&mut self, value: DistanceMeasure)

Sets distance_measure to the provided enum value.

Trait Implementations

impl Clone for FindNearest

fn clone(&self) -> FindNearest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FindNearest

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

Formats the value using the given formatter.

impl Default for FindNearest

fn default() -> Self

Returns the “default value” for a type.

impl Message for FindNearest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FindNearest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FindNearest