@knowledge-stack/ksapi 1.85.0 → 1.86.1

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 (44) hide show
  1. package/.openapi-generator/FILES +0 -2
  2. package/README.md +2 -5
  3. package/dist/apis/DocumentVersionsApi.d.ts +3 -0
  4. package/dist/apis/DocumentVersionsApi.js +3 -0
  5. package/dist/apis/WorkflowRunsApi.d.ts +13 -101
  6. package/dist/apis/WorkflowRunsApi.js +6 -93
  7. package/dist/esm/apis/DocumentVersionsApi.d.ts +3 -0
  8. package/dist/esm/apis/DocumentVersionsApi.js +3 -0
  9. package/dist/esm/apis/WorkflowRunsApi.d.ts +13 -101
  10. package/dist/esm/apis/WorkflowRunsApi.js +7 -94
  11. package/dist/esm/models/DocumentVersionResponse.d.ts +6 -0
  12. package/dist/esm/models/DocumentVersionResponse.js +2 -0
  13. package/dist/esm/models/ThreadMessageDetailsInput.d.ts +6 -0
  14. package/dist/esm/models/ThreadMessageDetailsInput.js +7 -1
  15. package/dist/esm/models/ThreadMessageDetailsOutput.d.ts +6 -0
  16. package/dist/esm/models/ThreadMessageDetailsOutput.js +7 -1
  17. package/dist/esm/models/index.d.ts +0 -1
  18. package/dist/esm/models/index.js +0 -1
  19. package/dist/models/DocumentVersionResponse.d.ts +6 -0
  20. package/dist/models/DocumentVersionResponse.js +2 -0
  21. package/dist/models/ThreadMessageDetailsInput.d.ts +6 -0
  22. package/dist/models/ThreadMessageDetailsInput.js +7 -1
  23. package/dist/models/ThreadMessageDetailsOutput.d.ts +6 -0
  24. package/dist/models/ThreadMessageDetailsOutput.js +7 -1
  25. package/dist/models/index.d.ts +0 -1
  26. package/dist/models/index.js +0 -1
  27. package/docs/DocumentVersionResponse.md +2 -0
  28. package/docs/DocumentVersionsApi.md +4 -1
  29. package/docs/ThreadMessageDetailsInput.md +2 -0
  30. package/docs/ThreadMessageDetailsOutput.md +2 -0
  31. package/docs/WorkflowRunsApi.md +3 -153
  32. package/package.json +1 -1
  33. package/src/apis/DocumentVersionsApi.ts +7 -0
  34. package/src/apis/WorkflowRunsApi.ts +12 -184
  35. package/src/models/DocumentVersionResponse.ts +8 -0
  36. package/src/models/ThreadMessageDetailsInput.ts +11 -0
  37. package/src/models/ThreadMessageDetailsOutput.ts +11 -0
  38. package/src/models/index.ts +0 -1
  39. package/dist/esm/models/RunLockResponse.d.ts +0 -59
  40. package/dist/esm/models/RunLockResponse.js +0 -52
  41. package/dist/models/RunLockResponse.d.ts +0 -59
  42. package/dist/models/RunLockResponse.js +0 -60
  43. package/docs/RunLockResponse.md +0 -39
  44. package/src/models/RunLockResponse.ts +0 -101
@@ -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
 
@@ -142,7 +142,6 @@ export * from './RejectFileRequest';
142
142
  export * from './ResolvedReferenceInput';
143
143
  export * from './ResolvedReferenceOutput';
144
144
  export * from './RootResponse';
145
- export * from './RunLockResponse';
146
145
  export * from './SSOInitiateResponse';
147
146
  export * from './ScoredChunkResponse';
148
147
  export * from './SearchSortOrder';
@@ -1,59 +0,0 @@
1
- /**
2
- * Knowledge Stack API
3
- * Knowledge Stack backend API for authentication and knowledge management
4
- *
5
- * The version of the OpenAPI document: 0.1.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * Reviewer-lock state on a workflow run.
14
- * @export
15
- * @interface RunLockResponse
16
- */
17
- export interface RunLockResponse {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof RunLockResponse
22
- */
23
- runId: string;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof RunLockResponse
28
- */
29
- lockUserId: string | null;
30
- /**
31
- *
32
- * @type {Date}
33
- * @memberof RunLockResponse
34
- */
35
- lockAcquiredAt: Date | null;
36
- }
37
- export declare const RunLockResponsePropertyValidationAttributesMap: {
38
- [property: string]: {
39
- maxLength?: number;
40
- minLength?: number;
41
- pattern?: string;
42
- maximum?: number;
43
- exclusiveMaximum?: boolean;
44
- minimum?: number;
45
- exclusiveMinimum?: boolean;
46
- multipleOf?: number;
47
- maxItems?: number;
48
- minItems?: number;
49
- uniqueItems?: boolean;
50
- };
51
- };
52
- /**
53
- * Check if a given object implements the RunLockResponse interface.
54
- */
55
- export declare function instanceOfRunLockResponse(value: object): value is RunLockResponse;
56
- export declare function RunLockResponseFromJSON(json: any): RunLockResponse;
57
- export declare function RunLockResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunLockResponse;
58
- export declare function RunLockResponseToJSON(json: any): RunLockResponse;
59
- export declare function RunLockResponseToJSONTyped(value?: RunLockResponse | null, ignoreDiscriminator?: boolean): any;
@@ -1,52 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Knowledge Stack API
5
- * Knowledge Stack backend API for authentication and knowledge management
6
- *
7
- * The version of the OpenAPI document: 0.1.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export const RunLockResponsePropertyValidationAttributesMap = {};
15
- /**
16
- * Check if a given object implements the RunLockResponse interface.
17
- */
18
- export function instanceOfRunLockResponse(value) {
19
- if (!('runId' in value) || value['runId'] === undefined)
20
- return false;
21
- if (!('lockUserId' in value) || value['lockUserId'] === undefined)
22
- return false;
23
- if (!('lockAcquiredAt' in value) || value['lockAcquiredAt'] === undefined)
24
- return false;
25
- return true;
26
- }
27
- export function RunLockResponseFromJSON(json) {
28
- return RunLockResponseFromJSONTyped(json, false);
29
- }
30
- export function RunLockResponseFromJSONTyped(json, ignoreDiscriminator) {
31
- if (json == null) {
32
- return json;
33
- }
34
- return {
35
- 'runId': json['run_id'],
36
- 'lockUserId': json['lock_user_id'],
37
- 'lockAcquiredAt': (json['lock_acquired_at'] == null ? null : new Date(json['lock_acquired_at'])),
38
- };
39
- }
40
- export function RunLockResponseToJSON(json) {
41
- return RunLockResponseToJSONTyped(json, false);
42
- }
43
- export function RunLockResponseToJSONTyped(value, ignoreDiscriminator = false) {
44
- if (value == null) {
45
- return value;
46
- }
47
- return {
48
- 'run_id': value['runId'],
49
- 'lock_user_id': value['lockUserId'],
50
- 'lock_acquired_at': value['lockAcquiredAt'] == null ? value['lockAcquiredAt'] : value['lockAcquiredAt'].toISOString(),
51
- };
52
- }
@@ -1,59 +0,0 @@
1
- /**
2
- * Knowledge Stack API
3
- * Knowledge Stack backend API for authentication and knowledge management
4
- *
5
- * The version of the OpenAPI document: 0.1.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * Reviewer-lock state on a workflow run.
14
- * @export
15
- * @interface RunLockResponse
16
- */
17
- export interface RunLockResponse {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof RunLockResponse
22
- */
23
- runId: string;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof RunLockResponse
28
- */
29
- lockUserId: string | null;
30
- /**
31
- *
32
- * @type {Date}
33
- * @memberof RunLockResponse
34
- */
35
- lockAcquiredAt: Date | null;
36
- }
37
- export declare const RunLockResponsePropertyValidationAttributesMap: {
38
- [property: string]: {
39
- maxLength?: number;
40
- minLength?: number;
41
- pattern?: string;
42
- maximum?: number;
43
- exclusiveMaximum?: boolean;
44
- minimum?: number;
45
- exclusiveMinimum?: boolean;
46
- multipleOf?: number;
47
- maxItems?: number;
48
- minItems?: number;
49
- uniqueItems?: boolean;
50
- };
51
- };
52
- /**
53
- * Check if a given object implements the RunLockResponse interface.
54
- */
55
- export declare function instanceOfRunLockResponse(value: object): value is RunLockResponse;
56
- export declare function RunLockResponseFromJSON(json: any): RunLockResponse;
57
- export declare function RunLockResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunLockResponse;
58
- export declare function RunLockResponseToJSON(json: any): RunLockResponse;
59
- export declare function RunLockResponseToJSONTyped(value?: RunLockResponse | null, ignoreDiscriminator?: boolean): any;
@@ -1,60 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Knowledge Stack API
6
- * Knowledge Stack backend API for authentication and knowledge management
7
- *
8
- * The version of the OpenAPI document: 0.1.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.RunLockResponsePropertyValidationAttributesMap = void 0;
17
- exports.instanceOfRunLockResponse = instanceOfRunLockResponse;
18
- exports.RunLockResponseFromJSON = RunLockResponseFromJSON;
19
- exports.RunLockResponseFromJSONTyped = RunLockResponseFromJSONTyped;
20
- exports.RunLockResponseToJSON = RunLockResponseToJSON;
21
- exports.RunLockResponseToJSONTyped = RunLockResponseToJSONTyped;
22
- exports.RunLockResponsePropertyValidationAttributesMap = {};
23
- /**
24
- * Check if a given object implements the RunLockResponse interface.
25
- */
26
- function instanceOfRunLockResponse(value) {
27
- if (!('runId' in value) || value['runId'] === undefined)
28
- return false;
29
- if (!('lockUserId' in value) || value['lockUserId'] === undefined)
30
- return false;
31
- if (!('lockAcquiredAt' in value) || value['lockAcquiredAt'] === undefined)
32
- return false;
33
- return true;
34
- }
35
- function RunLockResponseFromJSON(json) {
36
- return RunLockResponseFromJSONTyped(json, false);
37
- }
38
- function RunLockResponseFromJSONTyped(json, ignoreDiscriminator) {
39
- if (json == null) {
40
- return json;
41
- }
42
- return {
43
- 'runId': json['run_id'],
44
- 'lockUserId': json['lock_user_id'],
45
- 'lockAcquiredAt': (json['lock_acquired_at'] == null ? null : new Date(json['lock_acquired_at'])),
46
- };
47
- }
48
- function RunLockResponseToJSON(json) {
49
- return RunLockResponseToJSONTyped(json, false);
50
- }
51
- function RunLockResponseToJSONTyped(value, ignoreDiscriminator = false) {
52
- if (value == null) {
53
- return value;
54
- }
55
- return {
56
- 'run_id': value['runId'],
57
- 'lock_user_id': value['lockUserId'],
58
- 'lock_acquired_at': value['lockAcquiredAt'] == null ? value['lockAcquiredAt'] : value['lockAcquiredAt'].toISOString(),
59
- };
60
- }
@@ -1,39 +0,0 @@
1
-
2
- # RunLockResponse
3
-
4
- Reviewer-lock state on a workflow run.
5
-
6
- ## Properties
7
-
8
- Name | Type
9
- ------------ | -------------
10
- `runId` | string
11
- `lockUserId` | string
12
- `lockAcquiredAt` | Date
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import type { RunLockResponse } from '@knowledge-stack/ksapi'
18
-
19
- // TODO: Update the object below with actual values
20
- const example = {
21
- "runId": null,
22
- "lockUserId": null,
23
- "lockAcquiredAt": null,
24
- } satisfies RunLockResponse
25
-
26
- console.log(example)
27
-
28
- // Convert the instance to a JSON string
29
- const exampleJSON: string = JSON.stringify(example)
30
- console.log(exampleJSON)
31
-
32
- // Parse the JSON string back to an object
33
- const exampleParsed = JSON.parse(exampleJSON) as RunLockResponse
34
- console.log(exampleParsed)
35
- ```
36
-
37
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
-
39
-
@@ -1,101 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Knowledge Stack API
5
- * Knowledge Stack backend API for authentication and knowledge management
6
- *
7
- * The version of the OpenAPI document: 0.1.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
- import { mapValues } from '../runtime';
16
- /**
17
- * Reviewer-lock state on a workflow run.
18
- * @export
19
- * @interface RunLockResponse
20
- */
21
- export interface RunLockResponse {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof RunLockResponse
26
- */
27
- runId: string;
28
- /**
29
- *
30
- * @type {string}
31
- * @memberof RunLockResponse
32
- */
33
- lockUserId: string | null;
34
- /**
35
- *
36
- * @type {Date}
37
- * @memberof RunLockResponse
38
- */
39
- lockAcquiredAt: Date | null;
40
- }
41
- export const RunLockResponsePropertyValidationAttributesMap: {
42
- [property: string]: {
43
- maxLength?: number,
44
- minLength?: number,
45
- pattern?: string,
46
- maximum?: number,
47
- exclusiveMaximum?: boolean,
48
- minimum?: number,
49
- exclusiveMinimum?: boolean,
50
- multipleOf?: number,
51
- maxItems?: number,
52
- minItems?: number,
53
- uniqueItems?: boolean
54
- }
55
- } = {
56
- }
57
-
58
-
59
- /**
60
- * Check if a given object implements the RunLockResponse interface.
61
- */
62
- export function instanceOfRunLockResponse(value: object): value is RunLockResponse {
63
- if (!('runId' in value) || value['runId'] === undefined) return false;
64
- if (!('lockUserId' in value) || value['lockUserId'] === undefined) return false;
65
- if (!('lockAcquiredAt' in value) || value['lockAcquiredAt'] === undefined) return false;
66
- return true;
67
- }
68
-
69
- export function RunLockResponseFromJSON(json: any): RunLockResponse {
70
- return RunLockResponseFromJSONTyped(json, false);
71
- }
72
-
73
- export function RunLockResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunLockResponse {
74
- if (json == null) {
75
- return json;
76
- }
77
- return {
78
-
79
- 'runId': json['run_id'],
80
- 'lockUserId': json['lock_user_id'],
81
- 'lockAcquiredAt': (json['lock_acquired_at'] == null ? null : new Date(json['lock_acquired_at'])),
82
- };
83
- }
84
-
85
- export function RunLockResponseToJSON(json: any): RunLockResponse {
86
- return RunLockResponseToJSONTyped(json, false);
87
- }
88
-
89
- export function RunLockResponseToJSONTyped(value?: RunLockResponse | null, ignoreDiscriminator: boolean = false): any {
90
- if (value == null) {
91
- return value;
92
- }
93
-
94
- return {
95
-
96
- 'run_id': value['runId'],
97
- 'lock_user_id': value['lockUserId'],
98
- 'lock_acquired_at': value['lockAcquiredAt'] == null ? value['lockAcquiredAt'] : value['lockAcquiredAt'].toISOString(),
99
- };
100
- }
101
-