Struct Point 

pub struct Point {
    pub id: PointId,
    pub vector: Vec<f32>,
    pub payload: JsonObject,
}

A vector and its optional JSON payload, identified by a typed ID.

Fields

id: PointId

The stable typed identifier for this point.

vector: Vec<f32>

The vector components, whose length must match the collection dimension.

payload: JsonObject

Application-defined metadata used by filters and optional result output.

Implementations

impl Point

pub fn new( id: impl Into<PointId>, vector: impl IntoIterator<Item = f32>, ) -> Self

Creates a point with an empty payload.

Examples found in repository

examples/persistence.rs (line 8)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let path = temporary.path().join("vectors.git");
    open(&path)?
        .collection("docs")
        .upsert([Point::new("stable-id", [1.0, 0.0])])?;
    assert_eq!(open(&path)?.collection("docs").count()?, 1);
    Ok(())
}

examples/history.rs (line 6)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let docs = open(temporary.path().join("vectors.git"))?.collection("docs");
    docs.upsert([Point::new("v1", [1.0, 0.0])])?;
    docs.upsert([Point::new("v2", [0.0, 1.0])])?;
    assert_eq!(docs.advanced()?.history(10)?.len(), 3);
    Ok(())
}

examples/quickstart.rs (line 8)

fn main() -> git_vdb::Result<()> {
    let temporary = tempfile::TempDir::new()?;
    let db = open(temporary.path().join("vectors.git"))?;
    let docs = db.collection("docs");
    docs.upsert([
        Point::new("east", [1.0, 0.0]),
        Point::new("north", [0.0, 1.0]),
    ])?;
    let hits = docs.search([0.9, 0.1], 1)?;
    assert_eq!(hits[0].id.to_string(), "east");
    Ok(())
}

examples/filtering.rs (line 8)

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, payload: JsonObject) -> Self

Replaces the point payload and returns the updated point.

pub fn with_metadata(self, metadata: impl Serialize) -> Result<Self>

Serializes object-shaped metadata as the point payload.

Arrays, scalars, and null are rejected because persisted point payloads are always JSON objects.

Examples found in repository

examples/filtering.rs (line 8)

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(())
}

Trait Implementations

impl Clone for Point

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 Point

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Point

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Point

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Point

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 Point