okc 0.1.0

A local-first tool for AI agents to browse, parse, search, and reason over Open Knowledge Format (OKF) repositories
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

//! Query and search operations for RepositoryIndex.
//!
//! Public API: browse_directory, get_document, get_section, search,
//! query_metadata, get_recently_modified, get_stats.

pub mod browse;
pub mod document;
pub mod metadata;
pub mod stats;

use crate::index::traits::{SearchFilters, SearchIndex};
use crate::model::directory::{BrowseResponse, DirectoryDocument};
use crate::model::document::{
    DocumentDetail, DocumentMetadata, DocumentSummary, HeadingInfo, IndexStats,
    MetadataQueryResponse, ParseError, SearchResponse, SearchResult,
};

impl super::database::RepositoryIndex {
    /// Browse a directory in the knowledge base.
    pub fn browse_directory(
        &self,
        path: &str,
        depth: usize,
        limit: usize,
    ) -> Result<BrowseResponse, anyhow::Error> {
        browse::browse_directory(self, path, depth, limit)
    }

    /// Get a document by path with optional section inclusion and truncation.
    pub fn get_document(
        &self,
        doc_path: &str,
        include: &[String],
        max_body_chars: usize,
    ) -> Result<DocumentDetail, anyhow::Error> {
        document::get_document(self, doc_path, include, max_body_chars)
    }

    /// Get a specific section from a document by heading title or anchor slug.
    pub fn get_section(
        &self,
        doc_path: &str,
        heading: &str,
        max_chars: usize,
    ) -> Result<Option<(String, String)>, anyhow::Error> {
        document::get_section(self, doc_path, heading, max_chars)
    }

    /// Full-text search across indexed documents.
    pub fn search(
        &self,
        query: &str,
        path_prefix: Option<&str>,
        types: Option<&[String]>,
        tags: Option<&[String]>,
        limit: usize,
    ) -> Result<SearchResponse, anyhow::Error> {
        self.search_index.search(
            query,
            &SearchFilters {
                path_prefix: path_prefix.map(str::to_string),
                concept_types: types.map(<[String]>::to_vec),
                tags: tags.map(<[String]>::to_vec),
            },
            limit,
        )
    }

    /// Structured metadata query with filtering and projection.
    pub fn query_metadata(
        &self,
        filters: &std::collections::HashMap<String, serde_json::Value>,
        select: &[String],
        limit: usize,
    ) -> Result<MetadataQueryResponse, anyhow::Error> {
        metadata::query_metadata(self, filters, select, limit)
    }

    /// Get recently modified documents.
    pub fn get_recently_modified(
        &self,
        limit: usize,
    ) -> Result<Vec<DocumentSummary>, anyhow::Error> {
        stats::get_recently_modified(self, limit)
    }

    /// Get index statistics.
    pub fn get_stats(&self) -> Result<IndexStats, anyhow::Error> {
        stats::get_stats(self)
    }
}

fn slugify(text: &str) -> String {
    text.to_lowercase()
        .chars()
        .filter(|c| c.is_alphanumeric() || *c == ' ' || *c == '-' || *c == '_')
        .collect::<String>()
        .split_whitespace()
        .collect::<Vec<_>>()
        .join("-")
}