Struct EmbeddingKey 

pub struct EmbeddingKey {
    pub model: Box<str>,
    pub revision: Box<str>,
    pub dims: u32,
    pub metric: DistanceMetric,
    pub dtype: VectorDType,
    pub norm: VectorNorm,
}

Identifies an embedding space (model + revision + dims + metric + dtype + norm).

Used for selecting vector store collections, caching, and embedding migration routing. canonical_bytes() produces a stable hash for deduplication.

Fields

model: Box<str>

Provider/model name (e.g., “bge-small-en-v1.5”).

revision: Box<str>

Provider-specific revision (semver, date tag, or commit hash).

dims: u32

Vector dimensionality.

metric: DistanceMetric

Distance metric for similarity.

dtype: VectorDType

Element data type.

norm: VectorNorm

Normalization state.

Implementations

impl EmbeddingKey

pub fn new( model: impl Into<Box<str>>, revision: impl Into<Box<str>>, dims: u32, metric: DistanceMetric, dtype: VectorDType, norm: VectorNorm, ) -> Self

Create a new EmbeddingKey.

pub fn canonical_bytes(&self) -> Vec<u8>

Returns canonical bytes for deterministic hashing.

Format:

• model (4-byte big-endian length prefix + UTF-8 bytes)
• revision (4-byte big-endian length prefix + UTF-8 bytes)
• dims (4 bytes, big-endian)
• metric (1 byte)
• dtype (1 byte)
• norm (1 byte)

Trait Implementations

impl Clone for EmbeddingKey

fn clone(&self) -> EmbeddingKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmbeddingKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for EmbeddingKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EmbeddingKey

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EmbeddingKey

impl StructuralPartialEq for EmbeddingKey