kglite 0.17.12

Pure-Rust embedded Cypher knowledge graph engine with in-memory, mmap, and disk storage, and agent-facing schema introspection
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! Shared optional metric/exact-policy parsing for scalar and indexed scoring.

use crate::datatypes::values::Value;
use crate::graph::algorithms::vector::DistanceMetric;

#[derive(Default)]
pub(super) struct VectorOptions {
    pub(super) metric: Option<DistanceMetric>,
    pub(super) exact: bool,
}

fn metric(name: &str) -> Result<DistanceMetric, String> {
    DistanceMetric::from_name(name).ok_or_else(|| {
        format!("vector_score(): unknown metric '{name}'. Use 'cosine', 'dot_product', 'euclidean', or 'poincare'.")
    })
}

fn exact(value: &Value) -> Result<bool, String> {
    let Value::Map(options) = value else {
        return Err(
            "vector_score(): options must be a map containing an optional boolean 'exact'".into(),
        );
    };
    let mut exact = false;
    for (key, value) in options.iter() {
        if key != "exact" {
            return Err(format!(
                "vector_score(): unknown options key '{key}'; use 'exact'"
            ));
        }
        let Value::Boolean(requested) = value else {
            return Err("vector_score(): options 'exact' must be a boolean".into());
        };
        exact = *requested;
    }
    Ok(exact)
}

pub(super) fn parse(tail: &[Value]) -> Result<VectorOptions, String> {
    match tail {
        [] => Ok(VectorOptions::default()),
        [Value::String(name)] => Ok(VectorOptions {
            metric: Some(metric(name)?),
            exact: false,
        }),
        [value @ Value::Map(_)] => Ok(VectorOptions {
            metric: None,
            exact: exact(value)?,
        }),
        // Existing non-string fourth metric arguments selected cosine. Keep
        // that behavior while giving maps their new explicit options meaning.
        [_] => Ok(VectorOptions {
            metric: Some(DistanceMetric::Cosine),
            exact: false,
        }),
        [Value::String(name), options] => Ok(VectorOptions {
            metric: Some(metric(name)?),
            exact: exact(options)?,
        }),
        _ => Err("vector_score(): expected (node, property, query [, metric] [, options])".into()),
    }
}