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

//! Graph traversal and link navigation service.
//!
//! Provides link graph operations: forward links, backlinks, and
//! multi-hop traversal with depth and node limits.

use crate::model::document::LinkInfo;
use crate::model::graph::TraverseResponse;
use crate::service::OkcService;

impl OkcService {
    /// Get forward links from a document.
    ///
    /// Returns all links originating from the given document with
    /// resolution status (exists in repo, external, broken).
    pub fn get_links(&self, path: &str) -> Result<Vec<LinkInfo>, anyhow::Error> {
        self.index.get_links(path)
    }

    /// Get backlinks to a document.
    ///
    /// Returns documents that link to the given path, limited by `limit`.
    pub fn get_backlinks(&self, path: &str, limit: usize) -> Result<Vec<LinkInfo>, anyhow::Error> {
        self.index.get_backlinks(path, limit)
    }

    /// Traverse the link graph from a starting document.
    ///
    /// - `relations`: Link relation types to follow (empty = all)
    /// - `max_depth`: Maximum hops from start
    /// - `max_nodes`: Maximum total nodes to visit
    pub fn traverse(
        &self,
        start: &str,
        relations: &[String],
        max_depth: usize,
        max_nodes: usize,
    ) -> Result<TraverseResponse, anyhow::Error> {
        self.index
            .traverse_graph(start, relations, max_depth, max_nodes)
    }
}