@juspay/neurolink 12.44.7 → 12.45.0

package/dist/constants/enums.d.ts

@@ -16,6 +16,7 @@ export declare enum AIProviderName {
     NVIDIA_NIM = "nvidia-nim",
     LM_STUDIO = "lm-studio",
     LLAMACPP = "llamacpp",
+    A2AGENT = "a2agent",
     ABOVE_DEV = "above-dev",
     AI21 = "ai21",
     AIAND = "aiand",
@@ -844,6 +845,9 @@ export declare enum ReplicateModels {
  * authentication failures during ongoing operations
  */
 export declare const TOKEN_EXPIRY_BUFFER_MS: number;
+export declare enum A2agentModels {
+    DEEPSEEK_V4_FLASH = "deepseek-v4-flash"
+}
 export declare enum AboveDevModels {
     DEEPSEEK_V4_1_FLASH = "deepseek-v4.1-flash",
     DEEPSEEK_V4_PRO = "deepseek-v4-pro",

package/dist/constants/enums.js

@@ -21,6 +21,7 @@ export var AIProviderName;
     AIProviderName["LM_STUDIO"] = "lm-studio";
     AIProviderName["LLAMACPP"] = "llamacpp";
     // ── BEGIN GENERATED(provider-members): provider catalog (pnpm run codegen:catalog) ──
+    AIProviderName["A2AGENT"] = "a2agent";
     AIProviderName["ABOVE_DEV"] = "above-dev";
     AIProviderName["AI21"] = "ai21";
     AIProviderName["AIAND"] = "aiand";
@@ -1080,6 +1081,10 @@ export var ReplicateModels;
  */
 export const TOKEN_EXPIRY_BUFFER_MS = 5 * 60 * 1000; // 5 minutes
 // ── BEGIN GENERATED(models-enums): provider catalog (pnpm run codegen:catalog) ──
+export var A2agentModels;
+(function (A2agentModels) {
+    A2agentModels["DEEPSEEK_V4_FLASH"] = "deepseek-v4-flash";
+})(A2agentModels || (A2agentModels = {}));
 export var AboveDevModels;
 (function (AboveDevModels) {
     AboveDevModels["DEEPSEEK_V4_1_FLASH"] = "deepseek-v4.1-flash";

package/dist/providers/catalog/a2agent.json

@@ -0,0 +1,64 @@
+{
+    "$schema": "./provider-catalog.schema.json",
+    "id": "a2agent",
+    "displayName": "A2Agent",
+    "aliases": [],
+    "tier": 2,
+    "wire": {
+        "baseURL": "https://api.a2agent.me/v1"
+    },
+    "models": {
+        "default": "deepseek-v4-flash",
+        "fallbacks": ["deepseek-v4-flash"],
+        "defaultContextWindow": 1000000,
+        "defaultMaxOutputTokens": 4096,
+        "catalog": {
+            "deepseek-v4-flash": {
+                "contextWindow": 1000000,
+                "vision": false,
+                "status": "production",
+                "description": "DeepSeek V4 Flash via A2Agent; live-verified chat and tool calling"
+            }
+        }
+    },
+    "capabilities": {
+        "text": true,
+        "streaming": true,
+        "tools": true,
+        "toolsWithStreaming": true,
+        "structuredOutput": true,
+        "structuredOutputWithTools": true,
+        "embeddings": false,
+        "thinking": false
+    },
+    "errorRules": [],
+    "setup": {
+        "url": "https://a2agent.me/keys",
+        "apiKeyFormat": null,
+        "billingPolicy": "no-free-tier",
+        "instructions": [
+            "1. Create an account at https://a2agent.me/register",
+            "2. Create an API key at https://a2agent.me/keys",
+            "3. Set {apiKeyEnvVar} in your environment",
+            "4. Review trial-credit eligibility and prepaid rates at https://docs.a2agent.me/quickstart and https://a2agent.me/pricing",
+            "5. Use authenticated GET https://api.a2agent.me/v1/models for current model IDs; set A2AGENT_MODEL to select another model"
+        ]
+    },
+    "evidence": {
+        "rosterVerified": {
+            "date": "2026-09-21",
+            "status": 200,
+            "method": "authenticated GET https://api.a2agent.me/v1/models; deepseek-v4-flash present among 21 model IDs"
+        },
+        "authProbe": {
+            "date": "2026-09-21",
+            "status": 401,
+            "method": "GET /v1/models with a deliberately invalid Bearer token"
+        },
+        "liveMatrix": {
+            "date": "2026-09-21",
+            "result": "deepseek-v4-flash: provider matrix 4/4 (generate, stream, tools, structured output); CLI generate resolves the default and returns HELLO. Direct SSE, tool calls, streaming tool calls, JSON output and tools+response_format probes pass. SDK generate executes a tool and validates its result against a schema; fresh-session SDK streaming executes the tool and returns its value with automatic tool choice. Forcing required tool choice on every stream step loops until timeout, so that mode is not claimed. Vision, embeddings and thinking-level controls are not claimed."
+        },
+        "addedInPR": "https://github.com/juspay/neurolink/pull/1775"
+    }
+}

package/dist/providers/catalog/index.generated.d.ts

@@ -1,3 +1,3 @@
 import type { ProviderCatalogJson } from "../../types/index.js";
 export declare const CATALOG_JSON_ENTRIES: ProviderCatalogJson[];
-export declare const CATALOG_PROVIDER_IDS: readonly ["above-dev", "ai21", "aiand", "aionlabs", "ambient", "api-route", "arcee", "atlas-cloud", "avian-io", "baidu-qianfan", "baseten", "bee-heossi", "byteplus-modelark", "bytez", "cerebras", "charm-hyper", "chutes", "cloudflare", "crusoe", "dashscope", "deepinfra", "deepseek", "empiriolabs", "featherless-ai", "fireworks", "friendli", "gmicloud", "gradientai", "groq", "hetzner-inference", "huggingface", "inception-labs", "inceptron", "inco", "inference-net", "io-intelligence", "koscompute", "lemonfox-ai", "lilac", "llmtech", "mancer", "meta-model-api", "minimax", "mistral", "moark", "modelscope", "moonshot-ai", "morph", "nebius", "neuralwatt", "novita", "ovhcloud", "parasail", "pareto-inference", "perplexity", "poolside", "prime-intellect", "reka", "sakana-ai", "sambanova", "sarvam", "scaleway", "siliconflow", "stackit", "stepfun", "subconscious", "synthetic", "telnyx", "thinking-machines", "tinfoil", "together-ai", "umans-ai", "upstage", "venice-ai", "vispark", "vultr-inference", "wafer", "wandb-inference", "xai", "z-ai"];
+export declare const CATALOG_PROVIDER_IDS: readonly ["a2agent", "above-dev", "ai21", "aiand", "aionlabs", "ambient", "api-route", "arcee", "atlas-cloud", "avian-io", "baidu-qianfan", "baseten", "bee-heossi", "byteplus-modelark", "bytez", "cerebras", "charm-hyper", "chutes", "cloudflare", "crusoe", "dashscope", "deepinfra", "deepseek", "empiriolabs", "featherless-ai", "fireworks", "friendli", "gmicloud", "gradientai", "groq", "hetzner-inference", "huggingface", "inception-labs", "inceptron", "inco", "inference-net", "io-intelligence", "koscompute", "lemonfox-ai", "lilac", "llmtech", "mancer", "meta-model-api", "minimax", "mistral", "moark", "modelscope", "moonshot-ai", "morph", "nebius", "neuralwatt", "novita", "ovhcloud", "parasail", "pareto-inference", "perplexity", "poolside", "prime-intellect", "reka", "sakana-ai", "sambanova", "sarvam", "scaleway", "siliconflow", "stackit", "stepfun", "subconscious", "synthetic", "telnyx", "thinking-machines", "tinfoil", "together-ai", "umans-ai", "upstage", "venice-ai", "vispark", "vultr-inference", "wafer", "wandb-inference", "xai", "z-ai"];

package/dist/providers/catalog/index.generated.js

@@ -1,5 +1,6 @@
 // GENERATED FILE — do not edit. Regenerate with `pnpm run codegen:catalog`.
 // Source of truth: the per-provider JSON files in this directory.
+import a2agentJson from "./a2agent.json" with { type: "json" };
 import aboveDevJson from "./above-dev.json" with { type: "json" };
 import ai21Json from "./ai21.json" with { type: "json" };
 import aiandJson from "./aiand.json" with { type: "json" };
@@ -81,6 +82,7 @@ import wandbInferenceJson from "./wandb-inference.json" with { type: "json" };
 import xaiJson from "./xai.json" with { type: "json" };
 import zAiJson from "./z-ai.json" with { type: "json" };
 export const CATALOG_JSON_ENTRIES = [
+    a2agentJson,
     aboveDevJson,
     ai21Json,
     aiandJson,
@@ -163,6 +165,7 @@ export const CATALOG_JSON_ENTRIES = [
     zAiJson,
 ];
 export const CATALOG_PROVIDER_IDS = [
+    "a2agent",
     "above-dev",
     "ai21",
     "aiand",

package/dist/types/providerCatalog.generated.d.ts

@@ -1,2 +1,2 @@
-export type CatalogProviderName = "above-dev" | "ai21" | "aiand" | "aionlabs" | "ambient" | "api-route" | "arcee" | "atlas-cloud" | "avian-io" | "baidu-qianfan" | "baseten" | "bee-heossi" | "byteplus-modelark" | "bytez" | "cerebras" | "charm-hyper" | "chutes" | "cloudflare" | "crusoe" | "dashscope" | "deepinfra" | "deepseek" | "empiriolabs" | "featherless-ai" | "fireworks" | "friendli" | "gmicloud" | "gradientai" | "groq" | "hetzner-inference" | "huggingface" | "inception-labs" | "inceptron" | "inco" | "inference-net" | "io-intelligence" | "koscompute" | "lemonfox-ai" | "lilac" | "llmtech" | "mancer" | "meta-model-api" | "minimax" | "mistral" | "moark" | "modelscope" | "moonshot-ai" | "morph" | "nebius" | "neuralwatt" | "novita" | "ovhcloud" | "parasail" | "pareto-inference" | "perplexity" | "poolside" | "prime-intellect" | "reka" | "sakana-ai" | "sambanova" | "sarvam" | "scaleway" | "siliconflow" | "stackit" | "stepfun" | "subconscious" | "synthetic" | "telnyx" | "thinking-machines" | "tinfoil" | "together-ai" | "umans-ai" | "upstage" | "venice-ai" | "vispark" | "vultr-inference" | "wafer" | "wandb-inference" | "xai" | "z-ai";
-export type CatalogCredentialKey = "aboveDev" | "ai21" | "aiand" | "aionlabs" | "ambient" | "apiRoute" | "arcee" | "atlasCloud" | "avianIo" | "baiduQianfan" | "baseten" | "beeHeossi" | "byteplusModelark" | "bytez" | "cerebras" | "charmHyper" | "chutes" | "cloudflare" | "crusoe" | "dashscope" | "deepinfra" | "deepseek" | "empiriolabs" | "featherlessAi" | "fireworks" | "friendli" | "gmicloud" | "gradientai" | "groq" | "hetznerInference" | "huggingFace" | "inceptionLabs" | "inceptron" | "inco" | "inferenceNet" | "ioIntelligence" | "koscompute" | "lemonfoxAi" | "lilac" | "llmtech" | "mancer" | "metaModelApi" | "minimax" | "mistral" | "moark" | "modelscope" | "moonshotAi" | "morph" | "nebius" | "neuralwatt" | "novita" | "ovhcloud" | "parasail" | "paretoInference" | "perplexity" | "poolside" | "primeIntellect" | "reka" | "sakanaAi" | "sambanova" | "sarvam" | "scaleway" | "siliconflow" | "stackit" | "stepfun" | "subconscious" | "synthetic" | "telnyx" | "thinkingMachines" | "tinfoil" | "together" | "umansAi" | "upstage" | "veniceAi" | "vispark" | "vultrInference" | "wafer" | "wandbInference" | "xai" | "zAi";
+export type CatalogProviderName = "a2agent" | "above-dev" | "ai21" | "aiand" | "aionlabs" | "ambient" | "api-route" | "arcee" | "atlas-cloud" | "avian-io" | "baidu-qianfan" | "baseten" | "bee-heossi" | "byteplus-modelark" | "bytez" | "cerebras" | "charm-hyper" | "chutes" | "cloudflare" | "crusoe" | "dashscope" | "deepinfra" | "deepseek" | "empiriolabs" | "featherless-ai" | "fireworks" | "friendli" | "gmicloud" | "gradientai" | "groq" | "hetzner-inference" | "huggingface" | "inception-labs" | "inceptron" | "inco" | "inference-net" | "io-intelligence" | "koscompute" | "lemonfox-ai" | "lilac" | "llmtech" | "mancer" | "meta-model-api" | "minimax" | "mistral" | "moark" | "modelscope" | "moonshot-ai" | "morph" | "nebius" | "neuralwatt" | "novita" | "ovhcloud" | "parasail" | "pareto-inference" | "perplexity" | "poolside" | "prime-intellect" | "reka" | "sakana-ai" | "sambanova" | "sarvam" | "scaleway" | "siliconflow" | "stackit" | "stepfun" | "subconscious" | "synthetic" | "telnyx" | "thinking-machines" | "tinfoil" | "together-ai" | "umans-ai" | "upstage" | "venice-ai" | "vispark" | "vultr-inference" | "wafer" | "wandb-inference" | "xai" | "z-ai";
+export type CatalogCredentialKey = "a2agent" | "aboveDev" | "ai21" | "aiand" | "aionlabs" | "ambient" | "apiRoute" | "arcee" | "atlasCloud" | "avianIo" | "baiduQianfan" | "baseten" | "beeHeossi" | "byteplusModelark" | "bytez" | "cerebras" | "charmHyper" | "chutes" | "cloudflare" | "crusoe" | "dashscope" | "deepinfra" | "deepseek" | "empiriolabs" | "featherlessAi" | "fireworks" | "friendli" | "gmicloud" | "gradientai" | "groq" | "hetznerInference" | "huggingFace" | "inceptionLabs" | "inceptron" | "inco" | "inferenceNet" | "ioIntelligence" | "koscompute" | "lemonfoxAi" | "lilac" | "llmtech" | "mancer" | "metaModelApi" | "minimax" | "mistral" | "moark" | "modelscope" | "moonshotAi" | "morph" | "nebius" | "neuralwatt" | "novita" | "ovhcloud" | "parasail" | "paretoInference" | "perplexity" | "poolside" | "primeIntellect" | "reka" | "sakanaAi" | "sambanova" | "sarvam" | "scaleway" | "siliconflow" | "stackit" | "stepfun" | "subconscious" | "synthetic" | "telnyx" | "thinkingMachines" | "tinfoil" | "together" | "umansAi" | "upstage" | "veniceAi" | "vispark" | "vultrInference" | "wafer" | "wandbInference" | "xai" | "zAi";

package/dist/types/providers.d.ts

@@ -172,6 +172,10 @@ export type NeurolinkCredentials = {
         apiKey?: string;
         baseURL?: string;
     };
+    a2agent?: {
+        apiKey?: string;
+        baseURL?: string;
+    };
     aboveDev?: {
         apiKey?: string;
         baseURL?: string;

package/docs-site/static/search-index.json

@@ -1268,7 +1268,7 @@
 {"objectID":"f5f73efdd4286e5fadbc8e565606028eaaf1d527e37beeaaeec1910817bb072c","title":"Recognition","url":"/docs/community/contributing#recognition","content":"We value all contributions! Contributors are:\nListed in our Contributors page\nMentioned in release notes\nGiven credit in the changelog","hierarchy":{"lvl0":"Community","lvl1":"🤝 Contributing to NeuroLink","lvl2":"Recognition","lvl3":""}},
 {"objectID":"4bb17f9c985c0b3f6575474dc003fc5a5bb94668d98a8071d6852c14dad1796f","title":"🎯 Current Focus Areas","url":"/docs/community/contributing#-current-focus-areas","content":"We're particularly interested in contributions for:\nProvider Support - Adding new AI providers\nTool Integration - MCP external server activation\nPerformance - Optimization and benchmarking\nDocumentation - Tutorials and guides\nTesting - Increasing test coverage","hierarchy":{"lvl0":"Community","lvl1":"🤝 Contributing to NeuroLink","lvl2":"🎯 Current Focus Areas","lvl3":""}},
 {"objectID":"f88b7ad80d1f2c3206d04b9cbcae88e51d4e58e1d133a35f909db9a3504d8535","title":"📝 License","url":"/docs/community/contributing#-license","content":"By contributing to NeuroLink, you agree that your contributions will be licensed under the MIT License.\n\nThank you for contributing to NeuroLink! 🚀","hierarchy":{"lvl0":"Community","lvl1":"🤝 Contributing to NeuroLink","lvl2":"📝 License","lvl3":""}},
-{"objectID":"e79e61b456a7d08d82af7d1db7a9208b9742297f6704005da3bb2c755d4a47c7","title":"Automatic","url":"/docs/connectors/automatic","content":"Automatic\n\nStatus: ✅ Production\nType: Consumer intelligence · Operations hub\nStack: SvelteKit + NeuroLink SDK + Shopify API\n\nPurpose\n\nAutomatic is a Shopify merchant operations connector. It routes order and address data through NeuroLink's pipe to surface address quality grades and return-to-origin (RTO) risk scores — giving merchants AI-driven insight on every order before fulfillment.\n\nStream Types\n\n| Stream                  | Direction | Description                                                 |\n| ----------------------- | --------- | ----------------------------------------------------------- |\n| Shopify order data      | → Pipe    | Orders fetched via Shopify GraphQL and Vayu backend         |\n| Address strings         | → Pipe    | Delivery addresses sent to external validation service      |\n| Pincode + order context | → Pipe    | COD flag, order value, address score for RTO model          |\n| Validation results      | Pipe →    | Grade (A–E), score (0–100), spam flag, missing fields       |\n| RTO assessment          | Pipe →    | Risk level (HIGH/MEDIUM/LOW), probability %, reason factors |\n\nInput / Output Contract\n\nPOST /automatic/analytics\n\nReturns: Array of Shopify order nodes with full order data.\n\nPOST /automatic/address\n\nReturns:\n\nPOST /automatic/rto\n\nReturns:\n\nPOST /automatic/rto/pincode\n\nReturns: { \"isRtoPincode\": true }\n\nNeuroLink Integration\n\nAutomatic uses NeuroLink for MCP tool registry, HITL conversation types, and OpenTelemetry observability. Provider selection happens at generation time in other parts of the application.\n\nFeatures used:\nMCP tool registry and execution\nOpenTelemetry logging (DEBUG / INFO / WARN / ERROR severity)\nHITL types from @juspay/neurolink/dist/types/hitlTypes\nConversation memory configuration types\n\nGateway Unlocked\n\nAutomatic gives Shopify merchants:\nAddress intelligence — grade every delivery address before shipping\nRTO prediction — flag high-risk orders (COD + bad pincode + low address score)\nOperational clarity — every order carries an AI risk signal, no manual review needed\n\nOperational Notes\nAddress validation and 2-second UX delay run concurrently via Promise.all()\nRequest bodies validated with type decoders and Zod schemas\nAll endpoints return createFailureResponse() (400) on error with descriptive message\nNeuroLink instance lazy-initialized — ensureToolsRegistered() called on first use\nSession auth: Shopify session tokens via validateAuth() middleware","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"","lvl3":""}},
+{"objectID":"e79e61b456a7d08d82af7d1db7a9208b9742297f6704005da3bb2c755d4a47c7","title":"Automatic","url":"/docs/connectors/automatic","content":"Automatic\n\nStatus: ✅ Production\nType: Consumer intelligence · Operations hub\nStack: SvelteKit + NeuroLink SDK + Shopify API\n\nPurpose\n\nAutomatic is a Shopify merchant operations connector. It routes order and address data through NeuroLink's pipe to surface address quality grades and return-to-origin (RTO) risk scores — giving merchants AI-driven insight on every order before fulfillment.\n\nStream Types\n\n| Stream                  | Direction | Description                                                 |\n| ----------------------- | --------- | ----------------------------------------------------------- |\n| Shopify order data      | → Pipe    | Orders fetched via Shopify GraphQL and Vayu backend         |\n| Address strings         | → Pipe    | Delivery addresses sent to external validation service      |\n| Pincode + order context | → Pipe    | COD flag, order value, address score for RTO model          |\n| Validation results      | Pipe →    | Grade (A–E), score (0–100), spam flag, missing fields       |\n| RTO assessment          | Pipe →    | Risk level (HIGH/MEDIUM/LOW), probability %, reason factors |\n\nInput / Output Contract\n\nPOST /automatic/analytics\n\nReturns: Array of Shopify order nodes with full order data.\n\nPOST /automatic/address\n\nReturns:\n\nPOST /automatic/rto\n\nReturns:\n\nPOST /automatic/rto/pincode\n\nReturns: { \"isRtoPincode\": true }\n\nNeuroLink Integration\n\nAutomatic uses NeuroLink for MCP tool registry, HITL conversation types, and OpenTelemetry observability. Provider selection happens at generation time in other parts of the application.\n\nFeatures used:\nMCP tool registry and execution\nOpenTelemetry logging (DEBUG / INFO / WARN / ERROR severity)\nHITL types from @juspay/neurolink\nConversation memory configuration types\n\nGateway Unlocked\n\nAutomatic gives Shopify merchants:\nAddress intelligence — grade every delivery address before shipping\nRTO prediction — flag high-risk orders (COD + bad pincode + low address score)\nOperational clarity — every order carries an AI risk signal, no manual review needed\n\nOperational Notes\nAddress validation and 2-second UX delay run concurrently via Promise.all()\nRequest bodies validated with type decoders and Zod schemas\nAll endpoints return createFailureResponse() (400) on error with descriptive message\nNeuroLink instance lazy-initialized — ensureToolsRegistered() called on first use\nSession auth: Shopify session tokens via validateAuth() middleware","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"","lvl3":""}},
 {"objectID":"de5dd97b5cff947efcff1a1224ddf4b64296bb3ce017a2c627ab88120a6d63b6","title":"Automatic","url":"/docs/connectors/automatic#automatic","content":"Status: ✅ Production\nType: Consumer intelligence · Operations hub\nStack: SvelteKit + NeuroLink SDK + Shopify API","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"Automatic","lvl3":""}},
 {"objectID":"80d1ddf5f066c98190b83e53fc449a51c4d4f24646ae3428c02a7648166d4ce5","title":"Purpose","url":"/docs/connectors/automatic#purpose","content":"Automatic is a Shopify merchant operations connector. It routes order and address data through NeuroLink's pipe to surface address quality grades and return-to-origin (RTO) risk scores — giving merchants AI-driven insight on every order before fulfillment.","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"Purpose","lvl3":""}},
 {"objectID":"c2b720f9555688be2e4bb98a65c88136c15d11e8fc8aec9c002858fed0060764","title":"Stream Types","url":"/docs/connectors/automatic#stream-types","content":"| Stream                  | Direction | Description                                                 |\n| ----------------------- | --------- | ----------------------------------------------------------- |\n| Shopify order data      | → Pipe    | Orders fetched via Shopify GraphQL and Vayu backend         |\n| Address strings         | → Pipe    | Delivery addresses sent to external validation service      |\n| Pincode + order context | → Pipe    | COD flag, order value, address score for RTO model          |\n| Validation results      | Pipe →    | Grade (A–E), score (0–100), spam flag, missing fields       |\n| RTO assessment          | Pipe →    | Risk level (HIGH/MEDIUM/LOW), probability %, reason factors |","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"Stream Types","lvl3":""}},
@@ -1276,7 +1276,7 @@
 {"objectID":"ae1ffeb7537ba19800e5cd2c90236a2beaf6c1764670b4735ddcab468c7bed2b","title":"POST /automatic/address","url":"/docs/connectors/automatic#post-automaticaddress","content":"Returns:","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"POST /automatic/address","lvl3":""}},
 {"objectID":"57befbc7f7f6e32d1815c6b35496d8212cfe8b98ded1a2d89117e2b0fd2775f9","title":"POST /automatic/rto","url":"/docs/connectors/automatic#post-automaticrto","content":"Returns:","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"POST /automatic/rto","lvl3":""}},
 {"objectID":"71d1f27e3a563db07f1dee966ee2e5790e43d95d426da6c6721cfe8a226289b8","title":"POST /automatic/rto/pincode","url":"/docs/connectors/automatic#post-automaticrtopincode","content":"Returns: { \"isRtoPincode\": true }","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"POST /automatic/rto/pincode","lvl3":""}},
-{"objectID":"6a46accc0bc04e2dbe7f1408f66bcc70d671a0be83f15d8e9106dde2839f1e8a","title":"NeuroLink Integration","url":"/docs/connectors/automatic#neurolink-integration","content":"Automatic uses NeuroLink for MCP tool registry, HITL conversation types, and OpenTelemetry observability. Provider selection happens at generation time in other parts of the application.\n\nFeatures used:\nMCP tool registry and execution\nOpenTelemetry logging (DEBUG / INFO / WARN / ERROR severity)\nHITL types from @juspay/neurolink/dist/types/hitlTypes\nConversation memory configuration types","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"NeuroLink Integration","lvl3":""}},
+{"objectID":"6a46accc0bc04e2dbe7f1408f66bcc70d671a0be83f15d8e9106dde2839f1e8a","title":"NeuroLink Integration","url":"/docs/connectors/automatic#neurolink-integration","content":"Automatic uses NeuroLink for MCP tool registry, HITL conversation types, and OpenTelemetry observability. Provider selection happens at generation time in other parts of the application.\n\nFeatures used:\nMCP tool registry and execution\nOpenTelemetry logging (DEBUG / INFO / WARN / ERROR severity)\nHITL types from @juspay/neurolink\nConversation memory configuration types","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"NeuroLink Integration","lvl3":""}},
 {"objectID":"5ef8d3e6cca7cfeb1be6c53321971b9ec0ed36ead39f7f673658dcb352a2b593","title":"Gateway Unlocked","url":"/docs/connectors/automatic#gateway-unlocked","content":"Automatic gives Shopify merchants:\nAddress intelligence — grade every delivery address before shipping\nRTO prediction — flag high-risk orders (COD + bad pincode + low address score)\nOperational clarity — every order carries an AI risk signal, no manual review needed","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"Gateway Unlocked","lvl3":""}},
 {"objectID":"0115690e3895bb4454bd957ea1827e28be41d82f8e88210c7a485205d74c9d68","title":"Operational Notes","url":"/docs/connectors/automatic#operational-notes","content":"Address validation and 2-second UX delay run concurrently via Promise.all()\nRequest bodies validated with type decoders and Zod schemas\nAll endpoints return createFailureResponse() (400) on error with descriptive message\nNeuroLink instance lazy-initialized — ensureToolsRegistered() called on first use\nSession auth: Shopify session tokens via validateAuth() middleware","hierarchy":{"lvl0":"Connectors","lvl1":"Automatic","lvl2":"Operational Notes","lvl3":""}},
 {"objectID":"fa95e01efb0a0501fb1705d149d82391f46c1a9e720f821d8625568a966346ac","title":"Connector Catalog","url":"/docs/connectors","content":"Connector Catalog\n\nConnectors are applications built on NeuroLink that open a specific gateway — a new way for people or systems to access and experience AI.\n\nEvery connector follows the same pattern:\n\nThe pipe handles provider dispatch, context building, tool execution, and memory. The connector decides what flows through it and what happens at each end.\n\nProduction Connectors\n\n| Connector                               | Status        | Gateway                                   | Provider                |\n| --------------------------------------- | ------------- | ----------------------------------------- | ----------------------- |\n| Automatic | ✅ Production | Consumer intelligence · Operations risk   | NeuroLink SDK           |\n| Tara           | ✅ Production | Engineering assistance · Self-improvement | Vertex AI via NeuroLink |\n| Yama           | ✅ Production | Code quality · Automated governance       | LiteLLM via NeuroLink   |\n\nBuilding Your Own Connector\n\nAny application that imports NeuroLink and connects it to a data source or action surface is a connector. Study the production connectors above — then build yours.\n\nStart with: Quick Start →","hierarchy":{"lvl0":"Connectors","lvl1":"Connector Catalog","lvl2":"","lvl3":""}},
@@ -4331,13 +4331,13 @@
 {"objectID":"4f7347e1213c98df50781c6e08637edf26a9230b6cde930cb8d61cdaac35743f","title":"Log specific components","url":"/docs/features/rag#log-specific-components","content":"DEBUG=neurolink:rag:chunker pnpm exec tsx your-script.ts\nDEBUG=neurolink:rag:reranker pnpm exec tsx your-script.ts\nDEBUG=neurolink:rag:hybrid pnpm exec tsx your-script.ts\n`","hierarchy":{"lvl0":"Features","lvl1":"RAG Document Processing Guide","lvl2":"Log specific components","lvl3":""}},
 {"objectID":"79ce1d456fd4fd9c06bf8aab0a9244c950872cdea1eb786fbed8c98444e51377","title":"Core Exports","url":"/docs/features/rag#core-exports","content":"Document Processing:\nloadDocument(path) - Load a single document\nloadDocuments(paths) - Load multiple documents\nMDocument - Fluent document processing class\nprocessDocument(text, options) - Process text through chunking and metadata extraction\n\nChunking:\ncreateChunker(strategy, config) - Create a chunker instance\nChunkerFactory - Factory for chunker creation\nChunkerRegistry - Registry with all chunker implementations\ngetAvailableStrategies() - List available chunking strategies\ngetRecommendedStrategy(contentType) - Get recommended strategy for content type\n\nReranking:\ncreateReranker(type, config) - Create a reranker instance\nRerankerFactory - Factory for reranker creation\nRerankerRegistry - Registry with all reranker implementations\ngetAvailableRerankerTypes() - List available reranker types\nrerank(results, query, model) - Direct reranking function\nbatchRerank(results, query, options) - Batch reranking\n\nRetrieval:\ncreateHybridSearch(config) - Create hybrid search instance\nInMemoryBM25Index - In-memory BM25 index\nInMemoryVectorStore - In-memory vector store\nreciprocalRankFusion(rankings, k) - RRF score fusion\nlinearCombination(vectorScores, bm25Scores, alpha) - Linear score fusion\ncreateVectorQueryTool(vectorStore, options) - Create vector query tool\n\nMetadata:\ncreateMetadataExtractor(type, config) - Create metadata extractor\nLLMMetadataExtractor - LLM-powered extractor class\nextractMetadata(chunks, params) - Extract metadata from chunks\n\nPipeline:\nRAGPipeline - Full RAG pipeline class\ncreateRAGPipeline(config) - Create pipeline instance\nassembleContext(chunks, options) - Assemble context from chunks\nformatContextWithCitations(chunks, format) - Format with citations\n\nResilience:\nRAGCircuitBreaker - Circuit breaker pattern for RAG operations\nRAGRetryHandler - Retry with exponential backoff and jitter\n\nTypes:\nChunk, ChunkMetadata, ChunkerConfig\nReranker, RerankerConfig, RerankerType\nHybridSearchOptions, BM25Config\nRAGPipelineConfig, RAGResponse\nMetadataExtractor, Metad","hierarchy":{"lvl0":"Features","lvl1":"RAG Document Processing Guide","lvl2":"Core Exports","lvl3":""}},
 {"objectID":"a5a323f35e894680ca74c75bd4c91f4ed7a1a3f8f4783bc1cef0d6a2c738a4d7","title":"See Also","url":"/docs/features/rag#see-also","content":"RAG Configuration Guide - Detailed configuration reference\nRAG Testing Guide - Testing RAG pipelines\nObservability Guide - Tracing and monitoring\nGuardrails Guide - Input/output validation\nVector Store Integrations - Production vector stores","hierarchy":{"lvl0":"Features","lvl1":"RAG Document Processing Guide","lvl2":"See Also","lvl3":""}},
-{"objectID":"8520c68d4d7a4320716d52b9cc0ac0f75a1ce3eafa30ad50b9f196f7d2a4e49c","title":"Real-time Voice Services","url":"/docs/features/real-time-services","content":"NeuroLink integrates the two major realtime voice APIs behind a single, provider-agnostic interface: OpenAI Realtime (openai-realtime) and Google Gemini Live (gemini-live). These let you build full-duplex voice agents where audio streams in and out simultaneously, with the model responding mid-utterance and calling tools in-flight.\n\nRealtime voice is exposed through the RealtimeProcessor static class (not a method on the NeuroLink instance). For non-realtime synthesis and transcription, see the TTS Guide and STT Guide.\n\nOverview\n\n| Capability     | openai-realtime               | gemini-live                   |\n| -------------- | ------------------------------- | ------------------------------- |\n| Provider value | \"openai-realtime\"             | \"gemini-live\"                 |\n| Transport      | WebSocket                       | WebSocket / WebRTC              |\n| Modalities     | audio in/out, text in/out       | audio in/out, text, video       |\n| Tool calls     | Yes (via onFunctionCall)      | Yes (via onFunctionCall)      |\n| Interruption   | Server-side VAD + manual cancel | Native barge-in + manual cancel |\n\nBoth APIs support concurrent audio input and output streams, so the user can interrupt the model mid-response and the model can stream audio while still listening for new input.\n\nQuick Start (SDK)\n\nThe RealtimeProcessor is a static class — there is no new RealtimeProcessor() and no neurolink.openRealtimeSession(...) method. Connect with RealtimeProcessor.connect(provider, config, handlers):\n\nThe handler shape is provider-agnostic: the same RealtimeEventHandlers object works across both providers, so you can switch with a single string change.\n\nEvent handler reference\n\nQuick Start (CLI)\n\nNeuroLink does not ship a neurolink voice realtime interactive CLI. Instead, the realtime voice server is exposed via:\n\nConnect a browser/mobile client to ws://localhost:8081/voice to drive the session. The server bridges the client to the chosen provider (configured via env vars and per-session messages) and forwards events bidirectionally.\n\nThe TTS and STT flags on generate / stream (e.g. --tts, --stt, --input-audio) are for non-realtime synthesis and transcription — see TTS and STT.\n\nSelf-hosted Realtime Voice Server\n\nFor multi-tenant deployments — voice bots, IVR-style applications, in-app voice features — NeuroLink ships a real-time voice agent server. It bridges browser/mobile clients to provider realtime APIs with session management, observability, and tool routing.\n\nNote: the server is a function export (startVoiceServer), not a NeuroLinkVoiceServer class. To run it from the CLI, prefer npx @juspay/neurolink serve voice --port 8081.\n\nThe server emits OTEL spans + Langfuse traces per session, supports HITL approvals on tool calls, and can be deployed standalone or behind your own gateway.\n\nProvider Selection\n\n| Use case                                                  | Recommended provider                                  |\n| --------------------------------------------------------- | ----------------------------------------------------- |\n| English-first, broad voice catalog, GPT-4o reasoning      | openai-realtime                                     |\n| Multilingual, video input, lowest latency in many regions | gemini-live                                         |\n| Customer support voice bots with structured tool calls    | openai-realtime (more deterministic function calls) |\n| In-app voice search / multimodal queries                  | gemini-live                                         |\n\nEither can be wrapped behind providerFallback so a model-access denial automatically falls through to the alternate model. See Provider Fallback — note that the orchestrator only triggers on access-denied errors, not on rate limits or generic failures.\n\nTool Calls Inside Realtime Sessions\n\nBoth providers can call functions registered with the realtime session. Use the onFunctionCall handler (not onToolCall — that name is reserved for the streaming-text API):\n\nWhen HITL middleware is wired in front of the function-call handler, sensitive operations (e.g. cancelOrder, chargeCard) pause for human approval before responding back into the realtime stream.\n\nObservability\n\nRealtime sessions emit:\nsession:start, session:end events with duration + token usage\nPer-utterance transcript:user, transcript:assistant events\ntool:call, tool:result events\naudio:in:bytes, audio:out:bytes for bandwidth tracking\n\nThese flow into the same OTEL/Langfuse pipeline as text generation. See the Observability Guide.\n\nStatus & Inspection\n\nRelated\nTTS Guide — non-realtime text-to-speech (6 providers)\nSTT Guide — transcription (4 providers)\nVoice Agent Guide — building voice agents end-to-end\nProvider Fallback — failover between models on access denial\nObservability — wiring fallback events into your monitoring stack","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"","lvl3":""}},
+{"objectID":"8520c68d4d7a4320716d52b9cc0ac0f75a1ce3eafa30ad50b9f196f7d2a4e49c","title":"Real-time Voice Services","url":"/docs/features/real-time-services","content":"NeuroLink integrates the two major realtime voice APIs behind a single, provider-agnostic interface: OpenAI Realtime (openai-realtime) and Google Gemini Live (gemini-live). These let you build full-duplex voice agents where audio streams in and out simultaneously, with the model responding mid-utterance and calling tools in-flight.\n\nRealtime voice is exposed through the RealtimeProcessor static class (not a method on the NeuroLink instance). For non-realtime synthesis and transcription, see the TTS Guide and STT Guide.\n\nOverview\n\n| Capability     | openai-realtime               | gemini-live                   |\n| -------------- | ------------------------------- | ------------------------------- |\n| Provider value | \"openai-realtime\"             | \"gemini-live\"                 |\n| Transport      | WebSocket                       | WebSocket / WebRTC              |\n| Modalities     | audio in/out, text in/out       | audio in/out, text, video       |\n| Tool calls     | Yes (via onFunctionCall)      | Yes (via onFunctionCall)      |\n| Interruption   | Server-side VAD + manual cancel | Native barge-in + manual cancel |\n\nBoth APIs support concurrent audio input and output streams, so the user can interrupt the model mid-response and the model can stream audio while still listening for new input.\n\nQuick Start (SDK)\n\nThe RealtimeProcessor is a static class — there is no new RealtimeProcessor() and no neurolink.openRealtimeSession(...) method. Connect with RealtimeProcessor.connect(provider, config, handlers):\n\nThe handler shape is provider-agnostic: the same RealtimeEventHandlers object works across both providers, so you can switch with a single string change.\n\nEvent handler reference\n\nQuick Start (CLI)\n\nNeuroLink does not ship a neurolink voice realtime interactive CLI. Instead, the realtime voice server is exposed via:\n\nConnect a browser/mobile client to ws://localhost:8081/voice to drive the session. The server bridges the client to the chosen provider (configured via env vars and per-session messages) and forwards events bidirectionally.\n\nThe TTS and STT flags on generate / stream (e.g. --tts, --stt, --input-audio) are for non-realtime synthesis and transcription — see TTS and STT.\n\nSelf-hosted Realtime Voice Server\n\nFor multi-tenant deployments — voice bots, IVR-style applications, in-app voice features — NeuroLink ships a real-time voice agent server. It bridges browser/mobile clients to provider realtime APIs with session management, observability, and tool routing.\n\nNote: the server is launched from the CLI, as in Quick Start (CLI) above. startVoiceServer, the function behind that command, is internal: it is a function rather than a NeuroLinkVoiceServer class, and the package does not export it, so there is no supported import path for starting it from code.\n\nThe server emits OTEL spans + Langfuse traces per session, supports HITL approvals on tool calls, and can be deployed standalone or behind your own gateway.\n\nProvider Selection\n\n| Use case                                                  | Recommended provider                                  |\n| --------------------------------------------------------- | ----------------------------------------------------- |\n| English-first, broad voice catalog, GPT-4o reasoning      | openai-realtime                                     |\n| Multilingual, video input, lowest latency in many regions | gemini-live                                         |\n| Customer support voice bots with structured tool calls    | openai-realtime (more deterministic function calls) |\n| In-app voice search / multimodal queries                  | gemini-live                                         |\n\nEither can be wrapped behind providerFallback so a model-access denial automatically falls through to the alternate model. See Provider Fallback — note that the orchestrator only triggers on access-denied errors, not on rate limits or generic failures.\n\nTool Calls Inside Realtime Sessions\n\nBoth providers can call functions registered with the realtime session. Use the onFunctionCall handler (not onToolCall — that name is reserved for the streaming-text API):\n\nWhen HITL middleware is wired in front of the function-call handler, sensitive operations (e.g. cancelOrder, chargeCard) pause for human approval before responding back into the realtime stream.\n\nObservability\n\nRealtime sessions emit:\nsession:start, session:end events with duration + token usage\nPer-utterance transcript:user, transcript:assistant events\ntool:call, tool:result events\naudio:in:bytes, audio:out:bytes for bandwidth tracking\n\nThese flow into the same OTEL/Langfuse pipeline as text generation. See the Observability Guide.\n\nStatus & Inspection\n\nRelated\nTTS Guide — non-realtime text-to-speech (6 providers)\nSTT Guide — transcription (4 providers)\nVoice Agent Guide — building voice agents end-to-end\nProvider Fallback — failover between models on access denial\nObservability — wiring fallback events into your monitoring stack","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"","lvl3":""}},
 {"objectID":"87b8bb1f37916fade5b273a6037c4aedf9a1a2e425352b238a961c192b64e7ea","title":"Overview","url":"/docs/features/real-time-services#overview","content":"| Capability     | openai-realtime               | gemini-live                   |\n| -------------- | ------------------------------- | ------------------------------- |\n| Provider value | \"openai-realtime\"             | \"gemini-live\"                 |\n| Transport      | WebSocket                       | WebSocket / WebRTC              |\n| Modalities     | audio in/out, text in/out       | audio in/out, text, video       |\n| Tool calls     | Yes (via onFunctionCall)      | Yes (via onFunctionCall)      |\n| Interruption   | Server-side VAD + manual cancel | Native barge-in + manual cancel |\n\nBoth APIs support concurrent audio input and output streams, so the user can interrupt the model mid-response and the model can stream audio while still listening for new input.","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Overview","lvl3":""}},
 {"objectID":"e67429fee6cb4d4138a61d5d6377ce42f05311ca590c7e2af4d5f67ed9937e00","title":"Quick Start (SDK)","url":"/docs/features/real-time-services#quick-start-sdk","content":"The RealtimeProcessor is a static class — there is no new RealtimeProcessor() and no neurolink.openRealtimeSession(...) method. Connect with RealtimeProcessor.connect(provider, config, handlers):\n\nThe handler shape is provider-agnostic: the same RealtimeEventHandlers object works across both providers, so you can switch with a single string change.","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Quick Start (SDK)","lvl3":""}},
 {"objectID":"908a71813f0c74c8d299bb8054a7b1bda254ec6d642e6fe6ccf8bd8e5eab09bf","title":"Quick Start (CLI)","url":"/docs/features/real-time-services#quick-start-cli","content":"NeuroLink does not ship a neurolink voice realtime interactive CLI. Instead, the realtime voice server is exposed via:\n\n`bash","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Quick Start (CLI)","lvl3":""}},
 {"objectID":"75191549698a180302a3c5cc8a569ae56746610c861afdb6ac16423dde6dfcab","title":"Canonical: start the realtime voice WebSocket server","url":"/docs/features/real-time-services#canonical-start-the-realtime-voice-websocket-server","content":"npx @juspay/neurolink serve voice --port 8081","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Canonical: start the realtime voice WebSocket server","lvl3":""}},
 {"objectID":"7d1d459e2f376156ae554f68c93ffef4fcb5c86abdd088cb5f2fcbc5a1fe905a","title":"Deprecated alias (still works, prints a deprecation notice)","url":"/docs/features/real-time-services#deprecated-alias-still-works-prints-a-deprecation-notice","content":"npx @juspay/neurolink voice-server --port 8081\n\n\nConnect a browser/mobile client to ws://localhost:8081/voice to drive the session. The server bridges the client to the chosen provider (configured via env vars and per-session messages) and forwards events bidirectionally.\n\nThe TTS and STT _flags_ on generate / stream (e.g. --tts, --stt, --input-audio`) are for non-realtime synthesis and transcription — see TTS and STT.","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Deprecated alias (still works, prints a deprecation notice)","lvl3":""}},
-{"objectID":"c140aba9971425669727df00fba1b8ac11cdd873fd27a03933c575301dbd3bef","title":"Self-hosted Realtime Voice Server","url":"/docs/features/real-time-services#self-hosted-realtime-voice-server","content":"For multi-tenant deployments — voice bots, IVR-style applications, in-app voice features — NeuroLink ships a real-time voice agent server. It bridges browser/mobile clients to provider realtime APIs with session management, observability, and tool routing.\n\nNote: the server is a function export (startVoiceServer), not a NeuroLinkVoiceServer class. To run it from the CLI, prefer npx @juspay/neurolink serve voice --port 8081.\n\nThe server emits OTEL spans + Langfuse traces per session, supports HITL approvals on tool calls, and can be deployed standalone or behind your own gateway.","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Self-hosted Realtime Voice Server","lvl3":""}},
+{"objectID":"c140aba9971425669727df00fba1b8ac11cdd873fd27a03933c575301dbd3bef","title":"Self-hosted Realtime Voice Server","url":"/docs/features/real-time-services#self-hosted-realtime-voice-server","content":"For multi-tenant deployments — voice bots, IVR-style applications, in-app voice features — NeuroLink ships a real-time voice agent server. It bridges browser/mobile clients to provider realtime APIs with session management, observability, and tool routing.\n\nNote: the server is launched from the CLI, as in Quick Start (CLI) above. startVoiceServer, the function behind that command, is internal: it is a function rather than a NeuroLinkVoiceServer class, and the package does not export it, so there is no supported import path for starting it from code.\n\nThe server emits OTEL spans + Langfuse traces per session, supports HITL approvals on tool calls, and can be deployed standalone or behind your own gateway.","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Self-hosted Realtime Voice Server","lvl3":""}},
 {"objectID":"bd64662bc081839e65fa0142f0f05090121ed145e2df85dc04bc4da3eedad07d","title":"Provider Selection","url":"/docs/features/real-time-services#provider-selection","content":"| Use case                                                  | Recommended provider                                  |\n| --------------------------------------------------------- | ----------------------------------------------------- |\n| English-first, broad voice catalog, GPT-4o reasoning      | openai-realtime                                     |\n| Multilingual, video input, lowest latency in many regions | gemini-live                                         |\n| Customer support voice bots with structured tool calls    | openai-realtime (more deterministic function calls) |\n| In-app voice search / multimodal queries                  | gemini-live                                         |\n\nEither can be wrapped behind providerFallback so a model-access denial automatically falls through to the alternate model. See Provider Fallback — note that the orchestrator only triggers on access-denied errors, not on rate limits or generic failures.","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Provider Selection","lvl3":""}},
 {"objectID":"491a5c18055e328dafca470921c76a02c447e8212d99904e7964b0021f3c08ab","title":"Tool Calls Inside Realtime Sessions","url":"/docs/features/real-time-services#tool-calls-inside-realtime-sessions","content":"Both providers can call functions registered with the realtime session. Use the onFunctionCall handler (not onToolCall — that name is reserved for the streaming-text API):\n\nWhen HITL middleware is wired in front of the function-call handler, sensitive operations (e.g. cancelOrder, chargeCard) pause for human approval before responding back into the realtime stream.","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Tool Calls Inside Realtime Sessions","lvl3":""}},
 {"objectID":"b245605b86c76d4a79fc9b4399211a7fa803e23fe9dfb682b81c5853af40ae37","title":"Observability","url":"/docs/features/real-time-services#observability","content":"Realtime sessions emit:\nsession:start, session:end events with duration + token usage\nPer-utterance transcript:user, transcript:assistant events\ntool:call, tool:result events\naudio:in:bytes, audio:out:bytes for bandwidth tracking\n\nThese flow into the same OTEL/Langfuse pipeline as text generation. See the Observability Guide.","hierarchy":{"lvl0":"Features","lvl1":"Real-time Voice Services","lvl2":"Observability","lvl3":""}},
@@ -9799,7 +9799,7 @@
 {"objectID":"61a3976ba8f1c5eeed456f7af64d3274a0fd5bf8ee77fe201de27295f5b403cb","title":"8. Documentation Verification","url":"/docs/rag/VERIFICATION#8-documentation-verification","content":"| Document         | Exists | Accurate | Complete | Status |\n| ---------------- | ------ | -------- | -------- | ------ |\n| TESTING.md       | [ ]    | [ ]      | [ ]      | [ ]    |\n| CONFIGURATION.md | [ ]    | [ ]      | [ ]      | [ ]    |\n| VERIFICATION.md  | [ ]    | [ ]      | [ ]      | [ ]    |\n| CLI-COVERAGE.md  | [ ]    | [ ]      | [ ]      | [ ]    |","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - Manual Verification Checklist","lvl2":"8. Documentation Verification","lvl3":""}},
 {"objectID":"83f7357fa2d3b81496d704bba2ae12343314f32e2ccec6dae2248e63867cddca","title":"Sign-off","url":"/docs/rag/VERIFICATION#sign-off","content":"| Role      | Name | Date | Signature |\n| --------- | ---- | ---- | --------- |\n| Developer |      |      |           |\n| QA        |      |      |           |\n| Tech Lead |      |      |           |","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - Manual Verification Checklist","lvl2":"Sign-off","lvl3":""}},
 {"objectID":"574e58b2065b4cf4518e5cbf15dfd86d2bea4091d742c3eeb19a4f89f28fbfc5","title":"Notes","url":"/docs/rag/VERIFICATION#notes","content":"Add any observations, issues, or recommendations here:","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - Manual Verification Checklist","lvl2":"Notes","lvl3":""}},
-{"objectID":"9b3ba67e38b636436e6b2f378b85e8b14b45f30f68b91afe7597703a50c9d82a","title":"Analytics Reference","url":"/docs/reference/analytics","content":"Analytics Reference\n\nNeuroLink provides comprehensive analytics capabilities for tracking token usage, costs, performance metrics, and quality evaluation across your configured AI provider interactions.\n\nOverview\n\nThe analytics system in NeuroLink consists of several interconnected components:\n\n| Component                  | Purpose                                                         |\n| -------------------------- | --------------------------------------------------------------- |\n| Token Usage Tracking   | Monitor input/output tokens, cache tokens, and reasoning tokens |\n| Cost Analytics         | Estimate and track costs across providers and models            |\n| Performance Metrics    | Measure response times, throughput, and memory usage            |\n| Quality Evaluation     | Assess response relevance, accuracy, and completeness           |\n| Middleware Integration | Automatic analytics collection via middleware                   |\n\nToken Usage Tracking\n\nBasic Token Usage\n\nNeuroLink automatically tracks token usage for every generation:\n\nTokenUsage Type\n\nThe TokenUsage type provides detailed token information:\n\nCache Token Tracking\n\nFor providers that support prompt caching (Anthropic, Google), NeuroLink tracks cache metrics:\n\nReasoning Token Tracking\n\nFor models with extended thinking capabilities (OpenAI o1, Anthropic Claude with thinking, Gemini 3):\n\nCost Analytics\n\nAutomatic Cost Estimation\n\nNeuroLink automatically estimates costs based on provider pricing:\n\nCost Calculation Formula\n\nCosts are calculated using per-token pricing:\n\nProvider Pricing Configuration\n\nNeuroLink uses configurable pricing for each provider:\n\n| Provider      | Default Input Cost (per 1K) | Default Output Cost (per 1K) |\n| ------------- | --------------------------- | ---------------------------- |\n| OpenAI        | $0.00015                    | $0.0006                      |\n| Anthropic     | $0.0015                     | $0.0075                      |\n| Google AI     | $0.000075                   | $0.0003                      |\n| Google Vertex | $0.000075                   | $0.0003                      |\n| Bedrock       | $0.0015                     | $0.0075                      |\n| Azure         | $0.00015                    | $0.0006                      |\n| Mistral       | $0.0001                     | $0.0003                      |\n| HuggingFace   | $0.0002                     | $0.0008                      |\n| Ollama        | $0                          | $0                           |\n\nCustom Cost Configuration\n\nOverride default pricing via environment variables:\n\nAggregating Costs\n\nTrack cumulative costs across multiple requests:\n\nPerformance Metrics\n\nResponse Time Tracking\n\nEvery request automatically tracks response time:\n\nAnalyticsData Structure\n\nThe complete analytics data structure:\n\nPerformance Metrics Type\n\nFor advanced performance tracking:\n\nStream Performance Metrics\n\nFor streaming requests, additional metrics are available:\n\nStreaming Example\n\nQuality Evaluation\n\nEnabling Evaluation\n\nNeuroLink can automatically evaluate response quality:\n\nEvaluationData Structure\n\nDomain-Aware Evaluation\n\nConfigure evaluation for specific domains:\n\nEvaluation Providers\n\nEvaluation can use different providers:\n\nAnalytics Middleware\n\nUsing Analytics Middleware\n\nNeuroLink provides built-in analytics middleware:\n\nMiddleware Metadata\n\nThe analytics middleware provides:\n\nCustom Analytics Collection\n\nImplement custom analytics collection:\n\nAnalytics Utilities\n\nFormatting Utilities\n\nValidation Utilities\n\nIntegration with Observability Tools\n\nOpenTelemetry Integration\n\nExport analytics to OpenTelemetry:\n\nPrometheus Metrics\n\nExport metrics to Prometheus:\n\nDataDog Integration\n\nSend analytics to DataDog:\n\nCustom Logging\n\nStructured logging with analytics:\n\nUsage Statistics\n\nTracking Usage Over Time\n\nBuild usage dashboards with aggregated statistics:\n\nRate Limiting Based on Usage\n\nImplement rate limiting using analytics:\n\nCLI Analytics\n\nViewing Analytics in CLI\n\nVerbose Analytics\n\nBest Practices\nAlways Enable Analytics in Production\nMonitor Cost Alerts\nTrack Token Efficiency\nImplement Budget Controls\n\nRelated Documentation\nConfiguration Reference - Configure analytics settings\nProvider Comparison - Compare provider costs\nTroubleshooting - Debug analytics issues\nError Codes - Analytics-related error codes","hierarchy":{"lvl0":"Reference","lvl1":"Analytics Reference","lvl2":"","lvl3":""}},
+{"objectID":"9b3ba67e38b636436e6b2f378b85e8b14b45f30f68b91afe7597703a50c9d82a","title":"Analytics Reference","url":"/docs/reference/analytics","content":"Analytics Reference\n\nNeuroLink provides comprehensive analytics capabilities for tracking token usage, costs, performance metrics, and quality evaluation across your configured AI provider interactions.\n\nOverview\n\nThe analytics system in NeuroLink consists of several interconnected components:\n\n| Component                  | Purpose                                                         |\n| -------------------------- | --------------------------------------------------------------- |\n| Token Usage Tracking   | Monitor input/output tokens, cache tokens, and reasoning tokens |\n| Cost Analytics         | Estimate and track costs across providers and models            |\n| Performance Metrics    | Measure response times, throughput, and memory usage            |\n| Quality Evaluation     | Assess response relevance, accuracy, and completeness           |\n| Middleware Integration | Automatic analytics collection via middleware                   |\n\nToken Usage Tracking\n\nBasic Token Usage\n\nNeuroLink automatically tracks token usage for every generation:\n\nTokenUsage Type\n\nThe TokenUsage type provides detailed token information:\n\nCache Token Tracking\n\nFor providers that support prompt caching (Anthropic, Google), NeuroLink tracks cache metrics:\n\nReasoning Token Tracking\n\nFor models with extended thinking capabilities (OpenAI o1, Anthropic Claude with thinking, Gemini 3):\n\nCost Analytics\n\nAutomatic Cost Estimation\n\nNeuroLink automatically estimates costs based on provider pricing:\n\nCost Calculation Formula\n\nCosts are calculated using per-token pricing:\n\nProvider Pricing Configuration\n\nNeuroLink uses configurable pricing for each provider:\n\n| Provider      | Default Input Cost (per 1K) | Default Output Cost (per 1K) |\n| ------------- | --------------------------- | ---------------------------- |\n| OpenAI        | $0.00015                    | $0.0006                      |\n| Anthropic     | $0.0015                     | $0.0075                      |\n| Google AI     | $0.000075                   | $0.0003                      |\n| Google Vertex | $0.000075                   | $0.0003                      |\n| Bedrock       | $0.0015                     | $0.0075                      |\n| Azure         | $0.00015                    | $0.0006                      |\n| Mistral       | $0.0001                     | $0.0003                      |\n| HuggingFace   | $0.0002                     | $0.0008                      |\n| Ollama        | $0                          | $0                           |\n\nCustom Cost Configuration\n\nOverride default pricing via environment variables:\n\nAggregating Costs\n\nTrack cumulative costs across multiple requests:\n\nPerformance Metrics\n\nResponse Time Tracking\n\nEvery request automatically tracks response time:\n\nAnalyticsData Structure\n\nThe complete analytics data structure:\n\nPerformance Metrics Type\n\nFor advanced performance tracking:\n\nStream Performance Metrics\n\nFor streaming requests, additional metrics are available:\n\nStreaming Example\n\nQuality Evaluation\n\nEnabling Evaluation\n\nNeuroLink can automatically evaluate response quality:\n\nEvaluationData Structure\n\nDomain-Aware Evaluation\n\nConfigure evaluation for specific domains:\n\nEvaluation Providers\n\nEvaluation can use different providers:\n\nAnalytics Middleware\n\nUsing Analytics Middleware\n\nNeuroLink provides built-in analytics middleware:\n\nMiddleware Metadata\n\nThe analytics middleware provides:\n\nCustom Analytics Collection\n\nImplement custom analytics collection:\n\nIntegration with Observability Tools\n\nOpenTelemetry Integration\n\nExport analytics to OpenTelemetry:\n\nPrometheus Metrics\n\nExport metrics to Prometheus:\n\nDataDog Integration\n\nSend analytics to DataDog:\n\nCustom Logging\n\nStructured logging with analytics:\n\nUsage Statistics\n\nTracking Usage Over Time\n\nBuild usage dashboards with aggregated statistics:\n\nRate Limiting Based on Usage\n\nImplement rate limiting using analytics:\n\nCLI Analytics\n\nViewing Analytics in CLI\n\nVerbose Analytics\n\nBest Practices\nAlways Enable Analytics in Production\nMonitor Cost Alerts\nTrack Token Efficiency\nImplement Budget Controls\n\nRelated Documentation\nConfiguration Reference - Configure analytics settings\nProvider Comparison - Compare provider costs\nTroubleshooting - Debug analytics issues\nError Codes - Analytics-related error codes","hierarchy":{"lvl0":"Reference","lvl1":"Analytics Reference","lvl2":"","lvl3":""}},
 {"objectID":"0926aba6cc673644c3648445ea2da40fb83fabeb6f365c4e889c094c3560fb9d","title":"Analytics Reference","url":"/docs/reference/analytics#analytics-reference","content":"NeuroLink provides comprehensive analytics capabilities for tracking token usage, costs, performance metrics, and quality evaluation across your configured AI provider interactions.","hierarchy":{"lvl0":"Reference","lvl1":"Analytics Reference","lvl2":"Analytics Reference","lvl3":""}},
 {"objectID":"2405c488fbebcf4cfe8245a94e5fe3eb106a312cde6bd795c0b2710362507e6f","title":"Overview","url":"/docs/reference/analytics#overview","content":"The analytics system in NeuroLink consists of several interconnected components:\n\n| Component                  | Purpose                                                         |\n| -------------------------- | --------------------------------------------------------------- |\n| Token Usage Tracking   | Monitor input/output tokens, cache tokens, and reasoning tokens |\n| Cost Analytics         | Estimate and track costs across providers and models            |\n| Performance Metrics    | Measure response times, throughput, and memory usage            |\n| Quality Evaluation     | Assess response relevance, accuracy, and completeness           |\n| Middleware Integration | Automatic analytics collection via middleware                   |","hierarchy":{"lvl0":"Reference","lvl1":"Analytics Reference","lvl2":"Overview","lvl3":""}},
 {"objectID":"4de3db21ab73ce27bed5f620bc7d11d61e84931962cde34efcd084c976a22c99","title":"Basic Token Usage","url":"/docs/reference/analytics#basic-token-usage","content":"NeuroLink automatically tracks token usage for every generation:","hierarchy":{"lvl0":"Reference","lvl1":"Analytics Reference","lvl2":"Basic Token Usage","lvl3":""}},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juspay/neurolink",
-  "version": "12.44.7",
+  "version": "12.45.0",
   "packageManager": "pnpm@10.15.1",
   "description": "The pipe layer of an AI nervous system: one interface connecting provider neurons to your application, across three inference types — generate, stream and decide. `decide` returns typed, calibrated judgements from a non-generative model (~400ms, ~$0.00002/call) for routing, tool selection and context budgeting. MCP-native (4 transports), voice TTS/STT/realtime, RAG, agents, memory, compaction, 9 observability exporters. OpenAI · Anthropic · Gemini · Bedrock · Azure · Ollama · TypeSafe Jev and more.",
   "author": {
@@ -35,6 +35,7 @@
     "build:cli:link": "pnpm run build:cli && pnpm link --global",
     "check:deps": "tsx scripts/check-banned-deps.ts",
     "check:dts": "tsx scripts/check-shipped-types.ts",
+    "check:docs-api": "tsx scripts/check-docs-api.ts",
     "codegen:catalog": "tsx tools/codegen-catalog.ts",
     "cli": "node dist/cli/index.js",
     "preview": "vite preview",
@@ -251,7 +252,7 @@
     "validate:commit": "tsx scripts/commit-validation.ts",
     "quality:metrics": "tsx scripts/quality-metrics.ts",
     "quality:report": "pnpm run quality:metrics && echo 'Quality metrics saved to quality-metrics.json'",
-    "pre-push": "pnpm run check:deps && pnpm run build && pnpm run test:provider-structure && pnpm run test:model-manifests",
+    "pre-push": "pnpm run check:deps && pnpm run check:docs-api && pnpm run build && pnpm run test:provider-structure && pnpm run test:model-manifests",
     "check:all": "pnpm run lint && pnpm run format --check && pnpm run validate && pnpm run validate:commit",
     "test:file-formats": "pnpm exec tsx test/continuous-test-suite-file-formats.ts",
     "test:audio-transcription": "pnpm exec tsx test/continuous-test-suite-audio-transcription.ts",
@@ -280,6 +281,8 @@
     "test:aistudio-loop-characterization": "tsx test/continuous-test-suite-aistudio-loop-characterization.ts",
     "test:docs-mcp": "pnpm exec tsx test/continuous-test-suite-docs-mcp.ts",
     "test:docs-search-index": "pnpm exec tsx test/continuous-test-suite-docs-search-index.ts",
+    "test:docs-snippets": "pnpm exec tsx test/continuous-test-suite-docs-snippets.ts",
+    "test:docs-snippets:update": "pnpm exec tsx test/continuous-test-suite-docs-snippets.ts --update-ledger",
     "test:import-cost": "pnpm exec tsx test/continuous-test-suite-import-cost.ts",
     "test:vertex-claude-characterization": "tsx test/continuous-test-suite-vertex-claude-characterization.ts",
     "test:toolfree-guard-overhead": "pnpm exec tsx test/continuous-test-suite-toolfree-guard-overhead.ts",