@zokizuan/satori-core 1.5.0 → 1.5.2
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/README.md +14 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
# @zokizuan/satori-core
|
|
2
2
|
|
|
3
3
|
Core indexing and retrieval engine used by Satori.
|
|
4
|
-
This package handles the heavy lifting behind indexing, semantic retrieval, and incremental sync.
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
Use this package when you want the lower-level engine directly. Most agent workflows should install `@zokizuan/satori-mcp` or `@zokizuan/satori-cli` instead.
|
|
7
6
|
|
|
8
|
-
##
|
|
7
|
+
## What It Owns
|
|
9
8
|
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
- vector persistence and search
|
|
14
|
-
-
|
|
9
|
+
- File discovery and ignore filtering.
|
|
10
|
+
- AST-aware chunking with LangChain fallback.
|
|
11
|
+
- OpenAI, VoyageAI, Gemini, and Ollama embeddings.
|
|
12
|
+
- Milvus/Zilliz vector persistence and search.
|
|
13
|
+
- Dense/BM25 hybrid retrieval and optional reranking.
|
|
14
|
+
- Incremental sync with stat-first, hash-on-change file tracking.
|
|
15
15
|
|
|
16
16
|
## Install
|
|
17
17
|
|
|
@@ -19,7 +19,7 @@ Maintained by: `ham-zax` (`@zokizuan`).
|
|
|
19
19
|
npm install @zokizuan/satori-core
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
## Minimal
|
|
22
|
+
## Minimal Use
|
|
23
23
|
|
|
24
24
|
```ts
|
|
25
25
|
import { Context, OpenAIEmbedding, MilvusVectorDatabase } from '@zokizuan/satori-core';
|
|
@@ -36,9 +36,10 @@ const context = new Context({
|
|
|
36
36
|
});
|
|
37
37
|
|
|
38
38
|
await context.indexCodebase('/absolute/path/to/repo');
|
|
39
|
+
|
|
39
40
|
const results = await context.semanticSearch({
|
|
40
41
|
codebasePath: '/absolute/path/to/repo',
|
|
41
|
-
query: 'authentication
|
|
42
|
+
query: 'authentication refresh flow',
|
|
42
43
|
topK: 5,
|
|
43
44
|
retrievalMode: 'hybrid',
|
|
44
45
|
scorePolicy: { kind: 'topk_only' }
|
|
@@ -48,7 +49,7 @@ const results = await context.semanticSearch({
|
|
|
48
49
|
## Development
|
|
49
50
|
|
|
50
51
|
```bash
|
|
51
|
-
pnpm build
|
|
52
|
-
pnpm typecheck
|
|
53
|
-
pnpm test:integration
|
|
52
|
+
pnpm --filter @zokizuan/satori-core build
|
|
53
|
+
pnpm --filter @zokizuan/satori-core typecheck
|
|
54
|
+
pnpm --filter @zokizuan/satori-core test:integration
|
|
54
55
|
```
|