@usecortex_ai/node 0.1.2 → 0.2.1

package/dist/api/resources/userMemory/client/requests/RetrieveUserMemoryRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tenant_id: "tenant_id",
+ *         query: "query"
+ *     }
+ */
+export interface RetrieveUserMemoryRequest {
+    /** Unique identifier for the tenant/organization */
+    tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
+    sub_tenant_id?: string;
+    /** Maximum number of memories to return (default: 5) */
+    max_count?: number;
+    /** Search query to find relevant user memories */
+    query: string;
+}

package/dist/api/resources/userMemory/client/requests/RetrieveUserMemoryRequest.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/userMemory/client/requests/UserMemoryDeleteUserMemoryRequest.d.ts

@@ -5,12 +5,14 @@
  * @example
  *     {
  *         tenant_id: "tenant_id",
- *         memory_id: "memory_id",
- *         sub_tenant_id: "sub_tenant_id"
+ *         memory_id: "memory_id"
  *     }
  */
 export interface UserMemoryDeleteUserMemoryRequest {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
+    /** Unique identifier of the memory to delete */
     memory_id: string;
-    sub_tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
+    sub_tenant_id?: string;
 }

package/dist/api/resources/userMemory/client/requests/UserMemoryListUserMemoriesRequest.d.ts

@@ -4,11 +4,12 @@
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id",
- *         sub_tenant_id: "sub_tenant_id"
+ *         tenant_id: "tenant_id"
  *     }
  */
 export interface UserMemoryListUserMemoriesRequest {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
-    sub_tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
+    sub_tenant_id?: string;
 }

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

@@ -1,5 +1,5 @@
 export { type UserMemoryListUserMemoriesRequest } from "./UserMemoryListUserMemoriesRequest.js";
 export { type UserMemoryDeleteUserMemoryRequest } from "./UserMemoryDeleteUserMemoryRequest.js";
-export { type UserMemoryRetrieveUserMemoryRequest } from "./UserMemoryRetrieveUserMemoryRequest.js";
-export { type UserMemoryGenerateUserMemoryRequest } from "./UserMemoryGenerateUserMemoryRequest.js";
-export { type UserMemoryAddUserMemoryRequest } from "./UserMemoryAddUserMemoryRequest.js";
+export { type RetrieveUserMemoryRequest } from "./RetrieveUserMemoryRequest.js";
+export { type GenerateUserMemoryRequest } from "./GenerateUserMemoryRequest.js";
+export { type AddUserMemoryRequest } from "./AddUserMemoryRequest.js";

package/dist/api/types/AddUserMemoryResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for adding a new user memory.
+ */
+export interface AddUserMemoryResponse {
+    /** Indicates whether the memory addition operation was successful */
+    success: boolean;
+    /** Confirms whether the memory was successfully stored in the system */
+    user_memory_added: boolean;
+    /** Unique identifier assigned to the newly created memory */
+    memory_id?: string;
+}

package/dist/api/types/AddUserMemoryResponse.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/types/AppSourcesUploadData.d.ts

@@ -3,7 +3,9 @@
  */
 import * as CortexAI from "../index.js";
 export interface AppSourcesUploadData {
+    /** List of successfully uploaded app source for indexing */
     uploaded: CortexAI.FileUploadResult[];
+    /** Status message indicating app sources upload scheduled */
+    message: string;
     success?: boolean;
-    message?: string;
 }

package/dist/api/types/AttachmentModel.d.ts

@@ -3,11 +3,18 @@
  */
 import * as CortexAI from "../index.js";
 export interface AttachmentModel {
+    /** Unique identifier for the attachment. */
     id?: string;
+    /** Public or internal URL referencing the attachment resource. */
     url?: string;
+    /** Human-readable title or filename of the attachment. */
     title?: string;
+    /** MIME type of the attachment (e.g., application/pdf). */
     content_type?: string;
+    /** Direct URL for content retrieval when different from the reference URL. */
     content_url?: string;
+    /** Additional attachment attributes defined by the tenant (free-form). */
     misc?: Record<string, unknown>;
+    /** Structured content payload for the attachment when available. */
     content?: CortexAI.ContentModel;
 }

package/dist/api/types/BatchUploadData.d.ts

@@ -3,7 +3,9 @@
  */
 import * as CortexAI from "../index.js";
 export interface BatchUploadData {
+    /** List of successfully uploaded files for processing */
     uploaded: CortexAI.FileUploadResult[];
+    /** Status message indicating batch document parsing scheduled */
+    message: string;
     success?: boolean;
-    message?: string;
 }

package/dist/api/types/BodyScrapeWebpageUploadScrapeWebpagePost.d.ts

@@ -2,5 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface BodyScrapeWebpageUploadScrapeWebpagePost {
-    relations?: string;
 }

package/dist/api/types/BodyUpdateScrapeJobUploadUpdateWebpagePatch.d.ts

@@ -2,5 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface BodyUpdateScrapeJobUploadUpdateWebpagePatch {
-    relations?: string;
 }

package/dist/api/types/ContentModel.d.ts

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ContentModel {
+    /** Plain text content extracted or provided for indexing. */
     text?: string;
+    /** Base64-encoded HTML content preserving structure and formatting. */
     html_base64?: string;
+    /** Base64-encoded CSV data for tabular content ingestion. */
     csv_base64?: string;
+    /** Raw Markdown content to be indexed as rich text. */
     markdown?: string;
+    /** List of file descriptors associated with the source (e.g., filenames, sizes). */
     files?: Record<string, unknown>[];
+    /** Optional layout metadata such as sections or blocks to guide chunking. */
     layout?: Record<string, unknown>[];
 }

package/dist/api/types/DeleteMemoryRequest.d.ts

@@ -2,7 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface DeleteMemoryRequest {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
+    /** List of source IDs to delete */
     source_ids: string[];
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
     sub_tenant_id?: string;
 }

package/dist/api/types/DeleteSources.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DeleteSources {
+    success?: boolean;
+    message?: string;
+}

package/dist/api/types/DeleteSources.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/types/DeleteSubTenantData.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DeleteSubTenantData {
+    /** The status of the deletion operation. */
+    status: string;
+    /** The tenant ID from which the sub-tenant was deleted. */
+    tenant_id: string;
+    /** The ID of the sub-tenant that was deleted. */
+    sub_tenant_id: string;
+    /** Indicates whether the sub-tenant deletion was successful. */
+    success?: boolean;
+    /** Response message describing the operation result. */
+    message?: string;
+}

package/dist/api/types/DeleteSubTenantData.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/types/DeleteUserMemoryResponse.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for deleting a user memory.
+ */
+export interface DeleteUserMemoryResponse {
+    /** Indicates whether the memory deletion operation was successful */
+    success: boolean;
+    /** Confirms whether the specific memory was successfully deleted */
+    user_memory_deleted: boolean;
+}

package/dist/api/types/DeleteUserMemoryResponse.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/types/EmbeddingsCreateCollectionData.d.ts

@@ -2,8 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface EmbeddingsCreateCollectionData {
+    /** Identifier for the tenant/organization */
     tenant_id: string;
+    /** Identifier for the sub-tenant within the tenant */
     sub_tenant_id: string;
+    /** Indicates whether the embeddings tenant creation completed successfully */
     success?: boolean;
+    /** Status message about the tenant creation operation */
     message?: string;
 }

package/dist/api/types/EmbeddingsDeleteData.d.ts

@@ -2,8 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface EmbeddingsDeleteData {
+    /** Total number of embeddings that were successfully deleted */
     total_deleted: number;
+    /** Dictionary mapping chunk IDs to their deletion status (true if deleted successfully). Example: {'chunk_1234': true} */
     status: Record<string, boolean>;
+    /** Indicates whether the embeddings deletion operation completed successfully */
     success?: boolean;
+    /** Status message about the deletion operation */
     message?: string;
 }

package/dist/api/types/EmbeddingsGetData.d.ts

@@ -2,8 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface EmbeddingsGetData {
+    /** Dictionary mapping chunk IDs to their embedding vectors (lists of float values) */
     embeddings: Record<string, number[]>;
+    /** List of chunk IDs that were not found in the embeddings collection */
     not_found_chunk_ids: string[];
+    /** Indicates whether the embeddings retrieval operation completed successfully */
     success?: boolean;
+    /** Status message about the retrieval operation */
     message?: string;
 }

package/dist/api/types/EmbeddingsSearchData.d.ts

@@ -2,8 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface EmbeddingsSearchData {
+    /** List of chunk IDs that match the search query */
     chunk_ids: string[];
+    /** Similarity scores for each matching chunk (higher is more similar) */
     scores: number[];
+    /** Indicates whether the embeddings search operation completed successfully */
     success?: boolean;
+    /** Status message about the search operation */
     message?: string;
 }

package/dist/api/types/ErrorResponse.d.ts

@@ -5,5 +5,4 @@ export interface ErrorResponse {
     success?: boolean;
     message?: string;
     error_code?: string;
-    data?: Record<string, unknown>;
 }

package/dist/api/types/FetchContentData.d.ts

@@ -2,9 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface FetchContentData {
+    /** Unique identifier for the file being fetched */
     file_id: string;
-    url: string;
+    /** Content of the fetched file */
     file_content?: string;
+    /** Indicates whether the fetch operation completed successfully */
     success?: boolean;
+    /** Status message about the fetch operation */
     message?: string;
 }

package/dist/api/types/FileUploadResult.d.ts

@@ -2,6 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface FileUploadResult {
+    /** Unique identifier for the file being processed */
     file_id: string;
+    /** Name of the uploaded file, if provided */
     filename?: string;
 }

package/dist/api/types/GenerateUserMemoryResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+/**
+ * Response model for AI-generated user memories.
+ */
+export interface GenerateUserMemoryResponse {
+    /** Indicates whether the memory generation operation was successful */
+    success: boolean;
+    /** Array of AI-generated memories based on your query and user context */
+    generated_user_memories?: CortexAI.UserMemory[];
+}

package/dist/api/types/GenerateUserMemoryResponse.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/types/ListSourcesResponse.d.ts

@@ -3,7 +3,10 @@
  */
 import * as CortexAI from "../index.js";
 export interface ListSourcesResponse {
+    /** List of source documents retrieved */
     sources: (CortexAI.Source | undefined)[];
+    /** Indicates whether the request was successful */
     success?: boolean;
+    /** Response message describing the operation result */
     message?: string;
 }

package/dist/api/types/ListUserMemoriesResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+/**
+ * Response model for listing all user memories.
+ */
+export interface ListUserMemoriesResponse {
+    /** Indicates whether the memory listing operation was successful */
+    success: boolean;
+    /** Array of all user memories associated with your tenant */
+    user_memories?: CortexAI.UserMemory[];
+}

package/dist/api/types/ListUserMemoriesResponse.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/types/MarkdownUploadRequest.d.ts

@@ -1,10 +1,20 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as CortexAI from "../index.js";
 export interface MarkdownUploadRequest {
+    /** The text or markdown content to upload */
     content: string;
+    /**
+     * JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+     *
+     * Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+     */
     tenant_metadata?: Record<string, unknown>;
+    /**
+     * JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+     *
+     * Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+     *
+     */
     document_metadata?: Record<string, unknown>;
-    relations?: CortexAI.Relations;
 }

package/dist/api/types/ProcessingStatus.d.ts

@@ -2,8 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ProcessingStatus {
+    /** Identifier for the file whose status is being retrieved */
     file_id: string;
+    /** Current status of the file. Possible values are 'queued', 'processing', 'completed', 'failed' */
     indexing_status: string;
     success?: boolean;
+    /** Detailed status message about the processing operation */
     message?: string;
 }

package/dist/api/types/Relations.d.ts

@@ -2,6 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface Relations {
+    /** List of cortex source IDs to directly relate with */
     cortex_source_ids?: string[];
+    /** Key value pairs to allow cortex to automatically discover relations */
     auto_discovery?: Record<string, unknown>;
 }

package/dist/api/types/RetrieveUserMemoryResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+/**
+ * Response model for retrieving user memories through semantic search.
+ */
+export interface RetrieveUserMemoryResponse {
+    /** Indicates whether the memory retrieval operation was successful */
+    success: boolean;
+    /** Array of user memories ranked by relevance to your search query */
+    retrieved_user_memories?: CortexAI.UserMemory[];
+}

package/dist/api/types/RetrieveUserMemoryResponse.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/types/SearchChunk.d.ts

@@ -1,22 +1,27 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as CortexAI from "../index.js";
 export interface SearchChunk {
+    /** Unique identifier for this content chunk */
     chunk_uuid: string;
+    /** Unique identifier for the source document */
     source_id: string;
+    /** The actual text content of this chunk */
     chunk_content: string;
+    /** Type of the source document (file, webpage, etc.) */
     source_type?: string;
+    /** When the source document was originally uploaded */
     source_upload_time?: string;
+    /** Title or name of the source document */
     source_title?: string;
+    /** When the source document was last modified */
     source_last_updated_time?: string;
-    source_collection?: string[];
+    /** Layout of the chunk in original document. You will generally receive a stringified dict with 2 keys, `offsets` and `page`(optional). Offsets will have `document_level_start_index` and `page_level_start_index`(optional) */
     layout?: string;
-    source_url?: string;
-    version?: string;
+    /** Score indicating how relevant this chunk is to your search query, with higher values indicating better matches */
     relevancy_score?: number;
-    cortex_metadata?: Record<string, unknown>;
+    /** Metadata extracted from the source document */
     document_metadata?: Record<string, unknown>;
+    /** Custom metadata associated with your tenant */
     tenant_metadata?: Record<string, unknown>;
-    extra_context?: CortexAI.ExtendedContext;
 }

package/dist/api/types/SingleUploadData.d.ts

@@ -2,7 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SingleUploadData {
+    /** Unique identifier for the file being processed */
     file_id: string;
+    /** Status message indicating document parsing scheduled or update completed */
+    message: string;
     success?: boolean;
-    message?: string;
 }

package/dist/api/types/Source.d.ts

@@ -1,20 +1,19 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as CortexAI from "../index.js";
 export interface Source {
+    /** Unique identifier for the source document */
     id: string;
+    /** Display title of the source document */
     title: string;
+    /** Type of content (document, file, text, etc.) */
     type: string;
+    /** When the source was originally created or uploaded */
     timestamp: string;
-    content: CortexAI.SourceContent;
-    collections?: string[];
+    /** Brief summary or description of the source content */
     description?: string;
-    note?: string;
-    url?: string;
-    cortex_metadata?: Record<string, unknown>;
+    /** Additional metadata specific to the document */
     document_metadata?: Record<string, unknown>;
+    /** Metadata related to the tenant and organizational context */
     tenant_metadata?: Record<string, unknown>;
-    meta?: Record<string, unknown>;
-    attachments?: unknown[];
 }

package/dist/api/types/SourceModel.d.ts

@@ -3,18 +3,37 @@
  */
 import * as CortexAI from "../index.js";
 export interface SourceModel {
-    collections?: string[];
+    /** Stable, unique identifier for the source. If omitted, one may be generated upstream. */
     id?: string;
+    /** Short human-readable title for the source. */
     title?: string;
+    /** High-level category of the source (e.g., document, email, ticket). */
     type?: string;
+    /** Optional long-form description providing additional context. */
     description?: string;
+    /** Free-form notes for internal use or ingestion hints. */
     note?: string;
+    /** Canonical URL or reference link associated with the source. */
     url?: string;
+    /** Creation or last-updated timestamp of the source in ISO-8601 format. */
     timestamp?: string;
+    /** Primary content payload used for indexing and retrieval. */
     content?: CortexAI.ContentModel;
-    cortex_metadata?: Record<string, unknown>;
+    /**
+     * JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+     *
+     * Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+     */
     tenant_metadata?: Record<string, unknown>;
+    /**
+     * JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+     *
+     * Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+     *
+     */
     document_metadata?: Record<string, unknown>;
+    /** System-provided attributes (e.g., app_name, local file size) not intended for search filtering. */
     meta?: Record<string, unknown>;
+    /** Attachments related to the source such as images, PDFs, or supplemental files. */
     attachments?: CortexAI.AttachmentModel[];
 }

package/dist/api/types/SubTenantIdsData.d.ts

@@ -2,9 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SubTenantIdsData {
-    collection_name: string;
+    /** The tenant ID that was queried */
+    tenant_id: string;
+    /** Array of all sub-tenant IDs within the tenant */
     sub_tenant_ids: string[];
+    /** Total number of sub-tenants found */
     count: number;
+    /** Indicates whether the sub-tenant retrieval was successful */
     success?: boolean;
+    /** Response message describing the operation result */
     message?: string;
 }

package/dist/api/types/TenantCreateData.d.ts

@@ -2,8 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface TenantCreateData {
+    /** Current status of the tenant creation process */
     status: string;
+    /** Unique identifier assigned to the new tenant */
     tenant_id: string;
+    /** Indicates whether the tenant creation was successful */
     success?: boolean;
+    /** Response message describing the creation result */
     message?: string;
 }

package/dist/api/types/TenantStats.d.ts

@@ -2,9 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface TenantStats {
+    /** Total number of objects stored for this tenant */
     object_count: number;
+    /** Name identifier for the tenant */
     tenant_name: string;
+    /** Dimensions of the vector embeddings used for this tenant. Null when the tenant is empty. */
     vector_dimension?: number;
+    /** Indicates whether the stats retrieval was successful */
     success?: boolean;
+    /** Response message describing the operation result */
     message?: string;
 }

package/dist/api/types/UserMemory.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Represents a user memory stored in the system.
+ */
+export interface UserMemory {
+    /** Unique identifier for the user memory */
+    memory_id: string;
+    /** The actual memory content text that was stored */
+    memory_content: string;
+}

package/dist/api/types/UserMemory.js

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