Struct VectorStoreSearchRequest

pub struct VectorStoreSearchRequest {
    pub query: VectorStoreSearchRequestQuery,
    pub rewrite_query: Option<bool>,
    pub max_num_results: Option<u64>,
    pub filters: Option<VectorStoreSearchRequestFilters>,
    pub ranking_options: Option<VectorStoreSearchRequestRankingOptions>,
}

Fields

query: VectorStoreSearchRequestQuery

A query string for a search

rewrite_query: Option<bool>

Whether to rewrite the natural language query for vector search.

max_num_results: Option<u64>

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

filters: Option<VectorStoreSearchRequestFilters>

A filter to apply based on file attributes.

ranking_options: Option<VectorStoreSearchRequestRankingOptions>

Ranking options for search.

Implementations

impl VectorStoreSearchRequest

pub fn builder() -> VectorStoreSearchRequestBuilder<((), (), (), (), ())>

Create a builder for building VectorStoreSearchRequest. On the builder, call .query(...), .rewrite_query(...)(optional), .max_num_results(...)(optional), .filters(...)(optional), .ranking_options(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of VectorStoreSearchRequest.

Trait Implementations

impl Clone for VectorStoreSearchRequest

fn clone(&self) -> VectorStoreSearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorStoreSearchRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VectorStoreSearchRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VectorStoreSearchRequest

fn eq(&self, other: &VectorStoreSearchRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for VectorStoreSearchRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VectorStoreSearchRequest