@knowledge-stack/ksapi 1.100.1 → 1.101.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 +2 -2
- package/dist/esm/models/ChunkMetadata.d.ts +6 -10
- package/dist/esm/models/CitedChunk.d.ts +1 -1
- package/dist/esm/models/DocumentVersionMetadata.d.ts +1 -1
- package/dist/models/ChunkMetadata.d.ts +6 -10
- package/dist/models/CitedChunk.d.ts +1 -1
- package/dist/models/DocumentVersionMetadata.d.ts +1 -1
- package/docs/ChunkMetadata.md +2 -2
- package/docs/CitedChunk.md +1 -1
- package/package.json +1 -1
- package/src/models/ChunkMetadata.ts +6 -6
- package/src/models/CitedChunk.ts +1 -1
- package/src/models/DocumentVersionMetadata.ts +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.101.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -537,7 +537,7 @@ and is automatically generated by the
|
|
|
537
537
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
538
538
|
|
|
539
539
|
- API version: `0.1.0`
|
|
540
|
-
- Package version: `1.
|
|
540
|
+
- Package version: `1.101.0`
|
|
541
541
|
- Generator version: `7.21.0`
|
|
542
542
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
543
543
|
|
|
@@ -94,21 +94,17 @@ export interface ChunkMetadata {
|
|
|
94
94
|
[key: string]: string;
|
|
95
95
|
}> | null;
|
|
96
96
|
/**
|
|
97
|
-
* Notable output/header cells
|
|
98
|
-
* @type {Array<
|
|
97
|
+
* Notable output/header cells as A1 refs, e.g. 'Sheet1!A1' (XLSX only)
|
|
98
|
+
* @type {Array<string>}
|
|
99
99
|
* @memberof ChunkMetadata
|
|
100
100
|
*/
|
|
101
|
-
keyCells?: Array<
|
|
102
|
-
[key: string]: any;
|
|
103
|
-
}> | null;
|
|
101
|
+
keyCells?: Array<string> | null;
|
|
104
102
|
/**
|
|
105
|
-
*
|
|
106
|
-
* @type {Array<
|
|
103
|
+
* Names of named ranges overlapping this chunk (XLSX only)
|
|
104
|
+
* @type {Array<string>}
|
|
107
105
|
* @memberof ChunkMetadata
|
|
108
106
|
*/
|
|
109
|
-
namedRanges?: Array<
|
|
110
|
-
[key: string]: any;
|
|
111
|
-
}> | null;
|
|
107
|
+
namedRanges?: Array<string> | null;
|
|
112
108
|
}
|
|
113
109
|
export declare const ChunkMetadataPropertyValidationAttributesMap: {
|
|
114
110
|
[property: string]: {
|
|
@@ -15,7 +15,7 @@ import type { DocumentType } from './DocumentType';
|
|
|
15
15
|
*
|
|
16
16
|
* ``chunk_id`` is the load-bearing field — every reader can use it via
|
|
17
17
|
* ``/v1/chunks/bulk``. The document fields are populated by
|
|
18
|
-
* ``
|
|
18
|
+
* ``ks_upload_from_sandbox`` when it resolves each chunk through the KS API at
|
|
19
19
|
* save time; they stay ``None`` only when the chunk could not be resolved
|
|
20
20
|
* (e.g. the agent cited an id that no longer exists, or the resolve call
|
|
21
21
|
* failed). The doc-info snapshot is captured at save time; later renames
|
|
@@ -110,7 +110,7 @@ export interface DocumentVersionMetadata {
|
|
|
110
110
|
[key: string]: any;
|
|
111
111
|
}> | null;
|
|
112
112
|
/**
|
|
113
|
-
* In-file citation anchors for agent-generated .xlsx/.docx deliverables. Each anchor binds an in-file location (cell or paragraph) to the chunk IDs cited there. Populated by
|
|
113
|
+
* In-file citation anchors for agent-generated .xlsx/.docx deliverables. Each anchor binds an in-file location (cell or paragraph) to the chunk IDs cited there. Populated by ks_upload_from_sandbox during upload; ``null`` for versions ingested before this field shipped or for files re-uploaded outside the agent flow. FE enriches chunks via /v1/chunks/bulk.
|
|
114
114
|
* @type {Array<XlsxCellAnchorOutputOrDocxParagraphAnchorOutput>}
|
|
115
115
|
* @memberof DocumentVersionMetadata
|
|
116
116
|
*/
|
|
@@ -94,21 +94,17 @@ export interface ChunkMetadata {
|
|
|
94
94
|
[key: string]: string;
|
|
95
95
|
}> | null;
|
|
96
96
|
/**
|
|
97
|
-
* Notable output/header cells
|
|
98
|
-
* @type {Array<
|
|
97
|
+
* Notable output/header cells as A1 refs, e.g. 'Sheet1!A1' (XLSX only)
|
|
98
|
+
* @type {Array<string>}
|
|
99
99
|
* @memberof ChunkMetadata
|
|
100
100
|
*/
|
|
101
|
-
keyCells?: Array<
|
|
102
|
-
[key: string]: any;
|
|
103
|
-
}> | null;
|
|
101
|
+
keyCells?: Array<string> | null;
|
|
104
102
|
/**
|
|
105
|
-
*
|
|
106
|
-
* @type {Array<
|
|
103
|
+
* Names of named ranges overlapping this chunk (XLSX only)
|
|
104
|
+
* @type {Array<string>}
|
|
107
105
|
* @memberof ChunkMetadata
|
|
108
106
|
*/
|
|
109
|
-
namedRanges?: Array<
|
|
110
|
-
[key: string]: any;
|
|
111
|
-
}> | null;
|
|
107
|
+
namedRanges?: Array<string> | null;
|
|
112
108
|
}
|
|
113
109
|
export declare const ChunkMetadataPropertyValidationAttributesMap: {
|
|
114
110
|
[property: string]: {
|
|
@@ -15,7 +15,7 @@ import type { DocumentType } from './DocumentType';
|
|
|
15
15
|
*
|
|
16
16
|
* ``chunk_id`` is the load-bearing field — every reader can use it via
|
|
17
17
|
* ``/v1/chunks/bulk``. The document fields are populated by
|
|
18
|
-
* ``
|
|
18
|
+
* ``ks_upload_from_sandbox`` when it resolves each chunk through the KS API at
|
|
19
19
|
* save time; they stay ``None`` only when the chunk could not be resolved
|
|
20
20
|
* (e.g. the agent cited an id that no longer exists, or the resolve call
|
|
21
21
|
* failed). The doc-info snapshot is captured at save time; later renames
|
|
@@ -110,7 +110,7 @@ export interface DocumentVersionMetadata {
|
|
|
110
110
|
[key: string]: any;
|
|
111
111
|
}> | null;
|
|
112
112
|
/**
|
|
113
|
-
* In-file citation anchors for agent-generated .xlsx/.docx deliverables. Each anchor binds an in-file location (cell or paragraph) to the chunk IDs cited there. Populated by
|
|
113
|
+
* In-file citation anchors for agent-generated .xlsx/.docx deliverables. Each anchor binds an in-file location (cell or paragraph) to the chunk IDs cited there. Populated by ks_upload_from_sandbox during upload; ``null`` for versions ingested before this field shipped or for files re-uploaded outside the agent flow. FE enriches chunks via /v1/chunks/bulk.
|
|
114
114
|
* @type {Array<XlsxCellAnchorOutputOrDocxParagraphAnchorOutput>}
|
|
115
115
|
* @memberof DocumentVersionMetadata
|
|
116
116
|
*/
|
package/docs/ChunkMetadata.md
CHANGED
|
@@ -19,8 +19,8 @@ Name | Type
|
|
|
19
19
|
`cellRange` | string
|
|
20
20
|
`dependencySummary` | { [key: string]: any; }
|
|
21
21
|
`formulas` | Array<{ [key: string]: string; }>
|
|
22
|
-
`keyCells` | Array<
|
|
23
|
-
`namedRanges` | Array<
|
|
22
|
+
`keyCells` | Array<string>
|
|
23
|
+
`namedRanges` | Array<string>
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
package/docs/CitedChunk.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# CitedChunk
|
|
3
3
|
|
|
4
|
-
One cited chunk with the source document context for FE rendering. ``chunk_id`` is the load-bearing field — every reader can use it via ``/v1/chunks/bulk``. The document fields are populated by ``
|
|
4
|
+
One cited chunk with the source document context for FE rendering. ``chunk_id`` is the load-bearing field — every reader can use it via ``/v1/chunks/bulk``. The document fields are populated by ``ks_upload_from_sandbox`` when it resolves each chunk through the KS API at save time; they stay ``None`` only when the chunk could not be resolved (e.g. the agent cited an id that no longer exists, or the resolve call failed). The doc-info snapshot is captured at save time; later renames or replacements of the source document do not update it.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
package/package.json
CHANGED
|
@@ -107,17 +107,17 @@ export interface ChunkMetadata {
|
|
|
107
107
|
*/
|
|
108
108
|
formulas?: Array<{ [key: string]: string; }> | null;
|
|
109
109
|
/**
|
|
110
|
-
* Notable output/header cells
|
|
111
|
-
* @type {Array<
|
|
110
|
+
* Notable output/header cells as A1 refs, e.g. 'Sheet1!A1' (XLSX only)
|
|
111
|
+
* @type {Array<string>}
|
|
112
112
|
* @memberof ChunkMetadata
|
|
113
113
|
*/
|
|
114
|
-
keyCells?: Array<
|
|
114
|
+
keyCells?: Array<string> | null;
|
|
115
115
|
/**
|
|
116
|
-
*
|
|
117
|
-
* @type {Array<
|
|
116
|
+
* Names of named ranges overlapping this chunk (XLSX only)
|
|
117
|
+
* @type {Array<string>}
|
|
118
118
|
* @memberof ChunkMetadata
|
|
119
119
|
*/
|
|
120
|
-
namedRanges?: Array<
|
|
120
|
+
namedRanges?: Array<string> | null;
|
|
121
121
|
}
|
|
122
122
|
|
|
123
123
|
|
package/src/models/CitedChunk.ts
CHANGED
|
@@ -26,7 +26,7 @@ import {
|
|
|
26
26
|
*
|
|
27
27
|
* ``chunk_id`` is the load-bearing field — every reader can use it via
|
|
28
28
|
* ``/v1/chunks/bulk``. The document fields are populated by
|
|
29
|
-
* ``
|
|
29
|
+
* ``ks_upload_from_sandbox`` when it resolves each chunk through the KS API at
|
|
30
30
|
* save time; they stay ``None`` only when the chunk could not be resolved
|
|
31
31
|
* (e.g. the agent cited an id that no longer exists, or the resolve call
|
|
32
32
|
* failed). The doc-info snapshot is captured at save time; later renames
|
|
@@ -129,7 +129,7 @@ export interface DocumentVersionMetadata {
|
|
|
129
129
|
*/
|
|
130
130
|
xlsxKpiCatalog?: Array<{ [key: string]: any; }> | null;
|
|
131
131
|
/**
|
|
132
|
-
* In-file citation anchors for agent-generated .xlsx/.docx deliverables. Each anchor binds an in-file location (cell or paragraph) to the chunk IDs cited there. Populated by
|
|
132
|
+
* In-file citation anchors for agent-generated .xlsx/.docx deliverables. Each anchor binds an in-file location (cell or paragraph) to the chunk IDs cited there. Populated by ks_upload_from_sandbox during upload; ``null`` for versions ingested before this field shipped or for files re-uploaded outside the agent flow. FE enriches chunks via /v1/chunks/bulk.
|
|
133
133
|
* @type {Array<XlsxCellAnchorOutputOrDocxParagraphAnchorOutput>}
|
|
134
134
|
* @memberof DocumentVersionMetadata
|
|
135
135
|
*/
|