@usecortex_ai/node 0.5.0 → 0.5.2

package/dist/api/resources/search/client/requests/HybridSearchRequest.d.ts

@@ -5,8 +5,8 @@ import * as CortexAI from "../../../../index.js";
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id",
- *         query: "query"
+ *         tenant_id: "tenant_1234",
+ *         query: "Which mode does user prefer"
  *     }
  */
 export interface HybridSearchRequest {
@@ -17,25 +17,23 @@ export interface HybridSearchRequest {
     /** Search terms to find relevant content */
     query: string;
     /** Maximum number of results to return */
-    max_chunks?: number;
+    max_results?: number;
     /** Retrieval mode to use ('fast' or 'accurate') */
     mode?: CortexAI.RetrieveMode;
     /** Search ranking algorithm parameter (0.0-1.0 or 'auto') */
     alpha?: HybridSearchRequest.Alpha;
     /** Preference for newer content (0.0 = no bias, 1.0 =             strong recency preference) */
     recency_bias?: number;
-    /** Number of related content chunks to include */
-    num_related_chunks?: number;
     /** Enable personalized search results based on user preferences */
-    personalise_search?: boolean;
+    personalise_recall?: boolean;
     /** Enable graph context for search results */
     graph_context?: boolean;
     /** Additional context provided by the user to guide retrieval */
-    extra_context?: string;
+    additional_context?: string;
     /** What to search: 'sources' for documents or 'memories' for user memories */
     search_mode?: CortexAI.SearchMode;
     /** Optional key-value pairs to filter search results by tenant metadata fields. Keys must match fields defined in tenant_metadata_schema during tenant creation. Supports exact match filtering on indexed metadata fields. Example: {'category': 'engineering', 'priority': 'high'} */
-    filters?: Record<string, unknown>;
+    metadata_filters?: Record<string, unknown>;
 }
 export declare namespace HybridSearchRequest {
     /**

package/dist/api/resources/search/client/requests/QnASearchRequest.d.ts

@@ -5,8 +5,8 @@ import * as CortexAI from "../../../../index.js";
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id",
- *         question: "question"
+ *         tenant_id: "tenant_1234",
+ *         question: "What is Cortex AI"
  *     }
  */
 export interface QnASearchRequest {

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

@@ -30,13 +30,6 @@ export declare class Sources {
     protected readonly _options: Sources.Options;
     constructor(_options?: Sources.Options);
     /**
-     * Remove documents and content from your knowledge base.
-     *
-     * This endpoint permanently deletes the specified sources from your knowledge base.
-     *  Once deleted, the content will no longer be available for search or retrieval.
-     *
-     * Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
-     *
      * @param {CortexAI.SourceDeleteRequest} request
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -50,8 +43,8 @@ export declare class Sources {
      *
      * @example
      *     await client.sources.delete({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id",
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567",
      *         source_ids: ["source_ids"]
      *     })
      */

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

@@ -37,13 +37,6 @@ class Sources {
         this._options = _options;
     }
     /**
-     * Remove documents and content from your knowledge base.
-     *
-     * This endpoint permanently deletes the specified sources from your knowledge base.
-     *  Once deleted, the content will no longer be available for search or retrieval.
-     *
-     * Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
-     *
      * @param {CortexAI.SourceDeleteRequest} request
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -57,8 +50,8 @@ class Sources {
      *
      * @example
      *     await client.sources.delete({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id",
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567",
      *         source_ids: ["source_ids"]
      *     })
      */
@@ -69,7 +62,7 @@ class Sources {
         var _a, _b, _c;
         let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
         const _response = await core.fetcher({
-            url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "delete/delete-sources"),
+            url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "knowledge/delete_knowledge"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -115,7 +108,7 @@ class Sources {
                     rawResponse: _response.rawResponse,
                 });
             case "timeout":
-                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /delete/delete-sources.");
+                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /knowledge/delete_knowledge.");
             case "unknown":
                 throw new errors.CortexAIError({
                     message: _response.error.errorMessage,

package/dist/api/resources/sources/client/requests/SourceDeleteRequest.d.ts

@@ -4,8 +4,8 @@
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id",
- *         sub_tenant_id: "sub_tenant_id",
+ *         tenant_id: "tenant_1234",
+ *         sub_tenant_id: "sub_tenant_4567",
  *         source_ids: ["source_ids"]
  *     }
  */

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

@@ -30,47 +30,6 @@ export declare class Tenant {
     protected readonly _options: Tenant.Options;
     constructor(_options?: Tenant.Options);
     /**
-     * Create a tenant for your account.
-     *
-     * Use this endpoint to initialize a tenant space you can use for ingestion, embeddings, and search.
-     *
-     * **Tenant Metadata Schema**
-     *
-     * You can optionally provide a `tenant_metadata_schema` to define custom fields that will be
-     * indexed in the vector store. Each field can be configured with:
-     *
-     * - `enable_match`: Enable text filtering on this field
-     * - `enable_dense_embedding`: Create dense embeddings for semantic similarity search
-     * - `enable_sparse_embedding`: Create sparse embeddings (BM25) for keyword search
-     *
-     * **Example Request:**
-     * ```json
-     * {
-     *     "tenant_id": "my-tenant",
-     *     "tenant_metadata_schema": [
-     *         {
-     *             "name": "category",
-     *             "data_type": "VARCHAR",
-     *             "max_length": 256,
-     *             "enable_match": true
-     *         },
-     *         {
-     *             "name": "product_description",
-     *             "data_type": "VARCHAR",
-     *             "max_length": 4096,
-     *             "enable_dense_embedding": true,
-     *             "enable_sparse_embedding": true
-     *         }
-     *     ]
-     * }
-     * ```
-     *
-     * Expected outcome:
-     * - A tenant is created and returned with its identifier.
-     * - If tenant_metadata_schema is provided, the vector store collection will include
-     *   the specified custom fields with their configured search capabilities.
-     * - If the tenant already exists, you receive a success message with the existing identifier.
-     *
      * @param {CortexAI.TenantCreateRequest} request
      * @param {Tenant.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -84,23 +43,12 @@ export declare class Tenant {
      *
      * @example
      *     await client.tenant.createTenant({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234"
      *     })
      */
     createTenant(request: CortexAI.TenantCreateRequest, requestOptions?: Tenant.RequestOptions): core.HttpResponsePromise<CortexAI.TenantCreateResponse>;
     private __createTenant;
     /**
-     * Retrieve usage stats for your tenant.
-     *
-     * Use this endpoint to check whether a tenant exists and view core metrics like total
-     * indexed objects and vector dimension. This helps you validate
-     * setup and monitor ingestion.
-     *
-     * Expected outcome
-     *
-     * You receive the current object count and vector dimension for the tenant.
-     * If the tenant does not exist, you get a not-found error.
-     *
      * @param {CortexAI.TenantStatsRequest} request
      * @param {Tenant.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -114,7 +62,7 @@ export declare class Tenant {
      *
      * @example
      *     await client.tenant.stats({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234"
      *     })
      */
     stats(request: CortexAI.TenantStatsRequest, requestOptions?: Tenant.RequestOptions): core.HttpResponsePromise<CortexAI.TenantStatsResponse>;

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

@@ -37,47 +37,6 @@ class Tenant {
         this._options = _options;
     }
     /**
-     * Create a tenant for your account.
-     *
-     * Use this endpoint to initialize a tenant space you can use for ingestion, embeddings, and search.
-     *
-     * **Tenant Metadata Schema**
-     *
-     * You can optionally provide a `tenant_metadata_schema` to define custom fields that will be
-     * indexed in the vector store. Each field can be configured with:
-     *
-     * - `enable_match`: Enable text filtering on this field
-     * - `enable_dense_embedding`: Create dense embeddings for semantic similarity search
-     * - `enable_sparse_embedding`: Create sparse embeddings (BM25) for keyword search
-     *
-     * **Example Request:**
-     * ```json
-     * {
-     *     "tenant_id": "my-tenant",
-     *     "tenant_metadata_schema": [
-     *         {
-     *             "name": "category",
-     *             "data_type": "VARCHAR",
-     *             "max_length": 256,
-     *             "enable_match": true
-     *         },
-     *         {
-     *             "name": "product_description",
-     *             "data_type": "VARCHAR",
-     *             "max_length": 4096,
-     *             "enable_dense_embedding": true,
-     *             "enable_sparse_embedding": true
-     *         }
-     *     ]
-     * }
-     * ```
-     *
-     * Expected outcome:
-     * - A tenant is created and returned with its identifier.
-     * - If tenant_metadata_schema is provided, the vector store collection will include
-     *   the specified custom fields with their configured search capabilities.
-     * - If the tenant already exists, you receive a success message with the existing identifier.
-     *
      * @param {CortexAI.TenantCreateRequest} request
      * @param {Tenant.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -91,7 +50,7 @@ class Tenant {
      *
      * @example
      *     await client.tenant.createTenant({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234"
      *     })
      */
     createTenant(request, requestOptions) {
@@ -156,17 +115,6 @@ class Tenant {
         }
     }
     /**
-     * Retrieve usage stats for your tenant.
-     *
-     * Use this endpoint to check whether a tenant exists and view core metrics like total
-     * indexed objects and vector dimension. This helps you validate
-     * setup and monitor ingestion.
-     *
-     * Expected outcome
-     *
-     * You receive the current object count and vector dimension for the tenant.
-     * If the tenant does not exist, you get a not-found error.
-     *
      * @param {CortexAI.TenantStatsRequest} request
      * @param {Tenant.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -180,7 +128,7 @@ class Tenant {
      *
      * @example
      *     await client.tenant.stats({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234"
      *     })
      */
     stats(request, requestOptions) {
@@ -193,7 +141,7 @@ class Tenant {
         _queryParams["tenant_id"] = tenantId;
         let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
         const _response = await core.fetcher({
-            url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "tenants/stats"),
+            url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "tenants/monitor"),
             method: "GET",
             headers: _headers,
             queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -236,7 +184,7 @@ class Tenant {
                     rawResponse: _response.rawResponse,
                 });
             case "timeout":
-                throw new errors.CortexAITimeoutError("Timeout exceeded when calling GET /tenants/stats.");
+                throw new errors.CortexAITimeoutError("Timeout exceeded when calling GET /tenants/monitor.");
             case "unknown":
                 throw new errors.CortexAIError({
                     message: _response.error.errorMessage,

package/dist/api/resources/tenant/client/requests/TenantCreateRequest.d.ts

@@ -5,7 +5,7 @@ import * as CortexAI from "../../../../index.js";
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id"
+ *         tenant_id: "tenant_1234"
  *     }
  */
 export interface TenantCreateRequest {

package/dist/api/resources/tenant/client/requests/TenantStatsRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id"
+ *         tenant_id: "tenant_1234"
  *     }
  */
 export interface TenantStatsRequest {

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

@@ -30,12 +30,7 @@ export declare class Upload {
     protected readonly _options: Upload.Options;
     constructor(_options?: Upload.Options);
     /**
-     * Upload one or more documents for ingestion.
-     * Supports both single and batch uploads.
-     * For single file: send one file with the 'files' field.
-     * For batch: send multiple files with the 'files' field (FastAPI will parse as list).
-     *
-     * @param {CortexAI.BodyUploadDocumentIngestionUploadDocumentPost} request
+     * @param {CortexAI.BodyUploadKnowledgeIngestionUploadKnowledgePost} request
      * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}
@@ -48,47 +43,13 @@ export declare class Upload {
      *
      * @example
      *     import { createReadStream } from "fs";
-     *     await client.upload.uploadDocument({
-     *         files: [fs.createReadStream("/path/to/your/file")],
+     *     await client.upload.uploadKnowledge({
      *         tenant_id: "tenant_id"
      *     })
      */
-    uploadDocument(request: CortexAI.BodyUploadDocumentIngestionUploadDocumentPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SourceUploadResponse>;
-    private __uploadDocument;
+    uploadKnowledge(request: CortexAI.BodyUploadKnowledgeIngestionUploadKnowledgePost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.SourceUploadResponse>;
+    private __uploadKnowledge;
     /**
-     * Upload structured sources generated by first-party or third-party apps.
-     * Supports both single and batch uploads.
-     *
-     * @param {CortexAI.BodyUploadAppIngestionUploadAppPost} 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({
-     *         app_sources: {
-     *             id: "id",
-     *             tenant_id: "tenant_id",
-     *             sub_tenant_id: "sub_tenant_id"
-     *         },
-     *         tenant_id: "tenant_id"
-     *     })
-     */
-    uploadAppSources(request: CortexAI.BodyUploadAppIngestionUploadAppPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.AppSourcesUploadData>;
-    private __uploadAppSources;
-    /**
-     * Check the current processing status of your uploaded content.
-     *
-     * This endpoint allows you to monitor the progress of documents, text, or other content you've uploaded. Simply provide the file ID to see whether processing is complete, still in progress, or if any errors occurred.
-     *
-     * Use this to determine when your content is ready for search and retrieval, or to troubleshoot any processing issues.
-     *
      * @param {CortexAI.UploadVerifyProcessingRequest} request
      * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -102,30 +63,13 @@ export declare class Upload {
      *
      * @example
      *     await client.upload.verifyProcessing({
-     *         file_id: "file_id"
+     *         file_id: "<str>",
+     *         tenant_id: "tenant_1234"
      *     })
      */
     verifyProcessing(request: CortexAI.UploadVerifyProcessingRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.ProcessingStatus>;
     private __verifyProcessing;
     /**
-     * Add memories for indexing and retrieval.
-     *
-     *     This API provides a unified entry point for ingesting various types of content:
-     *
-     *     **Content Types Supported:**
-     *     - Raw text content (`text` field)
-     *     - Markdown formatted content (`text` + `is_markdown=true`)
-     *     - User/assistant conversation pairs (`user_assistant_pairs` field)
-     *
-     *     **Key Features:**
-     *     - **Inference Mode (`infer=true`)**: When enabled, the system extracts additional
-     *       insights and implicit information from your content. Useful for conversation
-     *       analysis and knowledge extraction.
-     *     - **Direct Mode (`infer=false`)**: Content is chunked and indexed as-is without
-     *       additional processing.
-     *
-     *     Use `/ingestion/verify-processing` endpoint to check the processing status.
-     *
      * @param {CortexAI.BodyAddMemoryMemoriesAddMemoryPost} request
      * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -140,20 +84,12 @@ export declare class Upload {
      * @example
      *     await client.upload.addMemory({
      *         memories: [{}],
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234"
      *     })
      */
     addMemory(request: CortexAI.BodyAddMemoryMemoriesAddMemoryPost, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.AddMemoryResponse>;
     private __addMemory;
     /**
-     * Permanently remove a specific memory from storage.
-     *
-     *     This API allows you to delete a 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.UploadDeleteMemoryRequest} request
      * @param {Upload.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -167,8 +103,8 @@ export declare class Upload {
      *
      * @example
      *     await client.upload.deleteMemory({
-     *         tenant_id: "tenant_id",
-     *         memory_id: "memory_id"
+     *         tenant_id: "tenant_1234",
+     *         memory_id: "memory_1234"
      *     })
      */
     deleteMemory(request: CortexAI.UploadDeleteMemoryRequest, requestOptions?: Upload.RequestOptions): core.HttpResponsePromise<CortexAI.DeleteUserMemoryResponse>;