Struct Embedding

pub struct Embedding {
    pub values: Vec<f32>,
    pub metadata: HashMap<String, Value>,
}

A text embedding

Fields

values: Vec<f32>

The embedding vector

metadata: HashMap<String, Value>

Metadata about the embedding

Implementations

impl Embedding

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

Create a new embedding

pub fn new_with_metadata( values: Vec<f32>, metadata: HashMap<String, Value>, ) -> Self

Create a new embedding with metadata

pub fn dimension(&self) -> usize

Get the dimension of the embedding

pub fn cosine_similarity(&self, other: &Embedding) -> f32

Calculate cosine similarity with another embedding

pub fn euclidean_distance(&self, other: &Embedding) -> f32

Calculate Euclidean distance to another embedding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Embedding

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serializable for Embedding

fn namespace() -> Vec<String>

Get the namespace for this serializable object

fn is_serializable() -> bool

Check if this object is serializable

fn to_json(&self) -> Result<String>

Serialize this object to JSON

fn to_json_pretty(&self) -> Result<String>

Serialize this object to a pretty-printed JSON string

fn from_json(json: &str) -> Result<Self>

where Self: Sized,

Deserialize this object from JSON

fn to_dict(&self) -> Result<HashMap<String, Value>>

Serialize this object to a dictionary (HashMap)

fn from_dict(dict: &HashMap<String, Value>) -> Result<Self>

where Self: Sized,

Deserialize this object from a dictionary (HashMap)

fn type_name() -> &'static str

Get the type name for this serializable object

impl Serialize for Embedding

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 Embedding