@yolk-sdk/knowledge 0.1.0-canary.70 → 0.1.0-canary.72

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 (5) hide show
  1. package/README.md +16 -15
  2. package/dist/ingestion.d.mts +1 -1
  3. package/dist/search.d.mts +1 -1
  4. package/dist/search.d.mts.map +1 -1
  5. package/package.json +2 -2
package/README.md CHANGED
@@ -5,10 +5,11 @@ Domain-free knowledge document/source/file/context, ingestion, hybrid search, an
5
5
  ## Install
6
6
 
7
7
  ```bash
8
- pnpm add @yolk-sdk/knowledge@canary @yolk-sdk/agent@canary effect
8
+ pnpm add @yolk-sdk/knowledge@canary @yolk-sdk/agent@canary effect@4.0.0-beta.80
9
9
  ```
10
10
 
11
11
  Canary APIs are unstable. Keep all `@yolk-sdk/*` packages on the same version.
12
+ Use the SDK's matching Effect version (`4.0.0-beta.80`) in host code.
12
13
  Published package metadata requires Node.js 22+.
13
14
 
14
15
  ## Model
@@ -68,21 +69,21 @@ ids or kinds.
68
69
 
69
70
  ## Subpaths
70
71
 
71
- | Subpath | Purpose |
72
- | ----------------------------------- | -------------------------------------------------------------- |
73
- | `@yolk-sdk/knowledge` | Root context/store/file/error helpers |
72
+ | Subpath | Purpose |
73
+ | ----------------------------------- | ---------------------------------------------------------------------- |
74
+ | `@yolk-sdk/knowledge` | Root context/store/file/error helpers |
74
75
  | `@yolk-sdk/knowledge/documents` | Document, source, file, chunk, status, availability, and scope schemas |
75
- | `@yolk-sdk/knowledge/files` | File blob-store contract |
76
- | `@yolk-sdk/knowledge/store` | Document store and search-index store contracts |
77
- | `@yolk-sdk/knowledge/context` | Pinned context builder |
78
- | `@yolk-sdk/knowledge/chunking` | Text chunker contracts and defaults |
79
- | `@yolk-sdk/knowledge/embeddings` | Embedder contract and vector types |
80
- | `@yolk-sdk/knowledge/extraction` | Source/extractor contract |
81
- | `@yolk-sdk/knowledge/ingestion` | Extract/chunk/embed/summarize/index pipeline |
82
- | `@yolk-sdk/knowledge/search` | Vector/hybrid chunk search helpers |
83
- | `@yolk-sdk/knowledge/summarization` | Optional title/summary service contract |
84
- | `@yolk-sdk/knowledge/agent` | `knowledge_lookup` and `knowledge_manage` tool factories |
85
- | `@yolk-sdk/knowledge/errors` | Shared error types |
76
+ | `@yolk-sdk/knowledge/files` | File blob-store contract |
77
+ | `@yolk-sdk/knowledge/store` | Document store and search-index store contracts |
78
+ | `@yolk-sdk/knowledge/context` | Pinned context builder |
79
+ | `@yolk-sdk/knowledge/chunking` | Text chunker contracts and defaults |
80
+ | `@yolk-sdk/knowledge/embeddings` | Embedder contract and vector types |
81
+ | `@yolk-sdk/knowledge/extraction` | Source/extractor contract |
82
+ | `@yolk-sdk/knowledge/ingestion` | Extract/chunk/embed/summarize/index pipeline |
83
+ | `@yolk-sdk/knowledge/search` | Vector/hybrid chunk search helpers |
84
+ | `@yolk-sdk/knowledge/summarization` | Optional title/summary service contract |
85
+ | `@yolk-sdk/knowledge/agent` | `knowledge_lookup` and `knowledge_manage` tool factories |
86
+ | `@yolk-sdk/knowledge/errors` | Shared error types |
86
87
 
87
88
  ## Imports
88
89
 
package/dist/ingestion.d.mts CHANGED
@@ -39,7 +39,7 @@ declare const ingestKnowledgeDocument: (input: IngestKnowledgeDocumentInput) =>
39
39
  readonly metadata?: {
40
40
  readonly [x: string]: unknown;
41
41
  } | undefined;
42
- }, KnowledgeIngestionError, KnowledgeSummarizer | SearchIndexStore | KnowledgeEmbedder | KnowledgeChunker | KnowledgeExtractor>;
42
+ }, KnowledgeIngestionError, KnowledgeSummarizer | KnowledgeChunker | KnowledgeEmbedder | KnowledgeExtractor | SearchIndexStore>;
43
43
  type KnowledgeIngestionPipeline = {
44
44
  readonly ingest: (input: IngestKnowledgeDocumentInput) => ReturnType<typeof ingestKnowledgeDocument>;
45
45
  };
package/dist/search.d.mts CHANGED
@@ -43,7 +43,7 @@ declare const fuseKnowledgeSearchResults: (input: {
43
43
  readonly limit: number;
44
44
  readonly rankConstant?: number;
45
45
  }) => ReadonlyArray<KnowledgeSearchResult>;
46
- declare const searchKnowledge: (input: KnowledgeSearchInput) => Effect.Effect<readonly KnowledgeSearchResult[], KnowledgeSearchError, SearchIndexStore | KnowledgeEmbedder>;
46
+ declare const searchKnowledge: (input: KnowledgeSearchInput) => Effect.Effect<readonly KnowledgeSearchResult[], KnowledgeSearchError, KnowledgeEmbedder | SearchIndexStore>;
47
47
  //#endregion
48
48
  export { KnowledgeSearchContext, KnowledgeSearchInput, KnowledgeSearchMode, KnowledgeSearchResult, KnowledgeSearchScores, KnowledgeSearcher, fuseKnowledgeSearchResults, packKnowledgeSearchContext, searchKnowledge };
49
49
  //# sourceMappingURL=search.d.mts.map
package/dist/search.d.mts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"search.d.mts","names":[],"sources":["../src/search.ts"],"mappings":";;;;;;;KAMY,oBAAA;EAAA,SACD,KAAA,EAAO,oBAAA;EAAA,SACP,KAAA;EAAA,SACA,KAAA;EAAA,SACA,QAAA;EAAA,SACA,aAAA;EAAA,SACA,IAAA,GAAO,mBAAmB;EAAA,SAC1B,WAAA;EAAA,SACA,SAAA;AAAA;AAAA,KAGC,mBAAA;AAAA,KAEA,qBAAA;EAAA,SACD,MAAA;EAAA,SACA,IAAA;EAAA,SACA,KAAA;AAAA;AAAA,KAGC,qBAAA;EAAA,SACD,KAAA,EAAO,cAAA;EAAA,SACP,KAAA;EAAA,SACA,QAAA,EAAU,wBAAA;EAAA,SACV,OAAA,GAAU,aAAA,CAAc,cAAA;EAAA,SACxB,MAAA,GAAS,qBAAA;AAAA;AAAA,KAGR,sBAAA;EAAA,SACD,KAAA;EAAA,SACA,OAAA,EAAS,aAAa,CAAC,qBAAA;EAAA,SACvB,IAAA;AAAA;AAAA,KAGC,iBAAA;EAAA,SACD,MAAA,GACP,KAAA,EAAO,oBAAA,KACJ,MAAA,CAAO,MAAA,CAAO,aAAA,CAAc,qBAAA,GAAwB,oBAAA;AAAA;AAAA,cAM9C,0BAAA,GACX,KAAA,UACA,OAAA,EAAS,aAAA,CAAc,qBAAA,MACtB,sBAAA;AAAA,cAmBU,0BAAA,GAA8B,KAAA;EAAA,SAChC,aAAA,EAAe,aAAA,CAAc,qBAAA;EAAA,SAC7B,WAAA,EAAa,aAAA,CAAc,qBAAA;EAAA,SAC3B,KAAA;EAAA,SACA,YAAA;AAAA,MACP,aAAA,CAAc,qBAAA;AAAA,cAyJL,eAAA,GAAmB,KAAA,EAAO,oBAAA,KAAoB,MAAA,CAAA,MAAA,UAAA,qBAAA,IAAA,oBAAA,EAAA,gBAAA,GAAA,iBAAA"}
1
+ {"version":3,"file":"search.d.mts","names":[],"sources":["../src/search.ts"],"mappings":";;;;;;;KAMY,oBAAA;EAAA,SACD,KAAA,EAAO,oBAAA;EAAA,SACP,KAAA;EAAA,SACA,KAAA;EAAA,SACA,QAAA;EAAA,SACA,aAAA;EAAA,SACA,IAAA,GAAO,mBAAmB;EAAA,SAC1B,WAAA;EAAA,SACA,SAAA;AAAA;AAAA,KAGC,mBAAA;AAAA,KAEA,qBAAA;EAAA,SACD,MAAA;EAAA,SACA,IAAA;EAAA,SACA,KAAA;AAAA;AAAA,KAGC,qBAAA;EAAA,SACD,KAAA,EAAO,cAAA;EAAA,SACP,KAAA;EAAA,SACA,QAAA,EAAU,wBAAA;EAAA,SACV,OAAA,GAAU,aAAA,CAAc,cAAA;EAAA,SACxB,MAAA,GAAS,qBAAA;AAAA;AAAA,KAGR,sBAAA;EAAA,SACD,KAAA;EAAA,SACA,OAAA,EAAS,aAAa,CAAC,qBAAA;EAAA,SACvB,IAAA;AAAA;AAAA,KAGC,iBAAA;EAAA,SACD,MAAA,GACP,KAAA,EAAO,oBAAA,KACJ,MAAA,CAAO,MAAA,CAAO,aAAA,CAAc,qBAAA,GAAwB,oBAAA;AAAA;AAAA,cAM9C,0BAAA,GACX,KAAA,UACA,OAAA,EAAS,aAAA,CAAc,qBAAA,MACtB,sBAAA;AAAA,cAmBU,0BAAA,GAA8B,KAAA;EAAA,SAChC,aAAA,EAAe,aAAA,CAAc,qBAAA;EAAA,SAC7B,WAAA,EAAa,aAAA,CAAc,qBAAA;EAAA,SAC3B,KAAA;EAAA,SACA,YAAA;AAAA,MACP,aAAA,CAAc,qBAAA;AAAA,cAyJL,eAAA,GAAmB,KAAA,EAAO,oBAAA,KAAoB,MAAA,CAAA,MAAA,UAAA,qBAAA,IAAA,oBAAA,EAAA,iBAAA,GAAA,gBAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yolk-sdk/knowledge",
3
- "version": "0.1.0-canary.70",
3
+ "version": "0.1.0-canary.72",
4
4
  "description": "Domain-free knowledge document/source/file/context, ingestion, hybrid search, and lookup/manage tool helpers for agents.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -106,7 +106,7 @@
106
106
  "dependencies": {
107
107
  "effect": "4.0.0-beta.80",
108
108
  "gpt-tokenizer": "^3.4.0",
109
- "@yolk-sdk/agent": "^0.1.0-canary.70"
109
+ "@yolk-sdk/agent": "^0.1.0-canary.72"
110
110
  },
111
111
  "scripts": {
112
112
  "build": "tsdown",