Struct DiscoverPointsBuilder

pub struct DiscoverPointsBuilder { /* private fields */ }

Builder for DiscoverPoints.

Implementations

impl DiscoverPointsBuilder

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

name of the collection

pub fn target<VALUE: Into<TargetVector>>(self, value: VALUE) -> Self

Use this as the primary search objective

pub fn context(self, value: Vec<ContextExamplePair>) -> Self

Search will be constrained by these pairs of examples

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: u64) -> Self

Max number of 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 offset(self, value: u64) -> Self

Offset of the result

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 read_consistency<VALUE: Into<Value>>(self, value: VALUE) -> Self

Options for specifying read consistency guarantees

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 DiscoverPointsBuilder

pub fn build(self) -> DiscoverPoints

Builds the desired type. Can often be omitted.

impl DiscoverPointsBuilder

pub fn new( collection_name: impl Into<String>, context: impl Into<Vec<ContextExamplePair>>, limit: u64, ) -> Self

Trait Implementations

impl From<DiscoverPointsBuilder> for DiscoverPoints

fn from(value: DiscoverPointsBuilder) -> Self

Converts to this type from the input type.