hyphae-retrieval 0.1.0

Exact provider-neutral vector retrieval with explicit abstention for Hyphae.
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
63
64
65
66
67
68
69
70
71

// SPDX-License-Identifier: Apache-2.0

//! Fixed-vector quality expectations for the provider-neutral reference path.

use hyphae_retrieval::{
    AbstentionReason, RetrievalLimits, RetrievalOutcome, RetrievalRequest, VectorRecord, retrieve,
};

#[test]
fn labeled_reference_vectors_have_perfect_top_one_accuracy()
-> Result<(), Box<dyn std::error::Error>> {
    let candidates = vec![
        VectorRecord::new(b"rust", vec![1.0, 0.0, 0.0]),
        VectorRecord::new(b"storage", vec![0.0, 1.0, 0.0]),
        VectorRecord::new(b"network", vec![0.0, 0.0, 1.0]),
        VectorRecord::new(b"rust-storage", vec![0.7, 0.7, 0.0]),
    ];
    let cases = [
        (vec![1.0, 0.0, 0.0], b"rust".as_slice()),
        (vec![0.0, 1.0, 0.0], b"storage".as_slice()),
        (vec![0.0, 0.0, 1.0], b"network".as_slice()),
    ];
    let total = cases.len();
    let mut correct = 0_usize;
    for (query, expected) in cases {
        let outcome = retrieve(
            &[candidates.as_slice()],
            &RetrievalRequest {
                query,
                limit: 1,
                minimum_score: 0.5,
                minimum_margin: 0.05,
            },
            &RetrievalLimits::default(),
        )?;
        let RetrievalOutcome::Matches { matches, .. } = outcome else {
            return Err("labeled query unexpectedly abstained".into());
        };
        if matches[0].key == expected {
            correct += 1;
        }
    }
    assert_eq!(correct, total);
    Ok(())
}

#[test]
fn intentionally_ambiguous_reference_vector_abstains() -> Result<(), Box<dyn std::error::Error>> {
    let candidates = vec![
        VectorRecord::new(b"left", vec![1.0, 0.0]),
        VectorRecord::new(b"right", vec![0.0, 1.0]),
    ];
    let outcome = retrieve(
        &[candidates.as_slice()],
        &RetrievalRequest {
            query: vec![1.0, 1.0],
            limit: 2,
            minimum_score: 0.5,
            minimum_margin: 0.01,
        },
        &RetrievalLimits::default(),
    )?;
    assert!(matches!(
        outcome,
        RetrievalOutcome::Abstained(hyphae_retrieval::Abstention {
            reason: AbstentionReason::Ambiguous,
            ..
        })
    ));
    Ok(())
}