@knowledge-stack/ksapi 3.13.0 → 3.14.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.
- package/.openapi-generator/FILES +4 -0
- package/README.md +6 -2
- package/dist/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/apis/DocumentVersionsApi.js +2 -2
- package/dist/apis/SystemJobsApi.d.ts +126 -17
- package/dist/apis/SystemJobsApi.js +137 -8
- package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentVersionsApi.js +2 -2
- package/dist/esm/apis/SystemJobsApi.d.ts +126 -17
- package/dist/esm/apis/SystemJobsApi.js +138 -9
- package/dist/esm/models/BulkFailureReason.d.ts +3 -0
- package/dist/esm/models/BulkFailureReason.js +4 -1
- package/dist/esm/models/BulkRerunRequest.d.ts +47 -0
- package/dist/esm/models/BulkRerunRequest.js +42 -0
- package/dist/esm/models/PaginatedResponseUserInfo.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseUserInfo.js +70 -0
- package/dist/esm/models/WorkflowDetailResponse.d.ts +26 -1
- package/dist/esm/models/WorkflowDetailResponse.js +17 -0
- package/dist/esm/models/WorkflowSummaryResponse.d.ts +26 -1
- package/dist/esm/models/WorkflowSummaryResponse.js +17 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/BulkFailureReason.d.ts +3 -0
- package/dist/models/BulkFailureReason.js +4 -1
- package/dist/models/BulkRerunRequest.d.ts +47 -0
- package/dist/models/BulkRerunRequest.js +50 -0
- package/dist/models/PaginatedResponseUserInfo.d.ts +66 -0
- package/dist/models/PaginatedResponseUserInfo.js +78 -0
- package/dist/models/WorkflowDetailResponse.d.ts +26 -1
- package/dist/models/WorkflowDetailResponse.js +17 -0
- package/dist/models/WorkflowSummaryResponse.d.ts +26 -1
- package/dist/models/WorkflowSummaryResponse.js +17 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/BulkRerunRequest.md +35 -0
- package/docs/DocumentVersionsApi.md +1 -1
- package/docs/PaginatedResponseUserInfo.md +40 -0
- package/docs/SystemJobsApi.md +190 -5
- package/docs/WorkflowDetailResponse.md +8 -0
- package/docs/WorkflowSummaryResponse.md +8 -0
- package/package.json +1 -1
- package/src/apis/DocumentVersionsApi.ts +4 -4
- package/src/apis/SystemJobsApi.ts +272 -16
- package/src/models/BulkFailureReason.ts +4 -1
- package/src/models/BulkRerunRequest.ts +82 -0
- package/src/models/PaginatedResponseUserInfo.ts +130 -0
- package/src/models/WorkflowDetailResponse.ts +44 -1
- package/src/models/WorkflowSummaryResponse.ts +44 -1
- package/src/models/index.ts +2 -0
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { PipelineStatusFromJSON, PipelineStatusToJSON, } from './PipelineStatus';
|
|
15
|
+
import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
|
|
15
16
|
export const WorkflowSummaryResponsePropertyValidationAttributesMap = {};
|
|
16
17
|
/**
|
|
17
18
|
* Check if a given object implements the WorkflowSummaryResponse interface.
|
|
@@ -21,8 +22,16 @@ export function instanceOfWorkflowSummaryResponse(value) {
|
|
|
21
22
|
return false;
|
|
22
23
|
if (!('documentId' in value) || value['documentId'] === undefined)
|
|
23
24
|
return false;
|
|
25
|
+
if (!('documentName' in value) || value['documentName'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('materializedPath' in value) || value['materializedPath'] === undefined)
|
|
28
|
+
return false;
|
|
24
29
|
if (!('documentVersionId' in value) || value['documentVersionId'] === undefined)
|
|
25
30
|
return false;
|
|
31
|
+
if (!('isActiveVersion' in value) || value['isActiveVersion'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('uploader' in value) || value['uploader'] === undefined)
|
|
34
|
+
return false;
|
|
26
35
|
if (!('status' in value) || value['status'] === undefined)
|
|
27
36
|
return false;
|
|
28
37
|
if (!('lastRunTimestamp' in value) || value['lastRunTimestamp'] === undefined)
|
|
@@ -41,7 +50,11 @@ export function WorkflowSummaryResponseFromJSONTyped(json, ignoreDiscriminator)
|
|
|
41
50
|
return {
|
|
42
51
|
'workflowId': json['workflow_id'],
|
|
43
52
|
'documentId': json['document_id'],
|
|
53
|
+
'documentName': json['document_name'],
|
|
54
|
+
'materializedPath': json['materialized_path'],
|
|
44
55
|
'documentVersionId': json['document_version_id'],
|
|
56
|
+
'isActiveVersion': json['is_active_version'],
|
|
57
|
+
'uploader': UserInfoFromJSON(json['uploader']),
|
|
45
58
|
'status': PipelineStatusFromJSON(json['status']),
|
|
46
59
|
'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
|
|
47
60
|
'error': json['error'] == null ? undefined : json['error'],
|
|
@@ -60,7 +73,11 @@ export function WorkflowSummaryResponseToJSONTyped(value, ignoreDiscriminator =
|
|
|
60
73
|
return {
|
|
61
74
|
'workflow_id': value['workflowId'],
|
|
62
75
|
'document_id': value['documentId'],
|
|
76
|
+
'document_name': value['documentName'],
|
|
77
|
+
'materialized_path': value['materializedPath'],
|
|
63
78
|
'document_version_id': value['documentVersionId'],
|
|
79
|
+
'is_active_version': value['isActiveVersion'],
|
|
80
|
+
'uploader': UserInfoToJSON(value['uploader']),
|
|
64
81
|
'status': PipelineStatusToJSON(value['status']),
|
|
65
82
|
'last_activity': value['lastActivity'],
|
|
66
83
|
'error': value['error'],
|
|
@@ -35,6 +35,7 @@ export * from './BulkModelTablesRequest';
|
|
|
35
35
|
export * from './BulkModelTablesResponse';
|
|
36
36
|
export * from './BulkMoveRequest';
|
|
37
37
|
export * from './BulkOperationResponse';
|
|
38
|
+
export * from './BulkRerunRequest';
|
|
38
39
|
export * from './BulkRevokeRequest';
|
|
39
40
|
export * from './BulkTagRequest';
|
|
40
41
|
export * from './BulkTrashRequest';
|
|
@@ -235,6 +236,7 @@ export * from './PaginatedResponseTenantUserResponse';
|
|
|
235
236
|
export * from './PaginatedResponseThreadMessageResponse';
|
|
236
237
|
export * from './PaginatedResponseThreadResponse';
|
|
237
238
|
export * from './PaginatedResponseTrashItemResponse';
|
|
239
|
+
export * from './PaginatedResponseUserInfo';
|
|
238
240
|
export * from './PaginatedResponseWorkflowDefinitionResponse';
|
|
239
241
|
export * from './PaginatedResponseWorkflowRunResponse';
|
|
240
242
|
export * from './PaginatedResponseWorkflowSummaryResponse';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -37,6 +37,7 @@ export * from './BulkModelTablesRequest';
|
|
|
37
37
|
export * from './BulkModelTablesResponse';
|
|
38
38
|
export * from './BulkMoveRequest';
|
|
39
39
|
export * from './BulkOperationResponse';
|
|
40
|
+
export * from './BulkRerunRequest';
|
|
40
41
|
export * from './BulkRevokeRequest';
|
|
41
42
|
export * from './BulkTagRequest';
|
|
42
43
|
export * from './BulkTrashRequest';
|
|
@@ -237,6 +238,7 @@ export * from './PaginatedResponseTenantUserResponse';
|
|
|
237
238
|
export * from './PaginatedResponseThreadMessageResponse';
|
|
238
239
|
export * from './PaginatedResponseThreadResponse';
|
|
239
240
|
export * from './PaginatedResponseTrashItemResponse';
|
|
241
|
+
export * from './PaginatedResponseUserInfo';
|
|
240
242
|
export * from './PaginatedResponseWorkflowDefinitionResponse';
|
|
241
243
|
export * from './PaginatedResponseWorkflowRunResponse';
|
|
242
244
|
export * from './PaginatedResponseWorkflowSummaryResponse';
|
|
@@ -28,6 +28,9 @@ export declare const BulkFailureReason: {
|
|
|
28
28
|
readonly NameConflict: 'name_conflict';
|
|
29
29
|
readonly InProgressWorkflow: 'in_progress_workflow';
|
|
30
30
|
readonly PermissionLimit: 'permission_limit';
|
|
31
|
+
readonly AlreadyIngested: 'already_ingested';
|
|
32
|
+
readonly UnsupportedDocumentType: 'unsupported_document_type';
|
|
33
|
+
readonly Superseded: 'superseded';
|
|
31
34
|
};
|
|
32
35
|
export type BulkFailureReason = typeof BulkFailureReason[keyof typeof BulkFailureReason];
|
|
33
36
|
export declare function instanceOfBulkFailureReason(value: any): boolean;
|
|
@@ -37,7 +37,10 @@ exports.BulkFailureReason = {
|
|
|
37
37
|
CheckedOut: 'checked_out',
|
|
38
38
|
NameConflict: 'name_conflict',
|
|
39
39
|
InProgressWorkflow: 'in_progress_workflow',
|
|
40
|
-
PermissionLimit: 'permission_limit'
|
|
40
|
+
PermissionLimit: 'permission_limit',
|
|
41
|
+
AlreadyIngested: 'already_ingested',
|
|
42
|
+
UnsupportedDocumentType: 'unsupported_document_type',
|
|
43
|
+
Superseded: 'superseded'
|
|
41
44
|
};
|
|
42
45
|
function instanceOfBulkFailureReason(value) {
|
|
43
46
|
for (const key in exports.BulkFailureReason) {
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
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
|
+
* Re-run ingestion for the selected document versions.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface BulkRerunRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface BulkRerunRequest {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {Array<string>}
|
|
21
|
+
* @memberof BulkRerunRequest
|
|
22
|
+
*/
|
|
23
|
+
documentVersionIds?: Array<string>;
|
|
24
|
+
}
|
|
25
|
+
export declare const BulkRerunRequestPropertyValidationAttributesMap: {
|
|
26
|
+
[property: string]: {
|
|
27
|
+
maxLength?: number;
|
|
28
|
+
minLength?: number;
|
|
29
|
+
pattern?: string;
|
|
30
|
+
maximum?: number;
|
|
31
|
+
exclusiveMaximum?: boolean;
|
|
32
|
+
minimum?: number;
|
|
33
|
+
exclusiveMinimum?: boolean;
|
|
34
|
+
multipleOf?: number;
|
|
35
|
+
maxItems?: number;
|
|
36
|
+
minItems?: number;
|
|
37
|
+
uniqueItems?: boolean;
|
|
38
|
+
};
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* Check if a given object implements the BulkRerunRequest interface.
|
|
42
|
+
*/
|
|
43
|
+
export declare function instanceOfBulkRerunRequest(value: object): value is BulkRerunRequest;
|
|
44
|
+
export declare function BulkRerunRequestFromJSON(json: any): BulkRerunRequest;
|
|
45
|
+
export declare function BulkRerunRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkRerunRequest;
|
|
46
|
+
export declare function BulkRerunRequestToJSON(json: any): BulkRerunRequest;
|
|
47
|
+
export declare function BulkRerunRequestToJSONTyped(value?: BulkRerunRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
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.BulkRerunRequestPropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfBulkRerunRequest = instanceOfBulkRerunRequest;
|
|
18
|
+
exports.BulkRerunRequestFromJSON = BulkRerunRequestFromJSON;
|
|
19
|
+
exports.BulkRerunRequestFromJSONTyped = BulkRerunRequestFromJSONTyped;
|
|
20
|
+
exports.BulkRerunRequestToJSON = BulkRerunRequestToJSON;
|
|
21
|
+
exports.BulkRerunRequestToJSONTyped = BulkRerunRequestToJSONTyped;
|
|
22
|
+
exports.BulkRerunRequestPropertyValidationAttributesMap = {};
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the BulkRerunRequest interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfBulkRerunRequest(value) {
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
function BulkRerunRequestFromJSON(json) {
|
|
30
|
+
return BulkRerunRequestFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
function BulkRerunRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if (json == null) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'documentVersionIds': json['document_version_ids'] == null ? undefined : json['document_version_ids'],
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
function BulkRerunRequestToJSON(json) {
|
|
41
|
+
return BulkRerunRequestToJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
function BulkRerunRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
44
|
+
if (value == null) {
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'document_version_ids': value['documentVersionIds'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
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 { UserInfo } from './UserInfo';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface PaginatedResponseUserInfo
|
|
17
|
+
*/
|
|
18
|
+
export interface PaginatedResponseUserInfo {
|
|
19
|
+
/**
|
|
20
|
+
* List of items
|
|
21
|
+
* @type {Array<UserInfo>}
|
|
22
|
+
* @memberof PaginatedResponseUserInfo
|
|
23
|
+
*/
|
|
24
|
+
items: Array<UserInfo>;
|
|
25
|
+
/**
|
|
26
|
+
* Total number of items
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof PaginatedResponseUserInfo
|
|
29
|
+
*/
|
|
30
|
+
total: number;
|
|
31
|
+
/**
|
|
32
|
+
* Number of items per page
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof PaginatedResponseUserInfo
|
|
35
|
+
*/
|
|
36
|
+
limit: number;
|
|
37
|
+
/**
|
|
38
|
+
* Number of items to skip
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof PaginatedResponseUserInfo
|
|
41
|
+
*/
|
|
42
|
+
offset: number;
|
|
43
|
+
}
|
|
44
|
+
export declare const PaginatedResponseUserInfoPropertyValidationAttributesMap: {
|
|
45
|
+
[property: string]: {
|
|
46
|
+
maxLength?: number;
|
|
47
|
+
minLength?: number;
|
|
48
|
+
pattern?: string;
|
|
49
|
+
maximum?: number;
|
|
50
|
+
exclusiveMaximum?: boolean;
|
|
51
|
+
minimum?: number;
|
|
52
|
+
exclusiveMinimum?: boolean;
|
|
53
|
+
multipleOf?: number;
|
|
54
|
+
maxItems?: number;
|
|
55
|
+
minItems?: number;
|
|
56
|
+
uniqueItems?: boolean;
|
|
57
|
+
};
|
|
58
|
+
};
|
|
59
|
+
/**
|
|
60
|
+
* Check if a given object implements the PaginatedResponseUserInfo interface.
|
|
61
|
+
*/
|
|
62
|
+
export declare function instanceOfPaginatedResponseUserInfo(value: object): value is PaginatedResponseUserInfo;
|
|
63
|
+
export declare function PaginatedResponseUserInfoFromJSON(json: any): PaginatedResponseUserInfo;
|
|
64
|
+
export declare function PaginatedResponseUserInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseUserInfo;
|
|
65
|
+
export declare function PaginatedResponseUserInfoToJSON(json: any): PaginatedResponseUserInfo;
|
|
66
|
+
export declare function PaginatedResponseUserInfoToJSONTyped(value?: PaginatedResponseUserInfo | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
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.PaginatedResponseUserInfoPropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfPaginatedResponseUserInfo = instanceOfPaginatedResponseUserInfo;
|
|
18
|
+
exports.PaginatedResponseUserInfoFromJSON = PaginatedResponseUserInfoFromJSON;
|
|
19
|
+
exports.PaginatedResponseUserInfoFromJSONTyped = PaginatedResponseUserInfoFromJSONTyped;
|
|
20
|
+
exports.PaginatedResponseUserInfoToJSON = PaginatedResponseUserInfoToJSON;
|
|
21
|
+
exports.PaginatedResponseUserInfoToJSONTyped = PaginatedResponseUserInfoToJSONTyped;
|
|
22
|
+
const UserInfo_1 = require("./UserInfo");
|
|
23
|
+
exports.PaginatedResponseUserInfoPropertyValidationAttributesMap = {
|
|
24
|
+
total: {
|
|
25
|
+
minimum: 0,
|
|
26
|
+
exclusiveMinimum: false,
|
|
27
|
+
},
|
|
28
|
+
limit: {
|
|
29
|
+
minimum: 1,
|
|
30
|
+
exclusiveMinimum: false,
|
|
31
|
+
},
|
|
32
|
+
offset: {
|
|
33
|
+
minimum: 0,
|
|
34
|
+
exclusiveMinimum: false,
|
|
35
|
+
},
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the PaginatedResponseUserInfo interface.
|
|
39
|
+
*/
|
|
40
|
+
function instanceOfPaginatedResponseUserInfo(value) {
|
|
41
|
+
if (!('items' in value) || value['items'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('total' in value) || value['total'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('limit' in value) || value['limit'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('offset' in value) || value['offset'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
return true;
|
|
50
|
+
}
|
|
51
|
+
function PaginatedResponseUserInfoFromJSON(json) {
|
|
52
|
+
return PaginatedResponseUserInfoFromJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function PaginatedResponseUserInfoFromJSONTyped(json, ignoreDiscriminator) {
|
|
55
|
+
if (json == null) {
|
|
56
|
+
return json;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'items': (json['items'].map(UserInfo_1.UserInfoFromJSON)),
|
|
60
|
+
'total': json['total'],
|
|
61
|
+
'limit': json['limit'],
|
|
62
|
+
'offset': json['offset'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
function PaginatedResponseUserInfoToJSON(json) {
|
|
66
|
+
return PaginatedResponseUserInfoToJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
function PaginatedResponseUserInfoToJSONTyped(value, ignoreDiscriminator = false) {
|
|
69
|
+
if (value == null) {
|
|
70
|
+
return value;
|
|
71
|
+
}
|
|
72
|
+
return {
|
|
73
|
+
'items': (value['items'].map(UserInfo_1.UserInfoToJSON)),
|
|
74
|
+
'total': value['total'],
|
|
75
|
+
'limit': value['limit'],
|
|
76
|
+
'offset': value['offset'],
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { PipelineStatus } from './PipelineStatus';
|
|
13
|
+
import type { UserInfo } from './UserInfo';
|
|
13
14
|
/**
|
|
14
15
|
* Single item - adds live Temporal fields.
|
|
15
16
|
* @export
|
|
@@ -28,12 +29,36 @@ export interface WorkflowDetailResponse {
|
|
|
28
29
|
* @memberof WorkflowDetailResponse
|
|
29
30
|
*/
|
|
30
31
|
documentId: string;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof WorkflowDetailResponse
|
|
36
|
+
*/
|
|
37
|
+
documentName: string;
|
|
38
|
+
/**
|
|
39
|
+
* The document's path
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof WorkflowDetailResponse
|
|
42
|
+
*/
|
|
43
|
+
materializedPath: string;
|
|
31
44
|
/**
|
|
32
45
|
*
|
|
33
46
|
* @type {string}
|
|
34
47
|
* @memberof WorkflowDetailResponse
|
|
35
48
|
*/
|
|
36
49
|
documentVersionId: string;
|
|
50
|
+
/**
|
|
51
|
+
* Whether this version is the document's active one; false for an unfinished newer upload and for a superseded older version
|
|
52
|
+
* @type {boolean}
|
|
53
|
+
* @memberof WorkflowDetailResponse
|
|
54
|
+
*/
|
|
55
|
+
isActiveVersion: boolean;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {UserInfo}
|
|
59
|
+
* @memberof WorkflowDetailResponse
|
|
60
|
+
*/
|
|
61
|
+
uploader: UserInfo;
|
|
37
62
|
/**
|
|
38
63
|
*
|
|
39
64
|
* @type {PipelineStatus}
|
|
@@ -53,7 +78,7 @@ export interface WorkflowDetailResponse {
|
|
|
53
78
|
*/
|
|
54
79
|
error?: string | null;
|
|
55
80
|
/**
|
|
56
|
-
*
|
|
81
|
+
* When the last run started; the upload time until a run has started
|
|
57
82
|
* @type {Date}
|
|
58
83
|
* @memberof WorkflowDetailResponse
|
|
59
84
|
*/
|
|
@@ -20,6 +20,7 @@ exports.WorkflowDetailResponseFromJSONTyped = WorkflowDetailResponseFromJSONType
|
|
|
20
20
|
exports.WorkflowDetailResponseToJSON = WorkflowDetailResponseToJSON;
|
|
21
21
|
exports.WorkflowDetailResponseToJSONTyped = WorkflowDetailResponseToJSONTyped;
|
|
22
22
|
const PipelineStatus_1 = require("./PipelineStatus");
|
|
23
|
+
const UserInfo_1 = require("./UserInfo");
|
|
23
24
|
exports.WorkflowDetailResponsePropertyValidationAttributesMap = {};
|
|
24
25
|
/**
|
|
25
26
|
* Check if a given object implements the WorkflowDetailResponse interface.
|
|
@@ -29,8 +30,16 @@ function instanceOfWorkflowDetailResponse(value) {
|
|
|
29
30
|
return false;
|
|
30
31
|
if (!('documentId' in value) || value['documentId'] === undefined)
|
|
31
32
|
return false;
|
|
33
|
+
if (!('documentName' in value) || value['documentName'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('materializedPath' in value) || value['materializedPath'] === undefined)
|
|
36
|
+
return false;
|
|
32
37
|
if (!('documentVersionId' in value) || value['documentVersionId'] === undefined)
|
|
33
38
|
return false;
|
|
39
|
+
if (!('isActiveVersion' in value) || value['isActiveVersion'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('uploader' in value) || value['uploader'] === undefined)
|
|
42
|
+
return false;
|
|
34
43
|
if (!('status' in value) || value['status'] === undefined)
|
|
35
44
|
return false;
|
|
36
45
|
if (!('lastRunTimestamp' in value) || value['lastRunTimestamp'] === undefined)
|
|
@@ -59,7 +68,11 @@ function WorkflowDetailResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
59
68
|
return {
|
|
60
69
|
'workflowId': json['workflow_id'],
|
|
61
70
|
'documentId': json['document_id'],
|
|
71
|
+
'documentName': json['document_name'],
|
|
72
|
+
'materializedPath': json['materialized_path'],
|
|
62
73
|
'documentVersionId': json['document_version_id'],
|
|
74
|
+
'isActiveVersion': json['is_active_version'],
|
|
75
|
+
'uploader': (0, UserInfo_1.UserInfoFromJSON)(json['uploader']),
|
|
63
76
|
'status': (0, PipelineStatus_1.PipelineStatusFromJSON)(json['status']),
|
|
64
77
|
'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
|
|
65
78
|
'error': json['error'] == null ? undefined : json['error'],
|
|
@@ -85,7 +98,11 @@ function WorkflowDetailResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
85
98
|
return {
|
|
86
99
|
'workflow_id': value['workflowId'],
|
|
87
100
|
'document_id': value['documentId'],
|
|
101
|
+
'document_name': value['documentName'],
|
|
102
|
+
'materialized_path': value['materializedPath'],
|
|
88
103
|
'document_version_id': value['documentVersionId'],
|
|
104
|
+
'is_active_version': value['isActiveVersion'],
|
|
105
|
+
'uploader': (0, UserInfo_1.UserInfoToJSON)(value['uploader']),
|
|
89
106
|
'status': (0, PipelineStatus_1.PipelineStatusToJSON)(value['status']),
|
|
90
107
|
'last_activity': value['lastActivity'],
|
|
91
108
|
'error': value['error'],
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { PipelineStatus } from './PipelineStatus';
|
|
13
|
+
import type { UserInfo } from './UserInfo';
|
|
13
14
|
/**
|
|
14
15
|
* List item - DB-only fields, no Temporal call per item.
|
|
15
16
|
* @export
|
|
@@ -28,12 +29,36 @@ export interface WorkflowSummaryResponse {
|
|
|
28
29
|
* @memberof WorkflowSummaryResponse
|
|
29
30
|
*/
|
|
30
31
|
documentId: string;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof WorkflowSummaryResponse
|
|
36
|
+
*/
|
|
37
|
+
documentName: string;
|
|
38
|
+
/**
|
|
39
|
+
* The document's path
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof WorkflowSummaryResponse
|
|
42
|
+
*/
|
|
43
|
+
materializedPath: string;
|
|
31
44
|
/**
|
|
32
45
|
*
|
|
33
46
|
* @type {string}
|
|
34
47
|
* @memberof WorkflowSummaryResponse
|
|
35
48
|
*/
|
|
36
49
|
documentVersionId: string;
|
|
50
|
+
/**
|
|
51
|
+
* Whether this version is the document's active one; false for an unfinished newer upload and for a superseded older version
|
|
52
|
+
* @type {boolean}
|
|
53
|
+
* @memberof WorkflowSummaryResponse
|
|
54
|
+
*/
|
|
55
|
+
isActiveVersion: boolean;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {UserInfo}
|
|
59
|
+
* @memberof WorkflowSummaryResponse
|
|
60
|
+
*/
|
|
61
|
+
uploader: UserInfo;
|
|
37
62
|
/**
|
|
38
63
|
*
|
|
39
64
|
* @type {PipelineStatus}
|
|
@@ -53,7 +78,7 @@ export interface WorkflowSummaryResponse {
|
|
|
53
78
|
*/
|
|
54
79
|
error?: string | null;
|
|
55
80
|
/**
|
|
56
|
-
*
|
|
81
|
+
* When the last run started; the upload time until a run has started
|
|
57
82
|
* @type {Date}
|
|
58
83
|
* @memberof WorkflowSummaryResponse
|
|
59
84
|
*/
|
|
@@ -20,6 +20,7 @@ exports.WorkflowSummaryResponseFromJSONTyped = WorkflowSummaryResponseFromJSONTy
|
|
|
20
20
|
exports.WorkflowSummaryResponseToJSON = WorkflowSummaryResponseToJSON;
|
|
21
21
|
exports.WorkflowSummaryResponseToJSONTyped = WorkflowSummaryResponseToJSONTyped;
|
|
22
22
|
const PipelineStatus_1 = require("./PipelineStatus");
|
|
23
|
+
const UserInfo_1 = require("./UserInfo");
|
|
23
24
|
exports.WorkflowSummaryResponsePropertyValidationAttributesMap = {};
|
|
24
25
|
/**
|
|
25
26
|
* Check if a given object implements the WorkflowSummaryResponse interface.
|
|
@@ -29,8 +30,16 @@ function instanceOfWorkflowSummaryResponse(value) {
|
|
|
29
30
|
return false;
|
|
30
31
|
if (!('documentId' in value) || value['documentId'] === undefined)
|
|
31
32
|
return false;
|
|
33
|
+
if (!('documentName' in value) || value['documentName'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('materializedPath' in value) || value['materializedPath'] === undefined)
|
|
36
|
+
return false;
|
|
32
37
|
if (!('documentVersionId' in value) || value['documentVersionId'] === undefined)
|
|
33
38
|
return false;
|
|
39
|
+
if (!('isActiveVersion' in value) || value['isActiveVersion'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('uploader' in value) || value['uploader'] === undefined)
|
|
42
|
+
return false;
|
|
34
43
|
if (!('status' in value) || value['status'] === undefined)
|
|
35
44
|
return false;
|
|
36
45
|
if (!('lastRunTimestamp' in value) || value['lastRunTimestamp'] === undefined)
|
|
@@ -49,7 +58,11 @@ function WorkflowSummaryResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
49
58
|
return {
|
|
50
59
|
'workflowId': json['workflow_id'],
|
|
51
60
|
'documentId': json['document_id'],
|
|
61
|
+
'documentName': json['document_name'],
|
|
62
|
+
'materializedPath': json['materialized_path'],
|
|
52
63
|
'documentVersionId': json['document_version_id'],
|
|
64
|
+
'isActiveVersion': json['is_active_version'],
|
|
65
|
+
'uploader': (0, UserInfo_1.UserInfoFromJSON)(json['uploader']),
|
|
53
66
|
'status': (0, PipelineStatus_1.PipelineStatusFromJSON)(json['status']),
|
|
54
67
|
'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
|
|
55
68
|
'error': json['error'] == null ? undefined : json['error'],
|
|
@@ -68,7 +81,11 @@ function WorkflowSummaryResponseToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
68
81
|
return {
|
|
69
82
|
'workflow_id': value['workflowId'],
|
|
70
83
|
'document_id': value['documentId'],
|
|
84
|
+
'document_name': value['documentName'],
|
|
85
|
+
'materialized_path': value['materializedPath'],
|
|
71
86
|
'document_version_id': value['documentVersionId'],
|
|
87
|
+
'is_active_version': value['isActiveVersion'],
|
|
88
|
+
'uploader': (0, UserInfo_1.UserInfoToJSON)(value['uploader']),
|
|
72
89
|
'status': (0, PipelineStatus_1.PipelineStatusToJSON)(value['status']),
|
|
73
90
|
'last_activity': value['lastActivity'],
|
|
74
91
|
'error': value['error'],
|
package/dist/models/index.d.ts
CHANGED
|
@@ -35,6 +35,7 @@ export * from './BulkModelTablesRequest';
|
|
|
35
35
|
export * from './BulkModelTablesResponse';
|
|
36
36
|
export * from './BulkMoveRequest';
|
|
37
37
|
export * from './BulkOperationResponse';
|
|
38
|
+
export * from './BulkRerunRequest';
|
|
38
39
|
export * from './BulkRevokeRequest';
|
|
39
40
|
export * from './BulkTagRequest';
|
|
40
41
|
export * from './BulkTrashRequest';
|
|
@@ -235,6 +236,7 @@ export * from './PaginatedResponseTenantUserResponse';
|
|
|
235
236
|
export * from './PaginatedResponseThreadMessageResponse';
|
|
236
237
|
export * from './PaginatedResponseThreadResponse';
|
|
237
238
|
export * from './PaginatedResponseTrashItemResponse';
|
|
239
|
+
export * from './PaginatedResponseUserInfo';
|
|
238
240
|
export * from './PaginatedResponseWorkflowDefinitionResponse';
|
|
239
241
|
export * from './PaginatedResponseWorkflowRunResponse';
|
|
240
242
|
export * from './PaginatedResponseWorkflowSummaryResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -53,6 +53,7 @@ __exportStar(require("./BulkModelTablesRequest"), exports);
|
|
|
53
53
|
__exportStar(require("./BulkModelTablesResponse"), exports);
|
|
54
54
|
__exportStar(require("./BulkMoveRequest"), exports);
|
|
55
55
|
__exportStar(require("./BulkOperationResponse"), exports);
|
|
56
|
+
__exportStar(require("./BulkRerunRequest"), exports);
|
|
56
57
|
__exportStar(require("./BulkRevokeRequest"), exports);
|
|
57
58
|
__exportStar(require("./BulkTagRequest"), exports);
|
|
58
59
|
__exportStar(require("./BulkTrashRequest"), exports);
|
|
@@ -253,6 +254,7 @@ __exportStar(require("./PaginatedResponseTenantUserResponse"), exports);
|
|
|
253
254
|
__exportStar(require("./PaginatedResponseThreadMessageResponse"), exports);
|
|
254
255
|
__exportStar(require("./PaginatedResponseThreadResponse"), exports);
|
|
255
256
|
__exportStar(require("./PaginatedResponseTrashItemResponse"), exports);
|
|
257
|
+
__exportStar(require("./PaginatedResponseUserInfo"), exports);
|
|
256
258
|
__exportStar(require("./PaginatedResponseWorkflowDefinitionResponse"), exports);
|
|
257
259
|
__exportStar(require("./PaginatedResponseWorkflowRunResponse"), exports);
|
|
258
260
|
__exportStar(require("./PaginatedResponseWorkflowSummaryResponse"), exports);
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
# BulkRerunRequest
|
|
3
|
+
|
|
4
|
+
Re-run ingestion for the selected document versions.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`documentVersionIds` | Array<string>
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { BulkRerunRequest } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"documentVersionIds": null,
|
|
20
|
+
} satisfies BulkRerunRequest
|
|
21
|
+
|
|
22
|
+
console.log(example)
|
|
23
|
+
|
|
24
|
+
// Convert the instance to a JSON string
|
|
25
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
26
|
+
console.log(exampleJSON)
|
|
27
|
+
|
|
28
|
+
// Parse the JSON string back to an object
|
|
29
|
+
const exampleParsed = JSON.parse(exampleJSON) as BulkRerunRequest
|
|
30
|
+
console.log(exampleParsed)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
34
|
+
|
|
35
|
+
|
|
@@ -826,7 +826,7 @@ example().catch(console.error);
|
|
|
826
826
|
|
|
827
827
|
Update Document Version Metadata Handler
|
|
828
828
|
|
|
829
|
-
Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
829
|
+
Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``). Any settle pushes a tenant-wide ``document_detail_changed``; a failed, cancelled or quota-limited one does so with the ``ingestion_failed`` kind so open views (the Ingestions page) refetch.
|
|
830
830
|
|
|
831
831
|
### Example
|
|
832
832
|
|