Struct Embedding 

pub struct Embedding(/* private fields */);

A vector embedding payload.

Implementations

impl Embedding

pub fn new(values: Vec<f32>) -> Embedding

Creates an embedding from components.

Examples found in repository

examples/basic_usage.rs (line 24)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let collection = CollectionName::new("customers");
    let document_id = DocumentId::new("customer_123");
    let patch = PatchSet::new(vec![PatchOperation::set(
        DocumentPath::new("profile.display_name"),
        "Joshua Whalen",
    )]);

    let key = CacheKey::builder()
        .namespace(CacheNamespace::new("reviews"))
        .segment("google-business-profile")
        .segment("location")
        .segment("fort-wayne")
        .segment("summary")
        .build();

    let record = VectorRecord::new(
        VectorId::new("review_789_embedding"),
        Embedding::new(vec![0.012, -0.032, 0.481]),
    )
    .with_dimension(VectorDimension::new(3))?
    .with_similarity_metric(SimilarityMetric::Cosine);

    assert_eq!(collection.as_str(), "customers");
    assert_eq!(document_id.as_str(), "customer_123");
    assert_eq!(patch.operations().len(), 1);
    assert_eq!(
        key.to_string(),
        "reviews:google-business-profile:location:fort-wayne:summary"
    );
    assert_eq!(record.dimension(), Some(VectorDimension::new(3)));

    Ok(())
}

pub fn values(&self) -> &[f32]

Returns embedding components.

pub fn dimension(&self) -> VectorDimension

Returns the embedding dimension.

pub fn is_empty(&self) -> bool

Returns whether the embedding has no components.

Trait Implementations

impl Clone for Embedding

fn clone(&self) -> Embedding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Embedding

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

Formats the value using the given formatter.

impl Default for Embedding

fn default() -> Embedding

Returns the “default value” for a type.

impl PartialEq for Embedding

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