@usecortex_ai/node 0.3.1 → 0.3.2

package/README.md

@@ -2,14 +2,139 @@
 
 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/)
 
-## Getting Started
+## Our docs
 
-Please refer to our [SDK documentation](https://docs.usecortex.ai/api-reference/sdks) and [API reference](https://docs.usecortex.ai/api-reference/introduction) to get started.
+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
 

package/package.json

@@ -1,19 +1,21 @@
 {
     "name": "@usecortex_ai/node",
-    "version": "0.3.1",
+    "version": "0.3.2",
     "description": "The official TypeScript SDK for the Cortex AI platform.",
     "author": "Nishkarsh Shrivastava <nishkarsh@usecortex.ai>",
     "license": "SEE LICENSE IN LICENSE",
-    "private": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/usefindr/cortex-ai-ts.git"
-    },
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
     "files": [
         "dist"
     ],
+    "keywords": [
+        "cortex",
+        "cortex-ai",
+        "cortex-ai-sdk",
+        "cortex-ai-typescript-sdk",
+        "rag", "gen-ai", "memory", "ai"
+    ],
     "scripts": {
         "build": "tsc",
         "prepublishOnly": "npm run build"