@usecortex_ai/node 0.1.0

package/dist/api/resources/upload/client/Client.d.ts

@@ -0,0 +1,369 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as CortexAI from "../../../index.js";
+export declare namespace Upload {
+    interface Options {
+        environment?: core.Supplier<environments.CortexAIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class Upload {
+    protected readonly _options: Upload.Options;
+    constructor(_options?: Upload.Options);
+    /**
+     * @param {CortexAI.BodyBatchUploadUploadBatchUploadPost} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.upload.batchUpload({
+     *         files: [fs.createReadStream("/path/to/your/file")],
+     *         tenant_id: "tenant_id"
+     *     })
+     */
+    batchUpload(request: CortexAI.BodyBatchUploadUploadBatchUploadPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.BatchUploadData>;
+    private __batchUpload;
+    /**
+     * @param {CortexAI.BodyBatchUpdateUploadBatchUpdatePatch} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.upload.batchUpdate({
+     *         files: [fs.createReadStream("/path/to/your/file")],
+     *         tenant_id: "tenant_id"
+     *     })
+     */
+    batchUpdate(request: CortexAI.BodyBatchUpdateUploadBatchUpdatePatch, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.BatchUploadData>;
+    private __batchUpdate;
+    /**
+     * @param {CortexAI.BodyUploadFilesUploadUploadDocumentPost} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.upload.uploadDocument({
+     *         file: fs.createReadStream("/path/to/your/file"),
+     *         tenant_id: "tenant_id"
+     *     })
+     */
+    uploadDocument(request: CortexAI.BodyUploadFilesUploadUploadDocumentPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __uploadDocument;
+    /**
+     * @param {CortexAI.BodyUpdateFileUploadUpdateDocumentPatch} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.upload.updateDocument({
+     *         file: fs.createReadStream("/path/to/your/file"),
+     *         source_id: "source_id",
+     *         tenant_id: "tenant_id"
+     *     })
+     */
+    updateDocument(request: CortexAI.BodyUpdateFileUploadUpdateDocumentPatch, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __updateDocument;
+    /**
+     * @param {CortexAI.UploadUploadAppSourcesRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.uploadAppSources({
+     *         tenant_id: "tenant_id",
+     *         body: [{}]
+     *     })
+     */
+    uploadAppSources(request: CortexAI.UploadUploadAppSourcesRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.AppSourcesUploadData>;
+    private __uploadAppSources;
+    /**
+     * Upload markdown content. If request.document_metadata contains a 'file_id' key (non-empty), it will be used as the file ID;
+     * otherwise, a new file_id will be generated for that file. This allows file-specific IDs to be set directly in the metadata.
+     *
+     * @param {CortexAI.UploadUploadMarkdownRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.uploadMarkdown({
+     *         tenant_id: "tenant_id",
+     *         body: {
+     *             content: "content"
+     *         }
+     *     })
+     */
+    uploadMarkdown(request: CortexAI.UploadUploadMarkdownRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __uploadMarkdown;
+    /**
+     * Upload markdown content. If request.document_metadata contains a 'file_id' key (non-empty), it will be used as the file ID;
+     * otherwise, a new file_id will be generated for that file. This allows file-specific IDs to be set directly in the metadata.
+     *
+     * @param {CortexAI.UploadUploadTextRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.uploadText({
+     *         tenant_id: "tenant_id",
+     *         body: {
+     *             content: "content"
+     *         }
+     *     })
+     */
+    uploadText(request: CortexAI.UploadUploadTextRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __uploadText;
+    /**
+     * @param {CortexAI.UploadUpdateMarkdownRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.updateMarkdown({
+     *         source_id: "source_id",
+     *         tenant_id: "tenant_id",
+     *         body: {
+     *             content: "content"
+     *         }
+     *     })
+     */
+    updateMarkdown(request: CortexAI.UploadUpdateMarkdownRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __updateMarkdown;
+    /**
+     * @param {CortexAI.UploadUpdateTextRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.updateText({
+     *         source_id: "source_id",
+     *         tenant_id: "tenant_id",
+     *         body: {
+     *             content: "content"
+     *         }
+     *     })
+     */
+    updateText(request: CortexAI.UploadUpdateTextRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __updateText;
+    /**
+     * @param {CortexAI.EmbeddingsUploadRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.uploadEmbeddings({
+     *         tenant_id: "tenant_id",
+     *         embeddings: [[1.1]]
+     *     })
+     */
+    uploadEmbeddings(request: CortexAI.EmbeddingsUploadRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __uploadEmbeddings;
+    /**
+     * @param {CortexAI.EmbeddingsUpdateRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.updateEmbeddings({
+     *         tenant_id: "tenant_id",
+     *         embeddings: {
+     *             "key": [1.1]
+     *         }
+     *     })
+     */
+    updateEmbeddings(request: CortexAI.EmbeddingsUpdateRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __updateEmbeddings;
+    /**
+     * @param {CortexAI.UploadScrapeWebpageRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.scrapeWebpage({
+     *         web_url: "web_url",
+     *         tenant_id: "tenant_id"
+     *     })
+     */
+    scrapeWebpage(request: CortexAI.UploadScrapeWebpageRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __scrapeWebpage;
+    /**
+     * @param {CortexAI.UploadUpdateWebpageRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.updateWebpage({
+     *         web_url: "web_url",
+     *         source_id: "source_id",
+     *         tenant_id: "tenant_id"
+     *     })
+     */
+    updateWebpage(request: CortexAI.UploadUpdateWebpageRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SingleUploadData>;
+    private __updateWebpage;
+    /**
+     * @param {CortexAI.DeleteMemoryRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.upload.deleteSource({
+     *         tenant_id: "tenant_id",
+     *         source_ids: ["source_ids"]
+     *     })
+     */
+    deleteSource(request: CortexAI.DeleteMemoryRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __deleteSource;
+    /**
+     * @param {CortexAI.DeleteMemoryRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.upload.deleteMemory({
+     *         tenant_id: "tenant_id",
+     *         source_ids: ["source_ids"]
+     *     })
+     */
+    deleteMemory(request: CortexAI.DeleteMemoryRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __deleteMemory;
+    /**
+     * Verify the processing status of an uploaded file.
+     *
+     * Returns:
+     *     ProcessingStatusResponse: Processing status information
+     *
+     * @param {CortexAI.UploadVerifyProcessingRequest} request
+     * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.upload.verifyProcessing({
+     *         file_id: "file_id"
+     *     })
+     */
+    verifyProcessing(request: CortexAI.UploadVerifyProcessingRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.ProcessingStatus>;
+    private __verifyProcessing;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}