Struct SearchRequest 

pub struct SearchRequest {
    pub query: String,
    pub source: DocumentsSource,
    pub instructions: Option<String>,
    pub limit: Option<i32>,
    pub ranking_metric: Option<RankingMetric>,
    pub retrieval_mode: Option<RetrievalMode>,
}

SearchRequest defines the request to search for documents.

Fields

query: String

The query to search for which will be embedded using the same embedding model as the one used for the source to query.

source: DocumentsSource

The source to query.

instructions: Option<String>

User-defined instructions to be included in the search query.

limit: Option<i32>

The number of chunks to return. Defaults to 10.

ranking_metric: Option<RankingMetric>

Deprecated: Metric now comes from collection creation.

retrieval_mode: Option<RetrievalMode>

How to perform the document search. Defaults to hybrid retrieval.

Trait Implementations

impl Clone for SearchRequest

fn clone(&self) -> SearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchRequest

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

Formats the value using the given formatter.

impl Default for SearchRequest

fn default() -> SearchRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchRequest

fn eq(&self, other: &SearchRequest) -> 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 SearchRequest

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 SearchRequest