@knowledge-stack/ksapi 1.82.0 → 1.84.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/README.md +26 -2
  3. package/dist/apis/PathPartsApi.d.ts +110 -1
  4. package/dist/apis/PathPartsApi.js +111 -0
  5. package/dist/apis/WorkflowMemoryApi.d.ts +249 -0
  6. package/dist/apis/WorkflowMemoryApi.js +299 -0
  7. package/dist/apis/WorkflowRunsApi.d.ts +233 -1
  8. package/dist/apis/WorkflowRunsApi.js +236 -0
  9. package/dist/apis/index.d.ts +1 -0
  10. package/dist/apis/index.js +1 -0
  11. package/dist/esm/apis/PathPartsApi.d.ts +110 -1
  12. package/dist/esm/apis/PathPartsApi.js +112 -1
  13. package/dist/esm/apis/WorkflowMemoryApi.d.ts +249 -0
  14. package/dist/esm/apis/WorkflowMemoryApi.js +262 -0
  15. package/dist/esm/apis/WorkflowRunsApi.d.ts +233 -1
  16. package/dist/esm/apis/WorkflowRunsApi.js +237 -1
  17. package/dist/esm/apis/index.d.ts +1 -0
  18. package/dist/esm/apis/index.js +1 -0
  19. package/dist/esm/models/AppendEventRequest.d.ts +62 -0
  20. package/dist/esm/models/AppendEventRequest.js +51 -0
  21. package/dist/esm/models/AppendMemoryChunkRequest.d.ts +54 -0
  22. package/dist/esm/models/AppendMemoryChunkRequest.js +52 -0
  23. package/dist/esm/models/ChunkBulkResponse.d.ts +4 -4
  24. package/dist/esm/models/ChunkContentItem.d.ts +2 -2
  25. package/dist/esm/models/ChunkResponse.d.ts +4 -4
  26. package/dist/esm/models/CreateThreadMessageRequest.d.ts +2 -2
  27. package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +7 -1
  28. package/dist/esm/models/CreateWorkflowDefinitionRequest.js +2 -0
  29. package/dist/esm/models/DocumentVersionMetadata.d.ts +4 -4
  30. package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts +2 -2
  31. package/dist/esm/models/EditMemoryChunkRequest.d.ts +47 -0
  32. package/dist/esm/models/EditMemoryChunkRequest.js +49 -0
  33. package/dist/esm/models/EventResponse.d.ts +83 -0
  34. package/dist/esm/models/EventResponse.js +64 -0
  35. package/dist/esm/models/ListMemoryChunksResponse.d.ts +48 -0
  36. package/dist/esm/models/ListMemoryChunksResponse.js +45 -0
  37. package/dist/esm/models/MemoryChunkResponse.d.ts +60 -0
  38. package/dist/esm/models/MemoryChunkResponse.js +53 -0
  39. package/dist/esm/models/MemoryKind.d.ts +29 -0
  40. package/dist/esm/models/MemoryKind.js +47 -0
  41. package/dist/esm/models/PaginatedResponseEventResponse.d.ts +66 -0
  42. package/dist/esm/models/PaginatedResponseEventResponse.js +70 -0
  43. package/dist/esm/models/PathPartApprovalDecision.d.ts +30 -0
  44. package/dist/esm/models/PathPartApprovalDecision.js +48 -0
  45. package/dist/esm/models/PathPartApprovalResponse.d.ts +111 -0
  46. package/dist/esm/models/PathPartApprovalResponse.js +85 -0
  47. package/dist/esm/models/RejectFileRequest.d.ts +47 -0
  48. package/dist/esm/models/RejectFileRequest.js +49 -0
  49. package/dist/esm/models/RunLockResponse.d.ts +59 -0
  50. package/dist/esm/models/RunLockResponse.js +52 -0
  51. package/dist/esm/models/ScoredChunkResponse.d.ts +4 -4
  52. package/dist/esm/models/SectionSystemMetadata.d.ts +1 -1
  53. package/dist/esm/models/TenantSettingsUpdate.d.ts +2 -2
  54. package/dist/esm/models/ThreadMessageDetailsInput.d.ts +2 -2
  55. package/dist/esm/models/ThreadMessageDetailsOutput.d.ts +2 -2
  56. package/dist/esm/models/ThreadMessageResponse.d.ts +2 -2
  57. package/dist/esm/models/UpdateChunkMetadataRequest.d.ts +2 -2
  58. package/dist/esm/models/UpdateTenantRequest.d.ts +4 -4
  59. package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +7 -1
  60. package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +2 -0
  61. package/dist/esm/models/WorkflowDefinitionResponse.d.ts +7 -1
  62. package/dist/esm/models/WorkflowDefinitionResponse.js +4 -0
  63. package/dist/esm/models/WorkflowRunSnapshot.d.ts +1 -1
  64. package/dist/esm/models/WorkflowRunStatus.d.ts +20 -2
  65. package/dist/esm/models/WorkflowRunStatus.js +20 -2
  66. package/dist/esm/models/index.d.ts +12 -0
  67. package/dist/esm/models/index.js +12 -0
  68. package/dist/models/AppendEventRequest.d.ts +62 -0
  69. package/dist/models/AppendEventRequest.js +59 -0
  70. package/dist/models/AppendMemoryChunkRequest.d.ts +54 -0
  71. package/dist/models/AppendMemoryChunkRequest.js +60 -0
  72. package/dist/models/ChunkBulkResponse.d.ts +4 -4
  73. package/dist/models/ChunkContentItem.d.ts +2 -2
  74. package/dist/models/ChunkResponse.d.ts +4 -4
  75. package/dist/models/CreateThreadMessageRequest.d.ts +2 -2
  76. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +7 -1
  77. package/dist/models/CreateWorkflowDefinitionRequest.js +2 -0
  78. package/dist/models/DocumentVersionMetadata.d.ts +4 -4
  79. package/dist/models/DocumentVersionMetadataUpdate.d.ts +2 -2
  80. package/dist/models/EditMemoryChunkRequest.d.ts +47 -0
  81. package/dist/models/EditMemoryChunkRequest.js +57 -0
  82. package/dist/models/EventResponse.d.ts +83 -0
  83. package/dist/models/EventResponse.js +72 -0
  84. package/dist/models/ListMemoryChunksResponse.d.ts +48 -0
  85. package/dist/models/ListMemoryChunksResponse.js +53 -0
  86. package/dist/models/MemoryChunkResponse.d.ts +60 -0
  87. package/dist/models/MemoryChunkResponse.js +61 -0
  88. package/dist/models/MemoryKind.d.ts +29 -0
  89. package/dist/models/MemoryKind.js +55 -0
  90. package/dist/models/PaginatedResponseEventResponse.d.ts +66 -0
  91. package/dist/models/PaginatedResponseEventResponse.js +78 -0
  92. package/dist/models/PathPartApprovalDecision.d.ts +30 -0
  93. package/dist/models/PathPartApprovalDecision.js +56 -0
  94. package/dist/models/PathPartApprovalResponse.d.ts +111 -0
  95. package/dist/models/PathPartApprovalResponse.js +93 -0
  96. package/dist/models/RejectFileRequest.d.ts +47 -0
  97. package/dist/models/RejectFileRequest.js +57 -0
  98. package/dist/models/RunLockResponse.d.ts +59 -0
  99. package/dist/models/RunLockResponse.js +60 -0
  100. package/dist/models/ScoredChunkResponse.d.ts +4 -4
  101. package/dist/models/SectionSystemMetadata.d.ts +1 -1
  102. package/dist/models/TenantSettingsUpdate.d.ts +2 -2
  103. package/dist/models/ThreadMessageDetailsInput.d.ts +2 -2
  104. package/dist/models/ThreadMessageDetailsOutput.d.ts +2 -2
  105. package/dist/models/ThreadMessageResponse.d.ts +2 -2
  106. package/dist/models/UpdateChunkMetadataRequest.d.ts +2 -2
  107. package/dist/models/UpdateTenantRequest.d.ts +4 -4
  108. package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +7 -1
  109. package/dist/models/UpdateWorkflowDefinitionRequest.js +2 -0
  110. package/dist/models/WorkflowDefinitionResponse.d.ts +7 -1
  111. package/dist/models/WorkflowDefinitionResponse.js +4 -0
  112. package/dist/models/WorkflowRunSnapshot.d.ts +1 -1
  113. package/dist/models/WorkflowRunStatus.d.ts +20 -2
  114. package/dist/models/WorkflowRunStatus.js +20 -2
  115. package/dist/models/index.d.ts +12 -0
  116. package/dist/models/index.js +12 -0
  117. package/docs/AppendEventRequest.md +37 -0
  118. package/docs/AppendMemoryChunkRequest.md +36 -0
  119. package/docs/CreateWorkflowDefinitionRequest.md +2 -0
  120. package/docs/EditMemoryChunkRequest.md +34 -0
  121. package/docs/EventResponse.md +45 -0
  122. package/docs/ListMemoryChunksResponse.md +34 -0
  123. package/docs/MemoryChunkResponse.md +39 -0
  124. package/docs/MemoryKind.md +33 -0
  125. package/docs/PaginatedResponseEventResponse.md +40 -0
  126. package/docs/PathPartApprovalDecision.md +33 -0
  127. package/docs/PathPartApprovalResponse.md +55 -0
  128. package/docs/PathPartsApi.md +171 -0
  129. package/docs/RejectFileRequest.md +35 -0
  130. package/docs/RunLockResponse.md +39 -0
  131. package/docs/UpdateWorkflowDefinitionRequest.md +2 -0
  132. package/docs/WorkflowDefinitionResponse.md +2 -0
  133. package/docs/WorkflowMemoryApi.md +390 -0
  134. package/docs/WorkflowRunStatus.md +1 -1
  135. package/docs/WorkflowRunsApi.md +387 -0
  136. package/package.json +1 -1
  137. package/src/apis/PathPartsApi.ts +234 -0
  138. package/src/apis/WorkflowMemoryApi.ts +522 -0
  139. package/src/apis/WorkflowRunsApi.ts +479 -0
  140. package/src/apis/index.ts +1 -0
  141. package/src/models/AppendEventRequest.ts +102 -0
  142. package/src/models/AppendMemoryChunkRequest.ts +105 -0
  143. package/src/models/ChunkBulkResponse.ts +4 -4
  144. package/src/models/ChunkContentItem.ts +2 -2
  145. package/src/models/ChunkResponse.ts +4 -4
  146. package/src/models/CreateThreadMessageRequest.ts +2 -2
  147. package/src/models/CreateWorkflowDefinitionRequest.ts +9 -1
  148. package/src/models/DocumentVersionMetadata.ts +4 -4
  149. package/src/models/DocumentVersionMetadataUpdate.ts +2 -2
  150. package/src/models/EditMemoryChunkRequest.ts +87 -0
  151. package/src/models/EventResponse.ts +132 -0
  152. package/src/models/ListMemoryChunksResponse.ts +91 -0
  153. package/src/models/MemoryChunkResponse.ts +111 -0
  154. package/src/models/MemoryKind.ts +57 -0
  155. package/src/models/PaginatedResponseEventResponse.ts +130 -0
  156. package/src/models/PathPartApprovalDecision.ts +58 -0
  157. package/src/models/PathPartApprovalResponse.ts +186 -0
  158. package/src/models/RejectFileRequest.ts +87 -0
  159. package/src/models/RunLockResponse.ts +101 -0
  160. package/src/models/ScoredChunkResponse.ts +4 -4
  161. package/src/models/SectionSystemMetadata.ts +1 -1
  162. package/src/models/TenantSettingsUpdate.ts +2 -2
  163. package/src/models/ThreadMessageDetailsInput.ts +2 -2
  164. package/src/models/ThreadMessageDetailsOutput.ts +2 -2
  165. package/src/models/ThreadMessageResponse.ts +2 -2
  166. package/src/models/UpdateChunkMetadataRequest.ts +2 -2
  167. package/src/models/UpdateTenantRequest.ts +4 -4
  168. package/src/models/UpdateWorkflowDefinitionRequest.ts +9 -1
  169. package/src/models/WorkflowDefinitionResponse.ts +10 -1
  170. package/src/models/WorkflowRunSnapshot.ts +1 -1
  171. package/src/models/WorkflowRunStatus.ts +20 -2
  172. package/src/models/index.ts +12 -0
@@ -72,11 +72,11 @@ export interface ThreadMessageResponse {
72
72
  */
73
73
  content: EnrichedThreadMessageContent;
74
74
  /**
75
- *
75
+ * Message details (None when not requested via with_details)
76
76
  * @type {ThreadMessageDetailsOutput}
77
77
  * @memberof ThreadMessageResponse
78
78
  */
79
- details?: ThreadMessageDetailsOutput;
79
+ details?: ThreadMessageDetailsOutput | null;
80
80
  /**
81
81
  * Thread's PathPart ID
82
82
  * @type {string}
@@ -28,11 +28,11 @@ import {
28
28
  */
29
29
  export interface UpdateChunkMetadataRequest {
30
30
  /**
31
- *
31
+ * Metadata to merge into existing chunk_metadata (optional)
32
32
  * @type {ChunkMetadata}
33
33
  * @memberof UpdateChunkMetadataRequest
34
34
  */
35
- chunkMetadata?: ChunkMetadata;
35
+ chunkMetadata?: ChunkMetadata | null;
36
36
  /**
37
37
  * Reparent to this PathPart ID (must be DOCUMENT_VERSION or SECTION in the same document version)
38
38
  * @type {string}
@@ -41,17 +41,17 @@ export interface UpdateTenantRequest {
41
41
  */
42
42
  name?: string | null;
43
43
  /**
44
- *
44
+ * Optional external IdP configuration to update
45
45
  * @type {IdpConfig}
46
46
  * @memberof UpdateTenantRequest
47
47
  */
48
- idpConfig?: IdpConfig;
48
+ idpConfig?: IdpConfig | null;
49
49
  /**
50
- *
50
+ * Optional tenant settings to update
51
51
  * @type {TenantSettingsUpdate}
52
52
  * @memberof UpdateTenantRequest
53
53
  */
54
- settings?: TenantSettingsUpdate;
54
+ settings?: TenantSettingsUpdate | null;
55
55
  }
56
56
  export const UpdateTenantRequestPropertyValidationAttributesMap: {
57
57
  [property: string]: {
@@ -62,7 +62,7 @@ export interface UpdateWorkflowDefinitionRequest {
62
62
  * @type {SelfHostedRunnerConfig}
63
63
  * @memberof UpdateWorkflowDefinitionRequest
64
64
  */
65
- runnerConfig?: SelfHostedRunnerConfig;
65
+ runnerConfig?: SelfHostedRunnerConfig | null;
66
66
  /**
67
67
  *
68
68
  * @type {number}
@@ -99,6 +99,12 @@ export interface UpdateWorkflowDefinitionRequest {
99
99
  * @memberof UpdateWorkflowDefinitionRequest
100
100
  */
101
101
  isActive?: boolean;
102
+ /**
103
+ *
104
+ * @type {boolean}
105
+ * @memberof UpdateWorkflowDefinitionRequest
106
+ */
107
+ approvalRequired?: boolean;
102
108
  }
103
109
 
104
110
 
@@ -176,6 +182,7 @@ export function UpdateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDi
176
182
  'outputPathPartIds': json['output_path_part_ids'],
177
183
  'templatePathPartId': json['template_path_part_id'] == null ? undefined : json['template_path_part_id'],
178
184
  'isActive': json['is_active'] == null ? undefined : json['is_active'],
185
+ 'approvalRequired': json['approval_required'] == null ? undefined : json['approval_required'],
179
186
  };
180
187
  }
181
188
 
@@ -200,6 +207,7 @@ export function UpdateWorkflowDefinitionRequestToJSONTyped(value?: UpdateWorkflo
200
207
  'output_path_part_ids': value['outputPathPartIds'],
201
208
  'template_path_part_id': value['templatePathPartId'],
202
209
  'is_active': value['isActive'],
210
+ 'approval_required': value['approvalRequired'],
203
211
  };
204
212
  }
205
213
 
@@ -63,7 +63,7 @@ export interface WorkflowDefinitionResponse {
63
63
  * @type {SelfHostedRunnerConfigResponse}
64
64
  * @memberof WorkflowDefinitionResponse
65
65
  */
66
- runnerConfig: SelfHostedRunnerConfigResponse;
66
+ runnerConfig: SelfHostedRunnerConfigResponse | null;
67
67
  /**
68
68
  *
69
69
  * @type {number}
@@ -100,6 +100,12 @@ export interface WorkflowDefinitionResponse {
100
100
  * @memberof WorkflowDefinitionResponse
101
101
  */
102
102
  isActive: boolean;
103
+ /**
104
+ *
105
+ * @type {boolean}
106
+ * @memberof WorkflowDefinitionResponse
107
+ */
108
+ approvalRequired: boolean;
103
109
  /**
104
110
  *
105
111
  * @type {Date}
@@ -148,6 +154,7 @@ export function instanceOfWorkflowDefinitionResponse(value: object): value is Wo
148
154
  if (!('outputPathPartIds' in value) || value['outputPathPartIds'] === undefined) return false;
149
155
  if (!('templatePathPartId' in value) || value['templatePathPartId'] === undefined) return false;
150
156
  if (!('isActive' in value) || value['isActive'] === undefined) return false;
157
+ if (!('approvalRequired' in value) || value['approvalRequired'] === undefined) return false;
151
158
  if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
152
159
  if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
153
160
  return true;
@@ -174,6 +181,7 @@ export function WorkflowDefinitionResponseFromJSONTyped(json: any, ignoreDiscrim
174
181
  'outputPathPartIds': json['output_path_part_ids'],
175
182
  'templatePathPartId': json['template_path_part_id'],
176
183
  'isActive': json['is_active'],
184
+ 'approvalRequired': json['approval_required'],
177
185
  'createdAt': (new Date(json['created_at'])),
178
186
  'updatedAt': (new Date(json['updated_at'])),
179
187
  };
@@ -201,6 +209,7 @@ export function WorkflowDefinitionResponseToJSONTyped(value?: WorkflowDefinition
201
209
  'output_path_part_ids': value['outputPathPartIds'],
202
210
  'template_path_part_id': value['templatePathPartId'],
203
211
  'is_active': value['isActive'],
212
+ 'approval_required': value['approvalRequired'],
204
213
  'created_at': value['createdAt'].toISOString(),
205
214
  'updated_at': value['updatedAt'].toISOString(),
206
215
  };
@@ -94,7 +94,7 @@ export interface WorkflowRunSnapshot {
94
94
  * @type {ABCDPathSnapshot}
95
95
  * @memberof WorkflowRunSnapshot
96
96
  */
97
- template: ABCDPathSnapshot;
97
+ template: ABCDPathSnapshot | null;
98
98
  }
99
99
 
100
100
 
@@ -14,13 +14,31 @@
14
14
 
15
15
 
16
16
  /**
17
- * Lifecycle status of a workflow run.
17
+ * Combined lifecycle + approval-rollup status of a workflow run.
18
+ *
19
+ * Absorbs the prior split between ``status`` (PENDING/RUNNING/COMPLETED/
20
+ * FAILED) and ``approval_state`` (in_progress/awaiting_review/approved/
21
+ * rejected/failed). One state field per run.
22
+ *
23
+ * Allowed transitions::
24
+ *
25
+ * PENDING -> IN_PROGRESS (agent dispatched)
26
+ * IN_PROGRESS -> COMPLETED (workflow.approval_required=FALSE)
27
+ * IN_PROGRESS -> NEEDS_APPROVAL (workflow.approval_required=TRUE, agent done)
28
+ * NEEDS_APPROVAL -> APPROVED (run folder approved by reviewer)
29
+ * NEEDS_APPROVAL -> REJECTED (run folder or any child rejected)
30
+ * APPROVED -> NEEDS_APPROVAL (run folder unapproved)
31
+ * REJECTED -> NEEDS_APPROVAL (rejection reversed; mutable)
32
+ * any non-terminal -> FAILED (agent error)
18
33
  * @export
19
34
  */
20
35
  export const WorkflowRunStatus = {
21
36
  Pending: 'PENDING',
22
- Running: 'RUNNING',
37
+ InProgress: 'IN_PROGRESS',
23
38
  Completed: 'COMPLETED',
39
+ NeedsApproval: 'NEEDS_APPROVAL',
40
+ Approved: 'APPROVED',
41
+ Rejected: 'REJECTED',
24
42
  Failed: 'FAILED'
25
43
  } as const;
26
44
  export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];
@@ -5,6 +5,8 @@ export * from './AcceptInviteResponse';
5
5
  export * from './AddMemberRequest';
6
6
  export * from './AncestryResponse';
7
7
  export * from './ApiKeyResponse';
8
+ export * from './AppendEventRequest';
9
+ export * from './AppendMemoryChunkRequest';
8
10
  export * from './Args';
9
11
  export * from './AskRequest';
10
12
  export * from './AskResponse';
@@ -50,10 +52,12 @@ export * from './DocumentVersionContentTypeFilter';
50
52
  export * from './DocumentVersionMetadata';
51
53
  export * from './DocumentVersionMetadataUpdate';
52
54
  export * from './DocumentVersionResponse';
55
+ export * from './EditMemoryChunkRequest';
53
56
  export * from './EmailSentResponse';
54
57
  export * from './EmailVerificationRequest';
55
58
  export * from './EnrichedCitation';
56
59
  export * from './EnrichedThreadMessageContent';
60
+ export * from './EventResponse';
57
61
  export * from './ExtractRequest';
58
62
  export * from './ExtractResponse';
59
63
  export * from './FeaturesResponse';
@@ -86,8 +90,11 @@ export * from './InvokeWorkflowRequest';
86
90
  export * from './LineageEdgeResponse';
87
91
  export * from './LineageGraphResponse';
88
92
  export * from './LineageNodeResponse';
93
+ export * from './ListMemoryChunksResponse';
89
94
  export * from './LocationInner';
90
95
  export * from './MembershipResponse';
96
+ export * from './MemoryChunkResponse';
97
+ export * from './MemoryKind';
91
98
  export * from './MessageRole';
92
99
  export * from './MeteredQuotaStatus';
93
100
  export * from './NonFilesystemReferenceType';
@@ -97,6 +104,7 @@ export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDi
97
104
  export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
98
105
  export * from './PaginatedResponseDocumentResponse';
99
106
  export * from './PaginatedResponseDocumentVersionResponse';
107
+ export * from './PaginatedResponseEventResponse';
100
108
  export * from './PaginatedResponseFeedbackEventResponse';
101
109
  export * from './PaginatedResponseFolderResponse';
102
110
  export * from './PaginatedResponseGroupPermissionResponse';
@@ -118,6 +126,8 @@ export * from './PasswordResetRequest';
118
126
  export * from './PasswordResetWithTokenRequest';
119
127
  export * from './PathOrder';
120
128
  export * from './PathPartAncestorItem';
129
+ export * from './PathPartApprovalDecision';
130
+ export * from './PathPartApprovalResponse';
121
131
  export * from './PathPartResponse';
122
132
  export * from './PathPartTagsResponse';
123
133
  export * from './PermissionCapability';
@@ -127,9 +137,11 @@ export * from './PipelineStatus';
127
137
  export * from './Polygon';
128
138
  export * from './PolygonReference';
129
139
  export * from './ReferenceType';
140
+ export * from './RejectFileRequest';
130
141
  export * from './ResolvedReferenceInput';
131
142
  export * from './ResolvedReferenceOutput';
132
143
  export * from './RootResponse';
144
+ export * from './RunLockResponse';
133
145
  export * from './SSOInitiateResponse';
134
146
  export * from './ScoredChunkResponse';
135
147
  export * from './SearchSortOrder';