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

//! Search and metadata query service.
//!
//! Provides full-text search with filtering and structured metadata queries.

use std::collections::HashMap;

use crate::model::document::{MetadataQueryResponse, SearchResponse};
use crate::service::OkcService;

impl OkcService {
    /// Full-text search across indexed documents.
    ///
    /// - `query`: Search query string (FTS5 syntax supported)
    /// - `path_prefix`: Optional path prefix to restrict search scope
    /// - `types`: Optional concept types to filter by
    /// - `tags`: Optional tags to filter by
    /// - `limit`: Maximum results to return
    pub fn search(
        &self,
        query: &str,
        path_prefix: Option<&str>,
        types: Option<&[String]>,
        tags: Option<&[String]>,
        limit: usize,
    ) -> Result<SearchResponse, anyhow::Error> {
        self.index.search(query, path_prefix, types, tags, limit)
    }

    /// Structured metadata query with filtering and projection.
    ///
    /// - `filters`: Key-value pairs to match against front-matter fields
    /// - `select`: Fields to return (empty = all default fields)
    /// - `limit`: Maximum rows to return
    pub fn query_metadata(
        &self,
        filters: &HashMap<String, serde_json::Value>,
        select: &[String],
        limit: usize,
    ) -> Result<MetadataQueryResponse, anyhow::Error> {
        self.index.query_metadata(filters, select, limit)
    }
}