@toolpack-sdk/knowledge 2.7.0 → 3.1.0
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 +27 -1
- package/dist/index.cjs +13 -13
- package/dist/index.d.cts +47 -1
- package/dist/index.d.ts +47 -1
- package/dist/index.js +13 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -275,6 +275,21 @@ new MarkdownSource('./docs/**/*.md', {
|
|
|
275
275
|
- Code block detection (`hasCode` metadata)
|
|
276
276
|
- Deterministic chunk IDs
|
|
277
277
|
|
|
278
|
+
### TextSource
|
|
279
|
+
|
|
280
|
+
Chunk plain text (for example platform / tenant knowledge items) with optional metadata.
|
|
281
|
+
|
|
282
|
+
```typescript
|
|
283
|
+
import { TextSource } from '@toolpack-sdk/knowledge';
|
|
284
|
+
|
|
285
|
+
new TextSource('item-abc', documentBody, {
|
|
286
|
+
maxChunkSize: 2000,
|
|
287
|
+
chunkOverlap: 200,
|
|
288
|
+
namespace: 'tenant-knowledge',
|
|
289
|
+
metadata: { knowledge_item_id: 'abc', tenant_id: 't1' },
|
|
290
|
+
})
|
|
291
|
+
```
|
|
292
|
+
|
|
278
293
|
### WebUrlSource
|
|
279
294
|
|
|
280
295
|
Crawl and index web pages with HTML parsing.
|
|
@@ -488,6 +503,8 @@ interface KnowledgeOptions {
|
|
|
488
503
|
onError?: (error, context) => 'skip' | 'abort';
|
|
489
504
|
onSync?: (event: SyncEvent) => void;
|
|
490
505
|
onEmbeddingProgress?: (event: EmbeddingProgressEvent) => void;
|
|
506
|
+
onAdd?: (event: KnowledgeAddEvent) => void; // After add()
|
|
507
|
+
onDelete?: (event: KnowledgeDeleteEvent) => void; // After delete() / deleteWhere()
|
|
491
508
|
}
|
|
492
509
|
```
|
|
493
510
|
|
|
@@ -508,10 +525,19 @@ await kb.query('search query', {
|
|
|
508
525
|
});
|
|
509
526
|
```
|
|
510
527
|
|
|
528
|
+
### Incremental updates
|
|
529
|
+
|
|
530
|
+
```typescript
|
|
531
|
+
await kb.add(content, metadata); // Embed + store one chunk
|
|
532
|
+
await kb.ingest(source); // Add source chunks without clearing
|
|
533
|
+
await kb.delete([id]); // Delete by IDs
|
|
534
|
+
await kb.deleteWhere({ knowledge_item_id: 'abc' }); // Delete by metadata match
|
|
535
|
+
```
|
|
536
|
+
|
|
511
537
|
### Utility Functions
|
|
512
538
|
|
|
513
539
|
```typescript
|
|
514
|
-
import { keywordSearch, combineScores } from '@toolpack-sdk/knowledge';
|
|
540
|
+
import { keywordSearch, combineScores, matchesFilter } from '@toolpack-sdk/knowledge';
|
|
515
541
|
|
|
516
542
|
// Manual keyword search
|
|
517
543
|
const score = keywordSearch('document content', 'search query');
|