Struct QueryPointGroupsBuilder

pub struct QueryPointGroupsBuilder { /* private fields */ }

Builder for QueryPointGroups.

Implementations

impl QueryPointGroupsBuilder

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

Name of the collection

pub fn prefetch<VALUE: Into<Vec<PrefetchQuery>>>(self, value: VALUE) -> Self

Sub-requests to perform first. If present, the query will be performed on the results of the prefetches.

pub fn query<VALUE: Into<Query>>(self, value: VALUE) -> Self

Query to perform. If missing, returns points ordered by their IDs.

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

Define which vector to use for querying. If missing, the default vector is used.

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

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

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

Search params for when there is no prefetch.

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

Return points with scores better than this threshold.

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

Options for specifying which payload to include or not

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

Options for specifying which vectors to include into response

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

The location to use for IDs lookup, if not specified - use the current collection and the ‘using’ vector

pub fn limit<VALUE: Into<u64>>(self, value: VALUE) -> Self

Max number of points. Default is 3.

pub fn group_size<VALUE: Into<u64>>(self, value: VALUE) -> Self

Maximum amount of points to return per group. Default to 10.

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 read_consistency<VALUE: Into<ReadConsistency>>( 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 timeout<VALUE: Into<u64>>(self, value: VALUE) -> 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 QueryPointGroupsBuilder

pub fn build(self) -> QueryPointGroups

Builds the desired type. Can often be omitted.

impl QueryPointGroupsBuilder

pub fn new( collection_name: impl Into<String>, group_by: impl Into<String>, ) -> QueryPointGroupsBuilder

impl QueryPointGroupsBuilder

pub fn add_prefetch(self, prefetch_query: impl Into<PrefetchQuery>) -> Self

Trait Implementations

impl From<QueryPointGroupsBuilder> for QueryPointGroups

fn from(value: QueryPointGroupsBuilder) -> Self

Converts to this type from the input type.