Struct VectorIndex 

pub struct VectorIndex {
    pub name: String,
    pub property: NamedNode,
    pub dimensions: u32,
    pub metric: Metric,
    pub element_type: ElementType,
    pub class: Option<NamedNode>,
}

A vector index definition.

Fields

name: String

property: NamedNode

The property whose literal values are embeddings ("[0.1, 0.2, …]").

dimensions: u32

metric: Metric

element_type: ElementType

class: Option<NamedNode>

Only instances of this class are candidates.

Implementations

impl VectorIndex

pub fn new( name: impl Into<String>, property: NamedNode, dimensions: u32, ) -> Self

A cosine, 32-bit float index.

pub fn metric(self, metric: Metric) -> Self

pub fn element_type(self, element_type: ElementType) -> Self

pub fn class(self, class: NamedNode) -> Self

pub fn validate(&self) -> Result<()>

Checks the name, the dimensions and the metric/element-type combination.

pub fn iri(&self) -> NamedNode

<oxilite:vector/NAME>.

pub fn table(&self) -> String

The table holding the embeddings (lower case: SQLite names ignore case).

pub fn fingerprint(&self) -> String

Everything the built table depends on.

pub fn to_quads(&self) -> Vec<Quad>

The definition as quads of <oxilite:vectors>.

pub fn create_statements(&self, caps: &Capabilities) -> Result<Vec<Statement>>

Statements creating the table, its triggers (and IVF index), back-filling it and recording its fingerprint. Run them in one atomic request: a malformed existing value aborts the back-fill, and with it the whole creation.

pub fn knn_sql(&self, query: &QueryVector, k: u64) -> Result<String>

The nearest-neighbour statement for this index (see knn_sql).

Trait Implementations

impl Clone for VectorIndex

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorIndex

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

Formats the value using the given formatter.

impl Eq for VectorIndex

impl PartialEq for VectorIndex

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for VectorIndex