Skip to main content

Crate use_vector_store

Crate use_vector_store 

Source
Expand description

§use-vector-store

Vector-store and embedding modeling primitives for RustUse.

§Experimental

use-vector-store is experimental while use-nosql remains below 0.3.0.

§Example

use use_vector_store::{Embedding, SimilarityMetric, VectorDimension, VectorId, VectorRecord};

let record = VectorRecord::new(VectorId::new("review_1"), Embedding::new(vec![0.1, 0.2]))
    .with_dimension(VectorDimension::new(2))?
    .with_similarity_metric(SimilarityMetric::Cosine);

assert_eq!(record.dimension(), Some(VectorDimension::new(2)));

§Scope

  • Vector identifiers, embeddings, dimensions, similarity metrics, metadata, and records.
  • Dimension consistency validation.

§Non-goals

  • Qdrant, Pinecone, Weaviate, or other vector database clients.
  • Approximate nearest-neighbor indexes.
  • Embedding generation.

§License

Licensed under either Apache-2.0 or MIT.

Structs§

Embedding
A vector embedding payload.
InvalidDimensionError
Error returned when a vector dimension does not match its embedding.
VectorCollectionName
A vector collection name.
VectorDimension
A vector dimension count.
VectorId
A vector record identifier.
VectorMetadata
String metadata attached to a vector record.
VectorRecord
A vector store record.

Enums§

SimilarityMetric
Similarity metric labels used by vector stores.