@knowledge-stack/ksapi 1.19.4 → 1.20.0

package/.openapi-generator/FILES

@@ -28,6 +28,7 @@ src/models/ChunkMetadataOutput.ts
 src/models/ChunkResponse.ts
 src/models/ChunkSearchRequest.ts
 src/models/ChunkType.ts
+src/models/ClearVersionContentsResponse.ts
 src/models/CreateChunkLineageRequest.ts
 src/models/CreateChunkRequest.ts
 src/models/CreateDocumentRequest.ts

package/README.md

@@ -1,4 +1,4 @@
-## @knowledge-stack/ksapi@1.19.4
+## @knowledge-stack/ksapi@1.20.0
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @knowledge-stack/ksapi@1.19.4 --save
+npm install @knowledge-stack/ksapi@1.20.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/DocumentVersionsApi.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { DocumentVersionMetadataUpdate, DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
+import type { ClearVersionContentsResponse, DocumentVersionMetadataUpdate, DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
+export interface ClearDocumentVersionContentsRequest {
+    versionId: string;
+    ksUat?: string;
+}
 export interface CreateDocumentVersionRequest {
     documentId: string;
     ksUat?: string;
@@ -48,6 +52,21 @@ export interface UpdateDocumentVersionMetadataRequest {
  * @interface DocumentVersionsApiInterface
  */
 export interface DocumentVersionsApiInterface {
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * @summary Clear Document Version Contents Handler
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>>;
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse>;
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * @summary Create Document Version Handler
@@ -149,6 +168,16 @@ export interface DocumentVersionsApiInterface {
  *
  */
 export declare class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVersionsApiInterface {
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>>;
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse>;
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * Create Document Version Handler

package/dist/apis/DocumentVersionsApi.js

@@ -29,6 +29,38 @@ const index_1 = require("../models/index");
  *
  */
 class DocumentVersionsApi extends runtime.BaseAPI {
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContentsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling clearDocumentVersionContents().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/document_versions/{version_id}/contents`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ClearVersionContentsResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContents(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.clearDocumentVersionContentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * Create Document Version Handler

package/dist/apis/DocumentsApi.d.ts

@@ -25,7 +25,7 @@ export interface GetDocumentRequest {
 }
 export interface IngestDocumentRequest {
     file: Blob;
-    folderId: string;
+    pathPartId: string;
     ksUat?: string;
     name?: string;
 }
@@ -97,7 +97,7 @@ export interface DocumentsApiInterface {
      * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
      * @summary Ingest Document Handler
      * @param {Blob} file
-     * @param {string} folderId Parent folder ID
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {string} [ksUat]
      * @param {string} [name] Document name (defaults to filename)
      * @param {*} [options] Override http request option.

package/dist/apis/DocumentsApi.js

@@ -134,8 +134,8 @@ class DocumentsApi extends runtime.BaseAPI {
             if (requestParameters['file'] == null) {
                 throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestDocument().');
             }
-            if (requestParameters['folderId'] == null) {
-                throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling ingestDocument().');
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling ingestDocument().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -157,8 +157,8 @@ class DocumentsApi extends runtime.BaseAPI {
             if (requestParameters['file'] != null) {
                 formParams.append('file', requestParameters['file']);
             }
-            if (requestParameters['folderId'] != null) {
-                formParams.append('folder_id', requestParameters['folderId']);
+            if (requestParameters['pathPartId'] != null) {
+                formParams.append('path_part_id', requestParameters['pathPartId']);
             }
             if (requestParameters['name'] != null) {
                 formParams.append('name', requestParameters['name']);

package/dist/esm/apis/DocumentVersionsApi.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { DocumentVersionMetadataUpdate, DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
+import type { ClearVersionContentsResponse, DocumentVersionMetadataUpdate, DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
+export interface ClearDocumentVersionContentsRequest {
+    versionId: string;
+    ksUat?: string;
+}
 export interface CreateDocumentVersionRequest {
     documentId: string;
     ksUat?: string;
@@ -48,6 +52,21 @@ export interface UpdateDocumentVersionMetadataRequest {
  * @interface DocumentVersionsApiInterface
  */
 export interface DocumentVersionsApiInterface {
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * @summary Clear Document Version Contents Handler
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>>;
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse>;
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * @summary Create Document Version Handler
@@ -149,6 +168,16 @@ export interface DocumentVersionsApiInterface {
  *
  */
 export declare class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVersionsApiInterface {
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>>;
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse>;
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * Create Document Version Handler

package/dist/esm/apis/DocumentVersionsApi.js

@@ -21,11 +21,43 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { DocumentVersionMetadataUpdateToJSON, DocumentVersionResponseFromJSON, PaginatedResponseDocumentContentPathPartFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
+import { ClearVersionContentsResponseFromJSON, DocumentVersionMetadataUpdateToJSON, DocumentVersionResponseFromJSON, PaginatedResponseDocumentContentPathPartFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
 /**
  *
  */
 export class DocumentVersionsApi extends runtime.BaseAPI {
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContentsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling clearDocumentVersionContents().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/document_versions/{version_id}/contents`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ClearVersionContentsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContents(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.clearDocumentVersionContentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * Create Document Version Handler

package/dist/esm/apis/DocumentsApi.d.ts

@@ -25,7 +25,7 @@ export interface GetDocumentRequest {
 }
 export interface IngestDocumentRequest {
     file: Blob;
-    folderId: string;
+    pathPartId: string;
     ksUat?: string;
     name?: string;
 }
@@ -97,7 +97,7 @@ export interface DocumentsApiInterface {
      * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
      * @summary Ingest Document Handler
      * @param {Blob} file
-     * @param {string} folderId Parent folder ID
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {string} [ksUat]
      * @param {string} [name] Document name (defaults to filename)
      * @param {*} [options] Override http request option.

package/dist/esm/apis/DocumentsApi.js

@@ -131,8 +131,8 @@ export class DocumentsApi extends runtime.BaseAPI {
             if (requestParameters['file'] == null) {
                 throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestDocument().');
             }
-            if (requestParameters['folderId'] == null) {
-                throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling ingestDocument().');
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling ingestDocument().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -154,8 +154,8 @@ export class DocumentsApi extends runtime.BaseAPI {
             if (requestParameters['file'] != null) {
                 formParams.append('file', requestParameters['file']);
             }
-            if (requestParameters['folderId'] != null) {
-                formParams.append('folder_id', requestParameters['folderId']);
+            if (requestParameters['pathPartId'] != null) {
+                formParams.append('path_part_id', requestParameters['pathPartId']);
             }
             if (requestParameters['name'] != null) {
                 formParams.append('name', requestParameters['name']);

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

@@ -22,6 +22,12 @@ export interface ChunkMetadataInput {
      * @memberof ChunkMetadataInput
      */
     polygons?: Array<PolygonReference>;
+    /**
+     * Full s3:// URI to the visual asset for this chunk. Set for IMAGE and TABLE chunks.
+     * @type {string}
+     * @memberof ChunkMetadataInput
+     */
+    s3Url?: string;
 }
 /**
  * Check if a given object implements the ChunkMetadataInput interface.

package/dist/esm/models/ChunkMetadataInput.js

@@ -27,6 +27,7 @@ export function ChunkMetadataInputFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReferenceFromJSON)),
+        's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
     };
 }
 export function ChunkMetadataInputToJSON(json) {
@@ -38,6 +39,7 @@ export function ChunkMetadataInputToJSONTyped(value, ignoreDiscriminator = false
     }
     return {
         'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReferenceToJSON)),
+        's3_url': value['s3Url'],
     };
 }
 export const ChunkMetadataInputPropertyValidationAttributesMap = {};

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

@@ -22,6 +22,12 @@ export interface ChunkMetadataOutput {
      * @memberof ChunkMetadataOutput
      */
     polygons?: Array<PolygonReference>;
+    /**
+     * Full s3:// URI to the visual asset for this chunk. Set for IMAGE and TABLE chunks.
+     * @type {string}
+     * @memberof ChunkMetadataOutput
+     */
+    s3Url?: string;
 }
 /**
  * Check if a given object implements the ChunkMetadataOutput interface.

package/dist/esm/models/ChunkMetadataOutput.js

@@ -27,6 +27,7 @@ export function ChunkMetadataOutputFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReferenceFromJSON)),
+        's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
     };
 }
 export function ChunkMetadataOutputToJSON(json) {
@@ -38,6 +39,7 @@ export function ChunkMetadataOutputToJSONTyped(value, ignoreDiscriminator = fals
     }
     return {
         'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReferenceToJSON)),
+        's3_url': value['s3Url'],
     };
 }
 export const ChunkMetadataOutputPropertyValidationAttributesMap = {};

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

@@ -0,0 +1,47 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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.
+ */
+/**
+ * Response model for the clear version contents endpoint.
+ * @export
+ * @interface ClearVersionContentsResponse
+ */
+export interface ClearVersionContentsResponse {
+    /**
+     * Number of top-level children deleted
+     * @type {number}
+     * @memberof ClearVersionContentsResponse
+     */
+    deleted: number;
+}
+/**
+ * Check if a given object implements the ClearVersionContentsResponse interface.
+ */
+export declare function instanceOfClearVersionContentsResponse(value: object): value is ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseFromJSON(json: any): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseToJSON(json: any): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseToJSONTyped(value?: ClearVersionContentsResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const ClearVersionContentsResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/esm/models/ClearVersionContentsResponse.js

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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.
+ */
+/**
+ * Check if a given object implements the ClearVersionContentsResponse interface.
+ */
+export function instanceOfClearVersionContentsResponse(value) {
+    if (!('deleted' in value) || value['deleted'] === undefined)
+        return false;
+    return true;
+}
+export function ClearVersionContentsResponseFromJSON(json) {
+    return ClearVersionContentsResponseFromJSONTyped(json, false);
+}
+export function ClearVersionContentsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'deleted': json['deleted'],
+    };
+}
+export function ClearVersionContentsResponseToJSON(json) {
+    return ClearVersionContentsResponseToJSONTyped(json, false);
+}
+export function ClearVersionContentsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted': value['deleted'],
+    };
+}
+export const ClearVersionContentsResponsePropertyValidationAttributesMap = {};

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

@@ -15,6 +15,7 @@
  */
 export declare const DocumentType: {
     readonly Pdf: "PDF";
+    readonly Docx: "DOCX";
     readonly Unknown: "UNKNOWN";
 };
 export type DocumentType = typeof DocumentType[keyof typeof DocumentType];

package/dist/esm/models/DocumentType.js

@@ -17,6 +17,7 @@
  */
 export const DocumentType = {
     Pdf: 'PDF',
+    Docx: 'DOCX',
     Unknown: 'UNKNOWN'
 };
 export function instanceOfDocumentType(value) {

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

@@ -4,6 +4,7 @@ export * from './ChunkMetadataOutput';
 export * from './ChunkResponse';
 export * from './ChunkSearchRequest';
 export * from './ChunkType';
+export * from './ClearVersionContentsResponse';
 export * from './CreateChunkLineageRequest';
 export * from './CreateChunkRequest';
 export * from './CreateDocumentRequest';

package/dist/esm/models/index.js

@@ -6,6 +6,7 @@ export * from './ChunkMetadataOutput';
 export * from './ChunkResponse';
 export * from './ChunkSearchRequest';
 export * from './ChunkType';
+export * from './ClearVersionContentsResponse';
 export * from './CreateChunkLineageRequest';
 export * from './CreateChunkRequest';
 export * from './CreateDocumentRequest';

package/dist/models/ChunkMetadataInput.d.ts

@@ -22,6 +22,12 @@ export interface ChunkMetadataInput {
      * @memberof ChunkMetadataInput
      */
     polygons?: Array<PolygonReference>;
+    /**
+     * Full s3:// URI to the visual asset for this chunk. Set for IMAGE and TABLE chunks.
+     * @type {string}
+     * @memberof ChunkMetadataInput
+     */
+    s3Url?: string;
 }
 /**
  * Check if a given object implements the ChunkMetadataInput interface.

package/dist/models/ChunkMetadataInput.js

@@ -35,6 +35,7 @@ function ChunkMetadataInputFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReference_1.PolygonReferenceFromJSON)),
+        's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
     };
 }
 function ChunkMetadataInputToJSON(json) {
@@ -46,6 +47,7 @@ function ChunkMetadataInputToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReference_1.PolygonReferenceToJSON)),
+        's3_url': value['s3Url'],
     };
 }
 exports.ChunkMetadataInputPropertyValidationAttributesMap = {};

package/dist/models/ChunkMetadataOutput.d.ts

@@ -22,6 +22,12 @@ export interface ChunkMetadataOutput {
      * @memberof ChunkMetadataOutput
      */
     polygons?: Array<PolygonReference>;
+    /**
+     * Full s3:// URI to the visual asset for this chunk. Set for IMAGE and TABLE chunks.
+     * @type {string}
+     * @memberof ChunkMetadataOutput
+     */
+    s3Url?: string;
 }
 /**
  * Check if a given object implements the ChunkMetadataOutput interface.

package/dist/models/ChunkMetadataOutput.js

@@ -35,6 +35,7 @@ function ChunkMetadataOutputFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReference_1.PolygonReferenceFromJSON)),
+        's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
     };
 }
 function ChunkMetadataOutputToJSON(json) {
@@ -46,6 +47,7 @@ function ChunkMetadataOutputToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReference_1.PolygonReferenceToJSON)),
+        's3_url': value['s3Url'],
     };
 }
 exports.ChunkMetadataOutputPropertyValidationAttributesMap = {};

package/dist/models/ClearVersionContentsResponse.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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.
+ */
+/**
+ * Response model for the clear version contents endpoint.
+ * @export
+ * @interface ClearVersionContentsResponse
+ */
+export interface ClearVersionContentsResponse {
+    /**
+     * Number of top-level children deleted
+     * @type {number}
+     * @memberof ClearVersionContentsResponse
+     */
+    deleted: number;
+}
+/**
+ * Check if a given object implements the ClearVersionContentsResponse interface.
+ */
+export declare function instanceOfClearVersionContentsResponse(value: object): value is ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseFromJSON(json: any): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseToJSON(json: any): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseToJSONTyped(value?: ClearVersionContentsResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const ClearVersionContentsResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/models/ClearVersionContentsResponse.js

@@ -0,0 +1,52 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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.ClearVersionContentsResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfClearVersionContentsResponse = instanceOfClearVersionContentsResponse;
+exports.ClearVersionContentsResponseFromJSON = ClearVersionContentsResponseFromJSON;
+exports.ClearVersionContentsResponseFromJSONTyped = ClearVersionContentsResponseFromJSONTyped;
+exports.ClearVersionContentsResponseToJSON = ClearVersionContentsResponseToJSON;
+exports.ClearVersionContentsResponseToJSONTyped = ClearVersionContentsResponseToJSONTyped;
+/**
+ * Check if a given object implements the ClearVersionContentsResponse interface.
+ */
+function instanceOfClearVersionContentsResponse(value) {
+    if (!('deleted' in value) || value['deleted'] === undefined)
+        return false;
+    return true;
+}
+function ClearVersionContentsResponseFromJSON(json) {
+    return ClearVersionContentsResponseFromJSONTyped(json, false);
+}
+function ClearVersionContentsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'deleted': json['deleted'],
+    };
+}
+function ClearVersionContentsResponseToJSON(json) {
+    return ClearVersionContentsResponseToJSONTyped(json, false);
+}
+function ClearVersionContentsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted': value['deleted'],
+    };
+}
+exports.ClearVersionContentsResponsePropertyValidationAttributesMap = {};

package/dist/models/DocumentType.d.ts

@@ -15,6 +15,7 @@
  */
 export declare const DocumentType: {
     readonly Pdf: "PDF";
+    readonly Docx: "DOCX";
     readonly Unknown: "UNKNOWN";
 };
 export type DocumentType = typeof DocumentType[keyof typeof DocumentType];

package/dist/models/DocumentType.js

@@ -25,6 +25,7 @@ exports.DocumentTypeToJSONTyped = DocumentTypeToJSONTyped;
  */
 exports.DocumentType = {
     Pdf: 'PDF',
+    Docx: 'DOCX',
     Unknown: 'UNKNOWN'
 };
 function instanceOfDocumentType(value) {

package/dist/models/index.d.ts

@@ -4,6 +4,7 @@ export * from './ChunkMetadataOutput';
 export * from './ChunkResponse';
 export * from './ChunkSearchRequest';
 export * from './ChunkType';
+export * from './ClearVersionContentsResponse';
 export * from './CreateChunkLineageRequest';
 export * from './CreateChunkRequest';
 export * from './CreateDocumentRequest';

package/dist/models/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./ChunkMetadataOutput"), exports);
 __exportStar(require("./ChunkResponse"), exports);
 __exportStar(require("./ChunkSearchRequest"), exports);
 __exportStar(require("./ChunkType"), exports);
+__exportStar(require("./ClearVersionContentsResponse"), exports);
 __exportStar(require("./CreateChunkLineageRequest"), exports);
 __exportStar(require("./CreateChunkRequest"), exports);
 __exportStar(require("./CreateDocumentRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.19.4",
+  "version": "1.20.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DocumentVersionsApi.ts

@@ -15,6 +15,7 @@
 
 import * as runtime from '../runtime';
 import type {
+  ClearVersionContentsResponse,
   DocumentVersionMetadataUpdate,
   DocumentVersionResponse,
   HTTPValidationError,
@@ -22,6 +23,8 @@ import type {
   PaginatedResponseDocumentVersionResponse,
 } from '../models/index';
 import {
+    ClearVersionContentsResponseFromJSON,
+    ClearVersionContentsResponseToJSON,
     DocumentVersionMetadataUpdateFromJSON,
     DocumentVersionMetadataUpdateToJSON,
     DocumentVersionResponseFromJSON,
@@ -34,6 +37,11 @@ import {
     PaginatedResponseDocumentVersionResponseToJSON,
 } from '../models/index';
 
+export interface ClearDocumentVersionContentsRequest {
+    versionId: string;
+    ksUat?: string;
+}
+
 export interface CreateDocumentVersionRequest {
     documentId: string;
     ksUat?: string;
@@ -77,6 +85,23 @@ export interface UpdateDocumentVersionMetadataRequest {
  * @interface DocumentVersionsApiInterface
  */
 export interface DocumentVersionsApiInterface {
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * @summary Clear Document Version Contents Handler
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>>;
+
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse>;
+
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * @summary Create Document Version Handler
@@ -192,6 +217,45 @@ export interface DocumentVersionsApiInterface {
  */
 export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVersionsApiInterface {
 
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    async clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>> {
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling clearDocumentVersionContents().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/document_versions/{version_id}/contents`;
+        urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClearVersionContentsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    async clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse> {
+        const response = await this.clearDocumentVersionContentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * Create Document Version Handler

package/src/apis/DocumentsApi.ts

@@ -57,7 +57,7 @@ export interface GetDocumentRequest {
 
 export interface IngestDocumentRequest {
     file: Blob;
-    folderId: string;
+    pathPartId: string;
     ksUat?: string;
     name?: string;
 }
@@ -138,7 +138,7 @@ export interface DocumentsApiInterface {
      * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
      * @summary Ingest Document Handler
      * @param {Blob} file 
-     * @param {string} folderId Parent folder ID
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {string} [ksUat] 
      * @param {string} [name] Document name (defaults to filename)
      * @param {*} [options] Override http request option.
@@ -328,10 +328,10 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
             );
         }
 
-        if (requestParameters['folderId'] == null) {
+        if (requestParameters['pathPartId'] == null) {
             throw new runtime.RequiredError(
-                'folderId',
-                'Required parameter "folderId" was null or undefined when calling ingestDocument().'
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling ingestDocument().'
             );
         }
 
@@ -359,8 +359,8 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
             formParams.append('file', requestParameters['file'] as any);
         }
 
-        if (requestParameters['folderId'] != null) {
-            formParams.append('folder_id', requestParameters['folderId'] as any);
+        if (requestParameters['pathPartId'] != null) {
+            formParams.append('path_part_id', requestParameters['pathPartId'] as any);
         }
 
         if (requestParameters['name'] != null) {

package/src/models/ChunkMetadataInput.ts

@@ -33,6 +33,12 @@ export interface ChunkMetadataInput {
      * @memberof ChunkMetadataInput
      */
     polygons?: Array<PolygonReference>;
+    /**
+     * Full s3:// URI to the visual asset for this chunk. Set for IMAGE and TABLE chunks.
+     * @type {string}
+     * @memberof ChunkMetadataInput
+     */
+    s3Url?: string;
 }
 
 /**
@@ -53,6 +59,7 @@ export function ChunkMetadataInputFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
+        's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
     };
 }
 
@@ -68,6 +75,7 @@ export function ChunkMetadataInputToJSONTyped(value?: ChunkMetadataInput | null,
     return {
         
         'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
+        's3_url': value['s3Url'],
     };
 }
 

package/src/models/ChunkMetadataOutput.ts

@@ -33,6 +33,12 @@ export interface ChunkMetadataOutput {
      * @memberof ChunkMetadataOutput
      */
     polygons?: Array<PolygonReference>;
+    /**
+     * Full s3:// URI to the visual asset for this chunk. Set for IMAGE and TABLE chunks.
+     * @type {string}
+     * @memberof ChunkMetadataOutput
+     */
+    s3Url?: string;
 }
 
 /**
@@ -53,6 +59,7 @@ export function ChunkMetadataOutputFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
+        's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
     };
 }
 
@@ -68,6 +75,7 @@ export function ChunkMetadataOutputToJSONTyped(value?: ChunkMetadataOutput | nul
     return {
         
         'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
+        's3_url': value['s3Url'],
     };
 }
 

package/src/models/ClearVersionContentsResponse.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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';
+/**
+ * Response model for the clear version contents endpoint.
+ * @export
+ * @interface ClearVersionContentsResponse
+ */
+export interface ClearVersionContentsResponse {
+    /**
+     * Number of top-level children deleted
+     * @type {number}
+     * @memberof ClearVersionContentsResponse
+     */
+    deleted: number;
+}
+
+/**
+ * Check if a given object implements the ClearVersionContentsResponse interface.
+ */
+export function instanceOfClearVersionContentsResponse(value: object): value is ClearVersionContentsResponse {
+    if (!('deleted' in value) || value['deleted'] === undefined) return false;
+    return true;
+}
+
+export function ClearVersionContentsResponseFromJSON(json: any): ClearVersionContentsResponse {
+    return ClearVersionContentsResponseFromJSONTyped(json, false);
+}
+
+export function ClearVersionContentsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClearVersionContentsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'deleted': json['deleted'],
+    };
+}
+
+export function ClearVersionContentsResponseToJSON(json: any): ClearVersionContentsResponse {
+    return ClearVersionContentsResponseToJSONTyped(json, false);
+}
+
+export function ClearVersionContentsResponseToJSONTyped(value?: ClearVersionContentsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'deleted': value['deleted'],
+    };
+}
+
+export const ClearVersionContentsResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+

package/src/models/DocumentType.ts

@@ -19,6 +19,7 @@
  */
 export const DocumentType = {
     Pdf: 'PDF',
+    Docx: 'DOCX',
     Unknown: 'UNKNOWN'
 } as const;
 export type DocumentType = typeof DocumentType[keyof typeof DocumentType];

package/src/models/index.ts

@@ -6,6 +6,7 @@ export * from './ChunkMetadataOutput';
 export * from './ChunkResponse';
 export * from './ChunkSearchRequest';
 export * from './ChunkType';
+export * from './ClearVersionContentsResponse';
 export * from './CreateChunkLineageRequest';
 export * from './CreateChunkRequest';
 export * from './CreateDocumentRequest';