Struct NearestNeighborQuery

#[non_exhaustive]
pub struct NearestNeighborQuery {
    pub neighbor_count: i32,
    pub string_filters: Vec<StringFilter>,
    pub numeric_filters: Vec<NumericFilter>,
    pub per_crowding_attribute_neighbor_count: i32,
    pub parameters: Option<Parameters>,
    pub instance: Option<Instance>,
    /* private fields */
}

A query to find a number of similar entities.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

neighbor_count: i32

Optional. The number of similar entities to be retrieved from feature view for each query.

string_filters: Vec<StringFilter>

Optional. The list of string filters.

numeric_filters: Vec<NumericFilter>

Optional. The list of numeric filters.

per_crowding_attribute_neighbor_count: i32

Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It’s used for improving result diversity.

parameters: Option<Parameters>

Optional. Parameters that can be set to tune query on the fly.

instance: Option<Instance>

Implementations

impl NearestNeighborQuery

pub fn new() -> Self

pub fn set_neighbor_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of neighbor_count.

pub fn set_string_filters<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<StringFilter>,

Sets the value of string_filters.

pub fn set_numeric_filters<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<NumericFilter>,

Sets the value of numeric_filters.

pub fn set_per_crowding_attribute_neighbor_count<T: Into<i32>>( self, v: T, ) -> Self

Sets the value of per_crowding_attribute_neighbor_count.

pub fn set_parameters<T: Into<Option<Parameters>>>(self, v: T) -> Self

Sets the value of parameters.

pub fn set_instance<T: Into<Option<Instance>>>(self, v: T) -> Self

Sets the value of instance.

Note that all the setters affecting instance are mutually exclusive.

pub fn entity_id(&self) -> Option<&String>

The value of instance if it holds a EntityId, None if the field is not set or holds a different branch.

pub fn set_entity_id<T: Into<String>>(self, v: T) -> Self

Sets the value of instance to hold a EntityId.

Note that all the setters affecting instance are mutually exclusive.

pub fn embedding(&self) -> Option<&Box<Embedding>>

The value of instance if it holds a Embedding, None if the field is not set or holds a different branch.

pub fn set_embedding<T: Into<Box<Embedding>>>(self, v: T) -> Self

Sets the value of instance to hold a Embedding.

Note that all the setters affecting instance are mutually exclusive.

Trait Implementations

impl Clone for NearestNeighborQuery

fn clone(&self) -> NearestNeighborQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NearestNeighborQuery

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

Formats the value using the given formatter.

impl Default for NearestNeighborQuery

fn default() -> NearestNeighborQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NearestNeighborQuery

where NearestNeighborQuery: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for NearestNeighborQuery

fn typename() -> &'static str

The typename of this message.

impl PartialEq for NearestNeighborQuery

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for NearestNeighborQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NearestNeighborQuery