@yolk-sdk/knowledge 0.1.0-canary.55 → 0.1.0-canary.57

package/README.md

@@ -9,6 +9,7 @@ pnpm add @yolk-sdk/knowledge@canary @yolk-sdk/agent@canary effect
 ```
 
 Canary APIs are unstable. Keep all `@yolk-sdk/*` packages on the same version.
+Published package metadata requires Node.js 22+.
 
 ## Model
 
@@ -105,6 +106,10 @@ Add the resulting text to your system prompt. Your app chooses which documents a
 summarizes concurrently, checks embedding cardinality, calls `replaceDocumentChunks`, then marks
 the index record `ready`.
 
+`DefaultKnowledgeChunkerLive` uses the bundled `gpt-tokenizer` `o200k_base` encoding for default
+chunk boundaries and token counts. Hosts can provide another `KnowledgeChunker` layer when they
+need model-specific tokenization.
+
 Failures are returned as `KnowledgeIngestionError` with a `store`, `extract`, `chunk`, `embed`, or
 `summarize` stage. The pipeline then best-effort calls `markDocumentError` with the error message;
 failure to mark the error is suppressed so the original failure survives.
@@ -118,6 +123,9 @@ filtering, and any coordination with the content document store.
 - Own users, workspaces, permissions, routing, and product policy.
 - Implement `KnowledgeStore` with app storage.
 - Implement `KnowledgeFileBlobStore` with R2/S3/blob storage when files are needed.
+- When using ingestion, provide `KnowledgeExtractor`, `KnowledgeChunker`, `KnowledgeEmbedder`,
+  `KnowledgeSummarizer`, and `SearchIndexStore` layers. Summary/title values may be absent, but the
+  current pipeline still requires the summarizer service.
 - Own concrete extraction, embeddings, search SQL/vector storage, and upload URLs.
 - Keep slug uniqueness scoped to the host boundary.
 

package/dist/ingestion.d.mts

@@ -17,12 +17,11 @@ type IngestKnowledgeDocumentInput = {
 declare const ingestKnowledgeDocument: (input: IngestKnowledgeDocumentInput) => Effect.Effect<{
   readonly id: string;
   readonly scopeId: string;
-  readonly status: "processing" | "ready" | "error";
   readonly source: {
     readonly _tag: "File";
     readonly ref: string;
-    readonly mediaType?: string | undefined;
     readonly name?: string | undefined;
+    readonly mediaType?: string | undefined;
   } | {
     readonly _tag: "Url";
     readonly url: string;
@@ -30,16 +29,17 @@ declare const ingestKnowledgeDocument: (input: IngestKnowledgeDocumentInput) =>
     readonly _tag: "Text";
     readonly label?: string | undefined;
   };
+  readonly status: "processing" | "ready" | "error";
+  readonly title?: string | undefined;
+  readonly summary?: string | undefined;
   readonly metadata?: {
     readonly [x: string]: unknown;
   } | undefined;
   readonly tokenCount?: number | undefined;
-  readonly summary?: string | undefined;
   readonly errorMessage?: string | undefined;
-  readonly title?: string | undefined;
   readonly contentHash?: string | undefined;
   readonly chunkCount?: number | undefined;
-}, KnowledgeIngestionError, KnowledgeSummarizer | KnowledgeChunker | KnowledgeEmbedder | KnowledgeExtractor | SearchIndexStore>;
+}, KnowledgeIngestionError, KnowledgeSummarizer | KnowledgeExtractor | SearchIndexStore | KnowledgeEmbedder | KnowledgeChunker>;
 type KnowledgeIngestionPipeline = {
   readonly ingest: (input: IngestKnowledgeDocumentInput) => ReturnType<typeof ingestKnowledgeDocument>;
 };

package/dist/search.d.mts

@@ -43,7 +43,7 @@ declare const fuseKnowledgeSearchResults: (input: {
   readonly limit: number;
   readonly rankConstant?: number;
 }) => ReadonlyArray<KnowledgeSearchResult>;
-declare const searchKnowledge: (input: KnowledgeSearchInput) => Effect.Effect<readonly KnowledgeSearchResult[], KnowledgeSearchError, KnowledgeEmbedder | SearchIndexStore>;
+declare const searchKnowledge: (input: KnowledgeSearchInput) => Effect.Effect<readonly KnowledgeSearchResult[], KnowledgeSearchError, SearchIndexStore | KnowledgeEmbedder>;
 //#endregion
 export { KnowledgeSearchContext, KnowledgeSearchInput, KnowledgeSearchMode, KnowledgeSearchResult, KnowledgeSearchScores, KnowledgeSearcher, fuseKnowledgeSearchResults, packKnowledgeSearchContext, searchKnowledge };
 //# sourceMappingURL=search.d.mts.map

package/dist/search.d.mts.map

@@ -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,iBAAA,GAAA,gBAAA"}
+{"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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yolk-sdk/knowledge",
-  "version": "0.1.0-canary.55",
+  "version": "0.1.0-canary.57",
   "description": "Domain-free durable knowledge document, file, search, context, and tool contracts for Yolk agents.",
   "license": "MIT",
   "type": "module",
@@ -106,7 +106,7 @@
   "dependencies": {
     "effect": "4.0.0-beta.65",
     "gpt-tokenizer": "^3.4.0",
-    "@yolk-sdk/agent": "^0.1.0-canary.55"
+    "@yolk-sdk/agent": "^0.1.0-canary.57"
   },
   "scripts": {
     "build": "tsdown",