@knowledge-stack/ksapi 1.139.1 → 1.140.1

package/dist/esm/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/esm/models/KbSummaryResponse.js

@@ -0,0 +1,109 @@
+/* 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.
+ */
+import { MeteredQuotaStatusFromJSON, MeteredQuotaStatusToJSON, } from './MeteredQuotaStatus';
+export const KbSummaryResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the KbSummaryResponse interface.
+ */
+export 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;
+}
+export function KbSummaryResponseFromJSON(json) {
+    return KbSummaryResponseFromJSONTyped(json, false);
+}
+export 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(MeteredQuotaStatusFromJSON)),
+        'feedbackUp': json['feedback_up'],
+        'feedbackDown': json['feedback_down'],
+    };
+}
+export function KbSummaryResponseToJSON(json) {
+    return KbSummaryResponseToJSONTyped(json, false);
+}
+export 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(MeteredQuotaStatusToJSON)),
+        'feedback_up': value['feedbackUp'],
+        'feedback_down': value['feedbackDown'],
+    };
+}

package/dist/esm/models/KbTimeseriesResponse.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 { KbMetric } from './KbMetric';
+import type { TimeBucket } from './TimeBucket';
+import type { LabeledSeries } from './LabeledSeries';
+/**
+ * A knowledge-base metric bucketed over time.
+ *
+ * ``series`` carries one entry per split — two (SOURCE / GENERATED) for
+ * ``document_uploads``, one for the ingestion metrics.
+ * @export
+ * @interface KbTimeseriesResponse
+ */
+export interface KbTimeseriesResponse {
+    /**
+     *
+     * @type {KbMetric}
+     * @memberof KbTimeseriesResponse
+     */
+    metric: KbMetric;
+    /**
+     *
+     * @type {string}
+     * @memberof KbTimeseriesResponse
+     */
+    timezone: string;
+    /**
+     *
+     * @type {TimeBucket}
+     * @memberof KbTimeseriesResponse
+     */
+    bucket: TimeBucket;
+    /**
+     *
+     * @type {Array<LabeledSeries>}
+     * @memberof KbTimeseriesResponse
+     */
+    series?: Array<LabeledSeries>;
+}
+export declare const KbTimeseriesResponsePropertyValidationAttributesMap: {
+    [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 KbTimeseriesResponse interface.
+ */
+export declare function instanceOfKbTimeseriesResponse(value: object): value is KbTimeseriesResponse;
+export declare function KbTimeseriesResponseFromJSON(json: any): KbTimeseriesResponse;
+export declare function KbTimeseriesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): KbTimeseriesResponse;
+export declare function KbTimeseriesResponseToJSON(json: any): KbTimeseriesResponse;
+export declare function KbTimeseriesResponseToJSONTyped(value?: KbTimeseriesResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/KbTimeseriesResponse.js

@@ -0,0 +1,57 @@
+/* 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.
+ */
+import { KbMetricFromJSON, KbMetricToJSON, } from './KbMetric';
+import { TimeBucketFromJSON, TimeBucketToJSON, } from './TimeBucket';
+import { LabeledSeriesFromJSON, LabeledSeriesToJSON, } from './LabeledSeries';
+export const KbTimeseriesResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the KbTimeseriesResponse interface.
+ */
+export function instanceOfKbTimeseriesResponse(value) {
+    if (!('metric' in value) || value['metric'] === undefined)
+        return false;
+    if (!('timezone' in value) || value['timezone'] === undefined)
+        return false;
+    if (!('bucket' in value) || value['bucket'] === undefined)
+        return false;
+    return true;
+}
+export function KbTimeseriesResponseFromJSON(json) {
+    return KbTimeseriesResponseFromJSONTyped(json, false);
+}
+export function KbTimeseriesResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'metric': KbMetricFromJSON(json['metric']),
+        'timezone': json['timezone'],
+        'bucket': TimeBucketFromJSON(json['bucket']),
+        'series': json['series'] == null ? undefined : (json['series'].map(LabeledSeriesFromJSON)),
+    };
+}
+export function KbTimeseriesResponseToJSON(json) {
+    return KbTimeseriesResponseToJSONTyped(json, false);
+}
+export function KbTimeseriesResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'metric': KbMetricToJSON(value['metric']),
+        'timezone': value['timezone'],
+        'bucket': TimeBucketToJSON(value['bucket']),
+        'series': value['series'] == null ? undefined : (value['series'].map(LabeledSeriesToJSON)),
+    };
+}

package/dist/esm/models/LabeledSeries.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 { TimeseriesPoint } from './TimeseriesPoint';
+/**
+ * A named series (e.g. one per document origin or ingestion outcome).
+ * @export
+ * @interface LabeledSeries
+ */
+export interface LabeledSeries {
+    /**
+     * Series label, e.g. 'SOURCE' or 'FAILED'.
+     * @type {string}
+     * @memberof LabeledSeries
+     */
+    label: string;
+    /**
+     *
+     * @type {Array<TimeseriesPoint>}
+     * @memberof LabeledSeries
+     */
+    points?: Array<TimeseriesPoint>;
+}
+export declare const LabeledSeriesPropertyValidationAttributesMap: {
+    [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 LabeledSeries interface.
+ */
+export declare function instanceOfLabeledSeries(value: object): value is LabeledSeries;
+export declare function LabeledSeriesFromJSON(json: any): LabeledSeries;
+export declare function LabeledSeriesFromJSONTyped(json: any, ignoreDiscriminator: boolean): LabeledSeries;
+export declare function LabeledSeriesToJSON(json: any): LabeledSeries;
+export declare function LabeledSeriesToJSONTyped(value?: LabeledSeries | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LabeledSeries.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+import { TimeseriesPointFromJSON, TimeseriesPointToJSON, } from './TimeseriesPoint';
+export const LabeledSeriesPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the LabeledSeries interface.
+ */
+export function instanceOfLabeledSeries(value) {
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    return true;
+}
+export function LabeledSeriesFromJSON(json) {
+    return LabeledSeriesFromJSONTyped(json, false);
+}
+export function LabeledSeriesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'label': json['label'],
+        'points': json['points'] == null ? undefined : (json['points'].map(TimeseriesPointFromJSON)),
+    };
+}
+export function LabeledSeriesToJSON(json) {
+    return LabeledSeriesToJSONTyped(json, false);
+}
+export function LabeledSeriesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'label': value['label'],
+        'points': value['points'] == null ? undefined : (value['points'].map(TimeseriesPointToJSON)),
+    };
+}

package/dist/esm/models/LeaderboardEntry.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+/**
+ * One ranked entry (a workflow definition or a user).
+ * @export
+ * @interface LeaderboardEntry
+ */
+export interface LeaderboardEntry {
+    /**
+     *
+     * @type {string}
+     * @memberof LeaderboardEntry
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LeaderboardEntry
+     */
+    name: string;
+    /**
+     * Run count.
+     * @type {number}
+     * @memberof LeaderboardEntry
+     */
+    count: number;
+}
+export declare const LeaderboardEntryPropertyValidationAttributesMap: {
+    [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 LeaderboardEntry interface.
+ */
+export declare function instanceOfLeaderboardEntry(value: object): value is LeaderboardEntry;
+export declare function LeaderboardEntryFromJSON(json: any): LeaderboardEntry;
+export declare function LeaderboardEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeaderboardEntry;
+export declare function LeaderboardEntryToJSON(json: any): LeaderboardEntry;
+export declare function LeaderboardEntryToJSONTyped(value?: LeaderboardEntry | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LeaderboardEntry.js

@@ -0,0 +1,52 @@
+/* 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.
+ */
+export const LeaderboardEntryPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the LeaderboardEntry interface.
+ */
+export function instanceOfLeaderboardEntry(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('count' in value) || value['count'] === undefined)
+        return false;
+    return true;
+}
+export function LeaderboardEntryFromJSON(json) {
+    return LeaderboardEntryFromJSONTyped(json, false);
+}
+export function LeaderboardEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'count': json['count'],
+    };
+}
+export function LeaderboardEntryToJSON(json) {
+    return LeaderboardEntryToJSONTyped(json, false);
+}
+export function LeaderboardEntryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'count': value['count'],
+    };
+}