@knowledge-stack/ksapi 1.119.0 → 1.120.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.
- package/.openapi-generator/FILES +6 -0
- package/README.md +5 -2
- package/dist/esm/models/CommonFileExclusionReason.d.ts +29 -0
- package/dist/esm/models/CommonFileExclusionReason.js +47 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +6 -0
- package/dist/esm/models/ExcludedCommonFile.d.ts +58 -0
- package/dist/esm/models/ExcludedCommonFile.js +49 -0
- package/dist/esm/models/InputOrigin.d.ts +30 -0
- package/dist/esm/models/InputOrigin.js +48 -0
- package/dist/esm/models/InputSnapshot.d.ts +7 -0
- package/dist/esm/models/InputSnapshot.js +3 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +6 -0
- package/dist/esm/models/WorkflowDefinitionResponse.d.ts +6 -0
- package/dist/esm/models/WorkflowDefinitionResponse.js +2 -0
- package/dist/esm/models/WorkflowRunResponse.d.ts +7 -0
- package/dist/esm/models/WorkflowRunResponse.js +3 -0
- package/dist/esm/models/WorkflowRunSnapshot.d.ts +7 -0
- package/dist/esm/models/WorkflowRunSnapshot.js +3 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/CommonFileExclusionReason.d.ts +29 -0
- package/dist/models/CommonFileExclusionReason.js +55 -0
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/models/CreateWorkflowDefinitionRequest.js +6 -0
- package/dist/models/ExcludedCommonFile.d.ts +58 -0
- package/dist/models/ExcludedCommonFile.js +57 -0
- package/dist/models/InputOrigin.d.ts +30 -0
- package/dist/models/InputOrigin.js +56 -0
- package/dist/models/InputSnapshot.d.ts +7 -0
- package/dist/models/InputSnapshot.js +3 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.js +6 -0
- package/dist/models/WorkflowDefinitionResponse.d.ts +6 -0
- package/dist/models/WorkflowDefinitionResponse.js +2 -0
- package/dist/models/WorkflowRunResponse.d.ts +7 -0
- package/dist/models/WorkflowRunResponse.js +3 -0
- package/dist/models/WorkflowRunSnapshot.d.ts +7 -0
- package/dist/models/WorkflowRunSnapshot.js +3 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/CommonFileExclusionReason.md +33 -0
- package/docs/CreateWorkflowDefinitionRequest.md +2 -0
- package/docs/ExcludedCommonFile.md +37 -0
- package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md +4 -0
- package/docs/InputOrigin.md +33 -0
- package/docs/InputSnapshot.md +2 -0
- package/docs/UpdateWorkflowDefinitionRequest.md +2 -0
- package/docs/WorkflowDefinitionResponse.md +2 -0
- package/docs/WorkflowRunResponse.md +2 -0
- package/docs/WorkflowRunSnapshot.md +2 -0
- package/package.json +1 -1
- package/src/models/CommonFileExclusionReason.ts +57 -0
- package/src/models/CreateWorkflowDefinitionRequest.ts +12 -0
- package/src/models/ExcludedCommonFile.ts +106 -0
- package/src/models/InputOrigin.ts +58 -0
- package/src/models/InputSnapshot.ts +16 -0
- package/src/models/UpdateWorkflowDefinitionRequest.ts +12 -0
- package/src/models/WorkflowDefinitionResponse.ts +8 -0
- package/src/models/WorkflowRunResponse.ts +15 -0
- package/src/models/WorkflowRunSnapshot.ts +15 -0
- package/src/models/index.ts +3 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -57,6 +57,7 @@ docs/ClearVersionContentsResponse.md
|
|
|
57
57
|
docs/CloneWorkflowRunRequest.md
|
|
58
58
|
docs/ColumnConfig.md
|
|
59
59
|
docs/ColumnReference.md
|
|
60
|
+
docs/CommonFileExclusionReason.md
|
|
60
61
|
docs/ConnectionConfig.md
|
|
61
62
|
docs/CreateApiConnectionRequest.md
|
|
62
63
|
docs/CreateApiKeyRequest.md
|
|
@@ -123,6 +124,7 @@ docs/EnrichedCitation.md
|
|
|
123
124
|
docs/EnrichedThreadMessageContent.md
|
|
124
125
|
docs/ErrorResponse.md
|
|
125
126
|
docs/EventResponse.md
|
|
127
|
+
docs/ExcludedCommonFile.md
|
|
126
128
|
docs/ExtractRequest.md
|
|
127
129
|
docs/ExtractResponse.md
|
|
128
130
|
docs/FeaturesApi.md
|
|
@@ -151,6 +153,7 @@ docs/ImageTaxonomy.md
|
|
|
151
153
|
docs/InformationStatistics.md
|
|
152
154
|
docs/IngestDocumentResponse.md
|
|
153
155
|
docs/IngestionMode.md
|
|
156
|
+
docs/InputOrigin.md
|
|
154
157
|
docs/InputSnapshot.md
|
|
155
158
|
docs/InstantiateWorkflowTemplateRequest.md
|
|
156
159
|
docs/InstructionSnapshot.md
|
|
@@ -436,6 +439,7 @@ src/models/ClearVersionContentsResponse.ts
|
|
|
436
439
|
src/models/CloneWorkflowRunRequest.ts
|
|
437
440
|
src/models/ColumnConfig.ts
|
|
438
441
|
src/models/ColumnReference.ts
|
|
442
|
+
src/models/CommonFileExclusionReason.ts
|
|
439
443
|
src/models/ConnectionConfig.ts
|
|
440
444
|
src/models/CreateApiConnectionRequest.ts
|
|
441
445
|
src/models/CreateApiKeyRequest.ts
|
|
@@ -497,6 +501,7 @@ src/models/EnrichedCitation.ts
|
|
|
497
501
|
src/models/EnrichedThreadMessageContent.ts
|
|
498
502
|
src/models/ErrorResponse.ts
|
|
499
503
|
src/models/EventResponse.ts
|
|
504
|
+
src/models/ExcludedCommonFile.ts
|
|
500
505
|
src/models/ExtractRequest.ts
|
|
501
506
|
src/models/ExtractResponse.ts
|
|
502
507
|
src/models/FeaturesResponse.ts
|
|
@@ -522,6 +527,7 @@ src/models/ImageTaxonomy.ts
|
|
|
522
527
|
src/models/InformationStatistics.ts
|
|
523
528
|
src/models/IngestDocumentResponse.ts
|
|
524
529
|
src/models/IngestionMode.ts
|
|
530
|
+
src/models/InputOrigin.ts
|
|
525
531
|
src/models/InputSnapshot.ts
|
|
526
532
|
src/models/InstantiateWorkflowTemplateRequest.ts
|
|
527
533
|
src/models/InstructionSnapshot.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.120.1
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -314,6 +314,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
314
314
|
- [CloneWorkflowRunRequest](docs/CloneWorkflowRunRequest.md)
|
|
315
315
|
- [ColumnConfig](docs/ColumnConfig.md)
|
|
316
316
|
- [ColumnReference](docs/ColumnReference.md)
|
|
317
|
+
- [CommonFileExclusionReason](docs/CommonFileExclusionReason.md)
|
|
317
318
|
- [ConnectionConfig](docs/ConnectionConfig.md)
|
|
318
319
|
- [CreateApiConnectionRequest](docs/CreateApiConnectionRequest.md)
|
|
319
320
|
- [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
|
@@ -375,6 +376,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
375
376
|
- [EnrichedThreadMessageContent](docs/EnrichedThreadMessageContent.md)
|
|
376
377
|
- [ErrorResponse](docs/ErrorResponse.md)
|
|
377
378
|
- [EventResponse](docs/EventResponse.md)
|
|
379
|
+
- [ExcludedCommonFile](docs/ExcludedCommonFile.md)
|
|
378
380
|
- [ExtractRequest](docs/ExtractRequest.md)
|
|
379
381
|
- [ExtractResponse](docs/ExtractResponse.md)
|
|
380
382
|
- [FeaturesResponse](docs/FeaturesResponse.md)
|
|
@@ -400,6 +402,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
400
402
|
- [InformationStatistics](docs/InformationStatistics.md)
|
|
401
403
|
- [IngestDocumentResponse](docs/IngestDocumentResponse.md)
|
|
402
404
|
- [IngestionMode](docs/IngestionMode.md)
|
|
405
|
+
- [InputOrigin](docs/InputOrigin.md)
|
|
403
406
|
- [InputSnapshot](docs/InputSnapshot.md)
|
|
404
407
|
- [InstantiateWorkflowTemplateRequest](docs/InstantiateWorkflowTemplateRequest.md)
|
|
405
408
|
- [InstructionSnapshot](docs/InstructionSnapshot.md)
|
|
@@ -606,7 +609,7 @@ and is automatically generated by the
|
|
|
606
609
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
607
610
|
|
|
608
611
|
- API version: `0.1.0`
|
|
609
|
-
- Package version: `1.
|
|
612
|
+
- Package version: `1.120.1`
|
|
610
613
|
- Generator version: `7.21.0`
|
|
611
614
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
612
615
|
|
|
@@ -0,0 +1,29 @@
|
|
|
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
|
+
* Why a definition common file was left out of a run at Start.
|
|
14
|
+
*
|
|
15
|
+
* Common files resolve resiliently (record-and-continue): an unresolvable
|
|
16
|
+
* one is excluded with one of these reasons rather than failing the run.
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const CommonFileExclusionReason: {
|
|
20
|
+
readonly NotFound: "NOT_FOUND";
|
|
21
|
+
readonly NoAccess: "NO_ACCESS";
|
|
22
|
+
readonly Unresolvable: "UNRESOLVABLE";
|
|
23
|
+
};
|
|
24
|
+
export type CommonFileExclusionReason = typeof CommonFileExclusionReason[keyof typeof CommonFileExclusionReason];
|
|
25
|
+
export declare function instanceOfCommonFileExclusionReason(value: any): boolean;
|
|
26
|
+
export declare function CommonFileExclusionReasonFromJSON(json: any): CommonFileExclusionReason;
|
|
27
|
+
export declare function CommonFileExclusionReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommonFileExclusionReason;
|
|
28
|
+
export declare function CommonFileExclusionReasonToJSON(value?: CommonFileExclusionReason | null): any;
|
|
29
|
+
export declare function CommonFileExclusionReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): CommonFileExclusionReason;
|
|
@@ -0,0 +1,47 @@
|
|
|
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
|
+
* Why a definition common file was left out of a run at Start.
|
|
16
|
+
*
|
|
17
|
+
* Common files resolve resiliently (record-and-continue): an unresolvable
|
|
18
|
+
* one is excluded with one of these reasons rather than failing the run.
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export const CommonFileExclusionReason = {
|
|
22
|
+
NotFound: 'NOT_FOUND',
|
|
23
|
+
NoAccess: 'NO_ACCESS',
|
|
24
|
+
Unresolvable: 'UNRESOLVABLE'
|
|
25
|
+
};
|
|
26
|
+
export function instanceOfCommonFileExclusionReason(value) {
|
|
27
|
+
for (const key in CommonFileExclusionReason) {
|
|
28
|
+
if (Object.prototype.hasOwnProperty.call(CommonFileExclusionReason, key)) {
|
|
29
|
+
if (CommonFileExclusionReason[key] === value) {
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
return false;
|
|
35
|
+
}
|
|
36
|
+
export function CommonFileExclusionReasonFromJSON(json) {
|
|
37
|
+
return CommonFileExclusionReasonFromJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function CommonFileExclusionReasonFromJSONTyped(json, ignoreDiscriminator) {
|
|
40
|
+
return json;
|
|
41
|
+
}
|
|
42
|
+
export function CommonFileExclusionReasonToJSON(value) {
|
|
43
|
+
return value;
|
|
44
|
+
}
|
|
45
|
+
export function CommonFileExclusionReasonToJSONTyped(value, ignoreDiscriminator) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
@@ -61,6 +61,12 @@ export interface CreateWorkflowDefinitionRequest {
|
|
|
61
61
|
* @memberof CreateWorkflowDefinitionRequest
|
|
62
62
|
*/
|
|
63
63
|
isTemplate?: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Optional path_part ids of common files (DOCUMENT / FOLDER / DATA_SOURCE / API_CONNECTION) attached to every run of this workflow — e.g. an output template. Merged with each run's own inputs at Start. The caller must be able to read each one.
|
|
66
|
+
* @type {Array<string>}
|
|
67
|
+
* @memberof CreateWorkflowDefinitionRequest
|
|
68
|
+
*/
|
|
69
|
+
commonFilePathPartIds?: Array<string>;
|
|
64
70
|
}
|
|
65
71
|
export declare const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
|
|
66
72
|
[property: string]: {
|
|
@@ -21,6 +21,10 @@ export const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap = {
|
|
|
21
21
|
minimum: 60,
|
|
22
22
|
exclusiveMinimum: false,
|
|
23
23
|
},
|
|
24
|
+
commonFilePathPartIds: {
|
|
25
|
+
maxItems: 20,
|
|
26
|
+
uniqueItems: false,
|
|
27
|
+
},
|
|
24
28
|
};
|
|
25
29
|
/**
|
|
26
30
|
* Check if a given object implements the CreateWorkflowDefinitionRequest interface.
|
|
@@ -49,6 +53,7 @@ export function CreateWorkflowDefinitionRequestFromJSONTyped(json, ignoreDiscrim
|
|
|
49
53
|
'instructionPathPartId': json['instruction_path_part_id'] == null ? undefined : json['instruction_path_part_id'],
|
|
50
54
|
'approvalRequired': json['approval_required'],
|
|
51
55
|
'isTemplate': json['is_template'] == null ? undefined : json['is_template'],
|
|
56
|
+
'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
|
|
52
57
|
};
|
|
53
58
|
}
|
|
54
59
|
export function CreateWorkflowDefinitionRequestToJSON(json) {
|
|
@@ -66,5 +71,6 @@ export function CreateWorkflowDefinitionRequestToJSONTyped(value, ignoreDiscrimi
|
|
|
66
71
|
'instruction_path_part_id': value['instructionPathPartId'],
|
|
67
72
|
'approval_required': value['approvalRequired'],
|
|
68
73
|
'is_template': value['isTemplate'],
|
|
74
|
+
'common_file_path_part_ids': value['commonFilePathPartIds'],
|
|
69
75
|
};
|
|
70
76
|
}
|
|
@@ -0,0 +1,58 @@
|
|
|
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
|
+
import type { CommonFileExclusionReason } from './CommonFileExclusionReason';
|
|
13
|
+
/**
|
|
14
|
+
* A definition common file that could not be applied to a run at Start.
|
|
15
|
+
*
|
|
16
|
+
* Common files resolve resiliently (record-and-continue): one that is
|
|
17
|
+
* missing/deleted or unreadable by the run-starter is recorded here rather
|
|
18
|
+
* than failing the run, so the exclusion is auditable and visible to the FE.
|
|
19
|
+
* @export
|
|
20
|
+
* @interface ExcludedCommonFile
|
|
21
|
+
*/
|
|
22
|
+
export interface ExcludedCommonFile {
|
|
23
|
+
/**
|
|
24
|
+
* The common file's path_part id, as set on the definition
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof ExcludedCommonFile
|
|
27
|
+
*/
|
|
28
|
+
pathPartId: string;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {CommonFileExclusionReason}
|
|
32
|
+
* @memberof ExcludedCommonFile
|
|
33
|
+
*/
|
|
34
|
+
reason: CommonFileExclusionReason;
|
|
35
|
+
}
|
|
36
|
+
export declare const ExcludedCommonFilePropertyValidationAttributesMap: {
|
|
37
|
+
[property: string]: {
|
|
38
|
+
maxLength?: number;
|
|
39
|
+
minLength?: number;
|
|
40
|
+
pattern?: string;
|
|
41
|
+
maximum?: number;
|
|
42
|
+
exclusiveMaximum?: boolean;
|
|
43
|
+
minimum?: number;
|
|
44
|
+
exclusiveMinimum?: boolean;
|
|
45
|
+
multipleOf?: number;
|
|
46
|
+
maxItems?: number;
|
|
47
|
+
minItems?: number;
|
|
48
|
+
uniqueItems?: boolean;
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the ExcludedCommonFile interface.
|
|
53
|
+
*/
|
|
54
|
+
export declare function instanceOfExcludedCommonFile(value: object): value is ExcludedCommonFile;
|
|
55
|
+
export declare function ExcludedCommonFileFromJSON(json: any): ExcludedCommonFile;
|
|
56
|
+
export declare function ExcludedCommonFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExcludedCommonFile;
|
|
57
|
+
export declare function ExcludedCommonFileToJSON(json: any): ExcludedCommonFile;
|
|
58
|
+
export declare function ExcludedCommonFileToJSONTyped(value?: ExcludedCommonFile | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,49 @@
|
|
|
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
|
+
import { CommonFileExclusionReasonFromJSON, CommonFileExclusionReasonToJSON, } from './CommonFileExclusionReason';
|
|
15
|
+
export const ExcludedCommonFilePropertyValidationAttributesMap = {};
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the ExcludedCommonFile interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfExcludedCommonFile(value) {
|
|
20
|
+
if (!('pathPartId' in value) || value['pathPartId'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('reason' in value) || value['reason'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
export function ExcludedCommonFileFromJSON(json) {
|
|
27
|
+
return ExcludedCommonFileFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
export function ExcludedCommonFileFromJSONTyped(json, ignoreDiscriminator) {
|
|
30
|
+
if (json == null) {
|
|
31
|
+
return json;
|
|
32
|
+
}
|
|
33
|
+
return {
|
|
34
|
+
'pathPartId': json['path_part_id'],
|
|
35
|
+
'reason': CommonFileExclusionReasonFromJSON(json['reason']),
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
export function ExcludedCommonFileToJSON(json) {
|
|
39
|
+
return ExcludedCommonFileToJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
export function ExcludedCommonFileToJSONTyped(value, ignoreDiscriminator = false) {
|
|
42
|
+
if (value == null) {
|
|
43
|
+
return value;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
'path_part_id': value['pathPartId'],
|
|
47
|
+
'reason': CommonFileExclusionReasonToJSON(value['reason']),
|
|
48
|
+
};
|
|
49
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
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
|
+
* Where a run-snapshot input came from, for auditability.
|
|
14
|
+
*
|
|
15
|
+
* A run's pinned inputs are merged from three sources at Start; this tags
|
|
16
|
+
* each so an auditor / the FE can tell a definition-mandated common file
|
|
17
|
+
* apart from a file the run's creator chose.
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export declare const InputOrigin: {
|
|
21
|
+
readonly DefinitionCommon: "DEFINITION_COMMON";
|
|
22
|
+
readonly RunReference: "RUN_REFERENCE";
|
|
23
|
+
readonly RunUpload: "RUN_UPLOAD";
|
|
24
|
+
};
|
|
25
|
+
export type InputOrigin = typeof InputOrigin[keyof typeof InputOrigin];
|
|
26
|
+
export declare function instanceOfInputOrigin(value: any): boolean;
|
|
27
|
+
export declare function InputOriginFromJSON(json: any): InputOrigin;
|
|
28
|
+
export declare function InputOriginFromJSONTyped(json: any, ignoreDiscriminator: boolean): InputOrigin;
|
|
29
|
+
export declare function InputOriginToJSON(value?: InputOrigin | null): any;
|
|
30
|
+
export declare function InputOriginToJSONTyped(value: any, ignoreDiscriminator: boolean): InputOrigin;
|
|
@@ -0,0 +1,48 @@
|
|
|
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
|
+
* Where a run-snapshot input came from, for auditability.
|
|
16
|
+
*
|
|
17
|
+
* A run's pinned inputs are merged from three sources at Start; this tags
|
|
18
|
+
* each so an auditor / the FE can tell a definition-mandated common file
|
|
19
|
+
* apart from a file the run's creator chose.
|
|
20
|
+
* @export
|
|
21
|
+
*/
|
|
22
|
+
export const InputOrigin = {
|
|
23
|
+
DefinitionCommon: 'DEFINITION_COMMON',
|
|
24
|
+
RunReference: 'RUN_REFERENCE',
|
|
25
|
+
RunUpload: 'RUN_UPLOAD'
|
|
26
|
+
};
|
|
27
|
+
export function instanceOfInputOrigin(value) {
|
|
28
|
+
for (const key in InputOrigin) {
|
|
29
|
+
if (Object.prototype.hasOwnProperty.call(InputOrigin, key)) {
|
|
30
|
+
if (InputOrigin[key] === value) {
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return false;
|
|
36
|
+
}
|
|
37
|
+
export function InputOriginFromJSON(json) {
|
|
38
|
+
return InputOriginFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
export function InputOriginFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
return json;
|
|
42
|
+
}
|
|
43
|
+
export function InputOriginToJSON(value) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
export function InputOriginToJSONTyped(value, ignoreDiscriminator) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { InputOrigin } from './InputOrigin';
|
|
12
13
|
/**
|
|
13
14
|
* One entry of a run's input scope, self-describing its pin semantics.
|
|
14
15
|
*
|
|
@@ -52,6 +53,12 @@ export interface InputSnapshot {
|
|
|
52
53
|
* @memberof InputSnapshot
|
|
53
54
|
*/
|
|
54
55
|
partType: InputSnapshotPartTypeEnum;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {InputOrigin}
|
|
59
|
+
* @memberof InputSnapshot
|
|
60
|
+
*/
|
|
61
|
+
origin?: InputOrigin;
|
|
55
62
|
}
|
|
56
63
|
/**
|
|
57
64
|
* @export
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { InputOriginFromJSON, InputOriginToJSON, } from './InputOrigin';
|
|
14
15
|
/**
|
|
15
16
|
* @export
|
|
16
17
|
*/
|
|
@@ -44,6 +45,7 @@ export function InputSnapshotFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
44
45
|
'pathPartId': json['path_part_id'],
|
|
45
46
|
'materializedPath': json['materialized_path'],
|
|
46
47
|
'partType': json['part_type'],
|
|
48
|
+
'origin': json['origin'] == null ? undefined : InputOriginFromJSON(json['origin']),
|
|
47
49
|
};
|
|
48
50
|
}
|
|
49
51
|
export function InputSnapshotToJSON(json) {
|
|
@@ -57,5 +59,6 @@ export function InputSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
57
59
|
'path_part_id': value['pathPartId'],
|
|
58
60
|
'materialized_path': value['materializedPath'],
|
|
59
61
|
'part_type': value['partType'],
|
|
62
|
+
'origin': InputOriginToJSON(value['origin']),
|
|
60
63
|
};
|
|
61
64
|
}
|
|
@@ -57,6 +57,12 @@ export interface UpdateWorkflowDefinitionRequest {
|
|
|
57
57
|
* @memberof UpdateWorkflowDefinitionRequest
|
|
58
58
|
*/
|
|
59
59
|
approvalRequired: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Common files attached to every run (DOCUMENT / FOLDER / DATA_SOURCE / API_CONNECTION path_part ids). Like ``instruction_path_part_id``, this is the exception to PUT semantics: null (or omit) retains the stored list; pass [] to clear; pass a list to replace it wholesale. The caller must be able to read each one.
|
|
62
|
+
* @type {Array<string>}
|
|
63
|
+
* @memberof UpdateWorkflowDefinitionRequest
|
|
64
|
+
*/
|
|
65
|
+
commonFilePathPartIds?: Array<string> | null;
|
|
60
66
|
}
|
|
61
67
|
export declare const UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
|
|
62
68
|
[property: string]: {
|
|
@@ -21,6 +21,10 @@ export const UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap = {
|
|
|
21
21
|
minimum: 60,
|
|
22
22
|
exclusiveMinimum: false,
|
|
23
23
|
},
|
|
24
|
+
commonFilePathPartIds: {
|
|
25
|
+
maxItems: 20,
|
|
26
|
+
uniqueItems: false,
|
|
27
|
+
},
|
|
24
28
|
};
|
|
25
29
|
/**
|
|
26
30
|
* Check if a given object implements the UpdateWorkflowDefinitionRequest interface.
|
|
@@ -49,6 +53,7 @@ export function UpdateWorkflowDefinitionRequestFromJSONTyped(json, ignoreDiscrim
|
|
|
49
53
|
'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
|
|
50
54
|
'isActive': json['is_active'],
|
|
51
55
|
'approvalRequired': json['approval_required'],
|
|
56
|
+
'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
|
|
52
57
|
};
|
|
53
58
|
}
|
|
54
59
|
export function UpdateWorkflowDefinitionRequestToJSON(json) {
|
|
@@ -66,5 +71,6 @@ export function UpdateWorkflowDefinitionRequestToJSONTyped(value, ignoreDiscrimi
|
|
|
66
71
|
'parent_path_part_id': value['parentPathPartId'],
|
|
67
72
|
'is_active': value['isActive'],
|
|
68
73
|
'approval_required': value['approvalRequired'],
|
|
74
|
+
'common_file_path_part_ids': value['commonFilePathPartIds'],
|
|
69
75
|
};
|
|
70
76
|
}
|
|
@@ -102,6 +102,12 @@ export interface WorkflowDefinitionResponse {
|
|
|
102
102
|
* @memberof WorkflowDefinitionResponse
|
|
103
103
|
*/
|
|
104
104
|
isTemplate: boolean;
|
|
105
|
+
/**
|
|
106
|
+
* Common files attached to every run (path_part ids). The FE renders these as 'attached to every run' on the workflow page.
|
|
107
|
+
* @type {Array<string>}
|
|
108
|
+
* @memberof WorkflowDefinitionResponse
|
|
109
|
+
*/
|
|
110
|
+
commonFilePathPartIds?: Array<string>;
|
|
105
111
|
/**
|
|
106
112
|
* Source definition this workflow was copied from (a template or any other workflow); null if hand-authored.
|
|
107
113
|
* @type {string}
|
|
@@ -80,6 +80,7 @@ export function WorkflowDefinitionResponseFromJSONTyped(json, ignoreDiscriminato
|
|
|
80
80
|
'isActive': json['is_active'],
|
|
81
81
|
'approvalRequired': json['approval_required'],
|
|
82
82
|
'isTemplate': json['is_template'],
|
|
83
|
+
'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
|
|
83
84
|
'createdFromId': json['created_from_id'],
|
|
84
85
|
'copyCount': json['copy_count'] == null ? undefined : json['copy_count'],
|
|
85
86
|
'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
|
|
@@ -110,6 +111,7 @@ export function WorkflowDefinitionResponseToJSONTyped(value, ignoreDiscriminator
|
|
|
110
111
|
'is_active': value['isActive'],
|
|
111
112
|
'approval_required': value['approvalRequired'],
|
|
112
113
|
'is_template': value['isTemplate'],
|
|
114
|
+
'common_file_path_part_ids': value['commonFilePathPartIds'],
|
|
113
115
|
'created_from_id': value['createdFromId'],
|
|
114
116
|
'copy_count': value['copyCount'],
|
|
115
117
|
'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { ItemPermissions } from './ItemPermissions';
|
|
13
13
|
import type { WorkflowRunSnapshot } from './WorkflowRunSnapshot';
|
|
14
14
|
import type { WorkflowExecutionState } from './WorkflowExecutionState';
|
|
15
|
+
import type { ExcludedCommonFile } from './ExcludedCommonFile';
|
|
15
16
|
import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
16
17
|
import type { UserInfo } from './UserInfo';
|
|
17
18
|
/**
|
|
@@ -162,6 +163,12 @@ export interface WorkflowRunResponse {
|
|
|
162
163
|
* @memberof WorkflowRunResponse
|
|
163
164
|
*/
|
|
164
165
|
outputsPathPartIds: Array<string>;
|
|
166
|
+
/**
|
|
167
|
+
* Definition common files that were excluded from this run at Start (deleted or unreadable by the starter). Empty until Start builds the snapshot, and empty for the common happy path.
|
|
168
|
+
* @type {Array<ExcludedCommonFile>}
|
|
169
|
+
* @memberof WorkflowRunResponse
|
|
170
|
+
*/
|
|
171
|
+
excludedCommonFiles?: Array<ExcludedCommonFile>;
|
|
165
172
|
/**
|
|
166
173
|
* The run's primary chat thread (1:1). NULL while NOT_STARTED; set by Start. The FE opens the run by opening this thread.
|
|
167
174
|
* @type {string}
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
import { ItemPermissionsFromJSON, ItemPermissionsToJSON, } from './ItemPermissions';
|
|
15
15
|
import { WorkflowRunSnapshotFromJSON, WorkflowRunSnapshotToJSON, } from './WorkflowRunSnapshot';
|
|
16
16
|
import { WorkflowExecutionStateFromJSON, WorkflowExecutionStateToJSON, } from './WorkflowExecutionState';
|
|
17
|
+
import { ExcludedCommonFileFromJSON, ExcludedCommonFileToJSON, } from './ExcludedCommonFile';
|
|
17
18
|
import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
|
|
18
19
|
import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
|
|
19
20
|
/**
|
|
@@ -101,6 +102,7 @@ export function WorkflowRunResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
101
102
|
'discussionsPathPartId': json['discussions_path_part_id'],
|
|
102
103
|
'inputPathPartIds': json['input_path_part_ids'] == null ? undefined : json['input_path_part_ids'],
|
|
103
104
|
'outputsPathPartIds': json['outputs_path_part_ids'],
|
|
105
|
+
'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : (json['excluded_common_files'].map(ExcludedCommonFileFromJSON)),
|
|
104
106
|
'runThreadId': json['run_thread_id'] == null ? undefined : json['run_thread_id'],
|
|
105
107
|
'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
|
|
106
108
|
'createdAt': (new Date(json['created_at'])),
|
|
@@ -138,6 +140,7 @@ export function WorkflowRunResponseToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
138
140
|
'discussions_path_part_id': value['discussionsPathPartId'],
|
|
139
141
|
'input_path_part_ids': value['inputPathPartIds'],
|
|
140
142
|
'outputs_path_part_ids': value['outputsPathPartIds'],
|
|
143
|
+
'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : (value['excludedCommonFiles'].map(ExcludedCommonFileToJSON)),
|
|
141
144
|
'run_thread_id': value['runThreadId'],
|
|
142
145
|
'owner': UserInfoToJSON(value['owner']),
|
|
143
146
|
'created_at': value['createdAt'].toISOString(),
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { InputSnapshot } from './InputSnapshot';
|
|
13
|
+
import type { ExcludedCommonFile } from './ExcludedCommonFile';
|
|
13
14
|
import type { InstructionSnapshot } from './InstructionSnapshot';
|
|
14
15
|
/**
|
|
15
16
|
* Frozen workflow configuration captured at trigger time.
|
|
@@ -49,6 +50,12 @@ export interface WorkflowRunSnapshot {
|
|
|
49
50
|
* @memberof WorkflowRunSnapshot
|
|
50
51
|
*/
|
|
51
52
|
inputs: Array<InputSnapshot>;
|
|
53
|
+
/**
|
|
54
|
+
* Definition common files left out of this run at Start (deleted or unreadable by the starter), each with its exclusion reason. Empty for the common happy path; pre-feature snapshots default to empty.
|
|
55
|
+
* @type {Array<ExcludedCommonFile>}
|
|
56
|
+
* @memberof WorkflowRunSnapshot
|
|
57
|
+
*/
|
|
58
|
+
excludedCommonFiles?: Array<ExcludedCommonFile>;
|
|
52
59
|
/**
|
|
53
60
|
* Optional free-text message the caller supplied at Start. Pinned here so the runner injects it into the agent's first user turn and it survives retry, redrive, and workflow-thread follow-ups (all of which re-assemble the prompt from this snapshot).
|
|
54
61
|
* @type {string}
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { InputSnapshotFromJSON, InputSnapshotToJSON, } from './InputSnapshot';
|
|
15
|
+
import { ExcludedCommonFileFromJSON, ExcludedCommonFileToJSON, } from './ExcludedCommonFile';
|
|
15
16
|
import { InstructionSnapshotFromJSON, InstructionSnapshotToJSON, } from './InstructionSnapshot';
|
|
16
17
|
export const WorkflowRunSnapshotPropertyValidationAttributesMap = {
|
|
17
18
|
userMessage: {
|
|
@@ -44,6 +45,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
44
45
|
'maxRunDurationSeconds': json['max_run_duration_seconds'],
|
|
45
46
|
'instruction': InstructionSnapshotFromJSON(json['instruction']),
|
|
46
47
|
'inputs': (json['inputs'].map(InputSnapshotFromJSON)),
|
|
48
|
+
'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : (json['excluded_common_files'].map(ExcludedCommonFileFromJSON)),
|
|
47
49
|
'userMessage': json['user_message'] == null ? undefined : json['user_message'],
|
|
48
50
|
};
|
|
49
51
|
}
|
|
@@ -59,6 +61,7 @@ export function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
59
61
|
'max_run_duration_seconds': value['maxRunDurationSeconds'],
|
|
60
62
|
'instruction': InstructionSnapshotToJSON(value['instruction']),
|
|
61
63
|
'inputs': (value['inputs'].map(InputSnapshotToJSON)),
|
|
64
|
+
'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : (value['excludedCommonFiles'].map(ExcludedCommonFileToJSON)),
|
|
62
65
|
'user_message': value['userMessage'],
|
|
63
66
|
};
|
|
64
67
|
}
|
|
@@ -45,6 +45,7 @@ export * from './ClearVersionContentsResponse';
|
|
|
45
45
|
export * from './CloneWorkflowRunRequest';
|
|
46
46
|
export * from './ColumnConfig';
|
|
47
47
|
export * from './ColumnReference';
|
|
48
|
+
export * from './CommonFileExclusionReason';
|
|
48
49
|
export * from './ConnectionConfig';
|
|
49
50
|
export * from './CreateApiConnectionRequest';
|
|
50
51
|
export * from './CreateApiKeyRequest';
|
|
@@ -106,6 +107,7 @@ export * from './EnrichedCitation';
|
|
|
106
107
|
export * from './EnrichedThreadMessageContent';
|
|
107
108
|
export * from './ErrorResponse';
|
|
108
109
|
export * from './EventResponse';
|
|
110
|
+
export * from './ExcludedCommonFile';
|
|
109
111
|
export * from './ExtractRequest';
|
|
110
112
|
export * from './ExtractResponse';
|
|
111
113
|
export * from './FeaturesResponse';
|
|
@@ -131,6 +133,7 @@ export * from './ImageTaxonomy';
|
|
|
131
133
|
export * from './InformationStatistics';
|
|
132
134
|
export * from './IngestDocumentResponse';
|
|
133
135
|
export * from './IngestionMode';
|
|
136
|
+
export * from './InputOrigin';
|
|
134
137
|
export * from './InputSnapshot';
|
|
135
138
|
export * from './InstantiateWorkflowTemplateRequest';
|
|
136
139
|
export * from './InstructionSnapshot';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -47,6 +47,7 @@ export * from './ClearVersionContentsResponse';
|
|
|
47
47
|
export * from './CloneWorkflowRunRequest';
|
|
48
48
|
export * from './ColumnConfig';
|
|
49
49
|
export * from './ColumnReference';
|
|
50
|
+
export * from './CommonFileExclusionReason';
|
|
50
51
|
export * from './ConnectionConfig';
|
|
51
52
|
export * from './CreateApiConnectionRequest';
|
|
52
53
|
export * from './CreateApiKeyRequest';
|
|
@@ -108,6 +109,7 @@ export * from './EnrichedCitation';
|
|
|
108
109
|
export * from './EnrichedThreadMessageContent';
|
|
109
110
|
export * from './ErrorResponse';
|
|
110
111
|
export * from './EventResponse';
|
|
112
|
+
export * from './ExcludedCommonFile';
|
|
111
113
|
export * from './ExtractRequest';
|
|
112
114
|
export * from './ExtractResponse';
|
|
113
115
|
export * from './FeaturesResponse';
|
|
@@ -133,6 +135,7 @@ export * from './ImageTaxonomy';
|
|
|
133
135
|
export * from './InformationStatistics';
|
|
134
136
|
export * from './IngestDocumentResponse';
|
|
135
137
|
export * from './IngestionMode';
|
|
138
|
+
export * from './InputOrigin';
|
|
136
139
|
export * from './InputSnapshot';
|
|
137
140
|
export * from './InstantiateWorkflowTemplateRequest';
|
|
138
141
|
export * from './InstructionSnapshot';
|