@knowledge-stack/ksapi 1.146.0 → 1.147.0

package/src/apis/DocumentsApi.ts

@@ -25,6 +25,7 @@ import type {
   HTTPValidationError,
   ImageTaxonomy,
   IngestDocumentResponse,
+  IngestZipResponse,
   IngestionMode,
   PaginatedResponseDocumentResponse,
   PathOrder,
@@ -52,6 +53,8 @@ import {
     ImageTaxonomyToJSON,
     IngestDocumentResponseFromJSON,
     IngestDocumentResponseToJSON,
+    IngestZipResponseFromJSON,
+    IngestZipResponseToJSON,
     IngestionModeFromJSON,
     IngestionModeToJSON,
     PaginatedResponseDocumentResponseFromJSON,
@@ -105,6 +108,12 @@ export interface IngestDocumentVersionRequest {
     workflowDefinitionId?: string | null;
 }
 
+export interface IngestZipRequest {
+    file: Blob;
+    pathPartId: string;
+    ingestionMode?: IngestionMode;
+}
+
 export interface ListDocumentsRequest {
     parentPathPartId?: string | null;
     sortOrder?: PathOrder;
@@ -309,6 +318,34 @@ export interface DocumentsApiInterface {
      */
     ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
 
+    /**
+     * Creates request options for ingestZip without sending the request
+     * @param {Blob} file 
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {IngestionMode} [ingestionMode] 
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * @summary Ingest Zip Handler
+     * @param {Blob} file 
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {IngestionMode} [ingestionMode] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
+
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
+
     /**
      * Creates request options for listDocuments without sending the request
      * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
@@ -836,6 +873,96 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
         return await response.value();
     }
 
+    /**
+     * Creates request options for ingestZip without sending the request
+     */
+    async ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling ingestZip().'
+            );
+        }
+
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling ingestZip().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
+        if (requestParameters['pathPartId'] != null) {
+            formParams.append('path_part_id', requestParameters['pathPartId'] as any);
+        }
+
+        if (requestParameters['ingestionMode'] != null) {
+            formParams.append('ingestion_mode', requestParameters['ingestionMode'] as any);
+        }
+
+
+        let urlPath = `/v1/documents/ingest-zip`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    async ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>> {
+        const requestOptions = await this.ingestZipRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IngestZipResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    async ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse> {
+        const response = await this.ingestZipRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listDocuments without sending the request
      */

package/src/models/IngestZipResponse.ts

@@ -0,0 +1,127 @@
+/* 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 { ZipFileResult } from './ZipFileResult';
+import {
+    ZipFileResultFromJSON,
+    ZipFileResultFromJSONTyped,
+    ZipFileResultToJSON,
+    ZipFileResultToJSONTyped,
+} from './ZipFileResult';
+
+/**
+ * Aggregate response from a ZIP ingestion batch.
+ * @export
+ * @interface IngestZipResponse
+ */
+export interface IngestZipResponse {
+    /**
+     * 
+     * @type {Array<ZipFileResult>}
+     * @memberof IngestZipResponse
+     */
+    files: Array<ZipFileResult>;
+    /**
+     * 
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    totalFound: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    succeeded: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    skipped: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    failed: number;
+}
+export const IngestZipResponsePropertyValidationAttributesMap: {
+    [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 IngestZipResponse interface.
+ */
+export function instanceOfIngestZipResponse(value: object): value is IngestZipResponse {
+    if (!('files' in value) || value['files'] === undefined) return false;
+    if (!('totalFound' in value) || value['totalFound'] === undefined) return false;
+    if (!('succeeded' in value) || value['succeeded'] === undefined) return false;
+    if (!('skipped' in value) || value['skipped'] === undefined) return false;
+    if (!('failed' in value) || value['failed'] === undefined) return false;
+    return true;
+}
+
+export function IngestZipResponseFromJSON(json: any): IngestZipResponse {
+    return IngestZipResponseFromJSONTyped(json, false);
+}
+
+export function IngestZipResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IngestZipResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'files': ((json['files'] as Array<any>).map(ZipFileResultFromJSON)),
+        'totalFound': json['total_found'],
+        'succeeded': json['succeeded'],
+        'skipped': json['skipped'],
+        'failed': json['failed'],
+    };
+}
+
+export function IngestZipResponseToJSON(json: any): IngestZipResponse {
+    return IngestZipResponseToJSONTyped(json, false);
+}
+
+export function IngestZipResponseToJSONTyped(value?: IngestZipResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'files': ((value['files'] as Array<any>).map(ZipFileResultToJSON)),
+        'total_found': value['totalFound'],
+        'succeeded': value['succeeded'],
+        'skipped': value['skipped'],
+        'failed': value['failed'],
+    };
+}
+

package/src/models/ZipFileResult.ts

@@ -0,0 +1,123 @@
+/* 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';
+/**
+ * Per-file outcome from a ZIP ingestion batch.
+ * @export
+ * @interface ZipFileResult
+ */
+export interface ZipFileResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    zipPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    documentId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    documentVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    workflowId?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ZipFileResult
+     */
+    skipped?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    error?: string | null;
+}
+export const ZipFileResultPropertyValidationAttributesMap: {
+    [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 ZipFileResult interface.
+ */
+export function instanceOfZipFileResult(value: object): value is ZipFileResult {
+    if (!('zipPath' in value) || value['zipPath'] === undefined) return false;
+    return true;
+}
+
+export function ZipFileResultFromJSON(json: any): ZipFileResult {
+    return ZipFileResultFromJSONTyped(json, false);
+}
+
+export function ZipFileResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipFileResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'zipPath': json['zip_path'],
+        'documentId': json['document_id'] == null ? undefined : json['document_id'],
+        'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
+        'workflowId': json['workflow_id'] == null ? undefined : json['workflow_id'],
+        'skipped': json['skipped'] == null ? undefined : json['skipped'],
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+
+export function ZipFileResultToJSON(json: any): ZipFileResult {
+    return ZipFileResultToJSONTyped(json, false);
+}
+
+export function ZipFileResultToJSONTyped(value?: ZipFileResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'zip_path': value['zipPath'],
+        'document_id': value['documentId'],
+        'document_version_id': value['documentVersionId'],
+        'workflow_id': value['workflowId'],
+        'skipped': value['skipped'],
+        'error': value['error'],
+    };
+}
+

package/src/models/index.ts

@@ -141,6 +141,7 @@ export * from './IdpType';
 export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
+export * from './IngestZipResponse';
 export * from './IngestionMode';
 export * from './Input';
 export * from './InputOrigin';
@@ -359,3 +360,4 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './ZipFileResult';