Struct VectorConfig 

pub struct VectorConfig {
    pub dimensions: u32,
    pub index_type: VectorIndexType,
    pub distance_metric: DistanceMetric,
}

Configuration for a vector field (pgvector).

This represents the configuration for a vector embedding field, including dimensions, index type, and distance metric.

Example

use fraiseql_core::schema::{VectorConfig, VectorIndexType, DistanceMetric};

let config = VectorConfig {
    dimensions: 1536,
    index_type: VectorIndexType::Hnsw,
    distance_metric: DistanceMetric::Cosine,
};

Fields

dimensions: u32

Number of dimensions in the vector (e.g., 1536 for OpenAI embeddings).

index_type: VectorIndexType

Type of index to use for similarity search.

distance_metric: DistanceMetric

Distance metric for similarity calculations.

Implementations

impl VectorConfig

pub fn new(dimensions: u32) -> Self

Create a new vector config with default index and distance metric.

pub fn openai() -> Self

Create a vector config for OpenAI embeddings (1536 dimensions, cosine).

pub fn openai_small() -> Self

Create a vector config for OpenAI small embeddings (512 dimensions, cosine).

pub fn with_index(self, index_type: VectorIndexType) -> Self

Set the index type.

pub fn with_distance(self, distance_metric: DistanceMetric) -> Self

Set the distance metric.

Trait Implementations

impl Clone for VectorConfig

fn clone(&self) -> VectorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorConfig

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

Formats the value using the given formatter.

impl Default for VectorConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VectorConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VectorConfig

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

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 VectorConfig