relay-knowledge 1.1.17

Graph-database-based knowledge graph project.
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

//! Local-file command specifications.

use super::{CliCommandSpec, CommandEffect, arg, command_syntax, opt};

pub(super) fn files_index() -> CliCommandSpec {
    command!(
        &["files", "index"],
        "relay-knowledge files index [--root <path>] [--source <scope>]",
        "Scan authorized local file roots into the file-location index.",
        "files.index",
        CommandEffect::WritesIndexes,
        &[],
        &[
            opt(
                "--root",
                Some("path"),
                false,
                true,
                "Absolute root to scan. Omit to scan configured roots.",
                None,
                &[],
            ),
            opt(
                "--source",
                Some("scope"),
                false,
                false,
                "Source scope assigned to explicit roots.",
                Some("local-files"),
                &[],
            ),
        ],
        &["relay-knowledge files index --root /opt/docs --source local-files --format json"],
        &["Configured roots are absolute paths controlled by RELAY_KNOWLEDGE_FILE_INDEX_ROOTS."],
    )
}

pub(super) fn files_query() -> CliCommandSpec {
    command!(
        &["files", "query"],
        "relay-knowledge files query <text> [--source <scope>] [--root <root-id>] [--freshness <policy>] [--limit <n>]",
        "Query the local file-location index.",
        "files.query",
        CommandEffect::ReadOnly,
        &[arg(
            "text",
            true,
            false,
            "File name, extension, directory, or path text.",
            None,
            &[],
        )],
        &[
            opt(
                "--source",
                Some("scope"),
                false,
                false,
                "Restricts results to one file source scope.",
                None,
                &[],
            ),
            opt(
                "--root",
                Some("root-id"),
                false,
                false,
                "Restricts results to one indexed root.",
                None,
                &[],
            ),
            opt(
                "--freshness",
                Some("policy"),
                false,
                false,
                "Controls file-index freshness.",
                Some("allow-stale"),
                &["allow-stale", "wait-until-fresh", "graph-only"],
            ),
            opt(
                "--limit",
                Some("n"),
                false,
                false,
                "Maximum result count.",
                Some("20"),
                &[],
            ),
        ],
        &["relay-knowledge files query design pdf --source local-files --format json"],
        &["Queries are bounded by RELAY_KNOWLEDGE_FILE_QUERY_TIMEOUT_MS."],
    )
}

pub(super) fn files_content() -> CliCommandSpec {
    command!(
        &["files", "content"],
        "relay-knowledge files content <text> [--source <scope>] [--root <root-id>] [--freshness <policy>] [--limit <n>]",
        "Query the local file-content read model.",
        "files.content",
        CommandEffect::ReadOnly,
        &[arg(
            "text",
            true,
            false,
            "Text to search inside bounded, indexed file-content chunks.",
            None,
            &[],
        )],
        &[
            opt(
                "--source",
                Some("scope"),
                false,
                false,
                "Restricts results to one file source scope.",
                None,
                &[],
            ),
            opt(
                "--root",
                Some("root-id"),
                false,
                false,
                "Restricts results to one indexed root.",
                None,
                &[],
            ),
            opt(
                "--freshness",
                Some("policy"),
                false,
                false,
                "Controls file-index freshness.",
                Some("allow-stale"),
                &["allow-stale", "wait-until-fresh", "graph-only"],
            ),
            opt(
                "--limit",
                Some("n"),
                false,
                false,
                "Maximum result count.",
                Some("20"),
                &[],
            ),
        ],
        &["relay-knowledge files content database runbook --source local-files --format json"],
        &[
            "Content hits are returned as content_role=user_source with source path, span, fingerprint, and read-model freshness.",
        ],
    )
}