@knowledge-stack/ksapi 1.66.2 → 1.66.3

package/dist/esm/apis/DocumentsApi.js

@@ -0,0 +1,429 @@
+/* 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 { CreateDocumentRequestToJSON, DocumentResponseFromJSON, IngestDocumentResponseFromJSON, PaginatedResponseDocumentResponseFromJSON, UpdateDocumentRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class DocumentsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createDocument without sending the request
+     */
+    createDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createDocumentRequest'] == null) {
+                throw new runtime.RequiredError('createDocumentRequest', 'Required parameter "createDocumentRequest" was null or undefined when calling createDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateDocumentRequestToJSON(requestParameters['createDocumentRequest']),
+            };
+        });
+    }
+    /**
+     * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
+     * Create Document Handler
+     */
+    createDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
+     * Create Document Handler
+     */
+    createDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteDocument without sending the request
+     */
+    deleteDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling deleteDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents/{document_id}`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * Delete Document Handler
+     */
+    deleteDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * Delete Document Handler
+     */
+    deleteDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteDocumentRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getDocument without sending the request
+     */
+    getDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling getDocument().');
+            }
+            const queryParameters = {};
+            if (requestParameters['withTags'] != null) {
+                queryParameters['with_tags'] = requestParameters['withTags'];
+            }
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents/{document_id}`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    getDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    getDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for ingestDocument without sending the request
+     */
+    ingestDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['file'] == null) {
+                throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestDocument().');
+            }
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling ingestDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            let useForm = false;
+            // use FormData to transmit files using content-type "multipart/form-data"
+            useForm = canConsumeForm;
+            if (useForm) {
+                formParams = new FormData();
+            }
+            else {
+                formParams = new URLSearchParams();
+            }
+            if (requestParameters['file'] != null) {
+                formParams.append('file', requestParameters['file']);
+            }
+            if (requestParameters['pathPartId'] != null) {
+                formParams.append('path_part_id', requestParameters['pathPartId']);
+            }
+            if (requestParameters['name'] != null) {
+                formParams.append('name', requestParameters['name']);
+            }
+            if (requestParameters['ingestionMode'] != null) {
+                formParams.append('ingestion_mode', requestParameters['ingestionMode']);
+            }
+            if (requestParameters['chunkType'] != null) {
+                formParams.append('chunk_type', requestParameters['chunkType']);
+            }
+            if (requestParameters['secondaryTaxonomy'] != null) {
+                formParams.append('secondary_taxonomy', requestParameters['secondaryTaxonomy']);
+            }
+            if (requestParameters['pageDpi'] != null) {
+                formParams.append('page_dpi', requestParameters['pageDpi']);
+            }
+            let urlPath = `/v1/documents/ingest`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            };
+        });
+    }
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Handler
+     */
+    ingestDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.ingestDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => IngestDocumentResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Handler
+     */
+    ingestDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.ingestDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for ingestDocumentVersion without sending the request
+     */
+    ingestDocumentVersionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling ingestDocumentVersion().');
+            }
+            if (requestParameters['file'] == null) {
+                throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestDocumentVersion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            let useForm = false;
+            // use FormData to transmit files using content-type "multipart/form-data"
+            useForm = canConsumeForm;
+            if (useForm) {
+                formParams = new FormData();
+            }
+            else {
+                formParams = new URLSearchParams();
+            }
+            if (requestParameters['file'] != null) {
+                formParams.append('file', requestParameters['file']);
+            }
+            if (requestParameters['ingestionMode'] != null) {
+                formParams.append('ingestion_mode', requestParameters['ingestionMode']);
+            }
+            if (requestParameters['chunkType'] != null) {
+                formParams.append('chunk_type', requestParameters['chunkType']);
+            }
+            if (requestParameters['secondaryTaxonomy'] != null) {
+                formParams.append('secondary_taxonomy', requestParameters['secondaryTaxonomy']);
+            }
+            if (requestParameters['pageDpi'] != null) {
+                formParams.append('page_dpi', requestParameters['pageDpi']);
+            }
+            let urlPath = `/v1/documents/{document_id}/ingest`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            };
+        });
+    }
+    /**
+     * Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Version Handler
+     */
+    ingestDocumentVersionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.ingestDocumentVersionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => IngestDocumentResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Version Handler
+     */
+    ingestDocumentVersion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.ingestDocumentVersionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listDocuments without sending the request
+     */
+    listDocumentsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['parentPathPartId'] != null) {
+                queryParameters['parent_path_part_id'] = requestParameters['parentPathPartId'];
+            }
+            if (requestParameters['sortOrder'] != null) {
+                queryParameters['sort_order'] = requestParameters['sortOrder'];
+            }
+            if (requestParameters['withTags'] != null) {
+                queryParameters['with_tags'] = requestParameters['withTags'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
+     * List Documents Handler
+     */
+    listDocumentsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listDocumentsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
+     * List Documents Handler
+     */
+    listDocuments() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listDocumentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateDocument without sending the request
+     */
+    updateDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling updateDocument().');
+            }
+            if (requestParameters['updateDocumentRequest'] == null) {
+                throw new runtime.RequiredError('updateDocumentRequest', 'Required parameter "updateDocumentRequest" was null or undefined when calling updateDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents/{document_id}`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateDocumentRequestToJSON(requestParameters['updateDocumentRequest']),
+            };
+        });
+    }
+    /**
+     * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
+     * Update Document Handler
+     */
+    updateDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
+     * Update Document Handler
+     */
+    updateDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,59 @@
+/**
+ * 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 { FeaturesResponse } from '../models/index';
+/**
+ * FeaturesApi - interface
+ *
+ * @export
+ * @interface FeaturesApiInterface
+ */
+export interface FeaturesApiInterface {
+    /**
+     * Creates request options for getFeatures without sending the request
+     * @throws {RequiredError}
+     * @memberof FeaturesApiInterface
+     */
+    getFeaturesRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Return public feature flags for the frontend.
+     * @summary Get Features Handler
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FeaturesApiInterface
+     */
+    getFeaturesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeaturesResponse>>;
+    /**
+     * Return public feature flags for the frontend.
+     * Get Features Handler
+     */
+    getFeatures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeaturesResponse>;
+}
+/**
+ *
+ */
+export declare class FeaturesApi extends runtime.BaseAPI implements FeaturesApiInterface {
+    /**
+     * Creates request options for getFeatures without sending the request
+     */
+    getFeaturesRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Return public feature flags for the frontend.
+     * Get Features Handler
+     */
+    getFeaturesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeaturesResponse>>;
+    /**
+     * Return public feature flags for the frontend.
+     * Get Features Handler
+     */
+    getFeatures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeaturesResponse>;
+}

package/dist/esm/apis/FeaturesApi.js

@@ -0,0 +1,66 @@
+/* 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 { FeaturesResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class FeaturesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getFeatures without sending the request
+     */
+    getFeaturesRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/features`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Return public feature flags for the frontend.
+     * Get Features Handler
+     */
+    getFeaturesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getFeaturesRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => FeaturesResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Return public feature flags for the frontend.
+     * Get Features Handler
+     */
+    getFeatures(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getFeaturesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+}