Struct QueryPointsBuilder

pub struct QueryPointsBuilder { /* private fields */ }

Builder for QueryPoints.

Implementations

impl QueryPointsBuilder

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 limit(self, value: u64) -> Self

Max number of points. Default is 10.

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

Offset of the result. Skip this many points. Default is 0.

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

Options for specifying which vectors to include into the response.

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

Options for specifying which payload to include or not.

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

Options for specifying read consistency guarantees.

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.

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 timeout(self, value: u64) -> Self

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

impl QueryPointsBuilder

pub fn build(self) -> QueryPoints

Builds the desired type. Can often be omitted.

impl QueryPointsBuilder

pub fn new(collection_name: impl Into<String>) -> Self

impl QueryPointsBuilder

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

Trait Implementations

impl From<QueryPointsBuilder> for QueryPoints

fn from(value: QueryPointsBuilder) -> Self

Converts to this type from the input type.