@knowledge-stack/ksapi 1.83.0 → 1.84.0

package/dist/esm/apis/WorkflowMemoryApi.js

@@ -0,0 +1,262 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { AppendMemoryChunkRequestToJSON, EditMemoryChunkRequestToJSON, ListMemoryChunksResponseFromJSON, MemoryChunkResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class WorkflowMemoryApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for appendWorkflowMemoryChunk without sending the request
+     */
+    appendWorkflowMemoryChunkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['definitionId'] == null) {
+                throw new runtime.RequiredError('definitionId', 'Required parameter "definitionId" was null or undefined when calling appendWorkflowMemoryChunk().');
+            }
+            if (requestParameters['appendMemoryChunkRequest'] == null) {
+                throw new runtime.RequiredError('appendMemoryChunkRequest', 'Required parameter "appendMemoryChunkRequest" was null or undefined when calling appendWorkflowMemoryChunk().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/workflow-definitions/{definition_id}/memory/chunks`;
+            urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AppendMemoryChunkRequestToJSON(requestParameters['appendMemoryChunkRequest']),
+            };
+        });
+    }
+    /**
+     * Append a new memory chunk.  Exposed for external agents (e.g. self-hosted runners) that need to capture learnings without touching the DB directly. The new chunk\'s ``chunk_id`` is server-assigned. Each call snapshots a new DocumentVersion, just like edit/forget.
+     * Append Workflow Memory Chunk Handler
+     */
+    appendWorkflowMemoryChunkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.appendWorkflowMemoryChunkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => MemoryChunkResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Append a new memory chunk.  Exposed for external agents (e.g. self-hosted runners) that need to capture learnings without touching the DB directly. The new chunk\'s ``chunk_id`` is server-assigned. Each call snapshots a new DocumentVersion, just like edit/forget.
+     * Append Workflow Memory Chunk Handler
+     */
+    appendWorkflowMemoryChunk(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.appendWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for editWorkflowMemoryChunk without sending the request
+     */
+    editWorkflowMemoryChunkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['definitionId'] == null) {
+                throw new runtime.RequiredError('definitionId', 'Required parameter "definitionId" was null or undefined when calling editWorkflowMemoryChunk().');
+            }
+            if (requestParameters['chunkId'] == null) {
+                throw new runtime.RequiredError('chunkId', 'Required parameter "chunkId" was null or undefined when calling editWorkflowMemoryChunk().');
+            }
+            if (requestParameters['editMemoryChunkRequest'] == null) {
+                throw new runtime.RequiredError('editMemoryChunkRequest', 'Required parameter "editMemoryChunkRequest" was null or undefined when calling editWorkflowMemoryChunk().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id}`;
+            urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+            urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: EditMemoryChunkRequestToJSON(requestParameters['editMemoryChunkRequest']),
+            };
+        });
+    }
+    /**
+     * Edit Workflow Memory Chunk Handler
+     */
+    editWorkflowMemoryChunkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.editWorkflowMemoryChunkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => MemoryChunkResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Edit Workflow Memory Chunk Handler
+     */
+    editWorkflowMemoryChunk(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.editWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for forgetWorkflowMemoryChunk without sending the request
+     */
+    forgetWorkflowMemoryChunkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['definitionId'] == null) {
+                throw new runtime.RequiredError('definitionId', 'Required parameter "definitionId" was null or undefined when calling forgetWorkflowMemoryChunk().');
+            }
+            if (requestParameters['chunkId'] == null) {
+                throw new runtime.RequiredError('chunkId', 'Required parameter "chunkId" was null or undefined when calling forgetWorkflowMemoryChunk().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id}`;
+            urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+            urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Forget Workflow Memory Chunk Handler
+     */
+    forgetWorkflowMemoryChunkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.forgetWorkflowMemoryChunkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Forget Workflow Memory Chunk Handler
+     */
+    forgetWorkflowMemoryChunk(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.forgetWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getWorkflowMemoryChunk without sending the request
+     */
+    getWorkflowMemoryChunkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['definitionId'] == null) {
+                throw new runtime.RequiredError('definitionId', 'Required parameter "definitionId" was null or undefined when calling getWorkflowMemoryChunk().');
+            }
+            if (requestParameters['chunkId'] == null) {
+                throw new runtime.RequiredError('chunkId', 'Required parameter "chunkId" was null or undefined when calling getWorkflowMemoryChunk().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id}`;
+            urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+            urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get Workflow Memory Chunk Handler
+     */
+    getWorkflowMemoryChunkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getWorkflowMemoryChunkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => MemoryChunkResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get Workflow Memory Chunk Handler
+     */
+    getWorkflowMemoryChunk(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listWorkflowMemoryChunks without sending the request
+     */
+    listWorkflowMemoryChunksRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['definitionId'] == null) {
+                throw new runtime.RequiredError('definitionId', 'Required parameter "definitionId" was null or undefined when calling listWorkflowMemoryChunks().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/workflow-definitions/{definition_id}/memory`;
+            urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List Workflow Memory Chunks Handler
+     */
+    listWorkflowMemoryChunksRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listWorkflowMemoryChunksRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListMemoryChunksResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List Workflow Memory Chunks Handler
+     */
+    listWorkflowMemoryChunks(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listWorkflowMemoryChunksRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -22,5 +22,6 @@ export * from './ThreadsApi';
 export * from './UserPermissionsApi';
 export * from './UsersApi';
 export * from './WorkflowDefinitionsApi';
+export * from './WorkflowMemoryApi';
 export * from './WorkflowRunsApi';
 export * from './WorkflowsApi';

package/dist/esm/apis/index.js

@@ -24,5 +24,6 @@ export * from './ThreadsApi';
 export * from './UserPermissionsApi';
 export * from './UsersApi';
 export * from './WorkflowDefinitionsApi';
+export * from './WorkflowMemoryApi';
 export * from './WorkflowRunsApi';
 export * from './WorkflowsApi';

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

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ * Body for ``POST /v1/path-parts/{path_part_id}/events``.
+ *
+ * The route requires ``can_write`` on the subject path_part. Server
+ * stamps ``id``/``tenant_id``/``actor_user_id``/``ts``/
+ * ``subject_path_part_id``; frontend supplies only ``kind`` and
+ * ``payload``. ``kind`` must NOT use a reserved server namespace —
+ * those are emitted by service code so the audit trail can't be
+ * forged by an authenticated client.
+ * @export
+ * @interface AppendEventRequest
+ */
+export interface AppendEventRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof AppendEventRequest
+     */
+    kind: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof AppendEventRequest
+     */
+    payload?: {
+        [key: string]: any;
+    };
+}
+export declare const AppendEventRequestPropertyValidationAttributesMap: {
+    [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 AppendEventRequest interface.
+ */
+export declare function instanceOfAppendEventRequest(value: object): value is AppendEventRequest;
+export declare function AppendEventRequestFromJSON(json: any): AppendEventRequest;
+export declare function AppendEventRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppendEventRequest;
+export declare function AppendEventRequestToJSON(json: any): AppendEventRequest;
+export declare function AppendEventRequestToJSONTyped(value?: AppendEventRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AppendEventRequest.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+export const AppendEventRequestPropertyValidationAttributesMap = {
+    kind: {
+        maxLength: 255,
+        minLength: 1,
+    },
+};
+/**
+ * Check if a given object implements the AppendEventRequest interface.
+ */
+export function instanceOfAppendEventRequest(value) {
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    return true;
+}
+export function AppendEventRequestFromJSON(json) {
+    return AppendEventRequestFromJSONTyped(json, false);
+}
+export function AppendEventRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'kind': json['kind'],
+        'payload': json['payload'] == null ? undefined : json['payload'],
+    };
+}
+export function AppendEventRequestToJSON(json) {
+    return AppendEventRequestToJSONTyped(json, false);
+}
+export function AppendEventRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'kind': value['kind'],
+        'payload': value['payload'],
+    };
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 type { MemoryKind } from './MemoryKind';
+/**
+ *
+ * @export
+ * @interface AppendMemoryChunkRequest
+ */
+export interface AppendMemoryChunkRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof AppendMemoryChunkRequest
+     */
+    body: string;
+    /**
+     *
+     * @type {MemoryKind}
+     * @memberof AppendMemoryChunkRequest
+     */
+    kind?: MemoryKind;
+}
+export declare const AppendMemoryChunkRequestPropertyValidationAttributesMap: {
+    [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 AppendMemoryChunkRequest interface.
+ */
+export declare function instanceOfAppendMemoryChunkRequest(value: object): value is AppendMemoryChunkRequest;
+export declare function AppendMemoryChunkRequestFromJSON(json: any): AppendMemoryChunkRequest;
+export declare function AppendMemoryChunkRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppendMemoryChunkRequest;
+export declare function AppendMemoryChunkRequestToJSON(json: any): AppendMemoryChunkRequest;
+export declare function AppendMemoryChunkRequestToJSONTyped(value?: AppendMemoryChunkRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AppendMemoryChunkRequest.js

@@ -0,0 +1,52 @@
+/* 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 { MemoryKindFromJSON, MemoryKindToJSON, } from './MemoryKind';
+export const AppendMemoryChunkRequestPropertyValidationAttributesMap = {
+    body: {
+        maxLength: 16384,
+        minLength: 1,
+    },
+};
+/**
+ * Check if a given object implements the AppendMemoryChunkRequest interface.
+ */
+export function instanceOfAppendMemoryChunkRequest(value) {
+    if (!('body' in value) || value['body'] === undefined)
+        return false;
+    return true;
+}
+export function AppendMemoryChunkRequestFromJSON(json) {
+    return AppendMemoryChunkRequestFromJSONTyped(json, false);
+}
+export function AppendMemoryChunkRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'body': json['body'],
+        'kind': json['kind'] == null ? undefined : MemoryKindFromJSON(json['kind']),
+    };
+}
+export function AppendMemoryChunkRequestToJSON(json) {
+    return AppendMemoryChunkRequestToJSONTyped(json, false);
+}
+export function AppendMemoryChunkRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'body': value['body'],
+        'kind': MemoryKindToJSON(value['kind']),
+    };
+}

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

@@ -116,17 +116,17 @@ export interface ChunkBulkResponse {
      */
     assetS3Urls?: Array<string>;
     /**
-     *
+     * Ancestor document info (populated when with_document=true)
      * @type {ChunkDocumentResponse}
      * @memberof ChunkBulkResponse
      */
-    document?: ChunkDocumentResponse;
+    document?: ChunkDocumentResponse | null;
     /**
-     *
+     * Ancestor document version info (populated when with_document=true)
      * @type {ChunkDocumentVersionResponse}
      * @memberof ChunkBulkResponse
      */
-    documentVersion?: ChunkDocumentVersionResponse;
+    documentVersion?: ChunkDocumentVersionResponse | null;
     /**
      * Ordered ancestor PathPart IDs from root to chunk
      * @type {Array<string>}

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

@@ -66,11 +66,11 @@ export interface ChunkContentItem {
      */
     chunkType?: ChunkType;
     /**
-     *
+     * Chunk metadata
      * @type {ChunkMetadata}
      * @memberof ChunkContentItem
      */
-    chunkMetadata?: ChunkMetadata;
+    chunkMetadata?: ChunkMetadata | null;
     /**
      * Full materialized path from root
      * @type {string}

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

@@ -116,17 +116,17 @@ export interface ChunkResponse {
      */
     assetS3Urls?: Array<string>;
     /**
-     *
+     * Ancestor document info (populated when with_document=true)
      * @type {ChunkDocumentResponse}
      * @memberof ChunkResponse
      */
-    document?: ChunkDocumentResponse;
+    document?: ChunkDocumentResponse | null;
     /**
-     *
+     * Ancestor document version info (populated when with_document=true)
      * @type {ChunkDocumentVersionResponse}
      * @memberof ChunkResponse
      */
-    documentVersion?: ChunkDocumentVersionResponse;
+    documentVersion?: ChunkDocumentVersionResponse | null;
 }
 export declare const ChunkResponsePropertyValidationAttributesMap: {
     [property: string]: {

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

@@ -37,11 +37,11 @@ export interface CreateThreadMessageRequest {
      */
     content: ThreadMessageContent;
     /**
-     *
+     * Message details (execution steps). Omit for user messages.
      * @type {ThreadMessageDetailsInput}
      * @memberof CreateThreadMessageRequest
      */
-    details?: ThreadMessageDetailsInput;
+    details?: ThreadMessageDetailsInput | null;
 }
 export declare const CreateThreadMessageRequestPropertyValidationAttributesMap: {
     [property: string]: {

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

@@ -47,7 +47,7 @@ export interface CreateWorkflowDefinitionRequest {
      * @type {SelfHostedRunnerConfig}
      * @memberof CreateWorkflowDefinitionRequest
      */
-    runnerConfig?: SelfHostedRunnerConfig;
+    runnerConfig?: SelfHostedRunnerConfig | null;
     /**
      *
      * @type {number}

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

@@ -51,11 +51,11 @@ export interface DocumentVersionMetadata {
      */
     hash?: string | null;
     /**
-     *
+     * Current state of the ingestion pipeline workflow
      * @type {PipelineState}
      * @memberof DocumentVersionMetadata
      */
-    pipelineState?: PipelineState;
+    pipelineState?: PipelineState | null;
     /**
      * Total number of pages in the document
      * @type {number}
@@ -103,11 +103,11 @@ export interface DocumentVersionMetadata {
         [key: string]: any;
     }> | null;
     /**
-     *
+     * Aggregate statistics for the document version (tokens, chunk counts, depth)
      * @type {InformationStatistics}
      * @memberof DocumentVersionMetadata
      */
-    informationStatistics?: InformationStatistics;
+    informationStatistics?: InformationStatistics | null;
     /**
      * True once the conversion activity successfully consumed PAGE quota
      * @type {boolean}

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

@@ -67,7 +67,7 @@ export interface DocumentVersionMetadataUpdate {
      * @type {PipelineState}
      * @memberof DocumentVersionMetadataUpdate
      */
-    pipelineState?: PipelineState;
+    pipelineState?: PipelineState | null;
     /**
      *
      * @type {number}
@@ -119,7 +119,7 @@ export interface DocumentVersionMetadataUpdate {
      * @type {InformationStatistics}
      * @memberof DocumentVersionMetadataUpdate
      */
-    informationStatistics?: InformationStatistics;
+    informationStatistics?: InformationStatistics | null;
     /**
      *
      * @type {boolean}