@juspay/neurolink 12.47.2 → 12.47.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -2
- package/dist/browser/neurolink.min.js +354 -353
- package/dist/core/loopEngine.js +1 -1
- package/dist/processors/media/VideoProcessor.js +7 -2
- package/dist/providers/amazonSagemaker.js +1 -1
- package/dist/providers/anthropic/client.d.ts +10 -0
- package/dist/providers/anthropic/client.js +58 -38
- package/dist/providers/nvidiaNim/client.js +3 -1
- package/dist/providers/openaiChatCompletionsBase.js +2 -2
- package/dist/types/model.d.ts +7 -6
- package/dist/types/providers.d.ts +15 -1
- package/dist/utils/errorClassifier.d.ts +7 -4
- package/dist/utils/errorClassifier.js +18 -6
- package/dist/utils/messageBuilder.js +15 -1
- package/dist/utils/modelChoices.d.ts +10 -0
- package/dist/utils/modelChoices.js +18 -3
- package/dist/utils/providerHealth.js +23 -4
- package/dist/utils/providerRetry.d.ts +5 -1
- package/dist/utils/providerRetry.js +25 -3
- package/dist/utils/providerUtils.js +2 -10
- package/docs-site/static/search-index.json +10 -8
- package/package.json +2 -1
|
@@ -4131,15 +4131,15 @@
|
|
|
4131
4131
|
{"objectID":"1d8625a67cba7bc640e454fe15f76d86e2be4fbe79e9496fc085e5a6df496086","title":"Future Enhancements","url":"/docs/features/pdf-support#future-enhancements","content":"Planned features for PDF support:\nOCR Integration: Extract text from scanned PDFs\nPage Selection: Analyze specific pages only\nPDF Generation: Create PDFs from AI responses\nForm Filling: Extract and populate PDF forms","hierarchy":{"lvl0":"Features","lvl1":"PDF File Support","lvl2":"Future Enhancements","lvl3":""}},
|
|
4132
4132
|
{"objectID":"20bb5119cb74199a04bebd17c621d8c6a0438c0833f12103b9f3914c5f026ceb","title":"Feedback and Support","url":"/docs/features/pdf-support#feedback-and-support","content":"Found a bug or have a feature request? Please:\nCheck existing issues on GitHub\nCreate a new issue with:\nProvider used\nPDF file details (size, pages)\nError message or unexpected behavior\nSample code (if possible)","hierarchy":{"lvl0":"Features","lvl1":"PDF File Support","lvl2":"Feedback and Support","lvl3":""}},
|
|
4133
4133
|
{"objectID":"7c47c75b9023d438078ad3ed696c167cb9b5beaa369fad844635f7f32cce74a5","title":"Version 9.2.0 (Current)","url":"/docs/features/pdf-support#version-920-current","content":"✅ Initial PDF support for Vertex AI, Anthropic, Bedrock, AI Studio\n✅ Auto-detection via --file flag\n✅ Multiple PDF processing\n✅ Size and page limit validation\n✅ Comprehensive error messages\n✅ CLI and SDK integration\n✅ Streaming support\n✅ Mixed multimodal inputs (PDF + CSV + images)\n\nNext: Multimodal Chat Guide | CSV Support","hierarchy":{"lvl0":"Features","lvl1":"PDF File Support","lvl2":"Version 9.2.0 (Current)","lvl3":""}},
|
|
4134
|
-
{"objectID":"2a46dad649fcc5c7b389d9db519211899183703302b4127f0a4a2285018e1362","title":"Per-Request Credentials","url":"/docs/features/per-request-credentials","content":"Per-Request Credentials\n\nStatus: Stable | Availability: SDK only\n\nOverview\n\nNeuroLink allows provider credentials to be supplied at two levels below the environment-variable default: on the NeuroLink constructor (instance level) and on individual generate() / stream() calls (per-call level). Credentials are resolved in the following order of precedence:\n\nThis enables multi-tenant architectures where different users or tenants supply their own provider API keys (bring-your-own-key, BYOK), without requiring separate NeuroLink instances per user or touching the process environment.\n\nTypical use cases:\nMulti-tenant SaaS — each API request carries the calling user's provider key; no shared key leakage between tenants\nBYOK products — end users paste their OpenAI / Anthropic keys in settings; you forward them to NeuroLink per call\nTesting and CI — inject credentials programmatically without setting environment variables\nProvider switching — override only the active provider's credentials while leaving others to fall through to env vars\n\nQuick Start\n\nInstance-Level vs Per-Call\n\nInstance-Level Credentials\n\nSet credentials in the NeuroLink constructor. These apply as the default for every generate() and stream() call made on that instance. Useful when serving a single tenant or when you have a known key for the duration of the instance lifecycle.\n\nPer-Call Credentials\n\nSet credentials directly on generate() or stream(). These override the instance-level credentials for that single call only. Only the providers you explicitly set are overridden — others continue falling through to instance credentials and then environment variables.\n\nPrecedence Rules\n\n| Level | Scope | Set on |\n| ----------- | --------------------- | ----------------------------------------------------------------------------------- |\n| Per-call | Single request only | generate({ credentials }), stream({ credentials }) or decide({ credentials }) |\n| Instance | All calls on instance | new NeuroLink({ credentials }) |\n| Environment | Process-wide fallback | OPENAI_API_KEY, ANTHROPIC_API_KEY, … |\n\nUnset providers at any level fall through to the next. You never need to repeat a credential at the per-call level if the instance default is correct.\n\nProvider Credential Reference\n\nAll fields are optional — omit any field you want to fall through to a lower-precedence level.\n\n| Provider | Key | Fields |\n| -------------------- | ------------------- | ---------------------------------------------------------------------------------------------------- |\n| OpenAI | openai | apiKey, baseURL |\n| Anthropic | anthropic | apiKey, oauthToken
|
|
4134
|
+
{"objectID":"2a46dad649fcc5c7b389d9db519211899183703302b4127f0a4a2285018e1362","title":"Per-Request Credentials","url":"/docs/features/per-request-credentials","content":"Per-Request Credentials\n\nStatus: Stable | Availability: SDK only\n\nOverview\n\nNeuroLink allows provider credentials to be supplied at two levels below the environment-variable default: on the NeuroLink constructor (instance level) and on individual generate() / stream() calls (per-call level). Credentials are resolved in the following order of precedence:\n\nThis enables multi-tenant architectures where different users or tenants supply their own provider API keys (bring-your-own-key, BYOK), without requiring separate NeuroLink instances per user or touching the process environment.\n\nTypical use cases:\nMulti-tenant SaaS — each API request carries the calling user's provider key; no shared key leakage between tenants\nBYOK products — end users paste their OpenAI / Anthropic keys in settings; you forward them to NeuroLink per call\nTesting and CI — inject credentials programmatically without setting environment variables\nProvider switching — override only the active provider's credentials while leaving others to fall through to env vars\n\nQuick Start\n\nInstance-Level vs Per-Call\n\nInstance-Level Credentials\n\nSet credentials in the NeuroLink constructor. These apply as the default for every generate() and stream() call made on that instance. Useful when serving a single tenant or when you have a known key for the duration of the instance lifecycle.\n\nPer-Call Credentials\n\nSet credentials directly on generate() or stream(). These override the instance-level credentials for that single call only. Only the providers you explicitly set are overridden — others continue falling through to instance credentials and then environment variables.\n\nPrecedence Rules\n\n| Level | Scope | Set on |\n| ----------- | --------------------- | ----------------------------------------------------------------------------------- |\n| Per-call | Single request only | generate({ credentials }), stream({ credentials }) or decide({ credentials }) |\n| Instance | All calls on instance | new NeuroLink({ credentials }) |\n| Environment | Process-wide fallback | OPENAI_API_KEY, ANTHROPIC_API_KEY, … |\n\nUnset providers at any level fall through to the next. You never need to repeat a credential at the per-call level if the instance default is correct.\n\nProvider Credential Reference\n\nAll fields are optional — omit any field you want to fall through to a lower-precedence level.\n\n| Provider | Key | Fields |\n| -------------------- | ------------------- | ---------------------------------------------------------------------------------------------------- |\n| OpenAI | openai | apiKey, baseURL |\n| Anthropic | anthropic | apiKey, oauthToken, baseURL |\n| Google AI Studio | googleAiStudio | apiKey, baseURL |\n| Google Vertex AI | vertex | projectId, location, apiKey (Express Mode), serviceAccountKey, clientEmail, privateKey |\n| Amazon Bedrock | bedrock | accessKeyId, secretAccessKey, sessionToken, region |\n| Amazon SageMaker | sagemaker | accessKeyId, secretAccessKey, sessionToken, region, endpoint |\n| Azure OpenAI | azure | apiKey, resourceName, deploymentName, apiVersion |\n| Mistral | mistral | apiKey |\n| Hugging Face | huggingFace | apiKey, baseURL |\n| OpenRouter | openrouter | apiKey, baseURL |\n| LiteLLM | litellm | apiKey, baseURL |\n| OpenAI-Compatible | openaiCompatible | apiKey, baseURL |\n| Cerebras | cerebras | apiKey, baseURL |\n| SambaNova | sambanova | apiKey, baseURL |\n| Ollama | ollama | baseURL ","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"","lvl3":""}},
|
|
4135
4135
|
{"objectID":"12291afcfaaf4af65b01b07e93a9eac08280ff7c61394f6051a86c1b152a7b4a","title":"Per-Request Credentials","url":"/docs/features/per-request-credentials#per-request-credentials","content":"Status: Stable | Availability: SDK only","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Per-Request Credentials","lvl3":""}},
|
|
4136
4136
|
{"objectID":"6c6756b0806344240b3c86d6b0063587db50f2c4ccf936a32e87d4377b77014c","title":"Overview","url":"/docs/features/per-request-credentials#overview","content":"NeuroLink allows provider credentials to be supplied at two levels below the environment-variable default: on the NeuroLink constructor (instance level) and on individual generate() / stream() calls (per-call level). Credentials are resolved in the following order of precedence:\n\nThis enables multi-tenant architectures where different users or tenants supply their own provider API keys (bring-your-own-key, BYOK), without requiring separate NeuroLink instances per user or touching the process environment.\n\nTypical use cases:\nMulti-tenant SaaS — each API request carries the calling user's provider key; no shared key leakage between tenants\nBYOK products — end users paste their OpenAI / Anthropic keys in settings; you forward them to NeuroLink per call\nTesting and CI — inject credentials programmatically without setting environment variables\nProvider switching — override only the active provider's credentials while leaving others to fall through to env vars","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Overview","lvl3":""}},
|
|
4137
4137
|
{"objectID":"d4e86918319aa78b4e4461dbf29a60ebe90935e74fc70617f59bf524ba3e1eae","title":"Instance-Level Credentials","url":"/docs/features/per-request-credentials#instance-level-credentials","content":"Set credentials in the NeuroLink constructor. These apply as the default for every generate() and stream() call made on that instance. Useful when serving a single tenant or when you have a known key for the duration of the instance lifecycle.","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Instance-Level Credentials","lvl3":""}},
|
|
4138
4138
|
{"objectID":"250b1dd11e018f5f252b27ce408e3dade21eff1cf26eed4aaf81126fad6ab691","title":"Per-Call Credentials","url":"/docs/features/per-request-credentials#per-call-credentials","content":"Set credentials directly on generate() or stream(). These override the instance-level credentials for that single call only. Only the providers you explicitly set are overridden — others continue falling through to instance credentials and then environment variables.","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Per-Call Credentials","lvl3":""}},
|
|
4139
4139
|
{"objectID":"4166cbaf6e6263ac98e24d7ede9950b44aade18e787b57e71138d2fc2deaaa07","title":"Precedence Rules","url":"/docs/features/per-request-credentials#precedence-rules","content":"| Level | Scope | Set on |\n| ----------- | --------------------- | ----------------------------------------------------------------------------------- |\n| Per-call | Single request only | generate({ credentials }), stream({ credentials }) or decide({ credentials }) |\n| Instance | All calls on instance | new NeuroLink({ credentials }) |\n| Environment | Process-wide fallback | OPENAI_API_KEY, ANTHROPIC_API_KEY, … |\n\nUnset providers at any level fall through to the next. You never need to repeat a credential at the per-call level if the instance default is correct.","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Precedence Rules","lvl3":""}},
|
|
4140
|
-
{"objectID":"b739fcf7819dd6f055ebe3bcdb161ff839067dc172235f9d0072f9cf79d7bcd3","title":"Provider Credential Reference","url":"/docs/features/per-request-credentials#provider-credential-reference","content":"All fields are optional — omit any field you want to fall through to a lower-precedence level.\n\n| Provider | Key | Fields |\n| -------------------- | ------------------- | ---------------------------------------------------------------------------------------------------- |\n| OpenAI | openai | apiKey, baseURL |\n| Anthropic | anthropic | apiKey, oauthToken
|
|
4140
|
+
{"objectID":"b739fcf7819dd6f055ebe3bcdb161ff839067dc172235f9d0072f9cf79d7bcd3","title":"Provider Credential Reference","url":"/docs/features/per-request-credentials#provider-credential-reference","content":"All fields are optional — omit any field you want to fall through to a lower-precedence level.\n\n| Provider | Key | Fields |\n| -------------------- | ------------------- | ---------------------------------------------------------------------------------------------------- |\n| OpenAI | openai | apiKey, baseURL |\n| Anthropic | anthropic | apiKey, oauthToken, baseURL |\n| Google AI Studio | googleAiStudio | apiKey, baseURL |\n| Google Vertex AI | vertex | projectId, location, apiKey (Express Mode), serviceAccountKey, clientEmail, privateKey |\n| Amazon Bedrock | bedrock | accessKeyId, secretAccessKey, sessionToken, region |\n| Amazon SageMaker | sagemaker | accessKeyId, secretAccessKey, sessionToken, region, endpoint |\n| Azure OpenAI | azure | apiKey, resourceName, deploymentName, apiVersion |\n| Mistral | mistral | apiKey |\n| Hugging Face | huggingFace | apiKey, baseURL |\n| OpenRouter | openrouter | apiKey, baseURL |\n| LiteLLM | litellm | apiKey, baseURL |\n| OpenAI-Compatible | openaiCompatible","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Provider Credential Reference","lvl3":""}},
|
|
4141
4141
|
{"objectID":"575e2e50c5fd00e53fce66deee556264f3df8962e2188ac446e6e7d4ad29b2ed","title":"OpenAI","url":"/docs/features/per-request-credentials#openai","content":"Custom base URL for OpenAI-compatible proxies:","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"OpenAI","lvl3":""}},
|
|
4142
|
-
{"objectID":"499e7c1d012d337ad54e06db35770d5b3471afb0f9e3f471564642e8ba7e5c6b","title":"Anthropic","url":"/docs/features/per-request-credentials#anthropic","content":"OAuth token (Anthropic Claude subscription):","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Anthropic","lvl3":""}},
|
|
4142
|
+
{"objectID":"499e7c1d012d337ad54e06db35770d5b3471afb0f9e3f471564642e8ba7e5c6b","title":"Anthropic","url":"/docs/features/per-request-credentials#anthropic","content":"OAuth token (Anthropic Claude subscription):\n\nA gateway or proxy in front of Anthropic (baseURL wins over ANTHROPIC_BASE_URL, with or without a trailing /v1; a gateway that does its own auth accepts any apiKey):","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Anthropic","lvl3":""}},
|
|
4143
4143
|
{"objectID":"3f5ea871d2750f36fca227c33f109de53f5d0bc4c184ea956d0b8c3736babe29","title":"Vertex AI — Express Mode","url":"/docs/features/per-request-credentials#vertex-ai-express-mode","content":"Express Mode uses a simple API key instead of service-account credentials, making it suitable for per-request BYOK flows:\n\nFull service-account credentials (server-side only — keep private keys out of client code):","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Vertex AI — Express Mode","lvl3":""}},
|
|
4144
4144
|
{"objectID":"af5efdaa7ba1811d537c1c7aca8a0143cd8496be1e9db86526d34003cf427dbb","title":"Streaming with Credentials","url":"/docs/features/per-request-credentials#streaming-with-credentials","content":"credentials works identically on stream(). Note that neurolink.stream()\nreturns a StreamResult wrapper — iterate over its .stream property:","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Streaming with Credentials","lvl3":""}},
|
|
4145
4145
|
{"objectID":"ea70e911923bd079e70af1c36bda14c16bdd9bfcec49f236a9d0550d6602502a","title":"Multi-Tenant Request Handler","url":"/docs/features/per-request-credentials#multi-tenant-request-handler","content":"A typical pattern for a multi-tenant API endpoint. Note the provider-name →\ncredential-key mapping: the registered provider names (google-ai,\nopenai-compatible, huggingface) differ from their NeurolinkCredentials\nslot keys (googleAiStudio, openaiCompatible, huggingFace), so map\nexplicitly to avoid runtime surprises.\n\nNote: This example assumes API-key authentication. Providers like Bedrock\n(which use accessKeyId/secretAccessKey) and Ollama (which use baseURL)\nrequire different credential shapes — see the Provider Credential Reference above.","hierarchy":{"lvl0":"Features","lvl1":"Per-Request Credentials","lvl2":"Multi-Tenant Request Handler","lvl3":""}},
|
|
@@ -4727,7 +4727,7 @@
|
|
|
4727
4727
|
{"objectID":"8b922e3ee9644559addad4738b5f0c6360fe12ae2d1d0c98d678ddaac03eede9","title":"Troubleshooting","url":"/docs/features/workflow-engine#troubleshooting","content":"| Problem | Solution |\n| --------------------------------- | ---------------------------------------------------------------------------------- |\n| Workflow not found in registry | Register it with registerWorkflow() before calling generate() with workflow: |\n| All models failed | Check API keys, increase timeout, verify provider availability |\n| Judge returns neutral scores (50) | Judge response parsing failed; check judge model supports JSON output |\n| Slow execution | Reduce model count, use faster models, increase parallelism |\n| High costs | Use consensus-3-fast, chain/adaptive workflows, or set costThreshold |\n| Low consensus in multi-judge | Normal for subjective queries; increase judge count or align criteria |","hierarchy":{"lvl0":"Features","lvl1":"Workflow Engine Guide","lvl2":"Troubleshooting","lvl3":""}},
|
|
4728
4728
|
{"objectID":"e9de380e8339140c2951bda58d6eaaffb28f182c85fbfda7d7679ea6f5af270e","title":"Core Exports","url":"/docs/features/workflow-engine#core-exports","content":"Execution:\nrunWorkflow(config, options) -- Execute a complete workflow\nrunWorkflowWithStreaming(config, options) -- Execute with progressive streaming\nexecuteEnsemble(options) -- Low-level parallel model execution\nexecuteModelGroups(groups, prompt, config) -- Low-level layer-based execution\nscoreEnsemble(options) -- Low-level judge scoring\nconditionResponse(options) -- Low-level response conditioning\n\nConfiguration:\ncreateWorkflowConfig(partial) -- Create config with defaults\nvalidateWorkflow(config) -- Validate workflow configuration\nvalidateForExecution(config) -- Validate for execution readiness\n\nRegistry:\nregisterWorkflow(config, options) -- Register a workflow\nunregisterWorkflow(workflowId) -- Remove a workflow\ngetWorkflow(workflowId) -- Retrieve by ID\nlistWorkflows(options) -- List with filtering\ngetRegistryStats() -- Registry statistics\nclearRegistry() -- Remove all workflows\n\nPre-built Workflows:\nCONSENSUS_3_WORKFLOW -- 3-model ensemble with judge\nCONSENSUS_3_FAST_WORKFLOW -- Fast/cheap 3-model ensemble\nBALANCED_ADAPTIVE_WORKFLOW -- 2-tier balanced adaptive\nQUALITY_MAX_WORKFLOW -- 3-tier quality-maximizing adaptive\nSPEED_FIRST_WORKFLOW -- Speed-optimized adaptive\nAGGRESSIVE_FALLBACK_WORKFLOW -- Fast + parallel premium fallback\nFAST_FALLBACK_WORKFLOW -- Sequential 3-tier fallback\nMULTI_JUDGE_3_WORKFLOW -- 3 models, 2 judges\nMULTI_JUDGE_5_WORKFLOW -- 5 models, 3 judges\n\nFactory Functions:\ncreateConsensus3WithPrompt(systemPrompt) -- Consensus-3 with custom prompt\ncreateAdaptiveWorkflow(tiers, strategy) -- Custom adaptive workflow\ncreateMultiJudgeWorkflow(modelCount, judgeCount) -- Custom multi-judge\n\nMetrics:\ncalculateModelMetrics(responses) -- Per-model metrics\ncalculateConfidence(scores) -- Confidence calculation\ncalculateConsensus(scores) -- Consensus calculation\ngenerateSummaryStats(results) -- Summary statistics\ncompareWorkflows(stats1, stats2) -- Workflow comparison\nformatMetricsForLogging(result) -- Formatted logging output\n\nTypes:\nWorkflowConfig,","hierarchy":{"lvl0":"Features","lvl1":"Workflow Engine Guide","lvl2":"Core Exports","lvl3":""}},
|
|
4729
4729
|
{"objectID":"fb91715f0910d539aa3342bb53890eb88ef04121ad496d9c8c982c55d6a645d5","title":"See Also","url":"/docs/features/workflow-engine#see-also","content":"Provider Orchestration Guide -- Multi-provider configuration\nObservability Guide -- Tracing workflow executions with Langfuse\nStructured Output Guide -- JSON schema output (note: incompatible with Gemini tools)","hierarchy":{"lvl0":"Features","lvl1":"Workflow Engine Guide","lvl2":"See Also","lvl3":""}},
|
|
4730
|
-
{"objectID":"fcc71bbb437aec3313f917118186ae468e33d960b134ccbe3a8151a55970c6a9","title":"🔧 Environment Variables Configuration Guide","url":"/docs/getting-started/environment-variables","content":"🔧 Environment Variables Configuration Guide\n\nThis guide provides comprehensive setup instructions for all AI providers supported by NeuroLink. The CLI automatically loads environment variables from .env files, making configuration seamless.\n\n🚀 Quick Setup\n\nAutomatic .env Loading ✨ NEW!\n\nNeuroLink CLI automatically loads environment variables from .env files in your project directory:\n\nManual Export (Also Supported)\n\n🏗️ Enterprise Configuration Management\n\n✨ NEW: Automatic Backup System\n\nInterface Configuration\n\nPerformance & Optimization\n\n🆕 AI Enhancement Features\n\nBasic Enhancement Configuration\n\nDescription: Configures the AI model used for response quality evaluation when --enable-evaluation flag is used. Uses Google AI's fast Gemini 2.5 Flash model for quick quality assessment.\n\nSupported Models:\ngemini-2.5-flash (default) - Fast evaluation processing\ngemini-2.5-pro - More detailed evaluation (slower)\n\nUsage:\n\n🌐 Universal Evaluation System (Advanced)\n\nPrimary Configuration\n\nNEUROLINK_EVALUATION_PROVIDER: Primary AI provider for evaluation\nOptions: google-ai, openai, anthropic, vertex, bedrock, azure, ollama, huggingface, mistral\nDefault: google-ai\nUsage: Determines which AI provider performs the quality evaluation\n\nNEUROLINK_EVALUATION_MODE: Performance vs quality trade-off\nOptions: fast (cost-effective), balanced (optimal), quality (highest accuracy)\nDefault: fast\nUsage: Selects appropriate model for the provider (e.g., gemini-2.5-flash vs gemini-2.5-pro)\n\nFallback Configuration\n\nNEUROLINK_EVALUATION_FALLBACK_ENABLED: Enable intelligent fallback system\nOptions: true, false\nDefault: true\nUsage: When enabled, automatically tries backup providers if primary fails\n\nNEUROLINK_EVALUATION_FALLBACK_PROVIDERS: Backup provider order\nFormat: Comma-separated provider names\nDefault: openai,anthropic,vertex,bedrock\nUsage: Defines the order of providers to try if primary fails\n\nPerformance Tuning\n\nPerformance Variables:\nTIMEOUT: Maximum time to wait for evaluation (prevents hanging)\nMAX_TOKENS: Limits evaluation response length (controls cost)\nTEMPERATURE: Lower values = more consistent scoring\nRETRY_ATTEMPTS: Number of retry attempts for transient failures\n\nCost Optimization\n\nNEUROLINK_EVALUATION_PREFER_CHEAP: Cost optimization preference\nOptions: true, false\nDefault: true\nUsage: When enabled, prioritizes cheaper providers and models\n\nNEUROLINK_EVALUATION_MAX_COST_PER_EVAL: Cost limit per evaluation\nFormat: Decimal number (USD)\nDefault: 0.01 ($0.01)\nUsage: Prevents expensive evaluations, switches to cheaper providers if needed\n\nComplete Universal Evaluation Example\n\nTesting Universal Evaluation\n\n🏢 Enterprise Proxy Configuration\n\nProxy Environment Variables\n\n| Variable | Description | Example |\n| ------------- | ------------------------------- | ---------------------------------- |\n| HTTPS_PROXY | Proxy server for HTTPS requests | http://proxy.company.com:8080 |\n| HTTP_PROXY | Proxy server for HTTP requests | http://proxy.company.com:8080 |\n| NO_PROXY | Domains to bypass proxy | localhost,127.0.0.1,.company.com |\n\nAuthenticated Proxy\n\nAll NeuroLink providers automatically use proxy settings when configured.\n\nFor detailed proxy setup → See Enterprise & Proxy Setup Guide\n\n🤖 Provider Configuration\nOpenAI\n\nRequired Variables\n\nOptional Variables\n\nHow to Get OpenAI API Key\nVisit OpenAI Platform\nSign up or log in to your account\nNavigate to API Keys section\nClick Create new secret key\nCopy the key (starts with sk-proj- or sk-)\nAdd billing information if required\n\nSupported Models\ngpt-
|
|
4730
|
+
{"objectID":"fcc71bbb437aec3313f917118186ae468e33d960b134ccbe3a8151a55970c6a9","title":"🔧 Environment Variables Configuration Guide","url":"/docs/getting-started/environment-variables","content":"🔧 Environment Variables Configuration Guide\n\nThis guide provides comprehensive setup instructions for all AI providers supported by NeuroLink. The CLI automatically loads environment variables from .env files, making configuration seamless.\n\n🚀 Quick Setup\n\nAutomatic .env Loading ✨ NEW!\n\nNeuroLink CLI automatically loads environment variables from .env files in your project directory:\n\nManual Export (Also Supported)\n\n🏗️ Enterprise Configuration Management\n\n✨ NEW: Automatic Backup System\n\nInterface Configuration\n\nPerformance & Optimization\n\n🆕 AI Enhancement Features\n\nBasic Enhancement Configuration\n\nDescription: Configures the AI model used for response quality evaluation when --enable-evaluation flag is used. Uses Google AI's fast Gemini 2.5 Flash model for quick quality assessment.\n\nSupported Models:\ngemini-2.5-flash (default) - Fast evaluation processing\ngemini-2.5-pro - More detailed evaluation (slower)\n\nUsage:\n\n🌐 Universal Evaluation System (Advanced)\n\nPrimary Configuration\n\nNEUROLINK_EVALUATION_PROVIDER: Primary AI provider for evaluation\nOptions: google-ai, openai, anthropic, vertex, bedrock, azure, ollama, huggingface, mistral\nDefault: google-ai\nUsage: Determines which AI provider performs the quality evaluation\n\nNEUROLINK_EVALUATION_MODE: Performance vs quality trade-off\nOptions: fast (cost-effective), balanced (optimal), quality (highest accuracy)\nDefault: fast\nUsage: Selects appropriate model for the provider (e.g., gemini-2.5-flash vs gemini-2.5-pro)\n\nFallback Configuration\n\nNEUROLINK_EVALUATION_FALLBACK_ENABLED: Enable intelligent fallback system\nOptions: true, false\nDefault: true\nUsage: When enabled, automatically tries backup providers if primary fails\n\nNEUROLINK_EVALUATION_FALLBACK_PROVIDERS: Backup provider order\nFormat: Comma-separated provider names\nDefault: openai,anthropic,vertex,bedrock\nUsage: Defines the order of providers to try if primary fails\n\nPerformance Tuning\n\nPerformance Variables:\nTIMEOUT: Maximum time to wait for evaluation (prevents hanging)\nMAX_TOKENS: Limits evaluation response length (controls cost)\nTEMPERATURE: Lower values = more consistent scoring\nRETRY_ATTEMPTS: Number of retry attempts for transient failures\n\nCost Optimization\n\nNEUROLINK_EVALUATION_PREFER_CHEAP: Cost optimization preference\nOptions: true, false\nDefault: true\nUsage: When enabled, prioritizes cheaper providers and models\n\nNEUROLINK_EVALUATION_MAX_COST_PER_EVAL: Cost limit per evaluation\nFormat: Decimal number (USD)\nDefault: 0.01 ($0.01)\nUsage: Prevents expensive evaluations, switches to cheaper providers if needed\n\nComplete Universal Evaluation Example\n\nTesting Universal Evaluation\n\n🏢 Enterprise Proxy Configuration\n\nProxy Environment Variables\n\n| Variable | Description | Example |\n| ------------- | ------------------------------- | ---------------------------------- |\n| HTTPS_PROXY | Proxy server for HTTPS requests | http://proxy.company.com:8080 |\n| HTTP_PROXY | Proxy server for HTTP requests | http://proxy.company.com:8080 |\n| NO_PROXY | Domains to bypass proxy | localhost,127.0.0.1,.company.com |\n\nAuthenticated Proxy\n\nAll NeuroLink providers automatically use proxy settings when configured.\n\nFor detailed proxy setup → See Enterprise & Proxy Setup Guide\n\n🤖 Provider Configuration\nOpenAI\n\nRequired Variables\n\nOptional Variables\n\nHow to Get OpenAI API Key\nVisit OpenAI Platform\nSign up or log in to your account\nNavigate to API Keys section\nClick Create new secret key\nCopy the key (starts with sk-proj- or sk-)\nAdd billing information if required\n\nSupported Models\ngpt-5.4 - GPT-5.4 model\ngpt-5.4-mini - Faster, cost-effective GPT-5.4 option\ngpt-4o-mini (default) - Cost-effective, fast\ngpt-4o - Previous generation multimodal model\ngpt-4-turbo - High-performance model\ngpt-3.5-turbo - Legacy cost-effective option\n\nWith no model set, NeuroLink uses the explicit model option, then OPENAI_MODEL, then the default in the model configuration (MODEL_CONFIG_URL, otherwise the repository's config/models.json), then the registry default gpt-4o-mini. Constructing OpenAIProvider directly with none of these falls back to gpt-5.4.\nAmazon Bedrock\n\nRequired Variables\n\nModel Configuration (⚠️ Critical)\n\nOptional Variables\n\nHow to Get AWS Credentials\nSign up for AWS Account\nNavigate to IAM Console\nCreate new user with programmatic access\nAttach policy: AmazonBedrockFullAccess\nDownload access key and secret key\nImportant: Request model access in Bedrock console\n\nBedrock Model Access Setup\nGo to AWS Bedrock Console\nNavigate to Model access\nClick Request model access\nSelect desired models (Claude, Titan, etc.)\nSubmit request and wait for approval\n\nSupported Models\nAnthropic Claude:\narn:aws:bedrock:<region>:<account_id>:inference-profile/us.anthropic.claude-3-7-sonnet-20250219-v1:0\narn:aws:bedrock:<region>:<account_id>:inference-profile/us.anthropic.claude-3-5-sonnet-20241022-v2:0\nAmazon Titan:\namazon.titan-text-express-v1\namazon.titan-text-lite-v1\nGoogle V","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"","lvl3":""}},
|
|
4731
4731
|
{"objectID":"c81a81fd6221fc873edf4a381a6af70939b66519ee4d4ce31acce9afec8fb5f1","title":"🔧 Environment Variables Configuration Guide","url":"/docs/getting-started/environment-variables#-environment-variables-configuration-guide","content":"This guide provides comprehensive setup instructions for all AI providers supported by NeuroLink. The CLI automatically loads environment variables from .env files, making configuration seamless.","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"🔧 Environment Variables Configuration Guide","lvl3":""}},
|
|
4732
4732
|
{"objectID":"a78ad3583ac3d28848100b6a1e832a69a5d8d6dd5538da571bcf5d184ef34789","title":"Automatic .env Loading ✨ NEW!","url":"/docs/getting-started/environment-variables#automatic-env-loading-new","content":"NeuroLink CLI automatically loads environment variables from .env files in your project directory:\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"Automatic .env Loading ✨ NEW!","lvl3":""}},
|
|
4733
4733
|
{"objectID":"7f0086c723d683ab77c7a74bfeaf8a61a34e60fc87f62f7c8abceeb385bebab3","title":"Create .env file (automatically loaded)","url":"/docs/getting-started/environment-variables#create-env-file-automatically-loaded","content":"echo 'OPENAIAPIKEY=\"sk-your-key\"' > .env\necho 'AWSACCESSKEY_ID=\"your-key\"' >> .env","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"Create .env file (automatically loaded)","lvl3":""}},
|
|
@@ -4771,7 +4771,7 @@
|
|
|
4771
4771
|
{"objectID":"d5cabd5bf6ae965d7bf7274d74934ba63f7d8b3567bc4b54317270dade223d44","title":"Authenticated Proxy","url":"/docs/getting-started/environment-variables#authenticated-proxy","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"Authenticated Proxy","lvl3":""}},
|
|
4772
4772
|
{"objectID":"bf0792704fa31e90694a52e8e293682873f558d49131eba9f2e9a4d2f40498ec","title":"Proxy with username/password authentication","url":"/docs/getting-started/environment-variables#proxy-with-usernamepassword-authentication","content":"HTTPS_PROXY=\"http://username:password@proxy.company.com:8080\"\nHTTP_PROXY=\"http://username:password@proxy.company.com:8080\"\n`\n\nAll NeuroLink providers automatically use proxy settings when configured.\n\nFor detailed proxy setup → See Enterprise & Proxy Setup Guide","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"Proxy with username/password authentication","lvl3":""}},
|
|
4773
4773
|
{"objectID":"010e6483ced7a9b1fba1740513766a58d6e77b2da14e91d6d3669cfb10eaecc8","title":"How to Get OpenAI API Key","url":"/docs/getting-started/environment-variables#how-to-get-openai-api-key","content":"Visit OpenAI Platform\nSign up or log in to your account\nNavigate to API Keys section\nClick Create new secret key\nCopy the key (starts with sk-proj- or sk-)\nAdd billing information if required","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"How to Get OpenAI API Key","lvl3":""}},
|
|
4774
|
-
{"objectID":"dc3d270e290e8328b30e8814d306c2f91955a36a56e2204eba0e8ab3ac284bf1","title":"Supported Models","url":"/docs/getting-started/environment-variables#supported-models","content":"gpt-
|
|
4774
|
+
{"objectID":"dc3d270e290e8328b30e8814d306c2f91955a36a56e2204eba0e8ab3ac284bf1","title":"Supported Models","url":"/docs/getting-started/environment-variables#supported-models","content":"gpt-5.4 - GPT-5.4 model\ngpt-5.4-mini - Faster, cost-effective GPT-5.4 option\ngpt-4o-mini (default) - Cost-effective, fast\ngpt-4o - Previous generation multimodal model\ngpt-4-turbo - High-performance model\ngpt-3.5-turbo - Legacy cost-effective option\n\nWith no model set, NeuroLink uses the explicit model option, then OPENAI_MODEL, then the default in the model configuration (MODEL_CONFIG_URL, otherwise the repository's config/models.json), then the registry default gpt-4o-mini. Constructing OpenAIProvider directly with none of these falls back to gpt-5.4.","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"Supported Models","lvl3":""}},
|
|
4775
4775
|
{"objectID":"d73a5c2adb25974a196bb6ecad05bc436d23500f98110dc47bd16408df6000a0","title":"Model Configuration (⚠️ Critical)","url":"/docs/getting-started/environment-variables#model-configuration-critical","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"Model Configuration (⚠️ Critical)","lvl3":""}},
|
|
4776
4776
|
{"objectID":"122f80d8fffd22fa876007b951e16c9a6406ea21c25e0a4c6bdffa6fb4eb4fe3","title":"Use full inference profile ARN for Anthropic models","url":"/docs/getting-started/environment-variables#use-full-inference-profile-arn-for-anthropic-models","content":"BEDROCK_MODEL=\"arn:aws:bedrock:us-east-2::inference-profile/us.anthropic.claude-3-7-sonnet-20250219-v1:0\"","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"Use full inference profile ARN for Anthropic models","lvl3":""}},
|
|
4777
4777
|
{"objectID":"760493b55dfa9f12d29701bdea240a7f20e48c40af9ae3cc5038c87ea0a60844","title":"OR use simple model names for non-Anthropic models","url":"/docs/getting-started/environment-variables#or-use-simple-model-names-for-non-anthropic-models","content":"BEDROCK_MODEL=\"amazon.titan-text-express-v1\"\n`","hierarchy":{"lvl0":"Getting Started","lvl1":"🔧 Environment Variables Configuration Guide","lvl2":"OR use simple model names for non-Anthropic models","lvl3":""}},
|
|
@@ -4938,7 +4938,9 @@
|
|
|
4938
4938
|
{"objectID":"cc96a04c9f262c3c1f6f8b8e7c82407cc63406705250afd22947a3567e151721","title":"Other providers (setup guides in the Provider Guides index)","url":"/docs/getting-started/provider-setup#other-providers-setup-guides-in-the-provider-guides-index","content":"Onboarded via the zero-quirk OpenAI-wire-compatible catalog (Tier 2) — each has its own setup guide under providers/:\nGroq - LPU-accelerated inference; default openai/gpt-oss-120b\nCerebras - Wafer-scale inference; default gpt-oss-120b\nSambaNova - default Meta-Llama-3.3-70B-Instruct\nTogether AI - default meta-llama/Llama-3.3-70B-Instruct-Turbo\nFireworks AI - default accounts/fireworks/models/kimi-k3\nPerplexity - search-augmented models; default sonar\nCloudflare Workers AI - edge inference\nxAI - Grok models; default grok-4.6\nBaseten - default zai-org/GLM-5.3-Flash (BASETEN_API_KEY)\nGMI Cloud - default MiniMaxAI/MiniMax-M3 (GMICLOUD_API_KEY)\nInception Labs - diffusion LLMs; default mercury-2 (INCEPTION_LABS_API_KEY)\nio.net Intelligence - decentralized GPU inference; default meta-llama/Llama-3.3-70B-Instruct (IO_INTELLIGENCE_API_KEY)\nMancer - default deepseek-v4-flash (MANCER_API_KEY); no tool calling\nUpstage - Solar models; default solar-pro4 (UPSTAGE_API_KEY)\nAPI Route - OpenAI-compatible passthrough; default claude-sonnet-4-6 (API_ROUTE_API_KEY)\nDeepInfra - default deepseek-ai/DeepSeek-V4-Flash-0731 (DEEPINFRA_API_KEY); docs- and roster-verified, not yet live-verified\nFeatherless AI - default unsloth/Llama-3.3-70B-Instruct (FEATHERLESS_AI_API_KEY); docs- and roster-verified, not yet live-verified\nChutes - default moonshotai/Kimi-K2.6-TEE (CHUTES_API_KEY); docs- and roster-verified, not yet live-verified\nOVHcloud AI Endpoints - default gpt-oss-120b (OVH_AI_ENDPOINTS_ACCESS_TOKEN); docs- and roster-verified, not yet live-verified\nSarvam AI - default sarvam-105b (SARVAM_API_KEY); docs- and roster-verified, not yet live-verified\nSynthetic - default syn:large:text (SYNTHETIC_API_KEY); docs- and roster-verified, not yet live-verified\nAmbient - default ambient/large (AMBIENT_API_KEY); docs- and roster-verified, not yet live-verified\nInference.net - default glm-5.2 (INFERENCE_API_KEY); docs- and roster-verified, not yet live-verified\nEmpirioLabs AI - default glm-5-3","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Other providers (setup guides in the Provider Guides index)","lvl3":""}},
|
|
4939
4939
|
{"objectID":"d17be3311722218280d0e76731e7344c620c18f5073e07abbc826f3922db976a","title":"💰 Model Availability & Cost Considerations","url":"/docs/getting-started/provider-setup#-model-availability-cost-considerations","content":"Important Notes:\nModel Availability: Specific models may not be available in all regions or require special access\nCost Variations: Pricing differs significantly between providers and models (e.g., Claude 3.5 Sonnet vs GPT-4o)\nRate Limits: Each provider has different rate limits and quota restrictions\nLocal vs Cloud: Ollama (local) has no per-request cost but requires hardware resources\nEnterprise Tiers: AWS Bedrock, Google Vertex AI, and Azure typically offer enterprise pricing\n\nBest Practices:\nUse new NeuroLink() with automatic provider selection for cost-optimized routing\nMonitor usage through built-in analytics to track costs\nConsider local models (Ollama) for development and testing\nCheck provider documentation for current pricing and availability","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"💰 Model Availability & Cost Considerations","lvl3":""}},
|
|
4940
4940
|
{"objectID":"3a1bd0ccb708d37a59e2db3650f689f77fba69e91ec88142c7c9b85f1c18057d","title":"🏢 Enterprise Proxy Support","url":"/docs/getting-started/provider-setup#-enterprise-proxy-support","content":"Providers support corporate proxy environments automatically. Simply set environment variables:\n\nNo code changes required - NeuroLink automatically detects and uses proxy settings.\n\nFor detailed proxy setup → See Enterprise & Proxy Setup Guide","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"🏢 Enterprise Proxy Support","lvl3":""}},
|
|
4941
|
-
{"objectID":"
|
|
4941
|
+
{"objectID":"4e800f7c6d1d49fcbf1a5a8613f3449ee6fc0585728904b2f4b2d36dea4ce9ea","title":"Optional Configuration","url":"/docs/getting-started/provider-setup#optional-configuration","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Optional Configuration","lvl3":""}},
|
|
4942
|
+
{"objectID":"f455604e5b971c306f68461570edeca70b81f3a7b6cd9edd89d7e158bdfaddf9","title":"Optional: override the default model (default: gpt-4o-mini)","url":"/docs/getting-started/provider-setup#optional-override-the-default-model-default-gpt-4o-mini","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Optional: override the default model (default: gpt-4o-mini)","lvl3":""}},
|
|
4943
|
+
{"objectID":"1b0159447e4aee3ffd31efe28600cf755e4cc49d50f354e1a59d9574199213d2","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models","content":"gpt-5.4 - GPT-5.4 model\ngpt-5.4-mini - Cost-effective GPT-5.4 variant\ngpt-4o-mini (default) - Cost-effective variant\ngpt-4o - Previous generation multimodal model\ngpt-4-turbo - High-performance model\n\nSee the environment variables guide for the order in which the model is chosen when none is set.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
|
|
4942
4944
|
{"objectID":"27581667470b332f3c1c5159d4345a675be587f71dfb0d0b5d2a342adf1d2d44","title":"Timeout Configuration","url":"/docs/getting-started/provider-setup#timeout-configuration","content":"Default Timeout: 30 seconds\nSupported Formats: Milliseconds (30000), human-readable ('30s', '1m', '5m')\nEnvironment Variable: OPENAI_TIMEOUT='45s' (optional)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Timeout Configuration","lvl3":""}},
|
|
4943
4945
|
{"objectID":"9c310a3f365a46c6628ae6910d2bb72ec8560e43353e044f6c9b73e5ce8d1798","title":"🚨 Critical Setup Requirements","url":"/docs/getting-started/provider-setup#-critical-setup-requirements","content":"⚠️ IMPORTANT: Anthropic Models Require Inference Profile ARN\n\nFor Anthropic Claude models in Bedrock, you MUST use the full inference profile ARN, not simple model names:\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"🚨 Critical Setup Requirements","lvl3":""}},
|
|
4944
4946
|
{"objectID":"8f68b311be31716cccb17765bab6b712bc3ca441695a69967f7cc3c9cdf8929b","title":"export BEDROCK_MODEL=\"anthropic.claude-3-sonnet-20240229-v1:0\"","url":"/docs/getting-started/provider-setup#export-bedrock_modelanthropicclaude-3-sonnet-20240229-v10","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"export BEDROCK_MODEL=\"anthropic.claude-3-sonnet-20240229-v1:0\"","lvl3":""}},
|
|
@@ -6789,7 +6791,7 @@
|
|
|
6789
6791
|
{"objectID":"6102cd238f922f95762068dd3d2b3950e839a87ac388ee96bb805db79c47d00e","title":"Use specific model","url":"/docs/getting-started/providers/openai#use-specific-model","content":"pnpm run cli -- generate \"Write a haiku about AI\" \\\n --provider openai \\\n --model \"gpt-4o\"","hierarchy":{"lvl0":"Getting Started","lvl1":"OpenAI Provider Guide","lvl2":"Use specific model","lvl3":""}},
|
|
6790
6792
|
{"objectID":"b56485bde526a3210810b768ba819d40dffdff5e3cf66309d26c5f53b89e30c1","title":"Interactive loop mode","url":"/docs/getting-started/providers/openai#interactive-loop-mode","content":"pnpm run cli -- loop \\\n --provider openai \\\n --model \"gpt-4o-mini\"\n`","hierarchy":{"lvl0":"Getting Started","lvl1":"OpenAI Provider Guide","lvl2":"Interactive loop mode","lvl3":""}},
|
|
6791
6793
|
{"objectID":"dc674c0134ff9c1c707403e195849d7738176f984fe0c8226f05877f4951e0cd","title":"Available Models (from OpenAIModels enum)","url":"/docs/getting-started/providers/openai#available-models-from-openaimodels-enum","content":"| Enum Key | Model ID | Series | Context Window | Notes |\n| --------------------- | --------------------- | ------------ | -------------- | ------------------------ |\n| GPT_6_ASTRA | gpt-6-astra | GPT-6 | 1.05M | New (September 2026) |\n| GPT_6_SOL | gpt-6-sol | GPT-6 | 1.05M | New (September 2026) |\n| GPT_6_LUNA | gpt-6-luna | GPT-6 | 1.05M | New (September 2026) |\n| GPT_5_4 | gpt-5.4 | GPT-5.4 | 1.05M | New (March 2026) |\n| GPT_5_4_MINI | gpt-5.4-mini | GPT-5.4 | 400K | New (March 2026) |\n| GPT_5_4_NANO | gpt-5.4-nano | GPT-5.4 | 400K | New (March 2026) |\n| GPT_5_3_CODEX | gpt-5.3-codex | GPT-5.3 | 400K | |\n| GPT_5_2 | gpt-5.2 | GPT-5.2 | 400K | |\n| GPT_5_2_CHAT_LATEST | gpt-5.2-chat-latest | GPT-5.2 | 128K | |\n| GPT_5_2_PRO | gpt-5.2-pro | GPT-5.2 | 400K | |\n| GPT_5_2_CODEX | gpt-5.2-codex | GPT-5.2 | 400K | |\n| GPT_5_1 | gpt-5.1 | GPT-5.1 | 400K | |\n| GPT_5_1_CHAT_LATEST | gpt-5.1-chat-latest | GPT-5.1 | 128K | |\n| GPT_5_1_CODEX | gpt-5.1-codex | GPT-5.1 | 400K | |\n| GPT_5_1_CODEX_MAX | gpt-5.1-codex-max | GPT-5.1 | 400K | |\n| GPT_5_1_CODEX_MINI | gpt-5.1-codex-mini | GPT-5.1 | 400K | |\n| GPT_5 | gpt-5 | GPT-5 | 400K | |\n| GPT_5_MINI","hierarchy":{"lvl0":"Getting Started","lvl1":"OpenAI Provider Guide","lvl2":"Available Models (from OpenAIModels enum)","lvl3":""}},
|
|
6792
|
-
{"objectID":"daaa71958d244b14e0a92247a5ea7890e487f466f9647915a9b274196dcf2cd3","title":"Default Model","url":"/docs/getting-started/providers/openai#default-model","content":"The default model when no model is specified is gpt-4o-mini (set via OpenAIModels.GPT_4O_MINI in the provider registry). This can be overridden with the OPENAI_MODEL environment variable.\n\nNote: When using NeuroLink SDK/CLI, the default is gpt-4o-mini. When instantiating OpenAIProvider directly without setting OPENAI_MODEL, the internal fallback is gpt-
|
|
6794
|
+
{"objectID":"daaa71958d244b14e0a92247a5ea7890e487f466f9647915a9b274196dcf2cd3","title":"Default Model","url":"/docs/getting-started/providers/openai#default-model","content":"The default model when no model is specified is gpt-4o-mini (set via OpenAIModels.GPT_4O_MINI in the provider registry). This can be overridden with the OPENAI_MODEL environment variable.\n\nNote: When using NeuroLink SDK/CLI, the default is gpt-4o-mini. When instantiating OpenAIProvider directly without setting OPENAI_MODEL, the internal fallback is gpt-5.4.","hierarchy":{"lvl0":"Getting Started","lvl1":"OpenAI Provider Guide","lvl2":"Default Model","lvl3":""}},
|
|
6793
6795
|
{"objectID":"a722c79038b2a55ddfff8bbe51cc124c6b52334826423cf1b4db83de4e7b9aef","title":"Multimodal Capabilities","url":"/docs/getting-started/providers/openai#multimodal-capabilities","content":"Models listed in VISION_CAPABILITIES for the openai provider support image analysis. This includes the GPT-5 family, GPT-4.1 family, GPT-4o family, and o-series models.","hierarchy":{"lvl0":"Getting Started","lvl1":"OpenAI Provider Guide","lvl2":"Multimodal Capabilities","lvl3":""}},
|
|
6794
6796
|
{"objectID":"c331cb5e1ae253efea1792e057d6a4178c61191fe30972b6974856225af3cb12","title":"Image Analysis","url":"/docs/getting-started/providers/openai#image-analysis","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"OpenAI Provider Guide","lvl2":"Image Analysis","lvl3":""}},
|
|
6795
6797
|
{"objectID":"38a79b6cfe051e6742d94758c2df3c0646cae963aab6b4e141db528eb2890eed","title":"From file path (CLI)","url":"/docs/getting-started/providers/openai#from-file-path-cli","content":"pnpm run cli -- generate \"Describe this image\" \\\n --provider openai \\\n --model gpt-4o \\\n --image ./photo.jpg\n\n\nThe provider supports up to **10 images per request** (defined in IMAGE_LIMITS in src/lib/adapters/providerImageAdapter.ts`).","hierarchy":{"lvl0":"Getting Started","lvl1":"OpenAI Provider Guide","lvl2":"From file path (CLI)","lvl3":""}},
|
|
@@ -9758,7 +9760,7 @@
|
|
|
9758
9760
|
{"objectID":"72e3f0653f5610f5b565dde0eeb5fae0f9c2aa2e077546cf977d08fb5ba16d7a","title":"Environment Variables","url":"/docs/rag/CLI-COVERAGE#environment-variables","content":"The following environment variables can be used to configure default behavior:","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - CLI Reference","lvl2":"Environment Variables","lvl3":""}},
|
|
9759
9761
|
{"objectID":"08692e093a4e83ac5f475c624ccb93198b7787555cb016a315235c899937aa7e","title":"Provider & Authentication","url":"/docs/rag/CLI-COVERAGE#provider-authentication","content":"| Variable | Description | Default |\n| ------------------------- | ---------------------------------------- | -------- |\n| NEUROLINK_PROVIDER | Default AI provider | vertex |\n| AI_PROVIDER | Alternative env var for default provider | vertex |\n| GOOGLE_CLOUD_PROJECT_ID | Google Cloud project ID (for Vertex AI) | - |\n| GOOGLE_API_KEY | Google AI Studio API key | - |\n| OPENAI_API_KEY | OpenAI API key | - |\n| ANTHROPIC_API_KEY | Anthropic API key | - |","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - CLI Reference","lvl2":"Provider & Authentication","lvl3":""}},
|
|
9760
9762
|
{"objectID":"07f864c105b32f6b1fc50e0cb08e2125ef5503b8fba263eb75f440ededc69f8b","title":"Embedding Models (for index and query commands)","url":"/docs/rag/CLI-COVERAGE#embedding-models-for-index-and-query-commands","content":"| Variable | Description | Default |\n| ------------------------------ | ------------------------------ | ------------------------------ |\n| NEUROLINK_EMBEDDING_MODEL | Global default embedding model | Provider-specific default |\n| VERTEX_EMBEDDING_MODEL | Vertex AI embedding model | text-embedding-004 |\n| GOOGLE_EMBEDDING_MODEL | Google AI embedding model | text-embedding-004 |\n| OPENAI_EMBEDDING_MODEL | OpenAI embedding model | text-embedding-3-small |\n| AZURE_OPENAI_EMBEDDING_MODEL | Azure OpenAI embedding model | text-embedding-3-small |\n| BEDROCK_EMBEDDING_MODEL | AWS Bedrock embedding model | amazon.titan-embed-text-v2:0 |","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - CLI Reference","lvl2":"Embedding Models (for index and query commands)","lvl3":""}},
|
|
9761
|
-
{"objectID":"50663c177a070a66d4944fcf5d84f98d78f14bd15f71691772f0dc73015bf0f1","title":"Generation Models (for chunk --extract and other text generation)","url":"/docs/rag/CLI-COVERAGE#generation-models-for-chunk---extract-and-other-text-generation","content":"| Variable | Description | Default |\n| -------------------- | ------------------------------ | ------------------ |\n| VERTEX_MODEL | Default model for Vertex AI | gemini-2.5-flash |\n| OPENAI_MODEL | Default model for OpenAI | gpt-4o
|
|
9763
|
+
{"objectID":"50663c177a070a66d4944fcf5d84f98d78f14bd15f71691772f0dc73015bf0f1","title":"Generation Models (for chunk --extract and other text generation)","url":"/docs/rag/CLI-COVERAGE#generation-models-for-chunk---extract-and-other-text-generation","content":"| Variable | Description | Default |\n| -------------------- | ------------------------------ | ------------------ |\n| VERTEX_MODEL | Default model for Vertex AI | gemini-2.5-flash |\n| OPENAI_MODEL | Default model for OpenAI | gpt-4o-mini |\n| AZURE_OPENAI_MODEL | Default model for Azure OpenAI | Deployment-based |\n| BEDROCK_MODEL | Default model for AWS Bedrock | Provider-specific |","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - CLI Reference","lvl2":"Generation Models (for chunk --extract and other text generation)","lvl3":""}},
|
|
9762
9764
|
{"objectID":"6c018c3875b57f47baf2f47fba0097a6ce95bc6057d3455ad0d76888b62885bb","title":"Embedding Model Resolution Order","url":"/docs/rag/CLI-COVERAGE#embedding-model-resolution-order","content":"For index and query commands, the embedding model is resolved in this order:\nCLI --model flag (if it's an embedding model)\nNEUROLINK_EMBEDDING_MODEL (global embedding model)\nProvider-specific embedding env vars (e.g., VERTEX_EMBEDDING_MODEL)\nProvider's default model env var (if it's an embedding model, e.g., if VERTEX_MODEL=text-embedding-004)\nProvider-specific default embedding model (e.g., text-embedding-004 for Vertex)\nFallback: OpenAI text-embedding-3-small\n\nNote: The RAG CLI is smart about model selection. Even if you have VERTEX_MODEL=gemini-2.5-flash set for text generation, the index and query commands will automatically use the appropriate embedding model for your provider.\nIf you explicitly specify a model with --model, ensure it's an embedding model that supports the embed() operation.","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - CLI Reference","lvl2":"Embedding Model Resolution Order","lvl3":""}},
|
|
9763
9765
|
{"objectID":"89a49e923879e964391df538667a2f5c4215cb7d3fc33a55f5b27872411f621e","title":"Common Errors","url":"/docs/rag/CLI-COVERAGE#common-errors","content":"File not found:\n\nEnsure the file path is correct and the file exists.\n\nNo indexed documents:\n\nYou must index a document before querying. Run neurolink rag index <file> first.\n\nIndex not found:\n\nThe specified index name doesn't exist. Check available indices or use the default.","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - CLI Reference","lvl2":"Common Errors","lvl3":""}},
|
|
9764
9766
|
{"objectID":"e2ed24b27e4284131ff513d59ed982787d2eef74c8dcbe04f9c5f8b4e7f74687","title":"Notes","url":"/docs/rag/CLI-COVERAGE#notes","content":"In-memory storage: Currently, indexed documents are stored in memory and will be lost when the process exits. For persistence, use the SDK API with a vector database.\nAuto-detection: When --strategy is not specified, the chunking strategy is automatically detected based on file extension.\nGraph RAG: Building a Graph RAG index (--graph) requires additional processing time but enables context-aware traversal during queries.","hierarchy":{"lvl0":"Rag","lvl1":"RAG Processing - CLI Reference","lvl2":"Notes","lvl3":""}},
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@juspay/neurolink",
|
|
3
|
-
"version": "12.47.
|
|
3
|
+
"version": "12.47.4",
|
|
4
4
|
"packageManager": "pnpm@10.15.1",
|
|
5
5
|
"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.",
|
|
6
6
|
"author": {
|
|
@@ -261,6 +261,7 @@
|
|
|
261
261
|
"test:multimodal:sdk": "pnpm exec tsx test/continuous-test-suite-multimodal-sdk.ts",
|
|
262
262
|
"test:video-frames": "pnpm exec tsx test/continuous-test-suite-video-frames.ts",
|
|
263
263
|
"test:video-no-ffprobe": "pnpm exec tsx test/continuous-test-suite-video-no-ffprobe.ts",
|
|
264
|
+
"test:model-default-resolution": "pnpm exec tsx test/continuous-test-suite-model-default-resolution.ts",
|
|
264
265
|
"test:video-native": "pnpm exec tsx test/continuous-test-suite-video-native.ts",
|
|
265
266
|
"test:mcp-result-cache": "pnpm exec tsx test/continuous-test-suite-mcp-result-cache.ts",
|
|
266
267
|
"test:mcp-breaker-resolved-errors": "pnpm exec tsx test/continuous-test-suite-mcp-breaker-resolved-errors.ts",
|