Struct Query 

pub struct Query {
    pub vector: Vec<f32>,
    pub limit: usize,
    pub filter: Option<Filter>,
    pub with_payload: bool,
    pub with_vector: bool,
    pub expected_vector_space: Option<String>,
    pub params: QueryParams,
}

A vector similarity query.

Fields

vector: Vec<f32>

Query vector, which must match the collection dimension.

limit: usize

Maximum number of scored points to return.

filter: Option<Filter>

Optional point filter applied before final ranking.

with_payload: bool

Whether returned winners include their JSON payloads.

with_vector: bool

Whether returned winners include their stored vectors.

expected_vector_space: Option<String>

Optional vector-space identity that must match collection metadata.

params: QueryParams

Exact or approximate execution controls.

Implementations

impl Query

pub fn new(vector: impl IntoIterator<Item = f32>, limit: usize) -> Self

Creates a query using collection defaults for exact or approximate mode.

Examples found in repository

examples/filtering.rs (line 12)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let docs = open(temporary.path().join("vectors.git"))?.collection("docs");
    docs.upsert([
        Point::new("guide", [1.0, 0.0]).with_metadata(json!({"kind": "docs"}))?,
        Point::new("code", [0.9, 0.1]).with_metadata(json!({"kind": "source"}))?,
    ])?;
    let result = docs.advanced()?.query(
        Query::new([1.0, 0.0], 5)
            .with_filter(Filter::must([Condition::matches("kind", "docs")]))
            .with_payload(),
    )?;
    assert_eq!(result.points[0].id.to_string(), "guide");
    Ok(())
}

pub fn exact(vector: impl IntoIterator<Item = f32>, limit: usize) -> Self

Creates a query that scores every eligible point.

pub fn approximate(vector: impl IntoIterator<Item = f32>, limit: usize) -> Self

Creates a query that uses deterministic approximate candidate discovery.

pub fn with_filter(self, filter: Filter) -> Self

Adds a point filter.

Examples found in repository

examples/filtering.rs (line 13)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let docs = open(temporary.path().join("vectors.git"))?.collection("docs");
    docs.upsert([
        Point::new("guide", [1.0, 0.0]).with_metadata(json!({"kind": "docs"}))?,
        Point::new("code", [0.9, 0.1]).with_metadata(json!({"kind": "source"}))?,
    ])?;
    let result = docs.advanced()?.query(
        Query::new([1.0, 0.0], 5)
            .with_filter(Filter::must([Condition::matches("kind", "docs")]))
            .with_payload(),
    )?;
    assert_eq!(result.points[0].id.to_string(), "guide");
    Ok(())
}

pub fn with_payload(self) -> Self

Requests payloads for returned winners.

Examples found in repository

examples/filtering.rs (line 14)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let docs = open(temporary.path().join("vectors.git"))?.collection("docs");
    docs.upsert([
        Point::new("guide", [1.0, 0.0]).with_metadata(json!({"kind": "docs"}))?,
        Point::new("code", [0.9, 0.1]).with_metadata(json!({"kind": "source"}))?,
    ])?;
    let result = docs.advanced()?.query(
        Query::new([1.0, 0.0], 5)
            .with_filter(Filter::must([Condition::matches("kind", "docs")]))
            .with_payload(),
    )?;
    assert_eq!(result.points[0].id.to_string(), "guide");
    Ok(())
}

pub fn with_vector(self) -> Self

Requests stored vectors for returned winners.

pub fn in_vector_space(self, vector_space: impl Into<String>) -> Self

Requires the collection to use the supplied vector-space identity.

pub fn with_params(self, params: QueryParams) -> Self

Replaces the exact or approximate execution parameters.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Query

where Query: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Query

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

where __S: Serializer,

Serialize this value into the given Serde serializer.