@knowledge-stack/ksapi 1.145.1 → 1.147.0

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

@@ -0,0 +1,77 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare 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 declare function instanceOfZipFileResult(value: object): value is ZipFileResult;
+export declare function ZipFileResultFromJSON(json: any): ZipFileResult;
+export declare function ZipFileResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipFileResult;
+export declare function ZipFileResultToJSON(json: any): ZipFileResult;
+export declare function ZipFileResultToJSONTyped(value?: ZipFileResult | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ZipFileResult.js

@@ -0,0 +1,54 @@
+/* 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 ZipFileResultPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ZipFileResult interface.
+ */
+export function instanceOfZipFileResult(value) {
+    if (!('zipPath' in value) || value['zipPath'] === undefined)
+        return false;
+    return true;
+}
+export function ZipFileResultFromJSON(json) {
+    return ZipFileResultFromJSONTyped(json, false);
+}
+export function ZipFileResultFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return ZipFileResultToJSONTyped(json, false);
+}
+export function ZipFileResultToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/index.d.ts

@@ -139,6 +139,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';
@@ -357,3 +358,4 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './ZipFileResult';

package/dist/esm/models/index.js

@@ -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';

package/dist/models/ChunkContentItem.d.ts

@@ -54,6 +54,12 @@ export interface ChunkContentItem {
      * @memberof ChunkContentItem
      */
     depth: number;
+    /**
+     * 0-based ordinal of this chunk, counting CHUNK rows in DFS order from the traversal root. Usable directly as a read start/end coordinate. Null on endpoints that do not compute traversal ordinals.
+     * @type {number}
+     * @memberof ChunkContentItem
+     */
+    chunkStartIndex?: number | null;
     /**
      * Chunk content
      * @type {string}

package/dist/models/ChunkContentItem.js

@@ -71,6 +71,7 @@ function ChunkContentItemFromJSONTyped(json, ignoreDiscriminator) {
         'parentPathId': json['parent_path_id'],
         'metadataObjId': json['metadata_obj_id'],
         'depth': json['depth'],
+        'chunkStartIndex': json['chunk_start_index'] == null ? undefined : json['chunk_start_index'],
         'content': json['content'] == null ? undefined : json['content'],
         'chunkType': json['chunk_type'] == null ? undefined : (0, ChunkType_1.ChunkTypeFromJSON)(json['chunk_type']),
         'chunkMetadata': json['chunk_metadata'] == null ? undefined : (0, ChunkMetadata_1.ChunkMetadataFromJSON)(json['chunk_metadata']),
@@ -95,6 +96,7 @@ function ChunkContentItemToJSONTyped(value, ignoreDiscriminator = false) {
         'parent_path_id': value['parentPathId'],
         'metadata_obj_id': value['metadataObjId'],
         'depth': value['depth'],
+        'chunk_start_index': value['chunkStartIndex'],
         'content': value['content'],
         'chunk_type': (0, ChunkType_1.ChunkTypeToJSON)(value['chunkType']),
         'chunk_metadata': (0, ChunkMetadata_1.ChunkMetadataToJSON)(value['chunkMetadata']),

package/dist/models/IngestZipResponse.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 { ZipFileResult } 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 declare 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 declare function instanceOfIngestZipResponse(value: object): value is IngestZipResponse;
+export declare function IngestZipResponseFromJSON(json: any): IngestZipResponse;
+export declare function IngestZipResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IngestZipResponse;
+export declare function IngestZipResponseToJSON(json: any): IngestZipResponse;
+export declare function IngestZipResponseToJSONTyped(value?: IngestZipResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IngestZipResponse.js

@@ -0,0 +1,69 @@
+"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.IngestZipResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfIngestZipResponse = instanceOfIngestZipResponse;
+exports.IngestZipResponseFromJSON = IngestZipResponseFromJSON;
+exports.IngestZipResponseFromJSONTyped = IngestZipResponseFromJSONTyped;
+exports.IngestZipResponseToJSON = IngestZipResponseToJSON;
+exports.IngestZipResponseToJSONTyped = IngestZipResponseToJSONTyped;
+const ZipFileResult_1 = require("./ZipFileResult");
+exports.IngestZipResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the IngestZipResponse interface.
+ */
+function instanceOfIngestZipResponse(value) {
+    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;
+}
+function IngestZipResponseFromJSON(json) {
+    return IngestZipResponseFromJSONTyped(json, false);
+}
+function IngestZipResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'files': (json['files'].map(ZipFileResult_1.ZipFileResultFromJSON)),
+        'totalFound': json['total_found'],
+        'succeeded': json['succeeded'],
+        'skipped': json['skipped'],
+        'failed': json['failed'],
+    };
+}
+function IngestZipResponseToJSON(json) {
+    return IngestZipResponseToJSONTyped(json, false);
+}
+function IngestZipResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'files': (value['files'].map(ZipFileResult_1.ZipFileResultToJSON)),
+        'total_found': value['totalFound'],
+        'succeeded': value['succeeded'],
+        'skipped': value['skipped'],
+        'failed': value['failed'],
+    };
+}

package/dist/models/SectionContentItem.d.ts

@@ -52,6 +52,18 @@ export interface SectionContentItem {
      * @memberof SectionContentItem
      */
     depth: number;
+    /**
+     * 0-based ordinal of the first chunk in this section's subtree, counting CHUNK rows in DFS order from the traversal root. Null when the section has no chunk anywhere below it, and on endpoints that do not compute traversal ordinals.
+     * @type {number}
+     * @memberof SectionContentItem
+     */
+    chunkStartIndex?: number | null;
+    /**
+     * 0-based ordinal of the last chunk in this section's subtree, inclusive. Chunks outside the section — a later sibling, or a chunk attached to an ancestor — are excluded, so the span covers only this section's own content. Null under the same conditions as chunk_start_index.
+     * @type {number}
+     * @memberof SectionContentItem
+     */
+    chunkEndIndex?: number | null;
     /**
      * Section page number
      * @type {number}

package/dist/models/SectionContentItem.js

@@ -69,6 +69,8 @@ function SectionContentItemFromJSONTyped(json, ignoreDiscriminator) {
         'parentPathId': json['parent_path_id'],
         'metadataObjId': json['metadata_obj_id'],
         'depth': json['depth'],
+        'chunkStartIndex': json['chunk_start_index'] == null ? undefined : json['chunk_start_index'],
+        'chunkEndIndex': json['chunk_end_index'] == null ? undefined : json['chunk_end_index'],
         'pageNumber': json['page_number'] == null ? undefined : json['page_number'],
         'materializedPath': json['materialized_path'],
         'systemManaged': json['system_managed'],
@@ -91,6 +93,8 @@ function SectionContentItemToJSONTyped(value, ignoreDiscriminator = false) {
         'parent_path_id': value['parentPathId'],
         'metadata_obj_id': value['metadataObjId'],
         'depth': value['depth'],
+        'chunk_start_index': value['chunkStartIndex'],
+        'chunk_end_index': value['chunkEndIndex'],
         'page_number': value['pageNumber'],
         'materialized_path': value['materializedPath'],
         'system_managed': value['systemManaged'],

package/dist/models/ZipFileResult.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare 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 declare function instanceOfZipFileResult(value: object): value is ZipFileResult;
+export declare function ZipFileResultFromJSON(json: any): ZipFileResult;
+export declare function ZipFileResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipFileResult;
+export declare function ZipFileResultToJSON(json: any): ZipFileResult;
+export declare function ZipFileResultToJSONTyped(value?: ZipFileResult | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ZipFileResult.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.ZipFileResultPropertyValidationAttributesMap = void 0;
+exports.instanceOfZipFileResult = instanceOfZipFileResult;
+exports.ZipFileResultFromJSON = ZipFileResultFromJSON;
+exports.ZipFileResultFromJSONTyped = ZipFileResultFromJSONTyped;
+exports.ZipFileResultToJSON = ZipFileResultToJSON;
+exports.ZipFileResultToJSONTyped = ZipFileResultToJSONTyped;
+exports.ZipFileResultPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ZipFileResult interface.
+ */
+function instanceOfZipFileResult(value) {
+    if (!('zipPath' in value) || value['zipPath'] === undefined)
+        return false;
+    return true;
+}
+function ZipFileResultFromJSON(json) {
+    return ZipFileResultFromJSONTyped(json, false);
+}
+function ZipFileResultFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function ZipFileResultToJSON(json) {
+    return ZipFileResultToJSONTyped(json, false);
+}
+function ZipFileResultToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/index.d.ts

@@ -139,6 +139,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';
@@ -357,3 +358,4 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './ZipFileResult';

package/dist/models/index.js

@@ -157,6 +157,7 @@ __exportStar(require("./IdpType"), exports);
 __exportStar(require("./ImageTaxonomy"), exports);
 __exportStar(require("./InformationStatistics"), exports);
 __exportStar(require("./IngestDocumentResponse"), exports);
+__exportStar(require("./IngestZipResponse"), exports);
 __exportStar(require("./IngestionMode"), exports);
 __exportStar(require("./Input"), exports);
 __exportStar(require("./InputOrigin"), exports);
@@ -375,3 +376,4 @@ __exportStar(require("./XlsxCellAnchorInput"), exports);
 __exportStar(require("./XlsxCellAnchorInputOrDocxParagraphAnchorInput"), exports);
 __exportStar(require("./XlsxCellAnchorOutput"), exports);
 __exportStar(require("./XlsxCellAnchorOutputOrDocxParagraphAnchorOutput"), exports);
+__exportStar(require("./ZipFileResult"), exports);

package/docs/ChunkContentItem.md

@@ -13,6 +13,7 @@ Name | Type
 `parentPathId` | string
 `metadataObjId` | string
 `depth` | number
+`chunkStartIndex` | number
 `content` | string
 `chunkType` | [ChunkType](ChunkType.md)
 `chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
@@ -35,6 +36,7 @@ const example = {
   "parentPathId": null,
   "metadataObjId": null,
   "depth": null,
+  "chunkStartIndex": null,
   "content": null,
   "chunkType": null,
   "chunkMetadata": null,