@usecortex_ai/node 0.4.0 → 0.5.0

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/api/resources/search/client/Client.d.ts

@@ -43,6 +43,11 @@ export declare class Search {
      *     - "fast" (default): Single query, faster response
      *     - "accurate": Multi-query generation with reranking, higher quality
      *
+     *     Use `filters` to narrow results by metadata:
+     *     - Provide key-value pairs matching fields defined in your tenant_metadata_schema
+     *     - Example: `{"category": "engineering", "priority": "high"}`
+     *     - Filters are validated against your tenant schema for type safety
+     *
      * @param {CortexAI.HybridSearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -50,6 +50,11 @@ class Search {
      *     - "fast" (default): Single query, faster response
      *     - "accurate": Multi-query generation with reranking, higher quality
      *
+     *     Use `filters` to narrow results by metadata:
+     *     - Provide key-value pairs matching fields defined in your tenant_metadata_schema
+     *     - Example: `{"category": "engineering", "priority": "high"}`
+     *     - Filters are validated against your tenant schema for type safety
+     *
      * @param {CortexAI.HybridSearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -34,6 +34,8 @@ export interface HybridSearchRequest {
     extra_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>;
 }
 export declare namespace HybridSearchRequest {
     /**