@yolk-sdk/knowledge 0.0.1-canary.0 → 0.0.1-canary.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 +2 -1
- package/dist/ingestion.d.mts +4 -4
- package/dist/search.d.mts +1 -1
- package/dist/search.d.mts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -24,6 +24,7 @@ Canary APIs are unstable. Keep all `@yolk-sdk/*` packages on the same version.
|
|
|
24
24
|
| `@yolk-sdk/knowledge/search` | Search interface, hybrid search, context packing |
|
|
25
25
|
| `@yolk-sdk/knowledge/documents` | Collection, document, chunk, and search scope schemas |
|
|
26
26
|
| `@yolk-sdk/knowledge/search-store` | Collection/document/chunk/search lifecycle store |
|
|
27
|
+
| `@yolk-sdk/knowledge/vector-store` | Compatibility aliases for vector search/store types |
|
|
27
28
|
| `@yolk-sdk/knowledge/summarization` | Optional title/summary service contract |
|
|
28
29
|
| `@yolk-sdk/knowledge/provenance` | Source/provenance metadata |
|
|
29
30
|
| `@yolk-sdk/knowledge/links` | Typed links between records |
|
|
@@ -76,7 +77,7 @@ Search APIs use canonical search naming. Removed APIs are intentionally not back
|
|
|
76
77
|
| Hybrid search | Search mode that fuses vector and text search rankings. |
|
|
77
78
|
| Search scope | Caller-provided collection or collections to search. Package does not interpret tenant semantics. |
|
|
78
79
|
| Search index store | Persistence contract for collections, documents, chunks, status, and search. |
|
|
79
|
-
| Vector store |
|
|
80
|
+
| Vector store | Compatibility naming over search-store chunk search contracts. |
|
|
80
81
|
| Knowledge store | Persistence contract for non-index knowledge records and context assembly. |
|
|
81
82
|
| Artifact store | Persistence contract for artifact bytes/metadata. |
|
|
82
83
|
| Host | App using the package; owns auth, DB, object storage, providers, permissions, and policy. |
|
package/dist/ingestion.d.mts
CHANGED
|
@@ -19,8 +19,8 @@ declare const ingestKnowledgeDocument: (input: IngestKnowledgeDocumentInput) =>
|
|
|
19
19
|
readonly source: {
|
|
20
20
|
readonly _tag: "File";
|
|
21
21
|
readonly ref: string;
|
|
22
|
-
readonly name?: string | undefined;
|
|
23
22
|
readonly mediaType?: string | undefined;
|
|
23
|
+
readonly name?: string | undefined;
|
|
24
24
|
} | {
|
|
25
25
|
readonly _tag: "Url";
|
|
26
26
|
readonly url: string;
|
|
@@ -28,17 +28,17 @@ declare const ingestKnowledgeDocument: (input: IngestKnowledgeDocumentInput) =>
|
|
|
28
28
|
readonly _tag: "Text";
|
|
29
29
|
readonly label?: string | undefined;
|
|
30
30
|
};
|
|
31
|
-
readonly status: "
|
|
31
|
+
readonly status: "processing" | "ready" | "error" | "pending";
|
|
32
32
|
readonly metadata?: {
|
|
33
33
|
readonly [x: string]: unknown;
|
|
34
34
|
} | undefined;
|
|
35
35
|
readonly tokenCount?: number | undefined;
|
|
36
|
-
readonly title?: string | undefined;
|
|
37
36
|
readonly summary?: string | undefined;
|
|
37
|
+
readonly title?: string | undefined;
|
|
38
38
|
readonly errorMessage?: string | undefined;
|
|
39
39
|
readonly contentHash?: string | undefined;
|
|
40
40
|
readonly chunkCount?: number | undefined;
|
|
41
|
-
}, KnowledgeIngestionError,
|
|
41
|
+
}, KnowledgeIngestionError, KnowledgeChunker | KnowledgeEmbedder | KnowledgeExtractor | SearchIndexStore | KnowledgeSummarizer>;
|
|
42
42
|
type KnowledgeIngestionPipeline = {
|
|
43
43
|
readonly ingest: (input: IngestKnowledgeDocumentInput) => ReturnType<typeof ingestKnowledgeDocument>;
|
|
44
44
|
};
|
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,
|
|
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,iBAAA;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,GAA8B,KAAA,UAAe,OAAA,EAAS,aAAA,CAAc,qBAAA,MAAyB,sBAAA;AAAA,cAoB7F,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,cAsIL,eAAA,GAAmB,KAAA,EAAO,oBAAA,KAAoB,MAAA,CAAA,MAAA,UAAA,qBAAA,IAAA,oBAAA,EAAA,
|
|
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,iBAAA;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,GAA8B,KAAA,UAAe,OAAA,EAAS,aAAA,CAAc,qBAAA,MAAyB,sBAAA;AAAA,cAoB7F,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,cAsIL,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.0.1-canary.
|
|
3
|
+
"version": "0.0.1-canary.2",
|
|
4
4
|
"description": "Domain-free knowledge record, artifact, provenance, and context contracts for Yolk agents.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -136,7 +136,7 @@
|
|
|
136
136
|
"dependencies": {
|
|
137
137
|
"effect": "4.0.0-beta.65",
|
|
138
138
|
"gpt-tokenizer": "^3.4.0",
|
|
139
|
-
"@yolk-sdk/agent": "^0.0.1-canary.
|
|
139
|
+
"@yolk-sdk/agent": "^0.0.1-canary.2"
|
|
140
140
|
},
|
|
141
141
|
"scripts": {
|
|
142
142
|
"build": "tsdown",
|