codanna 0.9.19

Code Intelligence for Large Language Models
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

//! Semantic search functionality for documentation comments
//!
//! This module provides a simple API for semantic search on documentation,
//! designed to integrate with the existing indexing system.

mod metadata;
mod pool;
pub(crate) mod remote;
mod simple;
mod storage;

pub use metadata::{EmbeddingBackendKind, SemanticMetadata};
pub use pool::{EmbeddingBackend, EmbeddingPool};
pub use remote::RemoteEmbedder;
pub use simple::{SemanticSearchError, SimpleSemanticSearch};
pub use storage::SemanticVectorStorage;

// Re-export key types
pub use fastembed::{EmbeddingModel, TextEmbedding};

/// Similarity threshold recommendations based on testing
pub mod thresholds {
    /// Threshold for very similar documents (e.g., same concept, different wording)
    pub const VERY_SIMILAR: f32 = 0.75;

    /// Threshold for similar documents (e.g., related concepts)
    pub const SIMILAR: f32 = 0.60;

    /// Threshold for somewhat related documents
    pub const RELATED: f32 = 0.40;

    /// Default threshold for semantic search
    pub const DEFAULT: f32 = SIMILAR;
}