@knowledge-stack/ksapi 1.8.0 → 1.10.0

package/dist/esm/apis/ThreadsApi.js

@@ -0,0 +1,199 @@
+/* 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 { CreateThreadRequestToJSON, PaginatedResponseThreadResponseFromJSON, ThreadResponseFromJSON, UpdateThreadRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class ThreadsApi extends runtime.BaseAPI {
+    /**
+     * Create a new thread.  If parent_path_part_id is omitted, the thread is created under the user\'s /users/{user_id}/threads/ folder (auto-provisioned if needed).
+     * Create Thread Handler
+     */
+    createThreadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createThreadRequest'] == null) {
+                throw new runtime.RequiredError('createThreadRequest', 'Required parameter "createThreadRequest" was null or undefined when calling createThread().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/threads`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateThreadRequestToJSON(requestParameters['createThreadRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a new thread.  If parent_path_part_id is omitted, the thread is created under the user\'s /users/{user_id}/threads/ folder (auto-provisioned if needed).
+     * Create Thread Handler
+     */
+    createThread(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createThreadRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted.
+     * Delete Thread Handler
+     */
+    deleteThreadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['threadId'] == null) {
+                throw new runtime.RequiredError('threadId', 'Required parameter "threadId" was null or undefined when calling deleteThread().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/threads/{thread_id}`;
+            urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted.
+     * Delete Thread Handler
+     */
+    deleteThread(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteThreadRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Get a thread by its thread ID.
+     * Get Thread Handler
+     */
+    getThreadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['threadId'] == null) {
+                throw new runtime.RequiredError('threadId', 'Required parameter "threadId" was null or undefined when calling getThread().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/threads/{thread_id}`;
+            urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a thread by its thread ID.
+     * Get Thread Handler
+     */
+    getThread(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getThreadRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List threads under a parent path_part.  When parent_path_part_id is omitted, lists the authenticated user\'s conversation threads from /users/{user_id}/threads/.
+     * List Threads Handler
+     */
+    listThreadsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['parentPathPartId'] != null) {
+                queryParameters['parent_path_part_id'] = requestParameters['parentPathPartId'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            let urlPath = `/v1/threads`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseThreadResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List threads under a parent path_part.  When parent_path_part_id is omitted, lists the authenticated user\'s conversation threads from /users/{user_id}/threads/.
+     * List Threads Handler
+     */
+    listThreads() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listThreadsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * Update Thread Handler
+     */
+    updateThreadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['threadId'] == null) {
+                throw new runtime.RequiredError('threadId', 'Required parameter "threadId" was null or undefined when calling updateThread().');
+            }
+            if (requestParameters['updateThreadRequest'] == null) {
+                throw new runtime.RequiredError('updateThreadRequest', 'Required parameter "updateThreadRequest" was null or undefined when calling updateThread().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/threads/{thread_id}`;
+            urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateThreadRequestToJSON(requestParameters['updateThreadRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * Update Thread Handler
+     */
+    updateThread(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateThreadRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -8,4 +8,6 @@ export * from './InvitesApi';
 export * from './PathPartsApi';
 export * from './SectionsApi';
 export * from './TenantsApi';
+export * from './ThreadMessagesApi';
+export * from './ThreadsApi';
 export * from './UsersApi';

package/dist/esm/apis/index.js

@@ -10,4 +10,6 @@ export * from './InvitesApi';
 export * from './PathPartsApi';
 export * from './SectionsApi';
 export * from './TenantsApi';
+export * from './ThreadMessagesApi';
+export * from './ThreadsApi';
 export * from './UsersApi';

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

@@ -0,0 +1,58 @@
+/**
+ * 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 { MessageRole } from './MessageRole';
+/**
+ * Request to create a new thread message.
+ * @export
+ * @interface CreateThreadMessageRequest
+ */
+export interface CreateThreadMessageRequest {
+    /**
+     * Role of the message author (USER, ASSISTANT, SYSTEM)
+     * @type {MessageRole}
+     * @memberof CreateThreadMessageRequest
+     */
+    role: MessageRole;
+    /**
+     * Structured message content (JSONB)
+     * @type {object}
+     * @memberof CreateThreadMessageRequest
+     */
+    content: object;
+}
+/**
+ * Check if a given object implements the CreateThreadMessageRequest interface.
+ */
+export declare function instanceOfCreateThreadMessageRequest(value: object): value is CreateThreadMessageRequest;
+export declare function CreateThreadMessageRequestFromJSON(json: any): CreateThreadMessageRequest;
+export declare function CreateThreadMessageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateThreadMessageRequest;
+export declare function CreateThreadMessageRequestToJSON(json: any): CreateThreadMessageRequest;
+export declare function CreateThreadMessageRequestToJSONTyped(value?: CreateThreadMessageRequest | null, ignoreDiscriminator?: boolean): any;
+export declare const CreateThreadMessageRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+export declare const CreateThreadMessageRequestAdditionalPropertiesValidationAttributes: {
+    maxProperties?: number;
+    minProperties?: number;
+};

package/dist/esm/models/CreateThreadMessageRequest.js

@@ -0,0 +1,50 @@
+/* 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 { MessageRoleFromJSON, MessageRoleToJSON, } from './MessageRole';
+/**
+ * Check if a given object implements the CreateThreadMessageRequest interface.
+ */
+export function instanceOfCreateThreadMessageRequest(value) {
+    if (!('role' in value) || value['role'] === undefined)
+        return false;
+    if (!('content' in value) || value['content'] === undefined)
+        return false;
+    return true;
+}
+export function CreateThreadMessageRequestFromJSON(json) {
+    return CreateThreadMessageRequestFromJSONTyped(json, false);
+}
+export function CreateThreadMessageRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'role': MessageRoleFromJSON(json['role']),
+        'content': json['content'],
+    };
+}
+export function CreateThreadMessageRequestToJSON(json) {
+    return CreateThreadMessageRequestToJSONTyped(json, false);
+}
+export function CreateThreadMessageRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'role': MessageRoleToJSON(value['role']),
+        'content': value['content'],
+    };
+}
+export const CreateThreadMessageRequestPropertyValidationAttributesMap = {};
+export const CreateThreadMessageRequestAdditionalPropertiesValidationAttributes = {};

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

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+/**
+ * Request to create a new thread.
+ * @export
+ * @interface CreateThreadRequest
+ */
+export interface CreateThreadRequest {
+    /**
+     * Parent PathPart ID. When omitted, auto-provisions and uses the user's /users/{user_id}/threads/ folder.
+     * @type {string}
+     * @memberof CreateThreadRequest
+     */
+    parentPathPartId?: string;
+    /**
+     * Thread title
+     * @type {string}
+     * @memberof CreateThreadRequest
+     */
+    title?: string;
+}
+/**
+ * Check if a given object implements the CreateThreadRequest interface.
+ */
+export declare function instanceOfCreateThreadRequest(value: object): value is CreateThreadRequest;
+export declare function CreateThreadRequestFromJSON(json: any): CreateThreadRequest;
+export declare function CreateThreadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateThreadRequest;
+export declare function CreateThreadRequestToJSON(json: any): CreateThreadRequest;
+export declare function CreateThreadRequestToJSONTyped(value?: CreateThreadRequest | null, ignoreDiscriminator?: boolean): any;
+export declare const CreateThreadRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/esm/models/CreateThreadRequest.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CreateThreadRequest interface.
+ */
+export function instanceOfCreateThreadRequest(value) {
+    return true;
+}
+export function CreateThreadRequestFromJSON(json) {
+    return CreateThreadRequestFromJSONTyped(json, false);
+}
+export function CreateThreadRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+export function CreateThreadRequestToJSON(json) {
+    return CreateThreadRequestToJSONTyped(json, false);
+}
+export function CreateThreadRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'parent_path_part_id': value['parentPathPartId'],
+        'title': value['title'],
+    };
+}
+export const CreateThreadRequestPropertyValidationAttributesMap = {
+    title: {
+        maxLength: 255,
+        minLength: 1,
+    },
+};

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

@@ -0,0 +1,119 @@
+/**
+ * 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 { PartType } from './PartType';
+import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
+import type { ChunkType } from './ChunkType';
+/**
+ * Response model for a single item in the document version contents list.
+ *
+ * Represents a section or chunk with enriched data (content, metadata)
+ * returned in depth-first logical order.
+ * @export
+ * @interface DocumentContentPathPart
+ */
+export interface DocumentContentPathPart {
+    /**
+     * PathPart ID
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    pathPartId: string;
+    /**
+     * PathPart name
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    name: string;
+    /**
+     * SECTION or CHUNK
+     * @type {PartType}
+     * @memberof DocumentContentPathPart
+     */
+    partType: PartType;
+    /**
+     * Parent PathPart ID
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    parentId: string;
+    /**
+     * Section ID or Chunk ID
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    metadataObjId: string;
+    /**
+     * Depth relative to document version root
+     * @type {number}
+     * @memberof DocumentContentPathPart
+     */
+    depth: number;
+    /**
+     * Chunk content (None for sections)
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    content?: string;
+    /**
+     * Chunk type (None for sections)
+     * @type {ChunkType}
+     * @memberof DocumentContentPathPart
+     */
+    chunkType?: ChunkType;
+    /**
+     * Chunk metadata (None for sections)
+     * @type {ChunkMetadataOutput}
+     * @memberof DocumentContentPathPart
+     */
+    chunkMetadata?: ChunkMetadataOutput;
+    /**
+     * Section page number (None for chunks)
+     * @type {number}
+     * @memberof DocumentContentPathPart
+     */
+    pageNumber?: number;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof DocumentContentPathPart
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof DocumentContentPathPart
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the DocumentContentPathPart interface.
+ */
+export declare function instanceOfDocumentContentPathPart(value: object): value is DocumentContentPathPart;
+export declare function DocumentContentPathPartFromJSON(json: any): DocumentContentPathPart;
+export declare function DocumentContentPathPartFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentContentPathPart;
+export declare function DocumentContentPathPartToJSON(json: any): DocumentContentPathPart;
+export declare function DocumentContentPathPartToJSONTyped(value?: DocumentContentPathPart | null, ignoreDiscriminator?: boolean): any;
+export declare const DocumentContentPathPartPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/esm/models/DocumentContentPathPart.js

@@ -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 { PartTypeFromJSON, PartTypeToJSON, } from './PartType';
+import { ChunkMetadataOutputFromJSON, ChunkMetadataOutputToJSON, } from './ChunkMetadataOutput';
+import { ChunkTypeFromJSON, ChunkTypeToJSON, } from './ChunkType';
+/**
+ * Check if a given object implements the DocumentContentPathPart interface.
+ */
+export function instanceOfDocumentContentPathPart(value) {
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('partType' in value) || value['partType'] === undefined)
+        return false;
+    if (!('parentId' in value) || value['parentId'] === undefined)
+        return false;
+    if (!('metadataObjId' in value) || value['metadataObjId'] === undefined)
+        return false;
+    if (!('depth' in value) || value['depth'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function DocumentContentPathPartFromJSON(json) {
+    return DocumentContentPathPartFromJSONTyped(json, false);
+}
+export function DocumentContentPathPartFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'pathPartId': json['path_part_id'],
+        'name': json['name'],
+        'partType': PartTypeFromJSON(json['part_type']),
+        'parentId': json['parent_id'],
+        'metadataObjId': json['metadata_obj_id'],
+        'depth': json['depth'],
+        'content': json['content'] == null ? undefined : json['content'],
+        'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
+        'chunkMetadata': json['chunk_metadata'] == null ? undefined : ChunkMetadataOutputFromJSON(json['chunk_metadata']),
+        'pageNumber': json['page_number'] == null ? undefined : json['page_number'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+export function DocumentContentPathPartToJSON(json) {
+    return DocumentContentPathPartToJSONTyped(json, false);
+}
+export function DocumentContentPathPartToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path_part_id': value['pathPartId'],
+        'name': value['name'],
+        'part_type': PartTypeToJSON(value['partType']),
+        'parent_id': value['parentId'],
+        'metadata_obj_id': value['metadataObjId'],
+        'depth': value['depth'],
+        'content': value['content'],
+        'chunk_type': ChunkTypeToJSON(value['chunkType']),
+        'chunk_metadata': ChunkMetadataOutputToJSON(value['chunkMetadata']),
+        'page_number': value['pageNumber'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+export const DocumentContentPathPartPropertyValidationAttributesMap = {};