@knowledge-stack/ksapi 2.12.0 → 2.13.0

package/src/models/SearchItemsResponse.ts

@@ -0,0 +1,141 @@
+/* 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 { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR } from './FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR';
+import {
+    FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRFromJSON,
+    FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRFromJSONTyped,
+    FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRToJSON,
+    FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRToJSONTyped,
+} from './FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR';
+
+/**
+ * A search page plus how many items of each type the query matched.
+ * 
+ * ``counts_by_type`` ignores any ``part_type`` filter so the filter chips can
+ * keep showing every type's count while one of them is selected.
+ * @export
+ * @interface SearchItemsResponse
+ */
+export interface SearchItemsResponse {
+    /**
+     * List of items
+     * @type {Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR>}
+     * @memberof SearchItemsResponse
+     */
+    items: Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof SearchItemsResponse
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof SearchItemsResponse
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof SearchItemsResponse
+     */
+    offset: number;
+    /**
+     * Matches per item type, keyed by SearchablePartType and unaffected by the part_type filter
+     * @type {{ [key: string]: number; }}
+     * @memberof SearchItemsResponse
+     */
+    countsByType?: { [key: string]: number; };
+}
+export const SearchItemsResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the SearchItemsResponse interface.
+ */
+export function instanceOfSearchItemsResponse(value: object): value is SearchItemsResponse {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    if (!('offset' in value) || value['offset'] === undefined) return false;
+    return true;
+}
+
+export function SearchItemsResponseFromJSON(json: any): SearchItemsResponse {
+    return SearchItemsResponseFromJSONTyped(json, false);
+}
+
+export function SearchItemsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchItemsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+        'countsByType': json['counts_by_type'] == null ? undefined : json['counts_by_type'],
+    };
+}
+
+export function SearchItemsResponseToJSON(json: any): SearchItemsResponse {
+    return SearchItemsResponseToJSONTyped(json, false);
+}
+
+export function SearchItemsResponseToJSONTyped(value?: SearchItemsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+        'counts_by_type': value['countsByType'],
+    };
+}
+

package/src/models/SearchSortOrder.ts

@@ -14,10 +14,15 @@
 
 
 /**
- * Sort order options for search results.
+ * Ordering for flat name search.
+ * 
+ * RELEVANCE ranks an exact name match first, then names starting with the
+ * query, then by how closely the name matches, then shorter names, then
+ * alphabetically.
  * @export
  */
 export const SearchSortOrder = {
+    Relevance: 'RELEVANCE',
     Name: 'NAME',
     UpdatedAt: 'UPDATED_AT',
     CreatedAt: 'CREATED_AT'

package/src/models/SearchablePartType.ts

@@ -25,7 +25,8 @@ export const SearchablePartType = {
     DataSource: 'DATA_SOURCE',
     DataSourceSchema: 'DATA_SOURCE_SCHEMA',
     DataSourceTable: 'DATA_SOURCE_TABLE',
-    ApiConnection: 'API_CONNECTION'
+    ApiConnection: 'API_CONNECTION',
+    Skill: 'SKILL'
 } as const;
 export type SearchablePartType = typeof SearchablePartType[keyof typeof SearchablePartType];
 

package/src/models/index.ts

@@ -265,6 +265,7 @@ export * from './RunTimeseriesResponse';
 export * from './SSOInitiateResponse';
 export * from './ScheduleCadence';
 export * from './ScoredChunkResponse';
+export * from './SearchItemsResponse';
 export * from './SearchSkillsRequest';
 export * from './SearchSkillsResponse';
 export * from './SearchSortOrder';