@knowledge-stack/ksapi 1.139.0 → 1.140.0

package/src/models/WorkflowOutputStatsResponse.ts

@@ -0,0 +1,99 @@
+/* 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 { mapValues } from '../runtime';
+import type { DefinitionOutputStat } from './DefinitionOutputStat';
+import {
+    DefinitionOutputStatFromJSON,
+    DefinitionOutputStatFromJSONTyped,
+    DefinitionOutputStatToJSON,
+    DefinitionOutputStatToJSONTyped,
+} from './DefinitionOutputStat';
+
+/**
+ * Avg documents generated per workflow definition (completed runs).
+ * @export
+ * @interface WorkflowOutputStatsResponse
+ */
+export interface WorkflowOutputStatsResponse {
+    /**
+     * 
+     * @type {Array<DefinitionOutputStat>}
+     * @memberof WorkflowOutputStatsResponse
+     */
+    perDefinition?: Array<DefinitionOutputStat>;
+    /**
+     * Mean output DOCUMENTs across all completed runs; null when none.
+     * @type {number}
+     * @memberof WorkflowOutputStatsResponse
+     */
+    overallAvg: number | null;
+}
+export const WorkflowOutputStatsResponsePropertyValidationAttributesMap: {
+    [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 WorkflowOutputStatsResponse interface.
+ */
+export function instanceOfWorkflowOutputStatsResponse(value: object): value is WorkflowOutputStatsResponse {
+    if (!('overallAvg' in value) || value['overallAvg'] === undefined) return false;
+    return true;
+}
+
+export function WorkflowOutputStatsResponseFromJSON(json: any): WorkflowOutputStatsResponse {
+    return WorkflowOutputStatsResponseFromJSONTyped(json, false);
+}
+
+export function WorkflowOutputStatsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowOutputStatsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'perDefinition': json['per_definition'] == null ? undefined : ((json['per_definition'] as Array<any>).map(DefinitionOutputStatFromJSON)),
+        'overallAvg': json['overall_avg'],
+    };
+}
+
+export function WorkflowOutputStatsResponseToJSON(json: any): WorkflowOutputStatsResponse {
+    return WorkflowOutputStatsResponseToJSONTyped(json, false);
+}
+
+export function WorkflowOutputStatsResponseToJSONTyped(value?: WorkflowOutputStatsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'per_definition': value['perDefinition'] == null ? undefined : ((value['perDefinition'] as Array<any>).map(DefinitionOutputStatToJSON)),
+        'overall_avg': value['overallAvg'],
+    };
+}
+

package/src/models/index.ts

@@ -82,6 +82,7 @@ export * from './DataSourceSchemaListResponse';
 export * from './DataSourceSchemaResponse';
 export * from './DataSourceSyncResponse';
 export * from './DataSourceTableResponse';
+export * from './DefinitionOutputStat';
 export * from './DiffFormat';
 export * from './DiffRow';
 export * from './DiffRowType';
@@ -133,6 +134,7 @@ export * from './GroupPermissionResponse';
 export * from './GroupResponse';
 export * from './HTTPValidationError';
 export * from './HealthCheckResponse';
+export * from './HourHistogramResponse';
 export * from './HybridSearchProfile';
 export * from './IdpConfig';
 export * from './IdpType';
@@ -152,6 +154,11 @@ export * from './InviteResponse';
 export * from './InviteStatus';
 export * from './InviteUserRequest';
 export * from './ItemPermissions';
+export * from './KbMetric';
+export * from './KbSummaryResponse';
+export * from './KbTimeseriesResponse';
+export * from './LabeledSeries';
+export * from './LeaderboardEntry';
 export * from './LineageEdgeResponse';
 export * from './LineageGraphResponse';
 export * from './LineageNodeResponse';
@@ -228,6 +235,7 @@ export * from './RevisionEdit';
 export * from './RootResponse';
 export * from './RunFolder';
 export * from './RunFolderRef';
+export * from './RunTimeseriesResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
 export * from './SearchSkillsRequest';
@@ -291,6 +299,8 @@ export * from './ThreadMessageDetails';
 export * from './ThreadMessageResponse';
 export * from './ThreadOrder';
 export * from './ThreadResponse';
+export * from './TimeBucket';
+export * from './TimeseriesPoint';
 export * from './ToolDisplayType';
 export * from './ToolPart';
 export * from './ToolStatus';
@@ -334,6 +344,8 @@ export * from './WorkflowDefinitionOrder';
 export * from './WorkflowDefinitionResponse';
 export * from './WorkflowDetailResponse';
 export * from './WorkflowExecutionState';
+export * from './WorkflowLeaderboardResponse';
+export * from './WorkflowOutputStatsResponse';
 export * from './WorkflowRunAsset';
 export * from './WorkflowRunCallbackRequest';
 export * from './WorkflowRunOrder';