@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
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# ExcludedCommonFile
|
|
3
|
+
|
|
4
|
+
A definition common file that could not be applied to a run at Start. Common files resolve resiliently (record-and-continue): one that is missing/deleted or unreadable by the run-starter is recorded here rather than failing the run, so the exclusion is auditable and visible to the FE.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`pathPartId` | string
|
|
11
|
+
`reason` | [CommonFileExclusionReason](CommonFileExclusionReason.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ExcludedCommonFile } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"pathPartId": null,
|
|
21
|
+
"reason": null,
|
|
22
|
+
} satisfies ExcludedCommonFile
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as ExcludedCommonFile
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|
|
@@ -32,6 +32,7 @@ Name | Type
|
|
|
32
32
|
`isActive` | boolean
|
|
33
33
|
`approvalRequired` | boolean
|
|
34
34
|
`isTemplate` | boolean
|
|
35
|
+
`commonFilePathPartIds` | Array<string>
|
|
35
36
|
`createdFromId` | string
|
|
36
37
|
`copyCount` | number
|
|
37
38
|
`workflowDefinitionId` | string
|
|
@@ -48,6 +49,7 @@ Name | Type
|
|
|
48
49
|
`discussionsPathPartId` | string
|
|
49
50
|
`inputPathPartIds` | Array<string>
|
|
50
51
|
`outputsPathPartIds` | Array<string>
|
|
52
|
+
`excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
|
|
51
53
|
`runThreadId` | string
|
|
52
54
|
`engine` | [DataSourceEngine](DataSourceEngine.md)
|
|
53
55
|
`dataSourceId` | string
|
|
@@ -97,6 +99,7 @@ const example = {
|
|
|
97
99
|
"isActive": null,
|
|
98
100
|
"approvalRequired": null,
|
|
99
101
|
"isTemplate": null,
|
|
102
|
+
"commonFilePathPartIds": null,
|
|
100
103
|
"createdFromId": null,
|
|
101
104
|
"copyCount": null,
|
|
102
105
|
"workflowDefinitionId": null,
|
|
@@ -113,6 +116,7 @@ const example = {
|
|
|
113
116
|
"discussionsPathPartId": null,
|
|
114
117
|
"inputPathPartIds": null,
|
|
115
118
|
"outputsPathPartIds": null,
|
|
119
|
+
"excludedCommonFiles": null,
|
|
116
120
|
"runThreadId": null,
|
|
117
121
|
"engine": null,
|
|
118
122
|
"dataSourceId": null,
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# InputOrigin
|
|
3
|
+
|
|
4
|
+
Where a run-snapshot input came from, for auditability. A run\'s pinned inputs are merged from three sources at Start; this tags each so an auditor / the FE can tell a definition-mandated common file apart from a file the run\'s creator chose.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { InputOrigin } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies InputOrigin
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as InputOrigin
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
package/docs/InputSnapshot.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`pathPartId` | string
|
|
11
11
|
`materializedPath` | string
|
|
12
12
|
`partType` | string
|
|
13
|
+
`origin` | [InputOrigin](InputOrigin.md)
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -21,6 +22,7 @@ const example = {
|
|
|
21
22
|
"pathPartId": null,
|
|
22
23
|
"materializedPath": null,
|
|
23
24
|
"partType": null,
|
|
25
|
+
"origin": null,
|
|
24
26
|
} satisfies InputSnapshot
|
|
25
27
|
|
|
26
28
|
console.log(example)
|
|
@@ -14,6 +14,7 @@ Name | Type
|
|
|
14
14
|
`parentPathPartId` | string
|
|
15
15
|
`isActive` | boolean
|
|
16
16
|
`approvalRequired` | boolean
|
|
17
|
+
`commonFilePathPartIds` | Array<string>
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -29,6 +30,7 @@ const example = {
|
|
|
29
30
|
"parentPathPartId": null,
|
|
30
31
|
"isActive": null,
|
|
31
32
|
"approvalRequired": null,
|
|
33
|
+
"commonFilePathPartIds": null,
|
|
32
34
|
} satisfies UpdateWorkflowDefinitionRequest
|
|
33
35
|
|
|
34
36
|
console.log(example)
|
|
@@ -20,6 +20,7 @@ Name | Type
|
|
|
20
20
|
`isActive` | boolean
|
|
21
21
|
`approvalRequired` | boolean
|
|
22
22
|
`isTemplate` | boolean
|
|
23
|
+
`commonFilePathPartIds` | Array<string>
|
|
23
24
|
`createdFromId` | string
|
|
24
25
|
`copyCount` | number
|
|
25
26
|
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
@@ -48,6 +49,7 @@ const example = {
|
|
|
48
49
|
"isActive": null,
|
|
49
50
|
"approvalRequired": null,
|
|
50
51
|
"isTemplate": null,
|
|
52
|
+
"commonFilePathPartIds": null,
|
|
51
53
|
"createdFromId": null,
|
|
52
54
|
"copyCount": null,
|
|
53
55
|
"approvalState": null,
|
|
@@ -29,6 +29,7 @@ Name | Type
|
|
|
29
29
|
`discussionsPathPartId` | string
|
|
30
30
|
`inputPathPartIds` | Array<string>
|
|
31
31
|
`outputsPathPartIds` | Array<string>
|
|
32
|
+
`excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
|
|
32
33
|
`runThreadId` | string
|
|
33
34
|
`owner` | [UserInfo](UserInfo.md)
|
|
34
35
|
`createdAt` | Date
|
|
@@ -64,6 +65,7 @@ const example = {
|
|
|
64
65
|
"discussionsPathPartId": null,
|
|
65
66
|
"inputPathPartIds": null,
|
|
66
67
|
"outputsPathPartIds": null,
|
|
68
|
+
"excludedCommonFiles": null,
|
|
67
69
|
"runThreadId": null,
|
|
68
70
|
"owner": null,
|
|
69
71
|
"createdAt": null,
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`maxRunDurationSeconds` | number
|
|
12
12
|
`instruction` | [InstructionSnapshot](InstructionSnapshot.md)
|
|
13
13
|
`inputs` | [Array<InputSnapshot>](InputSnapshot.md)
|
|
14
|
+
`excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
|
|
14
15
|
`userMessage` | string
|
|
15
16
|
|
|
16
17
|
## Example
|
|
@@ -24,6 +25,7 @@ const example = {
|
|
|
24
25
|
"maxRunDurationSeconds": null,
|
|
25
26
|
"instruction": null,
|
|
26
27
|
"inputs": null,
|
|
28
|
+
"excludedCommonFiles": null,
|
|
27
29
|
"userMessage": null,
|
|
28
30
|
} satisfies WorkflowRunSnapshot
|
|
29
31
|
|
package/package.json
CHANGED
|
@@ -0,0 +1,57 @@
|
|
|
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
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Why a definition common file was left out of a run at Start.
|
|
18
|
+
*
|
|
19
|
+
* Common files resolve resiliently (record-and-continue): an unresolvable
|
|
20
|
+
* one is excluded with one of these reasons rather than failing the run.
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
export const CommonFileExclusionReason = {
|
|
24
|
+
NotFound: 'NOT_FOUND',
|
|
25
|
+
NoAccess: 'NO_ACCESS',
|
|
26
|
+
Unresolvable: 'UNRESOLVABLE'
|
|
27
|
+
} as const;
|
|
28
|
+
export type CommonFileExclusionReason = typeof CommonFileExclusionReason[keyof typeof CommonFileExclusionReason];
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
export function instanceOfCommonFileExclusionReason(value: any): boolean {
|
|
32
|
+
for (const key in CommonFileExclusionReason) {
|
|
33
|
+
if (Object.prototype.hasOwnProperty.call(CommonFileExclusionReason, key)) {
|
|
34
|
+
if (CommonFileExclusionReason[key as keyof typeof CommonFileExclusionReason] === value) {
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
return false;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export function CommonFileExclusionReasonFromJSON(json: any): CommonFileExclusionReason {
|
|
43
|
+
return CommonFileExclusionReasonFromJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export function CommonFileExclusionReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommonFileExclusionReason {
|
|
47
|
+
return json as CommonFileExclusionReason;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function CommonFileExclusionReasonToJSON(value?: CommonFileExclusionReason | null): any {
|
|
51
|
+
return value as any;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export function CommonFileExclusionReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): CommonFileExclusionReason {
|
|
55
|
+
return value as CommonFileExclusionReason;
|
|
56
|
+
}
|
|
57
|
+
|
|
@@ -65,6 +65,12 @@ export interface CreateWorkflowDefinitionRequest {
|
|
|
65
65
|
* @memberof CreateWorkflowDefinitionRequest
|
|
66
66
|
*/
|
|
67
67
|
isTemplate?: boolean;
|
|
68
|
+
/**
|
|
69
|
+
* 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.
|
|
70
|
+
* @type {Array<string>}
|
|
71
|
+
* @memberof CreateWorkflowDefinitionRequest
|
|
72
|
+
*/
|
|
73
|
+
commonFilePathPartIds?: Array<string>;
|
|
68
74
|
}
|
|
69
75
|
export const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
|
|
70
76
|
[property: string]: {
|
|
@@ -90,6 +96,10 @@ export const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
|
|
|
90
96
|
minimum: 60,
|
|
91
97
|
exclusiveMinimum: false,
|
|
92
98
|
},
|
|
99
|
+
commonFilePathPartIds: {
|
|
100
|
+
maxItems: 20,
|
|
101
|
+
uniqueItems: false,
|
|
102
|
+
},
|
|
93
103
|
}
|
|
94
104
|
|
|
95
105
|
|
|
@@ -120,6 +130,7 @@ export function CreateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDi
|
|
|
120
130
|
'instructionPathPartId': json['instruction_path_part_id'] == null ? undefined : json['instruction_path_part_id'],
|
|
121
131
|
'approvalRequired': json['approval_required'],
|
|
122
132
|
'isTemplate': json['is_template'] == null ? undefined : json['is_template'],
|
|
133
|
+
'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
|
|
123
134
|
};
|
|
124
135
|
}
|
|
125
136
|
|
|
@@ -141,6 +152,7 @@ export function CreateWorkflowDefinitionRequestToJSONTyped(value?: CreateWorkflo
|
|
|
141
152
|
'instruction_path_part_id': value['instructionPathPartId'],
|
|
142
153
|
'approval_required': value['approvalRequired'],
|
|
143
154
|
'is_template': value['isTemplate'],
|
|
155
|
+
'common_file_path_part_ids': value['commonFilePathPartIds'],
|
|
144
156
|
};
|
|
145
157
|
}
|
|
146
158
|
|
|
@@ -0,0 +1,106 @@
|
|
|
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
|
+
import type { CommonFileExclusionReason } from './CommonFileExclusionReason';
|
|
17
|
+
import {
|
|
18
|
+
CommonFileExclusionReasonFromJSON,
|
|
19
|
+
CommonFileExclusionReasonFromJSONTyped,
|
|
20
|
+
CommonFileExclusionReasonToJSON,
|
|
21
|
+
CommonFileExclusionReasonToJSONTyped,
|
|
22
|
+
} from './CommonFileExclusionReason';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* A definition common file that could not be applied to a run at Start.
|
|
26
|
+
*
|
|
27
|
+
* Common files resolve resiliently (record-and-continue): one that is
|
|
28
|
+
* missing/deleted or unreadable by the run-starter is recorded here rather
|
|
29
|
+
* than failing the run, so the exclusion is auditable and visible to the FE.
|
|
30
|
+
* @export
|
|
31
|
+
* @interface ExcludedCommonFile
|
|
32
|
+
*/
|
|
33
|
+
export interface ExcludedCommonFile {
|
|
34
|
+
/**
|
|
35
|
+
* The common file's path_part id, as set on the definition
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof ExcludedCommonFile
|
|
38
|
+
*/
|
|
39
|
+
pathPartId: string;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {CommonFileExclusionReason}
|
|
43
|
+
* @memberof ExcludedCommonFile
|
|
44
|
+
*/
|
|
45
|
+
reason: CommonFileExclusionReason;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
export const ExcludedCommonFilePropertyValidationAttributesMap: {
|
|
50
|
+
[property: string]: {
|
|
51
|
+
maxLength?: number,
|
|
52
|
+
minLength?: number,
|
|
53
|
+
pattern?: string,
|
|
54
|
+
maximum?: number,
|
|
55
|
+
exclusiveMaximum?: boolean,
|
|
56
|
+
minimum?: number,
|
|
57
|
+
exclusiveMinimum?: boolean,
|
|
58
|
+
multipleOf?: number,
|
|
59
|
+
maxItems?: number,
|
|
60
|
+
minItems?: number,
|
|
61
|
+
uniqueItems?: boolean
|
|
62
|
+
}
|
|
63
|
+
} = {
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* Check if a given object implements the ExcludedCommonFile interface.
|
|
69
|
+
*/
|
|
70
|
+
export function instanceOfExcludedCommonFile(value: object): value is ExcludedCommonFile {
|
|
71
|
+
if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
|
|
72
|
+
if (!('reason' in value) || value['reason'] === undefined) return false;
|
|
73
|
+
return true;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export function ExcludedCommonFileFromJSON(json: any): ExcludedCommonFile {
|
|
77
|
+
return ExcludedCommonFileFromJSONTyped(json, false);
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export function ExcludedCommonFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExcludedCommonFile {
|
|
81
|
+
if (json == null) {
|
|
82
|
+
return json;
|
|
83
|
+
}
|
|
84
|
+
return {
|
|
85
|
+
|
|
86
|
+
'pathPartId': json['path_part_id'],
|
|
87
|
+
'reason': CommonFileExclusionReasonFromJSON(json['reason']),
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function ExcludedCommonFileToJSON(json: any): ExcludedCommonFile {
|
|
92
|
+
return ExcludedCommonFileToJSONTyped(json, false);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function ExcludedCommonFileToJSONTyped(value?: ExcludedCommonFile | null, ignoreDiscriminator: boolean = false): any {
|
|
96
|
+
if (value == null) {
|
|
97
|
+
return value;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return {
|
|
101
|
+
|
|
102
|
+
'path_part_id': value['pathPartId'],
|
|
103
|
+
'reason': CommonFileExclusionReasonToJSON(value['reason']),
|
|
104
|
+
};
|
|
105
|
+
}
|
|
106
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
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
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Where a run-snapshot input came from, for auditability.
|
|
18
|
+
*
|
|
19
|
+
* A run's pinned inputs are merged from three sources at Start; this tags
|
|
20
|
+
* each so an auditor / the FE can tell a definition-mandated common file
|
|
21
|
+
* apart from a file the run's creator chose.
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export const InputOrigin = {
|
|
25
|
+
DefinitionCommon: 'DEFINITION_COMMON',
|
|
26
|
+
RunReference: 'RUN_REFERENCE',
|
|
27
|
+
RunUpload: 'RUN_UPLOAD'
|
|
28
|
+
} as const;
|
|
29
|
+
export type InputOrigin = typeof InputOrigin[keyof typeof InputOrigin];
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
export function instanceOfInputOrigin(value: any): boolean {
|
|
33
|
+
for (const key in InputOrigin) {
|
|
34
|
+
if (Object.prototype.hasOwnProperty.call(InputOrigin, key)) {
|
|
35
|
+
if (InputOrigin[key as keyof typeof InputOrigin] === value) {
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
return false;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export function InputOriginFromJSON(json: any): InputOrigin {
|
|
44
|
+
return InputOriginFromJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export function InputOriginFromJSONTyped(json: any, ignoreDiscriminator: boolean): InputOrigin {
|
|
48
|
+
return json as InputOrigin;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function InputOriginToJSON(value?: InputOrigin | null): any {
|
|
52
|
+
return value as any;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export function InputOriginToJSONTyped(value: any, ignoreDiscriminator: boolean): InputOrigin {
|
|
56
|
+
return value as InputOrigin;
|
|
57
|
+
}
|
|
58
|
+
|
|
@@ -13,6 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { InputOrigin } from './InputOrigin';
|
|
17
|
+
import {
|
|
18
|
+
InputOriginFromJSON,
|
|
19
|
+
InputOriginFromJSONTyped,
|
|
20
|
+
InputOriginToJSON,
|
|
21
|
+
InputOriginToJSONTyped,
|
|
22
|
+
} from './InputOrigin';
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
25
|
* One entry of a run's input scope, self-describing its pin semantics.
|
|
18
26
|
*
|
|
@@ -56,6 +64,12 @@ export interface InputSnapshot {
|
|
|
56
64
|
* @memberof InputSnapshot
|
|
57
65
|
*/
|
|
58
66
|
partType: InputSnapshotPartTypeEnum;
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @type {InputOrigin}
|
|
70
|
+
* @memberof InputSnapshot
|
|
71
|
+
*/
|
|
72
|
+
origin?: InputOrigin;
|
|
59
73
|
}
|
|
60
74
|
|
|
61
75
|
|
|
@@ -111,6 +125,7 @@ export function InputSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boole
|
|
|
111
125
|
'pathPartId': json['path_part_id'],
|
|
112
126
|
'materializedPath': json['materialized_path'],
|
|
113
127
|
'partType': json['part_type'],
|
|
128
|
+
'origin': json['origin'] == null ? undefined : InputOriginFromJSON(json['origin']),
|
|
114
129
|
};
|
|
115
130
|
}
|
|
116
131
|
|
|
@@ -128,6 +143,7 @@ export function InputSnapshotToJSONTyped(value?: InputSnapshot | null, ignoreDis
|
|
|
128
143
|
'path_part_id': value['pathPartId'],
|
|
129
144
|
'materialized_path': value['materializedPath'],
|
|
130
145
|
'part_type': value['partType'],
|
|
146
|
+
'origin': InputOriginToJSON(value['origin']),
|
|
131
147
|
};
|
|
132
148
|
}
|
|
133
149
|
|
|
@@ -61,6 +61,12 @@ export interface UpdateWorkflowDefinitionRequest {
|
|
|
61
61
|
* @memberof UpdateWorkflowDefinitionRequest
|
|
62
62
|
*/
|
|
63
63
|
approvalRequired: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* 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.
|
|
66
|
+
* @type {Array<string>}
|
|
67
|
+
* @memberof UpdateWorkflowDefinitionRequest
|
|
68
|
+
*/
|
|
69
|
+
commonFilePathPartIds?: Array<string> | null;
|
|
64
70
|
}
|
|
65
71
|
export const UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
|
|
66
72
|
[property: string]: {
|
|
@@ -86,6 +92,10 @@ export const UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
|
|
|
86
92
|
minimum: 60,
|
|
87
93
|
exclusiveMinimum: false,
|
|
88
94
|
},
|
|
95
|
+
commonFilePathPartIds: {
|
|
96
|
+
maxItems: 20,
|
|
97
|
+
uniqueItems: false,
|
|
98
|
+
},
|
|
89
99
|
}
|
|
90
100
|
|
|
91
101
|
|
|
@@ -116,6 +126,7 @@ export function UpdateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDi
|
|
|
116
126
|
'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
|
|
117
127
|
'isActive': json['is_active'],
|
|
118
128
|
'approvalRequired': json['approval_required'],
|
|
129
|
+
'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
|
|
119
130
|
};
|
|
120
131
|
}
|
|
121
132
|
|
|
@@ -137,6 +148,7 @@ export function UpdateWorkflowDefinitionRequestToJSONTyped(value?: UpdateWorkflo
|
|
|
137
148
|
'parent_path_part_id': value['parentPathPartId'],
|
|
138
149
|
'is_active': value['isActive'],
|
|
139
150
|
'approval_required': value['approvalRequired'],
|
|
151
|
+
'common_file_path_part_ids': value['commonFilePathPartIds'],
|
|
140
152
|
};
|
|
141
153
|
}
|
|
142
154
|
|
|
@@ -125,6 +125,12 @@ export interface WorkflowDefinitionResponse {
|
|
|
125
125
|
* @memberof WorkflowDefinitionResponse
|
|
126
126
|
*/
|
|
127
127
|
isTemplate: boolean;
|
|
128
|
+
/**
|
|
129
|
+
* Common files attached to every run (path_part ids). The FE renders these as 'attached to every run' on the workflow page.
|
|
130
|
+
* @type {Array<string>}
|
|
131
|
+
* @memberof WorkflowDefinitionResponse
|
|
132
|
+
*/
|
|
133
|
+
commonFilePathPartIds?: Array<string>;
|
|
128
134
|
/**
|
|
129
135
|
* Source definition this workflow was copied from (a template or any other workflow); null if hand-authored.
|
|
130
136
|
* @type {string}
|
|
@@ -242,6 +248,7 @@ export function WorkflowDefinitionResponseFromJSONTyped(json: any, ignoreDiscrim
|
|
|
242
248
|
'isActive': json['is_active'],
|
|
243
249
|
'approvalRequired': json['approval_required'],
|
|
244
250
|
'isTemplate': json['is_template'],
|
|
251
|
+
'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
|
|
245
252
|
'createdFromId': json['created_from_id'],
|
|
246
253
|
'copyCount': json['copy_count'] == null ? undefined : json['copy_count'],
|
|
247
254
|
'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
|
|
@@ -276,6 +283,7 @@ export function WorkflowDefinitionResponseToJSONTyped(value?: WorkflowDefinition
|
|
|
276
283
|
'is_active': value['isActive'],
|
|
277
284
|
'approval_required': value['approvalRequired'],
|
|
278
285
|
'is_template': value['isTemplate'],
|
|
286
|
+
'common_file_path_part_ids': value['commonFilePathPartIds'],
|
|
279
287
|
'created_from_id': value['createdFromId'],
|
|
280
288
|
'copy_count': value['copyCount'],
|
|
281
289
|
'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
|
|
@@ -34,6 +34,13 @@ import {
|
|
|
34
34
|
WorkflowExecutionStateToJSON,
|
|
35
35
|
WorkflowExecutionStateToJSONTyped,
|
|
36
36
|
} from './WorkflowExecutionState';
|
|
37
|
+
import type { ExcludedCommonFile } from './ExcludedCommonFile';
|
|
38
|
+
import {
|
|
39
|
+
ExcludedCommonFileFromJSON,
|
|
40
|
+
ExcludedCommonFileFromJSONTyped,
|
|
41
|
+
ExcludedCommonFileToJSON,
|
|
42
|
+
ExcludedCommonFileToJSONTyped,
|
|
43
|
+
} from './ExcludedCommonFile';
|
|
37
44
|
import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
38
45
|
import {
|
|
39
46
|
PathPartApprovalStateFromJSON,
|
|
@@ -197,6 +204,12 @@ export interface WorkflowRunResponse {
|
|
|
197
204
|
* @memberof WorkflowRunResponse
|
|
198
205
|
*/
|
|
199
206
|
outputsPathPartIds: Array<string>;
|
|
207
|
+
/**
|
|
208
|
+
* 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.
|
|
209
|
+
* @type {Array<ExcludedCommonFile>}
|
|
210
|
+
* @memberof WorkflowRunResponse
|
|
211
|
+
*/
|
|
212
|
+
excludedCommonFiles?: Array<ExcludedCommonFile>;
|
|
200
213
|
/**
|
|
201
214
|
* The run's primary chat thread (1:1). NULL while NOT_STARTED; set by Start. The FE opens the run by opening this thread.
|
|
202
215
|
* @type {string}
|
|
@@ -316,6 +329,7 @@ export function WorkflowRunResponseFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
316
329
|
'discussionsPathPartId': json['discussions_path_part_id'],
|
|
317
330
|
'inputPathPartIds': json['input_path_part_ids'] == null ? undefined : json['input_path_part_ids'],
|
|
318
331
|
'outputsPathPartIds': json['outputs_path_part_ids'],
|
|
332
|
+
'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : ((json['excluded_common_files'] as Array<any>).map(ExcludedCommonFileFromJSON)),
|
|
319
333
|
'runThreadId': json['run_thread_id'] == null ? undefined : json['run_thread_id'],
|
|
320
334
|
'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
|
|
321
335
|
'createdAt': (new Date(json['created_at'])),
|
|
@@ -357,6 +371,7 @@ export function WorkflowRunResponseToJSONTyped(value?: WorkflowRunResponse | nul
|
|
|
357
371
|
'discussions_path_part_id': value['discussionsPathPartId'],
|
|
358
372
|
'input_path_part_ids': value['inputPathPartIds'],
|
|
359
373
|
'outputs_path_part_ids': value['outputsPathPartIds'],
|
|
374
|
+
'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : ((value['excludedCommonFiles'] as Array<any>).map(ExcludedCommonFileToJSON)),
|
|
360
375
|
'run_thread_id': value['runThreadId'],
|
|
361
376
|
'owner': UserInfoToJSON(value['owner']),
|
|
362
377
|
'created_at': value['createdAt'].toISOString(),
|
|
@@ -20,6 +20,13 @@ import {
|
|
|
20
20
|
InputSnapshotToJSON,
|
|
21
21
|
InputSnapshotToJSONTyped,
|
|
22
22
|
} from './InputSnapshot';
|
|
23
|
+
import type { ExcludedCommonFile } from './ExcludedCommonFile';
|
|
24
|
+
import {
|
|
25
|
+
ExcludedCommonFileFromJSON,
|
|
26
|
+
ExcludedCommonFileFromJSONTyped,
|
|
27
|
+
ExcludedCommonFileToJSON,
|
|
28
|
+
ExcludedCommonFileToJSONTyped,
|
|
29
|
+
} from './ExcludedCommonFile';
|
|
23
30
|
import type { InstructionSnapshot } from './InstructionSnapshot';
|
|
24
31
|
import {
|
|
25
32
|
InstructionSnapshotFromJSON,
|
|
@@ -66,6 +73,12 @@ export interface WorkflowRunSnapshot {
|
|
|
66
73
|
* @memberof WorkflowRunSnapshot
|
|
67
74
|
*/
|
|
68
75
|
inputs: Array<InputSnapshot>;
|
|
76
|
+
/**
|
|
77
|
+
* 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.
|
|
78
|
+
* @type {Array<ExcludedCommonFile>}
|
|
79
|
+
* @memberof WorkflowRunSnapshot
|
|
80
|
+
*/
|
|
81
|
+
excludedCommonFiles?: Array<ExcludedCommonFile>;
|
|
69
82
|
/**
|
|
70
83
|
* 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).
|
|
71
84
|
* @type {string}
|
|
@@ -119,6 +132,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
119
132
|
'maxRunDurationSeconds': json['max_run_duration_seconds'],
|
|
120
133
|
'instruction': InstructionSnapshotFromJSON(json['instruction']),
|
|
121
134
|
'inputs': ((json['inputs'] as Array<any>).map(InputSnapshotFromJSON)),
|
|
135
|
+
'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : ((json['excluded_common_files'] as Array<any>).map(ExcludedCommonFileFromJSON)),
|
|
122
136
|
'userMessage': json['user_message'] == null ? undefined : json['user_message'],
|
|
123
137
|
};
|
|
124
138
|
}
|
|
@@ -138,6 +152,7 @@ export function WorkflowRunSnapshotToJSONTyped(value?: WorkflowRunSnapshot | nul
|
|
|
138
152
|
'max_run_duration_seconds': value['maxRunDurationSeconds'],
|
|
139
153
|
'instruction': InstructionSnapshotToJSON(value['instruction']),
|
|
140
154
|
'inputs': ((value['inputs'] as Array<any>).map(InputSnapshotToJSON)),
|
|
155
|
+
'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : ((value['excludedCommonFiles'] as Array<any>).map(ExcludedCommonFileToJSON)),
|
|
141
156
|
'user_message': value['userMessage'],
|
|
142
157
|
};
|
|
143
158
|
}
|