@knowledge-stack/ksapi 1.7.0 → 1.8.0

package/src/apis/ChunksApi.ts

@@ -0,0 +1,381 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ChunkResponse,
+  CreateChunkRequest,
+  HTTPValidationError,
+  UpdateChunkContentRequest,
+  UpdateChunkMetadataRequest,
+} from '../models/index';
+import {
+    ChunkResponseFromJSON,
+    ChunkResponseToJSON,
+    CreateChunkRequestFromJSON,
+    CreateChunkRequestToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    UpdateChunkContentRequestFromJSON,
+    UpdateChunkContentRequestToJSON,
+    UpdateChunkMetadataRequestFromJSON,
+    UpdateChunkMetadataRequestToJSON,
+} from '../models/index';
+
+export interface CreateChunkOperationRequest {
+    createChunkRequest: CreateChunkRequest;
+    ksUat?: string;
+}
+
+export interface DeleteChunkRequest {
+    chunkId: string;
+    ksUat?: string;
+}
+
+export interface GetChunkRequest {
+    chunkId: string;
+    ksUat?: string;
+}
+
+export interface UpdateChunkContentOperationRequest {
+    chunkId: string;
+    updateChunkContentRequest: UpdateChunkContentRequest;
+    ksUat?: string;
+}
+
+export interface UpdateChunkMetadataOperationRequest {
+    chunkId: string;
+    updateChunkMetadataRequest: UpdateChunkMetadataRequest;
+    ksUat?: string;
+}
+
+/**
+ * ChunksApi - interface
+ * 
+ * @export
+ * @interface ChunksApiInterface
+ */
+export interface ChunksApiInterface {
+    /**
+     * Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+     * @summary Create Chunk Handler
+     * @param {CreateChunkRequest} createChunkRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    createChunkRaw(requestParameters: CreateChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>>;
+
+    /**
+     * Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+     * Create Chunk Handler
+     */
+    createChunk(requestParameters: CreateChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse>;
+
+    /**
+     * Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+     * @summary Delete Chunk Handler
+     * @param {string} chunkId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    deleteChunkRaw(requestParameters: DeleteChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+     * Delete Chunk Handler
+     */
+    deleteChunk(requestParameters: DeleteChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Get a chunk by its ID, including content.
+     * @summary Get Chunk Handler
+     * @param {string} chunkId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    getChunkRaw(requestParameters: GetChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>>;
+
+    /**
+     * Get a chunk by its ID, including content.
+     * Get Chunk Handler
+     */
+    getChunk(requestParameters: GetChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse>;
+
+    /**
+     * Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+     * @summary Update Chunk Content Handler
+     * @param {string} chunkId 
+     * @param {UpdateChunkContentRequest} updateChunkContentRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    updateChunkContentRaw(requestParameters: UpdateChunkContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>>;
+
+    /**
+     * Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+     * Update Chunk Content Handler
+     */
+    updateChunkContent(requestParameters: UpdateChunkContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse>;
+
+    /**
+     * Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+     * @summary Update Chunk Metadata Handler
+     * @param {string} chunkId 
+     * @param {UpdateChunkMetadataRequest} updateChunkMetadataRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    updateChunkMetadataRaw(requestParameters: UpdateChunkMetadataOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>>;
+
+    /**
+     * Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+     * Update Chunk Metadata Handler
+     */
+    updateChunkMetadata(requestParameters: UpdateChunkMetadataOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse>;
+
+}
+
+/**
+ * 
+ */
+export class ChunksApi extends runtime.BaseAPI implements ChunksApiInterface {
+
+    /**
+     * Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+     * Create Chunk Handler
+     */
+    async createChunkRaw(requestParameters: CreateChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>> {
+        if (requestParameters['createChunkRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createChunkRequest',
+                'Required parameter "createChunkRequest" was null or undefined when calling createChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/chunks`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateChunkRequestToJSON(requestParameters['createChunkRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+     * Create Chunk Handler
+     */
+    async createChunk(requestParameters: CreateChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse> {
+        const response = await this.createChunkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+     * Delete Chunk Handler
+     */
+    async deleteChunkRaw(requestParameters: DeleteChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling deleteChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/chunks/{chunk_id}`;
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+     * Delete Chunk Handler
+     */
+    async deleteChunk(requestParameters: DeleteChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteChunkRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a chunk by its ID, including content.
+     * Get Chunk Handler
+     */
+    async getChunkRaw(requestParameters: GetChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling getChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/chunks/{chunk_id}`;
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a chunk by its ID, including content.
+     * Get Chunk Handler
+     */
+    async getChunk(requestParameters: GetChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse> {
+        const response = await this.getChunkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+     * Update Chunk Content Handler
+     */
+    async updateChunkContentRaw(requestParameters: UpdateChunkContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling updateChunkContent().'
+            );
+        }
+
+        if (requestParameters['updateChunkContentRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateChunkContentRequest',
+                'Required parameter "updateChunkContentRequest" was null or undefined when calling updateChunkContent().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/chunks/{chunk_id}/content`;
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateChunkContentRequestToJSON(requestParameters['updateChunkContentRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+     * Update Chunk Content Handler
+     */
+    async updateChunkContent(requestParameters: UpdateChunkContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse> {
+        const response = await this.updateChunkContentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+     * Update Chunk Metadata Handler
+     */
+    async updateChunkMetadataRaw(requestParameters: UpdateChunkMetadataOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling updateChunkMetadata().'
+            );
+        }
+
+        if (requestParameters['updateChunkMetadataRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateChunkMetadataRequest',
+                'Required parameter "updateChunkMetadataRequest" was null or undefined when calling updateChunkMetadata().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/chunks/{chunk_id}/metadata`;
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateChunkMetadataRequestToJSON(requestParameters['updateChunkMetadataRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+     * Update Chunk Metadata Handler
+     */
+    async updateChunkMetadata(requestParameters: UpdateChunkMetadataOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse> {
+        const response = await this.updateChunkMetadataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -1,6 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './AuthApi';
+export * from './ChunksApi';
 export * from './DefaultApi';
 export * from './DocumentVersionsApi';
 export * from './DocumentsApi';

package/src/models/ChunkMetadataInput.ts

@@ -0,0 +1,90 @@
+/* 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 { PolygonReference } from './PolygonReference';
+import {
+    PolygonReferenceFromJSON,
+    PolygonReferenceFromJSONTyped,
+    PolygonReferenceToJSON,
+    PolygonReferenceToJSONTyped,
+} from './PolygonReference';
+
+/**
+ * Metadata for a chunk including source document references.
+ * @export
+ * @interface ChunkMetadataInput
+ */
+export interface ChunkMetadataInput {
+    /**
+     * List of bounding boxes in the source document for the chunk, potentially from multiple areas of multiple pages.
+     * @type {Array<PolygonReference>}
+     * @memberof ChunkMetadataInput
+     */
+    polygons?: Array<PolygonReference>;
+}
+
+/**
+ * Check if a given object implements the ChunkMetadataInput interface.
+ */
+export function instanceOfChunkMetadataInput(value: object): value is ChunkMetadataInput {
+    return true;
+}
+
+export function ChunkMetadataInputFromJSON(json: any): ChunkMetadataInput {
+    return ChunkMetadataInputFromJSONTyped(json, false);
+}
+
+export function ChunkMetadataInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkMetadataInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
+    };
+}
+
+export function ChunkMetadataInputToJSON(json: any): ChunkMetadataInput {
+    return ChunkMetadataInputToJSONTyped(json, false);
+}
+
+export function ChunkMetadataInputToJSONTyped(value?: ChunkMetadataInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
+    };
+}
+
+export const ChunkMetadataInputPropertyValidationAttributesMap: {
+    [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/ChunkMetadataOutput.ts

@@ -0,0 +1,90 @@
+/* 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 { PolygonReference } from './PolygonReference';
+import {
+    PolygonReferenceFromJSON,
+    PolygonReferenceFromJSONTyped,
+    PolygonReferenceToJSON,
+    PolygonReferenceToJSONTyped,
+} from './PolygonReference';
+
+/**
+ * Metadata for a chunk including source document references.
+ * @export
+ * @interface ChunkMetadataOutput
+ */
+export interface ChunkMetadataOutput {
+    /**
+     * List of bounding boxes in the source document for the chunk, potentially from multiple areas of multiple pages.
+     * @type {Array<PolygonReference>}
+     * @memberof ChunkMetadataOutput
+     */
+    polygons?: Array<PolygonReference>;
+}
+
+/**
+ * Check if a given object implements the ChunkMetadataOutput interface.
+ */
+export function instanceOfChunkMetadataOutput(value: object): value is ChunkMetadataOutput {
+    return true;
+}
+
+export function ChunkMetadataOutputFromJSON(json: any): ChunkMetadataOutput {
+    return ChunkMetadataOutputFromJSONTyped(json, false);
+}
+
+export function ChunkMetadataOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkMetadataOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
+    };
+}
+
+export function ChunkMetadataOutputToJSON(json: any): ChunkMetadataOutput {
+    return ChunkMetadataOutputToJSONTyped(json, false);
+}
+
+export function ChunkMetadataOutputToJSONTyped(value?: ChunkMetadataOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
+    };
+}
+
+export const ChunkMetadataOutputPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+