@knowledge-stack/ksapi 1.10.0 → 1.11.1

package/src/apis/ChunkLineagesApi.ts

@@ -0,0 +1,254 @@
+/* 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 {
+  ChunkLineageResponse,
+  CreateChunkLineageRequest,
+  HTTPValidationError,
+  LineageGraphResponse,
+} from '../models/index';
+import {
+    ChunkLineageResponseFromJSON,
+    ChunkLineageResponseToJSON,
+    CreateChunkLineageRequestFromJSON,
+    CreateChunkLineageRequestToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    LineageGraphResponseFromJSON,
+    LineageGraphResponseToJSON,
+} from '../models/index';
+
+export interface CreateChunkLineageOperationRequest {
+    createChunkLineageRequest: CreateChunkLineageRequest;
+    ksUat?: string;
+}
+
+export interface DeleteChunkLineageRequest {
+    parentChunkId: string;
+    chunkId: string;
+    ksUat?: string;
+}
+
+export interface GetChunkLineageRequest {
+    chunkId: string;
+    maxDepth?: number;
+    ksUat?: string;
+}
+
+/**
+ * ChunkLineagesApi - interface
+ * 
+ * @export
+ * @interface ChunkLineagesApiInterface
+ */
+export interface ChunkLineagesApiInterface {
+    /**
+     * Batch-create lineage edges for a child chunk.  Creates edges from each parent chunk to the specified child chunk. All chunks must exist in the same tenant.
+     * @summary Create Chunk Lineage Handler
+     * @param {CreateChunkLineageRequest} createChunkLineageRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunkLineagesApiInterface
+     */
+    createChunkLineageRaw(requestParameters: CreateChunkLineageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ChunkLineageResponse>>>;
+
+    /**
+     * Batch-create lineage edges for a child chunk.  Creates edges from each parent chunk to the specified child chunk. All chunks must exist in the same tenant.
+     * Create Chunk Lineage Handler
+     */
+    createChunkLineage(requestParameters: CreateChunkLineageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ChunkLineageResponse>>;
+
+    /**
+     * Delete a single lineage edge between parent and child chunks.
+     * @summary Delete Chunk Lineage Handler
+     * @param {string} parentChunkId Parent chunk ID
+     * @param {string} chunkId Child chunk ID
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunkLineagesApiInterface
+     */
+    deleteChunkLineageRaw(requestParameters: DeleteChunkLineageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete a single lineage edge between parent and child chunks.
+     * Delete Chunk Lineage Handler
+     */
+    deleteChunkLineage(requestParameters: DeleteChunkLineageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Get lineage graph for a chunk.  Traverses both ancestors and descendants up to max_depth, returning enriched nodes and edges.
+     * @summary Get Chunk Lineage Handler
+     * @param {string} chunkId 
+     * @param {number} [maxDepth] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunkLineagesApiInterface
+     */
+    getChunkLineageRaw(requestParameters: GetChunkLineageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LineageGraphResponse>>;
+
+    /**
+     * Get lineage graph for a chunk.  Traverses both ancestors and descendants up to max_depth, returning enriched nodes and edges.
+     * Get Chunk Lineage Handler
+     */
+    getChunkLineage(requestParameters: GetChunkLineageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LineageGraphResponse>;
+
+}
+
+/**
+ * 
+ */
+export class ChunkLineagesApi extends runtime.BaseAPI implements ChunkLineagesApiInterface {
+
+    /**
+     * Batch-create lineage edges for a child chunk.  Creates edges from each parent chunk to the specified child chunk. All chunks must exist in the same tenant.
+     * Create Chunk Lineage Handler
+     */
+    async createChunkLineageRaw(requestParameters: CreateChunkLineageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ChunkLineageResponse>>> {
+        if (requestParameters['createChunkLineageRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createChunkLineageRequest',
+                'Required parameter "createChunkLineageRequest" was null or undefined when calling createChunkLineage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/chunk-lineages`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateChunkLineageRequestToJSON(requestParameters['createChunkLineageRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ChunkLineageResponseFromJSON));
+    }
+
+    /**
+     * Batch-create lineage edges for a child chunk.  Creates edges from each parent chunk to the specified child chunk. All chunks must exist in the same tenant.
+     * Create Chunk Lineage Handler
+     */
+    async createChunkLineage(requestParameters: CreateChunkLineageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ChunkLineageResponse>> {
+        const response = await this.createChunkLineageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a single lineage edge between parent and child chunks.
+     * Delete Chunk Lineage Handler
+     */
+    async deleteChunkLineageRaw(requestParameters: DeleteChunkLineageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['parentChunkId'] == null) {
+            throw new runtime.RequiredError(
+                'parentChunkId',
+                'Required parameter "parentChunkId" was null or undefined when calling deleteChunkLineage().'
+            );
+        }
+
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling deleteChunkLineage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['parentChunkId'] != null) {
+            queryParameters['parent_chunk_id'] = requestParameters['parentChunkId'];
+        }
+
+        if (requestParameters['chunkId'] != null) {
+            queryParameters['chunk_id'] = requestParameters['chunkId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/chunk-lineages`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a single lineage edge between parent and child chunks.
+     * Delete Chunk Lineage Handler
+     */
+    async deleteChunkLineage(requestParameters: DeleteChunkLineageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteChunkLineageRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get lineage graph for a chunk.  Traverses both ancestors and descendants up to max_depth, returning enriched nodes and edges.
+     * Get Chunk Lineage Handler
+     */
+    async getChunkLineageRaw(requestParameters: GetChunkLineageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LineageGraphResponse>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling getChunkLineage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['maxDepth'] != null) {
+            queryParameters['max_depth'] = requestParameters['maxDepth'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/chunk-lineages/{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) => LineageGraphResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get lineage graph for a chunk.  Traverses both ancestors and descendants up to max_depth, returning enriched nodes and edges.
+     * Get Chunk Lineage Handler
+     */
+    async getChunkLineage(requestParameters: GetChunkLineageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LineageGraphResponse> {
+        const response = await this.getChunkLineageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

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

package/src/models/ChunkLineageResponse.ts

@@ -0,0 +1,110 @@
+/* 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';
+/**
+ * Single chunk lineage edge response.
+ * @export
+ * @interface ChunkLineageResponse
+ */
+export interface ChunkLineageResponse {
+    /**
+     * Parent chunk ID
+     * @type {string}
+     * @memberof ChunkLineageResponse
+     */
+    parentChunkId: string;
+    /**
+     * Child chunk ID
+     * @type {string}
+     * @memberof ChunkLineageResponse
+     */
+    chunkId: string;
+    /**
+     * Tenant ID
+     * @type {string}
+     * @memberof ChunkLineageResponse
+     */
+    tenantId: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof ChunkLineageResponse
+     */
+    createdAt: Date;
+}
+
+/**
+ * Check if a given object implements the ChunkLineageResponse interface.
+ */
+export function instanceOfChunkLineageResponse(value: object): value is ChunkLineageResponse {
+    if (!('parentChunkId' in value) || value['parentChunkId'] === undefined) return false;
+    if (!('chunkId' in value) || value['chunkId'] === undefined) return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function ChunkLineageResponseFromJSON(json: any): ChunkLineageResponse {
+    return ChunkLineageResponseFromJSONTyped(json, false);
+}
+
+export function ChunkLineageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkLineageResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'parentChunkId': json['parent_chunk_id'],
+        'chunkId': json['chunk_id'],
+        'tenantId': json['tenant_id'],
+        'createdAt': (new Date(json['created_at'])),
+    };
+}
+
+export function ChunkLineageResponseToJSON(json: any): ChunkLineageResponse {
+    return ChunkLineageResponseToJSONTyped(json, false);
+}
+
+export function ChunkLineageResponseToJSONTyped(value?: ChunkLineageResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'parent_chunk_id': value['parentChunkId'],
+        'chunk_id': value['chunkId'],
+        'tenant_id': value['tenantId'],
+        'created_at': value['createdAt'].toISOString(),
+    };
+}
+
+export const ChunkLineageResponsePropertyValidationAttributesMap: {
+    [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/CreateChunkLineageRequest.ts

@@ -0,0 +1,96 @@
+/* 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';
+/**
+ * Request to batch-create lineage edges for a child chunk.
+ * @export
+ * @interface CreateChunkLineageRequest
+ */
+export interface CreateChunkLineageRequest {
+    /**
+     * Child chunk ID
+     * @type {string}
+     * @memberof CreateChunkLineageRequest
+     */
+    chunkId: string;
+    /**
+     * List of parent chunk IDs
+     * @type {Array<string>}
+     * @memberof CreateChunkLineageRequest
+     */
+    parentChunkIds: Array<string>;
+}
+
+/**
+ * Check if a given object implements the CreateChunkLineageRequest interface.
+ */
+export function instanceOfCreateChunkLineageRequest(value: object): value is CreateChunkLineageRequest {
+    if (!('chunkId' in value) || value['chunkId'] === undefined) return false;
+    if (!('parentChunkIds' in value) || value['parentChunkIds'] === undefined) return false;
+    return true;
+}
+
+export function CreateChunkLineageRequestFromJSON(json: any): CreateChunkLineageRequest {
+    return CreateChunkLineageRequestFromJSONTyped(json, false);
+}
+
+export function CreateChunkLineageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateChunkLineageRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'chunkId': json['chunk_id'],
+        'parentChunkIds': json['parent_chunk_ids'],
+    };
+}
+
+export function CreateChunkLineageRequestToJSON(json: any): CreateChunkLineageRequest {
+    return CreateChunkLineageRequestToJSONTyped(json, false);
+}
+
+export function CreateChunkLineageRequestToJSONTyped(value?: CreateChunkLineageRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'chunk_id': value['chunkId'],
+        'parent_chunk_ids': value['parentChunkIds'],
+    };
+}
+
+export const CreateChunkLineageRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    parentChunkIds: {
+        minItems: 1,
+        uniqueItems: false,
+    },
+}
+

package/src/models/LineageEdgeResponse.ts

@@ -0,0 +1,92 @@
+/* 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';
+/**
+ * An edge in the lineage graph.
+ * @export
+ * @interface LineageEdgeResponse
+ */
+export interface LineageEdgeResponse {
+    /**
+     * Parent chunk ID (source)
+     * @type {string}
+     * @memberof LineageEdgeResponse
+     */
+    parentChunkId: string;
+    /**
+     * Child chunk ID (derived)
+     * @type {string}
+     * @memberof LineageEdgeResponse
+     */
+    chunkId: string;
+}
+
+/**
+ * Check if a given object implements the LineageEdgeResponse interface.
+ */
+export function instanceOfLineageEdgeResponse(value: object): value is LineageEdgeResponse {
+    if (!('parentChunkId' in value) || value['parentChunkId'] === undefined) return false;
+    if (!('chunkId' in value) || value['chunkId'] === undefined) return false;
+    return true;
+}
+
+export function LineageEdgeResponseFromJSON(json: any): LineageEdgeResponse {
+    return LineageEdgeResponseFromJSONTyped(json, false);
+}
+
+export function LineageEdgeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LineageEdgeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'parentChunkId': json['parent_chunk_id'],
+        'chunkId': json['chunk_id'],
+    };
+}
+
+export function LineageEdgeResponseToJSON(json: any): LineageEdgeResponse {
+    return LineageEdgeResponseToJSONTyped(json, false);
+}
+
+export function LineageEdgeResponseToJSONTyped(value?: LineageEdgeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'parent_chunk_id': value['parentChunkId'],
+        'chunk_id': value['chunkId'],
+    };
+}
+
+export const LineageEdgeResponsePropertyValidationAttributesMap: {
+    [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/LineageGraphResponse.ts

@@ -0,0 +1,107 @@
+/* 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 { LineageEdgeResponse } from './LineageEdgeResponse';
+import {
+    LineageEdgeResponseFromJSON,
+    LineageEdgeResponseFromJSONTyped,
+    LineageEdgeResponseToJSON,
+    LineageEdgeResponseToJSONTyped,
+} from './LineageEdgeResponse';
+import type { LineageNodeResponse } from './LineageNodeResponse';
+import {
+    LineageNodeResponseFromJSON,
+    LineageNodeResponseFromJSONTyped,
+    LineageNodeResponseToJSON,
+    LineageNodeResponseToJSONTyped,
+} from './LineageNodeResponse';
+
+/**
+ * Complete lineage graph with nodes and edges.
+ * @export
+ * @interface LineageGraphResponse
+ */
+export interface LineageGraphResponse {
+    /**
+     * Chunk nodes in the graph
+     * @type {Array<LineageNodeResponse>}
+     * @memberof LineageGraphResponse
+     */
+    nodes: Array<LineageNodeResponse>;
+    /**
+     * Lineage edges in the graph
+     * @type {Array<LineageEdgeResponse>}
+     * @memberof LineageGraphResponse
+     */
+    edges: Array<LineageEdgeResponse>;
+}
+
+/**
+ * Check if a given object implements the LineageGraphResponse interface.
+ */
+export function instanceOfLineageGraphResponse(value: object): value is LineageGraphResponse {
+    if (!('nodes' in value) || value['nodes'] === undefined) return false;
+    if (!('edges' in value) || value['edges'] === undefined) return false;
+    return true;
+}
+
+export function LineageGraphResponseFromJSON(json: any): LineageGraphResponse {
+    return LineageGraphResponseFromJSONTyped(json, false);
+}
+
+export function LineageGraphResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LineageGraphResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'nodes': ((json['nodes'] as Array<any>).map(LineageNodeResponseFromJSON)),
+        'edges': ((json['edges'] as Array<any>).map(LineageEdgeResponseFromJSON)),
+    };
+}
+
+export function LineageGraphResponseToJSON(json: any): LineageGraphResponse {
+    return LineageGraphResponseToJSONTyped(json, false);
+}
+
+export function LineageGraphResponseToJSONTyped(value?: LineageGraphResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'nodes': ((value['nodes'] as Array<any>).map(LineageNodeResponseToJSON)),
+        'edges': ((value['edges'] as Array<any>).map(LineageEdgeResponseToJSON)),
+    };
+}
+
+export const LineageGraphResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+