Struct QueryRequest

pub struct QueryRequest {
    pub namespace: Option<String>,
    pub top_k: usize,
    pub filter: Option<BTreeMap<String, Value>>,
    pub include_values: bool,
    pub include_metadata: bool,
    pub vector: Option<Vec<f32>>,
    pub sparse_vector: Option<SparseValues>,
    pub id: Option<String>,
}

Data type detailing the search of a namespace using a query vector.

Fields

namespace: Option<String>

The namespace to query.

top_k: usize

Number of values to search for. This number cannot be 0 or negative.

filter: Option<BTreeMap<String, Value>>

The filter to apply. You can use vector metadata to limit your search. See Metadat Filtering

include_values: bool

Whether vector values should be included in the response

include_metadata: bool

Whether metadata should be included in the response

vector: Option<Vec<f32>>

Vector value if include_values was true

sparse_vector: Option<SparseValues>

Vector Sparse Data.

id: Option<String>

The unique id of the vector to be used as a query vector.

Trait Implementations

impl Clone for QueryRequest

fn clone(&self) -> QueryRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryRequest

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

Formats the value using the given formatter.

impl Default for QueryRequest

fn default() -> QueryRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.