@knowledge-stack/ksapi 1.139.1 → 1.140.0

package/dist/models/DefinitionOutputStat.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Average output-document count for one workflow definition.
+ * @export
+ * @interface DefinitionOutputStat
+ */
+export interface DefinitionOutputStat {
+    /**
+     *
+     * @type {string}
+     * @memberof DefinitionOutputStat
+     */
+    definitionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DefinitionOutputStat
+     */
+    name: string;
+    /**
+     * COMPLETED runs in the window.
+     * @type {number}
+     * @memberof DefinitionOutputStat
+     */
+    completedRuns: number;
+    /**
+     * Mean output DOCUMENTs generated per completed run.
+     * @type {number}
+     * @memberof DefinitionOutputStat
+     */
+    avgDocuments: number;
+}
+export declare const DefinitionOutputStatPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the DefinitionOutputStat interface.
+ */
+export declare function instanceOfDefinitionOutputStat(value: object): value is DefinitionOutputStat;
+export declare function DefinitionOutputStatFromJSON(json: any): DefinitionOutputStat;
+export declare function DefinitionOutputStatFromJSONTyped(json: any, ignoreDiscriminator: boolean): DefinitionOutputStat;
+export declare function DefinitionOutputStatToJSON(json: any): DefinitionOutputStat;
+export declare function DefinitionOutputStatToJSONTyped(value?: DefinitionOutputStat | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DefinitionOutputStat.js

@@ -0,0 +1,64 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefinitionOutputStatPropertyValidationAttributesMap = void 0;
+exports.instanceOfDefinitionOutputStat = instanceOfDefinitionOutputStat;
+exports.DefinitionOutputStatFromJSON = DefinitionOutputStatFromJSON;
+exports.DefinitionOutputStatFromJSONTyped = DefinitionOutputStatFromJSONTyped;
+exports.DefinitionOutputStatToJSON = DefinitionOutputStatToJSON;
+exports.DefinitionOutputStatToJSONTyped = DefinitionOutputStatToJSONTyped;
+exports.DefinitionOutputStatPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DefinitionOutputStat interface.
+ */
+function instanceOfDefinitionOutputStat(value) {
+    if (!('definitionId' in value) || value['definitionId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('completedRuns' in value) || value['completedRuns'] === undefined)
+        return false;
+    if (!('avgDocuments' in value) || value['avgDocuments'] === undefined)
+        return false;
+    return true;
+}
+function DefinitionOutputStatFromJSON(json) {
+    return DefinitionOutputStatFromJSONTyped(json, false);
+}
+function DefinitionOutputStatFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'definitionId': json['definition_id'],
+        'name': json['name'],
+        'completedRuns': json['completed_runs'],
+        'avgDocuments': json['avg_documents'],
+    };
+}
+function DefinitionOutputStatToJSON(json) {
+    return DefinitionOutputStatToJSONTyped(json, false);
+}
+function DefinitionOutputStatToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'definition_id': value['definitionId'],
+        'name': value['name'],
+        'completed_runs': value['completedRuns'],
+        'avg_documents': value['avgDocuments'],
+    };
+}

package/dist/models/HourHistogramResponse.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Workflow runs by hour-of-day (0-23) in the resolved timezone.
+ * @export
+ * @interface HourHistogramResponse
+ */
+export interface HourHistogramResponse {
+    /**
+     * IANA timezone the hours are in.
+     * @type {string}
+     * @memberof HourHistogramResponse
+     */
+    timezone: string;
+    /**
+     * Exactly 24 entries; index i is the run count for hour i.
+     * @type {Array<number>}
+     * @memberof HourHistogramResponse
+     */
+    countsByHour: Array<number>;
+}
+export declare const HourHistogramResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the HourHistogramResponse interface.
+ */
+export declare function instanceOfHourHistogramResponse(value: object): value is HourHistogramResponse;
+export declare function HourHistogramResponseFromJSON(json: any): HourHistogramResponse;
+export declare function HourHistogramResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HourHistogramResponse;
+export declare function HourHistogramResponseToJSON(json: any): HourHistogramResponse;
+export declare function HourHistogramResponseToJSONTyped(value?: HourHistogramResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/HourHistogramResponse.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HourHistogramResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfHourHistogramResponse = instanceOfHourHistogramResponse;
+exports.HourHistogramResponseFromJSON = HourHistogramResponseFromJSON;
+exports.HourHistogramResponseFromJSONTyped = HourHistogramResponseFromJSONTyped;
+exports.HourHistogramResponseToJSON = HourHistogramResponseToJSON;
+exports.HourHistogramResponseToJSONTyped = HourHistogramResponseToJSONTyped;
+exports.HourHistogramResponsePropertyValidationAttributesMap = {
+    countsByHour: {
+        maxItems: 24,
+        minItems: 24,
+        uniqueItems: false,
+    },
+};
+/**
+ * Check if a given object implements the HourHistogramResponse interface.
+ */
+function instanceOfHourHistogramResponse(value) {
+    if (!('timezone' in value) || value['timezone'] === undefined)
+        return false;
+    if (!('countsByHour' in value) || value['countsByHour'] === undefined)
+        return false;
+    return true;
+}
+function HourHistogramResponseFromJSON(json) {
+    return HourHistogramResponseFromJSONTyped(json, false);
+}
+function HourHistogramResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'timezone': json['timezone'],
+        'countsByHour': json['counts_by_hour'],
+    };
+}
+function HourHistogramResponseToJSON(json) {
+    return HourHistogramResponseToJSONTyped(json, false);
+}
+function HourHistogramResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'timezone': value['timezone'],
+        'counts_by_hour': value['countsByHour'],
+    };
+}

package/dist/models/KbMetric.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A knowledge-base time series the dashboard can request.
+ * @export
+ */
+export declare const KbMetric: {
+    readonly DocumentUploads: 'document_uploads';
+    readonly IngestionCompleted: 'ingestion_completed';
+    readonly IngestionFailed: 'ingestion_failed';
+};
+export type KbMetric = typeof KbMetric[keyof typeof KbMetric];
+export declare function instanceOfKbMetric(value: any): boolean;
+export declare function KbMetricFromJSON(json: any): KbMetric;
+export declare function KbMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): KbMetric;
+export declare function KbMetricToJSON(value?: KbMetric | null): any;
+export declare function KbMetricToJSONTyped(value: any, ignoreDiscriminator: boolean): KbMetric;

package/dist/models/KbMetric.js

@@ -0,0 +1,52 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KbMetric = void 0;
+exports.instanceOfKbMetric = instanceOfKbMetric;
+exports.KbMetricFromJSON = KbMetricFromJSON;
+exports.KbMetricFromJSONTyped = KbMetricFromJSONTyped;
+exports.KbMetricToJSON = KbMetricToJSON;
+exports.KbMetricToJSONTyped = KbMetricToJSONTyped;
+/**
+ * A knowledge-base time series the dashboard can request.
+ * @export
+ */
+exports.KbMetric = {
+    DocumentUploads: 'document_uploads',
+    IngestionCompleted: 'ingestion_completed',
+    IngestionFailed: 'ingestion_failed'
+};
+function instanceOfKbMetric(value) {
+    for (const key in exports.KbMetric) {
+        if (Object.prototype.hasOwnProperty.call(exports.KbMetric, key)) {
+            if (exports.KbMetric[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function KbMetricFromJSON(json) {
+    return KbMetricFromJSONTyped(json, false);
+}
+function KbMetricFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function KbMetricToJSON(value) {
+    return value;
+}
+function KbMetricToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/KbSummaryResponse.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { MeteredQuotaStatus } from './MeteredQuotaStatus';
+/**
+ * Point-in-time knowledge-base totals for a tenant.
+ * @export
+ * @interface KbSummaryResponse
+ */
+export interface KbSummaryResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    documentsTotal: number;
+    /**
+     * Live document count keyed by document_origin.
+     * @type {{ [key: string]: number; }}
+     * @memberof KbSummaryResponse
+     */
+    documentsByOrigin: {
+        [key: string]: number;
+    };
+    /**
+     * Live document count keyed by document_type.
+     * @type {{ [key: string]: number; }}
+     * @memberof KbSummaryResponse
+     */
+    documentsByType: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    documentVersionsTotal: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    chunksTotal: number;
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof KbSummaryResponse
+     */
+    chunksByType: {
+        [key: string]: number;
+    };
+    /**
+     * Sum of chunk.num_tokens (cl100k).
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    tokensTotal: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    sectionsTotal: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    threadsTotal: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    messagesTotal: number;
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof KbSummaryResponse
+     */
+    messagesByRole: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    dataSourcesTotal: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    dataSourceTablesTotal: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    documentsCheckedOut: number;
+    /**
+     * Current-period usage vs limit per metered resource.
+     * @type {Array<MeteredQuotaStatus>}
+     * @memberof KbSummaryResponse
+     */
+    quota: Array<MeteredQuotaStatus>;
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    feedbackUp: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KbSummaryResponse
+     */
+    feedbackDown: number;
+}
+export declare const KbSummaryResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the KbSummaryResponse interface.
+ */
+export declare function instanceOfKbSummaryResponse(value: object): value is KbSummaryResponse;
+export declare function KbSummaryResponseFromJSON(json: any): KbSummaryResponse;
+export declare function KbSummaryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): KbSummaryResponse;
+export declare function KbSummaryResponseToJSON(json: any): KbSummaryResponse;
+export declare function KbSummaryResponseToJSONTyped(value?: KbSummaryResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/KbSummaryResponse.js

@@ -0,0 +1,117 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KbSummaryResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfKbSummaryResponse = instanceOfKbSummaryResponse;
+exports.KbSummaryResponseFromJSON = KbSummaryResponseFromJSON;
+exports.KbSummaryResponseFromJSONTyped = KbSummaryResponseFromJSONTyped;
+exports.KbSummaryResponseToJSON = KbSummaryResponseToJSON;
+exports.KbSummaryResponseToJSONTyped = KbSummaryResponseToJSONTyped;
+const MeteredQuotaStatus_1 = require("./MeteredQuotaStatus");
+exports.KbSummaryResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the KbSummaryResponse interface.
+ */
+function instanceOfKbSummaryResponse(value) {
+    if (!('documentsTotal' in value) || value['documentsTotal'] === undefined)
+        return false;
+    if (!('documentsByOrigin' in value) || value['documentsByOrigin'] === undefined)
+        return false;
+    if (!('documentsByType' in value) || value['documentsByType'] === undefined)
+        return false;
+    if (!('documentVersionsTotal' in value) || value['documentVersionsTotal'] === undefined)
+        return false;
+    if (!('chunksTotal' in value) || value['chunksTotal'] === undefined)
+        return false;
+    if (!('chunksByType' in value) || value['chunksByType'] === undefined)
+        return false;
+    if (!('tokensTotal' in value) || value['tokensTotal'] === undefined)
+        return false;
+    if (!('sectionsTotal' in value) || value['sectionsTotal'] === undefined)
+        return false;
+    if (!('threadsTotal' in value) || value['threadsTotal'] === undefined)
+        return false;
+    if (!('messagesTotal' in value) || value['messagesTotal'] === undefined)
+        return false;
+    if (!('messagesByRole' in value) || value['messagesByRole'] === undefined)
+        return false;
+    if (!('dataSourcesTotal' in value) || value['dataSourcesTotal'] === undefined)
+        return false;
+    if (!('dataSourceTablesTotal' in value) || value['dataSourceTablesTotal'] === undefined)
+        return false;
+    if (!('documentsCheckedOut' in value) || value['documentsCheckedOut'] === undefined)
+        return false;
+    if (!('quota' in value) || value['quota'] === undefined)
+        return false;
+    if (!('feedbackUp' in value) || value['feedbackUp'] === undefined)
+        return false;
+    if (!('feedbackDown' in value) || value['feedbackDown'] === undefined)
+        return false;
+    return true;
+}
+function KbSummaryResponseFromJSON(json) {
+    return KbSummaryResponseFromJSONTyped(json, false);
+}
+function KbSummaryResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'documentsTotal': json['documents_total'],
+        'documentsByOrigin': json['documents_by_origin'],
+        'documentsByType': json['documents_by_type'],
+        'documentVersionsTotal': json['document_versions_total'],
+        'chunksTotal': json['chunks_total'],
+        'chunksByType': json['chunks_by_type'],
+        'tokensTotal': json['tokens_total'],
+        'sectionsTotal': json['sections_total'],
+        'threadsTotal': json['threads_total'],
+        'messagesTotal': json['messages_total'],
+        'messagesByRole': json['messages_by_role'],
+        'dataSourcesTotal': json['data_sources_total'],
+        'dataSourceTablesTotal': json['data_source_tables_total'],
+        'documentsCheckedOut': json['documents_checked_out'],
+        'quota': (json['quota'].map(MeteredQuotaStatus_1.MeteredQuotaStatusFromJSON)),
+        'feedbackUp': json['feedback_up'],
+        'feedbackDown': json['feedback_down'],
+    };
+}
+function KbSummaryResponseToJSON(json) {
+    return KbSummaryResponseToJSONTyped(json, false);
+}
+function KbSummaryResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'documents_total': value['documentsTotal'],
+        'documents_by_origin': value['documentsByOrigin'],
+        'documents_by_type': value['documentsByType'],
+        'document_versions_total': value['documentVersionsTotal'],
+        'chunks_total': value['chunksTotal'],
+        'chunks_by_type': value['chunksByType'],
+        'tokens_total': value['tokensTotal'],
+        'sections_total': value['sectionsTotal'],
+        'threads_total': value['threadsTotal'],
+        'messages_total': value['messagesTotal'],
+        'messages_by_role': value['messagesByRole'],
+        'data_sources_total': value['dataSourcesTotal'],
+        'data_source_tables_total': value['dataSourceTablesTotal'],
+        'documents_checked_out': value['documentsCheckedOut'],
+        'quota': (value['quota'].map(MeteredQuotaStatus_1.MeteredQuotaStatusToJSON)),
+        'feedback_up': value['feedbackUp'],
+        'feedback_down': value['feedbackDown'],
+    };
+}