Struct RecommendPointGroupsBuilder

pub struct RecommendPointGroupsBuilder { /* private fields */ }

Builder for RecommendPointGroups.

Implementations

impl RecommendPointGroupsBuilder

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

Name of the collection

pub fn filter<VALUE: Into<Filter>>(self, value: VALUE) -> Self

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

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

Max number of groups in result

pub fn with_payload<VALUE: Into<SelectorOptions>>(self, value: VALUE) -> Self

Options for specifying which payload to include or not

pub fn params<VALUE: Into<SearchParams>>(self, value: VALUE) -> Self

Search config

pub fn score_threshold(self, value: f32) -> Self

If provided - cut off results with worse scores

pub fn using<VALUE: Into<String>>(self, value: VALUE) -> Self

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

pub fn with_vectors<VALUE: Into<SelectorOptions>>(self, value: VALUE) -> Self

Options for specifying which vectors to include into response

pub fn lookup_from<VALUE: Into<LookupLocation>>(self, value: VALUE) -> Self

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

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

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.

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

Maximum amount of points to return per group

pub fn read_consistency<VALUE: Into<Value>>(self, value: VALUE) -> Self

Options for specifying read consistency guarantees

pub fn with_lookup<VALUE: Into<WithLookup>>(self, value: VALUE) -> Self

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

pub fn strategy<VALUE: Into<i32>>(self, value: VALUE) -> Self

How to use the example vectors to find the results

pub fn timeout(self, value: u64) -> Self

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

pub fn shard_key_selector<VALUE: Into<ShardKeySelector>>( self, value: VALUE, ) -> Self

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

impl RecommendPointGroupsBuilder

pub fn build(self) -> RecommendPointGroups

Builds the desired type. Can often be omitted.

impl RecommendPointGroupsBuilder

pub fn new( collection_name: impl Into<String>, group_by: impl Into<String>, group_size: u32, limit: u32, ) -> Self

impl RecommendPointGroupsBuilder

pub fn add_positive( self, recommend_example: impl Into<RecommendExample>, ) -> Self

Look for vectors closest to the vectors from these points or vectors

pub fn add_negative( self, recommend_example: impl Into<RecommendExample>, ) -> Self

Try to avoid vectors like the vector from these points or vectors

Trait Implementations

impl From<RecommendPointGroupsBuilder> for RecommendPointGroups

fn from(value: RecommendPointGroupsBuilder) -> Self

Converts to this type from the input type.