@knowledge-stack/ksapi 1.86.0 → 1.86.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 -2
- package/dist/apis/DocumentVersionsApi.d.ts +3 -0
- package/dist/apis/DocumentVersionsApi.js +3 -0
- package/dist/esm/apis/DocumentVersionsApi.d.ts +3 -0
- package/dist/esm/apis/DocumentVersionsApi.js +3 -0
- package/dist/esm/models/DocumentVersionResponse.d.ts +6 -0
- package/dist/esm/models/DocumentVersionResponse.js +2 -0
- package/dist/esm/models/ThreadMessageDetailsInput.d.ts +6 -0
- package/dist/esm/models/ThreadMessageDetailsInput.js +7 -1
- package/dist/esm/models/ThreadMessageDetailsOutput.d.ts +6 -0
- package/dist/esm/models/ThreadMessageDetailsOutput.js +7 -1
- package/dist/models/DocumentVersionResponse.d.ts +6 -0
- package/dist/models/DocumentVersionResponse.js +2 -0
- package/dist/models/ThreadMessageDetailsInput.d.ts +6 -0
- package/dist/models/ThreadMessageDetailsInput.js +7 -1
- package/dist/models/ThreadMessageDetailsOutput.d.ts +6 -0
- package/dist/models/ThreadMessageDetailsOutput.js +7 -1
- package/docs/DocumentVersionResponse.md +2 -0
- package/docs/DocumentVersionsApi.md +4 -1
- package/docs/ThreadMessageDetailsInput.md +2 -0
- package/docs/ThreadMessageDetailsOutput.md +2 -0
- package/package.json +1 -1
- package/src/apis/DocumentVersionsApi.ts +7 -0
- package/src/models/DocumentVersionResponse.ts +8 -0
- package/src/models/ThreadMessageDetailsInput.ts +11 -0
- package/src/models/ThreadMessageDetailsOutput.ts +11 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.86.
|
|
1
|
+
# @knowledge-stack/ksapi@1.86.2
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -440,7 +440,7 @@ and is automatically generated by the
|
|
|
440
440
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
441
441
|
|
|
442
442
|
- API version: `0.1.0`
|
|
443
|
-
- Package version: `1.86.
|
|
443
|
+
- Package version: `1.86.2`
|
|
444
444
|
- Generator version: `7.21.0`
|
|
445
445
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
446
446
|
|
|
@@ -34,6 +34,7 @@ export interface DocumentVersionActionRequest {
|
|
|
34
34
|
}
|
|
35
35
|
export interface GetDocumentVersionRequest {
|
|
36
36
|
versionId: string;
|
|
37
|
+
includePageScreenshots?: boolean;
|
|
37
38
|
authorization?: string | null;
|
|
38
39
|
ksUat?: string | null;
|
|
39
40
|
}
|
|
@@ -171,6 +172,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
171
172
|
/**
|
|
172
173
|
* Creates request options for getDocumentVersion without sending the request
|
|
173
174
|
* @param {string} versionId DocumentVersion ID
|
|
175
|
+
* @param {boolean} [includePageScreenshots] When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small.
|
|
174
176
|
* @param {string} [authorization]
|
|
175
177
|
* @param {string} [ksUat]
|
|
176
178
|
* @throws {RequiredError}
|
|
@@ -181,6 +183,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
181
183
|
* Get a document version by its ID.
|
|
182
184
|
* @summary Get Document Version Handler
|
|
183
185
|
* @param {string} versionId DocumentVersion ID
|
|
186
|
+
* @param {boolean} [includePageScreenshots] When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small.
|
|
184
187
|
* @param {string} [authorization]
|
|
185
188
|
* @param {string} [ksUat]
|
|
186
189
|
* @param {*} [options] Override http request option.
|
|
@@ -252,6 +252,9 @@ class DocumentVersionsApi extends runtime.BaseAPI {
|
|
|
252
252
|
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getDocumentVersion().');
|
|
253
253
|
}
|
|
254
254
|
const queryParameters = {};
|
|
255
|
+
if (requestParameters['includePageScreenshots'] != null) {
|
|
256
|
+
queryParameters['include_page_screenshots'] = requestParameters['includePageScreenshots'];
|
|
257
|
+
}
|
|
255
258
|
const headerParameters = {};
|
|
256
259
|
if (requestParameters['authorization'] != null) {
|
|
257
260
|
headerParameters['authorization'] = String(requestParameters['authorization']);
|
|
@@ -34,6 +34,7 @@ export interface DocumentVersionActionRequest {
|
|
|
34
34
|
}
|
|
35
35
|
export interface GetDocumentVersionRequest {
|
|
36
36
|
versionId: string;
|
|
37
|
+
includePageScreenshots?: boolean;
|
|
37
38
|
authorization?: string | null;
|
|
38
39
|
ksUat?: string | null;
|
|
39
40
|
}
|
|
@@ -171,6 +172,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
171
172
|
/**
|
|
172
173
|
* Creates request options for getDocumentVersion without sending the request
|
|
173
174
|
* @param {string} versionId DocumentVersion ID
|
|
175
|
+
* @param {boolean} [includePageScreenshots] When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small.
|
|
174
176
|
* @param {string} [authorization]
|
|
175
177
|
* @param {string} [ksUat]
|
|
176
178
|
* @throws {RequiredError}
|
|
@@ -181,6 +183,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
181
183
|
* Get a document version by its ID.
|
|
182
184
|
* @summary Get Document Version Handler
|
|
183
185
|
* @param {string} versionId DocumentVersion ID
|
|
186
|
+
* @param {boolean} [includePageScreenshots] When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small.
|
|
184
187
|
* @param {string} [authorization]
|
|
185
188
|
* @param {string} [ksUat]
|
|
186
189
|
* @param {*} [options] Override http request option.
|
|
@@ -216,6 +216,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
|
|
|
216
216
|
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getDocumentVersion().');
|
|
217
217
|
}
|
|
218
218
|
const queryParameters = {};
|
|
219
|
+
if (requestParameters['includePageScreenshots'] != null) {
|
|
220
|
+
queryParameters['include_page_screenshots'] = requestParameters['includePageScreenshots'];
|
|
221
|
+
}
|
|
219
222
|
const headerParameters = {};
|
|
220
223
|
if (requestParameters['authorization'] != null) {
|
|
221
224
|
headerParameters['authorization'] = String(requestParameters['authorization']);
|
|
@@ -97,6 +97,12 @@ export interface DocumentVersionResponse {
|
|
|
97
97
|
* @memberof DocumentVersionResponse
|
|
98
98
|
*/
|
|
99
99
|
fastPlaintextUrl?: string | null;
|
|
100
|
+
/**
|
|
101
|
+
* Presigned URLs (6-hour validity) to per-page WEBP screenshots in page order: index 0 is page 1, index N-1 is page N. Populated only when the request includes include_page_screenshots=true; null otherwise.
|
|
102
|
+
* @type {Array<string>}
|
|
103
|
+
* @memberof DocumentVersionResponse
|
|
104
|
+
*/
|
|
105
|
+
pageScreenshotUrls?: Array<string> | null;
|
|
100
106
|
/**
|
|
101
107
|
*
|
|
102
108
|
* @type {DocumentVersionMetadata}
|
|
@@ -62,6 +62,7 @@ export function DocumentVersionResponseFromJSONTyped(json, ignoreDiscriminator)
|
|
|
62
62
|
'updatedAt': (new Date(json['updated_at'])),
|
|
63
63
|
'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
|
|
64
64
|
'fastPlaintextUrl': json['fast_plaintext_url'] == null ? undefined : json['fast_plaintext_url'],
|
|
65
|
+
'pageScreenshotUrls': json['page_screenshot_urls'] == null ? undefined : json['page_screenshot_urls'],
|
|
65
66
|
'systemMetadata': json['system_metadata'] == null ? undefined : DocumentVersionMetadataFromJSON(json['system_metadata']),
|
|
66
67
|
};
|
|
67
68
|
}
|
|
@@ -86,6 +87,7 @@ export function DocumentVersionResponseToJSONTyped(value, ignoreDiscriminator =
|
|
|
86
87
|
'updated_at': value['updatedAt'].toISOString(),
|
|
87
88
|
'asset_s3_url': value['assetS3Url'],
|
|
88
89
|
'fast_plaintext_url': value['fastPlaintextUrl'],
|
|
90
|
+
'page_screenshot_urls': value['pageScreenshotUrls'],
|
|
89
91
|
'system_metadata': DocumentVersionMetadataToJSON(value['systemMetadata']),
|
|
90
92
|
};
|
|
91
93
|
}
|
|
@@ -29,6 +29,12 @@ export interface ThreadMessageDetailsInput {
|
|
|
29
29
|
* @memberof ThreadMessageDetailsInput
|
|
30
30
|
*/
|
|
31
31
|
checkpoint?: CheckpointDetails | null;
|
|
32
|
+
/**
|
|
33
|
+
* Model registry id (FE-stable, e.g. ``qwen-flash``) that produced this assistant message. ``None`` for legacy rows that pre-date model selection.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ThreadMessageDetailsInput
|
|
36
|
+
*/
|
|
37
|
+
modelId?: string | null;
|
|
32
38
|
}
|
|
33
39
|
export declare const ThreadMessageDetailsInputPropertyValidationAttributesMap: {
|
|
34
40
|
[property: string]: {
|
|
@@ -13,7 +13,11 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import { CheckpointDetailsFromJSON, CheckpointDetailsToJSON, } from './CheckpointDetails';
|
|
15
15
|
import { StepInputFromJSON, StepInputToJSON, } from './StepInput';
|
|
16
|
-
export const ThreadMessageDetailsInputPropertyValidationAttributesMap = {
|
|
16
|
+
export const ThreadMessageDetailsInputPropertyValidationAttributesMap = {
|
|
17
|
+
modelId: {
|
|
18
|
+
maxLength: 64,
|
|
19
|
+
},
|
|
20
|
+
};
|
|
17
21
|
/**
|
|
18
22
|
* Check if a given object implements the ThreadMessageDetailsInput interface.
|
|
19
23
|
*/
|
|
@@ -30,6 +34,7 @@ export function ThreadMessageDetailsInputFromJSONTyped(json, ignoreDiscriminator
|
|
|
30
34
|
return {
|
|
31
35
|
'steps': json['steps'] == null ? undefined : (json['steps'].map(StepInputFromJSON)),
|
|
32
36
|
'checkpoint': json['checkpoint'] == null ? undefined : CheckpointDetailsFromJSON(json['checkpoint']),
|
|
37
|
+
'modelId': json['model_id'] == null ? undefined : json['model_id'],
|
|
33
38
|
};
|
|
34
39
|
}
|
|
35
40
|
export function ThreadMessageDetailsInputToJSON(json) {
|
|
@@ -42,5 +47,6 @@ export function ThreadMessageDetailsInputToJSONTyped(value, ignoreDiscriminator
|
|
|
42
47
|
return {
|
|
43
48
|
'steps': value['steps'] == null ? undefined : (value['steps'].map(StepInputToJSON)),
|
|
44
49
|
'checkpoint': CheckpointDetailsToJSON(value['checkpoint']),
|
|
50
|
+
'model_id': value['modelId'],
|
|
45
51
|
};
|
|
46
52
|
}
|
|
@@ -29,6 +29,12 @@ export interface ThreadMessageDetailsOutput {
|
|
|
29
29
|
* @memberof ThreadMessageDetailsOutput
|
|
30
30
|
*/
|
|
31
31
|
checkpoint?: CheckpointDetails | null;
|
|
32
|
+
/**
|
|
33
|
+
* Model registry id (FE-stable, e.g. ``qwen-flash``) that produced this assistant message. ``None`` for legacy rows that pre-date model selection.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ThreadMessageDetailsOutput
|
|
36
|
+
*/
|
|
37
|
+
modelId?: string | null;
|
|
32
38
|
}
|
|
33
39
|
export declare const ThreadMessageDetailsOutputPropertyValidationAttributesMap: {
|
|
34
40
|
[property: string]: {
|
|
@@ -13,7 +13,11 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import { StepOutputFromJSON, StepOutputToJSON, } from './StepOutput';
|
|
15
15
|
import { CheckpointDetailsFromJSON, CheckpointDetailsToJSON, } from './CheckpointDetails';
|
|
16
|
-
export const ThreadMessageDetailsOutputPropertyValidationAttributesMap = {
|
|
16
|
+
export const ThreadMessageDetailsOutputPropertyValidationAttributesMap = {
|
|
17
|
+
modelId: {
|
|
18
|
+
maxLength: 64,
|
|
19
|
+
},
|
|
20
|
+
};
|
|
17
21
|
/**
|
|
18
22
|
* Check if a given object implements the ThreadMessageDetailsOutput interface.
|
|
19
23
|
*/
|
|
@@ -30,6 +34,7 @@ export function ThreadMessageDetailsOutputFromJSONTyped(json, ignoreDiscriminato
|
|
|
30
34
|
return {
|
|
31
35
|
'steps': json['steps'] == null ? undefined : (json['steps'].map(StepOutputFromJSON)),
|
|
32
36
|
'checkpoint': json['checkpoint'] == null ? undefined : CheckpointDetailsFromJSON(json['checkpoint']),
|
|
37
|
+
'modelId': json['model_id'] == null ? undefined : json['model_id'],
|
|
33
38
|
};
|
|
34
39
|
}
|
|
35
40
|
export function ThreadMessageDetailsOutputToJSON(json) {
|
|
@@ -42,5 +47,6 @@ export function ThreadMessageDetailsOutputToJSONTyped(value, ignoreDiscriminator
|
|
|
42
47
|
return {
|
|
43
48
|
'steps': value['steps'] == null ? undefined : (value['steps'].map(StepOutputToJSON)),
|
|
44
49
|
'checkpoint': CheckpointDetailsToJSON(value['checkpoint']),
|
|
50
|
+
'model_id': value['modelId'],
|
|
45
51
|
};
|
|
46
52
|
}
|
|
@@ -97,6 +97,12 @@ export interface DocumentVersionResponse {
|
|
|
97
97
|
* @memberof DocumentVersionResponse
|
|
98
98
|
*/
|
|
99
99
|
fastPlaintextUrl?: string | null;
|
|
100
|
+
/**
|
|
101
|
+
* Presigned URLs (6-hour validity) to per-page WEBP screenshots in page order: index 0 is page 1, index N-1 is page N. Populated only when the request includes include_page_screenshots=true; null otherwise.
|
|
102
|
+
* @type {Array<string>}
|
|
103
|
+
* @memberof DocumentVersionResponse
|
|
104
|
+
*/
|
|
105
|
+
pageScreenshotUrls?: Array<string> | null;
|
|
100
106
|
/**
|
|
101
107
|
*
|
|
102
108
|
* @type {DocumentVersionMetadata}
|
|
@@ -70,6 +70,7 @@ function DocumentVersionResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
70
70
|
'updatedAt': (new Date(json['updated_at'])),
|
|
71
71
|
'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
|
|
72
72
|
'fastPlaintextUrl': json['fast_plaintext_url'] == null ? undefined : json['fast_plaintext_url'],
|
|
73
|
+
'pageScreenshotUrls': json['page_screenshot_urls'] == null ? undefined : json['page_screenshot_urls'],
|
|
73
74
|
'systemMetadata': json['system_metadata'] == null ? undefined : (0, DocumentVersionMetadata_1.DocumentVersionMetadataFromJSON)(json['system_metadata']),
|
|
74
75
|
};
|
|
75
76
|
}
|
|
@@ -94,6 +95,7 @@ function DocumentVersionResponseToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
94
95
|
'updated_at': value['updatedAt'].toISOString(),
|
|
95
96
|
'asset_s3_url': value['assetS3Url'],
|
|
96
97
|
'fast_plaintext_url': value['fastPlaintextUrl'],
|
|
98
|
+
'page_screenshot_urls': value['pageScreenshotUrls'],
|
|
97
99
|
'system_metadata': (0, DocumentVersionMetadata_1.DocumentVersionMetadataToJSON)(value['systemMetadata']),
|
|
98
100
|
};
|
|
99
101
|
}
|
|
@@ -29,6 +29,12 @@ export interface ThreadMessageDetailsInput {
|
|
|
29
29
|
* @memberof ThreadMessageDetailsInput
|
|
30
30
|
*/
|
|
31
31
|
checkpoint?: CheckpointDetails | null;
|
|
32
|
+
/**
|
|
33
|
+
* Model registry id (FE-stable, e.g. ``qwen-flash``) that produced this assistant message. ``None`` for legacy rows that pre-date model selection.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ThreadMessageDetailsInput
|
|
36
|
+
*/
|
|
37
|
+
modelId?: string | null;
|
|
32
38
|
}
|
|
33
39
|
export declare const ThreadMessageDetailsInputPropertyValidationAttributesMap: {
|
|
34
40
|
[property: string]: {
|
|
@@ -21,7 +21,11 @@ exports.ThreadMessageDetailsInputToJSON = ThreadMessageDetailsInputToJSON;
|
|
|
21
21
|
exports.ThreadMessageDetailsInputToJSONTyped = ThreadMessageDetailsInputToJSONTyped;
|
|
22
22
|
const CheckpointDetails_1 = require("./CheckpointDetails");
|
|
23
23
|
const StepInput_1 = require("./StepInput");
|
|
24
|
-
exports.ThreadMessageDetailsInputPropertyValidationAttributesMap = {
|
|
24
|
+
exports.ThreadMessageDetailsInputPropertyValidationAttributesMap = {
|
|
25
|
+
modelId: {
|
|
26
|
+
maxLength: 64,
|
|
27
|
+
},
|
|
28
|
+
};
|
|
25
29
|
/**
|
|
26
30
|
* Check if a given object implements the ThreadMessageDetailsInput interface.
|
|
27
31
|
*/
|
|
@@ -38,6 +42,7 @@ function ThreadMessageDetailsInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
42
|
return {
|
|
39
43
|
'steps': json['steps'] == null ? undefined : (json['steps'].map(StepInput_1.StepInputFromJSON)),
|
|
40
44
|
'checkpoint': json['checkpoint'] == null ? undefined : (0, CheckpointDetails_1.CheckpointDetailsFromJSON)(json['checkpoint']),
|
|
45
|
+
'modelId': json['model_id'] == null ? undefined : json['model_id'],
|
|
41
46
|
};
|
|
42
47
|
}
|
|
43
48
|
function ThreadMessageDetailsInputToJSON(json) {
|
|
@@ -50,5 +55,6 @@ function ThreadMessageDetailsInputToJSONTyped(value, ignoreDiscriminator = false
|
|
|
50
55
|
return {
|
|
51
56
|
'steps': value['steps'] == null ? undefined : (value['steps'].map(StepInput_1.StepInputToJSON)),
|
|
52
57
|
'checkpoint': (0, CheckpointDetails_1.CheckpointDetailsToJSON)(value['checkpoint']),
|
|
58
|
+
'model_id': value['modelId'],
|
|
53
59
|
};
|
|
54
60
|
}
|
|
@@ -29,6 +29,12 @@ export interface ThreadMessageDetailsOutput {
|
|
|
29
29
|
* @memberof ThreadMessageDetailsOutput
|
|
30
30
|
*/
|
|
31
31
|
checkpoint?: CheckpointDetails | null;
|
|
32
|
+
/**
|
|
33
|
+
* Model registry id (FE-stable, e.g. ``qwen-flash``) that produced this assistant message. ``None`` for legacy rows that pre-date model selection.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ThreadMessageDetailsOutput
|
|
36
|
+
*/
|
|
37
|
+
modelId?: string | null;
|
|
32
38
|
}
|
|
33
39
|
export declare const ThreadMessageDetailsOutputPropertyValidationAttributesMap: {
|
|
34
40
|
[property: string]: {
|
|
@@ -21,7 +21,11 @@ exports.ThreadMessageDetailsOutputToJSON = ThreadMessageDetailsOutputToJSON;
|
|
|
21
21
|
exports.ThreadMessageDetailsOutputToJSONTyped = ThreadMessageDetailsOutputToJSONTyped;
|
|
22
22
|
const StepOutput_1 = require("./StepOutput");
|
|
23
23
|
const CheckpointDetails_1 = require("./CheckpointDetails");
|
|
24
|
-
exports.ThreadMessageDetailsOutputPropertyValidationAttributesMap = {
|
|
24
|
+
exports.ThreadMessageDetailsOutputPropertyValidationAttributesMap = {
|
|
25
|
+
modelId: {
|
|
26
|
+
maxLength: 64,
|
|
27
|
+
},
|
|
28
|
+
};
|
|
25
29
|
/**
|
|
26
30
|
* Check if a given object implements the ThreadMessageDetailsOutput interface.
|
|
27
31
|
*/
|
|
@@ -38,6 +42,7 @@ function ThreadMessageDetailsOutputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
42
|
return {
|
|
39
43
|
'steps': json['steps'] == null ? undefined : (json['steps'].map(StepOutput_1.StepOutputFromJSON)),
|
|
40
44
|
'checkpoint': json['checkpoint'] == null ? undefined : (0, CheckpointDetails_1.CheckpointDetailsFromJSON)(json['checkpoint']),
|
|
45
|
+
'modelId': json['model_id'] == null ? undefined : json['model_id'],
|
|
41
46
|
};
|
|
42
47
|
}
|
|
43
48
|
function ThreadMessageDetailsOutputToJSON(json) {
|
|
@@ -50,5 +55,6 @@ function ThreadMessageDetailsOutputToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
50
55
|
return {
|
|
51
56
|
'steps': value['steps'] == null ? undefined : (value['steps'].map(StepOutput_1.StepOutputToJSON)),
|
|
52
57
|
'checkpoint': (0, CheckpointDetails_1.CheckpointDetailsToJSON)(value['checkpoint']),
|
|
58
|
+
'model_id': value['modelId'],
|
|
53
59
|
};
|
|
54
60
|
}
|
|
@@ -20,6 +20,7 @@ Name | Type
|
|
|
20
20
|
`updatedAt` | Date
|
|
21
21
|
`assetS3Url` | string
|
|
22
22
|
`fastPlaintextUrl` | string
|
|
23
|
+
`pageScreenshotUrls` | Array<string>
|
|
23
24
|
`systemMetadata` | [DocumentVersionMetadata](DocumentVersionMetadata.md)
|
|
24
25
|
|
|
25
26
|
## Example
|
|
@@ -42,6 +43,7 @@ const example = {
|
|
|
42
43
|
"updatedAt": null,
|
|
43
44
|
"assetS3Url": null,
|
|
44
45
|
"fastPlaintextUrl": null,
|
|
46
|
+
"pageScreenshotUrls": null,
|
|
45
47
|
"systemMetadata": null,
|
|
46
48
|
} satisfies DocumentVersionResponse
|
|
47
49
|
|
|
@@ -316,7 +316,7 @@ No authorization required
|
|
|
316
316
|
|
|
317
317
|
## getDocumentVersion
|
|
318
318
|
|
|
319
|
-
> DocumentVersionResponse getDocumentVersion(versionId, authorization, ksUat)
|
|
319
|
+
> DocumentVersionResponse getDocumentVersion(versionId, includePageScreenshots, authorization, ksUat)
|
|
320
320
|
|
|
321
321
|
Get Document Version Handler
|
|
322
322
|
|
|
@@ -338,6 +338,8 @@ async function example() {
|
|
|
338
338
|
const body = {
|
|
339
339
|
// string | DocumentVersion ID
|
|
340
340
|
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
341
|
+
// boolean | When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small. (optional)
|
|
342
|
+
includePageScreenshots: true,
|
|
341
343
|
// string (optional)
|
|
342
344
|
authorization: authorization_example,
|
|
343
345
|
// string (optional)
|
|
@@ -362,6 +364,7 @@ example().catch(console.error);
|
|
|
362
364
|
| Name | Type | Description | Notes |
|
|
363
365
|
|------------- | ------------- | ------------- | -------------|
|
|
364
366
|
| **versionId** | `string` | DocumentVersion ID | [Defaults to `undefined`] |
|
|
367
|
+
| **includePageScreenshots** | `boolean` | When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small. | [Optional] [Defaults to `false`] |
|
|
365
368
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
366
369
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
367
370
|
|
|
@@ -8,6 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`steps` | [Array<StepInput>](StepInput.md)
|
|
10
10
|
`checkpoint` | [CheckpointDetails](CheckpointDetails.md)
|
|
11
|
+
`modelId` | string
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ import type { ThreadMessageDetailsInput } from '@knowledge-stack/ksapi'
|
|
|
18
19
|
const example = {
|
|
19
20
|
"steps": null,
|
|
20
21
|
"checkpoint": null,
|
|
22
|
+
"modelId": null,
|
|
21
23
|
} satisfies ThreadMessageDetailsInput
|
|
22
24
|
|
|
23
25
|
console.log(example)
|
|
@@ -8,6 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`steps` | [Array<StepOutput>](StepOutput.md)
|
|
10
10
|
`checkpoint` | [CheckpointDetails](CheckpointDetails.md)
|
|
11
|
+
`modelId` | string
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ import type { ThreadMessageDetailsOutput } from '@knowledge-stack/ksapi'
|
|
|
18
19
|
const example = {
|
|
19
20
|
"steps": null,
|
|
20
21
|
"checkpoint": null,
|
|
22
|
+
"modelId": null,
|
|
21
23
|
} satisfies ThreadMessageDetailsOutput
|
|
22
24
|
|
|
23
25
|
console.log(example)
|
package/package.json
CHANGED
|
@@ -73,6 +73,7 @@ export interface DocumentVersionActionRequest {
|
|
|
73
73
|
|
|
74
74
|
export interface GetDocumentVersionRequest {
|
|
75
75
|
versionId: string;
|
|
76
|
+
includePageScreenshots?: boolean;
|
|
76
77
|
authorization?: string | null;
|
|
77
78
|
ksUat?: string | null;
|
|
78
79
|
}
|
|
@@ -226,6 +227,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
226
227
|
/**
|
|
227
228
|
* Creates request options for getDocumentVersion without sending the request
|
|
228
229
|
* @param {string} versionId DocumentVersion ID
|
|
230
|
+
* @param {boolean} [includePageScreenshots] When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small.
|
|
229
231
|
* @param {string} [authorization]
|
|
230
232
|
* @param {string} [ksUat]
|
|
231
233
|
* @throws {RequiredError}
|
|
@@ -237,6 +239,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
237
239
|
* Get a document version by its ID.
|
|
238
240
|
* @summary Get Document Version Handler
|
|
239
241
|
* @param {string} versionId DocumentVersion ID
|
|
242
|
+
* @param {boolean} [includePageScreenshots] When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small.
|
|
240
243
|
* @param {string} [authorization]
|
|
241
244
|
* @param {string} [ksUat]
|
|
242
245
|
* @param {*} [options] Override http request option.
|
|
@@ -583,6 +586,10 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
|
|
|
583
586
|
|
|
584
587
|
const queryParameters: any = {};
|
|
585
588
|
|
|
589
|
+
if (requestParameters['includePageScreenshots'] != null) {
|
|
590
|
+
queryParameters['include_page_screenshots'] = requestParameters['includePageScreenshots'];
|
|
591
|
+
}
|
|
592
|
+
|
|
586
593
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
587
594
|
|
|
588
595
|
if (requestParameters['authorization'] != null) {
|
|
@@ -108,6 +108,12 @@ export interface DocumentVersionResponse {
|
|
|
108
108
|
* @memberof DocumentVersionResponse
|
|
109
109
|
*/
|
|
110
110
|
fastPlaintextUrl?: string | null;
|
|
111
|
+
/**
|
|
112
|
+
* Presigned URLs (6-hour validity) to per-page WEBP screenshots in page order: index 0 is page 1, index N-1 is page N. Populated only when the request includes include_page_screenshots=true; null otherwise.
|
|
113
|
+
* @type {Array<string>}
|
|
114
|
+
* @memberof DocumentVersionResponse
|
|
115
|
+
*/
|
|
116
|
+
pageScreenshotUrls?: Array<string> | null;
|
|
111
117
|
/**
|
|
112
118
|
*
|
|
113
119
|
* @type {DocumentVersionMetadata}
|
|
@@ -174,6 +180,7 @@ export function DocumentVersionResponseFromJSONTyped(json: any, ignoreDiscrimina
|
|
|
174
180
|
'updatedAt': (new Date(json['updated_at'])),
|
|
175
181
|
'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
|
|
176
182
|
'fastPlaintextUrl': json['fast_plaintext_url'] == null ? undefined : json['fast_plaintext_url'],
|
|
183
|
+
'pageScreenshotUrls': json['page_screenshot_urls'] == null ? undefined : json['page_screenshot_urls'],
|
|
177
184
|
'systemMetadata': json['system_metadata'] == null ? undefined : DocumentVersionMetadataFromJSON(json['system_metadata']),
|
|
178
185
|
};
|
|
179
186
|
}
|
|
@@ -202,6 +209,7 @@ export function DocumentVersionResponseToJSONTyped(value?: DocumentVersionRespon
|
|
|
202
209
|
'updated_at': value['updatedAt'].toISOString(),
|
|
203
210
|
'asset_s3_url': value['assetS3Url'],
|
|
204
211
|
'fast_plaintext_url': value['fastPlaintextUrl'],
|
|
212
|
+
'page_screenshot_urls': value['pageScreenshotUrls'],
|
|
205
213
|
'system_metadata': DocumentVersionMetadataToJSON(value['systemMetadata']),
|
|
206
214
|
};
|
|
207
215
|
}
|
|
@@ -46,6 +46,12 @@ export interface ThreadMessageDetailsInput {
|
|
|
46
46
|
* @memberof ThreadMessageDetailsInput
|
|
47
47
|
*/
|
|
48
48
|
checkpoint?: CheckpointDetails | null;
|
|
49
|
+
/**
|
|
50
|
+
* Model registry id (FE-stable, e.g. ``qwen-flash``) that produced this assistant message. ``None`` for legacy rows that pre-date model selection.
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof ThreadMessageDetailsInput
|
|
53
|
+
*/
|
|
54
|
+
modelId?: string | null;
|
|
49
55
|
}
|
|
50
56
|
export const ThreadMessageDetailsInputPropertyValidationAttributesMap: {
|
|
51
57
|
[property: string]: {
|
|
@@ -62,6 +68,9 @@ export const ThreadMessageDetailsInputPropertyValidationAttributesMap: {
|
|
|
62
68
|
uniqueItems?: boolean
|
|
63
69
|
}
|
|
64
70
|
} = {
|
|
71
|
+
modelId: {
|
|
72
|
+
maxLength: 64,
|
|
73
|
+
},
|
|
65
74
|
}
|
|
66
75
|
|
|
67
76
|
|
|
@@ -84,6 +93,7 @@ export function ThreadMessageDetailsInputFromJSONTyped(json: any, ignoreDiscrimi
|
|
|
84
93
|
|
|
85
94
|
'steps': json['steps'] == null ? undefined : ((json['steps'] as Array<any>).map(StepInputFromJSON)),
|
|
86
95
|
'checkpoint': json['checkpoint'] == null ? undefined : CheckpointDetailsFromJSON(json['checkpoint']),
|
|
96
|
+
'modelId': json['model_id'] == null ? undefined : json['model_id'],
|
|
87
97
|
};
|
|
88
98
|
}
|
|
89
99
|
|
|
@@ -100,6 +110,7 @@ export function ThreadMessageDetailsInputToJSONTyped(value?: ThreadMessageDetail
|
|
|
100
110
|
|
|
101
111
|
'steps': value['steps'] == null ? undefined : ((value['steps'] as Array<any>).map(StepInputToJSON)),
|
|
102
112
|
'checkpoint': CheckpointDetailsToJSON(value['checkpoint']),
|
|
113
|
+
'model_id': value['modelId'],
|
|
103
114
|
};
|
|
104
115
|
}
|
|
105
116
|
|
|
@@ -46,6 +46,12 @@ export interface ThreadMessageDetailsOutput {
|
|
|
46
46
|
* @memberof ThreadMessageDetailsOutput
|
|
47
47
|
*/
|
|
48
48
|
checkpoint?: CheckpointDetails | null;
|
|
49
|
+
/**
|
|
50
|
+
* Model registry id (FE-stable, e.g. ``qwen-flash``) that produced this assistant message. ``None`` for legacy rows that pre-date model selection.
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof ThreadMessageDetailsOutput
|
|
53
|
+
*/
|
|
54
|
+
modelId?: string | null;
|
|
49
55
|
}
|
|
50
56
|
export const ThreadMessageDetailsOutputPropertyValidationAttributesMap: {
|
|
51
57
|
[property: string]: {
|
|
@@ -62,6 +68,9 @@ export const ThreadMessageDetailsOutputPropertyValidationAttributesMap: {
|
|
|
62
68
|
uniqueItems?: boolean
|
|
63
69
|
}
|
|
64
70
|
} = {
|
|
71
|
+
modelId: {
|
|
72
|
+
maxLength: 64,
|
|
73
|
+
},
|
|
65
74
|
}
|
|
66
75
|
|
|
67
76
|
|
|
@@ -84,6 +93,7 @@ export function ThreadMessageDetailsOutputFromJSONTyped(json: any, ignoreDiscrim
|
|
|
84
93
|
|
|
85
94
|
'steps': json['steps'] == null ? undefined : ((json['steps'] as Array<any>).map(StepOutputFromJSON)),
|
|
86
95
|
'checkpoint': json['checkpoint'] == null ? undefined : CheckpointDetailsFromJSON(json['checkpoint']),
|
|
96
|
+
'modelId': json['model_id'] == null ? undefined : json['model_id'],
|
|
87
97
|
};
|
|
88
98
|
}
|
|
89
99
|
|
|
@@ -100,6 +110,7 @@ export function ThreadMessageDetailsOutputToJSONTyped(value?: ThreadMessageDetai
|
|
|
100
110
|
|
|
101
111
|
'steps': value['steps'] == null ? undefined : ((value['steps'] as Array<any>).map(StepOutputToJSON)),
|
|
102
112
|
'checkpoint': CheckpointDetailsToJSON(value['checkpoint']),
|
|
113
|
+
'model_id': value['modelId'],
|
|
103
114
|
};
|
|
104
115
|
}
|
|
105
116
|
|