Struct VectorStoreSearchRequestArgs

pub struct VectorStoreSearchRequestArgs { /* private fields */ }

Builder for VectorStoreSearchRequest.

Implementations

impl VectorStoreSearchRequestArgs

pub fn query<VALUE: Into<VectorStoreSearchQuery>>( &mut self, value: VALUE, ) -> &mut Self

A query string for a search.

pub fn rewrite_query<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether to rewrite the natural language query for vector search.

pub fn max_num_results<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

The maximum number of results to return. This number should be between 1 and 50 inclusive.

pub fn filters<VALUE: Into<VectorStoreSearchFilter>>( &mut self, value: VALUE, ) -> &mut Self

A filter to apply based on file attributes.

pub fn ranking_options<VALUE: Into<RankingOptions>>( &mut self, value: VALUE, ) -> &mut Self

Ranking options for search.

pub fn build(&self) -> Result<VectorStoreSearchRequest, OpenAIError>

Builds a new VectorStoreSearchRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for VectorStoreSearchRequestArgs

fn clone(&self) -> VectorStoreSearchRequestArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorStoreSearchRequestArgs

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

Formats the value using the given formatter.

impl Default for VectorStoreSearchRequestArgs

fn default() -> Self

Returns the “default value” for a type.