@lotics/cli 0.152.0 → 0.152.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/knowledge_docs.md +11 -5
- package/package.json +1 -1
package/docs/knowledge_docs.md
CHANGED
|
@@ -30,18 +30,24 @@ lotics knowledge create --name "Shipping tariffs" \
|
|
|
30
30
|
|
|
31
31
|
This reads the body from your filesystem and creates the doc through `create_knowledge`
|
|
32
32
|
(prints the new id). A raw `lotics run create_knowledge @doc.json` works too — read a large
|
|
33
|
-
`content` from a file or stdin.
|
|
33
|
+
`content` from a file or stdin. `create_knowledge` takes five fields, three of them required:
|
|
34
34
|
|
|
35
|
-
- `name` — what it is.
|
|
35
|
+
- `name` — what it is. Just the name: **grouping belongs in `tags`, not in a prefix baked into
|
|
36
|
+
every title.**
|
|
36
37
|
- `description` — what the doc is **and what to grep it for**: its vocabulary and the synonyms
|
|
37
38
|
an ambiguous query would use. Surfaced in the tree before any body is read, and truncated at
|
|
38
39
|
200 characters. See *Write for grep* below.
|
|
39
40
|
- `content` — Markdown.
|
|
41
|
+
- `tags` *(optional)* — the labels someone would filter by, e.g. `["Hồ sơ NOXH", "Khoản 13"]`.
|
|
42
|
+
Give **every** one that is true of the doc, not just the main one — a corpus is narrowed by
|
|
43
|
+
intersecting tags, so a doc carrying one label can only ever be found down one path. On
|
|
44
|
+
`update_knowledge` the array **replaces** what is stored, so resend the labels it should keep.
|
|
45
|
+
- `files` *(optional)* — file ids of the source `.docx`/`.pdf`/`.xlsx` the doc was built from,
|
|
46
|
+
stored alongside it so a reader can open the original. The body stays the searchable text.
|
|
40
47
|
|
|
41
48
|
A new doc is created **owned by you, active in your own agent context, and private** — no one
|
|
42
|
-
else can see it yet.
|
|
43
|
-
|
|
44
|
-
tool.)
|
|
49
|
+
else can see it yet. Changing a doc's default-active state is done through the web app / REST
|
|
50
|
+
surface, not this tool.
|
|
45
51
|
|
|
46
52
|
## Access vs. activation — both are required
|
|
47
53
|
|