@bendyline/gezel-knowledge 1.2.10 → 1.2.11

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.
Files changed (2) hide show
  1. package/README.md +10 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -8,8 +8,12 @@ personal reference and a 2,000,000-document Wikipedia-class corpus.
8
8
 
9
9
  ```bash
10
10
  npm install @bendyline/gezel-knowledge
11
+ # Building a catalog and semantic search also need the embedding runtime:
12
+ npm install @huggingface/transformers@^4.3.1
11
13
  ```
12
14
 
15
+ Reading a catalog and full-text search work without `@huggingface/transformers`.
16
+
13
17
  ## What a `.gezk` is
14
18
 
15
19
  An open format (format version 0.8, preliminary until format 1.0; 0.5–0.7
@@ -27,6 +31,11 @@ reader live in [bendyline/gezk](https://github.com/bendyline/gezk).
27
31
 
28
32
  ## Building a catalog
29
33
 
34
+ Building embeds every passage, so it needs `@huggingface/transformers`
35
+ (^4.3.1) installed beside this package. It is imported only when a build or a
36
+ semantic search starts, so everything else works without it. The first build
37
+ downloads the profile's embedding model (about 130 MB for `bge-small-en-v1.5`).
38
+
30
39
  ```ts
31
40
  import {
32
41
  BGE_SMALL_EN_V15_1,
@@ -63,9 +72,7 @@ await compileKnowledgeCatalog({
63
72
 
64
73
  Every archive ships a `README.md` and `LICENSES/catalog.txt`; the compiler
65
74
  generates minimal ones from the catalog block unless you pass richer texts in
66
- `extraFiles`. Embedding requires `@huggingface/transformers` (^4.3.1) at
67
- runtime; the module is imported dynamically so everything else works without
68
- it. The `gezel knowledge` CLI wraps this same API (`init`, `build`,
75
+ `extraFiles`. The `gezel knowledge` CLI wraps this same API (`init`, `build`,
69
76
  `validate`, `inspect`, `search`), entirely offline — no daemon.
70
77
 
71
78
  With a multimodal profile (`EMBEDDINGGEMMA_2_512_1`), pass `embedMedia` too and
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bendyline/gezel-knowledge",
3
- "version": "1.2.10",
3
+ "version": "1.2.11",
4
4
  "description": "Gezel knowledge catalogs: the .gezk compiler, archive safety, read-only reader, routing, and signatures.",
5
5
  "license": "MIT",
6
6
  "keywords": [
@@ -47,7 +47,7 @@
47
47
  "!dist/**/*.map"
48
48
  ],
49
49
  "dependencies": {
50
- "@bendyline/gezk": "1.0.6",
50
+ "@bendyline/gezk": "1.0.7",
51
51
  "yaml": "^2.9.0",
52
52
  "yauzl": "^3.4.0",
53
53
  "yazl": "^3.3.1",