@usecortex_ai/node 0.5.0 → 0.5.1

package/LICENSE

@@ -1,24 +1,24 @@
-Copyright (c) 2024 Cortex AI
-
-All Rights Reserved.
-
-PROPRIETARY AND CONFIDENTIAL
-
-This software is the proprietary and confidential property of Cortex AI ("the Company").
-Permission is hereby granted to authorized users to install and use this software as part of the Cortex AI service, subject to the terms and conditions of the service agreement entered into with the Company.
-
-You may not, without the express written permission of the Company:
-
-Copy, modify, or create derivative works of the software.
-
-Distribute, sell, rent, lease, sublicense, or otherwise transfer the software to any third party.
-
-Reverse engineer, decompile, or disassemble the software, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+Copyright (c) 2024 Cortex AI
+
+All Rights Reserved.
+
+PROPRIETARY AND CONFIDENTIAL
+
+This software is the proprietary and confidential property of Cortex AI ("the Company").
+Permission is hereby granted to authorized users to install and use this software as part of the Cortex AI service, subject to the terms and conditions of the service agreement entered into with the Company.
+
+You may not, without the express written permission of the Company:
+
+Copy, modify, or create derivative works of the software.
+
+Distribute, sell, rent, lease, sublicense, or otherwise transfer the software to any third party.
+
+Reverse engineer, decompile, or disassemble the software, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,141 +1,141 @@
-# Cortex AI TypeScript SDK
-
-The official TypeScript SDK for the Cortex AI platform. Build powerful, context-aware AI applications in your Node.js or TypeScript projects.
-
-**Cortex** is your plug-and-play memory infrastructure. It powers intelligent, context-aware retrieval for any AI app or agent. Whether you’re building a customer support bot, research copilot, or internal knowledge assistant - Cortex handles all!
-
-[Learn more about the SDK from our docs](https://docs.usecortex.ai/)
-
-## Core features
-
-* **Dynamic retrieval and querying** that always retrieve the most relevant context
-* **Built-in long-term memory** that evolves with every user interaction
-* **Personalization hooks** for user preferences, intent, and history
-* **Developer-first SDK** with the most flexible APIs and fine-grained controls
-
-## Getting started
-
-### Installation
-
-```
-npm i @usecortex_ai/node
-# or
-yarn add @usecortex_ai/node
-# or
-pnpm add @usecortex_ai/node
-```
-
-### Client setup
-
-```ts
-import { CortexAIClient } from "@usecortex_ai/node";
-
-const client = new CortexAIClient({
-  token: process.env.CORTEX_API_KEY,
-});
-```
-
-### Create a Tenant
-
-You can consider a `tenant` as a single database that can have internal isolated collections called `sub-tenants`. [Know more about the concept of tenant here](https://docs.usecortex.ai/essentials/multi-tenant)
-
-```ts
-async function createTenant() {
-  const tenantCreationResponse = await client.user.createTenant({
-    tenant_id: "my-company"
-  });
-  return tenantCreationResponse;
-}
-```
-
-### Index Your Data
-
-When you index your data, you make it ready for retrieval from Cortex using natural language.
-
-```ts
-// Upload text content
-async function uploadText() {
-  const res = await client.upload.uploadText({
-    tenant_id: "my-company",
-    sub_tenant_id: "engineering",
-    body: {
-      content: "Our API rate limits are 1000 requests per minute for premium accounts.",
-      file_id: "api-docs-rate-limits",
-      tenant_metadata: { sub_tenant_id: "engineering" }
-    }
-  });
-  return res;
-}
-
-// Upload a document file
-async function uploadFile() {
-  const uploadResult = await client.upload.uploadDocument({
-    file: fs.readFileSync("company-handbook.pdf"),
-    tenant_id: "my-company",
-    sub_tenant_id: "hr",
-    file_id: "doc_q1_summary"
-  });
-  return uploadResult;
-}
-```
-
-> **For a more detailed explanation** of document upload, including supported file formats, processing pipeline, metadata handling, and advanced configuration options, refer to the [Upload Document endpoint documentation](https://docs.usecortex.ai/api-reference/endpoint/upload-document).
-
-### Search and retrieval
-
-```ts
-// Semantic search with retrieval
-const results = await client.search.retrieve({
-  query: "What are the API rate limits?",
-  tenant_id: "my-company",
-  sub_tenant_id: "engineering",
-  max_chunks: 10
-});
-
-// List all sources
-const allSources = await client.sources.getAll({
-    tenant_id: "my-company",
-    sub_tenant_id: "engineering"
-});
-
-// Get specific sources by ID
-const specificSources = await client.sources.getByIds({
-  tenant_id: "my-company",
-  sub_tenant_id: "engineering",
-  source_ids: ["api-docs-rate-limits", "company-handbook"]
-});
-```
-
-> **For a more detailed explanation** of search and retrieval, including query parameters, scoring mechanisms, result structure, and advanced search features, refer to the [Search endpoint documentation](https://docs.usecortex.ai/api-reference/endpoint/search).
-
-## SDK Method Structure & Type Safety
-
-Our SDKs follow a predictable pattern that mirrors the API structure while providing full type safety.
-
-> **Method Mapping** : `client.<group>.<functionName>` mirrors `api.usecortex.ai/<group>/<function_name>`
->
-> For example: `client.upload.uploadText()` corresponds to `POST /upload/upload_text`
-
-The SDKs provide exact type parity with the API specification:
-
-- **Request Parameters** : Every field documented in the API reference (required, optional, types, validation rules) is reflected in the SDK method signatures
-- **Response Objects** : Return types match the exact JSON schema documented for each endpoint
-- **Error Types** : Exception structures mirror the error response formats from the API
-- **Nested Objects** : Complex nested parameters and responses maintain their full structure and typing
-
-> This means you can rely on your IDE’s autocomplete and type checking. If a parameter is optional in the API docs, it’s optional in the SDK. If a response contains a specific field, your IDE will know about it. Our SDKs are built in such a way that your IDE will automatically provide **autocompletion, type-checking, inline documentation with examples, and compile time validation** for each and every method.
->
-> Just hit **Cmd+Space/Ctrl+Space!**
-
-## Links
-
-- **Homepage:** [usecortex.ai](https://www.usecortex.ai/)
-- **Documentation:** [docs.usecortex.ai](https://docs.usecortex.ai/)
-
-## Our docs
-
-Please refer to our [API reference](https://docs.usecortex.ai/api-reference/introduction) for detailed explanations of every API endpoint, parameter options, and advanced use cases.
-
-## Support
-
-If you have any questions or need help, please reach out to our support team at [founders@usecortex.ai](mailto:founders@usecortex.ai).
+# Cortex AI TypeScript SDK
+
+The official TypeScript SDK for the Cortex AI platform. Build powerful, context-aware AI applications in your Node.js or TypeScript projects.
+
+**Cortex** is your plug-and-play memory infrastructure. It powers intelligent, context-aware retrieval for any AI app or agent. Whether you’re building a customer support bot, research copilot, or internal knowledge assistant - Cortex handles all!
+
+[Learn more about the SDK from our docs](https://docs.usecortex.ai/)
+
+## Core features
+
+* **Dynamic retrieval and querying** that always retrieve the most relevant context
+* **Built-in long-term memory** that evolves with every user interaction
+* **Personalization hooks** for user preferences, intent, and history
+* **Developer-first SDK** with the most flexible APIs and fine-grained controls
+
+## Getting started
+
+### Installation
+
+```
+npm i @usecortex_ai/node
+# or
+yarn add @usecortex_ai/node
+# or
+pnpm add @usecortex_ai/node
+```
+
+### Client setup
+
+```ts
+import { CortexAIClient } from "@usecortex_ai/node";
+
+const client = new CortexAIClient({
+  token: process.env.CORTEX_API_KEY,
+});
+```
+
+### Create a Tenant
+
+You can consider a `tenant` as a single database that can have internal isolated collections called `sub-tenants`. [Know more about the concept of tenant here](https://docs.usecortex.ai/essentials/multi-tenant)
+
+```ts
+async function createTenant() {
+  const tenantCreationResponse = await client.user.createTenant({
+    tenant_id: "my-company"
+  });
+  return tenantCreationResponse;
+}
+```
+
+### Index Your Data
+
+When you index your data, you make it ready for retrieval from Cortex using natural language.
+
+```ts
+// Upload text content
+async function uploadText() {
+  const res = await client.upload.uploadText({
+    tenant_id: "my-company",
+    sub_tenant_id: "engineering",
+    body: {
+      content: "Our API rate limits are 1000 requests per minute for premium accounts.",
+      file_id: "api-docs-rate-limits",
+      tenant_metadata: { sub_tenant_id: "engineering" }
+    }
+  });
+  return res;
+}
+
+// Upload a document file
+async function uploadFile() {
+  const uploadResult = await client.upload.uploadDocument({
+    file: fs.readFileSync("company-handbook.pdf"),
+    tenant_id: "my-company",
+    sub_tenant_id: "hr",
+    file_id: "doc_q1_summary"
+  });
+  return uploadResult;
+}
+```
+
+> **For a more detailed explanation** of document upload, including supported file formats, processing pipeline, metadata handling, and advanced configuration options, refer to the [Upload Document endpoint documentation](https://docs.usecortex.ai/api-reference/endpoint/upload-document).
+
+### Search and retrieval
+
+```ts
+// Semantic search with retrieval
+const results = await client.search.retrieve({
+  query: "What are the API rate limits?",
+  tenant_id: "my-company",
+  sub_tenant_id: "engineering",
+  max_chunks: 10
+});
+
+// List all sources
+const allSources = await client.sources.getAll({
+    tenant_id: "my-company",
+    sub_tenant_id: "engineering"
+});
+
+// Get specific sources by ID
+const specificSources = await client.sources.getByIds({
+  tenant_id: "my-company",
+  sub_tenant_id: "engineering",
+  source_ids: ["api-docs-rate-limits", "company-handbook"]
+});
+```
+
+> **For a more detailed explanation** of search and retrieval, including query parameters, scoring mechanisms, result structure, and advanced search features, refer to the [Search endpoint documentation](https://docs.usecortex.ai/api-reference/endpoint/search).
+
+## SDK Method Structure & Type Safety
+
+Our SDKs follow a predictable pattern that mirrors the API structure while providing full type safety.
+
+> **Method Mapping** : `client.<group>.<functionName>` mirrors `api.usecortex.ai/<group>/<function_name>`
+>
+> For example: `client.upload.uploadText()` corresponds to `POST /upload/upload_text`
+
+The SDKs provide exact type parity with the API specification:
+
+- **Request Parameters** : Every field documented in the API reference (required, optional, types, validation rules) is reflected in the SDK method signatures
+- **Response Objects** : Return types match the exact JSON schema documented for each endpoint
+- **Error Types** : Exception structures mirror the error response formats from the API
+- **Nested Objects** : Complex nested parameters and responses maintain their full structure and typing
+
+> This means you can rely on your IDE’s autocomplete and type checking. If a parameter is optional in the API docs, it’s optional in the SDK. If a response contains a specific field, your IDE will know about it. Our SDKs are built in such a way that your IDE will automatically provide **autocompletion, type-checking, inline documentation with examples, and compile time validation** for each and every method.
+>
+> Just hit **Cmd+Space/Ctrl+Space!**
+
+## Links
+
+- **Homepage:** [usecortex.ai](https://www.usecortex.ai/)
+- **Documentation:** [docs.usecortex.ai](https://docs.usecortex.ai/)
+
+## Our docs
+
+Please refer to our [API reference](https://docs.usecortex.ai/api-reference/introduction) for detailed explanations of every API endpoint, parameter options, and advanced use cases.
+
+## Support
+
+If you have any questions or need help, please reach out to our support team at [founders@usecortex.ai](mailto:founders@usecortex.ai).

package/dist/Client.d.ts

@@ -50,8 +50,6 @@ export declare class CortexAIClient {
     get search(): Search;
     get dashboard(): Dashboard;
     /**
-     * Endpoint that serves Prometheus metrics.
-     *
      * @param {CortexAIClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example

package/dist/Client.js

@@ -75,8 +75,6 @@ class CortexAIClient {
         return ((_a = this._dashboard) !== null && _a !== void 0 ? _a : (this._dashboard = new Client_js_7.Dashboard(this._options)));
     }
     /**
-     * Endpoint that serves Prometheus metrics.
-     *
      * @param {CortexAIClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example

package/dist/api/index.d.ts

@@ -1,3 +1,3 @@
+export * from "./resources/index.js";
 export * from "./types/index.js";
 export * from "./errors/index.js";
-export * from "./resources/index.js";

package/dist/api/index.js

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources/index.js"), exports);
 __exportStar(require("./types/index.js"), exports);
 __exportStar(require("./errors/index.js"), exports);
-__exportStar(require("./resources/index.js"), exports);

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

@@ -30,11 +30,6 @@ export declare class Dashboard {
     protected readonly _options: Dashboard.Options;
     constructor(_options?: Dashboard.Options);
     /**
-     * List all API keys for dashboard view.
-     *
-     * Uses Firebase authentication to identify the user and returns API keys
-     * associated with that user.
-     *
      * @param {Dashboard.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}
@@ -51,10 +46,6 @@ export declare class Dashboard {
     listApis(requestOptions?: Dashboard.RequestOptions): core.HttpResponsePromise<CortexAI.DashboardApisResponse>;
     private __listApis;
     /**
-     * List all sources for a tenant/sub-tenant combination.
-     *
-     * Uses the same logic as the existing get_sources function.
-     *
      * @param {CortexAI.ListSourcesDashboardSourcesGetRequest} request
      * @param {Dashboard.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -68,18 +59,13 @@ export declare class Dashboard {
      *
      * @example
      *     await client.dashboard.listSources({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567"
      *     })
      */
     listSources(request: CortexAI.ListSourcesDashboardSourcesGetRequest, requestOptions?: Dashboard.RequestOptions): core.HttpResponsePromise<CortexAI.DashboardSourcesResponse>;
     private __listSources;
     /**
-     * List all tenants for dashboard view.
-     *
-     * Uses Firebase authentication to identify the user and returns tenant
-     * mappings associated with that user's organization.
-     *
      * @param {Dashboard.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}

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

@@ -37,11 +37,6 @@ class Dashboard {
         this._options = _options;
     }
     /**
-     * List all API keys for dashboard view.
-     *
-     * Uses Firebase authentication to identify the user and returns API keys
-     * associated with that user.
-     *
      * @param {Dashboard.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}
@@ -114,10 +109,6 @@ class Dashboard {
         }
     }
     /**
-     * List all sources for a tenant/sub-tenant combination.
-     *
-     * Uses the same logic as the existing get_sources function.
-     *
      * @param {CortexAI.ListSourcesDashboardSourcesGetRequest} request
      * @param {Dashboard.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -131,8 +122,8 @@ class Dashboard {
      *
      * @example
      *     await client.dashboard.listSources({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567"
      *     })
      */
     listSources(request, requestOptions) {
@@ -198,11 +189,6 @@ class Dashboard {
         }
     }
     /**
-     * List all tenants for dashboard view.
-     *
-     * Uses Firebase authentication to identify the user and returns tenant
-     * mappings associated with that user's organization.
-     *
      * @param {Dashboard.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}

package/dist/api/resources/dashboard/client/requests/ListSourcesDashboardSourcesGetRequest.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"
  *     }
  */
 export interface ListSourcesDashboardSourcesGetRequest {

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

@@ -30,16 +30,6 @@ export declare class Embeddings {
     protected readonly _options: Embeddings.Options;
     constructor(_options?: Embeddings.Options);
     /**
-     * Upload pre-computed embeddings for advanced similarity search.
-     *
-     * This endpoint accepts vector embeddings that you’ve generated externally,
-     *  allowing you to integrate with custom embedding models or existing vector databases.
-     *   The embeddings represent chunks of your content as numerical vectors.
-     *
-     * The system stores these embeddings and makes them available for semantic search and similarity matching.
-     *  Use this when you want to leverage specialized embedding models or have existing vector representations.
-     * When upsert=True, existing embeddings with the same chunk_id will be updated.
-     *
      * @param {CortexAI.BodyInsertRawEmbeddingsEndpointEmbeddingsInsertRawEmbeddingsPost} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -53,11 +43,23 @@ export declare class Embeddings {
      *
      * @example
      *     await client.embeddings.insert({
-     *         tenant_id: "tenant_id",
+     *         tenant_id: "tenant_1234",
      *         embeddings: [{
-     *                 source_id: "source_id",
+     *                 source_id: "<source_id>",
+     *                 embeddings: [{
+     *                         chunk_id: "<chunk_id>",
+     *                         embedding: [1.1]
+     *                     }, {
+     *                         chunk_id: "<chunk_id>",
+     *                         embedding: [1.1]
+     *                     }]
+     *             }, {
+     *                 source_id: "<source_id>",
      *                 embeddings: [{
-     *                         chunk_id: "chunk_id",
+     *                         chunk_id: "<chunk_id>",
+     *                         embedding: [1.1]
+     *                     }, {
+     *                         chunk_id: "<chunk_id>",
      *                         embedding: [1.1]
      *                     }]
      *             }]
@@ -66,13 +68,6 @@ export declare class Embeddings {
     insert(request: CortexAI.BodyInsertRawEmbeddingsEndpointEmbeddingsInsertRawEmbeddingsPost, requestOptions?: Embeddings.RequestOptions): core.HttpResponsePromise<CortexAI.InsertResult>;
     private __insert;
     /**
-     * Find similar chunks using an embedding vector.
-     *
-     * Use this to retrieve the most similar chunk IDs to a single query embedding.
-     *
-     * Expected outcome:
-     * - You receive the closest chunk IDs with optional similarity scores.
-     *
      * @param {CortexAI.BodySearchRawEmbeddingsEndpointEmbeddingsSearchRawEmbeddingsPost} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -86,17 +81,14 @@ export declare class Embeddings {
      *
      * @example
      *     await client.embeddings.search({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id",
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567",
      *         query_embedding: [1.1]
      *     })
      */
     search(request: CortexAI.BodySearchRawEmbeddingsEndpointEmbeddingsSearchRawEmbeddingsPost, requestOptions?: Embeddings.RequestOptions): core.HttpResponsePromise<CortexAI.RawEmbeddingSearchResult[]>;
     private __search;
     /**
-     * Retrieve embeddings for specific chunk IDs.
-     * Use this when you already know the chunk IDs and need their corresponding embeddings.
-     *
      * @param {CortexAI.BodyFilterRawEmbeddingsEndpointEmbeddingsFilterRawEmbeddingsPost} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -110,18 +102,13 @@ export declare class Embeddings {
      *
      * @example
      *     await client.embeddings.filter({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567"
      *     })
      */
     filter(request: CortexAI.BodyFilterRawEmbeddingsEndpointEmbeddingsFilterRawEmbeddingsPost, requestOptions?: Embeddings.RequestOptions): core.HttpResponsePromise<CortexAI.RawEmbeddingSearchResult[]>;
     private __filter;
     /**
-     * Delete embedding chunks by chunk ID.
-     *
-     * Use this to remove specific chunks from your embeddings index when they are no longer
-     * valid or should not appear in results.
-     *
      * @param {CortexAI.EmbeddingsDeleteRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -135,7 +122,7 @@ export declare class Embeddings {
      *
      * @example
      *     await client.embeddings.delete({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234"
      *     })
      */
     delete(request: CortexAI.EmbeddingsDeleteRequest, requestOptions?: Embeddings.RequestOptions): core.HttpResponsePromise<CortexAI.DeleteResult>;