@knowledge-stack/ksapi 1.139.1 → 1.140.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +28 -0
- package/README.md +25 -11
- package/dist/apis/AdminKbApi.d.ts +109 -0
- package/dist/apis/AdminKbApi.js +172 -0
- package/dist/apis/AdminWorkflowsApi.d.ts +252 -0
- package/dist/apis/AdminWorkflowsApi.js +337 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/esm/apis/AdminKbApi.d.ts +109 -0
- package/dist/esm/apis/AdminKbApi.js +135 -0
- package/dist/esm/apis/AdminWorkflowsApi.d.ts +252 -0
- package/dist/esm/apis/AdminWorkflowsApi.js +300 -0
- package/dist/esm/apis/index.d.ts +2 -0
- package/dist/esm/apis/index.js +2 -0
- package/dist/esm/models/CitedChunk.d.ts +6 -4
- package/dist/esm/models/DefinitionOutputStat.d.ts +65 -0
- package/dist/esm/models/DefinitionOutputStat.js +56 -0
- package/dist/esm/models/HourHistogramResponse.d.ts +53 -0
- package/dist/esm/models/HourHistogramResponse.js +54 -0
- package/dist/esm/models/KbMetric.d.ts +26 -0
- package/dist/esm/models/KbMetric.js +44 -0
- package/dist/esm/models/KbSummaryResponse.d.ts +152 -0
- package/dist/esm/models/KbSummaryResponse.js +109 -0
- package/dist/esm/models/KbTimeseriesResponse.d.ts +71 -0
- package/dist/esm/models/KbTimeseriesResponse.js +57 -0
- package/dist/esm/models/LabeledSeries.d.ts +54 -0
- package/dist/esm/models/LabeledSeries.js +47 -0
- package/dist/esm/models/LeaderboardEntry.d.ts +59 -0
- package/dist/esm/models/LeaderboardEntry.js +52 -0
- package/dist/esm/models/RunTimeseriesResponse.d.ts +61 -0
- package/dist/esm/models/RunTimeseriesResponse.js +52 -0
- package/dist/esm/models/TimeBucket.d.ts +27 -0
- package/dist/esm/models/TimeBucket.js +45 -0
- package/dist/esm/models/TimeseriesPoint.d.ts +53 -0
- package/dist/esm/models/TimeseriesPoint.js +48 -0
- package/dist/esm/models/WorkflowLeaderboardResponse.d.ts +54 -0
- package/dist/esm/models/WorkflowLeaderboardResponse.js +45 -0
- package/dist/esm/models/WorkflowOutputStatsResponse.d.ts +54 -0
- package/dist/esm/models/WorkflowOutputStatsResponse.js +47 -0
- package/dist/esm/models/index.d.ts +12 -0
- package/dist/esm/models/index.js +12 -0
- package/dist/models/CitedChunk.d.ts +6 -4
- package/dist/models/DefinitionOutputStat.d.ts +65 -0
- package/dist/models/DefinitionOutputStat.js +64 -0
- package/dist/models/HourHistogramResponse.d.ts +53 -0
- package/dist/models/HourHistogramResponse.js +62 -0
- package/dist/models/KbMetric.d.ts +26 -0
- package/dist/models/KbMetric.js +52 -0
- package/dist/models/KbSummaryResponse.d.ts +152 -0
- package/dist/models/KbSummaryResponse.js +117 -0
- package/dist/models/KbTimeseriesResponse.d.ts +71 -0
- package/dist/models/KbTimeseriesResponse.js +65 -0
- package/dist/models/LabeledSeries.d.ts +54 -0
- package/dist/models/LabeledSeries.js +55 -0
- package/dist/models/LeaderboardEntry.d.ts +59 -0
- package/dist/models/LeaderboardEntry.js +60 -0
- package/dist/models/RunTimeseriesResponse.d.ts +61 -0
- package/dist/models/RunTimeseriesResponse.js +60 -0
- package/dist/models/TimeBucket.d.ts +27 -0
- package/dist/models/TimeBucket.js +53 -0
- package/dist/models/TimeseriesPoint.d.ts +53 -0
- package/dist/models/TimeseriesPoint.js +56 -0
- package/dist/models/WorkflowLeaderboardResponse.d.ts +54 -0
- package/dist/models/WorkflowLeaderboardResponse.js +53 -0
- package/dist/models/WorkflowOutputStatsResponse.d.ts +54 -0
- package/dist/models/WorkflowOutputStatsResponse.js +55 -0
- package/dist/models/index.d.ts +12 -0
- package/dist/models/index.js +12 -0
- package/docs/AdminKbApi.md +163 -0
- package/docs/AdminWorkflowsApi.md +424 -0
- package/docs/CitedChunk.md +1 -1
- package/docs/DefinitionOutputStat.md +41 -0
- package/docs/HourHistogramResponse.md +37 -0
- package/docs/KbMetric.md +33 -0
- package/docs/KbSummaryResponse.md +67 -0
- package/docs/KbTimeseriesResponse.md +41 -0
- package/docs/LabeledSeries.md +37 -0
- package/docs/LeaderboardEntry.md +39 -0
- package/docs/RunTimeseriesResponse.md +39 -0
- package/docs/TimeBucket.md +33 -0
- package/docs/TimeseriesPoint.md +37 -0
- package/docs/WorkflowLeaderboardResponse.md +37 -0
- package/docs/WorkflowOutputStatsResponse.md +37 -0
- package/package.json +1 -1
- package/src/apis/AdminKbApi.ts +237 -0
- package/src/apis/AdminWorkflowsApi.ts +539 -0
- package/src/apis/index.ts +2 -0
- package/src/models/CitedChunk.ts +6 -4
- package/src/models/DefinitionOutputStat.ts +110 -0
- package/src/models/HourHistogramResponse.ts +97 -0
- package/src/models/KbMetric.ts +54 -0
- package/src/models/KbSummaryResponse.ts +235 -0
- package/src/models/KbTimeseriesResponse.ts +136 -0
- package/src/models/LabeledSeries.ts +99 -0
- package/src/models/LeaderboardEntry.ts +101 -0
- package/src/models/RunTimeseriesResponse.ts +117 -0
- package/src/models/TimeBucket.ts +55 -0
- package/src/models/TimeseriesPoint.ts +92 -0
- package/src/models/WorkflowLeaderboardResponse.ts +98 -0
- package/src/models/WorkflowOutputStatsResponse.ts +99 -0
- package/src/models/index.ts +12 -0
|
@@ -0,0 +1,61 @@
|
|
|
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 { TimeseriesPoint } from './TimeseriesPoint';
|
|
13
|
+
import type { TimeBucket } from './TimeBucket';
|
|
14
|
+
/**
|
|
15
|
+
* Workflow runs bucketed over time.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface RunTimeseriesResponse
|
|
18
|
+
*/
|
|
19
|
+
export interface RunTimeseriesResponse {
|
|
20
|
+
/**
|
|
21
|
+
* IANA timezone the buckets are in.
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof RunTimeseriesResponse
|
|
24
|
+
*/
|
|
25
|
+
timezone: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {TimeBucket}
|
|
29
|
+
* @memberof RunTimeseriesResponse
|
|
30
|
+
*/
|
|
31
|
+
bucket: TimeBucket;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Array<TimeseriesPoint>}
|
|
35
|
+
* @memberof RunTimeseriesResponse
|
|
36
|
+
*/
|
|
37
|
+
points?: Array<TimeseriesPoint>;
|
|
38
|
+
}
|
|
39
|
+
export declare const RunTimeseriesResponsePropertyValidationAttributesMap: {
|
|
40
|
+
[property: string]: {
|
|
41
|
+
maxLength?: number;
|
|
42
|
+
minLength?: number;
|
|
43
|
+
pattern?: string;
|
|
44
|
+
maximum?: number;
|
|
45
|
+
exclusiveMaximum?: boolean;
|
|
46
|
+
minimum?: number;
|
|
47
|
+
exclusiveMinimum?: boolean;
|
|
48
|
+
multipleOf?: number;
|
|
49
|
+
maxItems?: number;
|
|
50
|
+
minItems?: number;
|
|
51
|
+
uniqueItems?: boolean;
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* Check if a given object implements the RunTimeseriesResponse interface.
|
|
56
|
+
*/
|
|
57
|
+
export declare function instanceOfRunTimeseriesResponse(value: object): value is RunTimeseriesResponse;
|
|
58
|
+
export declare function RunTimeseriesResponseFromJSON(json: any): RunTimeseriesResponse;
|
|
59
|
+
export declare function RunTimeseriesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunTimeseriesResponse;
|
|
60
|
+
export declare function RunTimeseriesResponseToJSON(json: any): RunTimeseriesResponse;
|
|
61
|
+
export declare function RunTimeseriesResponseToJSONTyped(value?: RunTimeseriesResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { TimeseriesPointFromJSON, TimeseriesPointToJSON, } from './TimeseriesPoint';
|
|
15
|
+
import { TimeBucketFromJSON, TimeBucketToJSON, } from './TimeBucket';
|
|
16
|
+
export const RunTimeseriesResponsePropertyValidationAttributesMap = {};
|
|
17
|
+
/**
|
|
18
|
+
* Check if a given object implements the RunTimeseriesResponse interface.
|
|
19
|
+
*/
|
|
20
|
+
export function instanceOfRunTimeseriesResponse(value) {
|
|
21
|
+
if (!('timezone' in value) || value['timezone'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('bucket' in value) || value['bucket'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
export function RunTimeseriesResponseFromJSON(json) {
|
|
28
|
+
return RunTimeseriesResponseFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
export function RunTimeseriesResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'timezone': json['timezone'],
|
|
36
|
+
'bucket': TimeBucketFromJSON(json['bucket']),
|
|
37
|
+
'points': json['points'] == null ? undefined : (json['points'].map(TimeseriesPointFromJSON)),
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
export function RunTimeseriesResponseToJSON(json) {
|
|
41
|
+
return RunTimeseriesResponseToJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
export function RunTimeseriesResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
44
|
+
if (value == null) {
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'timezone': value['timezone'],
|
|
49
|
+
'bucket': TimeBucketToJSON(value['bucket']),
|
|
50
|
+
'points': value['points'] == null ? undefined : (value['points'].map(TimeseriesPointToJSON)),
|
|
51
|
+
};
|
|
52
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
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
|
+
* Granularity for a bucketed time series.
|
|
14
|
+
* @export
|
|
15
|
+
*/
|
|
16
|
+
export declare const TimeBucket: {
|
|
17
|
+
readonly Hour: 'hour';
|
|
18
|
+
readonly Day: 'day';
|
|
19
|
+
readonly Week: 'week';
|
|
20
|
+
readonly Month: 'month';
|
|
21
|
+
};
|
|
22
|
+
export type TimeBucket = typeof TimeBucket[keyof typeof TimeBucket];
|
|
23
|
+
export declare function instanceOfTimeBucket(value: any): boolean;
|
|
24
|
+
export declare function TimeBucketFromJSON(json: any): TimeBucket;
|
|
25
|
+
export declare function TimeBucketFromJSONTyped(json: any, ignoreDiscriminator: boolean): TimeBucket;
|
|
26
|
+
export declare function TimeBucketToJSON(value?: TimeBucket | null): any;
|
|
27
|
+
export declare function TimeBucketToJSONTyped(value: any, ignoreDiscriminator: boolean): TimeBucket;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Granularity for a bucketed time series.
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const TimeBucket = {
|
|
19
|
+
Hour: 'hour',
|
|
20
|
+
Day: 'day',
|
|
21
|
+
Week: 'week',
|
|
22
|
+
Month: 'month'
|
|
23
|
+
};
|
|
24
|
+
export function instanceOfTimeBucket(value) {
|
|
25
|
+
for (const key in TimeBucket) {
|
|
26
|
+
if (Object.prototype.hasOwnProperty.call(TimeBucket, key)) {
|
|
27
|
+
if (TimeBucket[key] === value) {
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
return false;
|
|
33
|
+
}
|
|
34
|
+
export function TimeBucketFromJSON(json) {
|
|
35
|
+
return TimeBucketFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function TimeBucketFromJSONTyped(json, ignoreDiscriminator) {
|
|
38
|
+
return json;
|
|
39
|
+
}
|
|
40
|
+
export function TimeBucketToJSON(value) {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
export function TimeBucketToJSONTyped(value, ignoreDiscriminator) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
@@ -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
|
+
* One bucket of a time series.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface TimeseriesPoint
|
|
16
|
+
*/
|
|
17
|
+
export interface TimeseriesPoint {
|
|
18
|
+
/**
|
|
19
|
+
* Start of the bucket, in the resolved timezone.
|
|
20
|
+
* @type {Date}
|
|
21
|
+
* @memberof TimeseriesPoint
|
|
22
|
+
*/
|
|
23
|
+
bucketStart: Date;
|
|
24
|
+
/**
|
|
25
|
+
* Row count in this bucket.
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof TimeseriesPoint
|
|
28
|
+
*/
|
|
29
|
+
count: number;
|
|
30
|
+
}
|
|
31
|
+
export declare const TimeseriesPointPropertyValidationAttributesMap: {
|
|
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 TimeseriesPoint interface.
|
|
48
|
+
*/
|
|
49
|
+
export declare function instanceOfTimeseriesPoint(value: object): value is TimeseriesPoint;
|
|
50
|
+
export declare function TimeseriesPointFromJSON(json: any): TimeseriesPoint;
|
|
51
|
+
export declare function TimeseriesPointFromJSONTyped(json: any, ignoreDiscriminator: boolean): TimeseriesPoint;
|
|
52
|
+
export declare function TimeseriesPointToJSON(json: any): TimeseriesPoint;
|
|
53
|
+
export declare function TimeseriesPointToJSONTyped(value?: TimeseriesPoint | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export const TimeseriesPointPropertyValidationAttributesMap = {};
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the TimeseriesPoint interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfTimeseriesPoint(value) {
|
|
19
|
+
if (!('bucketStart' in value) || value['bucketStart'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('count' in value) || value['count'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
export function TimeseriesPointFromJSON(json) {
|
|
26
|
+
return TimeseriesPointFromJSONTyped(json, false);
|
|
27
|
+
}
|
|
28
|
+
export function TimeseriesPointFromJSONTyped(json, ignoreDiscriminator) {
|
|
29
|
+
if (json == null) {
|
|
30
|
+
return json;
|
|
31
|
+
}
|
|
32
|
+
return {
|
|
33
|
+
'bucketStart': (new Date(json['bucket_start'])),
|
|
34
|
+
'count': json['count'],
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
export function TimeseriesPointToJSON(json) {
|
|
38
|
+
return TimeseriesPointToJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
export function TimeseriesPointToJSONTyped(value, ignoreDiscriminator = false) {
|
|
41
|
+
if (value == null) {
|
|
42
|
+
return value;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'bucket_start': value['bucketStart'].toISOString(),
|
|
46
|
+
'count': value['count'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
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 { LeaderboardEntry } from './LeaderboardEntry';
|
|
13
|
+
/**
|
|
14
|
+
* Top workflows and top users by run count over a window.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface WorkflowLeaderboardResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface WorkflowLeaderboardResponse {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {Array<LeaderboardEntry>}
|
|
22
|
+
* @memberof WorkflowLeaderboardResponse
|
|
23
|
+
*/
|
|
24
|
+
topWorkflows?: Array<LeaderboardEntry>;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {Array<LeaderboardEntry>}
|
|
28
|
+
* @memberof WorkflowLeaderboardResponse
|
|
29
|
+
*/
|
|
30
|
+
topUsers?: Array<LeaderboardEntry>;
|
|
31
|
+
}
|
|
32
|
+
export declare const WorkflowLeaderboardResponsePropertyValidationAttributesMap: {
|
|
33
|
+
[property: string]: {
|
|
34
|
+
maxLength?: number;
|
|
35
|
+
minLength?: number;
|
|
36
|
+
pattern?: string;
|
|
37
|
+
maximum?: number;
|
|
38
|
+
exclusiveMaximum?: boolean;
|
|
39
|
+
minimum?: number;
|
|
40
|
+
exclusiveMinimum?: boolean;
|
|
41
|
+
multipleOf?: number;
|
|
42
|
+
maxItems?: number;
|
|
43
|
+
minItems?: number;
|
|
44
|
+
uniqueItems?: boolean;
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Check if a given object implements the WorkflowLeaderboardResponse interface.
|
|
49
|
+
*/
|
|
50
|
+
export declare function instanceOfWorkflowLeaderboardResponse(value: object): value is WorkflowLeaderboardResponse;
|
|
51
|
+
export declare function WorkflowLeaderboardResponseFromJSON(json: any): WorkflowLeaderboardResponse;
|
|
52
|
+
export declare function WorkflowLeaderboardResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowLeaderboardResponse;
|
|
53
|
+
export declare function WorkflowLeaderboardResponseToJSON(json: any): WorkflowLeaderboardResponse;
|
|
54
|
+
export declare function WorkflowLeaderboardResponseToJSONTyped(value?: WorkflowLeaderboardResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { LeaderboardEntryFromJSON, LeaderboardEntryToJSON, } from './LeaderboardEntry';
|
|
15
|
+
export const WorkflowLeaderboardResponsePropertyValidationAttributesMap = {};
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the WorkflowLeaderboardResponse interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfWorkflowLeaderboardResponse(value) {
|
|
20
|
+
return true;
|
|
21
|
+
}
|
|
22
|
+
export function WorkflowLeaderboardResponseFromJSON(json) {
|
|
23
|
+
return WorkflowLeaderboardResponseFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
export function WorkflowLeaderboardResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
26
|
+
if (json == null) {
|
|
27
|
+
return json;
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
'topWorkflows': json['top_workflows'] == null ? undefined : (json['top_workflows'].map(LeaderboardEntryFromJSON)),
|
|
31
|
+
'topUsers': json['top_users'] == null ? undefined : (json['top_users'].map(LeaderboardEntryFromJSON)),
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
export function WorkflowLeaderboardResponseToJSON(json) {
|
|
35
|
+
return WorkflowLeaderboardResponseToJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function WorkflowLeaderboardResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
38
|
+
if (value == null) {
|
|
39
|
+
return value;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'top_workflows': value['topWorkflows'] == null ? undefined : (value['topWorkflows'].map(LeaderboardEntryToJSON)),
|
|
43
|
+
'top_users': value['topUsers'] == null ? undefined : (value['topUsers'].map(LeaderboardEntryToJSON)),
|
|
44
|
+
};
|
|
45
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
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 { DefinitionOutputStat } from './DefinitionOutputStat';
|
|
13
|
+
/**
|
|
14
|
+
* Avg documents generated per workflow definition (completed runs).
|
|
15
|
+
* @export
|
|
16
|
+
* @interface WorkflowOutputStatsResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface WorkflowOutputStatsResponse {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {Array<DefinitionOutputStat>}
|
|
22
|
+
* @memberof WorkflowOutputStatsResponse
|
|
23
|
+
*/
|
|
24
|
+
perDefinition?: Array<DefinitionOutputStat>;
|
|
25
|
+
/**
|
|
26
|
+
* Mean output DOCUMENTs across all completed runs; null when none.
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof WorkflowOutputStatsResponse
|
|
29
|
+
*/
|
|
30
|
+
overallAvg: number | null;
|
|
31
|
+
}
|
|
32
|
+
export declare const WorkflowOutputStatsResponsePropertyValidationAttributesMap: {
|
|
33
|
+
[property: string]: {
|
|
34
|
+
maxLength?: number;
|
|
35
|
+
minLength?: number;
|
|
36
|
+
pattern?: string;
|
|
37
|
+
maximum?: number;
|
|
38
|
+
exclusiveMaximum?: boolean;
|
|
39
|
+
minimum?: number;
|
|
40
|
+
exclusiveMinimum?: boolean;
|
|
41
|
+
multipleOf?: number;
|
|
42
|
+
maxItems?: number;
|
|
43
|
+
minItems?: number;
|
|
44
|
+
uniqueItems?: boolean;
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Check if a given object implements the WorkflowOutputStatsResponse interface.
|
|
49
|
+
*/
|
|
50
|
+
export declare function instanceOfWorkflowOutputStatsResponse(value: object): value is WorkflowOutputStatsResponse;
|
|
51
|
+
export declare function WorkflowOutputStatsResponseFromJSON(json: any): WorkflowOutputStatsResponse;
|
|
52
|
+
export declare function WorkflowOutputStatsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowOutputStatsResponse;
|
|
53
|
+
export declare function WorkflowOutputStatsResponseToJSON(json: any): WorkflowOutputStatsResponse;
|
|
54
|
+
export declare function WorkflowOutputStatsResponseToJSONTyped(value?: WorkflowOutputStatsResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { DefinitionOutputStatFromJSON, DefinitionOutputStatToJSON, } from './DefinitionOutputStat';
|
|
15
|
+
export const WorkflowOutputStatsResponsePropertyValidationAttributesMap = {};
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the WorkflowOutputStatsResponse interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfWorkflowOutputStatsResponse(value) {
|
|
20
|
+
if (!('overallAvg' in value) || value['overallAvg'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
return true;
|
|
23
|
+
}
|
|
24
|
+
export function WorkflowOutputStatsResponseFromJSON(json) {
|
|
25
|
+
return WorkflowOutputStatsResponseFromJSONTyped(json, false);
|
|
26
|
+
}
|
|
27
|
+
export function WorkflowOutputStatsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
28
|
+
if (json == null) {
|
|
29
|
+
return json;
|
|
30
|
+
}
|
|
31
|
+
return {
|
|
32
|
+
'perDefinition': json['per_definition'] == null ? undefined : (json['per_definition'].map(DefinitionOutputStatFromJSON)),
|
|
33
|
+
'overallAvg': json['overall_avg'],
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
export function WorkflowOutputStatsResponseToJSON(json) {
|
|
37
|
+
return WorkflowOutputStatsResponseToJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function WorkflowOutputStatsResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
|
+
if (value == null) {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'per_definition': value['perDefinition'] == null ? undefined : (value['perDefinition'].map(DefinitionOutputStatToJSON)),
|
|
45
|
+
'overall_avg': value['overallAvg'],
|
|
46
|
+
};
|
|
47
|
+
}
|
|
@@ -80,6 +80,7 @@ export * from './DataSourceSchemaListResponse';
|
|
|
80
80
|
export * from './DataSourceSchemaResponse';
|
|
81
81
|
export * from './DataSourceSyncResponse';
|
|
82
82
|
export * from './DataSourceTableResponse';
|
|
83
|
+
export * from './DefinitionOutputStat';
|
|
83
84
|
export * from './DiffFormat';
|
|
84
85
|
export * from './DiffRow';
|
|
85
86
|
export * from './DiffRowType';
|
|
@@ -131,6 +132,7 @@ export * from './GroupPermissionResponse';
|
|
|
131
132
|
export * from './GroupResponse';
|
|
132
133
|
export * from './HTTPValidationError';
|
|
133
134
|
export * from './HealthCheckResponse';
|
|
135
|
+
export * from './HourHistogramResponse';
|
|
134
136
|
export * from './HybridSearchProfile';
|
|
135
137
|
export * from './IdpConfig';
|
|
136
138
|
export * from './IdpType';
|
|
@@ -150,6 +152,11 @@ export * from './InviteResponse';
|
|
|
150
152
|
export * from './InviteStatus';
|
|
151
153
|
export * from './InviteUserRequest';
|
|
152
154
|
export * from './ItemPermissions';
|
|
155
|
+
export * from './KbMetric';
|
|
156
|
+
export * from './KbSummaryResponse';
|
|
157
|
+
export * from './KbTimeseriesResponse';
|
|
158
|
+
export * from './LabeledSeries';
|
|
159
|
+
export * from './LeaderboardEntry';
|
|
153
160
|
export * from './LineageEdgeResponse';
|
|
154
161
|
export * from './LineageGraphResponse';
|
|
155
162
|
export * from './LineageNodeResponse';
|
|
@@ -226,6 +233,7 @@ export * from './RevisionEdit';
|
|
|
226
233
|
export * from './RootResponse';
|
|
227
234
|
export * from './RunFolder';
|
|
228
235
|
export * from './RunFolderRef';
|
|
236
|
+
export * from './RunTimeseriesResponse';
|
|
229
237
|
export * from './SSOInitiateResponse';
|
|
230
238
|
export * from './ScoredChunkResponse';
|
|
231
239
|
export * from './SearchSkillsRequest';
|
|
@@ -289,6 +297,8 @@ export * from './ThreadMessageDetails';
|
|
|
289
297
|
export * from './ThreadMessageResponse';
|
|
290
298
|
export * from './ThreadOrder';
|
|
291
299
|
export * from './ThreadResponse';
|
|
300
|
+
export * from './TimeBucket';
|
|
301
|
+
export * from './TimeseriesPoint';
|
|
292
302
|
export * from './ToolDisplayType';
|
|
293
303
|
export * from './ToolPart';
|
|
294
304
|
export * from './ToolStatus';
|
|
@@ -332,6 +342,8 @@ export * from './WorkflowDefinitionOrder';
|
|
|
332
342
|
export * from './WorkflowDefinitionResponse';
|
|
333
343
|
export * from './WorkflowDetailResponse';
|
|
334
344
|
export * from './WorkflowExecutionState';
|
|
345
|
+
export * from './WorkflowLeaderboardResponse';
|
|
346
|
+
export * from './WorkflowOutputStatsResponse';
|
|
335
347
|
export * from './WorkflowRunAsset';
|
|
336
348
|
export * from './WorkflowRunCallbackRequest';
|
|
337
349
|
export * from './WorkflowRunOrder';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -82,6 +82,7 @@ export * from './DataSourceSchemaListResponse';
|
|
|
82
82
|
export * from './DataSourceSchemaResponse';
|
|
83
83
|
export * from './DataSourceSyncResponse';
|
|
84
84
|
export * from './DataSourceTableResponse';
|
|
85
|
+
export * from './DefinitionOutputStat';
|
|
85
86
|
export * from './DiffFormat';
|
|
86
87
|
export * from './DiffRow';
|
|
87
88
|
export * from './DiffRowType';
|
|
@@ -133,6 +134,7 @@ export * from './GroupPermissionResponse';
|
|
|
133
134
|
export * from './GroupResponse';
|
|
134
135
|
export * from './HTTPValidationError';
|
|
135
136
|
export * from './HealthCheckResponse';
|
|
137
|
+
export * from './HourHistogramResponse';
|
|
136
138
|
export * from './HybridSearchProfile';
|
|
137
139
|
export * from './IdpConfig';
|
|
138
140
|
export * from './IdpType';
|
|
@@ -152,6 +154,11 @@ export * from './InviteResponse';
|
|
|
152
154
|
export * from './InviteStatus';
|
|
153
155
|
export * from './InviteUserRequest';
|
|
154
156
|
export * from './ItemPermissions';
|
|
157
|
+
export * from './KbMetric';
|
|
158
|
+
export * from './KbSummaryResponse';
|
|
159
|
+
export * from './KbTimeseriesResponse';
|
|
160
|
+
export * from './LabeledSeries';
|
|
161
|
+
export * from './LeaderboardEntry';
|
|
155
162
|
export * from './LineageEdgeResponse';
|
|
156
163
|
export * from './LineageGraphResponse';
|
|
157
164
|
export * from './LineageNodeResponse';
|
|
@@ -228,6 +235,7 @@ export * from './RevisionEdit';
|
|
|
228
235
|
export * from './RootResponse';
|
|
229
236
|
export * from './RunFolder';
|
|
230
237
|
export * from './RunFolderRef';
|
|
238
|
+
export * from './RunTimeseriesResponse';
|
|
231
239
|
export * from './SSOInitiateResponse';
|
|
232
240
|
export * from './ScoredChunkResponse';
|
|
233
241
|
export * from './SearchSkillsRequest';
|
|
@@ -291,6 +299,8 @@ export * from './ThreadMessageDetails';
|
|
|
291
299
|
export * from './ThreadMessageResponse';
|
|
292
300
|
export * from './ThreadOrder';
|
|
293
301
|
export * from './ThreadResponse';
|
|
302
|
+
export * from './TimeBucket';
|
|
303
|
+
export * from './TimeseriesPoint';
|
|
294
304
|
export * from './ToolDisplayType';
|
|
295
305
|
export * from './ToolPart';
|
|
296
306
|
export * from './ToolStatus';
|
|
@@ -334,6 +344,8 @@ export * from './WorkflowDefinitionOrder';
|
|
|
334
344
|
export * from './WorkflowDefinitionResponse';
|
|
335
345
|
export * from './WorkflowDetailResponse';
|
|
336
346
|
export * from './WorkflowExecutionState';
|
|
347
|
+
export * from './WorkflowLeaderboardResponse';
|
|
348
|
+
export * from './WorkflowOutputStatsResponse';
|
|
337
349
|
export * from './WorkflowRunAsset';
|
|
338
350
|
export * from './WorkflowRunCallbackRequest';
|
|
339
351
|
export * from './WorkflowRunOrder';
|
|
@@ -16,10 +16,12 @@ import type { DocumentType } from './DocumentType';
|
|
|
16
16
|
* ``chunk_id`` is the load-bearing field — every reader can use it via
|
|
17
17
|
* ``/v1/chunks/bulk``. The document fields are populated by
|
|
18
18
|
* ``ks_upload_from_sandbox`` when it resolves each chunk through the KS API at
|
|
19
|
-
* save time; they stay ``None`` only when
|
|
20
|
-
* (
|
|
21
|
-
*
|
|
22
|
-
*
|
|
19
|
+
* save time; they stay ``None`` only when a *transient* resolve failure
|
|
20
|
+
* (network, 5xx) left the chunk unenriched. A chunk that no longer exists
|
|
21
|
+
* (a definitive 404) is dropped at save time rather than persisted with a
|
|
22
|
+
* bare id, so a dead citation never reaches the FE. The doc-info snapshot is
|
|
23
|
+
* captured at save time; later renames or replacements of the source document
|
|
24
|
+
* do not update it.
|
|
23
25
|
* @export
|
|
24
26
|
* @interface CitedChunk
|
|
25
27
|
*/
|