Skip to main content

Module model

Module model 

Source
Expand description

Public API types for the vector database (RFC 0002).

This module provides the user-facing types for writing vectors to the database. The API is designed to be simple and ergonomic while enforcing necessary constraints like dimension matching and metadata schema validation.

Re-exports§

pub use crate::serde::FieldType;
pub use crate::serde::collection_meta::DistanceMetric;

Structs§

Attribute
A metadata attribute attached to a vector.
Config
Configuration for a VectorDb instance.
MetadataFieldSpec
Metadata field specification for schema definition.
Query
Query specification for vector search.
ReaderConfig
Configuration for a read-only vector database client.
SearchResult
A search result with vector, score, and metadata.
Vector
A vector with its identifying ID, embedding values, and metadata.
VectorBuilder
Builder for constructing Vector instances with attributes.

Enums§

AttributeValue
Supported attribute value types.
FieldSelection
Specifies which fields to include in query results.
Filter
Metadata filter for search queries.

Constants§

VECTOR_FIELD_NAME
Reserved field name for the embedding vector stored as an AttributeValue::Vector.