@usecortex_ai/node 0.1.1 → 0.2.0

package/dist/api/resources/upload/client/requests/UploadUploadTextRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/upload/client/requests/UploadVerifyProcessingRequest.d.ts

@@ -8,6 +8,8 @@
  *     }
  */
 export interface UploadVerifyProcessingRequest {
+    /** The file ID to check processing status for */
     file_id: string;
+    /** Unique identifier for the tenant/organization */
     tenant_id?: string;
 }

package/dist/api/resources/upload/client/requests/index.d.ts

@@ -3,10 +3,10 @@ export { type BodyBatchUpdateUploadBatchUpdatePatch } from "./BodyBatchUpdateUpl
 export { type BodyUploadFilesUploadUploadDocumentPost } from "./BodyUploadFilesUploadUploadDocumentPost.js";
 export { type BodyUpdateFileUploadUpdateDocumentPatch } from "./BodyUpdateFileUploadUpdateDocumentPatch.js";
 export { type UploadUploadAppSourcesRequest } from "./UploadUploadAppSourcesRequest.js";
-export { type BodyUploadMarkdownUploadUploadMarkdownPost } from "./BodyUploadMarkdownUploadUploadMarkdownPost.js";
-export { type BodyUploadMarkdownUploadUploadTextPost } from "./BodyUploadMarkdownUploadUploadTextPost.js";
-export { type BodyUpdateMarkdownUploadUpdateMarkdownPatch } from "./BodyUpdateMarkdownUploadUpdateMarkdownPatch.js";
-export { type BodyUpdateMarkdownUploadUpdateTextPatch } from "./BodyUpdateMarkdownUploadUpdateTextPatch.js";
+export { type UploadUploadMarkdownRequest } from "./UploadUploadMarkdownRequest.js";
+export { type UploadUploadTextRequest } from "./UploadUploadTextRequest.js";
+export { type UploadUpdateMarkdownRequest } from "./UploadUpdateMarkdownRequest.js";
+export { type UploadUpdateTextRequest } from "./UploadUpdateTextRequest.js";
 export { type EmbeddingsUploadRequest } from "./EmbeddingsUploadRequest.js";
 export { type EmbeddingsUpdateRequest } from "./EmbeddingsUpdateRequest.js";
 export { type UploadScrapeWebpageRequest } from "./UploadScrapeWebpageRequest.js";

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

@@ -9,7 +9,7 @@ export declare namespace User {
         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>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,12 +28,15 @@ export declare namespace User {
 }
 export declare class User {
     protected readonly _options: User.Options;
-    constructor(_options?: User.Options);
+    constructor(_options: User.Options);
     /**
-     * Create a new tenant for the authenticated user.
+     * Create a tenant for your account.
      *
-     * Returns:
-     *     TenantCreateResponse: Success response with tenant creation details
+     * Use this endpoint to initialize a tenant space you can use for ingestion, embeddings, and search. Optionally include a metadata schema to enforce consistent attributes across documents.
+     *
+     * Expected outcome
+     * - A tenant is created and returned with its identifier.
+     * - If the tenant already exists, you receive a success message with the existing identifier.
      *
      * @param {CortexAI.BodyCreateTenantUserCreateTenantPost} request
      * @param {User.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,5 +54,5 @@ export declare class User {
      */
     createTenant(request?: CortexAI.BodyCreateTenantUserCreateTenantPost, requestOptions?: User.RequestOptions): core.HttpResponsePromise<CortexAI.TenantCreateData>;
     private __createTenant;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/api/resources/user/client/Client.js

@@ -44,14 +44,17 @@ const CortexAI = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 class User {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
-     * Create a new tenant for the authenticated user.
+     * Create a tenant for your account.
      *
-     * Returns:
-     *     TenantCreateResponse: Success response with tenant creation details
+     * Use this endpoint to initialize a tenant space you can use for ingestion, embeddings, and search. Optionally include a metadata schema to enforce consistent attributes across documents.
+     *
+     * Expected outcome
+     * - A tenant is created and returned with its identifier.
+     * - If the tenant already exists, you receive a success message with the existing identifier.
      *
      * @param {CortexAI.BodyCreateTenantUserCreateTenantPost} request
      * @param {User.RequestOptions} requestOptions - Request-specific configuration.
@@ -134,11 +137,7 @@ class User {
         }
     }
     async _getAuthorizationHeader() {
-        const bearer = await core.Supplier.get(this._options.token);
-        if (bearer != null) {
-            return `Bearer ${bearer}`;
-        }
-        return undefined;
+        return `Bearer ${await core.Supplier.get(this._options.token)}`;
     }
 }
 exports.User = User;

package/dist/api/resources/user/client/requests/BodyCreateTenantUserCreateTenantPost.d.ts

@@ -6,6 +6,7 @@
  *     {}
  */
 export interface BodyCreateTenantUserCreateTenantPost {
+    /** Unique identifier for the tenant/organization */
     tenant_id?: string;
     tenant_metadata_schema?: Record<string, unknown>[];
 }

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

@@ -9,7 +9,7 @@ export declare namespace UserMemory {
         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>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,81 +28,149 @@ export declare namespace UserMemory {
 }
 export declare class UserMemory {
     protected readonly _options: UserMemory.Options;
-    constructor(_options?: UserMemory.Options);
+    constructor(_options: UserMemory.Options);
     /**
+     * Retrieve all stored user memories for your tenant.
+     *
+     * This endpoint returns a comprehensive list of all user memories that have been stored,
+     * whether they were added manually or generated through AI. User memories help personalize
+     * your experience by storing context, preferences, and important information.
+     *
+     * You can optionally specify a sub-tenant to filter memories within that specific scope.
+     *
      * @param {CortexAI.UserMemoryListUserMemoriesRequest} request
      * @param {UserMemory.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.userMemory.listUserMemories({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         tenant_id: "tenant_id"
      *     })
      */
-    listUserMemories(request: CortexAI.UserMemoryListUserMemoriesRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<unknown>;
+    listUserMemories(request: CortexAI.UserMemoryListUserMemoriesRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<CortexAI.ListUserMemoriesResponse>;
     private __listUserMemories;
     /**
+     * Permanently remove a specific user memory from storage.
+     *
+     * This endpoint allows you to delete a user memory by its unique identifier.
+     * Once deleted, the memory cannot be recovered, so use this operation carefully.
+     *
+     * The memory will be removed from your tenant's storage and will no longer
+     * appear in search results or memory listings.
+     *
      * @param {CortexAI.UserMemoryDeleteUserMemoryRequest} request
      * @param {UserMemory.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.userMemory.deleteUserMemory({
      *         tenant_id: "tenant_id",
-     *         memory_id: "memory_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         memory_id: "memory_id"
      *     })
      */
-    deleteUserMemory(request: CortexAI.UserMemoryDeleteUserMemoryRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<unknown>;
+    deleteUserMemory(request: CortexAI.UserMemoryDeleteUserMemoryRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<CortexAI.DeleteUserMemoryResponse>;
     private __deleteUserMemory;
     /**
-     * @param {CortexAI.UserMemoryRetrieveUserMemoryRequest} request
+     * Find relevant user memories using semantic search.
+     *
+     * This endpoint performs a semantic search across all your stored user memories
+     * to find the most relevant ones based on your query. The results are ranked by
+     * similarity score, with the most relevant memories returned first.
+     *
+     * Use this to recall past preferences, context, or information that might be
+     * relevant to your current task or query.
+     *
+     * @param {CortexAI.RetrieveUserMemoryRequest} request
      * @param {UserMemory.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.userMemory.retrieveUserMemory({
      *         tenant_id: "tenant_id",
-     *         query: "query",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         query: "query"
      *     })
      */
-    retrieveUserMemory(request: CortexAI.UserMemoryRetrieveUserMemoryRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<unknown>;
+    retrieveUserMemory(request: CortexAI.RetrieveUserMemoryRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<CortexAI.RetrieveUserMemoryResponse>;
     private __retrieveUserMemory;
     /**
-     * @param {CortexAI.UserMemoryGenerateUserMemoryRequest} request
+     * Generate AI-powered user memories from your query and context.
+     *
+     * This endpoint uses artificial intelligence to create personalized memories
+     * based on your query and user context. The AI analyzes your input and generates
+     * relevant, contextual memories that can help improve future interactions.
+     *
+     * Generated memories are automatically stored and can be retrieved through
+     * the standard memory search endpoints.
+     *
+     * @param {CortexAI.GenerateUserMemoryRequest} request
      * @param {UserMemory.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.userMemory.generateUserMemory({
      *         tenant_id: "tenant_id",
      *         user_query: "user_query",
-     *         user_name: "user_name",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         user_name: "user_name"
      *     })
      */
-    generateUserMemory(request: CortexAI.UserMemoryGenerateUserMemoryRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<unknown>;
+    generateUserMemory(request: CortexAI.GenerateUserMemoryRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<CortexAI.GenerateUserMemoryResponse>;
     private __generateUserMemory;
     /**
-     * @param {CortexAI.UserMemoryAddUserMemoryRequest} request
+     * Store a new user memory for future reference.
+     *
+     * This endpoint allows you to manually add a memory that will be stored and
+     * can be retrieved later through memory search. Use this to save important
+     * preferences, context, or information that you want the system to remember.
+     *
+     * The stored memory will be indexed and available for semantic search, making
+     * it accessible when relevant to future queries or interactions.
+     *
+     * @param {CortexAI.AddUserMemoryRequest} request
      * @param {UserMemory.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.userMemory.addUserMemory({
      *         tenant_id: "tenant_id",
-     *         user_memory: "user_memory",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         user_memory: "user_memory"
      *     })
      */
-    addUserMemory(request: CortexAI.UserMemoryAddUserMemoryRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<unknown>;
+    addUserMemory(request: CortexAI.AddUserMemoryRequest, requestOptions?: UserMemory.RequestOptions): core.HttpResponsePromise<CortexAI.AddUserMemoryResponse>;
     private __addUserMemory;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }