hermes-core 1.8.54

Core async search engine library with WASM support
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
72
73
74
75
76
77
78
79
80
81

//! Binary dense vector query for Hamming distance search

use crate::dsl::Field;
use crate::segment::SegmentReader;

use super::VectorResultScorer;
use super::combiner::MultiValueCombiner;
use crate::query::traits::{CountFuture, Query, Scorer, ScorerFuture};

/// Binary dense vector query for Hamming distance similarity search
///
/// Uses brute-force XOR + popcount scoring. Score = 1.0 - hamming/dim_bits.
#[derive(Debug, Clone)]
pub struct BinaryDenseVectorQuery {
    /// Field containing the binary dense vectors
    pub field: Field,
    /// Query vector (packed bits, ceil(dim/8) bytes)
    pub vector: Vec<u8>,
    /// How to combine scores for multi-valued documents
    pub combiner: MultiValueCombiner,
}

impl std::fmt::Display for BinaryDenseVectorQuery {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "BinaryDense({}, bytes={})",
            self.field.0,
            self.vector.len(),
        )
    }
}

impl BinaryDenseVectorQuery {
    pub fn new(field: Field, vector: Vec<u8>) -> Self {
        Self {
            field,
            vector,
            combiner: MultiValueCombiner::Max,
        }
    }

    pub fn with_combiner(mut self, combiner: MultiValueCombiner) -> Self {
        self.combiner = combiner;
        self
    }
}

impl Query for BinaryDenseVectorQuery {
    fn scorer<'a>(&self, reader: &'a SegmentReader, limit: usize) -> ScorerFuture<'a> {
        let field = self.field;
        let vector = self.vector.clone();
        let combiner = self.combiner;
        Box::pin(async move {
            let results = reader
                .search_binary_dense_vector(field, &vector, limit, combiner)
                .await?;

            Ok(Box::new(VectorResultScorer::new(results, field.0)) as Box<dyn Scorer>)
        })
    }

    #[cfg(feature = "sync")]
    fn scorer_sync<'a>(
        &self,
        reader: &'a SegmentReader,
        limit: usize,
    ) -> crate::Result<Box<dyn Scorer + 'a>> {
        let results = reader.search_binary_dense_vector_sync(
            self.field,
            &self.vector,
            limit,
            self.combiner,
        )?;
        Ok(Box::new(VectorResultScorer::new(results, self.field.0)) as Box<dyn Scorer>)
    }

    fn count_estimate<'a>(&self, _reader: &'a SegmentReader) -> CountFuture<'a> {
        Box::pin(async move { Ok(u32::MAX) })
    }
}