Struct Embedding 

pub struct Embedding { /* private fields */ }

A dense vector embedding for use with pgvector.

This wraps pgvector::Vector and provides additional methods for ORM integration, validation, and conversion.

Examples

use prax_pgvector::Embedding;

// From a Vec<f32>
let embedding = Embedding::new(vec![0.1, 0.2, 0.3]);

// From a slice
let embedding = Embedding::from_slice(&[0.1, 0.2, 0.3]);

// Access dimensions
assert_eq!(embedding.len(), 3);
assert_eq!(embedding.as_slice()[0], 0.1);

Implementations

impl Embedding

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

Create a new embedding from a vector of floats.

pub fn from_slice(slice: &[f32]) -> Self

Create an embedding from a float slice.

pub fn zeros(dimensions: usize) -> Self

Create a zero vector with the given number of dimensions.

pub fn try_new(dimensions: Vec<f32>) -> VectorResult<Self>

Create a validated embedding, ensuring it’s non-empty.

Errors

Returns VectorError::EmptyVector if the input is empty.

pub fn validate_dimensions(&self, expected: usize) -> VectorResult<()>

Validate that this embedding has the expected number of dimensions.

Errors

Returns VectorError::DimensionMismatch if the dimensions don’t match.

pub fn len(&self) -> usize

Get the number of dimensions.

pub fn is_empty(&self) -> bool

Check if the vector is empty.

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

Get the dimensions as a slice.

pub fn to_vec(&self) -> Vec<f32>

Convert to a Vec<f32>.

pub fn into_inner(self) -> Vector

Get the inner pgvector type.

pub fn inner(&self) -> &Vector

Get a reference to the inner pgvector type.

pub fn l2_norm(&self) -> f32

Compute the L2 (Euclidean) norm of this vector.

pub fn normalize(&self) -> Option<Self>

Normalize this vector to unit length (L2 normalization).

Returns None if the vector is a zero vector.

pub fn dot_product(&self, other: &Self) -> VectorResult<f32>

Compute the dot product with another embedding.

Errors

Returns VectorError::DimensionMismatch if the dimensions differ.

pub fn cosine_similarity(&self, other: &Self) -> VectorResult<f32>

Compute the cosine similarity with another embedding.

Returns a value between -1.0 and 1.0.

Errors

Returns VectorError::DimensionMismatch if the dimensions differ.

pub fn l2_distance(&self, other: &Self) -> VectorResult<f32>

Compute the Euclidean (L2) distance to another embedding.

Errors

Returns VectorError::DimensionMismatch if the dimensions differ.

pub fn to_sql_literal(&self) -> String

Generate the PostgreSQL literal representation.

This produces a string like '[0.1,0.2,0.3]'::vector.

pub fn to_sql_literal_typed(&self) -> String

Generate the PostgreSQL literal with explicit dimension.

This produces a string like '[0.1,0.2,0.3]'::vector(3).

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

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

Formats the value using the given formatter.

impl From<&[f32]> for Embedding

fn from(s: &[f32]) -> Self

Converts to this type from the input type.

impl From<Embedding> for Vec<f32>

fn from(e: Embedding) -> Self

Converts to this type from the input type.

impl From<Embedding> for Vector

fn from(e: Embedding) -> Self

Converts to this type from the input type.

impl From<Vec<f32>> for Embedding

fn from(v: Vec<f32>) -> Self

Converts to this type from the input type.

impl From<Vector> for Embedding

fn from(v: Vector) -> Self

Converts to this type from the input 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 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