Struct RecommendPointGroups

pub struct RecommendPointGroups {

    pub collection_name: String,
    pub positive: Vec<PointId>,
    pub negative: Vec<PointId>,
    pub filter: Option<Filter>,
    pub limit: u32,
    pub with_payload: Option<WithPayloadSelector>,
    pub params: Option<SearchParams>,
    pub score_threshold: Option<f32>,
    pub using: Option<String>,
    pub with_vectors: Option<WithVectorsSelector>,
    pub lookup_from: Option<LookupLocation>,
    pub group_by: String,
    pub group_size: u32,
    pub read_consistency: Option<ReadConsistency>,
    pub with_lookup: Option<WithLookup>,
    pub strategy: Option<i32>,
    pub positive_vectors: Vec<Vector>,
    pub negative_vectors: Vec<Vector>,
    pub timeout: Option<u64>,
    pub shard_key_selector: Option<ShardKeySelector>,
}

Fields

collection_name: String

Name of the collection

positive: Vec<PointId>

Look for vectors closest to the vectors from these points

negative: Vec<PointId>

Try to avoid vectors like the vector from these points

filter: Option<Filter>

Filter conditions - return only those points that satisfy the specified conditions

limit: u32

Max number of groups in result

with_payload: Option<WithPayloadSelector>

Options for specifying which payload to include or not

params: Option<SearchParams>

Search config

score_threshold: Option<f32>

If provided - cut off results with worse scores

using: Option<String>

Define which vector to use for recommendation, if not specified - default vector

with_vectors: Option<WithVectorsSelector>

Options for specifying which vectors to include into response

lookup_from: Option<LookupLocation>

Name of the collection to use for points lookup, if not specified - use current collection

group_by: String

Payload field to group by, must be a string or number field. If there are multiple values for the field, all of them will be used. One point can be in multiple groups.

group_size: u32

Maximum amount of points to return per group

read_consistency: Option<ReadConsistency>

Options for specifying read consistency guarantees

with_lookup: Option<WithLookup>

Options for specifying how to use the group id to lookup points in another collection

strategy: Option<i32>

How to use the example vectors to find the results

positive_vectors: Vec<Vector>

Look for vectors closest to those

negative_vectors: Vec<Vector>

Try to avoid vectors like this

timeout: Option<u64>

If set, overrides global timeout setting for this request. Unit is seconds.

shard_key_selector: Option<ShardKeySelector>

Specify in which shards to look for the points, if not specified - look in all shards

Implementations

impl RecommendPointGroups

pub fn score_threshold(&self) -> f32

Returns the value of score_threshold, or the default value if score_threshold is unset.

pub fn using(&self) -> &str

Returns the value of using, or the default value if using is unset.

pub fn strategy(&self) -> RecommendStrategy

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

pub fn set_strategy(&mut self, value: RecommendStrategy)

Sets strategy to the provided enum value.

pub fn timeout(&self) -> u64

Returns the value of timeout, or the default value if timeout is unset.

Trait Implementations

impl Clone for RecommendPointGroups

fn clone(&self) -> RecommendPointGroups

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RecommendPointGroups

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

Formats the value using the given formatter.

impl Default for RecommendPointGroups

fn default() -> Self

Returns the “default value” for a type.

impl From<RecommendPointGroupsBuilder> for RecommendPointGroups

fn from(value: RecommendPointGroupsBuilder) -> Self

Converts to this type from the input type.

impl Message for RecommendPointGroups

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 RecommendPointGroups

fn eq(&self, other: &RecommendPointGroups) -> 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 StructuralPartialEq for RecommendPointGroups