@knowledge-stack/ksapi 1.135.1 → 1.136.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 +28 -4
- package/README.md +29 -4
- package/dist/apis/FoldersApi.d.ts +9 -9
- package/dist/apis/FoldersApi.js +2 -2
- package/dist/apis/SkillsApi.d.ts +579 -0
- package/dist/apis/SkillsApi.js +786 -0
- package/dist/apis/WorkflowDefinitionsApi.d.ts +3 -0
- package/dist/apis/WorkflowDefinitionsApi.js +3 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/FoldersApi.d.ts +9 -9
- package/dist/esm/apis/FoldersApi.js +3 -3
- package/dist/esm/apis/SkillsApi.d.ts +579 -0
- package/dist/esm/apis/SkillsApi.js +749 -0
- package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +3 -0
- package/dist/esm/apis/WorkflowDefinitionsApi.js +3 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/ActivateSkillVersionRequest.d.ts +47 -0
- package/dist/esm/models/ActivateSkillVersionRequest.js +42 -0
- package/dist/esm/models/CreateSkillRequest.d.ts +60 -0
- package/dist/esm/models/CreateSkillRequest.js +59 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +6 -0
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.d.ts} +9 -6
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.js} +11 -6
- package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.d.ts} +16 -16
- package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.js} +12 -12
- package/dist/esm/models/PaginatedResponseSkillResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseSkillResponse.js +70 -0
- package/dist/esm/models/PartType.d.ts +1 -0
- package/dist/esm/models/PartType.js +2 -1
- package/dist/esm/models/ReferenceType.d.ts +1 -0
- package/dist/esm/models/ReferenceType.js +1 -0
- package/dist/esm/models/SearchSkillsRequest.d.ts +59 -0
- package/dist/esm/models/SearchSkillsRequest.js +64 -0
- package/dist/esm/models/SearchSkillsResponse.d.ts +48 -0
- package/dist/esm/models/SearchSkillsResponse.js +43 -0
- package/dist/esm/models/SkillOrder.d.ts +26 -0
- package/dist/esm/models/SkillOrder.js +44 -0
- package/dist/esm/models/SkillResponse.d.ts +147 -0
- package/dist/esm/models/SkillResponse.js +101 -0
- package/dist/esm/models/SkillScriptFile.d.ts +53 -0
- package/dist/esm/models/SkillScriptFile.js +52 -0
- package/dist/esm/models/SkillSearchResult.d.ts +71 -0
- package/dist/esm/models/SkillSearchResult.js +60 -0
- package/dist/esm/models/SkillVersionResponse.d.ts +71 -0
- package/dist/esm/models/SkillVersionResponse.js +58 -0
- package/dist/esm/models/UpdateSkillRequest.d.ts +54 -0
- package/dist/esm/models/UpdateSkillRequest.js +50 -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/WorkflowRunSnapshot.d.ts +6 -0
- package/dist/esm/models/WorkflowRunSnapshot.js +2 -0
- package/dist/esm/models/index.d.ts +13 -2
- package/dist/esm/models/index.js +13 -2
- package/dist/models/ActivateSkillVersionRequest.d.ts +47 -0
- package/dist/models/ActivateSkillVersionRequest.js +50 -0
- package/dist/models/CreateSkillRequest.d.ts +60 -0
- package/dist/models/CreateSkillRequest.js +67 -0
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/models/CreateWorkflowDefinitionRequest.js +6 -0
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.d.ts} +9 -6
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.js} +15 -10
- package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.d.ts} +16 -16
- package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.js} +18 -18
- package/dist/models/PaginatedResponseSkillResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseSkillResponse.js +78 -0
- package/dist/models/PartType.d.ts +1 -0
- package/dist/models/PartType.js +2 -1
- package/dist/models/ReferenceType.d.ts +1 -0
- package/dist/models/ReferenceType.js +1 -0
- package/dist/models/SearchSkillsRequest.d.ts +59 -0
- package/dist/models/SearchSkillsRequest.js +72 -0
- package/dist/models/SearchSkillsResponse.d.ts +48 -0
- package/dist/models/SearchSkillsResponse.js +51 -0
- package/dist/models/SkillOrder.d.ts +26 -0
- package/dist/models/SkillOrder.js +52 -0
- package/dist/models/SkillResponse.d.ts +147 -0
- package/dist/models/SkillResponse.js +109 -0
- package/dist/models/SkillScriptFile.d.ts +53 -0
- package/dist/models/SkillScriptFile.js +60 -0
- package/dist/models/SkillSearchResult.d.ts +71 -0
- package/dist/models/SkillSearchResult.js +68 -0
- package/dist/models/SkillVersionResponse.d.ts +71 -0
- package/dist/models/SkillVersionResponse.js +66 -0
- package/dist/models/UpdateSkillRequest.d.ts +54 -0
- package/dist/models/UpdateSkillRequest.js +58 -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/WorkflowRunSnapshot.d.ts +6 -0
- package/dist/models/WorkflowRunSnapshot.js +2 -0
- package/dist/models/index.d.ts +13 -2
- package/dist/models/index.js +13 -2
- package/docs/ActivateSkillVersionRequest.md +35 -0
- package/docs/ChunksApi.md +1 -1
- package/docs/CreateSkillRequest.md +39 -0
- package/docs/CreateWorkflowDefinitionRequest.md +2 -0
- package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.md} +12 -4
- package/docs/FoldersApi.md +4 -4
- package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.md} +5 -5
- package/docs/PaginatedResponseSkillResponse.md +40 -0
- package/docs/SearchSkillsRequest.md +39 -0
- package/docs/SearchSkillsResponse.md +34 -0
- package/docs/SkillOrder.md +33 -0
- package/docs/SkillResponse.md +65 -0
- package/docs/SkillScriptFile.md +37 -0
- package/docs/SkillSearchResult.md +43 -0
- package/docs/SkillVersionResponse.md +43 -0
- package/docs/SkillsApi.md +1093 -0
- package/docs/UpdateSkillRequest.md +37 -0
- package/docs/UpdateWorkflowDefinitionRequest.md +2 -0
- package/docs/WorkflowDefinitionResponse.md +2 -0
- package/docs/WorkflowDefinitionsApi.md +4 -1
- package/docs/WorkflowRunSnapshot.md +2 -0
- package/package.json +1 -1
- package/src/apis/FoldersApi.ts +13 -13
- package/src/apis/SkillsApi.ts +1321 -0
- package/src/apis/WorkflowDefinitionsApi.ts +7 -0
- package/src/apis/index.ts +1 -0
- package/src/models/ActivateSkillVersionRequest.ts +82 -0
- package/src/models/CreateSkillRequest.ts +115 -0
- package/src/models/CreateWorkflowDefinitionRequest.ts +12 -0
- package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.ts} +19 -8
- package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.ts} +25 -25
- package/src/models/PaginatedResponseSkillResponse.ts +130 -0
- package/src/models/PartType.ts +2 -1
- package/src/models/ReferenceType.ts +1 -0
- package/src/models/SearchSkillsRequest.ts +114 -0
- package/src/models/SearchSkillsResponse.ts +90 -0
- package/src/models/SkillOrder.ts +54 -0
- package/src/models/SkillResponse.ts +244 -0
- package/src/models/SkillScriptFile.ts +95 -0
- package/src/models/SkillSearchResult.ts +119 -0
- package/src/models/SkillVersionResponse.ts +118 -0
- package/src/models/UpdateSkillRequest.ts +102 -0
- package/src/models/UpdateWorkflowDefinitionRequest.ts +12 -0
- package/src/models/WorkflowDefinitionResponse.ts +8 -0
- package/src/models/WorkflowRunSnapshot.ts +8 -0
- package/src/models/index.ts +13 -2
|
@@ -0,0 +1,52 @@
|
|
|
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.SkillOrder = void 0;
|
|
17
|
+
exports.instanceOfSkillOrder = instanceOfSkillOrder;
|
|
18
|
+
exports.SkillOrderFromJSON = SkillOrderFromJSON;
|
|
19
|
+
exports.SkillOrderFromJSONTyped = SkillOrderFromJSONTyped;
|
|
20
|
+
exports.SkillOrderToJSON = SkillOrderToJSON;
|
|
21
|
+
exports.SkillOrderToJSONTyped = SkillOrderToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Sort fields for the skill list (sidebar/browse).
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.SkillOrder = {
|
|
27
|
+
Name: 'NAME',
|
|
28
|
+
CreatedAt: 'CREATED_AT',
|
|
29
|
+
UpdatedAt: 'UPDATED_AT'
|
|
30
|
+
};
|
|
31
|
+
function instanceOfSkillOrder(value) {
|
|
32
|
+
for (const key in exports.SkillOrder) {
|
|
33
|
+
if (Object.prototype.hasOwnProperty.call(exports.SkillOrder, key)) {
|
|
34
|
+
if (exports.SkillOrder[key] === value) {
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
return false;
|
|
40
|
+
}
|
|
41
|
+
function SkillOrderFromJSON(json) {
|
|
42
|
+
return SkillOrderFromJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function SkillOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
45
|
+
return json;
|
|
46
|
+
}
|
|
47
|
+
function SkillOrderToJSON(value) {
|
|
48
|
+
return value;
|
|
49
|
+
}
|
|
50
|
+
function SkillOrderToJSONTyped(value, ignoreDiscriminator) {
|
|
51
|
+
return value;
|
|
52
|
+
}
|
|
@@ -0,0 +1,147 @@
|
|
|
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 { ItemPermissions } from './ItemPermissions';
|
|
13
|
+
import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
14
|
+
import type { UserInfo } from './UserInfo';
|
|
15
|
+
/**
|
|
16
|
+
* Skill response; ``part_type`` is the folder-listing discriminator.
|
|
17
|
+
* @export
|
|
18
|
+
* @interface SkillResponse
|
|
19
|
+
*/
|
|
20
|
+
export interface SkillResponse {
|
|
21
|
+
/**
|
|
22
|
+
* Path part type
|
|
23
|
+
* @type {SkillResponsePartTypeEnum}
|
|
24
|
+
* @memberof SkillResponse
|
|
25
|
+
*/
|
|
26
|
+
partType?: SkillResponsePartTypeEnum;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof SkillResponse
|
|
31
|
+
*/
|
|
32
|
+
id: string;
|
|
33
|
+
/**
|
|
34
|
+
* SKILL path_part of this skill
|
|
35
|
+
* @type {string}
|
|
36
|
+
* @memberof SkillResponse
|
|
37
|
+
*/
|
|
38
|
+
pathPartId: string;
|
|
39
|
+
/**
|
|
40
|
+
* FOLDER path_part of the containing folder
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof SkillResponse
|
|
43
|
+
*/
|
|
44
|
+
parentPathPartId: string | null;
|
|
45
|
+
/**
|
|
46
|
+
* Full materialized path from root
|
|
47
|
+
* @type {string}
|
|
48
|
+
* @memberof SkillResponse
|
|
49
|
+
*/
|
|
50
|
+
materializedPath: string;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof SkillResponse
|
|
55
|
+
*/
|
|
56
|
+
tenantId: string;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {string}
|
|
60
|
+
* @memberof SkillResponse
|
|
61
|
+
*/
|
|
62
|
+
name: string;
|
|
63
|
+
/**
|
|
64
|
+
* One-line 'use when…' routing signal, from the SKILL.md frontmatter.
|
|
65
|
+
* @type {string}
|
|
66
|
+
* @memberof SkillResponse
|
|
67
|
+
*/
|
|
68
|
+
description: string;
|
|
69
|
+
/**
|
|
70
|
+
* Full SKILL.md content; populated on detail reads, null on list.
|
|
71
|
+
* @type {string}
|
|
72
|
+
* @memberof SkillResponse
|
|
73
|
+
*/
|
|
74
|
+
skillMd?: string | null;
|
|
75
|
+
/**
|
|
76
|
+
* Bundled script file names; populated on detail reads.
|
|
77
|
+
* @type {Array<string>}
|
|
78
|
+
* @memberof SkillResponse
|
|
79
|
+
*/
|
|
80
|
+
scriptNames?: Array<string>;
|
|
81
|
+
/**
|
|
82
|
+
* Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.
|
|
83
|
+
* @type {boolean}
|
|
84
|
+
* @memberof SkillResponse
|
|
85
|
+
*/
|
|
86
|
+
hasUnpublishedChanges?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
*
|
|
89
|
+
* @type {PathPartApprovalState}
|
|
90
|
+
* @memberof SkillResponse
|
|
91
|
+
*/
|
|
92
|
+
approvalState: PathPartApprovalState;
|
|
93
|
+
/**
|
|
94
|
+
* Creator, or null.
|
|
95
|
+
* @type {UserInfo}
|
|
96
|
+
* @memberof SkillResponse
|
|
97
|
+
*/
|
|
98
|
+
owner?: UserInfo | null;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @type {Date}
|
|
102
|
+
* @memberof SkillResponse
|
|
103
|
+
*/
|
|
104
|
+
createdAt: Date;
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @type {Date}
|
|
108
|
+
* @memberof SkillResponse
|
|
109
|
+
*/
|
|
110
|
+
updatedAt: Date;
|
|
111
|
+
/**
|
|
112
|
+
* Caller's effective rights; null on mutation responses.
|
|
113
|
+
* @type {ItemPermissions}
|
|
114
|
+
* @memberof SkillResponse
|
|
115
|
+
*/
|
|
116
|
+
permissions?: ItemPermissions | null;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* @export
|
|
120
|
+
*/
|
|
121
|
+
export declare const SkillResponsePartTypeEnum: {
|
|
122
|
+
readonly Skill: "SKILL";
|
|
123
|
+
};
|
|
124
|
+
export type SkillResponsePartTypeEnum = typeof SkillResponsePartTypeEnum[keyof typeof SkillResponsePartTypeEnum];
|
|
125
|
+
export declare const SkillResponsePropertyValidationAttributesMap: {
|
|
126
|
+
[property: string]: {
|
|
127
|
+
maxLength?: number;
|
|
128
|
+
minLength?: number;
|
|
129
|
+
pattern?: string;
|
|
130
|
+
maximum?: number;
|
|
131
|
+
exclusiveMaximum?: boolean;
|
|
132
|
+
minimum?: number;
|
|
133
|
+
exclusiveMinimum?: boolean;
|
|
134
|
+
multipleOf?: number;
|
|
135
|
+
maxItems?: number;
|
|
136
|
+
minItems?: number;
|
|
137
|
+
uniqueItems?: boolean;
|
|
138
|
+
};
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* Check if a given object implements the SkillResponse interface.
|
|
142
|
+
*/
|
|
143
|
+
export declare function instanceOfSkillResponse(value: object): value is SkillResponse;
|
|
144
|
+
export declare function SkillResponseFromJSON(json: any): SkillResponse;
|
|
145
|
+
export declare function SkillResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillResponse;
|
|
146
|
+
export declare function SkillResponseToJSON(json: any): SkillResponse;
|
|
147
|
+
export declare function SkillResponseToJSONTyped(value?: SkillResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,109 @@
|
|
|
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.SkillResponsePropertyValidationAttributesMap = exports.SkillResponsePartTypeEnum = void 0;
|
|
17
|
+
exports.instanceOfSkillResponse = instanceOfSkillResponse;
|
|
18
|
+
exports.SkillResponseFromJSON = SkillResponseFromJSON;
|
|
19
|
+
exports.SkillResponseFromJSONTyped = SkillResponseFromJSONTyped;
|
|
20
|
+
exports.SkillResponseToJSON = SkillResponseToJSON;
|
|
21
|
+
exports.SkillResponseToJSONTyped = SkillResponseToJSONTyped;
|
|
22
|
+
const ItemPermissions_1 = require("./ItemPermissions");
|
|
23
|
+
const PathPartApprovalState_1 = require("./PathPartApprovalState");
|
|
24
|
+
const UserInfo_1 = require("./UserInfo");
|
|
25
|
+
/**
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
exports.SkillResponsePartTypeEnum = {
|
|
29
|
+
Skill: 'SKILL'
|
|
30
|
+
};
|
|
31
|
+
exports.SkillResponsePropertyValidationAttributesMap = {};
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the SkillResponse interface.
|
|
34
|
+
*/
|
|
35
|
+
function instanceOfSkillResponse(value) {
|
|
36
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('pathPartId' in value) || value['pathPartId'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('materializedPath' in value) || value['materializedPath'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('tenantId' in value) || value['tenantId'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
if (!('description' in value) || value['description'] === undefined)
|
|
49
|
+
return false;
|
|
50
|
+
if (!('approvalState' in value) || value['approvalState'] === undefined)
|
|
51
|
+
return false;
|
|
52
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
53
|
+
return false;
|
|
54
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined)
|
|
55
|
+
return false;
|
|
56
|
+
return true;
|
|
57
|
+
}
|
|
58
|
+
function SkillResponseFromJSON(json) {
|
|
59
|
+
return SkillResponseFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
function SkillResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
62
|
+
if (json == null) {
|
|
63
|
+
return json;
|
|
64
|
+
}
|
|
65
|
+
return {
|
|
66
|
+
'partType': json['part_type'] == null ? undefined : json['part_type'],
|
|
67
|
+
'id': json['id'],
|
|
68
|
+
'pathPartId': json['path_part_id'],
|
|
69
|
+
'parentPathPartId': json['parent_path_part_id'],
|
|
70
|
+
'materializedPath': json['materialized_path'],
|
|
71
|
+
'tenantId': json['tenant_id'],
|
|
72
|
+
'name': json['name'],
|
|
73
|
+
'description': json['description'],
|
|
74
|
+
'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
|
|
75
|
+
'scriptNames': json['script_names'] == null ? undefined : json['script_names'],
|
|
76
|
+
'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
|
|
77
|
+
'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
|
|
78
|
+
'owner': json['owner'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['owner']),
|
|
79
|
+
'createdAt': (new Date(json['created_at'])),
|
|
80
|
+
'updatedAt': (new Date(json['updated_at'])),
|
|
81
|
+
'permissions': json['permissions'] == null ? undefined : (0, ItemPermissions_1.ItemPermissionsFromJSON)(json['permissions']),
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
function SkillResponseToJSON(json) {
|
|
85
|
+
return SkillResponseToJSONTyped(json, false);
|
|
86
|
+
}
|
|
87
|
+
function SkillResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
88
|
+
if (value == null) {
|
|
89
|
+
return value;
|
|
90
|
+
}
|
|
91
|
+
return {
|
|
92
|
+
'part_type': value['partType'],
|
|
93
|
+
'id': value['id'],
|
|
94
|
+
'path_part_id': value['pathPartId'],
|
|
95
|
+
'parent_path_part_id': value['parentPathPartId'],
|
|
96
|
+
'materialized_path': value['materializedPath'],
|
|
97
|
+
'tenant_id': value['tenantId'],
|
|
98
|
+
'name': value['name'],
|
|
99
|
+
'description': value['description'],
|
|
100
|
+
'skill_md': value['skillMd'],
|
|
101
|
+
'script_names': value['scriptNames'],
|
|
102
|
+
'has_unpublished_changes': value['hasUnpublishedChanges'],
|
|
103
|
+
'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
|
|
104
|
+
'owner': (0, UserInfo_1.UserInfoToJSON)(value['owner']),
|
|
105
|
+
'created_at': value['createdAt'].toISOString(),
|
|
106
|
+
'updated_at': value['updatedAt'].toISOString(),
|
|
107
|
+
'permissions': (0, ItemPermissions_1.ItemPermissionsToJSON)(value['permissions']),
|
|
108
|
+
};
|
|
109
|
+
}
|
|
@@ -0,0 +1,53 @@
|
|
|
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
|
+
* A single script bundled under a skill's ``scripts/`` folder.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SkillScriptFile
|
|
16
|
+
*/
|
|
17
|
+
export interface SkillScriptFile {
|
|
18
|
+
/**
|
|
19
|
+
* Script file name, e.g. inspect.py
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SkillScriptFile
|
|
22
|
+
*/
|
|
23
|
+
name: string;
|
|
24
|
+
/**
|
|
25
|
+
* Script file contents (UTF-8 text).
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SkillScriptFile
|
|
28
|
+
*/
|
|
29
|
+
content: string;
|
|
30
|
+
}
|
|
31
|
+
export declare const SkillScriptFilePropertyValidationAttributesMap: {
|
|
32
|
+
[property: string]: {
|
|
33
|
+
maxLength?: number;
|
|
34
|
+
minLength?: number;
|
|
35
|
+
pattern?: string;
|
|
36
|
+
maximum?: number;
|
|
37
|
+
exclusiveMaximum?: boolean;
|
|
38
|
+
minimum?: number;
|
|
39
|
+
exclusiveMinimum?: boolean;
|
|
40
|
+
multipleOf?: number;
|
|
41
|
+
maxItems?: number;
|
|
42
|
+
minItems?: number;
|
|
43
|
+
uniqueItems?: boolean;
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* Check if a given object implements the SkillScriptFile interface.
|
|
48
|
+
*/
|
|
49
|
+
export declare function instanceOfSkillScriptFile(value: object): value is SkillScriptFile;
|
|
50
|
+
export declare function SkillScriptFileFromJSON(json: any): SkillScriptFile;
|
|
51
|
+
export declare function SkillScriptFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillScriptFile;
|
|
52
|
+
export declare function SkillScriptFileToJSON(json: any): SkillScriptFile;
|
|
53
|
+
export declare function SkillScriptFileToJSONTyped(value?: SkillScriptFile | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,60 @@
|
|
|
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.SkillScriptFilePropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfSkillScriptFile = instanceOfSkillScriptFile;
|
|
18
|
+
exports.SkillScriptFileFromJSON = SkillScriptFileFromJSON;
|
|
19
|
+
exports.SkillScriptFileFromJSONTyped = SkillScriptFileFromJSONTyped;
|
|
20
|
+
exports.SkillScriptFileToJSON = SkillScriptFileToJSON;
|
|
21
|
+
exports.SkillScriptFileToJSONTyped = SkillScriptFileToJSONTyped;
|
|
22
|
+
exports.SkillScriptFilePropertyValidationAttributesMap = {
|
|
23
|
+
name: {
|
|
24
|
+
maxLength: 255,
|
|
25
|
+
},
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Check if a given object implements the SkillScriptFile interface.
|
|
29
|
+
*/
|
|
30
|
+
function instanceOfSkillScriptFile(value) {
|
|
31
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('content' in value) || value['content'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function SkillScriptFileFromJSON(json) {
|
|
38
|
+
return SkillScriptFileFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function SkillScriptFileFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'name': json['name'],
|
|
46
|
+
'content': json['content'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
function SkillScriptFileToJSON(json) {
|
|
50
|
+
return SkillScriptFileToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
function SkillScriptFileToJSONTyped(value, ignoreDiscriminator = false) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'name': value['name'],
|
|
58
|
+
'content': value['content'],
|
|
59
|
+
};
|
|
60
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
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
|
+
* One skill matched by semantic search.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SkillSearchResult
|
|
16
|
+
*/
|
|
17
|
+
export interface SkillSearchResult {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SkillSearchResult
|
|
22
|
+
*/
|
|
23
|
+
skillId: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SkillSearchResult
|
|
28
|
+
*/
|
|
29
|
+
name: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SkillSearchResult
|
|
34
|
+
*/
|
|
35
|
+
description: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof SkillSearchResult
|
|
40
|
+
*/
|
|
41
|
+
materializedPath: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof SkillSearchResult
|
|
46
|
+
*/
|
|
47
|
+
score: number;
|
|
48
|
+
}
|
|
49
|
+
export declare const SkillSearchResultPropertyValidationAttributesMap: {
|
|
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
|
+
* Check if a given object implements the SkillSearchResult interface.
|
|
66
|
+
*/
|
|
67
|
+
export declare function instanceOfSkillSearchResult(value: object): value is SkillSearchResult;
|
|
68
|
+
export declare function SkillSearchResultFromJSON(json: any): SkillSearchResult;
|
|
69
|
+
export declare function SkillSearchResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillSearchResult;
|
|
70
|
+
export declare function SkillSearchResultToJSON(json: any): SkillSearchResult;
|
|
71
|
+
export declare function SkillSearchResultToJSONTyped(value?: SkillSearchResult | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,68 @@
|
|
|
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.SkillSearchResultPropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfSkillSearchResult = instanceOfSkillSearchResult;
|
|
18
|
+
exports.SkillSearchResultFromJSON = SkillSearchResultFromJSON;
|
|
19
|
+
exports.SkillSearchResultFromJSONTyped = SkillSearchResultFromJSONTyped;
|
|
20
|
+
exports.SkillSearchResultToJSON = SkillSearchResultToJSON;
|
|
21
|
+
exports.SkillSearchResultToJSONTyped = SkillSearchResultToJSONTyped;
|
|
22
|
+
exports.SkillSearchResultPropertyValidationAttributesMap = {};
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the SkillSearchResult interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfSkillSearchResult(value) {
|
|
27
|
+
if (!('skillId' in value) || value['skillId'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('description' in value) || value['description'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('materializedPath' in value) || value['materializedPath'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('score' in value) || value['score'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
return true;
|
|
38
|
+
}
|
|
39
|
+
function SkillSearchResultFromJSON(json) {
|
|
40
|
+
return SkillSearchResultFromJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
function SkillSearchResultFromJSONTyped(json, ignoreDiscriminator) {
|
|
43
|
+
if (json == null) {
|
|
44
|
+
return json;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'skillId': json['skill_id'],
|
|
48
|
+
'name': json['name'],
|
|
49
|
+
'description': json['description'],
|
|
50
|
+
'materializedPath': json['materialized_path'],
|
|
51
|
+
'score': json['score'],
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
function SkillSearchResultToJSON(json) {
|
|
55
|
+
return SkillSearchResultToJSONTyped(json, false);
|
|
56
|
+
}
|
|
57
|
+
function SkillSearchResultToJSONTyped(value, ignoreDiscriminator = false) {
|
|
58
|
+
if (value == null) {
|
|
59
|
+
return value;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
'skill_id': value['skillId'],
|
|
63
|
+
'name': value['name'],
|
|
64
|
+
'description': value['description'],
|
|
65
|
+
'materialized_path': value['materializedPath'],
|
|
66
|
+
'score': value['score'],
|
|
67
|
+
};
|
|
68
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
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
|
+
* One published version of a skill.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SkillVersionResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface SkillVersionResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SkillVersionResponse
|
|
22
|
+
*/
|
|
23
|
+
versionId: string;
|
|
24
|
+
/**
|
|
25
|
+
* Monotonic version number (0, 1, 2, …)
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof SkillVersionResponse
|
|
28
|
+
*/
|
|
29
|
+
version: number;
|
|
30
|
+
/**
|
|
31
|
+
* Content hash of the version bundle.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SkillVersionResponse
|
|
34
|
+
*/
|
|
35
|
+
contentSha256?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {boolean}
|
|
39
|
+
* @memberof SkillVersionResponse
|
|
40
|
+
*/
|
|
41
|
+
isActive: boolean;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {Date}
|
|
45
|
+
* @memberof SkillVersionResponse
|
|
46
|
+
*/
|
|
47
|
+
createdAt: Date;
|
|
48
|
+
}
|
|
49
|
+
export declare const SkillVersionResponsePropertyValidationAttributesMap: {
|
|
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
|
+
* Check if a given object implements the SkillVersionResponse interface.
|
|
66
|
+
*/
|
|
67
|
+
export declare function instanceOfSkillVersionResponse(value: object): value is SkillVersionResponse;
|
|
68
|
+
export declare function SkillVersionResponseFromJSON(json: any): SkillVersionResponse;
|
|
69
|
+
export declare function SkillVersionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillVersionResponse;
|
|
70
|
+
export declare function SkillVersionResponseToJSON(json: any): SkillVersionResponse;
|
|
71
|
+
export declare function SkillVersionResponseToJSONTyped(value?: SkillVersionResponse | null, ignoreDiscriminator?: boolean): any;
|