@usecortex_ai/node 0.3.6 → 0.5.0

package/dist/api/resources/upload/client/requests/{UploadUploadMarkdownRequest.d.ts → BodyAddMemoryMemoriesAddMemoryPost.d.ts}

@@ -5,17 +5,17 @@ import * as CortexAI from "../../../../index.js";
 /**
  * @example
  *     {
- *         tenant_id: "tenant_1234",
- *         sub_tenant_id: "sub_tenant_4567",
- *         body: {
- *             content: "<content>"
- *         }
+ *         memories: [{}],
+ *         tenant_id: "tenant_id"
  *     }
  */
-export interface UploadUploadMarkdownRequest {
+export interface BodyAddMemoryMemoriesAddMemoryPost {
+    /** List of memory items to ingest */
+    memories: CortexAI.MemoryItem[];
     /** Unique identifier for the tenant/organization */
     tenant_id: string;
     /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
     sub_tenant_id?: string;
-    body: CortexAI.MarkdownUploadRequest;
+    /** If true, update existing sources with the same source_id. */
+    upsert?: boolean;
 }

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

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         app_sources: {
+ *             id: "id",
+ *             tenant_id: "tenant_id",
+ *             sub_tenant_id: "sub_tenant_id"
+ *         },
+ *         tenant_id: "tenant_id"
+ *     }
+ */
+export interface BodyUploadAppIngestionUploadAppPost {
+    /** Single source object or list of structured source objects containing app-generated data to be indexed */
+    app_sources: BodyUploadAppIngestionUploadAppPost.AppSources;
+    /** Unique identifier for the tenant/organization */
+    tenant_id: string;
+    /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
+    sub_tenant_id?: string;
+    /** If true, update existing sources with the same source_id. Defaults to True. */
+    upsert?: boolean;
+}
+export declare namespace BodyUploadAppIngestionUploadAppPost {
+    /**
+     * Single source object or list of structured source objects containing app-generated data to be indexed
+     */
+    type AppSources = CortexAI.SourceModel | CortexAI.SourceModel[];
+}

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../../core/index.js";
+/**
+ * @example
+ *     {
+ *         files: [fs.createReadStream("/path/to/your/file")],
+ *         tenant_id: "tenant_id"
+ *     }
+ */
+export interface BodyUploadDocumentIngestionUploadDocumentPost {
+    /** Files to be uploaded */
+    files: core.file.Uploadable.FileLike[];
+    /** Unique identifier for the tenant/organization */
+    tenant_id: string;
+    /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
+    sub_tenant_id?: string;
+    upsert?: boolean;
+    /** JSON Array of file metadata objects */
+    file_metadata?: string;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tenant_id: "tenant_id",
+ *         memory_id: "memory_id"
+ *     }
+ */
+export interface UploadDeleteMemoryRequest {
+    /** Tenant ID */
+    tenant_id: string;
+    /** Unique identifier of the memory to delete */
+    memory_id: string;
+    /** Sub-tenant ID */
+    sub_tenant_id?: string;
+}

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

@@ -4,8 +4,7 @@
 /**
  * @example
  *     {
- *         file_id: "CortexDoc1234",
- *         tenant_id: "tenant_1234"
+ *         file_id: "file_id"
  *     }
  */
 export interface UploadVerifyProcessingRequest {

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

@@ -1,17 +1,5 @@
-export { type BodyBatchUploadUploadBatchUploadPost } from "./BodyBatchUploadUploadBatchUploadPost.js";
-export { type BodyBatchUpdateUploadBatchUpdatePatch } from "./BodyBatchUpdateUploadBatchUpdatePatch.js";
-export { type BodyUploadFilesUploadUploadDocumentPost } from "./BodyUploadFilesUploadUploadDocumentPost.js";
-export { type BodyUpdateFileUploadUpdateDocumentPatch } from "./BodyUpdateFileUploadUpdateDocumentPatch.js";
-export { type UploadUploadAppSourcesRequest } from "./UploadUploadAppSourcesRequest.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 UploadBatchUploadMarkdownRequest } from "./UploadBatchUploadMarkdownRequest.js";
-export { type UploadBatchUploadTextRequest } from "./UploadBatchUploadTextRequest.js";
-export { type EmbeddingsUploadRequest } from "./EmbeddingsUploadRequest.js";
-export { type EmbeddingsUpdateRequest } from "./EmbeddingsUpdateRequest.js";
-export { type UploadScrapeWebpageRequest } from "./UploadScrapeWebpageRequest.js";
-export { type UploadUpdateWebpageRequest } from "./UploadUpdateWebpageRequest.js";
-export { type UploadBatchScrapeWebpageRequest } from "./UploadBatchScrapeWebpageRequest.js";
+export { type BodyUploadDocumentIngestionUploadDocumentPost } from "./BodyUploadDocumentIngestionUploadDocumentPost.js";
+export { type BodyUploadAppIngestionUploadAppPost } from "./BodyUploadAppIngestionUploadAppPost.js";
 export { type UploadVerifyProcessingRequest } from "./UploadVerifyProcessingRequest.js";
+export { type BodyAddMemoryMemoriesAddMemoryPost } from "./BodyAddMemoryMemoriesAddMemoryPost.js";
+export { type UploadDeleteMemoryRequest } from "./UploadDeleteMemoryRequest.js";

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+/**
+ * Response model for add_memory endpoint.
+ */
+export interface AddMemoryResponse {
+    success?: boolean;
+    message?: string;
+    /** List of results for each ingested memory item. */
+    results?: CortexAI.MemoryResultItem[];
+    /** Number of items successfully queued for ingestion. */
+    success_count?: number;
+    /** Number of items that failed to queue. */
+    failed_count?: number;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ApiKeyInfo {
+    /** API key identifier */
+    api_key_id: string;
+    /** Owner email */
+    user_email: string;
+    /** User ID */
+    user_id: string;
+    /** API key scopes */
+    scopes?: string[];
+    /** Whether the API key is valid */
+    is_valid: boolean;
+    /** Creation timestamp */
+    created_at: string;
+}

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

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CortexAI from "../index.js";
+/**
+ * Response model for uploads of app-generated sources.
+ */
 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;
+    /** List of upload results for each source. */
+    results?: CortexAI.SourceUploadResultItem[];
+    /** Number of sources successfully queued. */
+    success_count?: number;
+    /** Number of sources that failed to upload. */
+    failed_count?: number;
 }

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CollectionStats {
+    /** Number of rows in the collection */
+    row_count: number;
+    /** Number of dimensions in the collection */
+    dimensions: number;
+}

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

@@ -0,0 +1,38 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+/**
+ * Definition for custom/dynamic properties on a collection.
+ *
+ * Use this to define tenant metadata fields that can enhance search capabilities:
+ * - enable_dense_embedding: Creates a dense vector field for semantic similarity search
+ * - enable_sparse_embedding: Creates a sparse vector field for BM25 keyword search
+ *
+ * Example:
+ *     CustomPropertyDefinition(
+ *         name="product_description",
+ *         data_type=MilvusDataType.VARCHAR,
+ *         max_length=4096,
+ *         enable_dense_embedding=True,  # Enables semantic search on this field
+ *         enable_sparse_embedding=True,  # Enables keyword search on this field
+ *     )
+ */
+export interface CustomPropertyDefinition {
+    /** Property name (used as field name in Milvus) */
+    name: string;
+    /** Milvus data type. Use VARCHAR for text fields that need embeddings. */
+    data_type?: CortexAI.MilvusDataType;
+    /** Max length for VARCHAR fields. Increase for longer text content. */
+    max_length?: number;
+    /** Enable text analyzer for full-text search capabilities */
+    enable_analyzer?: boolean;
+    /** Enable TEXT_MATCH filtering on this field */
+    enable_match?: boolean;
+    /** Create a dense embedding field (FLOAT_VECTOR) for semantic similarity search. Only applicable to VARCHAR fields. A corresponding '{name}_embedding' field will be created. */
+    enable_dense_embedding?: boolean;
+    /** Create a sparse embedding field (BM25) for keyword search. Only applicable to VARCHAR fields. A corresponding '{name}_sparse' field and BM25 function will be created. */
+    enable_sparse_embedding?: boolean;
+    /** Whether field can be null */
+    nullable?: boolean;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+export interface DashboardApisResponse {
+    /** List of API keys */
+    api_keys?: CortexAI.ApiKeyInfo[];
+    /** Total number of API keys */
+    count: number;
+    /** Response message */
+    message?: string;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+export interface DashboardSourcesResponse {
+    /** List of sources */
+    sources?: CortexAI.SourceModel[];
+    /** Total number of sources */
+    count: number;
+    /** Response message */
+    message?: string;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+export interface DashboardTenantsResponse {
+    /** List of tenants */
+    tenants?: CortexAI.TenantInfo[];
+    /** Total number of tenants */
+    count: number;
+    /** Response message */
+    message?: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Result of a delete operation.
+ */
+export interface DeleteResult {
+    /** Number of entities deleted */
+    delete_count: number;
+    /** Whether delete succeeded */
+    success?: boolean;
+    /** Error message if failed */
+    error?: string;
+}

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

@@ -6,7 +6,7 @@
  */
 export interface DeleteUserMemoryResponse {
     /** Indicates whether the memory deletion operation was successful */
-    success: boolean;
+    success?: boolean;
     /** Confirms whether the specific memory was successfully deleted */
     user_memory_deleted: boolean;
 }

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

@@ -8,8 +8,8 @@ export interface Entity {
     type: string;
     /** Context category like 'employees', 'projects' */
     namespace?: string;
+    /** Internal unique entity ID from graph database */
+    entity_id: string;
     /** Unique ID like email, employee_id, URL */
     identifier?: string;
-    /** Internal unique entity ID from graph database */
-    entity_id?: string;
 }

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Mode for fetching file content.
+ */
+export type FetchMode = "content" | "url" | "both";
+export declare const FetchMode: {
+    readonly Content: "content";
+    readonly Url: "url";
+    readonly Both: "both";
+};

package/dist/api/types/FetchMode.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchMode = void 0;
+exports.FetchMode = {
+    Content: "content",
+    Url: "url",
+    Both: "both",
+};

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ForcefulRelationsPayload {
+    /** Cortex source IDs to forcefully relate to the uploaded source. */
+    cortex_source_ids?: string[];
+    /** Optional properties to attach to the forceful relation. */
+    properties?: Record<string, unknown>;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+/**
+ * Graph context containing query-based paths and chunk-based relation paths.
+ */
+export interface GraphContext {
+    query_paths?: CortexAI.ScoredPathResponse[];
+    chunk_relations?: CortexAI.ScoredPathResponse[];
+    chunk_id_to_group_ids?: Record<string, string[]>;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Infra {
+    scheduler_status: boolean;
+    graph_status: boolean;
+    vectorstore_status: unknown[];
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Result of an insert operation.
+ */
+export interface InsertResult {
+    /** Number of entities inserted */
+    insert_count: number;
+    /** Inserted entity IDs */
+    ids?: string[];
+    /** Whether insert succeeded */
+    success?: boolean;
+    /** Error message if failed */
+    error?: string;
+}

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

@@ -0,0 +1,43 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+/**
+ * Represents a single memory item for ingestion.
+ * Supports raw text, markdown, and user/assistant conversation pairs.
+ */
+export interface MemoryItem {
+    /** Optional unique identifier. Auto-generated if not provided. */
+    source_id?: string;
+    /** Display title for this memory item. */
+    title?: string;
+    /** Raw text or markdown content to be indexed. */
+    text?: string;
+    /** Array of user/assistant conversation pairs to store as memory. */
+    user_assistant_pairs?: CortexAI.UserAssistantPair[];
+    /** Whether the text is markdown formatted. */
+    is_markdown?: boolean;
+    /** If true, process and extract additional insights/inferences from the contentbefore indexingUseful for extracting implicit information from conversations */
+    infer?: boolean;
+    /** Custom instructions to guide inference processing. */
+    custom_instructions?: string;
+    /** User's name for personalization in conversation pairs. */
+    user_name?: string;
+    /** Optional TTL in seconds for this memory. */
+    expiry_time?: number;
+    /**
+     * JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+     *
+     * Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+     */
+    tenant_metadata?: string;
+    /**
+     * 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?: string;
+    /** Forcefully connect 2 sources based on cortex source ids or common properties. */
+    relations?: CortexAI.ForcefulRelationsPayload;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../index.js";
+/**
+ * Result for a single ingested memory item.
+ */
+export interface MemoryResultItem {
+    /** Unique identifier for the ingested source. */
+    source_id: string;
+    /** Title of the memory if provided. */
+    title?: string;
+    /** Initial processing status. */
+    status?: CortexAI.SourceStatus;
+    /** Whether inference was requested for this memory. */
+    infer?: boolean;
+    /** Error message if ingestion failed. */
+    error?: string;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Milvus data types mapped from Weaviate schema.
+ */
+export type MilvusDataType = "BOOL" | "INT8" | "INT16" | "INT32" | "INT64" | "FLOAT" | "DOUBLE" | "VARCHAR" | "JSON" | "ARRAY" | "FLOAT_VECTOR" | "SPARSE_FLOAT_VECTOR";
+export declare const MilvusDataType: {
+    readonly Bool: "BOOL";
+    readonly Int8: "INT8";
+    readonly Int16: "INT16";
+    readonly Int32: "INT32";
+    readonly Int64: "INT64";
+    readonly Float: "FLOAT";
+    readonly Double: "DOUBLE";
+    readonly Varchar: "VARCHAR";
+    readonly Json: "JSON";
+    readonly Array: "ARRAY";
+    readonly FloatVector: "FLOAT_VECTOR";
+    readonly SparseFloatVector: "SPARSE_FLOAT_VECTOR";
+};

package/dist/api/types/MilvusDataType.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MilvusDataType = void 0;
+exports.MilvusDataType = {
+    Bool: "BOOL",
+    Int8: "INT8",
+    Int16: "INT16",
+    Int32: "INT32",
+    Int64: "INT64",
+    Float: "FLOAT",
+    Double: "DOUBLE",
+    Varchar: "VARCHAR",
+    Json: "JSON",
+    Array: "ARRAY",
+    FloatVector: "FLOAT_VECTOR",
+    SparseFloatVector: "SPARSE_FLOAT_VECTOR",
+};

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

@@ -2,14 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CortexAI from "../index.js";
-/**
- * Single triplet within a path (without score, as the path is scored as a whole)
- */
 export interface PathTriplet {
-    /** Source entity */
     source: CortexAI.Entity;
-    /** Target entity */
-    target: CortexAI.Entity;
-    /** Relation between entities */
     relation: CortexAI.RelationEvidence;
+    target: CortexAI.Entity;
 }