@knowledge-stack/ksapi 1.15.0 → 1.16.0

package/src/models/AssumeUserResponse.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';
+/**
+ * 
+ * @export
+ * @interface AssumeUserResponse
+ */
+export interface AssumeUserResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof AssumeUserResponse
+     */
+    token: string;
+}
+
+/**
+ * Check if a given object implements the AssumeUserResponse interface.
+ */
+export function instanceOfAssumeUserResponse(value: object): value is AssumeUserResponse {
+    if (!('token' in value) || value['token'] === undefined) return false;
+    return true;
+}
+
+export function AssumeUserResponseFromJSON(json: any): AssumeUserResponse {
+    return AssumeUserResponseFromJSONTyped(json, false);
+}
+
+export function AssumeUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssumeUserResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'token': json['token'],
+    };
+}
+
+export function AssumeUserResponseToJSON(json: any): AssumeUserResponse {
+    return AssumeUserResponseToJSONTyped(json, false);
+}
+
+export function AssumeUserResponseToJSONTyped(value?: AssumeUserResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'token': value['token'],
+    };
+}
+
+export const AssumeUserResponsePropertyValidationAttributesMap: {
+    [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/DocumentVersionMetadata.ts

@@ -0,0 +1,143 @@
+/* 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';
+import type { PipelineState } from './PipelineState';
+import {
+    PipelineStateFromJSON,
+    PipelineStateFromJSONTyped,
+    PipelineStateToJSON,
+    PipelineStateToJSONTyped,
+} from './PipelineState';
+
+/**
+ * Schema for document_version.metadata JSONB field.
+ * 
+ * Tracks S3 URLs for generated artifacts, pipeline execution state,
+ * and document statistics. Convention-based paths (images, page screenshots)
+ * are derived from document_id/document_version_id via s3_paths helpers,
+ * using a flat S3 layout: documents/{document_id}/{document_version_id}/...
+ * @export
+ * @interface DocumentVersionMetadata
+ */
+export interface DocumentVersionMetadata {
+    /**
+     * S3 URL to the source document (set by API on upload)
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    sourceS3?: string;
+    /**
+     * S3 URL to watermark-removed source document
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    cleanedSourceS3?: string;
+    /**
+     * S3 URL to the Docling JSON conversion output
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    doclingJsonS3?: string;
+    /**
+     * Current state of the ingestion pipeline workflow
+     * @type {PipelineState}
+     * @memberof DocumentVersionMetadata
+     */
+    pipelineState?: PipelineState;
+    /**
+     * Total number of pages in the document
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    totalPages?: number;
+    /**
+     * Total number of sections created
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    totalSections?: number;
+    /**
+     * Total number of chunks created
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    totalChunks?: number;
+}
+
+/**
+ * Check if a given object implements the DocumentVersionMetadata interface.
+ */
+export function instanceOfDocumentVersionMetadata(value: object): value is DocumentVersionMetadata {
+    return true;
+}
+
+export function DocumentVersionMetadataFromJSON(json: any): DocumentVersionMetadata {
+    return DocumentVersionMetadataFromJSONTyped(json, false);
+}
+
+export function DocumentVersionMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionMetadata {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
+        'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
+        'doclingJsonS3': json['docling_json_s3'] == null ? undefined : json['docling_json_s3'],
+        'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
+        'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
+        'totalSections': json['total_sections'] == null ? undefined : json['total_sections'],
+        'totalChunks': json['total_chunks'] == null ? undefined : json['total_chunks'],
+    };
+}
+
+export function DocumentVersionMetadataToJSON(json: any): DocumentVersionMetadata {
+    return DocumentVersionMetadataToJSONTyped(json, false);
+}
+
+export function DocumentVersionMetadataToJSONTyped(value?: DocumentVersionMetadata | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'source_s3': value['sourceS3'],
+        'cleaned_source_s3': value['cleanedSourceS3'],
+        'docling_json_s3': value['doclingJsonS3'],
+        'pipeline_state': PipelineStateToJSON(value['pipelineState']),
+        'total_pages': value['totalPages'],
+        'total_sections': value['totalSections'],
+        'total_chunks': value['totalChunks'],
+    };
+}
+
+export const DocumentVersionMetadataPropertyValidationAttributesMap: {
+    [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/DocumentVersionMetadataUpdate.ts

@@ -0,0 +1,141 @@
+/* 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';
+import type { PipelineState } from './PipelineState';
+import {
+    PipelineStateFromJSON,
+    PipelineStateFromJSONTyped,
+    PipelineStateToJSON,
+    PipelineStateToJSONTyped,
+} from './PipelineState';
+
+/**
+ * Partial update schema for document version metadata.
+ * 
+ * All fields are optional.  Only non-``None`` fields are merged into
+ * the existing metadata dict.
+ * @export
+ * @interface DocumentVersionMetadataUpdate
+ */
+export interface DocumentVersionMetadataUpdate {
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    sourceS3?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    cleanedSourceS3?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    doclingJsonS3?: string;
+    /**
+     * 
+     * @type {PipelineState}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    pipelineState?: PipelineState;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    totalPages?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    totalSections?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    totalChunks?: number;
+}
+
+/**
+ * Check if a given object implements the DocumentVersionMetadataUpdate interface.
+ */
+export function instanceOfDocumentVersionMetadataUpdate(value: object): value is DocumentVersionMetadataUpdate {
+    return true;
+}
+
+export function DocumentVersionMetadataUpdateFromJSON(json: any): DocumentVersionMetadataUpdate {
+    return DocumentVersionMetadataUpdateFromJSONTyped(json, false);
+}
+
+export function DocumentVersionMetadataUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionMetadataUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
+        'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
+        'doclingJsonS3': json['docling_json_s3'] == null ? undefined : json['docling_json_s3'],
+        'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
+        'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
+        'totalSections': json['total_sections'] == null ? undefined : json['total_sections'],
+        'totalChunks': json['total_chunks'] == null ? undefined : json['total_chunks'],
+    };
+}
+
+export function DocumentVersionMetadataUpdateToJSON(json: any): DocumentVersionMetadataUpdate {
+    return DocumentVersionMetadataUpdateToJSONTyped(json, false);
+}
+
+export function DocumentVersionMetadataUpdateToJSONTyped(value?: DocumentVersionMetadataUpdate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'source_s3': value['sourceS3'],
+        'cleaned_source_s3': value['cleanedSourceS3'],
+        'docling_json_s3': value['doclingJsonS3'],
+        'pipeline_state': PipelineStateToJSON(value['pipelineState']),
+        'total_pages': value['totalPages'],
+        'total_sections': value['totalSections'],
+        'total_chunks': value['totalChunks'],
+    };
+}
+
+export const DocumentVersionMetadataUpdatePropertyValidationAttributesMap: {
+    [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/DocumentVersionResponse.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { DocumentVersionMetadata } from './DocumentVersionMetadata';
+import {
+    DocumentVersionMetadataFromJSON,
+    DocumentVersionMetadataFromJSONTyped,
+    DocumentVersionMetadataToJSON,
+    DocumentVersionMetadataToJSONTyped,
+} from './DocumentVersionMetadata';
+
 /**
  * DocumentVersion response model.
  * 
@@ -76,6 +84,18 @@ export interface DocumentVersionResponse {
      * @memberof DocumentVersionResponse
      */
     updatedAt: Date;
+    /**
+     * Presigned URL to download the source document (6-hour validity)
+     * @type {string}
+     * @memberof DocumentVersionResponse
+     */
+    assetS3Url?: string;
+    /**
+     * Version metadata (S3 artifacts, pipeline state, statistics)
+     * @type {DocumentVersionMetadata}
+     * @memberof DocumentVersionResponse
+     */
+    metadata?: DocumentVersionMetadata;
 }
 
 /**
@@ -113,6 +133,8 @@ export function DocumentVersionResponseFromJSONTyped(json: any, ignoreDiscrimina
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
+        'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
+        'metadata': json['metadata'] == null ? undefined : DocumentVersionMetadataFromJSON(json['metadata']),
     };
 }
 
@@ -136,6 +158,8 @@ export function DocumentVersionResponseToJSONTyped(value?: DocumentVersionRespon
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
+        'asset_s3_url': value['assetS3Url'],
+        'metadata': DocumentVersionMetadataToJSON(value['metadata']),
     };
 }
 

package/src/models/IngestDocumentResponse.ts

@@ -0,0 +1,101 @@
+/* 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 with workflow execution details.
+ * @export
+ * @interface IngestDocumentResponse
+ */
+export interface IngestDocumentResponse {
+    /**
+     * Temporal workflow ID
+     * @type {string}
+     * @memberof IngestDocumentResponse
+     */
+    workflowId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IngestDocumentResponse
+     */
+    documentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IngestDocumentResponse
+     */
+    documentVersionId: string;
+}
+
+/**
+ * Check if a given object implements the IngestDocumentResponse interface.
+ */
+export function instanceOfIngestDocumentResponse(value: object): value is IngestDocumentResponse {
+    if (!('workflowId' in value) || value['workflowId'] === undefined) return false;
+    if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    if (!('documentVersionId' in value) || value['documentVersionId'] === undefined) return false;
+    return true;
+}
+
+export function IngestDocumentResponseFromJSON(json: any): IngestDocumentResponse {
+    return IngestDocumentResponseFromJSONTyped(json, false);
+}
+
+export function IngestDocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IngestDocumentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'workflowId': json['workflow_id'],
+        'documentId': json['document_id'],
+        'documentVersionId': json['document_version_id'],
+    };
+}
+
+export function IngestDocumentResponseToJSON(json: any): IngestDocumentResponse {
+    return IngestDocumentResponseToJSONTyped(json, false);
+}
+
+export function IngestDocumentResponseToJSONTyped(value?: IngestDocumentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'workflow_id': value['workflowId'],
+        'document_id': value['documentId'],
+        'document_version_id': value['documentVersionId'],
+    };
+}
+
+export const IngestDocumentResponsePropertyValidationAttributesMap: {
+    [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/PipelineState.ts

@@ -0,0 +1,134 @@
+/* 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';
+import type { PipelineStatus } from './PipelineStatus';
+import {
+    PipelineStatusFromJSON,
+    PipelineStatusFromJSONTyped,
+    PipelineStatusToJSON,
+    PipelineStatusToJSONTyped,
+} from './PipelineStatus';
+
+/**
+ * Pipeline execution state tracking.
+ * @export
+ * @interface PipelineState
+ */
+export interface PipelineState {
+    /**
+     * Current status of the ingestion pipeline
+     * @type {PipelineStatus}
+     * @memberof PipelineState
+     */
+    status: PipelineStatus;
+    /**
+     * Timestamp of the last pipeline execution attempt
+     * @type {Date}
+     * @memberof PipelineState
+     */
+    lastRunTimestamp: Date;
+    /**
+     * Name of the last activity that executed (e.g., 'docling_conversion')
+     * @type {string}
+     * @memberof PipelineState
+     */
+    lastActivity?: string;
+    /**
+     * Error message if pipeline failed
+     * @type {string}
+     * @memberof PipelineState
+     */
+    error?: string;
+    /**
+     * Temporal workflow ID for tracking the ingestion run
+     * @type {string}
+     * @memberof PipelineState
+     */
+    temporalWorkflowId?: string;
+    /**
+     * Number of chunks processed (for progress tracking)
+     * @type {number}
+     * @memberof PipelineState
+     */
+    chunksProcessed?: number;
+}
+
+
+
+/**
+ * Check if a given object implements the PipelineState interface.
+ */
+export function instanceOfPipelineState(value: object): value is PipelineState {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('lastRunTimestamp' in value) || value['lastRunTimestamp'] === undefined) return false;
+    return true;
+}
+
+export function PipelineStateFromJSON(json: any): PipelineState {
+    return PipelineStateFromJSONTyped(json, false);
+}
+
+export function PipelineStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineState {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': PipelineStatusFromJSON(json['status']),
+        'lastRunTimestamp': (new Date(json['last_run_timestamp'])),
+        'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'temporalWorkflowId': json['temporal_workflow_id'] == null ? undefined : json['temporal_workflow_id'],
+        'chunksProcessed': json['chunks_processed'] == null ? undefined : json['chunks_processed'],
+    };
+}
+
+export function PipelineStateToJSON(json: any): PipelineState {
+    return PipelineStateToJSONTyped(json, false);
+}
+
+export function PipelineStateToJSONTyped(value?: PipelineState | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': PipelineStatusToJSON(value['status']),
+        'last_run_timestamp': value['lastRunTimestamp'].toISOString(),
+        'last_activity': value['lastActivity'],
+        'error': value['error'],
+        'temporal_workflow_id': value['temporalWorkflowId'],
+        'chunks_processed': value['chunksProcessed'],
+    };
+}
+
+export const PipelineStatePropertyValidationAttributesMap: {
+    [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/PipelineStatus.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+
+/**
+ * Status of the ingestion pipeline workflow.
+ * @export
+ */
+export const PipelineStatus = {
+    Pending: 'pending',
+    Processing: 'processing',
+    Completed: 'completed',
+    Failed: 'failed'
+} as const;
+export type PipelineStatus = typeof PipelineStatus[keyof typeof PipelineStatus];
+
+
+export function instanceOfPipelineStatus(value: any): boolean {
+    for (const key in PipelineStatus) {
+        if (Object.prototype.hasOwnProperty.call(PipelineStatus, key)) {
+            if (PipelineStatus[key as keyof typeof PipelineStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PipelineStatusFromJSON(json: any): PipelineStatus {
+    return PipelineStatusFromJSONTyped(json, false);
+}
+
+export function PipelineStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineStatus {
+    return json as PipelineStatus;
+}
+
+export function PipelineStatusToJSON(value?: PipelineStatus | null): any {
+    return value as any;
+}
+
+export function PipelineStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): PipelineStatus {
+    return value as PipelineStatus;
+}
+