From 22c0cf4f9f793afd32d52b58adaea48ebd7debdc Mon Sep 17 00:00:00 2001 From: Sachin Sharma Date: Sat, 26 Sep 2026 20:46:16 +0530 Subject: [PATCH] fix(docs): stop recording source line numbers in generated API docs Every docs/api page ended with "Defined in: file.ts:LINE", so a PR that added lines near the top of a large type file rewrote every later page. Three comment-only lines added to src/lib/types/providers.ts changed 143 generated pages without touching any API. Two open PRs that edit the same type file then conflicted on all of those pages, whatever they changed. On 2026-09-26 that was nearly every conflict in the open queue: #1800 hit 110 conflicting docs/api pages and no code conflict. It also inflated diffs: #1800 is 162 files for about 12 real changes. typedoc.json now sets disableSources. The same three-line probe changes 0 pages, so docs/api changes only when a documented API changes, and the CI drift gate keeps working. The regeneration here removes the "Defined in" line from all 3,662 pages and changes nothing else (37,832 deleted lines, one added). Trade-off: the generated pages lose their link to the source line. docs/api is excluded from the docs site (docusaurus docs.exclude "**/api/**"), so this only affects reading the markdown on GitHub. --- .github/workflows/ci.yml | 5 +- .../type-aliases/AnthropicSetupArgv.md | 6 - .../type-aliases/AnthropicSetupConfig.md | 8 - .../type-aliases/AnthropicSetupOptions.md | 6 - .../AzureSetup/type-aliases/AzureSetupArgv.md | 6 - .../type-aliases/AzureSetupConfig.md | 14 - .../type-aliases/AzureSetupOptions.md | 6 - .../type-aliases/BedrockSetupArgv.md | 6 - .../type-aliases/BedrockSetupOptions.md | 6 - .../BedrockSetup/type-aliases/ConfigData.md | 10 - .../BedrockSetup/type-aliases/ConfigStatus.md | 10 - .../type-aliases/BedrockClient.md | 6 - .../type-aliases/InvokeModelCommand.md | 4 - .../GCPSetup/type-aliases/AuthMethodStatus.md | 10 - .../GCPSetup/type-aliases/GCPSetupArgv.md | 6 - .../GCPSetup/type-aliases/GCPSetupOptions.md | 6 - .../type-aliases/GoogleAISetupArgv.md | 6 - .../type-aliases/GoogleAISetupConfig.md | 8 - .../type-aliases/GoogleAISetupOptions.md | 6 - .../type-aliases/HuggingFaceSetupArgs.md | 8 - .../type-aliases/MistralSetupArgs.md | 8 - .../type-aliases/MistralClient.md | 4 - .../type-aliases/OpenAISetupArgv.md | 6 - .../type-aliases/OpenAISetupConfig.md | 10 - .../type-aliases/OpenAISetupOptions.md | 6 - .../TelemetryTypes/type-aliases/Counter.md | 4 - .../TelemetryTypes/type-aliases/Histogram.md | 4 - .../TelemetryTypes/type-aliases/Meter.md | 6 - .../TelemetryTypes/type-aliases/Span.md | 8 - .../TelemetryTypes/type-aliases/Tracer.md | 4 - docs/api/classes/AIProviderFactory.md | 10 - docs/api/classes/AbortError.md | 18 - docs/api/classes/Agent.md | 42 --- docs/api/classes/AgentCoordinator.md | 22 -- docs/api/classes/AgentExposureManager.md | 22 -- docs/api/classes/AgentNetwork.md | 24 -- docs/api/classes/AlreadyRunningError.md | 28 -- docs/api/classes/AlwaysSampler.md | 8 - docs/api/classes/AnswerRelevancyScorer.md | 58 ---- docs/api/classes/AuthContextHolder.md | 18 - docs/api/classes/AuthProviderFactory.md | 16 - docs/api/classes/AuthProviderRegistry.md | 8 - docs/api/classes/AuthenticationError.md | 6 - docs/api/classes/AuthorizationError.md | 6 - docs/api/classes/AvatarError.md | 24 -- docs/api/classes/AvatarProcessor.md | 14 - docs/api/classes/AzureSTT.md | 18 - docs/api/classes/AzureTTS.md | 12 - docs/api/classes/BaseAuthProvider.md | 78 ----- docs/api/classes/BaseError.md | 4 - docs/api/classes/BaseFactory.md | 28 -- docs/api/classes/BaseLLMScorer.md | 58 ---- docs/api/classes/BaseRealtimeHandler.md | 46 --- docs/api/classes/BaseRegistry.md | 24 -- docs/api/classes/BaseRuleScorer.md | 58 ---- docs/api/classes/BaseScorer.md | 34 -- docs/api/classes/BaseServerAdapter.md | 86 ----- docs/api/classes/BatchStrategy.md | 8 - docs/api/classes/BeatovenMusic.md | 14 - docs/api/classes/BiasDetectionScorer.md | 58 ---- docs/api/classes/CSVLoader.md | 10 - docs/api/classes/CartesiaTTS.md | 10 - docs/api/classes/CharacterChunker.md | 8 - docs/api/classes/ChromaVectorStore.md | 10 - docs/api/classes/ChunkerRegistry.md | 18 - docs/api/classes/CircuitBreakerManager.md | 16 - docs/api/classes/CircuitBreakerOpenError.md | 14 - docs/api/classes/ClassifierRouter.md | 12 - docs/api/classes/ClientAuthenticationError.md | 22 -- docs/api/classes/ClientAuthorizationError.md | 22 -- docs/api/classes/ClientConfigurationError.md | 20 -- docs/api/classes/ClientConnectionError.md | 22 -- docs/api/classes/ClientNetworkError.md | 18 - docs/api/classes/ClientNeuroLinkError.md | 18 - docs/api/classes/ClientProviderError.md | 24 -- docs/api/classes/ClientRateLimitError.md | 26 -- docs/api/classes/ClientTimeoutError.md | 20 -- docs/api/classes/ClientValidationError.md | 24 -- docs/api/classes/CohereRelevanceScorer.md | 6 - docs/api/classes/ConfigManager.md | 22 -- docs/api/classes/ConfigurationError.md | 28 -- docs/api/classes/ContentFilterError.md | 26 -- docs/api/classes/ContextBuilder.md | 8 - docs/api/classes/ContextConverter.md | 6 - docs/api/classes/ContextFactory.md | 26 -- docs/api/classes/ContextLengthError.md | 28 -- docs/api/classes/ContextPrecisionScorer.md | 58 ---- docs/api/classes/ContextRelevancyScorer.md | 58 ---- docs/api/classes/ConversationMemoryError.md | 8 - docs/api/classes/CrossEncoderReranker.md | 6 - docs/api/classes/DIDAvatar.md | 12 - docs/api/classes/DeepgramSTT.md | 18 - docs/api/classes/ElevenLabsMusic.md | 14 - docs/api/classes/ElevenLabsTTS.md | 12 - docs/api/classes/ElicitationManager.md | 32 -- .../api/classes/ElicitationProtocolAdapter.md | 18 - docs/api/classes/EnhancedToolDiscovery.md | 32 -- docs/api/classes/EvaluationAggregator.md | 32 -- docs/api/classes/EvaluationPipeline.md | 24 -- docs/api/classes/Evaluator.md | 6 - docs/api/classes/EvaluatorFactory.md | 46 --- docs/api/classes/ExporterRegistry.md | 44 --- docs/api/classes/ExpressServerAdapter.md | 86 ----- docs/api/classes/ExternalServerManager.md | 48 --- docs/api/classes/FaithfulnessScorer.md | 58 ---- docs/api/classes/FastifyServerAdapter.md | 86 ----- docs/api/classes/FileSystemSkillStore.md | 16 - docs/api/classes/FileTokenStorage.md | 14 - docs/api/classes/FishAudioTTS.md | 10 - docs/api/classes/GeminiLive.md | 54 --- docs/api/classes/GoogleSTT.md | 18 - docs/api/classes/GoogleTTSHandler.md | 12 - docs/api/classes/GraphRAG.md | 28 -- docs/api/classes/HITLManager.md | 24 -- docs/api/classes/HTMLChunker.md | 8 - docs/api/classes/HTMLLoader.md | 10 - docs/api/classes/HTTPRateLimiter.md | 20 -- docs/api/classes/HallucinationScorer.md | 58 ---- docs/api/classes/HandlerError.md | 28 -- docs/api/classes/HeyGenAvatar.md | 12 - docs/api/classes/HonoServerAdapter.md | 86 ----- docs/api/classes/ImageGenService.md | 22 -- docs/api/classes/InMemoryBM25Index.md | 6 - docs/api/classes/InMemoryCacheStore.md | 12 - docs/api/classes/InMemoryRateLimitStore.md | 14 - docs/api/classes/InMemorySessionStorage.md | 20 -- docs/api/classes/InMemorySkillStore.md | 14 - docs/api/classes/InMemoryTokenStorage.md | 16 - docs/api/classes/InMemoryVectorStore.md | 8 - .../api/classes/InvalidAuthenticationError.md | 28 -- docs/api/classes/InvalidModelError.md | 6 - docs/api/classes/JSONLoader.md | 10 - docs/api/classes/JWTTokenManager.md | 12 - docs/api/classes/KlingVideoHandler.md | 14 - docs/api/classes/KnowledgeGroundingEngine.md | 12 - docs/api/classes/KnowledgeLexicalIndex.md | 10 - docs/api/classes/KoaServerAdapter.md | 86 ----- docs/api/classes/LLMMetadataExtractor.md | 6 - docs/api/classes/LaTeXChunker.md | 8 - docs/api/classes/LocalTempArtifactStore.md | 14 - docs/api/classes/LyriaMusic.md | 14 - docs/api/classes/MCPCircuitBreaker.md | 22 -- docs/api/classes/MCPClientFactory.md | 16 - docs/api/classes/MCPRegistryClient.md | 38 --- docs/api/classes/MCPServerBase.md | 66 ---- docs/api/classes/MCPToolRegistry.md | 68 ---- docs/api/classes/MDocument.md | 56 ---- docs/api/classes/MarkdownChunker.md | 8 - docs/api/classes/MarkdownLoader.md | 10 - docs/api/classes/MemoryRateLimitStorage.md | 14 - docs/api/classes/MemorySessionStorage.md | 16 - docs/api/classes/MessageBus.md | 40 --- docs/api/classes/MetricsAggregator.md | 40 --- docs/api/classes/MetricsCollector.md | 18 - docs/api/classes/MiddlewareFactory.md | 24 -- docs/api/classes/MissingDependencyError.md | 28 -- docs/api/classes/ModelAccessDeniedError.md | 12 - docs/api/classes/ModelAccessError.md | 10 - docs/api/classes/ModelPool.md | 16 - docs/api/classes/MultiServerManager.md | 48 --- docs/api/classes/MusicError.md | 24 -- docs/api/classes/MusicProcessor.md | 14 - docs/api/classes/NetworkError.md | 6 - docs/api/classes/NetworkOrchestrator.md | 38 --- docs/api/classes/NetworkTopology.md | 42 --- docs/api/classes/NeuroLink.md | 316 ------------------ docs/api/classes/NeuroLinkAIProvider.md | 10 - docs/api/classes/NeuroLinkApiError.md | 22 -- docs/api/classes/NeuroLinkClient.md | 58 ---- docs/api/classes/NeuroLinkFeatureError.md | 14 - docs/api/classes/NeuroLinkLanguageModel.md | 12 - docs/api/classes/NeuroLinkOAuthProvider.md | 30 -- docs/api/classes/NeverSampler.md | 8 - docs/api/classes/NoOpExporter.md | 56 ---- docs/api/classes/NotFoundError.md | 26 -- docs/api/classes/NotRunningError.md | 28 -- docs/api/classes/OAuth2AuthError.md | 8 - docs/api/classes/OAuth2Error.md | 8 - docs/api/classes/OAuth2TokenManager.md | 12 - docs/api/classes/OAuthCallbackServerError.md | 6 - docs/api/classes/OAuthConfigurationError.md | 6 - docs/api/classes/OAuthError.md | 6 - docs/api/classes/OAuthTokenExchangeError.md | 8 - docs/api/classes/OAuthTokenRefreshError.md | 8 - docs/api/classes/OAuthTokenRevocationError.md | 8 - docs/api/classes/OAuthTokenValidationError.md | 6 - docs/api/classes/ObservabilityHooks.md | 22 -- docs/api/classes/OpenAIRealtime.md | 54 --- docs/api/classes/OpenAISTT.md | 16 - docs/api/classes/OpenAITTS.md | 14 - docs/api/classes/PDFLoader.md | 6 - docs/api/classes/PgVectorStore.md | 10 - docs/api/classes/PineconeVectorStore.md | 10 - docs/api/classes/PipelineBuilder.md | 40 --- docs/api/classes/PromptAlignmentScorer.md | 58 ---- docs/api/classes/ProviderError.md | 6 - docs/api/classes/ProviderFactory.md | 22 -- docs/api/classes/ProviderRegistry.md | 16 - docs/api/classes/RAGASEvaluator.md | 6 - docs/api/classes/RAGCircuitBreaker.md | 34 -- docs/api/classes/RAGCircuitBreakerManager.md | 16 - docs/api/classes/RAGJSONChunker.md | 8 - docs/api/classes/RAGPipeline.md | 22 -- docs/api/classes/RAGRetryHandler.md | 12 - docs/api/classes/RateLimitError.md | 6 - docs/api/classes/RateLimiterManager.md | 18 - docs/api/classes/RealtimeError.md | 48 --- docs/api/classes/RealtimeProcessor.md | 30 -- docs/api/classes/RecursiveChunker.md | 8 - docs/api/classes/RedisArtifactStore.md | 18 - docs/api/classes/RedisRateLimitStorage.md | 16 - docs/api/classes/RedisSessionStorage.md | 20 -- docs/api/classes/RedisSkillStore.md | 14 - docs/api/classes/ReplicateAvatar.md | 10 - docs/api/classes/ReplicateMusic.md | 12 - docs/api/classes/ReplicateVideoHandler.md | 14 - docs/api/classes/ReportGenerator.md | 8 - docs/api/classes/RequestBatcher.md | 20 -- docs/api/classes/RequestContext.md | 18 - docs/api/classes/RetryManager.md | 8 - docs/api/classes/RouteConflictError.md | 28 -- docs/api/classes/RouteNotFoundError.md | 28 -- docs/api/classes/RunwayVideoHandler.md | 14 - docs/api/classes/S3SkillStore.md | 16 - docs/api/classes/SSEClient.md | 16 - docs/api/classes/STTError.md | 44 --- docs/api/classes/STTProcessor.md | 14 - docs/api/classes/SamplingStrategy.md | 18 - docs/api/classes/ScorerBuilder.md | 42 --- docs/api/classes/ScorerRegistry.md | 24 -- docs/api/classes/SemanticChunker.md | 8 - docs/api/classes/SentenceChunker.md | 8 - docs/api/classes/ServerAdapterError.md | 28 -- docs/api/classes/ServerAdapterFactory.md | 20 -- docs/api/classes/ServerAuthenticationError.md | 28 -- docs/api/classes/ServerAuthorizationError.md | 28 -- docs/api/classes/ServerCapabilitiesManager.md | 36 -- docs/api/classes/ServerRateLimitError.md | 28 -- docs/api/classes/ServerStartError.md | 28 -- docs/api/classes/ServerStopError.md | 28 -- docs/api/classes/ServerTimeoutError.md | 28 -- docs/api/classes/ServerValidationError.md | 30 -- docs/api/classes/SessionManager.md | 24 -- docs/api/classes/SkillsManager.md | 24 -- docs/api/classes/SpanSerializer.md | 32 -- docs/api/classes/StreamAbortedError.md | 28 -- docs/api/classes/StreamError.md | 18 - docs/api/classes/StreamingError.md | 28 -- docs/api/classes/SummarizationScorer.md | 58 ---- docs/api/classes/TTSError.md | 24 -- docs/api/classes/TTSProcessor.md | 16 - docs/api/classes/TaskDistributor.md | 28 -- docs/api/classes/TextLoader.md | 10 - docs/api/classes/TokenChunker.md | 10 - docs/api/classes/TokenRefreshError.md | 6 - docs/api/classes/TokenStoreError.md | 6 - docs/api/classes/TokenTracker.md | 30 -- docs/api/classes/ToneConsistencyScorer.md | 58 ---- docs/api/classes/ToolCache.md | 30 -- docs/api/classes/ToolCallBatcher.md | 18 - docs/api/classes/ToolEmbeddingIndex.md | 6 - docs/api/classes/ToolIntegrationManager.md | 18 - docs/api/classes/ToolResultCache.md | 18 - docs/api/classes/ToolRouter.md | 28 -- docs/api/classes/ToolRoutingCache.md | 12 - docs/api/classes/TopologyBuilder.md | 18 - docs/api/classes/ToxicityScorer.md | 58 ---- docs/api/classes/TripwireEvaluator.md | 12 - docs/api/classes/TypedEventEmitter.md | 12 - docs/api/classes/UserRateLimiter.md | 14 - docs/api/classes/VertexVideoHandler.md | 14 - docs/api/classes/VideoError.md | 24 -- docs/api/classes/VideoProcessor.md | 16 - docs/api/classes/VoiceError.md | 24 -- docs/api/classes/WebLoader.md | 6 - docs/api/classes/WebSocketConnectionError.md | 28 -- .../api/classes/WebSocketConnectionManager.md | 34 -- docs/api/classes/WebSocketError.md | 28 -- docs/api/classes/WebSocketMessageRouter.md | 8 - docs/api/classes/WebSocketStreamingClient.md | 20 -- docs/api/classes/WorkflowError.md | 6 - docs/api/enumerations/AIProviderName.md | 88 ----- docs/api/enumerations/BedrockModels.md | 176 ---------- docs/api/enumerations/FileErrorCode.md | 50 --- docs/api/enumerations/OpenAIModels.md | 82 ----- docs/api/enumerations/SpanStatus.md | 10 - docs/api/enumerations/SpanType.md | 40 --- docs/api/enumerations/VertexModels.md | 60 ---- docs/api/functions/assembleContext.md | 2 - .../api/functions/assembleKnowledgeContext.md | 2 - docs/api/functions/batchConvertToMCP.md | 2 - docs/api/functions/batchConvertToNeuroLink.md | 2 - docs/api/functions/batchRerank.md | 2 - docs/api/functions/buildDocument.md | 2 - docs/api/functions/buildIndexSnapshot.md | 2 - docs/api/functions/buildModelCatalog.md | 2 - .../buildObservabilityConfigFromEnv.md | 2 - docs/api/functions/buildRegistryIndex.md | 2 - .../functions/buildRoutingQueryFromHistory.md | 2 - docs/api/functions/buildToolRoutingCatalog.md | 2 - docs/api/functions/calculateCost.md | 2 - docs/api/functions/calculateExpiresAt.md | 2 - docs/api/functions/calculateModelMetrics.md | 2 - docs/api/functions/canDeliverVideoNatively.md | 2 - docs/api/functions/chunkText.md | 2 - docs/api/functions/classifyHeuristic.md | 2 - docs/api/functions/classifyJev.md | 2 - docs/api/functions/classifyProviderError.md | 2 - docs/api/functions/clearAnalyticsMetrics.md | 2 - docs/api/functions/clearWorkflowRegistry.md | 2 - docs/api/functions/collectStream.md | 2 - docs/api/functions/compareWorkflows.md | 2 - docs/api/functions/composeMiddleware.md | 2 - docs/api/functions/composeScorers.md | 2 - docs/api/functions/computeToolSignature.md | 2 - docs/api/functions/conditionalMiddleware.md | 2 - docs/api/functions/contextScopeToThreshold.md | 2 - docs/api/functions/contextToErrorContext.md | 2 - docs/api/functions/cosineSimilarity.md | 2 - docs/api/functions/createAIProvider.md | 2 - .../functions/createAIProviderWithFallback.md | 2 - docs/api/functions/createAdaptiveWorkflow.md | 2 - docs/api/functions/createAgentRoutes.md | 2 - .../functions/createAgentWebSocketHandler.md | 2 - docs/api/functions/createAllRoutes.md | 2 - .../functions/createAnalyticsMiddleware.md | 2 - .../functions/createAndInitializePipeline.md | 2 - docs/api/functions/createAnnotatedTool.md | 2 - .../functions/createAnswerRelevancyScorer.md | 2 - .../functions/createApiKeyAuthInterceptor.md | 2 - docs/api/functions/createApiKeyMiddleware.md | 2 - docs/api/functions/createArtifactStore.md | 2 - docs/api/functions/createAsyncStream.md | 2 - docs/api/functions/createAuthMiddleware.md | 2 - docs/api/functions/createAuthProvider.md | 2 - .../functions/createAuthProviderMiddleware.md | 2 - .../createAuthValidatorFromProvider.md | 2 - .../createAuthWithRetryMiddleware.md | 2 - .../functions/createAuthenticatedContext.md | 2 - .../createAuthenticatedRateLimitMiddleware.md | 2 - .../functions/createBatchEvaluationError.md | 2 - docs/api/functions/createBatchStrategy.md | 2 - .../functions/createBearerAuthInterceptor.md | 2 - .../functions/createBearerTokenMiddleware.md | 2 - docs/api/functions/createBestAIProvider.md | 2 - .../functions/createBiasDetectionScorer.md | 2 - docs/api/functions/createCacheInterceptor.md | 2 - docs/api/functions/createCacheInvalidator.md | 2 - docs/api/functions/createCacheMiddleware.md | 2 - docs/api/functions/createChunker.md | 2 - docs/api/functions/createClient.md | 2 - .../functions/createCompressionMiddleware.md | 2 - docs/api/functions/createConditionalScorer.md | 2 - .../api/functions/createConfigurationError.md | 2 - .../functions/createConfirmationRequest.md | 2 - .../functions/createConsensus3WithPrompt.md | 2 - docs/api/functions/createConsoleLoggerHook.md | 2 - .../createContentSimilarityScorer.md | 2 - docs/api/functions/createContextEnricher.md | 2 - .../functions/createContextPrecisionScorer.md | 2 - .../functions/createContextRelevancyScorer.md | 2 - docs/api/functions/createContextWindow.md | 2 - .../api/functions/createDataStreamResponse.md | 2 - docs/api/functions/createDataStreamWriter.md | 2 - .../functions/createDefaultRequestRouter.md | 2 - .../createDefaultTripwireEvaluator.md | 2 - .../functions/createDynamicAuthInterceptor.md | 2 - docs/api/functions/createElicitationCancel.md | 2 - .../api/functions/createElicitationContext.md | 2 - .../api/functions/createElicitationRequest.md | 2 - .../functions/createElicitationResponse.md | 2 - docs/api/functions/createErrorFactory.md | 2 - docs/api/functions/createErrorFromNative.md | 2 - docs/api/functions/createErrorFromResponse.md | 2 - .../createErrorHandlerInterceptor.md | 2 - .../createErrorHandlingMiddleware.md | 2 - docs/api/functions/createErrorResponse.md | 2 - .../functions/createEvaluationFailedError.md | 2 - .../functions/createExpressAuthMiddleware.md | 2 - .../api/functions/createFaithfulnessScorer.md | 2 - docs/api/functions/createFieldValidator.md | 2 - docs/api/functions/createFormRequest.md | 2 - docs/api/functions/createFormatScorer.md | 2 - docs/api/functions/createFunctionScorer.md | 2 - .../functions/createHallucinationScorer.md | 2 - docs/api/functions/createHealthRoutes.md | 2 - docs/api/functions/createHybridSearch.md | 2 - docs/api/functions/createInvertedScorer.md | 2 - docs/api/functions/createJsonResource.md | 2 - .../functions/createKeywordCoverageScorer.md | 2 - docs/api/functions/createKeywordScorer.md | 2 - docs/api/functions/createLangfuseAdapter.md | 2 - docs/api/functions/createLengthScorer.md | 2 - .../functions/createLifecycleMiddleware.md | 2 - docs/api/functions/createLocalUsageReader.md | 2 - .../api/functions/createLoggingInterceptor.md | 2 - docs/api/functions/createLoggingMiddleware.md | 2 - docs/api/functions/createMCPRoutes.md | 2 - docs/api/functions/createMCPServer.md | 2 - .../createMaxRetriesExceededError.md | 2 - docs/api/functions/createMemoryRoutes.md | 2 - docs/api/functions/createMetricsCollector.md | 2 - .../functions/createMetricsCollectorHook.md | 2 - .../api/functions/createMockLangfuseClient.md | 2 - .../functions/createMultiAuthMiddleware.md | 2 - .../api/functions/createMultiJudgeWorkflow.md | 2 - docs/api/functions/createNDJSONHeaders.md | 2 - docs/api/functions/createNeuroLinkModel.md | 2 - docs/api/functions/createNeuroLinkProvider.md | 2 - .../createOAuthProviderFromConfig.md | 2 - docs/api/functions/createOpenAPIGenerator.md | 2 - docs/api/functions/createParseError.md | 2 - docs/api/functions/createPipeline.md | 2 - docs/api/functions/createPrompt.md | 2 - .../functions/createPromptAlignmentScorer.md | 2 - .../functions/createProtectedMiddleware.md | 2 - docs/api/functions/createProviderError.md | 2 - docs/api/functions/createRAGPipeline.md | 2 - docs/api/functions/createRBACMiddleware.md | 2 - .../createRateLimitByUserMiddleware.md | 2 - .../functions/createRateLimitInterceptor.md | 2 - .../functions/createRateLimitMiddleware.md | 2 - docs/api/functions/createRateLimitStorage.md | 2 - docs/api/functions/createRegexScorer.md | 2 - docs/api/functions/createReportGenerator.md | 2 - docs/api/functions/createRequestBatcher.md | 2 - docs/api/functions/createRequestContext.md | 2 - .../functions/createRequestIdMiddleware.md | 2 - .../createRequestTransformInterceptor.md | 2 - .../createRequestValidationMiddleware.md | 2 - .../createResponseTransformInterceptor.md | 2 - docs/api/functions/createRetryInterceptor.md | 2 - docs/api/functions/createRetryMiddleware.md | 2 - docs/api/functions/createRoleMiddleware.md | 2 - docs/api/functions/createSSEHeaders.md | 2 - docs/api/functions/createSamplingStrategy.md | 2 - docs/api/functions/createScorerMetadata.md | 2 - .../createSecurityHeadersMiddleware.md | 2 - docs/api/functions/createSelectRequest.md | 2 - docs/api/functions/createServer.md | 2 - docs/api/functions/createSessionStorage.md | 2 - .../api/functions/createSimpleLengthScorer.md | 2 - docs/api/functions/createSkillStore.md | 2 - docs/api/functions/createSkillTools.md | 2 - .../createSlidingWindowRateLimitMiddleware.md | 2 - .../functions/createStrategyNotFoundError.md | 2 - docs/api/functions/createStreamingClient.md | 2 - docs/api/functions/createStreamingResponse.md | 2 - .../functions/createSummarizationScorer.md | 2 - docs/api/functions/createTextInputRequest.md | 2 - docs/api/functions/createTextResource.md | 2 - .../api/functions/createTimeoutInterceptor.md | 2 - docs/api/functions/createTimeoutMiddleware.md | 2 - docs/api/functions/createTimingMiddleware.md | 2 - .../functions/createTokenManagerMiddleware.md | 2 - .../functions/createToneConsistencyScorer.md | 2 - docs/api/functions/createToolCache.md | 2 - docs/api/functions/createToolCallBatcher.md | 2 - docs/api/functions/createToolFromFunction.md | 2 - .../functions/createToolMiddlewareChain.md | 2 - docs/api/functions/createToolResultCache.md | 2 - docs/api/functions/createToolRouter.md | 2 - docs/api/functions/createToolRoutes.md | 2 - docs/api/functions/createToxicityScorer.md | 2 - docs/api/functions/createVectorQueryTool.md | 2 - docs/api/functions/decideSearchPlan.md | 2 - .../functions/decisionBooleanConfidence.md | 2 - docs/api/functions/decisionKey.md | 2 - docs/api/functions/decodeJWTPayload.md | 2 - docs/api/functions/dedupeTools.md | 2 - docs/api/functions/detectAndRedactPII.md | 2 - docs/api/functions/detectImageMimeType.md | 2 - .../elicitationResponseToProtocol.md | 2 - docs/api/functions/enrichCandidate.md | 2 - docs/api/functions/estimateVideoTokens.md | 2 - docs/api/functions/evaluateBatch.md | 2 - docs/api/functions/executeMCP.md | 2 - .../functions/executeWithCircuitBreaker.md | 2 - docs/api/functions/exposeAgentAsTool.md | 2 - docs/api/functions/exposeAgentsAsTools.md | 2 - docs/api/functions/exposeWorkflowAsTool.md | 2 - docs/api/functions/exposeWorkflowsAsTools.md | 2 - docs/api/functions/extractMetadata.md | 2 - docs/api/functions/extractToken.md | 2 - .../api/functions/filterToolsByAnnotations.md | 2 - docs/api/functions/flushOpenTelemetry.md | 2 - .../functions/formatContextWithCitations.md | 2 - docs/api/functions/gateDecisionBoolean.md | 2 - .../functions/generateOpenAPIFromConfig.md | 2 - docs/api/functions/generateOpenAPISpec.md | 2 - docs/api/functions/generateSummaryStats.md | 2 - docs/api/functions/generateText.md | 2 - docs/api/functions/getAllWellKnownServers.md | 2 - docs/api/functions/getAnalyticsMetrics.md | 2 - docs/api/functions/getAnnotationSummary.md | 2 - docs/api/functions/getApiKeyFromEnv.md | 2 - docs/api/functions/getAuthContext.md | 2 - docs/api/functions/getAvailableProviders.md | 2 - docs/api/functions/getAvailableStrategies.md | 2 - docs/api/functions/getBestProvider.md | 2 - docs/api/functions/getCircuitBreaker.md | 2 - docs/api/functions/getCurrentSession.md | 2 - docs/api/functions/getCurrentUser.md | 2 - docs/api/functions/getDefaultChunkerConfig.md | 2 - docs/api/functions/getErrorMessage.md | 2 - docs/api/functions/getEvaluatorFactory.md | 2 - docs/api/functions/getEvaluatorRegistry.md | 2 - docs/api/functions/getJWTExpiry.md | 2 - docs/api/functions/getLangfuseContext.md | 2 - docs/api/functions/getLangfuseHealthStatus.md | 2 - .../api/functions/getLangfuseSpanProcessor.md | 2 - .../api/functions/getLocalUsageDescriptors.md | 2 - docs/api/functions/getMCPStats.md | 2 - docs/api/functions/getMetricsAggregator.md | 2 - docs/api/functions/getPoolStats.md | 2 - docs/api/functions/getPreset.md | 2 - docs/api/functions/getPresetNames.md | 2 - docs/api/functions/getRecommendedStrategy.md | 2 - .../getRegisteredLocalUsageCliIds.md | 2 - docs/api/functions/getServerInfo.md | 2 - docs/api/functions/getSpanProcessors.md | 2 - docs/api/functions/getTelemetryStatus.md | 2 - docs/api/functions/getToolSafetyLevel.md | 2 - docs/api/functions/getTracer.md | 2 - docs/api/functions/getTracerProvider.md | 2 - docs/api/functions/getVideoProviderConfig.md | 2 - docs/api/functions/getWellKnownServer.md | 2 - docs/api/functions/getWorkflow.md | 2 - docs/api/functions/hasAllPermissions.md | 2 - docs/api/functions/hasAnyRole.md | 2 - docs/api/functions/hasPermission.md | 2 - docs/api/functions/hasPricing.md | 2 - docs/api/functions/hasRole.md | 2 - docs/api/functions/inferAnnotations.md | 2 - docs/api/functions/initializeMCPEcosystem.md | 2 - docs/api/functions/initializeOpenTelemetry.md | 2 - docs/api/functions/initializeTelemetry.md | 2 - docs/api/functions/isAbortError.md | 2 - docs/api/functions/isAnthropicConfig.md | 2 - docs/api/functions/isApiError.md | 2 - docs/api/functions/isAsyncFunction.md | 2 - docs/api/functions/isAudioContent.md | 2 - docs/api/functions/isAuthenticated.md | 2 - docs/api/functions/isCSVContent.md | 2 - docs/api/functions/isCliGenerateResult.md | 2 - docs/api/functions/isCommandResult.md | 2 - .../functions/isElicitationProtocolMessage.md | 2 - docs/api/functions/isError.md | 2 - docs/api/functions/isErrorInfo.md | 2 - docs/api/functions/isEvaluationError.md | 2 - docs/api/functions/isImageContent.md | 2 - docs/api/functions/isJWTExpired.md | 2 - docs/api/functions/isJsonRecord.md | 2 - docs/api/functions/isLangfuseInternalSpan.md | 2 - .../functions/isModelAccessDeniedMessage.md | 2 - docs/api/functions/isMultimodalInput.md | 2 - .../functions/isMultimodalMessageContent.md | 2 - docs/api/functions/isNativeVideoMimeType.md | 2 - docs/api/functions/isNeuroLinkError.md | 2 - .../functions/isOpenTelemetryInitialized.md | 2 - docs/api/functions/isPDFContent.md | 2 - docs/api/functions/isRetryableError.md | 2 - .../functions/isRetryableEvaluationError.md | 2 - docs/api/functions/isRetryableHTTPError.md | 2 - docs/api/functions/isRetryableStatus.md | 2 - docs/api/functions/isRetryableStatusCode.md | 2 - docs/api/functions/isSTTResult.md | 2 - docs/api/functions/isSafeToRetry.md | 2 - docs/api/functions/isStandardRecord.md | 2 - docs/api/functions/isStringArray.md | 2 - docs/api/functions/isTTSResult.md | 2 - docs/api/functions/isTextContent.md | 2 - docs/api/functions/isTokenExpired.md | 2 - docs/api/functions/isToolDefinition.md | 2 - docs/api/functions/isToolResult.md | 2 - docs/api/functions/isTranscriptionSegment.md | 2 - .../isUsingExternalTracerProvider.md | 2 - docs/api/functions/isValidHexColor.md | 2 - docs/api/functions/isValidProvider.md | 2 - docs/api/functions/isValidRealtimeConfig.md | 2 - docs/api/functions/isValidSTTOptions.md | 2 - docs/api/functions/isValidTTSOptions.md | 2 - docs/api/functions/isVertexVideoConfigured.md | 2 - docs/api/functions/isVideoContent.md | 2 - docs/api/functions/jsonSchema.md | 2 - .../api/functions/langfuseShouldExportSpan.md | 2 - docs/api/functions/linearCombination.md | 2 - docs/api/functions/listMCPs.md | 2 - docs/api/functions/listWorkflows.md | 2 - docs/api/functions/loadDocument.md | 2 - docs/api/functions/loadDocuments.md | 2 - docs/api/functions/manifestToSources.md | 2 - docs/api/functions/mapStatusToErrorCode.md | 2 - .../functions/mcpProtocolToolToServerTool.md | 2 - docs/api/functions/mcpToolToNeuroLink.md | 2 - docs/api/functions/mergeAnnotations.md | 2 - docs/api/functions/neuroLinkToolToMCP.md | 2 - docs/api/functions/normalizeAndValidate.md | 2 - docs/api/functions/normalizeHexColor.md | 2 - docs/api/functions/normalizePhrases.md | 2 - docs/api/functions/normalizeText.md | 2 - docs/api/functions/parseAllowedModels.md | 2 - .../pipeAsyncIterableToDataStream.md | 2 - .../api/functions/pipelineToSpanAttributes.md | 2 - docs/api/functions/prepareRAGTool.md | 2 - docs/api/functions/processDocument.md | 2 - .../functions/protocolMessageToElicitation.md | 2 - docs/api/functions/rankCatalogue.md | 2 - docs/api/functions/reachableTextProviders.md | 2 - docs/api/functions/readAllLocalUsage.md | 2 - docs/api/functions/readDecisionBoolean.md | 2 - docs/api/functions/readDecisionChoice.md | 2 - docs/api/functions/readDecisionScore.md | 2 - docs/api/functions/reciprocalRankFusion.md | 2 - docs/api/functions/registerAllRoutes.md | 2 - .../registerDefaultAvatarHandlers.md | 2 - .../functions/registerDefaultMusicHandlers.md | 2 - .../registerDefaultRealtimeHandlers.md | 2 - .../functions/registerDefaultSTTHandlers.md | 2 - .../functions/registerDefaultTTSHandlers.md | 2 - .../functions/registerDefaultVideoHandlers.md | 2 - .../api/functions/registerLocalUsageReader.md | 2 - docs/api/functions/registerWorkflow.md | 2 - docs/api/functions/renderCandidate.md | 2 - docs/api/functions/requireAuth.md | 2 - docs/api/functions/requirePermission.md | 2 - docs/api/functions/requireRole.md | 2 - docs/api/functions/requireUser.md | 2 - docs/api/functions/requiresConfirmation.md | 2 - docs/api/functions/rerank.md | 2 - docs/api/functions/resetMetricsAggregator.md | 2 - .../functions/resolveArtifactStorageType.md | 2 - .../resolveDefaultDecisionProvider.md | 2 - docs/api/functions/resolveEntry.md | 2 - docs/api/functions/resolveHistoryBudget.md | 2 - .../functions/resolveToolRoutingExclusions.md | 2 - docs/api/functions/retrieve.md | 2 - docs/api/functions/runWithAuthContext.md | 2 - .../runWithCurrentLangfuseContext.md | 2 - docs/api/functions/runWorkflow.md | 2 - docs/api/functions/sanitizeToolName.md | 2 - docs/api/functions/scorerToSpanAttributes.md | 2 - .../api/functions/selectIrrelevantMessages.md | 2 - docs/api/functions/selectRelevantToolNames.md | 2 - docs/api/functions/selectServersByDecision.md | 2 - docs/api/functions/serverToolToMCPProtocol.md | 2 - docs/api/functions/servesInferenceKind.md | 2 - docs/api/functions/setLangfuseContext.md | 2 - docs/api/functions/shutdownOpenTelemetry.md | 2 - docs/api/functions/simpleRerank.md | 2 - docs/api/functions/sniffImageMimeType.md | 2 - docs/api/functions/startLangfuseAdapter.md | 2 - docs/api/functions/stepCountIs.md | 2 - docs/api/functions/streamBatchEvaluation.md | 2 - docs/api/functions/summarizeContext.md | 2 - docs/api/functions/summaryPreservesContext.md | 2 - docs/api/functions/supportsNativeVideo.md | 2 - docs/api/functions/toErrorInfo.md | 2 - docs/api/functions/tokenize.md | 2 - docs/api/functions/tool.md | 4 - docs/api/functions/validateAnnotations.md | 2 - docs/api/functions/validateMCPTool.md | 2 - docs/api/functions/validateParams.md | 2 - docs/api/functions/validateQuery.md | 2 - docs/api/functions/validateRequest.md | 2 - docs/api/functions/validateResponse.md | 2 - docs/api/functions/validateServerTools.md | 2 - docs/api/functions/validateTool.md | 2 - docs/api/functions/validateToolName.md | 2 - docs/api/functions/validateWorkflow.md | 2 - docs/api/functions/withHTTPRetry.md | 2 - docs/api/functions/withRetry.md | 2 - docs/api/functions/wrapError.md | 2 - docs/api/functions/wrapToolWithElicitation.md | 2 - .../api/functions/wrapToolsWithElicitation.md | 2 - .../api/type-aliases/AIModelProviderConfig.md | 6 - docs/api/type-aliases/AIProvider.md | 24 -- docs/api/type-aliases/AISDKModel.md | 2 - docs/api/type-aliases/AISDKUsage.md | 12 - docs/api/type-aliases/APIValidationResult.md | 12 - docs/api/type-aliases/AWSCredentialConfig.md | 20 -- .../AbortSignalMiddlewareOptions.md | 6 - .../api/type-aliases/AccountAdmissionLease.md | 4 - .../api/type-aliases/AccountAdmissionState.md | 6 - .../type-aliases/AccountAdmissionWaiter.md | 8 - docs/api/type-aliases/AccountAllowlist.md | 2 - docs/api/type-aliases/AccountCooldownPlan.md | 10 - docs/api/type-aliases/AccountCoolingReason.md | 2 - docs/api/type-aliases/AccountPoolConfig.md | 10 - docs/api/type-aliases/AccountQuota.md | 40 --- docs/api/type-aliases/AccountQuotaSource.md | 2 - docs/api/type-aliases/AccountQuotaWindow.md | 28 -- .../type-aliases/AccountSelectionContext.md | 16 - docs/api/type-aliases/AccountStats.md | 26 -- .../type-aliases/AccountUsageFetchResult.md | 2 - docs/api/type-aliases/ActionAWSConfig.md | 14 - docs/api/type-aliases/ActionCommentResult.md | 10 - docs/api/type-aliases/ActionEvaluation.md | 10 - .../api/type-aliases/ActionExecutionResult.md | 22 -- .../type-aliases/ActionGoogleCloudConfig.md | 8 - .../api/type-aliases/ActionInputValidation.md | 8 - docs/api/type-aliases/ActionInputs.md | 54 --- .../type-aliases/ActionMultimodalInputs.md | 10 - docs/api/type-aliases/ActionOutput.md | 24 -- docs/api/type-aliases/ActionProviderKeys.md | 28 -- docs/api/type-aliases/ActionThinkingConfig.md | 8 - docs/api/type-aliases/ActionTokenUsage.md | 8 - .../type-aliases/AdaptiveSemaphoreConfig.md | 8 - .../type-aliases/AdaptiveSemaphoreMetrics.md | 14 - docs/api/type-aliases/AdditionalMemoryUser.md | 14 - docs/api/type-aliases/AffinityRule.md | 8 - docs/api/type-aliases/AgentCapability.md | 14 - docs/api/type-aliases/AgentDefinition.md | 30 -- docs/api/type-aliases/AgentExecuteRequest.md | 22 -- docs/api/type-aliases/AgentExecuteResponse.md | 16 - .../api/type-aliases/AgentExecutionContext.md | 8 - .../api/type-aliases/AgentExecutionOptions.md | 22 -- docs/api/type-aliases/AgentInput.md | 2 - docs/api/type-aliases/AgentInstance.md | 16 - docs/api/type-aliases/AgentLegOptions.md | 6 - .../api/type-aliases/AgentMechanicalDigest.md | 8 - docs/api/type-aliases/AgentMessage.md | 26 -- docs/api/type-aliases/AgentNetworkConfig.md | 20 -- docs/api/type-aliases/AgentPrimitive.md | 2 - docs/api/type-aliases/AgentResult.md | 22 -- docs/api/type-aliases/AgentRoutingDecision.md | 16 - docs/api/type-aliases/AgentRunBudget.md | 8 - docs/api/type-aliases/AgentRunEvent.md | 28 -- docs/api/type-aliases/AgentRunEventType.md | 2 - docs/api/type-aliases/AgentRunLegInfo.md | 8 - docs/api/type-aliases/AgentRunOptions.md | 18 - docs/api/type-aliases/AgentRunOutcome.md | 32 -- docs/api/type-aliases/AgentRunOverrides.md | 16 - docs/api/type-aliases/AgentRunStatus.md | 2 - docs/api/type-aliases/AgentStatus.md | 12 - docs/api/type-aliases/AgentStreamChunk.md | 30 -- docs/api/type-aliases/AgentStreamChunkType.md | 2 - docs/api/type-aliases/AgentTextChunk.md | 2 - docs/api/type-aliases/AgentToolCallChunk.md | 2 - .../AgentToolRegistrationOptions.md | 20 -- docs/api/type-aliases/AgentToolResultChunk.md | 2 - docs/api/type-aliases/AgentWasteThresholds.md | 10 - docs/api/type-aliases/AgenticLoopAdapter.md | 26 -- docs/api/type-aliases/AgenticLoopChunk.md | 6 - docs/api/type-aliases/AgenticLoopOptions.md | 12 - .../type-aliases/AgenticLoopReclaimResult.md | 6 - .../type-aliases/AgenticLoopReportMetadata.md | 10 - .../type-aliases/AgenticLoopReportStatus.md | 2 - .../api/type-aliases/AgenticLoopReportType.md | 2 - docs/api/type-aliases/AgenticLoopResult.md | 18 - .../type-aliases/AgenticLoopStepRequest.md | 6 - .../api/type-aliases/AgenticLoopStepResult.md | 14 - docs/api/type-aliases/AgenticLoopToolCall.md | 8 - .../type-aliases/AgenticLoopToolCallResult.md | 2 - .../AgenticLoopToolFailureBreaker.md | 8 - docs/api/type-aliases/AgenticLoopUsage.md | 16 - docs/api/type-aliases/AggregatedMetrics.md | 20 -- docs/api/type-aliases/AggregatedScores.md | 16 - docs/api/type-aliases/AggregatedUsage.md | 12 - docs/api/type-aliases/AggregationConfig.md | 8 - docs/api/type-aliases/AggregationMethod.md | 2 - docs/api/type-aliases/AggregationRequest.md | 8 - docs/api/type-aliases/AggregationResult.md | 20 -- docs/api/type-aliases/AiAnalysisProvider.md | 2 - docs/api/type-aliases/AiSdkStreamChunk.md | 10 - docs/api/type-aliases/AiSdkToolCall.md | 10 - docs/api/type-aliases/AlertSeverity.md | 2 - docs/api/type-aliases/AlertSummary.md | 12 - docs/api/type-aliases/AllToolsMap.md | 14 - docs/api/type-aliases/AllowedCommand.md | 2 - docs/api/type-aliases/AnalyticsConfig.md | 18 - docs/api/type-aliases/AnalyticsData.md | 28 -- docs/api/type-aliases/AnalyticsErrorInfo.md | 10 - .../api/type-aliases/AnalyticsQualityScore.md | 12 - docs/api/type-aliases/AnalyticsStorage.md | 8 - docs/api/type-aliases/AnalyzeCsvToolArgs.md | 10 - docs/api/type-aliases/AnalyzeUsageParams.md | 12 - docs/api/type-aliases/AnnotatedToolTarget.md | 10 - .../type-aliases/AnthropicAttemptLogger.md | 2 - docs/api/type-aliases/AnthropicAuthConfig.md | 18 - .../type-aliases/AnthropicAuthConfigResult.md | 16 - docs/api/type-aliases/AnthropicAuthMethod.md | 2 - .../type-aliases/AnthropicAuthRetryResult.md | 24 -- .../api/type-aliases/AnthropicBetaFeatures.md | 26 -- docs/api/type-aliases/AnthropicBetaHeader.md | 2 - .../AnthropicEntitlementFailure.md | 10 - docs/api/type-aliases/AnthropicGuardBlock.md | 8 - .../api/type-aliases/AnthropicGuardMessage.md | 6 - .../AnthropicInvalidRequestFailure.md | 8 - .../AnthropicLoopAdapterConfig.md | 26 -- docs/api/type-aliases/AnthropicLoopState.md | 28 -- .../type-aliases/AnthropicModelMetadata.md | 22 -- docs/api/type-aliases/AnthropicNonOkResult.md | 22 -- docs/api/type-aliases/AnthropicOAuthConfig.md | 18 - .../type-aliases/AnthropicPendingToolUse.md | 8 - .../type-aliases/AnthropicProviderConfig.md | 2 - .../type-aliases/AnthropicRateLimitInfo.md | 36 -- .../type-aliases/AnthropicResponseMetadata.md | 8 - .../type-aliases/AnthropicScopedExhaustion.md | 12 - .../AnthropicStreamPreflightResult.md | 2 - .../type-aliases/AnthropicSuccessResult.md | 2 - .../api/type-aliases/AnthropicUpstreamBody.md | 8 - .../AnthropicUpstreamBodyBuilder.md | 2 - .../AnthropicUpstreamFetchResult.md | 30 -- docs/api/type-aliases/AnthropicUsageLimit.md | 16 - .../type-aliases/AnthropicUsageResponse.md | 10 - docs/api/type-aliases/AnthropicUsageWindow.md | 6 - .../type-aliases/AnthropicVertexSettings.md | 14 - docs/api/type-aliases/AnyFunction.md | 2 - docs/api/type-aliases/ApiKeyAuthOptions.md | 6 - docs/api/type-aliases/ApiResponse.md | 10 - .../ArchiveDecompressionResult.md | 2 - docs/api/type-aliases/ArchiveEntry.md | 10 - .../type-aliases/ArchiveEntryReadResult.md | 2 - docs/api/type-aliases/ArchiveFormat.md | 2 - docs/api/type-aliases/ArizeExporterConfig.md | 2 - docs/api/type-aliases/ArtifactMeta.md | 18 - docs/api/type-aliases/ArtifactPageRequest.md | 6 - docs/api/type-aliases/ArtifactRef.md | 10 - docs/api/type-aliases/ArtifactSearchMatch.md | 10 - docs/api/type-aliases/ArtifactSearchResult.md | 12 - .../api/type-aliases/ArtifactStorageConfig.md | 8 - docs/api/type-aliases/ArtifactStorageType.md | 2 - docs/api/type-aliases/ArtifactStore.md | 16 - docs/api/type-aliases/ArtifactWindow.md | 8 - docs/api/type-aliases/AspectRatio.md | 2 - docs/api/type-aliases/AspectRatioOption.md | 2 - docs/api/type-aliases/AssistantContent.md | 2 - .../api/type-aliases/AssistantModelMessage.md | 8 - docs/api/type-aliases/AsyncApiResponse.md | 2 - docs/api/type-aliases/AsyncEventHandler.md | 2 - docs/api/type-aliases/AsyncFunction.md | 2 - docs/api/type-aliases/AsyncResult.md | 2 - .../type-aliases/AsyncTransformFunction.md | 2 - docs/api/type-aliases/AtomicConsumeResult.md | 6 - docs/api/type-aliases/AudienceOption.md | 2 - docs/api/type-aliases/AudioChunk.md | 10 - docs/api/type-aliases/AudioContent.md | 10 - .../type-aliases/AudioConversionOptions.md | 12 - .../api/type-aliases/AudioConversionResult.md | 8 - docs/api/type-aliases/AudioFormat.md | 2 - docs/api/type-aliases/AudioFormatDetails.md | 14 - docs/api/type-aliases/AudioInputSpec.md | 10 - docs/api/type-aliases/AudioMetadata.md | 16 - .../api/type-aliases/AudioProcessorOptions.md | 14 - docs/api/type-aliases/AudioProviderConfig.md | 16 - docs/api/type-aliases/AudioSaveResult.md | 10 - docs/api/type-aliases/AudioStreamChunk.md | 16 - docs/api/type-aliases/Auth0Config.md | 16 - docs/api/type-aliases/Auth0TokenPayload.md | 24 -- docs/api/type-aliases/AuthCacheConfig.md | 10 - docs/api/type-aliases/AuthCommandArgs.md | 2 - docs/api/type-aliases/AuthErrorCode.md | 2 - docs/api/type-aliases/AuthErrorInfo.md | 2 - docs/api/type-aliases/AuthEventData.md | 16 - docs/api/type-aliases/AuthEventHandler.md | 2 - docs/api/type-aliases/AuthEventType.md | 2 - docs/api/type-aliases/AuthEvents.md | 12 - docs/api/type-aliases/AuthHealthArgs.md | 20 -- docs/api/type-aliases/AuthHealthCheck.md | 12 - docs/api/type-aliases/AuthJWKSCacheEntry.md | 6 - docs/api/type-aliases/AuthLifecycle.md | 10 - .../AuthListDirectQuotaRefreshResult.md | 2 - .../AuthListQuotaRefreshAdapter.md | 10 - .../AuthListRefreshAccountResult.md | 8 - .../type-aliases/AuthListRefreshOutcome.md | 10 - .../AuthListRefreshResultSetter.md | 2 - .../api/type-aliases/AuthListRefreshStatus.md | 2 - docs/api/type-aliases/AuthMiddlewareConfig.md | 16 - .../api/type-aliases/AuthMiddlewareHandler.md | 2 - .../api/type-aliases/AuthMiddlewareOptions.md | 12 - docs/api/type-aliases/AuthMiddlewareResult.md | 8 - docs/api/type-aliases/AuthProvider.md | 2 - docs/api/type-aliases/AuthProviderConfig.md | 2 - .../type-aliases/AuthProviderConstructor.md | 2 - .../api/type-aliases/AuthProviderFactoryFn.md | 2 - .../type-aliases/AuthProviderHealthCheck.md | 14 - .../type-aliases/AuthProviderHealthStatus.md | 12 - docs/api/type-aliases/AuthProviderMetadata.md | 20 -- .../type-aliases/AuthProviderRegistration.md | 8 - docs/api/type-aliases/AuthProviderType.md | 2 - docs/api/type-aliases/AuthProvidersArgs.md | 4 - docs/api/type-aliases/AuthRateLimitConfig.md | 14 - .../type-aliases/AuthRateLimitRedisClient.md | 16 - docs/api/type-aliases/AuthRequestContext.md | 22 -- docs/api/type-aliases/AuthRequestHandler.md | 4 - docs/api/type-aliases/AuthResult.md | 10 - docs/api/type-aliases/AuthSession.md | 26 -- docs/api/type-aliases/AuthSessionManager.md | 14 - docs/api/type-aliases/AuthStatus.md | 12 - docs/api/type-aliases/AuthStatusResult.md | 16 - docs/api/type-aliases/AuthStrategy.md | 2 - docs/api/type-aliases/AuthTokenValidator.md | 10 - docs/api/type-aliases/AuthUser.md | 28 -- docs/api/type-aliases/AuthUserAuthorizer.md | 8 - docs/api/type-aliases/AuthUserManager.md | 12 - docs/api/type-aliases/AuthValidateArgs.md | 22 -- docs/api/type-aliases/AuthenticatedContext.md | 2 - docs/api/type-aliases/AuthenticatedUser.md | 14 - docs/api/type-aliases/AuthenticationState.md | 14 - docs/api/type-aliases/AuthorizationResult.md | 16 - .../type-aliases/AuthorizationUrlResult.md | 8 - docs/api/type-aliases/AutoEvaluationConfig.md | 20 -- docs/api/type-aliases/AutoresearchEmitter.md | 4 - .../type-aliases/AutoresearchErrorEvent.md | 12 - docs/api/type-aliases/AutoresearchEventMap.md | 22 -- .../api/type-aliases/AutoresearchEventName.md | 2 - .../AutoresearchExperimentCompletedEvent.md | 16 - .../AutoresearchExperimentStartedEvent.md | 8 - docs/api/type-aliases/AutoresearchInitArgs.md | 24 -- .../AutoresearchInitializedEvent.md | 8 - .../AutoresearchMetricImprovedEvent.md | 14 - .../AutoresearchPhaseChangedEvent.md | 10 - .../type-aliases/AutoresearchResumedEvent.md | 10 - .../type-aliases/AutoresearchRevertEvent.md | 10 - .../AutoresearchRevertFailedEvent.md | 10 - .../AutoresearchStateUpdatedEvent.md | 12 - .../type-aliases/AutoresearchTaskConfig.md | 36 -- docs/api/type-aliases/AvailableTool.md | 12 - docs/api/type-aliases/AvatarHandler.md | 10 - docs/api/type-aliases/AvatarOptions.md | 22 -- docs/api/type-aliases/AvatarProviderName.md | 2 - docs/api/type-aliases/AvatarQuality.md | 2 - docs/api/type-aliases/AvatarResult.md | 14 - docs/api/type-aliases/AvatarVideoFormat.md | 2 - docs/api/type-aliases/AzureNBest.md | 14 - docs/api/type-aliases/AzureOutputFormat.md | 2 - docs/api/type-aliases/AzureRecognitionMode.md | 2 - .../type-aliases/AzureRecognitionResult.md | 12 - docs/api/type-aliases/AzureSTTOptions.md | 2 - .../AzureSpeakerRecognitionResult.md | 2 - docs/api/type-aliases/AzureTTSOptions.md | 2 - docs/api/type-aliases/AzureVoiceInfo.md | 22 -- docs/api/type-aliases/AzureWord.md | 10 - docs/api/type-aliases/BM25Index.md | 6 - docs/api/type-aliases/BM25Result.md | 10 - docs/api/type-aliases/BackgroundColors.md | 10 - .../BackgroundCommandAllowDecision.md | 2 - .../type-aliases/BackgroundCommandCounts.md | 6 - .../BackgroundCommandCountsSource.md | 2 - .../type-aliases/BackgroundCommandHandle.md | 8 - .../type-aliases/BackgroundCommandOptions.md | 16 - .../BackgroundCommandOutputPage.md | 16 - .../BackgroundCommandPageRequest.md | 8 - .../type-aliases/BackgroundCommandPolicy.md | 12 - .../type-aliases/BackgroundCommandRefusal.md | 6 - .../BackgroundCommandStartToolResult.md | 2 - .../type-aliases/BackgroundCommandState.md | 2 - .../type-aliases/BackgroundCommandStatus.md | 26 -- .../BackgroundCommandStatusToolResult.md | 2 - .../BackgroundCommandStreamName.md | 2 - docs/api/type-aliases/BackgroundStyle.md | 2 - docs/api/type-aliases/BackupInfo.md | 10 - docs/api/type-aliases/BackupMetadata.md | 16 - docs/api/type-aliases/BadWordsConfig.md | 10 - docs/api/type-aliases/BankArtifactOptions.md | 12 - docs/api/type-aliases/BankedArtifactKind.md | 2 - docs/api/type-aliases/BankedArtifactRef.md | 14 - .../type-aliases/BaseAuthProviderConfig.md | 20 -- docs/api/type-aliases/BaseChunkerConfig.md | 14 - docs/api/type-aliases/BaseCommandArgs.md | 10 - docs/api/type-aliases/BaseContext.md | 22 -- docs/api/type-aliases/BaseEvaluateArgs.md | 8 - docs/api/type-aliases/BaseExtractorConfig.md | 12 - docs/api/type-aliases/BaseToolArgs.md | 2 - docs/api/type-aliases/BashToolResult.md | 12 - docs/api/type-aliases/BasicContext.md | 8 - docs/api/type-aliases/BasicToolsMap.md | 6 - docs/api/type-aliases/BatchCommandArgs.md | 2 - docs/api/type-aliases/BatchConfig.md | 12 - .../api/type-aliases/BatchEvaluationConfig.md | 2 - docs/api/type-aliases/BatchEvaluationItem.md | 10 - .../type-aliases/BatchEvaluationItemResult.md | 14 - .../api/type-aliases/BatchEvaluationResult.md | 8 - docs/api/type-aliases/BatchExecutor.md | 2 - .../type-aliases/BatchFileProcessingResult.md | 8 - docs/api/type-aliases/BatchInferenceConfig.md | 16 - docs/api/type-aliases/BatchItemResult.md | 12 - docs/api/type-aliases/BatchOperationResult.md | 8 - .../type-aliases/BatchProcessingSummary.md | 14 - docs/api/type-aliases/BatchProgress.md | 16 - docs/api/type-aliases/BatchResult.md | 12 - docs/api/type-aliases/BatcherEvents.md | 12 - docs/api/type-aliases/BearerAuthOptions.md | 8 - .../type-aliases/BeatovenComposeResponse.md | 6 - docs/api/type-aliases/BeatovenTaskStatus.md | 8 - docs/api/type-aliases/BedrockConfigData.md | 10 - docs/api/type-aliases/BedrockConfigStatus.md | 8 - docs/api/type-aliases/BedrockContentBlock.md | 12 - docs/api/type-aliases/BedrockMessage.md | 6 - .../BedrockPendingContentBlock.md | 2 - docs/api/type-aliases/BedrockToolResult.md | 8 - docs/api/type-aliases/BedrockToolUse.md | 8 - docs/api/type-aliases/BenchmarkParams.md | 12 - docs/api/type-aliases/BetterAuthConfig.md | 10 - docs/api/type-aliases/BiasInstance.md | 10 - docs/api/type-aliases/BodyParserConfig.md | 10 - docs/api/type-aliases/BooleanRecord.md | 2 - docs/api/type-aliases/BoundedZipEntry.md | 6 - docs/api/type-aliases/BracketCountingState.md | 10 - .../type-aliases/BraintrustExporterConfig.md | 2 - docs/api/type-aliases/BudgetCheckParams.md | 20 -- docs/api/type-aliases/BudgetCheckResult.md | 14 - docs/api/type-aliases/BudgetFileInput.md | 8 - .../BuildContentPlanningPromptOptions.md | 16 - .../BuildRealtimeMcpToolsParams.md | 14 - .../api/type-aliases/BuiltInMiddlewareType.md | 2 - .../type-aliases/BuiltInScorerDefinition.md | 8 - docs/api/type-aliases/BulletPoint.md | 18 - docs/api/type-aliases/BulletStyle.md | 2 - docs/api/type-aliases/CLIContext.md | 10 - docs/api/type-aliases/CLIMCPServerConfig.md | 16 - docs/api/type-aliases/CLIProviderConfig.md | 10 - docs/api/type-aliases/CLISetupResult.md | 10 - docs/api/type-aliases/CORSConfig.md | 14 - docs/api/type-aliases/CSVColumnDataType.md | 2 - docs/api/type-aliases/CSVColumnMetadata.md | 28 -- docs/api/type-aliases/CSVContent.md | 8 - .../api/type-aliases/CSVDataQualityWarning.md | 12 - docs/api/type-aliases/CSVLoaderOptions.md | 2 - docs/api/type-aliases/CSVProcessorOptions.md | 22 -- docs/api/type-aliases/CSVRow.md | 2 - docs/api/type-aliases/CacheConfig.md | 14 - docs/api/type-aliases/CacheEntry.md | 10 - docs/api/type-aliases/CacheEvents.md | 12 - .../type-aliases/CacheInterceptorOptions.md | 14 - docs/api/type-aliases/CacheOptions.md | 8 - docs/api/type-aliases/CacheStats.md | 14 - docs/api/type-aliases/CacheStore.md | 10 - docs/api/type-aliases/CacheStrategy.md | 2 - docs/api/type-aliases/CachedImage.md | 16 - docs/api/type-aliases/CachedSession.md | 6 - docs/api/type-aliases/CallRecord.md | 10 - docs/api/type-aliases/CallbackResult.md | 6 - docs/api/type-aliases/CartesiaMessage.md | 8 - docs/api/type-aliases/CatalogBillingPolicy.md | 2 - docs/api/type-aliases/CatalogCapabilities.md | 18 - docs/api/type-aliases/CatalogCredentialKey.md | 2 - .../api/type-aliases/CatalogErrorRuleClass.md | 2 - docs/api/type-aliases/CatalogErrorRuleJson.md | 10 - docs/api/type-aliases/CatalogEvidence.md | 12 - docs/api/type-aliases/CatalogModelSpec.md | 16 - docs/api/type-aliases/CatalogModelStatus.md | 2 - .../api/type-aliases/CatalogPricingPerMTok.md | 8 - docs/api/type-aliases/CatalogProbeEvidence.md | 10 - docs/api/type-aliases/CatalogProviderName.md | 2 - docs/api/type-aliases/CatalogQuirks.md | 10 - docs/api/type-aliases/CatalogSetup.md | 12 - docs/api/type-aliases/CatalogTimeouts.md | 6 - docs/api/type-aliases/CatalogWire.md | 14 - docs/api/type-aliases/CategoryMapping.md | 8 - docs/api/type-aliases/CellValue.md | 2 - .../type-aliases/CharacterChunkerConfig.md | 2 - docs/api/type-aliases/ChartSeries.md | 10 - docs/api/type-aliases/ChatMessage.md | 32 -- docs/api/type-aliases/ChatMessageMetadata.md | 42 --- .../type-aliases/ChecklistCommandCounts.md | 6 - .../ChecklistCommandCountsSource.md | 2 - docs/api/type-aliases/ChecklistCreateInput.md | 4 - .../type-aliases/ChecklistDelegateCounts.md | 6 - .../ChecklistDelegateCountsSource.md | 2 - docs/api/type-aliases/ChecklistItem.md | 14 - docs/api/type-aliases/ChecklistItemStatus.md | 2 - docs/api/type-aliases/ChecklistRefusal.md | 6 - docs/api/type-aliases/ChecklistState.md | 8 - docs/api/type-aliases/ChecklistToolResult.md | 14 - docs/api/type-aliases/ChecklistUpdateInput.md | 8 - docs/api/type-aliases/ChromaClientLike.md | 4 - docs/api/type-aliases/ChromaCollectionLike.md | 8 - docs/api/type-aliases/ChromaDeleteParams.md | 6 - docs/api/type-aliases/ChromaDistanceMetric.md | 2 - docs/api/type-aliases/ChromaIncludeField.md | 2 - docs/api/type-aliases/ChromaMetadata.md | 2 - docs/api/type-aliases/ChromaMetadataValue.md | 2 - docs/api/type-aliases/ChromaQueryParams.md | 10 - docs/api/type-aliases/ChromaQueryResponse.md | 12 - docs/api/type-aliases/ChromaUpsertParams.md | 10 - .../type-aliases/ChromaVectorStoreOptions.md | 4 - docs/api/type-aliases/ChromaWhere.md | 2 - docs/api/type-aliases/Chunk.md | 10 - docs/api/type-aliases/ChunkMetadata.md | 32 -- docs/api/type-aliases/ChunkParams.md | 8 - docs/api/type-aliases/Chunker.md | 6 - docs/api/type-aliases/ChunkerConfig.md | 2 - docs/api/type-aliases/ChunkerMetadata.md | 16 - .../type-aliases/ChunkerValidationResult.md | 8 - docs/api/type-aliases/ChunkingStrategy.md | 2 - docs/api/type-aliases/CircuitBreakerConfig.md | 14 - docs/api/type-aliases/CircuitBreakerEvents.md | 14 - docs/api/type-aliases/CircuitBreakerState.md | 2 - docs/api/type-aliases/CircuitBreakerStats.md | 20 -- docs/api/type-aliases/CircuitState.md | 2 - docs/api/type-aliases/CitationFormat.md | 2 - docs/api/type-aliases/ClaimItem.md | 8 - docs/api/type-aliases/ClassificationScores.md | 8 - docs/api/type-aliases/ClassificationStats.md | 10 - .../type-aliases/ClassificationValidation.md | 6 - docs/api/type-aliases/ClassifierCandidate.md | 32 -- .../type-aliases/ClassifierCatalogConfig.md | 12 - .../type-aliases/ClassifierContextScope.md | 2 - docs/api/type-aliases/ClassifierDecideFn.md | 2 - docs/api/type-aliases/ClassifierDecision.md | 20 -- docs/api/type-aliases/ClassifierDifficulty.md | 2 - docs/api/type-aliases/ClassifierGenerateFn.md | 2 - .../type-aliases/ClassifierGenerateOptions.md | 24 -- .../type-aliases/ClassifierGenerateResult.md | 6 - docs/api/type-aliases/ClassifierLogger.md | 6 - docs/api/type-aliases/ClassifierModelMeta.md | 8 - docs/api/type-aliases/ClassifierModelRef.md | 10 - .../type-aliases/ClassifierRouterConfig.md | 24 -- .../type-aliases/ClassifierRouterDecision.md | 22 -- docs/api/type-aliases/ClassifierRouterDeps.md | 10 - .../api/type-aliases/ClassifierRouterInput.md | 18 - .../ClassifierRouterPoolMember.md | 22 -- .../type-aliases/ClassifierStrategyKind.md | 2 - .../type-aliases/ClassifierToolDirective.md | 6 - docs/api/type-aliases/ClaudeCacheControl.md | 6 - docs/api/type-aliases/ClaudeCodeIdentity.md | 10 - docs/api/type-aliases/ClaudeContentBlock.md | 2 - docs/api/type-aliases/ClaudeErrorResponse.md | 6 - .../type-aliases/ClaudeFinalRequestLogger.md | 2 - docs/api/type-aliases/ClaudeImageBlock.md | 6 - .../type-aliases/ClaudeLimitCaptureSlot.md | 6 - docs/api/type-aliases/ClaudeLimitSnapshot.md | 24 -- .../type-aliases/ClaudeLoggedErrorBuilder.md | 2 - docs/api/type-aliases/ClaudeMessage.md | 6 - docs/api/type-aliases/ClaudeMetadata.md | 4 - docs/api/type-aliases/ClaudeProxyDeps.md | 4 - docs/api/type-aliases/ClaudeProxyModelTier.md | 2 - .../ClaudeProxyRouteRuntimeOptions.md | 6 - docs/api/type-aliases/ClaudeQuotaInfo.md | 22 -- docs/api/type-aliases/ClaudeRequest.md | 28 -- .../ClaudeRequestRuntimeContext.md | 12 - docs/api/type-aliases/ClaudeResponse.md | 18 - docs/api/type-aliases/ClaudeSnapshot.md | 12 - docs/api/type-aliases/ClaudeSnapshotBody.md | 10 - .../type-aliases/ClaudeSubscriptionTier.md | 2 - docs/api/type-aliases/ClaudeTextBlock.md | 8 - docs/api/type-aliases/ClaudeThinkingBlock.md | 6 - .../ClaudeTokenValidationResult.md | 12 - docs/api/type-aliases/ClaudeTool.md | 10 - .../api/type-aliases/ClaudeToolResultBlock.md | 10 - docs/api/type-aliases/ClaudeToolUseBlock.md | 10 - docs/api/type-aliases/ClaudeUsage.md | 10 - docs/api/type-aliases/ClaudeUsageInfo.md | 26 -- docs/api/type-aliases/ClerkConfig.md | 14 - .../api/type-aliases/CliAccountUsageTotals.md | 20 -- docs/api/type-aliases/CliAccountsResponse.md | 16 - docs/api/type-aliases/CliAccountsRow.md | 34 -- docs/api/type-aliases/CliAgentCommandArgs.md | 2 - docs/api/type-aliases/CliAnalytics.md | 14 - .../CliAnalyticsDomainAnalyticsConfig.md | 8 - .../api/type-aliases/CliAudioPlayerCommand.md | 6 - .../type-aliases/CliClassifierRouterFlags.md | 20 -- docs/api/type-aliases/CliClientUsageTotals.md | 14 - docs/api/type-aliases/CliConfigProvider.md | 2 - docs/api/type-aliases/CliDecideArgs.md | 20 -- docs/api/type-aliases/CliDomainConfig.md | 6 - .../CliEcommerceAnalyticsConfig.md | 8 - docs/api/type-aliases/CliEvaluation.md | 14 - .../type-aliases/CliFileProcessingOptions.md | 8 - .../type-aliases/CliFinanceAnalyticsConfig.md | 8 - docs/api/type-aliases/CliGeminiSnapshot.md | 6 - docs/api/type-aliases/CliGenerateResult.md | 2 - .../api/type-aliases/CliGrokProxyModelSpec.md | 14 - docs/api/type-aliases/CliGrokSnapshot.md | 6 - .../CliHealthcareAnalyticsConfig.md | 8 - .../api/type-aliases/CliNetworkCommandArgs.md | 2 - docs/api/type-aliases/CliNeuroLinkConfig.md | 12 - docs/api/type-aliases/CliOpenCodeSnapshot.md | 6 - docs/api/type-aliases/CliProcessingResult.md | 10 - .../CliProxyClientApplyOptions.md | 4 - .../type-aliases/CliProxyClientApplyResult.md | 12 - .../CliProxyClientConfigurator.md | 14 - .../CliProxyClientRestoreResult.md | 10 - docs/api/type-aliases/CliProxyConfigDoc.md | 8 - docs/api/type-aliases/CliProxyRestartError.md | 8 - .../api/type-aliases/CliProxyRestartOutput.md | 2 - docs/api/type-aliases/CliQwenSettings.md | 2 - docs/api/type-aliases/CliRedisClient.md | 12 - docs/api/type-aliases/CliResponse.md | 16 - docs/api/type-aliases/CliServeFlatRoute.md | 10 - docs/api/type-aliases/CliServeRouteGroup.md | 6 - docs/api/type-aliases/CliStreamChunk.md | 10 - docs/api/type-aliases/CliTokenUsage.md | 12 - docs/api/type-aliases/CliToolRoutingFlags.md | 16 - .../type-aliases/CliValidatedFileOption.md | 2 - .../type-aliases/ClientAgentExecuteOptions.md | 14 - .../type-aliases/ClientAgentExecuteResult.md | 16 - docs/api/type-aliases/ClientAgentInfo.md | 12 - docs/api/type-aliases/ClientApiError.md | 14 - docs/api/type-aliases/ClientApiResponse.md | 12 - docs/api/type-aliases/ClientAuthConfig.md | 16 - docs/api/type-aliases/ClientChatMessage.md | 16 - .../ClientClientWebSocketState.md | 2 - docs/api/type-aliases/ClientConfig.md | 20 -- docs/api/type-aliases/ClientControlMessage.md | 4 - .../ClientGenerateRequestOptions.md | 20 -- .../type-aliases/ClientGenerateResponse.md | 18 - docs/api/type-aliases/ClientInternalConfig.md | 26 -- docs/api/type-aliases/ClientLanguageModel.md | 10 - .../ClientLanguageModelCallOptions.md | 16 - .../ClientLanguageModelResponse.md | 10 - .../ClientLanguageModelStreamResponse.md | 6 - docs/api/type-aliases/ClientMiddleware.md | 2 - .../type-aliases/ClientMiddlewareContext.md | 8 - .../type-aliases/ClientMiddlewareRequest.md | 12 - .../type-aliases/ClientMiddlewareResponse.md | 10 - docs/api/type-aliases/ClientModelOptions.md | 10 - docs/api/type-aliases/ClientOAuth2Config.md | 12 - docs/api/type-aliases/ClientProviderStatus.md | 12 - docs/api/type-aliases/ClientRequestOptions.md | 10 - docs/api/type-aliases/ClientRetryConfig.md | 14 - .../ClientSpeechRecognitionResult.md | 8 - .../ClientSpeechSynthesisOptions.md | 12 - .../api/type-aliases/ClientStreamCallbacks.md | 18 - docs/api/type-aliases/ClientStreamEvent.md | 20 -- .../api/type-aliases/ClientStreamEventType.md | 2 - .../ClientStreamRequestOptions.md | 2 - docs/api/type-aliases/ClientStreamResult.md | 14 - .../type-aliases/ClientTokenRefreshResult.md | 12 - docs/api/type-aliases/ClientToolInfo.md | 14 - .../api/type-aliases/ClientWebSocketConfig.md | 2 - .../type-aliases/ClientWebSocketMessage.md | 2 - .../ClientWebSocketMessageHandler.md | 2 - .../type-aliases/ClientWebSocketOptions.md | 14 - docs/api/type-aliases/ClientWebSocketState.md | 2 - .../ClientWorkflowExecuteOptions.md | 12 - .../ClientWorkflowExecuteResult.md | 18 - docs/api/type-aliases/ClientWorkflowInfo.md | 12 - docs/api/type-aliases/ClipCompletion.md | 2 - docs/api/type-aliases/ClipGenState.md | 12 - docs/api/type-aliases/ClipResult.md | 6 - docs/api/type-aliases/CloakingAccount.md | 16 - docs/api/type-aliases/CloakingConfig.md | 6 - docs/api/type-aliases/CloakingContext.md | 10 - docs/api/type-aliases/CloakingMode.md | 2 - docs/api/type-aliases/CloakingPlugin.md | 12 - docs/api/type-aliases/CloakingRequest.md | 8 - docs/api/type-aliases/CloakingResponse.md | 8 - docs/api/type-aliases/CloseHandler.md | 2 - docs/api/type-aliases/CobraInstance.md | 8 - docs/api/type-aliases/CodeLanguage.md | 2 - docs/api/type-aliases/CodexAttemptLogExtra.md | 2 - docs/api/type-aliases/CodexAuthFile.md | 10 - docs/api/type-aliases/CodexAuthFileTokens.md | 10 - docs/api/type-aliases/CodexContentPart.md | 2 - docs/api/type-aliases/CodexFallbackResult.md | 10 - docs/api/type-aliases/CodexFallbackStream.md | 6 - docs/api/type-aliases/CodexFinalLogExtra.md | 2 - .../type-aliases/CodexImportedCredential.md | 16 - .../CodexProxyStatusAccountIdentity.md | 2 - docs/api/type-aliases/CodexQuotaError.md | 8 - docs/api/type-aliases/CodexRateLimitWindow.md | 16 - docs/api/type-aliases/CodexRateLimits.md | 10 - docs/api/type-aliases/CodexReasoningEffort.md | 2 - .../type-aliases/CodexRefreshTokenStore.md | 6 - .../type-aliases/CodexResponsesInputItem.md | 2 - .../api/type-aliases/CodexResponsesRequest.md | 20 -- docs/api/type-aliases/CodexRuntimeAccount.md | 22 -- docs/api/type-aliases/CodexStreamEvidence.md | 18 - docs/api/type-aliases/CodexStreamUsage.md | 22 -- docs/api/type-aliases/CodexTokenRefresher.md | 2 - docs/api/type-aliases/CodexTokenResponse.md | 12 - .../api/type-aliases/CodexUsageFetchResult.md | 2 - docs/api/type-aliases/CodexUsageResponse.md | 8 - docs/api/type-aliases/CognitoConfig.md | 12 - docs/api/type-aliases/CollectedChunkResult.md | 18 - docs/api/type-aliases/ColorMap.md | 2 - docs/api/type-aliases/ColumnData.md | 8 - docs/api/type-aliases/CommandDefinition.md | 12 - docs/api/type-aliases/CommandHandler.md | 2 - docs/api/type-aliases/CommandResult.md | 12 - docs/api/type-aliases/CompactionConfig.md | 26 -- docs/api/type-aliases/CompactionResult.md | 14 - docs/api/type-aliases/CompactionStage.md | 2 - .../type-aliases/CompareProxyReplayOptions.md | 16 - docs/api/type-aliases/ComparisonColumn.md | 8 - .../type-aliases/CompatibilityCheckResult.md | 10 - docs/api/type-aliases/CompleteSlide.md | 12 - docs/api/type-aliases/CompressionOptions.md | 10 - docs/api/type-aliases/CompressionResult.md | 12 - docs/api/type-aliases/ConditionOptions.md | 14 - docs/api/type-aliases/ConditionResult.md | 8 - docs/api/type-aliases/ConditioningConfig.md | 24 -- docs/api/type-aliases/ConfigSource.md | 2 - docs/api/type-aliases/ConfigUpdateOptions.md | 12 - .../type-aliases/ConfigValidationResult.md | 10 - .../type-aliases/ConfirmationElicitation.md | 2 - docs/api/type-aliases/ConfirmationRequest.md | 16 - .../type-aliases/ConfirmationRequestEvent.md | 6 - .../type-aliases/ConfirmationResponseEvent.md | 6 - docs/api/type-aliases/ConfirmationResult.md | 10 - .../type-aliases/ConfirmationTimeoutEvent.md | 6 - .../type-aliases/ConflictDetectionPlugin.md | 12 - docs/api/type-aliases/ConnectionResult.md | 8 - docs/api/type-aliases/ConnectivityResult.md | 6 - docs/api/type-aliases/ConsoleOverride.md | 2 - docs/api/type-aliases/Content.md | 2 - docs/api/type-aliases/ContentBlockType.md | 2 - .../type-aliases/ContentFilteringResult.md | 10 - docs/api/type-aliases/ContentPlan.md | 16 - .../type-aliases/ContentSimilarityConfig.md | 2 - docs/api/type-aliases/Context.md | 10 - .../type-aliases/ContextAssemblyOptions.md | 22 -- .../api/type-aliases/ContextCompactRequest.md | 4 - docs/api/type-aliases/ContextCompactorDeps.md | 8 - docs/api/type-aliases/ContextConfig.md | 14 - .../type-aliases/ContextRelevanceOptions.md | 10 - .../type-aliases/ContextRelevanceResult.md | 14 - docs/api/type-aliases/ContextScoreItem.md | 10 - docs/api/type-aliases/ContextWindow.md | 14 - docs/api/type-aliases/ConversationBase.md | 28 -- docs/api/type-aliases/ConversationChoice.md | 8 - docs/api/type-aliases/ConversationData.md | 2 - docs/api/type-aliases/ConversationEntry.md | 8 - .../type-aliases/ConversationMemoryConfig.md | 30 -- .../type-aliases/ConversationMemoryEvents.md | 10 - .../type-aliases/ConversationMemoryStats.md | 6 - docs/api/type-aliases/ConversationMessage.md | 6 - docs/api/type-aliases/ConversationSummary.md | 2 - docs/api/type-aliases/CoordinationContext.md | 2 - docs/api/type-aliases/CoordinationResult.md | 16 - docs/api/type-aliases/CoordinationStrategy.md | 2 - docs/api/type-aliases/CoordinatorConfig.md | 14 - docs/api/type-aliases/CoreMessage.md | 6 - docs/api/type-aliases/CostAnalysisOptions.md | 8 - docs/api/type-aliases/CostAnalysisResult.md | 18 - docs/api/type-aliases/CostEstimate.md | 10 - docs/api/type-aliases/CostEstimationParams.md | 10 - docs/api/type-aliases/CostGroupItem.md | 22 -- docs/api/type-aliases/CreateRoutesOptions.md | 16 - .../CreateThinkingConfigOptions.md | 8 - .../CredentialValidationResult.md | 16 - docs/api/type-aliases/CronSchedule.md | 8 - docs/api/type-aliases/CustomAuthConfig.md | 8 - .../CustomSchemaExtractorConfig.md | 2 - docs/api/type-aliases/DIDTalkResponse.md | 12 - docs/api/type-aliases/DataContent.md | 2 - docs/api/type-aliases/DataStreamEvent.md | 10 - docs/api/type-aliases/DataStreamEventType.md | 2 - .../type-aliases/DataStreamResponseConfig.md | 10 - docs/api/type-aliases/DataStreamWriter.md | 18 - .../type-aliases/DataStreamWriterConfig.md | 10 - .../api/type-aliases/DatadogExporterConfig.md | 2 - docs/api/type-aliases/DebugResult.md | 10 - docs/api/type-aliases/DecisionAnswer.md | 2 - docs/api/type-aliases/DecisionAnswerMap.md | 2 - .../api/type-aliases/DecisionBooleanAnswer.md | 6 - docs/api/type-aliases/DecisionBooleanGate.md | 6 - .../type-aliases/DecisionBooleanQuestion.md | 8 - docs/api/type-aliases/DecisionCallerFn.md | 2 - docs/api/type-aliases/DecisionChoiceAnswer.md | 10 - .../type-aliases/DecisionChoiceQuestion.md | 8 - .../api/type-aliases/DecisionChoiceReading.md | 10 - docs/api/type-aliases/DecisionError.md | 12 - docs/api/type-aliases/DecisionErrorKind.md | 2 - docs/api/type-aliases/DecisionInput.md | 2 - docs/api/type-aliases/DecisionLimits.md | 10 - docs/api/type-aliases/DecisionModelCard.md | 8 - docs/api/type-aliases/DecisionOptions.md | 2 - docs/api/type-aliases/DecisionQuestion.md | 2 - docs/api/type-aliases/DecisionQuestionMap.md | 2 - docs/api/type-aliases/DecisionRequest.md | 12 - docs/api/type-aliases/DecisionResult.md | 16 - docs/api/type-aliases/DecisionScoreAnswer.md | 12 - .../api/type-aliases/DecisionScoreQuestion.md | 8 - docs/api/type-aliases/DecisionScoreReading.md | 10 - docs/api/type-aliases/DecisionState.md | 2 - docs/api/type-aliases/DecisionUsage.md | 6 - docs/api/type-aliases/DecodedBuffer.md | 8 - docs/api/type-aliases/DeduplicationResult.md | 8 - docs/api/type-aliases/DeepgramAlternative.md | 10 - docs/api/type-aliases/DeepgramChannel.md | 4 - docs/api/type-aliases/DeepgramModel.md | 2 - docs/api/type-aliases/DeepgramResponse.md | 6 - docs/api/type-aliases/DeepgramResult.md | 6 - docs/api/type-aliases/DeepgramSTTOptions.md | 2 - docs/api/type-aliases/DeepgramUtterance.md | 18 - docs/api/type-aliases/DeepgramWord.md | 14 - .../DefaultRequestRouterConfig.md | 10 - .../DeferredClaudeAccountFailure.md | 10 - .../type-aliases/DeferredToolIndexEntry.md | 8 - docs/api/type-aliases/DeferredToolResolver.md | 2 - docs/api/type-aliases/DeferredUsage.md | 14 - docs/api/type-aliases/DelegateCollectMode.md | 2 - .../type-aliases/DelegateCollectRequest.md | 2 - .../api/type-aliases/DelegateCollectResult.md | 10 - docs/api/type-aliases/DelegateHandle.md | 8 - docs/api/type-aliases/DelegateJobPhase.md | 2 - docs/api/type-aliases/DelegateOutcome.md | 24 -- docs/api/type-aliases/DelegateRefusal.md | 6 - .../DelegateRegistrationOptions.md | 10 - .../type-aliases/DelegateRuntimeSettings.md | 10 - .../api/type-aliases/DelegateSpawnDefaults.md | 6 - docs/api/type-aliases/DelegateSpawnOptions.md | 26 -- .../type-aliases/DelegateSpawnToolResult.md | 2 - docs/api/type-aliases/DelegationCondition.md | 2 - docs/api/type-aliases/DelegationRule.md | 8 - docs/api/type-aliases/DeprecatedRouteInfo.md | 8 - docs/api/type-aliases/DeprecationConfig.md | 8 - .../DetachableTransferableProxySocket.md | 2 - docs/api/type-aliases/DetectedPII.md | 10 - docs/api/type-aliases/DetectionStrategy.md | 4 - docs/api/type-aliases/DetectionTestConfig.md | 18 - docs/api/type-aliases/DiagnosticReport.md | 8 - docs/api/type-aliases/DiagnosticResult.md | 14 - docs/api/type-aliases/DimensionAnalysis.md | 12 - docs/api/type-aliases/DirectEvaluateArgs.md | 2 - docs/api/type-aliases/DirectorModeOptions.md | 6 - docs/api/type-aliases/DirectorSegment.md | 6 - docs/api/type-aliases/DiscoveredMcp.md | 12 - docs/api/type-aliases/DistributableTask.md | 20 -- docs/api/type-aliases/DistributionResult.md | 16 - docs/api/type-aliases/DistributionStrategy.md | 2 - docs/api/type-aliases/DoGenerateModel.md | 4 - docs/api/type-aliases/DocsCommandArgs.md | 6 - docs/api/type-aliases/DocumentLoader.md | 6 - docs/api/type-aliases/DocumentState.md | 14 - docs/api/type-aliases/DocumentType.md | 2 - docs/api/type-aliases/DocumentationResult.md | 10 - docs/api/type-aliases/DomainConfig.md | 14 - docs/api/type-aliases/DomainConfigOptions.md | 10 - .../type-aliases/DomainEvaluationCriteria.md | 16 - docs/api/type-aliases/DomainTemplate.md | 8 - docs/api/type-aliases/DomainType.md | 2 - docs/api/type-aliases/DomainValidationRule.md | 10 - docs/api/type-aliases/DynamicArgument.md | 2 - docs/api/type-aliases/DynamicCacheEntry.md | 10 - docs/api/type-aliases/DynamicConfig.md | 2 - docs/api/type-aliases/DynamicModelConfig.md | 2 - docs/api/type-aliases/DynamicOptions.md | 32 -- .../type-aliases/DynamicResolutionContext.md | 6 - .../EffectivePPTProviderResult.md | 10 - docs/api/type-aliases/ElevenLabsModel.md | 2 - docs/api/type-aliases/ElevenLabsTTSOptions.md | 2 - docs/api/type-aliases/ElevenLabsVoice.md | 12 - .../type-aliases/ElevenLabsVoicesResponse.md | 4 - docs/api/type-aliases/Elicitation.md | 2 - .../type-aliases/ElicitationCancelMessage.md | 10 - .../type-aliases/ElicitationCancelParams.md | 6 - docs/api/type-aliases/ElicitationContext.md | 14 - docs/api/type-aliases/ElicitationHandler.md | 2 - .../type-aliases/ElicitationManagerConfig.md | 10 - .../ElicitationProtocolAdapterConfig.md | 10 - .../ElicitationProtocolHandler.md | 2 - .../ElicitationProtocolMessage.md | 10 - .../ElicitationProtocolMessageType.md | 2 - .../ElicitationProtocolPayload.md | 2 - docs/api/type-aliases/ElicitationRequest.md | 20 -- .../type-aliases/ElicitationRequestMessage.md | 10 - .../type-aliases/ElicitationRequestParams.md | 18 - docs/api/type-aliases/ElicitationResponse.md | 16 - .../ElicitationResponseMessage.md | 10 - .../type-aliases/ElicitationResponseParams.md | 14 - docs/api/type-aliases/ElicitationType.md | 2 - docs/api/type-aliases/EmbedInput.md | 8 - docs/api/type-aliases/EmbedManyRequest.md | 8 - docs/api/type-aliases/EmbedManyResponse.md | 12 - docs/api/type-aliases/EmbedRequest.md | 8 - docs/api/type-aliases/EmbedResponse.md | 10 - docs/api/type-aliases/EmbeddingModality.md | 2 - docs/api/type-aliases/EmbeddingModel.md | 2 - docs/api/type-aliases/EmbeddingModelConfig.md | 6 - docs/api/type-aliases/EndpointHealth.md | 10 - docs/api/type-aliases/EndpointMetrics.md | 18 - docs/api/type-aliases/EnhancedContext.md | 2 - .../type-aliases/EnhancedConversationTurn.md | 12 - .../type-aliases/EnhancedEvaluationContext.md | 26 -- .../type-aliases/EnhancedEvaluationResult.md | 2 - .../type-aliases/EnhancedExecutionContext.md | 2 - .../type-aliases/EnhancedGenerateResult.md | 2 - .../type-aliases/EnhancedGroundingMetadata.md | 16 - .../type-aliases/EnhancedGroundingSource.md | 14 - docs/api/type-aliases/EnhancedProvider.md | 8 - docs/api/type-aliases/EnhancedSearchResult.md | 8 - .../type-aliases/EnhancedStreamProvider.md | 8 - docs/api/type-aliases/EnhancedToolInfo.md | 2 - .../type-aliases/EnhancedValidationResult.md | 10 - docs/api/type-aliases/EnhancementOptions.md | 14 - docs/api/type-aliases/EnhancementResult.md | 6 - docs/api/type-aliases/EnhancementType.md | 2 - .../type-aliases/EnsembleExecutionResult.md | 12 - docs/api/type-aliases/EnsembleResponse.md | 22 -- docs/api/type-aliases/Entity.md | 8 - docs/api/type-aliases/EntityId.md | 2 - docs/api/type-aliases/EnvBackupResult.md | 6 - docs/api/type-aliases/EnvUpdateResult.md | 12 - .../type-aliases/EnvVarValidationResult.md | 10 - docs/api/type-aliases/EphemeralContext.md | 12 - docs/api/type-aliases/ErrorCategoryType.md | 2 - docs/api/type-aliases/ErrorCode.md | 2 - docs/api/type-aliases/ErrorCodeType.md | 2 - docs/api/type-aliases/ErrorHandlerOptions.md | 8 - docs/api/type-aliases/ErrorInfo.md | 10 - docs/api/type-aliases/ErrorResponse.md | 8 - docs/api/type-aliases/ErrorSeverityType.md | 2 - docs/api/type-aliases/EscalationResult.md | 10 - docs/api/type-aliases/EvaluatePresetsArgs.md | 6 - docs/api/type-aliases/EvaluateReportArgs.md | 2 - docs/api/type-aliases/EvaluateRunArgs.md | 2 - docs/api/type-aliases/EvaluateScoreArgs.md | 2 - docs/api/type-aliases/EvaluateScorersArgs.md | 10 - docs/api/type-aliases/EvaluationAction.md | 2 - .../type-aliases/EvaluationActionResult.md | 6 - docs/api/type-aliases/EvaluationActions.md | 8 - docs/api/type-aliases/EvaluationConfig.md | 20 -- docs/api/type-aliases/EvaluationContext.md | 20 -- docs/api/type-aliases/EvaluationCriteria.md | 10 - docs/api/type-aliases/EvaluationData.md | 44 --- docs/api/type-aliases/EvaluationErrorCode.md | 2 - .../type-aliases/EvaluationErrorContext.md | 20 -- docs/api/type-aliases/EvaluationEvents.md | 14 - docs/api/type-aliases/EvaluationIssue.md | 8 - docs/api/type-aliases/EvaluationMode.md | 2 - docs/api/type-aliases/EvaluationProvider.md | 2 - docs/api/type-aliases/EvaluationRequest.md | 10 - docs/api/type-aliases/EvaluationResult.md | 24 -- .../type-aliases/EvaluationSpanAttributes.md | 2 - .../type-aliases/EvaluationStrategyConfig.md | 12 - .../EvaluationStrategyFunction.md | 2 - .../EvaluationStrategyMetadata.md | 16 - docs/api/type-aliases/EvaluationThresholds.md | 8 - .../type-aliases/EvaluationTraceContext.md | 14 - docs/api/type-aliases/EvaluatorPreset.md | 8 - docs/api/type-aliases/EventHandler.md | 2 - docs/api/type-aliases/ExcelJSCell.md | 4 - docs/api/type-aliases/ExcelJSRow.md | 6 - docs/api/type-aliases/ExcelJSWorkbook.md | 8 - docs/api/type-aliases/ExcelJSWorksheet.md | 10 - docs/api/type-aliases/ExcelWorksheet.md | 12 - .../type-aliases/ExecuteEnsembleOptions.md | 12 - docs/api/type-aliases/ExecuteLayerOptions.md | 10 - docs/api/type-aliases/ExecuteModelOptions.md | 10 - docs/api/type-aliases/ExecutionConfig.md | 30 -- docs/api/type-aliases/ExecutionContext.md | 22 -- .../type-aliases/ExecutionControlDecision.md | 6 - .../type-aliases/ExecutionControlOptions.md | 10 - .../ExecutionControlStepContext.md | 14 - docs/api/type-aliases/ExecutionRequest.md | 10 - docs/api/type-aliases/ExecutionStrategy.md | 2 - docs/api/type-aliases/ExifOrientationProbe.md | 2 - docs/api/type-aliases/ExperimentPhase.md | 2 - docs/api/type-aliases/ExperimentRecord.md | 14 - docs/api/type-aliases/ExperimentStats.md | 18 - docs/api/type-aliases/ExperimentStatus.md | 2 - docs/api/type-aliases/ExperimentSummary.md | 14 - docs/api/type-aliases/ExportError.md | 8 - .../type-aliases/ExportProxyReplayOptions.md | 8 - docs/api/type-aliases/ExportResult.md | 12 - docs/api/type-aliases/ExporterConfig.md | 18 - docs/api/type-aliases/ExporterHealthStatus.md | 14 - docs/api/type-aliases/ExporterName.md | 2 - docs/api/type-aliases/ExporterPlugin.md | 8 - docs/api/type-aliases/ExposableAgent.md | 16 - docs/api/type-aliases/ExposableWorkflow.md | 18 - docs/api/type-aliases/ExposureOptions.md | 16 - docs/api/type-aliases/ExposureResult.md | 10 - docs/api/type-aliases/ExpressMiddleware.md | 2 - .../ExtendedObservabilityConfig.md | 22 -- .../type-aliases/ExtendedPropertySchema.md | 2 - docs/api/type-aliases/ExtendedTool.md | 2 - .../type-aliases/ExtendedValidationSchema.md | 12 - .../ExternalMCPConfigValidation.md | 10 - .../type-aliases/ExternalMCPManagerConfig.md | 18 - .../ExternalMCPOperationResult.md | 14 - .../type-aliases/ExternalMCPServerConfig.md | 30 -- .../type-aliases/ExternalMCPServerEvents.md | 16 - .../type-aliases/ExternalMCPServerHealth.md | 18 - .../type-aliases/ExternalMCPServerInstance.md | 36 -- .../type-aliases/ExternalMCPServerStatus.md | 2 - .../type-aliases/ExternalMCPToolContext.md | 14 - docs/api/type-aliases/ExternalMCPToolInfo.md | 18 - .../api/type-aliases/ExternalMCPToolResult.md | 14 - .../ExternalToolExecutionOptions.md | 10 - docs/api/type-aliases/ExtractChunksOptions.md | 18 - docs/api/type-aliases/ExtractParams.md | 12 - docs/api/type-aliases/ExtractionResult.md | 12 - docs/api/type-aliases/ExtractorType.md | 2 - .../type-aliases/FactoryEnhancedProvider.md | 2 - docs/api/type-aliases/FactoryFunction.md | 2 - docs/api/type-aliases/FactoryRegistration.md | 8 - docs/api/type-aliases/FailedFileInfo.md | 12 - docs/api/type-aliases/FallbackConfig.md | 16 - docs/api/type-aliases/FallbackEntry.md | 8 - docs/api/type-aliases/FallbackInfo.md | 6 - docs/api/type-aliases/FallbackOptions.md | 10 - .../type-aliases/FastifyRateLimitContext.md | 6 - docs/api/type-aliases/FeatureConfig.md | 2 - docs/api/type-aliases/FeatureItem.md | 10 - docs/api/type-aliases/FfprobeData.md | 6 - docs/api/type-aliases/FfprobeStream.md | 22 -- docs/api/type-aliases/FileDetectionResult.md | 12 - docs/api/type-aliases/FileDetectorOptions.md | 30 -- docs/api/type-aliases/FileElicitation.md | 2 - docs/api/type-aliases/FileExtractionParams.md | 24 -- docs/api/type-aliases/FileExtractionResult.md | 12 - docs/api/type-aliases/FileForSummarization.md | 14 - docs/api/type-aliases/FileFormatEntry.md | 12 - docs/api/type-aliases/FileInfo.md | 16 - docs/api/type-aliases/FileInput.md | 2 - docs/api/type-aliases/FileModality.md | 2 - docs/api/type-aliases/FilePart.md | 12 - docs/api/type-aliases/FileProcessingError.md | 18 - .../api/type-aliases/FileProcessingOptions.md | 2 - docs/api/type-aliases/FileProcessingResult.md | 12 - .../api/type-aliases/FileProcessingSummary.md | 12 - docs/api/type-aliases/FileProcessorConfig.md | 14 - docs/api/type-aliases/FileReadResult.md | 14 - docs/api/type-aliases/FileReference.md | 44 --- docs/api/type-aliases/FileReferenceStatus.md | 2 - .../type-aliases/FileRegistrationOptions.md | 12 - docs/api/type-aliases/FileRegistryOptions.md | 10 - docs/api/type-aliases/FileSearchMatch.md | 10 - docs/api/type-aliases/FileSearchResult.md | 8 - docs/api/type-aliases/FileSource.md | 2 - .../FileSummarizationCheckParams.md | 26 -- .../FileSummarizationCheckResult.md | 12 - .../FileSummarizationPlanEntry.md | 8 - .../FileSummarizationPromptParams.md | 12 - .../FileSummarizationServiceOptions.md | 6 - docs/api/type-aliases/FileToolRootPolicy.md | 4 - docs/api/type-aliases/FileType.md | 2 - docs/api/type-aliases/FileWarning.md | 8 - docs/api/type-aliases/FileWithMetadata.md | 8 - docs/api/type-aliases/FilesystemToolsMap.md | 8 - docs/api/type-aliases/FinishEvent.md | 2 - docs/api/type-aliases/FinishReason.md | 2 - docs/api/type-aliases/FirebaseConfig.md | 14 - .../FixedWindowRateLimitConfig.md | 14 - docs/api/type-aliases/FlaggedItem.md | 8 - docs/api/type-aliases/FlexibleSchema.md | 2 - .../type-aliases/FlexibleValidationResult.md | 12 - docs/api/type-aliases/FormElicitation.md | 2 - docs/api/type-aliases/FormField.md | 20 -- docs/api/type-aliases/FormatScorerConfig.md | 2 - docs/api/type-aliases/FormatType.md | 2 - .../type-aliases/FormatValidationResult.md | 10 - docs/api/type-aliases/Frame.md | 2 - .../api/type-aliases/FrameworkFieldsConfig.md | 10 - docs/api/type-aliases/FunctionParameters.md | 2 - docs/api/type-aliases/GcpAuthMethodStatus.md | 10 - docs/api/type-aliases/GeminiGuardContent.md | 6 - .../type-aliases/GeminiLoopAdapterConfig.md | 2 - .../GeminiLoopAdapterCoreConfig.md | 28 -- .../GeminiMalformedRetryConfig.md | 2 - docs/api/type-aliases/GeminiMessage.md | 8 - .../api/type-aliases/GeminiMultimodalInput.md | 12 - docs/api/type-aliases/GeminiResponse.md | 10 - docs/api/type-aliases/GeminiStepRaw.md | 6 - .../type-aliases/GeminiToolExecutionGuards.md | 2 - docs/api/type-aliases/GeminiTurnContent.md | 6 - docs/api/type-aliases/GenAIClient.md | 6 - .../GenAIGenerateContentResponse.md | 4 - docs/api/type-aliases/GenAILiveMedia.md | 6 - docs/api/type-aliases/GenAILiveSession.md | 8 - docs/api/type-aliases/GenAIModelsAPI.md | 8 - docs/api/type-aliases/GenAIStreamChunk.md | 8 - docs/api/type-aliases/Gender.md | 2 - docs/api/type-aliases/GenerateCommandArgs.md | 2 - docs/api/type-aliases/GenerateOptions.md | 144 -------- .../type-aliases/GenerateOptionsNormalized.md | 2 - docs/api/type-aliases/GenerateResult.md | 2 - docs/api/type-aliases/GenerateStopReason.md | 2 - docs/api/type-aliases/GenerateTextResult.md | 2 - docs/api/type-aliases/GeneratedReport.md | 8 - .../api/type-aliases/GenerationModelConfig.md | 10 - docs/api/type-aliases/GetPromptFunction.md | 2 - docs/api/type-aliases/GitToolLogFormat.md | 2 - docs/api/type-aliases/GitToolRefusal.md | 6 - docs/api/type-aliases/GitToolResult.md | 18 - .../type-aliases/GitToolRuntimeSettings.md | 12 - docs/api/type-aliases/GitToolsetOptions.md | 12 - .../type-aliases/GlobalInstallerExecFile.md | 2 - docs/api/type-aliases/GlobalInstallerKind.md | 2 - docs/api/type-aliases/GlobalInstallerProbe.md | 20 -- .../type-aliases/GlobalInstallerResolution.md | 6 - docs/api/type-aliases/GoogleAudioConfig.md | 14 - docs/api/type-aliases/GoogleAudioEncoding.md | 2 - .../GoogleFilesAPIUploadResult.md | 4 - docs/api/type-aliases/GoogleGenAIClass.md | 2 - .../type-aliases/GoogleGenAIHttpOptions.md | 6 - .../type-aliases/GoogleListVoicesResponse.md | 4 - .../type-aliases/GoogleLiveAudioQueueItem.md | 2 - .../GoogleLongRunningRecognizeResponse.md | 6 - .../type-aliases/GoogleOperationResponse.md | 12 - .../type-aliases/GoogleRecognitionAudio.md | 4 - .../type-aliases/GoogleRecognitionConfig.md | 26 -- .../type-aliases/GoogleRecognizeResponse.md | 6 - .../type-aliases/GoogleSTTAudioEncoding.md | 2 - docs/api/type-aliases/GoogleSTTModel.md | 2 - docs/api/type-aliases/GoogleSTTOptions.md | 2 - .../GoogleSpeechRecognitionAlternative.md | 8 - .../GoogleSpeechRecognitionResult.md | 10 - docs/api/type-aliases/GoogleSynthesisInput.md | 6 - .../type-aliases/GoogleSynthesizeRequest.md | 8 - .../type-aliases/GoogleSynthesizeResponse.md | 4 - docs/api/type-aliases/GoogleTTSOptions.md | 2 - .../GoogleVertexProviderSettings.md | 8 - docs/api/type-aliases/GoogleVoiceInfo.md | 10 - .../GoogleVoiceSelectionParams.md | 8 - docs/api/type-aliases/GoogleVoiceType.md | 2 - docs/api/type-aliases/GoogleWordInfo.md | 12 - docs/api/type-aliases/GraphChunk.md | 6 - docs/api/type-aliases/GraphEdge.md | 10 - docs/api/type-aliases/GraphEmbedding.md | 4 - docs/api/type-aliases/GraphNode.md | 10 - docs/api/type-aliases/GraphQueryParams.md | 10 - docs/api/type-aliases/GraphRAGConfig.md | 6 - docs/api/type-aliases/GraphStats.md | 10 - docs/api/type-aliases/GridPosition.md | 10 - docs/api/type-aliases/GroundingChunk.md | 6 - docs/api/type-aliases/GroundingSupport.md | 8 - .../GuardrailsMiddlewareConfig.md | 8 - docs/api/type-aliases/HITLAuditLog.md | 22 -- docs/api/type-aliases/HITLConfig.md | 18 - docs/api/type-aliases/HITLExecutionState.md | 4 - docs/api/type-aliases/HITLRule.md | 10 - docs/api/type-aliases/HITLStatistics.md | 14 - docs/api/type-aliases/HTMLChunkerConfig.md | 2 - docs/api/type-aliases/HTTPRetryConfig.md | 12 - docs/api/type-aliases/HallucinationItem.md | 8 - .../api/type-aliases/HeaderScrubberOptions.md | 4 - docs/api/type-aliases/HealthMetrics.md | 14 - docs/api/type-aliases/HealthResponse.md | 10 - .../type-aliases/HeyGenVideoStatusResponse.md | 8 - .../HierarchicalExecutionTrace.md | 2 - .../type-aliases/HierarchicalNetworkConfig.md | 2 - .../api/type-aliases/HippocampusAddOptions.md | 6 - docs/api/type-aliases/HippocampusConfig.md | 10 - docs/api/type-aliases/HippocampusLike.md | 10 - docs/api/type-aliases/HippocampusMemory.md | 2 - docs/api/type-aliases/HippocampusModule.md | 4 - .../type-aliases/HippocampusStorageConfig.md | 2 - docs/api/type-aliases/HonoRateLimitEntry.md | 6 - docs/api/type-aliases/HttpMethod.md | 2 - docs/api/type-aliases/HybridSearchConfig.md | 16 - docs/api/type-aliases/HybridSearchOptions.md | 12 - docs/api/type-aliases/HybridSearchResult.md | 12 - docs/api/type-aliases/HyperlinkProps.md | 8 - .../IConversationMemoryManager.md | 30 -- .../api/type-aliases/IdeogramImageResponse.md | 6 - docs/api/type-aliases/ImageCacheConfig.md | 8 - docs/api/type-aliases/ImageCacheStats.md | 18 - docs/api/type-aliases/ImageChunkMetadata.md | 14 - docs/api/type-aliases/ImageContent.md | 12 - docs/api/type-aliases/ImageDocument.md | 12 - docs/api/type-aliases/ImageGenConfig.md | 20 -- docs/api/type-aliases/ImageGenOptions.md | 24 -- docs/api/type-aliases/ImageGenProvider.md | 2 - docs/api/type-aliases/ImageGenResult.md | 20 -- docs/api/type-aliases/ImageGenToolContext.md | 12 - .../type-aliases/ImageGenToolDefinition.md | 10 - docs/api/type-aliases/ImageGenToolParams.md | 10 - docs/api/type-aliases/ImageGenToolResponse.md | 10 - docs/api/type-aliases/ImageLoaderOptions.md | 10 - docs/api/type-aliases/ImageModel.md | 2 - .../ImageOrientationNormalization.md | 6 - docs/api/type-aliases/ImagePart.md | 10 - .../api/type-aliases/ImageValidationResult.md | 10 - docs/api/type-aliases/ImageWithAltText.md | 6 - .../InMemoryAnalyticsStorageOptions.md | 4 - docs/api/type-aliases/IncomingRequest.md | 22 -- docs/api/type-aliases/IndexEntry.md | 2 - .../type-aliases/IndexedKnowledgeDocument.md | 8 - .../type-aliases/IndividualProviderConfig.md | 20 -- docs/api/type-aliases/InferSchema.md | 2 - docs/api/type-aliases/InferToolInput.md | 2 - docs/api/type-aliases/InferToolOutput.md | 2 - docs/api/type-aliases/InferenceKind.md | 2 - docs/api/type-aliases/InfraRegistryEntry.md | 8 - docs/api/type-aliases/InfraRetryOptions.md | 10 - docs/api/type-aliases/IngestOptions.md | 12 - .../InstalledVersionValidation.md | 8 - .../type-aliases/InteractiveProviderConfig.md | 10 - docs/api/type-aliases/InternalResult.md | 14 - docs/api/type-aliases/InternalStreamEvent.md | 10 - docs/api/type-aliases/IntervalSchedule.md | 6 - docs/api/type-aliases/InvokeEndpointParams.md | 20 -- .../type-aliases/InvokeEndpointResponse.md | 10 - .../type-aliases/IsolatedAgentDefinition.md | 2 - .../type-aliases/IsolatedAgentExtraction.md | 16 - docs/api/type-aliases/IssueCategory.md | 2 - docs/api/type-aliases/IssueSeverity.md | 2 - docs/api/type-aliases/JSONChunkerConfig.md | 2 - docs/api/type-aliases/JSONOutput.md | 10 - docs/api/type-aliases/JWK.md | 20 -- docs/api/type-aliases/JWKS.md | 4 - docs/api/type-aliases/JWTConfig.md | 12 - .../type-aliases/JinaEmbeddingsResponse.md | 10 - docs/api/type-aliases/JinaRerankResponse.md | 8 - docs/api/type-aliases/JsonArray.md | 2 - docs/api/type-aliases/JsonCoercionResult.md | 10 - docs/api/type-aliases/JsonObject.md | 2 - docs/api/type-aliases/JsonRecord.md | 2 - docs/api/type-aliases/JsonTypeGuard.md | 2 - docs/api/type-aliases/JsonValue.md | 2 - docs/api/type-aliases/JudgeConfig.md | 32 -- docs/api/type-aliases/JudgeOutputFormat.md | 2 - docs/api/type-aliases/JudgeScoreResult.md | 8 - docs/api/type-aliases/JudgeScores.md | 26 -- docs/api/type-aliases/KeycloakConfig.md | 12 - .../api/type-aliases/KeywordCoverageConfig.md | 2 - .../type-aliases/KeywordCoverageDetails.md | 12 - .../type-aliases/KeywordExtractorConfig.md | 2 - docs/api/type-aliases/KlingTaskResponse.md | 10 - .../type-aliases/KnowledgeAssembledContext.md | 10 - docs/api/type-aliases/KnowledgeCitation.md | 6 - .../type-aliases/KnowledgeContextConfig.md | 6 - .../type-aliases/KnowledgeConversationTurn.md | 6 - .../api/type-aliases/KnowledgeEngineStatus.md | 12 - docs/api/type-aliases/KnowledgeEntryInput.md | 26 -- docs/api/type-aliases/KnowledgeEntryKind.md | 2 - docs/api/type-aliases/KnowledgeFieldName.md | 2 - .../api/type-aliases/KnowledgeFieldWeights.md | 12 - .../type-aliases/KnowledgeGroundingConfig.md | 14 - .../type-aliases/KnowledgeGroundingInput.md | 8 - .../KnowledgeGroundingMetadata.md | 20 -- .../type-aliases/KnowledgeGroundingOutcome.md | 8 - .../type-aliases/KnowledgeIndexSnapshot.md | 14 - .../api/type-aliases/KnowledgeLexicalMatch.md | 8 - .../type-aliases/KnowledgeLexicalSearcher.md | 4 - docs/api/type-aliases/KnowledgeManifest.md | 10 - .../type-aliases/KnowledgeManifestCatalog.md | 6 - .../type-aliases/KnowledgeNormalizeOptions.md | 4 - .../type-aliases/KnowledgeNormalizeResult.md | 6 - .../api/type-aliases/KnowledgeRequestScope.md | 4 - .../KnowledgeResolvedRetrieval.md | 14 - .../KnowledgeRetrievalConfidence.md | 2 - .../type-aliases/KnowledgeRetrievalConfig.md | 16 - .../type-aliases/KnowledgeRetrievalMode.md | 2 - .../type-aliases/KnowledgeRetrievalRequest.md | 8 - .../type-aliases/KnowledgeRetrievalResult.md | 22 -- .../type-aliases/KnowledgeScoredCandidate.md | 16 - docs/api/type-aliases/KnowledgeSelection.md | 12 - docs/api/type-aliases/KnowledgeSource.md | 8 - docs/api/type-aliases/KnowledgeStatus.md | 2 - .../type-aliases/KnowledgeValidationIssue.md | 12 - .../type-aliases/KnowledgeValidationResult.md | 6 - docs/api/type-aliases/KoaRateLimitEntry.md | 6 - docs/api/type-aliases/LLMScorer.md | 2 - docs/api/type-aliases/LLMScorerConfig.md | 2 - docs/api/type-aliases/LaTeXChunkerConfig.md | 2 - .../api/type-aliases/LaminarExporterConfig.md | 2 - .../type-aliases/LangSmithExporterConfig.md | 2 - docs/api/type-aliases/LangSmithRun.md | 26 -- .../api/type-aliases/LangfuseAdapterConfig.md | 14 - docs/api/type-aliases/LangfuseClient.md | 8 - docs/api/type-aliases/LangfuseConfig.md | 28 -- docs/api/type-aliases/LangfuseContext.md | 20 -- .../type-aliases/LangfuseExporterConfig.md | 2 - docs/api/type-aliases/LangfuseSpan.md | 26 -- .../type-aliases/LangfuseSpanAttributes.md | 40 --- docs/api/type-aliases/LanguageModel.md | 2 - .../type-aliases/LanguageModelMiddleware.md | 2 - docs/api/type-aliases/LanguageModelObject.md | 6 - .../LanguageModelRequestMetadata.md | 4 - .../LanguageModelResponseMetadata.md | 10 - docs/api/type-aliases/LanguageModelUsage.md | 16 - docs/api/type-aliases/LanguageModelV3.md | 14 - .../LanguageModelV3CallOptions.md | 34 -- .../type-aliases/LanguageModelV3Content.md | 2 - .../LanguageModelV3GenerateResult.md | 16 - .../type-aliases/LanguageModelV3Message.md | 2 - .../type-aliases/LanguageModelV3Middleware.md | 16 - .../api/type-aliases/LanguageModelV3Prompt.md | 2 - .../api/type-aliases/LanguageModelV3Source.md | 12 - .../type-aliases/LanguageModelV3StreamPart.md | 2 - .../LanguageModelV3StreamResult.md | 8 - .../type-aliases/LanguageModelV3ToolCall.md | 12 - .../type-aliases/LanguageModelV3ToolChoice.md | 2 - docs/api/type-aliases/LatencyStats.md | 24 -- docs/api/type-aliases/LayerExecutionResult.md | 14 - docs/api/type-aliases/LengthConstraintType.md | 2 - docs/api/type-aliases/LengthMeasurement.md | 12 - docs/api/type-aliases/LengthScorerConfig.md | 2 - docs/api/type-aliases/LengthUnit.md | 2 - .../api/type-aliases/LifecycleChunkPayload.md | 8 - .../api/type-aliases/LifecycleErrorPayload.md | 8 - .../type-aliases/LifecycleFinishPayload.md | 10 - .../type-aliases/LifecycleMiddlewareConfig.md | 10 - docs/api/type-aliases/ListOptions.md | 10 - docs/api/type-aliases/LiveConnectCallbacks.md | 10 - docs/api/type-aliases/LiveConnectConfig.md | 8 - docs/api/type-aliases/LiveKitBrainConfig.md | 16 - docs/api/type-aliases/LiveKitBrainDefaults.md | 6 - docs/api/type-aliases/LiveKitBrainTurn.md | 8 - docs/api/type-aliases/LiveKitBridgeRoom.md | 8 - .../type-aliases/LiveKitEventBridgeConfig.md | 12 - .../type-aliases/LiveKitEventBridgeHandle.md | 4 - .../type-aliases/LiveKitEventBridgeParams.md | 8 - .../type-aliases/LiveKitInterruptionConfig.md | 6 - .../type-aliases/LiveKitNeuroLinkStreamer.md | 6 - .../type-aliases/LiveKitRoomCallContext.md | 6 - docs/api/type-aliases/LiveKitServerConfig.md | 8 - .../type-aliases/LiveKitServerCredentials.md | 8 - docs/api/type-aliases/LiveKitSttConfig.md | 10 - docs/api/type-aliases/LiveKitTokenRequest.md | 12 - .../type-aliases/LiveKitToolEventFields.md | 14 - docs/api/type-aliases/LiveKitTtsConfig.md | 8 - docs/api/type-aliases/LiveKitTurnConfig.md | 8 - docs/api/type-aliases/LiveKitVadConfig.md | 8 - .../type-aliases/LiveKitVoiceAgentConfig.md | 32 -- docs/api/type-aliases/LiveKitVoiceBrain.md | 4 - .../LiveKitVoiceControlMessage.md | 2 - .../api/type-aliases/LiveKitVoiceDoneEvent.md | 6 - docs/api/type-aliases/LiveKitVoiceEvent.md | 2 - .../type-aliases/LiveKitVoiceEventEnvelope.md | 2 - .../api/type-aliases/LiveKitVoiceEventType.md | 2 - .../LiveKitVoiceHitlPromptEvent.md | 6 - .../type-aliases/LiveKitVoiceStatusEvent.md | 6 - .../api/type-aliases/LiveKitVoiceTextEvent.md | 6 - .../LiveKitVoiceToolResultEvent.md | 6 - .../LiveKitVoiceToolStartEvent.md | 6 - .../type-aliases/LiveKitVoiceUserTextEvent.md | 6 - .../LiveKitWorkerLaunchOptions.md | 6 - docs/api/type-aliases/LiveServerContent.md | 6 - docs/api/type-aliases/LiveServerMessage.md | 4 - .../LiveServerMessageModelTurn.md | 4 - .../LiveServerMessagePartInlineData.md | 4 - .../api/type-aliases/LoadBalancingStrategy.md | 2 - .../type-aliases/LoadProxyConfigOptions.md | 6 - .../LoadedClaudeAccountContext.md | 22 -- docs/api/type-aliases/LoadedProxyConfig.md | 4 - docs/api/type-aliases/LoaderOptions.md | 8 - .../LocalUsageAggregateOptions.md | 2 - .../type-aliases/LocalUsageAggregateReport.md | 12 - .../type-aliases/LocalUsageClaudeRawUsage.md | 10 - docs/api/type-aliases/LocalUsageCliId.md | 2 - .../LocalUsageCodexSessionRollup.md | 12 - .../api/type-aliases/LocalUsageCommandArgs.md | 8 - .../api/type-aliases/LocalUsageContextPart.md | 6 - .../type-aliases/LocalUsageCopilotUsageRow.md | 16 - .../type-aliases/LocalUsageCostConfidence.md | 2 - .../type-aliases/LocalUsageDedupStrategy.md | 2 - .../type-aliases/LocalUsageGeminiCliTokens.md | 14 - .../LocalUsageGeminiMessageRecord.md | 10 - docs/api/type-aliases/LocalUsageGrokTurn.md | 16 - .../type-aliases/LocalUsageGrokTurnUsage.md | 18 - .../type-aliases/LocalUsageHermesUsageRow.md | 26 -- .../type-aliases/LocalUsageQwenRawUsage.md | 12 - docs/api/type-aliases/LocalUsageReader.md | 8 - .../LocalUsageReaderDescriptor.md | 16 - .../type-aliases/LocalUsageReaderFactoryFn.md | 2 - .../type-aliases/LocalUsageReaderFailure.md | 6 - .../LocalUsageReaderRegistration.md | 6 - .../api/type-aliases/LocalUsageRequestUnit.md | 2 - docs/api/type-aliases/LocalUsageScanError.md | 8 - .../api/type-aliases/LocalUsageScanOptions.md | 4 - docs/api/type-aliases/LocalUsageScanResult.md | 10 - .../type-aliases/LocalUsageSqliteDatabase.md | 6 - .../LocalUsageSqliteDatabaseCtor.md | 2 - docs/api/type-aliases/LocalUsageTotals.md | 20 -- docs/api/type-aliases/LocalUsageWireField.md | 2 - docs/api/type-aliases/LogEntry.md | 10 - docs/api/type-aliases/LogLevel.md | 2 - docs/api/type-aliases/Logger.md | 24 -- docs/api/type-aliases/LoggingConfig.md | 10 - .../type-aliases/LoggingInterceptorOptions.md | 14 - docs/api/type-aliases/LogoConfig.md | 12 - docs/api/type-aliases/LogoPosition.md | 2 - docs/api/type-aliases/LoopGuardEntry.md | 8 - docs/api/type-aliases/LoopGuardPlan.md | 10 - docs/api/type-aliases/LoopGuardPolicy.md | 14 - docs/api/type-aliases/LoopSessionState.md | 12 - docs/api/type-aliases/LyriaResponse.md | 6 - docs/api/type-aliases/MCPClientResult.md | 16 - docs/api/type-aliases/MCPCommandArgs.md | 2 - docs/api/type-aliases/MCPConnectedServer.md | 18 - docs/api/type-aliases/MCPDiscoveredServer.md | 20 -- docs/api/type-aliases/MCPDiscoveryResult.md | 10 - .../api/type-aliases/MCPEnhancementsConfig.md | 16 - docs/api/type-aliases/MCPExecutableTool.md | 2 - .../type-aliases/MCPHTTPTransportOptions.md | 10 - docs/api/type-aliases/MCPOAuthConfig.md | 18 - docs/api/type-aliases/MCPPrompt.md | 8 - docs/api/type-aliases/MCPProtocolTool.md | 10 - .../type-aliases/MCPRegistryClientConfig.md | 12 - docs/api/type-aliases/MCPResource.md | 16 - docs/api/type-aliases/MCPServerBaseConfig.md | 20 -- docs/api/type-aliases/MCPServerCategory.md | 2 - docs/api/type-aliases/MCPServerConfig.md | 20 -- .../type-aliases/MCPServerConnectionStatus.md | 2 - .../type-aliases/MCPServerDomainCategory.md | 2 - docs/api/type-aliases/MCPServerEvents.md | 12 - docs/api/type-aliases/MCPServerInfo.md | 52 --- docs/api/type-aliases/MCPServerMetadata.md | 2 - docs/api/type-aliases/MCPServerReadiness.md | 2 - .../type-aliases/MCPServerRegistryEntry.md | 2 - docs/api/type-aliases/MCPServerStatus.md | 26 -- .../type-aliases/MCPServerStatusResponse.md | 14 - docs/api/type-aliases/MCPServerTool.md | 16 - docs/api/type-aliases/MCPStatus.md | 28 -- docs/api/type-aliases/MCPTool.md | 2 - docs/api/type-aliases/MCPToolAnnotations.md | 28 -- docs/api/type-aliases/MCPToolInfo.md | 18 - docs/api/type-aliases/MCPToolMetadata.md | 2 - docs/api/type-aliases/MCPToolWithServer.md | 16 - docs/api/type-aliases/MCPTransportType.md | 2 - docs/api/type-aliases/MDocumentConfig.md | 6 - docs/api/type-aliases/ManagedLogFile.md | 8 - docs/api/type-aliases/ManifestFamilyRule.md | 6 - .../api/type-aliases/MarkdownChunkerConfig.md | 2 - docs/api/type-aliases/Maybe.md | 2 - docs/api/type-aliases/McpCacheConfig.md | 14 - docs/api/type-aliases/McpCacheEntry.md | 14 - docs/api/type-aliases/McpMetadata.md | 16 - docs/api/type-aliases/McpOperationConfig.md | 2 - docs/api/type-aliases/McpOutputContext.md | 8 - .../type-aliases/McpOutputNormalizerConfig.md | 8 - docs/api/type-aliases/McpOutputStrategy.md | 2 - docs/api/type-aliases/McpRegistry.md | 8 - docs/api/type-aliases/McpRegistryEntry.md | 46 --- docs/api/type-aliases/McpServerWeight.md | 8 - .../type-aliases/MediaGenerationOutputs.md | 18 - .../type-aliases/MediaHandlerDescriptor.md | 8 - docs/api/type-aliases/MediaHandlerKind.md | 2 - .../type-aliases/MemoryCustomStorageConfig.md | 12 - docs/api/type-aliases/MemoryMetricConfig.md | 6 - .../type-aliases/MemoryRedisStorageConfig.md | 16 - .../api/type-aliases/MemoryS3StorageConfig.md | 8 - .../type-aliases/MemorySqliteStorageConfig.md | 6 - docs/api/type-aliases/MenuChoice.md | 2 - docs/api/type-aliases/Message.md | 6 - docs/api/type-aliases/MessageBusConfig.md | 12 - .../type-aliases/MessageBusSubscription.md | 14 - docs/api/type-aliases/MessageContent.md | 28 -- docs/api/type-aliases/MessageHandler.md | 2 - docs/api/type-aliases/MessagePriority.md | 2 - docs/api/type-aliases/MessageType.md | 2 - docs/api/type-aliases/MetadataExtractor.md | 6 - .../type-aliases/MetadataExtractorConfig.md | 14 - .../type-aliases/MetadataExtractorMetadata.md | 16 - .../api/type-aliases/MetadataExtractorType.md | 2 - docs/api/type-aliases/MetadataFilter.md | 34 -- docs/api/type-aliases/MetricConfig.md | 8 - docs/api/type-aliases/MetricDirection.md | 2 - .../type-aliases/MetricsAggregatorConfig.md | 10 - docs/api/type-aliases/MetricsSummary.md | 28 -- docs/api/type-aliases/MetricsTraceContext.md | 6 - .../api/type-aliases/MiddlewareChainConfig.md | 10 - docs/api/type-aliases/MiddlewareChainStats.md | 10 - docs/api/type-aliases/MiddlewareConditions.md | 10 - docs/api/type-aliases/MiddlewareConfig.md | 8 - docs/api/type-aliases/MiddlewareContext.md | 12 - docs/api/type-aliases/MiddlewareDefinition.md | 12 - .../MiddlewareExecutionContext.md | 16 - .../type-aliases/MiddlewareExecutionResult.md | 10 - .../type-aliases/MiddlewareFactoryConfig.md | 10 - .../type-aliases/MiddlewareFactoryOptions.md | 14 - docs/api/type-aliases/MiddlewareHandler.md | 2 - docs/api/type-aliases/MiddlewareMetrics.md | 14 - docs/api/type-aliases/MiddlewarePreset.md | 8 - .../MiddlewareRegistrationOptions.md | 8 - .../type-aliases/MiddlewareRegistryEntry.md | 12 - .../type-aliases/MiddlewareRequestSchema.md | 8 - .../MiddlewareValidationResult.md | 8 - docs/api/type-aliases/MinimalChatMessage.md | 12 - docs/api/type-aliases/ModelAliasConfig.md | 4 - docs/api/type-aliases/ModelCapabilities.md | 18 - docs/api/type-aliases/ModelCapability.md | 2 - docs/api/type-aliases/ModelChoice.md | 8 - docs/api/type-aliases/ModelComparison.md | 6 - docs/api/type-aliases/ModelConfig.md | 14 - docs/api/type-aliases/ModelCostStats.md | 20 -- .../api/type-aliases/ModelDeploymentConfig.md | 20 -- docs/api/type-aliases/ModelDetectionResult.md | 10 - docs/api/type-aliases/ModelFilter.md | 16 - docs/api/type-aliases/ModelFilterConfig.md | 6 - docs/api/type-aliases/ModelGroup.md | 22 -- docs/api/type-aliases/ModelInfo.md | 30 -- docs/api/type-aliases/ModelLimits.md | 10 - docs/api/type-aliases/ModelMapping.md | 8 - docs/api/type-aliases/ModelMessage.md | 2 - docs/api/type-aliases/ModelPerformance.md | 8 - docs/api/type-aliases/ModelPoolConfig.md | 10 - docs/api/type-aliases/ModelPoolMember.md | 10 - docs/api/type-aliases/ModelPoolStrategy.md | 2 - docs/api/type-aliases/ModelPricing.md | 18 - docs/api/type-aliases/ModelPricingInfo.md | 8 - docs/api/type-aliases/ModelRecommendation.md | 10 - docs/api/type-aliases/ModelRegistry.md | 2 - .../type-aliases/ModelResolutionContext.md | 12 - docs/api/type-aliases/ModelRoute.md | 10 - docs/api/type-aliases/ModelRouterInterface.md | 16 - docs/api/type-aliases/ModelRoutingOptions.md | 10 - docs/api/type-aliases/ModelSearchFilters.md | 18 - docs/api/type-aliases/ModelSearchResult.md | 8 - docs/api/type-aliases/ModelStats.md | 16 - docs/api/type-aliases/ModelTier.md | 2 - docs/api/type-aliases/ModelTierEntry.md | 8 - docs/api/type-aliases/ModelTokenStats.md | 18 - docs/api/type-aliases/ModelUseCase.md | 2 - docs/api/type-aliases/ModelsCommandArgs.md | 2 - docs/api/type-aliases/ModelsResponse.md | 4 - docs/api/type-aliases/MultiJudgeScores.md | 36 -- docs/api/type-aliases/MultiModalChunk.md | 2 - .../type-aliases/MultiModalEmbeddingConfig.md | 10 - docs/api/type-aliases/MultiModalMatchType.md | 2 - docs/api/type-aliases/MultiModalQuery.md | 2 - docs/api/type-aliases/MultiModalRAGConfig.md | 16 - .../type-aliases/MultiModalSearchResult.md | 8 - .../type-aliases/MultiSelectElicitation.md | 2 - .../type-aliases/MultiServerManagerConfig.md | 16 - docs/api/type-aliases/MultimodalAudioEntry.md | 8 - .../api/type-aliases/MultimodalChatMessage.md | 8 - docs/api/type-aliases/MultimodalInput.md | 20 -- docs/api/type-aliases/MultimodalMessage.md | 6 - docs/api/type-aliases/MultimodalPdfEntry.md | 16 - docs/api/type-aliases/MultimodalVideoEntry.md | 10 - docs/api/type-aliases/MusicAudioFormat.md | 2 - docs/api/type-aliases/MusicGenre.md | 2 - docs/api/type-aliases/MusicHandler.md | 12 - docs/api/type-aliases/MusicMood.md | 2 - docs/api/type-aliases/MusicOptions.md | 22 -- docs/api/type-aliases/MusicProviderName.md | 2 - docs/api/type-aliases/MusicResult.md | 14 - .../NativeAnthropicToolDeclaration.md | 10 - docs/api/type-aliases/NativeFunctionCall.md | 6 - .../type-aliases/NativeFunctionDeclaration.md | 8 - .../type-aliases/NativeFunctionResponse.md | 4 - .../type-aliases/NativeGenerateGuardConfig.md | 8 - .../type-aliases/NativeGenerateLoopArgs.md | 32 -- .../type-aliases/NativeGenerateLoopResult.md | 22 -- .../type-aliases/NativeMediaAttachments.md | 8 - docs/api/type-aliases/NativeThinkingConfig.md | 8 - .../NativeToolDeclarationsResult.md | 8 - docs/api/type-aliases/NativeToolFormat.md | 2 - docs/api/type-aliases/NativeToolsConfig.md | 2 - docs/api/type-aliases/NetworkCompleteChunk.md | 2 - docs/api/type-aliases/NetworkDefaults.md | 8 - docs/api/type-aliases/NetworkErrorChunk.md | 2 - .../api/type-aliases/NetworkExecutionInput.md | 10 - .../type-aliases/NetworkExecutionOptions.md | 16 - .../type-aliases/NetworkExecutionResult.md | 16 - .../type-aliases/NetworkExecutionStatus.md | 2 - docs/api/type-aliases/NetworkExecutionStep.md | 18 - .../api/type-aliases/NetworkExecutionTrace.md | 12 - docs/api/type-aliases/NetworkInfo.md | 22 -- docs/api/type-aliases/NetworkMemoryConfig.md | 10 - docs/api/type-aliases/NetworkPrimitive.md | 14 - docs/api/type-aliases/NetworkPrimitiveType.md | 2 - docs/api/type-aliases/NetworkStartChunk.md | 2 - docs/api/type-aliases/NetworkState.md | 2 - docs/api/type-aliases/NetworkStreamChunk.md | 2 - .../type-aliases/NetworkStreamChunkBase.md | 10 - .../type-aliases/NetworkStreamChunkType.md | 2 - docs/api/type-aliases/NetworkTokenUsage.md | 10 - docs/api/type-aliases/NetworkToolInfo.md | 8 - .../type-aliases/NetworkTransportResult.md | 4 - docs/api/type-aliases/NetworkWorkflow.md | 6 - .../type-aliases/NetworkWorkflowDefinition.md | 14 - docs/api/type-aliases/NeuroLinkAuthConfig.md | 2 - docs/api/type-aliases/NeuroLinkAuthOptions.md | 8 - docs/api/type-aliases/NeuroLinkConfig.md | 14 - docs/api/type-aliases/NeuroLinkEvents.md | 72 ---- docs/api/type-aliases/NeuroLinkExecutable.md | 4 - .../type-aliases/NeuroLinkExecutionContext.md | 62 ---- docs/api/type-aliases/NeuroLinkInstance.md | 4 - docs/api/type-aliases/NeuroLinkMCPServer.md | 24 -- docs/api/type-aliases/NeuroLinkMCPTool.md | 22 -- docs/api/type-aliases/NeuroLinkMiddleware.md | 2 - .../NeuroLinkMiddlewareMetadata.md | 14 - .../type-aliases/NeuroLinkProviderOptions.md | 14 - .../type-aliases/NeuroLinkProviderProps.md | 6 - docs/api/type-aliases/NeuroLinkTool.md | 18 - .../NeurolinkConstructorConfig.md | 46 --- docs/api/type-aliases/NeurolinkCredentials.md | 86 ----- docs/api/type-aliases/NeurolinkOptions.md | 8 - docs/api/type-aliases/NextFunction.md | 2 - docs/api/type-aliases/NonEmptyString.md | 2 - .../type-aliases/NormalizedKnowledgeEntry.md | 28 -- docs/api/type-aliases/NormalizedMcpOutput.md | 10 - docs/api/type-aliases/Nullable.md | 2 - docs/api/type-aliases/NumberArray.md | 2 - docs/api/type-aliases/NumberRecord.md | 2 - docs/api/type-aliases/NvidiaNimExtraBody.md | 18 - docs/api/type-aliases/OAuth2Config.md | 20 -- .../type-aliases/OAuthClientInformation.md | 8 - docs/api/type-aliases/OAuthConfig.md | 18 - docs/api/type-aliases/OAuthFlowTokens.md | 12 - docs/api/type-aliases/OAuthToken.md | 12 - docs/api/type-aliases/OAuthTokenResponse.md | 12 - docs/api/type-aliases/OAuthTokens.md | 12 - .../ObservabilityCircuitBreakerConfig.md | 6 - .../ObservabilityCircuitBreakerState.md | 8 - .../type-aliases/ObservabilityCommandArgs.md | 6 - docs/api/type-aliases/ObservabilityConfig.md | 6 - .../type-aliases/ObservabilityCostsArgs.md | 2 - .../ObservabilityExportersArgs.md | 2 - .../type-aliases/ObservabilityMetricsArgs.md | 2 - .../type-aliases/ObservabilityModelPricing.md | 8 - .../type-aliases/ObservabilityStatusArgs.md | 2 - docs/api/type-aliases/OfficeDocumentType.md | 2 - .../type-aliases/OfficeProcessorOptions.md | 14 - docs/api/type-aliases/OllamaCommandArgs.md | 2 - docs/api/type-aliases/OllamaHttpError.md | 2 - docs/api/type-aliases/OnChunkCallback.md | 2 - docs/api/type-aliases/OnErrorCallback.md | 2 - docs/api/type-aliases/OnFinishCallback.md | 2 - docs/api/type-aliases/OnceSchedule.md | 6 - .../type-aliases/OpenAIAssistantMessage.md | 8 - docs/api/type-aliases/OpenAIAudioDelta.md | 2 - .../type-aliases/OpenAICompatBuildBodyArgs.md | 16 - .../type-aliases/OpenAICompatCatalogEntry.md | 38 --- .../type-aliases/OpenAICompatChatChoice.md | 8 - .../OpenAICompatChatChoiceMessage.md | 14 - .../type-aliases/OpenAICompatChatMessage.md | 2 - .../type-aliases/OpenAICompatChatRequest.md | 36 -- .../type-aliases/OpenAICompatChatResponse.md | 16 - docs/api/type-aliases/OpenAICompatChatRole.md | 2 - .../OpenAICompatChatStreamChunk.md | 14 - docs/api/type-aliases/OpenAICompatChatTool.md | 6 - docs/api/type-aliases/OpenAICompatConfig.md | 14 - .../type-aliases/OpenAICompatConfigInput.md | 2 - .../type-aliases/OpenAICompatCredentials.md | 8 - .../api/type-aliases/OpenAICompatErrorBody.md | 6 - .../type-aliases/OpenAICompatErrorMessage.md | 2 - .../OpenAICompatImageURLContent.md | 6 - docs/api/type-aliases/OpenAICompatMessage.md | 10 - .../OpenAICompatMessageContent.md | 2 - .../OpenAICompatResponseFormat.md | 2 - .../api/type-aliases/OpenAICompatSSEResult.md | 16 - .../type-aliases/OpenAICompatStreamChunk.md | 6 - .../OpenAICompatStreamChunkChoice.md | 8 - .../type-aliases/OpenAICompatStreamDelta.md | 14 - .../OpenAICompatStreamLifecycleListeners.md | 6 - .../type-aliases/OpenAICompatTextContent.md | 6 - .../type-aliases/OpenAICompatToolCallWire.md | 8 - .../OpenAICompatToolChoiceWire.md | 2 - .../type-aliases/OpenAICompatToolWarning.md | 2 - docs/api/type-aliases/OpenAICompatUsage.md | 12 - .../OpenAICompatUserOrAssistantPart.md | 2 - .../OpenAICompatV3CallToolChoice.md | 2 - .../type-aliases/OpenAICompatV3CallTools.md | 2 - .../api/type-aliases/OpenAICompatV3Content.md | 2 - .../OpenAICompatV3FinishReason.md | 2 - .../type-aliases/OpenAICompatV3StreamPart.md | 2 - docs/api/type-aliases/OpenAICompatV3Usage.md | 2 - .../type-aliases/OpenAICompletionRequest.md | 28 -- .../type-aliases/OpenAICompletionResponse.md | 14 - docs/api/type-aliases/OpenAIContentPart.md | 2 - .../type-aliases/OpenAIContentPartImage.md | 6 - .../api/type-aliases/OpenAIContentPartText.md | 6 - docs/api/type-aliases/OpenAIErrorResponse.md | 4 - docs/api/type-aliases/OpenAIMessage.md | 2 - docs/api/type-aliases/OpenAIRealtimeEvent.md | 6 - docs/api/type-aliases/OpenAISessionCreated.md | 2 - docs/api/type-aliases/OpenAIStreamChunk.md | 14 - docs/api/type-aliases/OpenAISystemMessage.md | 6 - docs/api/type-aliases/OpenAITTSModel.md | 2 - docs/api/type-aliases/OpenAITTSOptions.md | 2 - docs/api/type-aliases/OpenAIToolCall.md | 8 - docs/api/type-aliases/OpenAIToolChoice.md | 2 - docs/api/type-aliases/OpenAIToolDef.md | 6 - docs/api/type-aliases/OpenAIToolMessage.md | 8 - .../api/type-aliases/OpenAITranscriptDelta.md | 2 - docs/api/type-aliases/OpenAIUsage.md | 8 - docs/api/type-aliases/OpenAIUserMessage.md | 6 - docs/api/type-aliases/OpenAIVoice.md | 2 - .../type-aliases/OpenAPIGeneratorConfig.md | 16 - docs/api/type-aliases/OpenAPISpec.md | 16 - docs/api/type-aliases/OpenRouterModelInfo.md | 14 - .../type-aliases/OpenRouterModelsResponse.md | 4 - .../type-aliases/OpenRouterProviderCache.md | 10 - docs/api/type-aliases/OpenTelemetryConfig.md | 10 - docs/api/type-aliases/OperationResult.md | 2 - .../type-aliases/OptimizeParametersParams.md | 14 - docs/api/type-aliases/OptionSchema.md | 8 - docs/api/type-aliases/Optional.md | 2 - docs/api/type-aliases/OptionalJsonRecord.md | 2 - docs/api/type-aliases/OptionalRecordArray.md | 2 - .../type-aliases/OptionalStandardRecord.md | 2 - docs/api/type-aliases/OptionalStringArray.md | 2 - docs/api/type-aliases/OptionalStringRecord.md | 2 - .../type-aliases/OptionalValidationSchema.md | 2 - .../OptionsWithLifecycleMiddleware.md | 4 - docs/api/type-aliases/OrchestrationMode.md | 2 - docs/api/type-aliases/OrchestrationResult.md | 6 - docs/api/type-aliases/OrchestrationState.md | 10 - docs/api/type-aliases/OrchestratorConfig.md | 16 - docs/api/type-aliases/OtelExporterConfig.md | 2 - docs/api/type-aliases/OtelProtocol.md | 2 - docs/api/type-aliases/OtelSpan.md | 22 -- docs/api/type-aliases/OutgoingResponse.md | 6 - docs/api/type-aliases/OutlineSection.md | 14 - docs/api/type-aliases/OutputFormatOption.md | 2 - docs/api/type-aliases/OutputOptions.md | 10 - docs/api/type-aliases/PCMEncoding.md | 2 - docs/api/type-aliases/PDFAPIType.md | 2 - docs/api/type-aliases/PDFContent.md | 8 - .../type-aliases/PDFImageConversionOptions.md | 14 - .../PDFImageConversionProgress.md | 8 - .../type-aliases/PDFImageConversionResult.md | 12 - docs/api/type-aliases/PDFImagePage.md | 10 - docs/api/type-aliases/PDFLoaderOptions.md | 2 - docs/api/type-aliases/PDFProcessorOptions.md | 14 - docs/api/type-aliases/PDFProviderConfig.md | 12 - docs/api/type-aliases/PDFRenderDocument.md | 8 - docs/api/type-aliases/PKCEChallenge.md | 8 - docs/api/type-aliases/PKCEParams.md | 8 - docs/api/type-aliases/PPTGenerationContext.md | 26 -- docs/api/type-aliases/PPTGenerationResult.md | 14 - docs/api/type-aliases/PPTModelInfo.md | 6 - docs/api/type-aliases/PPTOutputOptions.md | 20 -- docs/api/type-aliases/PaginatedResponse.md | 2 - .../type-aliases/ParallelDetectionConfig.md | 8 - docs/api/type-aliases/ParsedClaudeError.md | 8 - docs/api/type-aliases/ParsedClaudeRequest.md | 34 -- docs/api/type-aliases/ParsedGeminiRequest.md | 24 -- docs/api/type-aliases/ParsedJudgeResponse.md | 14 - docs/api/type-aliases/ParsedOpenAIRequest.md | 30 -- docs/api/type-aliases/ParsedProxyConfig.md | 12 - docs/api/type-aliases/ParsedSSEBuffer.md | 6 - docs/api/type-aliases/ParsedSSEEvent.md | 6 - docs/api/type-aliases/PathSandboxResult.md | 2 - docs/api/type-aliases/PendingRequest.md | 16 - docs/api/type-aliases/PendingToolExecution.md | 8 - docs/api/type-aliases/PerformanceConfig.md | 12 - docs/api/type-aliases/PerformanceMetrics.md | 14 - docs/api/type-aliases/PerformancePriority.md | 2 - docs/api/type-aliases/PerformanceProfile.md | 2 - .../api/type-aliases/PerformanceThresholds.md | 10 - docs/api/type-aliases/PermissionDefinition.md | 10 - .../type-aliases/PersistedAccountCooldown.md | 8 - .../PersistedProxyStatsSnapshot.md | 10 - .../PersistedProxyTerminalErrorSnapshot.md | 10 - docs/api/type-aliases/PgClientLike.md | 4 - docs/api/type-aliases/PgQueryResult.md | 4 - docs/api/type-aliases/PgVectorStoreOptions.md | 4 - docs/api/type-aliases/PgVectorStoreRow.md | 10 - docs/api/type-aliases/PhaseToolPolicy.md | 6 - docs/api/type-aliases/PiiDetectionConfig.md | 14 - docs/api/type-aliases/PiiDetectionResult.md | 10 - docs/api/type-aliases/PiiType.md | 2 - docs/api/type-aliases/PineconeIndexLike.md | 10 - docs/api/type-aliases/PineconeMatch.md | 10 - docs/api/type-aliases/PineconeQueryRequest.md | 12 - .../api/type-aliases/PineconeQueryResponse.md | 4 - docs/api/type-aliases/PineconeUpsertRecord.md | 8 - docs/api/type-aliases/PinnedAddress.md | 6 - docs/api/type-aliases/PipelineConfig.md | 20 -- .../type-aliases/PipelineExecutionOptions.md | 12 - docs/api/type-aliases/PipelineMetrics.md | 28 -- docs/api/type-aliases/PipelineResult.md | 2 - docs/api/type-aliases/PipelineStats.md | 14 - docs/api/type-aliases/PositiveNumber.md | 2 - .../api/type-aliases/PostHogExporterConfig.md | 2 - .../api/type-aliases/PptxBackgroundOptions.md | 6 - docs/api/type-aliases/PptxChartData.md | 8 - docs/api/type-aliases/PptxChartName.md | 2 - docs/api/type-aliases/PptxChartOptions.md | 40 --- docs/api/type-aliases/PptxImageOptions.md | 26 -- docs/api/type-aliases/PptxPresentation.md | 20 -- docs/api/type-aliases/PptxRichTextProps.md | 6 - docs/api/type-aliases/PptxShapeOptions.md | 20 -- docs/api/type-aliases/PptxSlide.md | 16 - docs/api/type-aliases/PptxTableOptions.md | 34 -- docs/api/type-aliases/PptxTableRow.md | 2 - docs/api/type-aliases/PptxTextOptions.md | 40 --- docs/api/type-aliases/PptxTextProps.md | 6 - docs/api/type-aliases/PptxTextRun.md | 6 - .../type-aliases/PrecallEvaluationConfig.md | 20 -- .../type-aliases/PrecallEvaluationResult.md | 16 - docs/api/type-aliases/PrepareStepFunction.md | 2 - docs/api/type-aliases/PrepareStepResult.md | 16 - .../PreparedAnthropicAccountAttempt.md | 20 -- .../PresentationGenerationOptions.md | 16 - docs/api/type-aliases/PresentationTheme.md | 12 - docs/api/type-aliases/Primitive.md | 2 - docs/api/type-aliases/PrimitiveEndChunk.md | 2 - .../type-aliases/PrimitiveExecutionResult.md | 10 - docs/api/type-aliases/PrimitiveRecord.md | 2 - docs/api/type-aliases/PrimitiveStartChunk.md | 2 - docs/api/type-aliases/ProcessOptions.md | 8 - docs/api/type-aliases/ProcessResult.md | 10 - docs/api/type-aliases/ProcessStep.md | 10 - docs/api/type-aliases/ProcessedArchive.md | 2 - docs/api/type-aliases/ProcessedAudio.md | 2 - docs/api/type-aliases/ProcessedConfig.md | 2 - docs/api/type-aliases/ProcessedExcel.md | 2 - docs/api/type-aliases/ProcessedFileBase.md | 10 - docs/api/type-aliases/ProcessedFileInfo.md | 12 - docs/api/type-aliases/ProcessedHtml.md | 2 - docs/api/type-aliases/ProcessedImage.md | 10 - docs/api/type-aliases/ProcessedJson.md | 2 - docs/api/type-aliases/ProcessedMarkdown.md | 2 - .../api/type-aliases/ProcessedOpenDocument.md | 2 - .../type-aliases/ProcessedProxyBodyCapture.md | 18 - docs/api/type-aliases/ProcessedRtf.md | 2 - docs/api/type-aliases/ProcessedSourceCode.md | 2 - docs/api/type-aliases/ProcessedSvg.md | 2 - docs/api/type-aliases/ProcessedText.md | 2 - docs/api/type-aliases/ProcessedVideo.md | 2 - docs/api/type-aliases/ProcessedWord.md | 2 - docs/api/type-aliases/ProcessedXml.md | 2 - docs/api/type-aliases/ProcessedYaml.md | 2 - .../ProcessorErrorMessageTemplate.md | 10 - .../ProcessorFileProcessingResult.md | 8 - docs/api/type-aliases/ProcessorInfo.md | 12 - docs/api/type-aliases/ProcessorMatch.md | 10 - .../type-aliases/ProcessorOperationResult.md | 8 - .../type-aliases/ProcessorPipelineConfig.md | 14 - docs/api/type-aliases/ProcessorPriorityKey.md | 2 - .../type-aliases/ProcessorPriorityValue.md | 2 - .../api/type-aliases/ProcessorRegistration.md | 14 - docs/api/type-aliases/ProcessorRetryConfig.md | 10 - docs/api/type-aliases/ProgressCallback.md | 2 - docs/api/type-aliases/PromptGenerator.md | 2 - docs/api/type-aliases/PromptMessage.md | 6 - .../type-aliases/PromptRedactionOptions.md | 8 - docs/api/type-aliases/PromptResult.md | 6 - docs/api/type-aliases/PromptTier.md | 2 - docs/api/type-aliases/PropertySchema.md | 24 -- docs/api/type-aliases/ProtocolState.md | 2 - docs/api/type-aliases/ProviderAttempt.md | 12 - .../ProviderAvailabilityStatus.md | 10 - docs/api/type-aliases/ProviderCapabilities.md | 18 - docs/api/type-aliases/ProviderCapability.md | 2 - docs/api/type-aliases/ProviderCatalogJson.md | 34 -- .../api/type-aliases/ProviderConfigOptions.md | 16 - .../api/type-aliases/ProviderConfiguration.md | 16 - docs/api/type-aliases/ProviderConstructor.md | 2 - docs/api/type-aliases/ProviderCostStats.md | 14 - .../api/type-aliases/ProviderCreationError.md | 10 - docs/api/type-aliases/ProviderDescriptor.md | 36 -- docs/api/type-aliases/ProviderDetails.md | 6 - docs/api/type-aliases/ProviderErrorClass.md | 2 - docs/api/type-aliases/ProviderErrorContext.md | 16 - docs/api/type-aliases/ProviderErrorLike.md | 2 - docs/api/type-aliases/ProviderErrorRule.md | 8 - .../type-aliases/ProviderFallbackCallback.md | 2 - .../ProviderHealthCheckOptions.md | 12 - docs/api/type-aliases/ProviderHealthStatus.md | 2 - .../ProviderHealthStatusOptions.md | 22 -- docs/api/type-aliases/ProviderImageFormat.md | 12 - docs/api/type-aliases/ProviderInfo.md | 30 -- docs/api/type-aliases/ProviderKeyMap.md | 2 - docs/api/type-aliases/ProviderKeyMapping.md | 2 - docs/api/type-aliases/ProviderMetadata.md | 12 - docs/api/type-aliases/ProviderMetricItem.md | 24 -- .../type-aliases/ProviderMetricsOptions.md | 8 - .../api/type-aliases/ProviderMetricsResult.md | 24 -- docs/api/type-aliases/ProviderModelConfig.md | 12 - .../api/type-aliases/ProviderModelManifest.md | 8 - .../ProviderModelManifestEntry.md | 26 -- .../type-aliases/ProviderMultimodalPayload.md | 10 - docs/api/type-aliases/ProviderName.md | 2 - .../type-aliases/ProviderOperationConfig.md | 2 - docs/api/type-aliases/ProviderPairResult.md | 6 - .../ProviderPerformanceAnalytics.md | 14 - .../type-aliases/ProviderPerformanceData.md | 10 - .../ProviderPerformanceMetrics.md | 14 - docs/api/type-aliases/ProviderRegistration.md | 10 - .../type-aliases/ProviderRegistryOptions.md | 4 - .../api/type-aliases/ProviderRuntimeConfig.md | 24 -- .../api/type-aliases/ProviderScoringResult.md | 8 - .../type-aliases/ProviderSelectionCriteria.md | 14 - docs/api/type-aliases/ProviderSetupArgv.md | 6 - docs/api/type-aliases/ProviderSetupConfig.md | 10 - docs/api/type-aliases/ProviderSetupOptions.md | 6 - docs/api/type-aliases/ProviderStatus.md | 20 -- docs/api/type-aliases/ProviderStatusArgs.md | 2 - docs/api/type-aliases/ProviderStreamChunk.md | 2 - docs/api/type-aliases/ProviderTokenStats.md | 14 - docs/api/type-aliases/ProxyAccount.md | 24 -- docs/api/type-aliases/ProxyAccountConfig.md | 18 - .../ProxyAccountDirectoryOverride.md | 8 - .../ProxyAccountPrecedenceReason.md | 2 - docs/api/type-aliases/ProxyAccountProvider.md | 2 - .../type-aliases/ProxyAccountRankingPolicy.md | 2 - .../ProxyAccountRoutingAffinityEvidence.md | 10 - .../ProxyAccountRoutingAffinitySkipReason.md | 2 - .../ProxyAccountRoutingCandidate.md | 80 ----- .../ProxyAccountRoutingDecision.md | 36 -- .../type-aliases/ProxyAccountRoutingMode.md | 2 - .../type-aliases/ProxyAccountRoutingReason.md | 2 - .../ProxyAccountRoutingSpillEvidence.md | 8 - .../ProxyAccountRoutingStrategy.md | 2 - .../type-aliases/ProxyAccountSortMetrics.md | 78 ----- .../api/type-aliases/ProxyAccountSpillMove.md | 2 - docs/api/type-aliases/ProxyAccountType.md | 2 - .../api/type-aliases/ProxyActivitySnapshot.md | 6 - .../ProxyAffinityPrecedenceSkipReason.md | 2 - docs/api/type-aliases/ProxyAnalysisAccount.md | 20 -- .../ProxyAnalysisAttemptRecord.md | 10 - .../ProxyAnalysisFinalRequestRecord.md | 44 --- docs/api/type-aliases/ProxyAnalysisOptions.md | 10 - docs/api/type-aliases/ProxyAnalysisReport.md | 34 -- .../ProxyAnalysisRoutingRecord.md | 14 - .../type-aliases/ProxyAnalysisStreamName.md | 2 - docs/api/type-aliases/ProxyAnalyzeArgs.md | 12 - .../type-aliases/ProxyBodyCaptureAdmission.md | 16 - .../api/type-aliases/ProxyBodyCaptureEntry.md | 42 --- .../api/type-aliases/ProxyBodyCaptureInput.md | 26 -- .../type-aliases/ProxyBodyCaptureLogger.md | 2 - .../ProxyBodyCapturePolicyOptions.md | 8 - .../ProxyBodyCapturePolicySnapshot.md | 26 -- .../ProxyBodyCapturePublication.md | 6 - .../type-aliases/ProxyBodyCaptureReference.md | 12 - .../ProxyBodyCaptureWorkerSnapshot.md | 2 - .../api/type-aliases/ProxyBodyChunkEmitter.md | 2 - .../ProxyBodyDeduplicationEntry.md | 8 - .../type-aliases/ProxyBodyDeliveryResult.md | 24 -- .../ProxyBodyPublicationProgress.md | 16 - .../ProxyCancellableTransformer.md | 2 - docs/api/type-aliases/ProxyClosableServer.md | 4 - docs/api/type-aliases/ProxyConfig.md | 16 - docs/api/type-aliases/ProxyConfigFile.md | 14 - docs/api/type-aliases/ProxyContextEvidence.md | 36 -- docs/api/type-aliases/ProxyContextPolicy.md | 12 - docs/api/type-aliases/ProxyEnvLoadResult.md | 8 - docs/api/type-aliases/ProxyEnvOptions.md | 8 - docs/api/type-aliases/ProxyEnvResolution.md | 8 - docs/api/type-aliases/ProxyEnvSource.md | 2 - .../type-aliases/ProxyEnvironmentSnapshot.md | 12 - docs/api/type-aliases/ProxyExposeArgs.md | 10 - docs/api/type-aliases/ProxyFormat.md | 2 - docs/api/type-aliases/ProxyGateProbe.md | 8 - docs/api/type-aliases/ProxyGeminiContent.md | 6 - docs/api/type-aliases/ProxyGeminiPart.md | 6 - docs/api/type-aliases/ProxyGuardArgs.md | 18 - docs/api/type-aliases/ProxyHealthProbe.md | 12 - docs/api/type-aliases/ProxyHealthResponse.md | 26 -- docs/api/type-aliases/ProxyHistoryEstimate.md | 2 - docs/api/type-aliases/ProxyHistoryField.md | 2 - .../ProxyHistoryTruncationResult.md | 10 - docs/api/type-aliases/ProxyLatencySummary.md | 12 - docs/api/type-aliases/ProxyLedgerEntry.md | 22 -- .../api/type-aliases/ProxyLedgerFileCursor.md | 8 - .../type-aliases/ProxyLifecycleEventInput.md | 58 ---- .../type-aliases/ProxyLifecycleEventName.md | 2 - .../ProxyLifecycleLoggerOptions.md | 16 - .../ProxyLifecycleLoggerSnapshot.md | 44 --- .../ProxyLifecycleTerminalOutcome.md | 2 - .../type-aliases/ProxyLimitsAccountResult.md | 20 -- .../ProxyLimitsRefreshResponse.md | 10 - .../type-aliases/ProxyLogCleanupScheduler.md | 6 - .../type-aliases/ProxyLogCleanupWorkerData.md | 8 - docs/api/type-aliases/ProxyLogTraceContext.md | 8 - docs/api/type-aliases/ProxyMetrics.md | 34 -- docs/api/type-aliases/ProxyMode.md | 2 - .../type-aliases/ProxyModelRouterConfig.md | 2 - .../ProxyNetworkTransportScope.md | 2 - .../api/type-aliases/ProxyNeurolinkRuntime.md | 6 - .../type-aliases/ProxyOtelExportFailure.md | 12 - .../api/type-aliases/ProxyOtlpLogTransport.md | 2 - docs/api/type-aliases/ProxyOveragePolicy.md | 2 - .../api/type-aliases/ProxyPackageSelection.md | 8 - .../ProxyPackageSelectionState.md | 8 - .../type-aliases/ProxyPassthroughAccount.md | 16 - docs/api/type-aliases/ProxyPaths.md | 20 -- docs/api/type-aliases/ProxyPeer.md | 36 -- docs/api/type-aliases/ProxyPeerArgs.md | 32 -- docs/api/type-aliases/ProxyPeerAttempt.md | 2 - docs/api/type-aliases/ProxyPeerAuthOutcome.md | 2 - .../type-aliases/ProxyPeerCooldownReason.md | 2 - docs/api/type-aliases/ProxyPeerFile.md | 6 - docs/api/type-aliases/ProxyPeerInput.md | 14 - .../type-aliases/ProxyPeerLimitsSnapshot.md | 18 - docs/api/type-aliases/ProxyPeerObservation.md | 10 - .../type-aliases/ProxyPeerPendingProvision.md | 8 - docs/api/type-aliases/ProxyPoolHeadroom.md | 8 - docs/api/type-aliases/ProxyPreparedContext.md | 12 - .../ProxyProcessTelemetrySnapshot.md | 18 - .../ProxyProviderTransportPermit.md | 2 - .../ProxyProviderTransportProbeOutcome.md | 2 - .../type-aliases/ProxyQuotaCooldownUpdate.md | 2 - docs/api/type-aliases/ProxyQuotaFreshness.md | 2 - .../type-aliases/ProxyQuotaHeaderContext.md | 20 -- .../type-aliases/ProxyQuotaRefreshMetrics.md | 14 - .../type-aliases/ProxyQuotaRefreshReason.md | 2 - .../ProxyQuotaRefreshRunResult.md | 2 - .../ProxyQuotaRefreshRuntimeState.md | 18 - .../type-aliases/ProxyQuotaSaturationKind.md | 2 - docs/api/type-aliases/ProxyQuotaSource.md | 2 - docs/api/type-aliases/ProxyReadinessState.md | 12 - docs/api/type-aliases/ProxyReplayArgs.md | 28 -- docs/api/type-aliases/ProxyReplayBundle.md | 20 -- docs/api/type-aliases/ProxyReplayCapture.md | 38 --- .../api/type-aliases/ProxyReplayComparison.md | 20 -- .../api/type-aliases/ProxyReplayJsonRecord.md | 2 - docs/api/type-aliases/ProxyRequestContext.md | 28 -- .../ProxyRequestLogSinkSnapshot.md | 18 - .../ProxyRequestLoggerSnapshot.md | 18 - .../ProxyRequestRoutingSnapshot.md | 32 -- docs/api/type-aliases/ProxyResidentGrant.md | 22 -- .../type-aliases/ProxyResidentGrantFile.md | 6 - .../ProxyResponseTerminalOutcome.md | 2 - .../ProxyResponseTrackingObserver.md | 6 - docs/api/type-aliases/ProxyRestartArgs.md | 8 - .../ProxyRestartControlIdentity.md | 8 - .../ProxyRestartControlOptions.md | 16 - docs/api/type-aliases/ProxyRestartResult.md | 22 -- .../ProxyRestartSupervisorState.md | 2 - docs/api/type-aliases/ProxyRollingState.md | 20 -- docs/api/type-aliases/ProxyRoutingConfig.md | 36 -- .../ProxyRoutingPolicySnapshot.md | 12 - docs/api/type-aliases/ProxyRuntimeActivity.md | 14 - .../ProxyRuntimeConfigListener.md | 2 - .../ProxyRuntimeConfigProvider.md | 2 - .../ProxyRuntimeConfigReloadListener.md | 2 - .../ProxyRuntimeConfigReloadResult.md | 12 - .../ProxyRuntimeConfigReloadSource.md | 2 - .../ProxyRuntimeConfigSnapshot.md | 2 - .../type-aliases/ProxyRuntimeConfigStatus.md | 24 -- .../ProxyRuntimeConfigStoreOptions.md | 20 -- docs/api/type-aliases/ProxyRuntimeSample.md | 18 - .../ProxyServiceInstallSettings.md | 12 - .../ProxyServingWorkerIdentity.md | 8 - .../ProxyShareAccountExclusion.md | 6 - .../ProxyShareAccountFilterResult.md | 6 - .../api/type-aliases/ProxyShareAccountView.md | 16 - docs/api/type-aliases/ProxyShareAdmission.md | 2 - .../type-aliases/ProxyShareAdmissionInput.md | 12 - docs/api/type-aliases/ProxyShareArgs.md | 64 ---- docs/api/type-aliases/ProxyShareAuditFile.md | 6 - .../ProxyShareAuditObservation.md | 12 - .../api/type-aliases/ProxyShareAuditRecord.md | 18 - docs/api/type-aliases/ProxyShareCliAction.md | 2 - .../type-aliases/ProxyShareDriftVerdict.md | 2 - .../api/type-aliases/ProxyShareEntitlement.md | 8 - .../api/type-aliases/ProxyShareGateOutcome.md | 2 - docs/api/type-aliases/ProxyShareGates.md | 20 -- docs/api/type-aliases/ProxyShareGrant.md | 38 --- .../type-aliases/ProxyShareGrantCounters.md | 6 - docs/api/type-aliases/ProxyShareGrantFile.md | 10 - docs/api/type-aliases/ProxyShareGrantInput.md | 12 - docs/api/type-aliases/ProxyShareGrantPatch.md | 10 - docs/api/type-aliases/ProxyShareGrantState.md | 2 - .../ProxyShareGrantUsageSummary.md | 12 - .../ProxyShareHeartbeatRenewal.md | 2 - .../ProxyShareHeartbeatRequest.md | 10 - .../ProxyShareHeartbeatResponse.md | 2 - .../type-aliases/ProxyShareHeartbeatStop.md | 2 - docs/api/type-aliases/ProxyShareHold.md | 10 - .../api/type-aliases/ProxyShareIssuedGrant.md | 6 - docs/api/type-aliases/ProxyShareLease.md | 22 -- .../type-aliases/ProxyShareLeaseRefusal.md | 2 - .../type-aliases/ProxyShareLeaseVerdict.md | 2 - .../type-aliases/ProxyShareLedgerBucket.md | 20 -- docs/api/type-aliases/ProxyShareLedgerFile.md | 6 - docs/api/type-aliases/ProxyShareLedgerMode.md | 2 - docs/api/type-aliases/ProxyShareLevel.md | 2 - .../type-aliases/ProxyShareListenerHandle.md | 6 - .../type-aliases/ProxyShareNettingClaim.md | 8 - .../type-aliases/ProxyShareNettingResult.md | 8 - docs/api/type-aliases/ProxyShareNote.md | 18 - docs/api/type-aliases/ProxyShareNoteFile.md | 6 - docs/api/type-aliases/ProxyShareNoteRecord.md | 16 - docs/api/type-aliases/ProxyShareNoteStatus.md | 2 - docs/api/type-aliases/ProxySharePoolUsage.md | 6 - docs/api/type-aliases/ProxySharePresetName.md | 2 - .../type-aliases/ProxyShareProvisionClaim.md | 14 - .../type-aliases/ProxyShareProvisionFile.md | 6 - .../ProxyShareProvisionOutcome.md | 2 - .../ProxyShareProvisionRequest.md | 26 -- .../type-aliases/ProxyShareProvisionStatus.md | 2 - .../ProxyShareProvisioningBundle.md | 18 - docs/api/type-aliases/ProxyShareRate.md | 6 - docs/api/type-aliases/ProxyShareReceipt.md | 20 -- .../api/type-aliases/ProxyShareReceiptFile.md | 12 - .../type-aliases/ProxyShareRefillPeriod.md | 2 - .../type-aliases/ProxyShareRefusalReason.md | 2 - .../type-aliases/ProxyShareRefusalResponse.md | 8 - .../ProxyShareRefusedAdmission.md | 2 - .../type-aliases/ProxyShareRequestContext.md | 16 - .../type-aliases/ProxyShareRuntimeCounters.md | 6 - docs/api/type-aliases/ProxyShareSchedule.md | 6 - docs/api/type-aliases/ProxyShareSettlement.md | 12 - .../type-aliases/ProxyShareSpilloverGate.md | 8 - docs/api/type-aliases/ProxyShareStatement.md | 16 - docs/api/type-aliases/ProxyShareUsage.md | 10 - .../ProxyShareWindowObservation.md | 18 - .../api/type-aliases/ProxyShareWindowSlice.md | 6 - docs/api/type-aliases/ProxySpinner.md | 2 - .../type-aliases/ProxyStagedInstallOptions.md | 20 -- docs/api/type-aliases/ProxyStartApp.md | 6 - docs/api/type-aliases/ProxyStartArgs.md | 24 -- docs/api/type-aliases/ProxyStartStrategy.md | 2 - docs/api/type-aliases/ProxyState.md | 46 --- docs/api/type-aliases/ProxyStats.md | 22 -- docs/api/type-aliases/ProxyStatsLockOwner.md | 8 - .../ProxyStatsPersistenceStatus.md | 38 --- docs/api/type-aliases/ProxyStatusArgs.md | 6 - .../type-aliases/ProxyStatusPrimaryAccount.md | 10 - docs/api/type-aliases/ProxySupervisorState.md | 16 - .../type-aliases/ProxySupervisorTelemetry.md | 2 - docs/api/type-aliases/ProxyTelemetryAction.md | 2 - docs/api/type-aliases/ProxyTelemetryArgs.md | 24 -- .../api/type-aliases/ProxyTelemetryBackend.md | 14 - docs/api/type-aliases/ProxyTelemetryCheck.md | 8 - .../ProxyTelemetryDoctorOptions.md | 20 -- .../ProxyTelemetryFieldCoverage.md | 12 - .../ProxyTelemetryNativeConfig.md | 4 - .../type-aliases/ProxyTelemetryQueryBudget.md | 6 - .../ProxyTelemetryQueryOptions.md | 14 - .../ProxyTelemetryStoredRecord.md | 2 - .../ProxyTerminalErrorCategory.md | 2 - .../type-aliases/ProxyTerminalErrorDetails.md | 14 - .../type-aliases/ProxyTerminalErrorJournal.md | 10 - .../type-aliases/ProxyTerminalErrorSummary.md | 26 -- .../type-aliases/ProxyTokenBudgetBucket.md | 12 - .../api/type-aliases/ProxyTokenBudgetLease.md | 10 - .../type-aliases/ProxyTokenBudgetPolicy.md | 10 - .../type-aliases/ProxyTokenBudgetRecord.md | 12 - .../ProxyTokenBudgetReservation.md | 16 - .../ProxyTokenBudgetRpcPending.md | 8 - .../ProxyTokenBudgetRpcRequest.md | 18 - .../ProxyTokenBudgetRpcResponse.md | 16 - .../type-aliases/ProxyTokenBudgetSnapshot.md | 20 -- .../type-aliases/ProxyTranslationAttempt.md | 10 - docs/api/type-aliases/ProxyTranslationPlan.md | 10 - docs/api/type-aliases/ProxyTransportScope.md | 2 - .../type-aliases/ProxyUpdateWindowOptions.md | 26 -- .../type-aliases/ProxyUpdateWindowResult.md | 8 - .../ProxyUsageAttributionOptions.md | 4 - .../type-aliases/ProxyUsageStatsSnapshot.md | 10 - .../ProxyUsageStatsStoreOptions.md | 14 - .../type-aliases/ProxyWorkerControlMessage.md | 2 - .../api/type-aliases/ProxyWorkerIpcMessage.md | 2 - .../type-aliases/ProxyWorkerSocketMessage.md | 8 - .../type-aliases/ProxyWorkerStatusMessage.md | 2 - docs/api/type-aliases/PruneConfig.md | 10 - docs/api/type-aliases/PruneResult.md | 8 - docs/api/type-aliases/QualityErrorDetails.md | 10 - docs/api/type-aliases/QueryIntentAnalysis.md | 8 - docs/api/type-aliases/QueryOptions.md | 22 -- .../type-aliases/QuestionExtractorConfig.md | 2 - .../type-aliases/QueuedAccountAdmission.md | 8 - .../type-aliases/QueuedProxyLifecycleEvent.md | 14 - docs/api/type-aliases/QuietStatus.md | 8 - docs/api/type-aliases/QuotaCheckResult.md | 12 - .../type-aliases/RAGCircuitBreakerConfig.md | 14 - .../type-aliases/RAGCircuitBreakerEvents.md | 14 - .../type-aliases/RAGCircuitBreakerStats.md | 24 -- docs/api/type-aliases/RAGCommandArgs.md | 28 -- docs/api/type-aliases/RAGConfig.md | 20 -- docs/api/type-aliases/RAGErrorCode.md | 2 - docs/api/type-aliases/RAGPipelineConfig.md | 36 -- docs/api/type-aliases/RAGPreparedTool.md | 10 - docs/api/type-aliases/RAGResponse.md | 10 - docs/api/type-aliases/RAGRetryConfig.md | 18 - docs/api/type-aliases/RBACConfig.md | 16 - docs/api/type-aliases/RBACMiddlewareConfig.md | 18 - docs/api/type-aliases/RagChunkArgs.md | 2 - docs/api/type-aliases/RagIndexArgs.md | 2 - docs/api/type-aliases/RagQueryArgs.md | 2 - docs/api/type-aliases/RankedNode.md | 10 - docs/api/type-aliases/RateLimitConfig.md | 14 - .../type-aliases/RateLimitCoolingReason.md | 2 - docs/api/type-aliases/RateLimitEntry.md | 6 - .../type-aliases/RateLimitMiddlewareConfig.md | 16 - .../type-aliases/RateLimitMiddlewareResult.md | 8 - docs/api/type-aliases/RateLimitResult.md | 12 - docs/api/type-aliases/RateLimitStorage.md | 14 - docs/api/type-aliases/RateLimitStore.md | 10 - docs/api/type-aliases/RateLimiterConfig.md | 12 - docs/api/type-aliases/RateLimiterOptions.md | 10 - .../type-aliases/RateLimiterPendingRequest.md | 10 - docs/api/type-aliases/RateLimiterStats.md | 12 - docs/api/type-aliases/RawFileInput.md | 10 - docs/api/type-aliases/RawGroundingMetadata.md | 10 - docs/api/type-aliases/RawStreamCapture.md | 8 - .../type-aliases/RawStreamCaptureResult.md | 6 - docs/api/type-aliases/RawUsageObject.md | 42 --- docs/api/type-aliases/ReadyResponse.md | 8 - docs/api/type-aliases/RealtimeAudioChunk.md | 14 - docs/api/type-aliases/RealtimeConfig.md | 38 --- .../RealtimeConfirmationRequester.md | 2 - .../type-aliases/RealtimeEventBridgeHandle.md | 8 - .../type-aliases/RealtimeEventBridgeParams.md | 12 - .../api/type-aliases/RealtimeEventHandlers.md | 18 - .../type-aliases/RealtimeEventPublisher.md | 2 - docs/api/type-aliases/RealtimeHandler.md | 28 -- docs/api/type-aliases/RealtimeMessage.md | 20 -- docs/api/type-aliases/RealtimeMessageType.md | 2 - docs/api/type-aliases/RealtimeSession.md | 20 -- docs/api/type-aliases/RealtimeSessionState.md | 2 - docs/api/type-aliases/RealtimeTool.md | 8 - .../type-aliases/RealtimeVoiceAgentConfig.md | 24 -- docs/api/type-aliases/RealtimeVoiceConfig.md | 28 -- .../type-aliases/RealtimeVoiceLogContext.md | 4 - .../api/type-aliases/RealtimeVoiceLogEntry.md | 10 - .../api/type-aliases/RealtimeVoiceProvider.md | 20 -- .../api/type-aliases/RecommendationContext.md | 16 - docs/api/type-aliases/RecordArray.md | 2 - docs/api/type-aliases/RecraftImageResponse.md | 6 - .../type-aliases/RecursiveChunkerConfig.md | 2 - docs/api/type-aliases/RedactionConfig.md | 14 - docs/api/type-aliases/RedisArtifactRecord.md | 2 - docs/api/type-aliases/RedisClient.md | 2 - .../type-aliases/RedisConversationObject.md | 2 - docs/api/type-aliases/RedisStorageConfig.md | 22 -- docs/api/type-aliases/RefactoringResult.md | 10 - docs/api/type-aliases/RefreshResult.md | 8 - docs/api/type-aliases/RefreshableAccount.md | 10 - docs/api/type-aliases/RegisterOptions.md | 6 - docs/api/type-aliases/RegisterResult.md | 10 - docs/api/type-aliases/RegisteredPrompt.md | 2 - docs/api/type-aliases/RegisteredResource.md | 2 - docs/api/type-aliases/RegistryConfig.md | 14 - docs/api/type-aliases/RegistryEntry.md | 10 - docs/api/type-aliases/RegistryOptions.md | 6 - .../api/type-aliases/RegistryProcessResult.md | 8 - .../api/type-aliases/RegistrySearchOptions.md | 20 -- docs/api/type-aliases/RegistrySearchResult.md | 12 - docs/api/type-aliases/RegistrySourceType.md | 2 - docs/api/type-aliases/RegistryStats.md | 10 - .../type-aliases/RenderContentSlideOptions.md | 16 - docs/api/type-aliases/RepairResult.md | 10 - docs/api/type-aliases/RepairToolBatch.md | 8 - docs/api/type-aliases/ReplicateAuth.md | 6 - .../ReplicateCreatePredictionInput.md | 10 - docs/api/type-aliases/ReplicatePollOptions.md | 8 - docs/api/type-aliases/ReplicatePrediction.md | 26 -- .../type-aliases/ReplicatePredictionStatus.md | 2 - docs/api/type-aliases/ReportConfig.md | 10 - docs/api/type-aliases/ReportData.md | 10 - docs/api/type-aliases/ReportFormat.md | 2 - .../type-aliases/RequestAttemptLogEntry.md | 86 ----- docs/api/type-aliases/RequestKind.md | 2 - docs/api/type-aliases/RequestKindInput.md | 6 - docs/api/type-aliases/RequestLogEntry.md | 106 ------ docs/api/type-aliases/RequestRouter.md | 2 - .../api/type-aliases/RequestRouterDecision.md | 10 - .../type-aliases/RequiredBodyParserConfig.md | 10 - docs/api/type-aliases/RequiredCORSConfig.md | 14 - .../api/type-aliases/RequiredLoggingConfig.md | 10 - .../type-aliases/RequiredRateLimitConfig.md | 14 - .../type-aliases/RequiredRedactionConfig.md | 14 - .../RequiredServerAdapterConfig.md | 28 -- .../type-aliases/RequiredShutdownConfig.md | 8 - docs/api/type-aliases/Requirement.md | 8 - docs/api/type-aliases/RerankResult.md | 8 - docs/api/type-aliases/Reranker.md | 6 - docs/api/type-aliases/RerankerConfig.md | 14 - docs/api/type-aliases/RerankerMetadata.md | 16 - docs/api/type-aliases/RerankerOptions.md | 8 - docs/api/type-aliases/RerankerType.md | 2 - docs/api/type-aliases/ResearchConfig.md | 34 -- docs/api/type-aliases/ResearchState.md | 28 -- docs/api/type-aliases/ResearchToolsDeps.md | 12 - docs/api/type-aliases/ResearchWorkerConfig.md | 2 - docs/api/type-aliases/ResolutionOptions.md | 14 - docs/api/type-aliases/ResolutionResult.md | 10 - .../ResolveGlobalInstallerOptions.md | 10 - docs/api/type-aliases/ResolvedConfig.md | 2 - docs/api/type-aliases/ResolvedToolPolicy.md | 14 - docs/api/type-aliases/ResourceContent.md | 10 - docs/api/type-aliases/ResourceReader.md | 2 - .../ResourceSubscriptionCallback.md | 2 - docs/api/type-aliases/ResponseCacheEntry.md | 6 - docs/api/type-aliases/ResponseInfoContext.md | 10 - docs/api/type-aliases/ResponseMetadata.md | 10 - .../type-aliases/ResponseValidationConfig.md | 22 -- .../type-aliases/ResponseValidationResult.md | 12 - .../type-aliases/RestorationToolContext.md | 2 - docs/api/type-aliases/Result.md | 8 - docs/api/type-aliases/RetryConfig.md | 14 - docs/api/type-aliases/RetryContext.md | 12 - docs/api/type-aliases/RetryDecision.md | 8 - .../type-aliases/RetryInterceptorOptions.md | 2 - docs/api/type-aliases/RetryOptions.md | 14 - docs/api/type-aliases/RetryPolicy.md | 10 - docs/api/type-aliases/RetryStrategy.md | 2 - docs/api/type-aliases/ReviewDecision.md | 10 - .../type-aliases/RollingCandidateWorker.md | 2 - docs/api/type-aliases/RollingManagedWorker.md | 14 - docs/api/type-aliases/RollingProxyServer.md | 10 - .../type-aliases/RollingProxyServerOptions.md | 34 -- docs/api/type-aliases/RollingQueuedSocket.md | 2 - .../type-aliases/RollingSocketAdmission.md | 8 - .../RollingWorkerFailureDetails.md | 10 - docs/api/type-aliases/RollingWorkerHandle.md | 16 - .../RollingWorkerSupervisorEvent.md | 24 -- .../RollingWorkerSupervisorOptions.md | 22 -- .../RollingWorkerSupervisorSnapshot.md | 22 -- docs/api/type-aliases/RouteDefinition.md | 26 -- docs/api/type-aliases/RouteDeprecation.md | 12 - docs/api/type-aliases/RouteGroup.md | 12 - docs/api/type-aliases/RouteHandler.md | 2 - docs/api/type-aliases/RouteResult.md | 6 - .../RoutedClaudeRequestRuntimeContext.md | 2 - docs/api/type-aliases/RouterConfig.md | 12 - docs/api/type-aliases/RouterInputContext.md | 12 - docs/api/type-aliases/RoutingContext.md | 10 - docs/api/type-aliases/RoutingDecision.md | 12 - docs/api/type-aliases/RoutingDecisionChunk.md | 2 - docs/api/type-aliases/RoutingPromptOptions.md | 10 - docs/api/type-aliases/RoutingStrategy.md | 2 - docs/api/type-aliases/RuleResult.md | 10 - docs/api/type-aliases/RuleScorer.md | 2 - docs/api/type-aliases/RuleScorerConfig.md | 2 - docs/api/type-aliases/RunPipelineArgs.md | 2 - docs/api/type-aliases/RunWorkflowOptions.md | 16 - docs/api/type-aliases/RuntimeAccountState.md | 16 - docs/api/type-aliases/RuntimeMCPServerInfo.md | 2 - .../type-aliases/RuntimeRequestMetadata.md | 42 --- docs/api/type-aliases/RunwayTaskResponse.md | 10 - docs/api/type-aliases/SDKToolContext.md | 2 - docs/api/type-aliases/SSEConfig.md | 2 - docs/api/type-aliases/SSEConnectionOptions.md | 14 - docs/api/type-aliases/SSEConnectionState.md | 2 - docs/api/type-aliases/SSEContentBlock.md | 16 - docs/api/type-aliases/SSEContentBlockDelta.md | 8 - .../type-aliases/SSEContentBlockDescriptor.md | 2 - docs/api/type-aliases/SSEContentBlockStart.md | 8 - docs/api/type-aliases/SSEContentBlockStop.md | 6 - docs/api/type-aliases/SSEDeltaDescriptor.md | 2 - docs/api/type-aliases/SSEEvent.md | 2 - docs/api/type-aliases/SSEEventHandlers.md | 14 - docs/api/type-aliases/SSEEventOptions.md | 10 - .../api/type-aliases/SSEInterceptorOptions.md | 4 - docs/api/type-aliases/SSEInterceptorResult.md | 6 - docs/api/type-aliases/SSEMessageDelta.md | 8 - docs/api/type-aliases/SSEMessageStart.md | 6 - docs/api/type-aliases/SSEMessageStop.md | 4 - docs/api/type-aliases/SSEPing.md | 4 - docs/api/type-aliases/SSERequestOptions.md | 8 - docs/api/type-aliases/SSEState.md | 2 - docs/api/type-aliases/SSETelemetry.md | 36 -- docs/api/type-aliases/SSEWriteOptions.md | 10 - docs/api/type-aliases/STTHandler.md | 16 - docs/api/type-aliases/STTLanguage.md | 10 - docs/api/type-aliases/STTOptions.md | 34 -- docs/api/type-aliases/STTResult.md | 18 - docs/api/type-aliases/SafeDownloadOptions.md | 10 - docs/api/type-aliases/SafeParseResult.md | 8 - docs/api/type-aliases/SafetyStatus.md | 2 - .../type-aliases/SageMakerAsLanguageModel.md | 14 - docs/api/type-aliases/SageMakerCommandArgs.md | 2 - docs/api/type-aliases/SageMakerConfig.md | 16 - .../api/type-aliases/SageMakerEndpointInfo.md | 20 -- docs/api/type-aliases/SageMakerErrorCode.md | 2 - docs/api/type-aliases/SageMakerErrorInfo.md | 16 - .../type-aliases/SageMakerGenerateResult.md | 26 -- .../SageMakerGenerationOptions.md | 22 -- .../SageMakerGenerationResponse.md | 16 - docs/api/type-aliases/SageMakerModelConfig.md | 32 -- .../type-aliases/SageMakerOpenAIToolCall.md | 8 - docs/api/type-aliases/SageMakerStreamChunk.md | 18 - .../SageMakerStreamingToolCall.md | 14 - .../SageMakerStreamingToolResult.md | 16 - .../type-aliases/SageMakerStructuredOutput.md | 14 - docs/api/type-aliases/SageMakerToolCall.md | 10 - docs/api/type-aliases/SageMakerToolResult.md | 12 - docs/api/type-aliases/SageMakerUsage.md | 14 - docs/api/type-aliases/SampleDataFormat.md | 2 - docs/api/type-aliases/Sampler.md | 8 - docs/api/type-aliases/SamplerConfig.md | 2 - docs/api/type-aliases/SamplingConfig.md | 8 - docs/api/type-aliases/SamplingContext.md | 10 - docs/api/type-aliases/SamplingDecision.md | 8 - docs/api/type-aliases/SamplingRule.md | 10 - .../SanitizeDisplayNameOptions.md | 6 - .../type-aliases/SanitizeFileNameOptions.md | 10 - .../type-aliases/ScalarRecoveryDecision.md | 2 - docs/api/type-aliases/ScheduledEntry.md | 14 - docs/api/type-aliases/ScheduledTaskType.md | 2 - docs/api/type-aliases/Schema.md | 8 - docs/api/type-aliases/ScoreDistribution.md | 12 - docs/api/type-aliases/ScoreOptions.md | 14 - docs/api/type-aliases/ScoreResult.md | 26 -- docs/api/type-aliases/ScoreScale.md | 8 - docs/api/type-aliases/ScoreStatistics.md | 22 -- docs/api/type-aliases/Scorer.md | 12 - docs/api/type-aliases/ScorerCategory.md | 2 - docs/api/type-aliases/ScorerConfig.md | 14 - docs/api/type-aliases/ScorerEvent.md | 16 - docs/api/type-aliases/ScorerFactory.md | 2 - docs/api/type-aliases/ScorerFunction.md | 2 - docs/api/type-aliases/ScorerInput.md | 18 - docs/api/type-aliases/ScorerMetadata.md | 20 -- docs/api/type-aliases/ScorerMetrics.md | 32 -- docs/api/type-aliases/ScorerRegistryEntry.md | 10 - docs/api/type-aliases/ScorerRule.md | 12 - docs/api/type-aliases/ScorerType.md | 2 - docs/api/type-aliases/SdkSimpleTool.md | 2 - .../type-aliases/SearchPlanCapabilities.md | 12 - docs/api/type-aliases/SearchPlanResult.md | 16 - docs/api/type-aliases/SecretElicitation.md | 2 - docs/api/type-aliases/SecureConfiguration.md | 18 - docs/api/type-aliases/SegmentAttribution.md | 12 - docs/api/type-aliases/SegmentSupport.md | 6 - docs/api/type-aliases/SelectElicitation.md | 2 - docs/api/type-aliases/SelectOption.md | 10 - docs/api/type-aliases/SemVer.md | 8 - .../api/type-aliases/SemanticChunkerConfig.md | 2 - .../api/type-aliases/SentenceChunkerConfig.md | 2 - docs/api/type-aliases/SentryExporterConfig.md | 2 - docs/api/type-aliases/SentryModule.md | 14 - docs/api/type-aliases/SentryScope.md | 8 - docs/api/type-aliases/SerializeOptions.md | 10 - docs/api/type-aliases/SerializedError.md | 28 -- docs/api/type-aliases/ServeCommandArgs.md | 26 -- docs/api/type-aliases/ServeState.md | 16 - docs/api/type-aliases/ServerAdapterConfig.md | 28 -- .../ServerAdapterErrorCodeType.md | 2 - .../type-aliases/ServerAdapterErrorContext.md | 20 -- docs/api/type-aliases/ServerAdapterEvents.md | 14 - .../ServerAdapterFactoryOptions.md | 8 - docs/api/type-aliases/ServerAuthConfig.md | 16 - docs/api/type-aliases/ServerCacheConfig.md | 20 -- .../type-aliases/ServerCapabilitiesConfig.md | 8 - docs/api/type-aliases/ServerCommandArgs.md | 22 -- docs/api/type-aliases/ServerConfig.md | 16 - docs/api/type-aliases/ServerConfigFile.md | 24 -- docs/api/type-aliases/ServerContext.md | 42 --- docs/api/type-aliases/ServerFramework.md | 2 - docs/api/type-aliases/ServerGroup.md | 18 - docs/api/type-aliases/ServerInstance.md | 12 - docs/api/type-aliases/ServerLifecycleState.md | 2 - docs/api/type-aliases/ServerLoadResult.md | 6 - docs/api/type-aliases/ServerMetrics.md | 16 - docs/api/type-aliases/ServerResponse.md | 8 - .../type-aliases/ServerServerAuthConfig.md | 16 - docs/api/type-aliases/ServerState.md | 14 - docs/api/type-aliases/ServerStatus.md | 18 - .../type-aliases/ServerValidationResult.md | 2 - .../type-aliases/ServerVoiceConnectionCtx.md | 6 - .../type-aliases/ServerVoiceSessionState.md | 44 --- .../ServerVoiceWebSocketOptions.md | 6 - docs/api/type-aliases/ServerWeight.md | 8 - docs/api/type-aliases/ServiceConfig.md | 14 - docs/api/type-aliases/ServiceConfigOptions.md | 12 - .../type-aliases/ServiceConnectivityResult.md | 12 - docs/api/type-aliases/ServiceDefinition.md | 12 - .../type-aliases/ServiceDependencyHealth.md | 10 - docs/api/type-aliases/ServiceHealth.md | 12 - docs/api/type-aliases/ServiceMetadata.md | 10 - docs/api/type-aliases/ServiceRegistryStats.md | 12 - docs/api/type-aliases/ServiceStatus.md | 2 - docs/api/type-aliases/SessionConfig.md | 20 -- docs/api/type-aliases/SessionExport.md | 16 - docs/api/type-aliases/SessionIdentifier.md | 6 - docs/api/type-aliases/SessionListItem.md | 2 - .../api/type-aliases/SessionManagerStorage.md | 16 - docs/api/type-aliases/SessionMemory.md | 28 -- docs/api/type-aliases/SessionMetadata.md | 12 - docs/api/type-aliases/SessionRestoreResult.md | 12 - docs/api/type-aliases/SessionStorage.md | 18 - docs/api/type-aliases/SessionStorageType.md | 2 - .../type-aliases/SessionValidationResult.md | 12 - docs/api/type-aliases/SessionVariableValue.md | 2 - docs/api/type-aliases/SetupArgs.md | 16 - docs/api/type-aliases/SetupCommandArgs.md | 2 - docs/api/type-aliases/SetupHuggingFaceArgs.md | 6 - docs/api/type-aliases/SetupMistralArgs.md | 6 - docs/api/type-aliases/SetupProviderInfo.md | 2 - docs/api/type-aliases/SetupResult.md | 10 - docs/api/type-aliases/SeverityColors.md | 2 - docs/api/type-aliases/ShadowProps.md | 14 - docs/api/type-aliases/SharedRefreshResult.md | 10 - docs/api/type-aliases/ShutdownConfig.md | 8 - docs/api/type-aliases/SimilarityDetails.md | 12 - docs/api/type-aliases/SimilarityMetric.md | 2 - docs/api/type-aliases/SimpleResult.md | 6 - docs/api/type-aliases/SimpleTool.md | 10 - docs/api/type-aliases/SingleShotRequest.md | 12 - docs/api/type-aliases/SingleShotResult.md | 8 - docs/api/type-aliases/SizeTier.md | 2 - .../api/type-aliases/SkillActivationRecord.md | 10 - .../api/type-aliases/SkillCallToolsContext.md | 14 - docs/api/type-aliases/SkillCreateInput.md | 18 - .../type-aliases/SkillCustomStorageConfig.md | 6 - docs/api/type-aliases/SkillDefinition.md | 30 -- docs/api/type-aliases/SkillDiscoveryMode.md | 2 - .../SkillFilesystemStorageConfig.md | 6 - docs/api/type-aliases/SkillIndexItem.md | 2 - docs/api/type-aliases/SkillLifecycleStatus.md | 2 - .../type-aliases/SkillMemoryStorageConfig.md | 8 - docs/api/type-aliases/SkillMutationAction.md | 2 - .../api/type-aliases/SkillMutationDecision.md | 2 - docs/api/type-aliases/SkillMutationResult.md | 6 - .../type-aliases/SkillRedisStorageConfig.md | 18 - docs/api/type-aliases/SkillResourceRef.md | 6 - .../SkillS3ConditionalGetResult.md | 8 - docs/api/type-aliases/SkillS3IndexDocument.md | 6 - docs/api/type-aliases/SkillS3ModuleSurface.md | 12 - docs/api/type-aliases/SkillS3ObjectOps.md | 12 - docs/api/type-aliases/SkillS3StorageConfig.md | 16 - docs/api/type-aliases/SkillScopeKind.md | 2 - docs/api/type-aliases/SkillSearchQuery.md | 10 - .../api/type-aliases/SkillSessionStateLike.md | 10 - docs/api/type-aliases/SkillStore.md | 14 - docs/api/type-aliases/SkillToolsOptions.md | 4 - docs/api/type-aliases/SkillUpdateInput.md | 2 - docs/api/type-aliases/SkillsCallOptions.md | 12 - docs/api/type-aliases/SkillsConfig.md | 24 -- docs/api/type-aliases/SkillsManagerLike.md | 14 - docs/api/type-aliases/SkillsStorageConfig.md | 2 - docs/api/type-aliases/SkippedFileInfo.md | 14 - docs/api/type-aliases/SlideContent.md | 56 ---- .../api/type-aliases/SlideFormattingConfig.md | 8 - .../SlideGenerationBatchResult.md | 10 - docs/api/type-aliases/SlideGeneratorConfig.md | 18 - docs/api/type-aliases/SlideLayout.md | 2 - docs/api/type-aliases/SlideSchema.md | 16 - docs/api/type-aliases/SlideType.md | 2 - docs/api/type-aliases/SocketWorkerRuntime.md | 10 - .../SocketWorkerRuntimeOptions.md | 6 - docs/api/type-aliases/SonioxMessage.md | 10 - docs/api/type-aliases/SonioxToken.md | 6 - docs/api/type-aliases/SpanAttributes.md | 68 ---- docs/api/type-aliases/SpanData.md | 28 -- docs/api/type-aliases/SpanEvent.md | 8 - docs/api/type-aliases/SpanLink.md | 8 - docs/api/type-aliases/SpanOptions.md | 10 - docs/api/type-aliases/SpanProcessor.md | 10 - .../SpawnProxySocketWorkerOptions.md | 20 -- docs/api/type-aliases/SpeechGrammar.md | 6 - docs/api/type-aliases/SpeechGrammarList.md | 10 - .../SpeechRecognitionErrorEventInternal.md | 2 - .../SpeechRecognitionEventInternal.md | 2 - .../type-aliases/SpeechRecognitionEventMap.md | 24 -- .../type-aliases/SpeechRecognitionInternal.md | 2 - .../type-aliases/StabilityImageResponse.md | 8 - docs/api/type-aliases/StandardError.md | 10 - docs/api/type-aliases/StandardRecord.md | 2 - docs/api/type-aliases/Statistic.md | 12 - docs/api/type-aliases/StatusStats.md | 36 -- docs/api/type-aliases/StepResult.md | 38 --- docs/api/type-aliases/StepToolResult.md | 10 - docs/api/type-aliases/StorageConfig.md | 2 - docs/api/type-aliases/StorageType.md | 2 - .../StoreConversationTurnOptions.md | 26 -- docs/api/type-aliases/StoredBodyArtifact.md | 32 -- docs/api/type-aliases/StoredCredentials.md | 18 - docs/api/type-aliases/StoredOAuthTokens.md | 12 - docs/api/type-aliases/StoredProviderTokens.md | 14 - .../type-aliases/StreamAnalyticsCollector.md | 8 - docs/api/type-aliases/StreamAnalyticsData.md | 10 - docs/api/type-aliases/StreamChannel.md | 10 - docs/api/type-aliases/StreamChunk.md | 2 - docs/api/type-aliases/StreamCommandArgs.md | 2 - docs/api/type-aliases/StreamEventSequence.md | 8 - docs/api/type-aliases/StreamEvents.md | 14 - .../StreamGenerationEndContext.md | 4 - docs/api/type-aliases/StreamHandlerConfig.md | 14 - docs/api/type-aliases/StreamLifecycleState.md | 2 - docs/api/type-aliases/StreamLoopArgs.md | 38 --- .../type-aliases/StreamNoOutputSentinel.md | 6 - .../StreamNoOutputSentinelResultLike.md | 6 - docs/api/type-aliases/StreamOptions.md | 154 --------- docs/api/type-aliases/StreamPhase.md | 2 - docs/api/type-aliases/StreamResult.md | 46 --- .../type-aliases/StreamSerializerAdapter.md | 12 - .../api/type-aliases/StreamTerminalOutcome.md | 2 - .../StreamTerminalOutcomeTracker.md | 10 - docs/api/type-aliases/StreamTextResult.md | 18 - docs/api/type-aliases/StreamToolCall.md | 14 - docs/api/type-aliases/StreamToolResult.md | 16 - docs/api/type-aliases/StreamingCapability.md | 16 - .../api/type-aliases/StreamingClientConfig.md | 12 - docs/api/type-aliases/StreamingConfig.md | 8 - .../api/type-aliases/StreamingEventEmitter.md | 18 - docs/api/type-aliases/StreamingMetadata.md | 20 -- docs/api/type-aliases/StreamingOptions.md | 10 - docs/api/type-aliases/StreamingParser.md | 12 - .../api/type-aliases/StreamingProgressData.md | 16 - .../type-aliases/StreamingReaderOptions.md | 12 - .../type-aliases/StreamingRequestOptions.md | 18 - docs/api/type-aliases/StringArray.md | 2 - docs/api/type-aliases/StringRecord.md | 2 - docs/api/type-aliases/StructuredError.md | 22 -- .../StructuredRecoveryCandidate.md | 6 - .../type-aliases/StructuredRecoveryResult.md | 8 - .../type-aliases/StructuredRecoverySource.md | 2 - docs/api/type-aliases/StylePreset.md | 2 - docs/api/type-aliases/SubscriptionFeatures.md | 40 --- docs/api/type-aliases/SubscriptionInfo.md | 14 - .../type-aliases/SubscriptionInfoSummary.md | 22 -- docs/api/type-aliases/SubscriptionOptions.md | 12 - .../SummarizationPromptOptions.md | 10 - docs/api/type-aliases/SummarizeConfig.md | 12 - docs/api/type-aliases/SummarizeResult.md | 8 - docs/api/type-aliases/SummarizedFile.md | 14 - .../type-aliases/SummaryExtractorConfig.md | 2 - docs/api/type-aliases/SummaryStats.md | 14 - docs/api/type-aliases/SupabaseConfig.md | 10 - docs/api/type-aliases/SupervisedResult.md | 2 - docs/api/type-aliases/SupervisionOptions.md | 8 - docs/api/type-aliases/SupervisionPolicy.md | 10 - .../type-aliases/SupervisorAgentDefinition.md | 2 - .../api/type-aliases/SupportedFileTypeInfo.md | 12 - docs/api/type-aliases/SupportedFormat.md | 2 - docs/api/type-aliases/SupportedModelName.md | 2 - docs/api/type-aliases/SupportedProvider.md | 2 - docs/api/type-aliases/SuppressedVersion.md | 6 - .../api/type-aliases/SvgSanitizationResult.md | 8 - docs/api/type-aliases/SyncFunction.md | 2 - docs/api/type-aliases/SystemModelMessage.md | 8 - .../SystemPromptInjectorOptions.md | 12 - docs/api/type-aliases/TTSAudioFormat.md | 2 - docs/api/type-aliases/TTSChunk.md | 18 - docs/api/type-aliases/TTSGender.md | 2 - docs/api/type-aliases/TTSHandler.md | 12 - docs/api/type-aliases/TTSMetadata.md | 10 - docs/api/type-aliases/TTSOptions.md | 26 -- docs/api/type-aliases/TTSProvider.md | 10 - docs/api/type-aliases/TTSProviderName.md | 2 - docs/api/type-aliases/TTSQuality.md | 2 - docs/api/type-aliases/TTSResult.md | 16 - docs/api/type-aliases/TTSStreamChunk.md | 14 - docs/api/type-aliases/TTSVoice.md | 18 - docs/api/type-aliases/TTSVoiceType.md | 2 - docs/api/type-aliases/TableBorderOptions.md | 8 - docs/api/type-aliases/TableCell.md | 14 - docs/api/type-aliases/TableRow.md | 2 - docs/api/type-aliases/Task.md | 52 --- docs/api/type-aliases/TaskAnalysis.md | 12 - docs/api/type-aliases/TaskAssignment.md | 12 - docs/api/type-aliases/TaskBackend.md | 18 - docs/api/type-aliases/TaskBackendFactoryFn.md | 2 - docs/api/type-aliases/TaskBackendName.md | 2 - docs/api/type-aliases/TaskClassification.md | 8 - docs/api/type-aliases/TaskCreateArgs.md | 28 -- docs/api/type-aliases/TaskDefinition.md | 42 --- .../api/type-aliases/TaskDistributorConfig.md | 16 - docs/api/type-aliases/TaskExecutionMode.md | 2 - docs/api/type-aliases/TaskExecutorFn.md | 2 - docs/api/type-aliases/TaskLogsArgs.md | 10 - docs/api/type-aliases/TaskManagerConfig.md | 22 -- docs/api/type-aliases/TaskPriority.md | 2 - docs/api/type-aliases/TaskQueueItem.md | 8 - docs/api/type-aliases/TaskRetentionConfig.md | 10 - docs/api/type-aliases/TaskRunError.md | 16 - docs/api/type-aliases/TaskRunResult.md | 20 -- docs/api/type-aliases/TaskSchedule.md | 2 - docs/api/type-aliases/TaskScheduleType.md | 2 - docs/api/type-aliases/TaskStatus.md | 2 - docs/api/type-aliases/TaskStore.md | 28 -- docs/api/type-aliases/TaskType.md | 2 - docs/api/type-aliases/TaskUpdateArgs.md | 14 - docs/api/type-aliases/TasksFile.md | 6 - docs/api/type-aliases/TeamAnalyticsOptions.md | 10 - docs/api/type-aliases/TeamAnalyticsResult.md | 14 - docs/api/type-aliases/TeamMember.md | 12 - docs/api/type-aliases/TelemetryAccumulator.md | 48 --- docs/api/type-aliases/TelemetryCommandArgs.md | 6 - .../type-aliases/TelemetryConfigureArgs.md | 2 - docs/api/type-aliases/TelemetryFlushArgs.md | 2 - .../TelemetryListExportersArgs.md | 2 - .../TelemetryNativePrepareArgs.md | 24 -- .../TelemetryNativeValidateArgs.md | 6 - docs/api/type-aliases/TelemetryRecord.md | 32 -- docs/api/type-aliases/TelemetryStatsArgs.md | 2 - docs/api/type-aliases/TelemetryStatusArgs.md | 2 - .../type-aliases/TerminalAgentModeOption.md | 2 - .../type-aliases/TerminalAgentModeVersion.md | 2 - docs/api/type-aliases/TestFunction.md | 8 - docs/api/type-aliases/TestResult.md | 12 - docs/api/type-aliases/TextContent.md | 6 - docs/api/type-aliases/TextElicitation.md | 2 - .../api/type-aliases/TextGenerationOptions.md | 130 ------- docs/api/type-aliases/TextGenerationResult.md | 2 - docs/api/type-aliases/TextPart.md | 8 - docs/api/type-aliases/TextSegment.md | 8 - docs/api/type-aliases/ThemeColors.md | 16 - docs/api/type-aliases/ThemeFonts.md | 8 - docs/api/type-aliases/ThemeOption.md | 2 - docs/api/type-aliases/ThinkingConfig.md | 10 - docs/api/type-aliases/ThinkingLevel.md | 2 - docs/api/type-aliases/TierComparisonResult.md | 10 - docs/api/type-aliases/TimeRangeOption.md | 6 - docs/api/type-aliases/TimeWindowStats.md | 24 -- docs/api/type-aliases/TimelineItem.md | 10 - docs/api/type-aliases/TimeoutCategory.md | 2 - docs/api/type-aliases/TimeoutConfig.md | 14 - .../type-aliases/TimeoutInterceptorOptions.md | 6 - docs/api/type-aliases/TimeoutResult.md | 14 - docs/api/type-aliases/Timestamp.md | 2 - docs/api/type-aliases/TitleExtractorConfig.md | 2 - .../api/type-aliases/TlsFingerprintOptions.md | 6 - docs/api/type-aliases/TokenBucket.md | 8 - .../TokenBucketRateLimitConfig.md | 12 - docs/api/type-aliases/TokenChunkerConfig.md | 2 - docs/api/type-aliases/TokenClaims.md | 24 -- docs/api/type-aliases/TokenExchangeRequest.md | 8 - .../api/type-aliases/TokenExtractionConfig.md | 10 - .../type-aliases/TokenExtractionOptions.md | 6 - .../type-aliases/TokenExtractionStrategy.md | 10 - docs/api/type-aliases/TokenPersistTarget.md | 2 - docs/api/type-aliases/TokenRefreshResult.md | 8 - docs/api/type-aliases/TokenRefresher.md | 2 - docs/api/type-aliases/TokenResponse.md | 12 - docs/api/type-aliases/TokenStorage.md | 12 - docs/api/type-aliases/TokenStorageData.md | 8 - docs/api/type-aliases/TokenType.md | 2 - docs/api/type-aliases/TokenUsage.md | 16 - docs/api/type-aliases/TokenUsageStats.md | 22 -- .../api/type-aliases/TokenValidationConfig.md | 16 - .../api/type-aliases/TokenValidationResult.md | 22 -- docs/api/type-aliases/TokenValidator.md | 2 - docs/api/type-aliases/ToneAdjustment.md | 2 - docs/api/type-aliases/ToneOption.md | 2 - docs/api/type-aliases/ToneShift.md | 10 - docs/api/type-aliases/Tool.md | 2 - docs/api/type-aliases/ToolAnnotationInfo.md | 12 - docs/api/type-aliases/ToolApprovalRequest.md | 8 - docs/api/type-aliases/ToolApprovalResponse.md | 12 - docs/api/type-aliases/ToolArgs.md | 2 - docs/api/type-aliases/ToolCall.md | 8 - docs/api/type-aliases/ToolCallObject.md | 2 - docs/api/type-aliases/ToolCallPart.md | 14 - .../type-aliases/ToolCallRepairFunction.md | 2 - docs/api/type-aliases/ToolCallResult.md | 8 - docs/api/type-aliases/ToolCallResults.md | 2 - docs/api/type-aliases/ToolCalls.md | 2 - docs/api/type-aliases/ToolChoice.md | 2 - docs/api/type-aliases/ToolConfig.md | 24 -- docs/api/type-aliases/ToolContent.md | 2 - docs/api/type-aliases/ToolContext.md | 10 - docs/api/type-aliases/ToolConverterOptions.md | 10 - docs/api/type-aliases/ToolDedupConfig.md | 6 - docs/api/type-aliases/ToolDedupRemoved.md | 8 - docs/api/type-aliases/ToolDedupResult.md | 6 - docs/api/type-aliases/ToolDefinition.md | 10 - docs/api/type-aliases/ToolDiscoveryResult.md | 14 - docs/api/type-aliases/ToolEventPayload.md | 22 -- docs/api/type-aliases/ToolExecuteFunction.md | 2 - docs/api/type-aliases/ToolExecuteRequest.md | 10 - docs/api/type-aliases/ToolExecuteResponse.md | 12 - docs/api/type-aliases/ToolExecution.md | 12 - .../ToolExecutionCaptureOptions.md | 8 - docs/api/type-aliases/ToolExecutionContext.md | 16 - docs/api/type-aliases/ToolExecutionEvent.md | 20 -- .../api/type-aliases/ToolExecutionFunction.md | 2 - docs/api/type-aliases/ToolExecutionGuards.md | 10 - .../api/type-aliases/ToolExecutionMetadata.md | 8 - docs/api/type-aliases/ToolExecutionOptions.md | 20 -- docs/api/type-aliases/ToolExecutionRecord.md | 14 - docs/api/type-aliases/ToolExecutionResult.md | 14 - docs/api/type-aliases/ToolExecutionSummary.md | 20 -- .../ToolExecutionSummaryInternal.md | 16 - docs/api/type-aliases/ToolImplementation.md | 20 -- docs/api/type-aliases/ToolInfo.md | 22 -- docs/api/type-aliases/ToolMetadata.md | 12 - docs/api/type-aliases/ToolMiddleware.md | 2 - docs/api/type-aliases/ToolModelMessage.md | 8 - docs/api/type-aliases/ToolNameResolution.md | 8 - .../type-aliases/ToolOutputPreviewOptions.md | 12 - .../type-aliases/ToolOutputPreviewResult.md | 8 - docs/api/type-aliases/ToolParameterSchema.md | 2 - .../type-aliases/ToolPolicyResolutionInput.md | 8 - docs/api/type-aliases/ToolPrimitive.md | 2 - .../type-aliases/ToolRegistrationOptions.md | 10 - docs/api/type-aliases/ToolRegistryEntry.md | 14 - docs/api/type-aliases/ToolRegistryEvents.md | 14 - docs/api/type-aliases/ToolResult.md | 2 - docs/api/type-aliases/ToolResultData.md | 12 - docs/api/type-aliases/ToolResultMetadata.md | 18 - docs/api/type-aliases/ToolResultPart.md | 14 - docs/api/type-aliases/ToolResultUsage.md | 8 - docs/api/type-aliases/ToolRetrievalItem.md | 6 - .../type-aliases/ToolRetrievalRankedResult.md | 6 - .../ToolRetrievalSelectOptions.md | 12 - docs/api/type-aliases/ToolRetrievalWeights.md | 6 - docs/api/type-aliases/ToolRouterConfig.md | 18 - docs/api/type-aliases/ToolRouterEvents.md | 12 - .../api/type-aliases/ToolRoutingCacheEntry.md | 10 - .../type-aliases/ToolRoutingCacheOptions.md | 10 - .../type-aliases/ToolRoutingCatalogEntry.md | 8 - docs/api/type-aliases/ToolRoutingConfig.md | 24 -- docs/api/type-aliases/ToolRoutingDecision.md | 26 -- .../ToolRoutingDecisionOutcome.md | 14 - .../ToolRoutingEmbeddingConfig.md | 16 - .../type-aliases/ToolRoutingModelConfig.md | 10 - docs/api/type-aliases/ToolRoutingOutcome.md | 2 - .../ToolRoutingResolutionParams.md | 30 -- .../ToolRoutingServerDescriptor.md | 6 - .../api/type-aliases/ToolRoutingStickiness.md | 6 - docs/api/type-aliases/ToolSearchCriteria.md | 22 -- docs/api/type-aliases/ToolSearchResult.md | 10 - docs/api/type-aliases/ToolSet.md | 2 - docs/api/type-aliases/ToolUtilities.md | 10 - .../api/type-aliases/ToolValidationOptions.md | 8 - docs/api/type-aliases/ToolValidationResult.md | 10 - docs/api/type-aliases/ToolWithLegacyParams.md | 10 - docs/api/type-aliases/ToolWrapperOptions.md | 10 - docs/api/type-aliases/TopologyConfig.md | 12 - docs/api/type-aliases/TopologyEdge.md | 14 - docs/api/type-aliases/TopologyNode.md | 18 - docs/api/type-aliases/TopologyStats.md | 16 - docs/api/type-aliases/TopologyType.md | 2 - docs/api/type-aliases/TraceNameFormat.md | 2 - docs/api/type-aliases/TraceView.md | 14 - docs/api/type-aliases/TrackedConnection.md | 12 - docs/api/type-aliases/TranscriptionSegment.md | 24 -- .../type-aliases/TransferableProxySocket.md | 2 - docs/api/type-aliases/TransformFunction.md | 2 - .../TransientRateLimitRetryBudget.md | 6 - docs/api/type-aliases/TransitionResult.md | 12 - docs/api/type-aliases/TransportResult.md | 6 - .../TransportWithProcessResult.md | 6 - docs/api/type-aliases/TrendAnalysis.md | 12 - docs/api/type-aliases/TripwireAction.md | 2 - docs/api/type-aliases/TripwireConfig.md | 14 - docs/api/type-aliases/TripwireData.md | 14 - docs/api/type-aliases/TripwireResult.md | 10 - docs/api/type-aliases/TruncateOptions.md | 12 - docs/api/type-aliases/TruncateResult.md | 10 - docs/api/type-aliases/TruncationConfig.md | 14 - docs/api/type-aliases/TruncationResult.md | 8 - .../type-aliases/UnifiedGenerationOptions.md | 2 - docs/api/type-aliases/UnifiedMCPRegistry.md | 10 - docs/api/type-aliases/UnifiedTool.md | 12 - docs/api/type-aliases/Unknown.md | 2 - docs/api/type-aliases/UnknownArray.md | 2 - docs/api/type-aliases/UnknownRecord.md | 2 - docs/api/type-aliases/UnsupportedFileError.md | 14 - docs/api/type-aliases/UpdateCheckResult.md | 2 - docs/api/type-aliases/UpdateState.md | 24 -- .../type-aliases/UpdaterWorkerSupervisor.md | 8 - .../UpdaterWorkerSupervisorOptions.md | 14 - .../api/type-aliases/UpsertableVectorStore.md | 2 - .../type-aliases/UpstreamAttemptContext.md | 12 - docs/api/type-aliases/UsageContext.md | 22 -- docs/api/type-aliases/UsageQuota.md | 22 -- docs/api/type-aliases/UseAgentOptions.md | 14 - docs/api/type-aliases/UseAgentReturn.md | 22 -- docs/api/type-aliases/UseCaseSuitability.md | 16 - docs/api/type-aliases/UseChatOptions.md | 28 -- docs/api/type-aliases/UseChatReturn.md | 28 -- docs/api/type-aliases/UseStreamOptions.md | 6 - docs/api/type-aliases/UseStreamReturn.md | 14 - docs/api/type-aliases/UseToolsOptions.md | 8 - docs/api/type-aliases/UseToolsReturn.md | 12 - docs/api/type-aliases/UseVoiceOptions.md | 18 - docs/api/type-aliases/UseVoiceReturn.md | 26 -- docs/api/type-aliases/UseWorkflowOptions.md | 12 - docs/api/type-aliases/UseWorkflowReturn.md | 22 -- docs/api/type-aliases/UserContent.md | 2 - docs/api/type-aliases/UserModelMessage.md | 8 - docs/api/type-aliases/UtilityToolsMap.md | 8 - .../ValidateInstalledVersionOptions.md | 16 - docs/api/type-aliases/ValidationConfig.md | 16 - docs/api/type-aliases/ValidationErrorInfo.md | 6 - .../type-aliases/ValidationErrorPayload.md | 8 - docs/api/type-aliases/ValidationFunction.md | 2 - docs/api/type-aliases/ValidationIssue.md | 10 - docs/api/type-aliases/ValidationIssues.md | 6 - docs/api/type-aliases/ValidationResult.md | 10 - docs/api/type-aliases/ValidationSchema.md | 2 - .../api/type-aliases/VectorProviderOptions.md | 8 - docs/api/type-aliases/VectorQueryResponse.md | 10 - docs/api/type-aliases/VectorQueryResult.md | 12 - .../api/type-aliases/VectorQueryToolConfig.md | 22 -- docs/api/type-aliases/VectorStore.md | 4 - .../type-aliases/VertexAccessTokenProvider.md | 2 - .../type-aliases/VertexAnthropicAuthClient.md | 6 - .../VertexAnthropicCacheControl.md | 4 - .../type-aliases/VertexAnthropicCacheInput.md | 10 - .../VertexAnthropicCacheOutput.md | 8 - .../VertexAnthropicContentBlock.md | 2 - .../type-aliases/VertexAnthropicMessage.md | 6 - .../VertexAnthropicPassthroughRequest.md | 12 - .../VertexAnthropicPassthroughTarget.md | 10 - .../VertexAnthropicSystemBlock.md | 8 - docs/api/type-aliases/VertexAnthropicTool.md | 10 - .../VertexGenaiFunctionDeclaration.md | 8 - docs/api/type-aliases/VertexNativeLoopPart.md | 2 - docs/api/type-aliases/VertexNativePart.md | 2 - .../api/type-aliases/VertexOperationResult.md | 8 - .../type-aliases/VertexPassthroughTerminal.md | 8 - docs/api/type-aliases/VertexRegularSegment.md | 8 - docs/api/type-aliases/VertexSegment.md | 2 - docs/api/type-aliases/VertexToolStep.md | 8 - docs/api/type-aliases/VertexUsageCounter.md | 2 - docs/api/type-aliases/VideoContent.md | 10 - .../api/type-aliases/VideoDeliveryDecision.md | 2 - docs/api/type-aliases/VideoGenerateOptions.md | 2 - .../api/type-aliases/VideoGenerationResult.md | 8 - docs/api/type-aliases/VideoHandler.md | 14 - docs/api/type-aliases/VideoOutputOptions.md | 22 -- .../api/type-aliases/VideoProcessorOptions.md | 8 - docs/api/type-aliases/VideoProviderConfig.md | 14 - docs/api/type-aliases/VideoProviderName.md | 2 - docs/api/type-aliases/VideoSaveResult.md | 10 - .../type-aliases/VideoTransitionOptions.md | 12 - docs/api/type-aliases/VisionCapability.md | 12 - .../api/type-aliases/VisionImageConversion.md | 8 - .../type-aliases/VisionImageOutputFormat.md | 2 - .../type-aliases/VisionTranscodeOptions.md | 6 - docs/api/type-aliases/VoiceCapability.md | 2 - docs/api/type-aliases/VoiceErrorOptions.md | 18 - docs/api/type-aliases/VoiceEvent.md | 12 - docs/api/type-aliases/VoiceEventType.md | 2 - docs/api/type-aliases/VoiceHandler.md | 2 - docs/api/type-aliases/VoiceProviderConfig.md | 14 - docs/api/type-aliases/VoiceProviderName.md | 2 - docs/api/type-aliases/VoiceProviderType.md | 2 - docs/api/type-aliases/VoiceResult.md | 2 - docs/api/type-aliases/VoiceServerArgs.md | 4 - docs/api/type-aliases/VoiceTurn.md | 12 - docs/api/type-aliases/VoiceType.md | 2 - .../type-aliases/VoyageEmbeddingsResponse.md | 10 - docs/api/type-aliases/WSClientConfig.md | 2 - .../api/type-aliases/WSClientEventHandlers.md | 14 - docs/api/type-aliases/WSClientMessage.md | 10 - docs/api/type-aliases/WSClientState.md | 2 - docs/api/type-aliases/WebLoaderOptions.md | 2 - docs/api/type-aliases/WebSocketConfig.md | 14 - docs/api/type-aliases/WebSocketConnection.md | 14 - .../type-aliases/WebSocketEventHandlers.md | 2 - docs/api/type-aliases/WebSocketHandler.md | 10 - docs/api/type-aliases/WebSocketMessage.md | 8 - docs/api/type-aliases/WebSocketMessageType.md | 2 - docs/api/type-aliases/WhisperModel.md | 2 - docs/api/type-aliases/WhisperSTTOptions.md | 2 - .../api/type-aliases/WhisperSimpleResponse.md | 4 - .../WhisperTranscriptionSegment.md | 22 -- .../type-aliases/WhisperTranscriptionWord.md | 8 - .../type-aliases/WhisperVerboseResponse.md | 14 - docs/api/type-aliases/WordTiming.md | 16 - docs/api/type-aliases/WorkOSConfig.md | 8 - .../api/type-aliases/WorkerInstanceOptions.md | 10 - docs/api/type-aliases/WorkerLogEvent.md | 12 - docs/api/type-aliases/WorkerState.md | 8 - docs/api/type-aliases/WorkflowAnalytics.md | 2 - docs/api/type-aliases/WorkflowComparison.md | 10 - docs/api/type-aliases/WorkflowConfig.md | 36 -- docs/api/type-aliases/WorkflowErrorDetails.md | 14 - .../type-aliases/WorkflowEvaluationData.md | 12 - .../type-aliases/WorkflowExecutionMetrics.md | 20 -- .../type-aliases/WorkflowGenerateOptions.md | 16 - docs/api/type-aliases/WorkflowInput.md | 8 - docs/api/type-aliases/WorkflowMetadata.md | 8 - docs/api/type-aliases/WorkflowModelConfig.md | 28 -- docs/api/type-aliases/WorkflowPrimitive.md | 2 - docs/api/type-aliases/WorkflowResult.md | 46 --- docs/api/type-aliases/WorkflowStreamChunk.md | 8 - docs/api/type-aliases/WorkflowTestCase.md | 12 - docs/api/type-aliases/WorkflowType.md | 2 - docs/api/type-aliases/WorkflowValidation.md | 8 - .../type-aliases/WorkflowValidationError.md | 10 - .../type-aliases/WorkflowValidationResult.md | 8 - .../type-aliases/WorkflowValidationWarning.md | 10 - docs/api/type-aliases/YamlModule.md | 8 - docs/api/type-aliases/Zod4NativeParams.md | 4 - docs/api/type-aliases/Zod4NativeTarget.md | 2 - docs/api/type-aliases/ZodAnySchema.md | 2 - docs/api/type-aliases/ZodObjectSchema.md | 2 - docs/api/type-aliases/ZodStringSchema.md | 2 - docs/api/type-aliases/ZodToJsonSchemaInput.md | 2 - docs/api/type-aliases/ZodUnknownSchema.md | 2 - docs/api/variables/AGENT_ATTRIBUTES.md | 2 - .../variables/AGGRESSIVE_FALLBACK_WORKFLOW.md | 2 - docs/api/variables/AUDIO_FORMAT_DETAILS.md | 2 - docs/api/variables/AUTORESEARCH_DEFAULTS.md | 2 - docs/api/variables/AVATAR_ERROR_CODES.md | 2 - .../variables/AgentExecuteRequestSchema.md | 2 - docs/api/variables/AuthErrorCodes.md | 2 - docs/api/variables/AuthErrorFactory.md | 2 - docs/api/variables/AuthMiddlewareError.md | 2 - .../api/variables/AuthMiddlewareErrorCodes.md | 2 - docs/api/variables/AuthProviderError.md | 2 - .../variables/BALANCED_ADAPTIVE_WORKFLOW.md | 2 - .../variables/CLASSIFIER_CONTEXT_SCOPES.md | 2 - docs/api/variables/CLASSIFIER_DIFFICULTIES.md | 2 - .../api/variables/CODE_GENERATION_PIPELINE.md | 2 - docs/api/variables/COMPREHENSIVE_PIPELINE.md | 2 - .../variables/CONSENSUS_3_FAST_WORKFLOW.md | 2 - docs/api/variables/CONSENSUS_3_WORKFLOW.md | 2 - .../variables/CUSTOMER_SUPPORT_PIPELINE.md | 2 - docs/api/variables/ClientErrorCode.md | 2 - docs/api/variables/DECISION_PROVIDERS.md | 2 - docs/api/variables/DEFAULT_ALIAS_BOOST.md | 2 - docs/api/variables/DEFAULT_BATCH_CONFIG.md | 2 - docs/api/variables/DEFAULT_CACHE_CONFIG.md | 2 - docs/api/variables/DEFAULT_CANDIDATE_LIMIT.md | 2 - .../variables/DEFAULT_COMPACTION_THRESHOLD.md | 2 - docs/api/variables/DEFAULT_CONFIG.md | 2 - docs/api/variables/DEFAULT_EXACT_BOOST.md | 2 - docs/api/variables/DEFAULT_FIELD_WEIGHTS.md | 2 - .../variables/DEFAULT_HTTP_RETRY_CONFIG.md | 2 - .../api/variables/DEFAULT_IMAGE_GEN_CONFIG.md | 2 - .../variables/DEFAULT_IMAGE_MAX_SIZE_MB.md | 2 - .../api/variables/DEFAULT_IMAGE_TIMEOUT_MS.md | 2 - docs/api/variables/DEFAULT_INFERENCE_KINDS.md | 2 - .../variables/DEFAULT_LLM_SCORER_CONFIG.md | 2 - .../variables/DEFAULT_MAX_CONTEXT_TOKENS.md | 2 - docs/api/variables/DEFAULT_MODEL_ALIASES.md | 2 - .../api/variables/DEFAULT_PROVIDER_CONFIGS.md | 2 - .../variables/DEFAULT_RATE_LIMIT_CONFIG.md | 2 - docs/api/variables/DEFAULT_REALTIME_CONFIG.md | 2 - docs/api/variables/DEFAULT_RECENT_TURNS.md | 2 - docs/api/variables/DEFAULT_RELATION_LIMIT.md | 2 - docs/api/variables/DEFAULT_RESULT_LIMIT.md | 2 - docs/api/variables/DEFAULT_RETRY_CONFIG.md | 2 - docs/api/variables/DEFAULT_ROUTER_CONFIG.md | 2 - .../variables/DEFAULT_ROUTER_PROMPT_PREFIX.md | 2 - .../variables/DEFAULT_RULE_SCORER_CONFIG.md | 2 - docs/api/variables/DEFAULT_SAMPLING_CONFIG.md | 2 - docs/api/variables/DEFAULT_SCORE_SCALE.md | 2 - docs/api/variables/DEFAULT_STT_OPTIONS.md | 2 - .../api/variables/DEFAULT_TEXT_MAX_SIZE_MB.md | 2 - docs/api/variables/DEFAULT_TEXT_TIMEOUT_MS.md | 2 - docs/api/variables/DEFAULT_TIMEOUT_MS.md | 2 - .../api/variables/EVAL_DEFAULT_SCORE_SCALE.md | 2 - docs/api/variables/ErrorCategory.md | 2 - docs/api/variables/ErrorRecoveryStrategies.md | 2 - docs/api/variables/ErrorSeverity.md | 2 - docs/api/variables/FAST_FALLBACK_WORKFLOW.md | 2 - docs/api/variables/FormatScorerPresets.md | 2 - docs/api/variables/GENAI_ATTRIBUTES.md | 2 - docs/api/variables/LengthScorerPresets.md | 2 - docs/api/variables/MAX_SLIDES.md | 2 - docs/api/variables/MINIMAL_PIPELINE.md | 2 - docs/api/variables/MIN_SLIDES.md | 2 - docs/api/variables/MULTI_JUDGE_3_WORKFLOW.md | 2 - docs/api/variables/MULTI_JUDGE_5_WORKFLOW.md | 2 - docs/api/variables/MUSIC_ERROR_CODES.md | 2 - docs/api/variables/ModelAliases.md | 2 - docs/api/variables/ModelConfigSchema.md | 2 - docs/api/variables/ModelRegistrySchema.md | 2 - .../variables/NEUROLINK_RESOURCE_ID_KEY.md | 2 - docs/api/variables/NEUROLINK_THREAD_ID_KEY.md | 2 - docs/api/variables/PROCESSOR_PRIORITIES.md | 2 - docs/api/variables/PROVIDER_ALIAS_INDEX.md | 2 - docs/api/variables/PROVIDER_DESCRIPTORS.md | 2 - .../variables/PROVIDER_DESCRIPTORS_BY_NAME.md | 2 - docs/api/variables/Pipelines.md | 2 - docs/api/variables/QUALITY_MAX_WORKFLOW.md | 2 - docs/api/variables/QUALITY_PIPELINE.md | 2 - docs/api/variables/RAG_PIPELINE.md | 2 - docs/api/variables/REALTIME_ERROR_CODES.md | 2 - docs/api/variables/Reports.md | 2 - docs/api/variables/SAFETY_PIPELINE.md | 2 - docs/api/variables/SIZE_TIER_THRESHOLDS.md | 2 - docs/api/variables/SLIDE_DIMENSIONS.md | 2 - docs/api/variables/SPEED_FIRST_WORKFLOW.md | 2 - docs/api/variables/STT_ERROR_CODES.md | 2 - docs/api/variables/SUMMARIZATION_PIPELINE.md | 2 - .../variables/SUPPORTED_IMAGE_MIME_TYPES.md | 2 - docs/api/variables/SamplingStrategies.md | 2 - docs/api/variables/Scorers.md | 2 - docs/api/variables/ServerAdapterErrorCode.md | 2 - docs/api/variables/ServerNameParamSchema.md | 2 - docs/api/variables/SessionIdParamSchema.md | 2 - docs/api/variables/TASK_DEFAULTS.md | 2 - .../api/variables/TERMINAL_AGENT_PROMPT_V1.md | 2 - .../api/variables/TERMINAL_AGENT_PROMPT_V2.md | 2 - .../TERMINAL_AGENT_PROMPT_VERSION.md | 2 - docs/api/variables/TOOL_COMPATIBILITY.md | 2 - docs/api/variables/TTS_ERROR_CODES.md | 2 - .../variables/TYPESAFE_MAX_REQUEST_TOKENS.md | 2 - .../variables/TYPESAFE_MAX_STATE_TOKENS.md | 2 - docs/api/variables/ToolArgumentsSchema.md | 2 - .../api/variables/ToolExecuteRequestSchema.md | 2 - docs/api/variables/ToolNameParamSchema.md | 2 - docs/api/variables/ToolSearchQuerySchema.md | 2 - docs/api/variables/VALID_AUDIO_FORMATS.md | 2 - docs/api/variables/VALID_AVATAR_FORMATS.md | 2 - docs/api/variables/VALID_MUSIC_FORMATS.md | 2 - docs/api/variables/VALID_TTS_QUALITIES.md | 2 - docs/api/variables/VERSION.md | 2 - docs/api/variables/VIDEO_ERROR_CODES.md | 2 - docs/api/variables/VIDEO_PROVIDER_CONFIGS.md | 2 - docs/api/variables/VOICE_ERROR_CODES.md | 2 - docs/api/variables/WORKFLOW_ENGINE_VERSION.md | 2 - docs/api/variables/commonTripwires.md | 2 - docs/api/variables/confirmationMiddleware.md | 2 - docs/api/variables/dynamicModelProvider.md | 2 - docs/api/variables/evaluationErrors.md | 2 - .../variables/globalAgentExposureManager.md | 2 - docs/api/variables/globalAuthContext.md | 2 - .../variables/globalCircuitBreakerManager.md | 2 - .../api/variables/globalElicitationManager.md | 2 - .../variables/globalElicitationProtocol.md | 2 - docs/api/variables/globalMCPRegistryClient.md | 2 - docs/api/variables/globalMetricsCollector.md | 2 - .../api/variables/globalMultiServerManager.md | 2 - .../api/variables/globalRateLimiterManager.md | 2 - .../variables/globalToolIntegrationManager.md | 2 - docs/api/variables/logger.md | 2 - docs/api/variables/loggingMiddleware.md | 2 - docs/api/variables/mcpLogger.md | 2 - docs/api/variables/neuroLinkAIInstance.md | 2 - docs/api/variables/observabilityHooks.md | 2 - .../api/variables/ragCircuitBreakerManager.md | 2 - docs/api/variables/validationMiddleware.md | 2 - typedoc.json | 1 + 3684 files changed, 5 insertions(+), 37937 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e8ba9e452..a5b46ab43 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -196,7 +196,10 @@ jobs: # package version into every page header, so every commit rewrote all # 3224 files and a drift check would have failed on every PR. typedoc.json # pins gitRevision and drops includeVersion for exactly this reason — - # changing either back re-breaks this gate. + # changing either back re-breaks this gate. It also sets disableSources: + # "Defined in: file.ts:LINE" put a source line number on every page, so + # three added lines near the top of one type file rewrote 143 pages and + # made unrelated PRs conflict on docs/api. # # The prettier pass is part of the pipeline, not a tidy-up: docs/api is # not in .prettierignore and raw typedoc output fails format:check. diff --git a/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupArgv.md b/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupArgv.md index 5af607453..23b633daf 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupArgv.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupArgv.md @@ -8,20 +8,14 @@ > **AnthropicSetupArgv** = `object` -Defined in: [types/cli.ts:785](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L785) - ## Properties ### check? > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:786](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L786) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` - -Defined in: [types/cli.ts:787](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L787) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupConfig.md b/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupConfig.md index 4db92c7e3..8698b5403 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupConfig.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupConfig.md @@ -8,28 +8,20 @@ > **AnthropicSetupConfig** = `object` -Defined in: [types/cli.ts:790](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L790) - ## Properties ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/cli.ts:791](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L791) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/cli.ts:792](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L792) - --- ### isReconfiguring? > `optional` **isReconfiguring?**: `boolean` - -Defined in: [types/cli.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L793) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupOptions.md b/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupOptions.md index a57394467..c51f42b74 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupOptions.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/AnthropicSetup/type-aliases/AnthropicSetupOptions.md @@ -8,20 +8,14 @@ > **AnthropicSetupOptions** = `object` -Defined in: [types/cli.ts:780](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L780) - ## Properties ### checkOnly? > `optional` **checkOnly?**: `boolean` -Defined in: [types/cli.ts:781](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L781) - --- ### interactive? > `optional` **interactive?**: `boolean` - -Defined in: [types/cli.ts:782](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L782) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupArgv.md b/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupArgv.md index b35e293b9..62bfbffb2 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupArgv.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupArgv.md @@ -8,20 +8,14 @@ > **AzureSetupArgv** = `object` -Defined in: [types/cli.ts:827](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L827) - ## Properties ### check? > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:828](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L828) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` - -Defined in: [types/cli.ts:829](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L829) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupConfig.md b/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupConfig.md index 0b5cdc6a3..70af63c14 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupConfig.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupConfig.md @@ -8,52 +8,38 @@ > **AzureSetupConfig** = `object` -Defined in: [types/cli.ts:832](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L832) - ## Properties ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/cli.ts:833](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L833) - --- ### endpoint? > `optional` **endpoint?**: `string` -Defined in: [types/cli.ts:834](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L834) - --- ### deploymentName? > `optional` **deploymentName?**: `string` -Defined in: [types/cli.ts:835](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L835) - --- ### apiVersion? > `optional` **apiVersion?**: `string` -Defined in: [types/cli.ts:836](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L836) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/cli.ts:837](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L837) - --- ### isReconfiguring? > `optional` **isReconfiguring?**: `boolean` - -Defined in: [types/cli.ts:838](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L838) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupOptions.md b/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupOptions.md index 4cefd911a..87900f5d5 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupOptions.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/AzureSetup/type-aliases/AzureSetupOptions.md @@ -8,20 +8,14 @@ > **AzureSetupOptions** = `object` -Defined in: [types/cli.ts:822](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L822) - ## Properties ### checkOnly? > `optional` **checkOnly?**: `boolean` -Defined in: [types/cli.ts:823](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L823) - --- ### interactive? > `optional` **interactive?**: `boolean` - -Defined in: [types/cli.ts:824](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L824) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/BedrockSetupArgv.md b/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/BedrockSetupArgv.md index f9db10a0e..124894fc5 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/BedrockSetupArgv.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/BedrockSetupArgv.md @@ -8,20 +8,14 @@ > **BedrockSetupArgv** = `object` -Defined in: [types/cli.ts:851](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L851) - ## Properties ### check? > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:852](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L852) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` - -Defined in: [types/cli.ts:853](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L853) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/BedrockSetupOptions.md b/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/BedrockSetupOptions.md index 9c67999f1..84319748f 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/BedrockSetupOptions.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/BedrockSetupOptions.md @@ -8,20 +8,14 @@ > **BedrockSetupOptions** = `object` -Defined in: [types/cli.ts:846](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L846) - ## Properties ### checkOnly? > `optional` **checkOnly?**: `boolean` -Defined in: [types/cli.ts:847](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L847) - --- ### interactive? > `optional` **interactive?**: `boolean` - -Defined in: [types/cli.ts:848](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L848) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/ConfigData.md b/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/ConfigData.md index 15fccde54..5bd6277b3 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/ConfigData.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/ConfigData.md @@ -8,36 +8,26 @@ > **ConfigData** = `object` -Defined in: [types/cli.ts:856](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L856) - ## Properties ### region? > `optional` **region?**: `string` -Defined in: [types/cli.ts:857](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L857) - --- ### accessKeyId? > `optional` **accessKeyId?**: `string` -Defined in: [types/cli.ts:858](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L858) - --- ### secretAccessKey? > `optional` **secretAccessKey?**: `string` -Defined in: [types/cli.ts:859](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L859) - --- ### model? > `optional` **model?**: `string` - -Defined in: [types/cli.ts:860](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L860) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/ConfigStatus.md b/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/ConfigStatus.md index c84882cd6..28fe3300a 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/ConfigStatus.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/BedrockSetup/type-aliases/ConfigStatus.md @@ -8,36 +8,26 @@ > **ConfigStatus** = `object` -Defined in: [types/cli.ts:863](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L863) - ## Properties ### hasCredentials > **hasCredentials**: `boolean` -Defined in: [types/cli.ts:864](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L864) - --- ### hasRegion > **hasRegion**: `boolean` -Defined in: [types/cli.ts:865](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L865) - --- ### hasModel > **hasModel**: `boolean` -Defined in: [types/cli.ts:866](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L866) - --- ### isReconfiguring? > `optional` **isReconfiguring?**: `boolean` - -Defined in: [types/cli.ts:867](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L867) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/BedrockClient.md b/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/BedrockClient.md index 8fa7b99b9..ef8e71b85 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/BedrockClient.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/BedrockClient.md @@ -8,16 +8,12 @@ > **BedrockClient** = `object` -Defined in: [types/providers.ts:2006](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2006) - ## Properties ### config > **config**: `object` -Defined in: [types/providers.ts:2008](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2008) - #### region? > `optional` **region?**: `string` @@ -32,8 +28,6 @@ Defined in: [types/providers.ts:2008](https://github.com/juspay/neurolink/blob/r > **send**(`command`): `Promise`\<`unknown`\> -Defined in: [types/providers.ts:2007](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2007) - #### Parameters ##### command diff --git a/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/InvokeModelCommand.md b/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/InvokeModelCommand.md index b3fbd6ad8..dc1a351f0 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/InvokeModelCommand.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/InvokeModelCommand.md @@ -8,16 +8,12 @@ > **InvokeModelCommand** = `object` -Defined in: [types/providers.ts:2015](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2015) - ## Properties ### input > **input**: `object` -Defined in: [types/providers.ts:2016](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2016) - #### modelId > **modelId**: `string` diff --git a/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/AuthMethodStatus.md b/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/AuthMethodStatus.md index 538c96b42..7b37f0100 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/AuthMethodStatus.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/AuthMethodStatus.md @@ -8,36 +8,26 @@ > **AuthMethodStatus** = `object` -Defined in: [types/cli.ts:885](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L885) - ## Properties ### hasServiceAccount > **hasServiceAccount**: `boolean` -Defined in: [types/cli.ts:886](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L886) - --- ### hasGcloudAuth > **hasGcloudAuth**: `boolean` -Defined in: [types/cli.ts:887](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L887) - --- ### hasApplicationDefault > **hasApplicationDefault**: `boolean` -Defined in: [types/cli.ts:888](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L888) - --- ### preferredMethod? > `optional` **preferredMethod?**: `"service-account"` \| `"gcloud"` \| `"adc"` - -Defined in: [types/cli.ts:889](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L889) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/GCPSetupArgv.md b/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/GCPSetupArgv.md index d38658131..9a0c386bc 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/GCPSetupArgv.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/GCPSetupArgv.md @@ -8,20 +8,14 @@ > **GCPSetupArgv** = `object` -Defined in: [types/cli.ts:880](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L880) - ## Properties ### check? > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:881](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L881) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` - -Defined in: [types/cli.ts:882](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L882) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/GCPSetupOptions.md b/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/GCPSetupOptions.md index c40bde31e..d71e0e909 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/GCPSetupOptions.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/GCPSetup/type-aliases/GCPSetupOptions.md @@ -8,20 +8,14 @@ > **GCPSetupOptions** = `object` -Defined in: [types/cli.ts:875](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L875) - ## Properties ### checkOnly? > `optional` **checkOnly?**: `boolean` -Defined in: [types/cli.ts:876](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L876) - --- ### interactive? > `optional` **interactive?**: `boolean` - -Defined in: [types/cli.ts:877](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L877) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupArgv.md b/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupArgv.md index 0fb26845c..740743cb6 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupArgv.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupArgv.md @@ -8,20 +8,14 @@ > **GoogleAISetupArgv** = `object` -Defined in: [types/cli.ts:806](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L806) - ## Properties ### check? > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:807](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L807) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` - -Defined in: [types/cli.ts:808](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L808) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupConfig.md b/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupConfig.md index 2d0f74942..add38b1cf 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupConfig.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupConfig.md @@ -8,28 +8,20 @@ > **GoogleAISetupConfig** = `object` -Defined in: [types/cli.ts:811](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L811) - ## Properties ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/cli.ts:812](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L812) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/cli.ts:813](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L813) - --- ### isReconfiguring? > `optional` **isReconfiguring?**: `boolean` - -Defined in: [types/cli.ts:814](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L814) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupOptions.md b/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupOptions.md index 78538a514..83db3219f 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupOptions.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/GoogleAISetup/type-aliases/GoogleAISetupOptions.md @@ -8,20 +8,14 @@ > **GoogleAISetupOptions** = `object` -Defined in: [types/cli.ts:801](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L801) - ## Properties ### checkOnly? > `optional` **checkOnly?**: `boolean` -Defined in: [types/cli.ts:802](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L802) - --- ### interactive? > `optional` **interactive?**: `boolean` - -Defined in: [types/cli.ts:803](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L803) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/HuggingFaceSetup/type-aliases/HuggingFaceSetupArgs.md b/docs/api/NeuroLink-API-Reference/namespaces/HuggingFaceSetup/type-aliases/HuggingFaceSetupArgs.md index 6bca37d5e..da45cf2ac 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/HuggingFaceSetup/type-aliases/HuggingFaceSetupArgs.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/HuggingFaceSetup/type-aliases/HuggingFaceSetupArgs.md @@ -8,28 +8,20 @@ > **HuggingFaceSetupArgs** = `object` -Defined in: [types/cli.ts:897](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L897) - ## Properties ### check? > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:898](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L898) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` -Defined in: [types/cli.ts:899](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L899) - --- ### help? > `optional` **help?**: `boolean` - -Defined in: [types/cli.ts:900](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L900) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/MistralSetup/type-aliases/MistralSetupArgs.md b/docs/api/NeuroLink-API-Reference/namespaces/MistralSetup/type-aliases/MistralSetupArgs.md index 9b84b7ae6..a06c95e4f 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/MistralSetup/type-aliases/MistralSetupArgs.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/MistralSetup/type-aliases/MistralSetupArgs.md @@ -8,28 +8,20 @@ > **MistralSetupArgs** = `object` -Defined in: [types/cli.ts:908](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L908) - ## Properties ### check? > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:909](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L909) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` -Defined in: [types/cli.ts:910](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L910) - --- ### help? > `optional` **help?**: `boolean` - -Defined in: [types/cli.ts:911](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L911) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/MistralTypes/type-aliases/MistralClient.md b/docs/api/NeuroLink-API-Reference/namespaces/MistralTypes/type-aliases/MistralClient.md index c34400b49..d0147c1fd 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/MistralTypes/type-aliases/MistralClient.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/MistralTypes/type-aliases/MistralClient.md @@ -8,16 +8,12 @@ > **MistralClient** = `object` -Defined in: [types/providers.ts:2029](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2029) - ## Properties ### chat? > `optional` **chat?**: `object` -Defined in: [types/providers.ts:2030](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2030) - #### complete? > `optional` **complete?**: (`options`) => `Promise`\<`unknown`\> diff --git a/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupArgv.md b/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupArgv.md index 45cbbd192..160f4fd67 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupArgv.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupArgv.md @@ -8,20 +8,14 @@ > **OpenAISetupArgv** = `object` -Defined in: [types/cli.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L763) - ## Properties ### check? > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:764](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L764) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` - -Defined in: [types/cli.ts:765](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L765) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupConfig.md b/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupConfig.md index e59bf15e4..069da7dea 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupConfig.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupConfig.md @@ -8,36 +8,26 @@ > **OpenAISetupConfig** = `object` -Defined in: [types/cli.ts:768](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L768) - ## Properties ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/cli.ts:769](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L769) - --- ### organization? > `optional` **organization?**: `string` -Defined in: [types/cli.ts:770](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L770) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/cli.ts:771](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L771) - --- ### isReconfiguring? > `optional` **isReconfiguring?**: `boolean` - -Defined in: [types/cli.ts:772](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L772) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupOptions.md b/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupOptions.md index e9dc852f7..01d826d48 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupOptions.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/OpenAISetup/type-aliases/OpenAISetupOptions.md @@ -8,20 +8,14 @@ > **OpenAISetupOptions** = `object` -Defined in: [types/cli.ts:758](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L758) - ## Properties ### checkOnly? > `optional` **checkOnly?**: `boolean` -Defined in: [types/cli.ts:759](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L759) - --- ### interactive? > `optional` **interactive?**: `boolean` - -Defined in: [types/cli.ts:760](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L760) diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Counter.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Counter.md index feffe5444..6d60dbcc0 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Counter.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Counter.md @@ -8,16 +8,12 @@ > **Counter** = `object` -Defined in: [types/providers.ts:2050](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2050) - ## Methods ### add() > **add**(`value`, `attributes?`): `void` -Defined in: [types/providers.ts:2051](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2051) - #### Parameters ##### value diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Histogram.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Histogram.md index 2518bb56f..ecc189b42 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Histogram.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Histogram.md @@ -8,16 +8,12 @@ > **Histogram** = `object` -Defined in: [types/providers.ts:2054](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2054) - ## Methods ### record() > **record**(`value`, `attributes?`): `void` -Defined in: [types/providers.ts:2055](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2055) - #### Parameters ##### value diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Meter.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Meter.md index fc0abf50d..40243c60b 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Meter.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Meter.md @@ -8,16 +8,12 @@ > **Meter** = `object` -Defined in: [types/providers.ts:2041](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2041) - ## Methods ### createCounter() > **createCounter**(`name`, `options?`): [`Counter`](Counter.md) -Defined in: [types/providers.ts:2042](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2042) - #### Parameters ##### name @@ -38,8 +34,6 @@ Defined in: [types/providers.ts:2042](https://github.com/juspay/neurolink/blob/r > **createHistogram**(`name`, `options?`): [`Histogram`](Histogram.md) -Defined in: [types/providers.ts:2043](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2043) - #### Parameters ##### name diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Span.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Span.md index 301dd6be6..228b2b3cb 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Span.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Span.md @@ -8,16 +8,12 @@ > **Span** = `object` -Defined in: [types/providers.ts:2058](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2058) - ## Methods ### end() > **end**(): `void` -Defined in: [types/providers.ts:2059](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2059) - #### Returns `void` @@ -28,8 +24,6 @@ Defined in: [types/providers.ts:2059](https://github.com/juspay/neurolink/blob/r > **setStatus**(`status`): `void` -Defined in: [types/providers.ts:2060](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2060) - #### Parameters ##### status @@ -46,8 +40,6 @@ Defined in: [types/providers.ts:2060](https://github.com/juspay/neurolink/blob/r > **recordException**(`exception`): `void` -Defined in: [types/providers.ts:2061](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2061) - #### Parameters ##### exception diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Tracer.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Tracer.md index 9974c2879..13dcc911d 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Tracer.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Tracer.md @@ -8,16 +8,12 @@ > **Tracer** = `object` -Defined in: [types/providers.ts:2046](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2046) - ## Methods ### startSpan() > **startSpan**(`name`, `options?`): [`Span`](Span.md) -Defined in: [types/providers.ts:2047](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2047) - #### Parameters ##### name diff --git a/docs/api/classes/AIProviderFactory.md b/docs/api/classes/AIProviderFactory.md index 6934a93f6..b0e241797 100644 --- a/docs/api/classes/AIProviderFactory.md +++ b/docs/api/classes/AIProviderFactory.md @@ -6,8 +6,6 @@ # Class: AIProviderFactory -Defined in: [core/factory.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/core/factory.ts#L25) - Factory for creating AI provider instances with centralized configuration ## Constructors @@ -26,8 +24,6 @@ Factory for creating AI provider instances with centralized configuration > `static` **createProvider**(`providerName`, `modelName?`, `enableMCP?`, `sdk?`, `region?`, `credentials?`): `Promise`\<[`AIProvider`](../type-aliases/AIProvider.md)\> -Defined in: [core/factory.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/core/factory.ts#L297) - Create a provider instance for the specified provider type #### Parameters @@ -78,8 +74,6 @@ AIProvider instance > `static` **createProviderWithModel**(`provider`, `model`): `Promise`\<[`AIProvider`](../type-aliases/AIProvider.md)\> -Defined in: [core/factory.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/core/factory.ts#L423) - Create a provider instance with specific provider enum and model #### Parameters @@ -108,8 +102,6 @@ AIProvider instance > `static` **createBestProvider**(`requestedProvider?`, `modelName?`, `enableMCP?`, `sdk?`): `Promise`\<[`AIProvider`](../type-aliases/AIProvider.md)\> -Defined in: [core/factory.ts:465](https://github.com/juspay/neurolink/blob/release/src/lib/core/factory.ts#L465) - Create the best available provider automatically #### Parameters @@ -148,8 +140,6 @@ AIProvider instance > `static` **createProviderWithFallback**(`primaryProvider`, `fallbackProvider`, `modelName?`, `enableMCP?`): `Promise`\<[`ProviderPairResult`](../type-aliases/ProviderPairResult.md)\<[`AIProvider`](../type-aliases/AIProvider.md)\>\> -Defined in: [core/factory.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/core/factory.ts#L505) - Create primary and fallback provider instances #### Parameters diff --git a/docs/api/classes/AbortError.md b/docs/api/classes/AbortError.md index e2be0fc78..ca2cb890b 100644 --- a/docs/api/classes/AbortError.md +++ b/docs/api/classes/AbortError.md @@ -6,8 +6,6 @@ # Class: AbortError -Defined in: [client/errors.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L414) - Error for request cancellation ## Extends @@ -20,8 +18,6 @@ Error for request cancellation > **new AbortError**(`message?`, `options?`): `AbortError` -Defined in: [client/errors.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L415) - #### Parameters ##### message? @@ -48,8 +44,6 @@ Defined in: [client/errors.ts:415](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -62,8 +56,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -76,8 +68,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -90,8 +80,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -104,8 +92,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -118,8 +104,6 @@ Request ID for error tracking > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -136,8 +120,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/Agent.md b/docs/api/classes/Agent.md index 9d47b40a6..950be70dc 100644 --- a/docs/api/classes/Agent.md +++ b/docs/api/classes/Agent.md @@ -6,8 +6,6 @@ # Class: Agent -Defined in: [agent/agent.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L49) - Agent - Wraps a NeuroLink instance with specialized behavior Features: @@ -45,8 +43,6 @@ const result = await agent.execute("Find information about quantum computing"); > **new Agent**(`definition`, `neurolink`): `Agent` -Defined in: [agent/agent.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L70) - #### Parameters ##### definition @@ -67,8 +63,6 @@ Defined in: [agent/agent.ts:70](https://github.com/juspay/neurolink/blob/release > `readonly` **id**: `string` -Defined in: [agent/agent.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L50) - Agent ID #### Implementation of @@ -81,8 +75,6 @@ Agent ID > `readonly` **name**: `string` -Defined in: [agent/agent.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L51) - Agent name #### Implementation of @@ -95,8 +87,6 @@ Agent name > `readonly` **description**: `string` -Defined in: [agent/agent.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L52) - Agent description #### Implementation of @@ -109,8 +99,6 @@ Agent description > `readonly` **instructions**: `string` -Defined in: [agent/agent.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L53) - Agent instructions #### Implementation of @@ -123,80 +111,60 @@ Agent instructions > `readonly` `optional` **provider?**: `string` -Defined in: [agent/agent.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L54) - --- ### model? > `readonly` `optional` **model?**: `string` -Defined in: [agent/agent.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L55) - --- ### tools? > `readonly` `optional` **tools?**: `string`[] -Defined in: [agent/agent.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L56) - --- ### inputSchema? > `readonly` `optional` **inputSchema?**: `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> -Defined in: [agent/agent.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L57) - --- ### outputSchema? > `readonly` `optional` **outputSchema?**: `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> -Defined in: [agent/agent.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L58) - --- ### maxSteps > `readonly` **maxSteps**: `number` -Defined in: [agent/agent.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L59) - --- ### temperature > `readonly` **temperature**: `number` -Defined in: [agent/agent.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L60) - --- ### canDelegate > `readonly` **canDelegate**: `boolean` -Defined in: [agent/agent.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L61) - --- ### metadata? > `readonly` `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [agent/agent.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L62) - ## Methods ### execute() > **execute**(`input`, `options?`): `Promise`\<[`AgentResult`](../type-aliases/AgentResult.md)\> -Defined in: [agent/agent.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L131) - Execute the agent with given input #### Parameters @@ -229,8 +197,6 @@ Agent result with content and metadata > **stream**(`input`, `options?`): `AsyncIterable`\<[`AgentStreamChunk`](../type-aliases/AgentStreamChunk.md)\> -Defined in: [agent/agent.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L269) - Stream execution results #### Parameters @@ -265,8 +231,6 @@ Agent stream chunks > **getStatus**(): [`AgentStatus`](../type-aliases/AgentStatus.md) -Defined in: [agent/agent.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L409) - Get agent status #### Returns @@ -283,8 +247,6 @@ Get agent status > **getAverageExecutionTime**(): `number` -Defined in: [agent/agent.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L422) - Get average execution time #### Returns @@ -297,8 +259,6 @@ Get average execution time > **on**(`event`, `handler`): `void` -Defined in: [agent/agent.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L432) - Subscribe to agent events #### Parameters @@ -321,8 +281,6 @@ Subscribe to agent events > **off**(`event`, `handler`): `void` -Defined in: [agent/agent.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agent.ts#L439) - Unsubscribe from agent events #### Parameters diff --git a/docs/api/classes/AgentCoordinator.md b/docs/api/classes/AgentCoordinator.md index 6362b6102..37dddd857 100644 --- a/docs/api/classes/AgentCoordinator.md +++ b/docs/api/classes/AgentCoordinator.md @@ -6,8 +6,6 @@ # Class: AgentCoordinator -Defined in: [agent/coordination/coordinator.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L30) - Agent Coordinator - Orchestrates multi-agent execution ## Constructors @@ -16,8 +14,6 @@ Agent Coordinator - Orchestrates multi-agent execution > **new AgentCoordinator**(`config?`): `AgentCoordinator` -Defined in: [agent/coordination/coordinator.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L38) - #### Parameters ##### config? @@ -34,8 +30,6 @@ Defined in: [agent/coordination/coordinator.ts:38](https://github.com/juspay/neu > **registerAgent**(`agent`): `void` -Defined in: [agent/coordination/coordinator.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L57) - Register an agent with the coordinator #### Parameters @@ -54,8 +48,6 @@ Register an agent with the coordinator > **unregisterAgent**(`agentId`): `void` -Defined in: [agent/coordination/coordinator.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L65) - Unregister an agent #### Parameters @@ -74,8 +66,6 @@ Unregister an agent > **getAgents**(): [`Agent`](Agent.md)[] -Defined in: [agent/coordination/coordinator.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L72) - Get all registered agents #### Returns @@ -88,8 +78,6 @@ Get all registered agents > **getAgentStatus**(`agentId`): [`AgentStatus`](../type-aliases/AgentStatus.md) \| `undefined` -Defined in: [agent/coordination/coordinator.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L79) - Get agent status #### Parameters @@ -108,8 +96,6 @@ Get agent status > **coordinate**(`task`, `options?`): `Promise`\<[`CoordinationResult`](../type-aliases/CoordinationResult.md)\> -Defined in: [agent/coordination/coordinator.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L87) - Execute a coordinated task across agents #### Parameters @@ -132,8 +118,6 @@ Execute a coordinated task across agents > **executeWithDependencies**(`assignments`): `Promise`\<[`CoordinationResult`](../type-aliases/CoordinationResult.md)\> -Defined in: [agent/coordination/coordinator.ts:554](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L554) - Execute multiple task assignments with dependencies #### Parameters @@ -152,8 +136,6 @@ Execute multiple task assignments with dependencies > **updateConfig**(`config`): `void` -Defined in: [agent/coordination/coordinator.ts:711](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L711) - Update coordinator configuration #### Parameters @@ -172,8 +154,6 @@ Update coordinator configuration > **on**(`event`, `handler`): `void` -Defined in: [agent/coordination/coordinator.ts:718](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L718) - Subscribe to coordinator events #### Parameters @@ -196,8 +176,6 @@ Subscribe to coordinator events > **off**(`event`, `handler`): `void` -Defined in: [agent/coordination/coordinator.ts:725](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/coordinator.ts#L725) - Unsubscribe from coordinator events #### Parameters diff --git a/docs/api/classes/AgentExposureManager.md b/docs/api/classes/AgentExposureManager.md index 0f00c7ddc..1b5d9e4ac 100644 --- a/docs/api/classes/AgentExposureManager.md +++ b/docs/api/classes/AgentExposureManager.md @@ -6,8 +6,6 @@ # Class: AgentExposureManager -Defined in: [mcp/agentExposure.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L387) - Agent Exposure Manager Manages the lifecycle of exposed agents and workflows, @@ -19,8 +17,6 @@ providing registration, lookup, and invocation capabilities. > **new AgentExposureManager**(`options?`): `AgentExposureManager` -Defined in: [mcp/agentExposure.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L391) - #### Parameters ##### options? @@ -37,8 +33,6 @@ Defined in: [mcp/agentExposure.ts:391](https://github.com/juspay/neurolink/blob/ > **exposeAgent**(`agent`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) -Defined in: [mcp/agentExposure.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L398) - Expose an agent and register it #### Parameters @@ -57,8 +51,6 @@ Expose an agent and register it > **exposeWorkflow**(`workflow`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) -Defined in: [mcp/agentExposure.ts:407](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L407) - Expose a workflow and register it #### Parameters @@ -77,8 +69,6 @@ Expose a workflow and register it > **getExposedTools**(): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/agentExposure.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L416) - Get all exposed tools #### Returns @@ -91,8 +81,6 @@ Get all exposed tools > **getExposedTool**(`toolName`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) \| `undefined` -Defined in: [mcp/agentExposure.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L423) - Get exposed tool by name #### Parameters @@ -111,8 +99,6 @@ Get exposed tool by name > **getExposureResult**(`toolName`): [`ExposureResult`](../type-aliases/ExposureResult.md) \| `undefined` -Defined in: [mcp/agentExposure.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L430) - Get exposure result by tool name #### Parameters @@ -131,8 +117,6 @@ Get exposure result by tool name > **getToolsBySourceType**(`sourceType`): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/agentExposure.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L437) - Get tools by source type #### Parameters @@ -151,8 +135,6 @@ Get tools by source type > **unexpose**(`toolName`): `boolean` -Defined in: [mcp/agentExposure.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L446) - Remove exposed tool #### Parameters @@ -171,8 +153,6 @@ Remove exposed tool > **clear**(): `void` -Defined in: [mcp/agentExposure.ts:453](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L453) - Clear all exposed tools #### Returns @@ -185,8 +165,6 @@ Clear all exposed tools > **getStatistics**(): `object` -Defined in: [mcp/agentExposure.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L460) - Get statistics #### Returns diff --git a/docs/api/classes/AgentNetwork.md b/docs/api/classes/AgentNetwork.md index 5d01e643e..70e911d6d 100644 --- a/docs/api/classes/AgentNetwork.md +++ b/docs/api/classes/AgentNetwork.md @@ -6,8 +6,6 @@ # Class: AgentNetwork -Defined in: [agent/agentNetwork.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L65) - AgentNetwork - Multi-agent orchestration using the ai SDK tool loop Each agent in the network is registered as an ai SDK `tool()`. A single @@ -36,8 +34,6 @@ const result = await network.execute({ > **new AgentNetwork**(`config`, `neurolink`): `AgentNetwork` -Defined in: [agent/agentNetwork.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L81) - #### Parameters ##### config @@ -58,32 +54,24 @@ Defined in: [agent/agentNetwork.ts:81](https://github.com/juspay/neurolink/blob/ > `readonly` **id**: `string` -Defined in: [agent/agentNetwork.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L66) - --- ### name > `readonly` **name**: `string` -Defined in: [agent/agentNetwork.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L67) - --- ### description? > `readonly` `optional` **description?**: `string` -Defined in: [agent/agentNetwork.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L68) - ## Methods ### execute() > **execute**(`input`, `options?`): `Promise`\<[`NetworkExecutionResult`](../type-aliases/NetworkExecutionResult.md)\> -Defined in: [agent/agentNetwork.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L378) - Execute the network with intelligent routing via the ai SDK tool loop. A single `neurolink.generate()` call is issued. The model decides which @@ -110,8 +98,6 @@ agent tool(s) to call; the SDK executes them and loops until `stop` or > **stream**(`input`, `options?`): `AsyncIterable`\<[`NetworkStreamChunk`](../type-aliases/NetworkStreamChunk.md)\> -Defined in: [agent/agentNetwork.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L467) - Stream network execution using the ai SDK tool loop. Calls `neurolink.stream()` with agent tools. Text chunks, tool calls, and @@ -137,8 +123,6 @@ tool results are forwarded as typed NetworkStreamChunk events. > **getAgent**(`id`): [`Agent`](Agent.md) \| `undefined` -Defined in: [agent/agentNetwork.ts:597](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L597) - #### Parameters ##### id @@ -155,8 +139,6 @@ Defined in: [agent/agentNetwork.ts:597](https://github.com/juspay/neurolink/blob > **getAllAgents**(): [`Agent`](Agent.md)[] -Defined in: [agent/agentNetwork.ts:601](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L601) - #### Returns [`Agent`](Agent.md)[] @@ -167,8 +149,6 @@ Defined in: [agent/agentNetwork.ts:601](https://github.com/juspay/neurolink/blob > **getAllPrimitives**(): [`Primitive`](../type-aliases/Primitive.md)[] -Defined in: [agent/agentNetwork.ts:605](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L605) - #### Returns [`Primitive`](../type-aliases/Primitive.md)[] @@ -179,8 +159,6 @@ Defined in: [agent/agentNetwork.ts:605](https://github.com/juspay/neurolink/blob > **on**(`event`, `handler`): `void` -Defined in: [agent/agentNetwork.ts:609](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L609) - #### Parameters ##### event @@ -201,8 +179,6 @@ Defined in: [agent/agentNetwork.ts:609](https://github.com/juspay/neurolink/blob > **off**(`event`, `handler`): `void` -Defined in: [agent/agentNetwork.ts:613](https://github.com/juspay/neurolink/blob/release/src/lib/agent/agentNetwork.ts#L613) - #### Parameters ##### event diff --git a/docs/api/classes/AlreadyRunningError.md b/docs/api/classes/AlreadyRunningError.md index 13f748d55..12e6cac6f 100644 --- a/docs/api/classes/AlreadyRunningError.md +++ b/docs/api/classes/AlreadyRunningError.md @@ -6,8 +6,6 @@ # Class: AlreadyRunningError -Defined in: [server/errors.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L416) - Already running error ## Extends @@ -20,8 +18,6 @@ Already running error > **new AlreadyRunningError**(`port?`, `host?`): `AlreadyRunningError` -Defined in: [server/errors.ts:417](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L417) - #### Parameters ##### port? @@ -46,8 +42,6 @@ Defined in: [server/errors.ts:417](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -58,8 +52,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -70,8 +62,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -82,8 +72,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -94,8 +82,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -106,8 +92,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -118,8 +102,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -130,8 +112,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -142,8 +122,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -154,8 +132,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -166,8 +142,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -184,8 +158,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/AlwaysSampler.md b/docs/api/classes/AlwaysSampler.md index 0adb93bd8..445459540 100644 --- a/docs/api/classes/AlwaysSampler.md +++ b/docs/api/classes/AlwaysSampler.md @@ -6,8 +6,6 @@ # Class: AlwaysSampler -Defined in: [observability/sampling/samplers.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/observability/sampling/samplers.ts#L18) - Always sample all spans ## Implements @@ -30,8 +28,6 @@ Always sample all spans > `readonly` **name**: `"always"` = `"always"` -Defined in: [observability/sampling/samplers.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/observability/sampling/samplers.ts#L19) - Sampler name for identification #### Implementation of @@ -44,8 +40,6 @@ Sampler name for identification > **shouldSample**(`_span`): `boolean` -Defined in: [observability/sampling/samplers.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/observability/sampling/samplers.ts#L21) - Determine if a span should be sampled #### Parameters @@ -68,8 +62,6 @@ Determine if a span should be sampled > **getDescription**(): `string` -Defined in: [observability/sampling/samplers.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/observability/sampling/samplers.ts#L25) - Get sampling decision description #### Returns diff --git a/docs/api/classes/AnswerRelevancyScorer.md b/docs/api/classes/AnswerRelevancyScorer.md index 145cfee7b..6f1edd560 100644 --- a/docs/api/classes/AnswerRelevancyScorer.md +++ b/docs/api/classes/AnswerRelevancyScorer.md @@ -6,8 +6,6 @@ # Class: AnswerRelevancyScorer -Defined in: [evaluation/scorers/llm/answerRelevancyScorer.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/answerRelevancyScorer.ts#L45) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new AnswerRelevancyScorer**(`config?`): `AnswerRelevancyScorer` -Defined in: [evaluation/scorers/llm/answerRelevancyScorer.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/answerRelevancyScorer.ts#L46) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/answerRelevancyScorer.ts:46](https://github. > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/answerRelevancyScorer.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/answerRelevancyScorer.ts#L70) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -506,8 +466,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/answerRelevancyScorer.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/answerRelevancyScorer.ts#L90) - Parse LLM response into score result - must be implemented by subclasses #### Parameters @@ -534,8 +492,6 @@ Parse LLM response into score result - must be implemented by subclasses > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -558,8 +514,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -576,8 +530,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -600,8 +552,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -625,8 +575,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -653,8 +601,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -681,8 +627,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -706,8 +650,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters diff --git a/docs/api/classes/AuthContextHolder.md b/docs/api/classes/AuthContextHolder.md index c39c97908..15bc9f95a 100644 --- a/docs/api/classes/AuthContextHolder.md +++ b/docs/api/classes/AuthContextHolder.md @@ -6,8 +6,6 @@ # Class: AuthContextHolder -Defined in: [auth/authContext.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L286) - Context holder for non-async-local-storage environments Use this when async local storage is not available. @@ -28,8 +26,6 @@ Use this when async local storage is not available. > **set**(`context`): `void` -Defined in: [auth/authContext.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L292) - Set the auth context #### Parameters @@ -48,8 +44,6 @@ Set the auth context > **get**(): [`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md) \| `undefined` -Defined in: [auth/authContext.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L299) - Get the auth context #### Returns @@ -62,8 +56,6 @@ Get the auth context > **clear**(): `void` -Defined in: [auth/authContext.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L306) - Clear the auth context #### Returns @@ -76,8 +68,6 @@ Clear the auth context > **getUser**(): [`AuthUser`](../type-aliases/AuthUser.md) \| `undefined` -Defined in: [auth/authContext.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L313) - Get the current user #### Returns @@ -90,8 +80,6 @@ Get the current user > **getSession**(): [`AuthSession`](../type-aliases/AuthSession.md) \| `undefined` -Defined in: [auth/authContext.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L320) - Get the current session #### Returns @@ -104,8 +92,6 @@ Get the current session > **isAuthenticated**(): `boolean` -Defined in: [auth/authContext.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L327) - Check if authenticated #### Returns @@ -118,8 +104,6 @@ Check if authenticated > **hasPermission**(`permission`): `boolean` -Defined in: [auth/authContext.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L334) - Check if user has permission #### Parameters @@ -138,8 +122,6 @@ Check if user has permission > **hasRole**(`role`): `boolean` -Defined in: [auth/authContext.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L362) - Check if user has role #### Parameters diff --git a/docs/api/classes/AuthProviderFactory.md b/docs/api/classes/AuthProviderFactory.md index 983389662..82f23ec21 100644 --- a/docs/api/classes/AuthProviderFactory.md +++ b/docs/api/classes/AuthProviderFactory.md @@ -6,8 +6,6 @@ # Class: AuthProviderFactory -Defined in: [auth/AuthProviderFactory.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L40) - AuthProviderFactory - Creates authentication provider instances Pure static factory with no hardcoded imports. All providers are @@ -41,8 +39,6 @@ const provider = await AuthProviderFactory.createProvider("auth0", { > `static` **registerProvider**(`type`, `factory`, `aliases?`, `metadata?`): `void` -Defined in: [auth/AuthProviderFactory.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L50) - Register a provider with the factory #### Parameters @@ -73,8 +69,6 @@ Register a provider with the factory > `static` **createProvider**(`typeOrAlias`, `config`): `Promise`\<[`AuthProvider`](../type-aliases/AuthProvider.md)\> -Defined in: [auth/AuthProviderFactory.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L68) - Create a provider instance #### Parameters @@ -97,8 +91,6 @@ Create a provider instance > `static` **hasProvider**(`typeOrAlias`): `boolean` -Defined in: [auth/AuthProviderFactory.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L96) - Check if a provider is registered #### Parameters @@ -117,8 +109,6 @@ Check if a provider is registered > `static` **getAvailableProviders**(): `string`[] -Defined in: [auth/AuthProviderFactory.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L106) - Get list of available provider types (excludes aliases) #### Returns @@ -131,8 +121,6 @@ Get list of available provider types (excludes aliases) > `static` **getProviderMetadata**(`typeOrAlias`): [`AuthProviderMetadata`](../type-aliases/AuthProviderMetadata.md) \| `undefined` -Defined in: [auth/AuthProviderFactory.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L113) - Get provider metadata #### Parameters @@ -151,8 +139,6 @@ Get provider metadata > `static` **getAllProviderInfo**(): `object`[] -Defined in: [auth/AuthProviderFactory.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L123) - Get all registered providers with their metadata #### Returns @@ -165,8 +151,6 @@ Get all registered providers with their metadata > `static` **clearRegistrations**(): `void` -Defined in: [auth/AuthProviderFactory.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L140) - Clear all registrations (for testing) #### Returns diff --git a/docs/api/classes/AuthProviderRegistry.md b/docs/api/classes/AuthProviderRegistry.md index 1cee81d9d..d2bb2e252 100644 --- a/docs/api/classes/AuthProviderRegistry.md +++ b/docs/api/classes/AuthProviderRegistry.md @@ -6,8 +6,6 @@ # Class: AuthProviderRegistry -Defined in: [auth/AuthProviderRegistry.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderRegistry.ts#L44) - AuthProviderRegistry - registers all auth providers with the factory Call `AuthProviderRegistry.registerAllProviders()` once during @@ -29,8 +27,6 @@ application startup. The method is idempotent and concurrency-safe. > `static` **registerAllProviders**(): `Promise`\<`void`\> -Defined in: [auth/AuthProviderRegistry.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderRegistry.ts#L51) - Register all auth providers with the factory #### Returns @@ -43,8 +39,6 @@ Register all auth providers with the factory > `static` **isRegistered**(): `boolean` -Defined in: [auth/AuthProviderRegistry.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderRegistry.ts#L274) - Check if providers are registered #### Returns @@ -57,8 +51,6 @@ Check if providers are registered > `static` **clearRegistrations**(): `void` -Defined in: [auth/AuthProviderRegistry.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderRegistry.ts#L281) - Clear registrations (for testing) #### Returns diff --git a/docs/api/classes/AuthenticationError.md b/docs/api/classes/AuthenticationError.md index f2e932b10..ad6a9acaf 100644 --- a/docs/api/classes/AuthenticationError.md +++ b/docs/api/classes/AuthenticationError.md @@ -6,8 +6,6 @@ # Class: AuthenticationError -Defined in: [types/errors.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L33) - Thrown for authentication-related errors, such as invalid or missing API keys. ## Extends @@ -20,8 +18,6 @@ Thrown for authentication-related errors, such as invalid or missing API keys. > **new AuthenticationError**(`message`, `provider?`): `AuthenticationError` -Defined in: [types/errors.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L34) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [types/errors.ts:34](https://github.com/juspay/neurolink/blob/releas > `optional` **provider?**: `string` -Defined in: [types/errors.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L18) - #### Inherited from [`ProviderError`](ProviderError.md).[`provider`](ProviderError.md#provider) diff --git a/docs/api/classes/AuthorizationError.md b/docs/api/classes/AuthorizationError.md index f3019609b..fa6c66fe7 100644 --- a/docs/api/classes/AuthorizationError.md +++ b/docs/api/classes/AuthorizationError.md @@ -6,8 +6,6 @@ # Class: AuthorizationError -Defined in: [types/errors.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L42) - Thrown for authorization errors, where the user does not have permission. ## Extends @@ -20,8 +18,6 @@ Thrown for authorization errors, where the user does not have permission. > **new AuthorizationError**(`message`, `provider?`): `AuthorizationError` -Defined in: [types/errors.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L43) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [types/errors.ts:43](https://github.com/juspay/neurolink/blob/releas > `optional` **provider?**: `string` -Defined in: [types/errors.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L18) - #### Inherited from [`ProviderError`](ProviderError.md).[`provider`](ProviderError.md#provider) diff --git a/docs/api/classes/AvatarError.md b/docs/api/classes/AvatarError.md index 1ccd49b82..dcfdf515a 100644 --- a/docs/api/classes/AvatarError.md +++ b/docs/api/classes/AvatarError.md @@ -6,8 +6,6 @@ # Class: AvatarError -Defined in: [utils/avatarProcessor.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L46) - Typed error class for avatar-generation failures. ## Extends @@ -20,8 +18,6 @@ Typed error class for avatar-generation failures. > **new AvatarError**(`options`): `AvatarError` -Defined in: [utils/avatarProcessor.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L47) - #### Parameters ##### options @@ -68,8 +64,6 @@ Defined in: [utils/avatarProcessor.ts:47](https://github.com/juspay/neurolink/bl > `readonly` **code**: `string` -Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L105) - #### Inherited from `NeuroLinkError.code` @@ -80,8 +74,6 @@ Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blo > `readonly` **category**: `ErrorCategory` -Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L106) - #### Inherited from `NeuroLinkError.category` @@ -92,8 +84,6 @@ Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blo > `readonly` **severity**: `ErrorSeverity` -Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L107) - #### Inherited from `NeuroLinkError.severity` @@ -104,8 +94,6 @@ Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blo > `readonly` **retriable**: `boolean` -Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L108) - #### Inherited from `NeuroLinkError.retriable` @@ -116,8 +104,6 @@ Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blo > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L109) - #### Inherited from `NeuroLinkError.retryAfterMs` @@ -128,8 +114,6 @@ Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blo > `readonly` **context**: `Record`\<`string`, `unknown`\> -Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L110) - #### Inherited from `NeuroLinkError.context` @@ -140,8 +124,6 @@ Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blo > `readonly` **timestamp**: `Date` -Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L111) - #### Inherited from `NeuroLinkError.timestamp` @@ -152,8 +134,6 @@ Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blo > `readonly` `optional` **toolName?**: `string` -Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L112) - #### Inherited from `NeuroLinkError.toolName` @@ -164,8 +144,6 @@ Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blo > `readonly` `optional` **serverId?**: `string` -Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L113) - #### Inherited from `NeuroLinkError.serverId` @@ -176,8 +154,6 @@ Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blo > **toJSON**(): [`StructuredError`](../type-aliases/StructuredError.md) -Defined in: [utils/errorHandling.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L149) - Convert to JSON for logging and serialization #### Returns diff --git a/docs/api/classes/AvatarProcessor.md b/docs/api/classes/AvatarProcessor.md index 775e88748..dfeedc97e 100644 --- a/docs/api/classes/AvatarProcessor.md +++ b/docs/api/classes/AvatarProcessor.md @@ -6,8 +6,6 @@ # Class: AvatarProcessor -Defined in: [utils/avatarProcessor.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L72) - Static processor managing the avatar handler registry. ## Constructors @@ -26,8 +24,6 @@ Static processor managing the avatar handler registry. > `static` **registerHandler**(`providerName`, `handler`): `void` -Defined in: [utils/avatarProcessor.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L80) - Register an avatar handler for a specific provider. #### Parameters @@ -50,8 +46,6 @@ Register an avatar handler for a specific provider. > `static` **supports**(`providerName`): `boolean` -Defined in: [utils/avatarProcessor.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L89) - Check if a provider has a registered avatar handler. #### Parameters @@ -70,8 +64,6 @@ Check if a provider has a registered avatar handler. > `static` **listProviders**(): `string`[] -Defined in: [utils/avatarProcessor.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L96) - List the names of all registered providers. #### Returns @@ -84,8 +76,6 @@ List the names of all registered providers. > `static` **getHandler**(`providerName`): [`AvatarHandler`](../type-aliases/AvatarHandler.md) \| `undefined` -Defined in: [utils/avatarProcessor.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L106) - Get a registered avatar handler by provider name. Exposed publicly so module-level auto-registration code can reuse an @@ -107,8 +97,6 @@ already-registered primary handler when backfilling its aliases. > `static` **clearHandlers**(): `void` -Defined in: [utils/avatarProcessor.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L113) - Clear all registered handlers (for testing). #### Returns @@ -121,8 +109,6 @@ Clear all registered handlers (for testing). > `static` **generate**(`provider`, `options`): `Promise`\<[`AvatarResult`](../type-aliases/AvatarResult.md)\> -Defined in: [utils/avatarProcessor.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/utils/avatarProcessor.ts#L137) - Generate an avatar video via the registered handler. #### Parameters diff --git a/docs/api/classes/AzureSTT.md b/docs/api/classes/AzureSTT.md index f82ac9397..73ab92a3a 100644 --- a/docs/api/classes/AzureSTT.md +++ b/docs/api/classes/AzureSTT.md @@ -6,8 +6,6 @@ # Class: AzureSTT -Defined in: [voice/providers/AzureSTT.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L29) - Azure Cognitive Services Speech-to-Text Handler Supports speech recognition with custom models and detailed output. @@ -26,8 +24,6 @@ https://docs.microsoft.com/azure/cognitive-services/speech-service/ > **new AzureSTT**(`apiKey?`, `region?`): `AzureSTT` -Defined in: [voice/providers/AzureSTT.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L46) - #### Parameters ##### apiKey? @@ -48,8 +44,6 @@ Defined in: [voice/providers/AzureSTT.ts:46](https://github.com/juspay/neurolink > `readonly` **maxAudioDuration**: `60` = `60` -Defined in: [voice/providers/AzureSTT.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L39) - Maximum audio duration in seconds (60s — Azure's REST API for short audio documented limit on `/speech/recognition/conversation/cognitiveservices/v1`). For longer audio, use Azure Batch Transcription (not yet implemented) or @@ -65,8 +59,6 @@ pre-segment the input. > `readonly` **supportsStreaming**: `false` = `false` -Defined in: [voice/providers/AzureSTT.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L44) - Azure STT implementation buffers chunks via REST — not true streaming #### Implementation of @@ -79,8 +71,6 @@ Azure STT implementation buffers chunks via REST — not true streaming > **isConfigured**(): `boolean` -Defined in: [voice/providers/AzureSTT.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L57) - #### Returns `boolean` @@ -95,8 +85,6 @@ Defined in: [voice/providers/AzureSTT.ts:57](https://github.com/juspay/neurolink > **getSupportedFormats**(): [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] -Defined in: [voice/providers/AzureSTT.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L61) - #### Returns [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] @@ -111,8 +99,6 @@ Defined in: [voice/providers/AzureSTT.ts:61](https://github.com/juspay/neurolink > **getSupportedLanguages**(): `Promise`\<[`STTLanguage`](../type-aliases/STTLanguage.md)[]\> -Defined in: [voice/providers/AzureSTT.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L69) - #### Returns `Promise`\<[`STTLanguage`](../type-aliases/STTLanguage.md)[]\> @@ -127,8 +113,6 @@ Defined in: [voice/providers/AzureSTT.ts:69](https://github.com/juspay/neurolink > **transcribe**(`audio`, `options?`): `Promise`\<[`STTResult`](../type-aliases/STTResult.md)\> -Defined in: [voice/providers/AzureSTT.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L159) - #### Parameters ##### audio @@ -153,8 +137,6 @@ Defined in: [voice/providers/AzureSTT.ts:159](https://github.com/juspay/neurolin > **transcribeStream**(`audioStream`, `options`): `AsyncIterable`\<[`TranscriptionSegment`](../type-aliases/TranscriptionSegment.md)\> -Defined in: [voice/providers/AzureSTT.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureSTT.ts#L312) - Streaming transcription (placeholder - requires SDK) #### Parameters diff --git a/docs/api/classes/AzureTTS.md b/docs/api/classes/AzureTTS.md index 5c6922194..1ab3bc2f4 100644 --- a/docs/api/classes/AzureTTS.md +++ b/docs/api/classes/AzureTTS.md @@ -6,8 +6,6 @@ # Class: AzureTTS -Defined in: [voice/providers/AzureTTS.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureTTS.ts#L29) - Azure Cognitive Services Text-to-Speech Handler Supports neural voices with SSML and custom voice styles. @@ -26,8 +24,6 @@ https://docs.microsoft.com/azure/cognitive-services/speech-service/ > **new AzureTTS**(`apiKey?`, `region?`): `AzureTTS` -Defined in: [voice/providers/AzureTTS.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureTTS.ts#L40) - #### Parameters ##### apiKey? @@ -48,8 +44,6 @@ Defined in: [voice/providers/AzureTTS.ts:40](https://github.com/juspay/neurolink > `readonly` **maxTextLength**: `10000` = `10000` -Defined in: [voice/providers/AzureTTS.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureTTS.ts#L38) - Maximum text length (10000 characters for Azure) #### Implementation of @@ -62,8 +56,6 @@ Maximum text length (10000 characters for Azure) > **isConfigured**(): `boolean` -Defined in: [voice/providers/AzureTTS.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureTTS.ts#L51) - Validate that the provider is properly configured #### Returns @@ -82,8 +74,6 @@ True if provider can generate TTS > **getVoices**(`languageCode?`): `Promise`\<[`TTSVoice`](../type-aliases/TTSVoice.md)[]\> -Defined in: [voice/providers/AzureTTS.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureTTS.ts#L55) - Get available voices for the provider #### Parameters @@ -110,8 +100,6 @@ List of available voices > **synthesize**(`text`, `options?`): `Promise`\<[`TTSResult`](../type-aliases/TTSResult.md)\> -Defined in: [voice/providers/AzureTTS.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/AzureTTS.ts#L162) - Generate audio from text using provider-specific TTS API **IMPORTANT: Timeout Responsibility** diff --git a/docs/api/classes/BaseAuthProvider.md b/docs/api/classes/BaseAuthProvider.md index 9cb1bd786..dd335c521 100644 --- a/docs/api/classes/BaseAuthProvider.md +++ b/docs/api/classes/BaseAuthProvider.md @@ -6,8 +6,6 @@ # Abstract Class: BaseAuthProvider -Defined in: [auth/providers/BaseAuthProvider.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L175) - BaseAuthProvider - Abstract base class for all auth providers Subclasses must implement: @@ -31,8 +29,6 @@ Optionally override: > **new BaseAuthProvider**(`config`): `BaseAuthProvider` -Defined in: [auth/providers/BaseAuthProvider.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L184) - #### Parameters ##### config @@ -49,8 +45,6 @@ Defined in: [auth/providers/BaseAuthProvider.ts:184](https://github.com/juspay/n > `abstract` `readonly` **type**: [`AuthProviderType`](../type-aliases/AuthProviderType.md) -Defined in: [auth/providers/BaseAuthProvider.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L176) - Provider type identifier #### Implementation of @@ -63,8 +57,6 @@ Provider type identifier > `readonly` **config**: [`AuthProviderConfig`](../type-aliases/AuthProviderConfig.md) -Defined in: [auth/providers/BaseAuthProvider.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L177) - Provider configuration #### Implementation of @@ -77,40 +69,30 @@ Provider configuration > `protected` **sessionStorage**: [`SessionStorage`](../type-aliases/SessionStorage.md) -Defined in: [auth/providers/BaseAuthProvider.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L179) - --- ### sessionConfig > `protected` **sessionConfig**: [`SessionConfig`](../type-aliases/SessionConfig.md) -Defined in: [auth/providers/BaseAuthProvider.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L180) - --- ### rbacConfig > `protected` **rbacConfig**: [`RBACConfig`](../type-aliases/RBACConfig.md) -Defined in: [auth/providers/BaseAuthProvider.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L181) - --- ### emitter > `protected` **emitter**: `EventEmitter`\<`DefaultEventMap`\> -Defined in: [auth/providers/BaseAuthProvider.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L182) - ## Methods ### authenticateToken() > `abstract` **authenticateToken**(`token`, `context?`): `Promise`\<[`TokenValidationResult`](../type-aliases/TokenValidationResult.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L236) - Validate and authenticate a token Subclasses must implement provider-specific token validation @@ -138,8 +120,6 @@ Subclasses must implement provider-specific token validation > **extractToken**(`context`): `Promise`\<`string` \| `null`\> -Defined in: [auth/providers/BaseAuthProvider.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L257) - Extract token using configured strategy Attempts extraction in order: @@ -173,8 +153,6 @@ Extracted token or null if not found > **createSession**(`user`, `context?`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L325) - Create a new session for an authenticated user Session duration and metadata are derived from `this.sessionConfig` and @@ -205,8 +183,6 @@ signature: `createSession(user, context?)`. > **validateSession**(`sessionId`): `Promise`\<[`SessionValidationResult`](../type-aliases/SessionValidationResult.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L372) - Validate an existing session #### Parameters @@ -225,8 +201,6 @@ Validate an existing session > **refreshSession**(`sessionId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L433) - Refresh a session (extend expiration) #### Parameters @@ -249,8 +223,6 @@ Refresh a session (extend expiration) > **revokeSession**(`sessionId`): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L481) - Revoke a session Marks the session as invalid rather than deleting it immediately. @@ -273,8 +245,6 @@ This keeps a tombstone so that "revoked" is distinguishable from > **revokeAllSessions**(`userId`): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L495) - Revoke all sessions for a user #### Parameters @@ -293,8 +263,6 @@ Revoke all sessions for a user > **authorize**(`user`, `options`): `Promise`\<[`AuthorizationResult`](../type-aliases/AuthorizationResult.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L507) - Check if a user is authorized for specific roles/permissions #### Parameters @@ -327,8 +295,6 @@ Check if a user is authorized for specific roles/permissions > `protected` **isSuperAdmin**(`user`): `boolean` -Defined in: [auth/providers/BaseAuthProvider.ts:579](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L579) - Check if user is a super admin #### Parameters @@ -347,8 +313,6 @@ Check if user is a super admin > `protected` **getEffectiveRoles**(`user`): `Set`\<`string`\> -Defined in: [auth/providers/BaseAuthProvider.ts:587](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L587) - Get effective roles including inherited roles from hierarchy (transitive) #### Parameters @@ -367,8 +331,6 @@ Get effective roles including inherited roles from hierarchy (transitive) > `protected` **getEffectivePermissions**(`user`): `Set`\<`string`\> -Defined in: [auth/providers/BaseAuthProvider.ts:612](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L612) - Get effective permissions including role-based permissions #### Parameters @@ -387,8 +349,6 @@ Get effective permissions including role-based permissions > `protected` **parseJWT**(`token`): [`TokenClaims`](../type-aliases/TokenClaims.md) \| `null` -Defined in: [auth/providers/BaseAuthProvider.ts:658](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L658) - Parse JWT token (without validation) #### Parameters @@ -407,8 +367,6 @@ Parse JWT token (without validation) > `protected` **isTokenExpired**(`claims`, `clockTolerance?`): `boolean` -Defined in: [auth/providers/BaseAuthProvider.ts:676](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L676) - Check if token is expired #### Parameters @@ -431,8 +389,6 @@ Check if token is expired > `protected` **isTokenNotYetValid**(`claims`, `clockTolerance?`): `boolean` -Defined in: [auth/providers/BaseAuthProvider.ts:688](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L688) - Check if token is not yet valid #### Parameters @@ -455,8 +411,6 @@ Check if token is not yet valid > `protected` **extractUserFromClaims**(`claims`, `options?`): [`AuthUser`](../type-aliases/AuthUser.md) -Defined in: [auth/providers/BaseAuthProvider.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L703) - Extract user from token claims #### Parameters @@ -489,8 +443,6 @@ Extract user from token claims > `optional` **getUser**(`_userId`): `Promise`\<[`AuthUser`](../type-aliases/AuthUser.md) \| `null`\> -Defined in: [auth/providers/BaseAuthProvider.ts:743](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L743) - Get user by ID Override in subclass if provider supports user lookup @@ -514,8 +466,6 @@ Override in subclass if provider supports user lookup > `optional` **updateUserRoles**(`_userId`, `_roles`): `Promise`\<[`AuthUser`](../type-aliases/AuthUser.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:753](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L753) - Update user roles Override in subclass if provider supports role updates. Returns the user with updated roles. @@ -544,8 +494,6 @@ Returns the user with updated roles. > `optional` **updateUserPermissions**(`_userId`, `_permissions`): `Promise`\<[`AuthUser`](../type-aliases/AuthUser.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:765](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L765) - Update user permissions Override in subclass if provider supports permission updates. Returns the user with updated permissions. @@ -574,8 +522,6 @@ Returns the user with updated permissions. > **dispose**(): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:778](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L778) - Clean up resources #### Returns @@ -592,8 +538,6 @@ Clean up resources > **authorizeUser**(`user`, `permission`): `Promise`\<[`AuthorizationResult`](../type-aliases/AuthorizationResult.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:790](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L790) - Check if a user is authorized to perform an action #### Parameters @@ -620,8 +564,6 @@ Check if a user is authorized to perform an action > **authorizeRoles**(`user`, `roles`): `Promise`\<[`AuthorizationResult`](../type-aliases/AuthorizationResult.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:800](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L800) - Check if user has specific roles #### Parameters @@ -648,8 +590,6 @@ Check if user has specific roles > **authorizePermissions**(`user`, `permissions`): `Promise`\<[`AuthorizationResult`](../type-aliases/AuthorizationResult.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:810](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L810) - Check if user has all specified permissions #### Parameters @@ -676,8 +616,6 @@ Check if user has all specified permissions > **getSession**(`sessionId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md) \| `null`\> -Defined in: [auth/providers/BaseAuthProvider.ts:820](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L820) - Get an existing session by ID #### Parameters @@ -700,8 +638,6 @@ Get an existing session by ID > **destroySession**(`sessionId`): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:827](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L827) - Invalidate/destroy a session #### Parameters @@ -724,8 +660,6 @@ Invalidate/destroy a session > **getUserSessions**(`userId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md)[]\> -Defined in: [auth/providers/BaseAuthProvider.ts:834](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L834) - Get all active sessions for a user #### Parameters @@ -748,8 +682,6 @@ Get all active sessions for a user > **destroyAllUserSessions**(`userId`): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:841](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L841) - Invalidate all sessions for a user (global logout) #### Parameters @@ -772,8 +704,6 @@ Invalidate all sessions for a user (global logout) > **authenticateRequest**(`context`): `Promise`\<[`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md) \| `null`\> -Defined in: [auth/providers/BaseAuthProvider.ts:854](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L854) - Full request authentication flow Combines token extraction (with full strategy support), validation, @@ -803,8 +733,6 @@ Authenticated context with user and session, or null > **healthCheck**(): `Promise`\<[`AuthHealthCheck`](../type-aliases/AuthHealthCheck.md)\> -Defined in: [auth/providers/BaseAuthProvider.ts:901](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L901) - Check provider health #### Returns @@ -821,8 +749,6 @@ Check provider health > **on**(`event`, `listener`): `void` -Defined in: [auth/providers/BaseAuthProvider.ts:916](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L916) - Subscribe to auth events #### Parameters @@ -845,8 +771,6 @@ Subscribe to auth events > **off**(`event`, `listener`): `void` -Defined in: [auth/providers/BaseAuthProvider.ts:923](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L923) - Unsubscribe from auth events #### Parameters @@ -869,8 +793,6 @@ Unsubscribe from auth events > `protected` **emit**(`event`, ...`args`): `void` -Defined in: [auth/providers/BaseAuthProvider.ts:930](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L930) - Emit an auth event #### Parameters diff --git a/docs/api/classes/BaseError.md b/docs/api/classes/BaseError.md index cec2814c4..93ee20988 100644 --- a/docs/api/classes/BaseError.md +++ b/docs/api/classes/BaseError.md @@ -6,8 +6,6 @@ # Class: BaseError -Defined in: [types/errors.ts:5](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L5) - Base error class for all NeuroLink-specific errors. This allows for easy identification of errors thrown by the SDK. @@ -28,8 +26,6 @@ This allows for easy identification of errors thrown by the SDK. > **new BaseError**(`message`): `BaseError` -Defined in: [types/errors.ts:6](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L6) - #### Parameters ##### message diff --git a/docs/api/classes/BaseFactory.md b/docs/api/classes/BaseFactory.md index 7a7acf0e9..d286b614f 100644 --- a/docs/api/classes/BaseFactory.md +++ b/docs/api/classes/BaseFactory.md @@ -6,8 +6,6 @@ # Abstract Class: BaseFactory\ -Defined in: [core/infrastructure/baseFactory.ts:7](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L7) - ## Extended by - [`EvaluatorFactory`](EvaluatorFactory.md) @@ -38,40 +36,30 @@ Defined in: [core/infrastructure/baseFactory.ts:7](https://github.com/juspay/neu > `protected` **items**: `Map`\<`string`, [`FactoryRegistration`](../type-aliases/FactoryRegistration.md)\<`TInstance`, `TConfig`\>\> -Defined in: [core/infrastructure/baseFactory.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L8) - --- ### aliasMap > `protected` **aliasMap**: `Map`\<`string`, `string`\> -Defined in: [core/infrastructure/baseFactory.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L9) - --- ### initialized > `protected` **initialized**: `boolean` = `false` -Defined in: [core/infrastructure/baseFactory.ts:10](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L10) - --- ### initPromise > `protected` **initPromise**: `Promise`\<`void`\> \| `null` = `null` -Defined in: [core/infrastructure/baseFactory.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L11) - ## Methods ### registerAll() > `abstract` `protected` **registerAll**(): `Promise`\<`void`\> -Defined in: [core/infrastructure/baseFactory.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L13) - #### Returns `Promise`\<`void`\> @@ -82,8 +70,6 @@ Defined in: [core/infrastructure/baseFactory.ts:13](https://github.com/juspay/ne > **ensureInitialized**(): `Promise`\<`void`\> -Defined in: [core/infrastructure/baseFactory.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L15) - #### Returns `Promise`\<`void`\> @@ -94,8 +80,6 @@ Defined in: [core/infrastructure/baseFactory.ts:15](https://github.com/juspay/ne > **register**(`name`, `factory`, `aliases?`, `metadata?`): `void` -Defined in: [core/infrastructure/baseFactory.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L27) - #### Parameters ##### name @@ -124,8 +108,6 @@ Defined in: [core/infrastructure/baseFactory.ts:27](https://github.com/juspay/ne > **create**(`nameOrAlias`, `config?`): `Promise`\<`TInstance`\> -Defined in: [core/infrastructure/baseFactory.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L40) - #### Parameters ##### nameOrAlias @@ -146,8 +128,6 @@ Defined in: [core/infrastructure/baseFactory.ts:40](https://github.com/juspay/ne > **resolveName**(`nameOrAlias`): `string` -Defined in: [core/infrastructure/baseFactory.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L50) - #### Parameters ##### nameOrAlias @@ -164,8 +144,6 @@ Defined in: [core/infrastructure/baseFactory.ts:50](https://github.com/juspay/ne > **has**(`nameOrAlias`): `boolean` -Defined in: [core/infrastructure/baseFactory.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L55) - #### Parameters ##### nameOrAlias @@ -182,8 +160,6 @@ Defined in: [core/infrastructure/baseFactory.ts:55](https://github.com/juspay/ne > **getAvailable**(): `string`[] -Defined in: [core/infrastructure/baseFactory.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L60) - #### Returns `string`[] @@ -194,8 +170,6 @@ Defined in: [core/infrastructure/baseFactory.ts:60](https://github.com/juspay/ne > **getAliases**(): `Map`\<`string`, `string`\> -Defined in: [core/infrastructure/baseFactory.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L64) - #### Returns `Map`\<`string`, `string`\> @@ -206,8 +180,6 @@ Defined in: [core/infrastructure/baseFactory.ts:64](https://github.com/juspay/ne > **clear**(): `void` -Defined in: [core/infrastructure/baseFactory.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L68) - #### Returns `void` diff --git a/docs/api/classes/BaseLLMScorer.md b/docs/api/classes/BaseLLMScorer.md index df3bd7261..9dfd5071c 100644 --- a/docs/api/classes/BaseLLMScorer.md +++ b/docs/api/classes/BaseLLMScorer.md @@ -6,8 +6,6 @@ # Abstract Class: BaseLLMScorer -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L35) - Abstract base class for LLM-based scorers ## Extends @@ -37,8 +35,6 @@ Abstract base class for LLM-based scorers > **new BaseLLMScorer**(`metadata`, `config?`): `BaseLLMScorer` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L40) - #### Parameters ##### metadata @@ -63,8 +59,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:40](https://github.com/jusp > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseScorer`](BaseScorer.md).[`_config`](BaseScorer.md#_config) @@ -75,8 +69,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseScorer`](BaseScorer.md).[`_metadata`](BaseScorer.md#_metadata) @@ -87,16 +79,12 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - --- ### provider? > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - ## Accessors ### metadata @@ -105,8 +93,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -129,8 +115,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -153,8 +137,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -171,8 +153,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -207,8 +187,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -235,8 +213,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -263,8 +239,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -291,8 +265,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -315,8 +287,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -361,8 +331,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -385,8 +353,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -409,8 +375,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -447,8 +411,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -481,8 +443,6 @@ Execute with retry logic > `abstract` **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L59) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -505,8 +465,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > `abstract` **parseResponse**(`response`, `input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L64) - Parse LLM response into score result - must be implemented by subclasses #### Parameters @@ -533,8 +491,6 @@ Parse LLM response into score result - must be implemented by subclasses > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -561,8 +517,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -575,8 +529,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -595,8 +547,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -616,8 +566,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -640,8 +588,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -664,8 +610,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -685,8 +629,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters diff --git a/docs/api/classes/BaseRealtimeHandler.md b/docs/api/classes/BaseRealtimeHandler.md index bd77433af..2cef89395 100644 --- a/docs/api/classes/BaseRealtimeHandler.md +++ b/docs/api/classes/BaseRealtimeHandler.md @@ -6,8 +6,6 @@ # Abstract Class: BaseRealtimeHandler -Defined in: [voice/RealtimeVoiceAPI.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L425) - Base Realtime Handler with common functionality Providers can extend this class for common behavior. @@ -37,8 +35,6 @@ Providers can extend this class for common behavior. > `abstract` `readonly` **name**: `"openai-realtime"` \| `"gemini-live"` -Defined in: [voice/RealtimeVoiceAPI.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L430) - #### Implementation of `RealtimeHandler.name` @@ -49,32 +45,24 @@ Defined in: [voice/RealtimeVoiceAPI.ts:430](https://github.com/juspay/neurolink/ > `protected` **session**: [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` = `null` -Defined in: [voice/RealtimeVoiceAPI.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L432) - --- ### eventHandlers > `protected` **eventHandlers**: [`RealtimeEventHandlers`](../type-aliases/RealtimeEventHandlers.md) \| `null` = `null` -Defined in: [voice/RealtimeVoiceAPI.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L433) - --- ### state > `protected` **state**: [`RealtimeSessionState`](../type-aliases/RealtimeSessionState.md) = `"disconnected"` -Defined in: [voice/RealtimeVoiceAPI.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L434) - ## Methods ### connect() > `abstract` **connect**(`config`): `Promise`\<[`RealtimeSession`](../type-aliases/RealtimeSession.md)\> -Defined in: [voice/RealtimeVoiceAPI.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L436) - #### Parameters ##### config @@ -95,8 +83,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:436](https://github.com/juspay/neurolink/ > `abstract` **disconnect**(): `Promise`\<`void`\> -Defined in: [voice/RealtimeVoiceAPI.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L437) - #### Returns `Promise`\<`void`\> @@ -111,8 +97,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:437](https://github.com/juspay/neurolink/ > `abstract` **sendAudio**(`audio`): `Promise`\<`void`\> -Defined in: [voice/RealtimeVoiceAPI.ts:438](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L438) - #### Parameters ##### audio @@ -133,8 +117,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:438](https://github.com/juspay/neurolink/ > `abstract` **isConfigured**(): `boolean` -Defined in: [voice/RealtimeVoiceAPI.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L439) - #### Returns `boolean` @@ -149,8 +131,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:439](https://github.com/juspay/neurolink/ > `abstract` **getSupportedFormats**(): [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] -Defined in: [voice/RealtimeVoiceAPI.ts:440](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L440) - #### Returns [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] @@ -165,8 +145,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:440](https://github.com/juspay/neurolink/ > **isConnected**(): `boolean` -Defined in: [voice/RealtimeVoiceAPI.ts:442](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L442) - #### Returns `boolean` @@ -181,8 +159,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:442](https://github.com/juspay/neurolink/ > **getSession**(): [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` -Defined in: [voice/RealtimeVoiceAPI.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L446) - #### Returns [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` @@ -197,8 +173,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:446](https://github.com/juspay/neurolink/ > **on**(`handlers`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L450) - #### Parameters ##### handlers @@ -219,8 +193,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:450](https://github.com/juspay/neurolink/ > **off**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L454) - #### Returns `void` @@ -235,8 +207,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:454](https://github.com/juspay/neurolink/ > `protected` **emitStateChange**(`newState`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:461](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L461) - Emit state change event #### Parameters @@ -255,8 +225,6 @@ Emit state change event > `protected` **emitAudio**(`chunk`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L473) - Emit audio event #### Parameters @@ -275,8 +243,6 @@ Emit audio event > `protected` **emitTranscript**(`text`, `isFinal`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L480) - Emit transcript event #### Parameters @@ -299,8 +265,6 @@ Emit transcript event > `protected` **emitText**(`text`, `isFinal`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L487) - Emit text event #### Parameters @@ -323,8 +287,6 @@ Emit text event > `protected` **emitFunctionCall**(`name`, `args`): `Promise`\<`unknown`\> -Defined in: [voice/RealtimeVoiceAPI.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L494) - Emit function call event #### Parameters @@ -347,8 +309,6 @@ Emit function call event > `protected` **emitError**(`error`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L507) - Emit error event #### Parameters @@ -367,8 +327,6 @@ Emit error event > `protected` **emitTurnStart**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:514](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L514) - Emit turn start event #### Returns @@ -381,8 +339,6 @@ Emit turn start event > `protected` **emitTurnEnd**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L521) - Emit turn end event #### Returns @@ -395,8 +351,6 @@ Emit turn end event > `protected` **createSession**(`id`, `config`): [`RealtimeSession`](../type-aliases/RealtimeSession.md) -Defined in: [voice/RealtimeVoiceAPI.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L528) - Create a session object #### Parameters diff --git a/docs/api/classes/BaseRegistry.md b/docs/api/classes/BaseRegistry.md index 5b20ddccf..f2276f2a6 100644 --- a/docs/api/classes/BaseRegistry.md +++ b/docs/api/classes/BaseRegistry.md @@ -6,8 +6,6 @@ # Abstract Class: BaseRegistry\ -Defined in: [core/infrastructure/baseRegistry.ts:4](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L4) - ## Type Parameters ### TItem @@ -34,32 +32,24 @@ Defined in: [core/infrastructure/baseRegistry.ts:4](https://github.com/juspay/ne > `protected` **items**: `Map`\<`string`, [`InfraRegistryEntry`](../type-aliases/InfraRegistryEntry.md)\<`TItem`, `TMetadata`\>\> -Defined in: [core/infrastructure/baseRegistry.ts:5](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L5) - --- ### initialized > `protected` **initialized**: `boolean` = `false` -Defined in: [core/infrastructure/baseRegistry.ts:6](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L6) - --- ### initPromise > `protected` **initPromise**: `Promise`\<`void`\> \| `null` = `null` -Defined in: [core/infrastructure/baseRegistry.ts:7](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L7) - ## Methods ### registerAll() > `abstract` `protected` **registerAll**(): `Promise`\<`void`\> -Defined in: [core/infrastructure/baseRegistry.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L9) - #### Returns `Promise`\<`void`\> @@ -70,8 +60,6 @@ Defined in: [core/infrastructure/baseRegistry.ts:9](https://github.com/juspay/ne > **ensureInitialized**(): `Promise`\<`void`\> -Defined in: [core/infrastructure/baseRegistry.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L11) - #### Returns `Promise`\<`void`\> @@ -82,8 +70,6 @@ Defined in: [core/infrastructure/baseRegistry.ts:11](https://github.com/juspay/n > **register**(`id`, `factory`, `aliases?`, `options?`): `void` -Defined in: [core/infrastructure/baseRegistry.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L23) - #### Parameters ##### id @@ -114,8 +100,6 @@ Defined in: [core/infrastructure/baseRegistry.ts:23](https://github.com/juspay/n > **get**(`id`): `Promise`\<`TItem` \| `undefined`\> -Defined in: [core/infrastructure/baseRegistry.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L37) - #### Parameters ##### id @@ -132,8 +116,6 @@ Defined in: [core/infrastructure/baseRegistry.ts:37](https://github.com/juspay/n > **has**(`id`): `boolean` -Defined in: [core/infrastructure/baseRegistry.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L49) - #### Parameters ##### id @@ -150,8 +132,6 @@ Defined in: [core/infrastructure/baseRegistry.ts:49](https://github.com/juspay/n > **list**(): `object`[] -Defined in: [core/infrastructure/baseRegistry.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L53) - #### Returns `object`[] @@ -162,8 +142,6 @@ Defined in: [core/infrastructure/baseRegistry.ts:53](https://github.com/juspay/n > **clear**(): `void` -Defined in: [core/infrastructure/baseRegistry.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L60) - #### Returns `void` @@ -174,8 +152,6 @@ Defined in: [core/infrastructure/baseRegistry.ts:60](https://github.com/juspay/n > **isInitialized**(): `boolean` -Defined in: [core/infrastructure/baseRegistry.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseRegistry.ts#L66) - #### Returns `boolean` diff --git a/docs/api/classes/BaseRuleScorer.md b/docs/api/classes/BaseRuleScorer.md index 8e27c6bfd..ad9bc5d87 100644 --- a/docs/api/classes/BaseRuleScorer.md +++ b/docs/api/classes/BaseRuleScorer.md @@ -6,8 +6,6 @@ # Abstract Class: BaseRuleScorer -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L33) - Abstract base class for rule-based scorers ## Extends @@ -24,8 +22,6 @@ Abstract base class for rule-based scorers > **new BaseRuleScorer**(`metadata`, `config?`): `BaseRuleScorer` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L36) - #### Parameters ##### metadata @@ -50,8 +46,6 @@ Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:36](https://github.com/ju > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseScorer`](BaseScorer.md).[`_config`](BaseScorer.md#_config) @@ -62,8 +56,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseScorer`](BaseScorer.md).[`_metadata`](BaseScorer.md#_metadata) @@ -74,8 +66,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_ruleConfig**: [`RuleScorerConfig`](../type-aliases/RuleScorerConfig.md) -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L34) - ## Accessors ### metadata @@ -84,8 +74,6 @@ Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:34](https://github.com/ju > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -108,8 +96,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -132,8 +118,6 @@ Get current configuration > **get** **ruleConfig**(): [`RuleScorerConfig`](../type-aliases/RuleScorerConfig.md) -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L48) - Get rule-specific configuration ##### Returns @@ -150,8 +134,6 @@ Get rule-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -186,8 +168,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -214,8 +194,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -242,8 +220,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -270,8 +246,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -294,8 +268,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -340,8 +312,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -364,8 +334,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -388,8 +356,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -426,8 +392,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -460,8 +424,6 @@ Execute with retry logic > `abstract` **getRules**(): [`ScorerRule`](../type-aliases/ScorerRule.md)[] -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L55) - Get all rules for this scorer - must be implemented by subclasses #### Returns @@ -478,8 +440,6 @@ Get all rules for this scorer - must be implemented by subclasses > `abstract` **evaluateRule**(`rule`, `input`): `object` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L60) - Evaluate a single rule - must be implemented by subclasses #### Parameters @@ -514,8 +474,6 @@ Evaluate a single rule - must be implemented by subclasses > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L68) - Main scoring method #### Parameters @@ -542,8 +500,6 @@ Main scoring method > `protected` **combineRuleResults**(`results`, `rules`): `number` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L134) - Combine rule results based on configuration #### Parameters @@ -566,8 +522,6 @@ Combine rule results based on configuration > `protected` **generateReasoning**(`results`): `string` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L181) - Generate reasoning from rule results #### Parameters @@ -586,8 +540,6 @@ Generate reasoning from rule results > `protected` **matchesRegex**(`text`, `pattern`, `flags?`): `boolean` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L210) - Helper: Check if text matches a regex pattern #### Parameters @@ -614,8 +566,6 @@ Helper: Check if text matches a regex pattern > `protected` **containsKeyword**(`text`, `keyword`, `caseInsensitive?`): `boolean` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L231) - Helper: Check if text contains keyword with word boundaries #### Parameters @@ -642,8 +592,6 @@ Helper: Check if text contains keyword with word boundaries > `protected` **countOccurrences**(`text`, `pattern`, `caseInsensitive?`): `number` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L245) - Helper: Count occurrences of a pattern #### Parameters @@ -670,8 +618,6 @@ Helper: Count occurrences of a pattern > `protected` **getWordCount**(`text`): `number` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L272) - Helper: Get word count #### Parameters @@ -690,8 +636,6 @@ Helper: Get word count > `protected` **getCharacterCount**(`text`, `includeWhitespace?`): `number` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L282) - Helper: Get character count (excluding whitespace) #### Parameters @@ -714,8 +658,6 @@ Helper: Get character count (excluding whitespace) > `protected` **isWithinLengthBounds**(`text`, `minWords?`, `maxWords?`, `minChars?`, `maxChars?`): `object` -Defined in: [evaluation/scorers/rule/baseRuleScorer.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/baseRuleScorer.ts#L292) - Helper: Check text length is within bounds #### Parameters diff --git a/docs/api/classes/BaseScorer.md b/docs/api/classes/BaseScorer.md index 8e7089e57..f952d27ae 100644 --- a/docs/api/classes/BaseScorer.md +++ b/docs/api/classes/BaseScorer.md @@ -6,8 +6,6 @@ # Abstract Class: BaseScorer -Defined in: [evaluation/scorers/baseScorer.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L42) - Abstract base class for all scorers Provides common functionality and enforces interface compliance @@ -26,8 +24,6 @@ Provides common functionality and enforces interface compliance > **new BaseScorer**(`metadata`, `config?`): `BaseScorer` -Defined in: [evaluation/scorers/baseScorer.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L46) - #### Parameters ##### metadata @@ -48,16 +44,12 @@ Defined in: [evaluation/scorers/baseScorer.ts:46](https://github.com/juspay/neur > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - --- ### \_metadata > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - ## Accessors ### metadata @@ -66,8 +58,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -86,8 +76,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -104,8 +92,6 @@ Get current configuration > `abstract` **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L72) - Main scoring method - must be implemented by subclasses #### Parameters @@ -128,8 +114,6 @@ Main scoring method - must be implemented by subclasses > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -160,8 +144,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -184,8 +166,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -208,8 +188,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -232,8 +210,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -252,8 +228,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -294,8 +268,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -314,8 +286,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -334,8 +304,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -368,8 +336,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters diff --git a/docs/api/classes/BaseServerAdapter.md b/docs/api/classes/BaseServerAdapter.md index 6bfecaf7f..0b37bd8d6 100644 --- a/docs/api/classes/BaseServerAdapter.md +++ b/docs/api/classes/BaseServerAdapter.md @@ -6,8 +6,6 @@ # Abstract Class: BaseServerAdapter -Defined in: [server/abstract/baseServerAdapter.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L44) - Abstract base class for server adapters Provides common functionality and defines the interface for framework-specific implementations @@ -28,8 +26,6 @@ Provides common functionality and defines the interface for framework-specific i > **new BaseServerAdapter**(`neurolink`, `config?`): `BaseServerAdapter` -Defined in: [server/abstract/baseServerAdapter.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L60) - #### Parameters ##### neurolink @@ -54,104 +50,78 @@ Defined in: [server/abstract/baseServerAdapter.ts:60](https://github.com/juspay/ > `protected` `readonly` **config**: [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L45) - --- ### redactionConfig? > `protected` `readonly` `optional` **redactionConfig?**: [`RedactionConfig`](../type-aliases/RedactionConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L46) - --- ### neurolink > `protected` `readonly` **neurolink**: [`NeuroLink`](NeuroLink.md) -Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L47) - --- ### toolRegistry > `protected` `readonly` **toolRegistry**: [`MCPToolRegistry`](MCPToolRegistry.md) -Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L48) - --- ### externalServerManager? > `protected` `readonly` `optional` **externalServerManager?**: [`ExternalServerManager`](ExternalServerManager.md) -Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L49) - --- ### routes > `protected` **routes**: `Map`\<`string`, [`RouteDefinition`](../type-aliases/RouteDefinition.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L50) - --- ### middlewares > `protected` **middlewares**: [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md)[] = `[]` -Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L51) - --- ### isRunning > `protected` **isRunning**: `boolean` = `false` -Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L52) - --- ### startTime? > `protected` `optional` **startTime?**: `Date` -Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L53) - --- ### lifecycleState > `protected` **lifecycleState**: [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) = `"uninitialized"` -Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L56) - --- ### activeConnections > `protected` **activeConnections**: `Map`\<`string`, [`TrackedConnection`](../type-aliases/TrackedConnection.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L57) - --- ### shutdownConfig > `protected` `readonly` **shutdownConfig**: [`RequiredShutdownConfig`](../type-aliases/RequiredShutdownConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L58) - ## Methods ### initializeFramework() > `abstract` `protected` **initializeFramework**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L139) - Initialize the underlying server framework #### Returns @@ -164,8 +134,6 @@ Initialize the underlying server framework > `abstract` `protected` **registerFrameworkRoute**(`route`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L144) - Register a route with the framework #### Parameters @@ -184,8 +152,6 @@ Register a route with the framework > `abstract` `protected` **registerFrameworkMiddleware**(`middleware`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L149) - Register middleware with the framework #### Parameters @@ -204,8 +170,6 @@ Register middleware with the framework > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L156) - Start the server #### Returns @@ -218,8 +182,6 @@ Start the server > `abstract` **stop**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L161) - Stop the server #### Returns @@ -232,8 +194,6 @@ Stop the server > `abstract` **getFrameworkInstance**(): `unknown` -Defined in: [server/abstract/baseServerAdapter.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L166) - Get the underlying framework instance (for advanced usage) #### Returns @@ -246,8 +206,6 @@ Get the underlying framework instance (for advanced usage) > `abstract` `protected` **stopAcceptingConnections**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L176) - Stop accepting new connections Called during graceful shutdown to prevent new requests @@ -261,8 +219,6 @@ Called during graceful shutdown to prevent new requests > `abstract` `protected` **closeServer**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L182) - Close the underlying server Called after connections are drained or timeout @@ -276,8 +232,6 @@ Called after connections are drained or timeout > `abstract` `protected` **forceCloseConnections**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L188) - Force close all active connections Called when drain timeout expires and forceClose is true @@ -291,8 +245,6 @@ Called when drain timeout expires and forceClose is true > `protected` **importFrameworkDependency**\<`T`\>(`pkg`, `framework`): `Promise`\<`T`\> -Defined in: [server/abstract/baseServerAdapter.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L206) - Import an optional framework dependency (express/fastify/koa and their plugins), converting a missing package into a [MissingDependencyError](MissingDependencyError.md) instead of letting the framework's `Cannot find package` propagate raw. @@ -330,8 +282,6 @@ unchanged, matching `tryImport`'s own contract. > **initialize**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L224) - Initialize the server adapter Sets up routes, middleware, and framework @@ -345,8 +295,6 @@ Sets up routes, middleware, and framework > **registerRoute**(`route`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L295) - Register a custom route #### Parameters @@ -365,8 +313,6 @@ Register a custom route > **registerRouteGroup**(`group`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L317) - Register multiple routes from a route group #### Parameters @@ -395,8 +341,6 @@ Register multiple routes from a route group > **registerMiddleware**(`middleware`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L363) - Register custom middleware #### Parameters @@ -415,8 +359,6 @@ Register custom middleware > `protected` **createContext**(`options`): [`ServerContext`](../type-aliases/ServerContext.md) -Defined in: [server/abstract/baseServerAdapter.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L376) - Create request context from incoming request #### Parameters @@ -461,8 +403,6 @@ Create request context from incoming request > `protected` **registerBuiltInMiddleware**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L405) - Register built-in middleware #### Returns @@ -475,8 +415,6 @@ Register built-in middleware > `protected` **registerBuiltInRoutes**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L444) - Register built-in routes Only registers health routes if disableBuiltInHealth is false (default) @@ -490,8 +428,6 @@ Only registers health routes if disableBuiltInHealth is false (default) > `protected` **generateRequestId**(): `string` -Defined in: [server/abstract/baseServerAdapter.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L536) - Generate unique request ID #### Returns @@ -504,8 +440,6 @@ Generate unique request ID > **getLifecycleState**(): [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) -Defined in: [server/abstract/baseServerAdapter.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L547) - Get the current lifecycle state #### Returns @@ -518,8 +452,6 @@ Get the current lifecycle state > `protected` **trackConnection**(`id`, `socket?`, `requestId?`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L557) - Track a new connection #### Parameters @@ -552,8 +484,6 @@ Optional associated request ID > `protected` **untrackConnection**(`id`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L580) - Untrack a connection (when it's completed) #### Parameters @@ -574,8 +504,6 @@ Connection identifier to remove > **getActiveConnectionCount**(): `number` -Defined in: [server/abstract/baseServerAdapter.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L594) - Get the number of active connections #### Returns @@ -588,8 +516,6 @@ Get the number of active connections > `protected` **gracefulShutdown**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:602](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L602) - Perform graceful shutdown with connection draining This method handles the complete shutdown lifecycle @@ -603,8 +529,6 @@ This method handles the complete shutdown lifecycle > `protected` **drainConnections**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:737](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L737) - Wait for all active connections to drain Resolves when activeConnections is empty @@ -618,8 +542,6 @@ Resolves when activeConnections is empty > `protected` **resetServerState**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L763) - Reset server state for restart capability Call this after stop() completes to allow restart @@ -633,8 +555,6 @@ Call this after stop() completes to allow restart > `protected` **validateLifecycleState**(`operation`, `allowedStates`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:777](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L777) - Validate lifecycle state transition #### Parameters @@ -661,8 +581,6 @@ States that allow the operation > **getStatus**(): [`ServerStatus`](../type-aliases/ServerStatus.md) -Defined in: [server/abstract/baseServerAdapter.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L793) - Get server status #### Returns @@ -675,8 +593,6 @@ Get server status > **listRoutes**(): [`RouteDefinition`](../type-aliases/RouteDefinition.md)[] -Defined in: [server/abstract/baseServerAdapter.ts:809](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L809) - List all registered routes #### Returns @@ -689,8 +605,6 @@ List all registered routes > **getConfig**(): [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:816](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L816) - Get configuration #### Returns diff --git a/docs/api/classes/BatchStrategy.md b/docs/api/classes/BatchStrategy.md index 871ab9e6b..945ec964e 100644 --- a/docs/api/classes/BatchStrategy.md +++ b/docs/api/classes/BatchStrategy.md @@ -6,8 +6,6 @@ # Class: BatchStrategy -Defined in: [evaluation/pipeline/strategies/batchStrategy.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/batchStrategy.ts#L41) - Batch evaluation strategy ## Constructors @@ -16,8 +14,6 @@ Batch evaluation strategy > **new BatchStrategy**(`pipeline`, `config?`): `BatchStrategy` -Defined in: [evaluation/pipeline/strategies/batchStrategy.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/batchStrategy.ts#L54) - #### Parameters ##### pipeline @@ -38,8 +34,6 @@ Defined in: [evaluation/pipeline/strategies/batchStrategy.ts:54](https://github. > **evaluate**(`inputs`, `options?`): `Promise`\<[`BatchEvaluationResult`](../type-aliases/BatchEvaluationResult.md)\> -Defined in: [evaluation/pipeline/strategies/batchStrategy.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/batchStrategy.ts#L62) - Evaluate a batch of inputs #### Parameters @@ -62,8 +56,6 @@ Evaluate a batch of inputs > **configure**(`config`): `void` -Defined in: [evaluation/pipeline/strategies/batchStrategy.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/batchStrategy.ts#L210) - Update configuration #### Parameters diff --git a/docs/api/classes/BeatovenMusic.md b/docs/api/classes/BeatovenMusic.md index 35087a28f..68990fb11 100644 --- a/docs/api/classes/BeatovenMusic.md +++ b/docs/api/classes/BeatovenMusic.md @@ -6,8 +6,6 @@ # Class: BeatovenMusic -Defined in: [music/providers/BeatovenMusic.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/BeatovenMusic.ts#L37) - Beatoven.ai Music Generation Handler. Beatoven is a royalty-free music generation API tuned for @@ -24,8 +22,6 @@ asynchronously: submit a prompt, poll the task, then download. > **new BeatovenMusic**(`apiKey?`): `BeatovenMusic` -Defined in: [music/providers/BeatovenMusic.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/BeatovenMusic.ts#L58) - #### Parameters ##### apiKey? @@ -42,8 +38,6 @@ Defined in: [music/providers/BeatovenMusic.ts:58](https://github.com/juspay/neur > `readonly` **maxDurationSeconds**: `300` = `300` -Defined in: [music/providers/BeatovenMusic.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/BeatovenMusic.ts#L38) - Maximum supported track duration in seconds (provider-specific). #### Implementation of @@ -56,8 +50,6 @@ Maximum supported track duration in seconds (provider-specific). > `readonly` **supportedFormats**: readonly [`MusicAudioFormat`](../type-aliases/MusicAudioFormat.md)[] -Defined in: [music/providers/BeatovenMusic.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/BeatovenMusic.ts#L39) - Output formats supported by this handler. #### Implementation of @@ -70,8 +62,6 @@ Output formats supported by this handler. > `readonly` **supportedGenres**: readonly `string`[] -Defined in: [music/providers/BeatovenMusic.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/BeatovenMusic.ts#L43) - Genres / styles the upstream advertises (informational). #### Implementation of @@ -84,8 +74,6 @@ Genres / styles the upstream advertises (informational). > **isConfigured**(): `boolean` -Defined in: [music/providers/BeatovenMusic.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/BeatovenMusic.ts#L67) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -102,8 +90,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`options`): `Promise`\<[`MusicResult`](../type-aliases/MusicResult.md)\> -Defined in: [music/providers/BeatovenMusic.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/BeatovenMusic.ts#L71) - Generate a music track from prompt + options. #### Parameters diff --git a/docs/api/classes/BiasDetectionScorer.md b/docs/api/classes/BiasDetectionScorer.md index 483a35b5b..96d665279 100644 --- a/docs/api/classes/BiasDetectionScorer.md +++ b/docs/api/classes/BiasDetectionScorer.md @@ -6,8 +6,6 @@ # Class: BiasDetectionScorer -Defined in: [evaluation/scorers/llm/biasDetectionScorer.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/biasDetectionScorer.ts#L69) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new BiasDetectionScorer**(`config?`): `BiasDetectionScorer` -Defined in: [evaluation/scorers/llm/biasDetectionScorer.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/biasDetectionScorer.ts#L70) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/biasDetectionScorer.ts:70](https://github.co > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/biasDetectionScorer.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/biasDetectionScorer.ts#L93) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/biasDetectionScorer.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/biasDetectionScorer.ts#L107) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/CSVLoader.md b/docs/api/classes/CSVLoader.md index 287b1b002..89bb4916f 100644 --- a/docs/api/classes/CSVLoader.md +++ b/docs/api/classes/CSVLoader.md @@ -6,8 +6,6 @@ # Class: CSVLoader -Defined in: [rag/document/loaders.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L154) - CSV file loader ## Extends @@ -34,8 +32,6 @@ CSV file loader > `protected` **loadContent**(`source`, `encoding?`): `Promise`\<`string`\> -Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L70) - #### Parameters ##### source @@ -60,8 +56,6 @@ Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blo > `protected` **getSourceName**(`source`): `string` -Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L81) - #### Parameters ##### source @@ -82,8 +76,6 @@ Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blo > **load**(`source`, `options?`): `Promise`\<[`MDocument`](MDocument.md)\> -Defined in: [rag/document/loaders.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L155) - Load document from source #### Parameters @@ -116,8 +108,6 @@ Promise resolving to MDocument > **canHandle**(`source`): `boolean` -Defined in: [rag/document/loaders.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L245) - Check if loader can handle the source #### Parameters diff --git a/docs/api/classes/CartesiaTTS.md b/docs/api/classes/CartesiaTTS.md index 1513944fa..5a8e075a7 100644 --- a/docs/api/classes/CartesiaTTS.md +++ b/docs/api/classes/CartesiaTTS.md @@ -6,8 +6,6 @@ # Class: CartesiaTTS -Defined in: [voice/providers/CartesiaTTS.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/CartesiaTTS.ts#L40) - Cartesia synchronous TTS handler. Auth: `X-API-Key: ${CARTESIA_API_KEY}` + `Cartesia-Version` header. @@ -22,8 +20,6 @@ Auth: `X-API-Key: ${CARTESIA_API_KEY}` + `Cartesia-Version` header. > **new CartesiaTTS**(`apiKey?`): `CartesiaTTS` -Defined in: [voice/providers/CartesiaTTS.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/CartesiaTTS.ts#L47) - #### Parameters ##### apiKey? @@ -40,8 +36,6 @@ Defined in: [voice/providers/CartesiaTTS.ts:47](https://github.com/juspay/neurol > `readonly` **maxTextLength**: `5000` = `5000` -Defined in: [voice/providers/CartesiaTTS.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/CartesiaTTS.ts#L41) - Maximum text length supported by this provider (in bytes) Different providers have different limits @@ -61,8 +55,6 @@ Different providers have different limits > **isConfigured**(): `boolean` -Defined in: [voice/providers/CartesiaTTS.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/CartesiaTTS.ts#L57) - Validate that the provider is properly configured #### Returns @@ -81,8 +73,6 @@ True if provider can generate TTS > **synthesize**(`text`, `options?`): `Promise`\<[`TTSResult`](../type-aliases/TTSResult.md)\> -Defined in: [voice/providers/CartesiaTTS.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/CartesiaTTS.ts#L61) - Generate audio from text using provider-specific TTS API **IMPORTANT: Timeout Responsibility** diff --git a/docs/api/classes/CharacterChunker.md b/docs/api/classes/CharacterChunker.md index 64a7ec865..39cb4b4d5 100644 --- a/docs/api/classes/CharacterChunker.md +++ b/docs/api/classes/CharacterChunker.md @@ -6,8 +6,6 @@ # Class: CharacterChunker -Defined in: [rag/chunking/characterChunker.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/characterChunker.ts#L21) - Character-based chunker implementation Splits text by character count with optional separator @@ -31,8 +29,6 @@ Splits text by character count with optional separator > `readonly` **strategy**: `"character"` -Defined in: [rag/chunking/characterChunker.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/characterChunker.ts#L22) - Strategy name for identification #### Implementation of @@ -45,8 +41,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/characterChunker.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/characterChunker.ts#L24) - Split text into chunks #### Parameters @@ -79,8 +73,6 @@ Array of chunks > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/characterChunker.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/characterChunker.ts#L145) - #### Parameters ##### config diff --git a/docs/api/classes/ChromaVectorStore.md b/docs/api/classes/ChromaVectorStore.md index 3425c9af9..6d0b88c6b 100644 --- a/docs/api/classes/ChromaVectorStore.md +++ b/docs/api/classes/ChromaVectorStore.md @@ -6,8 +6,6 @@ # Class: ChromaVectorStore -Defined in: [rag/stores/chroma.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/chroma.ts#L255) - RAG (Retrieval-Augmented Generation) Document Processing Comprehensive RAG system with document loading, chunking, embedding, @@ -47,8 +45,6 @@ console.log(response.answer); > **new ChromaVectorStore**(`client`, `options?`): `ChromaVectorStore` -Defined in: [rag/stores/chroma.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/chroma.ts#L262) - #### Parameters ##### client @@ -69,8 +65,6 @@ Defined in: [rag/stores/chroma.ts:262](https://github.com/juspay/neurolink/blob/ > **upsert**(`indexName`, `items`): `Promise`\<`void`\> -Defined in: [rag/stores/chroma.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/chroma.ts#L281) - Add or update vectors in an index (Chroma collection). #### Parameters @@ -93,8 +87,6 @@ Add or update vectors in an index (Chroma collection). > **query**(`params`): `Promise`\<[`VectorQueryResult`](../type-aliases/VectorQueryResult.md)[]\> -Defined in: [rag/stores/chroma.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/chroma.ts#L303) - Query vectors by similarity. #### Parameters @@ -135,8 +127,6 @@ Query vectors by similarity. > **delete**(`indexName`, `ids`): `Promise`\<`void`\> -Defined in: [rag/stores/chroma.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/chroma.ts#L358) - Delete vectors from an index (Chroma collection) by id. #### Parameters diff --git a/docs/api/classes/ChunkerRegistry.md b/docs/api/classes/ChunkerRegistry.md index eab516cfc..d77c687f6 100644 --- a/docs/api/classes/ChunkerRegistry.md +++ b/docs/api/classes/ChunkerRegistry.md @@ -6,8 +6,6 @@ # Class: ChunkerRegistry -Defined in: [rag/chunking/chunkerRegistry.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L24) - Registry for chunking strategies Follows NeuroLink's factory pattern with lazy initialization @@ -27,8 +25,6 @@ Follows NeuroLink's factory pattern with lazy initialization > `static` **initialize**(): `void` -Defined in: [rag/chunking/chunkerRegistry.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L31) - Initialize all built-in chunkers #### Returns @@ -41,8 +37,6 @@ Initialize all built-in chunkers > `static` **register**(`strategy`, `factory`): `void` -Defined in: [rag/chunking/chunkerRegistry.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L58) - Register a custom chunker #### Parameters @@ -69,8 +63,6 @@ Factory function that creates chunker instance > `static` **get**(`strategy`): [`Chunker`](../type-aliases/Chunker.md) -Defined in: [rag/chunking/chunkerRegistry.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L68) - Get a chunker by strategy name #### Parameters @@ -97,8 +89,6 @@ Error if strategy is not registered > `static` **getAvailableStrategies**(): [`ChunkingStrategy`](../type-aliases/ChunkingStrategy.md)[] -Defined in: [rag/chunking/chunkerRegistry.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L85) - Get all available chunking strategies #### Returns @@ -113,8 +103,6 @@ Array of strategy names > `static` **has**(`strategy`): `boolean` -Defined in: [rag/chunking/chunkerRegistry.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L95) - Check if a strategy is registered #### Parameters @@ -137,8 +125,6 @@ True if strategy is registered > `static` **getRecommendedStrategy**(`contentType`): [`ChunkingStrategy`](../type-aliases/ChunkingStrategy.md) -Defined in: [rag/chunking/chunkerRegistry.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L105) - Get strategy recommendation based on content type #### Parameters @@ -161,8 +147,6 @@ Recommended chunking strategy > `static` **getDefaultConfig**(`strategy`): `Record`\<`string`, `unknown`\> -Defined in: [rag/chunking/chunkerRegistry.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L141) - Get default configuration for a strategy #### Parameters @@ -185,8 +169,6 @@ Default configuration object > `static` **reset**(): `void` -Defined in: [rag/chunking/chunkerRegistry.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L204) - Reset the registry (useful for testing) #### Returns diff --git a/docs/api/classes/CircuitBreakerManager.md b/docs/api/classes/CircuitBreakerManager.md index 9bc4da58b..7ce9b5924 100644 --- a/docs/api/classes/CircuitBreakerManager.md +++ b/docs/api/classes/CircuitBreakerManager.md @@ -6,8 +6,6 @@ # Class: CircuitBreakerManager -Defined in: [mcp/mcpCircuitBreaker.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L483) - Circuit breaker manager for multiple circuit breakers ## Constructors @@ -26,8 +24,6 @@ Circuit breaker manager for multiple circuit breakers > **getBreaker**(`name`, `config?`): [`MCPCircuitBreaker`](MCPCircuitBreaker.md) -Defined in: [mcp/mcpCircuitBreaker.ts:489](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L489) - Get or create a circuit breaker #### Parameters @@ -50,8 +46,6 @@ Get or create a circuit breaker > **removeBreaker**(`name`): `boolean` -Defined in: [mcp/mcpCircuitBreaker.ts:512](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L512) - Remove a circuit breaker and clean up its resources #### Parameters @@ -70,8 +64,6 @@ Remove a circuit breaker and clean up its resources > **getBreakerNames**(): `string`[] -Defined in: [mcp/mcpCircuitBreaker.ts:530](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L530) - Get all circuit breaker names #### Returns @@ -84,8 +76,6 @@ Get all circuit breaker names > **getAllStats**(): `Record`\<`string`, [`CircuitBreakerStats`](../type-aliases/CircuitBreakerStats.md)\> -Defined in: [mcp/mcpCircuitBreaker.ts:537](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L537) - Get statistics for all circuit breakers #### Returns @@ -98,8 +88,6 @@ Get statistics for all circuit breakers > **resetAll**(): `void` -Defined in: [mcp/mcpCircuitBreaker.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L550) - Reset all circuit breakers #### Returns @@ -112,8 +100,6 @@ Reset all circuit breakers > **getHealthSummary**(): `object` -Defined in: [mcp/mcpCircuitBreaker.ts:561](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L561) - Get health summary #### Returns @@ -146,8 +132,6 @@ Get health summary > **destroyAll**(): `void` -Defined in: [mcp/mcpCircuitBreaker.ts:603](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L603) - Destroy all circuit breakers and clean up their resources This should be called during application shutdown to prevent memory leaks diff --git a/docs/api/classes/CircuitBreakerOpenError.md b/docs/api/classes/CircuitBreakerOpenError.md index 7e2f95cd4..56380f385 100644 --- a/docs/api/classes/CircuitBreakerOpenError.md +++ b/docs/api/classes/CircuitBreakerOpenError.md @@ -6,8 +6,6 @@ # Class: CircuitBreakerOpenError -Defined in: [types/circuitBreakerErrors.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/circuitBreakerErrors.ts#L14) - Typed error thrown when a circuit breaker is open or half-open call limit is reached. Contains structured metadata so callers can build actionable error messages for AI models and downstream consumers. @@ -22,8 +20,6 @@ for AI models and downstream consumers. > **new CircuitBreakerOpenError**(`options`): `CircuitBreakerOpenError` -Defined in: [types/circuitBreakerErrors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/circuitBreakerErrors.ts#L26) - #### Parameters ##### options @@ -62,8 +58,6 @@ Defined in: [types/circuitBreakerErrors.ts:26](https://github.com/juspay/neuroli > `readonly` **breakerName**: `string` -Defined in: [types/circuitBreakerErrors.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/circuitBreakerErrors.ts#L16) - The circuit breaker name (e.g., "tool-execution-bitbucket-server-add_comment") --- @@ -72,8 +66,6 @@ The circuit breaker name (e.g., "tool-execution-bitbucket-server-add_comment") > `readonly` **retryAfter**: `string` -Defined in: [types/circuitBreakerErrors.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/circuitBreakerErrors.ts#L18) - ISO timestamp when the circuit breaker will transition to half-open and allow a retry --- @@ -82,8 +74,6 @@ ISO timestamp when the circuit breaker will transition to half-open and allow a > `readonly` **retryAfterMs**: `number` -Defined in: [types/circuitBreakerErrors.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/circuitBreakerErrors.ts#L20) - Milliseconds until the circuit breaker will allow a retry --- @@ -92,8 +82,6 @@ Milliseconds until the circuit breaker will allow a retry > `readonly` **breakerState**: [`CircuitBreakerState`](../type-aliases/CircuitBreakerState.md) -Defined in: [types/circuitBreakerErrors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/circuitBreakerErrors.ts#L22) - Current circuit breaker state ("open" or "half-open") --- @@ -102,6 +90,4 @@ Current circuit breaker state ("open" or "half-open") > `readonly` **failureCount**: `number` -Defined in: [types/circuitBreakerErrors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/circuitBreakerErrors.ts#L24) - Number of failures that caused the circuit to open diff --git a/docs/api/classes/ClassifierRouter.md b/docs/api/classes/ClassifierRouter.md index 33f0640fa..174a2e4c0 100644 --- a/docs/api/classes/ClassifierRouter.md +++ b/docs/api/classes/ClassifierRouter.md @@ -6,8 +6,6 @@ # Class: ClassifierRouter -Defined in: [routing/classifierRouter.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierRouter.ts#L68) - ModelPool and RequestRouter — opt-in multi-provider failover with error-class-aware cooldown, and a pluggable pre-call provider/model router. @@ -42,8 +40,6 @@ const router = createDefaultRequestRouter({ > **new ClassifierRouter**(`config`, `deps?`): `ClassifierRouter` -Defined in: [routing/classifierRouter.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierRouter.ts#L82) - #### Parameters ##### config @@ -64,8 +60,6 @@ Defined in: [routing/classifierRouter.ts:82](https://github.com/juspay/neurolink > **setPool**(`members`): `number` -Defined in: [routing/classifierRouter.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierRouter.ts#L121) - Replace the routable pool at runtime. Returns the new size. Clears the metadata cache, since a member's declared cost/quality is @@ -88,8 +82,6 @@ values for the same pair. > **getPool**(): [`ClassifierRouterPoolMember`](../type-aliases/ClassifierRouterPoolMember.md)[] -Defined in: [routing/classifierRouter.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierRouter.ts#L128) - The pool currently routed over, declared plus catalogue. #### Returns @@ -102,8 +94,6 @@ The pool currently routed over, declared plus catalogue. > **refreshCatalog**(): `number` -Defined in: [routing/classifierRouter.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierRouter.ts#L133) - Rebuild the catalogue half of the pool (e.g. after credentials change). #### Returns @@ -116,8 +106,6 @@ Rebuild the catalogue half of the pool (e.g. after credentials change). > **route**(`input`): `Promise`\<[`ClassifierRouterDecision`](../type-aliases/ClassifierRouterDecision.md) \| `null`\> -Defined in: [routing/classifierRouter.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierRouter.ts#L143) - Classify the request and produce a combined model + tool decision, or `null` when nothing should change. Never throws (fails open). diff --git a/docs/api/classes/ClientAuthenticationError.md b/docs/api/classes/ClientAuthenticationError.md index b240a5f69..bfeb3abd6 100644 --- a/docs/api/classes/ClientAuthenticationError.md +++ b/docs/api/classes/ClientAuthenticationError.md @@ -6,8 +6,6 @@ # Class: ClientAuthenticationError -Defined in: [client/errors.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L241) - Error for authentication failures (401) ## Extends @@ -20,8 +18,6 @@ Error for authentication failures (401) > **new ClientAuthenticationError**(`message?`, `options?`): `ClientAuthenticationError` -Defined in: [client/errors.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L242) - #### Parameters ##### message? @@ -52,8 +48,6 @@ Defined in: [client/errors.ts:242](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -66,8 +60,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -80,8 +72,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -94,8 +84,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -108,8 +96,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -122,8 +108,6 @@ Request ID for error tracking > `readonly` `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [client/errors.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L146) - HTTP response headers #### Inherited from @@ -136,8 +120,6 @@ HTTP response headers > `readonly` `optional` **body?**: `unknown` -Defined in: [client/errors.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L148) - HTTP response body #### Inherited from @@ -150,8 +132,6 @@ HTTP response body > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -168,8 +148,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientAuthorizationError.md b/docs/api/classes/ClientAuthorizationError.md index 6aa128ef4..fdeafb79d 100644 --- a/docs/api/classes/ClientAuthorizationError.md +++ b/docs/api/classes/ClientAuthorizationError.md @@ -6,8 +6,6 @@ # Class: ClientAuthorizationError -Defined in: [client/errors.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L262) - Error for authorization failures (403) ## Extends @@ -20,8 +18,6 @@ Error for authorization failures (403) > **new ClientAuthorizationError**(`message?`, `options?`): `ClientAuthorizationError` -Defined in: [client/errors.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L263) - #### Parameters ##### message? @@ -52,8 +48,6 @@ Defined in: [client/errors.ts:263](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -66,8 +60,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -80,8 +72,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -94,8 +84,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -108,8 +96,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -122,8 +108,6 @@ Request ID for error tracking > `readonly` `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [client/errors.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L146) - HTTP response headers #### Inherited from @@ -136,8 +120,6 @@ HTTP response headers > `readonly` `optional` **body?**: `unknown` -Defined in: [client/errors.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L148) - HTTP response body #### Inherited from @@ -150,8 +132,6 @@ HTTP response body > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -168,8 +148,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientConfigurationError.md b/docs/api/classes/ClientConfigurationError.md index 4fc5515f0..b5383fe81 100644 --- a/docs/api/classes/ClientConfigurationError.md +++ b/docs/api/classes/ClientConfigurationError.md @@ -6,8 +6,6 @@ # Class: ClientConfigurationError -Defined in: [client/errors.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L433) - Error for configuration issues ## Extends @@ -20,8 +18,6 @@ Error for configuration issues > **new ClientConfigurationError**(`message`, `options?`): `ClientConfigurationError` -Defined in: [client/errors.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L437) - #### Parameters ##### message @@ -52,8 +48,6 @@ Defined in: [client/errors.ts:437](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -66,8 +60,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -80,8 +72,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -94,8 +84,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -108,8 +96,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -122,8 +108,6 @@ Request ID for error tracking > `readonly` `optional` **field?**: `string` -Defined in: [client/errors.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L435) - Configuration field with issue ## Methods @@ -132,8 +116,6 @@ Configuration field with issue > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -150,8 +132,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientConnectionError.md b/docs/api/classes/ClientConnectionError.md index ccc6e4a22..bd139b8a7 100644 --- a/docs/api/classes/ClientConnectionError.md +++ b/docs/api/classes/ClientConnectionError.md @@ -6,8 +6,6 @@ # Class: ClientConnectionError -Defined in: [client/errors.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L374) - Error for connection refused ## Extends @@ -20,8 +18,6 @@ Error for connection refused > **new ClientConnectionError**(`message?`, `options?`): `ClientConnectionError` -Defined in: [client/errors.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L380) - #### Parameters ##### message? @@ -64,8 +60,6 @@ Defined in: [client/errors.ts:380](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -78,8 +72,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -92,8 +84,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -106,8 +96,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -120,8 +108,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -134,8 +120,6 @@ Request ID for error tracking > `readonly` `optional` **host?**: `string` -Defined in: [client/errors.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L376) - Target host --- @@ -144,8 +128,6 @@ Target host > `readonly` `optional` **port?**: `number` -Defined in: [client/errors.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L378) - Target port ## Methods @@ -154,8 +136,6 @@ Target port > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -172,8 +152,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientNetworkError.md b/docs/api/classes/ClientNetworkError.md index ddfcdb6fc..494ae0911 100644 --- a/docs/api/classes/ClientNetworkError.md +++ b/docs/api/classes/ClientNetworkError.md @@ -6,8 +6,6 @@ # Class: ClientNetworkError -Defined in: [client/errors.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L321) - Error for network-related failures ## Extends @@ -25,8 +23,6 @@ Error for network-related failures > **new ClientNetworkError**(`message?`, `options?`): `ClientNetworkError` -Defined in: [client/errors.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L322) - #### Parameters ##### message? @@ -65,8 +61,6 @@ Defined in: [client/errors.ts:322](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -79,8 +73,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -93,8 +85,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -107,8 +97,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -121,8 +109,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -135,8 +121,6 @@ Request ID for error tracking > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -153,8 +137,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientNeuroLinkError.md b/docs/api/classes/ClientNeuroLinkError.md index 5e947b6f9..887f8e748 100644 --- a/docs/api/classes/ClientNeuroLinkError.md +++ b/docs/api/classes/ClientNeuroLinkError.md @@ -6,8 +6,6 @@ # Class: ClientNeuroLinkError -Defined in: [client/errors.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L74) - Base error class for all NeuroLink client errors Provides consistent error structure with error codes, status codes, @@ -32,8 +30,6 @@ and additional metadata. > **new ClientNeuroLinkError**(`message`, `code?`, `options?`): `NeuroLinkError` -Defined in: [client/errors.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L86) - #### Parameters ##### message @@ -80,8 +76,6 @@ Defined in: [client/errors.ts:86](https://github.com/juspay/neurolink/blob/relea > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling --- @@ -90,8 +84,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) --- @@ -100,8 +92,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details --- @@ -110,8 +100,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable --- @@ -120,8 +108,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking ## Methods @@ -130,8 +116,6 @@ Request ID for error tracking > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -144,8 +128,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientProviderError.md b/docs/api/classes/ClientProviderError.md index 48739e1fd..c0e814efd 100644 --- a/docs/api/classes/ClientProviderError.md +++ b/docs/api/classes/ClientProviderError.md @@ -6,8 +6,6 @@ # Class: ClientProviderError -Defined in: [client/errors.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L487) - Error from AI provider ## Extends @@ -25,8 +23,6 @@ Error from AI provider > **new ClientProviderError**(`message`, `options?`): `ClientProviderError` -Defined in: [client/errors.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L495) - #### Parameters ##### message @@ -77,8 +73,6 @@ Defined in: [client/errors.ts:495](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -91,8 +85,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -105,8 +97,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -119,8 +109,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -133,8 +121,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -147,8 +133,6 @@ Request ID for error tracking > `readonly` `optional` **provider?**: `string` -Defined in: [client/errors.ts:489](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L489) - Provider name --- @@ -157,8 +141,6 @@ Provider name > `readonly` `optional` **model?**: `string` -Defined in: [client/errors.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L491) - Model name --- @@ -167,8 +149,6 @@ Model name > `readonly` `optional` **providerError?**: `unknown` -Defined in: [client/errors.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L493) - Original provider error ## Methods @@ -177,8 +157,6 @@ Original provider error > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -195,8 +173,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientRateLimitError.md b/docs/api/classes/ClientRateLimitError.md index 839989d4b..625ccbab4 100644 --- a/docs/api/classes/ClientRateLimitError.md +++ b/docs/api/classes/ClientRateLimitError.md @@ -6,8 +6,6 @@ # Class: ClientRateLimitError -Defined in: [client/errors.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L180) - Error for rate limiting (429) ## Extends @@ -20,8 +18,6 @@ Error for rate limiting (429) > **new ClientRateLimitError**(`message?`, `options?`): `ClientRateLimitError` -Defined in: [client/errors.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L186) - #### Parameters ##### message? @@ -60,8 +56,6 @@ Defined in: [client/errors.ts:186](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -74,8 +68,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -88,8 +80,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -102,8 +92,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -116,8 +104,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -130,8 +116,6 @@ Request ID for error tracking > `readonly` `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [client/errors.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L146) - HTTP response headers #### Inherited from @@ -144,8 +128,6 @@ HTTP response headers > `readonly` `optional` **body?**: `unknown` -Defined in: [client/errors.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L148) - HTTP response body #### Inherited from @@ -158,8 +140,6 @@ HTTP response body > `readonly` `optional` **retryAfter?**: `number` -Defined in: [client/errors.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L182) - Retry-After value in seconds (if provided) --- @@ -168,8 +148,6 @@ Retry-After value in seconds (if provided) > `readonly` `optional` **resetAt?**: `Date` -Defined in: [client/errors.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L184) - Rate limit reset time ## Methods @@ -178,8 +156,6 @@ Rate limit reset time > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -196,8 +172,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientTimeoutError.md b/docs/api/classes/ClientTimeoutError.md index aae07f58c..dc5f0f5eb 100644 --- a/docs/api/classes/ClientTimeoutError.md +++ b/docs/api/classes/ClientTimeoutError.md @@ -6,8 +6,6 @@ # Class: ClientTimeoutError -Defined in: [client/errors.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L345) - Error for request timeout ## Extends @@ -20,8 +18,6 @@ Error for request timeout > **new ClientTimeoutError**(`timeoutMs`, `message?`, `options?`): `ClientTimeoutError` -Defined in: [client/errors.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L349) - #### Parameters ##### timeoutMs @@ -56,8 +52,6 @@ Defined in: [client/errors.ts:349](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -70,8 +64,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -84,8 +76,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -98,8 +88,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -112,8 +100,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -126,8 +112,6 @@ Request ID for error tracking > `readonly` **timeoutMs**: `number` -Defined in: [client/errors.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L347) - Timeout duration in milliseconds ## Methods @@ -136,8 +120,6 @@ Timeout duration in milliseconds > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -154,8 +136,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ClientValidationError.md b/docs/api/classes/ClientValidationError.md index 38f5ff393..74f1cb2bf 100644 --- a/docs/api/classes/ClientValidationError.md +++ b/docs/api/classes/ClientValidationError.md @@ -6,8 +6,6 @@ # Class: ClientValidationError -Defined in: [client/errors.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L210) - Error for validation failures (400) ## Extends @@ -20,8 +18,6 @@ Error for validation failures (400) > **new ClientValidationError**(`message?`, `options?`): `ClientValidationError` -Defined in: [client/errors.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L214) - #### Parameters ##### message? @@ -56,8 +52,6 @@ Defined in: [client/errors.ts:214](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -70,8 +64,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -84,8 +76,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -98,8 +88,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -112,8 +100,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -126,8 +112,6 @@ Request ID for error tracking > `readonly` `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [client/errors.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L146) - HTTP response headers #### Inherited from @@ -140,8 +124,6 @@ HTTP response headers > `readonly` `optional` **body?**: `unknown` -Defined in: [client/errors.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L148) - HTTP response body #### Inherited from @@ -154,8 +136,6 @@ HTTP response body > `readonly` `optional` **fieldErrors?**: `Record`\<`string`, `string`[]\> -Defined in: [client/errors.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L212) - Field-level validation errors ## Methods @@ -164,8 +144,6 @@ Field-level validation errors > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -182,8 +160,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/CohereRelevanceScorer.md b/docs/api/classes/CohereRelevanceScorer.md index 96c47cd63..6753d29eb 100644 --- a/docs/api/classes/CohereRelevanceScorer.md +++ b/docs/api/classes/CohereRelevanceScorer.md @@ -6,8 +6,6 @@ # Class: CohereRelevanceScorer -Defined in: [rag/reranker/reranker.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L370) - Cohere-style relevance scorer interface Placeholder for integration with Cohere's rerank API @@ -17,8 +15,6 @@ Placeholder for integration with Cohere's rerank API > **new CohereRelevanceScorer**(`modelName?`): `CohereRelevanceScorer` -Defined in: [rag/reranker/reranker.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L373) - #### Parameters ##### modelName? @@ -35,8 +31,6 @@ Defined in: [rag/reranker/reranker.ts:373](https://github.com/juspay/neurolink/b > **score**(`_query`, `_documents`): `Promise`\<`object`[]\> -Defined in: [rag/reranker/reranker.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L377) - #### Parameters ##### \_query diff --git a/docs/api/classes/ConfigManager.md b/docs/api/classes/ConfigManager.md index 3875ea2a3..2c51baf91 100644 --- a/docs/api/classes/ConfigManager.md +++ b/docs/api/classes/ConfigManager.md @@ -6,8 +6,6 @@ # Class: ConfigManager -Defined in: [config/configManager.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L25) - Enhanced Config Manager with automatic backup/restore capabilities ## Constructors @@ -26,8 +24,6 @@ Enhanced Config Manager with automatic backup/restore capabilities > **loadConfig**(): `Promise`\<[`NeuroLinkConfig`](../type-aliases/NeuroLinkConfig.md)\> -Defined in: [config/configManager.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L37) - Load configuration with caching #### Returns @@ -40,8 +36,6 @@ Load configuration with caching > **updateConfig**(`updates`, `options?`): `Promise`\<`void`\> -Defined in: [config/configManager.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L47) - Update configuration with automatic backup #### Parameters @@ -64,8 +58,6 @@ Update configuration with automatic backup > **createBackup**(`reason?`): `Promise`\<`string`\> -Defined in: [config/configManager.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L107) - Create a backup with metadata #### Parameters @@ -84,8 +76,6 @@ Create a backup with metadata > **listBackups**(): `Promise`\<[`BackupInfo`](../type-aliases/BackupInfo.md)[]\> -Defined in: [config/configManager.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L141) - List all available backups #### Returns @@ -98,8 +88,6 @@ List all available backups > **restoreFromBackup**(`backupFilename`): `Promise`\<`void`\> -Defined in: [config/configManager.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L185) - Restore from specific backup #### Parameters @@ -118,8 +106,6 @@ Restore from specific backup > **restoreLatestBackup**(): `Promise`\<`void`\> -Defined in: [config/configManager.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L218) - Restore from latest backup #### Returns @@ -132,8 +118,6 @@ Restore from latest backup > **cleanupOldBackups**(`keepCount?`): `Promise`\<`void`\> -Defined in: [config/configManager.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L230) - Clean up old backups #### Parameters @@ -152,8 +136,6 @@ Clean up old backups > **updateProviderStatus**(`providerId`, `status`): `Promise`\<`void`\> -Defined in: [config/configManager.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L250) - Update provider status #### Parameters @@ -176,8 +158,6 @@ Update provider status > **validateConfig**(`config`): `Promise`\<[`ConfigValidationResult`](../type-aliases/ConfigValidationResult.md)\> -Defined in: [config/configManager.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L274) - Validate configuration #### Parameters @@ -196,8 +176,6 @@ Validate configuration > **generateDefaultConfig**(): `Promise`\<[`NeuroLinkConfig`](../type-aliases/NeuroLinkConfig.md)\> -Defined in: [config/configManager.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/config/configManager.ts#L326) - Generate default configuration #### Returns diff --git a/docs/api/classes/ConfigurationError.md b/docs/api/classes/ConfigurationError.md index 2ad299d84..98233b6a5 100644 --- a/docs/api/classes/ConfigurationError.md +++ b/docs/api/classes/ConfigurationError.md @@ -6,8 +6,6 @@ # Class: ConfigurationError -Defined in: [server/errors.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L113) - Configuration error ## Extends @@ -20,8 +18,6 @@ Configuration error > **new ConfigurationError**(`message`, `details?`, `cause?`): `ConfigurationError` -Defined in: [server/errors.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L114) - #### Parameters ##### message @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:114](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ContentFilterError.md b/docs/api/classes/ContentFilterError.md index ca14e1e51..705313817 100644 --- a/docs/api/classes/ContentFilterError.md +++ b/docs/api/classes/ContentFilterError.md @@ -6,8 +6,6 @@ # Class: ContentFilterError -Defined in: [client/errors.ts:568](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L568) - Error for content filtering ## Extends @@ -20,8 +18,6 @@ Error for content filtering > **new ContentFilterError**(`message?`, `options?`): `ContentFilterError` -Defined in: [client/errors.ts:572](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L572) - #### Parameters ##### message? @@ -60,8 +56,6 @@ Defined in: [client/errors.ts:572](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -74,8 +68,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -88,8 +80,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -102,8 +92,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -116,8 +104,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -130,8 +116,6 @@ Request ID for error tracking > `readonly` `optional` **provider?**: `string` -Defined in: [client/errors.ts:489](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L489) - Provider name #### Inherited from @@ -144,8 +128,6 @@ Provider name > `readonly` `optional` **model?**: `string` -Defined in: [client/errors.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L491) - Model name #### Inherited from @@ -158,8 +140,6 @@ Model name > `readonly` `optional` **providerError?**: `unknown` -Defined in: [client/errors.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L493) - Original provider error #### Inherited from @@ -172,8 +152,6 @@ Original provider error > `readonly` `optional` **category?**: `string` -Defined in: [client/errors.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L570) - Filter category that triggered ## Methods @@ -182,8 +160,6 @@ Filter category that triggered > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -200,8 +176,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ContextBuilder.md b/docs/api/classes/ContextBuilder.md index 03fbd45c1..fad737d9d 100644 --- a/docs/api/classes/ContextBuilder.md +++ b/docs/api/classes/ContextBuilder.md @@ -6,8 +6,6 @@ # Class: ContextBuilder -Defined in: [evaluation/contextBuilder.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/contextBuilder.ts#L23) - Builds the enhanced context required for a RAGAS-style evaluation. This class gathers data from the generation options and results to create a rich snapshot of the interaction, which is then used by the evaluator. @@ -28,8 +26,6 @@ rich snapshot of the interaction, which is then used by the evaluator. > **buildContext**(`options`, `result`): [`EnhancedEvaluationContext`](../type-aliases/EnhancedEvaluationContext.md) -Defined in: [evaluation/contextBuilder.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/contextBuilder.ts#L50) - Builds the full evaluation context for a single evaluation attempt. #### Parameters @@ -58,8 +54,6 @@ An `EnhancedEvaluationContext` object ready for evaluation. > **recordEvaluation**(`evaluation`): `void` -Defined in: [evaluation/contextBuilder.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/contextBuilder.ts#L108) - Records the result of an evaluation and increments the internal attempt counter. This is used to build up the `previousEvaluations` array for subsequent retries. @@ -81,8 +75,6 @@ The `EvaluationResult` from the last attempt. > **reset**(): `void` -Defined in: [evaluation/contextBuilder.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/contextBuilder.ts#L117) - Resets the internal state of the context builder. This should be called before starting a new, independent evaluation sequence. diff --git a/docs/api/classes/ContextConverter.md b/docs/api/classes/ContextConverter.md index aabbb0b3d..a477b243b 100644 --- a/docs/api/classes/ContextConverter.md +++ b/docs/api/classes/ContextConverter.md @@ -6,8 +6,6 @@ # Class: ContextConverter -Defined in: [types/context.ts:463](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L463) - ## Constructors ### Constructor @@ -24,8 +22,6 @@ Defined in: [types/context.ts:463](https://github.com/juspay/neurolink/blob/rele > `static` **convertBusinessContext**(`legacyContext`, `domainType`, `options?`): [`ExecutionContext`](../type-aliases/ExecutionContext.md) -Defined in: [types/context.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L468) - Convert legacy business context to generic domain context Based on business context patterns @@ -53,8 +49,6 @@ Based on business context patterns > `static` **createDomainContext**(`domainType`, `domainData`, `sessionInfo?`): [`ExecutionContext`](../type-aliases/ExecutionContext.md) -Defined in: [types/context.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L532) - Create execution context for required domain #### Parameters diff --git a/docs/api/classes/ContextFactory.md b/docs/api/classes/ContextFactory.md index bb8252900..70e52f179 100644 --- a/docs/api/classes/ContextFactory.md +++ b/docs/api/classes/ContextFactory.md @@ -6,8 +6,6 @@ # Class: ContextFactory -Defined in: [types/context.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L100) - Factory for context processing ## Constructors @@ -26,8 +24,6 @@ Factory for context processing > `readonly` `static` **DEFAULT_FRAMEWORK_FIELDS**: [`FrameworkFieldsConfig`](../type-aliases/FrameworkFieldsConfig.md) -Defined in: [types/context.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L104) - Default framework fields configuration --- @@ -36,8 +32,6 @@ Default framework fields configuration > `readonly` `static` **DEFAULT_CONFIG**: [`ContextConfig`](../type-aliases/ContextConfig.md) -Defined in: [types/context.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L235) - Default context configuration ## Methods @@ -46,8 +40,6 @@ Default context configuration > `static` **configureFrameworkFields**(`config`): `void` -Defined in: [types/context.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L139) - Configure framework fields for exclusion from custom data #### Parameters @@ -66,8 +58,6 @@ Configure framework fields for exclusion from custom data > `static` **getFrameworkFieldsConfig**(): [`FrameworkFieldsConfig`](../type-aliases/FrameworkFieldsConfig.md) -Defined in: [types/context.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L153) - Get current framework fields configuration Ensures lazy initialization if not already loaded @@ -81,8 +71,6 @@ Ensures lazy initialization if not already loaded > `static` **resetFrameworkFieldsConfig**(): `void` -Defined in: [types/context.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L165) - Reset framework fields configuration to default #### Returns @@ -95,8 +83,6 @@ Reset framework fields configuration to default > `static` **loadFrameworkFieldsFromEnv**(): `void` -Defined in: [types/context.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L175) - Load framework fields configuration from environment variables Supports NEUROLINK_CONTEXT_EXCLUDE_FIELDS and NEUROLINK_CONTEXT_INCLUDE_FIELDS @@ -110,8 +96,6 @@ Supports NEUROLINK_CONTEXT_EXCLUDE_FIELDS and NEUROLINK_CONTEXT_INCLUDE_FIELDS > `static` **addFrameworkFieldsToExclude**(`fields`): `void` -Defined in: [types/context.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L215) - Add additional fields to exclude #### Parameters @@ -130,8 +114,6 @@ Add additional fields to exclude > `static` **addFrameworkFieldsToInclude**(`fields`): `void` -Defined in: [types/context.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L225) - Add fields to include (override exclusion) #### Parameters @@ -150,8 +132,6 @@ Add fields to include (override exclusion) > `static` **validateContext**(`context`): [`BaseContext`](../type-aliases/BaseContext.md) \| `null` -Defined in: [types/context.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L246) - Validate and normalize context data #### Parameters @@ -170,8 +150,6 @@ Validate and normalize context data > `static` **processContext**(`context`, `config?`): `ProcessedContext` -Defined in: [types/context.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L270) - Process context for AI generation based on configuration #### Parameters @@ -194,8 +172,6 @@ Process context for AI generation based on configuration > `static` **extractAnalyticsContext**(`context`): [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [types/context.ts:421](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L421) - Extract analytics data from context #### Parameters @@ -214,8 +190,6 @@ Extract analytics data from context > `static` **extractEvaluationContext**(`context`): [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [types/context.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L435) - Extract evaluation context #### Parameters diff --git a/docs/api/classes/ContextLengthError.md b/docs/api/classes/ContextLengthError.md index 1794f2689..d040a45e1 100644 --- a/docs/api/classes/ContextLengthError.md +++ b/docs/api/classes/ContextLengthError.md @@ -6,8 +6,6 @@ # Class: ContextLengthError -Defined in: [client/errors.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L528) - Error for context length exceeded ## Extends @@ -20,8 +18,6 @@ Error for context length exceeded > **new ContextLengthError**(`message?`, `options?`): `ContextLengthError` -Defined in: [client/errors.ts:534](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L534) - #### Parameters ##### message? @@ -64,8 +60,6 @@ Defined in: [client/errors.ts:534](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -78,8 +72,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -92,8 +84,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -106,8 +96,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -120,8 +108,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -134,8 +120,6 @@ Request ID for error tracking > `readonly` `optional` **provider?**: `string` -Defined in: [client/errors.ts:489](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L489) - Provider name #### Inherited from @@ -148,8 +132,6 @@ Provider name > `readonly` `optional` **model?**: `string` -Defined in: [client/errors.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L491) - Model name #### Inherited from @@ -162,8 +144,6 @@ Model name > `readonly` `optional` **providerError?**: `unknown` -Defined in: [client/errors.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L493) - Original provider error #### Inherited from @@ -176,8 +156,6 @@ Original provider error > `readonly` `optional` **maxTokens?**: `number` -Defined in: [client/errors.ts:530](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L530) - Maximum allowed tokens --- @@ -186,8 +164,6 @@ Maximum allowed tokens > `readonly` `optional` **requestedTokens?**: `number` -Defined in: [client/errors.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L532) - Requested tokens ## Methods @@ -196,8 +172,6 @@ Requested tokens > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -214,8 +188,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/ContextPrecisionScorer.md b/docs/api/classes/ContextPrecisionScorer.md index f5147c582..0a02592df 100644 --- a/docs/api/classes/ContextPrecisionScorer.md +++ b/docs/api/classes/ContextPrecisionScorer.md @@ -6,8 +6,6 @@ # Class: ContextPrecisionScorer -Defined in: [evaluation/scorers/llm/contextPrecisionScorer.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextPrecisionScorer.ts#L35) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new ContextPrecisionScorer**(`config?`): `ContextPrecisionScorer` -Defined in: [evaluation/scorers/llm/contextPrecisionScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextPrecisionScorer.ts#L36) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/contextPrecisionScorer.ts:36](https://github > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/contextPrecisionScorer.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextPrecisionScorer.ts#L60) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/contextPrecisionScorer.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextPrecisionScorer.ts#L83) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/ContextRelevancyScorer.md b/docs/api/classes/ContextRelevancyScorer.md index 703ab1ca4..e1c263fda 100644 --- a/docs/api/classes/ContextRelevancyScorer.md +++ b/docs/api/classes/ContextRelevancyScorer.md @@ -6,8 +6,6 @@ # Class: ContextRelevancyScorer -Defined in: [evaluation/scorers/llm/contextRelevancyScorer.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextRelevancyScorer.ts#L50) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new ContextRelevancyScorer**(`config?`): `ContextRelevancyScorer` -Defined in: [evaluation/scorers/llm/contextRelevancyScorer.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextRelevancyScorer.ts#L51) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/contextRelevancyScorer.ts:51](https://github > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/contextRelevancyScorer.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextRelevancyScorer.ts#L75) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/contextRelevancyScorer.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextRelevancyScorer.ts#L92) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/ConversationMemoryError.md b/docs/api/classes/ConversationMemoryError.md index 6453295ab..83359d9f2 100644 --- a/docs/api/classes/ConversationMemoryError.md +++ b/docs/api/classes/ConversationMemoryError.md @@ -6,8 +6,6 @@ # Class: ConversationMemoryError -Defined in: [types/conversation.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L449) - Error types specific to conversation memory ## Extends @@ -20,8 +18,6 @@ Error types specific to conversation memory > **new ConversationMemoryError**(`message`, `code`, `details?`): `ConversationMemoryError` -Defined in: [types/conversation.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L450) - #### Parameters ##### message @@ -50,12 +46,8 @@ Defined in: [types/conversation.ts:450](https://github.com/juspay/neurolink/blob > **code**: `"STORAGE_ERROR"` \| `"CONFIG_ERROR"` \| `"SESSION_NOT_FOUND"` \| `"CLEANUP_ERROR"` -Defined in: [types/conversation.ts:452](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L452) - --- ### details? > `optional` **details?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/conversation.ts:457](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L457) diff --git a/docs/api/classes/CrossEncoderReranker.md b/docs/api/classes/CrossEncoderReranker.md index 1d69b9857..c3ded9d14 100644 --- a/docs/api/classes/CrossEncoderReranker.md +++ b/docs/api/classes/CrossEncoderReranker.md @@ -6,8 +6,6 @@ # Class: CrossEncoderReranker -Defined in: [rag/reranker/reranker.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L393) - Cross-encoder style reranker interface Placeholder for integration with cross-encoder models @@ -17,8 +15,6 @@ Placeholder for integration with cross-encoder models > **new CrossEncoderReranker**(`modelName?`): `CrossEncoderReranker` -Defined in: [rag/reranker/reranker.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L396) - #### Parameters ##### modelName? @@ -35,8 +31,6 @@ Defined in: [rag/reranker/reranker.ts:396](https://github.com/juspay/neurolink/b > **rerank**(`_query`, `_documents`): `Promise`\<`object`[]\> -Defined in: [rag/reranker/reranker.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L400) - #### Parameters ##### \_query diff --git a/docs/api/classes/DIDAvatar.md b/docs/api/classes/DIDAvatar.md index ff82e3fa7..38099f05d 100644 --- a/docs/api/classes/DIDAvatar.md +++ b/docs/api/classes/DIDAvatar.md @@ -6,8 +6,6 @@ # Class: DIDAvatar -Defined in: [avatar/providers/DIDAvatar.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/DIDAvatar.ts#L47) - D-ID Avatar Handler. Auth: `Authorization: Basic ${DID_API_KEY}` (the API key is @@ -25,8 +23,6 @@ Env vars: `DID_API_KEY` (preferred) / `D_ID_API_KEY` (legacy alias). > **new DIDAvatar**(`apiKey?`): `DIDAvatar` -Defined in: [avatar/providers/DIDAvatar.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/DIDAvatar.ts#L54) - #### Parameters ##### apiKey? @@ -43,8 +39,6 @@ Defined in: [avatar/providers/DIDAvatar.ts:54](https://github.com/juspay/neuroli > `readonly` **maxAudioDurationSeconds**: `60` = `60` -Defined in: [avatar/providers/DIDAvatar.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/DIDAvatar.ts#L48) - Maximum supported audio length in seconds (provider-specific). #### Implementation of @@ -57,8 +51,6 @@ Maximum supported audio length in seconds (provider-specific). > `readonly` **supportedFormats**: readonly [`AvatarVideoFormat`](../type-aliases/AvatarVideoFormat.md)[] -Defined in: [avatar/providers/DIDAvatar.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/DIDAvatar.ts#L49) - Output formats supported by this handler. #### Implementation of @@ -71,8 +63,6 @@ Output formats supported by this handler. > **isConfigured**(): `boolean` -Defined in: [avatar/providers/DIDAvatar.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/DIDAvatar.ts#L69) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -89,8 +79,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`options`): `Promise`\<[`AvatarResult`](../type-aliases/AvatarResult.md)\> -Defined in: [avatar/providers/DIDAvatar.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/DIDAvatar.ts#L73) - Generate a talking-head video from an image + audio (or pre-rendered text). #### Parameters diff --git a/docs/api/classes/DeepgramSTT.md b/docs/api/classes/DeepgramSTT.md index dff12f18c..0ba08dd86 100644 --- a/docs/api/classes/DeepgramSTT.md +++ b/docs/api/classes/DeepgramSTT.md @@ -6,8 +6,6 @@ # Class: DeepgramSTT -Defined in: [voice/providers/DeepgramSTT.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L30) - Deepgram Speech-to-Text Handler Supports real-time streaming, speaker diarization, and smart formatting. @@ -26,8 +24,6 @@ https://developers.deepgram.com/docs > **new DeepgramSTT**(`apiKey?`): `DeepgramSTT` -Defined in: [voice/providers/DeepgramSTT.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L44) - #### Parameters ##### apiKey? @@ -44,8 +40,6 @@ Defined in: [voice/providers/DeepgramSTT.ts:44](https://github.com/juspay/neurol > `readonly` **maxAudioDuration**: `7200` = `7200` -Defined in: [voice/providers/DeepgramSTT.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L37) - Maximum audio duration in seconds (2 hours) #### Implementation of @@ -58,8 +52,6 @@ Maximum audio duration in seconds (2 hours) > `readonly` **supportsStreaming**: `true` = `true` -Defined in: [voice/providers/DeepgramSTT.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L42) - Deepgram supports streaming #### Implementation of @@ -72,8 +64,6 @@ Deepgram supports streaming > **isConfigured**(): `boolean` -Defined in: [voice/providers/DeepgramSTT.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L52) - #### Returns `boolean` @@ -88,8 +78,6 @@ Defined in: [voice/providers/DeepgramSTT.ts:52](https://github.com/juspay/neurol > **getSupportedFormats**(): [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] -Defined in: [voice/providers/DeepgramSTT.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L56) - #### Returns [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] @@ -104,8 +92,6 @@ Defined in: [voice/providers/DeepgramSTT.ts:56](https://github.com/juspay/neurol > **getSupportedLanguages**(): `Promise`\<[`STTLanguage`](../type-aliases/STTLanguage.md)[]\> -Defined in: [voice/providers/DeepgramSTT.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L60) - #### Returns `Promise`\<[`STTLanguage`](../type-aliases/STTLanguage.md)[]\> @@ -120,8 +106,6 @@ Defined in: [voice/providers/DeepgramSTT.ts:60](https://github.com/juspay/neurol > **transcribe**(`audio`, `options?`): `Promise`\<[`STTResult`](../type-aliases/STTResult.md)\> -Defined in: [voice/providers/DeepgramSTT.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L150) - #### Parameters ##### audio @@ -146,8 +130,6 @@ Defined in: [voice/providers/DeepgramSTT.ts:150](https://github.com/juspay/neuro > **transcribeStream**(`audioStream`, `options`): `AsyncIterable`\<[`TranscriptionSegment`](../type-aliases/TranscriptionSegment.md)\> -Defined in: [voice/providers/DeepgramSTT.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/DeepgramSTT.ts#L380) - Streaming transcription using WebSocket #### Parameters diff --git a/docs/api/classes/ElevenLabsMusic.md b/docs/api/classes/ElevenLabsMusic.md index 415767632..cb622b167 100644 --- a/docs/api/classes/ElevenLabsMusic.md +++ b/docs/api/classes/ElevenLabsMusic.md @@ -6,8 +6,6 @@ # Class: ElevenLabsMusic -Defined in: [music/providers/ElevenLabsMusic.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ElevenLabsMusic.ts#L34) - ElevenLabs Music / Sound Generation Handler. Auth: `xi-api-key: ${ELEVENLABS_API_KEY}` (shares the same env var as @@ -26,8 +24,6 @@ music loops up to 22 seconds. > **new ElevenLabsMusic**(`apiKey?`): `ElevenLabsMusic` -Defined in: [music/providers/ElevenLabsMusic.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ElevenLabsMusic.ts#L49) - #### Parameters ##### apiKey? @@ -44,8 +40,6 @@ Defined in: [music/providers/ElevenLabsMusic.ts:49](https://github.com/juspay/ne > `readonly` **maxDurationSeconds**: `22` = `22` -Defined in: [music/providers/ElevenLabsMusic.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ElevenLabsMusic.ts#L35) - Maximum supported track duration in seconds (provider-specific). #### Implementation of @@ -58,8 +52,6 @@ Maximum supported track duration in seconds (provider-specific). > `readonly` **supportedFormats**: readonly [`MusicAudioFormat`](../type-aliases/MusicAudioFormat.md)[] -Defined in: [music/providers/ElevenLabsMusic.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ElevenLabsMusic.ts#L36) - Output formats supported by this handler. #### Implementation of @@ -72,8 +64,6 @@ Output formats supported by this handler. > `readonly` **supportedGenres**: readonly `string`[] -Defined in: [music/providers/ElevenLabsMusic.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ElevenLabsMusic.ts#L37) - Genres / styles the upstream advertises (informational). #### Implementation of @@ -86,8 +76,6 @@ Genres / styles the upstream advertises (informational). > **isConfigured**(): `boolean` -Defined in: [music/providers/ElevenLabsMusic.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ElevenLabsMusic.ts#L57) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -104,8 +92,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`options`): `Promise`\<[`MusicResult`](../type-aliases/MusicResult.md)\> -Defined in: [music/providers/ElevenLabsMusic.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ElevenLabsMusic.ts#L61) - Generate a music track from prompt + options. #### Parameters diff --git a/docs/api/classes/ElevenLabsTTS.md b/docs/api/classes/ElevenLabsTTS.md index 2f7c037f6..5903497a0 100644 --- a/docs/api/classes/ElevenLabsTTS.md +++ b/docs/api/classes/ElevenLabsTTS.md @@ -6,8 +6,6 @@ # Class: ElevenLabsTTS -Defined in: [voice/providers/ElevenLabsTTS.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/ElevenLabsTTS.ts#L29) - ElevenLabs Text-to-Speech Handler Supports high-quality multilingual TTS with voice cloning. @@ -26,8 +24,6 @@ https://elevenlabs.io/docs/api-reference > **new ElevenLabsTTS**(`apiKey?`): `ElevenLabsTTS` -Defined in: [voice/providers/ElevenLabsTTS.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/ElevenLabsTTS.ts#L40) - #### Parameters ##### apiKey? @@ -44,8 +40,6 @@ Defined in: [voice/providers/ElevenLabsTTS.ts:40](https://github.com/juspay/neur > `readonly` **maxTextLength**: `5000` = `5000` -Defined in: [voice/providers/ElevenLabsTTS.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/ElevenLabsTTS.ts#L38) - Maximum text length (5000 characters) #### Implementation of @@ -58,8 +52,6 @@ Maximum text length (5000 characters) > **isConfigured**(): `boolean` -Defined in: [voice/providers/ElevenLabsTTS.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/ElevenLabsTTS.ts#L45) - Validate that the provider is properly configured #### Returns @@ -78,8 +70,6 @@ True if provider can generate TTS > **getVoices**(`languageCode?`): `Promise`\<[`TTSVoice`](../type-aliases/TTSVoice.md)[]\> -Defined in: [voice/providers/ElevenLabsTTS.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/ElevenLabsTTS.ts#L49) - Get available voices for the provider #### Parameters @@ -106,8 +96,6 @@ List of available voices > **synthesize**(`text`, `options?`): `Promise`\<[`TTSResult`](../type-aliases/TTSResult.md)\> -Defined in: [voice/providers/ElevenLabsTTS.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/ElevenLabsTTS.ts#L165) - Generate audio from text using provider-specific TTS API **IMPORTANT: Timeout Responsibility** diff --git a/docs/api/classes/ElicitationManager.md b/docs/api/classes/ElicitationManager.md index 4e3a524ec..2874fd800 100644 --- a/docs/api/classes/ElicitationManager.md +++ b/docs/api/classes/ElicitationManager.md @@ -6,8 +6,6 @@ # Class: ElicitationManager -Defined in: [mcp/elicitation/elicitationManager.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L70) - Manager for handling elicitation requests during tool execution The elicitation protocol allows MCP tools to request interactive user input @@ -60,8 +58,6 @@ if (response.value === true) { > **new ElicitationManager**(`config?`): `ElicitationManager` -Defined in: [mcp/elicitation/elicitationManager.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L82) - #### Parameters ##### config? @@ -82,8 +78,6 @@ Defined in: [mcp/elicitation/elicitationManager.ts:82](https://github.com/juspay > **setHandler**(`handler`): `void` -Defined in: [mcp/elicitation/elicitationManager.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L96) - Set the elicitation handler #### Parameters @@ -102,8 +96,6 @@ Set the elicitation handler > **setEnabled**(`enabled`): `void` -Defined in: [mcp/elicitation/elicitationManager.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L103) - Enable or disable elicitation #### Parameters @@ -122,8 +114,6 @@ Enable or disable elicitation > **isEnabled**(): `boolean` -Defined in: [mcp/elicitation/elicitationManager.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L125) - Check if elicitation is enabled #### Returns @@ -136,8 +126,6 @@ Check if elicitation is enabled > **request**(`elicitation`): `Promise`\<[`ElicitationResponse`](../type-aliases/ElicitationResponse.md)\> -Defined in: [mcp/elicitation/elicitationManager.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L132) - Request user input #### Parameters @@ -156,8 +144,6 @@ Request user input > **confirm**(`message`, `options?`): `Promise`\<`boolean`\> -Defined in: [mcp/elicitation/elicitationManager.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L206) - Convenience method for confirmation requests #### Parameters @@ -198,8 +184,6 @@ Convenience method for confirmation requests > **getText**(`message`, `options?`): `Promise`\<`string` \| `undefined`\> -Defined in: [mcp/elicitation/elicitationManager.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L233) - Convenience method for text input #### Parameters @@ -236,8 +220,6 @@ Convenience method for text input > **select**\<`T`\>(`message`, `options`, `config?`): `Promise`\<`T` \| `undefined`\> -Defined in: [mcp/elicitation/elicitationManager.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L258) - Convenience method for selection #### Type Parameters @@ -276,8 +258,6 @@ Convenience method for selection > **multiSelect**\<`T`\>(`message`, `options`, `config?`): `Promise`\<`T`[] \| `undefined`\> -Defined in: [mcp/elicitation/elicitationManager.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L281) - Convenience method for multiple selection #### Type Parameters @@ -324,8 +304,6 @@ Convenience method for multiple selection > **form**\<`T`\>(`message`, `fields`, `config?`): `Promise`\<`T` \| `undefined`\> -Defined in: [mcp/elicitation/elicitationManager.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L308) - Convenience method for form input #### Type Parameters @@ -372,8 +350,6 @@ Convenience method for form input > **getSecret**(`message`, `options?`): `Promise`\<`string` \| `undefined`\> -Defined in: [mcp/elicitation/elicitationManager.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L335) - Convenience method for secret input #### Parameters @@ -406,8 +382,6 @@ Convenience method for secret input > **cancel**(`requestId`, `reason?`): `void` -Defined in: [mcp/elicitation/elicitationManager.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L358) - Cancel a pending request #### Parameters @@ -430,8 +404,6 @@ Cancel a pending request > **getPendingCount**(): `number` -Defined in: [mcp/elicitation/elicitationManager.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L481) - Get pending request count #### Returns @@ -444,8 +416,6 @@ Get pending request count > **getPendingRequests**(): [`Elicitation`](../type-aliases/Elicitation.md)[] -Defined in: [mcp/elicitation/elicitationManager.ts:488](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L488) - Get all pending requests #### Returns @@ -458,8 +428,6 @@ Get all pending requests > **clearPending**(`reason?`): `void` -Defined in: [mcp/elicitation/elicitationManager.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitation/elicitationManager.ts#L495) - Clear all pending requests #### Parameters diff --git a/docs/api/classes/ElicitationProtocolAdapter.md b/docs/api/classes/ElicitationProtocolAdapter.md index 51f393e57..3986d3d25 100644 --- a/docs/api/classes/ElicitationProtocolAdapter.md +++ b/docs/api/classes/ElicitationProtocolAdapter.md @@ -6,8 +6,6 @@ # Class: ElicitationProtocolAdapter -Defined in: [mcp/elicitationProtocol.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L243) - Elicitation Protocol Adapter Bridges protocol-level messages with the ElicitationManager @@ -18,8 +16,6 @@ Bridges protocol-level messages with the ElicitationManager > **new ElicitationProtocolAdapter**(`config?`): `ElicitationProtocolAdapter` -Defined in: [mcp/elicitationProtocol.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L251) - #### Parameters ##### config? @@ -36,8 +32,6 @@ Defined in: [mcp/elicitationProtocol.ts:251](https://github.com/juspay/neurolink > **handleMessage**(`message`): `Promise`\<`void` \| [`ElicitationProtocolPayload`](../type-aliases/ElicitationProtocolPayload.md)\> -Defined in: [mcp/elicitationProtocol.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L264) - Handle incoming protocol message #### Parameters @@ -56,8 +50,6 @@ Handle incoming protocol message > **requestElicitation**(`params`): `Promise`\<[`ElicitationResponse`](../type-aliases/ElicitationResponse.md)\> -Defined in: [mcp/elicitationProtocol.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L340) - Send an elicitation request through the protocol #### Parameters @@ -76,8 +68,6 @@ Send an elicitation request through the protocol > **cancelElicitation**(`requestId`, `reason?`): `void` -Defined in: [mcp/elicitationProtocol.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L355) - Cancel a pending elicitation #### Parameters @@ -100,8 +90,6 @@ Cancel a pending elicitation > **getManager**(): [`ElicitationManager`](ElicitationManager.md) -Defined in: [mcp/elicitationProtocol.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L362) - Get the underlying manager #### Returns @@ -114,8 +102,6 @@ Get the underlying manager > **setHandler**(`handler`): `void` -Defined in: [mcp/elicitationProtocol.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L369) - Set protocol handler for the manager #### Parameters @@ -134,8 +120,6 @@ Set protocol handler for the manager > **setEnabled**(`enabled`): `void` -Defined in: [mcp/elicitationProtocol.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L376) - Enable/disable the protocol #### Parameters @@ -154,8 +138,6 @@ Enable/disable the protocol > **isEnabled**(): `boolean` -Defined in: [mcp/elicitationProtocol.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L383) - Check if protocol is enabled #### Returns diff --git a/docs/api/classes/EnhancedToolDiscovery.md b/docs/api/classes/EnhancedToolDiscovery.md index 74c73a144..99b9d32af 100644 --- a/docs/api/classes/EnhancedToolDiscovery.md +++ b/docs/api/classes/EnhancedToolDiscovery.md @@ -6,8 +6,6 @@ # Class: EnhancedToolDiscovery -Defined in: [mcp/enhancedToolDiscovery.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L63) - Enhanced Tool Discovery Service Provides advanced tool discovery features including annotation support, @@ -45,8 +43,6 @@ const safeTools = discovery.getToolsBySafetyLevel("safe"); > **new EnhancedToolDiscovery**(`multiServerManager?`): `EnhancedToolDiscovery` -Defined in: [mcp/enhancedToolDiscovery.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L69) - #### Parameters ##### multiServerManager? @@ -67,8 +63,6 @@ Defined in: [mcp/enhancedToolDiscovery.ts:69](https://github.com/juspay/neurolin > **discoverToolsWithAnnotations**(`serverId`, `client`, `timeout?`): `Promise`\<[`ToolDiscoveryResult`](../type-aliases/ToolDiscoveryResult.md)\> -Defined in: [mcp/enhancedToolDiscovery.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L77) - Discover tools with automatic annotation inference #### Parameters @@ -95,8 +89,6 @@ Discover tools with automatic annotation inference > **searchTools**(`criteria`): [`ToolSearchResult`](../type-aliases/ToolSearchResult.md) -Defined in: [mcp/enhancedToolDiscovery.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L250) - Search tools with advanced criteria #### Parameters @@ -115,8 +107,6 @@ Search tools with advanced criteria > **getToolsBySafetyLevel**(`level`): [`EnhancedToolInfo`](../type-aliases/EnhancedToolInfo.md)[] -Defined in: [mcp/enhancedToolDiscovery.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L369) - Get tools by safety level #### Parameters @@ -135,8 +125,6 @@ Get tools by safety level > **getToolsRequiringConfirmation**(): [`EnhancedToolInfo`](../type-aliases/EnhancedToolInfo.md)[] -Defined in: [mcp/enhancedToolDiscovery.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L391) - Get tools requiring confirmation #### Returns @@ -149,8 +137,6 @@ Get tools requiring confirmation > **getReadOnlyTools**(): [`EnhancedToolInfo`](../type-aliases/EnhancedToolInfo.md)[] -Defined in: [mcp/enhancedToolDiscovery.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L402) - Get read-only tools #### Returns @@ -163,8 +149,6 @@ Get read-only tools > **getUnifiedTools**(): [`UnifiedTool`](../type-aliases/UnifiedTool.md)[] -Defined in: [mcp/enhancedToolDiscovery.ts:411](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L411) - Get unified tools from all servers #### Returns @@ -177,8 +161,6 @@ Get unified tools from all servers > **registerServer**(`server`): `void` -Defined in: [mcp/enhancedToolDiscovery.ts:418](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L418) - Register a server with the multi-server manager #### Parameters @@ -197,8 +179,6 @@ Register a server with the multi-server manager > **updateToolAnnotations**(`serverId`, `toolName`, `annotations`): `boolean` -Defined in: [mcp/enhancedToolDiscovery.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L425) - Update tool annotations #### Parameters @@ -225,8 +205,6 @@ Update tool annotations > **checkCompatibility**(`toolName`, `serverId`, `targetVersion?`): [`CompatibilityCheckResult`](../type-aliases/CompatibilityCheckResult.md) -Defined in: [mcp/enhancedToolDiscovery.ts:455](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L455) - Check tool compatibility #### Parameters @@ -253,8 +231,6 @@ Check tool compatibility > **getTool**(`serverId`, `toolName`): [`EnhancedToolInfo`](../type-aliases/EnhancedToolInfo.md) \| `undefined` -Defined in: [mcp/enhancedToolDiscovery.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L518) - Get tool by key #### Parameters @@ -277,8 +253,6 @@ Get tool by key > **getAllTools**(): [`EnhancedToolInfo`](../type-aliases/EnhancedToolInfo.md)[] -Defined in: [mcp/enhancedToolDiscovery.ts:525](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L525) - Get all tools #### Returns @@ -291,8 +265,6 @@ Get all tools > **getServerTools**(`serverId`): [`EnhancedToolInfo`](../type-aliases/EnhancedToolInfo.md)[] -Defined in: [mcp/enhancedToolDiscovery.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L532) - Get tools for a server #### Parameters @@ -311,8 +283,6 @@ Get tools for a server > **clearServerTools**(`serverId`): `void` -Defined in: [mcp/enhancedToolDiscovery.ts:546](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L546) - Clear tools for a server #### Parameters @@ -331,8 +301,6 @@ Clear tools for a server > **getStatistics**(): `object` -Defined in: [mcp/enhancedToolDiscovery.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/enhancedToolDiscovery.ts#L567) - Get statistics #### Returns diff --git a/docs/api/classes/EvaluationAggregator.md b/docs/api/classes/EvaluationAggregator.md index 083a5d3de..7802cb9ce 100644 --- a/docs/api/classes/EvaluationAggregator.md +++ b/docs/api/classes/EvaluationAggregator.md @@ -6,8 +6,6 @@ # Class: EvaluationAggregator -Defined in: [evaluation/EvaluationAggregator.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L39) - EvaluationAggregator - Aggregates evaluation results and provides analytics. Supports statistical analysis, trend detection, and quality monitoring. @@ -46,8 +44,6 @@ console.log(`Quality is ${trend.direction}`); > **addEvaluation**(`evaluation`): `void` -Defined in: [evaluation/EvaluationAggregator.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L47) - Adds an evaluation to the aggregator. #### Parameters @@ -68,8 +64,6 @@ The evaluation data to add > **addEvaluations**(`evaluations`): `void` -Defined in: [evaluation/EvaluationAggregator.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L56) - Adds multiple evaluations to the aggregator. #### Parameters @@ -90,8 +84,6 @@ Array of evaluation data to add > **clear**(): `void` -Defined in: [evaluation/EvaluationAggregator.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L63) - Clears all evaluations from the aggregator. #### Returns @@ -104,8 +96,6 @@ Clears all evaluations from the aggregator. > **getCount**(): `number` -Defined in: [evaluation/EvaluationAggregator.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L70) - Gets the current number of evaluations. #### Returns @@ -118,8 +108,6 @@ Gets the current number of evaluations. > **getEvaluations**(): [`EvaluationData`](../type-aliases/EvaluationData.md)[] -Defined in: [evaluation/EvaluationAggregator.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L77) - Gets all evaluations. #### Returns @@ -132,8 +120,6 @@ Gets all evaluations. > **aggregate**(`options?`): [`AggregationResult`](../type-aliases/AggregationResult.md) -Defined in: [evaluation/EvaluationAggregator.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L87) - Aggregates all evaluations and returns comprehensive statistics. #### Parameters @@ -158,8 +144,6 @@ Comprehensive aggregation result > **calculateStatistics**(`scores`): [`ScoreStatistics`](../type-aliases/ScoreStatistics.md) -Defined in: [evaluation/EvaluationAggregator.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L147) - Calculates statistical summary for a set of scores. #### Parameters @@ -182,8 +166,6 @@ Statistical summary > **calculateDistribution**(`scores`): [`ScoreDistribution`](../type-aliases/ScoreDistribution.md) -Defined in: [evaluation/EvaluationAggregator.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L193) - Calculates the distribution of scores across quality ranges. #### Parameters @@ -206,8 +188,6 @@ Score distribution > **analyzeSequenceTrend**(`windowSize?`): [`TrendAnalysis`](../type-aliases/TrendAnalysis.md) -Defined in: [evaluation/EvaluationAggregator.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L209) - Analyzes sequence-based trends in evaluation scores (based on insertion order, not time). #### Parameters @@ -230,8 +210,6 @@ Trend analysis > **getFailingEvaluations**(`threshold?`): [`EvaluationData`](../type-aliases/EvaluationData.md)[] -Defined in: [evaluation/EvaluationAggregator.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L384) - Gets evaluations that failed to meet the threshold. #### Parameters @@ -254,8 +232,6 @@ Array of failing evaluations > **getHighAlertEvaluations**(): [`EvaluationData`](../type-aliases/EvaluationData.md)[] -Defined in: [evaluation/EvaluationAggregator.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L393) - Gets evaluations with high severity alerts. #### Returns @@ -270,8 +246,6 @@ Array of high-alert evaluations > **getOffTopicEvaluations**(): [`EvaluationData`](../type-aliases/EvaluationData.md)[] -Defined in: [evaluation/EvaluationAggregator.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L402) - Gets evaluations marked as off-topic. #### Returns @@ -286,8 +260,6 @@ Array of off-topic evaluations > **getTopEvaluations**(`n?`): [`EvaluationData`](../type-aliases/EvaluationData.md)[] -Defined in: [evaluation/EvaluationAggregator.ts:412](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L412) - Gets the top N performing evaluations. #### Parameters @@ -310,8 +282,6 @@ Array of top evaluations > **getBottomEvaluations**(`n?`): [`EvaluationData`](../type-aliases/EvaluationData.md)[] -Defined in: [evaluation/EvaluationAggregator.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L424) - Gets the bottom N performing evaluations. #### Parameters @@ -334,8 +304,6 @@ Array of bottom evaluations > **generateSummary**(`threshold?`): `string` -Defined in: [evaluation/EvaluationAggregator.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluationAggregator.ts#L436) - Generates a text summary of the aggregation. #### Parameters diff --git a/docs/api/classes/EvaluationPipeline.md b/docs/api/classes/EvaluationPipeline.md index 25fa2a165..2d3f06880 100644 --- a/docs/api/classes/EvaluationPipeline.md +++ b/docs/api/classes/EvaluationPipeline.md @@ -6,8 +6,6 @@ # Class: EvaluationPipeline -Defined in: [evaluation/pipeline/evaluationPipeline.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L22) - Evaluation Pipeline for running multiple scorers ## Constructors @@ -16,8 +14,6 @@ Evaluation Pipeline for running multiple scorers > **new EvaluationPipeline**(`config`): `EvaluationPipeline` -Defined in: [evaluation/pipeline/evaluationPipeline.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L27) - #### Parameters ##### config @@ -36,8 +32,6 @@ Defined in: [evaluation/pipeline/evaluationPipeline.ts:27](https://github.com/ju > **get** **config**(): [`PipelineConfig`](../type-aliases/PipelineConfig.md) -Defined in: [evaluation/pipeline/evaluationPipeline.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L39) - Get pipeline configuration ##### Returns @@ -52,8 +46,6 @@ Get pipeline configuration > **get** **initialized**(): `boolean` -Defined in: [evaluation/pipeline/evaluationPipeline.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L46) - Check if pipeline is initialized ##### Returns @@ -66,8 +58,6 @@ Check if pipeline is initialized > **initialize**(): `Promise`\<`void`\> -Defined in: [evaluation/pipeline/evaluationPipeline.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L53) - Initialize the pipeline by loading all scorers #### Returns @@ -80,8 +70,6 @@ Initialize the pipeline by loading all scorers > **execute**(`input`, `options?`): `Promise`\<[`PipelineResult`](../type-aliases/PipelineResult.md)\> -Defined in: [evaluation/pipeline/evaluationPipeline.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L120) - Execute the pipeline on input #### Parameters @@ -104,8 +92,6 @@ Execute the pipeline on input > **addScorer**(`id`, `scorer`): `void` -Defined in: [evaluation/pipeline/evaluationPipeline.ts:419](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L419) - Add a scorer to the pipeline #### Parameters @@ -128,8 +114,6 @@ Add a scorer to the pipeline > **removeScorer**(`id`): `boolean` -Defined in: [evaluation/pipeline/evaluationPipeline.ts:431](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L431) - Remove a scorer from the pipeline #### Parameters @@ -148,8 +132,6 @@ Remove a scorer from the pipeline > **getScorer**(`id`): [`Scorer`](../type-aliases/Scorer.md) \| `undefined` -Defined in: [evaluation/pipeline/evaluationPipeline.ts:447](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L447) - Get a scorer by ID #### Parameters @@ -168,8 +150,6 @@ Get a scorer by ID > **getScorerIds**(): `string`[] -Defined in: [evaluation/pipeline/evaluationPipeline.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L454) - Get all scorer IDs #### Returns @@ -182,8 +162,6 @@ Get all scorer IDs > **configure**(`config`): `void` -Defined in: [evaluation/pipeline/evaluationPipeline.ts:461](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L461) - Update pipeline configuration #### Parameters @@ -202,8 +180,6 @@ Update pipeline configuration > **clone**(): `EvaluationPipeline` -Defined in: [evaluation/pipeline/evaluationPipeline.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L468) - Create a clone of this pipeline #### Returns diff --git a/docs/api/classes/Evaluator.md b/docs/api/classes/Evaluator.md index 017165224..7b82c909b 100644 --- a/docs/api/classes/Evaluator.md +++ b/docs/api/classes/Evaluator.md @@ -6,8 +6,6 @@ # Class: Evaluator -Defined in: [evaluation/index.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/index.ts#L49) - A centralized class for performing response evaluations. It supports different evaluation strategies, with RAGAS-style model-based evaluation as the default. This class orchestrates the context building and evaluation process. @@ -18,8 +16,6 @@ This class orchestrates the context building and evaluation process. > **new Evaluator**(`config?`): `Evaluator` -Defined in: [evaluation/index.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/index.ts#L54) - #### Parameters ##### config? @@ -36,8 +32,6 @@ Defined in: [evaluation/index.ts:54](https://github.com/juspay/neurolink/blob/re > **evaluate**(`options`, `result`, `threshold`, `config`): `Promise`\<[`EvaluationData`](../type-aliases/EvaluationData.md)\> -Defined in: [evaluation/index.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/index.ts#L73) - The main entry point for performing an evaluation. It selects the evaluation strategy based on the configuration and executes it. diff --git a/docs/api/classes/EvaluatorFactory.md b/docs/api/classes/EvaluatorFactory.md index b05a5fecc..41f82ae5e 100644 --- a/docs/api/classes/EvaluatorFactory.md +++ b/docs/api/classes/EvaluatorFactory.md @@ -6,8 +6,6 @@ # Class: EvaluatorFactory -Defined in: [evaluation/EvaluatorFactory.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L33) - Factory for creating Evaluator instances with various configurations. Supports presets for common use cases and custom configurations. @@ -40,8 +38,6 @@ const customEvaluator = await factory.create("default", { > `protected` **items**: `Map`\<`string`, [`FactoryRegistration`](../type-aliases/FactoryRegistration.md)\<[`Evaluator`](Evaluator.md), [`EvaluationConfig`](../type-aliases/EvaluationConfig.md)\>\> -Defined in: [core/infrastructure/baseFactory.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L8) - #### Inherited from [`BaseFactory`](BaseFactory.md).[`items`](BaseFactory.md#items) @@ -52,8 +48,6 @@ Defined in: [core/infrastructure/baseFactory.ts:8](https://github.com/juspay/neu > `protected` **aliasMap**: `Map`\<`string`, `string`\> -Defined in: [core/infrastructure/baseFactory.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L9) - #### Inherited from [`BaseFactory`](BaseFactory.md).[`aliasMap`](BaseFactory.md#aliasmap) @@ -64,8 +58,6 @@ Defined in: [core/infrastructure/baseFactory.ts:9](https://github.com/juspay/neu > `protected` **initialized**: `boolean` = `false` -Defined in: [core/infrastructure/baseFactory.ts:10](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L10) - #### Inherited from [`BaseFactory`](BaseFactory.md).[`initialized`](BaseFactory.md#initialized) @@ -76,8 +68,6 @@ Defined in: [core/infrastructure/baseFactory.ts:10](https://github.com/juspay/ne > `protected` **initPromise**: `Promise`\<`void`\> \| `null` = `null` -Defined in: [core/infrastructure/baseFactory.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L11) - #### Inherited from [`BaseFactory`](BaseFactory.md).[`initPromise`](BaseFactory.md#initpromise) @@ -88,8 +78,6 @@ Defined in: [core/infrastructure/baseFactory.ts:11](https://github.com/juspay/ne > **ensureInitialized**(): `Promise`\<`void`\> -Defined in: [core/infrastructure/baseFactory.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L15) - #### Returns `Promise`\<`void`\> @@ -104,8 +92,6 @@ Defined in: [core/infrastructure/baseFactory.ts:15](https://github.com/juspay/ne > **register**(`name`, `factory`, `aliases?`, `metadata?`): `void` -Defined in: [core/infrastructure/baseFactory.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L27) - #### Parameters ##### name @@ -138,8 +124,6 @@ Defined in: [core/infrastructure/baseFactory.ts:27](https://github.com/juspay/ne > **create**(`nameOrAlias`, `config?`): `Promise`\<[`Evaluator`](Evaluator.md)\> -Defined in: [core/infrastructure/baseFactory.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L40) - #### Parameters ##### nameOrAlias @@ -164,8 +148,6 @@ Defined in: [core/infrastructure/baseFactory.ts:40](https://github.com/juspay/ne > **resolveName**(`nameOrAlias`): `string` -Defined in: [core/infrastructure/baseFactory.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L50) - #### Parameters ##### nameOrAlias @@ -186,8 +168,6 @@ Defined in: [core/infrastructure/baseFactory.ts:50](https://github.com/juspay/ne > **has**(`nameOrAlias`): `boolean` -Defined in: [core/infrastructure/baseFactory.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L55) - #### Parameters ##### nameOrAlias @@ -208,8 +188,6 @@ Defined in: [core/infrastructure/baseFactory.ts:55](https://github.com/juspay/ne > **getAvailable**(): `string`[] -Defined in: [core/infrastructure/baseFactory.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L60) - #### Returns `string`[] @@ -224,8 +202,6 @@ Defined in: [core/infrastructure/baseFactory.ts:60](https://github.com/juspay/ne > **getAliases**(): `Map`\<`string`, `string`\> -Defined in: [core/infrastructure/baseFactory.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L64) - #### Returns `Map`\<`string`, `string`\> @@ -240,8 +216,6 @@ Defined in: [core/infrastructure/baseFactory.ts:64](https://github.com/juspay/ne > **clear**(): `void` -Defined in: [core/infrastructure/baseFactory.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseFactory.ts#L68) - #### Returns `void` @@ -256,8 +230,6 @@ Defined in: [core/infrastructure/baseFactory.ts:68](https://github.com/juspay/ne > `static` **getInstance**(): `EvaluatorFactory` -Defined in: [evaluation/EvaluatorFactory.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L43) - Gets the singleton instance of the EvaluatorFactory. #### Returns @@ -270,8 +242,6 @@ Gets the singleton instance of the EvaluatorFactory. > `static` **resetInstance**(): `void` -Defined in: [evaluation/EvaluatorFactory.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L53) - Resets the singleton instance (useful for testing). #### Returns @@ -284,8 +254,6 @@ Resets the singleton instance (useful for testing). > `protected` **registerAll**(): `Promise`\<`void`\> -Defined in: [evaluation/EvaluatorFactory.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L61) - Registers all built-in evaluator configurations. This is called automatically on first access. @@ -303,8 +271,6 @@ This is called automatically on first access. > **createEvaluator**(`presetOrName?`, `config?`): `Promise`\<[`Evaluator`](Evaluator.md)\> -Defined in: [evaluation/EvaluatorFactory.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L199) - Creates an evaluator instance with the specified preset and optional config overrides. #### Parameters @@ -333,8 +299,6 @@ A configured Evaluator instance > **createCustomEvaluator**(`config`): [`Evaluator`](Evaluator.md) -Defined in: [evaluation/EvaluatorFactory.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L212) - Creates an evaluator with a fully custom configuration (not based on a preset). #### Parameters @@ -357,8 +321,6 @@ A configured Evaluator instance > **getPresetInfo**(`presetOrName`): `Promise`\<[`EvaluatorPreset`](../type-aliases/EvaluatorPreset.md) \| `undefined`\> -Defined in: [evaluation/EvaluatorFactory.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L223) - Gets information about a preset by name or alias. #### Parameters @@ -381,8 +343,6 @@ The preset information or undefined if not found > **listPresets**(): `Promise`\<`object`[]\> -Defined in: [evaluation/EvaluatorFactory.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L240) - Lists all available presets with their descriptions. #### Returns @@ -397,8 +357,6 @@ Array of preset information > **validateConfig**(`config`): `void` -Defined in: [evaluation/EvaluatorFactory.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L274) - Validates an evaluation configuration. #### Parameters @@ -423,8 +381,6 @@ If the configuration is invalid > **registerPreset**(`name`, `config`, `aliases?`, `description?`): `void` -Defined in: [evaluation/EvaluatorFactory.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L321) - Registers a custom evaluator preset. #### Parameters @@ -463,8 +419,6 @@ Human-readable description > **unregisterPreset**(`name`): `boolean` -Defined in: [evaluation/EvaluatorFactory.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L358) - Unregisters a preset from the factory. #### Parameters diff --git a/docs/api/classes/ExporterRegistry.md b/docs/api/classes/ExporterRegistry.md index e1f148e64..741d9e7ec 100644 --- a/docs/api/classes/ExporterRegistry.md +++ b/docs/api/classes/ExporterRegistry.md @@ -6,8 +6,6 @@ # Class: ExporterRegistry -Defined in: [observability/exporterRegistry.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L51) - Registry for managing multiple observability exporters Includes circuit breaker protection to prevent cascading failures @@ -27,8 +25,6 @@ Includes circuit breaker protection to prevent cascading failures > **register**(`exporter`): `void` -Defined in: [observability/exporterRegistry.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L65) - Register an exporter #### Parameters @@ -47,8 +43,6 @@ Register an exporter > **unregister**(`name`): `boolean` -Defined in: [observability/exporterRegistry.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L72) - Unregister an exporter #### Parameters @@ -67,8 +61,6 @@ Unregister an exporter > **get**(`name`): `BaseExporter` \| `undefined` -Defined in: [observability/exporterRegistry.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L79) - Get an exporter by name #### Parameters @@ -87,8 +79,6 @@ Get an exporter by name > **getNames**(): `string`[] -Defined in: [observability/exporterRegistry.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L86) - Get all registered exporter names #### Returns @@ -101,8 +91,6 @@ Get all registered exporter names > **getCount**(): `number` -Defined in: [observability/exporterRegistry.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L93) - Get total exporter count #### Returns @@ -115,8 +103,6 @@ Get total exporter count > **setDefault**(`name`): `void` -Defined in: [observability/exporterRegistry.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L100) - Set the default exporter #### Parameters @@ -135,8 +121,6 @@ Set the default exporter > **getDefault**(): `BaseExporter` \| `undefined` -Defined in: [observability/exporterRegistry.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L110) - Get the default exporter #### Returns @@ -149,8 +133,6 @@ Get the default exporter > **setSampler**(`sampler`): `void` -Defined in: [observability/exporterRegistry.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L120) - Set the sampler for the registry #### Parameters @@ -169,8 +151,6 @@ Set the sampler for the registry > **getSampler**(): [`Sampler`](../type-aliases/Sampler.md) -Defined in: [observability/exporterRegistry.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L127) - Get the current sampler #### Returns @@ -183,8 +163,6 @@ Get the current sampler > **configureCircuitBreaker**(`config`): `void` -Defined in: [observability/exporterRegistry.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L135) - Configure the circuit breaker settings #### Parameters @@ -205,8 +183,6 @@ Partial circuit breaker configuration > **getCircuitBreakerStatus**(`exporterName`): [`ObservabilityCircuitBreakerState`](../type-aliases/ObservabilityCircuitBreakerState.md) \| `undefined` -Defined in: [observability/exporterRegistry.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L215) - Get circuit breaker status for an exporter #### Parameters @@ -229,8 +205,6 @@ Circuit breaker state or undefined if not tracked > **resetCircuitBreaker**(`exporterName`): `void` -Defined in: [observability/exporterRegistry.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L225) - Reset circuit breaker for an exporter #### Parameters @@ -251,8 +225,6 @@ Name of the exporter > **exportToAll**(`span`): `Promise`\<`Map`\<`string`, [`ExportResult`](../type-aliases/ExportResult.md)\>\> -Defined in: [observability/exporterRegistry.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L233) - Export span to all registered exporters Applies sampling and circuit breaker protection before export @@ -272,8 +244,6 @@ Applies sampling and circuit breaker protection before export > **exportTo**(`name`, `span`): `Promise`\<[`ExportResult`](../type-aliases/ExportResult.md) \| `null`\> -Defined in: [observability/exporterRegistry.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L309) - Export span to a specific exporter Applies sampling and circuit breaker protection @@ -297,8 +267,6 @@ Applies sampling and circuit breaker protection > **initializeAll**(): `Promise`\<`void`\> -Defined in: [observability/exporterRegistry.ts:381](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L381) - Initialize all exporters #### Returns @@ -311,8 +279,6 @@ Initialize all exporters > **shutdownAll**(): `Promise`\<`void`\> -Defined in: [observability/exporterRegistry.ts:406](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L406) - Shutdown all exporters #### Returns @@ -325,8 +291,6 @@ Shutdown all exporters > **flushAll**(): `Promise`\<`void`\> -Defined in: [observability/exporterRegistry.ts:431](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L431) - Flush all exporters #### Returns @@ -339,8 +303,6 @@ Flush all exporters > **healthCheckAll**(): `Promise`\<`Map`\<`string`, [`ExporterHealthStatus`](../type-aliases/ExporterHealthStatus.md)\>\> -Defined in: [observability/exporterRegistry.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L454) - Get health status of all exporters #### Returns @@ -353,8 +315,6 @@ Get health status of all exporters > **isHealthy**(): `Promise`\<`boolean`\> -Defined in: [observability/exporterRegistry.ts:471](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L471) - Check if all exporters are healthy #### Returns @@ -367,8 +327,6 @@ Check if all exporters are healthy > **getTotalPendingSpans**(): `number` -Defined in: [observability/exporterRegistry.ts:479](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L479) - Get total pending spans across all exporters #### Returns @@ -381,8 +339,6 @@ Get total pending spans across all exporters > **clear**(): `void` -Defined in: [observability/exporterRegistry.ts:492](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporterRegistry.ts#L492) - Clear all registered exporters and reset state (For testing and cleanup) diff --git a/docs/api/classes/ExpressServerAdapter.md b/docs/api/classes/ExpressServerAdapter.md index a1abbd02c..b30bb40cf 100644 --- a/docs/api/classes/ExpressServerAdapter.md +++ b/docs/api/classes/ExpressServerAdapter.md @@ -6,8 +6,6 @@ # Class: ExpressServerAdapter -Defined in: [server/adapters/expressAdapter.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L30) - Express-specific server adapter ## Extends @@ -20,8 +18,6 @@ Express-specific server adapter > **new ExpressServerAdapter**(`neurolink`, `config?`): `ExpressServerAdapter` -Defined in: [server/adapters/expressAdapter.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L36) - #### Parameters ##### neurolink @@ -46,8 +42,6 @@ Defined in: [server/adapters/expressAdapter.ts:36](https://github.com/juspay/neu > `protected` `readonly` **config**: [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L45) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`config`](BaseServerAdapter.md#config) @@ -58,8 +52,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/ > `protected` `readonly` `optional` **redactionConfig?**: [`RedactionConfig`](../type-aliases/RedactionConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L46) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`redactionConfig`](BaseServerAdapter.md#redactionconfig) @@ -70,8 +62,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/ > `protected` `readonly` **neurolink**: [`NeuroLink`](NeuroLink.md) -Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L47) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`neurolink`](BaseServerAdapter.md#neurolink) @@ -82,8 +72,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/ > `protected` `readonly` **toolRegistry**: [`MCPToolRegistry`](MCPToolRegistry.md) -Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L48) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`toolRegistry`](BaseServerAdapter.md#toolregistry) @@ -94,8 +82,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/ > `protected` `readonly` `optional` **externalServerManager?**: [`ExternalServerManager`](ExternalServerManager.md) -Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L49) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`externalServerManager`](BaseServerAdapter.md#externalservermanager) @@ -106,8 +92,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/ > `protected` **routes**: `Map`\<`string`, [`RouteDefinition`](../type-aliases/RouteDefinition.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L50) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`routes`](BaseServerAdapter.md#routes) @@ -118,8 +102,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/ > `protected` **middlewares**: [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md)[] = `[]` -Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L51) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`middlewares`](BaseServerAdapter.md#middlewares) @@ -130,8 +112,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/ > `protected` **isRunning**: `boolean` = `false` -Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L52) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`isRunning`](BaseServerAdapter.md#isrunning) @@ -142,8 +122,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/ > `protected` `optional` **startTime?**: `Date` -Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L53) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`startTime`](BaseServerAdapter.md#starttime) @@ -154,8 +132,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/ > `protected` **lifecycleState**: [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) = `"uninitialized"` -Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L56) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`lifecycleState`](BaseServerAdapter.md#lifecyclestate) @@ -166,8 +142,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/ > `protected` **activeConnections**: `Map`\<`string`, [`TrackedConnection`](../type-aliases/TrackedConnection.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L57) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`activeConnections`](BaseServerAdapter.md#activeconnections) @@ -178,8 +152,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/ > `protected` `readonly` **shutdownConfig**: [`RequiredShutdownConfig`](../type-aliases/RequiredShutdownConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L58) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`shutdownConfig`](BaseServerAdapter.md#shutdownconfig) @@ -190,8 +162,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/ > `protected` **importFrameworkDependency**\<`T`\>(`pkg`, `framework`): `Promise`\<`T`\> -Defined in: [server/abstract/baseServerAdapter.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L206) - Import an optional framework dependency (express/fastify/koa and their plugins), converting a missing package into a [MissingDependencyError](MissingDependencyError.md) instead of letting the framework's `Cannot find package` propagate raw. @@ -233,8 +203,6 @@ unchanged, matching `tryImport`'s own contract. > **registerRoute**(`route`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L295) - Register a custom route #### Parameters @@ -257,8 +225,6 @@ Register a custom route > **registerRouteGroup**(`group`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L317) - Register multiple routes from a route group #### Parameters @@ -291,8 +257,6 @@ Register multiple routes from a route group > **registerMiddleware**(`middleware`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L363) - Register custom middleware #### Parameters @@ -315,8 +279,6 @@ Register custom middleware > `protected` **createContext**(`options`): [`ServerContext`](../type-aliases/ServerContext.md) -Defined in: [server/abstract/baseServerAdapter.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L376) - Create request context from incoming request #### Parameters @@ -365,8 +327,6 @@ Create request context from incoming request > `protected` **registerBuiltInMiddleware**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L405) - Register built-in middleware #### Returns @@ -383,8 +343,6 @@ Register built-in middleware > `protected` **registerBuiltInRoutes**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L444) - Register built-in routes Only registers health routes if disableBuiltInHealth is false (default) @@ -402,8 +360,6 @@ Only registers health routes if disableBuiltInHealth is false (default) > `protected` **generateRequestId**(): `string` -Defined in: [server/abstract/baseServerAdapter.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L536) - Generate unique request ID #### Returns @@ -420,8 +376,6 @@ Generate unique request ID > **getLifecycleState**(): [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) -Defined in: [server/abstract/baseServerAdapter.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L547) - Get the current lifecycle state #### Returns @@ -438,8 +392,6 @@ Get the current lifecycle state > `protected` **trackConnection**(`id`, `socket?`, `requestId?`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L557) - Track a new connection #### Parameters @@ -476,8 +428,6 @@ Optional associated request ID > `protected` **untrackConnection**(`id`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L580) - Untrack a connection (when it's completed) #### Parameters @@ -502,8 +452,6 @@ Connection identifier to remove > **getActiveConnectionCount**(): `number` -Defined in: [server/abstract/baseServerAdapter.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L594) - Get the number of active connections #### Returns @@ -520,8 +468,6 @@ Get the number of active connections > `protected` **gracefulShutdown**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:602](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L602) - Perform graceful shutdown with connection draining This method handles the complete shutdown lifecycle @@ -539,8 +485,6 @@ This method handles the complete shutdown lifecycle > `protected` **drainConnections**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:737](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L737) - Wait for all active connections to drain Resolves when activeConnections is empty @@ -558,8 +502,6 @@ Resolves when activeConnections is empty > `protected` **resetServerState**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L763) - Reset server state for restart capability Call this after stop() completes to allow restart @@ -577,8 +519,6 @@ Call this after stop() completes to allow restart > `protected` **validateLifecycleState**(`operation`, `allowedStates`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:777](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L777) - Validate lifecycle state transition #### Parameters @@ -609,8 +549,6 @@ States that allow the operation > **getStatus**(): [`ServerStatus`](../type-aliases/ServerStatus.md) -Defined in: [server/abstract/baseServerAdapter.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L793) - Get server status #### Returns @@ -627,8 +565,6 @@ Get server status > **listRoutes**(): [`RouteDefinition`](../type-aliases/RouteDefinition.md)[] -Defined in: [server/abstract/baseServerAdapter.ts:809](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L809) - List all registered routes #### Returns @@ -645,8 +581,6 @@ List all registered routes > **getConfig**(): [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:816](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L816) - Get configuration #### Returns @@ -663,8 +597,6 @@ Get configuration > `protected` **initializeFramework**(): `void` -Defined in: [server/adapters/expressAdapter.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L43) - Initialize Express framework asynchronously #### Returns @@ -681,8 +613,6 @@ Initialize Express framework asynchronously > **initialize**(): `Promise`\<`void`\> -Defined in: [server/adapters/expressAdapter.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L167) - Override initialize to ensure async framework setup #### Returns @@ -699,8 +629,6 @@ Override initialize to ensure async framework setup > `protected` **registerFrameworkRoute**(`route`): `void` -Defined in: [server/adapters/expressAdapter.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L187) - Register route with Express #### Parameters @@ -723,8 +651,6 @@ Register route with Express > `protected` **registerFrameworkMiddleware**(`middleware`): `void` -Defined in: [server/adapters/expressAdapter.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L396) - Register middleware with Express #### Parameters @@ -747,8 +673,6 @@ Register middleware with Express > **start**(): `Promise`\<`void`\> -Defined in: [server/adapters/expressAdapter.ts:459](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L459) - Start the Express server #### Returns @@ -765,8 +689,6 @@ Start the Express server > **stop**(): `Promise`\<`void`\> -Defined in: [server/adapters/expressAdapter.ts:540](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L540) - Stop the Express server with graceful shutdown #### Returns @@ -783,8 +705,6 @@ Stop the Express server with graceful shutdown > `protected` **stopAcceptingConnections**(): `Promise`\<`void`\> -Defined in: [server/adapters/expressAdapter.ts:577](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L577) - Stop accepting new connections #### Returns @@ -801,8 +721,6 @@ Stop accepting new connections > `protected` **closeServer**(): `Promise`\<`void`\> -Defined in: [server/adapters/expressAdapter.ts:587](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L587) - Close the underlying server #### Returns @@ -819,8 +737,6 @@ Close the underlying server > `protected` **forceCloseConnections**(): `Promise`\<`void`\> -Defined in: [server/adapters/expressAdapter.ts:607](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L607) - Force close all active connections #### Returns @@ -837,8 +753,6 @@ Force close all active connections > **getFrameworkInstance**(): `unknown` -Defined in: [server/adapters/expressAdapter.ts:623](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/expressAdapter.ts#L623) - Get the Express app instance #### Returns diff --git a/docs/api/classes/ExternalServerManager.md b/docs/api/classes/ExternalServerManager.md index 449370678..aee1853f0 100644 --- a/docs/api/classes/ExternalServerManager.md +++ b/docs/api/classes/ExternalServerManager.md @@ -6,8 +6,6 @@ # Class: ExternalServerManager -Defined in: [mcp/externalServerManager.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L466) - MCP (Model Context Protocol) Plugin Ecosystem Extensible plugin architecture based on research blueprint for @@ -39,8 +37,6 @@ await writeFile("output.txt", "Hello from MCP!"); > **new ExternalServerManager**(`config?`, `options?`): `ExternalServerManager` -Defined in: [mcp/externalServerManager.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L480) - #### Parameters ##### config? @@ -67,8 +63,6 @@ Defined in: [mcp/externalServerManager.ts:480](https://github.com/juspay/neuroli > **setOutputNormalizer**(`normalizer`): `void` -Defined in: [mcp/externalServerManager.ts:539](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L539) - Attach a McpOutputNormalizer to the underlying ToolDiscoveryService. All tool outputs will be measured and (if oversized) replaced with compact surrogates before being returned to callers. @@ -89,8 +83,6 @@ surrogates before being returned to callers. > **setHITLManager**(`hitlManager?`): `void` -Defined in: [mcp/externalServerManager.ts:552](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L552) - Set HITL manager for human-in-the-loop safety mechanisms #### Parameters @@ -111,8 +103,6 @@ HITL manager instance (optional, can be undefined to disable) > **getHITLManager**(): `HITLManager` \| `undefined` -Defined in: [mcp/externalServerManager.ts:568](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L568) - Get current HITL manager #### Returns @@ -125,8 +115,6 @@ Get current HITL manager > **getServerName**(`serverId`): `string` -Defined in: [mcp/externalServerManager.ts:576](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L576) - Resolve the human-readable server name for an event payload. Falls back to serverId if the instance or config.name isn't available. @@ -146,8 +134,6 @@ Falls back to serverId if the instance or config.name isn't available. > **loadMCPConfiguration**(`configPath?`, `options?`): `Promise`\<[`ServerLoadResult`](../type-aliases/ServerLoadResult.md)\> -Defined in: [mcp/externalServerManager.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L588) - Load MCP server configurations from .mcp-config.json file with parallel loading support Automatically registers servers found in the configuration @@ -179,8 +165,6 @@ Promise resolving to { serversLoaded, errors } > **loadMCPConfigurationParallel**(`configPath?`): `Promise`\<[`ServerLoadResult`](../type-aliases/ServerLoadResult.md)\> -Defined in: [mcp/externalServerManager.ts:603](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L603) - Load MCP servers in parallel for improved performance #### Parameters @@ -203,8 +187,6 @@ Promise resolving to batch operation result > **loadMCPConfigurationSequential**(`configPath?`): `Promise`\<[`ServerLoadResult`](../type-aliases/ServerLoadResult.md)\> -Defined in: [mcp/externalServerManager.ts:785](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L785) - Load MCP servers sequentially (original implementation for backward compatibility) #### Parameters @@ -227,8 +209,6 @@ Promise resolving to batch operation result > **validateConfig**(`config`): [`ExternalMCPConfigValidation`](../type-aliases/ExternalMCPConfigValidation.md) -Defined in: [mcp/externalServerManager.ts:942](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L942) - Validate external MCP server configuration #### Parameters @@ -249,8 +229,6 @@ Validate external MCP server configuration > **addServer**(`serverId`, `config`): `Promise`\<[`ExternalMCPOperationResult`](../type-aliases/ExternalMCPOperationResult.md)\<[`ExternalMCPServerInstance`](../type-aliases/ExternalMCPServerInstance.md)\>\> -Defined in: [mcp/externalServerManager.ts:1043](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L1043) - Add a new external MCP server - Backward compatibility overload ##### Parameters @@ -271,8 +249,6 @@ Add a new external MCP server - Backward compatibility overload > **addServer**(`serverId`, `serverInfo`): `Promise`\<[`ExternalMCPOperationResult`](../type-aliases/ExternalMCPOperationResult.md)\<[`ExternalMCPServerInstance`](../type-aliases/ExternalMCPServerInstance.md)\>\> -Defined in: [mcp/externalServerManager.ts:1051](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L1051) - Add a new external MCP server - Updated to accept MCPServerInfo ##### Parameters @@ -295,8 +271,6 @@ Add a new external MCP server - Updated to accept MCPServerInfo > **removeServer**(`serverId`): `Promise`\<[`ExternalMCPOperationResult`](../type-aliases/ExternalMCPOperationResult.md)\<`void`\>\> -Defined in: [mcp/externalServerManager.ts:1242](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L1242) - Remove an external MCP server #### Parameters @@ -315,8 +289,6 @@ Remove an external MCP server > **getServer**(`serverId`): [`ExternalMCPServerInstance`](../type-aliases/ExternalMCPServerInstance.md) \| `undefined` -Defined in: [mcp/externalServerManager.ts:1952](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L1952) - Get server instance - converted to ExternalMCPServerInstance for compatibility #### Parameters @@ -335,8 +307,6 @@ Get server instance - converted to ExternalMCPServerInstance for compatibility > **getAllServers**(): `Map`\<`string`, [`ExternalMCPServerInstance`](../type-aliases/ExternalMCPServerInstance.md)\> -Defined in: [mcp/externalServerManager.ts:1982](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L1982) - Get all servers - converted to ExternalMCPServerInstance for compatibility #### Returns @@ -349,8 +319,6 @@ Get all servers - converted to ExternalMCPServerInstance for compatibility > **listServers**(): [`MCPServerInfo`](../type-aliases/MCPServerInfo.md)[] -Defined in: [mcp/externalServerManager.ts:2011](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2011) - List servers as MCPServerInfo - ZERO conversion needed #### Returns @@ -363,8 +331,6 @@ List servers as MCPServerInfo - ZERO conversion needed > **getServerStatuses**(): [`ExternalMCPServerHealth`](../type-aliases/ExternalMCPServerHealth.md)[] -Defined in: [mcp/externalServerManager.ts:2018](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2018) - Get server statuses #### Returns @@ -377,8 +343,6 @@ Get server statuses > **shutdown**(): `Promise`\<`void`\> -Defined in: [mcp/externalServerManager.ts:2047](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2047) - Shutdown all servers and clean up resources This method should be called during application shutdown to prevent memory leaks @@ -392,8 +356,6 @@ This method should be called during application shutdown to prevent memory leaks > **destroy**(): `Promise`\<`void`\> -Defined in: [mcp/externalServerManager.ts:2084](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2084) - Destroy the manager and all associated resources Alias for shutdown() to match the pattern used by other components @@ -407,8 +369,6 @@ Alias for shutdown() to match the pattern used by other components > **getStatistics**(): `object` -Defined in: [mcp/externalServerManager.ts:2091](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2091) - Get manager statistics #### Returns @@ -445,8 +405,6 @@ Get manager statistics > **executeTool**(`serverId`, `toolName`, `parameters`, `options?`): `Promise`\<`unknown`\> -Defined in: [mcp/externalServerManager.ts:2304](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2304) - Execute a tool on a specific server #### Parameters @@ -479,8 +437,6 @@ Execute a tool on a specific server > **getAllTools**(): [`ExternalMCPToolInfo`](../type-aliases/ExternalMCPToolInfo.md)[] -Defined in: [mcp/externalServerManager.ts:2515](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2515) - Get all tools from all servers #### Returns @@ -493,8 +449,6 @@ Get all tools from all servers > **getServerTools**(`serverId`): [`ExternalMCPToolInfo`](../type-aliases/ExternalMCPToolInfo.md)[] -Defined in: [mcp/externalServerManager.ts:2522](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2522) - Get tools for a specific server #### Parameters @@ -513,8 +467,6 @@ Get tools for a specific server > **getToolDiscovery**(): `ToolDiscoveryService` -Defined in: [mcp/externalServerManager.ts:2529](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/externalServerManager.ts#L2529) - Get tool discovery service #### Returns diff --git a/docs/api/classes/FaithfulnessScorer.md b/docs/api/classes/FaithfulnessScorer.md index 2b8a5f7f3..9109739aa 100644 --- a/docs/api/classes/FaithfulnessScorer.md +++ b/docs/api/classes/FaithfulnessScorer.md @@ -6,8 +6,6 @@ # Class: FaithfulnessScorer -Defined in: [evaluation/scorers/llm/faithfulnessScorer.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/faithfulnessScorer.ts#L56) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new FaithfulnessScorer**(`config?`): `FaithfulnessScorer` -Defined in: [evaluation/scorers/llm/faithfulnessScorer.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/faithfulnessScorer.ts#L57) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/faithfulnessScorer.ts:57](https://github.com > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/faithfulnessScorer.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/faithfulnessScorer.ts#L81) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/faithfulnessScorer.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/faithfulnessScorer.ts#L104) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/FastifyServerAdapter.md b/docs/api/classes/FastifyServerAdapter.md index 531f17e76..d8b58e7ee 100644 --- a/docs/api/classes/FastifyServerAdapter.md +++ b/docs/api/classes/FastifyServerAdapter.md @@ -6,8 +6,6 @@ # Class: FastifyServerAdapter -Defined in: [server/adapters/fastifyAdapter.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L37) - Fastify-specific server adapter Provides high-performance HTTP server with schema validation @@ -21,8 +19,6 @@ Provides high-performance HTTP server with schema validation > **new FastifyServerAdapter**(`neurolink`, `config?`): `FastifyServerAdapter` -Defined in: [server/adapters/fastifyAdapter.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L41) - #### Parameters ##### neurolink @@ -47,8 +43,6 @@ Defined in: [server/adapters/fastifyAdapter.ts:41](https://github.com/juspay/neu > `protected` `readonly` **config**: [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L45) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`config`](BaseServerAdapter.md#config) @@ -59,8 +53,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/ > `protected` `readonly` `optional` **redactionConfig?**: [`RedactionConfig`](../type-aliases/RedactionConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L46) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`redactionConfig`](BaseServerAdapter.md#redactionconfig) @@ -71,8 +63,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/ > `protected` `readonly` **neurolink**: [`NeuroLink`](NeuroLink.md) -Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L47) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`neurolink`](BaseServerAdapter.md#neurolink) @@ -83,8 +73,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/ > `protected` `readonly` **toolRegistry**: [`MCPToolRegistry`](MCPToolRegistry.md) -Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L48) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`toolRegistry`](BaseServerAdapter.md#toolregistry) @@ -95,8 +83,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/ > `protected` `readonly` `optional` **externalServerManager?**: [`ExternalServerManager`](ExternalServerManager.md) -Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L49) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`externalServerManager`](BaseServerAdapter.md#externalservermanager) @@ -107,8 +93,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/ > `protected` **routes**: `Map`\<`string`, [`RouteDefinition`](../type-aliases/RouteDefinition.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L50) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`routes`](BaseServerAdapter.md#routes) @@ -119,8 +103,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/ > `protected` **middlewares**: [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md)[] = `[]` -Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L51) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`middlewares`](BaseServerAdapter.md#middlewares) @@ -131,8 +113,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/ > `protected` **isRunning**: `boolean` = `false` -Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L52) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`isRunning`](BaseServerAdapter.md#isrunning) @@ -143,8 +123,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/ > `protected` `optional` **startTime?**: `Date` -Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L53) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`startTime`](BaseServerAdapter.md#starttime) @@ -155,8 +133,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/ > `protected` **lifecycleState**: [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) = `"uninitialized"` -Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L56) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`lifecycleState`](BaseServerAdapter.md#lifecyclestate) @@ -167,8 +143,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/ > `protected` **activeConnections**: `Map`\<`string`, [`TrackedConnection`](../type-aliases/TrackedConnection.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L57) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`activeConnections`](BaseServerAdapter.md#activeconnections) @@ -179,8 +153,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/ > `protected` `readonly` **shutdownConfig**: [`RequiredShutdownConfig`](../type-aliases/RequiredShutdownConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L58) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`shutdownConfig`](BaseServerAdapter.md#shutdownconfig) @@ -191,8 +163,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/ > `protected` **importFrameworkDependency**\<`T`\>(`pkg`, `framework`): `Promise`\<`T`\> -Defined in: [server/abstract/baseServerAdapter.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L206) - Import an optional framework dependency (express/fastify/koa and their plugins), converting a missing package into a [MissingDependencyError](MissingDependencyError.md) instead of letting the framework's `Cannot find package` propagate raw. @@ -234,8 +204,6 @@ unchanged, matching `tryImport`'s own contract. > **registerRoute**(`route`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L295) - Register a custom route #### Parameters @@ -258,8 +226,6 @@ Register a custom route > **registerRouteGroup**(`group`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L317) - Register multiple routes from a route group #### Parameters @@ -292,8 +258,6 @@ Register multiple routes from a route group > **registerMiddleware**(`middleware`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L363) - Register custom middleware #### Parameters @@ -316,8 +280,6 @@ Register custom middleware > `protected` **createContext**(`options`): [`ServerContext`](../type-aliases/ServerContext.md) -Defined in: [server/abstract/baseServerAdapter.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L376) - Create request context from incoming request #### Parameters @@ -366,8 +328,6 @@ Create request context from incoming request > `protected` **registerBuiltInMiddleware**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L405) - Register built-in middleware #### Returns @@ -384,8 +344,6 @@ Register built-in middleware > `protected` **registerBuiltInRoutes**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L444) - Register built-in routes Only registers health routes if disableBuiltInHealth is false (default) @@ -403,8 +361,6 @@ Only registers health routes if disableBuiltInHealth is false (default) > `protected` **generateRequestId**(): `string` -Defined in: [server/abstract/baseServerAdapter.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L536) - Generate unique request ID #### Returns @@ -421,8 +377,6 @@ Generate unique request ID > **getLifecycleState**(): [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) -Defined in: [server/abstract/baseServerAdapter.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L547) - Get the current lifecycle state #### Returns @@ -439,8 +393,6 @@ Get the current lifecycle state > `protected` **trackConnection**(`id`, `socket?`, `requestId?`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L557) - Track a new connection #### Parameters @@ -477,8 +429,6 @@ Optional associated request ID > `protected` **untrackConnection**(`id`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L580) - Untrack a connection (when it's completed) #### Parameters @@ -503,8 +453,6 @@ Connection identifier to remove > **getActiveConnectionCount**(): `number` -Defined in: [server/abstract/baseServerAdapter.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L594) - Get the number of active connections #### Returns @@ -521,8 +469,6 @@ Get the number of active connections > `protected` **gracefulShutdown**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:602](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L602) - Perform graceful shutdown with connection draining This method handles the complete shutdown lifecycle @@ -540,8 +486,6 @@ This method handles the complete shutdown lifecycle > `protected` **drainConnections**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:737](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L737) - Wait for all active connections to drain Resolves when activeConnections is empty @@ -559,8 +503,6 @@ Resolves when activeConnections is empty > `protected` **resetServerState**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L763) - Reset server state for restart capability Call this after stop() completes to allow restart @@ -578,8 +520,6 @@ Call this after stop() completes to allow restart > `protected` **validateLifecycleState**(`operation`, `allowedStates`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:777](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L777) - Validate lifecycle state transition #### Parameters @@ -610,8 +550,6 @@ States that allow the operation > **getStatus**(): [`ServerStatus`](../type-aliases/ServerStatus.md) -Defined in: [server/abstract/baseServerAdapter.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L793) - Get server status #### Returns @@ -628,8 +566,6 @@ Get server status > **listRoutes**(): [`RouteDefinition`](../type-aliases/RouteDefinition.md)[] -Defined in: [server/abstract/baseServerAdapter.ts:809](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L809) - List all registered routes #### Returns @@ -646,8 +582,6 @@ List all registered routes > **getConfig**(): [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:816](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L816) - Get configuration #### Returns @@ -664,8 +598,6 @@ Get configuration > `protected` **initializeFramework**(): `void` -Defined in: [server/adapters/fastifyAdapter.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L49) - Initialize Fastify framework Called by base class but actual initialization happens in initializeFrameworkAsync @@ -683,8 +615,6 @@ Called by base class but actual initialization happens in initializeFrameworkAsy > **initialize**(): `Promise`\<`void`\> -Defined in: [server/adapters/fastifyAdapter.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L233) - Override initialize to ensure async framework setup #### Returns @@ -701,8 +631,6 @@ Override initialize to ensure async framework setup > `protected` **registerFrameworkRoute**(`route`): `void` -Defined in: [server/adapters/fastifyAdapter.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L253) - Register route with Fastify #### Parameters @@ -725,8 +653,6 @@ Register route with Fastify > `protected` **registerFrameworkMiddleware**(`middleware`): `void` -Defined in: [server/adapters/fastifyAdapter.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L430) - Register middleware with Fastify #### Parameters @@ -749,8 +675,6 @@ Register middleware with Fastify > **start**(): `Promise`\<`void`\> -Defined in: [server/adapters/fastifyAdapter.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L497) - Start the Fastify server #### Returns @@ -767,8 +691,6 @@ Start the Fastify server > **stop**(): `Promise`\<`void`\> -Defined in: [server/adapters/fastifyAdapter.ts:561](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L561) - Stop the Fastify server with graceful shutdown #### Returns @@ -785,8 +707,6 @@ Stop the Fastify server with graceful shutdown > `protected` **stopAcceptingConnections**(): `Promise`\<`void`\> -Defined in: [server/adapters/fastifyAdapter.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L596) - Stop accepting new connections #### Returns @@ -803,8 +723,6 @@ Stop accepting new connections > `protected` **closeServer**(): `Promise`\<`void`\> -Defined in: [server/adapters/fastifyAdapter.ts:604](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L604) - Close the underlying server #### Returns @@ -821,8 +739,6 @@ Close the underlying server > `protected` **forceCloseConnections**(): `Promise`\<`void`\> -Defined in: [server/adapters/fastifyAdapter.ts:618](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L618) - Force close all active connections #### Returns @@ -839,8 +755,6 @@ Force close all active connections > **getFrameworkInstance**(): `unknown` -Defined in: [server/adapters/fastifyAdapter.ts:636](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/fastifyAdapter.ts#L636) - Get the Fastify instance #### Returns diff --git a/docs/api/classes/FileSystemSkillStore.md b/docs/api/classes/FileSystemSkillStore.md index 80c1fb572..eedcd605c 100644 --- a/docs/api/classes/FileSystemSkillStore.md +++ b/docs/api/classes/FileSystemSkillStore.md @@ -6,8 +6,6 @@ # Class: FileSystemSkillStore -Defined in: [skills/skillStores.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L210) - Directory-backed store. Read layouts: - `/.json` — JSON SkillDefinition (mutable) @@ -27,8 +25,6 @@ Directory-backed store. Read layouts: > **new FileSystemSkillStore**(`baseDir`): `FileSystemSkillStore` -Defined in: [skills/skillStores.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L215) - #### Parameters ##### baseDir @@ -45,8 +41,6 @@ Defined in: [skills/skillStores.ts:215](https://github.com/juspay/neurolink/blob > **invalidate**(): `void` -Defined in: [skills/skillStores.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L217) - Optional: drop any internal caches (called after mutations). #### Returns @@ -63,8 +57,6 @@ Optional: drop any internal caches (called after mutations). > **get**(`id`): `Promise`\<[`SkillDefinition`](../type-aliases/SkillDefinition.md) \| `null`\> -Defined in: [skills/skillStores.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L221) - Fetch one skill (with instructions) by id. Null when absent. #### Parameters @@ -87,8 +79,6 @@ Fetch one skill (with instructions) by id. Null when absent. > **getResource**(`id`, `resourcePath`): `Promise`\<`string` \| `null`\> -Defined in: [skills/skillStores.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L233) - Resources exist only for directory-layout skills (`/SKILL.md`) — every sibling file of SKILL.md is addressable by its relative path. The REAL path must stay inside the skill directory: lexical @@ -119,8 +109,6 @@ to anywhere on the host. > **put**(`skill`): `Promise`\<`void`\> -Defined in: [skills/skillStores.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L258) - Create or replace a skill. #### Parameters @@ -143,8 +131,6 @@ Create or replace a skill. > **delete**(`id`): `Promise`\<`void`\> -Defined in: [skills/skillStores.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L269) - Hard-remove a skill from storage. (Soft deletes go through put().) #### Parameters @@ -167,8 +153,6 @@ Hard-remove a skill from storage. (Soft deletes go through put().) > **index**(): `Promise`\<[`SkillIndexItem`](../type-aliases/SkillIndexItem.md)[]\> -Defined in: [skills/skillStores.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L282) - List index entries (no instructions) for all stored skills. #### Returns diff --git a/docs/api/classes/FileTokenStorage.md b/docs/api/classes/FileTokenStorage.md index 5c8fa8642..93e93558b 100644 --- a/docs/api/classes/FileTokenStorage.md +++ b/docs/api/classes/FileTokenStorage.md @@ -6,8 +6,6 @@ # Class: FileTokenStorage -Defined in: [mcp/auth/tokenStorage.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L56) - File-based token storage implementation Persists tokens to disk for cross-session use @@ -21,8 +19,6 @@ Persists tokens to disk for cross-session use > **new FileTokenStorage**(`filePath`): `FileTokenStorage` -Defined in: [mcp/auth/tokenStorage.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L61) - #### Parameters ##### filePath @@ -39,8 +35,6 @@ Defined in: [mcp/auth/tokenStorage.ts:61](https://github.com/juspay/neurolink/bl > **getTokens**(`serverId`): `Promise`\<[`OAuthTokens`](../type-aliases/OAuthTokens.md) \| `null`\> -Defined in: [mcp/auth/tokenStorage.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L112) - Get stored tokens for a server #### Parameters @@ -67,8 +61,6 @@ Stored tokens or null if not found > **saveTokens**(`serverId`, `tokens`): `Promise`\<`void`\> -Defined in: [mcp/auth/tokenStorage.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L117) - Save tokens for a server #### Parameters @@ -99,8 +91,6 @@ OAuth tokens to store > **deleteTokens**(`serverId`): `Promise`\<`void`\> -Defined in: [mcp/auth/tokenStorage.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L123) - Delete stored tokens for a server #### Parameters @@ -125,8 +115,6 @@ Unique identifier for the MCP server > **hasTokens**(`serverId`): `Promise`\<`boolean`\> -Defined in: [mcp/auth/tokenStorage.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L129) - Check if tokens exist for a server #### Parameters @@ -153,8 +141,6 @@ True if tokens exist > **clearAll**(): `Promise`\<`void`\> -Defined in: [mcp/auth/tokenStorage.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L134) - Clear all stored tokens #### Returns diff --git a/docs/api/classes/FishAudioTTS.md b/docs/api/classes/FishAudioTTS.md index 2329a9124..c1116fd42 100644 --- a/docs/api/classes/FishAudioTTS.md +++ b/docs/api/classes/FishAudioTTS.md @@ -6,8 +6,6 @@ # Class: FishAudioTTS -Defined in: [voice/providers/FishAudioTTS.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/FishAudioTTS.ts#L41) - Fish Audio Text-to-Speech Handler. Auth: `Authorization: Bearer ${FISH_AUDIO_API_KEY}`. @@ -23,8 +21,6 @@ Models: speech-1.5 (standard), speech-1.6, s1 (default; latest). > **new FishAudioTTS**(`apiKey?`): `FishAudioTTS` -Defined in: [voice/providers/FishAudioTTS.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/FishAudioTTS.ts#L47) - #### Parameters ##### apiKey? @@ -41,8 +37,6 @@ Defined in: [voice/providers/FishAudioTTS.ts:47](https://github.com/juspay/neuro > `readonly` **maxTextLength**: `5000` = `5000` -Defined in: [voice/providers/FishAudioTTS.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/FishAudioTTS.ts#L42) - Maximum text length supported by this provider (in bytes) Different providers have different limits @@ -62,8 +56,6 @@ Different providers have different limits > **isConfigured**(): `boolean` -Defined in: [voice/providers/FishAudioTTS.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/FishAudioTTS.ts#L55) - Validate that the provider is properly configured #### Returns @@ -82,8 +74,6 @@ True if provider can generate TTS > **synthesize**(`text`, `options?`): `Promise`\<[`TTSResult`](../type-aliases/TTSResult.md)\> -Defined in: [voice/providers/FishAudioTTS.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/FishAudioTTS.ts#L59) - Generate audio from text using provider-specific TTS API **IMPORTANT: Timeout Responsibility** diff --git a/docs/api/classes/GeminiLive.md b/docs/api/classes/GeminiLive.md index a7fb4b7de..1163976f4 100644 --- a/docs/api/classes/GeminiLive.md +++ b/docs/api/classes/GeminiLive.md @@ -6,8 +6,6 @@ # Class: GeminiLive -Defined in: [voice/providers/GeminiLive.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L29) - Google Gemini Live Voice API Handler Implements bidirectional voice communication with Gemini's Live API. @@ -26,8 +24,6 @@ https://ai.google.dev/gemini-api/docs/live > **new GeminiLive**(`apiKey?`): `GeminiLive` -Defined in: [voice/providers/GeminiLive.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L37) - #### Parameters ##### apiKey? @@ -48,8 +44,6 @@ Defined in: [voice/providers/GeminiLive.ts:37](https://github.com/juspay/neuroli > `protected` **session**: [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` = `null` -Defined in: [voice/RealtimeVoiceAPI.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L432) - #### Inherited from [`BaseRealtimeHandler`](BaseRealtimeHandler.md).[`session`](BaseRealtimeHandler.md#session) @@ -60,8 +54,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:432](https://github.com/juspay/neurolink/ > `protected` **eventHandlers**: [`RealtimeEventHandlers`](../type-aliases/RealtimeEventHandlers.md) \| `null` = `null` -Defined in: [voice/RealtimeVoiceAPI.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L433) - #### Inherited from [`BaseRealtimeHandler`](BaseRealtimeHandler.md).[`eventHandlers`](BaseRealtimeHandler.md#eventhandlers) @@ -72,8 +64,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:433](https://github.com/juspay/neurolink/ > `protected` **state**: [`RealtimeSessionState`](../type-aliases/RealtimeSessionState.md) = `"disconnected"` -Defined in: [voice/RealtimeVoiceAPI.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L434) - #### Inherited from [`BaseRealtimeHandler`](BaseRealtimeHandler.md).[`state`](BaseRealtimeHandler.md#state) @@ -84,8 +74,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:434](https://github.com/juspay/neurolink/ > `readonly` **name**: `"gemini-live"` = `"gemini-live"` -Defined in: [voice/providers/GeminiLive.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L30) - #### Overrides [`BaseRealtimeHandler`](BaseRealtimeHandler.md).[`name`](BaseRealtimeHandler.md#name) @@ -96,8 +84,6 @@ Defined in: [voice/providers/GeminiLive.ts:30](https://github.com/juspay/neuroli > **isConnected**(): `boolean` -Defined in: [voice/RealtimeVoiceAPI.ts:442](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L442) - #### Returns `boolean` @@ -112,8 +98,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:442](https://github.com/juspay/neurolink/ > **getSession**(): [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` -Defined in: [voice/RealtimeVoiceAPI.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L446) - #### Returns [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` @@ -128,8 +112,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:446](https://github.com/juspay/neurolink/ > **on**(`handlers`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L450) - #### Parameters ##### handlers @@ -150,8 +132,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:450](https://github.com/juspay/neurolink/ > **off**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L454) - #### Returns `void` @@ -166,8 +146,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:454](https://github.com/juspay/neurolink/ > `protected` **emitStateChange**(`newState`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:461](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L461) - Emit state change event #### Parameters @@ -190,8 +168,6 @@ Emit state change event > `protected` **emitAudio**(`chunk`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L473) - Emit audio event #### Parameters @@ -214,8 +190,6 @@ Emit audio event > `protected` **emitTranscript**(`text`, `isFinal`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L480) - Emit transcript event #### Parameters @@ -242,8 +216,6 @@ Emit transcript event > `protected` **emitText**(`text`, `isFinal`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L487) - Emit text event #### Parameters @@ -270,8 +242,6 @@ Emit text event > `protected` **emitFunctionCall**(`name`, `args`): `Promise`\<`unknown`\> -Defined in: [voice/RealtimeVoiceAPI.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L494) - Emit function call event #### Parameters @@ -298,8 +268,6 @@ Emit function call event > `protected` **emitError**(`error`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L507) - Emit error event #### Parameters @@ -322,8 +290,6 @@ Emit error event > `protected` **emitTurnStart**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:514](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L514) - Emit turn start event #### Returns @@ -340,8 +306,6 @@ Emit turn start event > `protected` **emitTurnEnd**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L521) - Emit turn end event #### Returns @@ -358,8 +322,6 @@ Emit turn end event > `protected` **createSession**(`id`, `config`): [`RealtimeSession`](../type-aliases/RealtimeSession.md) -Defined in: [voice/RealtimeVoiceAPI.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L528) - Create a session object #### Parameters @@ -386,8 +348,6 @@ Create a session object > **isConfigured**(): `boolean` -Defined in: [voice/providers/GeminiLive.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L52) - #### Returns `boolean` @@ -402,8 +362,6 @@ Defined in: [voice/providers/GeminiLive.ts:52](https://github.com/juspay/neuroli > **getSupportedFormats**(): [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] -Defined in: [voice/providers/GeminiLive.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L56) - #### Returns [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] @@ -418,8 +376,6 @@ Defined in: [voice/providers/GeminiLive.ts:56](https://github.com/juspay/neuroli > **connect**(`config`): `Promise`\<[`RealtimeSession`](../type-aliases/RealtimeSession.md)\> -Defined in: [voice/providers/GeminiLive.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L60) - #### Parameters ##### config @@ -440,8 +396,6 @@ Defined in: [voice/providers/GeminiLive.ts:60](https://github.com/juspay/neuroli > **disconnect**(): `Promise`\<`void`\> -Defined in: [voice/providers/GeminiLive.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L163) - #### Returns `Promise`\<`void`\> @@ -456,8 +410,6 @@ Defined in: [voice/providers/GeminiLive.ts:163](https://github.com/juspay/neurol > **sendAudio**(`audio`): `Promise`\<`void`\> -Defined in: [voice/providers/GeminiLive.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L189) - #### Parameters ##### audio @@ -478,8 +430,6 @@ Defined in: [voice/providers/GeminiLive.ts:189](https://github.com/juspay/neurol > **sendText**(`text`): `Promise`\<`void`\> -Defined in: [voice/providers/GeminiLive.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L211) - #### Parameters ##### text @@ -496,8 +446,6 @@ Defined in: [voice/providers/GeminiLive.ts:211](https://github.com/juspay/neurol > **triggerResponse**(): `Promise`\<`void`\> -Defined in: [voice/providers/GeminiLive.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L232) - #### Returns `Promise`\<`void`\> @@ -508,8 +456,6 @@ Defined in: [voice/providers/GeminiLive.ts:232](https://github.com/juspay/neurol > **cancelResponse**(): `Promise`\<`void`\> -Defined in: [voice/providers/GeminiLive.ts:237](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GeminiLive.ts#L237) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/classes/GoogleSTT.md b/docs/api/classes/GoogleSTT.md index 37b22bd36..6c4e8dc0e 100644 --- a/docs/api/classes/GoogleSTT.md +++ b/docs/api/classes/GoogleSTT.md @@ -6,8 +6,6 @@ # Class: GoogleSTT -Defined in: [voice/providers/GoogleSTT.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L33) - Google Cloud Speech-to-Text Handler Supports transcription with speaker diarization, word timestamps, and punctuation. @@ -26,8 +24,6 @@ https://cloud.google.com/speech-to-text/docs > **new GoogleSTT**(`apiKey?`, `credentialsPath?`): `GoogleSTT` -Defined in: [voice/providers/GoogleSTT.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L50) - #### Parameters ##### apiKey? @@ -48,8 +44,6 @@ Defined in: [voice/providers/GoogleSTT.ts:50](https://github.com/juspay/neurolin > `readonly` **maxAudioDuration**: `60` = `60` -Defined in: [voice/providers/GoogleSTT.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L42) - Maximum audio duration in seconds for the synchronous recognize endpoint. For longer audio, use the async longrunningrecognize endpoint (not yet implemented). @@ -63,8 +57,6 @@ For longer audio, use the async longrunningrecognize endpoint (not yet implement > `readonly` **supportsStreaming**: `false` = `false` -Defined in: [voice/providers/GoogleSTT.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L48) - True streaming requires gRPC (not yet implemented). transcribeStream() uses a chunk-and-batch workaround. @@ -78,8 +70,6 @@ transcribeStream() uses a chunk-and-batch workaround. > **isConfigured**(): `boolean` -Defined in: [voice/providers/GoogleSTT.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L70) - #### Returns `boolean` @@ -94,8 +84,6 @@ Defined in: [voice/providers/GoogleSTT.ts:70](https://github.com/juspay/neurolin > **getSupportedFormats**(): [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] -Defined in: [voice/providers/GoogleSTT.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L74) - #### Returns [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] @@ -110,8 +98,6 @@ Defined in: [voice/providers/GoogleSTT.ts:74](https://github.com/juspay/neurolin > **getSupportedLanguages**(): `Promise`\<[`STTLanguage`](../type-aliases/STTLanguage.md)[]\> -Defined in: [voice/providers/GoogleSTT.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L78) - #### Returns `Promise`\<[`STTLanguage`](../type-aliases/STTLanguage.md)[]\> @@ -126,8 +112,6 @@ Defined in: [voice/providers/GoogleSTT.ts:78](https://github.com/juspay/neurolin > **transcribe**(`audio`, `options?`): `Promise`\<[`STTResult`](../type-aliases/STTResult.md)\> -Defined in: [voice/providers/GoogleSTT.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L174) - #### Parameters ##### audio @@ -152,8 +136,6 @@ Defined in: [voice/providers/GoogleSTT.ts:174](https://github.com/juspay/neuroli > **transcribeStream**(`audioStream`, `options`): `AsyncIterable`\<[`TranscriptionSegment`](../type-aliases/TranscriptionSegment.md)\> -Defined in: [voice/providers/GoogleSTT.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/GoogleSTT.ts#L382) - Streaming transcription (placeholder - requires WebSocket/gRPC) #### Parameters diff --git a/docs/api/classes/GoogleTTSHandler.md b/docs/api/classes/GoogleTTSHandler.md index f5ddb89b6..e7cb97d05 100644 --- a/docs/api/classes/GoogleTTSHandler.md +++ b/docs/api/classes/GoogleTTSHandler.md @@ -6,8 +6,6 @@ # Class: GoogleTTSHandler -Defined in: [adapters/tts/googleTTSHandler.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/tts/googleTTSHandler.ts#L29) - ## Implements - [`TTSHandler`](../type-aliases/TTSHandler.md) @@ -18,8 +16,6 @@ Defined in: [adapters/tts/googleTTSHandler.ts:29](https://github.com/juspay/neur > **new GoogleTTSHandler**(`credentialsPath?`): `GoogleTTSHandler` -Defined in: [adapters/tts/googleTTSHandler.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/tts/googleTTSHandler.ts#L61) - #### Parameters ##### credentialsPath? @@ -36,8 +32,6 @@ Defined in: [adapters/tts/googleTTSHandler.ts:61](https://github.com/juspay/neur > `readonly` **maxTextLength**: `number` = `GoogleTTSHandler.DEFAULT_MAX_TEXT_LENGTH` -Defined in: [adapters/tts/googleTTSHandler.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/tts/googleTTSHandler.ts#L56) - Maximum text length supported by Google Cloud TTS (in bytes). NOTE: @@ -54,8 +48,6 @@ before invoking provider handlers, not inside this class. > **isConfigured**(): `boolean` -Defined in: [adapters/tts/googleTTSHandler.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/tts/googleTTSHandler.ts#L71) - Validate that the provider is properly configured #### Returns @@ -74,8 +66,6 @@ True if provider can generate TTS > **getVoices**(`languageCode?`): `Promise`\<[`TTSVoice`](../type-aliases/TTSVoice.md)[]\> -Defined in: [adapters/tts/googleTTSHandler.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/tts/googleTTSHandler.ts#L103) - Get available voices for the provider Note: This method is optional in the TTSHandler interface, but Google Cloud TTS @@ -105,8 +95,6 @@ List of available voices > **synthesize**(`text`, `options`): `Promise`\<[`TTSResult`](../type-aliases/TTSResult.md)\> -Defined in: [adapters/tts/googleTTSHandler.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/tts/googleTTSHandler.ts#L221) - Generate audio from text using provider-specific TTS API #### Parameters diff --git a/docs/api/classes/GraphRAG.md b/docs/api/classes/GraphRAG.md index 839b63c6d..aedfd72af 100644 --- a/docs/api/classes/GraphRAG.md +++ b/docs/api/classes/GraphRAG.md @@ -6,8 +6,6 @@ # Class: GraphRAG -Defined in: [rag/graphRag/graphRAG.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L29) - Graph-based Retrieval Augmented Generation Creates a knowledge graph from document chunks where nodes represent @@ -20,8 +18,6 @@ embedding similarity. > **new GraphRAG**(`config?`): `GraphRAG` -Defined in: [rag/graphRag/graphRAG.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L35) - #### Parameters ##### config? @@ -38,8 +34,6 @@ Defined in: [rag/graphRag/graphRAG.ts:35](https://github.com/juspay/neurolink/bl > **createGraph**(`chunks`, `embeddings`): `void` -Defined in: [rag/graphRag/graphRAG.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L46) - Create a knowledge graph from document chunks and embeddings #### Parameters @@ -66,8 +60,6 @@ Corresponding embedding vectors > **query**(`params`): [`RankedNode`](../type-aliases/RankedNode.md)[] -Defined in: [rag/graphRag/graphRAG.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L122) - Query the graph using random walk with restart #### Parameters @@ -90,8 +82,6 @@ Ranked nodes by relevance > **addNode**(`chunk`, `embedding`): `string` -Defined in: [rag/graphRag/graphRAG.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L224) - Add a single node to the graph #### Parameters @@ -120,8 +110,6 @@ Node ID > **removeNode**(`id`): `boolean` -Defined in: [rag/graphRag/graphRAG.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L280) - Remove a node and its edges from the graph #### Parameters @@ -144,8 +132,6 @@ True if node was removed > **getStats**(): [`GraphStats`](../type-aliases/GraphStats.md) -Defined in: [rag/graphRag/graphRAG.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L303) - Get graph statistics #### Returns @@ -158,8 +144,6 @@ Get graph statistics > **getNode**(`id`): [`GraphNode`](../type-aliases/GraphNode.md) \| `undefined` -Defined in: [rag/graphRag/graphRAG.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L320) - Get a node by ID #### Parameters @@ -178,8 +162,6 @@ Get a node by ID > **getAllNodes**(): [`GraphNode`](../type-aliases/GraphNode.md)[] -Defined in: [rag/graphRag/graphRAG.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L327) - Get all nodes #### Returns @@ -192,8 +174,6 @@ Get all nodes > **getEdges**(`nodeId`): [`GraphEdge`](../type-aliases/GraphEdge.md)[] -Defined in: [rag/graphRag/graphRAG.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L334) - Get edges for a node #### Parameters @@ -212,8 +192,6 @@ Get edges for a node > **findConnectedComponents**(): `string`[][] -Defined in: [rag/graphRag/graphRAG.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L341) - Find connected components in the graph #### Returns @@ -226,8 +204,6 @@ Find connected components in the graph > **updateThreshold**(`threshold`): `void` -Defined in: [rag/graphRag/graphRAG.ts:428](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L428) - Update similarity threshold and rebuild edges #### Parameters @@ -246,8 +222,6 @@ Update similarity threshold and rebuild edges > **toJSON**(): `object` -Defined in: [rag/graphRag/graphRAG.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L476) - Serialize graph to JSON #### Returns @@ -280,8 +254,6 @@ Serialize graph to JSON > `static` **fromJSON**(`json`): `GraphRAG` -Defined in: [rag/graphRag/graphRAG.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/rag/graphRag/graphRAG.ts#L497) - Load graph from JSON #### Parameters diff --git a/docs/api/classes/HITLManager.md b/docs/api/classes/HITLManager.md index cb947abf9..58bbc4455 100644 --- a/docs/api/classes/HITLManager.md +++ b/docs/api/classes/HITLManager.md @@ -6,8 +6,6 @@ # Class: HITLManager -Defined in: [hitl/hitlManager.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L39) - HITLManager - Central orchestrator for Human-in-the-Loop safety mechanisms Features: @@ -29,8 +27,6 @@ Features: > **new HITLManager**(`config`): `HITLManager` -Defined in: [hitl/hitlManager.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L51) - #### Parameters ##### config @@ -51,8 +47,6 @@ Defined in: [hitl/hitlManager.ts:51](https://github.com/juspay/neurolink/blob/re > **requiresConfirmation**(`toolName`, `args?`): `boolean` -Defined in: [hitl/hitlManager.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L111) - Check if a tool requires confirmation based on configuration #### Parameters @@ -75,8 +69,6 @@ Check if a tool requires confirmation based on configuration > **requestConfirmation**(`toolName`, `arguments_`, `context?`): `Promise`\<[`ConfirmationResult`](../type-aliases/ConfirmationResult.md)\> -Defined in: [hitl/hitlManager.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L150) - Request confirmation for a tool execution #### Parameters @@ -113,8 +105,6 @@ Request confirmation for a tool execution > **processUserResponse**(`confirmationId`, `response`): `void` -Defined in: [hitl/hitlManager.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L226) - Process user response to confirmation request #### Parameters @@ -155,8 +145,6 @@ Process user response to confirmation request > **getStatistics**(): [`HITLStatistics`](../type-aliases/HITLStatistics.md) -Defined in: [hitl/hitlManager.ts:519](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L519) - Get current HITL usage statistics #### Returns @@ -169,8 +157,6 @@ Get current HITL usage statistics > **getConfig**(): [`HITLConfig`](../type-aliases/HITLConfig.md) -Defined in: [hitl/hitlManager.ts:526](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L526) - Get current configuration #### Returns @@ -183,8 +169,6 @@ Get current configuration > **updateConfig**(`newConfig`): `void` -Defined in: [hitl/hitlManager.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L533) - Update configuration (for dynamic reconfiguration) #### Parameters @@ -203,8 +187,6 @@ Update configuration (for dynamic reconfiguration) > **cleanup**(): `void` -Defined in: [hitl/hitlManager.ts:548](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L548) - Clean up resources and reject pending confirmations #### Returns @@ -217,8 +199,6 @@ Clean up resources and reject pending confirmations > **isEnabled**(): `boolean` -Defined in: [hitl/hitlManager.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L570) - Check if manager is currently enabled #### Returns @@ -231,8 +211,6 @@ Check if manager is currently enabled > **getPendingCount**(): `number` -Defined in: [hitl/hitlManager.ts:577](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L577) - Get count of pending confirmations #### Returns @@ -245,8 +223,6 @@ Get count of pending confirmations > **hasPendingConfirmation**(`confirmationId`): `boolean` -Defined in: [hitl/hitlManager.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/hitl/hitlManager.ts#L594) - Whether a specific confirmation is still awaiting a response on this manager. A pending entry holds the `resolve`/`reject` of the suspended tool call, so it diff --git a/docs/api/classes/HTMLChunker.md b/docs/api/classes/HTMLChunker.md index edf0028ce..2a66dceae 100644 --- a/docs/api/classes/HTMLChunker.md +++ b/docs/api/classes/HTMLChunker.md @@ -6,8 +6,6 @@ # Class: HTMLChunker -Defined in: [rag/chunking/htmlChunker.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/htmlChunker.ts#L21) - HTML-aware chunker implementation Splits based on HTML structure (tags, elements) @@ -31,8 +29,6 @@ Splits based on HTML structure (tags, elements) > `readonly` **strategy**: `"html"` -Defined in: [rag/chunking/htmlChunker.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/htmlChunker.ts#L22) - Strategy name for identification #### Implementation of @@ -45,8 +41,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/htmlChunker.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/htmlChunker.ts#L49) - Split text into chunks #### Parameters @@ -79,8 +73,6 @@ Array of chunks > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/htmlChunker.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/htmlChunker.ts#L313) - #### Parameters ##### config diff --git a/docs/api/classes/HTMLLoader.md b/docs/api/classes/HTMLLoader.md index 8a7af0c11..b882b7ece 100644 --- a/docs/api/classes/HTMLLoader.md +++ b/docs/api/classes/HTMLLoader.md @@ -6,8 +6,6 @@ # Class: HTMLLoader -Defined in: [rag/document/loaders.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L107) - HTML file loader ## Extends @@ -34,8 +32,6 @@ HTML file loader > `protected` **loadContent**(`source`, `encoding?`): `Promise`\<`string`\> -Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L70) - #### Parameters ##### source @@ -60,8 +56,6 @@ Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blo > `protected` **getSourceName**(`source`): `string` -Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L81) - #### Parameters ##### source @@ -82,8 +76,6 @@ Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blo > **load**(`source`, `options?`): `Promise`\<[`MDocument`](MDocument.md)\> -Defined in: [rag/document/loaders.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L108) - Load document from source #### Parameters @@ -116,8 +108,6 @@ Promise resolving to MDocument > **canHandle**(`source`): `boolean` -Defined in: [rag/document/loaders.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L116) - Check if loader can handle the source #### Parameters diff --git a/docs/api/classes/HTTPRateLimiter.md b/docs/api/classes/HTTPRateLimiter.md index ab2db908d..a60739cef 100644 --- a/docs/api/classes/HTTPRateLimiter.md +++ b/docs/api/classes/HTTPRateLimiter.md @@ -6,8 +6,6 @@ # Class: HTTPRateLimiter -Defined in: [mcp/httpRateLimiter.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L42) - HTTPRateLimiter Implements token bucket algorithm for rate limiting HTTP requests @@ -24,8 +22,6 @@ The token bucket algorithm works as follows: > **new HTTPRateLimiter**(`config?`): `HTTPRateLimiter` -Defined in: [mcp/httpRateLimiter.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L52) - #### Parameters ##### config? @@ -42,8 +38,6 @@ Defined in: [mcp/httpRateLimiter.ts:52](https://github.com/juspay/neurolink/blob > **acquire**(): `Promise`\<`void`\> -Defined in: [mcp/httpRateLimiter.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L99) - Acquire a token, waiting if necessary This is the primary method for rate-limited operations @@ -63,8 +57,6 @@ Error if the wait queue is too long > **tryAcquire**(): `boolean` -Defined in: [mcp/httpRateLimiter.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L206) - Try to acquire a token without waiting #### Returns @@ -79,8 +71,6 @@ true if a token was acquired, false otherwise > **handleRateLimitResponse**(`headers`): `number` -Defined in: [mcp/httpRateLimiter.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L232) - Handle rate limit response headers from server Parses Retry-After header and returns wait time in milliseconds @@ -104,8 +94,6 @@ Wait time in milliseconds, or 0 if no rate limit headers found > **getRemainingTokens**(): `number` -Defined in: [mcp/httpRateLimiter.ts:288](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L288) - Get the number of remaining tokens #### Returns @@ -120,8 +108,6 @@ Current number of available tokens > **reset**(): `void` -Defined in: [mcp/httpRateLimiter.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L297) - Reset the rate limiter to initial state Useful for testing or when server indicates rate limits have been reset @@ -135,8 +121,6 @@ Useful for testing or when server indicates rate limits have been reset > **getStats**(): [`RateLimiterStats`](../type-aliases/RateLimiterStats.md) -Defined in: [mcp/httpRateLimiter.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L317) - Get current rate limiter statistics #### Returns @@ -149,8 +133,6 @@ Get current rate limiter statistics > **updateConfig**(`config`): `void` -Defined in: [mcp/httpRateLimiter.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L332) - Update configuration dynamically Useful when server provides rate limit information @@ -170,8 +152,6 @@ Useful when server provides rate limit information > **getConfig**(): `Readonly`\<[`TokenBucketRateLimitConfig`](../type-aliases/TokenBucketRateLimitConfig.md)\> -Defined in: [mcp/httpRateLimiter.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L340) - Get current configuration #### Returns diff --git a/docs/api/classes/HallucinationScorer.md b/docs/api/classes/HallucinationScorer.md index 5ed83757d..07dc0f9fb 100644 --- a/docs/api/classes/HallucinationScorer.md +++ b/docs/api/classes/HallucinationScorer.md @@ -6,8 +6,6 @@ # Class: HallucinationScorer -Defined in: [evaluation/scorers/llm/hallucinationScorer.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/hallucinationScorer.ts#L69) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new HallucinationScorer**(`config?`): `HallucinationScorer` -Defined in: [evaluation/scorers/llm/hallucinationScorer.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/hallucinationScorer.ts#L70) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/hallucinationScorer.ts:70](https://github.co > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/hallucinationScorer.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/hallucinationScorer.ts#L94) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/hallucinationScorer.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/hallucinationScorer.ts#L125) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/HandlerError.md b/docs/api/classes/HandlerError.md index 1af7e1735..ff2b313e1 100644 --- a/docs/api/classes/HandlerError.md +++ b/docs/api/classes/HandlerError.md @@ -6,8 +6,6 @@ # Class: HandlerError -Defined in: [server/errors.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L294) - Handler error ## Extends @@ -20,8 +18,6 @@ Handler error > **new HandlerError**(`message`, `cause?`, `requestId?`, `path?`, `method?`): `HandlerError` -Defined in: [server/errors.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L295) - #### Parameters ##### message @@ -58,8 +54,6 @@ Defined in: [server/errors.ts:295](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -70,8 +64,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -82,8 +74,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -94,8 +84,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -106,8 +94,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -118,8 +104,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -130,8 +114,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -142,8 +124,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -154,8 +134,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -166,8 +144,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -178,8 +154,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -196,8 +170,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/HeyGenAvatar.md b/docs/api/classes/HeyGenAvatar.md index 2e6056164..4d03b2af2 100644 --- a/docs/api/classes/HeyGenAvatar.md +++ b/docs/api/classes/HeyGenAvatar.md @@ -6,8 +6,6 @@ # Class: HeyGenAvatar -Defined in: [avatar/providers/HeyGenAvatar.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/HeyGenAvatar.ts#L40) - HeyGen Avatar Handler. Auth: `X-API-Key: ${HEYGEN_API_KEY}`. The HeyGen API expects an @@ -24,8 +22,6 @@ for legacy callers, or `options.avatarId` for explicit users. > **new HeyGenAvatar**(`apiKey?`): `HeyGenAvatar` -Defined in: [avatar/providers/HeyGenAvatar.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/HeyGenAvatar.ts#L47) - #### Parameters ##### apiKey? @@ -42,8 +38,6 @@ Defined in: [avatar/providers/HeyGenAvatar.ts:47](https://github.com/juspay/neur > `readonly` **maxAudioDurationSeconds**: `300` = `300` -Defined in: [avatar/providers/HeyGenAvatar.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/HeyGenAvatar.ts#L41) - Maximum supported audio length in seconds (provider-specific). #### Implementation of @@ -56,8 +50,6 @@ Maximum supported audio length in seconds (provider-specific). > `readonly` **supportedFormats**: readonly [`AvatarVideoFormat`](../type-aliases/AvatarVideoFormat.md)[] -Defined in: [avatar/providers/HeyGenAvatar.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/HeyGenAvatar.ts#L42) - Output formats supported by this handler. #### Implementation of @@ -70,8 +62,6 @@ Output formats supported by this handler. > **isConfigured**(): `boolean` -Defined in: [avatar/providers/HeyGenAvatar.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/HeyGenAvatar.ts#L56) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -88,8 +78,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`options`): `Promise`\<[`AvatarResult`](../type-aliases/AvatarResult.md)\> -Defined in: [avatar/providers/HeyGenAvatar.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/HeyGenAvatar.ts#L60) - Generate a talking-head video from an image + audio (or pre-rendered text). #### Parameters diff --git a/docs/api/classes/HonoServerAdapter.md b/docs/api/classes/HonoServerAdapter.md index ae27c07e5..5c07dc4b7 100644 --- a/docs/api/classes/HonoServerAdapter.md +++ b/docs/api/classes/HonoServerAdapter.md @@ -6,8 +6,6 @@ # Class: HonoServerAdapter -Defined in: [server/adapters/honoAdapter.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L39) - Hono-specific server adapter Supports multiple runtimes: Bun, Deno, Node.js @@ -21,8 +19,6 @@ Supports multiple runtimes: Bun, Deno, Node.js > **new HonoServerAdapter**(`neurolink`, `config?`): `HonoServerAdapter` -Defined in: [server/adapters/honoAdapter.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L47) - #### Parameters ##### neurolink @@ -47,8 +43,6 @@ Defined in: [server/adapters/honoAdapter.ts:47](https://github.com/juspay/neurol > `protected` `readonly` **config**: [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L45) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`config`](BaseServerAdapter.md#config) @@ -59,8 +53,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/ > `protected` `readonly` `optional` **redactionConfig?**: [`RedactionConfig`](../type-aliases/RedactionConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L46) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`redactionConfig`](BaseServerAdapter.md#redactionconfig) @@ -71,8 +63,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/ > `protected` `readonly` **neurolink**: [`NeuroLink`](NeuroLink.md) -Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L47) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`neurolink`](BaseServerAdapter.md#neurolink) @@ -83,8 +73,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/ > `protected` `readonly` **toolRegistry**: [`MCPToolRegistry`](MCPToolRegistry.md) -Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L48) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`toolRegistry`](BaseServerAdapter.md#toolregistry) @@ -95,8 +83,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/ > `protected` `readonly` `optional` **externalServerManager?**: [`ExternalServerManager`](ExternalServerManager.md) -Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L49) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`externalServerManager`](BaseServerAdapter.md#externalservermanager) @@ -107,8 +93,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/ > `protected` **routes**: `Map`\<`string`, [`RouteDefinition`](../type-aliases/RouteDefinition.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L50) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`routes`](BaseServerAdapter.md#routes) @@ -119,8 +103,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/ > `protected` **middlewares**: [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md)[] = `[]` -Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L51) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`middlewares`](BaseServerAdapter.md#middlewares) @@ -131,8 +113,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/ > `protected` **isRunning**: `boolean` = `false` -Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L52) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`isRunning`](BaseServerAdapter.md#isrunning) @@ -143,8 +123,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/ > `protected` `optional` **startTime?**: `Date` -Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L53) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`startTime`](BaseServerAdapter.md#starttime) @@ -155,8 +133,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/ > `protected` **lifecycleState**: [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) = `"uninitialized"` -Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L56) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`lifecycleState`](BaseServerAdapter.md#lifecyclestate) @@ -167,8 +143,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/ > `protected` **activeConnections**: `Map`\<`string`, [`TrackedConnection`](../type-aliases/TrackedConnection.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L57) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`activeConnections`](BaseServerAdapter.md#activeconnections) @@ -179,8 +153,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/ > `protected` `readonly` **shutdownConfig**: [`RequiredShutdownConfig`](../type-aliases/RequiredShutdownConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L58) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`shutdownConfig`](BaseServerAdapter.md#shutdownconfig) @@ -191,8 +163,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/ > `protected` **importFrameworkDependency**\<`T`\>(`pkg`, `framework`): `Promise`\<`T`\> -Defined in: [server/abstract/baseServerAdapter.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L206) - Import an optional framework dependency (express/fastify/koa and their plugins), converting a missing package into a [MissingDependencyError](MissingDependencyError.md) instead of letting the framework's `Cannot find package` propagate raw. @@ -234,8 +204,6 @@ unchanged, matching `tryImport`'s own contract. > **initialize**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L224) - Initialize the server adapter Sets up routes, middleware, and framework @@ -253,8 +221,6 @@ Sets up routes, middleware, and framework > **registerRoute**(`route`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L295) - Register a custom route #### Parameters @@ -277,8 +243,6 @@ Register a custom route > **registerRouteGroup**(`group`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L317) - Register multiple routes from a route group #### Parameters @@ -311,8 +275,6 @@ Register multiple routes from a route group > **registerMiddleware**(`middleware`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L363) - Register custom middleware #### Parameters @@ -335,8 +297,6 @@ Register custom middleware > `protected` **createContext**(`options`): [`ServerContext`](../type-aliases/ServerContext.md) -Defined in: [server/abstract/baseServerAdapter.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L376) - Create request context from incoming request #### Parameters @@ -385,8 +345,6 @@ Create request context from incoming request > `protected` **registerBuiltInMiddleware**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L405) - Register built-in middleware #### Returns @@ -403,8 +361,6 @@ Register built-in middleware > `protected` **registerBuiltInRoutes**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L444) - Register built-in routes Only registers health routes if disableBuiltInHealth is false (default) @@ -422,8 +378,6 @@ Only registers health routes if disableBuiltInHealth is false (default) > `protected` **generateRequestId**(): `string` -Defined in: [server/abstract/baseServerAdapter.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L536) - Generate unique request ID #### Returns @@ -440,8 +394,6 @@ Generate unique request ID > **getLifecycleState**(): [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) -Defined in: [server/abstract/baseServerAdapter.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L547) - Get the current lifecycle state #### Returns @@ -458,8 +410,6 @@ Get the current lifecycle state > `protected` **trackConnection**(`id`, `socket?`, `requestId?`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L557) - Track a new connection #### Parameters @@ -496,8 +446,6 @@ Optional associated request ID > `protected` **untrackConnection**(`id`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L580) - Untrack a connection (when it's completed) #### Parameters @@ -522,8 +470,6 @@ Connection identifier to remove > **getActiveConnectionCount**(): `number` -Defined in: [server/abstract/baseServerAdapter.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L594) - Get the number of active connections #### Returns @@ -540,8 +486,6 @@ Get the number of active connections > `protected` **gracefulShutdown**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:602](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L602) - Perform graceful shutdown with connection draining This method handles the complete shutdown lifecycle @@ -559,8 +503,6 @@ This method handles the complete shutdown lifecycle > `protected` **drainConnections**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:737](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L737) - Wait for all active connections to drain Resolves when activeConnections is empty @@ -578,8 +520,6 @@ Resolves when activeConnections is empty > `protected` **resetServerState**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L763) - Reset server state for restart capability Call this after stop() completes to allow restart @@ -597,8 +537,6 @@ Call this after stop() completes to allow restart > `protected` **validateLifecycleState**(`operation`, `allowedStates`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:777](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L777) - Validate lifecycle state transition #### Parameters @@ -629,8 +567,6 @@ States that allow the operation > **getStatus**(): [`ServerStatus`](../type-aliases/ServerStatus.md) -Defined in: [server/abstract/baseServerAdapter.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L793) - Get server status #### Returns @@ -647,8 +583,6 @@ Get server status > **listRoutes**(): [`RouteDefinition`](../type-aliases/RouteDefinition.md)[] -Defined in: [server/abstract/baseServerAdapter.ts:809](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L809) - List all registered routes #### Returns @@ -665,8 +599,6 @@ List all registered routes > **getConfig**(): [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:816](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L816) - Get configuration #### Returns @@ -683,8 +615,6 @@ Get configuration > `protected` **initializeFramework**(): `void` -Defined in: [server/adapters/honoAdapter.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L153) - Initialize Hono framework #### Returns @@ -701,8 +631,6 @@ Initialize Hono framework > `protected` **registerFrameworkRoute**(`route`): `void` -Defined in: [server/adapters/honoAdapter.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L257) - Register route with Hono #### Parameters @@ -725,8 +653,6 @@ Register route with Hono > `protected` **registerFrameworkMiddleware**(`middleware`): `void` -Defined in: [server/adapters/honoAdapter.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L522) - Register middleware with Hono #### Parameters @@ -749,8 +675,6 @@ Register middleware with Hono > **start**(): `Promise`\<`void`\> -Defined in: [server/adapters/honoAdapter.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L567) - Start the Hono server #### Returns @@ -767,8 +691,6 @@ Start the Hono server > **stop**(): `Promise`\<`void`\> -Defined in: [server/adapters/honoAdapter.ts:625](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L625) - Stop the Hono server with graceful shutdown #### Returns @@ -785,8 +707,6 @@ Stop the Hono server with graceful shutdown > `protected` **stopAcceptingConnections**(): `Promise`\<`void`\> -Defined in: [server/adapters/honoAdapter.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L666) - Stop accepting new connections #### Returns @@ -803,8 +723,6 @@ Stop accepting new connections > `protected` **closeServer**(): `Promise`\<`void`\> -Defined in: [server/adapters/honoAdapter.ts:674](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L674) - Close the underlying server #### Returns @@ -821,8 +739,6 @@ Close the underlying server > `protected` **forceCloseConnections**(): `Promise`\<`void`\> -Defined in: [server/adapters/honoAdapter.ts:710](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L710) - Force close all active connections #### Returns @@ -839,8 +755,6 @@ Force close all active connections > **getFrameworkInstance**(): `unknown` -Defined in: [server/adapters/honoAdapter.ts:731](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/honoAdapter.ts#L731) - Get the Hono app instance #### Returns diff --git a/docs/api/classes/ImageGenService.md b/docs/api/classes/ImageGenService.md index 01f41e010..81feb6a66 100644 --- a/docs/api/classes/ImageGenService.md +++ b/docs/api/classes/ImageGenService.md @@ -6,8 +6,6 @@ # Class: ImageGenService -Defined in: [image-gen/ImageGenService.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L72) - Image generation service for AI-powered image creation Uses NeuroLink SDK to generate images with support for: @@ -40,8 +38,6 @@ const service = new ImageGenService({ > **new ImageGenService**(`config?`): `ImageGenService` -Defined in: [image-gen/ImageGenService.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L82) - Create a new ImageGenService instance #### Parameters @@ -62,8 +58,6 @@ Optional configuration overrides > **generate**(`options`): `Promise`\<[`ImageGenResult`](../type-aliases/ImageGenResult.md)\> -Defined in: [image-gen/ImageGenService.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L131) - Generate an image from a text prompt #### Parameters @@ -103,8 +97,6 @@ const result = await service.generate({ > **isEnabled**(): `boolean` -Defined in: [image-gen/ImageGenService.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L350) - Check if image generation is enabled #### Returns @@ -117,8 +109,6 @@ Check if image generation is enabled > **getModel**(): `string` -Defined in: [image-gen/ImageGenService.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L357) - Get the default model #### Returns @@ -131,8 +121,6 @@ Get the default model > **getProvider**(): `string` -Defined in: [image-gen/ImageGenService.ts:364](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L364) - Get the default provider #### Returns @@ -145,8 +133,6 @@ Get the default provider > **getConfig**(): `Readonly`\<[`ImageGenConfig`](../type-aliases/ImageGenConfig.md)\> -Defined in: [image-gen/ImageGenService.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L371) - Get the service configuration #### Returns @@ -159,8 +145,6 @@ Get the service configuration > **getInstanceId**(): `string` -Defined in: [image-gen/ImageGenService.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L378) - Get the service instance ID (for debugging) #### Returns @@ -173,8 +157,6 @@ Get the service instance ID (for debugging) > **updateConfig**(`config`): `void` -Defined in: [image-gen/ImageGenService.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L387) - Update service configuration #### Parameters @@ -195,8 +177,6 @@ Partial configuration to merge > **enable**(): `void` -Defined in: [image-gen/ImageGenService.ts:397](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L397) - Enable image generation #### Returns @@ -209,8 +189,6 @@ Enable image generation > **disable**(): `void` -Defined in: [image-gen/ImageGenService.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/image-gen/ImageGenService.ts#L404) - Disable image generation #### Returns diff --git a/docs/api/classes/InMemoryBM25Index.md b/docs/api/classes/InMemoryBM25Index.md index b7d0c635e..e2c7fec14 100644 --- a/docs/api/classes/InMemoryBM25Index.md +++ b/docs/api/classes/InMemoryBM25Index.md @@ -6,8 +6,6 @@ # Class: InMemoryBM25Index -Defined in: [rag/retrieval/hybridSearch.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/hybridSearch.ts#L28) - In-memory BM25 implementation for testing and development ## Implements @@ -30,8 +28,6 @@ In-memory BM25 implementation for testing and development > **search**(`query`, `topK?`): `Promise`\<[`BM25Result`](../type-aliases/BM25Result.md)[]\> -Defined in: [rag/retrieval/hybridSearch.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/hybridSearch.ts#L37) - Search documents using BM25 algorithm #### Parameters @@ -64,8 +60,6 @@ Array of BM25 results > **addDocuments**(`documents`): `Promise`\<`void`\> -Defined in: [rag/retrieval/hybridSearch.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/hybridSearch.ts#L95) - Add documents to the index #### Parameters diff --git a/docs/api/classes/InMemoryCacheStore.md b/docs/api/classes/InMemoryCacheStore.md index 27acae120..eaaa23843 100644 --- a/docs/api/classes/InMemoryCacheStore.md +++ b/docs/api/classes/InMemoryCacheStore.md @@ -6,8 +6,6 @@ # Class: InMemoryCacheStore -Defined in: [server/middleware/cache.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/cache.ts#L25) - In-memory LRU cache store ## Implements @@ -20,8 +18,6 @@ In-memory LRU cache store > **new InMemoryCacheStore**(`maxSize?`): `InMemoryCacheStore` -Defined in: [server/middleware/cache.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/cache.ts#L30) - #### Parameters ##### maxSize? @@ -38,8 +34,6 @@ Defined in: [server/middleware/cache.ts:30](https://github.com/juspay/neurolink/ > **get**(`key`): `Promise`\<[`CacheEntry`](../type-aliases/CacheEntry.md) \| `undefined`\> -Defined in: [server/middleware/cache.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/cache.ts#L34) - #### Parameters ##### key @@ -60,8 +54,6 @@ Defined in: [server/middleware/cache.ts:34](https://github.com/juspay/neurolink/ > **set**(`key`, `entry`): `Promise`\<`void`\> -Defined in: [server/middleware/cache.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/cache.ts#L52) - #### Parameters ##### key @@ -86,8 +78,6 @@ Defined in: [server/middleware/cache.ts:52](https://github.com/juspay/neurolink/ > **delete**(`key`): `Promise`\<`void`\> -Defined in: [server/middleware/cache.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/cache.ts#L66) - #### Parameters ##### key @@ -108,8 +98,6 @@ Defined in: [server/middleware/cache.ts:66](https://github.com/juspay/neurolink/ > **clear**(): `Promise`\<`void`\> -Defined in: [server/middleware/cache.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/cache.ts#L74) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/classes/InMemoryRateLimitStore.md b/docs/api/classes/InMemoryRateLimitStore.md index 20365764d..35afe6cef 100644 --- a/docs/api/classes/InMemoryRateLimitStore.md +++ b/docs/api/classes/InMemoryRateLimitStore.md @@ -6,8 +6,6 @@ # Class: InMemoryRateLimitStore -Defined in: [server/middleware/rateLimit.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L19) - In-memory rate limit store ## Implements @@ -20,8 +18,6 @@ In-memory rate limit store > **new InMemoryRateLimitStore**(): `InMemoryRateLimitStore` -Defined in: [server/middleware/rateLimit.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L23) - #### Returns `InMemoryRateLimitStore` @@ -32,8 +28,6 @@ Defined in: [server/middleware/rateLimit.ts:23](https://github.com/juspay/neurol > **get**(`key`): `Promise`\<[`RateLimitEntry`](../type-aliases/RateLimitEntry.md) \| `undefined`\> -Defined in: [server/middleware/rateLimit.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L28) - #### Parameters ##### key @@ -54,8 +48,6 @@ Defined in: [server/middleware/rateLimit.ts:28](https://github.com/juspay/neurol > **set**(`key`, `entry`): `Promise`\<`void`\> -Defined in: [server/middleware/rateLimit.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L43) - #### Parameters ##### key @@ -80,8 +72,6 @@ Defined in: [server/middleware/rateLimit.ts:43](https://github.com/juspay/neurol > **increment**(`key`, `windowMs`): `Promise`\<[`RateLimitEntry`](../type-aliases/RateLimitEntry.md)\> -Defined in: [server/middleware/rateLimit.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L47) - #### Parameters ##### key @@ -106,8 +96,6 @@ Defined in: [server/middleware/rateLimit.ts:47](https://github.com/juspay/neurol > **reset**(`key`): `Promise`\<`void`\> -Defined in: [server/middleware/rateLimit.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L60) - #### Parameters ##### key @@ -128,8 +116,6 @@ Defined in: [server/middleware/rateLimit.ts:60](https://github.com/juspay/neurol > **destroy**(): `void` -Defined in: [server/middleware/rateLimit.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L73) - #### Returns `void` diff --git a/docs/api/classes/InMemorySessionStorage.md b/docs/api/classes/InMemorySessionStorage.md index c0ee76fc3..9bc150148 100644 --- a/docs/api/classes/InMemorySessionStorage.md +++ b/docs/api/classes/InMemorySessionStorage.md @@ -6,8 +6,6 @@ # Class: InMemorySessionStorage -Defined in: [auth/providers/BaseAuthProvider.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L53) - Default in-memory session storage ## Implements @@ -32,8 +30,6 @@ Default in-memory session storage > **get** **size**(): `number` -Defined in: [auth/providers/BaseAuthProvider.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L154) - Get session count (for testing/monitoring) ##### Returns @@ -46,8 +42,6 @@ Get session count (for testing/monitoring) > **get**(`sessionId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md) \| `null`\> -Defined in: [auth/providers/BaseAuthProvider.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L57) - Get a session by ID #### Parameters @@ -70,8 +64,6 @@ Get a session by ID > **save**(`session`): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L61) - Save a session #### Parameters @@ -94,8 +86,6 @@ Save a session > **delete**(`sessionId`): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L70) - Delete a session #### Parameters @@ -118,8 +108,6 @@ Delete a session > **deleteAllForUser**(`userId`): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L86) - Delete all sessions for a user #### Parameters @@ -142,8 +130,6 @@ Delete all sessions for a user > **getForUser**(`userId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md)[]\> -Defined in: [auth/providers/BaseAuthProvider.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L96) - Get all sessions for a user #### Parameters @@ -166,8 +152,6 @@ Get all sessions for a user > **exists**(`sessionId`): `Promise`\<`boolean`\> -Defined in: [auth/providers/BaseAuthProvider.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L134) - Check if a session exists #### Parameters @@ -190,8 +174,6 @@ Check if a session exists > **touch**(`sessionId`): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L138) - Update session last activity #### Parameters @@ -214,8 +196,6 @@ Update session last activity > **clear**(): `Promise`\<`void`\> -Defined in: [auth/providers/BaseAuthProvider.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/auth/providers/BaseAuthProvider.ts#L146) - Clear all sessions #### Returns diff --git a/docs/api/classes/InMemorySkillStore.md b/docs/api/classes/InMemorySkillStore.md index a357c46a5..43d27b6ac 100644 --- a/docs/api/classes/InMemorySkillStore.md +++ b/docs/api/classes/InMemorySkillStore.md @@ -6,8 +6,6 @@ # Class: InMemorySkillStore -Defined in: [skills/skillStores.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L54) - In-process store backed by a Map. ## Implements @@ -20,8 +18,6 @@ In-process store backed by a Map. > **new InMemorySkillStore**(`seed?`, `resources?`): `InMemorySkillStore` -Defined in: [skills/skillStores.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L59) - #### Parameters ##### seed? @@ -42,8 +38,6 @@ Defined in: [skills/skillStores.ts:59](https://github.com/juspay/neurolink/blob/ > **get**(`id`): `Promise`\<[`SkillDefinition`](../type-aliases/SkillDefinition.md) \| `null`\> -Defined in: [skills/skillStores.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L81) - Fetch one skill (with instructions) by id. Null when absent. #### Parameters @@ -66,8 +60,6 @@ Fetch one skill (with instructions) by id. Null when absent. > **put**(`skill`): `Promise`\<`void`\> -Defined in: [skills/skillStores.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L85) - Create or replace a skill. #### Parameters @@ -90,8 +82,6 @@ Create or replace a skill. > **delete**(`id`): `Promise`\<`void`\> -Defined in: [skills/skillStores.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L89) - Hard-remove a skill from storage. (Soft deletes go through put().) #### Parameters @@ -114,8 +104,6 @@ Hard-remove a skill from storage. (Soft deletes go through put().) > **index**(): `Promise`\<[`SkillIndexItem`](../type-aliases/SkillIndexItem.md)[]\> -Defined in: [skills/skillStores.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L93) - List index entries (no instructions) for all stored skills. #### Returns @@ -132,8 +120,6 @@ List index entries (no instructions) for all stored skills. > **getResource**(`id`, `resourcePath`): `Promise`\<`string` \| `null`\> -Defined in: [skills/skillStores.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L97) - Optional: fetch an auxiliary resource file bundled with a skill. `resourcePath` is relative to the skill (e.g. "references/forms.md"). Null when the skill or resource is absent. Stores without resource diff --git a/docs/api/classes/InMemoryTokenStorage.md b/docs/api/classes/InMemoryTokenStorage.md index 8776a577c..acadc4de6 100644 --- a/docs/api/classes/InMemoryTokenStorage.md +++ b/docs/api/classes/InMemoryTokenStorage.md @@ -6,8 +6,6 @@ # Class: InMemoryTokenStorage -Defined in: [mcp/auth/tokenStorage.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L14) - In-memory token storage implementation Suitable for development and single-session use Tokens are lost when the process terminates @@ -34,8 +32,6 @@ Tokens are lost when the process terminates > **get** **size**(): `number` -Defined in: [mcp/auth/tokenStorage.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L40) - Get the number of stored token sets ##### Returns @@ -48,8 +44,6 @@ Get the number of stored token sets > **getTokens**(`serverId`): `Promise`\<[`OAuthTokens`](../type-aliases/OAuthTokens.md) \| `null`\> -Defined in: [mcp/auth/tokenStorage.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L17) - Get stored tokens for a server #### Parameters @@ -76,8 +70,6 @@ Stored tokens or null if not found > **saveTokens**(`serverId`, `tokens`): `Promise`\<`void`\> -Defined in: [mcp/auth/tokenStorage.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L21) - Save tokens for a server #### Parameters @@ -108,8 +100,6 @@ OAuth tokens to store > **deleteTokens**(`serverId`): `Promise`\<`void`\> -Defined in: [mcp/auth/tokenStorage.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L25) - Delete stored tokens for a server #### Parameters @@ -134,8 +124,6 @@ Unique identifier for the MCP server > **hasTokens**(`serverId`): `Promise`\<`boolean`\> -Defined in: [mcp/auth/tokenStorage.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L29) - Check if tokens exist for a server #### Parameters @@ -162,8 +150,6 @@ True if tokens exist > **clearAll**(): `Promise`\<`void`\> -Defined in: [mcp/auth/tokenStorage.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L33) - Clear all stored tokens #### Returns @@ -180,8 +166,6 @@ Clear all stored tokens > **getServerIds**(): `string`[] -Defined in: [mcp/auth/tokenStorage.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L47) - Get all server IDs with stored tokens #### Returns diff --git a/docs/api/classes/InMemoryVectorStore.md b/docs/api/classes/InMemoryVectorStore.md index bd807b7e9..24b92e18a 100644 --- a/docs/api/classes/InMemoryVectorStore.md +++ b/docs/api/classes/InMemoryVectorStore.md @@ -6,8 +6,6 @@ # Class: InMemoryVectorStore -Defined in: [rag/retrieval/vectorQueryTool.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/vectorQueryTool.ts#L198) - In-memory vector store implementation for testing and development ## Implements @@ -30,8 +28,6 @@ In-memory vector store implementation for testing and development > **upsert**(`indexName`, `items`): `Promise`\<`void`\> -Defined in: [rag/retrieval/vectorQueryTool.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/vectorQueryTool.ts#L207) - Add vectors to an index #### Parameters @@ -54,8 +50,6 @@ Add vectors to an index > **query**(`params`): `Promise`\<[`VectorQueryResult`](../type-aliases/VectorQueryResult.md)[]\> -Defined in: [rag/retrieval/vectorQueryTool.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/vectorQueryTool.ts#L231) - Query vectors by similarity #### Parameters @@ -96,8 +90,6 @@ Query vectors by similarity > **delete**(`indexName`, `ids`): `Promise`\<`void`\> -Defined in: [rag/retrieval/vectorQueryTool.ts:288](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/vectorQueryTool.ts#L288) - Delete vectors from an index #### Parameters diff --git a/docs/api/classes/InvalidAuthenticationError.md b/docs/api/classes/InvalidAuthenticationError.md index e0b019a3d..c1a5ea146 100644 --- a/docs/api/classes/InvalidAuthenticationError.md +++ b/docs/api/classes/InvalidAuthenticationError.md @@ -6,8 +6,6 @@ # Class: InvalidAuthenticationError -Defined in: [server/errors.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L216) - Invalid authentication error ## Extends @@ -20,8 +18,6 @@ Invalid authentication error > **new InvalidAuthenticationError**(`message?`, `requestId?`): `InvalidAuthenticationError` -Defined in: [server/errors.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L217) - #### Parameters ##### message? @@ -46,8 +42,6 @@ Defined in: [server/errors.ts:217](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -58,8 +52,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -70,8 +62,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -82,8 +72,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -94,8 +82,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -106,8 +92,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -118,8 +102,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -130,8 +112,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -142,8 +122,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -154,8 +132,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -166,8 +142,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -184,8 +158,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/InvalidModelError.md b/docs/api/classes/InvalidModelError.md index dfab032ee..ba17eba86 100644 --- a/docs/api/classes/InvalidModelError.md +++ b/docs/api/classes/InvalidModelError.md @@ -6,8 +6,6 @@ # Class: InvalidModelError -Defined in: [types/errors.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L69) - Thrown when a specified model is not found or is invalid for the provider. ## Extends @@ -20,8 +18,6 @@ Thrown when a specified model is not found or is invalid for the provider. > **new InvalidModelError**(`message`, `provider?`): `InvalidModelError` -Defined in: [types/errors.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L70) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [types/errors.ts:70](https://github.com/juspay/neurolink/blob/releas > `optional` **provider?**: `string` -Defined in: [types/errors.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L18) - #### Inherited from [`ProviderError`](ProviderError.md).[`provider`](ProviderError.md#provider) diff --git a/docs/api/classes/JSONLoader.md b/docs/api/classes/JSONLoader.md index ce7b0cf1f..1e73e17f9 100644 --- a/docs/api/classes/JSONLoader.md +++ b/docs/api/classes/JSONLoader.md @@ -6,8 +6,6 @@ # Class: JSONLoader -Defined in: [rag/document/loaders.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L125) - JSON file loader ## Extends @@ -34,8 +32,6 @@ JSON file loader > `protected` **loadContent**(`source`, `encoding?`): `Promise`\<`string`\> -Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L70) - #### Parameters ##### source @@ -60,8 +56,6 @@ Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blo > `protected` **getSourceName**(`source`): `string` -Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L81) - #### Parameters ##### source @@ -82,8 +76,6 @@ Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blo > **load**(`source`, `options?`): `Promise`\<[`MDocument`](MDocument.md)\> -Defined in: [rag/document/loaders.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L126) - Load document from source #### Parameters @@ -116,8 +108,6 @@ Promise resolving to MDocument > **canHandle**(`source`): `boolean` -Defined in: [rag/document/loaders.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L145) - Check if loader can handle the source #### Parameters diff --git a/docs/api/classes/JWTTokenManager.md b/docs/api/classes/JWTTokenManager.md index ba1745b24..16fb02fae 100644 --- a/docs/api/classes/JWTTokenManager.md +++ b/docs/api/classes/JWTTokenManager.md @@ -6,8 +6,6 @@ # Class: JWTTokenManager -Defined in: [client/auth.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L198) - JWT Token Manager with automatic refresh Manages JWT tokens with automatic refresh using a provided refresh function. @@ -35,8 +33,6 @@ const tokenManager = new JWTTokenManager({ > **new JWTTokenManager**(`config`): `JWTTokenManager` -Defined in: [client/auth.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L204) - #### Parameters ##### config @@ -67,8 +63,6 @@ Defined in: [client/auth.ts:204](https://github.com/juspay/neurolink/blob/releas > **getToken**(): `Promise`\<`string`\> -Defined in: [client/auth.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L220) - Get a valid access token #### Returns @@ -81,8 +75,6 @@ Get a valid access token > **forceRefresh**(): `Promise`\<`string`\> -Defined in: [client/auth.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L240) - Force token refresh #### Returns @@ -95,8 +87,6 @@ Force token refresh > **setToken**(`token`, `expiresAt`): `void` -Defined in: [client/auth.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L252) - Update token manually #### Parameters @@ -119,8 +109,6 @@ Update token manually > **isValid**(): `boolean` -Defined in: [client/auth.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L260) - Check if token is valid #### Returns diff --git a/docs/api/classes/KlingVideoHandler.md b/docs/api/classes/KlingVideoHandler.md index 1db79b253..6c75d2359 100644 --- a/docs/api/classes/KlingVideoHandler.md +++ b/docs/api/classes/KlingVideoHandler.md @@ -6,8 +6,6 @@ # Class: KlingVideoHandler -Defined in: [adapters/video/klingVideoHandler.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/klingVideoHandler.ts#L42) - Kling Video Handler. Auth: `Authorization: Bearer ${KLING_API_KEY}` (PiAPI / Kling key). @@ -23,8 +21,6 @@ Models: kling-1.6-i2v (default), kling-1.5-i2v, kling-1.0. > **new KlingVideoHandler**(`apiKey?`): `KlingVideoHandler` -Defined in: [adapters/video/klingVideoHandler.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/klingVideoHandler.ts#L54) - #### Parameters ##### apiKey? @@ -41,8 +37,6 @@ Defined in: [adapters/video/klingVideoHandler.ts:54](https://github.com/juspay/n > `readonly` **maxDurationSeconds**: `10` = `10` -Defined in: [adapters/video/klingVideoHandler.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/klingVideoHandler.ts#L43) - Maximum video duration in seconds supported by this provider. #### Implementation of @@ -55,8 +49,6 @@ Maximum video duration in seconds supported by this provider. > `readonly` **supportedAspectRatios**: readonly (`"9:16"` \| `"16:9"` \| `"1:1"`)[] -Defined in: [adapters/video/klingVideoHandler.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/klingVideoHandler.ts#L44) - Supported aspect ratios. #### Implementation of @@ -69,8 +61,6 @@ Supported aspect ratios. > `readonly` **supportedResolutions**: readonly (`"720p"` \| `"1080p"`)[] -Defined in: [adapters/video/klingVideoHandler.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/klingVideoHandler.ts#L46) - Supported output resolutions. #### Implementation of @@ -83,8 +73,6 @@ Supported output resolutions. > **isConfigured**(): `boolean` -Defined in: [adapters/video/klingVideoHandler.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/klingVideoHandler.ts#L63) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -101,8 +89,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`image`, `prompt`, `options`): `Promise`\<[`VideoGenerationResult`](../type-aliases/VideoGenerationResult.md)\> -Defined in: [adapters/video/klingVideoHandler.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/klingVideoHandler.ts#L67) - Generate a single video clip from an input image and prompt. #### Parameters diff --git a/docs/api/classes/KnowledgeGroundingEngine.md b/docs/api/classes/KnowledgeGroundingEngine.md index 8b4ed4be1..a6f6b69a9 100644 --- a/docs/api/classes/KnowledgeGroundingEngine.md +++ b/docs/api/classes/KnowledgeGroundingEngine.md @@ -6,16 +6,12 @@ # Class: KnowledgeGroundingEngine -Defined in: [knowledge/engine.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/engine.ts#L73) - ## Constructors ### Constructor > **new KnowledgeGroundingEngine**(`config`, `now?`): `KnowledgeGroundingEngine` -Defined in: [knowledge/engine.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/engine.ts#L82) - #### Parameters ##### config @@ -36,8 +32,6 @@ Defined in: [knowledge/engine.ts:82](https://github.com/juspay/neurolink/blob/re > **isEnabled**(): `boolean` -Defined in: [knowledge/engine.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/engine.ts#L96) - #### Returns `boolean` @@ -48,8 +42,6 @@ Defined in: [knowledge/engine.ts:96](https://github.com/juspay/neurolink/blob/re > **ready**(): `Promise`\<`void`\> -Defined in: [knowledge/engine.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/engine.ts#L101) - Resolve once the one-time build settles. Safe to call before every turn. #### Returns @@ -62,8 +54,6 @@ Resolve once the one-time build settles. Safe to call before every turn. > **getStatus**(): [`KnowledgeEngineStatus`](../type-aliases/KnowledgeEngineStatus.md) -Defined in: [knowledge/engine.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/engine.ts#L107) - #### Returns [`KnowledgeEngineStatus`](../type-aliases/KnowledgeEngineStatus.md) @@ -74,8 +64,6 @@ Defined in: [knowledge/engine.ts:107](https://github.com/juspay/neurolink/blob/r > **ground**(`input`): `Promise`\<[`KnowledgeGroundingOutcome`](../type-aliases/KnowledgeGroundingOutcome.md)\> -Defined in: [knowledge/engine.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/engine.ts#L153) - Retrieve + assemble for one turn. Returns the ephemeral context to inject (or null), aggregate metadata, and the full retrieval. Never throws. diff --git a/docs/api/classes/KnowledgeLexicalIndex.md b/docs/api/classes/KnowledgeLexicalIndex.md index adabe313e..63eca5ed1 100644 --- a/docs/api/classes/KnowledgeLexicalIndex.md +++ b/docs/api/classes/KnowledgeLexicalIndex.md @@ -6,8 +6,6 @@ # Class: KnowledgeLexicalIndex -Defined in: [knowledge/knowledgeIndex.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/knowledgeIndex.ts#L41) - Field-aware BM25 over the document set. Query text is scored per field and the weighted per-field scores are summed. Satisfies the structural `KnowledgeLexicalSearcher` type held by a snapshot. @@ -18,8 +16,6 @@ the weighted per-field scores are summed. Satisfies the structural > **new KnowledgeLexicalIndex**(`weights`): `KnowledgeLexicalIndex` -Defined in: [knowledge/knowledgeIndex.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/knowledgeIndex.ts#L59) - #### Parameters ##### weights @@ -36,8 +32,6 @@ Defined in: [knowledge/knowledgeIndex.ts:59](https://github.com/juspay/neurolink > **add**(`document`): `void` -Defined in: [knowledge/knowledgeIndex.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/knowledgeIndex.ts#L68) - #### Parameters ##### document @@ -54,8 +48,6 @@ Defined in: [knowledge/knowledgeIndex.ts:68](https://github.com/juspay/neurolink > **finalize**(): `void` -Defined in: [knowledge/knowledgeIndex.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/knowledgeIndex.ts#L97) - #### Returns `void` @@ -66,8 +58,6 @@ Defined in: [knowledge/knowledgeIndex.ts:97](https://github.com/juspay/neurolink > **search**(`queryTokens`, `topK`, `eligibleEntryIds?`): [`KnowledgeLexicalMatch`](../type-aliases/KnowledgeLexicalMatch.md)[] -Defined in: [knowledge/knowledgeIndex.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/knowledgeIndex.ts#L107) - #### Parameters ##### queryTokens diff --git a/docs/api/classes/KoaServerAdapter.md b/docs/api/classes/KoaServerAdapter.md index fe34454b2..8efeaf65f 100644 --- a/docs/api/classes/KoaServerAdapter.md +++ b/docs/api/classes/KoaServerAdapter.md @@ -6,8 +6,6 @@ # Class: KoaServerAdapter -Defined in: [server/adapters/koaAdapter.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L28) - Koa-specific server adapter Leverages Koa's middleware composition for clean request handling @@ -21,8 +19,6 @@ Leverages Koa's middleware composition for clean request handling > **new KoaServerAdapter**(`neurolink`, `config?`): `KoaServerAdapter` -Defined in: [server/adapters/koaAdapter.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L37) - #### Parameters ##### neurolink @@ -47,8 +43,6 @@ Defined in: [server/adapters/koaAdapter.ts:37](https://github.com/juspay/neuroli > `protected` `readonly` **config**: [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L45) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`config`](BaseServerAdapter.md#config) @@ -59,8 +53,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:45](https://github.com/juspay/ > `protected` `readonly` `optional` **redactionConfig?**: [`RedactionConfig`](../type-aliases/RedactionConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L46) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`redactionConfig`](BaseServerAdapter.md#redactionconfig) @@ -71,8 +63,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:46](https://github.com/juspay/ > `protected` `readonly` **neurolink**: [`NeuroLink`](NeuroLink.md) -Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L47) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`neurolink`](BaseServerAdapter.md#neurolink) @@ -83,8 +73,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:47](https://github.com/juspay/ > `protected` `readonly` **toolRegistry**: [`MCPToolRegistry`](MCPToolRegistry.md) -Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L48) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`toolRegistry`](BaseServerAdapter.md#toolregistry) @@ -95,8 +83,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:48](https://github.com/juspay/ > `protected` `readonly` `optional` **externalServerManager?**: [`ExternalServerManager`](ExternalServerManager.md) -Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L49) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`externalServerManager`](BaseServerAdapter.md#externalservermanager) @@ -107,8 +93,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:49](https://github.com/juspay/ > `protected` **routes**: `Map`\<`string`, [`RouteDefinition`](../type-aliases/RouteDefinition.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L50) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`routes`](BaseServerAdapter.md#routes) @@ -119,8 +103,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:50](https://github.com/juspay/ > `protected` **middlewares**: [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md)[] = `[]` -Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L51) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`middlewares`](BaseServerAdapter.md#middlewares) @@ -131,8 +113,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:51](https://github.com/juspay/ > `protected` **isRunning**: `boolean` = `false` -Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L52) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`isRunning`](BaseServerAdapter.md#isrunning) @@ -143,8 +123,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:52](https://github.com/juspay/ > `protected` `optional` **startTime?**: `Date` -Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L53) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`startTime`](BaseServerAdapter.md#starttime) @@ -155,8 +133,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:53](https://github.com/juspay/ > `protected` **lifecycleState**: [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) = `"uninitialized"` -Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L56) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`lifecycleState`](BaseServerAdapter.md#lifecyclestate) @@ -167,8 +143,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:56](https://github.com/juspay/ > `protected` **activeConnections**: `Map`\<`string`, [`TrackedConnection`](../type-aliases/TrackedConnection.md)\> -Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L57) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`activeConnections`](BaseServerAdapter.md#activeconnections) @@ -179,8 +153,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:57](https://github.com/juspay/ > `protected` `readonly` **shutdownConfig**: [`RequiredShutdownConfig`](../type-aliases/RequiredShutdownConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L58) - #### Inherited from [`BaseServerAdapter`](BaseServerAdapter.md).[`shutdownConfig`](BaseServerAdapter.md#shutdownconfig) @@ -191,8 +163,6 @@ Defined in: [server/abstract/baseServerAdapter.ts:58](https://github.com/juspay/ > `protected` **importFrameworkDependency**\<`T`\>(`pkg`, `framework`): `Promise`\<`T`\> -Defined in: [server/abstract/baseServerAdapter.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L206) - Import an optional framework dependency (express/fastify/koa and their plugins), converting a missing package into a [MissingDependencyError](MissingDependencyError.md) instead of letting the framework's `Cannot find package` propagate raw. @@ -234,8 +204,6 @@ unchanged, matching `tryImport`'s own contract. > **registerRoute**(`route`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L295) - Register a custom route #### Parameters @@ -258,8 +226,6 @@ Register a custom route > **registerRouteGroup**(`group`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L317) - Register multiple routes from a route group #### Parameters @@ -292,8 +258,6 @@ Register multiple routes from a route group > **registerMiddleware**(`middleware`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L363) - Register custom middleware #### Parameters @@ -316,8 +280,6 @@ Register custom middleware > `protected` **createContext**(`options`): [`ServerContext`](../type-aliases/ServerContext.md) -Defined in: [server/abstract/baseServerAdapter.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L376) - Create request context from incoming request #### Parameters @@ -366,8 +328,6 @@ Create request context from incoming request > `protected` **registerBuiltInMiddleware**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L405) - Register built-in middleware #### Returns @@ -384,8 +344,6 @@ Register built-in middleware > `protected` **registerBuiltInRoutes**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L444) - Register built-in routes Only registers health routes if disableBuiltInHealth is false (default) @@ -403,8 +361,6 @@ Only registers health routes if disableBuiltInHealth is false (default) > `protected` **generateRequestId**(): `string` -Defined in: [server/abstract/baseServerAdapter.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L536) - Generate unique request ID #### Returns @@ -421,8 +377,6 @@ Generate unique request ID > **getLifecycleState**(): [`ServerLifecycleState`](../type-aliases/ServerLifecycleState.md) -Defined in: [server/abstract/baseServerAdapter.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L547) - Get the current lifecycle state #### Returns @@ -439,8 +393,6 @@ Get the current lifecycle state > `protected` **trackConnection**(`id`, `socket?`, `requestId?`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L557) - Track a new connection #### Parameters @@ -477,8 +429,6 @@ Optional associated request ID > `protected` **untrackConnection**(`id`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L580) - Untrack a connection (when it's completed) #### Parameters @@ -503,8 +453,6 @@ Connection identifier to remove > **getActiveConnectionCount**(): `number` -Defined in: [server/abstract/baseServerAdapter.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L594) - Get the number of active connections #### Returns @@ -521,8 +469,6 @@ Get the number of active connections > `protected` **gracefulShutdown**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:602](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L602) - Perform graceful shutdown with connection draining This method handles the complete shutdown lifecycle @@ -540,8 +486,6 @@ This method handles the complete shutdown lifecycle > `protected` **drainConnections**(): `Promise`\<`void`\> -Defined in: [server/abstract/baseServerAdapter.ts:737](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L737) - Wait for all active connections to drain Resolves when activeConnections is empty @@ -559,8 +503,6 @@ Resolves when activeConnections is empty > `protected` **resetServerState**(): `void` -Defined in: [server/abstract/baseServerAdapter.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L763) - Reset server state for restart capability Call this after stop() completes to allow restart @@ -578,8 +520,6 @@ Call this after stop() completes to allow restart > `protected` **validateLifecycleState**(`operation`, `allowedStates`): `void` -Defined in: [server/abstract/baseServerAdapter.ts:777](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L777) - Validate lifecycle state transition #### Parameters @@ -610,8 +550,6 @@ States that allow the operation > **getStatus**(): [`ServerStatus`](../type-aliases/ServerStatus.md) -Defined in: [server/abstract/baseServerAdapter.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L793) - Get server status #### Returns @@ -628,8 +566,6 @@ Get server status > **listRoutes**(): [`RouteDefinition`](../type-aliases/RouteDefinition.md)[] -Defined in: [server/abstract/baseServerAdapter.ts:809](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L809) - List all registered routes #### Returns @@ -646,8 +582,6 @@ List all registered routes > **getConfig**(): [`RequiredServerAdapterConfig`](../type-aliases/RequiredServerAdapterConfig.md) -Defined in: [server/abstract/baseServerAdapter.ts:816](https://github.com/juspay/neurolink/blob/release/src/lib/server/abstract/baseServerAdapter.ts#L816) - Get configuration #### Returns @@ -664,8 +598,6 @@ Get configuration > `protected` **initializeFramework**(): `void` -Defined in: [server/adapters/koaAdapter.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L45) - Initialize Koa framework Called by base class but actual initialization happens in initializeFrameworkAsync @@ -683,8 +615,6 @@ Called by base class but actual initialization happens in initializeFrameworkAsy > **initialize**(): `Promise`\<`void`\> -Defined in: [server/adapters/koaAdapter.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L267) - Override initialize to ensure async framework setup #### Returns @@ -701,8 +631,6 @@ Override initialize to ensure async framework setup > `protected` **registerFrameworkRoute**(`route`): `void` -Defined in: [server/adapters/koaAdapter.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L287) - Register route with Koa #### Parameters @@ -725,8 +653,6 @@ Register route with Koa > `protected` **registerFrameworkMiddleware**(`middleware`): `void` -Defined in: [server/adapters/koaAdapter.ts:451](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L451) - Register middleware with Koa #### Parameters @@ -749,8 +675,6 @@ Register middleware with Koa > **start**(): `Promise`\<`void`\> -Defined in: [server/adapters/koaAdapter.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L505) - Start the Koa server #### Returns @@ -767,8 +691,6 @@ Start the Koa server > **stop**(): `Promise`\<`void`\> -Defined in: [server/adapters/koaAdapter.ts:560](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L560) - Stop the Koa server with graceful shutdown #### Returns @@ -785,8 +707,6 @@ Stop the Koa server with graceful shutdown > `protected` **stopAcceptingConnections**(): `Promise`\<`void`\> -Defined in: [server/adapters/koaAdapter.ts:603](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L603) - Stop accepting new connections #### Returns @@ -803,8 +723,6 @@ Stop accepting new connections > `protected` **closeServer**(): `Promise`\<`void`\> -Defined in: [server/adapters/koaAdapter.ts:611](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L611) - Close the underlying server #### Returns @@ -821,8 +739,6 @@ Close the underlying server > `protected` **forceCloseConnections**(): `Promise`\<`void`\> -Defined in: [server/adapters/koaAdapter.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L631) - Force close all active connections #### Returns @@ -839,8 +755,6 @@ Force close all active connections > **getFrameworkInstance**(): `unknown` -Defined in: [server/adapters/koaAdapter.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/server/adapters/koaAdapter.ts#L647) - Get the Koa app instance #### Returns diff --git a/docs/api/classes/LLMMetadataExtractor.md b/docs/api/classes/LLMMetadataExtractor.md index d48606a55..080f68aa5 100644 --- a/docs/api/classes/LLMMetadataExtractor.md +++ b/docs/api/classes/LLMMetadataExtractor.md @@ -6,8 +6,6 @@ # Class: LLMMetadataExtractor -Defined in: [rag/metadata/metadataExtractor.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/rag/metadata/metadataExtractor.ts#L62) - LLM-powered metadata extractor Extracts title, summary, keywords, Q&A pairs, and custom schema data @@ -17,8 +15,6 @@ Extracts title, summary, keywords, Q&A pairs, and custom schema data > **new LLMMetadataExtractor**(`options?`): `LLMMetadataExtractor` -Defined in: [rag/metadata/metadataExtractor.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/rag/metadata/metadataExtractor.ts#L66) - #### Parameters ##### options? @@ -41,8 +37,6 @@ Defined in: [rag/metadata/metadataExtractor.ts:66](https://github.com/juspay/neu > **extract**(`chunks`, `params`): `Promise`\<[`ExtractionResult`](../type-aliases/ExtractionResult.md)[]\> -Defined in: [rag/metadata/metadataExtractor.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/rag/metadata/metadataExtractor.ts#L77) - Extract metadata from chunks based on configuration #### Parameters diff --git a/docs/api/classes/LaTeXChunker.md b/docs/api/classes/LaTeXChunker.md index e9ae6fca9..7274dbf92 100644 --- a/docs/api/classes/LaTeXChunker.md +++ b/docs/api/classes/LaTeXChunker.md @@ -6,8 +6,6 @@ # Class: LaTeXChunker -Defined in: [rag/chunking/latexChunker.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/latexChunker.ts#L21) - LaTeX-aware chunker implementation Splits based on LaTeX structure (sections, environments) @@ -31,8 +29,6 @@ Splits based on LaTeX structure (sections, environments) > `readonly` **strategy**: `"latex"` -Defined in: [rag/chunking/latexChunker.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/latexChunker.ts#L22) - Strategy name for identification #### Implementation of @@ -45,8 +41,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/latexChunker.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/latexChunker.ts#L44) - Split text into chunks #### Parameters @@ -79,8 +73,6 @@ Array of chunks > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/latexChunker.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/latexChunker.ts#L323) - #### Parameters ##### config diff --git a/docs/api/classes/LocalTempArtifactStore.md b/docs/api/classes/LocalTempArtifactStore.md index 07757cade..d68827c48 100644 --- a/docs/api/classes/LocalTempArtifactStore.md +++ b/docs/api/classes/LocalTempArtifactStore.md @@ -6,8 +6,6 @@ # Class: LocalTempArtifactStore -Defined in: [artifacts/artifactStore.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStore.ts#L118) - Filesystem-backed artifact store using the OS temp directory. Files are written with mode 0o600 (owner read/write only). @@ -41,8 +39,6 @@ const full = await store.retrieve(ref.id); > **new LocalTempArtifactStore**(`dir?`, `options?`): `LocalTempArtifactStore` -Defined in: [artifacts/artifactStore.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStore.ts#L132) - #### Parameters ##### dir? @@ -74,8 +70,6 @@ isolation: ids not stored by this process resolve to nothing. > **generatePreview**(`payload`): `string` -Defined in: [artifacts/artifactStore.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStore.ts#L139) - Generate a short preview string from a serialized payload. #### Parameters @@ -98,8 +92,6 @@ Generate a short preview string from a serialized payload. > **store**(`payload`, `meta`): `Promise`\<[`ArtifactRef`](../type-aliases/ArtifactRef.md)\> -Defined in: [artifacts/artifactStore.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStore.ts#L143) - Persist a payload and return a lightweight reference. #### Parameters @@ -130,8 +122,6 @@ Descriptor without `createdAt` (assigned internally). > **retrieve**(`id`): `Promise`\<`string` \| `null`\> -Defined in: [artifacts/artifactStore.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStore.ts#L176) - Retrieve the full payload by artifact ID. Returns `null` if the artifact is not found or has been cleaned up. @@ -155,8 +145,6 @@ Returns `null` if the artifact is not found or has been cleaned up. > **delete**(`id`): `Promise`\<`void`\> -Defined in: [artifacts/artifactStore.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStore.ts#L200) - Delete a single artifact. No-op if the ID does not exist. #### Parameters @@ -179,8 +167,6 @@ Delete a single artifact. No-op if the ID does not exist. > **cleanup**(`olderThanMs`): `Promise`\<`number`\> -Defined in: [artifacts/artifactStore.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStore.ts#L216) - Delete all artifacts older than `olderThanMs` milliseconds. Returns the number of artifacts deleted. diff --git a/docs/api/classes/LyriaMusic.md b/docs/api/classes/LyriaMusic.md index c11b55ae9..947628429 100644 --- a/docs/api/classes/LyriaMusic.md +++ b/docs/api/classes/LyriaMusic.md @@ -6,8 +6,6 @@ # Class: LyriaMusic -Defined in: [music/providers/LyriaMusic.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/LyriaMusic.ts#L34) - Google Lyria 3 Pro Music Handler. Auth: `Authorization: Bearer ${GOOGLE_API_KEY}` or query-string @@ -24,8 +22,6 @@ Generative Language endpoints today). > **new LyriaMusic**(`apiKey?`): `LyriaMusic` -Defined in: [music/providers/LyriaMusic.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/LyriaMusic.ts#L54) - #### Parameters ##### apiKey? @@ -42,8 +38,6 @@ Defined in: [music/providers/LyriaMusic.ts:54](https://github.com/juspay/neuroli > `readonly` **maxDurationSeconds**: `30` = `30` -Defined in: [music/providers/LyriaMusic.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/LyriaMusic.ts#L35) - Maximum supported track duration in seconds (provider-specific). #### Implementation of @@ -56,8 +50,6 @@ Maximum supported track duration in seconds (provider-specific). > `readonly` **supportedFormats**: readonly [`MusicAudioFormat`](../type-aliases/MusicAudioFormat.md)[] -Defined in: [music/providers/LyriaMusic.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/LyriaMusic.ts#L36) - Output formats supported by this handler. #### Implementation of @@ -70,8 +62,6 @@ Output formats supported by this handler. > `readonly` **supportedGenres**: readonly `string`[] -Defined in: [music/providers/LyriaMusic.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/LyriaMusic.ts#L37) - Genres / styles the upstream advertises (informational). #### Implementation of @@ -84,8 +74,6 @@ Genres / styles the upstream advertises (informational). > **isConfigured**(): `boolean` -Defined in: [music/providers/LyriaMusic.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/LyriaMusic.ts#L71) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -102,8 +90,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`options`): `Promise`\<[`MusicResult`](../type-aliases/MusicResult.md)\> -Defined in: [music/providers/LyriaMusic.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/LyriaMusic.ts#L75) - Generate a music track from prompt + options. #### Parameters diff --git a/docs/api/classes/MCPCircuitBreaker.md b/docs/api/classes/MCPCircuitBreaker.md index 3a5cb5773..2450eac5b 100644 --- a/docs/api/classes/MCPCircuitBreaker.md +++ b/docs/api/classes/MCPCircuitBreaker.md @@ -6,8 +6,6 @@ # Class: MCPCircuitBreaker -Defined in: [mcp/mcpCircuitBreaker.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L38) - MCPCircuitBreaker Implements circuit breaker pattern for fault tolerance @@ -21,8 +19,6 @@ Implements circuit breaker pattern for fault tolerance > **new MCPCircuitBreaker**(`name`, `config?`): `MCPCircuitBreaker` -Defined in: [mcp/mcpCircuitBreaker.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L48) - #### Parameters ##### name @@ -47,8 +43,6 @@ Defined in: [mcp/mcpCircuitBreaker.ts:48](https://github.com/juspay/neurolink/bl > **execute**\<`T`\>(`operation`): `Promise`\<`T`\> -Defined in: [mcp/mcpCircuitBreaker.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L91) - Execute an operation with circuit breaker protection. `operation` is handed a `recordResolvedFailure` callback so it can flag a @@ -86,8 +80,6 @@ otherwise. Callers that never call it see no behavior change. > **getStats**(): [`CircuitBreakerStats`](../type-aliases/CircuitBreakerStats.md) -Defined in: [mcp/mcpCircuitBreaker.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L385) - Get current statistics #### Returns @@ -100,8 +92,6 @@ Get current statistics > **reset**(): `void` -Defined in: [mcp/mcpCircuitBreaker.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L414) - Manually reset the circuit breaker #### Returns @@ -114,8 +104,6 @@ Manually reset the circuit breaker > **forceOpen**(`reason?`): `void` -Defined in: [mcp/mcpCircuitBreaker.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L424) - Force open the circuit breaker #### Parameters @@ -134,8 +122,6 @@ Force open the circuit breaker > **getName**(): `string` -Defined in: [mcp/mcpCircuitBreaker.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L432) - Get circuit breaker name #### Returns @@ -148,8 +134,6 @@ Get circuit breaker name > **isOpen**(): `boolean` -Defined in: [mcp/mcpCircuitBreaker.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L439) - Check if circuit is open #### Returns @@ -162,8 +146,6 @@ Check if circuit is open > **isClosed**(): `boolean` -Defined in: [mcp/mcpCircuitBreaker.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L446) - Check if circuit is closed #### Returns @@ -176,8 +158,6 @@ Check if circuit is closed > **isHalfOpen**(): `boolean` -Defined in: [mcp/mcpCircuitBreaker.ts:453](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L453) - Check if circuit is half-open #### Returns @@ -190,8 +170,6 @@ Check if circuit is half-open > **destroy**(): `void` -Defined in: [mcp/mcpCircuitBreaker.ts:462](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpCircuitBreaker.ts#L462) - Destroy the circuit breaker and clean up resources This method should be called when the circuit breaker is no longer needed to prevent memory leaks from the cleanup timer diff --git a/docs/api/classes/MCPClientFactory.md b/docs/api/classes/MCPClientFactory.md index bcbf8c61f..60b40860e 100644 --- a/docs/api/classes/MCPClientFactory.md +++ b/docs/api/classes/MCPClientFactory.md @@ -6,8 +6,6 @@ # Class: MCPClientFactory -Defined in: [mcp/mcpClientFactory.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpClientFactory.ts#L106) - MCPClientFactory Factory class for creating MCP clients with different transports @@ -27,8 +25,6 @@ Factory class for creating MCP clients with different transports > `static` **createClient**(`config`, `timeout?`): `Promise`\<[`MCPClientResult`](../type-aliases/MCPClientResult.md)\> -Defined in: [mcp/mcpClientFactory.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpClientFactory.ts#L123) - Create an MCP client for the given server configuration Enhanced with retry logic, rate limiting, and circuit breaker protection @@ -52,8 +48,6 @@ Enhanced with retry logic, rate limiting, and circuit breaker protection > `static` **getStderrTail**(`transport`): `string`[] -Defined in: [mcp/mcpClientFactory.ts:364](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpClientFactory.ts#L364) - The most recent stderr lines written by the stdio server behind `transport`. Empty for network transports and for servers that have written nothing. Lines are captured from before the process is even @@ -75,8 +69,6 @@ started, so an early boot failure is included. > `static` **closeClient**(`client`, `transport`, `process?`): `Promise`\<`void`\> -Defined in: [mcp/mcpClientFactory.ts:831](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpClientFactory.ts#L831) - Close an MCP client and clean up resources #### Parameters @@ -103,8 +95,6 @@ Close an MCP client and clean up resources > `static` **testConnection**(`config`, `timeout?`): `Promise`\<\{ `success`: `boolean`; `error?`: `string`; `capabilities?`: \{ \}; \}\> -Defined in: [mcp/mcpClientFactory.ts:902](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpClientFactory.ts#L902) - Test connection to an MCP server #### Parameters @@ -127,8 +117,6 @@ Test connection to an MCP server > `static` **validateClientConfig**(`config`): `object` -Defined in: [mcp/mcpClientFactory.ts:964](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpClientFactory.ts#L964) - Validate MCP server configuration for client creation #### Parameters @@ -155,8 +143,6 @@ Validate MCP server configuration for client creation > `static` **getSupportedTransports**(): [`MCPTransportType`](../type-aliases/MCPTransportType.md)[] -Defined in: [mcp/mcpClientFactory.ts:1015](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpClientFactory.ts#L1015) - Get supported transport types #### Returns @@ -169,8 +155,6 @@ Get supported transport types > `static` **getDefaultCapabilities**(): `object` -Defined in: [mcp/mcpClientFactory.ts:1022](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpClientFactory.ts#L1022) - Get default client capabilities #### Returns diff --git a/docs/api/classes/MCPRegistryClient.md b/docs/api/classes/MCPRegistryClient.md index 6bc1657d5..fe5eca866 100644 --- a/docs/api/classes/MCPRegistryClient.md +++ b/docs/api/classes/MCPRegistryClient.md @@ -6,8 +6,6 @@ # Class: MCPRegistryClient -Defined in: [mcp/mcpRegistryClient.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L199) - MCP Registry Client Provides methods to discover and install MCP servers from registries. @@ -37,8 +35,6 @@ const serverInfo = client.toServerInfo(entry); > **new MCPRegistryClient**(`config?`): `MCPRegistryClient` -Defined in: [mcp/mcpRegistryClient.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L204) - #### Parameters ##### config? @@ -59,8 +55,6 @@ Defined in: [mcp/mcpRegistryClient.ts:204](https://github.com/juspay/neurolink/b > **search**(`options?`): `Promise`\<[`RegistrySearchResult`](../type-aliases/RegistrySearchResult.md)\> -Defined in: [mcp/mcpRegistryClient.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L221) - Search the registry #### Parameters @@ -79,8 +73,6 @@ Search the registry > **getEntry**(`id`): `Promise`\<[`McpRegistryEntry`](../type-aliases/McpRegistryEntry.md) \| `undefined`\> -Defined in: [mcp/mcpRegistryClient.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L310) - Get a specific entry by ID #### Parameters @@ -99,8 +91,6 @@ Get a specific entry by ID > **getAllEntries**(): `Promise`\<[`McpRegistryEntry`](../type-aliases/McpRegistryEntry.md)[]\> -Defined in: [mcp/mcpRegistryClient.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L329) - Get all available entries #### Returns @@ -113,8 +103,6 @@ Get all available entries > **getByCategory**(`category`): `Promise`\<[`McpRegistryEntry`](../type-aliases/McpRegistryEntry.md)[]\> -Defined in: [mcp/mcpRegistryClient.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L362) - Get entries by category #### Parameters @@ -133,8 +121,6 @@ Get entries by category > **getByTag**(`tag`): `Promise`\<[`McpRegistryEntry`](../type-aliases/McpRegistryEntry.md)[]\> -Defined in: [mcp/mcpRegistryClient.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L370) - Get entries by tag #### Parameters @@ -153,8 +139,6 @@ Get entries by tag > **getCategories**(): `Promise`\<`string`[]\> -Defined in: [mcp/mcpRegistryClient.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L378) - Get all categories #### Returns @@ -167,8 +151,6 @@ Get all categories > **getTags**(): `Promise`\<`string`[]\> -Defined in: [mcp/mcpRegistryClient.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L394) - Get all tags #### Returns @@ -181,8 +163,6 @@ Get all tags > **toServerInfo**(`entry`): [`MCPServerInfo`](../type-aliases/MCPServerInfo.md) -Defined in: [mcp/mcpRegistryClient.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L410) - Convert registry entry to MCPServerInfo #### Parameters @@ -201,8 +181,6 @@ Convert registry entry to MCPServerInfo > **addCustomEntry**(`entry`): `void` -Defined in: [mcp/mcpRegistryClient.ts:443](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L443) - Add a custom registry entry #### Parameters @@ -221,8 +199,6 @@ Add a custom registry entry > **removeCustomEntry**(`id`): `boolean` -Defined in: [mcp/mcpRegistryClient.ts:452](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L452) - Remove a custom registry entry #### Parameters @@ -241,8 +217,6 @@ Remove a custom registry entry > **addRegistry**(`config`): `void` -Defined in: [mcp/mcpRegistryClient.ts:464](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L464) - Add a registry configuration #### Parameters @@ -261,8 +235,6 @@ Add a registry configuration > **clearCache**(): `void` -Defined in: [mcp/mcpRegistryClient.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L474) - Clear the cache #### Returns @@ -275,8 +247,6 @@ Clear the cache > **checkRequiredEnvVars**(`entry`): `object` -Defined in: [mcp/mcpRegistryClient.ts:482](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L482) - Check if required environment variables are set #### Parameters @@ -303,8 +273,6 @@ Check if required environment variables are set > **getInstallCommand**(`entry`): `string` \| `undefined` -Defined in: [mcp/mcpRegistryClient.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L503) - Get installation command for an entry #### Parameters @@ -323,8 +291,6 @@ Get installation command for an entry > **getPopularServers**(`limit?`): `Promise`\<[`McpRegistryEntry`](../type-aliases/McpRegistryEntry.md)[]\> -Defined in: [mcp/mcpRegistryClient.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L518) - Get popular servers #### Parameters @@ -343,8 +309,6 @@ Get popular servers > **getVerifiedServers**(): `Promise`\<[`McpRegistryEntry`](../type-aliases/McpRegistryEntry.md)[]\> -Defined in: [mcp/mcpRegistryClient.ts:531](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L531) - Get verified servers #### Returns @@ -357,8 +321,6 @@ Get verified servers > **getStatistics**(): `Promise`\<\{ `totalEntries`: `number`; `verifiedEntries`: `number`; `categories`: `number`; `tags`: `number`; `customEntries`: `number`; \}\> -Defined in: [mcp/mcpRegistryClient.ts:542](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L542) - Get statistics #### Returns diff --git a/docs/api/classes/MCPServerBase.md b/docs/api/classes/MCPServerBase.md index 8f1995485..5166e74e3 100644 --- a/docs/api/classes/MCPServerBase.md +++ b/docs/api/classes/MCPServerBase.md @@ -6,8 +6,6 @@ # Abstract Class: MCPServerBase -Defined in: [mcp/mcpServerBase.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L67) - Abstract base class for MCP servers Provides a foundation for creating custom MCP servers with consistent @@ -51,8 +49,6 @@ class MyCustomServer extends MCPServerBase { > **new MCPServerBase**(`config`): `MCPServerBase` -Defined in: [mcp/mcpServerBase.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L73) - #### Parameters ##### config @@ -73,32 +69,24 @@ Defined in: [mcp/mcpServerBase.ts:73](https://github.com/juspay/neurolink/blob/r > `protected` `readonly` **config**: `Required`\<[`MCPServerBaseConfig`](../type-aliases/MCPServerBaseConfig.md)\> -Defined in: [mcp/mcpServerBase.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L68) - --- ### tools > `protected` `readonly` **tools**: `Map`\<`string`, [`MCPServerTool`](../type-aliases/MCPServerTool.md)\> -Defined in: [mcp/mcpServerBase.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L69) - --- ### isInitialized > `protected` **isInitialized**: `boolean` = `false` -Defined in: [mcp/mcpServerBase.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L70) - --- ### isRunning > `protected` **isRunning**: `boolean` = `false` -Defined in: [mcp/mcpServerBase.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L71) - ## Accessors ### id @@ -107,8 +95,6 @@ Defined in: [mcp/mcpServerBase.ts:71](https://github.com/juspay/neurolink/blob/r > **get** **id**(): `string` -Defined in: [mcp/mcpServerBase.ts:451](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L451) - Server identification ##### Returns @@ -123,8 +109,6 @@ Server identification > **get** **name**(): `string` -Defined in: [mcp/mcpServerBase.ts:455](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L455) - ##### Returns `string` @@ -137,8 +121,6 @@ Defined in: [mcp/mcpServerBase.ts:455](https://github.com/juspay/neurolink/blob/ > **get** **description**(): `string` -Defined in: [mcp/mcpServerBase.ts:459](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L459) - ##### Returns `string` @@ -151,8 +133,6 @@ Defined in: [mcp/mcpServerBase.ts:459](https://github.com/juspay/neurolink/blob/ > **get** **version**(): `string` -Defined in: [mcp/mcpServerBase.ts:463](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L463) - ##### Returns `string` @@ -165,8 +145,6 @@ Defined in: [mcp/mcpServerBase.ts:463](https://github.com/juspay/neurolink/blob/ > **get** **category**(): [`MCPServerCategory`](../type-aliases/MCPServerCategory.md) -Defined in: [mcp/mcpServerBase.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L467) - ##### Returns [`MCPServerCategory`](../type-aliases/MCPServerCategory.md) @@ -179,8 +157,6 @@ Defined in: [mcp/mcpServerBase.ts:467](https://github.com/juspay/neurolink/blob/ > **get** **initialized**(): `boolean` -Defined in: [mcp/mcpServerBase.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L474) - Check if server is initialized ##### Returns @@ -195,8 +171,6 @@ Check if server is initialized > **get** **running**(): `boolean` -Defined in: [mcp/mcpServerBase.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L481) - Check if server is running ##### Returns @@ -209,8 +183,6 @@ Check if server is running > **init**(): `Promise`\<`void`\> -Defined in: [mcp/mcpServerBase.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L94) - Initialize the server Override in subclasses for async initialization @@ -224,8 +196,6 @@ Override in subclasses for async initialization > `protected` **onInit**(): `Promise`\<`void`\> -Defined in: [mcp/mcpServerBase.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L111) - Hook for subclass initialization Override to perform async setup @@ -239,8 +209,6 @@ Override to perform async setup > **start**(): `Promise`\<`void`\> -Defined in: [mcp/mcpServerBase.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L118) - Start the server #### Returns @@ -253,8 +221,6 @@ Start the server > `protected` **onStart**(): `Promise`\<`void`\> -Defined in: [mcp/mcpServerBase.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L134) - Hook for subclass start logic #### Returns @@ -267,8 +233,6 @@ Hook for subclass start logic > **stop**(`reason?`): `Promise`\<`void`\> -Defined in: [mcp/mcpServerBase.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L141) - Stop the server #### Parameters @@ -287,8 +251,6 @@ Stop the server > `protected` **onStop**(): `Promise`\<`void`\> -Defined in: [mcp/mcpServerBase.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L155) - Hook for subclass stop logic #### Returns @@ -301,8 +263,6 @@ Hook for subclass stop logic > **registerTool**(`tool`): `this` -Defined in: [mcp/mcpServerBase.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L162) - Register a tool with the server #### Parameters @@ -321,8 +281,6 @@ Register a tool with the server > **registerTools**(`tools`): `this` -Defined in: [mcp/mcpServerBase.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L188) - Register multiple tools at once #### Parameters @@ -341,8 +299,6 @@ Register multiple tools at once > `protected` **validateTool**(`tool`): `void` -Defined in: [mcp/mcpServerBase.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L198) - Validate tool configuration #### Parameters @@ -361,8 +317,6 @@ Validate tool configuration > **executeTool**(`toolName`, `params`, `context?`): `Promise`\<[`ToolResult`](../type-aliases/ToolResult.md)\> -Defined in: [mcp/mcpServerBase.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L250) - Execute a tool by name #### Parameters @@ -389,8 +343,6 @@ Execute a tool by name > **getTools**(): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/mcpServerBase.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L348) - Get all registered tools #### Returns @@ -403,8 +355,6 @@ Get all registered tools > **getTool**(`name`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) \| `undefined` -Defined in: [mcp/mcpServerBase.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L355) - Get a specific tool by name #### Parameters @@ -423,8 +373,6 @@ Get a specific tool by name > **hasTool**(`name`): `boolean` -Defined in: [mcp/mcpServerBase.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L362) - Check if a tool exists #### Parameters @@ -443,8 +391,6 @@ Check if a tool exists > **removeTool**(`name`): `boolean` -Defined in: [mcp/mcpServerBase.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L369) - Remove a tool #### Parameters @@ -463,8 +409,6 @@ Remove a tool > **toServerInfo**(): [`MCPServerInfo`](../type-aliases/MCPServerInfo.md) -Defined in: [mcp/mcpServerBase.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L376) - Get server info in MCPServerInfo format #### Returns @@ -477,8 +421,6 @@ Get server info in MCPServerInfo format > **getToolsByAnnotation**(`annotation`, `value`): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/mcpServerBase.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L405) - Get tools filtered by annotations #### Parameters @@ -501,8 +443,6 @@ keyof [`MCPToolAnnotations`](../type-aliases/MCPToolAnnotations.md) > **getReadOnlyTools**(): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/mcpServerBase.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L423) - Get read-only tools #### Returns @@ -515,8 +455,6 @@ Get read-only tools > **getDestructiveTools**(): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/mcpServerBase.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L430) - Get destructive tools #### Returns @@ -529,8 +467,6 @@ Get destructive tools > **getIdempotentTools**(): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/mcpServerBase.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L437) - Get idempotent tools #### Returns @@ -543,8 +479,6 @@ Get idempotent tools > **getToolsRequiringConfirmation**(): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/mcpServerBase.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpServerBase.ts#L444) - Get tools that require confirmation #### Returns diff --git a/docs/api/classes/MCPToolRegistry.md b/docs/api/classes/MCPToolRegistry.md index 903b7d54a..eb942d0ce 100644 --- a/docs/api/classes/MCPToolRegistry.md +++ b/docs/api/classes/MCPToolRegistry.md @@ -6,8 +6,6 @@ # Class: MCPToolRegistry -Defined in: [mcp/toolRegistry.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L40) - MCP (Model Context Protocol) Plugin Ecosystem Extensible plugin architecture based on research blueprint for @@ -39,8 +37,6 @@ await writeFile("output.txt", "Hello from MCP!"); > **new MCPToolRegistry**(): `MCPToolRegistry` -Defined in: [mcp/toolRegistry.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L54) - #### Returns `MCPToolRegistry` @@ -55,8 +51,6 @@ Defined in: [mcp/toolRegistry.ts:54](https://github.com/juspay/neurolink/blob/re > **plugins**: `Map`\<`string`, [`DiscoveredMcp`](../type-aliases/DiscoveredMcp.md)\> -Defined in: [mcp/registry.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L20) - #### Inherited from `MCPRegistry.plugins` @@ -67,8 +61,6 @@ Defined in: [mcp/registry.ts:20](https://github.com/juspay/neurolink/blob/releas > **register**(`plugin`): `void` -Defined in: [mcp/registry.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L25) - Register a plugin #### Parameters @@ -91,8 +83,6 @@ Register a plugin > **unregister**(`name`): `boolean` -Defined in: [mcp/registry.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L33) - Unregister a plugin #### Parameters @@ -115,8 +105,6 @@ Unregister a plugin > **get**(`name`): [`DiscoveredMcp`](../type-aliases/DiscoveredMcp.md) \| `undefined` -Defined in: [mcp/registry.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L44) - Get a plugin #### Parameters @@ -139,8 +127,6 @@ Get a plugin > **list**(): [`DiscoveredMcp`](../type-aliases/DiscoveredMcp.md)[] -Defined in: [mcp/registry.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L51) - List all plugins #### Returns @@ -157,8 +143,6 @@ List all plugins > **has**(`name`): `boolean` -Defined in: [mcp/registry.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L58) - Check if plugin exists #### Parameters @@ -181,8 +165,6 @@ Check if plugin exists > **clear**(): `void` -Defined in: [mcp/registry.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L65) - Clear all plugins #### Returns @@ -199,8 +181,6 @@ Clear all plugins > **registerServerSync**(`plugin`): `void` -Defined in: [mcp/registry.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L130) - Register a server (legacy sync version) #### Parameters @@ -223,8 +203,6 @@ Register a server (legacy sync version) > **executeToolSync**(`toolName`, `args?`): [`UnknownRecord`](../type-aliases/UnknownRecord.md) -Defined in: [mcp/registry.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L137) - Execute a tool (legacy sync version) #### Parameters @@ -251,8 +229,6 @@ Execute a tool (legacy sync version) > **listToolsSync**(): `object`[] -Defined in: [mcp/registry.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L145) - List all tools (legacy sync version) #### Returns @@ -269,8 +245,6 @@ List all tools (legacy sync version) > **listServers**(): `string`[] -Defined in: [mcp/registry.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/registry.ts#L174) - List all registered server IDs Returns an array of server IDs that are currently registered in the MCP registry. @@ -309,8 +283,6 @@ const tools = await registry.listTools(); // [{ name: 'tool1', serverId: 'server > **setHITLManager**(`hitlManager?`): `void` -Defined in: [mcp/toolRegistry.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L65) - Set HITL manager for human-in-the-loop safety mechanisms #### Parameters @@ -331,8 +303,6 @@ HITL manager instance (optional, can be undefined to disable) > **getHITLManager**(): `HITLManager` \| `undefined` -Defined in: [mcp/toolRegistry.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L77) - Get current HITL manager #### Returns @@ -345,8 +315,6 @@ Get current HITL manager > **setFileToolRootResolver**(`resolver`): `void` -Defined in: [mcp/toolRegistry.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L85) - Resolve file-tool roots for built-in tools executed on this registry without a per-call policy. Set by the NeuroLink instance that created it. @@ -368,8 +336,6 @@ without a per-call policy. Set by the NeuroLink instance that created it. > **registerServer**(`serverInfo`, `context?`): `Promise`\<`void`\> -Defined in: [mcp/toolRegistry.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L193) - Register a server with its tools - ONLY accepts MCPServerInfo (zero conversions) ##### Parameters @@ -394,8 +360,6 @@ Register a server with its tools - ONLY accepts MCPServerInfo (zero conversions) > **registerServer**(`serverId`, `serverConfig?`, `context?`): `Promise`\<`void`\> -Defined in: [mcp/toolRegistry.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L197) - Register a server with its tools - ONLY accepts MCPServerInfo (zero conversions) ##### Parameters @@ -426,8 +390,6 @@ Register a server with its tools - ONLY accepts MCPServerInfo (zero conversions) > **executeTool**\<`T`\>(`toolName`, `args?`, `context?`): `Promise`\<`T`\> -Defined in: [mcp/toolRegistry.ts:366](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L366) - Execute a tool with enhanced context and automatic result wrapping This method handles both raw return values and ToolResult objects: @@ -500,8 +462,6 @@ const result = await toolRegistry.executeTool("complexTool", { input: "test" }); > **listTools**(): `Promise`\<[`ToolInfo`](../type-aliases/ToolInfo.md)[]\> -Defined in: [mcp/toolRegistry.ts:656](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L656) - List all available tools (updated signature with filtering) ##### Returns @@ -516,8 +476,6 @@ List all available tools (updated signature with filtering) > **listTools**(`context`): `Promise`\<[`ToolInfo`](../type-aliases/ToolInfo.md)[]\> -Defined in: [mcp/toolRegistry.ts:657](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L657) - List all available tools (updated signature with filtering) ##### Parameters @@ -538,8 +496,6 @@ List all available tools (updated signature with filtering) > **listTools**(`filter`): `Promise`\<[`ToolInfo`](../type-aliases/ToolInfo.md)[]\> -Defined in: [mcp/toolRegistry.ts:658](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L658) - List all available tools (updated signature with filtering) ##### Parameters @@ -580,8 +536,6 @@ List all available tools (updated signature with filtering) > **getToolInfo**(`toolName`): \{ `tool`: [`ToolInfo`](../type-aliases/ToolInfo.md); `server`: \{ `id`: `string`; \}; \} \| `undefined` -Defined in: [mcp/toolRegistry.ts:795](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L795) - Get tool information with server details #### Parameters @@ -600,8 +554,6 @@ Get tool information with server details > **getExecutionStats**(): `Record`\<`string`, \{ `count`: `number`; `averageTime`: `number`; `totalTime`: `number`; \}\> -Defined in: [mcp/toolRegistry.ts:840](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L840) - Get execution statistics #### Returns @@ -614,8 +566,6 @@ Get execution statistics > **clearStats**(): `void` -Defined in: [mcp/toolRegistry.ts:863](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L863) - Clear execution statistics #### Returns @@ -628,8 +578,6 @@ Clear execution statistics > **getBuiltInServerInfos**(): [`MCPServerInfo`](../type-aliases/MCPServerInfo.md)[] -Defined in: [mcp/toolRegistry.ts:871](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L871) - Get built-in servers #### Returns @@ -644,8 +592,6 @@ Array of MCPServerInfo for built-in tools > **getToolsByCategory**(`category`): [`ToolInfo`](../type-aliases/ToolInfo.md)[] -Defined in: [mcp/toolRegistry.ts:878](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L878) - Get tools by category #### Parameters @@ -664,8 +610,6 @@ Get tools by category > **getAvailableTools**(`circuitBreakers`): `object` -Defined in: [mcp/toolRegistry.ts:893](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L893) - NL-001: Get available tools, filtering out those with OPEN circuit breakers. Returns both the filtered tools and the list of unavailable tool names. @@ -693,8 +637,6 @@ Returns both the filtered tools and the list of unavailable tool names. > **hasTool**(`toolName`): `boolean` -Defined in: [mcp/toolRegistry.ts:919](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L919) - Check if tool exists #### Parameters @@ -713,8 +655,6 @@ Check if tool exists > **registerTool**(`toolId`, `toolInfo`, `toolImpl`): `Promise`\<`void`\> -Defined in: [mcp/toolRegistry.ts:936](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L936) - Register a tool with implementation directly This is used for external MCP server tools @@ -742,8 +682,6 @@ This is used for external MCP server tools > **removeTool**(`toolName`): `boolean` -Defined in: [mcp/toolRegistry.ts:978](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L978) - Remove a tool #### Parameters @@ -762,8 +700,6 @@ Remove a tool > **getToolCount**(): `number` -Defined in: [mcp/toolRegistry.ts:1005](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L1005) - Get tool count #### Returns @@ -776,8 +712,6 @@ Get tool count > **getStats**(): `object` -Defined in: [mcp/toolRegistry.ts:1012](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L1012) - Get comprehensive statistics #### Returns @@ -810,8 +744,6 @@ Get comprehensive statistics > **unregisterServer**(`serverId`): `boolean` -Defined in: [mcp/toolRegistry.ts:1052](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolRegistry.ts#L1052) - Unregister a server #### Parameters diff --git a/docs/api/classes/MDocument.md b/docs/api/classes/MDocument.md index d6e279b9f..65edffa9d 100644 --- a/docs/api/classes/MDocument.md +++ b/docs/api/classes/MDocument.md @@ -6,8 +6,6 @@ # Class: MDocument -Defined in: [rag/document/MDocument.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L47) - MDocument class for comprehensive document processing Provides a chainable API for: @@ -23,8 +21,6 @@ Provides a chainable API for: > **new MDocument**(`content`, `config?`): `MDocument` -Defined in: [rag/document/MDocument.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L56) - Create a new MDocument instance #### Parameters @@ -51,8 +47,6 @@ Document configuration > `static` **fromText**(`text`, `metadata?`): `MDocument` -Defined in: [rag/document/MDocument.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L82) - Create MDocument from plain text #### Parameters @@ -81,8 +75,6 @@ MDocument instance > `static` **fromMarkdown**(`markdown`, `metadata?`): `MDocument` -Defined in: [rag/document/MDocument.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L92) - Create MDocument from markdown content #### Parameters @@ -111,8 +103,6 @@ MDocument instance > `static` **fromHTML**(`html`, `metadata?`): `MDocument` -Defined in: [rag/document/MDocument.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L105) - Create MDocument from HTML content #### Parameters @@ -141,8 +131,6 @@ MDocument instance > `static` **fromJSONContent**(`json`, `metadata?`): `MDocument` -Defined in: [rag/document/MDocument.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L115) - Create MDocument from JSON content #### Parameters @@ -171,8 +159,6 @@ MDocument instance > `static` **fromLaTeX**(`latex`, `metadata?`): `MDocument` -Defined in: [rag/document/MDocument.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L130) - Create MDocument from LaTeX content #### Parameters @@ -201,8 +187,6 @@ MDocument instance > `static` **fromCSV**(`csv`, `metadata?`): `MDocument` -Defined in: [rag/document/MDocument.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L143) - Create MDocument from CSV content #### Parameters @@ -231,8 +215,6 @@ MDocument instance > **chunk**(`params?`): `Promise`\<`MDocument`\> -Defined in: [rag/document/MDocument.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L156) - Chunk the document using specified strategy #### Parameters @@ -255,8 +237,6 @@ This MDocument instance (for chaining) > **extractMetadata**(`params`, `options?`): `Promise`\<`MDocument`\> -Defined in: [rag/document/MDocument.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L195) - Extract metadata from chunks using LLM #### Parameters @@ -291,8 +271,6 @@ This MDocument instance (for chaining) > **embed**(`provider?`, `modelName?`, `imageData?`, `mimeType?`): `Promise`\<`MDocument`\> -Defined in: [rag/document/MDocument.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L256) - Generate embeddings for all chunks #### Parameters @@ -336,8 +314,6 @@ This MDocument instance (for chaining) > **embedMultiModal**(`provider?`, `modelName?`, `imageData?`, `mimeType?`): `Promise`\<`MDocument`\> -Defined in: [rag/document/MDocument.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L327) - Generate multi-modal embeddings for all chunks using text + optional image data. Uses a provider that supports multi-modal embeddings (e.g. Bedrock Titan Image). @@ -381,8 +357,6 @@ This MDocument instance (for chaining) > **getId**(): `string` -Defined in: [rag/document/MDocument.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L343) - Get document ID #### Returns @@ -395,8 +369,6 @@ Get document ID > **getContent**(): `string` -Defined in: [rag/document/MDocument.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L350) - Get raw document content #### Returns @@ -409,8 +381,6 @@ Get raw document content > **getType**(): [`DocumentType`](../type-aliases/DocumentType.md) -Defined in: [rag/document/MDocument.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L357) - Get document type #### Returns @@ -423,8 +393,6 @@ Get document type > **getMetadata**(): `Record`\<`string`, `unknown`\> -Defined in: [rag/document/MDocument.ts:364](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L364) - Get document metadata #### Returns @@ -437,8 +405,6 @@ Get document metadata > **getChunks**(): [`Chunk`](../type-aliases/Chunk.md)[] -Defined in: [rag/document/MDocument.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L371) - Get processed chunks #### Returns @@ -451,8 +417,6 @@ Get processed chunks > **getEmbeddings**(): `number`[][] -Defined in: [rag/document/MDocument.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L378) - Get chunk embeddings #### Returns @@ -465,8 +429,6 @@ Get chunk embeddings > **getHistory**(): `string`[] -Defined in: [rag/document/MDocument.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L385) - Get processing history #### Returns @@ -479,8 +441,6 @@ Get processing history > **isChunked**(): `boolean` -Defined in: [rag/document/MDocument.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L392) - Check if document has been chunked #### Returns @@ -493,8 +453,6 @@ Check if document has been chunked > **hasEmbeddings**(): `boolean` -Defined in: [rag/document/MDocument.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L399) - Check if document has embeddings #### Returns @@ -507,8 +465,6 @@ Check if document has embeddings > **getChunkCount**(): `number` -Defined in: [rag/document/MDocument.ts:406](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L406) - Get chunk count #### Returns @@ -521,8 +477,6 @@ Get chunk count > **setMetadata**(`key`, `value`): `MDocument` -Defined in: [rag/document/MDocument.ts:420](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L420) - Set document metadata #### Parameters @@ -551,8 +505,6 @@ This MDocument instance (for chaining) > **mergeMetadata**(`metadata`): `MDocument` -Defined in: [rag/document/MDocument.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L430) - Merge metadata into document #### Parameters @@ -575,8 +527,6 @@ This MDocument instance (for chaining) > **filterChunks**(`predicate`): `MDocument` -Defined in: [rag/document/MDocument.ts:440](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L440) - Filter chunks based on predicate #### Parameters @@ -599,8 +549,6 @@ New MDocument with filtered chunks > **mapChunks**(`transform`): `MDocument` -Defined in: [rag/document/MDocument.ts:458](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L458) - Map transformation over chunks #### Parameters @@ -623,8 +571,6 @@ New MDocument with transformed chunks > **toJSON**(): `object` -Defined in: [rag/document/MDocument.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L476) - Convert to plain object for serialization #### Returns @@ -661,8 +607,6 @@ Convert to plain object for serialization > `static` **fromJSON**(`json`): `MDocument` -Defined in: [rag/document/MDocument.ts:499](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/MDocument.ts#L499) - Create MDocument from serialized JSON #### Parameters diff --git a/docs/api/classes/MarkdownChunker.md b/docs/api/classes/MarkdownChunker.md index 2e83f8616..c07816086 100644 --- a/docs/api/classes/MarkdownChunker.md +++ b/docs/api/classes/MarkdownChunker.md @@ -6,8 +6,6 @@ # Class: MarkdownChunker -Defined in: [rag/chunking/markdownChunker.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/markdownChunker.ts#L21) - Markdown-aware chunker implementation Splits based on markdown structure (headers, code blocks, etc.) @@ -31,8 +29,6 @@ Splits based on markdown structure (headers, code blocks, etc.) > `readonly` **strategy**: `"markdown"` -Defined in: [rag/chunking/markdownChunker.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/markdownChunker.ts#L22) - Strategy name for identification #### Implementation of @@ -45,8 +41,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/markdownChunker.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/markdownChunker.ts#L24) - Split text into chunks #### Parameters @@ -79,8 +73,6 @@ Array of chunks > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/markdownChunker.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/markdownChunker.ts#L466) - #### Parameters ##### config diff --git a/docs/api/classes/MarkdownLoader.md b/docs/api/classes/MarkdownLoader.md index 88014b317..7998c6b5a 100644 --- a/docs/api/classes/MarkdownLoader.md +++ b/docs/api/classes/MarkdownLoader.md @@ -6,8 +6,6 @@ # Class: MarkdownLoader -Defined in: [rag/document/loaders.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L89) - Markdown file loader ## Extends @@ -34,8 +32,6 @@ Markdown file loader > `protected` **loadContent**(`source`, `encoding?`): `Promise`\<`string`\> -Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L70) - #### Parameters ##### source @@ -60,8 +56,6 @@ Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blo > `protected` **getSourceName**(`source`): `string` -Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L81) - #### Parameters ##### source @@ -82,8 +76,6 @@ Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blo > **load**(`source`, `options?`): `Promise`\<[`MDocument`](MDocument.md)\> -Defined in: [rag/document/loaders.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L90) - Load document from source #### Parameters @@ -116,8 +108,6 @@ Promise resolving to MDocument > **canHandle**(`source`): `boolean` -Defined in: [rag/document/loaders.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L98) - Check if loader can handle the source #### Parameters diff --git a/docs/api/classes/MemoryRateLimitStorage.md b/docs/api/classes/MemoryRateLimitStorage.md index 3e3562dcd..02f6e0521 100644 --- a/docs/api/classes/MemoryRateLimitStorage.md +++ b/docs/api/classes/MemoryRateLimitStorage.md @@ -6,8 +6,6 @@ # Class: MemoryRateLimitStorage -Defined in: [auth/middleware/rateLimitByUser.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L25) - In-memory storage for rate limiting (single instance deployments) ## Implements @@ -20,8 +18,6 @@ In-memory storage for rate limiting (single instance deployments) > **new MemoryRateLimitStorage**(`cleanupIntervalMs?`, `expiryMs?`): `MemoryRateLimitStorage` -Defined in: [auth/middleware/rateLimitByUser.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L30) - #### Parameters ##### cleanupIntervalMs? @@ -42,8 +38,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:30](https://github.com/juspay/ne > **getBucket**(`userId`): `Promise`\<[`TokenBucket`](../type-aliases/TokenBucket.md) \| `null`\> -Defined in: [auth/middleware/rateLimitByUser.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L40) - #### Parameters ##### userId @@ -64,8 +58,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:40](https://github.com/juspay/ne > **setBucket**(`userId`, `bucket`): `Promise`\<`void`\> -Defined in: [auth/middleware/rateLimitByUser.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L44) - #### Parameters ##### userId @@ -90,8 +82,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:44](https://github.com/juspay/ne > **deleteBucket**(`userId`): `Promise`\<`void`\> -Defined in: [auth/middleware/rateLimitByUser.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L48) - #### Parameters ##### userId @@ -112,8 +102,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:48](https://github.com/juspay/ne > **healthCheck**(): `Promise`\<`boolean`\> -Defined in: [auth/middleware/rateLimitByUser.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L52) - #### Returns `Promise`\<`boolean`\> @@ -128,8 +116,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:52](https://github.com/juspay/ne > **cleanup**(): `Promise`\<`void`\> -Defined in: [auth/middleware/rateLimitByUser.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L56) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/classes/MemorySessionStorage.md b/docs/api/classes/MemorySessionStorage.md index bc9523072..50ff0f1fa 100644 --- a/docs/api/classes/MemorySessionStorage.md +++ b/docs/api/classes/MemorySessionStorage.md @@ -6,8 +6,6 @@ # Class: MemorySessionStorage -Defined in: [auth/sessionManager.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L31) - In-memory session storage Simple session storage using Map. Suitable for single-instance deployments @@ -33,8 +31,6 @@ or development. Sessions are lost on restart. > **get**(`sessionId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md) \| `null`\> -Defined in: [auth/sessionManager.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L35) - Get a session by ID #### Parameters @@ -57,8 +53,6 @@ Get a session by ID > **set**(`session`): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L51) - Store a session #### Parameters @@ -81,8 +75,6 @@ Store a session > **delete**(`sessionId`): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L63) - Delete a session #### Parameters @@ -105,8 +97,6 @@ Delete a session > **getUserSessions**(`userId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md)[]\> -Defined in: [auth/sessionManager.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L78) - Get all sessions for a user #### Parameters @@ -129,8 +119,6 @@ Get all sessions for a user > **deleteUserSessions**(`userId`): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L96) - Delete all sessions for a user #### Parameters @@ -153,8 +141,6 @@ Delete all sessions for a user > **clear**(): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L107) - Clear all sessions (for cleanup) #### Returns @@ -171,8 +157,6 @@ Clear all sessions (for cleanup) > **isHealthy**(): `Promise`\<`boolean`\> -Defined in: [auth/sessionManager.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L112) - Health check #### Returns diff --git a/docs/api/classes/MessageBus.md b/docs/api/classes/MessageBus.md index 3230d0ee4..54d997143 100644 --- a/docs/api/classes/MessageBus.md +++ b/docs/api/classes/MessageBus.md @@ -6,8 +6,6 @@ # Class: MessageBus -Defined in: [agent/communication/message-bus.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L26) - Message Bus - Central hub for agent communication ## Constructors @@ -16,8 +14,6 @@ Message Bus - Central hub for agent communication > **new MessageBus**(`config?`): `MessageBus` -Defined in: [agent/communication/message-bus.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L41) - #### Parameters ##### config? @@ -34,8 +30,6 @@ Defined in: [agent/communication/message-bus.ts:41](https://github.com/juspay/ne > **subscribe**(`topic`, `subscriberId`, `handler`, `options?`): `string` -Defined in: [agent/communication/message-bus.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L64) - Subscribe to a topic #### Parameters @@ -66,8 +60,6 @@ Subscribe to a topic > **unsubscribe**(`subscriptionId`): `boolean` -Defined in: [agent/communication/message-bus.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L101) - Unsubscribe from a topic #### Parameters @@ -86,8 +78,6 @@ Unsubscribe from a topic > **unsubscribeAll**(`subscriberId`): `number` -Defined in: [agent/communication/message-bus.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L122) - Unsubscribe all subscriptions for an agent #### Parameters @@ -106,8 +96,6 @@ Unsubscribe all subscriptions for an agent > **publish**(`topic`, `senderId`, `payload`, `options?`): `Promise`\<`void`\> -Defined in: [agent/communication/message-bus.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L139) - Publish a message to a topic #### Parameters @@ -138,8 +126,6 @@ Publish a message to a topic > **sendDirect**(`senderId`, `recipientId`, `payload`, `options?`): `Promise`\<`void`\> -Defined in: [agent/communication/message-bus.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L168) - Send a direct message to a specific agent #### Parameters @@ -170,8 +156,6 @@ Send a direct message to a specific agent > **request**(`topic`, `senderId`, `payload`, `timeout?`): `Promise`\<[`AgentMessage`](../type-aliases/AgentMessage.md)\> -Defined in: [agent/communication/message-bus.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L199) - Send a request and wait for response #### Parameters @@ -202,8 +186,6 @@ Send a request and wait for response > **reply**(`originalMessage`, `senderId`, `payload`): `Promise`\<`void`\> -Defined in: [agent/communication/message-bus.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L248) - Reply to a request #### Parameters @@ -230,8 +212,6 @@ Reply to a request > **broadcast**(`senderId`, `payload`, `excludeTopics?`): `Promise`\<`void`\> -Defined in: [agent/communication/message-bus.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L266) - Broadcast a message to all subscribers #### Parameters @@ -258,8 +238,6 @@ Broadcast a message to all subscribers > **getHistory**(`topic?`, `limit?`): [`AgentMessage`](../type-aliases/AgentMessage.md)[] -Defined in: [agent/communication/message-bus.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L415) - Get message history for a topic #### Parameters @@ -282,8 +260,6 @@ Get message history for a topic > **getDeadLetterQueue**(): [`AgentMessage`](../type-aliases/AgentMessage.md)[] -Defined in: [agent/communication/message-bus.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L430) - Get dead letter queue messages #### Returns @@ -296,8 +272,6 @@ Get dead letter queue messages > **clearDeadLetterQueue**(): `void` -Defined in: [agent/communication/message-bus.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L437) - Clear dead letter queue #### Returns @@ -310,8 +284,6 @@ Clear dead letter queue > **replayHistory**(`topic`, `subscriberId`, `since?`): `Promise`\<`void`\> -Defined in: [agent/communication/message-bus.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L444) - Replay messages from history #### Parameters @@ -338,8 +310,6 @@ Replay messages from history > **getTopics**(): `string`[] -Defined in: [agent/communication/message-bus.ts:472](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L472) - Get all topics #### Returns @@ -352,8 +322,6 @@ Get all topics > **getSubscriberCount**(`topic`): `number` -Defined in: [agent/communication/message-bus.ts:479](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L479) - Get subscriber count for a topic #### Parameters @@ -372,8 +340,6 @@ Get subscriber count for a topic > **getStats**(): `object` -Defined in: [agent/communication/message-bus.ts:486](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L486) - Get statistics #### Returns @@ -406,8 +372,6 @@ Get statistics > **on**(`event`, `handler`): `void` -Defined in: [agent/communication/message-bus.ts:510](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L510) - Subscribe to bus events #### Parameters @@ -430,8 +394,6 @@ Subscribe to bus events > **off**(`event`, `handler`): `void` -Defined in: [agent/communication/message-bus.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L517) - Unsubscribe from bus events #### Parameters @@ -454,8 +416,6 @@ Unsubscribe from bus events > **shutdown**(): `void` -Defined in: [agent/communication/message-bus.ts:524](https://github.com/juspay/neurolink/blob/release/src/lib/agent/communication/message-bus.ts#L524) - Shutdown the message bus #### Returns diff --git a/docs/api/classes/MetricsAggregator.md b/docs/api/classes/MetricsAggregator.md index 6a9c9f04d..f96f59567 100644 --- a/docs/api/classes/MetricsAggregator.md +++ b/docs/api/classes/MetricsAggregator.md @@ -6,8 +6,6 @@ # Class: MetricsAggregator -Defined in: [observability/metricsAggregator.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L18) - Metrics Aggregator for comprehensive telemetry analysis Provides latency percentiles, token aggregation, and cost tracking @@ -17,8 +15,6 @@ Provides latency percentiles, token aggregation, and cost tracking > **new MetricsAggregator**(`config?`): `MetricsAggregator` -Defined in: [observability/metricsAggregator.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L34) - #### Parameters ##### config? @@ -35,8 +31,6 @@ Defined in: [observability/metricsAggregator.ts:34](https://github.com/juspay/ne > **recordSpan**(`span`): `void` -Defined in: [observability/metricsAggregator.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L47) - Record a span for metrics aggregation #### Parameters @@ -55,8 +49,6 @@ Record a span for metrics aggregation > **getLatencyStats**(): [`LatencyStats`](../type-aliases/LatencyStats.md) -Defined in: [observability/metricsAggregator.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L274) - Get comprehensive latency statistics #### Returns @@ -69,8 +61,6 @@ Get comprehensive latency statistics > **getTokenStats**(): [`TokenUsageStats`](../type-aliases/TokenUsageStats.md) -Defined in: [observability/metricsAggregator.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L301) - Get token usage statistics #### Returns @@ -83,8 +73,6 @@ Get token usage statistics > **getCostByProvider**(): [`ProviderCostStats`](../type-aliases/ProviderCostStats.md)[] -Defined in: [observability/metricsAggregator.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L308) - Get cost breakdown by provider #### Returns @@ -97,8 +85,6 @@ Get cost breakdown by provider > **getCostByModel**(): [`ModelCostStats`](../type-aliases/ModelCostStats.md)[] -Defined in: [observability/metricsAggregator.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L315) - Get cost breakdown by model #### Returns @@ -111,8 +97,6 @@ Get cost breakdown by model > **getTotalCost**(): `number` -Defined in: [observability/metricsAggregator.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L322) - Get total cost across all providers #### Returns @@ -125,8 +109,6 @@ Get total cost across all providers > **getTimeWindows**(): [`TimeWindowStats`](../type-aliases/TimeWindowStats.md)[] -Defined in: [observability/metricsAggregator.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L334) - Get time window statistics #### Returns @@ -139,8 +121,6 @@ Get time window statistics > **getStatsForTimeRange**(`startTime`, `endTime`): [`TimeWindowStats`](../type-aliases/TimeWindowStats.md) -Defined in: [observability/metricsAggregator.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L343) - Get statistics for a specific time range #### Parameters @@ -163,8 +143,6 @@ Get statistics for a specific time range > **recordLatency**(`operation`, `latencyMs`): `void` -Defined in: [observability/metricsAggregator.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L382) - Record a latency measurement for an operation Use this for standalone latency tracking without a full span @@ -188,8 +166,6 @@ Use this for standalone latency tracking without a full span > **getMetrics**(): [`MetricsSummary`](../type-aliases/MetricsSummary.md) -Defined in: [observability/metricsAggregator.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L403) - Get comprehensive metrics summary (alias for getSummary) #### Returns @@ -202,8 +178,6 @@ Get comprehensive metrics summary (alias for getSummary) > **getSummary**(): [`MetricsSummary`](../type-aliases/MetricsSummary.md) -Defined in: [observability/metricsAggregator.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L410) - Get comprehensive metrics summary #### Returns @@ -216,8 +190,6 @@ Get comprehensive metrics summary > **getSpans**(): [`SpanData`](../type-aliases/SpanData.md)[] -Defined in: [observability/metricsAggregator.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L436) - Get all recorded spans (returns a copy) #### Returns @@ -230,8 +202,6 @@ Get all recorded spans (returns a copy) > **getTraces**(): [`TraceView`](../type-aliases/TraceView.md)[] -Defined in: [observability/metricsAggregator.ts:443](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L443) - Get spans grouped by traceId as hierarchical trace views #### Returns @@ -244,8 +214,6 @@ Get spans grouped by traceId as hierarchical trace views > **getTokenTracker**(): [`TokenTracker`](TokenTracker.md) -Defined in: [observability/metricsAggregator.ts:490](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L490) - Get the underlying token tracker for custom pricing configuration #### Returns @@ -258,8 +226,6 @@ Get the underlying token tracker for custom pricing configuration > **reset**(): `void` -Defined in: [observability/metricsAggregator.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L497) - Reset all metrics #### Returns @@ -272,8 +238,6 @@ Reset all metrics > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [observability/metricsAggregator.ts:514](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L514) - Export metrics as JSON #### Returns @@ -286,8 +250,6 @@ Export metrics as JSON > **formatCost**(`cost`, `currency?`): `string` -Defined in: [observability/metricsAggregator.ts:546](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L546) - Format cost as currency string #### Parameters @@ -310,8 +272,6 @@ Format cost as currency string > **getFormattedSummary**(): `string` -Defined in: [observability/metricsAggregator.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L557) - Get a formatted summary string #### Returns diff --git a/docs/api/classes/MetricsCollector.md b/docs/api/classes/MetricsCollector.md index 78a3ee38c..adbfaca55 100644 --- a/docs/api/classes/MetricsCollector.md +++ b/docs/api/classes/MetricsCollector.md @@ -6,8 +6,6 @@ # Class: MetricsCollector -Defined in: [evaluation/reporting/metricsCollector.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L17) - Metrics collector for evaluation data ## Constructors @@ -26,8 +24,6 @@ Metrics collector for evaluation data > **recordScorer**(`scorerId`, `scorerName`, `result`): `void` -Defined in: [evaluation/reporting/metricsCollector.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L34) - Record a scorer execution #### Parameters @@ -54,8 +50,6 @@ Record a scorer execution > **recordPipeline**(`result`): `void` -Defined in: [evaluation/reporting/metricsCollector.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L53) - Record a pipeline execution #### Parameters @@ -74,8 +68,6 @@ Record a pipeline execution > **getMetrics**(): [`AggregatedMetrics`](../type-aliases/AggregatedMetrics.md) -Defined in: [evaluation/reporting/metricsCollector.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L72) - Get aggregated metrics #### Returns @@ -88,8 +80,6 @@ Get aggregated metrics > **getScorerMetrics**(`scorerId`): [`ScorerMetrics`](../type-aliases/ScorerMetrics.md) \| `undefined` -Defined in: [evaluation/reporting/metricsCollector.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L102) - Get metrics for a specific scorer #### Parameters @@ -108,8 +98,6 @@ Get metrics for a specific scorer > **getPipelineMetrics**(`pipelineName`): [`PipelineMetrics`](../type-aliases/PipelineMetrics.md) \| `undefined` -Defined in: [evaluation/reporting/metricsCollector.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L109) - Get metrics for a specific pipeline #### Parameters @@ -128,8 +116,6 @@ Get metrics for a specific pipeline > **getSummary**(): `object` -Defined in: [evaluation/reporting/metricsCollector.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L116) - Get summary statistics #### Returns @@ -162,8 +148,6 @@ Get summary statistics > **exportJson**(): `string` -Defined in: [evaluation/reporting/metricsCollector.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L150) - Export metrics as JSON #### Returns @@ -176,8 +160,6 @@ Export metrics as JSON > **reset**(): `void` -Defined in: [evaluation/reporting/metricsCollector.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L192) - Reset all metrics #### Returns diff --git a/docs/api/classes/MiddlewareFactory.md b/docs/api/classes/MiddlewareFactory.md index 2ed15c833..dddeb815b 100644 --- a/docs/api/classes/MiddlewareFactory.md +++ b/docs/api/classes/MiddlewareFactory.md @@ -6,8 +6,6 @@ # Class: MiddlewareFactory -Defined in: [middleware/factory.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L25) - Middleware factory for creating and applying middleware chains. Each factory instance manages its own registry and configuration. @@ -17,8 +15,6 @@ Each factory instance manages its own registry and configuration. > **new MiddlewareFactory**(`options?`): `MiddlewareFactory` -Defined in: [middleware/factory.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L30) - #### Parameters ##### options? @@ -35,24 +31,18 @@ Defined in: [middleware/factory.ts:30](https://github.com/juspay/neurolink/blob/ > **registry**: `MiddlewareRegistry` -Defined in: [middleware/factory.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L26) - --- ### presets > **presets**: `Map`\<`string`, [`MiddlewarePreset`](../type-aliases/MiddlewarePreset.md)\> -Defined in: [middleware/factory.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L27) - ## Methods ### registerPreset() > **registerPreset**(`preset`, `replace?`): `void` -Defined in: [middleware/factory.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L94) - Register a custom preset #### Parameters @@ -75,8 +65,6 @@ Register a custom preset > **register**(`middleware`, `options?`): `void` -Defined in: [middleware/factory.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L106) - Register a custom middleware #### Parameters @@ -99,8 +87,6 @@ Register a custom middleware > **applyMiddleware**(`model`, `context`, `options?`): [`LanguageModel`](../type-aliases/LanguageModel.md) -Defined in: [middleware/factory.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L116) - Apply middleware to a language model #### Parameters @@ -127,8 +113,6 @@ Apply middleware to a language model > **createContext**(`provider`, `model`, `options?`, `session?`): [`MiddlewareContext`](../type-aliases/MiddlewareContext.md) -Defined in: [middleware/factory.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L297) - Create middleware context from provider and options #### Parameters @@ -165,8 +149,6 @@ Create middleware context from provider and options > **validateConfig**(`config`): `object` -Defined in: [middleware/factory.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L318) - Validate middleware configuration #### Parameters @@ -197,8 +179,6 @@ Validate middleware configuration > **getAvailablePresets**(): `object`[] -Defined in: [middleware/factory.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L373) - Get available presets #### Returns @@ -211,8 +191,6 @@ Get available presets > **getChainStats**(`context`, `config`): [`MiddlewareChainStats`](../type-aliases/MiddlewareChainStats.md) -Defined in: [middleware/factory.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L388) - Get middleware chain statistics #### Parameters @@ -235,8 +213,6 @@ Get middleware chain statistics > **createModelFactory**(`baseModelFactory`, `defaultOptions?`): (`context`, `options`) => `Promise`\<[`LanguageModel`](../type-aliases/LanguageModel.md)\> -Defined in: [middleware/factory.ts:421](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/factory.ts#L421) - Create a middleware-enabled model factory function #### Parameters diff --git a/docs/api/classes/MissingDependencyError.md b/docs/api/classes/MissingDependencyError.md index 4607fdbb4..e2670e84e 100644 --- a/docs/api/classes/MissingDependencyError.md +++ b/docs/api/classes/MissingDependencyError.md @@ -6,8 +6,6 @@ # Class: MissingDependencyError -Defined in: [server/errors.ts:530](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L530) - Missing dependency error ## Extends @@ -20,8 +18,6 @@ Missing dependency error > **new MissingDependencyError**(`dependency`, `framework`, `installCommand?`): `MissingDependencyError` -Defined in: [server/errors.ts:531](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L531) - #### Parameters ##### dependency @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:531](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ModelAccessDeniedError.md b/docs/api/classes/ModelAccessDeniedError.md index 1d38ec4d0..2b9d85b38 100644 --- a/docs/api/classes/ModelAccessDeniedError.md +++ b/docs/api/classes/ModelAccessDeniedError.md @@ -6,8 +6,6 @@ # Class: ModelAccessDeniedError -Defined in: [types/errors.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L253) - Curator P1-1: thrown when a provider rejects a request because the caller's team / API key is not whitelisted for the requested model. @@ -26,8 +24,6 @@ can choose a whitelisted alternative without scraping strings. > **new ModelAccessDeniedError**(`message`, `options?`): `ModelAccessDeniedError` -Defined in: [types/errors.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L258) - #### Parameters ##### message @@ -62,8 +58,6 @@ Defined in: [types/errors.ts:258](https://github.com/juspay/neurolink/blob/relea > `optional` **provider?**: `string` -Defined in: [types/errors.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L18) - #### Inherited from [`ProviderError`](ProviderError.md).[`provider`](ProviderError.md#provider) @@ -74,20 +68,14 @@ Defined in: [types/errors.ts:18](https://github.com/juspay/neurolink/blob/releas > `readonly` **requestedModel**: `string` \| `undefined` -Defined in: [types/errors.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L254) - --- ### allowedModels > `readonly` **allowedModels**: `string`[] \| `undefined` -Defined in: [types/errors.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L255) - --- ### code > `readonly` **code**: `"MODEL_ACCESS_DENIED"` - -Defined in: [types/errors.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L256) diff --git a/docs/api/classes/ModelAccessError.md b/docs/api/classes/ModelAccessError.md index 33b96f2df..69ae4ed94 100644 --- a/docs/api/classes/ModelAccessError.md +++ b/docs/api/classes/ModelAccessError.md @@ -6,8 +6,6 @@ # Class: ModelAccessError -Defined in: [types/errors.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L227) - Error thrown when model access is denied based on subscription tier ## Extends @@ -20,8 +18,6 @@ Error thrown when model access is denied based on subscription tier > **new ModelAccessError**(`model`, `tier`, `requiredTier`): `ModelAccessError` -Defined in: [types/errors.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L232) - #### Parameters ##### model @@ -50,20 +46,14 @@ Defined in: [types/errors.ts:232](https://github.com/juspay/neurolink/blob/relea > `readonly` **model**: `string` -Defined in: [types/errors.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L228) - --- ### tier > `readonly` **tier**: `string` -Defined in: [types/errors.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L229) - --- ### requiredTier > `readonly` **requiredTier**: `string` - -Defined in: [types/errors.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L230) diff --git a/docs/api/classes/ModelPool.md b/docs/api/classes/ModelPool.md index 5fbc6d79c..7b62bd4bd 100644 --- a/docs/api/classes/ModelPool.md +++ b/docs/api/classes/ModelPool.md @@ -6,8 +6,6 @@ # Class: ModelPool -Defined in: [routing/modelPool.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L173) - Multi-provider pool with per-member cooldown and strategy-based selection. All state (cooldowns, cursor) is instance-local and resets on construction. @@ -19,8 +17,6 @@ Thread safety is not required — Node.js is single-threaded for async work. > **new ModelPool**(`config`, `injectors?`): `ModelPool` -Defined in: [routing/modelPool.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L181) - #### Parameters ##### config @@ -45,8 +41,6 @@ Defined in: [routing/modelPool.ts:181](https://github.com/juspay/neurolink/blob/ > **get** **maxAttempts**(): `number` -Defined in: [routing/modelPool.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L194) - The maximum number of attempts per call (pool config value or member count). Used by callers that drive the retry loop externally. @@ -60,8 +54,6 @@ Used by callers that drive the retry loop externally. > **memberKey**(`member`): `string` -Defined in: [routing/modelPool.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L202) - Returns a stable string key for a pool member. Format: `${provider}:${model ?? "*"}:${region ?? "*"}` @@ -81,8 +73,6 @@ Format: `${provider}:${model ?? "*"}:${region ?? "*"}` > **availableMembers**(): [`ModelPoolMember`](../type-aliases/ModelPoolMember.md)[] -Defined in: [routing/modelPool.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L207) - Returns members whose cooldown has expired (or were never cooled). #### Returns @@ -95,8 +85,6 @@ Returns members whose cooldown has expired (or were never cooled). > **selectNext**(`excludedKeys?`): [`ModelPoolMember`](../type-aliases/ModelPoolMember.md) \| `undefined` -Defined in: [routing/modelPool.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L221) - Selects the next member to try according to the configured strategy. #### Parameters @@ -119,8 +107,6 @@ the chosen member, or undefined when all members are exhausted. > **recordFailure**(`member`, `errorClass`): `void` -Defined in: [routing/modelPool.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L289) - Records a provider failure, setting a cooldown appropriate for the error class. - Retryable classes (rate_limit, server, network, unknown): timed cooldown @@ -150,8 +136,6 @@ Records a provider failure, setting a cooldown appropriate for the error class. > **recordSuccess**(`member`): `void` -Defined in: [routing/modelPool.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L301) - Records a successful response, clearing any existing cooldown for this member so it remains fully available. diff --git a/docs/api/classes/MultiServerManager.md b/docs/api/classes/MultiServerManager.md index ada72b2b0..e1288c15b 100644 --- a/docs/api/classes/MultiServerManager.md +++ b/docs/api/classes/MultiServerManager.md @@ -6,8 +6,6 @@ # Class: MultiServerManager -Defined in: [mcp/multiServerManager.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L65) - Multi-Server Manager Coordinates multiple MCP servers for unified tool access @@ -51,8 +49,6 @@ const result = await manager.executeTool("readFile", { path: "/data" }); > **new MultiServerManager**(`config?`): `MultiServerManager` -Defined in: [mcp/multiServerManager.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L73) - #### Parameters ##### config? @@ -73,8 +69,6 @@ Defined in: [mcp/multiServerManager.ts:73](https://github.com/juspay/neurolink/b > **addServer**(`server`): `void` -Defined in: [mcp/multiServerManager.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L90) - Add a server to the manager #### Parameters @@ -93,8 +87,6 @@ Add a server to the manager > **removeServer**(`serverId`): `boolean` -Defined in: [mcp/multiServerManager.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L113) - Remove a server from the manager #### Parameters @@ -113,8 +105,6 @@ Remove a server from the manager > **updateServer**(`serverId`, `updates`): `void` -Defined in: [mcp/multiServerManager.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L154) - Update server info #### Parameters @@ -137,8 +127,6 @@ Update server info > **createGroup**(`group`): `void` -Defined in: [mcp/multiServerManager.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L180) - Create a server group #### Parameters @@ -157,8 +145,6 @@ Create a server group > **removeGroup**(`groupId`): `boolean` -Defined in: [mcp/multiServerManager.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L205) - Remove a server group #### Parameters @@ -177,8 +163,6 @@ Remove a server group > **addServerToGroup**(`serverId`, `groupId`): `void` -Defined in: [mcp/multiServerManager.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L217) - Add a server to a group #### Parameters @@ -201,8 +185,6 @@ Add a server to a group > **removeServerFromGroup**(`serverId`, `groupId`): `boolean` -Defined in: [mcp/multiServerManager.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L245) - Remove a server from a group #### Parameters @@ -225,8 +207,6 @@ Remove a server from a group > **getUnifiedTools**(): [`UnifiedTool`](../type-aliases/UnifiedTool.md)[] -Defined in: [mcp/multiServerManager.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L265) - Get unified tool list from all servers #### Returns @@ -239,8 +219,6 @@ Get unified tool list from all servers > **getNamespacedTools**(): `object`[] -Defined in: [mcp/multiServerManager.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L325) - Get namespaced tools (server.toolName format) #### Returns @@ -253,8 +231,6 @@ Get namespaced tools (server.toolName format) > **setToolPreference**(`toolName`, `serverId`): `void` -Defined in: [mcp/multiServerManager.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L370) - Set tool preference for routing #### Parameters @@ -277,8 +253,6 @@ Set tool preference for routing > **clearToolPreference**(`toolName`): `void` -Defined in: [mcp/multiServerManager.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L386) - Clear tool preference #### Parameters @@ -297,8 +271,6 @@ Clear tool preference > **selectServer**(`toolName`, `groupId?`): \{ `serverId`: `string`; `server`: [`MCPServerInfo`](../type-aliases/MCPServerInfo.md); \} \| `null` -Defined in: [mcp/multiServerManager.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L393) - Select a server for a tool using load balancing #### Parameters @@ -321,8 +293,6 @@ Select a server for a tool using load balancing > **updateMetrics**(`serverId`, `updates`): `void` -Defined in: [mcp/multiServerManager.ts:620](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L620) - Update server metrics #### Parameters @@ -345,8 +315,6 @@ Update server metrics > **requestStarted**(`serverId`): `void` -Defined in: [mcp/multiServerManager.ts:632](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L632) - Mark request started #### Parameters @@ -365,8 +333,6 @@ Mark request started > **requestCompleted**(`serverId`, `duration`, `success`): `void` -Defined in: [mcp/multiServerManager.ts:643](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L643) - Mark request completed #### Parameters @@ -393,8 +359,6 @@ Mark request completed > **getServers**(): [`MCPServerInfo`](../type-aliases/MCPServerInfo.md)[] -Defined in: [mcp/multiServerManager.ts:665](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L665) - Get all servers #### Returns @@ -407,8 +371,6 @@ Get all servers > **getServer**(`serverId`): [`MCPServerInfo`](../type-aliases/MCPServerInfo.md) \| `undefined` -Defined in: [mcp/multiServerManager.ts:672](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L672) - Get server by ID #### Parameters @@ -427,8 +389,6 @@ Get server by ID > **getGroups**(): [`ServerGroup`](../type-aliases/ServerGroup.md)[] -Defined in: [mcp/multiServerManager.ts:679](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L679) - Get all groups #### Returns @@ -441,8 +401,6 @@ Get all groups > **getGroup**(`groupId`): [`ServerGroup`](../type-aliases/ServerGroup.md) \| `undefined` -Defined in: [mcp/multiServerManager.ts:686](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L686) - Get group by ID #### Parameters @@ -461,8 +419,6 @@ Get group by ID > **getServerMetrics**(`serverId`): [`ServerMetrics`](../type-aliases/ServerMetrics.md) \| `undefined` -Defined in: [mcp/multiServerManager.ts:693](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L693) - Get server metrics #### Parameters @@ -481,8 +437,6 @@ Get server metrics > **getAllMetrics**(): `Map`\<`string`, [`ServerMetrics`](../type-aliases/ServerMetrics.md)\> -Defined in: [mcp/multiServerManager.ts:700](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L700) - Get all metrics #### Returns @@ -495,8 +449,6 @@ Get all metrics > **getStatistics**(): `object` -Defined in: [mcp/multiServerManager.ts:707](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/multiServerManager.ts#L707) - Get statistics #### Returns diff --git a/docs/api/classes/MusicError.md b/docs/api/classes/MusicError.md index bde34c9c0..5144a4b1e 100644 --- a/docs/api/classes/MusicError.md +++ b/docs/api/classes/MusicError.md @@ -6,8 +6,6 @@ # Class: MusicError -Defined in: [utils/musicProcessor.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L45) - Typed error class for music-generation failures. ## Extends @@ -20,8 +18,6 @@ Typed error class for music-generation failures. > **new MusicError**(`options`): `MusicError` -Defined in: [utils/musicProcessor.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L46) - #### Parameters ##### options @@ -68,8 +64,6 @@ Defined in: [utils/musicProcessor.ts:46](https://github.com/juspay/neurolink/blo > `readonly` **code**: `string` -Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L105) - #### Inherited from `NeuroLinkError.code` @@ -80,8 +74,6 @@ Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blo > `readonly` **category**: `ErrorCategory` -Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L106) - #### Inherited from `NeuroLinkError.category` @@ -92,8 +84,6 @@ Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blo > `readonly` **severity**: `ErrorSeverity` -Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L107) - #### Inherited from `NeuroLinkError.severity` @@ -104,8 +94,6 @@ Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blo > `readonly` **retriable**: `boolean` -Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L108) - #### Inherited from `NeuroLinkError.retriable` @@ -116,8 +104,6 @@ Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blo > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L109) - #### Inherited from `NeuroLinkError.retryAfterMs` @@ -128,8 +114,6 @@ Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blo > `readonly` **context**: `Record`\<`string`, `unknown`\> -Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L110) - #### Inherited from `NeuroLinkError.context` @@ -140,8 +124,6 @@ Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blo > `readonly` **timestamp**: `Date` -Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L111) - #### Inherited from `NeuroLinkError.timestamp` @@ -152,8 +134,6 @@ Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blo > `readonly` `optional` **toolName?**: `string` -Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L112) - #### Inherited from `NeuroLinkError.toolName` @@ -164,8 +144,6 @@ Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blo > `readonly` `optional` **serverId?**: `string` -Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L113) - #### Inherited from `NeuroLinkError.serverId` @@ -176,8 +154,6 @@ Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blo > **toJSON**(): [`StructuredError`](../type-aliases/StructuredError.md) -Defined in: [utils/errorHandling.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L149) - Convert to JSON for logging and serialization #### Returns diff --git a/docs/api/classes/MusicProcessor.md b/docs/api/classes/MusicProcessor.md index 8fd2cbeb9..b0168561d 100644 --- a/docs/api/classes/MusicProcessor.md +++ b/docs/api/classes/MusicProcessor.md @@ -6,8 +6,6 @@ # Class: MusicProcessor -Defined in: [utils/musicProcessor.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L71) - Static processor managing the music handler registry. ## Constructors @@ -26,8 +24,6 @@ Static processor managing the music handler registry. > `static` **registerHandler**(`providerName`, `handler`): `void` -Defined in: [utils/musicProcessor.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L79) - Register a music handler for a specific provider. #### Parameters @@ -50,8 +46,6 @@ Register a music handler for a specific provider. > `static` **supports**(`providerName`): `boolean` -Defined in: [utils/musicProcessor.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L88) - Check if a provider has a registered music handler. #### Parameters @@ -70,8 +64,6 @@ Check if a provider has a registered music handler. > `static` **listProviders**(): `string`[] -Defined in: [utils/musicProcessor.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L95) - List the names of all registered providers. #### Returns @@ -84,8 +76,6 @@ List the names of all registered providers. > `static` **getHandler**(`providerName`): [`MusicHandler`](../type-aliases/MusicHandler.md) \| `undefined` -Defined in: [utils/musicProcessor.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L105) - Get a registered music handler by provider name. Exposed publicly so module-level auto-registration code can reuse an @@ -107,8 +97,6 @@ already-registered primary handler when backfilling its aliases. > `static` **clearHandlers**(): `void` -Defined in: [utils/musicProcessor.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L112) - Clear all registered handlers (for testing). #### Returns @@ -121,8 +109,6 @@ Clear all registered handlers (for testing). > `static` **generate**(`provider`, `options`): `Promise`\<[`MusicResult`](../type-aliases/MusicResult.md)\> -Defined in: [utils/musicProcessor.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/utils/musicProcessor.ts#L136) - Generate a music track via the registered handler. #### Parameters diff --git a/docs/api/classes/NetworkError.md b/docs/api/classes/NetworkError.md index a88bfeb46..96ba98c5b 100644 --- a/docs/api/classes/NetworkError.md +++ b/docs/api/classes/NetworkError.md @@ -6,8 +6,6 @@ # Class: NetworkError -Defined in: [types/errors.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L51) - Thrown for network-related issues, such as connectivity problems or timeouts. ## Extends @@ -20,8 +18,6 @@ Thrown for network-related issues, such as connectivity problems or timeouts. > **new NetworkError**(`message`, `provider?`): `NetworkError` -Defined in: [types/errors.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L52) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [types/errors.ts:52](https://github.com/juspay/neurolink/blob/releas > `optional` **provider?**: `string` -Defined in: [types/errors.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L18) - #### Inherited from [`ProviderError`](ProviderError.md).[`provider`](ProviderError.md#provider) diff --git a/docs/api/classes/NetworkOrchestrator.md b/docs/api/classes/NetworkOrchestrator.md index f5e1634b2..f0cb9d37d 100644 --- a/docs/api/classes/NetworkOrchestrator.md +++ b/docs/api/classes/NetworkOrchestrator.md @@ -6,8 +6,6 @@ # Class: NetworkOrchestrator -Defined in: [agent/orchestration/orchestrator.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L37) - Network Orchestrator - Central controller for agent networks ## Constructors @@ -16,8 +14,6 @@ Network Orchestrator - Central controller for agent networks > **new NetworkOrchestrator**(`neurolink`, `config?`): `NetworkOrchestrator` -Defined in: [agent/orchestration/orchestrator.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L53) - #### Parameters ##### neurolink @@ -38,8 +34,6 @@ Defined in: [agent/orchestration/orchestrator.ts:53](https://github.com/juspay/n > **createNetwork**(`config`, `mode?`): `Promise`\<[`AgentNetwork`](AgentNetwork.md)\> -Defined in: [agent/orchestration/orchestrator.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L81) - Create a new agent network #### Parameters @@ -62,8 +56,6 @@ Create a new agent network > **createHierarchicalNetwork**(`config`, `parentNetworkId?`): `Promise`\<[`AgentNetwork`](AgentNetwork.md)\> -Defined in: [agent/orchestration/orchestrator.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L160) - Create a hierarchical network #### Parameters @@ -86,8 +78,6 @@ Create a hierarchical network > **getNetwork**(`networkId`): [`AgentNetwork`](AgentNetwork.md) \| `undefined` -Defined in: [agent/orchestration/orchestrator.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L209) - Get a network by ID #### Parameters @@ -106,8 +96,6 @@ Get a network by ID > **getNetworkInfo**(`networkId`): [`NetworkInfo`](../type-aliases/NetworkInfo.md) \| `undefined` -Defined in: [agent/orchestration/orchestrator.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L216) - Get network info #### Parameters @@ -126,8 +114,6 @@ Get network info > **getAllNetworks**(): [`NetworkInfo`](../type-aliases/NetworkInfo.md)[] -Defined in: [agent/orchestration/orchestrator.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L223) - Get all networks #### Returns @@ -140,8 +126,6 @@ Get all networks > **executeNetwork**(`networkId`, `input`, `options?`): `Promise`\<[`NetworkExecutionResult`](../type-aliases/NetworkExecutionResult.md)\> -Defined in: [agent/orchestration/orchestrator.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L230) - Execute a network #### Parameters @@ -168,8 +152,6 @@ Execute a network > **streamNetwork**(`networkId`, `input`, `options?`): `AsyncIterable`\<[`NetworkStreamChunk`](../type-aliases/NetworkStreamChunk.md)\> -Defined in: [agent/orchestration/orchestrator.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L376) - Stream network execution #### Parameters @@ -196,8 +178,6 @@ Stream network execution > **executeHierarchical**(`networkId`, `input`, `options?`): `Promise`\<[`HierarchicalExecutionTrace`](../type-aliases/HierarchicalExecutionTrace.md)\> -Defined in: [agent/orchestration/orchestrator.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L424) - Execute hierarchical network with delegation #### Parameters @@ -224,8 +204,6 @@ Execute hierarchical network with delegation > **pauseNetwork**(`networkId`): `void` -Defined in: [agent/orchestration/orchestrator.ts:478](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L478) - Pause a network #### Parameters @@ -244,8 +222,6 @@ Pause a network > **resumeNetwork**(`networkId`): `void` -Defined in: [agent/orchestration/orchestrator.ts:489](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L489) - Resume a network #### Parameters @@ -264,8 +240,6 @@ Resume a network > **shutdownNetwork**(`networkId`): `Promise`\<`void`\> -Defined in: [agent/orchestration/orchestrator.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L500) - Shutdown a network #### Parameters @@ -284,8 +258,6 @@ Shutdown a network > **coordinateNetworks**(`networkIds`, `task`, `strategy?`): `Promise`\<`Map`\<`string`, [`NetworkExecutionResult`](../type-aliases/NetworkExecutionResult.md)\>\> -Defined in: [agent/orchestration/orchestrator.ts:534](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L534) - Coordinate multiple networks #### Parameters @@ -312,8 +284,6 @@ Coordinate multiple networks > **getStats**(): `object` -Defined in: [agent/orchestration/orchestrator.ts:578](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L578) - Get orchestrator statistics #### Returns @@ -346,8 +316,6 @@ Get orchestrator statistics > **getMessageBus**(): [`MessageBus`](MessageBus.md) -Defined in: [agent/orchestration/orchestrator.ts:613](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L613) - Get the shared message bus #### Returns @@ -360,8 +328,6 @@ Get the shared message bus > **on**(`event`, `handler`): `void` -Defined in: [agent/orchestration/orchestrator.ts:620](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L620) - Subscribe to orchestrator events #### Parameters @@ -384,8 +350,6 @@ Subscribe to orchestrator events > **off**(`event`, `handler`): `void` -Defined in: [agent/orchestration/orchestrator.ts:627](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L627) - Unsubscribe from orchestrator events #### Parameters @@ -408,8 +372,6 @@ Unsubscribe from orchestrator events > **shutdown**(): `Promise`\<`void`\> -Defined in: [agent/orchestration/orchestrator.ts:634](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/orchestrator.ts#L634) - Shutdown the orchestrator #### Returns diff --git a/docs/api/classes/NetworkTopology.md b/docs/api/classes/NetworkTopology.md index 57e2cf476..96630788f 100644 --- a/docs/api/classes/NetworkTopology.md +++ b/docs/api/classes/NetworkTopology.md @@ -6,8 +6,6 @@ # Class: NetworkTopology -Defined in: [agent/orchestration/topology.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L26) - Network Topology - Manages agent network structure ## Constructors @@ -16,8 +14,6 @@ Network Topology - Manages agent network structure > **new NetworkTopology**(`config`): `NetworkTopology` -Defined in: [agent/orchestration/topology.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L32) - #### Parameters ##### config @@ -34,8 +30,6 @@ Defined in: [agent/orchestration/topology.ts:32](https://github.com/juspay/neuro > **buildFromAgents**(`agents`): `void` -Defined in: [agent/orchestration/topology.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L42) - Build topology from agents #### Parameters @@ -54,8 +48,6 @@ Build topology from agents > **addNode**(`agent`, `role?`): [`TopologyNode`](../type-aliases/TopologyNode.md) -Defined in: [agent/orchestration/topology.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L80) - Add a node to the topology #### Parameters @@ -78,8 +70,6 @@ Add a node to the topology > **removeNode**(`nodeId`): `boolean` -Defined in: [agent/orchestration/topology.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L97) - Remove a node from the topology #### Parameters @@ -98,8 +88,6 @@ Remove a node from the topology > **addEdge**(`sourceId`, `targetId`, `type?`, `weight?`): [`TopologyEdge`](../type-aliases/TopologyEdge.md) \| `undefined` -Defined in: [agent/orchestration/topology.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L129) - Add an edge between nodes #### Parameters @@ -130,8 +118,6 @@ Add an edge between nodes > **removeEdge**(`edgeId`): `boolean` -Defined in: [agent/orchestration/topology.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L171) - Remove an edge #### Parameters @@ -150,8 +136,6 @@ Remove an edge > **getNode**(`nodeId`): [`TopologyNode`](../type-aliases/TopologyNode.md) \| `undefined` -Defined in: [agent/orchestration/topology.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L356) - Get node by ID #### Parameters @@ -170,8 +154,6 @@ Get node by ID > **getNodeByAgentId**(`agentId`): [`TopologyNode`](../type-aliases/TopologyNode.md) \| `undefined` -Defined in: [agent/orchestration/topology.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L363) - Get node by agent ID #### Parameters @@ -190,8 +172,6 @@ Get node by agent ID > **getAllNodes**(): [`TopologyNode`](../type-aliases/TopologyNode.md)[] -Defined in: [agent/orchestration/topology.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L375) - Get all nodes #### Returns @@ -204,8 +184,6 @@ Get all nodes > **getAllEdges**(): [`TopologyEdge`](../type-aliases/TopologyEdge.md)[] -Defined in: [agent/orchestration/topology.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L382) - Get all edges #### Returns @@ -218,8 +196,6 @@ Get all edges > **getConnectedNodes**(`nodeId`): [`TopologyNode`](../type-aliases/TopologyNode.md)[] -Defined in: [agent/orchestration/topology.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L389) - Get connected nodes #### Parameters @@ -238,8 +214,6 @@ Get connected nodes > **findShortestPath**(`sourceId`, `targetId`): `string`[] \| `undefined` -Defined in: [agent/orchestration/topology.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L403) - Find shortest path between two nodes (BFS) #### Parameters @@ -262,8 +236,6 @@ Find shortest path between two nodes (BFS) > **areConnected**(`sourceId`, `targetId`): `boolean` -Defined in: [agent/orchestration/topology.ts:442](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L442) - Check if two nodes are connected (directly or indirectly) #### Parameters @@ -286,8 +258,6 @@ Check if two nodes are connected (directly or indirectly) > **getNodesByRole**(`role`): [`TopologyNode`](../type-aliases/TopologyNode.md)[] -Defined in: [agent/orchestration/topology.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L449) - Get nodes by role #### Parameters @@ -306,8 +276,6 @@ Get nodes by role > **getCoordinator**(): [`TopologyNode`](../type-aliases/TopologyNode.md) \| `undefined` -Defined in: [agent/orchestration/topology.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L456) - Get coordinator/root node #### Returns @@ -320,8 +288,6 @@ Get coordinator/root node > **getStats**(): [`TopologyStats`](../type-aliases/TopologyStats.md) -Defined in: [agent/orchestration/topology.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L468) - Calculate topology statistics #### Returns @@ -334,8 +300,6 @@ Calculate topology statistics > **toJSON**(): `object` -Defined in: [agent/orchestration/topology.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L522) - Export topology as JSON #### Returns @@ -364,8 +328,6 @@ Export topology as JSON > **fromJSON**(`data`): `void` -Defined in: [agent/orchestration/topology.ts:539](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L539) - Import topology from JSON #### Parameters @@ -398,8 +360,6 @@ Import topology from JSON > **getType**(): [`TopologyType`](../type-aliases/TopologyType.md) -Defined in: [agent/orchestration/topology.ts:566](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L566) - Get topology type #### Returns @@ -412,8 +372,6 @@ Get topology type > **getId**(): `string` -Defined in: [agent/orchestration/topology.ts:573](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L573) - Get topology ID #### Returns diff --git a/docs/api/classes/NeuroLink.md b/docs/api/classes/NeuroLink.md index 208a33163..1f46166a7 100644 --- a/docs/api/classes/NeuroLink.md +++ b/docs/api/classes/NeuroLink.md @@ -6,16 +6,12 @@ # Class: NeuroLink -Defined in: [neurolink.ts:690](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L690) - ## Constructors ### Constructor > **new NeuroLink**(`config?`): `NeuroLink` -Defined in: [neurolink.ts:1396](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L1396) - #### Parameters ##### config? @@ -32,8 +28,6 @@ Defined in: [neurolink.ts:1396](https://github.com/juspay/neurolink/blob/release > `optional` **conversationMemory?**: `ConversationMemoryManager` \| `RedisConversationMemoryManager` \| `null` -Defined in: [neurolink.ts:821](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L821) - ## Accessors ### tasks @@ -42,8 +36,6 @@ Defined in: [neurolink.ts:821](https://github.com/juspay/neurolink/blob/release/ > **get** **tasks**(): `TaskManager` -Defined in: [neurolink.ts:1578](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L1578) - TaskManager — scheduled and self-running tasks. Lazy-initialized on first access. Configurable via constructor `tasks` option. The actual async initialization (Redis connect, backend start) happens @@ -61,8 +53,6 @@ lazily inside TaskManager on first operation. > **generate**(`optionsOrPrompt`): `Promise`\<[`GenerateResult`](../type-aliases/GenerateResult.md)\> -Defined in: [neurolink.ts:4464](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L4464) - Generate AI response with comprehensive feature support. Primary method for AI generation with support for all NeuroLink features: @@ -191,8 +181,6 @@ When HITL approval is denied > **getSkillsManager**(): [`SkillsManager`](SkillsManager.md) \| `null` -Defined in: [neurolink.ts:2422](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L2422) - Programmatic access to the skills subsystem (search/list/get/mutations). Returns null when skills are not configured or failed to initialize. @@ -206,8 +194,6 @@ Returns null when skills are not configured or failed to initialize. > **getObservabilityConfig**(): [`ObservabilityConfig`](../type-aliases/ObservabilityConfig.md) \| `undefined` -Defined in: [neurolink.ts:3654](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3654) - Get observability configuration ##### Returns @@ -220,8 +206,6 @@ Get observability configuration > **isTelemetryEnabled**(): `boolean` -Defined in: [neurolink.ts:3662](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3662) - Check if Langfuse telemetry is enabled Centralized utility to avoid duplication across providers @@ -235,8 +219,6 @@ Centralized utility to avoid duplication across providers > **getTelemetryStatus**(): `object` -Defined in: [neurolink.ts:3674](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3674) - Get comprehensive telemetry status including Langfuse, OTel, and exporter health ##### Returns @@ -289,8 +271,6 @@ Get comprehensive telemetry status including Langfuse, OTel, and exporter health > **getMetrics**(): [`MetricsSummary`](../type-aliases/MetricsSummary.md) -Defined in: [neurolink.ts:3729](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3729) - Get aggregated observability metrics (latency, tokens, cost, success rate) ##### Returns @@ -303,8 +283,6 @@ Get aggregated observability metrics (latency, tokens, cost, success rate) > **getSpans**(): [`SpanData`](../type-aliases/SpanData.md)[] -Defined in: [neurolink.ts:3736](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3736) - Get all recorded spans ##### Returns @@ -317,8 +295,6 @@ Get all recorded spans > **getTraces**(): [`TraceView`](../type-aliases/TraceView.md)[] -Defined in: [neurolink.ts:3743](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3743) - Get traces (spans grouped by traceId with parent-child hierarchy) ##### Returns @@ -331,8 +307,6 @@ Get traces (spans grouped by traceId with parent-child hierarchy) > **resetMetrics**(): `void` -Defined in: [neurolink.ts:3750](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3750) - Reset all collected metrics and spans ##### Returns @@ -345,8 +319,6 @@ Reset all collected metrics and spans > **recordMetricsSpan**(`span`): `void` -Defined in: [neurolink.ts:3757](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3757) - Record a span for metrics tracking ##### Parameters @@ -365,8 +337,6 @@ Record a span for metrics tracking > **getProviderMetrics**(`options?`): `Promise`\<[`ProviderMetricsResult`](../type-aliases/ProviderMetricsResult.md)\> -Defined in: [neurolink.ts:3768](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3768) - Get provider metrics analysis Retrieves aggregated performance, token usage, latency, and success rates per provider. @@ -390,8 +360,6 @@ Comprehensive provider metrics result > **getCostAnalysis**(`options?`): `Promise`\<[`CostAnalysisResult`](../type-aliases/CostAnalysisResult.md)\> -Defined in: [neurolink.ts:3783](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3783) - Get cost analysis breakdown Analyzes AI generation costs across requested groups and provides future projections. @@ -415,8 +383,6 @@ Detailed cost analysis breakdown > **getTeamAnalytics**(`options?`): `Promise`\<[`TeamAnalyticsResult`](../type-aliases/TeamAnalyticsResult.md)\> -Defined in: [neurolink.ts:3796](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3796) - Get team-wide usage analytics Retrieves request counts, unique active users, provider breakdown, and quality scoring. @@ -440,8 +406,6 @@ Comprehensive team analytics report > **initializeLangfuseObservability**(): `Promise`\<`void`\> -Defined in: [neurolink.ts:3838](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3838) - Public method to initialize Langfuse observability This method can be called externally to ensure Langfuse is properly initialized @@ -455,8 +419,6 @@ This method can be called externally to ensure Langfuse is properly initialized > **shutdown**(): `Promise`\<`void`\> -Defined in: [neurolink.ts:3868](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L3868) - Gracefully shutdown NeuroLink and all MCP connections ##### Returns @@ -469,8 +431,6 @@ Gracefully shutdown NeuroLink and all MCP connections > **generateText**(`options`): `Promise`\<[`TextGenerationResult`](../type-aliases/TextGenerationResult.md)\> -Defined in: [neurolink.ts:6694](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L6694) - BACKWARD COMPATIBILITY: Legacy generateText method Internally calls generate() and converts result format @@ -490,8 +450,6 @@ Internally calls generate() and converts result format > **streamText**(`prompt`, `options?`): `Promise`\<`AsyncIterable`\<`string`, `any`, `any`\>\> -Defined in: [neurolink.ts:9251](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L9251) - BACKWARD COMPATIBILITY: Legacy streamText method Internally calls stream() and converts result format @@ -515,8 +473,6 @@ Internally calls stream() and converts result format > **stream**(`options`): `Promise`\<[`StreamResult`](../type-aliases/StreamResult.md)\> -Defined in: [neurolink.ts:9334](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L9334) - Stream AI-generated content in real-time using the best available provider. This method provides real-time streaming of AI responses with full MCP tool integration. @@ -588,8 +544,6 @@ When conversation memory operations fail (if enabled) > **setToolRoutingServers**(`servers`): `void` -Defined in: [neurolink.ts:10266](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L10266) - Supplies (or replaces) the pre-call tool routing server catalog. For hosts that only know their tool servers after constructing NeuroLink @@ -613,8 +567,6 @@ alone does not activate it. > **getKnowledgeStatus**(): [`KnowledgeEngineStatus`](../type-aliases/KnowledgeEngineStatus.md) \| `null` -Defined in: [neurolink.ts:10284](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L10284) - Knowledge-grounding engine health (null when it was not configured). ##### Returns @@ -627,8 +579,6 @@ Knowledge-grounding engine health (null when it was not configured). > **getEventEmitter**(): `TypedEventEmitter`\<[`NeuroLinkEvents`](../type-aliases/NeuroLinkEvents.md)\> -Defined in: [neurolink.ts:12772](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L12772) - Get the EventEmitter instance to listen to NeuroLink events for real-time monitoring and debugging. This method provides access to the internal event system that emits events during AI generation, tool execution, streaming, and other operations for comprehensive observability. @@ -833,8 +783,6 @@ This method does not throw errors as it returns the internal EventEmitter > **hasPendingHITLConfirmation**(`confirmationId`): `boolean` -Defined in: [neurolink.ts:12812](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L12812) - Whether a HITL confirmation is still awaiting a response on THIS instance. Emitting `hitl:confirmation-response` is not proof the decision landed. The @@ -888,8 +836,6 @@ neurolink.getEventEmitter().emit("hitl:confirmation-response", { ... }); > **getToolDedupConfig**(): [`ToolDedupConfig`](../type-aliases/ToolDedupConfig.md) \| `undefined` -Defined in: [neurolink.ts:12828](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L12828) - Returns the instance-level tool-dedup configuration, or `undefined` when toolDedup was not provided at construction time. @@ -911,8 +857,6 @@ parameter through the full call stack. > **getToolsConfig**(): [`ToolConfig`](../type-aliases/ToolConfig.md) \| `undefined` -Defined in: [neurolink.ts:12881](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L12881) - ##### Returns [`ToolConfig`](../type-aliases/ToolConfig.md) \| `undefined` @@ -923,8 +867,6 @@ Defined in: [neurolink.ts:12881](https://github.com/juspay/neurolink/blob/releas > **getDiscoveryPins**(`sessionKey`): `ReadonlySet`\<`string`\> -Defined in: [neurolink.ts:12892](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L12892) - Tools discovered via `search_tools` for a session (`tools.discovery` mode). Pinned tools are sent in full on every subsequent call of that session instead of being deferred — discovery cost is paid once. @@ -947,8 +889,6 @@ are never the ones evicted at the session cap. > **pinDiscoveredTools**(`sessionKey`, `toolNames`): `void` -Defined in: [neurolink.ts:12909](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L12909) - Pin discovered tools to a session (called by the `search_tools` meta-tool on hydration). Append-only within a session; the map is bounded by evicting the least-recently-used session past 1000 sessions. @@ -973,8 +913,6 @@ bounded by evicting the least-recently-used session past 1000 sessions. > **checkCredentials**(`input`): `Promise`\<\{ `provider`: `string`; `status`: `"network"` \| `"unknown"` \| `"expired"` \| `"ok"` \| `"missing"` \| `"denied"`; `detail`: `string`; \}\> -Defined in: [neurolink.ts:12954](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L12954) - Curator P1-1: synchronous credential health check for a single provider. Drives a tiny real call against the provider (1-token completion or @@ -1025,8 +963,6 @@ if (health.status !== "ok") { > **emitToolStart**(`toolName`, `input`, `startTime?`): `string` -Defined in: [neurolink.ts:13033](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13033) - Emit tool start event with execution tracking ##### Parameters @@ -1061,8 +997,6 @@ executionId for tracking this specific execution > **emitToolEnd**(`toolName`, `result?`, `error?`, `startTime?`, `endTime?`, `executionId?`): `void` -Defined in: [neurolink.ts:13084](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13084) - Emit tool end event with execution summary ##### Parameters @@ -1113,8 +1047,6 @@ Optional execution ID for tracking > **getCurrentToolExecutions**(): [`ToolExecutionContext`](../type-aliases/ToolExecutionContext.md)[] -Defined in: [neurolink.ts:13165](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13165) - Get current tool execution contexts for stream metadata ##### Returns @@ -1127,8 +1059,6 @@ Get current tool execution contexts for stream metadata > **getToolExecutionHistory**(): [`ToolExecutionSummary`](../type-aliases/ToolExecutionSummary.md)[] -Defined in: [neurolink.ts:13172](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13172) - Get tool execution history ##### Returns @@ -1141,8 +1071,6 @@ Get tool execution history > **clearCurrentStreamExecutions**(): `void` -Defined in: [neurolink.ts:13179](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13179) - Clear current stream tool executions (called at stream start) ##### Returns @@ -1155,8 +1083,6 @@ Clear current stream tool executions (called at stream start) > **registerTool**(`name`, `tool`, `options?`): `void` -Defined in: [neurolink.ts:13195](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13195) - Register a custom tool that will be available to all AI providers ##### Parameters @@ -1201,8 +1127,6 @@ Tool in MCPExecutableTool format (unified MCP protocol type) > **setToolContext**(`context`): `void` -Defined in: [neurolink.ts:13346](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13346) - Set the context that will be passed to tools during execution This context will be merged with any runtime context passed by the AI model @@ -1224,8 +1148,6 @@ Context object containing session info, tokens, shop data, etc. > **getToolContext**(): `Record`\<`string`, `unknown`\> \| `undefined` -Defined in: [neurolink.ts:13361](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13361) - Get the current tool execution context ##### Returns @@ -1240,8 +1162,6 @@ Current context or undefined if not set > **clearToolContext**(): `void` -Defined in: [neurolink.ts:13370](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13370) - Clear the tool execution context ##### Returns @@ -1254,8 +1174,6 @@ Clear the tool execution context > **registerTools**(`tools`): `void` -Defined in: [neurolink.ts:13382](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13382) - Register multiple tools at once - Supports both object and array formats ##### Parameters @@ -1279,8 +1197,6 @@ Array format (Lighthouse compatible): [{ name: string, tool: MCPExecutableTool } > **unregisterTool**(`name`): `boolean` -Defined in: [neurolink.ts:13405](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13405) - Unregister a custom tool ##### Parameters @@ -1303,8 +1219,6 @@ true if the tool was removed, false if it didn't exist > **useToolMiddleware**(`middleware`): `this` -Defined in: [neurolink.ts:13424](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13424) - Register a global tool middleware that runs on every tool execution. Middleware receives the tool, params, context, and a next() function. @@ -1328,8 +1242,6 @@ this (for chaining) > **getToolMiddlewares**(): [`ToolMiddleware`](../type-aliases/ToolMiddleware.md)[] -Defined in: [neurolink.ts:13437](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13437) - Get all registered tool middlewares ##### Returns @@ -1342,8 +1254,6 @@ Get all registered tool middlewares > **flushToolBatch**(): `Promise`\<`void`\> -Defined in: [neurolink.ts:13444](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13444) - Flush any pending batched tool calls immediately ##### Returns @@ -1356,8 +1266,6 @@ Flush any pending batched tool calls immediately > **getMCPEnhancementsConfig**(): [`MCPEnhancementsConfig`](../type-aliases/MCPEnhancementsConfig.md) \| `undefined` -Defined in: [neurolink.ts:13453](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13453) - Get the current MCP enhancements configuration ##### Returns @@ -1370,8 +1278,6 @@ Get the current MCP enhancements configuration > **updateAgenticLoopReport**(`sessionId`, `report`, `userId?`): `Promise`\<`void`\> -Defined in: [neurolink.ts:13476](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13476) - Update agentic loop report metadata for a conversation session. Upserts a report entry by reportId — updates existing or adds new. Only supported when using Redis conversation memory. @@ -1420,8 +1326,6 @@ await neurolink.updateAgenticLoopReport("session-123", { > **getCustomTools**(): `Map`\<`string`, \{ `name`: `string`; `description`: `string`; `inputSchema?`: `object`; `execute?`: (`params`, `context?`) => `unknown`; \}\> -Defined in: [neurolink.ts:13512](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13512) - Get all registered custom tools ##### Returns @@ -1436,8 +1340,6 @@ Map of tool names to MCPExecutableTool format > **addInMemoryMCPServer**(`serverId`, `serverInfo`): `Promise`\<`void`\> -Defined in: [neurolink.ts:13650](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13650) - Add an in-memory MCP server (from git diff) Allows registration of pre-instantiated server objects @@ -1465,8 +1367,6 @@ Server configuration > **getInMemoryServers**(): `Map`\<`string`, [`MCPServerInfo`](../type-aliases/MCPServerInfo.md)\> -Defined in: [neurolink.ts:13694](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13694) - Get all registered in-memory servers as a Map for ID-based lookup. This method is primarily used when you need O(1) lookup by server ID, @@ -1488,8 +1388,6 @@ Map of server IDs to MCPServerInfo > **getInMemoryServerInfos**(): [`MCPServerInfo`](../type-aliases/MCPServerInfo.md)[] -Defined in: [neurolink.ts:13721](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13721) - Get in-memory servers as an array of MCPServerInfo. This method is the canonical source for in-memory server filtering. @@ -1518,8 +1416,6 @@ Array of MCPServerInfo for in-memory servers > **getAutoDiscoveredServerInfos**(): [`MCPServerInfo`](../type-aliases/MCPServerInfo.md)[] -Defined in: [neurolink.ts:13737](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13737) - Get auto-discovered servers as MCPServerInfo - ZERO conversion needed ##### Returns @@ -1534,8 +1430,6 @@ Array of MCPServerInfo > **executeTool**\<`T`\>(`toolName`, `params?`, `options?`): `Promise`\<`T`\> -Defined in: [neurolink.ts:13749](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L13749) - Execute a specific tool by name with robust error handling Supports both custom tools and MCP server tools with timeout, retry, and circuit breaker patterns @@ -1625,8 +1519,6 @@ Tool execution result > **getAllAvailableTools**(): `Promise`\<[`ToolInfo`](../type-aliases/ToolInfo.md)[]\> -Defined in: [neurolink.ts:14849](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L14849) - ##### Returns `Promise`\<[`ToolInfo`](../type-aliases/ToolInfo.md)[]\> @@ -1637,8 +1529,6 @@ Defined in: [neurolink.ts:14849](https://github.com/juspay/neurolink/blob/releas > **getProviderStatus**(`options?`): `Promise`\<[`ProviderStatus`](../type-aliases/ProviderStatus.md)[]\> -Defined in: [neurolink.ts:15031](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15031) - Get comprehensive status of all AI providers Primary method for provider health checking and diagnostics @@ -1660,8 +1550,6 @@ Primary method for provider health checking and diagnostics > **testProvider**(`providerName`): `Promise`\<`boolean`\> -Defined in: [neurolink.ts:15234](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15234) - Test a specific AI provider's connectivity and authentication ##### Parameters @@ -1684,8 +1572,6 @@ Promise resolving to true if provider is working > **getBestProvider**(`requestedProvider?`): `Promise`\<`string`\> -Defined in: [neurolink.ts:15273](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15273) - Get the best available AI provider based on configuration and availability ##### Parameters @@ -1708,8 +1594,6 @@ Promise resolving to the best provider name > **getAvailableProviders**(): `Promise`\<`string`[]\> -Defined in: [neurolink.ts:15282](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15282) - Get list of all available AI provider names ##### Returns @@ -1724,8 +1608,6 @@ Array of supported provider names > **isValidProvider**(`providerName`): `Promise`\<`boolean`\> -Defined in: [neurolink.ts:15292](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15292) - Validate if a provider name is supported ##### Parameters @@ -1748,8 +1630,6 @@ True if provider name is valid > **getMCPStatus**(): `Promise`\<[`MCPStatus`](../type-aliases/MCPStatus.md)\> -Defined in: [neurolink.ts:15305](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15305) - Get comprehensive MCP (Model Context Protocol) status information ##### Returns @@ -1764,8 +1644,6 @@ Promise resolving to MCP status details > **listMCPServers**(): `Promise`\<[`MCPServerInfo`](../type-aliases/MCPServerInfo.md)[]\> -Defined in: [neurolink.ts:15375](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15375) - List all configured MCP servers with their status ##### Returns @@ -1780,8 +1658,6 @@ Promise resolving to array of MCP server information > **testMCPServer**(`serverId`): `Promise`\<`boolean`\> -Defined in: [neurolink.ts:15390](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15390) - Test connectivity to a specific MCP server ##### Parameters @@ -1804,8 +1680,6 @@ Promise resolving to true if server is reachable > **hasProviderEnvVars**(`providerName`): `Promise`\<`boolean`\> -Defined in: [neurolink.ts:15431](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15431) - Check if a provider has the required environment variables configured ##### Parameters @@ -1828,8 +1702,6 @@ Promise resolving to true if provider has required env vars > **checkProviderHealth**(`providerName`, `options?`): `Promise`\<\{ `provider`: `string`; `isHealthy`: `boolean`; `isConfigured`: `boolean`; `hasApiKey`: `boolean`; `lastChecked`: `Date`; `error?`: `string`; `warning?`: `string`; `responseTime?`: `number`; `configurationIssues`: `string`[]; `recommendations`: `string`[]; \}\> -Defined in: [neurolink.ts:15457](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15457) - Perform comprehensive health check on a specific provider ##### Parameters @@ -1872,8 +1744,6 @@ Promise resolving to detailed health status > **checkAllProvidersHealth**(`options?`): `Promise`\<`object`[]\> -Defined in: [neurolink.ts:15503](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15503) - Check health of all supported providers ##### Parameters @@ -1910,8 +1780,6 @@ Promise resolving to array of health statuses for all providers > **getProviderHealthSummary**(): `Promise`\<\{ `total`: `number`; `healthy`: `number`; `configured`: `number`; `hasIssues`: `number`; `healthyProviders`: `string`[]; `unhealthyProviders`: `string`[]; `recommendations`: `string`[]; \}\> -Defined in: [neurolink.ts:15547](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15547) - Get a summary of provider health across all supported providers ##### Returns @@ -1926,8 +1794,6 @@ Promise resolving to health summary statistics > **clearProviderHealthCache**(`providerName?`): `Promise`\<`void`\> -Defined in: [neurolink.ts:15594](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15594) - Clear provider health cache (useful for re-testing after configuration changes) ##### Parameters @@ -1948,8 +1814,6 @@ Optional specific provider to clear cache for > **getToolExecutionMetrics**(): `Record`\<`string`, \{ `totalExecutions`: `number`; `successfulExecutions`: `number`; `failedExecutions`: `number`; `successRate`: `number`; `averageExecutionTime`: `number`; `lastExecutionTime`: `number`; `errorCategories`: `Record`\<`string`, `number`\>; \}\> -Defined in: [neurolink.ts:15605](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15605) - Get execution metrics for all tools ##### Returns @@ -1964,8 +1828,6 @@ Object with execution metrics for each tool > **setModelAliasConfig**(`config`): `void` -Defined in: [neurolink.ts:15649](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15649) - NL-004: Set model alias/deprecation configuration. Models in the alias map will be warned, redirected, or blocked based on their action. @@ -1987,8 +1849,6 @@ Model alias configuration with aliases map > **getToolCircuitBreakerStatus**(): `Record`\<`string`, \{ `state`: `"closed"` \| `"open"` \| `"half-open"`; `failureCount`: `number`; `isHealthy`: `boolean`; \}\> -Defined in: [neurolink.ts:15662](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15662) - Get circuit breaker status for all tools ##### Returns @@ -2003,8 +1863,6 @@ Object with circuit breaker status for each tool > **resetToolCircuitBreaker**(`toolName`): `void` -Defined in: [neurolink.ts:15697](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15697) - Reset circuit breaker for a specific tool ##### Parameters @@ -2025,8 +1883,6 @@ Name of the tool to reset circuit breaker for > **clearToolExecutionMetrics**(): `void` -Defined in: [neurolink.ts:15714](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15714) - Clear all tool execution metrics ##### Returns @@ -2039,8 +1895,6 @@ Clear all tool execution metrics > **getToolHealthReport**(): `Promise`\<\{ `totalTools`: `number`; `healthyTools`: `number`; `unhealthyTools`: `number`; `tools`: `Record`\<`string`, \{ `name`: `string`; `isHealthy`: `boolean`; `metrics`: \{ `totalExecutions`: `number`; `successRate`: `number`; `averageExecutionTime`: `number`; `lastExecutionTime`: `number`; `errorCategories`: `Record`\<`string`, `number`\>; \}; `circuitBreaker`: \{ `state`: `"closed"` \| `"open"` \| `"half-open"`; `failureCount`: `number`; \}; `issues`: `string`[]; `recommendations`: `string`[]; \}\>; \}\> -Defined in: [neurolink.ts:15723](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15723) - Get comprehensive tool health report ##### Returns @@ -2055,8 +1909,6 @@ Detailed health report for all tools > **ensureConversationMemoryInitialized**(): `Promise`\<`boolean`\> -Defined in: [neurolink.ts:15878](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15878) - Initialize conversation memory if enabled (public method for explicit initialization) This is useful for testing or when you want to ensure conversation memory is ready @@ -2072,8 +1924,6 @@ Promise resolving to true if initialization was successful, false otherwise > **getConversationStats**(): `Promise`\<[`ConversationMemoryStats`](../type-aliases/ConversationMemoryStats.md)\> -Defined in: [neurolink.ts:15898](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15898) - Get conversation memory statistics (public API) ##### Returns @@ -2086,8 +1936,6 @@ Get conversation memory statistics (public API) > **getConversationHistory**(`sessionId`): `Promise`\<[`ChatMessage`](../type-aliases/ChatMessage.md)[]\> -Defined in: [neurolink.ts:15925](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15925) - Get complete conversation history for a specific session (public API) ##### Parameters @@ -2110,8 +1958,6 @@ Array of ChatMessage objects in chronological order, or empty array if session d > **clearConversationSession**(`sessionId`): `Promise`\<`boolean`\> -Defined in: [neurolink.ts:15981](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L15981) - Clear conversation history for a specific session (public API) ##### Parameters @@ -2130,8 +1976,6 @@ Clear conversation history for a specific session (public API) > **clearAllConversations**(): `Promise`\<`void`\> -Defined in: [neurolink.ts:16007](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16007) - Clear all conversation history (public API) ##### Returns @@ -2144,8 +1988,6 @@ Clear all conversation history (public API) > **listSessions**(`userId?`): `Promise`\<[`SessionListItem`](../type-aliases/SessionListItem.md)[]\> -Defined in: [neurolink.ts:16035](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16035) - List all conversation sessions with metadata (public API) ##### Parameters @@ -2168,8 +2010,6 @@ Array of session list items with metadata > **exportSession**(`sessionId`, `options?`): `Promise`\<[`SessionExport`](../type-aliases/SessionExport.md) \| `null`\> -Defined in: [neurolink.ts:16084](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16084) - Export a single session with full history and metadata (public API) ##### Parameters @@ -2204,8 +2044,6 @@ Session export object with full history > **exportAllSessions**(`userId?`, `options?`): `Promise`\<[`SessionExport`](../type-aliases/SessionExport.md)[]\> -Defined in: [neurolink.ts:16169](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16169) - Export all sessions for a user (public API) ##### Parameters @@ -2240,8 +2078,6 @@ Array of session exports > **storeToolExecutions**(`sessionId`, `userId`, `toolCalls`, `toolResults`, `currentTime?`): `Promise`\<`void`\> -Defined in: [neurolink.ts:16233](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16233) - Store tool executions in conversation memory if enabled and Redis is configured ##### Parameters @@ -2288,8 +2124,6 @@ Promise resolving when storage is complete > **isToolExecutionStorageAvailable**(): `boolean` -Defined in: [neurolink.ts:16303](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16303) - Check if tool execution storage is available. Now capability-based rather than Redis-specific: any configured memory @@ -2309,8 +2143,6 @@ whether the active memory backend can persist tool executions > **getSessionMessages**(`sessionId`, `userId?`): `Promise`\<[`ChatMessage`](../type-aliases/ChatMessage.md)[]\> -Defined in: [neurolink.ts:16313](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16313) - Get the raw messages array for a session. Returns the full messages list without context filtering or summarization. @@ -2338,8 +2170,6 @@ Array of ChatMessage objects, or empty array if session doesn't exist > **setSessionMessages**(`sessionId`, `messages`, `userId?`): `Promise`\<`void`\> -Defined in: [neurolink.ts:16354](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16354) - Replace the entire messages array for a session. ##### Parameters @@ -2372,8 +2202,6 @@ Optional user ID for scoped Redis key lookup > **modifyLastAssistantMessage**(`sessionId`, `transformer`, `userId?`): `Promise`\<`boolean`\> -Defined in: [neurolink.ts:16402](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16402) - Modify the last assistant message in a session using a transformer function. Convenience wrapper around getSessionMessages/setSessionMessages. @@ -2409,8 +2237,6 @@ true if a message was modified, false if no assistant message was found > **addExternalMCPServer**(`serverId`, `config`): `Promise`\<[`ExternalMCPOperationResult`](../type-aliases/ExternalMCPOperationResult.md)\<[`ExternalMCPServerInstance`](../type-aliases/ExternalMCPServerInstance.md)\>\> -Defined in: [neurolink.ts:16433](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16433) - Add an external MCP server Automatically discovers and registers tools from the server @@ -2440,8 +2266,6 @@ Operation result with server instance > **removeExternalMCPServer**(`serverId`): `Promise`\<[`ExternalMCPOperationResult`](../type-aliases/ExternalMCPOperationResult.md)\<`void`\>\> -Defined in: [neurolink.ts:16520](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16520) - Remove an external MCP server Stops the server and removes all its tools @@ -2465,8 +2289,6 @@ Operation result > **listExternalMCPServers**(): `object`[] -Defined in: [neurolink.ts:16572](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16572) - List all external MCP servers ##### Returns @@ -2481,8 +2303,6 @@ Array of server health information > **getExternalMCPServer**(`serverId`): [`ExternalMCPServerInstance`](../type-aliases/ExternalMCPServerInstance.md) \| `undefined` -Defined in: [neurolink.ts:16601](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16601) - Get external MCP server status ##### Parameters @@ -2505,8 +2325,6 @@ Server instance or undefined if not found > **executeExternalMCPTool**(`serverId`, `requestedToolName`, `parameters`, `options?`): `Promise`\<`unknown`\> -Defined in: [neurolink.ts:16615](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16615) - Execute a tool from an external MCP server ##### Parameters @@ -2547,8 +2365,6 @@ Tool execution result > **getExternalMCPTools**(): [`ExternalMCPToolInfo`](../type-aliases/ExternalMCPToolInfo.md)[] -Defined in: [neurolink.ts:16814](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16814) - Get all tools from external MCP servers ##### Returns @@ -2563,8 +2379,6 @@ Array of external tool information > **getExternalMCPServerTools**(`serverId`): [`ExternalMCPToolInfo`](../type-aliases/ExternalMCPToolInfo.md)[] -Defined in: [neurolink.ts:16823](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16823) - Get tools from a specific external MCP server ##### Parameters @@ -2587,8 +2401,6 @@ Array of tool information for the server > **testExternalMCPConnection**(`config`): `Promise`\<[`BatchOperationResult`](../type-aliases/BatchOperationResult.md)\> -Defined in: [neurolink.ts:16832](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16832) - Test connection to an external MCP server ##### Parameters @@ -2611,8 +2423,6 @@ Test result with connection status > **getExternalMCPStatistics**(): `object` -Defined in: [neurolink.ts:16860](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16860) - Get external MCP server manager statistics ##### Returns @@ -2651,8 +2461,6 @@ Statistics about external servers and tools > **shutdownExternalMCPServers**(): `Promise`\<`void`\> -Defined in: [neurolink.ts:16875](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16875) - Shutdown all external MCP servers Called automatically on process exit @@ -2666,8 +2474,6 @@ Called automatically on process exit > **getElicitationManager**(): `Promise`\<`any`\> -Defined in: [neurolink.ts:16913](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16913) - Get the global elicitation manager for interactive tool input Elicitation allows tools to request additional information from users during execution @@ -2697,8 +2503,6 @@ elicitationManager.registerHandler(async (request) => { > **registerElicitationHandler**(`handler`): `Promise`\<`void`\> -Defined in: [neurolink.ts:16941](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16941) - Register an elicitation handler for interactive tool input Handlers are called when tools need user input during execution @@ -2735,8 +2539,6 @@ neurolink.registerElicitationHandler(async (request) => { > **getMultiServerManager**(): `Promise`\<`any`\> -Defined in: [neurolink.ts:16964](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16964) - Get the multi-server manager for load balancing and coordination Allows managing multiple MCP servers with failover and load balancing @@ -2764,8 +2566,6 @@ await multiServer.createServerGroup("ai-tools", { > **getEnhancedToolDiscovery**(): `Promise`\<`any`\> -Defined in: [neurolink.ts:16989](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L16989) - Get the enhanced tool discovery service Provides advanced search, filtering, and compatibility checking for tools @@ -2794,8 +2594,6 @@ const results = await discovery.searchTools({ > **getMCPRegistryClient**(): `Promise`\<`any`\> -Defined in: [neurolink.ts:17016](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17016) - Get the MCP registry client for discovering servers from registries Supports multiple registry sources (official, community, custom) @@ -2826,8 +2624,6 @@ const githubServer = registryClient.getWellKnownServer("github"); > **exposeAgentAsTool**(`agent`, `options?`): `Promise`\<[`ExposureResult`](../type-aliases/ExposureResult.md)\> -Defined in: [neurolink.ts:17044](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17044) - Expose a NeuroLink agent as an MCP tool This allows agents to be called by other systems via MCP @@ -2903,8 +2699,6 @@ const tool = await neurolink.exposeAgentAsTool(agent, { > **exposeWorkflowAsTool**(`workflow`, `options?`): `Promise`\<[`ExposureResult`](../type-aliases/ExposureResult.md)\> -Defined in: [neurolink.ts:17085](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17085) - Expose a workflow as an MCP tool This allows workflows to be called by other systems via MCP @@ -2984,8 +2778,6 @@ const tool = await neurolink.exposeWorkflowAsTool(workflow, { > **getToolIntegrationManager**(): `Promise`\<`any`\> -Defined in: [neurolink.ts:17124](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17124) - Get the tool integration manager for middleware and elicitation Provides advanced tool wrapping with confirmation, timeout, retry, etc. @@ -3014,8 +2806,6 @@ integration.registerTool(myTool, { > **convertToolsToMCPFormat**(`tools`, `options?`): `Promise`\<`any`\> -Defined in: [neurolink.ts:17146](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17146) - Convert NeuroLink tools to MCP format Useful for exposing local tools to external MCP clients @@ -3055,8 +2845,6 @@ const mcpTools = neurolink.convertToolsToMCPFormat([ > **convertToolsFromMCPFormat**(`tools`, `options?`): `Promise`\<`any`\> -Defined in: [neurolink.ts:17185](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17185) - Convert MCP tools to NeuroLink format Useful for importing tools from external MCP servers @@ -3096,8 +2884,6 @@ const neurolinkTools = neurolink.convertToolsFromMCPFormat(externalTools, { > **getToolAnnotations**(`toolName`): `Promise`\<\{ `annotations`: [`MCPToolAnnotations`](../type-aliases/MCPToolAnnotations.md); `summary`: `string`; \} \| `null`\> -Defined in: [neurolink.ts:17208](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17208) - Get tool annotations and safety information Provides insights about tool behavior, safety levels, and retry-ability @@ -3128,8 +2914,6 @@ const annotations = await neurolink.getToolAnnotations("deleteFile"); > **createEvaluationPipeline**(`configOrPreset`): `Promise`\<[`EvaluationPipeline`](EvaluationPipeline.md)\> -Defined in: [neurolink.ts:17447](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17447) - Create an evaluation pipeline with the specified configuration or preset. Pipelines orchestrate multiple scorers to evaluate AI responses comprehensively. @@ -3179,8 +2963,6 @@ const pipeline = await neurolink.createEvaluationPipeline({ > **decide**(`options`): `Promise`\<[`DecisionResult`](../type-aliases/DecisionResult.md)\> -Defined in: [neurolink.ts:17529](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17529) - Run the `decide` inference type: evaluate a `state` against a batch of named, typed questions and get one typed answer each. @@ -3237,8 +3019,6 @@ when no decision provider is configured, or the call fails > **tryDecide**(`options`): `Promise`\<[`DecisionResult`](../type-aliases/DecisionResult.md) \| `null`\> -Defined in: [neurolink.ts:17678](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17678) - Fail-open [NeuroLink.decide](#decide): returns null on any failure instead of throwing. @@ -3263,8 +3043,6 @@ did before the decision was available. > **evaluate**(`input`, `options?`): `Promise`\<[`PipelineResult`](../type-aliases/PipelineResult.md)\> -Defined in: [neurolink.ts:17748](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17748) - Evaluate an AI response using the specified pipeline or scorers. This is a convenience method that creates a pipeline and executes it in one call. @@ -3365,8 +3143,6 @@ const result = await neurolink.evaluate( > **score**(`scorerId`, `input`, `config?`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [neurolink.ts:17886](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17886) - Score a response using a single scorer. Useful for quick, targeted evaluations without the overhead of a full pipeline. @@ -3434,8 +3210,6 @@ const result = await neurolink.score( > **getAvailableScorers**(`options?`): `Promise`\<[`ScorerMetadata`](../type-aliases/ScorerMetadata.md)[]\> -Defined in: [neurolink.ts:17972](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L17972) - Get a list of all available scorers and their metadata. Useful for discovering what evaluation capabilities are available. @@ -3495,8 +3269,6 @@ const ruleBasedScorers = await neurolink.getAvailableScorers({ > **getEvaluationPresets**(): `Promise`\<`string`[]\> -Defined in: [neurolink.ts:18018](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18018) - Get a list of available evaluation pipeline presets. Presets are pre-configured pipelines for common evaluation scenarios. @@ -3521,8 +3293,6 @@ console.log("Available presets:", presets); > **getEvaluationPreset**(`presetName`): `Promise`\<[`PipelineConfig`](../type-aliases/PipelineConfig.md)\> -Defined in: [neurolink.ts:18041](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18041) - Get details of a specific evaluation preset. ##### Parameters @@ -3557,8 +3327,6 @@ console.log("Pass threshold:", ragPreset.passThreshold); > **createAgent**(`definition`): `Promise`\<[`Agent`](Agent.md)\> -Defined in: [neurolink.ts:18091](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18091) - Create an Agent instance for multi-agent orchestration. Agents are specialized AI entities with defined instructions, tools, and behavior. @@ -3609,8 +3377,6 @@ const result = await researcher.execute("Find recent AI breakthroughs"); > **createNetwork**(`config`): `Promise`\<[`AgentNetwork`](AgentNetwork.md)\> -Defined in: [neurolink.ts:18153](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18153) - Create an AgentNetwork for multi-agent orchestration. Networks coordinate multiple agents, workflows, and tools with intelligent @@ -3683,8 +3449,6 @@ const result = await network.execute({ > **createWorkerInstance**(`options?`): `NeuroLink` -Defined in: [neurolink.ts:18185](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18185) - Create a worker-mode NeuroLink instance for sub-agent execution. Worker mode is the framework-provided version of the config block every @@ -3723,8 +3487,6 @@ A new worker-mode NeuroLink instance > **runIsolatedAgent**(`definition`, `input`, `options?`): `Promise`\<[`AgentRunOutcome`](../type-aliases/AgentRunOutcome.md)\> -Defined in: [neurolink.ts:18289](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18289) - Run an isolated sub-agent: a worker instance (see [createWorkerInstance](#createworkerinstance)) executes a tool-using research pass under the turn budget (wrap-up nudge, stall watchdog, honest `stopReason`), @@ -3773,8 +3535,6 @@ The run outcome > **continueAgent**(`handle`, `guidance?`): `Promise`\<[`AgentRunOutcome`](../type-aliases/AgentRunOutcome.md)\> -Defined in: [neurolink.ts:18308](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18308) - Resume a leashed isolated-agent run by handle. `guidance`, when given, is appended as a user turn before the next leg — the supervisor's re-steering channel. An expired handle returns its tombstoned final @@ -3806,8 +3566,6 @@ The next leg's outcome (or the final outcome) > **stopAgent**(`handle`): `Promise`\<[`AgentRunOutcome`](../type-aliases/AgentRunOutcome.md)\> -Defined in: [neurolink.ts:18324](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18324) - Stop a leashed isolated-agent run: dispose its worker and return the final outcome (mechanical digest over everything gathered so far). @@ -3831,8 +3589,6 @@ The final outcome > **registerAgentTool**(`definition`, `options?`): `Promise`\<\{ `name`: `string`; \}\> -Defined in: [neurolink.ts:18342](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18342) - Register an isolated agent as a delegation tool on THIS instance, so its existing generate() loop can delegate — no second router generate. Framework policy (per-turn caps, depth withholding, a process-wide @@ -3869,8 +3625,6 @@ The registered tool name > **registerTaskTools**(): `void` -Defined in: [neurolink.ts:18375](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18375) - Register the task CHECKLIST toolset — `tasks_create`, `tasks_update`, `tasks_list` — on this instance (TodoWrite-style planning for a long-running run). Opt-in and idempotent: existing callers see no new @@ -3905,8 +3659,6 @@ id for that one call. > **getTaskState**(`sessionId?`): [`ChecklistState`](../type-aliases/ChecklistState.md) -Defined in: [neurolink.ts:18401](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18401) - Read a session's task checklist — synchronous, so a completeness gate is one line of host code: `getTaskState(id).items.filter(i => i.status === "pending")`. @@ -3931,8 +3683,6 @@ instance's tool-context session, or its default checklist). > **clearTaskState**(`sessionId?`): `boolean` -Defined in: [neurolink.ts:18409](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18409) - Drop a session's checklist. Returns whether there was one to drop. Omit `sessionId` to clear the session the tools currently write to. @@ -3952,8 +3702,6 @@ Omit `sessionId` to clear the session the tools currently write to. > **registerDelegationTools**(`options?`): `void` -Defined in: [neurolink.ts:18436](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18436) - Register the background-delegation toolset — `delegate_task` and `collect_results` — on this instance. Opt-in and idempotent: existing callers see no new tools until they ask for them. @@ -3991,8 +3739,6 @@ Depth ceiling, pool raise, and queue wait > **spawnDelegate**(`options`): `Promise`\<[`DelegateHandle`](../type-aliases/DelegateHandle.md)\> -Defined in: [neurolink.ts:18476](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18476) - Start a background worker and get its handle immediately — before it has run anything, and long before it finishes. @@ -4035,8 +3781,6 @@ when the task is empty or the caller is at the depth ceiling > **collectDelegates**(`request`): `Promise`\<[`DelegateCollectResult`](../type-aliases/DelegateCollectResult.md)\> -Defined in: [neurolink.ts:18487](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18487) - Claim finished background workers — in COMPLETION order, which has nothing to do with spawn order. Each outcome is handed out exactly once. @@ -4060,8 +3804,6 @@ Claimed outcomes plus what is still pending/ready > **cancelDelegates**(`workerId?`): `Promise`\<`number`\> -Defined in: [neurolink.ts:18501](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18501) - Cancel background workers: one by id, or every outstanding worker this instance spawned. Cancelled workers still settle into a claimable outcome saying so. @@ -4086,8 +3828,6 @@ How many workers were cancelled > **getArtifactStore**(): [`ArtifactStore`](../type-aliases/ArtifactStore.md) -Defined in: [neurolink.ts:18524](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18524) - This instance's artifact store, created on first use. Until now a store existed only when `mcp.outputLimits.strategy` was set to @@ -4112,8 +3852,6 @@ The artifact store backing [bankArtifact](#bankartifact) / [readArtifact](#reada > **setArtifactStore**(`store`): `void` -Defined in: [neurolink.ts:18554](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18554) - Replace this instance's artifact store. Everything that writes or reads artifacts follows the swap: banking, @@ -4150,8 +3888,6 @@ Any [ArtifactStore](../type-aliases/ArtifactStore.md) > **bankArtifact**(`payload`, `options`): `Promise`\<[`BankedArtifactRef`](../type-aliases/BankedArtifactRef.md)\> -Defined in: [neurolink.ts:18642](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18642) - Bank a payload to a file and get back a pointer to it. The payload is stored WHOLE. What you put in the conversation is the @@ -4197,8 +3933,6 @@ const ref = await neurolink.bankArtifact(fullReport, { > **readArtifact**(`id`, `page?`): `Promise`\<`string` \| `null`\> -Defined in: [neurolink.ts:18659](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18659) - Read a banked payload back from host code — the programmatic twin of the model's `retrieve_context({ artifactId })` call. @@ -4229,8 +3963,6 @@ Optional character window > **registerBackgroundCommandTools**(`policy`): `void` -Defined in: [neurolink.ts:18691](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18691) - Register the background-command toolset — `run_command_bg`, `command_status`, `command_output`, `command_kill` — on this instance, and declare what may be executed. Opt-in and idempotent: existing callers see @@ -4270,8 +4002,6 @@ What may run, where, for how long, and how loudly > **setBackgroundCommandPolicy**(`policy`): `void` -Defined in: [neurolink.ts:18716](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18716) - Declare (or replace) what this instance may execute, without registering the model-facing tools. Host code that only drives [startBackgroundCommand](#startbackgroundcommand) itself needs nothing more than this. @@ -4294,8 +4024,6 @@ What may run, where, for how long, and how loudly > **startBackgroundCommand**(`argv`, `options`): `Promise`\<[`BackgroundCommandHandle`](../type-aliases/BackgroundCommandHandle.md)\> -Defined in: [neurolink.ts:18740](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18740) - Start a command in the background and get its task id immediately. ##### Parameters @@ -4341,8 +4069,6 @@ allowlisted, the policy vetoes it, or the cwd escapes the sandbox > **getBackgroundCommandStatus**(`taskId`): [`BackgroundCommandStatus`](../type-aliases/BackgroundCommandStatus.md) -Defined in: [neurolink.ts:18754](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18754) - Everything known about one command right now — synchronous, so a mid-loop monitor costs nothing. @@ -4368,8 +4094,6 @@ when the task id is unknown to this instance > **awaitBackgroundCommand**(`taskId`, `opts?`): `Promise`\<[`BackgroundCommandStatus`](../type-aliases/BackgroundCommandStatus.md)\> -Defined in: [neurolink.ts:18766](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18766) - Wait for a command to settle. `timeoutMs` bounds the WAIT, not the command: when it elapses the current status is returned rather than thrown, so a caller can poll in bounded steps and never lose the job. @@ -4400,8 +4124,6 @@ Task id from [startBackgroundCommand](#startbackgroundcommand) > **killBackgroundCommand**(`taskId`, `signal?`): `Promise`\<[`BackgroundCommandStatus`](../type-aliases/BackgroundCommandStatus.md)\> -Defined in: [neurolink.ts:18781](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18781) - Kill a running command — SIGTERM, then SIGKILL five seconds later — and resolve with its settled status. Whatever it printed first is still banked: killing a command discards the process, never its output. @@ -4430,8 +4152,6 @@ Signal to send first. Default SIGTERM > **readBackgroundCommandOutput**(`taskId`, `page`): `Promise`\<[`BackgroundCommandOutputPage`](../type-aliases/BackgroundCommandOutputPage.md)\> -Defined in: [neurolink.ts:18796](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18796) - Read one character window of a command's output straight from its log file — while it is still running, or long after it finished. Offsets, `totalSize` and `hasMore` match `retrieve_context` exactly. @@ -4460,8 +4180,6 @@ Which stream, and which window of it > **registerGitTools**(`options`): `void` -Defined in: [neurolink.ts:18823](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18823) - Register the read-only git toolset — `git_log`, `git_show`, `git_diff`, `git_blame`, `git_merge_base`, `git_ls_files` — on this instance. Opt-in and idempotent. @@ -4493,8 +4211,6 @@ Repository root, plus timeout / byte-cap / preview bounds > **runGitCommand**(`args`, `sessionId?`): `Promise`\<[`GitToolResult`](../type-aliases/GitToolResult.md)\> -Defined in: [neurolink.ts:18849](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18849) - Run one read-only git command from host code, with the same bounding the tools get: the complete stdout is banked, the result carries a preview and the read-back call. @@ -4528,8 +4244,6 @@ when [registerGitTools](#registergittools) has not been called > **executeNetwork**(`network`, `input`, `options?`): `Promise`\<[`NetworkExecutionResult`](../type-aliases/NetworkExecutionResult.md)\> -Defined in: [neurolink.ts:18868](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18868) - Execute an agent network with the given input. ##### Parameters @@ -4573,8 +4287,6 @@ Network execution result with content, trace, and usage > **streamNetwork**(`network`, `input`, `options?`): `AsyncIterable`\<[`NetworkStreamChunk`](../type-aliases/NetworkStreamChunk.md)\> -Defined in: [neurolink.ts:18892](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18892) - Stream agent network execution with real-time events. ##### Parameters @@ -4617,8 +4329,6 @@ Async iterable of network stream chunks > **createOrchestrator**(`config?`): `Promise`\<[`NetworkOrchestrator`](NetworkOrchestrator.md)\> -Defined in: [neurolink.ts:18916](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18916) - Create a NetworkOrchestrator for managing multiple agent networks. ##### Parameters @@ -4645,8 +4355,6 @@ A new NetworkOrchestrator instance > **createCoordinator**(`config?`): `Promise`\<[`AgentCoordinator`](AgentCoordinator.md)\> -Defined in: [neurolink.ts:18935](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18935) - Create an AgentCoordinator for managing agent coordination strategies. ##### Parameters @@ -4673,8 +4381,6 @@ A new AgentCoordinator instance > **createMessageBus**(`config?`): `Promise`\<[`MessageBus`](MessageBus.md)\> -Defined in: [neurolink.ts:18953](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18953) - Create a MessageBus for inter-agent communication. ##### Parameters @@ -4701,8 +4407,6 @@ A new MessageBus instance > **dispose**(): `Promise`\<`void`\> -Defined in: [neurolink.ts:18968](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L18968) - Dispose of all resources and cleanup connections Call this method when done using the NeuroLink instance to prevent resource leaks Especially important in test environments where multiple instances are created @@ -4717,8 +4421,6 @@ Especially important in test environments where multiple instances are created > **getToolRegistry**(): [`MCPToolRegistry`](MCPToolRegistry.md) -Defined in: [neurolink.ts:19187](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19187) - Get the tool registry instance Used internally by server adapters for tool management @@ -4734,8 +4436,6 @@ The MCPToolRegistry instance > **compactSession**(`sessionId`, `config?`): `Promise`\<[`CompactionResult`](../type-aliases/CompactionResult.md) \| `null`\> -Defined in: [neurolink.ts:19195](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19195) - Manually trigger context compaction for a session. Runs the full 4-stage compaction pipeline. @@ -4759,8 +4459,6 @@ Runs the full 4-stage compaction pipeline. > **getContextStats**(`sessionId`, `provider?`, `model?`): `Promise`\<\{ `estimatedInputTokens`: `number`; `availableInputTokens`: `number`; `usageRatio`: `number`; `shouldCompact`: `boolean`; `messageCount`: `number`; \} \| `null`\> -Defined in: [neurolink.ts:19249](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19249) - Get context usage statistics for a session. Returns token counts, usage ratio, and breakdown by category. @@ -4788,8 +4486,6 @@ Returns token counts, usage ratio, and breakdown by category. > **needsCompaction**(`sessionId`, `provider?`, `model?`): `boolean` -Defined in: [neurolink.ts:19291](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19291) - Check if a session needs compaction. ##### Parameters @@ -4816,8 +4512,6 @@ Check if a session needs compaction. > **setAuthProvider**(`config`): `Promise`\<`void`\> -Defined in: [neurolink.ts:19328](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19328) - Set the authentication provider for the NeuroLink instance ##### Parameters @@ -4838,8 +4532,6 @@ Auth provider or configuration to create one > **getAuthProvider**(): [`AuthProvider`](../type-aliases/AuthProvider.md) \| `undefined` -Defined in: [neurolink.ts:19376](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19376) - Get the currently configured authentication provider ##### Returns @@ -4852,8 +4544,6 @@ Get the currently configured authentication provider > **setAuthContext**(`context`): `Promise`\<`void`\> -Defined in: [neurolink.ts:19417](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19417) - Set the current authentication context for request handling. Delegates to the global AuthContextHolder so that auth state is NOT @@ -4879,8 +4569,6 @@ The authenticated user context > **getAuthContext**(): `Promise`\<[`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md) \| `undefined`\> -Defined in: [neurolink.ts:19432](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19432) - Get the current authentication context. Checks AsyncLocalStorage first, then falls back to the global holder. @@ -4895,8 +4583,6 @@ Checks AsyncLocalStorage first, then falls back to the global holder. > **clearAuthContext**(): `Promise`\<`void`\> -Defined in: [neurolink.ts:19440](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19440) - Clear the current authentication context ##### Returns @@ -4909,8 +4595,6 @@ Clear the current authentication context > **getExternalServerManager**(): [`ExternalServerManager`](ExternalServerManager.md) -Defined in: [neurolink.ts:19454](https://github.com/juspay/neurolink/blob/release/src/lib/neurolink.ts#L19454) - Get the external server manager instance Used internally by server adapters for external MCP server management diff --git a/docs/api/classes/NeuroLinkAIProvider.md b/docs/api/classes/NeuroLinkAIProvider.md index c330fc661..e367bcf5f 100644 --- a/docs/api/classes/NeuroLinkAIProvider.md +++ b/docs/api/classes/NeuroLinkAIProvider.md @@ -6,8 +6,6 @@ # Class: NeuroLinkAIProvider -Defined in: [client/aiSdkAdapter.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L318) - NeuroLink Provider for Vercel AI SDK Creates model instances that are compatible with the Vercel AI SDK. @@ -38,8 +36,6 @@ const result = await generateText({ > **new NeuroLinkAIProvider**(`options`): `NeuroLinkProvider` -Defined in: [client/aiSdkAdapter.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L323) - #### Parameters ##### options @@ -56,8 +52,6 @@ Defined in: [client/aiSdkAdapter.ts:323](https://github.com/juspay/neurolink/blo > **model**(`modelId?`, `options?`): [`NeuroLinkLanguageModel`](NeuroLinkLanguageModel.md) -Defined in: [client/aiSdkAdapter.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L340) - Create a language model instance #### Parameters @@ -84,8 +78,6 @@ Additional model options > **call**(`modelId?`, `options?`): [`NeuroLinkLanguageModel`](NeuroLinkLanguageModel.md) -Defined in: [client/aiSdkAdapter.ts:353](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L353) - Alias for model() - makes the provider callable #### Parameters @@ -108,8 +100,6 @@ Alias for model() - makes the provider callable > **getClient**(): [`NeuroLinkClient`](NeuroLinkClient.md) -Defined in: [client/aiSdkAdapter.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L385) - Get the underlying client #### Returns diff --git a/docs/api/classes/NeuroLinkApiError.md b/docs/api/classes/NeuroLinkApiError.md index 53eb8da9e..5654a8d46 100644 --- a/docs/api/classes/NeuroLinkApiError.md +++ b/docs/api/classes/NeuroLinkApiError.md @@ -6,8 +6,6 @@ # Class: NeuroLinkApiError -Defined in: [client/errors.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L144) - Error for HTTP-related failures ## Extends @@ -28,8 +26,6 @@ Error for HTTP-related failures > **new NeuroLinkApiError**(`message`, `status`, `options?`): `HttpError` -Defined in: [client/errors.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L150) - #### Parameters ##### message @@ -76,8 +72,6 @@ Defined in: [client/errors.ts:150](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -90,8 +84,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -104,8 +96,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -118,8 +108,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -132,8 +120,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -146,8 +132,6 @@ Request ID for error tracking > `readonly` `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [client/errors.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L146) - HTTP response headers --- @@ -156,8 +140,6 @@ HTTP response headers > `readonly` `optional` **body?**: `unknown` -Defined in: [client/errors.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L148) - HTTP response body ## Methods @@ -166,8 +148,6 @@ HTTP response body > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -184,8 +164,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/NeuroLinkClient.md b/docs/api/classes/NeuroLinkClient.md index e705b032c..4a1509aac 100644 --- a/docs/api/classes/NeuroLinkClient.md +++ b/docs/api/classes/NeuroLinkClient.md @@ -6,8 +6,6 @@ # Class: NeuroLinkClient -Defined in: [client/httpClient.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L137) - HTTP Client for NeuroLink API Provides type-safe access to all NeuroLink API endpoints with @@ -46,8 +44,6 @@ client.use(async (request, next) => { > **new NeuroLinkClient**(`config`): `NeuroLinkClient` -Defined in: [client/httpClient.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L145) - #### Parameters ##### config @@ -64,8 +60,6 @@ Defined in: [client/httpClient.ts:145](https://github.com/juspay/neurolink/blob/ > **use**(`middleware`): `this` -Defined in: [client/httpClient.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L188) - Add middleware to the client #### Parameters @@ -88,8 +82,6 @@ Client instance for chaining > **clearMiddleware**(): `this` -Defined in: [client/httpClient.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L196) - Clear all middleware #### Returns @@ -102,8 +94,6 @@ Clear all middleware > **generate**(`options`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientGenerateResponse`](../type-aliases/ClientGenerateResponse.md)\>\> -Defined in: [client/httpClient.ts:485](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L485) - Generate text using AI models #### Parameters @@ -138,8 +128,6 @@ console.log(response.data.content); > **stream**(`options`, `callbacks?`, `requestOptions?`): `Promise`\<[`ClientStreamResult`](../type-aliases/ClientStreamResult.md)\> -Defined in: [client/httpClient.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L506) - Stream text generation #### Parameters @@ -178,8 +166,6 @@ await client.stream( > **executeAgent**(`options`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientAgentExecuteResult`](../type-aliases/ClientAgentExecuteResult.md)\>\> -Defined in: [client/httpClient.ts:686](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L686) - Execute an agent #### Parameters @@ -213,8 +199,6 @@ console.log(result.data.content); > **streamAgent**(`options`, `callbacks?`, `requestOptions?`): `Promise`\<[`ClientStreamResult`](../type-aliases/ClientStreamResult.md)\> -Defined in: [client/httpClient.ts:701](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L701) - Stream agent execution #### Parameters @@ -241,8 +225,6 @@ Stream agent execution > **listAgents**(`requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientAgentInfo`](../type-aliases/ClientAgentInfo.md)[]\>\> -Defined in: [client/httpClient.ts:720](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L720) - List available agents #### Parameters @@ -261,8 +243,6 @@ List available agents > **getAgent**(`agentId`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientAgentInfo`](../type-aliases/ClientAgentInfo.md)\>\> -Defined in: [client/httpClient.ts:729](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L729) - Get agent details #### Parameters @@ -285,8 +265,6 @@ Get agent details > **executeWorkflow**(`options`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientWorkflowExecuteResult`](../type-aliases/ClientWorkflowExecuteResult.md)\>\> -Defined in: [client/httpClient.ts:764](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L764) - Execute a workflow #### Parameters @@ -326,8 +304,6 @@ if (result.data.status === 'running') { > **resumeWorkflow**(`workflowId`, `resumeToken`, `resumeData?`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientWorkflowExecuteResult`](../type-aliases/ClientWorkflowExecuteResult.md)\>\> -Defined in: [client/httpClient.ts:779](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L779) - Resume a suspended workflow #### Parameters @@ -358,8 +334,6 @@ Resume a suspended workflow > **getWorkflowStatus**(`workflowId`, `runId`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientWorkflowExecuteResult`](../type-aliases/ClientWorkflowExecuteResult.md)\>\> -Defined in: [client/httpClient.ts:796](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L796) - Get workflow execution status #### Parameters @@ -386,8 +360,6 @@ Get workflow execution status > **cancelWorkflow**(`workflowId`, `runId`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<\{ `success`: `boolean`; \}\>\> -Defined in: [client/httpClient.ts:812](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L812) - Cancel workflow execution #### Parameters @@ -414,8 +386,6 @@ Cancel workflow execution > **listWorkflows**(`requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientWorkflowInfo`](../type-aliases/ClientWorkflowInfo.md)[]\>\> -Defined in: [client/httpClient.ts:828](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L828) - List available workflows #### Parameters @@ -434,8 +404,6 @@ List available workflows > **getWorkflow**(`workflowId`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientWorkflowInfo`](../type-aliases/ClientWorkflowInfo.md)\>\> -Defined in: [client/httpClient.ts:837](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L837) - Get workflow details #### Parameters @@ -458,8 +426,6 @@ Get workflow details > **listTools**(`options?`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientToolInfo`](../type-aliases/ClientToolInfo.md)[]\>\> -Defined in: [client/httpClient.ts:862](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L862) - List available tools #### Parameters @@ -495,8 +461,6 @@ console.log(tools.data); > **executeTool**(`toolName`, `params`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<`unknown`\>\> -Defined in: [client/httpClient.ts:886](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L886) - Execute a tool #### Parameters @@ -523,8 +487,6 @@ Execute a tool > **getTool**(`toolName`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientToolInfo`](../type-aliases/ClientToolInfo.md)\>\> -Defined in: [client/httpClient.ts:902](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L902) - Get tool details #### Parameters @@ -547,8 +509,6 @@ Get tool details > **listProviders**(`requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientProviderStatus`](../type-aliases/ClientProviderStatus.md)[]\>\> -Defined in: [client/httpClient.ts:921](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L921) - List available providers #### Parameters @@ -567,8 +527,6 @@ List available providers > **getProviderStatus**(`providerName`, `requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<[`ClientProviderStatus`](../type-aliases/ClientProviderStatus.md)\>\> -Defined in: [client/httpClient.ts:930](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L930) - Get provider status #### Parameters @@ -591,8 +549,6 @@ Get provider status > **health**(`requestOptions?`): `Promise`\<[`ClientApiResponse`](../type-aliases/ClientApiResponse.md)\<\{ `status`: `string`; `version`: `string`; \}\>\> -Defined in: [client/httpClient.ts:949](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L949) - Health check #### Parameters @@ -611,8 +567,6 @@ Health check > **connectWebSocket**(`options?`): `void` -Defined in: [client/httpClient.ts:974](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L974) - Connect to WebSocket for real-time communication #### Parameters @@ -644,8 +598,6 @@ client.onWebSocketMessage("chat", (data) => { > **disconnectWebSocket**(): `void` -Defined in: [client/httpClient.ts:1043](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L1043) - Disconnect WebSocket #### Returns @@ -658,8 +610,6 @@ Disconnect WebSocket > **sendWebSocketMessage**(`data`): `void` -Defined in: [client/httpClient.ts:1054](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L1054) - Send message over WebSocket #### Parameters @@ -678,8 +628,6 @@ Send message over WebSocket > **onWebSocketMessage**(`messageType`, `handler`): () => `void` -Defined in: [client/httpClient.ts:1065](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L1065) - Register WebSocket message handler #### Parameters @@ -702,8 +650,6 @@ Register WebSocket message handler > **getWebSocketState**(): [`ClientWebSocketState`](../type-aliases/ClientWebSocketState.md) -Defined in: [client/httpClient.ts:1086](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L1086) - Get WebSocket connection state #### Returns @@ -716,8 +662,6 @@ Get WebSocket connection state > **updateConfig**(`config`): `void` -Defined in: [client/httpClient.ts:1097](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L1097) - Update client configuration #### Parameters @@ -736,8 +680,6 @@ Update client configuration > **getConfig**(): `Readonly`\<[`ClientConfig`](../type-aliases/ClientConfig.md)\> -Defined in: [client/httpClient.ts:1124](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L1124) - Get current configuration (readonly) #### Returns diff --git a/docs/api/classes/NeuroLinkFeatureError.md b/docs/api/classes/NeuroLinkFeatureError.md index 9ece7f86a..fbaad1c6b 100644 --- a/docs/api/classes/NeuroLinkFeatureError.md +++ b/docs/api/classes/NeuroLinkFeatureError.md @@ -6,8 +6,6 @@ # Class: NeuroLinkFeatureError -Defined in: [core/infrastructure/baseError.ts:3](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseError.ts#L3) - ## Extends - `Error` @@ -18,8 +16,6 @@ Defined in: [core/infrastructure/baseError.ts:3](https://github.com/juspay/neuro > **new NeuroLinkFeatureError**(`message`, `code`, `feature`, `options?`): `NeuroLinkFeatureError` -Defined in: [core/infrastructure/baseError.ts:10](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseError.ts#L10) - #### Parameters ##### message @@ -62,40 +58,30 @@ Defined in: [core/infrastructure/baseError.ts:10](https://github.com/juspay/neur > `readonly` **code**: `string` -Defined in: [core/infrastructure/baseError.ts:4](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseError.ts#L4) - --- ### feature > `readonly` **feature**: `string` -Defined in: [core/infrastructure/baseError.ts:5](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseError.ts#L5) - --- ### retryable > `readonly` **retryable**: `boolean` -Defined in: [core/infrastructure/baseError.ts:6](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseError.ts#L6) - --- ### details? > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [core/infrastructure/baseError.ts:7](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseError.ts#L7) - --- ### cause? > `readonly` `optional` **cause?**: `Error` -Defined in: [core/infrastructure/baseError.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseError.ts#L8) - #### Overrides `Error.cause` diff --git a/docs/api/classes/NeuroLinkLanguageModel.md b/docs/api/classes/NeuroLinkLanguageModel.md index 4639363d1..4b0db0c92 100644 --- a/docs/api/classes/NeuroLinkLanguageModel.md +++ b/docs/api/classes/NeuroLinkLanguageModel.md @@ -6,8 +6,6 @@ # Class: NeuroLinkLanguageModel -Defined in: [client/aiSdkAdapter.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L50) - NeuroLink Language Model implementation compatible with Vercel AI SDK Implements the LanguageModelV1 interface for drop-in compatibility. @@ -40,8 +38,6 @@ const result = await generateText({ > **new NeuroLinkLanguageModel**(`client`, `modelId`, `provider`, `options?`): `NeuroLinkLanguageModel` -Defined in: [client/aiSdkAdapter.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L56) - #### Parameters ##### client @@ -70,8 +66,6 @@ Defined in: [client/aiSdkAdapter.ts:56](https://github.com/juspay/neurolink/blob > `readonly` **modelId**: `string` -Defined in: [client/aiSdkAdapter.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L51) - Model specification string #### Implementation of @@ -84,8 +78,6 @@ Model specification string > `readonly` **provider**: `string` -Defined in: [client/aiSdkAdapter.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L52) - Provider name #### Implementation of @@ -98,8 +90,6 @@ Provider name > **doGenerate**(`options`): `Promise`\<[`ClientLanguageModelResponse`](../type-aliases/ClientLanguageModelResponse.md)\> -Defined in: [client/aiSdkAdapter.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L71) - Generate a non-streaming response #### Parameters @@ -122,8 +112,6 @@ Generate a non-streaming response > **doStream**(`options`): `Promise`\<[`ClientLanguageModelStreamResponse`](../type-aliases/ClientLanguageModelStreamResponse.md)\> -Defined in: [client/aiSdkAdapter.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L130) - Generate a streaming response Uses an async queue so that each text delta from the provider is yielded diff --git a/docs/api/classes/NeuroLinkOAuthProvider.md b/docs/api/classes/NeuroLinkOAuthProvider.md index 43a10f796..6114ca109 100644 --- a/docs/api/classes/NeuroLinkOAuthProvider.md +++ b/docs/api/classes/NeuroLinkOAuthProvider.md @@ -6,8 +6,6 @@ # Class: NeuroLinkOAuthProvider -Defined in: [mcp/auth/oauthClientProvider.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L32) - NeuroLink OAuth Provider for MCP HTTP Transport Handles OAuth 2.1 authentication flow with optional PKCE support @@ -17,8 +15,6 @@ Handles OAuth 2.1 authentication flow with optional PKCE support > **new NeuroLinkOAuthProvider**(`config`, `storage?`): `NeuroLinkOAuthProvider` -Defined in: [mcp/auth/oauthClientProvider.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L38) - #### Parameters ##### config @@ -39,8 +35,6 @@ Defined in: [mcp/auth/oauthClientProvider.ts:38](https://github.com/juspay/neuro > **tokens**(`serverId`): `Promise`\<[`OAuthTokens`](../type-aliases/OAuthTokens.md) \| `null`\> -Defined in: [mcp/auth/oauthClientProvider.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L50) - Get stored tokens for a server Returns null if tokens are not available or expired (without refresh token) @@ -60,8 +54,6 @@ Returns null if tokens are not available or expired (without refresh token) > **saveTokens**(`serverId`, `tokens`): `Promise`\<`void`\> -Defined in: [mcp/auth/oauthClientProvider.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L88) - Save tokens for a server #### Parameters @@ -84,8 +76,6 @@ Save tokens for a server > **deleteTokens**(`serverId`): `Promise`\<`void`\> -Defined in: [mcp/auth/oauthClientProvider.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L95) - Delete tokens for a server #### Parameters @@ -104,8 +94,6 @@ Delete tokens for a server > **clientInformation**(): [`OAuthClientInformation`](../type-aliases/OAuthClientInformation.md) -Defined in: [mcp/auth/oauthClientProvider.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L102) - Get client information for MCP SDK #### Returns @@ -118,8 +106,6 @@ Get client information for MCP SDK > **redirectToAuthorization**(`_serverId`): [`AuthorizationUrlResult`](../type-aliases/AuthorizationUrlResult.md) -Defined in: [mcp/auth/oauthClientProvider.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L115) - Generate authorization URL for OAuth flow Returns the URL to redirect the user to for authorization @@ -141,8 +127,6 @@ Server ID (reserved for future use in state management) > **exchangeCode**(`serverId`, `request`): `Promise`\<[`OAuthTokens`](../type-aliases/OAuthTokens.md)\> -Defined in: [mcp/auth/oauthClientProvider.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L164) - Exchange authorization code for tokens #### Parameters @@ -165,8 +149,6 @@ Exchange authorization code for tokens > **refreshTokens**(`serverId`, `refreshToken`): `Promise`\<[`OAuthTokens`](../type-aliases/OAuthTokens.md)\> -Defined in: [mcp/auth/oauthClientProvider.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L246) - Refresh tokens using refresh token #### Parameters @@ -189,8 +171,6 @@ Refresh tokens using refresh token > **revokeTokens**(`serverId`, `revocationUrl`): `Promise`\<`void`\> -Defined in: [mcp/auth/oauthClientProvider.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L303) - Revoke tokens (if supported by the OAuth server) #### Parameters @@ -213,8 +193,6 @@ Revoke tokens (if supported by the OAuth server) > **getAuthorizationHeader**(`serverId`): `Promise`\<`string` \| `null`\> -Defined in: [mcp/auth/oauthClientProvider.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L346) - Get authorization header value for API requests #### Parameters @@ -233,8 +211,6 @@ Get authorization header value for API requests > **hasValidTokens**(`serverId`): `Promise`\<`boolean`\> -Defined in: [mcp/auth/oauthClientProvider.ts:359](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L359) - Check if a server has valid (non-expired) tokens #### Parameters @@ -253,8 +229,6 @@ Check if a server has valid (non-expired) tokens > **getConfig**(): `Readonly`\<[`MCPOAuthConfig`](../type-aliases/MCPOAuthConfig.md)\> -Defined in: [mcp/auth/oauthClientProvider.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L394) - Get the OAuth configuration #### Returns @@ -267,8 +241,6 @@ Get the OAuth configuration > **getStorage**(): [`TokenStorage`](../type-aliases/TokenStorage.md) -Defined in: [mcp/auth/oauthClientProvider.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L401) - Get the token storage instance #### Returns @@ -281,8 +253,6 @@ Get the token storage instance > **cleanupPendingRequests**(): `void` -Defined in: [mcp/auth/oauthClientProvider.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L409) - Clean up expired pending states and challenges Should be called periodically to prevent memory leaks diff --git a/docs/api/classes/NeverSampler.md b/docs/api/classes/NeverSampler.md index b3448f4dd..0af28f925 100644 --- a/docs/api/classes/NeverSampler.md +++ b/docs/api/classes/NeverSampler.md @@ -6,8 +6,6 @@ # Class: NeverSampler -Defined in: [observability/sampling/samplers.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/observability/sampling/samplers.ts#L33) - Never sample any spans ## Implements @@ -30,8 +28,6 @@ Never sample any spans > `readonly` **name**: `"never"` = `"never"` -Defined in: [observability/sampling/samplers.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/observability/sampling/samplers.ts#L34) - Sampler name for identification #### Implementation of @@ -44,8 +40,6 @@ Sampler name for identification > **shouldSample**(`_span`): `boolean` -Defined in: [observability/sampling/samplers.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/observability/sampling/samplers.ts#L36) - Determine if a span should be sampled #### Parameters @@ -68,8 +62,6 @@ Determine if a span should be sampled > **getDescription**(): `string` -Defined in: [observability/sampling/samplers.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/observability/sampling/samplers.ts#L40) - Get sampling decision description #### Returns diff --git a/docs/api/classes/NoOpExporter.md b/docs/api/classes/NoOpExporter.md index 012bb6c26..752626e51 100644 --- a/docs/api/classes/NoOpExporter.md +++ b/docs/api/classes/NoOpExporter.md @@ -6,8 +6,6 @@ # Class: NoOpExporter -Defined in: [observability/exporters/baseExporter.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L243) - No-op exporter for when observability is disabled Provides zero-overhead behavior @@ -21,8 +19,6 @@ Provides zero-overhead behavior > **new NoOpExporter**(): `NoOpExporter` -Defined in: [observability/exporters/baseExporter.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L244) - #### Returns `NoOpExporter` @@ -37,8 +33,6 @@ Defined in: [observability/exporters/baseExporter.ts:244](https://github.com/jus > `protected` `readonly` **name**: `string` -Defined in: [observability/exporters/baseExporter.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L19) - #### Inherited from `BaseExporter.name` @@ -49,8 +43,6 @@ Defined in: [observability/exporters/baseExporter.ts:19](https://github.com/jusp > `protected` `readonly` **config**: [`ExporterConfig`](../type-aliases/ExporterConfig.md) -Defined in: [observability/exporters/baseExporter.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L20) - #### Inherited from `BaseExporter.config` @@ -61,8 +53,6 @@ Defined in: [observability/exporters/baseExporter.ts:20](https://github.com/jusp > `protected` **initialized**: `boolean` = `false` -Defined in: [observability/exporters/baseExporter.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L21) - #### Inherited from `BaseExporter.initialized` @@ -73,8 +63,6 @@ Defined in: [observability/exporters/baseExporter.ts:21](https://github.com/jusp > `protected` **buffer**: [`SpanData`](../type-aliases/SpanData.md)[] = `[]` -Defined in: [observability/exporters/baseExporter.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L22) - #### Inherited from `BaseExporter.buffer` @@ -85,8 +73,6 @@ Defined in: [observability/exporters/baseExporter.ts:22](https://github.com/jusp > `protected` `readonly` **maxBufferSize**: `number` -Defined in: [observability/exporters/baseExporter.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L23) - #### Inherited from `BaseExporter.maxBufferSize` @@ -97,8 +83,6 @@ Defined in: [observability/exporters/baseExporter.ts:23](https://github.com/jusp > `protected` `readonly` **retries**: `number` -Defined in: [observability/exporters/baseExporter.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L24) - #### Inherited from `BaseExporter.retries` @@ -109,8 +93,6 @@ Defined in: [observability/exporters/baseExporter.ts:24](https://github.com/jusp > `protected` **flushInterval**: `Timeout` \| `null` = `null` -Defined in: [observability/exporters/baseExporter.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L25) - #### Inherited from `BaseExporter.flushInterval` @@ -121,8 +103,6 @@ Defined in: [observability/exporters/baseExporter.ts:25](https://github.com/jusp > `protected` **lastExportTime**: `number` = `0` -Defined in: [observability/exporters/baseExporter.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L26) - #### Inherited from `BaseExporter.lastExportTime` @@ -133,8 +113,6 @@ Defined in: [observability/exporters/baseExporter.ts:26](https://github.com/jusp > `protected` **ping**(): `Promise`\<`void`\> -Defined in: [observability/exporters/baseExporter.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L74) - Ping the exporter's backend to verify connectivity Override this in subclasses to provide backend-specific health check @@ -152,8 +130,6 @@ Override this in subclasses to provide backend-specific health check > `protected` **bufferSpan**(`span`): `void` -Defined in: [observability/exporters/baseExporter.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L83) - Buffer a span for batch export Triggers flush if buffer is full @@ -177,8 +153,6 @@ Triggers flush if buffer is full > `protected` **startFlushInterval**(`intervalMs`): `void` -Defined in: [observability/exporters/baseExporter.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L95) - Start automatic flush interval #### Parameters @@ -203,8 +177,6 @@ Interval in milliseconds between flushes > `protected` **stopFlushInterval**(): `void` -Defined in: [observability/exporters/baseExporter.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L111) - Stop the automatic flush interval #### Returns @@ -221,8 +193,6 @@ Stop the automatic flush interval > **getName**(): `string` -Defined in: [observability/exporters/baseExporter.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L121) - Get exporter name #### Returns @@ -239,8 +209,6 @@ Get exporter name > **isInitialized**(): `boolean` -Defined in: [observability/exporters/baseExporter.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L128) - Check if exporter is initialized #### Returns @@ -257,8 +225,6 @@ Check if exporter is initialized > **getPendingCount**(): `number` -Defined in: [observability/exporters/baseExporter.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L135) - Get number of pending spans in buffer #### Returns @@ -275,8 +241,6 @@ Get number of pending spans in buffer > **getLastExportTime**(): `number` -Defined in: [observability/exporters/baseExporter.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L142) - Get last export timestamp #### Returns @@ -293,8 +257,6 @@ Get last export timestamp > `protected` **createSuccessResult**(`exportedCount`, `durationMs`): [`ExportResult`](../type-aliases/ExportResult.md) -Defined in: [observability/exporters/baseExporter.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L149) - Create a standard export result for success #### Parameters @@ -321,8 +283,6 @@ Create a standard export result for success > `protected` **createFailureResult**(`spanIds`, `error`, `durationMs`, `retryable?`): [`ExportResult`](../type-aliases/ExportResult.md) -Defined in: [observability/exporters/baseExporter.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L165) - Create a standard export result for failure #### Parameters @@ -357,8 +317,6 @@ Create a standard export result for failure > `protected` **createHealthStatus**(`healthy`, `errors?`): [`ExporterHealthStatus`](../type-aliases/ExporterHealthStatus.md) -Defined in: [observability/exporters/baseExporter.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L187) - Create a standard health status #### Parameters @@ -385,8 +343,6 @@ Create a standard health status > `protected` **withRetry**\<`T`\>(`operation`, `operationName`): `Promise`\<`T`\> -Defined in: [observability/exporters/baseExporter.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L207) - Execute an operation with exponential backoff retry #### Type Parameters @@ -429,8 +385,6 @@ The last error if all retries fail > **initialize**(): `Promise`\<`void`\> -Defined in: [observability/exporters/baseExporter.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L248) - Initialize the exporter connection Must be called before exporting spans @@ -448,8 +402,6 @@ Must be called before exporting spans > **exportSpan**(`_span`): `Promise`\<[`ExportResult`](../type-aliases/ExportResult.md)\> -Defined in: [observability/exporters/baseExporter.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L252) - Export a single span #### Parameters @@ -472,8 +424,6 @@ Export a single span > **exportBatch**(`_spans`): `Promise`\<[`ExportResult`](../type-aliases/ExportResult.md)\> -Defined in: [observability/exporters/baseExporter.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L256) - Export multiple spans in batch #### Parameters @@ -496,8 +446,6 @@ Export multiple spans in batch > **flush**(): `Promise`\<`void`\> -Defined in: [observability/exporters/baseExporter.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L260) - Flush all buffered spans #### Returns @@ -514,8 +462,6 @@ Flush all buffered spans > **shutdown**(): `Promise`\<`void`\> -Defined in: [observability/exporters/baseExporter.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L264) - Shutdown the exporter gracefully Should flush remaining spans before closing @@ -533,8 +479,6 @@ Should flush remaining spans before closing > **healthCheck**(): `Promise`\<[`ExporterHealthStatus`](../type-aliases/ExporterHealthStatus.md)\> -Defined in: [observability/exporters/baseExporter.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/observability/exporters/baseExporter.ts#L268) - Check exporter health status Implementations should make an actual API call to verify connectivity diff --git a/docs/api/classes/NotFoundError.md b/docs/api/classes/NotFoundError.md index cf9807c16..c024228f0 100644 --- a/docs/api/classes/NotFoundError.md +++ b/docs/api/classes/NotFoundError.md @@ -6,8 +6,6 @@ # Class: NotFoundError -Defined in: [client/errors.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L283) - Error for not found (404) ## Extends @@ -20,8 +18,6 @@ Error for not found (404) > **new NotFoundError**(`message?`, `options?`): `NotFoundError` -Defined in: [client/errors.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L289) - #### Parameters ##### message? @@ -60,8 +56,6 @@ Defined in: [client/errors.ts:289](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -74,8 +68,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -88,8 +80,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -102,8 +92,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -116,8 +104,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -130,8 +116,6 @@ Request ID for error tracking > `readonly` `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [client/errors.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L146) - HTTP response headers #### Inherited from @@ -144,8 +128,6 @@ HTTP response headers > `readonly` `optional` **body?**: `unknown` -Defined in: [client/errors.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L148) - HTTP response body #### Inherited from @@ -158,8 +140,6 @@ HTTP response body > `readonly` `optional` **resourceType?**: `string` -Defined in: [client/errors.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L285) - Resource type that was not found --- @@ -168,8 +148,6 @@ Resource type that was not found > `readonly` `optional` **resourceId?**: `string` -Defined in: [client/errors.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L287) - Resource ID that was not found ## Methods @@ -178,8 +156,6 @@ Resource ID that was not found > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -196,8 +172,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/NotRunningError.md b/docs/api/classes/NotRunningError.md index d73539bc6..8e616ccf5 100644 --- a/docs/api/classes/NotRunningError.md +++ b/docs/api/classes/NotRunningError.md @@ -6,8 +6,6 @@ # Class: NotRunningError -Defined in: [server/errors.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L435) - Not running error ## Extends @@ -20,8 +18,6 @@ Not running error > **new NotRunningError**(): `NotRunningError` -Defined in: [server/errors.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L436) - #### Returns `NotRunningError` @@ -36,8 +32,6 @@ Defined in: [server/errors.ts:436](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -48,8 +42,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -60,8 +52,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -72,8 +62,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -84,8 +72,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -96,8 +82,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -108,8 +92,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -120,8 +102,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -132,8 +112,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -144,8 +122,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -156,8 +132,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -174,8 +148,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/OAuth2AuthError.md b/docs/api/classes/OAuth2AuthError.md index 22c77c723..3d22f6fc9 100644 --- a/docs/api/classes/OAuth2AuthError.md +++ b/docs/api/classes/OAuth2AuthError.md @@ -6,8 +6,6 @@ # Class: OAuth2AuthError -Defined in: [client/auth.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L444) - Error thrown when authentication fails ## Extends @@ -20,8 +18,6 @@ Error thrown when authentication fails > **new OAuth2AuthError**(`message`, `code?`, `status?`): `OAuth2AuthenticationError` -Defined in: [client/auth.ts:448](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L448) - #### Parameters ##### message @@ -50,12 +46,8 @@ Defined in: [client/auth.ts:448](https://github.com/juspay/neurolink/blob/releas > `readonly` **code**: `string` -Defined in: [client/auth.ts:445](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L445) - --- ### status > `readonly` **status**: `number` - -Defined in: [client/auth.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L446) diff --git a/docs/api/classes/OAuth2Error.md b/docs/api/classes/OAuth2Error.md index 13ba80650..3d5161f42 100644 --- a/docs/api/classes/OAuth2Error.md +++ b/docs/api/classes/OAuth2Error.md @@ -6,8 +6,6 @@ # Class: OAuth2Error -Defined in: [client/auth.ts:429](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L429) - Error thrown during OAuth2 operations ## Extends @@ -20,8 +18,6 @@ Error thrown during OAuth2 operations > **new OAuth2Error**(`message`, `status`, `responseBody`): `OAuth2Error` -Defined in: [client/auth.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L433) - #### Parameters ##### message @@ -50,12 +46,8 @@ Defined in: [client/auth.ts:433](https://github.com/juspay/neurolink/blob/releas > `readonly` **status**: `number` -Defined in: [client/auth.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L430) - --- ### responseBody > `readonly` **responseBody**: `string` - -Defined in: [client/auth.ts:431](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L431) diff --git a/docs/api/classes/OAuth2TokenManager.md b/docs/api/classes/OAuth2TokenManager.md index 323556c66..a558b8edf 100644 --- a/docs/api/classes/OAuth2TokenManager.md +++ b/docs/api/classes/OAuth2TokenManager.md @@ -6,8 +6,6 @@ # Class: OAuth2TokenManager -Defined in: [client/auth.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L46) - OAuth2 Token Manager for client credentials flow Handles token acquisition, caching, and automatic refresh for OAuth2 @@ -39,8 +37,6 @@ client.use(createDynamicAuthInterceptor(() => tokenManager.getToken())); > **new OAuth2TokenManager**(`config`, `options?`): `OAuth2TokenManager` -Defined in: [client/auth.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L52) - #### Parameters ##### config @@ -63,8 +59,6 @@ Defined in: [client/auth.ts:52](https://github.com/juspay/neurolink/blob/release > **getToken**(): `Promise`\<`string`\> -Defined in: [client/auth.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L65) - Get a valid access token Returns cached token if still valid, otherwise fetches a new one. @@ -80,8 +74,6 @@ Handles concurrent requests by deduplicating token refresh calls. > **invalidate**(): `void` -Defined in: [client/auth.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L94) - Invalidate the cached token Call this when the token is rejected by the server to force a refresh. @@ -96,8 +88,6 @@ Call this when the token is rejected by the server to force a refresh. > **isValid**(): `boolean` -Defined in: [client/auth.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L102) - Check if the cached token is valid #### Returns @@ -110,8 +100,6 @@ Check if the cached token is valid > **getExpiryTime**(): `number` \| `null` -Defined in: [client/auth.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L113) - Get the token expiry time in milliseconds #### Returns diff --git a/docs/api/classes/OAuthCallbackServerError.md b/docs/api/classes/OAuthCallbackServerError.md index f2c528a4a..ee109a252 100644 --- a/docs/api/classes/OAuthCallbackServerError.md +++ b/docs/api/classes/OAuthCallbackServerError.md @@ -6,8 +6,6 @@ # Class: OAuthCallbackServerError -Defined in: [types/errors.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L191) - Thrown when callback server operations fail ## Extends @@ -20,8 +18,6 @@ Thrown when callback server operations fail > **new OAuthCallbackServerError**(`message`): `OAuthCallbackServerError` -Defined in: [types/errors.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L192) - #### Parameters ##### message @@ -42,8 +38,6 @@ Defined in: [types/errors.ts:192](https://github.com/juspay/neurolink/blob/relea > `optional` **code?**: `string` -Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L122) - #### Inherited from [`OAuthError`](OAuthError.md).[`code`](OAuthError.md#code) diff --git a/docs/api/classes/OAuthConfigurationError.md b/docs/api/classes/OAuthConfigurationError.md index ea73d968e..0e7b0dce5 100644 --- a/docs/api/classes/OAuthConfigurationError.md +++ b/docs/api/classes/OAuthConfigurationError.md @@ -6,8 +6,6 @@ # Class: OAuthConfigurationError -Defined in: [types/errors.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L132) - Thrown when OAuth configuration is invalid or missing ## Extends @@ -20,8 +18,6 @@ Thrown when OAuth configuration is invalid or missing > **new OAuthConfigurationError**(`message`): `OAuthConfigurationError` -Defined in: [types/errors.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L133) - #### Parameters ##### message @@ -42,8 +38,6 @@ Defined in: [types/errors.ts:133](https://github.com/juspay/neurolink/blob/relea > `optional` **code?**: `string` -Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L122) - #### Inherited from [`OAuthError`](OAuthError.md).[`code`](OAuthError.md#code) diff --git a/docs/api/classes/OAuthError.md b/docs/api/classes/OAuthError.md index f619c35bb..0de1c4ec3 100644 --- a/docs/api/classes/OAuthError.md +++ b/docs/api/classes/OAuthError.md @@ -6,8 +6,6 @@ # Class: OAuthError -Defined in: [types/errors.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L119) - Base class for OAuth-specific errors ## Extends @@ -29,8 +27,6 @@ Base class for OAuth-specific errors > **new OAuthError**(`message`, `code?`): `OAuthError` -Defined in: [types/errors.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L120) - #### Parameters ##### message @@ -54,5 +50,3 @@ Defined in: [types/errors.ts:120](https://github.com/juspay/neurolink/blob/relea ### code? > `optional` **code?**: `string` - -Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L122) diff --git a/docs/api/classes/OAuthTokenExchangeError.md b/docs/api/classes/OAuthTokenExchangeError.md index 28510abc1..f5ae909d4 100644 --- a/docs/api/classes/OAuthTokenExchangeError.md +++ b/docs/api/classes/OAuthTokenExchangeError.md @@ -6,8 +6,6 @@ # Class: OAuthTokenExchangeError -Defined in: [types/errors.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L142) - Thrown when authorization code exchange fails ## Extends @@ -20,8 +18,6 @@ Thrown when authorization code exchange fails > **new OAuthTokenExchangeError**(`message`, `statusCode?`): `OAuthTokenExchangeError` -Defined in: [types/errors.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L143) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [types/errors.ts:143](https://github.com/juspay/neurolink/blob/relea > `optional` **code?**: `string` -Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L122) - #### Inherited from [`OAuthError`](OAuthError.md).[`code`](OAuthError.md#code) @@ -57,5 +51,3 @@ Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/relea ### statusCode? > `optional` **statusCode?**: `number` - -Defined in: [types/errors.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L145) diff --git a/docs/api/classes/OAuthTokenRefreshError.md b/docs/api/classes/OAuthTokenRefreshError.md index 1d6081c99..e649d1c90 100644 --- a/docs/api/classes/OAuthTokenRefreshError.md +++ b/docs/api/classes/OAuthTokenRefreshError.md @@ -6,8 +6,6 @@ # Class: OAuthTokenRefreshError -Defined in: [types/errors.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L155) - Thrown when token refresh fails ## Extends @@ -20,8 +18,6 @@ Thrown when token refresh fails > **new OAuthTokenRefreshError**(`message`, `statusCode?`): `OAuthTokenRefreshError` -Defined in: [types/errors.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L156) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [types/errors.ts:156](https://github.com/juspay/neurolink/blob/relea > `optional` **code?**: `string` -Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L122) - #### Inherited from [`OAuthError`](OAuthError.md).[`code`](OAuthError.md#code) @@ -57,5 +51,3 @@ Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/relea ### statusCode? > `optional` **statusCode?**: `number` - -Defined in: [types/errors.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L158) diff --git a/docs/api/classes/OAuthTokenRevocationError.md b/docs/api/classes/OAuthTokenRevocationError.md index fbec192a4..d60e90fa1 100644 --- a/docs/api/classes/OAuthTokenRevocationError.md +++ b/docs/api/classes/OAuthTokenRevocationError.md @@ -6,8 +6,6 @@ # Class: OAuthTokenRevocationError -Defined in: [types/errors.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L178) - Thrown when token revocation fails ## Extends @@ -20,8 +18,6 @@ Thrown when token revocation fails > **new OAuthTokenRevocationError**(`message`, `statusCode?`): `OAuthTokenRevocationError` -Defined in: [types/errors.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L179) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [types/errors.ts:179](https://github.com/juspay/neurolink/blob/relea > `optional` **code?**: `string` -Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L122) - #### Inherited from [`OAuthError`](OAuthError.md).[`code`](OAuthError.md#code) @@ -57,5 +51,3 @@ Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/relea ### statusCode? > `optional` **statusCode?**: `number` - -Defined in: [types/errors.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L181) diff --git a/docs/api/classes/OAuthTokenValidationError.md b/docs/api/classes/OAuthTokenValidationError.md index de1c8a849..6496efd26 100644 --- a/docs/api/classes/OAuthTokenValidationError.md +++ b/docs/api/classes/OAuthTokenValidationError.md @@ -6,8 +6,6 @@ # Class: OAuthTokenValidationError -Defined in: [types/errors.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L168) - Thrown when token validation fails ## Extends @@ -20,8 +18,6 @@ Thrown when token validation fails > **new OAuthTokenValidationError**(`message`): `OAuthTokenValidationError` -Defined in: [types/errors.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L169) - #### Parameters ##### message @@ -42,8 +38,6 @@ Defined in: [types/errors.ts:169](https://github.com/juspay/neurolink/blob/relea > `optional` **code?**: `string` -Defined in: [types/errors.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L122) - #### Inherited from [`OAuthError`](OAuthError.md).[`code`](OAuthError.md#code) diff --git a/docs/api/classes/ObservabilityHooks.md b/docs/api/classes/ObservabilityHooks.md index 4c52145ba..3576d5039 100644 --- a/docs/api/classes/ObservabilityHooks.md +++ b/docs/api/classes/ObservabilityHooks.md @@ -6,8 +6,6 @@ # Class: ObservabilityHooks -Defined in: [evaluation/hooks/observabilityHooks.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L19) - Observability hooks manager ## Constructors @@ -28,8 +26,6 @@ Observability hooks manager > **get** **enabled**(): `boolean` -Defined in: [evaluation/hooks/observabilityHooks.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L31) - ##### Returns `boolean` @@ -38,8 +34,6 @@ Defined in: [evaluation/hooks/observabilityHooks.ts:31](https://github.com/juspa > **set** **enabled**(`value`): `void` -Defined in: [evaluation/hooks/observabilityHooks.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L27) - Enable/disable observability ##### Parameters @@ -58,8 +52,6 @@ Enable/disable observability > **setTraceContext**(`context`): `void` -Defined in: [evaluation/hooks/observabilityHooks.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L38) - Set trace context for all events #### Parameters @@ -78,8 +70,6 @@ Set trace context for all events > **clearTraceContext**(): `void` -Defined in: [evaluation/hooks/observabilityHooks.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L45) - Clear trace context #### Returns @@ -92,8 +82,6 @@ Clear trace context > **getTraceContext**(): [`EvaluationTraceContext`](../type-aliases/EvaluationTraceContext.md) \| `undefined` -Defined in: [evaluation/hooks/observabilityHooks.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L52) - Get current trace context #### Returns @@ -106,8 +94,6 @@ Get current trace context > **on**\<`K`\>(`event`, `handler`): () => `void` -Defined in: [evaluation/hooks/observabilityHooks.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L59) - Register an event handler #### Type Parameters @@ -136,8 +122,6 @@ Register an event handler > **off**\<`K`\>(`event`, `handler`): `void` -Defined in: [evaluation/hooks/observabilityHooks.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L80) - Remove an event handler #### Type Parameters @@ -166,8 +150,6 @@ Remove an event handler > **emit**\<`K`\>(`event`, `data`): `Promise`\<`void`\> -Defined in: [evaluation/hooks/observabilityHooks.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L90) - Emit an event #### Type Parameters @@ -196,8 +178,6 @@ Emit an event > **clear**(): `void` -Defined in: [evaluation/hooks/observabilityHooks.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L132) - Clear all handlers #### Returns @@ -210,8 +190,6 @@ Clear all handlers > **listenerCount**(`event`): `number` -Defined in: [evaluation/hooks/observabilityHooks.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L139) - Get handler count for an event #### Parameters diff --git a/docs/api/classes/OpenAIRealtime.md b/docs/api/classes/OpenAIRealtime.md index bf931363d..e35a6752d 100644 --- a/docs/api/classes/OpenAIRealtime.md +++ b/docs/api/classes/OpenAIRealtime.md @@ -6,8 +6,6 @@ # Class: OpenAIRealtime -Defined in: [voice/providers/OpenAIRealtime.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L31) - OpenAI Realtime API Handler Implements bidirectional voice communication with OpenAI's Realtime API. @@ -26,8 +24,6 @@ https://platform.openai.com/docs/api-reference/realtime > **new OpenAIRealtime**(`apiKey?`): `OpenAIRealtime` -Defined in: [voice/providers/OpenAIRealtime.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L38) - #### Parameters ##### apiKey? @@ -48,8 +44,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:38](https://github.com/juspay/neu > `protected` **session**: [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` = `null` -Defined in: [voice/RealtimeVoiceAPI.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L432) - #### Inherited from [`BaseRealtimeHandler`](BaseRealtimeHandler.md).[`session`](BaseRealtimeHandler.md#session) @@ -60,8 +54,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:432](https://github.com/juspay/neurolink/ > `protected` **eventHandlers**: [`RealtimeEventHandlers`](../type-aliases/RealtimeEventHandlers.md) \| `null` = `null` -Defined in: [voice/RealtimeVoiceAPI.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L433) - #### Inherited from [`BaseRealtimeHandler`](BaseRealtimeHandler.md).[`eventHandlers`](BaseRealtimeHandler.md#eventhandlers) @@ -72,8 +64,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:433](https://github.com/juspay/neurolink/ > `protected` **state**: [`RealtimeSessionState`](../type-aliases/RealtimeSessionState.md) = `"disconnected"` -Defined in: [voice/RealtimeVoiceAPI.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L434) - #### Inherited from [`BaseRealtimeHandler`](BaseRealtimeHandler.md).[`state`](BaseRealtimeHandler.md#state) @@ -84,8 +74,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:434](https://github.com/juspay/neurolink/ > `readonly` **name**: `"openai-realtime"` = `"openai-realtime"` -Defined in: [voice/providers/OpenAIRealtime.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L32) - #### Overrides [`BaseRealtimeHandler`](BaseRealtimeHandler.md).[`name`](BaseRealtimeHandler.md#name) @@ -96,8 +84,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:32](https://github.com/juspay/neu > **isConnected**(): `boolean` -Defined in: [voice/RealtimeVoiceAPI.ts:442](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L442) - #### Returns `boolean` @@ -112,8 +98,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:442](https://github.com/juspay/neurolink/ > **getSession**(): [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` -Defined in: [voice/RealtimeVoiceAPI.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L446) - #### Returns [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` @@ -128,8 +112,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:446](https://github.com/juspay/neurolink/ > **on**(`handlers`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L450) - #### Parameters ##### handlers @@ -150,8 +132,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:450](https://github.com/juspay/neurolink/ > **off**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L454) - #### Returns `void` @@ -166,8 +146,6 @@ Defined in: [voice/RealtimeVoiceAPI.ts:454](https://github.com/juspay/neurolink/ > `protected` **emitStateChange**(`newState`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:461](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L461) - Emit state change event #### Parameters @@ -190,8 +168,6 @@ Emit state change event > `protected` **emitAudio**(`chunk`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L473) - Emit audio event #### Parameters @@ -214,8 +190,6 @@ Emit audio event > `protected` **emitTranscript**(`text`, `isFinal`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L480) - Emit transcript event #### Parameters @@ -242,8 +216,6 @@ Emit transcript event > `protected` **emitText**(`text`, `isFinal`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L487) - Emit text event #### Parameters @@ -270,8 +242,6 @@ Emit text event > `protected` **emitFunctionCall**(`name`, `args`): `Promise`\<`unknown`\> -Defined in: [voice/RealtimeVoiceAPI.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L494) - Emit function call event #### Parameters @@ -298,8 +268,6 @@ Emit function call event > `protected` **emitError**(`error`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L507) - Emit error event #### Parameters @@ -322,8 +290,6 @@ Emit error event > `protected` **emitTurnStart**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:514](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L514) - Emit turn start event #### Returns @@ -340,8 +306,6 @@ Emit turn start event > `protected` **emitTurnEnd**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L521) - Emit turn end event #### Returns @@ -358,8 +322,6 @@ Emit turn end event > `protected` **createSession**(`id`, `config`): [`RealtimeSession`](../type-aliases/RealtimeSession.md) -Defined in: [voice/RealtimeVoiceAPI.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L528) - Create a session object #### Parameters @@ -386,8 +348,6 @@ Create a session object > **isConfigured**(): `boolean` -Defined in: [voice/providers/OpenAIRealtime.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L48) - #### Returns `boolean` @@ -402,8 +362,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:48](https://github.com/juspay/neu > **getSupportedFormats**(): [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] -Defined in: [voice/providers/OpenAIRealtime.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L52) - #### Returns [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] @@ -418,8 +376,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:52](https://github.com/juspay/neu > **connect**(`config`): `Promise`\<[`RealtimeSession`](../type-aliases/RealtimeSession.md)\> -Defined in: [voice/providers/OpenAIRealtime.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L59) - #### Parameters ##### config @@ -440,8 +396,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:59](https://github.com/juspay/neu > **disconnect**(): `Promise`\<`void`\> -Defined in: [voice/providers/OpenAIRealtime.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L145) - #### Returns `Promise`\<`void`\> @@ -456,8 +410,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:145](https://github.com/juspay/ne > **sendAudio**(`audio`): `Promise`\<`void`\> -Defined in: [voice/providers/OpenAIRealtime.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L170) - #### Parameters ##### audio @@ -478,8 +430,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:170](https://github.com/juspay/ne > **sendText**(`text`): `Promise`\<`void`\> -Defined in: [voice/providers/OpenAIRealtime.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L186) - #### Parameters ##### text @@ -496,8 +446,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:186](https://github.com/juspay/ne > **triggerResponse**(): `Promise`\<`void`\> -Defined in: [voice/providers/OpenAIRealtime.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L212) - #### Returns `Promise`\<`void`\> @@ -508,8 +456,6 @@ Defined in: [voice/providers/OpenAIRealtime.ts:212](https://github.com/juspay/ne > **cancelResponse**(): `Promise`\<`void`\> -Defined in: [voice/providers/OpenAIRealtime.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAIRealtime.ts#L232) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/classes/OpenAISTT.md b/docs/api/classes/OpenAISTT.md index 9b41ab951..4ccbd44fd 100644 --- a/docs/api/classes/OpenAISTT.md +++ b/docs/api/classes/OpenAISTT.md @@ -6,8 +6,6 @@ # Class: OpenAISTT -Defined in: [voice/providers/OpenAISTT.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAISTT.ts#L28) - OpenAI Whisper Speech-to-Text Handler Supports transcription and translation using OpenAI's Whisper model. @@ -26,8 +24,6 @@ https://platform.openai.com/docs/api-reference/audio > **new OpenAISTT**(`apiKey?`): `OpenAISTT` -Defined in: [voice/providers/OpenAISTT.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAISTT.ts#L42) - #### Parameters ##### apiKey? @@ -44,8 +40,6 @@ Defined in: [voice/providers/OpenAISTT.ts:42](https://github.com/juspay/neurolin > `readonly` **maxAudioDuration**: `number` -Defined in: [voice/providers/OpenAISTT.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAISTT.ts#L35) - Maximum audio duration in seconds (25 minutes) #### Implementation of @@ -58,8 +52,6 @@ Maximum audio duration in seconds (25 minutes) > `readonly` **supportsStreaming**: `false` = `false` -Defined in: [voice/providers/OpenAISTT.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAISTT.ts#L40) - Whisper does not support streaming #### Implementation of @@ -72,8 +64,6 @@ Whisper does not support streaming > **isConfigured**(): `boolean` -Defined in: [voice/providers/OpenAISTT.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAISTT.ts#L47) - #### Returns `boolean` @@ -88,8 +78,6 @@ Defined in: [voice/providers/OpenAISTT.ts:47](https://github.com/juspay/neurolin > **getSupportedFormats**(): [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] -Defined in: [voice/providers/OpenAISTT.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAISTT.ts#L51) - #### Returns [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] @@ -104,8 +92,6 @@ Defined in: [voice/providers/OpenAISTT.ts:51](https://github.com/juspay/neurolin > **getSupportedLanguages**(): `Promise`\<[`STTLanguage`](../type-aliases/STTLanguage.md)[]\> -Defined in: [voice/providers/OpenAISTT.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAISTT.ts#L69) - #### Returns `Promise`\<[`STTLanguage`](../type-aliases/STTLanguage.md)[]\> @@ -120,8 +106,6 @@ Defined in: [voice/providers/OpenAISTT.ts:69](https://github.com/juspay/neurolin > **transcribe**(`audio`, `options?`): `Promise`\<[`STTResult`](../type-aliases/STTResult.md)\> -Defined in: [voice/providers/OpenAISTT.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAISTT.ts#L148) - #### Parameters ##### audio diff --git a/docs/api/classes/OpenAITTS.md b/docs/api/classes/OpenAITTS.md index c54949678..3be8ca6d0 100644 --- a/docs/api/classes/OpenAITTS.md +++ b/docs/api/classes/OpenAITTS.md @@ -6,8 +6,6 @@ # Class: OpenAITTS -Defined in: [voice/providers/OpenAITTS.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAITTS.ts#L145) - ## Implements - [`TTSHandler`](../type-aliases/TTSHandler.md) @@ -18,8 +16,6 @@ Defined in: [voice/providers/OpenAITTS.ts:145](https://github.com/juspay/neuroli > **new OpenAITTS**(`apiKey?`): `OpenAITTS` -Defined in: [voice/providers/OpenAITTS.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAITTS.ts#L208) - #### Parameters ##### apiKey? @@ -36,8 +32,6 @@ Defined in: [voice/providers/OpenAITTS.ts:208](https://github.com/juspay/neuroli > `readonly` **maxTextLength**: `4096` = `4096` -Defined in: [voice/providers/OpenAITTS.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAITTS.ts#L152) - Maximum text length (4096 characters) #### Implementation of @@ -50,8 +44,6 @@ Maximum text length (4096 characters) > **isConfigured**(): `boolean` -Defined in: [voice/providers/OpenAITTS.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAITTS.ts#L213) - Validate that the provider is properly configured #### Returns @@ -70,8 +62,6 @@ True if provider can generate TTS > **getVoices**(`languageCode?`): `Promise`\<[`TTSVoice`](../type-aliases/TTSVoice.md)[]\> -Defined in: [voice/providers/OpenAITTS.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAITTS.ts#L217) - Get available voices for the provider #### Parameters @@ -98,8 +88,6 @@ List of available voices > **synthesize**(`text`, `options?`): `Promise`\<[`TTSResult`](../type-aliases/TTSResult.md)\> -Defined in: [voice/providers/OpenAITTS.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAITTS.ts#L356) - Generate audio from text using provider-specific TTS API **IMPORTANT: Timeout Responsibility** @@ -140,8 +128,6 @@ On synthesis failure, timeout, or configuration issues > **synthesizeStream**(`text`, `options?`): `AsyncIterable`\<[`TTSChunk`](../type-aliases/TTSChunk.md), `any`, `any`\> \| `undefined` -Defined in: [voice/providers/OpenAITTS.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/voice/providers/OpenAITTS.ts#L434) - Stream one segment's audio as the response body arrives. Returns `undefined` for any format without direct wire proof of diff --git a/docs/api/classes/PDFLoader.md b/docs/api/classes/PDFLoader.md index bd14cdc74..2788bcbb9 100644 --- a/docs/api/classes/PDFLoader.md +++ b/docs/api/classes/PDFLoader.md @@ -6,8 +6,6 @@ # Class: PDFLoader -Defined in: [rag/document/loaders.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L303) - PDF file loader Note: Requires external PDF processing library for full functionality. @@ -33,8 +31,6 @@ Falls back to placeholder implementation if pdf-parse is not available. > **load**(`source`, `options?`): `Promise`\<[`MDocument`](MDocument.md)\> -Defined in: [rag/document/loaders.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L304) - Load document from source #### Parameters @@ -67,8 +63,6 @@ Promise resolving to MDocument > **canHandle**(`source`): `boolean` -Defined in: [rag/document/loaders.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L394) - Check if loader can handle the source #### Parameters diff --git a/docs/api/classes/PgVectorStore.md b/docs/api/classes/PgVectorStore.md index a1afcc8a6..5eda4bb4b 100644 --- a/docs/api/classes/PgVectorStore.md +++ b/docs/api/classes/PgVectorStore.md @@ -6,8 +6,6 @@ # Class: PgVectorStore -Defined in: [rag/stores/pgvector.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pgvector.ts#L82) - RAG (Retrieval-Augmented Generation) Document Processing Comprehensive RAG system with document loading, chunking, embedding, @@ -47,8 +45,6 @@ console.log(response.answer); > **new PgVectorStore**(`client`, `options?`): `PgVectorStore` -Defined in: [rag/stores/pgvector.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pgvector.ts#L88) - #### Parameters ##### client @@ -69,8 +65,6 @@ Defined in: [rag/stores/pgvector.ts:88](https://github.com/juspay/neurolink/blob > **upsert**(`indexName`, `items`): `Promise`\<`void`\> -Defined in: [rag/stores/pgvector.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pgvector.ts#L154) - Upsert vectors into an index, creating its table on first use. Mirrors `InMemoryVectorStore.upsert` (metadata defaults to `{}`). @@ -94,8 +88,6 @@ Mirrors `InMemoryVectorStore.upsert` (metadata defaults to `{}`). > **query**(`params`): `Promise`\<[`VectorQueryResult`](../type-aliases/VectorQueryResult.md)[]\> -Defined in: [rag/stores/pgvector.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pgvector.ts#L203) - Query by cosine similarity. Returns `[]` if the index's table doesn't exist yet (mirrors `InMemoryVectorStore.query` on an unknown index) rather than throwing. @@ -138,8 +130,6 @@ rather than throwing. > **delete**(`indexName`, `ids`): `Promise`\<`void`\> -Defined in: [rag/stores/pgvector.ts:261](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pgvector.ts#L261) - Delete vectors by id. No-op if the index's table doesn't exist yet (mirrors `InMemoryVectorStore.delete`). diff --git a/docs/api/classes/PineconeVectorStore.md b/docs/api/classes/PineconeVectorStore.md index 5d4e48065..06014471b 100644 --- a/docs/api/classes/PineconeVectorStore.md +++ b/docs/api/classes/PineconeVectorStore.md @@ -6,8 +6,6 @@ # Class: PineconeVectorStore -Defined in: [rag/stores/pinecone.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pinecone.ts#L137) - Pinecone-backed implementation of the `VectorStore` contract. ## Example @@ -33,8 +31,6 @@ const results = await store.query({ indexName: 'tenant-a', queryVector: [...], t > **new PineconeVectorStore**(`client`): `PineconeVectorStore` -Defined in: [rag/stores/pinecone.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pinecone.ts#L138) - #### Parameters ##### client @@ -51,8 +47,6 @@ Defined in: [rag/stores/pinecone.ts:138](https://github.com/juspay/neurolink/blo > **query**(`params`): `Promise`\<[`VectorQueryResult`](../type-aliases/VectorQueryResult.md)[]\> -Defined in: [rag/stores/pinecone.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pinecone.ts#L147) - #### Parameters ##### params @@ -91,8 +85,6 @@ Defined in: [rag/stores/pinecone.ts:147](https://github.com/juspay/neurolink/blo > **upsert**(`indexName`, `items`): `Promise`\<`void`\> -Defined in: [rag/stores/pinecone.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pinecone.ts#L185) - Add or update vectors in the namespace mapped from `indexName`. #### Parameters @@ -115,8 +107,6 @@ Add or update vectors in the namespace mapped from `indexName`. > **delete**(`indexName`, `ids`): `Promise`\<`void`\> -Defined in: [rag/stores/pinecone.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/rag/stores/pinecone.ts#L204) - Delete vectors by id from the namespace mapped from `indexName`. #### Parameters diff --git a/docs/api/classes/PipelineBuilder.md b/docs/api/classes/PipelineBuilder.md index 8c8d493a3..afd7c86ee 100644 --- a/docs/api/classes/PipelineBuilder.md +++ b/docs/api/classes/PipelineBuilder.md @@ -6,8 +6,6 @@ # Class: PipelineBuilder -Defined in: [evaluation/pipeline/pipelineBuilder.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L18) - Fluent builder for creating evaluation pipelines ## Constructors @@ -16,8 +14,6 @@ Fluent builder for creating evaluation pipelines > **new PipelineBuilder**(`name?`): `PipelineBuilder` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L29) - #### Parameters ##### name? @@ -34,8 +30,6 @@ Defined in: [evaluation/pipeline/pipelineBuilder.ts:29](https://github.com/juspa > `static` **create**(`name?`): `PipelineBuilder` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L36) - Create a new pipeline builder #### Parameters @@ -54,8 +48,6 @@ Create a new pipeline builder > **name**(`name`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L43) - Set pipeline name #### Parameters @@ -74,8 +66,6 @@ Set pipeline name > **description**(`desc`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L51) - Set pipeline description #### Parameters @@ -94,8 +84,6 @@ Set pipeline description > **addScorer**(`id`, `config?`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L59) - Add a scorer by ID #### Parameters @@ -118,8 +106,6 @@ Add a scorer by ID > **addScorers**(...`ids`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L67) - Add multiple scorers #### Parameters @@ -138,8 +124,6 @@ Add multiple scorers > **requireScorer**(`id`, `config?`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L77) - Add a scorer and mark it as required #### Parameters @@ -162,8 +146,6 @@ Add a scorer and mark it as required > **aggregateWith**(`method`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L97) - Set aggregation method #### Parameters @@ -182,8 +164,6 @@ Set aggregation method > **withWeights**(`weights`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L105) - Set weights for weighted aggregation #### Parameters @@ -202,8 +182,6 @@ Set weights for weighted aggregation > **customAggregation**(`fn`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L114) - Set custom aggregation function #### Parameters @@ -222,8 +200,6 @@ Set custom aggregation function > **passThreshold**(`threshold`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L123) - Set pass/fail threshold #### Parameters @@ -242,8 +218,6 @@ Set pass/fail threshold > **parallel**(): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L131) - Run scorers in parallel (default) #### Returns @@ -256,8 +230,6 @@ Run scorers in parallel (default) > **sequential**(): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L139) - Run scorers sequentially #### Returns @@ -270,8 +242,6 @@ Run scorers sequentially > **stopOnFailure**(): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L147) - Stop pipeline on first failure #### Returns @@ -284,8 +254,6 @@ Stop pipeline on first failure > **continueOnFailure**(): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L155) - Continue pipeline on failures (default) #### Returns @@ -298,8 +266,6 @@ Continue pipeline on failures (default) > **timeout**(`ms`): `this` -Defined in: [evaluation/pipeline/pipelineBuilder.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L163) - Set pipeline timeout #### Parameters @@ -318,8 +284,6 @@ Set pipeline timeout > **buildConfig**(): [`PipelineConfig`](../type-aliases/PipelineConfig.md) -Defined in: [evaluation/pipeline/pipelineBuilder.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L171) - Build the pipeline configuration #### Returns @@ -332,8 +296,6 @@ Build the pipeline configuration > **build**(): [`EvaluationPipeline`](EvaluationPipeline.md) -Defined in: [evaluation/pipeline/pipelineBuilder.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L199) - Build the pipeline (not initialized) #### Returns @@ -346,8 +308,6 @@ Build the pipeline (not initialized) > **buildAndInitialize**(): `Promise`\<[`EvaluationPipeline`](EvaluationPipeline.md)\> -Defined in: [evaluation/pipeline/pipelineBuilder.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/pipelineBuilder.ts#L206) - Build and initialize the pipeline #### Returns diff --git a/docs/api/classes/PromptAlignmentScorer.md b/docs/api/classes/PromptAlignmentScorer.md index 21dfd5dba..5efb40f0e 100644 --- a/docs/api/classes/PromptAlignmentScorer.md +++ b/docs/api/classes/PromptAlignmentScorer.md @@ -6,8 +6,6 @@ # Class: PromptAlignmentScorer -Defined in: [evaluation/scorers/llm/promptAlignmentScorer.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/promptAlignmentScorer.ts#L57) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new PromptAlignmentScorer**(`config?`): `PromptAlignmentScorer` -Defined in: [evaluation/scorers/llm/promptAlignmentScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/promptAlignmentScorer.ts#L58) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/promptAlignmentScorer.ts:58](https://github. > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/promptAlignmentScorer.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/promptAlignmentScorer.ts#L82) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/promptAlignmentScorer.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/promptAlignmentScorer.ts#L89) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/ProviderError.md b/docs/api/classes/ProviderError.md index f8010edc4..a57074941 100644 --- a/docs/api/classes/ProviderError.md +++ b/docs/api/classes/ProviderError.md @@ -6,8 +6,6 @@ # Class: ProviderError -Defined in: [types/errors.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L15) - Thrown when a provider encounters a generic error. ## Extends @@ -29,8 +27,6 @@ Thrown when a provider encounters a generic error. > **new ProviderError**(`message`, `provider?`): `ProviderError` -Defined in: [types/errors.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L16) - #### Parameters ##### message @@ -54,5 +50,3 @@ Defined in: [types/errors.ts:16](https://github.com/juspay/neurolink/blob/releas ### provider? > `optional` **provider?**: `string` - -Defined in: [types/errors.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L18) diff --git a/docs/api/classes/ProviderFactory.md b/docs/api/classes/ProviderFactory.md index 862c81f73..9a8665bbd 100644 --- a/docs/api/classes/ProviderFactory.md +++ b/docs/api/classes/ProviderFactory.md @@ -6,8 +6,6 @@ # Class: ProviderFactory -Defined in: [factories/providerFactory.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L49) - True Factory Pattern implementation for AI Providers Uses registration-based approach to eliminate switch statements and enable dynamic provider registration @@ -28,8 +26,6 @@ and enable dynamic provider registration > `static` **registerProvider**(`name`, `constructor`, `defaultModel?`, `aliases?`, `descriptor?`): `void` -Defined in: [factories/providerFactory.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L56) - Register a provider with the factory #### Parameters @@ -64,8 +60,6 @@ Register a provider with the factory > `static` **createProvider**(`providerName?`, `modelName?`, `sdk?`, `region?`, `credentials?`): `Promise`\<[`AIProvider`](../type-aliases/AIProvider.md)\> -Defined in: [factories/providerFactory.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L87) - Create a provider instance #### Parameters @@ -104,8 +98,6 @@ Model name (optional, uses provider-specific env var or registry default) > `static` **hasProvider**(`providerName`): `boolean` -Defined in: [factories/providerFactory.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L197) - Check if a provider is registered #### Parameters @@ -124,8 +116,6 @@ Check if a provider is registered > `static` **getAvailableProviders**(): `string`[] -Defined in: [factories/providerFactory.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L272) - #### Returns `string`[] @@ -136,8 +126,6 @@ Defined in: [factories/providerFactory.ts:272](https://github.com/juspay/neuroli > `static` **getProviderInfo**(`providerName`): [`ProviderRegistration`](../type-aliases/ProviderRegistration.md) \| `undefined` -Defined in: [factories/providerFactory.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L281) - Get provider registration info #### Parameters @@ -156,8 +144,6 @@ Get provider registration info > `static` **getDescriptor**(`name`): [`ProviderDescriptor`](../type-aliases/ProviderDescriptor.md) \| `undefined` -Defined in: [factories/providerFactory.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L294) - Look up a provider's static descriptor. Checks the built-in PROVIDER_DESCRIPTORS first (works even before registerAllProviders() has run, and resolves aliases via PROVIDER_ALIAS_INDEX), then falls @@ -180,8 +166,6 @@ registerProvider()'s 5th parameter. > `static` **getAllDescriptors**(): readonly [`ProviderDescriptor`](../type-aliases/ProviderDescriptor.md)[] -Defined in: [factories/providerFactory.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L307) - All built-in provider descriptors (does not include custom-registered providers that lack a descriptor). #### Returns @@ -194,8 +178,6 @@ readonly [`ProviderDescriptor`](../type-aliases/ProviderDescriptor.md)[] > `static` **normalizeProviderName**(`providerName`): `string` \| `null` -Defined in: [factories/providerFactory.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L314) - Normalize provider names using aliases (PHASE 1: Factory Pattern) #### Parameters @@ -214,8 +196,6 @@ Normalize provider names using aliases (PHASE 1: Factory Pattern) > `static` **clearRegistrations**(): `void` -Defined in: [factories/providerFactory.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L336) - Clear all registrations (mainly for testing) #### Returns @@ -228,8 +208,6 @@ Clear all registrations (mainly for testing) > `static` **createBestProvider**(`providerName`, `modelName?`, `enableMCP?`, `sdk?`, `credentials?`): `Promise`\<[`AIProvider`](../type-aliases/AIProvider.md)\> -Defined in: [factories/providerFactory.ts:366](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerFactory.ts#L366) - Create the best available provider for the given name Used by NeuroLink SDK for streaming and generation diff --git a/docs/api/classes/ProviderRegistry.md b/docs/api/classes/ProviderRegistry.md index 8d8a564c7..ce443f2b3 100644 --- a/docs/api/classes/ProviderRegistry.md +++ b/docs/api/classes/ProviderRegistry.md @@ -6,8 +6,6 @@ # Class: ProviderRegistry -Defined in: [factories/providerRegistry.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerRegistry.ts#L41) - Provider Registry - registers all providers with the factory This is where we migrate providers one by one to the new pattern @@ -27,8 +25,6 @@ This is where we migrate providers one by one to the new pattern > `static` **realtimeRegistration**: `Record`\<`string`, `"ok"` \| `string`\> = `{}` -Defined in: [factories/providerRegistry.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerRegistry.ts#L52) - NEW4: per-handler registration outcomes for the realtime voice providers. `"ok"` = registered; any other string = the error message. Empty until the first `registerAllProviders()` call. @@ -39,8 +35,6 @@ Empty until the first `registerAllProviders()` call. > `static` **getRegistrationReport**(): `object` -Defined in: [factories/providerRegistry.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerRegistry.ts#L59) - Returns a snapshot of voice provider registration outcomes so callers can detect at runtime which voice handlers are usable. Useful in health-check endpoints and CI startup probes. @@ -59,8 +53,6 @@ health-check endpoints and CI startup probes. > `static` **registerAllProviders**(): `Promise`\<`void`\> -Defined in: [factories/providerRegistry.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerRegistry.ts#L66) - Register all providers with the factory #### Returns @@ -73,8 +65,6 @@ Register all providers with the factory > `static` **isRegistered**(): `boolean` -Defined in: [factories/providerRegistry.ts:825](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerRegistry.ts#L825) - Check if providers are registered #### Returns @@ -87,8 +77,6 @@ Check if providers are registered > `static` **clearRegistrations**(): `void` -Defined in: [factories/providerRegistry.ts:832](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerRegistry.ts#L832) - Clear registrations (for testing) #### Returns @@ -101,8 +89,6 @@ Clear registrations (for testing) > `static` **setOptions**(`options`): `void` -Defined in: [factories/providerRegistry.ts:845](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerRegistry.ts#L845) - Set registry options (should be called before initialization) #### Parameters @@ -121,8 +107,6 @@ Set registry options (should be called before initialization) > `static` **getOptions**(): [`ProviderRegistryOptions`](../type-aliases/ProviderRegistryOptions.md) -Defined in: [factories/providerRegistry.ts:853](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerRegistry.ts#L853) - Get current registry options #### Returns diff --git a/docs/api/classes/RAGASEvaluator.md b/docs/api/classes/RAGASEvaluator.md index bd0debf88..171fd2ed0 100644 --- a/docs/api/classes/RAGASEvaluator.md +++ b/docs/api/classes/RAGASEvaluator.md @@ -6,8 +6,6 @@ # Class: RAGASEvaluator -Defined in: [evaluation/ragasEvaluator.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/ragasEvaluator.ts#L22) - Implements a RAGAS-style evaluator that uses a "judge" LLM to score the quality of an AI response based on rich, contextual information. @@ -17,8 +15,6 @@ quality of an AI response based on rich, contextual information. > **new RAGASEvaluator**(`evaluationModel?`, `providerName?`, `threshold?`, `promptGenerator?`): `RAGASEvaluator` -Defined in: [evaluation/ragasEvaluator.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/ragasEvaluator.ts#L29) - #### Parameters ##### evaluationModel? @@ -47,8 +43,6 @@ Defined in: [evaluation/ragasEvaluator.ts:29](https://github.com/juspay/neurolin > **evaluate**(`context`): `Promise`\<[`EvaluationResult`](../type-aliases/EvaluationResult.md)\> -Defined in: [evaluation/ragasEvaluator.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/ragasEvaluator.ts#L55) - Evaluates an AI-generated response using a model-based approach. #### Parameters diff --git a/docs/api/classes/RAGCircuitBreaker.md b/docs/api/classes/RAGCircuitBreaker.md index 9f4bd92de..dd04bbe3d 100644 --- a/docs/api/classes/RAGCircuitBreaker.md +++ b/docs/api/classes/RAGCircuitBreaker.md @@ -6,8 +6,6 @@ # Class: RAGCircuitBreaker -Defined in: [rag/resilience/CircuitBreaker.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L38) - RAG Circuit Breaker Provides circuit breaker pattern implementation for RAG operations @@ -23,8 +21,6 @@ with comprehensive statistics and event handling. > **new RAGCircuitBreaker**(`name`, `config?`): `RAGCircuitBreaker` -Defined in: [rag/resilience/CircuitBreaker.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L47) - #### Parameters ##### name @@ -49,8 +45,6 @@ Defined in: [rag/resilience/CircuitBreaker.ts:47](https://github.com/juspay/neur > **on**\<`K`\>(`event`, `listener`): `this` -Defined in: [core/infrastructure/typedEventEmitter.ts:6](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L6) - #### Type Parameters ##### K @@ -81,8 +75,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:6](https://github.com/jusp > **off**\<`K`\>(`event`, `listener`): `this` -Defined in: [core/infrastructure/typedEventEmitter.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L14) - #### Type Parameters ##### K @@ -113,8 +105,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:14](https://github.com/jus > **emit**\<`K`\>(`event`, ...`args`): `boolean` -Defined in: [core/infrastructure/typedEventEmitter.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L22) - #### Type Parameters ##### K @@ -145,8 +135,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:22](https://github.com/jus > **once**\<`K`\>(`event`, `listener`): `this` -Defined in: [core/infrastructure/typedEventEmitter.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L26) - #### Type Parameters ##### K @@ -177,8 +165,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:26](https://github.com/jus > **removeAllListeners**\<`K`\>(`event?`): `this` -Defined in: [core/infrastructure/typedEventEmitter.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L37) - #### Type Parameters ##### K @@ -205,8 +191,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:37](https://github.com/jus > **execute**\<`T`\>(`operation`, `operationType?`): `Promise`\<`T`\> -Defined in: [rag/resilience/CircuitBreaker.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L61) - Execute an operation with circuit breaker protection #### Type Parameters @@ -235,8 +219,6 @@ Execute an operation with circuit breaker protection > **getStats**(): [`RAGCircuitBreakerStats`](../type-aliases/RAGCircuitBreakerStats.md) -Defined in: [rag/resilience/CircuitBreaker.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L303) - Get current statistics #### Returns @@ -249,8 +231,6 @@ Get current statistics > **reset**(): `void` -Defined in: [rag/resilience/CircuitBreaker.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L344) - Manually reset the circuit breaker #### Returns @@ -263,8 +243,6 @@ Manually reset the circuit breaker > **forceOpen**(`reason?`): `void` -Defined in: [rag/resilience/CircuitBreaker.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L354) - Force open the circuit breaker #### Parameters @@ -283,8 +261,6 @@ Force open the circuit breaker > **getName**(): `string` -Defined in: [rag/resilience/CircuitBreaker.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L362) - Get circuit breaker name #### Returns @@ -297,8 +273,6 @@ Get circuit breaker name > **isOpen**(): `boolean` -Defined in: [rag/resilience/CircuitBreaker.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L369) - Check if circuit is open #### Returns @@ -311,8 +285,6 @@ Check if circuit is open > **isClosed**(): `boolean` -Defined in: [rag/resilience/CircuitBreaker.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L376) - Check if circuit is closed #### Returns @@ -325,8 +297,6 @@ Check if circuit is closed > **isHalfOpen**(): `boolean` -Defined in: [rag/resilience/CircuitBreaker.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L383) - Check if circuit is half-open #### Returns @@ -339,8 +309,6 @@ Check if circuit is half-open > **getState**(): [`CircuitState`](../type-aliases/CircuitState.md) -Defined in: [rag/resilience/CircuitBreaker.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L390) - Get current state #### Returns @@ -353,8 +321,6 @@ Get current state > **destroy**(): `void` -Defined in: [rag/resilience/CircuitBreaker.ts:397](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L397) - Destroy the circuit breaker and clean up resources #### Returns diff --git a/docs/api/classes/RAGCircuitBreakerManager.md b/docs/api/classes/RAGCircuitBreakerManager.md index ad1b12c2e..b42b8a5dd 100644 --- a/docs/api/classes/RAGCircuitBreakerManager.md +++ b/docs/api/classes/RAGCircuitBreakerManager.md @@ -6,8 +6,6 @@ # Class: RAGCircuitBreakerManager -Defined in: [rag/resilience/CircuitBreaker.ts:411](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L411) - Circuit breaker manager for RAG operations ## Constructors @@ -26,8 +24,6 @@ Circuit breaker manager for RAG operations > **getBreaker**(`name`, `config?`): [`RAGCircuitBreaker`](RAGCircuitBreaker.md) -Defined in: [rag/resilience/CircuitBreaker.ts:417](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L417) - Get or create a circuit breaker #### Parameters @@ -50,8 +46,6 @@ Get or create a circuit breaker > **removeBreaker**(`name`): `boolean` -Defined in: [rag/resilience/CircuitBreaker.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L439) - Remove a circuit breaker #### Parameters @@ -70,8 +64,6 @@ Remove a circuit breaker > **getBreakerNames**(): `string`[] -Defined in: [rag/resilience/CircuitBreaker.ts:455](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L455) - Get all circuit breaker names #### Returns @@ -84,8 +76,6 @@ Get all circuit breaker names > **getAllStats**(): `Record`\<`string`, [`RAGCircuitBreakerStats`](../type-aliases/RAGCircuitBreakerStats.md)\> -Defined in: [rag/resilience/CircuitBreaker.ts:462](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L462) - Get statistics for all circuit breakers #### Returns @@ -98,8 +88,6 @@ Get statistics for all circuit breakers > **resetAll**(): `void` -Defined in: [rag/resilience/CircuitBreaker.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L473) - Reset all circuit breakers #### Returns @@ -112,8 +100,6 @@ Reset all circuit breakers > **getHealthSummary**(): `object` -Defined in: [rag/resilience/CircuitBreaker.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L483) - Get health summary #### Returns @@ -146,8 +132,6 @@ Get health summary > **destroyAll**(): `void` -Defined in: [rag/resilience/CircuitBreaker.ts:523](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L523) - Destroy all circuit breakers #### Returns diff --git a/docs/api/classes/RAGJSONChunker.md b/docs/api/classes/RAGJSONChunker.md index 2445f4bda..93b268008 100644 --- a/docs/api/classes/RAGJSONChunker.md +++ b/docs/api/classes/RAGJSONChunker.md @@ -6,8 +6,6 @@ # Class: RAGJSONChunker -Defined in: [rag/chunking/jsonChunker.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/jsonChunker.ts#L22) - JSON-aware chunker implementation Splits based on JSON structure @@ -31,8 +29,6 @@ Splits based on JSON structure > `readonly` **strategy**: `"json"` -Defined in: [rag/chunking/jsonChunker.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/jsonChunker.ts#L23) - Strategy name for identification #### Implementation of @@ -45,8 +41,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/jsonChunker.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/jsonChunker.ts#L25) - Split text into chunks #### Parameters @@ -79,8 +73,6 @@ Array of chunks > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/jsonChunker.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/jsonChunker.ts#L320) - #### Parameters ##### config diff --git a/docs/api/classes/RAGPipeline.md b/docs/api/classes/RAGPipeline.md index 84bddaabf..f5b739d3f 100644 --- a/docs/api/classes/RAGPipeline.md +++ b/docs/api/classes/RAGPipeline.md @@ -6,8 +6,6 @@ # Class: RAGPipeline -Defined in: [rag/pipeline/RAGPipeline.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L93) - RAG (Retrieval-Augmented Generation) Document Processing Comprehensive RAG system with document loading, chunking, embedding, @@ -43,8 +41,6 @@ console.log(response.answer); > **new RAGPipeline**(`config`): `RAGPipeline` -Defined in: [rag/pipeline/RAGPipeline.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L116) - #### Parameters ##### config @@ -61,8 +57,6 @@ Defined in: [rag/pipeline/RAGPipeline.ts:116](https://github.com/juspay/neurolin > **initialize**(): `Promise`\<`void`\> -Defined in: [rag/pipeline/RAGPipeline.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L161) - Initialize the pipeline (lazy loading of providers) #### Returns @@ -75,8 +69,6 @@ Initialize the pipeline (lazy loading of providers) > **ingest**(`sources`, `options?`): `Promise`\<\{ `documentsProcessed`: `number`; `chunksCreated`: `number`; \}\> -Defined in: [rag/pipeline/RAGPipeline.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L208) - Ingest documents into the pipeline #### Parameters @@ -103,8 +95,6 @@ Ingestion options > **query**(`query`, `options?`): `Promise`\<[`RAGResponse`](../type-aliases/RAGResponse.md)\> -Defined in: [rag/pipeline/RAGPipeline.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L335) - Query the pipeline #### Parameters @@ -133,8 +123,6 @@ RAG response with retrieved context and optional generated answer > **getStats**(): [`PipelineStats`](../type-aliases/PipelineStats.md) -Defined in: [rag/pipeline/RAGPipeline.ts:541](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L541) - Get pipeline statistics #### Returns @@ -147,8 +135,6 @@ Get pipeline statistics > **getId**(): `string` -Defined in: [rag/pipeline/RAGPipeline.ts:555](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L555) - Get pipeline ID #### Returns @@ -161,8 +147,6 @@ Get pipeline ID > **clear**(): `Promise`\<`void`\> -Defined in: [rag/pipeline/RAGPipeline.ts:562](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L562) - Clear all indexed data #### Returns @@ -175,8 +159,6 @@ Clear all indexed data > **ingestImages**(`sources`, `options?`): `Promise`\<\{ `imagesProcessed`: `number`; `chunksCreated`: `number`; \}\> -Defined in: [rag/pipeline/RAGPipeline.ts:587](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L587) - Ingest images into the pipeline for multi-modal RAG. Loads images, generates embeddings via the configured multi-modal provider, and stores them alongside text chunks in the vector store. @@ -205,8 +187,6 @@ Ingestion options > **queryMultiModal**(`query`, `options?`): `Promise`\<[`MultiModalSearchResult`](../type-aliases/MultiModalSearchResult.md)[]\> -Defined in: [rag/pipeline/RAGPipeline.ts:804](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L804) - Query the pipeline with multi-modal input (text, image, or both). #### Parameters @@ -235,8 +215,6 @@ Array of multi-modal search results > **getMultiModalStats**(): `object` -Defined in: [rag/pipeline/RAGPipeline.ts:885](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L885) - Get multi-modal pipeline statistics #### Returns diff --git a/docs/api/classes/RAGRetryHandler.md b/docs/api/classes/RAGRetryHandler.md index 8cddaaa08..5d8bf19fc 100644 --- a/docs/api/classes/RAGRetryHandler.md +++ b/docs/api/classes/RAGRetryHandler.md @@ -6,8 +6,6 @@ # Class: RAGRetryHandler -Defined in: [rag/resilience/RetryHandler.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/RetryHandler.ts#L221) - RAG Retry Handler class for more complex retry scenarios ## Constructors @@ -16,8 +14,6 @@ RAG Retry Handler class for more complex retry scenarios > **new RAGRetryHandler**(`config?`): `RAGRetryHandler` -Defined in: [rag/resilience/RetryHandler.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/RetryHandler.ts#L224) - #### Parameters ##### config? @@ -34,8 +30,6 @@ Defined in: [rag/resilience/RetryHandler.ts:224](https://github.com/juspay/neuro > **executeWithRetry**\<`T`\>(`operation`, `maxRetries?`): `Promise`\<`T`\> -Defined in: [rag/resilience/RetryHandler.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/RetryHandler.ts#L231) - Execute an operation with retry logic #### Type Parameters @@ -64,8 +58,6 @@ Execute an operation with retry logic > **executeBatch**\<`T`, `R`\>(`items`, `operation`, `options?`): `Promise`\<\{ `successful`: `object`[]; `failed`: `object`[]; `successRate`: `number`; \}\> -Defined in: [rag/resilience/RetryHandler.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/RetryHandler.ts#L244) - Execute multiple operations with retry, collecting results Returns successful results and failed operations with their errors @@ -109,8 +101,6 @@ Returns successful results and failed operations with their errors > **getConfig**(): [`RAGRetryConfig`](../type-aliases/RAGRetryConfig.md) -Defined in: [rag/resilience/RetryHandler.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/RetryHandler.ts#L294) - Get current configuration #### Returns @@ -123,8 +113,6 @@ Get current configuration > **updateConfig**(`config`): `void` -Defined in: [rag/resilience/RetryHandler.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/RetryHandler.ts#L301) - Update configuration #### Parameters diff --git a/docs/api/classes/RateLimitError.md b/docs/api/classes/RateLimitError.md index fb4198372..9e177941f 100644 --- a/docs/api/classes/RateLimitError.md +++ b/docs/api/classes/RateLimitError.md @@ -6,8 +6,6 @@ # Class: RateLimitError -Defined in: [types/errors.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L60) - Thrown when an API rate limit has been exceeded. ## Extends @@ -20,8 +18,6 @@ Thrown when an API rate limit has been exceeded. > **new RateLimitError**(`message`, `provider?`): `RateLimitError` -Defined in: [types/errors.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L61) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [types/errors.ts:61](https://github.com/juspay/neurolink/blob/releas > `optional` **provider?**: `string` -Defined in: [types/errors.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L18) - #### Inherited from [`ProviderError`](ProviderError.md).[`provider`](ProviderError.md#provider) diff --git a/docs/api/classes/RateLimiterManager.md b/docs/api/classes/RateLimiterManager.md index 2c5eaef8d..0a9898ad2 100644 --- a/docs/api/classes/RateLimiterManager.md +++ b/docs/api/classes/RateLimiterManager.md @@ -6,8 +6,6 @@ # Class: RateLimiterManager -Defined in: [mcp/httpRateLimiter.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L350) - RateLimiterManager Manages multiple rate limiters for different servers Each server can have its own rate limiting configuration @@ -28,8 +26,6 @@ Each server can have its own rate limiting configuration > **getLimiter**(`serverId`, `config?`): [`HTTPRateLimiter`](HTTPRateLimiter.md) -Defined in: [mcp/httpRateLimiter.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L360) - Get or create a rate limiter for a server #### Parameters @@ -58,8 +54,6 @@ HTTPRateLimiter instance for the server > **hasLimiter**(`serverId`): `boolean` -Defined in: [mcp/httpRateLimiter.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L387) - Check if a rate limiter exists for a server #### Parameters @@ -82,8 +76,6 @@ true if a rate limiter exists for the server > **removeLimiter**(`serverId`): `void` -Defined in: [mcp/httpRateLimiter.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L396) - Remove a rate limiter for a server #### Parameters @@ -104,8 +96,6 @@ Unique identifier for the server > **getServerIds**(): `string`[] -Defined in: [mcp/httpRateLimiter.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L413) - Get all server IDs with active rate limiters #### Returns @@ -120,8 +110,6 @@ Array of server IDs > **getAllStats**(): `Record`\<`string`, [`RateLimiterStats`](../type-aliases/RateLimiterStats.md)\> -Defined in: [mcp/httpRateLimiter.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L422) - Get statistics for all rate limiters #### Returns @@ -136,8 +124,6 @@ Record of server IDs to their rate limiter statistics > **resetAll**(): `void` -Defined in: [mcp/httpRateLimiter.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L435) - Reset all rate limiters #### Returns @@ -150,8 +136,6 @@ Reset all rate limiters > **destroyAll**(): `void` -Defined in: [mcp/httpRateLimiter.ts:447](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L447) - Destroy all rate limiters and clean up resources This should be called during application shutdown @@ -165,8 +149,6 @@ This should be called during application shutdown > **getHealthSummary**(): `object` -Defined in: [mcp/httpRateLimiter.ts:459](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRateLimiter.ts#L459) - Get health summary for all rate limiters #### Returns diff --git a/docs/api/classes/RealtimeError.md b/docs/api/classes/RealtimeError.md index b19a4236c..69bbe878f 100644 --- a/docs/api/classes/RealtimeError.md +++ b/docs/api/classes/RealtimeError.md @@ -6,8 +6,6 @@ # Class: RealtimeError -Defined in: [voice/errors.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L244) - Realtime Voice Error class for realtime-specific errors ## Extends @@ -20,8 +18,6 @@ Realtime Voice Error class for realtime-specific errors > **new RealtimeError**(`options`): `RealtimeError` -Defined in: [voice/errors.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L245) - #### Parameters ##### options @@ -42,8 +38,6 @@ Defined in: [voice/errors.ts:245](https://github.com/juspay/neurolink/blob/relea > `readonly` **code**: `string` -Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L105) - #### Inherited from [`VoiceError`](VoiceError.md).[`code`](VoiceError.md#code) @@ -54,8 +48,6 @@ Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blo > `readonly` **category**: `ErrorCategory` -Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L106) - #### Inherited from [`VoiceError`](VoiceError.md).[`category`](VoiceError.md#category) @@ -66,8 +58,6 @@ Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blo > `readonly` **severity**: `ErrorSeverity` -Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L107) - #### Inherited from [`VoiceError`](VoiceError.md).[`severity`](VoiceError.md#severity) @@ -78,8 +68,6 @@ Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blo > `readonly` **retriable**: `boolean` -Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L108) - #### Inherited from [`VoiceError`](VoiceError.md).[`retriable`](VoiceError.md#retriable) @@ -90,8 +78,6 @@ Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blo > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L109) - #### Inherited from [`VoiceError`](VoiceError.md).[`retryAfterMs`](VoiceError.md#retryafterms) @@ -102,8 +88,6 @@ Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blo > `readonly` **context**: `Record`\<`string`, `unknown`\> -Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L110) - #### Inherited from [`VoiceError`](VoiceError.md).[`context`](VoiceError.md#context) @@ -114,8 +98,6 @@ Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blo > `readonly` **timestamp**: `Date` -Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L111) - #### Inherited from [`VoiceError`](VoiceError.md).[`timestamp`](VoiceError.md#timestamp) @@ -126,8 +108,6 @@ Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blo > `readonly` `optional` **toolName?**: `string` -Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L112) - #### Inherited from [`VoiceError`](VoiceError.md).[`toolName`](VoiceError.md#toolname) @@ -138,8 +118,6 @@ Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blo > `readonly` `optional` **serverId?**: `string` -Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L113) - #### Inherited from [`VoiceError`](VoiceError.md).[`serverId`](VoiceError.md#serverid) @@ -150,8 +128,6 @@ Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blo > **toJSON**(): [`StructuredError`](../type-aliases/StructuredError.md) -Defined in: [utils/errorHandling.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L149) - Convert to JSON for logging and serialization #### Returns @@ -168,8 +144,6 @@ Convert to JSON for logging and serialization > `static` **connectionFailed**(`reason`, `providerOrError?`, `originalErrorOrProvider?`): `RealtimeError` -Defined in: [voice/errors.ts:261](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L261) - Create an error for connection failure Supports two signatures: @@ -200,8 +174,6 @@ Supports two signatures: > `static` **sessionTimeout**(`timeoutMs`, `provider?`): `RealtimeError` -Defined in: [voice/errors.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L299) - Create an error for session timeout #### Parameters @@ -224,8 +196,6 @@ Create an error for session timeout > `static` **protocolError**(`reason`, `provider?`, `originalError?`): `RealtimeError` -Defined in: [voice/errors.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L313) - Create an error for protocol errors #### Parameters @@ -252,8 +222,6 @@ Create an error for protocol errors > `static` **audioStreamError**(`reason`, `provider?`): `RealtimeError` -Defined in: [voice/errors.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L332) - Create an error for audio stream failures #### Parameters @@ -276,8 +244,6 @@ Create an error for audio stream failures > `static` **providerNotConfigured**(`provider`): `RealtimeError` -Defined in: [voice/errors.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L346) - Create an error for unconfigured provider #### Parameters @@ -296,8 +262,6 @@ Create an error for unconfigured provider > `static` **providerNotSupported**(`provider`, `availableProviders?`): `RealtimeError` -Defined in: [voice/errors.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L360) - Create an error for unsupported provider #### Parameters @@ -320,8 +284,6 @@ Create an error for unsupported provider > `static` **sessionAlreadyActive**(`provider?`): `RealtimeError` -Defined in: [voice/errors.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L377) - Create an error for duplicate session #### Parameters @@ -340,8 +302,6 @@ Create an error for duplicate session > `static` **sessionNotActive**(`provider?`): `RealtimeError` -Defined in: [voice/errors.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L391) - Create an error for no active session #### Parameters @@ -360,8 +320,6 @@ Create an error for no active session > `static` **invalidMessage**(`reason`, `provider?`): `RealtimeError` -Defined in: [voice/errors.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L405) - Create an error for invalid messages #### Parameters @@ -384,8 +342,6 @@ Create an error for invalid messages > `static` **connectionClosed**(`reason`, `sessionId?`, `provider?`): `RealtimeError` -Defined in: [voice/errors.ts:419](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L419) - Create an error for connection closed unexpectedly #### Parameters @@ -412,8 +368,6 @@ Create an error for connection closed unexpectedly > `static` **notConfigured**(`provider`): `RealtimeError` -Defined in: [voice/errors.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L437) - Create an error for unconfigured provider (alias) #### Parameters @@ -432,8 +386,6 @@ Create an error for unconfigured provider (alias) > `static` **timeout**(`operation`, `timeoutMs`, `provider?`): `RealtimeError` -Defined in: [voice/errors.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L444) - Create an error for operation timeout #### Parameters diff --git a/docs/api/classes/RealtimeProcessor.md b/docs/api/classes/RealtimeProcessor.md index d3857a555..e22b7a712 100644 --- a/docs/api/classes/RealtimeProcessor.md +++ b/docs/api/classes/RealtimeProcessor.md @@ -6,8 +6,6 @@ # Class: RealtimeProcessor -Defined in: [voice/RealtimeVoiceAPI.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L53) - Realtime Processor class for orchestrating realtime voice operations Provides a unified interface for realtime voice across multiple providers. @@ -49,8 +47,6 @@ await RealtimeProcessor.disconnect("openai-realtime"); > `static` **registerHandler**(`providerName`, `handler`): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L72) - Register a Realtime handler for a specific provider #### Parameters @@ -77,8 +73,6 @@ Realtime handler implementation > `static` **getHandler**(`providerName`): [`RealtimeHandler`](../type-aliases/RealtimeHandler.md) \| `undefined` -Defined in: [voice/RealtimeVoiceAPI.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L88) - Get a registered Realtime handler by provider name. Exposed publicly so module-level auto-registration code can reuse an @@ -100,8 +94,6 @@ already-registered primary handler when backfilling its aliases. > `static` **supports**(`providerName`): `boolean` -Defined in: [voice/RealtimeVoiceAPI.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L95) - Check if a provider is supported #### Parameters @@ -120,8 +112,6 @@ Check if a provider is supported > `static` **getProviders**(): `string`[] -Defined in: [voice/RealtimeVoiceAPI.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L102) - Get list of all registered providers #### Returns @@ -134,8 +124,6 @@ Get list of all registered providers > `static` **connect**(`provider`, `config`, `handlers?`): `Promise`\<[`RealtimeSession`](../type-aliases/RealtimeSession.md)\> -Defined in: [voice/RealtimeVoiceAPI.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L114) - Connect to a realtime session #### Parameters @@ -170,8 +158,6 @@ Session information > `static` **disconnect**(`provider`): `Promise`\<`void`\> -Defined in: [voice/RealtimeVoiceAPI.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L180) - Disconnect from a realtime session #### Parameters @@ -192,8 +178,6 @@ Provider identifier > `static` **sendAudio**(`provider`, `audio`): `Promise`\<`void`\> -Defined in: [voice/RealtimeVoiceAPI.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L221) - Send audio to a realtime session #### Parameters @@ -220,8 +204,6 @@ Audio data > `static` **sendText**(`provider`, `text`): `Promise`\<`void`\> -Defined in: [voice/RealtimeVoiceAPI.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L254) - Send text to a realtime session #### Parameters @@ -248,8 +230,6 @@ Text to send > `static` **triggerResponse**(`provider`): `Promise`\<`void`\> -Defined in: [voice/RealtimeVoiceAPI.ts:302](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L302) - Trigger a response from the model (manual turn detection) #### Parameters @@ -270,8 +250,6 @@ Provider identifier > `static` **cancelResponse**(`provider`): `Promise`\<`void`\> -Defined in: [voice/RealtimeVoiceAPI.ts:338](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L338) - Cancel the current response #### Parameters @@ -292,8 +270,6 @@ Provider identifier > `static` **getSession**(`provider`): [`RealtimeSession`](../type-aliases/RealtimeSession.md) \| `null` -Defined in: [voice/RealtimeVoiceAPI.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L375) - Get current session for a provider #### Parameters @@ -316,8 +292,6 @@ Session or null > `static` **isConnected**(`provider`): `boolean` -Defined in: [voice/RealtimeVoiceAPI.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L385) - Check if a provider has an active session #### Parameters @@ -338,8 +312,6 @@ Provider identifier > `static` **getSupportedFormats**(`provider`): [`TTSAudioFormat`](../type-aliases/TTSAudioFormat.md)[] -Defined in: [voice/RealtimeVoiceAPI.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L395) - Get supported formats for a provider #### Parameters @@ -360,8 +332,6 @@ Provider identifier > `static` **clearHandlers**(): `void` -Defined in: [voice/RealtimeVoiceAPI.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/voice/RealtimeVoiceAPI.ts#L403) - Clear all handlers and sessions (for testing) #### Returns diff --git a/docs/api/classes/RecursiveChunker.md b/docs/api/classes/RecursiveChunker.md index 5b80c3835..a7549ee80 100644 --- a/docs/api/classes/RecursiveChunker.md +++ b/docs/api/classes/RecursiveChunker.md @@ -6,8 +6,6 @@ # Class: RecursiveChunker -Defined in: [rag/chunking/recursiveChunker.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/recursiveChunker.ts#L22) - Recursive chunker implementation Smart splitting based on content structure using hierarchical separators @@ -31,8 +29,6 @@ Smart splitting based on content structure using hierarchical separators > `readonly` **strategy**: `"recursive"` -Defined in: [rag/chunking/recursiveChunker.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/recursiveChunker.ts#L23) - Strategy name for identification #### Implementation of @@ -45,8 +41,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/recursiveChunker.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/recursiveChunker.ts#L27) - Split text into chunks #### Parameters @@ -79,8 +73,6 @@ Array of chunks > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/recursiveChunker.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/recursiveChunker.ts#L175) - #### Parameters ##### config diff --git a/docs/api/classes/RedisArtifactStore.md b/docs/api/classes/RedisArtifactStore.md index d429f6c23..05349d763 100644 --- a/docs/api/classes/RedisArtifactStore.md +++ b/docs/api/classes/RedisArtifactStore.md @@ -6,8 +6,6 @@ # Class: RedisArtifactStore -Defined in: [artifacts/redisArtifactStore.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L145) - Redis-backed artifact store: shared across replicas, expired by TTL, range reads for ASCII payloads. @@ -29,8 +27,6 @@ const neurolink = new NeuroLink({ artifacts: { store } }); > **new RedisArtifactStore**(`config?`): `RedisArtifactStore` -Defined in: [artifacts/redisArtifactStore.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L158) - #### Parameters ##### config? @@ -54,8 +50,6 @@ meaningless here and ignored. > **generatePreview**(`payload`): `string` -Defined in: [artifacts/redisArtifactStore.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L172) - Generate a short preview string from a serialized payload. #### Parameters @@ -78,8 +72,6 @@ Generate a short preview string from a serialized payload. > **store**(`payload`, `meta`): `Promise`\<[`ArtifactRef`](../type-aliases/ArtifactRef.md)\> -Defined in: [artifacts/redisArtifactStore.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L176) - Persist a payload and return a lightweight reference. #### Parameters @@ -110,8 +102,6 @@ Descriptor without `createdAt` (assigned internally). > **retrieve**(`id`): `Promise`\<`string` \| `null`\> -Defined in: [artifacts/redisArtifactStore.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L214) - Retrieve the full payload by artifact ID. Returns `null` if the artifact is not found or has been cleaned up. @@ -135,8 +125,6 @@ Returns `null` if the artifact is not found or has been cleaned up. > **retrieveRange**(`id`, `range`): `Promise`\<[`ArtifactWindow`](../type-aliases/ArtifactWindow.md) \| `null`\> -Defined in: [artifacts/redisArtifactStore.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L223) - Retrieve one character window without materialising the whole payload. Optional. When present, `retrieve_context` and `readArtifact` call it for @@ -175,8 +163,6 @@ Returns `null` if the artifact is not found or has expired. > **delete**(`id`): `Promise`\<`void`\> -Defined in: [artifacts/redisArtifactStore.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L264) - Delete a single artifact. No-op if the ID does not exist. #### Parameters @@ -199,8 +185,6 @@ Delete a single artifact. No-op if the ID does not exist. > **cleanup**(`olderThanMs`): `Promise`\<`number`\> -Defined in: [artifacts/redisArtifactStore.ts:277](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L277) - Nothing to sweep: Redis expires every artifact `ttl` seconds after it was written, on every replica at once, which is what `cleanup()` on the local store could never do. @@ -225,8 +209,6 @@ store could never do. > **close**(): `Promise`\<`void`\> -Defined in: [artifacts/redisArtifactStore.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/redisArtifactStore.ts#L292) - Release this store's reference on the pooled connection. Waits for a connect that is still in flight: otherwise the reference it diff --git a/docs/api/classes/RedisRateLimitStorage.md b/docs/api/classes/RedisRateLimitStorage.md index 6e4f27f01..24e4eddaf 100644 --- a/docs/api/classes/RedisRateLimitStorage.md +++ b/docs/api/classes/RedisRateLimitStorage.md @@ -6,8 +6,6 @@ # Class: RedisRateLimitStorage -Defined in: [auth/middleware/rateLimitByUser.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L78) - Redis-backed storage for rate limiting (distributed deployments) ## Implements @@ -20,8 +18,6 @@ Redis-backed storage for rate limiting (distributed deployments) > **new RedisRateLimitStorage**(`config`): `RedisRateLimitStorage` -Defined in: [auth/middleware/rateLimitByUser.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L85) - #### Parameters ##### config @@ -54,8 +50,6 @@ When set, TTL will be at least ceil(windowMs/1000) so keys outlive the rate-limi > **getBucket**(`userId`): `Promise`\<[`TokenBucket`](../type-aliases/TokenBucket.md) \| `null`\> -Defined in: [auth/middleware/rateLimitByUser.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L125) - #### Parameters ##### userId @@ -76,8 +70,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:125](https://github.com/juspay/n > **setBucket**(`userId`, `bucket`): `Promise`\<`void`\> -Defined in: [auth/middleware/rateLimitByUser.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L142) - #### Parameters ##### userId @@ -102,8 +94,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:142](https://github.com/juspay/n > **deleteBucket**(`userId`): `Promise`\<`void`\> -Defined in: [auth/middleware/rateLimitByUser.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L152) - #### Parameters ##### userId @@ -124,8 +114,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:152](https://github.com/juspay/n > **atomicConsume**(`userId`, `limit`, `windowMs`, `nowMs`): `Promise`\<[`AtomicConsumeResult`](../type-aliases/AtomicConsumeResult.md) \| `null`\> -Defined in: [auth/middleware/rateLimitByUser.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L169) - Atomically refill and consume one token using a Redis Lua script. The entire read-modify-write cycle runs inside Redis as a single @@ -164,8 +152,6 @@ never read the same token count. > **healthCheck**(): `Promise`\<`boolean`\> -Defined in: [auth/middleware/rateLimitByUser.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L265) - #### Returns `Promise`\<`boolean`\> @@ -180,8 +166,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:265](https://github.com/juspay/n > **cleanup**(): `Promise`\<`void`\> -Defined in: [auth/middleware/rateLimitByUser.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L275) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/classes/RedisSessionStorage.md b/docs/api/classes/RedisSessionStorage.md index 307610555..a45e3db78 100644 --- a/docs/api/classes/RedisSessionStorage.md +++ b/docs/api/classes/RedisSessionStorage.md @@ -6,8 +6,6 @@ # Class: RedisSessionStorage -Defined in: [auth/sessionManager.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L125) - Redis session storage Distributed session storage using Redis. Suitable for multi-instance @@ -25,8 +23,6 @@ Note: Redis client must be provided or configured via environment. > **new RedisSessionStorage**(`config`): `RedisSessionStorage` -Defined in: [auth/sessionManager.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L132) - #### Parameters ##### config @@ -53,8 +49,6 @@ Defined in: [auth/sessionManager.ts:132](https://github.com/juspay/neurolink/blo > **get**(`sessionId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md) \| `null`\> -Defined in: [auth/sessionManager.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L189) - Get a session by ID #### Parameters @@ -77,8 +71,6 @@ Get a session by ID > **set**(`session`): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L226) - Store a session #### Parameters @@ -101,8 +93,6 @@ Store a session > **delete**(`sessionId`): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L254) - Delete a session #### Parameters @@ -125,8 +115,6 @@ Delete a session > **getUserSessions**(`userId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md)[]\> -Defined in: [auth/sessionManager.ts:288](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L288) - Get all sessions for a user #### Parameters @@ -149,8 +137,6 @@ Get all sessions for a user > **deleteUserSessions**(`userId`): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L308) - Delete all sessions for a user #### Parameters @@ -173,8 +159,6 @@ Delete all sessions for a user > **clear**(): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L323) - Clear all sessions (for cleanup) #### Returns @@ -191,8 +175,6 @@ Clear all sessions (for cleanup) > **isHealthy**(): `Promise`\<`boolean`\> -Defined in: [auth/sessionManager.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L345) - Health check #### Returns @@ -209,8 +191,6 @@ Health check > **disconnect**(): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L355) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/classes/RedisSkillStore.md b/docs/api/classes/RedisSkillStore.md index 71c637e0e..699b3253f 100644 --- a/docs/api/classes/RedisSkillStore.md +++ b/docs/api/classes/RedisSkillStore.md @@ -6,8 +6,6 @@ # Class: RedisSkillStore -Defined in: [skills/skillStoreRedis.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreRedis.ts#L27) - ## Implements - [`SkillStore`](../type-aliases/SkillStore.md) @@ -18,8 +16,6 @@ Defined in: [skills/skillStoreRedis.ts:27](https://github.com/juspay/neurolink/b > **new RedisSkillStore**(`config`): `RedisSkillStore` -Defined in: [skills/skillStoreRedis.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreRedis.ts#L39) - #### Parameters ##### config @@ -36,8 +32,6 @@ Defined in: [skills/skillStoreRedis.ts:39](https://github.com/juspay/neurolink/b > **getResource**(`id`, `resourcePath`): `Promise`\<`string` \| `null`\> -Defined in: [skills/skillStoreRedis.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreRedis.ts#L70) - Optional: fetch an auxiliary resource file bundled with a skill. `resourcePath` is relative to the skill (e.g. "references/forms.md"). Null when the skill or resource is absent. Stores without resource @@ -67,8 +61,6 @@ support simply omit this method. > **get**(`id`): `Promise`\<[`SkillDefinition`](../type-aliases/SkillDefinition.md) \| `null`\> -Defined in: [skills/skillStoreRedis.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreRedis.ts#L79) - Fetch one skill (with instructions) by id. Null when absent. #### Parameters @@ -91,8 +83,6 @@ Fetch one skill (with instructions) by id. Null when absent. > **put**(`skill`): `Promise`\<`void`\> -Defined in: [skills/skillStoreRedis.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreRedis.ts#L85) - Create or replace a skill. #### Parameters @@ -115,8 +105,6 @@ Create or replace a skill. > **delete**(`id`): `Promise`\<`void`\> -Defined in: [skills/skillStoreRedis.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreRedis.ts#L91) - Hard-remove a skill from storage. (Soft deletes go through put().) #### Parameters @@ -139,8 +127,6 @@ Hard-remove a skill from storage. (Soft deletes go through put().) > **index**(): `Promise`\<[`SkillIndexItem`](../type-aliases/SkillIndexItem.md)[]\> -Defined in: [skills/skillStoreRedis.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreRedis.ts#L96) - List index entries (no instructions) for all stored skills. #### Returns diff --git a/docs/api/classes/ReplicateAvatar.md b/docs/api/classes/ReplicateAvatar.md index bef7837f8..a8d31391e 100644 --- a/docs/api/classes/ReplicateAvatar.md +++ b/docs/api/classes/ReplicateAvatar.md @@ -6,8 +6,6 @@ # Class: ReplicateAvatar -Defined in: [avatar/providers/ReplicateAvatar.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/ReplicateAvatar.ts#L46) - Replicate Avatar Handler. MuseTalk requires both `image` and `audio` inputs — `text`-only is not @@ -33,8 +31,6 @@ supported here (use D-ID for that, or chain TTS + this handler). > `readonly` **maxAudioDurationSeconds**: `60` = `60` -Defined in: [avatar/providers/ReplicateAvatar.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/ReplicateAvatar.ts#L47) - Maximum supported audio length in seconds (provider-specific). #### Implementation of @@ -47,8 +43,6 @@ Maximum supported audio length in seconds (provider-specific). > `readonly` **supportedFormats**: readonly [`AvatarVideoFormat`](../type-aliases/AvatarVideoFormat.md)[] -Defined in: [avatar/providers/ReplicateAvatar.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/ReplicateAvatar.ts#L48) - Output formats supported by this handler. #### Implementation of @@ -61,8 +55,6 @@ Output formats supported by this handler. > **isConfigured**(): `boolean` -Defined in: [avatar/providers/ReplicateAvatar.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/ReplicateAvatar.ts#L50) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -79,8 +71,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`options`): `Promise`\<[`AvatarResult`](../type-aliases/AvatarResult.md)\> -Defined in: [avatar/providers/ReplicateAvatar.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/providers/ReplicateAvatar.ts#L54) - Generate a talking-head video from an image + audio (or pre-rendered text). #### Parameters diff --git a/docs/api/classes/ReplicateMusic.md b/docs/api/classes/ReplicateMusic.md index 883a0205f..f58ddb16b 100644 --- a/docs/api/classes/ReplicateMusic.md +++ b/docs/api/classes/ReplicateMusic.md @@ -6,8 +6,6 @@ # Class: ReplicateMusic -Defined in: [music/providers/ReplicateMusic.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ReplicateMusic.ts#L32) - ## Implements - [`MusicHandler`](../type-aliases/MusicHandler.md) @@ -28,8 +26,6 @@ Defined in: [music/providers/ReplicateMusic.ts:32](https://github.com/juspay/neu > `readonly` **maxDurationSeconds**: `30` = `30` -Defined in: [music/providers/ReplicateMusic.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ReplicateMusic.ts#L33) - Maximum supported track duration in seconds (provider-specific). #### Implementation of @@ -42,8 +38,6 @@ Maximum supported track duration in seconds (provider-specific). > `readonly` **supportedFormats**: readonly [`MusicAudioFormat`](../type-aliases/MusicAudioFormat.md)[] -Defined in: [music/providers/ReplicateMusic.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ReplicateMusic.ts#L34) - Output formats supported by this handler. #### Implementation of @@ -56,8 +50,6 @@ Output formats supported by this handler. > `readonly` **supportedGenres**: readonly `string`[] -Defined in: [music/providers/ReplicateMusic.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ReplicateMusic.ts#L38) - Genres / styles the upstream advertises (informational). #### Implementation of @@ -70,8 +62,6 @@ Genres / styles the upstream advertises (informational). > **isConfigured**(): `boolean` -Defined in: [music/providers/ReplicateMusic.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ReplicateMusic.ts#L51) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -88,8 +78,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`options`): `Promise`\<[`MusicResult`](../type-aliases/MusicResult.md)\> -Defined in: [music/providers/ReplicateMusic.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/music/providers/ReplicateMusic.ts#L55) - Generate a music track from prompt + options. #### Parameters diff --git a/docs/api/classes/ReplicateVideoHandler.md b/docs/api/classes/ReplicateVideoHandler.md index e2fcecfaa..4340f2ec4 100644 --- a/docs/api/classes/ReplicateVideoHandler.md +++ b/docs/api/classes/ReplicateVideoHandler.md @@ -6,8 +6,6 @@ # Class: ReplicateVideoHandler -Defined in: [adapters/video/replicateVideoHandler.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/replicateVideoHandler.ts#L37) - Replicate Video Handler. Capabilities depend on the specific Replicate model — this handler @@ -24,8 +22,6 @@ resolution; up to 10s typical for Wan-Alpha). > **new ReplicateVideoHandler**(`credentials?`): `ReplicateVideoHandler` -Defined in: [adapters/video/replicateVideoHandler.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/replicateVideoHandler.ts#L50) - #### Parameters ##### credentials? @@ -56,8 +52,6 @@ Defined in: [adapters/video/replicateVideoHandler.ts:50](https://github.com/jusp > `readonly` **maxDurationSeconds**: `10` = `10` -Defined in: [adapters/video/replicateVideoHandler.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/replicateVideoHandler.ts#L38) - Maximum video duration in seconds supported by this provider. #### Implementation of @@ -70,8 +64,6 @@ Maximum video duration in seconds supported by this provider. > `readonly` **supportedAspectRatios**: readonly (`"9:16"` \| `"16:9"` \| `"1:1"`)[] -Defined in: [adapters/video/replicateVideoHandler.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/replicateVideoHandler.ts#L39) - Supported aspect ratios. #### Implementation of @@ -84,8 +76,6 @@ Supported aspect ratios. > `readonly` **supportedResolutions**: readonly (`"720p"` \| `"1080p"`)[] -Defined in: [adapters/video/replicateVideoHandler.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/replicateVideoHandler.ts#L41) - Supported output resolutions. #### Implementation of @@ -98,8 +88,6 @@ Supported output resolutions. > **isConfigured**(): `boolean` -Defined in: [adapters/video/replicateVideoHandler.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/replicateVideoHandler.ts#L54) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -116,8 +104,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`image`, `prompt`, `options`): `Promise`\<[`VideoGenerationResult`](../type-aliases/VideoGenerationResult.md)\> -Defined in: [adapters/video/replicateVideoHandler.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/replicateVideoHandler.ts#L58) - Generate a single video clip from an input image and prompt. #### Parameters diff --git a/docs/api/classes/ReportGenerator.md b/docs/api/classes/ReportGenerator.md index 1f6638aed..113d5a075 100644 --- a/docs/api/classes/ReportGenerator.md +++ b/docs/api/classes/ReportGenerator.md @@ -6,8 +6,6 @@ # Class: ReportGenerator -Defined in: [evaluation/reporting/reportGenerator.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/reportGenerator.ts#L27) - Report generator class ## Constructors @@ -16,8 +14,6 @@ Report generator class > **new ReportGenerator**(`config?`): `ReportGenerator` -Defined in: [evaluation/reporting/reportGenerator.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/reportGenerator.ts#L30) - #### Parameters ##### config? @@ -34,8 +30,6 @@ Defined in: [evaluation/reporting/reportGenerator.ts:30](https://github.com/jusp > **generate**(`data`): [`GeneratedReport`](../type-aliases/GeneratedReport.md) -Defined in: [evaluation/reporting/reportGenerator.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/reportGenerator.ts#L37) - Generate a report #### Parameters @@ -54,8 +48,6 @@ Generate a report > **configure**(`config`): `void` -Defined in: [evaluation/reporting/reportGenerator.ts:419](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/reportGenerator.ts#L419) - Update configuration #### Parameters diff --git a/docs/api/classes/RequestBatcher.md b/docs/api/classes/RequestBatcher.md index ac887862b..2458440d1 100644 --- a/docs/api/classes/RequestBatcher.md +++ b/docs/api/classes/RequestBatcher.md @@ -6,8 +6,6 @@ # Class: RequestBatcher\ -Defined in: [mcp/batching/requestBatcher.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L44) - Request Batcher - Efficient batch processing for MCP tool calls ## Example @@ -45,8 +43,6 @@ const result2 = await batcher.add("getUserById", { id: 2 }); > **new RequestBatcher**\<`T`\>(`config`): `RequestBatcher`\<`T`\> -Defined in: [mcp/batching/requestBatcher.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L55) - #### Parameters ##### config @@ -69,8 +65,6 @@ Defined in: [mcp/batching/requestBatcher.ts:55](https://github.com/juspay/neurol > **get** **queueSize**(): `number` -Defined in: [mcp/batching/requestBatcher.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L155) - Get current queue size ##### Returns @@ -85,8 +79,6 @@ Get current queue size > **get** **activeBatchCount**(): `number` -Defined in: [mcp/batching/requestBatcher.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L162) - Get number of active batches ##### Returns @@ -101,8 +93,6 @@ Get number of active batches > **get** **isIdle**(): `boolean` -Defined in: [mcp/batching/requestBatcher.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L169) - Check if the batcher is idle (no pending requests) ##### Returns @@ -115,8 +105,6 @@ Check if the batcher is idle (no pending requests) > **setExecutor**(`executor`): `void` -Defined in: [mcp/batching/requestBatcher.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L70) - Set the batch executor function #### Parameters @@ -135,8 +123,6 @@ Set the batch executor function > **add**(`tool`, `args`, `serverId?`): `Promise`\<`T`\> -Defined in: [mcp/batching/requestBatcher.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L77) - Add a request to the batch queue #### Parameters @@ -163,8 +149,6 @@ Add a request to the batch queue > **flush**(): `Promise`\<`void`\> -Defined in: [mcp/batching/requestBatcher.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L137) - Manually flush the current batch #### Returns @@ -177,8 +161,6 @@ Manually flush the current batch > **drain**(): `Promise`\<`void`\> -Defined in: [mcp/batching/requestBatcher.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L176) - Wait for all pending requests to complete #### Returns @@ -191,8 +173,6 @@ Wait for all pending requests to complete > **destroy**(): `void` -Defined in: [mcp/batching/requestBatcher.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L194) - Destroy the batcher and reject all pending requests #### Returns diff --git a/docs/api/classes/RequestContext.md b/docs/api/classes/RequestContext.md index 7764c5743..fa331d8a3 100644 --- a/docs/api/classes/RequestContext.md +++ b/docs/api/classes/RequestContext.md @@ -6,8 +6,6 @@ # Class: RequestContext\ -Defined in: [auth/RequestContext.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L13) - ## Type Parameters ### T @@ -20,8 +18,6 @@ Defined in: [auth/RequestContext.ts:13](https://github.com/juspay/neurolink/blob > **new RequestContext**\<`T`\>(`initial?`): `RequestContext`\<`T`\> -Defined in: [auth/RequestContext.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L18) - #### Parameters ##### initial? @@ -40,8 +36,6 @@ Defined in: [auth/RequestContext.ts:18](https://github.com/juspay/neurolink/blob > **get** **size**(): `number` -Defined in: [auth/RequestContext.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L46) - ##### Returns `number` @@ -52,8 +46,6 @@ Defined in: [auth/RequestContext.ts:46](https://github.com/juspay/neurolink/blob > **set**\<`K`\>(`key`, `value`): `void` -Defined in: [auth/RequestContext.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L30) - #### Type Parameters ##### K @@ -80,8 +72,6 @@ Defined in: [auth/RequestContext.ts:30](https://github.com/juspay/neurolink/blob > **get**\<`K`\>(`key`): `unknown` -Defined in: [auth/RequestContext.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L34) - #### Type Parameters ##### K @@ -104,8 +94,6 @@ Defined in: [auth/RequestContext.ts:34](https://github.com/juspay/neurolink/blob > **has**(`key`): `boolean` -Defined in: [auth/RequestContext.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L38) - #### Parameters ##### key @@ -122,8 +110,6 @@ Defined in: [auth/RequestContext.ts:38](https://github.com/juspay/neurolink/blob > **delete**(`key`): `boolean` -Defined in: [auth/RequestContext.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L42) - #### Parameters ##### key @@ -140,8 +126,6 @@ Defined in: [auth/RequestContext.ts:42](https://github.com/juspay/neurolink/blob > **mergeClientContext**(`clientContext`): `void` -Defined in: [auth/RequestContext.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L54) - Merge client-provided values, but SKIP reserved keys that are already set. This prevents clients from overriding auth middleware values. @@ -161,8 +145,6 @@ This prevents clients from overriding auth middleware values. > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [auth/RequestContext.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/auth/RequestContext.ts#L65) - #### Returns `Record`\<`string`, `unknown`\> diff --git a/docs/api/classes/RetryManager.md b/docs/api/classes/RetryManager.md index 719d34301..6e8cb4ce8 100644 --- a/docs/api/classes/RetryManager.md +++ b/docs/api/classes/RetryManager.md @@ -6,8 +6,6 @@ # Class: RetryManager -Defined in: [evaluation/retryManager.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/retryManager.ts#L15) - Manages the retry logic for the auto-evaluation middleware. It decides if a retry is warranted based on the evaluation score and prepares the options for the next generation attempt by incorporating feedback into the prompt. @@ -18,8 +16,6 @@ for the next generation attempt by incorporating feedback into the prompt. > **new RetryManager**(`maxRetries?`): `RetryManager` -Defined in: [evaluation/retryManager.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/retryManager.ts#L18) - #### Parameters ##### maxRetries? @@ -36,8 +32,6 @@ Defined in: [evaluation/retryManager.ts:18](https://github.com/juspay/neurolink/ > **shouldRetry**(`evaluation`): `boolean` -Defined in: [evaluation/retryManager.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/retryManager.ts#L29) - Determines if a retry should be attempted based on the evaluation result. #### Parameters @@ -60,8 +54,6 @@ The `EvaluationResult` of the last attempt. > **prepareRetryOptions**(`originalOptions`, `evaluation`): [`TextGenerationOptions`](../type-aliases/TextGenerationOptions.md) -Defined in: [evaluation/retryManager.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/retryManager.ts#L43) - Prepares the options for the next generation attempt by creating a new, improved prompt that includes feedback from the failed evaluation. diff --git a/docs/api/classes/RouteConflictError.md b/docs/api/classes/RouteConflictError.md index 6433af235..0879671ad 100644 --- a/docs/api/classes/RouteConflictError.md +++ b/docs/api/classes/RouteConflictError.md @@ -6,8 +6,6 @@ # Class: RouteConflictError -Defined in: [server/errors.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L133) - Route conflict error ## Extends @@ -20,8 +18,6 @@ Route conflict error > **new RouteConflictError**(`path`, `method`, `existingRoute?`): `RouteConflictError` -Defined in: [server/errors.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L134) - #### Parameters ##### path @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:134](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/RouteNotFoundError.md b/docs/api/classes/RouteNotFoundError.md index 1d76d5083..1280d22da 100644 --- a/docs/api/classes/RouteNotFoundError.md +++ b/docs/api/classes/RouteNotFoundError.md @@ -6,8 +6,6 @@ # Class: RouteNotFoundError -Defined in: [server/errors.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L154) - Route not found error ## Extends @@ -20,8 +18,6 @@ Route not found error > **new RouteNotFoundError**(`path`, `method`, `requestId?`): `RouteNotFoundError` -Defined in: [server/errors.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L155) - #### Parameters ##### path @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:155](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/RunwayVideoHandler.md b/docs/api/classes/RunwayVideoHandler.md index 8fd2974db..75c0d986e 100644 --- a/docs/api/classes/RunwayVideoHandler.md +++ b/docs/api/classes/RunwayVideoHandler.md @@ -6,8 +6,6 @@ # Class: RunwayVideoHandler -Defined in: [adapters/video/runwayVideoHandler.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/runwayVideoHandler.ts#L35) - Runway Video Handler. Auth: `Authorization: Bearer ${RUNWAY_API_KEY}` + `X-Runway-Version` @@ -23,8 +21,6 @@ header. Models: gen3a_turbo (Gen-3 Alpha Turbo, default), gen4_turbo. > **new RunwayVideoHandler**(`apiKey?`): `RunwayVideoHandler` -Defined in: [adapters/video/runwayVideoHandler.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/runwayVideoHandler.ts#L50) - #### Parameters ##### apiKey? @@ -41,8 +37,6 @@ Defined in: [adapters/video/runwayVideoHandler.ts:50](https://github.com/juspay/ > `readonly` **maxDurationSeconds**: `10` = `10` -Defined in: [adapters/video/runwayVideoHandler.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/runwayVideoHandler.ts#L36) - Maximum video duration in seconds supported by this provider. #### Implementation of @@ -55,8 +49,6 @@ Maximum video duration in seconds supported by this provider. > `readonly` **supportedAspectRatios**: readonly (`"9:16"` \| `"16:9"`)[] -Defined in: [adapters/video/runwayVideoHandler.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/runwayVideoHandler.ts#L37) - Supported aspect ratios. #### Implementation of @@ -69,8 +61,6 @@ Supported aspect ratios. > `readonly` **supportedResolutions**: readonly (`"720p"` \| `"1080p"`)[] -Defined in: [adapters/video/runwayVideoHandler.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/runwayVideoHandler.ts#L41) - Supported output resolutions. #### Implementation of @@ -83,8 +73,6 @@ Supported output resolutions. > **isConfigured**(): `boolean` -Defined in: [adapters/video/runwayVideoHandler.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/runwayVideoHandler.ts#L60) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -101,8 +89,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`image`, `prompt`, `options`): `Promise`\<[`VideoGenerationResult`](../type-aliases/VideoGenerationResult.md)\> -Defined in: [adapters/video/runwayVideoHandler.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/runwayVideoHandler.ts#L64) - Generate a single video clip from an input image and prompt. #### Parameters diff --git a/docs/api/classes/S3SkillStore.md b/docs/api/classes/S3SkillStore.md index 8b5a98369..c83e639be 100644 --- a/docs/api/classes/S3SkillStore.md +++ b/docs/api/classes/S3SkillStore.md @@ -6,8 +6,6 @@ # Class: S3SkillStore -Defined in: [skills/skillStoreS3.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreS3.ts#L168) - ## Implements - [`SkillStore`](../type-aliases/SkillStore.md) @@ -18,8 +16,6 @@ Defined in: [skills/skillStoreS3.ts:168](https://github.com/juspay/neurolink/blo > **new S3SkillStore**(`config`, `injectedOps?`): `S3SkillStore` -Defined in: [skills/skillStoreS3.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreS3.ts#L175) - #### Parameters ##### config @@ -42,8 +38,6 @@ Test/host seam — omit to build ops from @aws-sdk/client-s3 lazily. > **invalidate**(): `void` -Defined in: [skills/skillStoreS3.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreS3.ts#L185) - Optional: drop any internal caches (called after mutations). #### Returns @@ -60,8 +54,6 @@ Optional: drop any internal caches (called after mutations). > **getResource**(`id`, `resourcePath`): `Promise`\<`string` \| `null`\> -Defined in: [skills/skillStoreS3.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreS3.ts#L210) - Optional: fetch an auxiliary resource file bundled with a skill. `resourcePath` is relative to the skill (e.g. "references/forms.md"). Null when the skill or resource is absent. Stores without resource @@ -91,8 +83,6 @@ support simply omit this method. > **get**(`id`): `Promise`\<[`SkillDefinition`](../type-aliases/SkillDefinition.md) \| `null`\> -Defined in: [skills/skillStoreS3.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreS3.ts#L217) - Fetch one skill (with instructions) by id. Null when absent. #### Parameters @@ -115,8 +105,6 @@ Fetch one skill (with instructions) by id. Null when absent. > **put**(`skill`): `Promise`\<`void`\> -Defined in: [skills/skillStoreS3.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreS3.ts#L233) - Create or replace a skill. #### Parameters @@ -139,8 +127,6 @@ Create or replace a skill. > **delete**(`id`): `Promise`\<`void`\> -Defined in: [skills/skillStoreS3.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreS3.ts#L250) - Hard-remove a skill from storage. (Soft deletes go through put().) #### Parameters @@ -163,8 +149,6 @@ Hard-remove a skill from storage. (Soft deletes go through put().) > **index**(): `Promise`\<[`SkillIndexItem`](../type-aliases/SkillIndexItem.md)[]\> -Defined in: [skills/skillStoreS3.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStoreS3.ts#L258) - List index entries (no instructions) for all stored skills. #### Returns diff --git a/docs/api/classes/SSEClient.md b/docs/api/classes/SSEClient.md index c21043c95..9930afade 100644 --- a/docs/api/classes/SSEClient.md +++ b/docs/api/classes/SSEClient.md @@ -6,8 +6,6 @@ # Class: SSEClient -Defined in: [client/streamingClient.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L65) - Server-Sent Events (SSE) Client Provides a robust SSE connection with automatic reconnection, @@ -40,8 +38,6 @@ for await (const event of sse.events({ body: { prompt: "Hello" } })) { > **new SSEClient**(`url`, `options?`): `SSEClient` -Defined in: [client/streamingClient.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L74) - #### Parameters ##### url @@ -62,8 +58,6 @@ Defined in: [client/streamingClient.ts:74](https://github.com/juspay/neurolink/b > **connect**(`requestOptions?`): `Promise`\<`void`\> -Defined in: [client/streamingClient.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L87) - Connect to SSE endpoint #### Parameters @@ -88,8 +82,6 @@ Connect to SSE endpoint > **disconnect**(): `void` -Defined in: [client/streamingClient.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L179) - Disconnect from SSE endpoint #### Returns @@ -102,8 +94,6 @@ Disconnect from SSE endpoint > **on**(`event`, `callback`): `void` -Defined in: [client/streamingClient.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L326) - Register event handler #### Parameters @@ -126,8 +116,6 @@ Register event handler > **off**(`event`, `callback`): `void` -Defined in: [client/streamingClient.ts:338](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L338) - Remove event handler #### Parameters @@ -150,8 +138,6 @@ Remove event handler > **getState**(): [`SSEConnectionState`](../type-aliases/SSEConnectionState.md) -Defined in: [client/streamingClient.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L355) - Get current connection state #### Returns @@ -164,8 +150,6 @@ Get current connection state > **events**(`requestOptions?`): `AsyncGenerator`\<[`ClientStreamEvent`](../type-aliases/ClientStreamEvent.md), `void`, `unknown`\> -Defined in: [client/streamingClient.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L369) - Create async iterator for events #### Parameters diff --git a/docs/api/classes/STTError.md b/docs/api/classes/STTError.md index a5d90b8db..2667f376a 100644 --- a/docs/api/classes/STTError.md +++ b/docs/api/classes/STTError.md @@ -6,8 +6,6 @@ # Class: STTError -Defined in: [voice/errors.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L42) - STT Error class for speech-to-text specific errors ## Extends @@ -20,8 +18,6 @@ STT Error class for speech-to-text specific errors > **new STTError**(`options`): `STTError` -Defined in: [voice/errors.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L43) - #### Parameters ##### options @@ -42,8 +38,6 @@ Defined in: [voice/errors.ts:43](https://github.com/juspay/neurolink/blob/releas > `readonly` **code**: `string` -Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L105) - #### Inherited from [`VoiceError`](VoiceError.md).[`code`](VoiceError.md#code) @@ -54,8 +48,6 @@ Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blo > `readonly` **category**: `ErrorCategory` -Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L106) - #### Inherited from [`VoiceError`](VoiceError.md).[`category`](VoiceError.md#category) @@ -66,8 +58,6 @@ Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blo > `readonly` **severity**: `ErrorSeverity` -Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L107) - #### Inherited from [`VoiceError`](VoiceError.md).[`severity`](VoiceError.md#severity) @@ -78,8 +68,6 @@ Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blo > `readonly` **retriable**: `boolean` -Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L108) - #### Inherited from [`VoiceError`](VoiceError.md).[`retriable`](VoiceError.md#retriable) @@ -90,8 +78,6 @@ Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blo > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L109) - #### Inherited from [`VoiceError`](VoiceError.md).[`retryAfterMs`](VoiceError.md#retryafterms) @@ -102,8 +88,6 @@ Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blo > `readonly` **context**: `Record`\<`string`, `unknown`\> -Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L110) - #### Inherited from [`VoiceError`](VoiceError.md).[`context`](VoiceError.md#context) @@ -114,8 +98,6 @@ Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blo > `readonly` **timestamp**: `Date` -Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L111) - #### Inherited from [`VoiceError`](VoiceError.md).[`timestamp`](VoiceError.md#timestamp) @@ -126,8 +108,6 @@ Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blo > `readonly` `optional` **toolName?**: `string` -Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L112) - #### Inherited from [`VoiceError`](VoiceError.md).[`toolName`](VoiceError.md#toolname) @@ -138,8 +118,6 @@ Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blo > `readonly` `optional` **serverId?**: `string` -Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L113) - #### Inherited from [`VoiceError`](VoiceError.md).[`serverId`](VoiceError.md#serverid) @@ -150,8 +128,6 @@ Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blo > **toJSON**(): [`StructuredError`](../type-aliases/StructuredError.md) -Defined in: [utils/errorHandling.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L149) - Convert to JSON for logging and serialization #### Returns @@ -168,8 +144,6 @@ Convert to JSON for logging and serialization > `static` **audioEmpty**(`provider?`): `STTError` -Defined in: [voice/errors.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L56) - Create an error for empty audio input #### Parameters @@ -188,8 +162,6 @@ Create an error for empty audio input > `static` **audioTooLong**(`durationSeconds`, `maxDurationSeconds`, `provider?`): `STTError` -Defined in: [voice/errors.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L70) - Create an error for audio that exceeds maximum duration #### Parameters @@ -216,8 +188,6 @@ Create an error for audio that exceeds maximum duration > `static` **invalidFormat**(`format`, `supportedFormatsOrProvider?`, `provider?`): `STTError` -Defined in: [voice/errors.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L88) - Create an error for invalid audio format #### Parameters @@ -244,8 +214,6 @@ Create an error for invalid audio format > `static` **languageNotSupported**(`language`, `supportedLanguages?`, `provider?`): `STTError` -Defined in: [voice/errors.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L122) - Create an error for unsupported language #### Parameters @@ -272,8 +240,6 @@ Create an error for unsupported language > `static` **transcriptionFailed**(`reason`, `providerOrError?`, `originalErrorOrProvider?`): `STTError` -Defined in: [voice/errors.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L146) - Create an error for transcription failure Supports two signatures: @@ -304,8 +270,6 @@ Supports two signatures: > `static` **providerNotConfigured**(`provider`): `STTError` -Defined in: [voice/errors.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L184) - Create an error for unconfigured provider #### Parameters @@ -324,8 +288,6 @@ Create an error for unconfigured provider > `static` **providerNotSupported**(`provider`, `availableProviders?`): `STTError` -Defined in: [voice/errors.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L198) - Create an error for unsupported provider #### Parameters @@ -348,8 +310,6 @@ Create an error for unsupported provider > `static` **streamError**(`reason`, `provider?`): `STTError` -Defined in: [voice/errors.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L215) - Create an error for stream processing failure #### Parameters @@ -372,8 +332,6 @@ Create an error for stream processing failure > `static` **notConfigured**(`provider`): `STTError` -Defined in: [voice/errors.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L229) - Alias for providerNotConfigured #### Parameters @@ -392,8 +350,6 @@ Alias for providerNotConfigured > `static` **emptyAudio**(`provider?`): `STTError` -Defined in: [voice/errors.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L236) - Alias for audioEmpty #### Parameters diff --git a/docs/api/classes/STTProcessor.md b/docs/api/classes/STTProcessor.md index 6d40beb24..19c097484 100644 --- a/docs/api/classes/STTProcessor.md +++ b/docs/api/classes/STTProcessor.md @@ -6,8 +6,6 @@ # Class: STTProcessor -Defined in: [utils/sttProcessor.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/utils/sttProcessor.ts#L40) - STT processor class for orchestrating speech-to-text operations Follows the same pattern as TTSProcessor, CSVProcessor, ImageProcessor, and PDFProcessor. @@ -41,8 +39,6 @@ if (STTProcessor.supports("whisper")) { > `static` **registerHandler**(`providerName`, `handler`): `void` -Defined in: [utils/sttProcessor.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/utils/sttProcessor.ts#L80) - Register an STT handler for a specific provider Allows providers to register their STT implementation at runtime. @@ -83,8 +79,6 @@ STTProcessor.registerHandler('whisper', whisperHandler); > `static` **getHandler**(`providerName`): [`STTHandler`](../type-aliases/STTHandler.md) \| `undefined` -Defined in: [utils/sttProcessor.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/utils/sttProcessor.ts#L99) - Get a registered STT handler by provider name. Exposed publicly so module-level auto-registration code can reuse an @@ -110,8 +104,6 @@ Handler instance or undefined if not registered > `static` **listProviders**(): `string`[] -Defined in: [utils/sttProcessor.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/sttProcessor.ts#L106) - List the names of all registered providers. #### Returns @@ -124,8 +116,6 @@ List the names of all registered providers. > `static` **clearHandlers**(): `void` -Defined in: [utils/sttProcessor.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/utils/sttProcessor.ts#L114) - Removes every registered STT handler. Primarily for test isolation — production code should not need to call this. @@ -139,8 +129,6 @@ production code should not need to call this. > `static` **supports**(`providerName`): `boolean` -Defined in: [utils/sttProcessor.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/utils/sttProcessor.ts#L131) - Check if a provider is supported (has a registered STT handler) #### Parameters @@ -171,8 +159,6 @@ if (STTProcessor.supports("whisper")) { > `static` **transcribe**(`audio`, `provider`, `options`): `Promise`\<[`STTResult`](../type-aliases/STTResult.md)\> -Defined in: [utils/sttProcessor.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/utils/sttProcessor.ts#L175) - Transcribe audio to text using a registered STT provider Orchestrates the speech-to-text transcription process: diff --git a/docs/api/classes/SamplingStrategy.md b/docs/api/classes/SamplingStrategy.md index 03a2ba98d..2be95a77f 100644 --- a/docs/api/classes/SamplingStrategy.md +++ b/docs/api/classes/SamplingStrategy.md @@ -6,8 +6,6 @@ # Class: SamplingStrategy -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L38) - Sampling strategy for evaluation ## Constructors @@ -16,8 +14,6 @@ Sampling strategy for evaluation > **new SamplingStrategy**(`config?`): `SamplingStrategy` -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L44) - #### Parameters ##### config? @@ -36,8 +32,6 @@ Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:44](https://gith > **get** **config**(): [`SamplingConfig`](../type-aliases/SamplingConfig.md) -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L78) - Get current sampling configuration ##### Returns @@ -52,8 +46,6 @@ Get current sampling configuration > **get** **currentRate**(): `number` -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L85) - Get current sampling rate ##### Returns @@ -66,8 +58,6 @@ Get current sampling rate > **shouldSample**(`context?`): [`SamplingDecision`](../type-aliases/SamplingDecision.md) -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L92) - Decide whether to sample a request #### Parameters @@ -86,8 +76,6 @@ Decide whether to sample a request > **recordScore**(`score`): `void` -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L144) - Record a score for adaptive sampling #### Parameters @@ -106,8 +94,6 @@ Record a score for adaptive sampling > **reset**(): `void` -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L191) - Reset sampling state #### Returns @@ -120,8 +106,6 @@ Reset sampling state > **configure**(`config`): `void` -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L199) - Update sampling configuration #### Parameters @@ -140,8 +124,6 @@ Update sampling configuration > **getStats**(): `object` -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L235) - Get sampling statistics #### Returns diff --git a/docs/api/classes/ScorerBuilder.md b/docs/api/classes/ScorerBuilder.md index f11b1d28d..fd073b75f 100644 --- a/docs/api/classes/ScorerBuilder.md +++ b/docs/api/classes/ScorerBuilder.md @@ -6,8 +6,6 @@ # Class: ScorerBuilder -Defined in: [evaluation/scorers/scorerBuilder.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L20) - Fluent builder for creating custom scorers ## Constructors @@ -16,8 +14,6 @@ Fluent builder for creating custom scorers > **new ScorerBuilder**(`id`, `name`): `ScorerBuilder` -Defined in: [evaluation/scorers/scorerBuilder.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L43) - #### Parameters ##### id @@ -38,8 +34,6 @@ Defined in: [evaluation/scorers/scorerBuilder.ts:43](https://github.com/juspay/n > `static` **create**(`id`, `name`): `ScorerBuilder` -Defined in: [evaluation/scorers/scorerBuilder.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L51) - Create a new scorer builder #### Parameters @@ -62,8 +56,6 @@ Create a new scorer builder > **description**(`desc`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L58) - Set scorer description #### Parameters @@ -82,8 +74,6 @@ Set scorer description > **type**(`type`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L66) - Set scorer type #### Parameters @@ -102,8 +92,6 @@ Set scorer type > **category**(`category`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L74) - Set scorer category #### Parameters @@ -122,8 +110,6 @@ Set scorer category > **version**(`version`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L82) - Set scorer version #### Parameters @@ -142,8 +128,6 @@ Set scorer version > **requireInputs**(...`inputs`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L90) - Set required inputs #### Parameters @@ -162,8 +146,6 @@ Set required inputs > **optionalInputs**(...`inputs`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L98) - Set optional inputs #### Parameters @@ -182,8 +164,6 @@ Set optional inputs > **threshold**(`threshold`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L106) - Set pass/fail threshold #### Parameters @@ -202,8 +182,6 @@ Set pass/fail threshold > **weight**(`weight`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L114) - Set weight for aggregation #### Parameters @@ -222,8 +200,6 @@ Set weight for aggregation > **timeout**(`ms`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L122) - Set execution timeout #### Parameters @@ -242,8 +218,6 @@ Set execution timeout > **retries**(`count`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L130) - Set retry count #### Parameters @@ -262,8 +236,6 @@ Set retry count > **scoringFunction**(`fn`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L138) - Set the scoring function #### Parameters @@ -282,8 +254,6 @@ Set the scoring function > **addScorer**(`scorer`, `weight?`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L146) - Add a sub-scorer for composition #### Parameters @@ -306,8 +276,6 @@ Add a sub-scorer for composition > **aggregateWith**(`method`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L155) - Set aggregation method for composed scorers #### Parameters @@ -326,8 +294,6 @@ Set aggregation method for composed scorers > **matchesPattern**(`pattern`, `options?`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L163) - Add a regex check rule #### Parameters @@ -356,8 +322,6 @@ Add a regex check rule > **containsKeyword**(`keyword`, `options?`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L205) - Add a keyword check rule #### Parameters @@ -386,8 +350,6 @@ Add a keyword check rule > **hasLength**(`options`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L225) - Add a length check rule #### Parameters @@ -428,8 +390,6 @@ Add a length check rule > **customRule**(`rule`): `this` -Defined in: [evaluation/scorers/scorerBuilder.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L251) - Add a custom rule #### Parameters @@ -448,8 +408,6 @@ Add a custom rule > **build**(): [`BaseScorer`](BaseScorer.md) -Defined in: [evaluation/scorers/scorerBuilder.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerBuilder.ts#L259) - Build the scorer #### Returns diff --git a/docs/api/classes/ScorerRegistry.md b/docs/api/classes/ScorerRegistry.md index c1de2bd8b..b50ddbc43 100644 --- a/docs/api/classes/ScorerRegistry.md +++ b/docs/api/classes/ScorerRegistry.md @@ -6,8 +6,6 @@ # Class: ScorerRegistry -Defined in: [evaluation/scorers/scorerRegistry.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L383) - Central registry for all scorers Manages registration, discovery, and instantiation @@ -29,8 +27,6 @@ Manages registration, discovery, and instantiation > **get** `static` **size**(): `number` -Defined in: [evaluation/scorers/scorerRegistry.ts:617](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L617) - Get the number of registered scorers (excluding aliases) ##### Returns @@ -43,8 +39,6 @@ Get the number of registered scorers (excluding aliases) > `static` **register**(`entry`): `void` -Defined in: [evaluation/scorers/scorerRegistry.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L391) - Register a scorer with the registry #### Parameters @@ -63,8 +57,6 @@ Register a scorer with the registry > `static` **registerScorer**(`metadata`, `factory`, `aliases?`): `void` -Defined in: [evaluation/scorers/scorerRegistry.ts:418](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L418) - Register a scorer using a simple configuration #### Parameters @@ -91,8 +83,6 @@ Register a scorer using a simple configuration > `static` **registerBuiltInScorers**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/scorerRegistry.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L454) - Register built-in scorers using dynamic imports #### Returns @@ -105,8 +95,6 @@ Register built-in scorers using dynamic imports > `static` **getScorer**(`scorerId`, `config?`): `Promise`\<[`Scorer`](../type-aliases/Scorer.md) \| `undefined`\> -Defined in: [evaluation/scorers/scorerRegistry.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L483) - Get a scorer instance by ID #### Parameters @@ -129,8 +117,6 @@ Get a scorer instance by ID > `static` **getScorersByCategory**(`category`): [`ScorerRegistryEntry`](../type-aliases/ScorerRegistryEntry.md)[] -Defined in: [evaluation/scorers/scorerRegistry.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L509) - Get scorers by category #### Parameters @@ -149,8 +135,6 @@ Get scorers by category > `static` **getScorersByType**(`type`): [`ScorerRegistryEntry`](../type-aliases/ScorerRegistryEntry.md)[] -Defined in: [evaluation/scorers/scorerRegistry.ts:529](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L529) - Get scorers by type #### Parameters @@ -169,8 +153,6 @@ Get scorers by type > `static` **list**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md)[] -Defined in: [evaluation/scorers/scorerRegistry.ts:546](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L546) - List all registered scorer metadata #### Returns @@ -183,8 +165,6 @@ List all registered scorer metadata > `static` **has**(`scorerId`): `boolean` -Defined in: [evaluation/scorers/scorerRegistry.ts:563](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L563) - Check if a scorer is registered #### Parameters @@ -203,8 +183,6 @@ Check if a scorer is registered > `static` **unregister**(`scorerId`): `boolean` -Defined in: [evaluation/scorers/scorerRegistry.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L570) - Unregister a scorer #### Parameters @@ -223,8 +201,6 @@ Unregister a scorer > `static` **clear**(): `void` -Defined in: [evaluation/scorers/scorerRegistry.ts:595](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/scorerRegistry.ts#L595) - Clear all registered scorers #### Returns diff --git a/docs/api/classes/SemanticChunker.md b/docs/api/classes/SemanticChunker.md index 417e7e1e6..4a8f73519 100644 --- a/docs/api/classes/SemanticChunker.md +++ b/docs/api/classes/SemanticChunker.md @@ -6,8 +6,6 @@ # Class: SemanticChunker -Defined in: [rag/chunking/semanticChunker.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/semanticChunker.ts#L24) - Semantic chunker implementation Uses embedding similarity to find natural content boundaries @@ -31,8 +29,6 @@ Uses embedding similarity to find natural content boundaries > `readonly` **strategy**: `"semantic"` -Defined in: [rag/chunking/semanticChunker.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/semanticChunker.ts#L25) - Strategy name for identification #### Implementation of @@ -45,8 +41,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/semanticChunker.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/semanticChunker.ts#L27) - Split text into chunks #### Parameters @@ -79,8 +73,6 @@ Array of chunks > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/semanticChunker.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/semanticChunker.ts#L390) - #### Parameters ##### config diff --git a/docs/api/classes/SentenceChunker.md b/docs/api/classes/SentenceChunker.md index 873686264..38c33ddee 100644 --- a/docs/api/classes/SentenceChunker.md +++ b/docs/api/classes/SentenceChunker.md @@ -6,8 +6,6 @@ # Class: SentenceChunker -Defined in: [rag/chunking/sentenceChunker.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/sentenceChunker.ts#L21) - Sentence-aware chunker implementation Splits text by sentences while respecting size constraints @@ -31,8 +29,6 @@ Splits text by sentences while respecting size constraints > `readonly` **strategy**: `"sentence"` -Defined in: [rag/chunking/sentenceChunker.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/sentenceChunker.ts#L22) - Strategy name for identification #### Implementation of @@ -45,8 +41,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/sentenceChunker.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/sentenceChunker.ts#L26) - Split text into chunks #### Parameters @@ -79,8 +73,6 @@ Array of chunks > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/sentenceChunker.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/sentenceChunker.ts#L250) - #### Parameters ##### config diff --git a/docs/api/classes/ServerAdapterError.md b/docs/api/classes/ServerAdapterError.md index 14e38836c..d92c6f4a4 100644 --- a/docs/api/classes/ServerAdapterError.md +++ b/docs/api/classes/ServerAdapterError.md @@ -6,8 +6,6 @@ # Class: ServerAdapterError -Defined in: [server/errors.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L20) - Base error class for server adapter errors ## Extends @@ -42,8 +40,6 @@ Base error class for server adapter errors > **new ServerAdapterError**(`message`, `code`, `context?`): `ServerAdapterError` -Defined in: [server/errors.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L32) - #### Parameters ##### message @@ -72,80 +68,60 @@ Defined in: [server/errors.ts:32](https://github.com/juspay/neurolink/blob/relea > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - --- ### category > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - --- ### severity > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - --- ### retryable > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - --- ### retryAfterMs? > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - --- ### requestId? > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - --- ### path? > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - --- ### method? > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - --- ### details? > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - --- ### cause? > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Overrides `Error.cause` @@ -156,8 +132,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -170,8 +144,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ServerAdapterFactory.md b/docs/api/classes/ServerAdapterFactory.md index ca33b6430..ea5fd7cd9 100644 --- a/docs/api/classes/ServerAdapterFactory.md +++ b/docs/api/classes/ServerAdapterFactory.md @@ -6,8 +6,6 @@ # Class: ServerAdapterFactory -Defined in: [server/factory/serverAdapterFactory.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L20) - Factory for creating server adapters Supports multiple web frameworks with consistent API @@ -27,8 +25,6 @@ Supports multiple web frameworks with consistent API > `static` **registerAdapter**(`framework`, `adapterClass`): `void` -Defined in: [server/factory/serverAdapterFactory.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L32) - Register an adapter class for a framework #### Parameters @@ -51,8 +47,6 @@ Register an adapter class for a framework > `static` **create**(`options`): `Promise`\<[`BaseServerAdapter`](BaseServerAdapter.md)\> -Defined in: [server/factory/serverAdapterFactory.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L49) - Create a server adapter for the specified framework Uses dynamic imports to avoid bundling unused frameworks @@ -72,8 +66,6 @@ Uses dynamic imports to avoid bundling unused frameworks > `static` **createHono**(`neurolink`, `config?`): `Promise`\<[`BaseServerAdapter`](BaseServerAdapter.md)\> -Defined in: [server/factory/serverAdapterFactory.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L104) - Create a Hono server adapter (convenience method) Hono is the recommended framework for its multi-runtime support @@ -97,8 +89,6 @@ Hono is the recommended framework for its multi-runtime support > `static` **createExpress**(`neurolink`, `config?`): `Promise`\<[`BaseServerAdapter`](BaseServerAdapter.md)\> -Defined in: [server/factory/serverAdapterFactory.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L118) - Create an Express server adapter (convenience method) #### Parameters @@ -121,8 +111,6 @@ Create an Express server adapter (convenience method) > `static` **createFastify**(`neurolink`, `config?`): `Promise`\<[`BaseServerAdapter`](BaseServerAdapter.md)\> -Defined in: [server/factory/serverAdapterFactory.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L133) - Create a Fastify server adapter (convenience method) Fastify is known for high performance and low overhead @@ -146,8 +134,6 @@ Fastify is known for high performance and low overhead > `static` **createKoa**(`neurolink`, `config?`): `Promise`\<[`BaseServerAdapter`](BaseServerAdapter.md)\> -Defined in: [server/factory/serverAdapterFactory.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L148) - Create a Koa server adapter (convenience method) Koa provides elegant middleware composition @@ -171,8 +157,6 @@ Koa provides elegant middleware composition > `static` **isSupported**(`framework`): `framework is ServerFramework` -Defined in: [server/factory/serverAdapterFactory.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L162) - Check if a framework is supported #### Parameters @@ -191,8 +175,6 @@ Check if a framework is supported > `static` **getSupportedFrameworks**(): `object`[] -Defined in: [server/factory/serverAdapterFactory.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L169) - Get list of supported frameworks #### Returns @@ -205,8 +187,6 @@ Get list of supported frameworks > `static` **getRecommendedFramework**(): [`ServerFramework`](../type-aliases/ServerFramework.md) -Defined in: [server/factory/serverAdapterFactory.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L202) - Get recommended framework based on runtime #### Returns diff --git a/docs/api/classes/ServerAuthenticationError.md b/docs/api/classes/ServerAuthenticationError.md index ef23d8108..5624c484b 100644 --- a/docs/api/classes/ServerAuthenticationError.md +++ b/docs/api/classes/ServerAuthenticationError.md @@ -6,8 +6,6 @@ # Class: ServerAuthenticationError -Defined in: [server/errors.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L201) - Authentication error ## Extends @@ -20,8 +18,6 @@ Authentication error > **new ServerAuthenticationError**(`message?`, `requestId?`): `AuthenticationError` -Defined in: [server/errors.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L202) - #### Parameters ##### message? @@ -46,8 +42,6 @@ Defined in: [server/errors.ts:202](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -58,8 +52,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -70,8 +62,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -82,8 +72,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -94,8 +82,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -106,8 +92,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -118,8 +102,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -130,8 +112,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -142,8 +122,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -154,8 +132,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -166,8 +142,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -184,8 +158,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ServerAuthorizationError.md b/docs/api/classes/ServerAuthorizationError.md index 43d6ea496..2a8dcb1c5 100644 --- a/docs/api/classes/ServerAuthorizationError.md +++ b/docs/api/classes/ServerAuthorizationError.md @@ -6,8 +6,6 @@ # Class: ServerAuthorizationError -Defined in: [server/errors.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L234) - Authorization error ## Extends @@ -20,8 +18,6 @@ Authorization error > **new ServerAuthorizationError**(`message?`, `requestId?`, `requiredPermissions?`): `AuthorizationError` -Defined in: [server/errors.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L235) - #### Parameters ##### message? @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:235](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ServerCapabilitiesManager.md b/docs/api/classes/ServerCapabilitiesManager.md index bc5386158..c721ba308 100644 --- a/docs/api/classes/ServerCapabilitiesManager.md +++ b/docs/api/classes/ServerCapabilitiesManager.md @@ -6,8 +6,6 @@ # Class: ServerCapabilitiesManager -Defined in: [mcp/serverCapabilities.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L68) - Server Capabilities Manager Manages resources and prompts for MCP servers. @@ -58,8 +56,6 @@ capabilities.registerPrompt({ > **new ServerCapabilitiesManager**(`config?`): `ServerCapabilitiesManager` -Defined in: [mcp/serverCapabilities.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L76) - #### Parameters ##### config? @@ -80,8 +76,6 @@ Defined in: [mcp/serverCapabilities.ts:76](https://github.com/juspay/neurolink/b > **registerResource**(`resource`): `this` -Defined in: [mcp/serverCapabilities.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L93) - Register a resource #### Parameters @@ -100,8 +94,6 @@ Register a resource > **registerResourceTemplate**(`pattern`, `template`): `this` -Defined in: [mcp/serverCapabilities.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L118) - Register a resource template (with URI pattern) #### Parameters @@ -124,8 +116,6 @@ Register a resource template (with URI pattern) > **unregisterResource**(`uri`): `boolean` -Defined in: [mcp/serverCapabilities.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L145) - Unregister a resource #### Parameters @@ -144,8 +134,6 @@ Unregister a resource > **listResources**(): [`MCPResource`](../type-aliases/MCPResource.md)[] -Defined in: [mcp/serverCapabilities.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L164) - List all resources #### Returns @@ -158,8 +146,6 @@ List all resources > **readResource**(`uri`, `context?`): `Promise`\<[`ResourceContent`](../type-aliases/ResourceContent.md)\> -Defined in: [mcp/serverCapabilities.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L179) - Read a resource #### Parameters @@ -182,8 +168,6 @@ Read a resource > **subscribeToResource**(`uri`, `callback`): () => `void` -Defined in: [mcp/serverCapabilities.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L235) - Subscribe to resource changes #### Parameters @@ -206,8 +190,6 @@ Subscribe to resource changes > **notifyResourceChanged**(`uri`): `Promise`\<`void`\> -Defined in: [mcp/serverCapabilities.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L280) - Notify subscribers of resource change #### Parameters @@ -226,8 +208,6 @@ Notify subscribers of resource change > **getResource**(`uri`): [`RegisteredResource`](../type-aliases/RegisteredResource.md) \| `undefined` -Defined in: [mcp/serverCapabilities.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L325) - Get resource by URI #### Parameters @@ -246,8 +226,6 @@ Get resource by URI > **registerPrompt**(`prompt`): `this` -Defined in: [mcp/serverCapabilities.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L390) - Register a prompt #### Parameters @@ -266,8 +244,6 @@ Register a prompt > **unregisterPrompt**(`name`): `boolean` -Defined in: [mcp/serverCapabilities.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L414) - Unregister a prompt #### Parameters @@ -286,8 +262,6 @@ Unregister a prompt > **listPrompts**(): [`MCPPrompt`](../type-aliases/MCPPrompt.md)[] -Defined in: [mcp/serverCapabilities.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L430) - List all prompts #### Returns @@ -300,8 +274,6 @@ List all prompts > **getPrompt**(`name`, `args?`, `context?`): `Promise`\<[`PromptResult`](../type-aliases/PromptResult.md)\> -Defined in: [mcp/serverCapabilities.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L441) - Get a prompt #### Parameters @@ -328,8 +300,6 @@ Get a prompt > **getPromptDefinition**(`name`): [`RegisteredPrompt`](../type-aliases/RegisteredPrompt.md) \| `undefined` -Defined in: [mcp/serverCapabilities.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L503) - Get prompt by name #### Parameters @@ -348,8 +318,6 @@ Get prompt by name > **getCapabilities**(): `object` -Defined in: [mcp/serverCapabilities.ts:540](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L540) - Get capabilities object for MCP protocol #### Returns @@ -382,8 +350,6 @@ Get capabilities object for MCP protocol > **getStatistics**(): `object` -Defined in: [mcp/serverCapabilities.ts:568](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L568) - Get statistics #### Returns @@ -412,8 +378,6 @@ Get statistics > **clear**(): `void` -Defined in: [mcp/serverCapabilities.ts:590](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L590) - Clear all resources and prompts #### Returns diff --git a/docs/api/classes/ServerRateLimitError.md b/docs/api/classes/ServerRateLimitError.md index ff9f77321..4bae9ee51 100644 --- a/docs/api/classes/ServerRateLimitError.md +++ b/docs/api/classes/ServerRateLimitError.md @@ -6,8 +6,6 @@ # Class: ServerRateLimitError -Defined in: [server/errors.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L254) - Rate limit error ## Extends @@ -20,8 +18,6 @@ Rate limit error > **new ServerRateLimitError**(`retryAfterMs`, `message?`, `requestId?`): `RateLimitError` -Defined in: [server/errors.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L255) - #### Parameters ##### retryAfterMs @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:255](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ServerStartError.md b/docs/api/classes/ServerStartError.md index 9a60c70bd..6763d0ccb 100644 --- a/docs/api/classes/ServerStartError.md +++ b/docs/api/classes/ServerStartError.md @@ -6,8 +6,6 @@ # Class: ServerStartError -Defined in: [server/errors.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L385) - Server start error ## Extends @@ -20,8 +18,6 @@ Server start error > **new ServerStartError**(`message`, `cause?`, `port?`, `host?`): `ServerStartError` -Defined in: [server/errors.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L386) - #### Parameters ##### message @@ -54,8 +50,6 @@ Defined in: [server/errors.ts:386](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -66,8 +60,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -78,8 +70,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -90,8 +80,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -102,8 +90,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -114,8 +100,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -126,8 +110,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -138,8 +120,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -150,8 +130,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -162,8 +140,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -174,8 +150,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -192,8 +166,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ServerStopError.md b/docs/api/classes/ServerStopError.md index 868d18731..0f7d4347f 100644 --- a/docs/api/classes/ServerStopError.md +++ b/docs/api/classes/ServerStopError.md @@ -6,8 +6,6 @@ # Class: ServerStopError -Defined in: [server/errors.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L401) - Server stop error ## Extends @@ -20,8 +18,6 @@ Server stop error > **new ServerStopError**(`message`, `cause?`): `ServerStopError` -Defined in: [server/errors.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L402) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [server/errors.ts:402](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -58,8 +52,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -70,8 +62,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -82,8 +72,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -94,8 +82,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -106,8 +92,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -118,8 +102,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -130,8 +112,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -142,8 +122,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -154,8 +132,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -166,8 +142,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -184,8 +158,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ServerTimeoutError.md b/docs/api/classes/ServerTimeoutError.md index 162b6e1d2..73bcb5dba 100644 --- a/docs/api/classes/ServerTimeoutError.md +++ b/docs/api/classes/ServerTimeoutError.md @@ -6,8 +6,6 @@ # Class: ServerTimeoutError -Defined in: [server/errors.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L274) - Timeout error ## Extends @@ -20,8 +18,6 @@ Timeout error > **new ServerTimeoutError**(`timeoutMs`, `operation?`, `requestId?`): `ServerTimeoutError` -Defined in: [server/errors.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L275) - #### Parameters ##### timeoutMs @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:275](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/ServerValidationError.md b/docs/api/classes/ServerValidationError.md index 3f84da750..c290e2cd1 100644 --- a/docs/api/classes/ServerValidationError.md +++ b/docs/api/classes/ServerValidationError.md @@ -6,8 +6,6 @@ # Class: ServerValidationError -Defined in: [server/errors.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L175) - Validation error ## Extends @@ -20,8 +18,6 @@ Validation error > **new ServerValidationError**(`errors`, `requestId?`): `ValidationError` -Defined in: [server/errors.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L178) - #### Parameters ##### errors @@ -46,8 +42,6 @@ Defined in: [server/errors.ts:178](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -58,8 +52,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -70,8 +62,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -82,8 +72,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -94,8 +82,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -106,8 +92,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -118,8 +102,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -130,8 +112,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -142,8 +122,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -154,8 +132,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -166,8 +142,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > `readonly` **errors**: `object`[] -Defined in: [server/errors.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L176) - #### field > **field**: `string` @@ -186,8 +160,6 @@ Defined in: [server/errors.ts:176](https://github.com/juspay/neurolink/blob/rele > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -204,8 +176,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/SessionManager.md b/docs/api/classes/SessionManager.md index a78d50ae2..c7e28bb16 100644 --- a/docs/api/classes/SessionManager.md +++ b/docs/api/classes/SessionManager.md @@ -6,8 +6,6 @@ # Class: SessionManager -Defined in: [auth/sessionManager.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L370) - Session Manager High-level session management that handles session lifecycle, @@ -19,8 +17,6 @@ automatic refresh, and storage abstraction. > **new SessionManager**(`config?`): `SessionManager` -Defined in: [auth/sessionManager.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L374) - #### Parameters ##### config? @@ -37,8 +33,6 @@ Defined in: [auth/sessionManager.ts:374](https://github.com/juspay/neurolink/blo > **createSession**(`user`, `metadata?`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md)\> -Defined in: [auth/sessionManager.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L409) - Create a new session #### Parameters @@ -71,8 +65,6 @@ Create a new session > **getSession**(`sessionId`, `autoRefresh?`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md) \| `null`\> -Defined in: [auth/sessionManager.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L466) - Get a session by ID Optionally auto-refreshes if close to expiration. @@ -97,8 +89,6 @@ Optionally auto-refreshes if close to expiration. > **refreshSession**(`sessionId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md) \| `null`\> -Defined in: [auth/sessionManager.ts:520](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L520) - Refresh a session #### Parameters @@ -117,8 +107,6 @@ Refresh a session > **destroySession**(`sessionId`): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L550) - Destroy a session #### Parameters @@ -137,8 +125,6 @@ Destroy a session > **getUserSessions**(`userId`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md)[]\> -Defined in: [auth/sessionManager.ts:558](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L558) - Get all sessions for a user #### Parameters @@ -157,8 +143,6 @@ Get all sessions for a user > **destroyAllUserSessions**(`userId`): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:565](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L565) - Destroy all sessions for a user (global logout) #### Parameters @@ -177,8 +161,6 @@ Destroy all sessions for a user (global logout) > **validateSession**(`sessionId`): `Promise`\<`boolean`\> -Defined in: [auth/sessionManager.ts:573](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L573) - Validate a session is still active #### Parameters @@ -197,8 +179,6 @@ Validate a session is still active > **updateSessionMetadata**(`sessionId`, `metadata`): `Promise`\<[`AuthSession`](../type-aliases/AuthSession.md) \| `null`\> -Defined in: [auth/sessionManager.ts:592](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L592) - Update session metadata #### Parameters @@ -221,8 +201,6 @@ Update session metadata > **isHealthy**(): `Promise`\<`boolean`\> -Defined in: [auth/sessionManager.ts:614](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L614) - Health check #### Returns @@ -235,8 +213,6 @@ Health check > **clear**(): `Promise`\<`void`\> -Defined in: [auth/sessionManager.ts:621](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L621) - Clear all sessions (for testing/cleanup) #### Returns diff --git a/docs/api/classes/SkillsManager.md b/docs/api/classes/SkillsManager.md index c0e3623fc..cbaf50c42 100644 --- a/docs/api/classes/SkillsManager.md +++ b/docs/api/classes/SkillsManager.md @@ -6,16 +6,12 @@ # Class: SkillsManager -Defined in: [skills/skillsManager.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L37) - ## Constructors ### Constructor > **new SkillsManager**(`config`): `SkillsManager` -Defined in: [skills/skillsManager.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L46) - #### Parameters ##### config @@ -32,8 +28,6 @@ Defined in: [skills/skillsManager.ts:46](https://github.com/juspay/neurolink/blo > `readonly` **sessions**: `SkillSessionTracker` -Defined in: [skills/skillsManager.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L44) - Per-session activation state (pinned skills). ## Accessors @@ -44,8 +38,6 @@ Per-session activation state (pinned skills). > **get** **mutationsAllowed**(): `boolean` -Defined in: [skills/skillsManager.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L212) - Whether skill create/update/delete is enabled on this instance. Gates the LLM-facing `skill_*` tools (registration) and the server REST mutation routes. Direct programmatic `requestMutation` calls are intentionally not @@ -61,8 +53,6 @@ gated, so a host can still seed skills at startup. > **getIndex**(`forceRefresh?`): `Promise`\<[`SkillIndexItem`](../type-aliases/SkillIndexItem.md)[]\> -Defined in: [skills/skillsManager.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L55) - Cached index read, sorted by name. TTL 0 disables caching. Sorting here (not per render) keeps every downstream listing byte-stable regardless of store enumeration order. @@ -83,8 +73,6 @@ regardless of store enumeration order. > **search**(`query`): `Promise`\<[`SkillDefinition`](../type-aliases/SkillDefinition.md)[]\> -Defined in: [skills/skillsManager.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L80) - Index-first search: filter the cached index, hydrate only the matched entries (max `limit`) with instructions. Cost: one cached index read + N_matched store gets. @@ -105,8 +93,6 @@ N_matched store gets. > **list**(`scopeId?`): `Promise`\<[`SkillIndexItem`](../type-aliases/SkillIndexItem.md)[]\> -Defined in: [skills/skillsManager.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L97) - Index entries only — no instructions. For discovery/listing. #### Parameters @@ -125,8 +111,6 @@ Index entries only — no instructions. For discovery/listing. > **get**(`idOrName`): `Promise`\<[`SkillDefinition`](../type-aliases/SkillDefinition.md) \| `null`\> -Defined in: [skills/skillsManager.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L106) - Fetch one skill by id, falling back to name lookup. #### Parameters @@ -145,8 +129,6 @@ Fetch one skill by id, falling back to name lookup. > **buildPromptIndex**(`options?`): `Promise`\<`string` \| `null`\> -Defined in: [skills/skillsManager.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L136) - Render the system-prompt skills index for one call, or null when nothing is visible. Never includes instructions. @@ -172,8 +154,6 @@ nothing is visible. Never includes instructions. > **buildToolListing**(`options?`): `Promise`\<`string` \| `null`\> -Defined in: [skills/skillsManager.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L152) - Render the `` block for the use_skill tool description ("tool" discovery mode), or null when nothing is visible. Bounded by listingBudgetChars; entries are never dropped. @@ -200,8 +180,6 @@ Bounded by listingBudgetChars; entries are never dropped. > **getResource**(`idOrName`, `resourcePath`): `Promise`\<`string` \| `null`\> -Defined in: [skills/skillsManager.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L183) - Read an auxiliary resource file bundled with a skill. Paths are relative to the skill; traversal segments are rejected. Null when the skill, the resource, or store resource support is absent. @@ -226,8 +204,6 @@ skill, the resource, or store resource support is absent. > **requestMutation**(`action`): `Promise`\<[`SkillMutationResult`](../type-aliases/SkillMutationResult.md)\> -Defined in: [skills/skillsManager.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillsManager.ts#L221) - Gate a proposed mutation through the host's onMutationRequest hook, then apply it when approved. No hook configured means direct apply (the tools themselves are already gated by allowMutations). diff --git a/docs/api/classes/SpanSerializer.md b/docs/api/classes/SpanSerializer.md index 0200391e8..020f7a0df 100644 --- a/docs/api/classes/SpanSerializer.md +++ b/docs/api/classes/SpanSerializer.md @@ -6,8 +6,6 @@ # Class: SpanSerializer -Defined in: [observability/utils/spanSerializer.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L22) - Utility class for span creation and serialization ## Constructors @@ -26,8 +24,6 @@ Utility class for span creation and serialization > `static` **createSpan**(`type`, `name`, `attributes?`, `parentSpanId?`, `traceId?`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L30) - Create a new span with generated IDs. When `traceId` / `parentSpanId` are omitted, the method automatically @@ -66,8 +62,6 @@ spans land inside the same Langfuse trace as Pipeline A spans (fix A5). > `static` **endSpan**(`span`, `status?`, `statusMessage?`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L65) - End a span with status #### Parameters @@ -94,8 +88,6 @@ End a span with status > `static` **addEvent**(`span`, `name`, `attributes?`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L85) - Add event to span #### Parameters @@ -122,8 +114,6 @@ Add event to span > `static` **updateAttributes**(`span`, `attributes`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L105) - Update span attributes #### Parameters @@ -146,8 +136,6 @@ Update span attributes > `static` **toJSON**(`span`): `string` -Defined in: [observability/utils/spanSerializer.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L121) - Serialize span to JSON for export #### Parameters @@ -166,8 +154,6 @@ Serialize span to JSON for export > `static` **fromJSON**(`json`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L146) - Parse span from JSON #### Parameters @@ -186,8 +172,6 @@ Parse span from JSON > `static` **toLangfuseFormat**(`span`): [`LangfuseSpan`](../type-aliases/LangfuseSpan.md) -Defined in: [observability/utils/spanSerializer.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L153) - Serialize span for Langfuse format #### Parameters @@ -206,8 +190,6 @@ Serialize span for Langfuse format > `static` **toLangSmithFormat**(`span`): [`LangSmithRun`](../type-aliases/LangSmithRun.md) -Defined in: [observability/utils/spanSerializer.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L189) - Serialize span for LangSmith format #### Parameters @@ -226,8 +208,6 @@ Serialize span for LangSmith format > `static` **toOtelFormat**(`span`): [`OtelSpan`](../type-aliases/OtelSpan.md) -Defined in: [observability/utils/spanSerializer.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L209) - Serialize span for OpenTelemetry format #### Parameters @@ -246,8 +226,6 @@ Serialize span for OpenTelemetry format > `static` **createGenerationSpan**(`params`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L324) - Create a generation span with AI-specific attributes #### Parameters @@ -304,8 +282,6 @@ Create a generation span with AI-specific attributes > `static` **createToolCallSpan**(`params`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L356) - Create a tool call span #### Parameters @@ -342,8 +318,6 @@ Create a tool call span > `static` **enrichWithTokenUsage**(`span`, `usage`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:379](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L379) - Enrich span with token usage #### Parameters @@ -388,8 +362,6 @@ Enrich span with token usage > `static` **enrichWithCost**(`span`, `cost`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L405) - Enrich span with cost information #### Parameters @@ -426,8 +398,6 @@ Enrich span with cost information > **serialize**(`span`): `string` -Defined in: [observability/utils/spanSerializer.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L130) - Instance method to serialize a span object to JSON string #### Parameters @@ -450,8 +420,6 @@ JSON string representation of the span > **deserialize**(`json`): [`SpanData`](../type-aliases/SpanData.md) -Defined in: [observability/utils/spanSerializer.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/observability/utils/spanSerializer.ts#L139) - Instance method to deserialize a JSON string to span data #### Parameters diff --git a/docs/api/classes/StreamAbortedError.md b/docs/api/classes/StreamAbortedError.md index efa37357b..3cac0e835 100644 --- a/docs/api/classes/StreamAbortedError.md +++ b/docs/api/classes/StreamAbortedError.md @@ -6,8 +6,6 @@ # Class: StreamAbortedError -Defined in: [server/errors.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L334) - Stream aborted error ## Extends @@ -20,8 +18,6 @@ Stream aborted error > **new StreamAbortedError**(`reason?`, `requestId?`): `StreamAbortedError` -Defined in: [server/errors.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L335) - #### Parameters ##### reason? @@ -46,8 +42,6 @@ Defined in: [server/errors.ts:335](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -58,8 +52,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -70,8 +62,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -82,8 +72,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -94,8 +82,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -106,8 +92,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -118,8 +102,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -130,8 +112,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -142,8 +122,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -154,8 +132,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -166,8 +142,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -184,8 +158,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/StreamError.md b/docs/api/classes/StreamError.md index 31b3e08a9..a46917e71 100644 --- a/docs/api/classes/StreamError.md +++ b/docs/api/classes/StreamError.md @@ -6,8 +6,6 @@ # Class: StreamError -Defined in: [client/errors.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L460) - Error for stream processing failures ## Extends @@ -20,8 +18,6 @@ Error for stream processing failures > **new StreamError**(`message?`, `options?`): `StreamError` -Defined in: [client/errors.ts:461](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L461) - #### Parameters ##### message? @@ -56,8 +52,6 @@ Defined in: [client/errors.ts:461](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L76) - Error code for programmatic handling #### Inherited from @@ -70,8 +64,6 @@ Error code for programmatic handling > `readonly` `optional` **status?**: `number` -Defined in: [client/errors.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L78) - HTTP status code (if applicable) #### Inherited from @@ -84,8 +76,6 @@ HTTP status code (if applicable) > `readonly` `optional` **details?**: [`JsonObject`](../type-aliases/JsonObject.md) -Defined in: [client/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L80) - Additional error details #### Inherited from @@ -98,8 +88,6 @@ Additional error details > `readonly` **retryable**: `boolean` -Defined in: [client/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L82) - Whether the error is retryable #### Inherited from @@ -112,8 +100,6 @@ Whether the error is retryable > `readonly` `optional` **requestId?**: `string` -Defined in: [client/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L84) - Request ID for error tracking #### Inherited from @@ -126,8 +112,6 @@ Request ID for error tracking > **toApiError**(): [`ClientApiError`](../type-aliases/ClientApiError.md) -Defined in: [client/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L109) - Convert error to API error format #### Returns @@ -144,8 +128,6 @@ Convert error to API error format > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [client/errors.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L123) - Convert error to JSON #### Returns diff --git a/docs/api/classes/StreamingError.md b/docs/api/classes/StreamingError.md index 8ca364148..3556ef8b1 100644 --- a/docs/api/classes/StreamingError.md +++ b/docs/api/classes/StreamingError.md @@ -6,8 +6,6 @@ # Class: StreamingError -Defined in: [server/errors.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L318) - Streaming error ## Extends @@ -20,8 +18,6 @@ Streaming error > **new StreamingError**(`message`, `cause?`, `requestId?`): `StreamingError` -Defined in: [server/errors.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L319) - #### Parameters ##### message @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:319](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/SummarizationScorer.md b/docs/api/classes/SummarizationScorer.md index 9397603a4..adbe711a7 100644 --- a/docs/api/classes/SummarizationScorer.md +++ b/docs/api/classes/SummarizationScorer.md @@ -6,8 +6,6 @@ # Class: SummarizationScorer -Defined in: [evaluation/scorers/llm/summarizationScorer.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/summarizationScorer.ts#L60) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new SummarizationScorer**(`config?`): `SummarizationScorer` -Defined in: [evaluation/scorers/llm/summarizationScorer.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/summarizationScorer.ts#L61) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/summarizationScorer.ts:61](https://github.co > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/summarizationScorer.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/summarizationScorer.ts#L84) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/summarizationScorer.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/summarizationScorer.ts#L97) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/TTSError.md b/docs/api/classes/TTSError.md index a66e16dfb..290fdbc69 100644 --- a/docs/api/classes/TTSError.md +++ b/docs/api/classes/TTSError.md @@ -6,8 +6,6 @@ # Class: TTSError -Defined in: [utils/ttsProcessor.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L229) - TTS Error class for text-to-speech specific errors ## Extends @@ -20,8 +18,6 @@ TTS Error class for text-to-speech specific errors > **new TTSError**(`options`): `TTSError` -Defined in: [utils/ttsProcessor.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L230) - #### Parameters ##### options @@ -68,8 +64,6 @@ Defined in: [utils/ttsProcessor.ts:230](https://github.com/juspay/neurolink/blob > `readonly` **code**: `string` -Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L105) - #### Inherited from `NeuroLinkError.code` @@ -80,8 +74,6 @@ Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blo > `readonly` **category**: `ErrorCategory` -Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L106) - #### Inherited from `NeuroLinkError.category` @@ -92,8 +84,6 @@ Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blo > `readonly` **severity**: `ErrorSeverity` -Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L107) - #### Inherited from `NeuroLinkError.severity` @@ -104,8 +94,6 @@ Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blo > `readonly` **retriable**: `boolean` -Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L108) - #### Inherited from `NeuroLinkError.retriable` @@ -116,8 +104,6 @@ Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blo > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L109) - #### Inherited from `NeuroLinkError.retryAfterMs` @@ -128,8 +114,6 @@ Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blo > `readonly` **context**: `Record`\<`string`, `unknown`\> -Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L110) - #### Inherited from `NeuroLinkError.context` @@ -140,8 +124,6 @@ Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blo > `readonly` **timestamp**: `Date` -Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L111) - #### Inherited from `NeuroLinkError.timestamp` @@ -152,8 +134,6 @@ Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blo > `readonly` `optional` **toolName?**: `string` -Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L112) - #### Inherited from `NeuroLinkError.toolName` @@ -164,8 +144,6 @@ Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blo > `readonly` `optional` **serverId?**: `string` -Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L113) - #### Inherited from `NeuroLinkError.serverId` @@ -176,8 +154,6 @@ Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blo > **toJSON**(): [`StructuredError`](../type-aliases/StructuredError.md) -Defined in: [utils/errorHandling.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L149) - Convert to JSON for logging and serialization #### Returns diff --git a/docs/api/classes/TTSProcessor.md b/docs/api/classes/TTSProcessor.md index 77698b970..bab2e4bf6 100644 --- a/docs/api/classes/TTSProcessor.md +++ b/docs/api/classes/TTSProcessor.md @@ -6,8 +6,6 @@ # Class: TTSProcessor -Defined in: [utils/ttsProcessor.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L290) - TTS processor class for orchestrating text-to-speech operations Follows the same pattern as CSVProcessor, ImageProcessor, and PDFProcessor. @@ -41,8 +39,6 @@ if (TTSProcessor.supports("google-ai")) { > `static` **registerHandler**(`providerName`, `handler`): `void` -Defined in: [utils/ttsProcessor.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L330) - Register a TTS handler for a specific provider Allows providers to register their TTS implementation at runtime. @@ -83,8 +79,6 @@ TTSProcessor.registerHandler('google-ai', googleHandler); > `static` **getHandler**(`providerName`): [`TTSHandler`](../type-aliases/TTSHandler.md) \| `undefined` -Defined in: [utils/ttsProcessor.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L350) - Get a registered TTS handler by provider name. Exposed publicly so module-level auto-registration code can reuse an @@ -111,8 +105,6 @@ Handler instance or undefined if not registered > `static` **listProviders**(): `string`[] -Defined in: [utils/ttsProcessor.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L357) - List the names of all registered providers. #### Returns @@ -125,8 +117,6 @@ List the names of all registered providers. > `static` **clearHandlers**(): `void` -Defined in: [utils/ttsProcessor.ts:365](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L365) - Removes every registered TTS handler. Primarily for test isolation — production code should not need to call this. @@ -140,8 +130,6 @@ production code should not need to call this. > `static` **supports**(`providerName`): `boolean` -Defined in: [utils/ttsProcessor.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L382) - Check if a provider is supported (has a registered TTS handler) #### Parameters @@ -172,8 +160,6 @@ if (TTSProcessor.supports("google-ai")) { > `static` **synthesize**(`text`, `provider`, `options`): `Promise`\<[`TTSResult`](../type-aliases/TTSResult.md)\> -Defined in: [utils/ttsProcessor.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L432) - Synthesize speech from text using a registered TTS provider Orchestrates the text-to-speech generation process: @@ -238,8 +224,6 @@ console.log(`Generated ${result.size} bytes of ${result.format} audio`); > `static` **synthesizeStream**(`textChunks`, `provider`, `options`, `shouldStop?`): `AsyncGenerator`\<[`TTSChunk`](../type-aliases/TTSChunk.md)\> -Defined in: [utils/ttsProcessor.ts:862](https://github.com/juspay/neurolink/blob/release/src/lib/utils/ttsProcessor.ts#L862) - Incrementally synthesize sentence-buffered text chunks. Text is flushed at a sentence boundary after `streamingBufferSize` diff --git a/docs/api/classes/TaskDistributor.md b/docs/api/classes/TaskDistributor.md index aaf449f0e..f1a7a8adb 100644 --- a/docs/api/classes/TaskDistributor.md +++ b/docs/api/classes/TaskDistributor.md @@ -6,8 +6,6 @@ # Class: TaskDistributor -Defined in: [agent/coordination/task-distributor.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L39) - Task Distributor - Manages task distribution across agents ## Constructors @@ -16,8 +14,6 @@ Task Distributor - Manages task distribution across agents > **new TaskDistributor**(`config`): `TaskDistributor` -Defined in: [agent/coordination/task-distributor.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L48) - #### Parameters ##### config @@ -34,8 +30,6 @@ Defined in: [agent/coordination/task-distributor.ts:48](https://github.com/juspa > **registerAgent**(`agent`, `capability?`): `void` -Defined in: [agent/coordination/task-distributor.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L68) - Register an agent with capabilities #### Parameters @@ -58,8 +52,6 @@ Register an agent with capabilities > **unregisterAgent**(`agentId`): `void` -Defined in: [agent/coordination/task-distributor.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L91) - Unregister an agent #### Parameters @@ -78,8 +70,6 @@ Unregister an agent > **updateCapability**(`agentId`, `update`): `void` -Defined in: [agent/coordination/task-distributor.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L99) - Update agent capability #### Parameters @@ -102,8 +92,6 @@ Update agent capability > **submitTask**(`task`): `Promise`\<[`DistributionResult`](../type-aliases/DistributionResult.md)\> -Defined in: [agent/coordination/task-distributor.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L109) - Submit a task for distribution #### Parameters @@ -122,8 +110,6 @@ Submit a task for distribution > **submitTasks**(`tasks`): `Promise`\<[`DistributionResult`](../type-aliases/DistributionResult.md)[]\> -Defined in: [agent/coordination/task-distributor.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L168) - Submit multiple tasks #### Parameters @@ -142,8 +128,6 @@ Submit multiple tasks > **decomposeTask**(`task`, `analysis`): `Promise`\<[`DistributableTask`](../type-aliases/DistributableTask.md)[]\> -Defined in: [agent/coordination/task-distributor.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L175) - Decompose a complex task into subtasks #### Parameters @@ -166,8 +150,6 @@ Decompose a complex task into subtasks > **broadcastTask**(`task`): `Promise`\<`Map`\<`string`, [`DistributionResult`](../type-aliases/DistributionResult.md)\>\> -Defined in: [agent/coordination/task-distributor.ts:583](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L583) - Broadcast a task to all agents #### Parameters @@ -186,8 +168,6 @@ Broadcast a task to all agents > **getTaskResult**(`taskId`): [`DistributionResult`](../type-aliases/DistributionResult.md) \| `undefined` -Defined in: [agent/coordination/task-distributor.ts:624](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L624) - Get task result #### Parameters @@ -206,8 +186,6 @@ Get task result > **getQueueStatus**(): `object` -Defined in: [agent/coordination/task-distributor.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L631) - Get queue status #### Returns @@ -236,8 +214,6 @@ Get queue status > **clearCompleted**(): `void` -Defined in: [agent/coordination/task-distributor.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L666) - Clear completed/failed tasks #### Returns @@ -250,8 +226,6 @@ Clear completed/failed tasks > **on**(`event`, `handler`): `void` -Defined in: [agent/coordination/task-distributor.ts:702](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L702) - Subscribe to distributor events #### Parameters @@ -274,8 +248,6 @@ Subscribe to distributor events > **off**(`event`, `handler`): `void` -Defined in: [agent/coordination/task-distributor.ts:709](https://github.com/juspay/neurolink/blob/release/src/lib/agent/coordination/task-distributor.ts#L709) - Unsubscribe from distributor events #### Parameters diff --git a/docs/api/classes/TextLoader.md b/docs/api/classes/TextLoader.md index 73b640ca2..a4778fcc0 100644 --- a/docs/api/classes/TextLoader.md +++ b/docs/api/classes/TextLoader.md @@ -6,8 +6,6 @@ # Class: TextLoader -Defined in: [rag/document/loaders.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L56) - Text file loader ## Extended by @@ -37,8 +35,6 @@ Text file loader > **load**(`source`, `options?`): `Promise`\<[`MDocument`](MDocument.md)\> -Defined in: [rag/document/loaders.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L57) - Load document from source #### Parameters @@ -71,8 +67,6 @@ Promise resolving to MDocument > **canHandle**(`source`): `boolean` -Defined in: [rag/document/loaders.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L65) - Check if loader can handle the source #### Parameters @@ -99,8 +93,6 @@ True if loader can handle the source > `protected` **loadContent**(`source`, `encoding?`): `Promise`\<`string`\> -Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L70) - #### Parameters ##### source @@ -121,8 +113,6 @@ Defined in: [rag/document/loaders.ts:70](https://github.com/juspay/neurolink/blo > `protected` **getSourceName**(`source`): `string` -Defined in: [rag/document/loaders.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L81) - #### Parameters ##### source diff --git a/docs/api/classes/TokenChunker.md b/docs/api/classes/TokenChunker.md index 490e78703..9137a4e0d 100644 --- a/docs/api/classes/TokenChunker.md +++ b/docs/api/classes/TokenChunker.md @@ -6,8 +6,6 @@ # Class: TokenChunker -Defined in: [rag/chunking/tokenChunker.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/tokenChunker.ts#L24) - Token-aware chunker implementation Splits text based on approximate token counts @@ -34,8 +32,6 @@ For exact token counts, integrate with tiktoken or model-specific tokenizers. > `readonly` **strategy**: `"token"` -Defined in: [rag/chunking/tokenChunker.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/tokenChunker.ts#L25) - Strategy name for identification #### Implementation of @@ -48,8 +44,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/tokenChunker.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/tokenChunker.ts#L35) - Split text into chunks #### Parameters @@ -82,8 +76,6 @@ Array of chunks > **estimateTokenCount**(`text`, `tokenizer?`): `number` -Defined in: [rag/chunking/tokenChunker.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/tokenChunker.ts#L200) - Estimate token count for text #### Parameters @@ -106,8 +98,6 @@ Estimate token count for text > **validateConfig**(`config`): [`ChunkerValidationResult`](../type-aliases/ChunkerValidationResult.md) -Defined in: [rag/chunking/tokenChunker.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/tokenChunker.ts#L204) - #### Parameters ##### config diff --git a/docs/api/classes/TokenRefreshError.md b/docs/api/classes/TokenRefreshError.md index 3bc1ab52f..6f2639d21 100644 --- a/docs/api/classes/TokenRefreshError.md +++ b/docs/api/classes/TokenRefreshError.md @@ -6,8 +6,6 @@ # Class: TokenRefreshError -Defined in: [client/auth.ts:463](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L463) - Error thrown when token refresh fails ## Extends @@ -20,8 +18,6 @@ Error thrown when token refresh fails > **new TokenRefreshError**(`message`, `cause?`): `TokenRefreshError` -Defined in: [client/auth.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L466) - #### Parameters ##### message @@ -46,8 +42,6 @@ Defined in: [client/auth.ts:466](https://github.com/juspay/neurolink/blob/releas > `readonly` `optional` **cause?**: `Error` -Defined in: [client/auth.ts:464](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L464) - #### Overrides `Error.cause` diff --git a/docs/api/classes/TokenStoreError.md b/docs/api/classes/TokenStoreError.md index 3a43d1aac..bb10bec15 100644 --- a/docs/api/classes/TokenStoreError.md +++ b/docs/api/classes/TokenStoreError.md @@ -6,8 +6,6 @@ # Class: TokenStoreError -Defined in: [types/errors.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L205) - Token storage error for authentication-related failures ## Extends @@ -20,8 +18,6 @@ Token storage error for authentication-related failures > **new TokenStoreError**(`message`, `code?`): `TokenStoreError` -Defined in: [types/errors.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L206) - #### Parameters ##### message @@ -45,5 +41,3 @@ Defined in: [types/errors.ts:206](https://github.com/juspay/neurolink/blob/relea ### code > `readonly` **code**: `"STORAGE_ERROR"` \| `"ENCRYPTION_ERROR"` \| `"VALIDATION_ERROR"` \| `"NOT_FOUND"` \| `"REFRESH_ERROR"` = `"STORAGE_ERROR"` - -Defined in: [types/errors.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L208) diff --git a/docs/api/classes/TokenTracker.md b/docs/api/classes/TokenTracker.md index 885182b7e..de17871c5 100644 --- a/docs/api/classes/TokenTracker.md +++ b/docs/api/classes/TokenTracker.md @@ -6,8 +6,6 @@ # Class: TokenTracker -Defined in: [observability/tokenTracker.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L81) - Token tracker for aggregating usage across spans ## Constructors @@ -26,8 +24,6 @@ Token tracker for aggregating usage across spans > **setObservabilityModelPricing**(`modelName`, `pricing`): `void` -Defined in: [observability/tokenTracker.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L102) - Set custom pricing for a single model #### Parameters @@ -54,8 +50,6 @@ The pricing information > **updatePricing**(`model`, `pricing`): `void` -Defined in: [observability/tokenTracker.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L114) - Update pricing for an existing model (alias for setObservabilityModelPricing) #### Parameters @@ -82,8 +76,6 @@ The new pricing information > **loadPricingFromConfig**(`config`): `void` -Defined in: [observability/tokenTracker.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L123) - Load pricing configuration from a config object Useful for loading pricing from environment or config files @@ -105,8 +97,6 @@ Record of model names to pricing information > **getModelPricing**(`model`): [`ObservabilityModelPricing`](../type-aliases/ObservabilityModelPricing.md) \| `undefined` -Defined in: [observability/tokenTracker.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L136) - Get pricing for a specific model #### Parameters @@ -129,8 +119,6 @@ The pricing information or undefined if not found > **getAllPricing**(): `Record`\<`string`, [`ObservabilityModelPricing`](../type-aliases/ObservabilityModelPricing.md)\> -Defined in: [observability/tokenTracker.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L144) - Get all available model pricing (custom + built-in) #### Returns @@ -145,8 +133,6 @@ Record of all model pricing > **removeCustomPricing**(`model`): `boolean` -Defined in: [observability/tokenTracker.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L160) - Remove custom pricing for a model (falls back to built-in) #### Parameters @@ -167,8 +153,6 @@ The model name to remove custom pricing for > **trackSpan**(`span`): `void` -Defined in: [observability/tokenTracker.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L167) - Track token usage from a span #### Parameters @@ -187,8 +171,6 @@ Track token usage from a span > **trackUsage**(`usage`): `void` -Defined in: [observability/tokenTracker.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L274) - Track token usage from a simple usage object This is a convenience method for tracking usage without a full span @@ -228,8 +210,6 @@ Token usage data > **getStats**(): [`TokenUsageStats`](../type-aliases/TokenUsageStats.md) -Defined in: [observability/tokenTracker.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L347) - Get current stats #### Returns @@ -242,8 +222,6 @@ Get current stats > **getStatsForWindow**(`spans`): [`TokenUsageStats`](../type-aliases/TokenUsageStats.md) -Defined in: [observability/tokenTracker.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L354) - Get stats for a specific time window of spans #### Parameters @@ -262,8 +240,6 @@ Get stats for a specific time window of spans > **reset**(): `void` -Defined in: [observability/tokenTracker.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L369) - Reset all stats #### Returns @@ -276,8 +252,6 @@ Reset all stats > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [observability/tokenTracker.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L387) - Export stats as JSON #### Returns @@ -290,8 +264,6 @@ Export stats as JSON > **formatCost**(`cost`, `currency?`): `string` -Defined in: [observability/tokenTracker.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L405) - Format cost as currency string #### Parameters @@ -314,8 +286,6 @@ Format cost as currency string > **getSummary**(): `string` -Defined in: [observability/tokenTracker.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/observability/tokenTracker.ts#L416) - Get a summary string of current stats #### Returns diff --git a/docs/api/classes/ToneConsistencyScorer.md b/docs/api/classes/ToneConsistencyScorer.md index 4dde212ba..2ccb9f2b9 100644 --- a/docs/api/classes/ToneConsistencyScorer.md +++ b/docs/api/classes/ToneConsistencyScorer.md @@ -6,8 +6,6 @@ # Class: ToneConsistencyScorer -Defined in: [evaluation/scorers/llm/toneConsistencyScorer.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toneConsistencyScorer.ts#L51) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new ToneConsistencyScorer**(`config?`): `ToneConsistencyScorer` -Defined in: [evaluation/scorers/llm/toneConsistencyScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toneConsistencyScorer.ts#L52) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/toneConsistencyScorer.ts:52](https://github. > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/toneConsistencyScorer.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toneConsistencyScorer.ts#L75) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/toneConsistencyScorer.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toneConsistencyScorer.ts#L89) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/ToolCache.md b/docs/api/classes/ToolCache.md index b590e95de..4787cc60b 100644 --- a/docs/api/classes/ToolCache.md +++ b/docs/api/classes/ToolCache.md @@ -6,8 +6,6 @@ # Class: ToolCache\ -Defined in: [mcp/caching/toolCache.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L41) - Tool Cache - High-performance caching for MCP tool results ## Example @@ -45,8 +43,6 @@ cache.invalidate("getUserById:*"); > **new ToolCache**\<`T`\>(`config`): `ToolCache`\<`T`\> -Defined in: [mcp/caching/toolCache.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L47) - #### Parameters ##### config @@ -69,8 +65,6 @@ Defined in: [mcp/caching/toolCache.ts:47](https://github.com/juspay/neurolink/bl > **get** **size**(): `number` -Defined in: [mcp/caching/toolCache.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L269) - Get the number of entries in the cache ##### Returns @@ -83,8 +77,6 @@ Get the number of entries in the cache > **get**(`key`): `T` \| `undefined` -Defined in: [mcp/caching/toolCache.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L80) - Get a value from the cache Returns an isolated copy of the stored value (see `cloneCachedValue`), so @@ -107,8 +99,6 @@ hits or for other concurrent callers of the same key. > **set**(`key`, `value`, `ttl?`): `void` -Defined in: [mcp/caching/toolCache.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L127) - Set a value in the cache Stores an isolated copy of `value` (see `cloneCachedValue`), so mutating @@ -139,8 +129,6 @@ cache entry. > **has**(`key`): `boolean` -Defined in: [mcp/caching/toolCache.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L155) - Check if a key exists and is not expired #### Parameters @@ -159,8 +147,6 @@ Check if a key exists and is not expired > **delete**(`key`): `boolean` -Defined in: [mcp/caching/toolCache.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L173) - Delete a specific key from the cache #### Parameters @@ -179,8 +165,6 @@ Delete a specific key from the cache > **invalidate**(`pattern`): `number` -Defined in: [mcp/caching/toolCache.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L189) - Invalidate entries matching a pattern Supports glob-style patterns with \* wildcard @@ -200,8 +184,6 @@ Supports glob-style patterns with \* wildcard > **clear**(): `void` -Defined in: [mcp/caching/toolCache.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L209) - Clear all entries from the cache #### Returns @@ -214,8 +196,6 @@ Clear all entries from the cache > **getOrSet**(`key`, `factory`, `ttl?`): `Promise`\<`T`\> -Defined in: [mcp/caching/toolCache.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L219) - Get or set a value (cache-aside pattern) #### Parameters @@ -242,8 +222,6 @@ Get or set a value (cache-aside pattern) > **getStats**(): [`CacheStats`](../type-aliases/CacheStats.md) -Defined in: [mcp/caching/toolCache.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L245) - Get cache statistics #### Returns @@ -256,8 +234,6 @@ Get cache statistics > **resetStats**(): `void` -Defined in: [mcp/caching/toolCache.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L252) - Reset statistics #### Returns @@ -270,8 +246,6 @@ Reset statistics > **keys**(): `string`[] -Defined in: [mcp/caching/toolCache.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L262) - Get all keys in the cache #### Returns @@ -284,8 +258,6 @@ Get all keys in the cache > `static` **generateKey**(`toolName`, `args`): `string` -Defined in: [mcp/caching/toolCache.ts:276](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L276) - Generate a cache key from tool name and arguments #### Parameters @@ -308,8 +280,6 @@ Generate a cache key from tool name and arguments > **destroy**(): `void` -Defined in: [mcp/caching/toolCache.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L320) - Stop the auto-cleanup timer #### Returns diff --git a/docs/api/classes/ToolCallBatcher.md b/docs/api/classes/ToolCallBatcher.md index 05ecdd68b..fad051f93 100644 --- a/docs/api/classes/ToolCallBatcher.md +++ b/docs/api/classes/ToolCallBatcher.md @@ -6,8 +6,6 @@ # Class: ToolCallBatcher -Defined in: [mcp/batching/requestBatcher.ts:486](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L486) - Tool Call Batcher - Specialized batcher for MCP tool calls ## Constructors @@ -16,8 +14,6 @@ Tool Call Batcher - Specialized batcher for MCP tool calls > **new ToolCallBatcher**(`config?`): `ToolCallBatcher` -Defined in: [mcp/batching/requestBatcher.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L494) - #### Parameters ##### config? @@ -36,8 +32,6 @@ Defined in: [mcp/batching/requestBatcher.ts:494](https://github.com/juspay/neuro > **get** **queueSize**(): `number` -Defined in: [mcp/batching/requestBatcher.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L574) - Get current queue size ##### Returns @@ -52,8 +46,6 @@ Get current queue size > **get** **isIdle**(): `boolean` -Defined in: [mcp/batching/requestBatcher.ts:581](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L581) - Check if idle ##### Returns @@ -66,8 +58,6 @@ Check if idle > **setToolExecutor**(`executor`): `void` -Defined in: [mcp/batching/requestBatcher.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L536) - Set the tool executor function #### Parameters @@ -86,8 +76,6 @@ Set the tool executor function > **execute**(`tool`, `args`, `serverId?`): `Promise`\<`unknown`\> -Defined in: [mcp/batching/requestBatcher.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L549) - Execute a tool call (will be batched automatically) #### Parameters @@ -114,8 +102,6 @@ Execute a tool call (will be batched automatically) > **flush**(): `Promise`\<`void`\> -Defined in: [mcp/batching/requestBatcher.ts:560](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L560) - Flush pending tool calls #### Returns @@ -128,8 +114,6 @@ Flush pending tool calls > **drain**(): `Promise`\<`void`\> -Defined in: [mcp/batching/requestBatcher.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L567) - Wait for all pending tool calls to complete #### Returns @@ -142,8 +126,6 @@ Wait for all pending tool calls to complete > **destroy**(): `void` -Defined in: [mcp/batching/requestBatcher.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L588) - Destroy the batcher #### Returns diff --git a/docs/api/classes/ToolEmbeddingIndex.md b/docs/api/classes/ToolEmbeddingIndex.md index 5007148a1..645fd75db 100644 --- a/docs/api/classes/ToolEmbeddingIndex.md +++ b/docs/api/classes/ToolEmbeddingIndex.md @@ -6,8 +6,6 @@ # Class: ToolEmbeddingIndex -Defined in: [core/toolRoutingEmbedding.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingEmbedding.ts#L236) - An in-process index that ranks tool catalog items by hybrid semantic + lexical relevance to a query. @@ -35,8 +33,6 @@ deterministic for a given text). > **new ToolEmbeddingIndex**(`items`, `embedFn`, `sharedVectorCache?`): `ToolEmbeddingIndex` -Defined in: [core/toolRoutingEmbedding.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingEmbedding.ts#L251) - #### Parameters ##### items @@ -65,8 +61,6 @@ into this same Map, making it warm for the next call. > **rank**(`query`, `opts`): `Promise`\<[`ToolRetrievalRankedResult`](../type-aliases/ToolRetrievalRankedResult.md)[]\> -Defined in: [core/toolRoutingEmbedding.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingEmbedding.ts#L272) - Returns the top-K catalog items ranked by hybrid score descending. #### Parameters diff --git a/docs/api/classes/ToolIntegrationManager.md b/docs/api/classes/ToolIntegrationManager.md index f6575b8a7..e7717ce6d 100644 --- a/docs/api/classes/ToolIntegrationManager.md +++ b/docs/api/classes/ToolIntegrationManager.md @@ -6,8 +6,6 @@ # Class: ToolIntegrationManager -Defined in: [mcp/toolIntegration.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L386) - Tool Integration Manager Manages tool execution with middleware and elicitation support. @@ -18,8 +16,6 @@ Manages tool execution with middleware and elicitation support. > **new ToolIntegrationManager**(`elicitationManager?`): `ToolIntegrationManager` -Defined in: [mcp/toolIntegration.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L391) - #### Parameters ##### elicitationManager? @@ -36,8 +32,6 @@ Defined in: [mcp/toolIntegration.ts:391](https://github.com/juspay/neurolink/blo > **setElicitationHandler**(`handler`): `void` -Defined in: [mcp/toolIntegration.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L398) - Set the elicitation handler #### Parameters @@ -56,8 +50,6 @@ Set the elicitation handler > **use**(`middleware`): `this` -Defined in: [mcp/toolIntegration.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L405) - Add middleware #### Parameters @@ -76,8 +68,6 @@ Add middleware > **registerTool**(`tool`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) -Defined in: [mcp/toolIntegration.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L413) - Register a tool with integration #### Parameters @@ -96,8 +86,6 @@ Register a tool with integration > **executeTool**(`toolName`, `params`, `context?`): `Promise`\<`unknown`\> -Defined in: [mcp/toolIntegration.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L425) - Execute a tool with full middleware chain #### Parameters @@ -124,8 +112,6 @@ Execute a tool with full middleware chain > **getTool**(`name`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) \| `undefined` -Defined in: [mcp/toolIntegration.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L477) - Get registered tool #### Parameters @@ -144,8 +130,6 @@ Get registered tool > **getAllTools**(): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/toolIntegration.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L484) - Get all registered tools #### Returns @@ -158,8 +142,6 @@ Get all registered tools > **getElicitationManager**(): [`ElicitationManager`](ElicitationManager.md) -Defined in: [mcp/toolIntegration.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L491) - Get the elicitation manager #### Returns diff --git a/docs/api/classes/ToolResultCache.md b/docs/api/classes/ToolResultCache.md index 8a7a1e14f..5853a0506 100644 --- a/docs/api/classes/ToolResultCache.md +++ b/docs/api/classes/ToolResultCache.md @@ -6,8 +6,6 @@ # Class: ToolResultCache -Defined in: [mcp/caching/toolCache.ts:514](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L514) - Tool-specific cache wrapper with automatic key generation ## Constructors @@ -16,8 +14,6 @@ Tool-specific cache wrapper with automatic key generation > **new ToolResultCache**(`config?`): `ToolResultCache` -Defined in: [mcp/caching/toolCache.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L517) - #### Parameters ##### config? @@ -34,8 +30,6 @@ Defined in: [mcp/caching/toolCache.ts:517](https://github.com/juspay/neurolink/b > **cacheResult**(`toolName`, `args`, `result`, `ttl?`): `void` -Defined in: [mcp/caching/toolCache.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L528) - Cache a tool result #### Parameters @@ -66,8 +60,6 @@ Cache a tool result > **getCachedResult**(`toolName`, `args`): `unknown` -Defined in: [mcp/caching/toolCache.ts:541](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L541) - Get a cached tool result #### Parameters @@ -90,8 +82,6 @@ Get a cached tool result > **hasCachedResult**(`toolName`, `args`): `boolean` -Defined in: [mcp/caching/toolCache.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L549) - Check if a result is cached #### Parameters @@ -114,8 +104,6 @@ Check if a result is cached > **invalidateTool**(`toolName`): `number` -Defined in: [mcp/caching/toolCache.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L557) - Invalidate all cached results for a tool #### Parameters @@ -134,8 +122,6 @@ Invalidate all cached results for a tool > **getStats**(): [`CacheStats`](../type-aliases/CacheStats.md) -Defined in: [mcp/caching/toolCache.ts:564](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L564) - Get cache statistics #### Returns @@ -148,8 +134,6 @@ Get cache statistics > **clear**(): `void` -Defined in: [mcp/caching/toolCache.ts:571](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L571) - Clear all cached results #### Returns @@ -162,8 +146,6 @@ Clear all cached results > **destroy**(): `void` -Defined in: [mcp/caching/toolCache.ts:578](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L578) - Destroy the cache #### Returns diff --git a/docs/api/classes/ToolRouter.md b/docs/api/classes/ToolRouter.md index b3f4ad504..3bfc15e36 100644 --- a/docs/api/classes/ToolRouter.md +++ b/docs/api/classes/ToolRouter.md @@ -6,8 +6,6 @@ # Class: ToolRouter -Defined in: [mcp/routing/toolRouter.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L50) - Tool Router - Intelligent routing for MCP tool calls ## Example @@ -36,8 +34,6 @@ console.log(`Routing to: ${decision.serverId}`); > **new ToolRouter**(`config?`): `ToolRouter` -Defined in: [mcp/routing/toolRouter.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L59) - #### Parameters ##### config? @@ -58,8 +54,6 @@ Defined in: [mcp/routing/toolRouter.ts:59](https://github.com/juspay/neurolink/b > **destroy**(): `void` -Defined in: [mcp/routing/toolRouter.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L83) - #### Returns `void` @@ -70,8 +64,6 @@ Defined in: [mcp/routing/toolRouter.ts:83](https://github.com/juspay/neurolink/b > **registerServer**(`serverId`, `capabilities?`): `void` -Defined in: [mcp/routing/toolRouter.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L104) - Register a server as available for routing #### Parameters @@ -94,8 +86,6 @@ Register a server as available for routing > **unregisterServer**(`serverId`): `void` -Defined in: [mcp/routing/toolRouter.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L125) - Unregister a server from routing #### Parameters @@ -114,8 +104,6 @@ Unregister a server from routing > **route**(`tool`, `context?`): [`RoutingDecision`](../type-aliases/RoutingDecision.md) -Defined in: [mcp/routing/toolRouter.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L146) - Route a tool call to the best server #### Parameters @@ -144,8 +132,6 @@ Route a tool call to the best server > **routeByCategory**(`tool`, `category`): `string`[] -Defined in: [mcp/routing/toolRouter.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L208) - Route by tool category #### Parameters @@ -168,8 +154,6 @@ Route by tool category > **routeByAnnotation**(`tool`): `string`[] -Defined in: [mcp/routing/toolRouter.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L216) - Route by tool annotation hints #### Parameters @@ -188,8 +172,6 @@ Route by tool annotation hints > **routeByCapability**(`tool`, `requiredCapabilities`): `string`[] -Defined in: [mcp/routing/toolRouter.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L262) - Route by required capabilities #### Parameters @@ -212,8 +194,6 @@ Route by required capabilities > **updateServerLoad**(`serverId`, `delta`): `void` -Defined in: [mcp/routing/toolRouter.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L292) - Update server load for least-loaded routing #### Parameters @@ -236,8 +216,6 @@ Update server load for least-loaded routing > **updateHealthStatus**(`serverId`, `healthy`): `void` -Defined in: [mcp/routing/toolRouter.ts:300](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L300) - Update server health status #### Parameters @@ -260,8 +238,6 @@ Update server health status > **setAffinity**(`key`, `serverId`): `void` -Defined in: [mcp/routing/toolRouter.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L312) - Set session/user affinity #### Parameters @@ -284,8 +260,6 @@ Set session/user affinity > **clearAffinity**(`key`): `void` -Defined in: [mcp/routing/toolRouter.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L324) - Clear affinity for a key #### Parameters @@ -304,8 +278,6 @@ Clear affinity for a key > **getStats**(): `object` -Defined in: [mcp/routing/toolRouter.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L331) - Get current routing statistics #### Returns diff --git a/docs/api/classes/ToolRoutingCache.md b/docs/api/classes/ToolRoutingCache.md index 5618eb642..c289899d4 100644 --- a/docs/api/classes/ToolRoutingCache.md +++ b/docs/api/classes/ToolRoutingCache.md @@ -6,16 +6,12 @@ # Class: ToolRoutingCache -Defined in: [core/toolRoutingCache.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingCache.ts#L34) - ## Constructors ### Constructor > **new ToolRoutingCache**(`opts?`): `ToolRoutingCache` -Defined in: [core/toolRoutingCache.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingCache.ts#L47) - #### Parameters ##### opts? @@ -32,8 +28,6 @@ Defined in: [core/toolRoutingCache.ts:47](https://github.com/juspay/neurolink/bl > **get**(`key`): \{ `excludedToolNames`: `string`[]; `selectedServerIds`: `string`[]; \} \| `undefined` -Defined in: [core/toolRoutingCache.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingCache.ts#L62) - Returns the cached routing result for the given key, or `undefined` on a miss or expiry. Expired entries are deleted on access (lazy eviction). @@ -53,8 +47,6 @@ miss or expiry. Expired entries are deleted on access (lazy eviction). > **set**(`key`, `value`): `void` -Defined in: [core/toolRoutingCache.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingCache.ts#L89) - Stores a routing result under the given key. Evicts the least-recently- used entry when the store is at capacity. Silently no-ops on any error (caller is responsible for fail-open behaviour). @@ -85,8 +77,6 @@ used entry when the store is at capacity. Silently no-ops on any error > **recordSelection**(`sessionId`, `serverIds`): `void` -Defined in: [core/toolRoutingCache.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingCache.ts#L114) - Records the server ids selected by the router for a session so they stay warm for the next `stickyTurns` turns. Called after a successful (non-cached) routing resolution. @@ -111,8 +101,6 @@ warm for the next `stickyTurns` turns. Called after a successful > **getStickyServerIds**(`sessionId`): `string`[] -Defined in: [core/toolRoutingCache.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingCache.ts#L138) - Returns the server ids that should be kept warm (not excluded) for the given session due to stickiness. Decrements the turn counter; when it reaches zero the entry is removed. Returns an empty array when there is no diff --git a/docs/api/classes/TopologyBuilder.md b/docs/api/classes/TopologyBuilder.md index 98301f101..3ab8164de 100644 --- a/docs/api/classes/TopologyBuilder.md +++ b/docs/api/classes/TopologyBuilder.md @@ -6,8 +6,6 @@ # Class: TopologyBuilder -Defined in: [agent/orchestration/topology.ts:581](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L581) - Topology builder for fluent API ## Constructors @@ -16,8 +14,6 @@ Topology builder for fluent API > **new TopologyBuilder**(`type`): `TopologyBuilder` -Defined in: [agent/orchestration/topology.ts:585](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L585) - #### Parameters ##### type @@ -34,8 +30,6 @@ Defined in: [agent/orchestration/topology.ts:585](https://github.com/juspay/neur > **addAgent**(`agent`): `TopologyBuilder` -Defined in: [agent/orchestration/topology.ts:592](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L592) - Add an agent #### Parameters @@ -54,8 +48,6 @@ Add an agent > **addAgents**(`agents`): `TopologyBuilder` -Defined in: [agent/orchestration/topology.ts:600](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L600) - Add multiple agents #### Parameters @@ -74,8 +66,6 @@ Add multiple agents > **setCoordinator**(`agentId`): `TopologyBuilder` -Defined in: [agent/orchestration/topology.ts:608](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L608) - Set coordinator (for star topology) #### Parameters @@ -94,8 +84,6 @@ Set coordinator (for star topology) > **setRoot**(`agentId`): `TopologyBuilder` -Defined in: [agent/orchestration/topology.ts:616](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L616) - Set root (for hierarchical topology) #### Parameters @@ -114,8 +102,6 @@ Set root (for hierarchical topology) > **setMaxChildren**(`max`): `TopologyBuilder` -Defined in: [agent/orchestration/topology.ts:624](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L624) - Set max children (for hierarchical topology) #### Parameters @@ -134,8 +120,6 @@ Set max children (for hierarchical topology) > **addCustomEdge**(`sourceAgentId`, `targetAgentId`, `bidirectional?`): `TopologyBuilder` -Defined in: [agent/orchestration/topology.ts:632](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L632) - Add custom edge #### Parameters @@ -162,8 +146,6 @@ Add custom edge > **build**(): [`NetworkTopology`](NetworkTopology.md) -Defined in: [agent/orchestration/topology.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/agent/orchestration/topology.ts#L651) - Build the topology #### Returns diff --git a/docs/api/classes/ToxicityScorer.md b/docs/api/classes/ToxicityScorer.md index 7f443797c..90f1bc4a4 100644 --- a/docs/api/classes/ToxicityScorer.md +++ b/docs/api/classes/ToxicityScorer.md @@ -6,8 +6,6 @@ # Class: ToxicityScorer -Defined in: [evaluation/scorers/llm/toxicityScorer.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toxicityScorer.ts#L69) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, @@ -50,8 +48,6 @@ const result = await pipeline.evaluate({ > **new ToxicityScorer**(`config?`): `ToxicityScorer` -Defined in: [evaluation/scorers/llm/toxicityScorer.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toxicityScorer.ts#L70) - #### Parameters ##### config? @@ -72,8 +68,6 @@ Defined in: [evaluation/scorers/llm/toxicityScorer.ts:70](https://github.com/jus > `protected` **\_config**: [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L43) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_config`](BaseLLMScorer.md#_config) @@ -84,8 +78,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:43](https://github.com/juspay/neur > `protected` **\_metadata**: [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L44) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_metadata`](BaseLLMScorer.md#_metadata) @@ -96,8 +88,6 @@ Defined in: [evaluation/scorers/baseScorer.ts:44](https://github.com/juspay/neur > `protected` **\_llmConfig**: [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L36) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`_llmConfig`](BaseLLMScorer.md#_llmconfig) @@ -108,8 +98,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:36](https://github.com/jusp > `protected` `optional` **provider?**: [`AIProvider`](../type-aliases/AIProvider.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L37) - #### Inherited from [`BaseLLMScorer`](BaseLLMScorer.md).[`provider`](BaseLLMScorer.md#provider) @@ -122,8 +110,6 @@ Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:37](https://github.com/jusp > **get** **metadata**(): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/baseScorer.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L58) - Get scorer metadata ##### Returns @@ -142,8 +128,6 @@ Get scorer metadata > **get** **config**(): [`ScorerConfig`](../type-aliases/ScorerConfig.md) -Defined in: [evaluation/scorers/baseScorer.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L65) - Get current configuration ##### Returns @@ -162,8 +146,6 @@ Get current configuration > **get** **llmConfig**(): [`LLMScorerConfig`](../type-aliases/LLMScorerConfig.md) -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L52) - Get LLM-specific configuration ##### Returns @@ -180,8 +162,6 @@ Get LLM-specific configuration > **validateInput**(`input`): `object` -Defined in: [evaluation/scorers/baseScorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L77) - Validate input has required fields #### Parameters @@ -212,8 +192,6 @@ Validate input has required fields > **configure**(`config`): `void` -Defined in: [evaluation/scorers/baseScorer.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L122) - Update configuration #### Parameters @@ -236,8 +214,6 @@ Update configuration > `protected` **normalizeScore**(`score`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L135) - Normalize a score to 0-1 scale #### Parameters @@ -264,8 +240,6 @@ Normalize a score to 0-1 scale > `protected` **denormalizeScore**(`normalizedScore`, `scale?`): `number` -Defined in: [evaluation/scorers/baseScorer.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L161) - Convert normalized score back to scale #### Parameters @@ -292,8 +266,6 @@ Convert normalized score back to scale > `protected` **checkThreshold**(`normalizedScore`): `boolean` -Defined in: [evaluation/scorers/baseScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L172) - Check if score passes threshold #### Parameters @@ -316,8 +288,6 @@ Check if score passes threshold > `protected` **createScoreResult**(`score`, `reasoning`, `options?`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L180) - Create a standardized score result #### Parameters @@ -362,8 +332,6 @@ Create a standardized score result > `protected` **createErrorResult**(`error`): [`ScoreResult`](../type-aliases/ScoreResult.md) -Defined in: [evaluation/scorers/baseScorer.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L225) - Create an error score result #### Parameters @@ -386,8 +354,6 @@ Create an error score result > `protected` **executeWithTiming**(`scoringFn`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/baseScorer.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L244) - Execute scoring with timing and error handling #### Parameters @@ -410,8 +376,6 @@ Execute scoring with timing and error handling > `protected` **executeWithTimeout**\<`T`\>(`fn`, `timeoutMs`, `operationName`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L272) - Execute scoring with timeout #### Type Parameters @@ -448,8 +412,6 @@ Execute scoring with timeout > `protected` **executeWithRetry**\<`T`\>(`operation`, `retries?`): `Promise`\<`T`\> -Defined in: [evaluation/scorers/baseScorer.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/baseScorer.ts#L287) - Execute with retry logic #### Type Parameters @@ -482,8 +444,6 @@ Execute with retry logic > **score**(`input`): `Promise`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L72) - Main scoring method #### Parameters @@ -506,8 +466,6 @@ Main scoring method > `protected` **initializeProvider**(): `Promise`\<`void`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L118) - Initialize the AI provider #### Returns @@ -524,8 +482,6 @@ Initialize the AI provider > `protected` **callLLM**(`prompt`): `Promise`\<`string`\> -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L172) - Call the LLM with the given prompt #### Parameters @@ -548,8 +504,6 @@ Call the LLM with the given prompt > `protected` **extractJSON**(`response`): [`JsonObject`](../type-aliases/JsonObject.md) \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L202) - Extract JSON from LLM response Handles various formats including markdown code blocks @@ -573,8 +527,6 @@ Handles various formats including markdown code blocks > `protected` **substituteTemplate**(`template`, `variables`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L254) - Simple template substitution for prompts #### Parameters @@ -601,8 +553,6 @@ Simple template substitution for prompts > `protected` **processConditionals**(`template`, `conditions`): `string` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L308) - Handle conditional template blocks #### Parameters @@ -629,8 +579,6 @@ Handle conditional template blocks > `protected` **extractNumericScore**(`text`): `number` \| `null` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L334) - Extract a numeric score from text response Safe numeric extraction without ReDoS-prone regex @@ -654,8 +602,6 @@ Safe numeric extraction without ReDoS-prone regex > `protected` **extractScoreFromText**(`text`, `min?`, `max?`): `number` -Defined in: [evaluation/scorers/llm/baseLLMScorer.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/baseLLMScorer.ts#L361) - Extract a numeric score from text response with fallback #### Parameters @@ -686,8 +632,6 @@ Extract a numeric score from text response with fallback > **generatePrompt**(`input`): `string` -Defined in: [evaluation/scorers/llm/toxicityScorer.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toxicityScorer.ts#L94) - Generate the prompt for LLM scoring - must be implemented by subclasses #### Parameters @@ -710,8 +654,6 @@ Generate the prompt for LLM scoring - must be implemented by subclasses > **parseResponse**(`response`, `_input`): `Partial`\<[`ScoreResult`](../type-aliases/ScoreResult.md)\> -Defined in: [evaluation/scorers/llm/toxicityScorer.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toxicityScorer.ts#L108) - Parse LLM response into score result - must be implemented by subclasses #### Parameters diff --git a/docs/api/classes/TripwireEvaluator.md b/docs/api/classes/TripwireEvaluator.md index c82b4dc31..94ed236f4 100644 --- a/docs/api/classes/TripwireEvaluator.md +++ b/docs/api/classes/TripwireEvaluator.md @@ -6,8 +6,6 @@ # Class: TripwireEvaluator -Defined in: [utils/tripwireEvaluator.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tripwireEvaluator.ts#L42) - Manages and evaluates tripwire conditions against LLM response data. ## Example @@ -42,8 +40,6 @@ if (result.triggered && result.action === "abort") { > **register**(`tripwire`): `void` -Defined in: [utils/tripwireEvaluator.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tripwireEvaluator.ts#L48) - Register a tripwire. Replaces any existing tripwire with the same id. #### Parameters @@ -62,8 +58,6 @@ Register a tripwire. Replaces any existing tripwire with the same id. > **unregister**(`id`): `boolean` -Defined in: [utils/tripwireEvaluator.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tripwireEvaluator.ts#L61) - Remove a registered tripwire by id. #### Parameters @@ -84,8 +78,6 @@ true if the tripwire was found and removed, false otherwise. > **evaluate**(`data`): [`TripwireResult`](../type-aliases/TripwireResult.md) -Defined in: [utils/tripwireEvaluator.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tripwireEvaluator.ts#L80) - Evaluate all tripwires and return the highest-priority triggered result. Priority order: "abort" > "warn" > "log" @@ -111,8 +103,6 @@ and promotes the highest-severity action. > **evaluateAll**(`data`): [`TripwireResult`](../type-aliases/TripwireResult.md)[] -Defined in: [utils/tripwireEvaluator.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tripwireEvaluator.ts#L135) - Evaluate all tripwires and return every triggered result. #### Parameters @@ -131,8 +121,6 @@ Evaluate all tripwires and return every triggered result. > **getTripwires**(): [`TripwireConfig`](../type-aliases/TripwireConfig.md)[] -Defined in: [utils/tripwireEvaluator.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tripwireEvaluator.ts#L169) - Return a shallow copy of all registered tripwires. #### Returns diff --git a/docs/api/classes/TypedEventEmitter.md b/docs/api/classes/TypedEventEmitter.md index 67bf64139..f070481fa 100644 --- a/docs/api/classes/TypedEventEmitter.md +++ b/docs/api/classes/TypedEventEmitter.md @@ -6,8 +6,6 @@ # Class: TypedEventEmitter\ -Defined in: [core/infrastructure/typedEventEmitter.ts:3](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L3) - ## Extended by - [`RAGCircuitBreaker`](RAGCircuitBreaker.md) @@ -34,8 +32,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:3](https://github.com/jusp > **on**\<`K`\>(`event`, `listener`): `this` -Defined in: [core/infrastructure/typedEventEmitter.ts:6](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L6) - #### Type Parameters ##### K @@ -62,8 +58,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:6](https://github.com/jusp > **off**\<`K`\>(`event`, `listener`): `this` -Defined in: [core/infrastructure/typedEventEmitter.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L14) - #### Type Parameters ##### K @@ -90,8 +84,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:14](https://github.com/jus > **emit**\<`K`\>(`event`, ...`args`): `boolean` -Defined in: [core/infrastructure/typedEventEmitter.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L22) - #### Type Parameters ##### K @@ -118,8 +110,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:22](https://github.com/jus > **once**\<`K`\>(`event`, `listener`): `this` -Defined in: [core/infrastructure/typedEventEmitter.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L26) - #### Type Parameters ##### K @@ -146,8 +136,6 @@ Defined in: [core/infrastructure/typedEventEmitter.ts:26](https://github.com/jus > **removeAllListeners**\<`K`\>(`event?`): `this` -Defined in: [core/infrastructure/typedEventEmitter.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/typedEventEmitter.ts#L37) - #### Type Parameters ##### K diff --git a/docs/api/classes/UserRateLimiter.md b/docs/api/classes/UserRateLimiter.md index 52805b337..f93a96923 100644 --- a/docs/api/classes/UserRateLimiter.md +++ b/docs/api/classes/UserRateLimiter.md @@ -6,8 +6,6 @@ # Class: UserRateLimiter -Defined in: [auth/middleware/rateLimitByUser.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L293) - Token bucket rate limiter implementation Uses the token bucket algorithm which allows for burst traffic while @@ -20,8 +18,6 @@ the bucket at a fixed rate, and each request consumes one token. > **new UserRateLimiter**(`config`, `storage?`): `UserRateLimiter` -Defined in: [auth/middleware/rateLimitByUser.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L297) - #### Parameters ##### config @@ -42,8 +38,6 @@ Defined in: [auth/middleware/rateLimitByUser.ts:297](https://github.com/juspay/n > **consume**(`user`): `Promise`\<[`RateLimitResult`](../type-aliases/RateLimitResult.md)\> -Defined in: [auth/middleware/rateLimitByUser.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L355) - Consume a token from the user's bucket Returns the rate limit result @@ -68,8 +62,6 @@ token count and both succeed. > **getStatus**(`user`): `Promise`\<[`RateLimitResult`](../type-aliases/RateLimitResult.md)\> -Defined in: [auth/middleware/rateLimitByUser.ts:462](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L462) - Get current rate limit status for a user without consuming a token #### Parameters @@ -88,8 +80,6 @@ Get current rate limit status for a user without consuming a token > **resetUser**(`userId`): `Promise`\<`void`\> -Defined in: [auth/middleware/rateLimitByUser.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L504) - Reset rate limit for a user (admin action) #### Parameters @@ -108,8 +98,6 @@ Reset rate limit for a user (admin action) > **healthCheck**(): `Promise`\<`boolean`\> -Defined in: [auth/middleware/rateLimitByUser.ts:512](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L512) - Check storage health #### Returns @@ -122,8 +110,6 @@ Check storage health > **cleanup**(): `Promise`\<`void`\> -Defined in: [auth/middleware/rateLimitByUser.ts:519](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L519) - Cleanup resources #### Returns diff --git a/docs/api/classes/VertexVideoHandler.md b/docs/api/classes/VertexVideoHandler.md index d13563ab7..6c973c248 100644 --- a/docs/api/classes/VertexVideoHandler.md +++ b/docs/api/classes/VertexVideoHandler.md @@ -6,8 +6,6 @@ # Class: VertexVideoHandler -Defined in: [adapters/video/vertexVideoHandler.ts:1085](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L1085) - Class wrapper around the standalone Vertex Veo functions, conforming to the `VideoHandler` contract so it can register with `VideoProcessor`. @@ -36,8 +34,6 @@ them directly. > `readonly` **maxDurationSeconds**: `8` = `8` -Defined in: [adapters/video/vertexVideoHandler.ts:1086](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L1086) - Maximum video duration in seconds supported by this provider. #### Implementation of @@ -50,8 +46,6 @@ Maximum video duration in seconds supported by this provider. > `readonly` **supportedAspectRatios**: readonly (`"9:16"` \| `"16:9"`)[] -Defined in: [adapters/video/vertexVideoHandler.ts:1087](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L1087) - Supported aspect ratios. #### Implementation of @@ -64,8 +58,6 @@ Supported aspect ratios. > `readonly` **supportedResolutions**: readonly (`"720p"` \| `"1080p"`)[] -Defined in: [adapters/video/vertexVideoHandler.ts:1091](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L1091) - Supported output resolutions. #### Implementation of @@ -78,8 +70,6 @@ Supported output resolutions. > **isConfigured**(): `boolean` -Defined in: [adapters/video/vertexVideoHandler.ts:1096](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L1096) - Validate the provider is configured (auth, base URL, etc.). #### Returns @@ -96,8 +86,6 @@ Validate the provider is configured (auth, base URL, etc.). > **generate**(`image`, `prompt`, `options`, `region?`): `Promise`\<[`VideoGenerationResult`](../type-aliases/VideoGenerationResult.md)\> -Defined in: [adapters/video/vertexVideoHandler.ts:1100](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L1100) - Generate a single video clip from an input image and prompt. #### Parameters @@ -142,8 +130,6 @@ Buffer + metadata > **generateTransition**(`firstFrame`, `lastFrame`, `prompt`, `options?`, `region?`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\> -Defined in: [adapters/video/vertexVideoHandler.ts:1109](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L1109) - Optional — generate a transition clip between two frames (Director Mode). Providers without first-and-last-frame interpolation omit this method; diff --git a/docs/api/classes/VideoError.md b/docs/api/classes/VideoError.md index d1a2614af..97928bb62 100644 --- a/docs/api/classes/VideoError.md +++ b/docs/api/classes/VideoError.md @@ -6,8 +6,6 @@ # Class: VideoError -Defined in: [adapters/video/vertexVideoHandler.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L43) - Video generation error class Extends NeuroLinkError for consistent error handling across the SDK @@ -21,8 +19,6 @@ Extends NeuroLinkError for consistent error handling across the SDK > **new VideoError**(`options`): `VideoError` -Defined in: [adapters/video/vertexVideoHandler.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L44) - #### Parameters ##### options @@ -69,8 +65,6 @@ Defined in: [adapters/video/vertexVideoHandler.ts:44](https://github.com/juspay/ > `readonly` **code**: `string` -Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L105) - #### Inherited from `NeuroLinkError.code` @@ -81,8 +75,6 @@ Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blo > `readonly` **category**: `ErrorCategory` -Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L106) - #### Inherited from `NeuroLinkError.category` @@ -93,8 +85,6 @@ Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blo > `readonly` **severity**: `ErrorSeverity` -Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L107) - #### Inherited from `NeuroLinkError.severity` @@ -105,8 +95,6 @@ Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blo > `readonly` **retriable**: `boolean` -Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L108) - #### Inherited from `NeuroLinkError.retriable` @@ -117,8 +105,6 @@ Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blo > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L109) - #### Inherited from `NeuroLinkError.retryAfterMs` @@ -129,8 +115,6 @@ Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blo > `readonly` **context**: `Record`\<`string`, `unknown`\> -Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L110) - #### Inherited from `NeuroLinkError.context` @@ -141,8 +125,6 @@ Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blo > `readonly` **timestamp**: `Date` -Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L111) - #### Inherited from `NeuroLinkError.timestamp` @@ -153,8 +135,6 @@ Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blo > `readonly` `optional` **toolName?**: `string` -Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L112) - #### Inherited from `NeuroLinkError.toolName` @@ -165,8 +145,6 @@ Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blo > `readonly` `optional` **serverId?**: `string` -Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L113) - #### Inherited from `NeuroLinkError.serverId` @@ -177,8 +155,6 @@ Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blo > **toJSON**(): [`StructuredError`](../type-aliases/StructuredError.md) -Defined in: [utils/errorHandling.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L149) - Convert to JSON for logging and serialization #### Returns diff --git a/docs/api/classes/VideoProcessor.md b/docs/api/classes/VideoProcessor.md index 94a2c530c..9fbff9448 100644 --- a/docs/api/classes/VideoProcessor.md +++ b/docs/api/classes/VideoProcessor.md @@ -6,8 +6,6 @@ # Class: VideoProcessor -Defined in: [utils/videoProcessor.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/utils/videoProcessor.ts#L52) - Static processor managing the video handler registry. Handlers register themselves during `ProviderRegistry._doRegister()` @@ -30,8 +28,6 @@ O(1) on a normalised lower-case provider key. > `static` **registerHandler**(`providerName`, `handler`): `void` -Defined in: [utils/videoProcessor.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/utils/videoProcessor.ts#L60) - Register a video handler for a specific provider. #### Parameters @@ -54,8 +50,6 @@ Register a video handler for a specific provider. > `static` **supports**(`providerName`): `boolean` -Defined in: [utils/videoProcessor.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/utils/videoProcessor.ts#L69) - Check if a provider has a registered video handler. #### Parameters @@ -74,8 +68,6 @@ Check if a provider has a registered video handler. > `static` **listProviders**(): `string`[] -Defined in: [utils/videoProcessor.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/utils/videoProcessor.ts#L76) - List the names of all registered providers. #### Returns @@ -88,8 +80,6 @@ List the names of all registered providers. > `static` **clearHandlers**(): `void` -Defined in: [utils/videoProcessor.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/utils/videoProcessor.ts#L87) - Clear all registered handlers (for testing). #### Returns @@ -104,8 +94,6 @@ Clear all registered handlers (for testing). > `static` **generate**(`provider`, `options`): `Promise`\<[`VideoGenerationResult`](../type-aliases/VideoGenerationResult.md)\> -Defined in: [utils/videoProcessor.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/utils/videoProcessor.ts#L116) - Generate a single video clip via the registered handler. ##### Parameters @@ -138,8 +126,6 @@ generation failure > `static` **generate**(`provider`, `image`, `prompt`, `options`, `region?`): `Promise`\<[`VideoGenerationResult`](../type-aliases/VideoGenerationResult.md)\> -Defined in: [utils/videoProcessor.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/utils/videoProcessor.ts#L125) - ##### Parameters ###### provider @@ -178,8 +164,6 @@ options-bag overload. > `static` **generateTransition**(`provider`, `firstFrame`, `lastFrame`, `prompt`, `options?`, `region?`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\> -Defined in: [utils/videoProcessor.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/utils/videoProcessor.ts#L243) - Generate a transition clip via the registered handler (Director Mode). Providers without first-and-last-frame interpolation surface a typed diff --git a/docs/api/classes/VoiceError.md b/docs/api/classes/VoiceError.md index d7f2cf170..ad10f87d8 100644 --- a/docs/api/classes/VoiceError.md +++ b/docs/api/classes/VoiceError.md @@ -6,8 +6,6 @@ # Class: VoiceError -Defined in: [voice/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L24) - Base Voice Error class for all voice-related errors ## Extends @@ -25,8 +23,6 @@ Base Voice Error class for all voice-related errors > **new VoiceError**(`options`): `VoiceError` -Defined in: [voice/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/voice/errors.ts#L25) - #### Parameters ##### options @@ -47,8 +43,6 @@ Defined in: [voice/errors.ts:25](https://github.com/juspay/neurolink/blob/releas > `readonly` **code**: `string` -Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L105) - #### Inherited from `NeuroLinkError.code` @@ -59,8 +53,6 @@ Defined in: [utils/errorHandling.ts:105](https://github.com/juspay/neurolink/blo > `readonly` **category**: `ErrorCategory` -Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L106) - #### Inherited from `NeuroLinkError.category` @@ -71,8 +63,6 @@ Defined in: [utils/errorHandling.ts:106](https://github.com/juspay/neurolink/blo > `readonly` **severity**: `ErrorSeverity` -Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L107) - #### Inherited from `NeuroLinkError.severity` @@ -83,8 +73,6 @@ Defined in: [utils/errorHandling.ts:107](https://github.com/juspay/neurolink/blo > `readonly` **retriable**: `boolean` -Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L108) - #### Inherited from `NeuroLinkError.retriable` @@ -95,8 +83,6 @@ Defined in: [utils/errorHandling.ts:108](https://github.com/juspay/neurolink/blo > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L109) - #### Inherited from `NeuroLinkError.retryAfterMs` @@ -107,8 +93,6 @@ Defined in: [utils/errorHandling.ts:109](https://github.com/juspay/neurolink/blo > `readonly` **context**: `Record`\<`string`, `unknown`\> -Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L110) - #### Inherited from `NeuroLinkError.context` @@ -119,8 +103,6 @@ Defined in: [utils/errorHandling.ts:110](https://github.com/juspay/neurolink/blo > `readonly` **timestamp**: `Date` -Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L111) - #### Inherited from `NeuroLinkError.timestamp` @@ -131,8 +113,6 @@ Defined in: [utils/errorHandling.ts:111](https://github.com/juspay/neurolink/blo > `readonly` `optional` **toolName?**: `string` -Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L112) - #### Inherited from `NeuroLinkError.toolName` @@ -143,8 +123,6 @@ Defined in: [utils/errorHandling.ts:112](https://github.com/juspay/neurolink/blo > `readonly` `optional` **serverId?**: `string` -Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L113) - #### Inherited from `NeuroLinkError.serverId` @@ -155,8 +133,6 @@ Defined in: [utils/errorHandling.ts:113](https://github.com/juspay/neurolink/blo > **toJSON**(): [`StructuredError`](../type-aliases/StructuredError.md) -Defined in: [utils/errorHandling.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L149) - Convert to JSON for logging and serialization #### Returns diff --git a/docs/api/classes/WebLoader.md b/docs/api/classes/WebLoader.md index aec6add50..be241a931 100644 --- a/docs/api/classes/WebLoader.md +++ b/docs/api/classes/WebLoader.md @@ -6,8 +6,6 @@ # Class: WebLoader -Defined in: [rag/document/loaders.ts:452](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L452) - Web page loader Fetches and extracts content from web pages. @@ -33,8 +31,6 @@ Supports basic HTML parsing without external dependencies. > **load**(`source`, `options?`): `Promise`\<[`MDocument`](MDocument.md)\> -Defined in: [rag/document/loaders.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L456) - Load document from source #### Parameters @@ -67,8 +63,6 @@ Promise resolving to MDocument > **canHandle**(`source`): `boolean` -Defined in: [rag/document/loaders.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L505) - Check if loader can handle the source #### Parameters diff --git a/docs/api/classes/WebSocketConnectionError.md b/docs/api/classes/WebSocketConnectionError.md index c38d5f70d..08e1c6159 100644 --- a/docs/api/classes/WebSocketConnectionError.md +++ b/docs/api/classes/WebSocketConnectionError.md @@ -6,8 +6,6 @@ # Class: WebSocketConnectionError -Defined in: [server/errors.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L370) - WebSocket connection failed error ## Extends @@ -20,8 +18,6 @@ WebSocket connection failed error > **new WebSocketConnectionError**(`message?`, `cause?`): `WebSocketConnectionError` -Defined in: [server/errors.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L371) - #### Parameters ##### message? @@ -46,8 +42,6 @@ Defined in: [server/errors.ts:371](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -58,8 +52,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -70,8 +62,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -82,8 +72,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -94,8 +82,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -106,8 +92,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -118,8 +102,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -130,8 +112,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -142,8 +122,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -154,8 +132,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -166,8 +142,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -184,8 +158,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/WebSocketConnectionManager.md b/docs/api/classes/WebSocketConnectionManager.md index 0eec49fae..b9a4ae055 100644 --- a/docs/api/classes/WebSocketConnectionManager.md +++ b/docs/api/classes/WebSocketConnectionManager.md @@ -6,8 +6,6 @@ # Class: WebSocketConnectionManager -Defined in: [server/websocket/WebSocketHandler.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L44) - WebSocket connection manager ## Constructors @@ -16,8 +14,6 @@ WebSocket connection manager > **new WebSocketConnectionManager**(`config?`): `WebSocketConnectionManager` -Defined in: [server/websocket/WebSocketHandler.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L50) - #### Parameters ##### config? @@ -34,8 +30,6 @@ Defined in: [server/websocket/WebSocketHandler.ts:50](https://github.com/juspay/ > **registerHandler**(`path`, `handler`): `void` -Defined in: [server/websocket/WebSocketHandler.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L57) - Register a handler for a path #### Parameters @@ -58,8 +52,6 @@ Register a handler for a path > **getHandler**(`path`): [`WebSocketHandler`](../type-aliases/WebSocketHandler.md) \| `undefined` -Defined in: [server/websocket/WebSocketHandler.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L65) - Get handler for a path #### Parameters @@ -78,8 +70,6 @@ Get handler for a path > **handleConnection**(`socket`, `path`, `user?`): `Promise`\<[`WebSocketConnection`](../type-aliases/WebSocketConnection.md)\> -Defined in: [server/websocket/WebSocketHandler.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L72) - Handle new connection #### Parameters @@ -106,8 +96,6 @@ Handle new connection > **handleMessage**(`connectionId`, `data`, `isBinary`): `Promise`\<`void`\> -Defined in: [server/websocket/WebSocketHandler.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L117) - Handle incoming message #### Parameters @@ -134,8 +122,6 @@ Handle incoming message > **handleClose**(`connectionId`, `code`, `reason`): `Promise`\<`void`\> -Defined in: [server/websocket/WebSocketHandler.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L164) - Handle connection close #### Parameters @@ -162,8 +148,6 @@ Handle connection close > **handleError**(`connectionId`, `error`): `Promise`\<`void`\> -Defined in: [server/websocket/WebSocketHandler.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L201) - Handle connection error #### Parameters @@ -186,8 +170,6 @@ Handle connection error > **getConnection**(`connectionId`): [`WebSocketConnection`](../type-aliases/WebSocketConnection.md) \| `undefined` -Defined in: [server/websocket/WebSocketHandler.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L228) - Get connection by ID #### Parameters @@ -206,8 +188,6 @@ Get connection by ID > **getAllConnections**(): [`WebSocketConnection`](../type-aliases/WebSocketConnection.md)[] -Defined in: [server/websocket/WebSocketHandler.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L235) - Get all connections #### Returns @@ -220,8 +200,6 @@ Get all connections > **getConnectionsByUser**(`userId`): [`WebSocketConnection`](../type-aliases/WebSocketConnection.md)[] -Defined in: [server/websocket/WebSocketHandler.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L242) - Get connections for a user #### Parameters @@ -240,8 +218,6 @@ Get connections for a user > **getConnectionsByPath**(`path`): [`WebSocketConnection`](../type-aliases/WebSocketConnection.md)[] -Defined in: [server/websocket/WebSocketHandler.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L251) - Get connections for a path #### Parameters @@ -260,8 +236,6 @@ Get connections for a path > **send**(`connectionId`, `data`): `void` -Defined in: [server/websocket/WebSocketHandler.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L260) - Send message to a connection #### Parameters @@ -284,8 +258,6 @@ Send message to a connection > **broadcast**(`data`, `filter?`): `void` -Defined in: [server/websocket/WebSocketHandler.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L284) - Broadcast message to all connections #### Parameters @@ -308,8 +280,6 @@ Broadcast message to all connections > **close**(`connectionId`, `code?`, `reason?`): `Promise`\<`void`\> -Defined in: [server/websocket/WebSocketHandler.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L306) - Close a connection #### Parameters @@ -336,8 +306,6 @@ Close a connection > **closeAll**(`code?`, `reason?`): `Promise`\<`void`\> -Defined in: [server/websocket/WebSocketHandler.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L334) - Close all connections #### Parameters @@ -360,8 +328,6 @@ Close all connections > **getConnectionCount**(): `number` -Defined in: [server/websocket/WebSocketHandler.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L344) - Get connection count #### Returns diff --git a/docs/api/classes/WebSocketError.md b/docs/api/classes/WebSocketError.md index 078b13c94..5587a3fff 100644 --- a/docs/api/classes/WebSocketError.md +++ b/docs/api/classes/WebSocketError.md @@ -6,8 +6,6 @@ # Class: WebSocketError -Defined in: [server/errors.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L354) - WebSocket error ## Extends @@ -20,8 +18,6 @@ WebSocket error > **new WebSocketError**(`message`, `cause?`, `connectionId?`): `WebSocketError` -Defined in: [server/errors.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L355) - #### Parameters ##### message @@ -50,8 +46,6 @@ Defined in: [server/errors.ts:355](https://github.com/juspay/neurolink/blob/rele > `readonly` **code**: [`ServerAdapterErrorCodeType`](../type-aliases/ServerAdapterErrorCodeType.md) -Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L21) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`code`](ServerAdapterError.md#code) @@ -62,8 +56,6 @@ Defined in: [server/errors.ts:21](https://github.com/juspay/neurolink/blob/relea > `readonly` **category**: [`ErrorCategoryType`](../type-aliases/ErrorCategoryType.md) -Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L22) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`category`](ServerAdapterError.md#category) @@ -74,8 +66,6 @@ Defined in: [server/errors.ts:22](https://github.com/juspay/neurolink/blob/relea > `readonly` **severity**: [`ErrorSeverityType`](../type-aliases/ErrorSeverityType.md) -Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L23) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`severity`](ServerAdapterError.md#severity) @@ -86,8 +76,6 @@ Defined in: [server/errors.ts:23](https://github.com/juspay/neurolink/blob/relea > `readonly` **retryable**: `boolean` -Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L24) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryable`](ServerAdapterError.md#retryable) @@ -98,8 +86,6 @@ Defined in: [server/errors.ts:24](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **retryAfterMs?**: `number` -Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L25) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`retryAfterMs`](ServerAdapterError.md#retryafterms) @@ -110,8 +96,6 @@ Defined in: [server/errors.ts:25](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **requestId?**: `string` -Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L26) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`requestId`](ServerAdapterError.md#requestid) @@ -122,8 +106,6 @@ Defined in: [server/errors.ts:26](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **path?**: `string` -Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L27) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`path`](ServerAdapterError.md#path) @@ -134,8 +116,6 @@ Defined in: [server/errors.ts:27](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **method?**: `string` -Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L28) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`method`](ServerAdapterError.md#method) @@ -146,8 +126,6 @@ Defined in: [server/errors.ts:28](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L29) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`details`](ServerAdapterError.md#details) @@ -158,8 +136,6 @@ Defined in: [server/errors.ts:29](https://github.com/juspay/neurolink/blob/relea > `readonly` `optional` **cause?**: `Error` -Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L30) - #### Inherited from [`ServerAdapterError`](ServerAdapterError.md).[`cause`](ServerAdapterError.md#cause) @@ -170,8 +146,6 @@ Defined in: [server/errors.ts:30](https://github.com/juspay/neurolink/blob/relea > **toJSON**(): `Record`\<`string`, `unknown`\> -Defined in: [server/errors.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L59) - Convert to JSON for API responses #### Returns @@ -188,8 +162,6 @@ Convert to JSON for API responses > **getHttpStatus**(): `number` -Defined in: [server/errors.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L77) - Get HTTP status code for this error #### Returns diff --git a/docs/api/classes/WebSocketMessageRouter.md b/docs/api/classes/WebSocketMessageRouter.md index 649f0301b..b7b5e42c4 100644 --- a/docs/api/classes/WebSocketMessageRouter.md +++ b/docs/api/classes/WebSocketMessageRouter.md @@ -6,8 +6,6 @@ # Class: WebSocketMessageRouter -Defined in: [server/websocket/WebSocketHandler.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L396) - WebSocket message router for handling different message types ## Constructors @@ -26,8 +24,6 @@ WebSocket message router for handling different message types > **route**(`type`, `handler`): `void` -Defined in: [server/websocket/WebSocketHandler.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L405) - Register a message route #### Parameters @@ -50,8 +46,6 @@ Register a message route > **handle**(`connection`, `message`): `Promise`\<`unknown`\> -Defined in: [server/websocket/WebSocketHandler.ts:418](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L418) - Handle incoming message #### Parameters @@ -74,8 +68,6 @@ Handle incoming message > **getRoutes**(): `string`[] -Defined in: [server/websocket/WebSocketHandler.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L450) - Get registered routes #### Returns diff --git a/docs/api/classes/WebSocketStreamingClient.md b/docs/api/classes/WebSocketStreamingClient.md index a3a04ca34..26c0f24a0 100644 --- a/docs/api/classes/WebSocketStreamingClient.md +++ b/docs/api/classes/WebSocketStreamingClient.md @@ -6,8 +6,6 @@ # Class: WebSocketStreamingClient -Defined in: [client/streamingClient.ts:463](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L463) - WebSocket Streaming Client Provides WebSocket-based streaming with automatic reconnection, @@ -33,8 +31,6 @@ ws.send({ type: "chat", content: "Hello" }); > **new WebSocketStreamingClient**(`options`): `WebSocketStreamingClient` -Defined in: [client/streamingClient.ts:472](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L472) - #### Parameters ##### options @@ -51,8 +47,6 @@ Defined in: [client/streamingClient.ts:472](https://github.com/juspay/neurolink/ > **connect**(): `Promise`\<`void`\> -Defined in: [client/streamingClient.ts:485](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L485) - Connect to WebSocket server #### Returns @@ -65,8 +59,6 @@ Connect to WebSocket server > **disconnect**(): `void` -Defined in: [client/streamingClient.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L567) - Disconnect from WebSocket server #### Returns @@ -79,8 +71,6 @@ Disconnect from WebSocket server > **send**(`data`): `void` -Defined in: [client/streamingClient.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L580) - Send message to server #### Parameters @@ -99,8 +89,6 @@ Send message to server > **request**\<`T`\>(`data`, `timeout?`): `Promise`\<`T`\> -Defined in: [client/streamingClient.ts:591](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L591) - Send message and wait for response #### Type Parameters @@ -129,8 +117,6 @@ Send message and wait for response > **on**(`event`, `callback`): `void` -Defined in: [client/streamingClient.ts:690](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L690) - Register event handler #### Parameters @@ -153,8 +139,6 @@ Register event handler > **off**(`event`, `callback`): `void` -Defined in: [client/streamingClient.ts:702](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L702) - Remove event handler #### Parameters @@ -177,8 +161,6 @@ Remove event handler > **getState**(): [`ClientWebSocketState`](../type-aliases/ClientWebSocketState.md) -Defined in: [client/streamingClient.ts:721](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L721) - Get current connection state #### Returns @@ -191,8 +173,6 @@ Get current connection state > **messages**(): `AsyncGenerator`\<`unknown`, `void`, `unknown`\> -Defined in: [client/streamingClient.ts:728](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L728) - Create async iterator for messages #### Returns diff --git a/docs/api/classes/WorkflowError.md b/docs/api/classes/WorkflowError.md index ae32b5af0..851ed43e4 100644 --- a/docs/api/classes/WorkflowError.md +++ b/docs/api/classes/WorkflowError.md @@ -6,8 +6,6 @@ # Class: WorkflowError -Defined in: [types/workflow.ts:510](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L510) - Workflow execution error class ## Extends @@ -20,8 +18,6 @@ Workflow execution error class > **new WorkflowError**(`message`, `details`): `WorkflowError` -Defined in: [types/workflow.ts:513](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L513) - #### Parameters ##### message @@ -45,5 +41,3 @@ Defined in: [types/workflow.ts:513](https://github.com/juspay/neurolink/blob/rel ### details > `readonly` **details**: [`WorkflowErrorDetails`](../type-aliases/WorkflowErrorDetails.md) - -Defined in: [types/workflow.ts:511](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L511) diff --git a/docs/api/enumerations/AIProviderName.md b/docs/api/enumerations/AIProviderName.md index 0d854ad36..61c3e21be 100644 --- a/docs/api/enumerations/AIProviderName.md +++ b/docs/api/enumerations/AIProviderName.md @@ -6,8 +6,6 @@ # Enumeration: AIProviderName -Defined in: [constants/enums.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L8) - Supported AI Provider Names ## Enumeration Members @@ -16,328 +14,246 @@ Supported AI Provider Names > **BEDROCK**: `"bedrock"` -Defined in: [constants/enums.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L9) - --- ### OPENAI > **OPENAI**: `"openai"` -Defined in: [constants/enums.ts:10](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L10) - --- ### OPENAI_COMPATIBLE > **OPENAI_COMPATIBLE**: `"openai-compatible"` -Defined in: [constants/enums.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L11) - --- ### OPENROUTER > **OPENROUTER**: `"openrouter"` -Defined in: [constants/enums.ts:12](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L12) - --- ### VERTEX > **VERTEX**: `"vertex"` -Defined in: [constants/enums.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L13) - --- ### ANTHROPIC > **ANTHROPIC**: `"anthropic"` -Defined in: [constants/enums.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L14) - --- ### AZURE > **AZURE**: `"azure"` -Defined in: [constants/enums.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L15) - --- ### GOOGLE_AI > **GOOGLE_AI**: `"google-ai"` -Defined in: [constants/enums.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L16) - --- ### OLLAMA > **OLLAMA**: `"ollama"` -Defined in: [constants/enums.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L17) - --- ### LITELLM > **LITELLM**: `"litellm"` -Defined in: [constants/enums.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L18) - --- ### SAGEMAKER > **SAGEMAKER**: `"sagemaker"` -Defined in: [constants/enums.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L19) - --- ### NVIDIA_NIM > **NVIDIA_NIM**: `"nvidia-nim"` -Defined in: [constants/enums.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L20) - --- ### LM_STUDIO > **LM_STUDIO**: `"lm-studio"` -Defined in: [constants/enums.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L21) - --- ### LLAMACPP > **LLAMACPP**: `"llamacpp"` -Defined in: [constants/enums.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L22) - --- ### API_ROUTE > **API_ROUTE**: `"api-route"` -Defined in: [constants/enums.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L24) - --- ### BASETEN > **BASETEN**: `"baseten"` -Defined in: [constants/enums.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L25) - --- ### CEREBRAS > **CEREBRAS**: `"cerebras"` -Defined in: [constants/enums.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L26) - --- ### CLOUDFLARE > **CLOUDFLARE**: `"cloudflare"` -Defined in: [constants/enums.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L27) - --- ### DEEPSEEK > **DEEPSEEK**: `"deepseek"` -Defined in: [constants/enums.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L28) - --- ### FIREWORKS > **FIREWORKS**: `"fireworks"` -Defined in: [constants/enums.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L29) - --- ### FRIENDLI > **FRIENDLI**: `"friendli"` -Defined in: [constants/enums.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L30) - --- ### GMICLOUD > **GMICLOUD**: `"gmicloud"` -Defined in: [constants/enums.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L31) - --- ### GROQ > **GROQ**: `"groq"` -Defined in: [constants/enums.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L32) - --- ### HUGGINGFACE > **HUGGINGFACE**: `"huggingface"` -Defined in: [constants/enums.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L33) - --- ### INCEPTION_LABS > **INCEPTION_LABS**: `"inception-labs"` -Defined in: [constants/enums.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L34) - --- ### IO_INTELLIGENCE > **IO_INTELLIGENCE**: `"io-intelligence"` -Defined in: [constants/enums.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L35) - --- ### MANCER > **MANCER**: `"mancer"` -Defined in: [constants/enums.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L36) - --- ### MISTRAL > **MISTRAL**: `"mistral"` -Defined in: [constants/enums.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L37) - --- ### PERPLEXITY > **PERPLEXITY**: `"perplexity"` -Defined in: [constants/enums.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L38) - --- ### SAMBANOVA > **SAMBANOVA**: `"sambanova"` -Defined in: [constants/enums.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L39) - --- ### TOGETHER_AI > **TOGETHER_AI**: `"together-ai"` -Defined in: [constants/enums.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L40) - --- ### UPSTAGE > **UPSTAGE**: `"upstage"` -Defined in: [constants/enums.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L41) - --- ### XAI > **XAI**: `"xai"` -Defined in: [constants/enums.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L42) - --- ### COHERE > **COHERE**: `"cohere"` -Defined in: [constants/enums.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L44) - --- ### REPLICATE > **REPLICATE**: `"replicate"` -Defined in: [constants/enums.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L45) - --- ### VOYAGE > **VOYAGE**: `"voyage"` -Defined in: [constants/enums.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L46) - --- ### JINA > **JINA**: `"jina"` -Defined in: [constants/enums.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L47) - --- ### STABILITY > **STABILITY**: `"stability"` -Defined in: [constants/enums.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L48) - --- ### IDEOGRAM > **IDEOGRAM**: `"ideogram"` -Defined in: [constants/enums.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L49) - --- ### RECRAFT > **RECRAFT**: `"recraft"` -Defined in: [constants/enums.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L50) - --- ### TYPESAFE > **TYPESAFE**: `"typesafe"` -Defined in: [constants/enums.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L52) - TypeSafe (Jev) — serves the `decide` inference type only. --- @@ -346,8 +262,6 @@ TypeSafe (Jev) — serves the `decide` inference type only. > **LAYA**: `"laya"` -Defined in: [constants/enums.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L54) - Laya (Convai, open weights) — serves the `decide` inference type only. --- @@ -355,5 +269,3 @@ Laya (Convai, open weights) — serves the `decide` inference type only. ### AUTO > **AUTO**: `"auto"` - -Defined in: [constants/enums.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L55) diff --git a/docs/api/enumerations/BedrockModels.md b/docs/api/enumerations/BedrockModels.md index 648deccd4..3ac480256 100644 --- a/docs/api/enumerations/BedrockModels.md +++ b/docs/api/enumerations/BedrockModels.md @@ -6,8 +6,6 @@ # Enumeration: BedrockModels -Defined in: [constants/enums.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L102) - Supported Models for Amazon Bedrock ## Enumeration Members @@ -16,64 +14,48 @@ Supported Models for Amazon Bedrock > **CLAUDE_4_6_OPUS**: `"anthropic.claude-opus-4-6-v1"` -Defined in: [constants/enums.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L108) - --- ### CLAUDE_4_6_SONNET > **CLAUDE_4_6_SONNET**: `"anthropic.claude-sonnet-4-6"` -Defined in: [constants/enums.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L109) - --- ### CLAUDE_4_5_OPUS > **CLAUDE_4_5_OPUS**: `"anthropic.claude-opus-4-5-20251101-v1:0"` -Defined in: [constants/enums.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L112) - --- ### CLAUDE_4_5_SONNET > **CLAUDE_4_5_SONNET**: `"anthropic.claude-sonnet-4-5-20250929-v1:0"` -Defined in: [constants/enums.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L113) - --- ### CLAUDE_4_5_HAIKU > **CLAUDE_4_5_HAIKU**: `"anthropic.claude-haiku-4-5-20251001-v1:0"` -Defined in: [constants/enums.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L114) - --- ### CLAUDE_4_1_OPUS > **CLAUDE_4_1_OPUS**: `"anthropic.claude-opus-4-1-20250805-v1:0"` -Defined in: [constants/enums.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L117) - --- ### CLAUDE_4_SONNET > **CLAUDE_4_SONNET**: `"anthropic.claude-sonnet-4-20250514-v1:0"` -Defined in: [constants/enums.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L118) - --- ### ~~CLAUDE_3_7_SONNET~~ > **CLAUDE_3_7_SONNET**: `"anthropic.claude-3-7-sonnet-20250219-v1:0"` -Defined in: [constants/enums.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L122) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -84,8 +66,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_5_SONNET**: `"anthropic.claude-3-5-sonnet-20241022-v1:0"` -Defined in: [constants/enums.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L126) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -96,8 +76,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_5_HAIKU**: `"anthropic.claude-3-5-haiku-20241022-v1:0"` -Defined in: [constants/enums.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L128) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -108,8 +86,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_SONNET**: `"anthropic.claude-3-sonnet-20240229-v1:0"` -Defined in: [constants/enums.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L132) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -120,8 +96,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_HAIKU**: `"anthropic.claude-3-haiku-20240307-v1:0"` -Defined in: [constants/enums.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L134) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -132,596 +106,446 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **NOVA_PREMIER**: `"amazon.nova-premier-v1:0"` -Defined in: [constants/enums.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L141) - --- ### NOVA_PRO > **NOVA_PRO**: `"amazon.nova-pro-v1:0"` -Defined in: [constants/enums.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L142) - --- ### NOVA_LITE > **NOVA_LITE**: `"amazon.nova-lite-v1:0"` -Defined in: [constants/enums.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L143) - --- ### NOVA_MICRO > **NOVA_MICRO**: `"amazon.nova-micro-v1:0"` -Defined in: [constants/enums.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L144) - --- ### NOVA_2_LITE > **NOVA_2_LITE**: `"amazon.nova-2-lite-v1:0"` -Defined in: [constants/enums.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L147) - --- ### NOVA_2_SONIC > **NOVA_2_SONIC**: `"amazon.nova-2-sonic-v1:0"` -Defined in: [constants/enums.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L148) - --- ### NOVA_SONIC > **NOVA_SONIC**: `"amazon.nova-sonic-v1:0"` -Defined in: [constants/enums.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L151) - --- ### NOVA_CANVAS > **NOVA_CANVAS**: `"amazon.nova-canvas-v1:0"` -Defined in: [constants/enums.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L152) - --- ### NOVA_REEL > **NOVA_REEL**: `"amazon.nova-reel-v1:0"` -Defined in: [constants/enums.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L153) - --- ### NOVA_REEL_V1_1 > **NOVA_REEL_V1_1**: `"amazon.nova-reel-v1:1"` -Defined in: [constants/enums.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L154) - --- ### NOVA_MULTIMODAL_EMBEDDINGS > **NOVA_MULTIMODAL_EMBEDDINGS**: `"amazon.nova-2-multimodal-embeddings-v1:0"` -Defined in: [constants/enums.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L155) - --- ### TITAN_TEXT_LARGE > **TITAN_TEXT_LARGE**: `"amazon.titan-tg1-large"` -Defined in: [constants/enums.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L162) - --- ### TITAN_EMBED_TEXT_V2 > **TITAN_EMBED_TEXT_V2**: `"amazon.titan-embed-text-v2:0"` -Defined in: [constants/enums.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L165) - --- ### TITAN_EMBED_TEXT_V1 > **TITAN_EMBED_TEXT_V1**: `"amazon.titan-embed-text-v1"` -Defined in: [constants/enums.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L166) - --- ### TITAN_EMBED_G1_TEXT_02 > **TITAN_EMBED_G1_TEXT_02**: `"amazon.titan-embed-g1-text-02"` -Defined in: [constants/enums.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L167) - --- ### TITAN_EMBED_IMAGE_V1 > **TITAN_EMBED_IMAGE_V1**: `"amazon.titan-embed-image-v1"` -Defined in: [constants/enums.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L170) - --- ### TITAN_IMAGE_GENERATOR_V2 > **TITAN_IMAGE_GENERATOR_V2**: `"amazon.titan-image-generator-v2:0"` -Defined in: [constants/enums.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L173) - --- ### LLAMA_4_MAVERICK_17B > **LLAMA_4_MAVERICK_17B**: `"meta.llama4-maverick-17b-instruct-v1:0"` -Defined in: [constants/enums.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L180) - --- ### LLAMA_4_SCOUT_17B > **LLAMA_4_SCOUT_17B**: `"meta.llama4-scout-17b-instruct-v1:0"` -Defined in: [constants/enums.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L181) - --- ### LLAMA_3_3_70B > **LLAMA_3_3_70B**: `"meta.llama3-3-70b-instruct-v1:0"` -Defined in: [constants/enums.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L184) - --- ### LLAMA_3_2_90B > **LLAMA_3_2_90B**: `"meta.llama3-2-90b-instruct-v1:0"` -Defined in: [constants/enums.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L187) - --- ### LLAMA_3_2_11B > **LLAMA_3_2_11B**: `"meta.llama3-2-11b-instruct-v1:0"` -Defined in: [constants/enums.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L188) - --- ### LLAMA_3_2_3B > **LLAMA_3_2_3B**: `"meta.llama3-2-3b-instruct-v1:0"` -Defined in: [constants/enums.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L189) - --- ### LLAMA_3_2_1B > **LLAMA_3_2_1B**: `"meta.llama3-2-1b-instruct-v1:0"` -Defined in: [constants/enums.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L190) - --- ### LLAMA_3_1_405B > **LLAMA_3_1_405B**: `"meta.llama3-1-405b-instruct-v1:0"` -Defined in: [constants/enums.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L193) - --- ### LLAMA_3_1_70B > **LLAMA_3_1_70B**: `"meta.llama3-1-70b-instruct-v1:0"` -Defined in: [constants/enums.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L194) - --- ### LLAMA_3_1_8B > **LLAMA_3_1_8B**: `"meta.llama3-1-8b-instruct-v1:0"` -Defined in: [constants/enums.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L195) - --- ### LLAMA_3_70B > **LLAMA_3_70B**: `"meta.llama3-70b-instruct-v1:0"` -Defined in: [constants/enums.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L198) - --- ### LLAMA_3_8B > **LLAMA_3_8B**: `"meta.llama3-8b-instruct-v1:0"` -Defined in: [constants/enums.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L199) - --- ### MISTRAL_LARGE_3 > **MISTRAL_LARGE_3**: `"mistral.mistral-large-3-675b-instruct"` -Defined in: [constants/enums.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L206) - --- ### MISTRAL_LARGE_2407 > **MISTRAL_LARGE_2407**: `"mistral.mistral-large-2407-v1:0"` -Defined in: [constants/enums.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L207) - --- ### MISTRAL_LARGE_2402 > **MISTRAL_LARGE_2402**: `"mistral.mistral-large-2402-v1:0"` -Defined in: [constants/enums.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L208) - --- ### MAGISTRAL_SMALL_2509 > **MAGISTRAL_SMALL_2509**: `"mistral.magistral-small-2509"` -Defined in: [constants/enums.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L211) - --- ### MINISTRAL_3_14B > **MINISTRAL_3_14B**: `"mistral.ministral-3-14b-instruct"` -Defined in: [constants/enums.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L212) - --- ### MINISTRAL_3_8B > **MINISTRAL_3_8B**: `"mistral.ministral-3-8b-instruct"` -Defined in: [constants/enums.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L213) - --- ### MINISTRAL_3_3B > **MINISTRAL_3_3B**: `"mistral.ministral-3-3b-instruct"` -Defined in: [constants/enums.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L214) - --- ### MISTRAL_7B > **MISTRAL_7B**: `"mistral.mistral-7b-instruct-v0:2"` -Defined in: [constants/enums.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L217) - --- ### MIXTRAL_8x7B > **MIXTRAL_8x7B**: `"mistral.mixtral-8x7b-instruct-v0:1"` -Defined in: [constants/enums.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L218) - --- ### PIXTRAL_LARGE_2502 > **PIXTRAL_LARGE_2502**: `"mistral.pixtral-large-2502-v1:0"` -Defined in: [constants/enums.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L221) - --- ### VOXTRAL_SMALL_24B > **VOXTRAL_SMALL_24B**: `"mistral.voxtral-small-24b-2507"` -Defined in: [constants/enums.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L222) - --- ### VOXTRAL_MINI_3B > **VOXTRAL_MINI_3B**: `"mistral.voxtral-mini-3b-2507"` -Defined in: [constants/enums.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L223) - --- ### COHERE_COMMAND_R_PLUS > **COHERE_COMMAND_R_PLUS**: `"cohere.command-r-plus-v1:0"` -Defined in: [constants/enums.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L230) - --- ### COHERE_COMMAND_R > **COHERE_COMMAND_R**: `"cohere.command-r-v1:0"` -Defined in: [constants/enums.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L231) - --- ### DEEPSEEK_R1 > **DEEPSEEK_R1**: `"deepseek.r1-v1:0"` -Defined in: [constants/enums.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L234) - --- ### DEEPSEEK_V3 > **DEEPSEEK_V3**: `"deepseek.v3-v1:0"` -Defined in: [constants/enums.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L235) - --- ### QWEN_3_235B_A22B > **QWEN_3_235B_A22B**: `"qwen.qwen3-235b-a22b-2507-v1:0"` -Defined in: [constants/enums.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L238) - --- ### QWEN_3_CODER_480B_A35B > **QWEN_3_CODER_480B_A35B**: `"qwen.qwen3-coder-480b-a35b-v1:0"` -Defined in: [constants/enums.ts:239](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L239) - --- ### QWEN_3_CODER_30B_A3B > **QWEN_3_CODER_30B_A3B**: `"qwen.qwen3-coder-30b-a3b-v1:0"` -Defined in: [constants/enums.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L240) - --- ### QWEN_3_32B > **QWEN_3_32B**: `"qwen.qwen3-32b-v1:0"` -Defined in: [constants/enums.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L241) - --- ### QWEN_3_NEXT_80B_A3B > **QWEN_3_NEXT_80B_A3B**: `"qwen.qwen3-next-80b-a3b"` -Defined in: [constants/enums.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L242) - --- ### QWEN_3_VL_235B_A22B > **QWEN_3_VL_235B_A22B**: `"qwen.qwen3-vl-235b-a22b"` -Defined in: [constants/enums.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L243) - --- ### GEMMA_3_27B_IT > **GEMMA_3_27B_IT**: `"google.gemma-3-27b-it"` -Defined in: [constants/enums.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L246) - --- ### GEMMA_3_12B_IT > **GEMMA_3_12B_IT**: `"google.gemma-3-12b-it"` -Defined in: [constants/enums.ts:247](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L247) - --- ### GEMMA_3_4B_IT > **GEMMA_3_4B_IT**: `"google.gemma-3-4b-it"` -Defined in: [constants/enums.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L248) - --- ### JAMBA_1_5_LARGE > **JAMBA_1_5_LARGE**: `"ai21.jamba-1-5-large-v1:0"` -Defined in: [constants/enums.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L251) - --- ### JAMBA_1_5_MINI > **JAMBA_1_5_MINI**: `"ai21.jamba-1-5-mini-v1:0"` -Defined in: [constants/enums.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L252) - --- ### WRITER_PALMYRA_X5 > **WRITER_PALMYRA_X5**: `"writer.palmyra-x5-v1:0"` -Defined in: [constants/enums.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L259) - --- ### WRITER_PALMYRA_X4 > **WRITER_PALMYRA_X4**: `"writer.palmyra-x4-v1:0"` -Defined in: [constants/enums.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L260) - --- ### MINIMAX_M2_1 > **MINIMAX_M2_1**: `"minimax.minimax-m2.1"` -Defined in: [constants/enums.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L263) - --- ### MINIMAX_M2 > **MINIMAX_M2**: `"minimax.minimax-m2"` -Defined in: [constants/enums.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L264) - --- ### KIMI_K2_THINKING > **KIMI_K2_THINKING**: `"moonshot.kimi-k2-thinking"` -Defined in: [constants/enums.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L267) - --- ### KIMI_K2_5 > **KIMI_K2_5**: `"moonshotai.kimi-k2.5"` -Defined in: [constants/enums.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L268) - --- ### NVIDIA_NEMOTRON_NANO_3_30B > **NVIDIA_NEMOTRON_NANO_3_30B**: `"nvidia.nemotron-nano-3-30b"` -Defined in: [constants/enums.ts:271](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L271) - --- ### NVIDIA_NEMOTRON_NANO_12B_V2 > **NVIDIA_NEMOTRON_NANO_12B_V2**: `"nvidia.nemotron-nano-12b-v2"` -Defined in: [constants/enums.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L272) - --- ### NVIDIA_NEMOTRON_NANO_9B_V2 > **NVIDIA_NEMOTRON_NANO_9B_V2**: `"nvidia.nemotron-nano-9b-v2"` -Defined in: [constants/enums.ts:273](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L273) - --- ### OPENAI_GPT_OSS_120B > **OPENAI_GPT_OSS_120B**: `"openai.gpt-oss-120b-1:0"` -Defined in: [constants/enums.ts:276](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L276) - --- ### OPENAI_GPT_OSS_20B > **OPENAI_GPT_OSS_20B**: `"openai.gpt-oss-20b-1:0"` -Defined in: [constants/enums.ts:277](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L277) - --- ### GLM_4_7 > **GLM_4_7**: `"zai.glm-4.7"` -Defined in: [constants/enums.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L280) - --- ### GLM_4_7_FLASH > **GLM_4_7_FLASH**: `"zai.glm-4.7-flash"` -Defined in: [constants/enums.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L281) - --- ### COHERE_EMBED_ENGLISH_V3 > **COHERE_EMBED_ENGLISH_V3**: `"cohere.embed-english-v3"` -Defined in: [constants/enums.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L284) - --- ### COHERE_EMBED_MULTILINGUAL_V3 > **COHERE_EMBED_MULTILINGUAL_V3**: `"cohere.embed-multilingual-v3"` -Defined in: [constants/enums.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L285) - --- ### COHERE_EMBED_V4 > **COHERE_EMBED_V4**: `"cohere.embed-v4:0"` -Defined in: [constants/enums.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L286) - --- ### COHERE_RERANK_V3_5 > **COHERE_RERANK_V3_5**: `"cohere.rerank-v3-5:0"` -Defined in: [constants/enums.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L287) - --- ### AMAZON_RERANK_V1 > **AMAZON_RERANK_V1**: `"amazon.rerank-v1:0"` -Defined in: [constants/enums.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L290) - --- ### DEVSTRAL_2_123B > **DEVSTRAL_2_123B**: `"mistral.devstral-2-123b"` - -Defined in: [constants/enums.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L293) diff --git a/docs/api/enumerations/FileErrorCode.md b/docs/api/enumerations/FileErrorCode.md index 50d211528..207686ee1 100644 --- a/docs/api/enumerations/FileErrorCode.md +++ b/docs/api/enumerations/FileErrorCode.md @@ -6,8 +6,6 @@ # Enumeration: FileErrorCode -Defined in: [processors/errors/FileErrorCode.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L20) - Enumeration of all file processing error codes. Each code represents a specific failure scenario with associated messaging. @@ -17,8 +15,6 @@ Each code represents a specific failure scenario with associated messaging. > **DOWNLOAD_FAILED**: `"DOWNLOAD_FAILED"` -Defined in: [processors/errors/FileErrorCode.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L26) - File download failed due to network or server error --- @@ -27,8 +23,6 @@ File download failed due to network or server error > **DOWNLOAD_TIMEOUT**: `"DOWNLOAD_TIMEOUT"` -Defined in: [processors/errors/FileErrorCode.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L29) - Download operation exceeded timeout threshold --- @@ -37,8 +31,6 @@ Download operation exceeded timeout threshold > **DOWNLOAD_AUTH_FAILED**: `"DOWNLOAD_AUTH_FAILED"` -Defined in: [processors/errors/FileErrorCode.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L32) - Authentication failed when accessing the file --- @@ -47,8 +39,6 @@ Authentication failed when accessing the file > **NETWORK_ERROR**: `"NETWORK_ERROR"` -Defined in: [processors/errors/FileErrorCode.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L35) - Network error during download (connection reset, DNS failure, etc.) --- @@ -57,8 +47,6 @@ Network error during download (connection reset, DNS failure, etc.) > **FILE_NOT_FOUND**: `"FILE_NOT_FOUND"` -Defined in: [processors/errors/FileErrorCode.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L38) - File was not found at the specified location --- @@ -67,8 +55,6 @@ File was not found at the specified location > **RATE_LIMITED**: `"RATE_LIMITED"` -Defined in: [processors/errors/FileErrorCode.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L41) - Request was rate limited by the server --- @@ -77,8 +63,6 @@ Request was rate limited by the server > **FILE_TOO_LARGE**: `"FILE_TOO_LARGE"` -Defined in: [processors/errors/FileErrorCode.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L48) - File exceeds maximum allowed size --- @@ -87,8 +71,6 @@ File exceeds maximum allowed size > **UNSUPPORTED_TYPE**: `"UNSUPPORTED_TYPE"` -Defined in: [processors/errors/FileErrorCode.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L51) - File type is not supported for processing --- @@ -97,8 +79,6 @@ File type is not supported for processing > **INVALID_FORMAT**: `"INVALID_FORMAT"` -Defined in: [processors/errors/FileErrorCode.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L54) - File format is invalid or malformed --- @@ -107,8 +87,6 @@ File format is invalid or malformed > **INVALID_MIME_TYPE**: `"INVALID_MIME_TYPE"` -Defined in: [processors/errors/FileErrorCode.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L57) - File MIME type doesn't match expected format --- @@ -117,8 +95,6 @@ File MIME type doesn't match expected format > **INVALID_MAGIC_BYTES**: `"INVALID_MAGIC_BYTES"` -Defined in: [processors/errors/FileErrorCode.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L60) - File magic bytes don't match expected file type --- @@ -127,8 +103,6 @@ File magic bytes don't match expected file type > **CORRUPTED_FILE**: `"CORRUPTED_FILE"` -Defined in: [processors/errors/FileErrorCode.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L63) - File appears to be corrupted or damaged --- @@ -137,8 +111,6 @@ File appears to be corrupted or damaged > **INVALID_STRUCTURE**: `"INVALID_STRUCTURE"` -Defined in: [processors/errors/FileErrorCode.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L66) - File internal structure is invalid --- @@ -147,8 +119,6 @@ File internal structure is invalid > **PROCESSING_FAILED**: `"PROCESSING_FAILED"` -Defined in: [processors/errors/FileErrorCode.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L73) - Generic processing failure --- @@ -157,8 +127,6 @@ Generic processing failure > **PARSING_FAILED**: `"PARSING_FAILED"` -Defined in: [processors/errors/FileErrorCode.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L76) - Failed to parse file content --- @@ -167,8 +135,6 @@ Failed to parse file content > **ENCODING_ERROR**: `"ENCODING_ERROR"` -Defined in: [processors/errors/FileErrorCode.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L79) - Text encoding error (not UTF-8, BOM issues, etc.) --- @@ -177,8 +143,6 @@ Text encoding error (not UTF-8, BOM issues, etc.) > **EXTRACTION_FAILED**: `"EXTRACTION_FAILED"` -Defined in: [processors/errors/FileErrorCode.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L82) - Failed to extract content from file --- @@ -187,8 +151,6 @@ Failed to extract content from file > **DECOMPRESSION_FAILED**: `"DECOMPRESSION_FAILED"` -Defined in: [processors/errors/FileErrorCode.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L85) - Failed to decompress file content --- @@ -197,8 +159,6 @@ Failed to decompress file content > **SECURITY_VALIDATION_FAILED**: `"SECURITY_VALIDATION_FAILED"` -Defined in: [processors/errors/FileErrorCode.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L92) - Security validation failed --- @@ -207,8 +167,6 @@ Security validation failed > **XXE_DETECTED**: `"XXE_DETECTED"` -Defined in: [processors/errors/FileErrorCode.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L95) - XML External Entity (XXE) attack detected --- @@ -217,8 +175,6 @@ XML External Entity (XXE) attack detected > **XSS_DETECTED**: `"XSS_DETECTED"` -Defined in: [processors/errors/FileErrorCode.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L98) - Cross-site scripting (XSS) attack detected --- @@ -227,8 +183,6 @@ Cross-site scripting (XSS) attack detected > **CODE_EXECUTION_DETECTED**: `"CODE_EXECUTION_DETECTED"` -Defined in: [processors/errors/FileErrorCode.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L101) - Potentially malicious code execution detected --- @@ -237,8 +191,6 @@ Potentially malicious code execution detected > **ZIP_BOMB_DETECTED**: `"ZIP_BOMB_DETECTED"` -Defined in: [processors/errors/FileErrorCode.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L104) - Zip bomb or decompression bomb detected --- @@ -247,6 +199,4 @@ Zip bomb or decompression bomb detected > **UNKNOWN_ERROR**: `"UNKNOWN_ERROR"` -Defined in: [processors/errors/FileErrorCode.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/processors/errors/FileErrorCode.ts#L111) - Unknown or unexpected error diff --git a/docs/api/enumerations/OpenAIModels.md b/docs/api/enumerations/OpenAIModels.md index a83e85297..82bbbeae5 100644 --- a/docs/api/enumerations/OpenAIModels.md +++ b/docs/api/enumerations/OpenAIModels.md @@ -6,8 +6,6 @@ # Enumeration: OpenAIModels -Defined in: [constants/enums.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L299) - Supported Models for OpenAI ## Enumeration Members @@ -16,264 +14,198 @@ Supported Models for OpenAI > **GPT_5_3_CODEX**: `"gpt-5.3-codex"` -Defined in: [constants/enums.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L301) - --- ### GPT_5_4 > **GPT_5_4**: `"gpt-5.4"` -Defined in: [constants/enums.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L304) - --- ### GPT_5_4_MINI > **GPT_5_4_MINI**: `"gpt-5.4-mini"` -Defined in: [constants/enums.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L305) - --- ### GPT_5_4_NANO > **GPT_5_4_NANO**: `"gpt-5.4-nano"` -Defined in: [constants/enums.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L306) - --- ### GPT_5_4_PRO > **GPT_5_4_PRO**: `"gpt-5.4-pro"` -Defined in: [constants/enums.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L307) - --- ### GPT_5_2 > **GPT_5_2**: `"gpt-5.2"` -Defined in: [constants/enums.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L310) - --- ### GPT_5_2_CHAT_LATEST > **GPT_5_2_CHAT_LATEST**: `"gpt-5.2-chat-latest"` -Defined in: [constants/enums.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L311) - --- ### GPT_5_2_PRO > **GPT_5_2_PRO**: `"gpt-5.2-pro"` -Defined in: [constants/enums.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L312) - --- ### GPT_5_2_CODEX > **GPT_5_2_CODEX**: `"gpt-5.2-codex"` -Defined in: [constants/enums.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L313) - --- ### GPT_5_1 > **GPT_5_1**: `"gpt-5.1"` -Defined in: [constants/enums.ts:316](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L316) - --- ### GPT_5_1_CHAT_LATEST > **GPT_5_1_CHAT_LATEST**: `"gpt-5.1-chat-latest"` -Defined in: [constants/enums.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L317) - --- ### GPT_5_1_CODEX > **GPT_5_1_CODEX**: `"gpt-5.1-codex"` -Defined in: [constants/enums.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L318) - --- ### GPT_5_1_CODEX_MAX > **GPT_5_1_CODEX_MAX**: `"gpt-5.1-codex-max"` -Defined in: [constants/enums.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L319) - --- ### GPT_5_1_CODEX_MINI > **GPT_5_1_CODEX_MINI**: `"gpt-5.1-codex-mini"` -Defined in: [constants/enums.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L320) - --- ### GPT_5 > **GPT_5**: `"gpt-5"` -Defined in: [constants/enums.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L323) - --- ### GPT_5_MINI > **GPT_5_MINI**: `"gpt-5-mini"` -Defined in: [constants/enums.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L324) - --- ### GPT_5_NANO > **GPT_5_NANO**: `"gpt-5-nano"` -Defined in: [constants/enums.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L325) - --- ### GPT_5_PRO > **GPT_5_PRO**: `"gpt-5-pro"` -Defined in: [constants/enums.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L326) - --- ### GPT_5_CHAT_LATEST > **GPT_5_CHAT_LATEST**: `"gpt-5-chat-latest"` -Defined in: [constants/enums.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L327) - --- ### GPT_5_CODEX > **GPT_5_CODEX**: `"gpt-5-codex"` -Defined in: [constants/enums.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L328) - --- ### GPT_OSS_120B > **GPT_OSS_120B**: `"gpt-oss-120b"` -Defined in: [constants/enums.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L331) - --- ### GPT_OSS_20B > **GPT_OSS_20B**: `"gpt-oss-20b"` -Defined in: [constants/enums.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L332) - --- ### GPT_4_1 > **GPT_4_1**: `"gpt-4.1"` -Defined in: [constants/enums.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L335) - --- ### GPT_4_1_MINI > **GPT_4_1_MINI**: `"gpt-4.1-mini"` -Defined in: [constants/enums.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L336) - --- ### GPT_4_1_NANO > **GPT_4_1_NANO**: `"gpt-4.1-nano"` -Defined in: [constants/enums.ts:337](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L337) - --- ### GPT_4O > **GPT_4O**: `"gpt-4o"` -Defined in: [constants/enums.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L340) - --- ### GPT_4O_MINI > **GPT_4O_MINI**: `"gpt-4o-mini"` -Defined in: [constants/enums.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L341) - --- ### O3 > **O3**: `"o3"` -Defined in: [constants/enums.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L344) - --- ### O3_MINI > **O3_MINI**: `"o3-mini"` -Defined in: [constants/enums.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L345) - --- ### O3_PRO > **O3_PRO**: `"o3-pro"` -Defined in: [constants/enums.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L346) - --- ### O4_MINI > **O4_MINI**: `"o4-mini"` -Defined in: [constants/enums.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L347) - --- ### O1 > **O1**: `"o1"` -Defined in: [constants/enums.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L348) - --- ### ~~O1_PREVIEW~~ > **O1_PREVIEW**: `"o1-preview"` -Defined in: [constants/enums.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L350) - #### Deprecated Turned off Jul 14, 2025. Use GPT_4_1 or O3. @@ -284,8 +216,6 @@ Turned off Jul 14, 2025. Use GPT_4_1 or O3. > **O1_MINI**: `"o1-mini"` -Defined in: [constants/enums.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L352) - #### Deprecated Replaced by o3-mini. @@ -296,44 +226,32 @@ Replaced by o3-mini. > **GPT_4**: `"gpt-4"` -Defined in: [constants/enums.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L355) - --- ### GPT_4_TURBO > **GPT_4_TURBO**: `"gpt-4-turbo"` -Defined in: [constants/enums.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L356) - --- ### GPT_3_5_TURBO > **GPT_3_5_TURBO**: `"gpt-3.5-turbo"` -Defined in: [constants/enums.ts:359](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L359) - --- ### GPT_IMAGE_1 > **GPT_IMAGE_1**: `"gpt-image-1"` -Defined in: [constants/enums.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L362) - --- ### DALL_E_3 > **DALL_E_3**: `"dall-e-3"` -Defined in: [constants/enums.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L363) - --- ### DALL_E_2 > **DALL_E_2**: `"dall-e-2"` - -Defined in: [constants/enums.ts:364](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L364) diff --git a/docs/api/enumerations/SpanStatus.md b/docs/api/enumerations/SpanStatus.md index b66a02aaf..3e021d2f4 100644 --- a/docs/api/enumerations/SpanStatus.md +++ b/docs/api/enumerations/SpanStatus.md @@ -6,8 +6,6 @@ # Enumeration: SpanStatus -Defined in: [types/span.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L63) - Span status codes (following OTel conventions) ## Enumeration Members @@ -16,28 +14,20 @@ Span status codes (following OTel conventions) > **UNSET**: `0` -Defined in: [types/span.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L64) - --- ### OK > **OK**: `1` -Defined in: [types/span.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L65) - --- ### ERROR > **ERROR**: `2` -Defined in: [types/span.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L66) - --- ### WARNING > **WARNING**: `3` - -Defined in: [types/span.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L67) diff --git a/docs/api/enumerations/SpanType.md b/docs/api/enumerations/SpanType.md index ed550fc33..47d0d6144 100644 --- a/docs/api/enumerations/SpanType.md +++ b/docs/api/enumerations/SpanType.md @@ -6,8 +6,6 @@ # Enumeration: SpanType -Defined in: [types/span.ts:10](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L10) - Span types for AI operations Following OTel GenAI conventions for span categorization @@ -17,8 +15,6 @@ Following OTel GenAI conventions for span categorization > **AGENT_RUN**: `"agent.run"` -Defined in: [types/span.ts:12](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L12) - Agent execution run (reserved for future multi-agent support) --- @@ -27,8 +23,6 @@ Agent execution run (reserved for future multi-agent support) > **WORKFLOW_STEP**: `"workflow.step"` -Defined in: [types/span.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L14) - Workflow step execution (reserved for future workflow engine) --- @@ -37,8 +31,6 @@ Workflow step execution (reserved for future workflow engine) > **TOOL_CALL**: `"tool.call"` -Defined in: [types/span.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L16) - Tool/function call --- @@ -47,8 +39,6 @@ Tool/function call > **MODEL_GENERATION**: `"model.generation"` -Defined in: [types/span.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L18) - LLM generation request --- @@ -57,8 +47,6 @@ LLM generation request > **MODEL_DECISION**: `"model.decision"` -Defined in: [types/span.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L29) - Decision-model request (the `decide` inference type). Deliberately NOT folded into MODEL_GENERATION. A decision emits no text, @@ -74,8 +62,6 @@ fractions of a cent to the same bucket as a frontier model. > **EMBEDDING**: `"embedding"` -Defined in: [types/span.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L31) - Embedding generation (reserved for future embedding API) --- @@ -84,8 +70,6 @@ Embedding generation (reserved for future embedding API) > **RETRIEVAL**: `"retrieval"` -Defined in: [types/span.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L33) - Retrieval operation (reserved for future RAG support) --- @@ -94,8 +78,6 @@ Retrieval operation (reserved for future RAG support) > **MEMORY**: `"memory"` -Defined in: [types/span.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L35) - Memory operation --- @@ -104,8 +86,6 @@ Memory operation > **CONTEXT_COMPACTION**: `"context.compaction"` -Defined in: [types/span.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L37) - Context compaction operation --- @@ -114,8 +94,6 @@ Context compaction operation > **RAG**: `"rag"` -Defined in: [types/span.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L39) - RAG pipeline operation --- @@ -124,8 +102,6 @@ RAG pipeline operation > **EVALUATION**: `"evaluation"` -Defined in: [types/span.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L41) - Evaluation/scoring operation --- @@ -134,8 +110,6 @@ Evaluation/scoring operation > **MCP_TRANSPORT**: `"mcp.transport"` -Defined in: [types/span.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L43) - MCP transport operation --- @@ -144,8 +118,6 @@ MCP transport operation > **MEDIA_GENERATION**: `"media.generation"` -Defined in: [types/span.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L45) - Media generation (image/video) --- @@ -154,8 +126,6 @@ Media generation (image/video) > **PPT_GENERATION**: `"ppt.generation"` -Defined in: [types/span.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L47) - PPT/presentation generation --- @@ -164,8 +134,6 @@ PPT/presentation generation > **WORKFLOW**: `"workflow"` -Defined in: [types/span.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L49) - Workflow execution --- @@ -174,8 +142,6 @@ Workflow execution > **TTS**: `"tts"` -Defined in: [types/span.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L51) - TTS synthesis --- @@ -184,8 +150,6 @@ TTS synthesis > **STT**: `"stt"` -Defined in: [types/span.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L53) - STT transcription --- @@ -194,8 +158,6 @@ STT transcription > **SERVER_REQUEST**: `"server.request"` -Defined in: [types/span.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L55) - Server adapter request --- @@ -204,6 +166,4 @@ Server adapter request > **CUSTOM**: `"custom"` -Defined in: [types/span.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L57) - Custom span diff --git a/docs/api/enumerations/VertexModels.md b/docs/api/enumerations/VertexModels.md index 64783a5e1..bd95c17c3 100644 --- a/docs/api/enumerations/VertexModels.md +++ b/docs/api/enumerations/VertexModels.md @@ -6,8 +6,6 @@ # Enumeration: VertexModels -Defined in: [constants/enums.ts:438](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L438) - Supported Models for Google Vertex AI ## Enumeration Members @@ -16,64 +14,48 @@ Supported Models for Google Vertex AI > **CLAUDE_4_6_OPUS**: `"claude-opus-4-6"` -Defined in: [constants/enums.ts:440](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L440) - --- ### CLAUDE_4_6_SONNET > **CLAUDE_4_6_SONNET**: `"claude-sonnet-4-6"` -Defined in: [constants/enums.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L441) - --- ### CLAUDE_4_5_OPUS > **CLAUDE_4_5_OPUS**: `"claude-opus-4-5@20251101"` -Defined in: [constants/enums.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L444) - --- ### CLAUDE_4_5_SONNET > **CLAUDE_4_5_SONNET**: `"claude-sonnet-4-5@20250929"` -Defined in: [constants/enums.ts:445](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L445) - --- ### CLAUDE_4_5_HAIKU > **CLAUDE_4_5_HAIKU**: `"claude-haiku-4-5@20251001"` -Defined in: [constants/enums.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L446) - --- ### CLAUDE_4_0_SONNET > **CLAUDE_4_0_SONNET**: `"claude-sonnet-4@20250514"` -Defined in: [constants/enums.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L449) - --- ### CLAUDE_4_0_OPUS > **CLAUDE_4_0_OPUS**: `"claude-opus-4@20250514"` -Defined in: [constants/enums.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L450) - --- ### ~~CLAUDE_3_7_SONNET~~ > **CLAUDE_3_7_SONNET**: `"claude-3-7-sonnet@20250219"` -Defined in: [constants/enums.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L454) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -84,8 +66,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_5_SONNET**: `"claude-3-5-sonnet-20241022"` -Defined in: [constants/enums.ts:458](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L458) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -96,8 +76,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_5_HAIKU**: `"claude-3-5-haiku-20241022"` -Defined in: [constants/enums.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L460) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -108,8 +86,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_SONNET**: `"claude-3-sonnet-20240229"` -Defined in: [constants/enums.ts:464](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L464) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -120,8 +96,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_OPUS**: `"claude-3-opus-20240229"` -Defined in: [constants/enums.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L466) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -132,8 +106,6 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **CLAUDE_3_HAIKU**: `"claude-3-haiku-20240307"` -Defined in: [constants/enums.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L468) - #### Deprecated Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. @@ -144,56 +116,42 @@ Retired from Anthropic API. Use CLAUDE_4_6_SONNET instead. > **GEMINI_3_1_PRO_PREVIEW**: `"gemini-3.1-pro-preview"` -Defined in: [constants/enums.ts:471](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L471) - --- ### GEMINI_3_1_FLASH_LITE_PREVIEW > **GEMINI_3_1_FLASH_LITE_PREVIEW**: `"gemini-3.1-flash-lite-preview"` -Defined in: [constants/enums.ts:472](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L472) - --- ### GEMINI_3_1_FLASH_IMAGE_PREVIEW > **GEMINI_3_1_FLASH_IMAGE_PREVIEW**: `"gemini-3.1-flash-image-preview"` -Defined in: [constants/enums.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L473) - --- ### GEMINI_3_1_PRO_PREVIEW_CUSTOMTOOLS > **GEMINI_3_1_PRO_PREVIEW_CUSTOMTOOLS**: `"gemini-3.1-pro-preview-customtools"` -Defined in: [constants/enums.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L474) - --- ### GEMINI_3_FLASH_PREVIEW > **GEMINI_3_FLASH_PREVIEW**: `"gemini-3-flash-preview"` -Defined in: [constants/enums.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L477) - --- ### GEMINI_3_PRO_IMAGE_PREVIEW > **GEMINI_3_PRO_IMAGE_PREVIEW**: `"gemini-3-pro-image-preview"` -Defined in: [constants/enums.ts:478](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L478) - --- ### ~~GEMINI_3_PRO_PREVIEW~~ > **GEMINI_3_PRO_PREVIEW**: `"gemini-3-pro-preview"` -Defined in: [constants/enums.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L480) - #### Deprecated SHUT DOWN March 9, 2026. Migrate to GEMINI_3_1_PRO_PREVIEW. @@ -204,64 +162,48 @@ SHUT DOWN March 9, 2026. Migrate to GEMINI_3_1_PRO_PREVIEW. > **GEMINI_2_5_PRO**: `"gemini-2.5-pro"` -Defined in: [constants/enums.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L483) - --- ### GEMINI_2_5_FLASH > **GEMINI_2_5_FLASH**: `"gemini-2.5-flash"` -Defined in: [constants/enums.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L484) - --- ### GEMINI_2_5_FLASH_LITE > **GEMINI_2_5_FLASH_LITE**: `"gemini-2.5-flash-lite"` -Defined in: [constants/enums.ts:485](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L485) - --- ### GEMINI_2_5_FLASH_IMAGE > **GEMINI_2_5_FLASH_IMAGE**: `"gemini-2.5-flash-image"` -Defined in: [constants/enums.ts:486](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L486) - --- ### GEMINI_2_0_FLASH > **GEMINI_2_0_FLASH**: `"gemini-2.0-flash"` -Defined in: [constants/enums.ts:489](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L489) - --- ### GEMINI_2_0_FLASH_001 > **GEMINI_2_0_FLASH_001**: `"gemini-2.0-flash-001"` -Defined in: [constants/enums.ts:490](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L490) - --- ### GEMINI_2_0_FLASH_LITE > **GEMINI_2_0_FLASH_LITE**: `"gemini-2.0-flash-lite"` -Defined in: [constants/enums.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L491) - --- ### ~~GEMINI_1_5_PRO~~ > **GEMINI_1_5_PRO**: `"gemini-1.5-pro-002"` -Defined in: [constants/enums.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L495) - #### Deprecated SHUT DOWN. Returns 404. Use GEMINI_2_5_FLASH or newer. @@ -272,8 +214,6 @@ SHUT DOWN. Returns 404. Use GEMINI_2_5_FLASH or newer. > **GEMINI_1_5_FLASH**: `"gemini-1.5-flash-002"` -Defined in: [constants/enums.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/constants/enums.ts#L497) - #### Deprecated SHUT DOWN. Returns 404. Use GEMINI_2_5_FLASH or newer. diff --git a/docs/api/functions/assembleContext.md b/docs/api/functions/assembleContext.md index 3be259cec..b34365579 100644 --- a/docs/api/functions/assembleContext.md +++ b/docs/api/functions/assembleContext.md @@ -8,8 +8,6 @@ > **assembleContext**(`results`, `options?`): `string` -Defined in: [rag/pipeline/contextAssembly.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/contextAssembly.ts#L44) - Assemble context from retrieved results Combines multiple chunks into a coherent context string diff --git a/docs/api/functions/assembleKnowledgeContext.md b/docs/api/functions/assembleKnowledgeContext.md index 78bb7b645..96a053815 100644 --- a/docs/api/functions/assembleKnowledgeContext.md +++ b/docs/api/functions/assembleKnowledgeContext.md @@ -8,8 +8,6 @@ > **assembleKnowledgeContext**(`selection`, `config`): [`KnowledgeAssembledContext`](../type-aliases/KnowledgeAssembledContext.md) -Defined in: [knowledge/context.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/context.ts#L77) - Assemble the selected entries into a bounded grounding block. Primary entries come first, then relationship-expanded ones. Returns the string, the citations for included entries, an estimated token count, and whether any diff --git a/docs/api/functions/batchConvertToMCP.md b/docs/api/functions/batchConvertToMCP.md index 6041e2785..c532b7ace 100644 --- a/docs/api/functions/batchConvertToMCP.md +++ b/docs/api/functions/batchConvertToMCP.md @@ -8,8 +8,6 @@ > **batchConvertToMCP**(`tools`, `options?`): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/toolConverter.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L233) - Batch convert NeuroLink tools to MCP format ## Parameters diff --git a/docs/api/functions/batchConvertToNeuroLink.md b/docs/api/functions/batchConvertToNeuroLink.md index 41ccd7723..3dd8cd63e 100644 --- a/docs/api/functions/batchConvertToNeuroLink.md +++ b/docs/api/functions/batchConvertToNeuroLink.md @@ -8,8 +8,6 @@ > **batchConvertToNeuroLink**(`tools`, `options?`): [`NeuroLinkTool`](../type-aliases/NeuroLinkTool.md)[] -Defined in: [mcp/toolConverter.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L243) - Batch convert MCP tools to NeuroLink format ## Parameters diff --git a/docs/api/functions/batchRerank.md b/docs/api/functions/batchRerank.md index cc553ca70..7bfbbcf1e 100644 --- a/docs/api/functions/batchRerank.md +++ b/docs/api/functions/batchRerank.md @@ -8,8 +8,6 @@ > **batchRerank**(`results`, `query`, `model`, `options?`): `Promise`\<[`RerankResult`](../type-aliases/RerankResult.md)[]\> -Defined in: [rag/reranker/reranker.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L202) - Batch rerank with optimized LLM calls Scores multiple documents in a single prompt for efficiency diff --git a/docs/api/functions/buildDocument.md b/docs/api/functions/buildDocument.md index a188f46e6..2a0ee29f6 100644 --- a/docs/api/functions/buildDocument.md +++ b/docs/api/functions/buildDocument.md @@ -8,8 +8,6 @@ > **buildDocument**(`entry`): [`IndexedKnowledgeDocument`](../type-aliases/IndexedKnowledgeDocument.md) -Defined in: [knowledge/knowledgeIndex.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/knowledgeIndex.ts#L199) - Build the internal search document from a normalized entry. `exactKeys` carry whole-phrase identifiers (entry id and title); each text field is tokenized for the field-aware scorer. diff --git a/docs/api/functions/buildIndexSnapshot.md b/docs/api/functions/buildIndexSnapshot.md index 5d3cc285b..2ccb48209 100644 --- a/docs/api/functions/buildIndexSnapshot.md +++ b/docs/api/functions/buildIndexSnapshot.md @@ -8,8 +8,6 @@ > **buildIndexSnapshot**(`entries`, `weights`): [`KnowledgeIndexSnapshot`](../type-aliases/KnowledgeIndexSnapshot.md) -Defined in: [knowledge/knowledgeIndex.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/knowledgeIndex.ts#L220) - Build the complete immutable snapshot: entry map, exact/alias/relation indexes, and the field-aware lexical index. diff --git a/docs/api/functions/buildModelCatalog.md b/docs/api/functions/buildModelCatalog.md index ba50e8a31..43953f274 100644 --- a/docs/api/functions/buildModelCatalog.md +++ b/docs/api/functions/buildModelCatalog.md @@ -8,8 +8,6 @@ > **buildModelCatalog**(`config?`): [`ClassifierRouterPoolMember`](../type-aliases/ClassifierRouterPoolMember.md)[] -Defined in: [routing/modelCatalog.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelCatalog.ts#L249) - Build catalogue pool members from the registry. Returns `[]` when the catalogue is disabled or nothing is reachable, which diff --git a/docs/api/functions/buildObservabilityConfigFromEnv.md b/docs/api/functions/buildObservabilityConfigFromEnv.md index 5250dbd22..60e8eb326 100644 --- a/docs/api/functions/buildObservabilityConfigFromEnv.md +++ b/docs/api/functions/buildObservabilityConfigFromEnv.md @@ -8,8 +8,6 @@ > **buildObservabilityConfigFromEnv**(): [`ObservabilityConfig`](../type-aliases/ObservabilityConfig.md) \| `undefined` -Defined in: [utils/observabilityHelpers.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/utils/observabilityHelpers.ts#L29) - Build observability config from environment variables Reads Langfuse configuration from environment: diff --git a/docs/api/functions/buildRegistryIndex.md b/docs/api/functions/buildRegistryIndex.md index 1adf940d6..b1dae8539 100644 --- a/docs/api/functions/buildRegistryIndex.md +++ b/docs/api/functions/buildRegistryIndex.md @@ -8,8 +8,6 @@ > **buildRegistryIndex**(): `Map`\<`string`, [`ModelInfo`](../type-aliases/ModelInfo.md)\> -Defined in: [routing/modelCatalog.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelCatalog.ts#L350) - Index the registry by model id once per build, for `enrichCandidate`. ## Returns diff --git a/docs/api/functions/buildRoutingQueryFromHistory.md b/docs/api/functions/buildRoutingQueryFromHistory.md index ef3fade8d..35669b82e 100644 --- a/docs/api/functions/buildRoutingQueryFromHistory.md +++ b/docs/api/functions/buildRoutingQueryFromHistory.md @@ -8,8 +8,6 @@ > **buildRoutingQueryFromHistory**(`recentMessages`, `currentQuery`, `maxChars?`, `maxMessages?`): `string` -Defined in: [core/toolRouting.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRouting.ts#L119) - Folds a bounded window of recent conversation turns together with the current user query into a single transcript string for the router. diff --git a/docs/api/functions/buildToolRoutingCatalog.md b/docs/api/functions/buildToolRoutingCatalog.md index 812c85b4c..70f32c415 100644 --- a/docs/api/functions/buildToolRoutingCatalog.md +++ b/docs/api/functions/buildToolRoutingCatalog.md @@ -8,8 +8,6 @@ > **buildToolRoutingCatalog**(`servers`, `registeredToolNames`): [`ToolRoutingCatalogEntry`](../type-aliases/ToolRoutingCatalogEntry.md)[] -Defined in: [core/toolRouting.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRouting.ts#L87) - Builds the routing catalog by pairing each declared server with the registered tool names that belong to it (`${serverId}_${toolName}`). Servers with zero registered tools are dropped. diff --git a/docs/api/functions/calculateCost.md b/docs/api/functions/calculateCost.md index 3c144174f..b8e2d0b06 100644 --- a/docs/api/functions/calculateCost.md +++ b/docs/api/functions/calculateCost.md @@ -8,8 +8,6 @@ > **calculateCost**(`provider`, `model`, `usage`): `number` -Defined in: [utils/pricing.ts:1037](https://github.com/juspay/neurolink/blob/release/src/lib/utils/pricing.ts#L1037) - Calculate the dollar cost of a generate/stream call based on token usage. Returns 0 if the provider/model combination is not in the pricing table. diff --git a/docs/api/functions/calculateExpiresAt.md b/docs/api/functions/calculateExpiresAt.md index bb6aabc40..6b195d023 100644 --- a/docs/api/functions/calculateExpiresAt.md +++ b/docs/api/functions/calculateExpiresAt.md @@ -8,8 +8,6 @@ > **calculateExpiresAt**(`expiresIn`): `number` -Defined in: [mcp/auth/tokenStorage.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L165) - Calculate token expiration timestamp from expires_in value ## Parameters diff --git a/docs/api/functions/calculateModelMetrics.md b/docs/api/functions/calculateModelMetrics.md index a8e53ce76..1b0f9828f 100644 --- a/docs/api/functions/calculateModelMetrics.md +++ b/docs/api/functions/calculateModelMetrics.md @@ -8,8 +8,6 @@ > **calculateModelMetrics**(`responses`): `Record`\<`string`, \{ `successRate`: `number`; `avgResponseTime`: `number`; \}\> -Defined in: [workflow/utils/workflowMetrics.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/utils/workflowMetrics.ts#L160) - Calculate model-specific metrics from ensemble responses ## Parameters diff --git a/docs/api/functions/canDeliverVideoNatively.md b/docs/api/functions/canDeliverVideoNatively.md index b3d7ddf6a..23c1f5195 100644 --- a/docs/api/functions/canDeliverVideoNatively.md +++ b/docs/api/functions/canDeliverVideoNatively.md @@ -8,8 +8,6 @@ > **canDeliverVideoNatively**(`provider`, `video`, `priorNativeVideoBytes?`, `model?`): [`VideoDeliveryDecision`](../type-aliases/VideoDeliveryDecision.md) -Defined in: [adapters/videoFormatSupport.ts:381](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/videoFormatSupport.ts#L381) - Whether one specific clip may go to one specific provider as bytes. Every rejection carries a reason the caller can log verbatim, because the diff --git a/docs/api/functions/chunkText.md b/docs/api/functions/chunkText.md index 67766b83a..00a3ec538 100644 --- a/docs/api/functions/chunkText.md +++ b/docs/api/functions/chunkText.md @@ -8,8 +8,6 @@ > **chunkText**(`text`, `strategy?`, `config?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/chunking/chunkerRegistry.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/rag/chunking/chunkerRegistry.ts#L217) - Convenience function to chunk text with a given strategy ## Parameters diff --git a/docs/api/functions/classifyHeuristic.md b/docs/api/functions/classifyHeuristic.md index 809b11902..43b9d85d4 100644 --- a/docs/api/functions/classifyHeuristic.md +++ b/docs/api/functions/classifyHeuristic.md @@ -8,8 +8,6 @@ > **classifyHeuristic**(`input`): [`ClassifierDecision`](../type-aliases/ClassifierDecision.md) -Defined in: [routing/classifierStrategies.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierStrategies.ts#L71) - Heuristic classifier — maps the binary fast/reasoning scores plus prompt length into one of five difficulty tiers. Deterministic and dependency-free. diff --git a/docs/api/functions/classifyJev.md b/docs/api/functions/classifyJev.md index 053fb7f53..ad84a1a15 100644 --- a/docs/api/functions/classifyJev.md +++ b/docs/api/functions/classifyJev.md @@ -8,8 +8,6 @@ > **classifyJev**(`input`, `decide`, `timeoutMs?`, `candidates?`, `thresholds?`): `Promise`\<[`ClassifierDecision`](../type-aliases/ClassifierDecision.md)\> -Defined in: [routing/classifierStrategies.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierStrategies.ts#L325) - Decision-model classifier — one request answers difficulty, capabilities, risk and model selection at once. diff --git a/docs/api/functions/classifyProviderError.md b/docs/api/functions/classifyProviderError.md index 8b9c10012..56287bc41 100644 --- a/docs/api/functions/classifyProviderError.md +++ b/docs/api/functions/classifyProviderError.md @@ -8,8 +8,6 @@ > **classifyProviderError**(`error`): [`ProviderErrorClass`](../type-aliases/ProviderErrorClass.md) -Defined in: [routing/modelPool.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelPool.ts#L65) - Classify a provider error into a coarse `ProviderErrorClass`. Rules (checked in order): diff --git a/docs/api/functions/clearAnalyticsMetrics.md b/docs/api/functions/clearAnalyticsMetrics.md index 9ca82f8d9..24bb777ee 100644 --- a/docs/api/functions/clearAnalyticsMetrics.md +++ b/docs/api/functions/clearAnalyticsMetrics.md @@ -8,8 +8,6 @@ > **clearAnalyticsMetrics**(): `void` -Defined in: [middleware/builtin/analytics.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/builtin/analytics.ts#L156) - Clear collected metrics from analytics middleware Note: This is a utility function for clearing metrics diff --git a/docs/api/functions/clearWorkflowRegistry.md b/docs/api/functions/clearWorkflowRegistry.md index 7bf3c8117..fc6bc9033 100644 --- a/docs/api/functions/clearWorkflowRegistry.md +++ b/docs/api/functions/clearWorkflowRegistry.md @@ -8,8 +8,6 @@ > **clearWorkflowRegistry**(): `void` -Defined in: [workflow/core/workflowRegistry.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/core/workflowRegistry.ts#L284) - Clear all workflows from registry WARNING: This will remove all registered workflows diff --git a/docs/api/functions/collectStream.md b/docs/api/functions/collectStream.md index 0354ee371..48e638f50 100644 --- a/docs/api/functions/collectStream.md +++ b/docs/api/functions/collectStream.md @@ -8,8 +8,6 @@ > **collectStream**(`stream`): `Promise`\<[`ClientStreamResult`](../type-aliases/ClientStreamResult.md)\> -Defined in: [client/streamingClient.ts:1081](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L1081) - Collect streaming events into a single result ## Parameters diff --git a/docs/api/functions/compareWorkflows.md b/docs/api/functions/compareWorkflows.md index 261e925d8..d96823e98 100644 --- a/docs/api/functions/compareWorkflows.md +++ b/docs/api/functions/compareWorkflows.md @@ -8,8 +8,6 @@ > **compareWorkflows**(`workflow1Results`, `workflow2Results`): [`WorkflowComparison`](../type-aliases/WorkflowComparison.md) -Defined in: [workflow/utils/workflowMetrics.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/utils/workflowMetrics.ts#L341) - Compare two workflows based on metrics ## Parameters diff --git a/docs/api/functions/composeMiddleware.md b/docs/api/functions/composeMiddleware.md index fd8d46edb..77ebb134a 100644 --- a/docs/api/functions/composeMiddleware.md +++ b/docs/api/functions/composeMiddleware.md @@ -8,8 +8,6 @@ > **composeMiddleware**(...`middlewares`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:764](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L764) - Compose multiple middleware into one ## Parameters diff --git a/docs/api/functions/composeScorers.md b/docs/api/functions/composeScorers.md index 040783b52..05efe1598 100644 --- a/docs/api/functions/composeScorers.md +++ b/docs/api/functions/composeScorers.md @@ -8,8 +8,6 @@ > **composeScorers**(`id`, `name`, `scorers`, `options?`): [`BaseScorer`](../classes/BaseScorer.md) -Defined in: [evaluation/scorers/customScorerUtils.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/customScorerUtils.ts#L405) - Compose multiple scorers into a single scorer with aggregation ## Parameters diff --git a/docs/api/functions/computeToolSignature.md b/docs/api/functions/computeToolSignature.md index ff77983f3..f02ad53ea 100644 --- a/docs/api/functions/computeToolSignature.md +++ b/docs/api/functions/computeToolSignature.md @@ -8,8 +8,6 @@ > **computeToolSignature**(`name`, `tool`): `string` -Defined in: [core/toolDedup.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolDedup.ts#L104) - Build a canonical, order-insensitive signature string for a named tool. The signature is composed of: diff --git a/docs/api/functions/conditionalMiddleware.md b/docs/api/functions/conditionalMiddleware.md index ce1fb70c4..43bf0ebf3 100644 --- a/docs/api/functions/conditionalMiddleware.md +++ b/docs/api/functions/conditionalMiddleware.md @@ -8,8 +8,6 @@ > **conditionalMiddleware**(`condition`, `middleware`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L793) - Conditionally apply middleware ## Parameters diff --git a/docs/api/functions/contextScopeToThreshold.md b/docs/api/functions/contextScopeToThreshold.md index c8c959cfa..dd5edbe5c 100644 --- a/docs/api/functions/contextScopeToThreshold.md +++ b/docs/api/functions/contextScopeToThreshold.md @@ -8,8 +8,6 @@ > **contextScopeToThreshold**(`index`): `number` -Defined in: [routing/classifierStrategies.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/routing/classifierStrategies.ts#L286) - Map a score answer onto a compaction threshold, clamped so it can only ever lower the default. diff --git a/docs/api/functions/contextToErrorContext.md b/docs/api/functions/contextToErrorContext.md index 6f55b4d2f..3555f8b0c 100644 --- a/docs/api/functions/contextToErrorContext.md +++ b/docs/api/functions/contextToErrorContext.md @@ -8,8 +8,6 @@ > **contextToErrorContext**(`context`): [`EvaluationErrorContext`](../type-aliases/EvaluationErrorContext.md) -Defined in: [evaluation/errors/EvaluationError.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L272) - Converts an evaluation context to error context for debugging. ## Parameters diff --git a/docs/api/functions/cosineSimilarity.md b/docs/api/functions/cosineSimilarity.md index 46161e955..6eb942ee4 100644 --- a/docs/api/functions/cosineSimilarity.md +++ b/docs/api/functions/cosineSimilarity.md @@ -8,8 +8,6 @@ > **cosineSimilarity**(`a`, `b`): `number` -Defined in: [core/toolRoutingEmbedding.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingEmbedding.ts#L72) - Cosine similarity between two vectors. Returns 0 when either vector is zero-length, has zero magnitude, or the diff --git a/docs/api/functions/createAIProvider.md b/docs/api/functions/createAIProvider.md index 91391847d..e59cd87a1 100644 --- a/docs/api/functions/createAIProvider.md +++ b/docs/api/functions/createAIProvider.md @@ -8,8 +8,6 @@ > **createAIProvider**(`providerName?`, `modelName?`): `Promise`\<[`AIProvider`](../type-aliases/AIProvider.md)\> -Defined in: [index.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/index.ts#L493) - Quick start factory function for creating AI provider instances. Creates a configured AI provider instance ready for immediate use. diff --git a/docs/api/functions/createAIProviderWithFallback.md b/docs/api/functions/createAIProviderWithFallback.md index ef40555c6..302de03aa 100644 --- a/docs/api/functions/createAIProviderWithFallback.md +++ b/docs/api/functions/createAIProviderWithFallback.md @@ -8,8 +8,6 @@ > **createAIProviderWithFallback**(`primaryProvider?`, `fallbackProvider?`, `modelName?`): `Promise`\<[`ProviderPairResult`](../type-aliases/ProviderPairResult.md)\<[`AIProvider`](../type-aliases/AIProvider.md)\>\> -Defined in: [index.ts:542](https://github.com/juspay/neurolink/blob/release/src/lib/index.ts#L542) - Create provider with automatic fallback for production resilience. Creates both primary and fallback provider instances for high-availability diff --git a/docs/api/functions/createAdaptiveWorkflow.md b/docs/api/functions/createAdaptiveWorkflow.md index d757f834a..5cc70821b 100644 --- a/docs/api/functions/createAdaptiveWorkflow.md +++ b/docs/api/functions/createAdaptiveWorkflow.md @@ -8,8 +8,6 @@ > **createAdaptiveWorkflow**(`tiers`, `strategy`): [`WorkflowConfig`](../type-aliases/WorkflowConfig.md) -Defined in: [workflow/workflows/adaptiveWorkflow.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/workflows/adaptiveWorkflow.ts#L375) - Create custom adaptive workflow ## Parameters diff --git a/docs/api/functions/createAgentRoutes.md b/docs/api/functions/createAgentRoutes.md index d7e5ab3d7..84aca0862 100644 --- a/docs/api/functions/createAgentRoutes.md +++ b/docs/api/functions/createAgentRoutes.md @@ -8,8 +8,6 @@ > **createAgentRoutes**(`basePath?`): [`RouteGroup`](../type-aliases/RouteGroup.md) -Defined in: [server/routes/agentRoutes.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/server/routes/agentRoutes.ts#L111) - Create agent routes ## Parameters diff --git a/docs/api/functions/createAgentWebSocketHandler.md b/docs/api/functions/createAgentWebSocketHandler.md index 2c34e088e..785eec542 100644 --- a/docs/api/functions/createAgentWebSocketHandler.md +++ b/docs/api/functions/createAgentWebSocketHandler.md @@ -8,8 +8,6 @@ > **createAgentWebSocketHandler**(`_neurolink`): [`WebSocketHandler`](../type-aliases/WebSocketHandler.md) -Defined in: [server/websocket/WebSocketHandler.ts:458](https://github.com/juspay/neurolink/blob/release/src/lib/server/websocket/WebSocketHandler.ts#L458) - Create a WebSocket handler for AI agent interactions ## Parameters diff --git a/docs/api/functions/createAllRoutes.md b/docs/api/functions/createAllRoutes.md index ced42f42c..6485bc342 100644 --- a/docs/api/functions/createAllRoutes.md +++ b/docs/api/functions/createAllRoutes.md @@ -8,8 +8,6 @@ > **createAllRoutes**(`basePath?`, `options?`): [`RouteGroup`](../type-aliases/RouteGroup.md)[] -Defined in: [server/routes/index.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/server/routes/index.ts#L40) - Create all standard routes Convenience method that combines all route groups diff --git a/docs/api/functions/createAnalyticsMiddleware.md b/docs/api/functions/createAnalyticsMiddleware.md index 323ccfe7b..9afabe973 100644 --- a/docs/api/functions/createAnalyticsMiddleware.md +++ b/docs/api/functions/createAnalyticsMiddleware.md @@ -8,8 +8,6 @@ > **createAnalyticsMiddleware**(): [`NeuroLinkMiddleware`](../type-aliases/NeuroLinkMiddleware.md) -Defined in: [middleware/builtin/analytics.ts:12](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/builtin/analytics.ts#L12) - Create analytics middleware for tracking AI model usage Collects metrics on token usage, response times, and model performance diff --git a/docs/api/functions/createAndInitializePipeline.md b/docs/api/functions/createAndInitializePipeline.md index b9305caeb..23cd9628f 100644 --- a/docs/api/functions/createAndInitializePipeline.md +++ b/docs/api/functions/createAndInitializePipeline.md @@ -8,8 +8,6 @@ > **createAndInitializePipeline**(`config`): `Promise`\<[`EvaluationPipeline`](../classes/EvaluationPipeline.md)\> -Defined in: [evaluation/pipeline/evaluationPipeline.ts:508](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L508) - Create and initialize a pipeline ## Parameters diff --git a/docs/api/functions/createAnnotatedTool.md b/docs/api/functions/createAnnotatedTool.md index ce3274a6d..8bbf5bb02 100644 --- a/docs/api/functions/createAnnotatedTool.md +++ b/docs/api/functions/createAnnotatedTool.md @@ -8,8 +8,6 @@ > **createAnnotatedTool**(`tool`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) -Defined in: [mcp/toolAnnotations.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L220) - Create a tool with default annotations inferred ## Parameters diff --git a/docs/api/functions/createAnswerRelevancyScorer.md b/docs/api/functions/createAnswerRelevancyScorer.md index 1416a1941..6df200ddd 100644 --- a/docs/api/functions/createAnswerRelevancyScorer.md +++ b/docs/api/functions/createAnswerRelevancyScorer.md @@ -8,8 +8,6 @@ > **createAnswerRelevancyScorer**(`config?`): `Promise`\<[`AnswerRelevancyScorer`](../classes/AnswerRelevancyScorer.md)\> -Defined in: [evaluation/scorers/llm/answerRelevancyScorer.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/answerRelevancyScorer.ts#L128) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createApiKeyAuthInterceptor.md b/docs/api/functions/createApiKeyAuthInterceptor.md index 012f74ffa..90816ece9 100644 --- a/docs/api/functions/createApiKeyAuthInterceptor.md +++ b/docs/api/functions/createApiKeyAuthInterceptor.md @@ -8,8 +8,6 @@ > **createApiKeyAuthInterceptor**(`apiKey`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L72) - API Key authentication interceptor Adds X-API-Key header to all requests. diff --git a/docs/api/functions/createApiKeyMiddleware.md b/docs/api/functions/createApiKeyMiddleware.md index bdf1b1097..3ad473332 100644 --- a/docs/api/functions/createApiKeyMiddleware.md +++ b/docs/api/functions/createApiKeyMiddleware.md @@ -8,8 +8,6 @@ > **createApiKeyMiddleware**(`apiKey`, `headerName?`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/auth.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L285) - Create an API key authentication middleware ## Parameters diff --git a/docs/api/functions/createArtifactStore.md b/docs/api/functions/createArtifactStore.md index 9f4b035b1..160e3c935 100644 --- a/docs/api/functions/createArtifactStore.md +++ b/docs/api/functions/createArtifactStore.md @@ -8,8 +8,6 @@ > **createArtifactStore**(`config?`, `fallbackRedis?`): [`ArtifactStore`](../type-aliases/ArtifactStore.md) -Defined in: [artifacts/artifactStoreFactory.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStoreFactory.ts#L106) - Build the artifact store `config` asks for. ## Parameters diff --git a/docs/api/functions/createAsyncStream.md b/docs/api/functions/createAsyncStream.md index 8df2eda09..0164c59fc 100644 --- a/docs/api/functions/createAsyncStream.md +++ b/docs/api/functions/createAsyncStream.md @@ -8,8 +8,6 @@ > **createAsyncStream**(`responsePromise`): `AsyncGenerator`\<[`ClientStreamEvent`](../type-aliases/ClientStreamEvent.md), `void`, `unknown`\> -Defined in: [client/streamingClient.ts:1016](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L1016) - Create an async iterable from streaming response ## Parameters diff --git a/docs/api/functions/createAuthMiddleware.md b/docs/api/functions/createAuthMiddleware.md index 1dfd83115..8af02eab9 100644 --- a/docs/api/functions/createAuthMiddleware.md +++ b/docs/api/functions/createAuthMiddleware.md @@ -8,8 +8,6 @@ > **createAuthMiddleware**(`config`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/auth.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/auth.ts#L78) - Create authentication middleware ## Parameters diff --git a/docs/api/functions/createAuthProvider.md b/docs/api/functions/createAuthProvider.md index 2827c5161..058db21ba 100644 --- a/docs/api/functions/createAuthProvider.md +++ b/docs/api/functions/createAuthProvider.md @@ -8,8 +8,6 @@ > **createAuthProvider**(`type`, `config`): `Promise`\<[`AuthProvider`](../type-aliases/AuthProvider.md)\> -Defined in: [auth/AuthProviderFactory.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/auth/AuthProviderFactory.ts#L162) - Create an auth provider using the factory ## Parameters diff --git a/docs/api/functions/createAuthProviderMiddleware.md b/docs/api/functions/createAuthProviderMiddleware.md index a609d632f..bf4065b39 100644 --- a/docs/api/functions/createAuthProviderMiddleware.md +++ b/docs/api/functions/createAuthProviderMiddleware.md @@ -8,8 +8,6 @@ > **createAuthProviderMiddleware**(`config`): `Promise`\<[`AuthMiddlewareHandler`](../type-aliases/AuthMiddlewareHandler.md)\<[`AuthRequestContext`](../type-aliases/AuthRequestContext.md)\>\> -Defined in: [auth/middleware/AuthMiddleware.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/AuthMiddleware.ts#L186) - Create authentication middleware Validates tokens and attaches user context to requests. diff --git a/docs/api/functions/createAuthValidatorFromProvider.md b/docs/api/functions/createAuthValidatorFromProvider.md index 80af6f713..0112142f9 100644 --- a/docs/api/functions/createAuthValidatorFromProvider.md +++ b/docs/api/functions/createAuthValidatorFromProvider.md @@ -8,8 +8,6 @@ > **createAuthValidatorFromProvider**(`provider`): (`token`, `ctx`) => `Promise`\<\{ `id`: `string`; `email?`: `string`; `roles?`: `string`[]; \} \| `null`\> -Defined in: [auth/serverBridge.ts:12](https://github.com/juspay/neurolink/blob/release/src/lib/auth/serverBridge.ts#L12) - Create a validate function for server auth middleware from an auth provider. ## Parameters diff --git a/docs/api/functions/createAuthWithRetryMiddleware.md b/docs/api/functions/createAuthWithRetryMiddleware.md index 67acb9144..983ca5117 100644 --- a/docs/api/functions/createAuthWithRetryMiddleware.md +++ b/docs/api/functions/createAuthWithRetryMiddleware.md @@ -8,8 +8,6 @@ > **createAuthWithRetryMiddleware**(`tokenManager`, `maxRetries?`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/auth.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L349) - Create an authentication middleware with retry on 401 Automatically refreshes token and retries request when receiving 401. diff --git a/docs/api/functions/createAuthenticatedContext.md b/docs/api/functions/createAuthenticatedContext.md index 58d56311f..28613da8e 100644 --- a/docs/api/functions/createAuthenticatedContext.md +++ b/docs/api/functions/createAuthenticatedContext.md @@ -8,8 +8,6 @@ > **createAuthenticatedContext**(`user`, `session`, `request`, `provider`): [`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md) -Defined in: [auth/authContext.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L265) - Create an authenticated context Helper to build an AuthenticatedContext object. diff --git a/docs/api/functions/createAuthenticatedRateLimitMiddleware.md b/docs/api/functions/createAuthenticatedRateLimitMiddleware.md index 7d4cf0d3d..d13c97bfc 100644 --- a/docs/api/functions/createAuthenticatedRateLimitMiddleware.md +++ b/docs/api/functions/createAuthenticatedRateLimitMiddleware.md @@ -8,8 +8,6 @@ > **createAuthenticatedRateLimitMiddleware**(`authMiddleware`, `rateLimitConfig`, `storage?`): (`context`) => `Promise`\<\{ `proceed`: `boolean`; `context?`: [`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md); `rateLimitResult?`: [`RateLimitResult`](../type-aliases/RateLimitResult.md); `response?`: `Response`; \}\> -Defined in: [auth/middleware/rateLimitByUser.ts:609](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L609) - Create a combined auth and rate limit middleware ## Parameters diff --git a/docs/api/functions/createBatchEvaluationError.md b/docs/api/functions/createBatchEvaluationError.md index eeda36947..ee3a9e93b 100644 --- a/docs/api/functions/createBatchEvaluationError.md +++ b/docs/api/functions/createBatchEvaluationError.md @@ -8,8 +8,6 @@ > **createBatchEvaluationError**(`failedCount`, `totalCount`, `errors`): [`NeuroLinkFeatureError`](../classes/NeuroLinkFeatureError.md) -Defined in: [evaluation/errors/EvaluationError.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L224) - Helper function to create a batch evaluation error. ## Parameters diff --git a/docs/api/functions/createBatchStrategy.md b/docs/api/functions/createBatchStrategy.md index 107e05931..5c603408c 100644 --- a/docs/api/functions/createBatchStrategy.md +++ b/docs/api/functions/createBatchStrategy.md @@ -8,8 +8,6 @@ > **createBatchStrategy**(`pipeline`, `config?`): [`BatchStrategy`](../classes/BatchStrategy.md) -Defined in: [evaluation/pipeline/strategies/batchStrategy.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/batchStrategy.ts#L218) - Create a batch strategy for a pipeline ## Parameters diff --git a/docs/api/functions/createBearerAuthInterceptor.md b/docs/api/functions/createBearerAuthInterceptor.md index ea971a833..71c51f4b0 100644 --- a/docs/api/functions/createBearerAuthInterceptor.md +++ b/docs/api/functions/createBearerAuthInterceptor.md @@ -8,8 +8,6 @@ > **createBearerAuthInterceptor**(`token`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L89) - Bearer token authentication interceptor Adds Authorization header with Bearer token. diff --git a/docs/api/functions/createBearerTokenMiddleware.md b/docs/api/functions/createBearerTokenMiddleware.md index dfa0e4588..5fac76799 100644 --- a/docs/api/functions/createBearerTokenMiddleware.md +++ b/docs/api/functions/createBearerTokenMiddleware.md @@ -8,8 +8,6 @@ > **createBearerTokenMiddleware**(`token`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/auth.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L304) - Create a Bearer token authentication middleware ## Parameters diff --git a/docs/api/functions/createBestAIProvider.md b/docs/api/functions/createBestAIProvider.md index 22d8446c0..aa6d0efdc 100644 --- a/docs/api/functions/createBestAIProvider.md +++ b/docs/api/functions/createBestAIProvider.md @@ -8,8 +8,6 @@ > **createBestAIProvider**(`requestedProvider?`, `modelName?`): `Promise`\<[`AIProvider`](../type-aliases/AIProvider.md)\> -Defined in: [index.ts:595](https://github.com/juspay/neurolink/blob/release/src/lib/index.ts#L595) - Create the best available provider based on environment configuration. Intelligently selects the best provider based on available API keys diff --git a/docs/api/functions/createBiasDetectionScorer.md b/docs/api/functions/createBiasDetectionScorer.md index cf4de700f..8628b3354 100644 --- a/docs/api/functions/createBiasDetectionScorer.md +++ b/docs/api/functions/createBiasDetectionScorer.md @@ -8,8 +8,6 @@ > **createBiasDetectionScorer**(`config?`): `Promise`\<[`BiasDetectionScorer`](../classes/BiasDetectionScorer.md)\> -Defined in: [evaluation/scorers/llm/biasDetectionScorer.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/biasDetectionScorer.ts#L154) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createCacheInterceptor.md b/docs/api/functions/createCacheInterceptor.md index c4a2fac17..5738a54b8 100644 --- a/docs/api/functions/createCacheInterceptor.md +++ b/docs/api/functions/createCacheInterceptor.md @@ -8,8 +8,6 @@ > **createCacheInterceptor**(`options`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:575](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L575) - Caching interceptor Caches responses to reduce API calls. diff --git a/docs/api/functions/createCacheInvalidator.md b/docs/api/functions/createCacheInvalidator.md index c15088003..d153090e1 100644 --- a/docs/api/functions/createCacheInvalidator.md +++ b/docs/api/functions/createCacheInvalidator.md @@ -8,8 +8,6 @@ > **createCacheInvalidator**(`store`): `object` -Defined in: [server/middleware/cache.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/cache.ts#L204) - Create a cache invalidation helper ## Parameters diff --git a/docs/api/functions/createCacheMiddleware.md b/docs/api/functions/createCacheMiddleware.md index 2ef55be66..cf0208e48 100644 --- a/docs/api/functions/createCacheMiddleware.md +++ b/docs/api/functions/createCacheMiddleware.md @@ -8,8 +8,6 @@ > **createCacheMiddleware**(`config`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/cache.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/cache.ts#L107) - Create cache middleware Response headers set by this middleware: diff --git a/docs/api/functions/createChunker.md b/docs/api/functions/createChunker.md index 88b605f47..21189ea7c 100644 --- a/docs/api/functions/createChunker.md +++ b/docs/api/functions/createChunker.md @@ -8,8 +8,6 @@ > **createChunker**(`strategyOrAlias`, `config?`): `Promise`\<[`Chunker`](../type-aliases/Chunker.md)\> -Defined in: [rag/ChunkerFactory.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/rag/ChunkerFactory.ts#L430) - Convenience function to create a chunker ## Parameters diff --git a/docs/api/functions/createClient.md b/docs/api/functions/createClient.md index c7ed3c5a2..a9d65c281 100644 --- a/docs/api/functions/createClient.md +++ b/docs/api/functions/createClient.md @@ -8,8 +8,6 @@ > **createClient**(`config`): [`NeuroLinkClient`](../classes/NeuroLinkClient.md) -Defined in: [client/httpClient.ts:1147](https://github.com/juspay/neurolink/blob/release/src/lib/client/httpClient.ts#L1147) - Create a new NeuroLink client instance ## Parameters diff --git a/docs/api/functions/createCompressionMiddleware.md b/docs/api/functions/createCompressionMiddleware.md index 95cc2b30f..b8573a378 100644 --- a/docs/api/functions/createCompressionMiddleware.md +++ b/docs/api/functions/createCompressionMiddleware.md @@ -8,8 +8,6 @@ > **createCompressionMiddleware**(`options?`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/common.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/common.ts#L398) - Create compression preference middleware Signals compression preference to adapters diff --git a/docs/api/functions/createConditionalScorer.md b/docs/api/functions/createConditionalScorer.md index bc54f251e..6daef6a9a 100644 --- a/docs/api/functions/createConditionalScorer.md +++ b/docs/api/functions/createConditionalScorer.md @@ -8,8 +8,6 @@ > **createConditionalScorer**(`id`, `name`, `condition`, `scorer`, `options?`): [`BaseScorer`](../classes/BaseScorer.md) -Defined in: [evaluation/scorers/customScorerUtils.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/customScorerUtils.ts#L501) - Create a conditional scorer that only runs if a condition is met ## Parameters diff --git a/docs/api/functions/createConfigurationError.md b/docs/api/functions/createConfigurationError.md index 5367f4d77..0cf27954c 100644 --- a/docs/api/functions/createConfigurationError.md +++ b/docs/api/functions/createConfigurationError.md @@ -8,8 +8,6 @@ > **createConfigurationError**(`message`, `configIssue`): [`NeuroLinkFeatureError`](../classes/NeuroLinkFeatureError.md) -Defined in: [evaluation/errors/EvaluationError.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L254) - Helper function to create a configuration error. ## Parameters diff --git a/docs/api/functions/createConfirmationRequest.md b/docs/api/functions/createConfirmationRequest.md index 708fcecb2..9ca181f41 100644 --- a/docs/api/functions/createConfirmationRequest.md +++ b/docs/api/functions/createConfirmationRequest.md @@ -8,8 +8,6 @@ > **createConfirmationRequest**(`message`, `options`): [`ElicitationRequestMessage`](../type-aliases/ElicitationRequestMessage.md) -Defined in: [mcp/elicitationProtocol.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L391) - Create protocol-compliant confirmation request ## Parameters diff --git a/docs/api/functions/createConsensus3WithPrompt.md b/docs/api/functions/createConsensus3WithPrompt.md index 2ea1138d0..895e1b9b2 100644 --- a/docs/api/functions/createConsensus3WithPrompt.md +++ b/docs/api/functions/createConsensus3WithPrompt.md @@ -8,8 +8,6 @@ > **createConsensus3WithPrompt**(`systemPrompt`): [`WorkflowConfig`](../type-aliases/WorkflowConfig.md) -Defined in: [workflow/workflows/consensusWorkflow.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/workflows/consensusWorkflow.ts#L129) - Consensus-3 with Custom System Prompt Same as CONSENSUS_3_WORKFLOW but allows custom system prompt diff --git a/docs/api/functions/createConsoleLoggerHook.md b/docs/api/functions/createConsoleLoggerHook.md index a902c2a97..19c0197dd 100644 --- a/docs/api/functions/createConsoleLoggerHook.md +++ b/docs/api/functions/createConsoleLoggerHook.md @@ -8,8 +8,6 @@ > **createConsoleLoggerHook**(): `void` -Defined in: [evaluation/hooks/observabilityHooks.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L152) - Helper: Create a console logger hook ## Returns diff --git a/docs/api/functions/createContentSimilarityScorer.md b/docs/api/functions/createContentSimilarityScorer.md index 0d3d41c1c..879adc613 100644 --- a/docs/api/functions/createContentSimilarityScorer.md +++ b/docs/api/functions/createContentSimilarityScorer.md @@ -8,8 +8,6 @@ > **createContentSimilarityScorer**(`config?`): `Promise`\<`ContentSimilarityScorer`\> -Defined in: [evaluation/scorers/rule/contentSimilarityScorer.ts:452](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/contentSimilarityScorer.ts#L452) - Factory function for creating ContentSimilarityScorer instances ## Parameters diff --git a/docs/api/functions/createContextEnricher.md b/docs/api/functions/createContextEnricher.md index 56bef54c9..816539170 100644 --- a/docs/api/functions/createContextEnricher.md +++ b/docs/api/functions/createContextEnricher.md @@ -8,8 +8,6 @@ > **createContextEnricher**(): `SpanProcessor` -Defined in: [services/server/ai/observability/instrumentation.ts:1564](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1564) - Create a new ContextEnricher span processor Use this when useExternalTracerProvider is true to add to your own TracerProvider diff --git a/docs/api/functions/createContextPrecisionScorer.md b/docs/api/functions/createContextPrecisionScorer.md index 1f35c7c30..c5d0d590f 100644 --- a/docs/api/functions/createContextPrecisionScorer.md +++ b/docs/api/functions/createContextPrecisionScorer.md @@ -8,8 +8,6 @@ > **createContextPrecisionScorer**(`config?`): `Promise`\<[`ContextPrecisionScorer`](../classes/ContextPrecisionScorer.md)\> -Defined in: [evaluation/scorers/llm/contextPrecisionScorer.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextPrecisionScorer.ts#L115) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createContextRelevancyScorer.md b/docs/api/functions/createContextRelevancyScorer.md index 56ddb0dd5..cb32997d2 100644 --- a/docs/api/functions/createContextRelevancyScorer.md +++ b/docs/api/functions/createContextRelevancyScorer.md @@ -8,8 +8,6 @@ > **createContextRelevancyScorer**(`config?`): `Promise`\<[`ContextRelevancyScorer`](../classes/ContextRelevancyScorer.md)\> -Defined in: [evaluation/scorers/llm/contextRelevancyScorer.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/contextRelevancyScorer.ts#L130) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createContextWindow.md b/docs/api/functions/createContextWindow.md index 38e2da962..0ec85652b 100644 --- a/docs/api/functions/createContextWindow.md +++ b/docs/api/functions/createContextWindow.md @@ -8,8 +8,6 @@ > **createContextWindow**(`results`, `options?`): [`ContextWindow`](../type-aliases/ContextWindow.md) -Defined in: [rag/pipeline/contextAssembly.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/contextAssembly.ts#L204) - Create a context window with detailed tracking ## Parameters diff --git a/docs/api/functions/createDataStreamResponse.md b/docs/api/functions/createDataStreamResponse.md index c593fc65f..ee69b674e 100644 --- a/docs/api/functions/createDataStreamResponse.md +++ b/docs/api/functions/createDataStreamResponse.md @@ -8,8 +8,6 @@ > **createDataStreamResponse**(`config?`): `DataStreamResponse` -Defined in: [server/streaming/dataStream.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/server/streaming/dataStream.ts#L330) - Create a data stream response ## Parameters diff --git a/docs/api/functions/createDataStreamWriter.md b/docs/api/functions/createDataStreamWriter.md index f9fcb8b88..f94a10a92 100644 --- a/docs/api/functions/createDataStreamWriter.md +++ b/docs/api/functions/createDataStreamWriter.md @@ -8,8 +8,6 @@ > **createDataStreamWriter**(`config`): [`DataStreamWriter`](../type-aliases/DataStreamWriter.md) -Defined in: [server/streaming/dataStream.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/server/streaming/dataStream.ts#L24) - Creates a data stream writer ## Parameters diff --git a/docs/api/functions/createDefaultRequestRouter.md b/docs/api/functions/createDefaultRequestRouter.md index 69dde4f27..71451aeb2 100644 --- a/docs/api/functions/createDefaultRequestRouter.md +++ b/docs/api/functions/createDefaultRequestRouter.md @@ -8,8 +8,6 @@ > **createDefaultRequestRouter**(`config?`): [`RequestRouter`](../type-aliases/RequestRouter.md) -Defined in: [routing/requestRouter.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/routing/requestRouter.ts#L73) - Creates a heuristic `RequestRouter` from a `DefaultRequestRouterConfig`. ## Parameters diff --git a/docs/api/functions/createDefaultTripwireEvaluator.md b/docs/api/functions/createDefaultTripwireEvaluator.md index e244a8a42..7a318f74a 100644 --- a/docs/api/functions/createDefaultTripwireEvaluator.md +++ b/docs/api/functions/createDefaultTripwireEvaluator.md @@ -8,8 +8,6 @@ > **createDefaultTripwireEvaluator**(): [`TripwireEvaluator`](../classes/TripwireEvaluator.md) -Defined in: [utils/tripwireEvaluator.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tripwireEvaluator.ts#L329) - Create a TripwireEvaluator pre-loaded with all built-in tripwires. ## Returns diff --git a/docs/api/functions/createDynamicAuthInterceptor.md b/docs/api/functions/createDynamicAuthInterceptor.md index 17ddef926..47470e58a 100644 --- a/docs/api/functions/createDynamicAuthInterceptor.md +++ b/docs/api/functions/createDynamicAuthInterceptor.md @@ -8,8 +8,6 @@ > **createDynamicAuthInterceptor**(`getAuth`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L110) - Dynamic authentication interceptor Retrieves authentication token dynamically for each request. diff --git a/docs/api/functions/createElicitationCancel.md b/docs/api/functions/createElicitationCancel.md index b28657439..ec1412ac8 100644 --- a/docs/api/functions/createElicitationCancel.md +++ b/docs/api/functions/createElicitationCancel.md @@ -8,8 +8,6 @@ > **createElicitationCancel**(`requestId`, `reason?`): [`ElicitationCancelMessage`](../type-aliases/ElicitationCancelMessage.md) -Defined in: [mcp/elicitationProtocol.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L91) - Create an elicitation cancel protocol message ## Parameters diff --git a/docs/api/functions/createElicitationContext.md b/docs/api/functions/createElicitationContext.md index 065d320c2..55d4583f6 100644 --- a/docs/api/functions/createElicitationContext.md +++ b/docs/api/functions/createElicitationContext.md @@ -8,8 +8,6 @@ > **createElicitationContext**(`toolName`, `serverId`, `manager`): [`ElicitationContext`](../type-aliases/ElicitationContext.md) -Defined in: [mcp/toolIntegration.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L31) - Create elicitation context for a tool ## Parameters diff --git a/docs/api/functions/createElicitationRequest.md b/docs/api/functions/createElicitationRequest.md index 9f62ef019..b5c08b615 100644 --- a/docs/api/functions/createElicitationRequest.md +++ b/docs/api/functions/createElicitationRequest.md @@ -8,8 +8,6 @@ > **createElicitationRequest**(`params`): [`ElicitationRequestMessage`](../type-aliases/ElicitationRequestMessage.md) -Defined in: [mcp/elicitationProtocol.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L46) - Create an elicitation request protocol message ## Parameters diff --git a/docs/api/functions/createElicitationResponse.md b/docs/api/functions/createElicitationResponse.md index 1523a5924..7b2995646 100644 --- a/docs/api/functions/createElicitationResponse.md +++ b/docs/api/functions/createElicitationResponse.md @@ -8,8 +8,6 @@ > **createElicitationResponse**(`requestId`, `response`): [`ElicitationResponseMessage`](../type-aliases/ElicitationResponseMessage.md) -Defined in: [mcp/elicitationProtocol.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L69) - Create an elicitation response protocol message ## Parameters diff --git a/docs/api/functions/createErrorFactory.md b/docs/api/functions/createErrorFactory.md index bd56184e2..5d2843aa9 100644 --- a/docs/api/functions/createErrorFactory.md +++ b/docs/api/functions/createErrorFactory.md @@ -8,8 +8,6 @@ > **createErrorFactory**\<`TCodes`\>(`feature`, `codes`): `object` -Defined in: [core/infrastructure/baseError.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/baseError.ts#L30) - ## Type Parameters ### TCodes diff --git a/docs/api/functions/createErrorFromNative.md b/docs/api/functions/createErrorFromNative.md index c7f7ca7ec..58d8c9cf8 100644 --- a/docs/api/functions/createErrorFromNative.md +++ b/docs/api/functions/createErrorFromNative.md @@ -8,8 +8,6 @@ > **createErrorFromNative**(`error`, `options?`): [`ClientNeuroLinkError`](../classes/ClientNeuroLinkError.md) -Defined in: [client/errors.ts:661](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L661) - Create an error from a native Error object ## Parameters diff --git a/docs/api/functions/createErrorFromResponse.md b/docs/api/functions/createErrorFromResponse.md index 132a98da9..879e4d70a 100644 --- a/docs/api/functions/createErrorFromResponse.md +++ b/docs/api/functions/createErrorFromResponse.md @@ -8,8 +8,6 @@ > **createErrorFromResponse**(`apiError`, `options?`): [`ClientNeuroLinkError`](../classes/ClientNeuroLinkError.md) -Defined in: [client/errors.ts:603](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L603) - Create an error from an API error response ## Parameters diff --git a/docs/api/functions/createErrorHandlerInterceptor.md b/docs/api/functions/createErrorHandlerInterceptor.md index d1e866546..a551400d4 100644 --- a/docs/api/functions/createErrorHandlerInterceptor.md +++ b/docs/api/functions/createErrorHandlerInterceptor.md @@ -8,8 +8,6 @@ > **createErrorHandlerInterceptor**(`options?`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:713](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L713) - Error handling interceptor Provides centralized error handling and transformation. diff --git a/docs/api/functions/createErrorHandlingMiddleware.md b/docs/api/functions/createErrorHandlingMiddleware.md index a4d40dc47..0c1450145 100644 --- a/docs/api/functions/createErrorHandlingMiddleware.md +++ b/docs/api/functions/createErrorHandlingMiddleware.md @@ -8,8 +8,6 @@ > **createErrorHandlingMiddleware**(`options?`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/common.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/common.ts#L148) - Create error handling middleware Catches errors and formats them consistently diff --git a/docs/api/functions/createErrorResponse.md b/docs/api/functions/createErrorResponse.md index e5a5e1183..792d308ce 100644 --- a/docs/api/functions/createErrorResponse.md +++ b/docs/api/functions/createErrorResponse.md @@ -8,8 +8,6 @@ > **createErrorResponse**(`code`, `message`, `details?`, `requestId?`, `httpStatus?`): [`ErrorResponse`](../type-aliases/ErrorResponse.md) -Defined in: [server/utils/validation.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/server/utils/validation.ts#L218) - Create a standardized error response ## Parameters diff --git a/docs/api/functions/createEvaluationFailedError.md b/docs/api/functions/createEvaluationFailedError.md index c8580bb9b..58af95af4 100644 --- a/docs/api/functions/createEvaluationFailedError.md +++ b/docs/api/functions/createEvaluationFailedError.md @@ -8,8 +8,6 @@ > **createEvaluationFailedError**(`message`, `context?`, `cause?`): [`NeuroLinkFeatureError`](../classes/NeuroLinkFeatureError.md) -Defined in: [evaluation/errors/EvaluationError.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L100) - Helper function to create an evaluation failed error with context. ## Parameters diff --git a/docs/api/functions/createExpressAuthMiddleware.md b/docs/api/functions/createExpressAuthMiddleware.md index ea43f308e..96fe80555 100644 --- a/docs/api/functions/createExpressAuthMiddleware.md +++ b/docs/api/functions/createExpressAuthMiddleware.md @@ -8,8 +8,6 @@ > **createExpressAuthMiddleware**(`config`): `Promise`\<[`ExpressMiddleware`](../type-aliases/ExpressMiddleware.md)\> -Defined in: [auth/middleware/AuthMiddleware.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/AuthMiddleware.ts#L647) - Create Express-compatible middleware ## Parameters diff --git a/docs/api/functions/createFaithfulnessScorer.md b/docs/api/functions/createFaithfulnessScorer.md index 7e855a267..0c4dae8e0 100644 --- a/docs/api/functions/createFaithfulnessScorer.md +++ b/docs/api/functions/createFaithfulnessScorer.md @@ -8,8 +8,6 @@ > **createFaithfulnessScorer**(`config?`): `Promise`\<[`FaithfulnessScorer`](../classes/FaithfulnessScorer.md)\> -Defined in: [evaluation/scorers/llm/faithfulnessScorer.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/faithfulnessScorer.ts#L148) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createFieldValidator.md b/docs/api/functions/createFieldValidator.md index 752770f2f..55b2b153b 100644 --- a/docs/api/functions/createFieldValidator.md +++ b/docs/api/functions/createFieldValidator.md @@ -8,8 +8,6 @@ > **createFieldValidator**(`fieldName`, `rules`): (`value`) => `void` -Defined in: [server/middleware/validation.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/validation.ts#L312) - Create a field validator helper ## Parameters diff --git a/docs/api/functions/createFormRequest.md b/docs/api/functions/createFormRequest.md index 7fb3a7263..ec4298fe2 100644 --- a/docs/api/functions/createFormRequest.md +++ b/docs/api/functions/createFormRequest.md @@ -8,8 +8,6 @@ > **createFormRequest**(`message`, `fields`, `options`): [`ElicitationRequestMessage`](../type-aliases/ElicitationRequestMessage.md) -Defined in: [mcp/elicitationProtocol.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L493) - Create protocol-compliant form request ## Parameters diff --git a/docs/api/functions/createFormatScorer.md b/docs/api/functions/createFormatScorer.md index 1f1a493d7..92447b220 100644 --- a/docs/api/functions/createFormatScorer.md +++ b/docs/api/functions/createFormatScorer.md @@ -8,8 +8,6 @@ > **createFormatScorer**(`config?`): `Promise`\<`FormatScorer`\> -Defined in: [evaluation/scorers/rule/formatScorer.ts:542](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/formatScorer.ts#L542) - Factory function for creating FormatScorer instances ## Parameters diff --git a/docs/api/functions/createFunctionScorer.md b/docs/api/functions/createFunctionScorer.md index 47d9cd1e9..1318dfa2c 100644 --- a/docs/api/functions/createFunctionScorer.md +++ b/docs/api/functions/createFunctionScorer.md @@ -8,8 +8,6 @@ > **createFunctionScorer**(`id`, `name`, `scorerFn`, `options?`): [`BaseScorer`](../classes/BaseScorer.md) -Defined in: [evaluation/scorers/customScorerUtils.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/customScorerUtils.ts#L107) - Create a simple function-based scorer ## Parameters diff --git a/docs/api/functions/createHallucinationScorer.md b/docs/api/functions/createHallucinationScorer.md index 5cc93d3e3..6dda1dd54 100644 --- a/docs/api/functions/createHallucinationScorer.md +++ b/docs/api/functions/createHallucinationScorer.md @@ -8,8 +8,6 @@ > **createHallucinationScorer**(`config?`): `Promise`\<[`HallucinationScorer`](../classes/HallucinationScorer.md)\> -Defined in: [evaluation/scorers/llm/hallucinationScorer.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/hallucinationScorer.ts#L168) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createHealthRoutes.md b/docs/api/functions/createHealthRoutes.md index 1f3f29806..981e0a5e3 100644 --- a/docs/api/functions/createHealthRoutes.md +++ b/docs/api/functions/createHealthRoutes.md @@ -8,8 +8,6 @@ > **createHealthRoutes**(`basePath?`): [`RouteGroup`](../type-aliases/RouteGroup.md) -Defined in: [server/routes/healthRoutes.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/server/routes/healthRoutes.ts#L41) - Create health check routes ## Parameters diff --git a/docs/api/functions/createHybridSearch.md b/docs/api/functions/createHybridSearch.md index 8856f96dc..9f1f2922e 100644 --- a/docs/api/functions/createHybridSearch.md +++ b/docs/api/functions/createHybridSearch.md @@ -8,8 +8,6 @@ > **createHybridSearch**(`options`): (`query`, `config?`) => `Promise`\<[`HybridSearchResult`](../type-aliases/HybridSearchResult.md)[]\> -Defined in: [rag/retrieval/hybridSearch.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/hybridSearch.ts#L225) - Create a hybrid search function ## Parameters diff --git a/docs/api/functions/createInvertedScorer.md b/docs/api/functions/createInvertedScorer.md index 72c3028f4..ab84e35b8 100644 --- a/docs/api/functions/createInvertedScorer.md +++ b/docs/api/functions/createInvertedScorer.md @@ -8,8 +8,6 @@ > **createInvertedScorer**(`id`, `name`, `scorer`, `options?`): [`BaseScorer`](../classes/BaseScorer.md) -Defined in: [evaluation/scorers/customScorerUtils.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/customScorerUtils.ts#L557) - Create a scorer that inverts the score (10 - score) ## Parameters diff --git a/docs/api/functions/createJsonResource.md b/docs/api/functions/createJsonResource.md index 5f4ab7174..8e82f5039 100644 --- a/docs/api/functions/createJsonResource.md +++ b/docs/api/functions/createJsonResource.md @@ -8,8 +8,6 @@ > **createJsonResource**\<`T`\>(`uri`, `name`, `content`, `options?`): [`RegisteredResource`](../type-aliases/RegisteredResource.md) -Defined in: [mcp/serverCapabilities.ts:629](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L629) - Create a JSON resource ## Type Parameters diff --git a/docs/api/functions/createKeywordCoverageScorer.md b/docs/api/functions/createKeywordCoverageScorer.md index 812569f1d..735a7a86e 100644 --- a/docs/api/functions/createKeywordCoverageScorer.md +++ b/docs/api/functions/createKeywordCoverageScorer.md @@ -8,8 +8,6 @@ > **createKeywordCoverageScorer**(`config?`): `Promise`\<`KeywordCoverageScorer`\> -Defined in: [evaluation/scorers/rule/keywordCoverageScorer.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/keywordCoverageScorer.ts#L439) - Factory function for creating KeywordCoverageScorer instances ## Parameters diff --git a/docs/api/functions/createKeywordScorer.md b/docs/api/functions/createKeywordScorer.md index 79a29b23a..2ef8f9907 100644 --- a/docs/api/functions/createKeywordScorer.md +++ b/docs/api/functions/createKeywordScorer.md @@ -8,8 +8,6 @@ > **createKeywordScorer**(`id`, `name`, `options`): [`BaseScorer`](../classes/BaseScorer.md) -Defined in: [evaluation/scorers/customScorerUtils.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/customScorerUtils.ts#L238) - Create a keyword presence scorer ## Parameters diff --git a/docs/api/functions/createLangfuseAdapter.md b/docs/api/functions/createLangfuseAdapter.md index e40c1eab3..7666b2dfa 100644 --- a/docs/api/functions/createLangfuseAdapter.md +++ b/docs/api/functions/createLangfuseAdapter.md @@ -8,8 +8,6 @@ > **createLangfuseAdapter**(`config`): `LangfuseAdapter` -Defined in: [evaluation/hooks/langfuseAdapter.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/langfuseAdapter.ts#L188) - Create a Langfuse adapter ## Parameters diff --git a/docs/api/functions/createLengthScorer.md b/docs/api/functions/createLengthScorer.md index 2d58d5f5e..b39d9d330 100644 --- a/docs/api/functions/createLengthScorer.md +++ b/docs/api/functions/createLengthScorer.md @@ -8,8 +8,6 @@ > **createLengthScorer**(`config?`): `Promise`\<`LengthScorer`\> -Defined in: [evaluation/scorers/rule/lengthScorer.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/rule/lengthScorer.ts#L362) - Factory function for creating LengthScorer instances ## Parameters diff --git a/docs/api/functions/createLifecycleMiddleware.md b/docs/api/functions/createLifecycleMiddleware.md index 1ecd9bef1..05ba91102 100644 --- a/docs/api/functions/createLifecycleMiddleware.md +++ b/docs/api/functions/createLifecycleMiddleware.md @@ -8,8 +8,6 @@ > **createLifecycleMiddleware**(`config?`): [`NeuroLinkMiddleware`](../type-aliases/NeuroLinkMiddleware.md) -Defined in: [middleware/builtin/lifecycle.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/builtin/lifecycle.ts#L41) - ## Parameters ### config? diff --git a/docs/api/functions/createLocalUsageReader.md b/docs/api/functions/createLocalUsageReader.md index 366204477..2582de834 100644 --- a/docs/api/functions/createLocalUsageReader.md +++ b/docs/api/functions/createLocalUsageReader.md @@ -8,8 +8,6 @@ > **createLocalUsageReader**(`cliId`): `Promise`\<[`LocalUsageReader`](../type-aliases/LocalUsageReader.md)\> -Defined in: [localUsage/localUsageReaderRegistry.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/localUsage/localUsageReaderRegistry.ts#L34) - ## Parameters ### cliId diff --git a/docs/api/functions/createLoggingInterceptor.md b/docs/api/functions/createLoggingInterceptor.md index 78aae83f5..d129fa762 100644 --- a/docs/api/functions/createLoggingInterceptor.md +++ b/docs/api/functions/createLoggingInterceptor.md @@ -8,8 +8,6 @@ > **createLoggingInterceptor**(`options?`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L148) - Logging interceptor Logs request and response details for debugging. diff --git a/docs/api/functions/createLoggingMiddleware.md b/docs/api/functions/createLoggingMiddleware.md index 3d877ba07..9469e53f3 100644 --- a/docs/api/functions/createLoggingMiddleware.md +++ b/docs/api/functions/createLoggingMiddleware.md @@ -8,8 +8,6 @@ > **createLoggingMiddleware**(`options?`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/common.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/common.ts#L318) - Create request logging middleware Logs request and response information diff --git a/docs/api/functions/createMCPRoutes.md b/docs/api/functions/createMCPRoutes.md index b9abf56df..c2acb7bec 100644 --- a/docs/api/functions/createMCPRoutes.md +++ b/docs/api/functions/createMCPRoutes.md @@ -8,8 +8,6 @@ > **createMCPRoutes**(`basePath?`): [`RouteGroup`](../type-aliases/RouteGroup.md) -Defined in: [server/routes/mcpRoutes.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/server/routes/mcpRoutes.ts#L473) - Create MCP server management routes ## Parameters diff --git a/docs/api/functions/createMCPServer.md b/docs/api/functions/createMCPServer.md index 505732de0..05c0174b3 100644 --- a/docs/api/functions/createMCPServer.md +++ b/docs/api/functions/createMCPServer.md @@ -8,8 +8,6 @@ > **createMCPServer**(`config`): [`NeuroLinkMCPServer`](../type-aliases/NeuroLinkMCPServer.md) -Defined in: [mcp/factory.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/factory.ts#L76) - Create MCP Server Factory Function Core factory function for creating MCP servers. diff --git a/docs/api/functions/createMaxRetriesExceededError.md b/docs/api/functions/createMaxRetriesExceededError.md index 148136a81..f46edbfc2 100644 --- a/docs/api/functions/createMaxRetriesExceededError.md +++ b/docs/api/functions/createMaxRetriesExceededError.md @@ -8,8 +8,6 @@ > **createMaxRetriesExceededError**(`attempts`, `lastScore`, `threshold`, `context?`): [`NeuroLinkFeatureError`](../classes/NeuroLinkFeatureError.md) -Defined in: [evaluation/errors/EvaluationError.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L195) - Helper function to create a max retries exceeded error. ## Parameters diff --git a/docs/api/functions/createMemoryRoutes.md b/docs/api/functions/createMemoryRoutes.md index bfd46280b..76e373a95 100644 --- a/docs/api/functions/createMemoryRoutes.md +++ b/docs/api/functions/createMemoryRoutes.md @@ -8,8 +8,6 @@ > **createMemoryRoutes**(`basePath?`): [`RouteGroup`](../type-aliases/RouteGroup.md) -Defined in: [server/routes/memoryRoutes.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/server/routes/memoryRoutes.ts#L521) - Create memory management routes Note: These routes provide a simplified interface to conversation memory. The actual implementation depends on the memory manager type (ConversationMemoryManager or RedisConversationMemoryManager). diff --git a/docs/api/functions/createMetricsCollector.md b/docs/api/functions/createMetricsCollector.md index 6f88c2e20..1a95c932a 100644 --- a/docs/api/functions/createMetricsCollector.md +++ b/docs/api/functions/createMetricsCollector.md @@ -8,8 +8,6 @@ > **createMetricsCollector**(): [`MetricsCollector`](../classes/MetricsCollector.md) -Defined in: [evaluation/reporting/metricsCollector.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/metricsCollector.ts#L348) - Create a metrics collector ## Returns diff --git a/docs/api/functions/createMetricsCollectorHook.md b/docs/api/functions/createMetricsCollectorHook.md index add664142..feb3b37c9 100644 --- a/docs/api/functions/createMetricsCollectorHook.md +++ b/docs/api/functions/createMetricsCollectorHook.md @@ -8,8 +8,6 @@ > **createMetricsCollectorHook**(`collector`): `void` -Defined in: [evaluation/hooks/observabilityHooks.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L193) - Helper: Create a metrics collector hook Accepts the actual MetricsCollector interface from reporting/metricsCollector diff --git a/docs/api/functions/createMockLangfuseClient.md b/docs/api/functions/createMockLangfuseClient.md index c27d18ec0..1f88361f1 100644 --- a/docs/api/functions/createMockLangfuseClient.md +++ b/docs/api/functions/createMockLangfuseClient.md @@ -8,8 +8,6 @@ > **createMockLangfuseClient**(): [`LangfuseClient`](../type-aliases/LangfuseClient.md) & `object` -Defined in: [evaluation/hooks/langfuseAdapter.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/langfuseAdapter.ts#L208) - Helper: Create a mock Langfuse client for testing ## Returns diff --git a/docs/api/functions/createMultiAuthMiddleware.md b/docs/api/functions/createMultiAuthMiddleware.md index 3a68886e7..a321d18c4 100644 --- a/docs/api/functions/createMultiAuthMiddleware.md +++ b/docs/api/functions/createMultiAuthMiddleware.md @@ -8,8 +8,6 @@ > **createMultiAuthMiddleware**(`config`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/auth.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L389) - Create a multi-auth middleware that supports multiple authentication methods ## Parameters diff --git a/docs/api/functions/createMultiJudgeWorkflow.md b/docs/api/functions/createMultiJudgeWorkflow.md index dca43a668..2f8ee2bf4 100644 --- a/docs/api/functions/createMultiJudgeWorkflow.md +++ b/docs/api/functions/createMultiJudgeWorkflow.md @@ -8,8 +8,6 @@ > **createMultiJudgeWorkflow**(`modelCount`, `judgeCount`): [`WorkflowConfig`](../type-aliases/WorkflowConfig.md) -Defined in: [workflow/workflows/multiJudgeWorkflow.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/workflows/multiJudgeWorkflow.ts#L250) - Create custom multi-judge workflow ## Parameters diff --git a/docs/api/functions/createNDJSONHeaders.md b/docs/api/functions/createNDJSONHeaders.md index ffdb31635..5a06b2837 100644 --- a/docs/api/functions/createNDJSONHeaders.md +++ b/docs/api/functions/createNDJSONHeaders.md @@ -8,8 +8,6 @@ > **createNDJSONHeaders**(`additionalHeaders?`): `Record`\<`string`, `string`\> -Defined in: [server/streaming/dataStream.ts:421](https://github.com/juspay/neurolink/blob/release/src/lib/server/streaming/dataStream.ts#L421) - Create NDJSON headers for streaming responses ## Parameters diff --git a/docs/api/functions/createNeuroLinkModel.md b/docs/api/functions/createNeuroLinkModel.md index 10833ecbf..676700c91 100644 --- a/docs/api/functions/createNeuroLinkModel.md +++ b/docs/api/functions/createNeuroLinkModel.md @@ -8,8 +8,6 @@ > **createNeuroLinkModel**(`options`): [`NeuroLinkLanguageModel`](../classes/NeuroLinkLanguageModel.md) -Defined in: [client/aiSdkAdapter.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L460) - Create a standalone NeuroLink model for Vercel AI SDK ## Parameters diff --git a/docs/api/functions/createNeuroLinkProvider.md b/docs/api/functions/createNeuroLinkProvider.md index 6e9728093..ca42b9b56 100644 --- a/docs/api/functions/createNeuroLinkProvider.md +++ b/docs/api/functions/createNeuroLinkProvider.md @@ -8,8 +8,6 @@ > **createNeuroLinkProvider**(`options`): [`NeuroLinkAIProvider`](../classes/NeuroLinkAIProvider.md) & (`modelId?`, `modelOptions?`) => [`NeuroLinkLanguageModel`](../classes/NeuroLinkLanguageModel.md) -Defined in: [client/aiSdkAdapter.ts:412](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L412) - Create a NeuroLink provider for Vercel AI SDK ## Parameters diff --git a/docs/api/functions/createOAuthProviderFromConfig.md b/docs/api/functions/createOAuthProviderFromConfig.md index 6921853ee..9068d17e7 100644 --- a/docs/api/functions/createOAuthProviderFromConfig.md +++ b/docs/api/functions/createOAuthProviderFromConfig.md @@ -8,8 +8,6 @@ > **createOAuthProviderFromConfig**(`authConfig`, `storage?`): [`NeuroLinkOAuthProvider`](../classes/NeuroLinkOAuthProvider.md) -Defined in: [mcp/auth/oauthClientProvider.ts:426](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/oauthClientProvider.ts#L426) - Create an OAuth provider from MCP server auth configuration ## Parameters diff --git a/docs/api/functions/createOpenAPIGenerator.md b/docs/api/functions/createOpenAPIGenerator.md index b236b3c1a..12f7d2280 100644 --- a/docs/api/functions/createOpenAPIGenerator.md +++ b/docs/api/functions/createOpenAPIGenerator.md @@ -8,8 +8,6 @@ > **createOpenAPIGenerator**(`config?`): `OpenAPIGenerator` -Defined in: [server/openapi/generator.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/server/openapi/generator.ts#L535) - Create an OpenAPI generator with default configuration ## Parameters diff --git a/docs/api/functions/createParseError.md b/docs/api/functions/createParseError.md index f59d660c0..a02a9997f 100644 --- a/docs/api/functions/createParseError.md +++ b/docs/api/functions/createParseError.md @@ -8,8 +8,6 @@ > **createParseError**(`rawResponse`, `cause?`): [`NeuroLinkFeatureError`](../classes/NeuroLinkFeatureError.md) -Defined in: [evaluation/errors/EvaluationError.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L121) - Helper function to create a parse error with raw response. ## Parameters diff --git a/docs/api/functions/createPipeline.md b/docs/api/functions/createPipeline.md index b1d169c82..f4cef9843 100644 --- a/docs/api/functions/createPipeline.md +++ b/docs/api/functions/createPipeline.md @@ -8,8 +8,6 @@ > **createPipeline**(`config`): [`EvaluationPipeline`](../classes/EvaluationPipeline.md) -Defined in: [evaluation/pipeline/evaluationPipeline.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/evaluationPipeline.ts#L501) - Create a new evaluation pipeline ## Parameters diff --git a/docs/api/functions/createPrompt.md b/docs/api/functions/createPrompt.md index b18c1908d..f34ae9af2 100644 --- a/docs/api/functions/createPrompt.md +++ b/docs/api/functions/createPrompt.md @@ -8,8 +8,6 @@ > **createPrompt**(`name`, `template`, `options?`): [`RegisteredPrompt`](../type-aliases/RegisteredPrompt.md) -Defined in: [mcp/serverCapabilities.ts:659](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L659) - Create a simple prompt template ## Parameters diff --git a/docs/api/functions/createPromptAlignmentScorer.md b/docs/api/functions/createPromptAlignmentScorer.md index 3d7419cc4..c097ef301 100644 --- a/docs/api/functions/createPromptAlignmentScorer.md +++ b/docs/api/functions/createPromptAlignmentScorer.md @@ -8,8 +8,6 @@ > **createPromptAlignmentScorer**(`config?`): `Promise`\<[`PromptAlignmentScorer`](../classes/PromptAlignmentScorer.md)\> -Defined in: [evaluation/scorers/llm/promptAlignmentScorer.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/promptAlignmentScorer.ts#L129) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createProtectedMiddleware.md b/docs/api/functions/createProtectedMiddleware.md index 4b0d8ac7b..593c6906a 100644 --- a/docs/api/functions/createProtectedMiddleware.md +++ b/docs/api/functions/createProtectedMiddleware.md @@ -8,8 +8,6 @@ > **createProtectedMiddleware**(`config`): `Promise`\<[`AuthMiddlewareHandler`](../type-aliases/AuthMiddlewareHandler.md)\<[`AuthRequestContext`](../type-aliases/AuthRequestContext.md)\>\> -Defined in: [auth/middleware/AuthMiddleware.ts:546](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/AuthMiddleware.ts#L546) - Create combined auth + RBAC middleware Convenience function that combines authentication and authorization. diff --git a/docs/api/functions/createProviderError.md b/docs/api/functions/createProviderError.md index d97a4643d..8cfb78558 100644 --- a/docs/api/functions/createProviderError.md +++ b/docs/api/functions/createProviderError.md @@ -8,8 +8,6 @@ > **createProviderError**(`message`, `provider`, `cause?`, `options?`): [`NeuroLinkFeatureError`](../classes/NeuroLinkFeatureError.md) -Defined in: [evaluation/errors/EvaluationError.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L170) - Helper function to create a provider error. ## Parameters diff --git a/docs/api/functions/createRAGPipeline.md b/docs/api/functions/createRAGPipeline.md index 85c19f311..8e1788c5d 100644 --- a/docs/api/functions/createRAGPipeline.md +++ b/docs/api/functions/createRAGPipeline.md @@ -8,8 +8,6 @@ > **createRAGPipeline**(`options`): [`RAGPipeline`](../classes/RAGPipeline.md) -Defined in: [rag/pipeline/RAGPipeline.ts:1123](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/RAGPipeline.ts#L1123) - Create a simple RAG pipeline with sensible defaults ## Parameters diff --git a/docs/api/functions/createRBACMiddleware.md b/docs/api/functions/createRBACMiddleware.md index 8db6e1dfd..169794a74 100644 --- a/docs/api/functions/createRBACMiddleware.md +++ b/docs/api/functions/createRBACMiddleware.md @@ -8,8 +8,6 @@ > **createRBACMiddleware**(`config`): [`AuthMiddlewareHandler`](../type-aliases/AuthMiddlewareHandler.md)\<[`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md)\> -Defined in: [auth/middleware/AuthMiddleware.ts:351](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/AuthMiddleware.ts#L351) - Create RBAC (Role-Based Access Control) middleware Checks if authenticated user has required roles/permissions. diff --git a/docs/api/functions/createRateLimitByUserMiddleware.md b/docs/api/functions/createRateLimitByUserMiddleware.md index e6becd5bb..5d749ab3c 100644 --- a/docs/api/functions/createRateLimitByUserMiddleware.md +++ b/docs/api/functions/createRateLimitByUserMiddleware.md @@ -8,8 +8,6 @@ > **createRateLimitByUserMiddleware**(`config`, `storage?`): (`context`) => `Promise`\<[`RateLimitMiddlewareResult`](../type-aliases/RateLimitMiddlewareResult.md)\> -Defined in: [auth/middleware/rateLimitByUser.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L557) - Create rate limiting middleware for authenticated requests ## Parameters diff --git a/docs/api/functions/createRateLimitInterceptor.md b/docs/api/functions/createRateLimitInterceptor.md index 86c5b2d3b..78b12bb0a 100644 --- a/docs/api/functions/createRateLimitInterceptor.md +++ b/docs/api/functions/createRateLimitInterceptor.md @@ -8,8 +8,6 @@ > **createRateLimitInterceptor**(`options`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L435) - Rate limiting interceptor Limits the rate of requests to prevent overwhelming the API. diff --git a/docs/api/functions/createRateLimitMiddleware.md b/docs/api/functions/createRateLimitMiddleware.md index 0288c2c95..58da8c475 100644 --- a/docs/api/functions/createRateLimitMiddleware.md +++ b/docs/api/functions/createRateLimitMiddleware.md @@ -8,8 +8,6 @@ > **createRateLimitMiddleware**(`config`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/rateLimit.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L103) - Create rate limiting middleware Response headers set on all requests: diff --git a/docs/api/functions/createRateLimitStorage.md b/docs/api/functions/createRateLimitStorage.md index 7bda0d31d..abe24816e 100644 --- a/docs/api/functions/createRateLimitStorage.md +++ b/docs/api/functions/createRateLimitStorage.md @@ -8,8 +8,6 @@ > **createRateLimitStorage**(`config`): [`RateLimitStorage`](../type-aliases/RateLimitStorage.md) -Defined in: [auth/middleware/rateLimitByUser.ts:700](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/rateLimitByUser.ts#L700) - Create rate limit storage based on configuration ## Parameters diff --git a/docs/api/functions/createRegexScorer.md b/docs/api/functions/createRegexScorer.md index 75413b02f..268cfd5b4 100644 --- a/docs/api/functions/createRegexScorer.md +++ b/docs/api/functions/createRegexScorer.md @@ -8,8 +8,6 @@ > **createRegexScorer**(`id`, `name`, `options`): [`BaseScorer`](../classes/BaseScorer.md) -Defined in: [evaluation/scorers/customScorerUtils.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/customScorerUtils.ts#L136) - Create a regex-based scorer ## Parameters diff --git a/docs/api/functions/createReportGenerator.md b/docs/api/functions/createReportGenerator.md index 832b0889b..2e016d7b3 100644 --- a/docs/api/functions/createReportGenerator.md +++ b/docs/api/functions/createReportGenerator.md @@ -8,8 +8,6 @@ > **createReportGenerator**(`config?`): [`ReportGenerator`](../classes/ReportGenerator.md) -Defined in: [evaluation/reporting/reportGenerator.ts:427](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/reporting/reportGenerator.ts#L427) - Create a report generator ## Parameters diff --git a/docs/api/functions/createRequestBatcher.md b/docs/api/functions/createRequestBatcher.md index a400447c9..d497448ff 100644 --- a/docs/api/functions/createRequestBatcher.md +++ b/docs/api/functions/createRequestBatcher.md @@ -8,8 +8,6 @@ > **createRequestBatcher**\<`T`\>(`config`): [`RequestBatcher`](../classes/RequestBatcher.md)\<`T`\> -Defined in: [mcp/batching/requestBatcher.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L468) - Factory function to create a RequestBatcher instance ## Type Parameters diff --git a/docs/api/functions/createRequestContext.md b/docs/api/functions/createRequestContext.md index 932c5c176..3866f289a 100644 --- a/docs/api/functions/createRequestContext.md +++ b/docs/api/functions/createRequestContext.md @@ -8,8 +8,6 @@ > **createRequestContext**(`req`): [`AuthRequestContext`](../type-aliases/AuthRequestContext.md) -Defined in: [auth/middleware/AuthMiddleware.ts:630](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/AuthMiddleware.ts#L630) - Create request context from standard request object ## Parameters diff --git a/docs/api/functions/createRequestIdMiddleware.md b/docs/api/functions/createRequestIdMiddleware.md index 3c16980f6..8dd8839e6 100644 --- a/docs/api/functions/createRequestIdMiddleware.md +++ b/docs/api/functions/createRequestIdMiddleware.md @@ -8,8 +8,6 @@ > **createRequestIdMiddleware**(`options?`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/common.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/common.ts#L105) - Create request ID middleware Ensures every request has a unique ID diff --git a/docs/api/functions/createRequestTransformInterceptor.md b/docs/api/functions/createRequestTransformInterceptor.md index 9fc5a612b..6ae26e65a 100644 --- a/docs/api/functions/createRequestTransformInterceptor.md +++ b/docs/api/functions/createRequestTransformInterceptor.md @@ -8,8 +8,6 @@ > **createRequestTransformInterceptor**(`transform`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:472](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L472) - Request transformation interceptor Transform request before sending. diff --git a/docs/api/functions/createRequestValidationMiddleware.md b/docs/api/functions/createRequestValidationMiddleware.md index faa21bb74..aaf7620b0 100644 --- a/docs/api/functions/createRequestValidationMiddleware.md +++ b/docs/api/functions/createRequestValidationMiddleware.md @@ -8,8 +8,6 @@ > **createRequestValidationMiddleware**(`config`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/validation.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/validation.ts#L38) - Create request validation middleware ## Parameters diff --git a/docs/api/functions/createResponseTransformInterceptor.md b/docs/api/functions/createResponseTransformInterceptor.md index 1c553b915..1acecf4fb 100644 --- a/docs/api/functions/createResponseTransformInterceptor.md +++ b/docs/api/functions/createResponseTransformInterceptor.md @@ -8,8 +8,6 @@ > **createResponseTransformInterceptor**(`transform`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:499](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L499) - Response transformation interceptor Transform response before returning. diff --git a/docs/api/functions/createRetryInterceptor.md b/docs/api/functions/createRetryInterceptor.md index 447da921c..4d284e268 100644 --- a/docs/api/functions/createRetryInterceptor.md +++ b/docs/api/functions/createRetryInterceptor.md @@ -8,8 +8,6 @@ > **createRetryInterceptor**(`options`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L255) - Retry interceptor with exponential backoff Automatically retries failed requests with configurable backoff. diff --git a/docs/api/functions/createRetryMiddleware.md b/docs/api/functions/createRetryMiddleware.md index 28552b237..1e36a3ea8 100644 --- a/docs/api/functions/createRetryMiddleware.md +++ b/docs/api/functions/createRetryMiddleware.md @@ -8,8 +8,6 @@ > **createRetryMiddleware**(`maxRetries`, `delayMs?`): [`ToolMiddleware`](../type-aliases/ToolMiddleware.md) -Defined in: [mcp/toolIntegration.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L272) - Built-in middleware: Retry ## Parameters diff --git a/docs/api/functions/createRoleMiddleware.md b/docs/api/functions/createRoleMiddleware.md index 5a4b2b1c4..5eecaf71e 100644 --- a/docs/api/functions/createRoleMiddleware.md +++ b/docs/api/functions/createRoleMiddleware.md @@ -8,8 +8,6 @@ > **createRoleMiddleware**(`config`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/auth.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/auth.ts#L228) - Role-based access control middleware Use after authentication middleware diff --git a/docs/api/functions/createSSEHeaders.md b/docs/api/functions/createSSEHeaders.md index f153cd6e7..dd44d4c19 100644 --- a/docs/api/functions/createSSEHeaders.md +++ b/docs/api/functions/createSSEHeaders.md @@ -8,8 +8,6 @@ > **createSSEHeaders**(`additionalHeaders?`): `Record`\<`string`, `string`\> -Defined in: [server/streaming/dataStream.ts:406](https://github.com/juspay/neurolink/blob/release/src/lib/server/streaming/dataStream.ts#L406) - Create SSE headers for streaming responses ## Parameters diff --git a/docs/api/functions/createSamplingStrategy.md b/docs/api/functions/createSamplingStrategy.md index fa7b6525c..121dc33c3 100644 --- a/docs/api/functions/createSamplingStrategy.md +++ b/docs/api/functions/createSamplingStrategy.md @@ -8,8 +8,6 @@ > **createSamplingStrategy**(`config?`): [`SamplingStrategy`](../classes/SamplingStrategy.md) -Defined in: [evaluation/pipeline/strategies/samplingStrategy.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/samplingStrategy.ts#L257) - Create a sampling strategy ## Parameters diff --git a/docs/api/functions/createScorerMetadata.md b/docs/api/functions/createScorerMetadata.md index e13bb01d7..7a606ad2e 100644 --- a/docs/api/functions/createScorerMetadata.md +++ b/docs/api/functions/createScorerMetadata.md @@ -8,8 +8,6 @@ > **createScorerMetadata**(`id`, `name`, `options?`): [`ScorerMetadata`](../type-aliases/ScorerMetadata.md) -Defined in: [evaluation/scorers/customScorerUtils.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/customScorerUtils.ts#L22) - Create scorer metadata with defaults ## Parameters diff --git a/docs/api/functions/createSecurityHeadersMiddleware.md b/docs/api/functions/createSecurityHeadersMiddleware.md index 5af5b0d78..0d2940822 100644 --- a/docs/api/functions/createSecurityHeadersMiddleware.md +++ b/docs/api/functions/createSecurityHeadersMiddleware.md @@ -8,8 +8,6 @@ > **createSecurityHeadersMiddleware**(`options?`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/common.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/common.ts#L241) - Create security headers middleware Adds common security headers to responses diff --git a/docs/api/functions/createSelectRequest.md b/docs/api/functions/createSelectRequest.md index 47e3da6fb..ecd54dac7 100644 --- a/docs/api/functions/createSelectRequest.md +++ b/docs/api/functions/createSelectRequest.md @@ -8,8 +8,6 @@ > **createSelectRequest**(`message`, `selectOptions`, `options`): [`ElicitationRequestMessage`](../type-aliases/ElicitationRequestMessage.md) -Defined in: [mcp/elicitationProtocol.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L467) - Create protocol-compliant select request ## Parameters diff --git a/docs/api/functions/createServer.md b/docs/api/functions/createServer.md index 0a314fce3..73378bfdc 100644 --- a/docs/api/functions/createServer.md +++ b/docs/api/functions/createServer.md @@ -8,8 +8,6 @@ > **createServer**(`neurolink`, `options?`): `Promise`\<[`BaseServerAdapter`](../classes/BaseServerAdapter.md)\> -Defined in: [server/factory/serverAdapterFactory.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/server/factory/serverAdapterFactory.ts#L219) - Quick helper to create a server from NeuroLink instance ## Parameters diff --git a/docs/api/functions/createSessionStorage.md b/docs/api/functions/createSessionStorage.md index af96cd543..ecad0e489 100644 --- a/docs/api/functions/createSessionStorage.md +++ b/docs/api/functions/createSessionStorage.md @@ -8,8 +8,6 @@ > **createSessionStorage**(`config`): [`SessionManagerStorage`](../type-aliases/SessionManagerStorage.md) -Defined in: [auth/sessionManager.ts:629](https://github.com/juspay/neurolink/blob/release/src/lib/auth/sessionManager.ts#L629) - Create session storage based on configuration ## Parameters diff --git a/docs/api/functions/createSimpleLengthScorer.md b/docs/api/functions/createSimpleLengthScorer.md index e4dcbd29c..712056737 100644 --- a/docs/api/functions/createSimpleLengthScorer.md +++ b/docs/api/functions/createSimpleLengthScorer.md @@ -8,8 +8,6 @@ > **createSimpleLengthScorer**(`id`, `name`, `options`): [`BaseScorer`](../classes/BaseScorer.md) -Defined in: [evaluation/scorers/customScorerUtils.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/customScorerUtils.ts#L333) - Create a length-based scorer ## Parameters diff --git a/docs/api/functions/createSkillStore.md b/docs/api/functions/createSkillStore.md index fff367125..d9b5c8937 100644 --- a/docs/api/functions/createSkillStore.md +++ b/docs/api/functions/createSkillStore.md @@ -8,8 +8,6 @@ > **createSkillStore**(`config?`): [`SkillStore`](../type-aliases/SkillStore.md) -Defined in: [skills/skillStores.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillStores.ts#L376) - Resolve a storage config to a concrete store. Defaults to memory. ## Parameters diff --git a/docs/api/functions/createSkillTools.md b/docs/api/functions/createSkillTools.md index 9b56c3dc5..b43fe8b12 100644 --- a/docs/api/functions/createSkillTools.md +++ b/docs/api/functions/createSkillTools.md @@ -8,8 +8,6 @@ > **createSkillTools**(`resolveManager`, `options?`): `Record`\<`string`, [`Tool`](../type-aliases/Tool.md)\> -Defined in: [skills/skillTools.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/skills/skillTools.ts#L275) - Instance skill tools bound to a lazily-resolved manager: list_skills plus the gated mutation tools. Returns Vercel AI SDK tool() objects (description + Zod inputSchema + execute) keyed by tool name. diff --git a/docs/api/functions/createSlidingWindowRateLimitMiddleware.md b/docs/api/functions/createSlidingWindowRateLimitMiddleware.md index d623019ea..7050dcc66 100644 --- a/docs/api/functions/createSlidingWindowRateLimitMiddleware.md +++ b/docs/api/functions/createSlidingWindowRateLimitMiddleware.md @@ -8,8 +8,6 @@ > **createSlidingWindowRateLimitMiddleware**(`config`): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/rateLimit.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/rateLimit.ts#L172) - Create a sliding window rate limiter More accurate than fixed window but slightly more complex diff --git a/docs/api/functions/createStrategyNotFoundError.md b/docs/api/functions/createStrategyNotFoundError.md index a7958168f..7742b4503 100644 --- a/docs/api/functions/createStrategyNotFoundError.md +++ b/docs/api/functions/createStrategyNotFoundError.md @@ -8,8 +8,6 @@ > **createStrategyNotFoundError**(`strategyName`, `availableStrategies?`): [`NeuroLinkFeatureError`](../classes/NeuroLinkFeatureError.md) -Defined in: [evaluation/errors/EvaluationError.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L145) - Helper function to create a strategy not found error. ## Parameters diff --git a/docs/api/functions/createStreamingClient.md b/docs/api/functions/createStreamingClient.md index e44330a71..d1f2037be 100644 --- a/docs/api/functions/createStreamingClient.md +++ b/docs/api/functions/createStreamingClient.md @@ -8,8 +8,6 @@ > **createStreamingClient**(`config`): `object` -Defined in: [client/streamingClient.ts:815](https://github.com/juspay/neurolink/blob/release/src/lib/client/streamingClient.ts#L815) - Streaming Client Factory Creates streaming clients for real-time communication with NeuroLink API. diff --git a/docs/api/functions/createStreamingResponse.md b/docs/api/functions/createStreamingResponse.md index a43a70b85..927ff10fa 100644 --- a/docs/api/functions/createStreamingResponse.md +++ b/docs/api/functions/createStreamingResponse.md @@ -8,8 +8,6 @@ > **createStreamingResponse**(`options`): `Promise`\<`Response`\> -Defined in: [client/aiSdkAdapter.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/client/aiSdkAdapter.ts#L518) - Create an AI SDK compatible streaming response from NeuroLink stream ## Parameters diff --git a/docs/api/functions/createSummarizationScorer.md b/docs/api/functions/createSummarizationScorer.md index 3241728b6..f7e0f96aa 100644 --- a/docs/api/functions/createSummarizationScorer.md +++ b/docs/api/functions/createSummarizationScorer.md @@ -8,8 +8,6 @@ > **createSummarizationScorer**(`config?`): `Promise`\<[`SummarizationScorer`](../classes/SummarizationScorer.md)\> -Defined in: [evaluation/scorers/llm/summarizationScorer.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/summarizationScorer.ts#L141) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createTextInputRequest.md b/docs/api/functions/createTextInputRequest.md index a905304b6..82f7c920e 100644 --- a/docs/api/functions/createTextInputRequest.md +++ b/docs/api/functions/createTextInputRequest.md @@ -8,8 +8,6 @@ > **createTextInputRequest**(`message`, `options`): [`ElicitationRequestMessage`](../type-aliases/ElicitationRequestMessage.md) -Defined in: [mcp/elicitationProtocol.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L422) - Create protocol-compliant text input request ## Parameters diff --git a/docs/api/functions/createTextResource.md b/docs/api/functions/createTextResource.md index 1342e3944..90224c9e3 100644 --- a/docs/api/functions/createTextResource.md +++ b/docs/api/functions/createTextResource.md @@ -8,8 +8,6 @@ > **createTextResource**(`uri`, `name`, `content`, `options?`): [`RegisteredResource`](../type-aliases/RegisteredResource.md) -Defined in: [mcp/serverCapabilities.ts:603](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/serverCapabilities.ts#L603) - Create a simple text resource ## Parameters diff --git a/docs/api/functions/createTimeoutInterceptor.md b/docs/api/functions/createTimeoutInterceptor.md index 6e41c3958..76ef0926d 100644 --- a/docs/api/functions/createTimeoutInterceptor.md +++ b/docs/api/functions/createTimeoutInterceptor.md @@ -8,8 +8,6 @@ > **createTimeoutInterceptor**(`options`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/interceptors.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/client/interceptors.ts#L649) - Timeout interceptor Adds a timeout to requests. diff --git a/docs/api/functions/createTimeoutMiddleware.md b/docs/api/functions/createTimeoutMiddleware.md index cd43ec2ac..d602e6b10 100644 --- a/docs/api/functions/createTimeoutMiddleware.md +++ b/docs/api/functions/createTimeoutMiddleware.md @@ -8,8 +8,6 @@ > **createTimeoutMiddleware**(`timeoutMs`): [`ToolMiddleware`](../type-aliases/ToolMiddleware.md) -Defined in: [mcp/toolIntegration.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L259) - Built-in middleware: Timeout ## Parameters diff --git a/docs/api/functions/createTimingMiddleware.md b/docs/api/functions/createTimingMiddleware.md index c7c97e457..f0c474aba 100644 --- a/docs/api/functions/createTimingMiddleware.md +++ b/docs/api/functions/createTimingMiddleware.md @@ -8,8 +8,6 @@ > **createTimingMiddleware**(): [`MiddlewareDefinition`](../type-aliases/MiddlewareDefinition.md) -Defined in: [server/middleware/common.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/server/middleware/common.ts#L26) - Create request timing middleware Adds timing information to responses diff --git a/docs/api/functions/createTokenManagerMiddleware.md b/docs/api/functions/createTokenManagerMiddleware.md index 58ebd7ab4..510b6ffd6 100644 --- a/docs/api/functions/createTokenManagerMiddleware.md +++ b/docs/api/functions/createTokenManagerMiddleware.md @@ -8,8 +8,6 @@ > **createTokenManagerMiddleware**(`tokenManager`): [`ClientMiddleware`](../type-aliases/ClientMiddleware.md) -Defined in: [client/auth.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L326) - Create a dynamic authentication middleware with token manager ## Parameters diff --git a/docs/api/functions/createToneConsistencyScorer.md b/docs/api/functions/createToneConsistencyScorer.md index 6352400e1..b4441ca62 100644 --- a/docs/api/functions/createToneConsistencyScorer.md +++ b/docs/api/functions/createToneConsistencyScorer.md @@ -8,8 +8,6 @@ > **createToneConsistencyScorer**(`config?`): `Promise`\<[`ToneConsistencyScorer`](../classes/ToneConsistencyScorer.md)\> -Defined in: [evaluation/scorers/llm/toneConsistencyScorer.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toneConsistencyScorer.ts#L129) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createToolCache.md b/docs/api/functions/createToolCache.md index af1f756c8..bd836f8fe 100644 --- a/docs/api/functions/createToolCache.md +++ b/docs/api/functions/createToolCache.md @@ -8,8 +8,6 @@ > **createToolCache**\<`T`\>(`config`): [`ToolCache`](../classes/ToolCache.md)\<`T`\> -Defined in: [mcp/caching/toolCache.ts:496](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L496) - Factory function to create a ToolCache instance ## Type Parameters diff --git a/docs/api/functions/createToolCallBatcher.md b/docs/api/functions/createToolCallBatcher.md index 02228114e..4ed70bc16 100644 --- a/docs/api/functions/createToolCallBatcher.md +++ b/docs/api/functions/createToolCallBatcher.md @@ -8,8 +8,6 @@ > **createToolCallBatcher**(`config?`): [`ToolCallBatcher`](../classes/ToolCallBatcher.md) -Defined in: [mcp/batching/requestBatcher.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/batching/requestBatcher.ts#L596) - Create a tool call batcher instance ## Parameters diff --git a/docs/api/functions/createToolFromFunction.md b/docs/api/functions/createToolFromFunction.md index cb7514e8d..42ea0337f 100644 --- a/docs/api/functions/createToolFromFunction.md +++ b/docs/api/functions/createToolFromFunction.md @@ -8,8 +8,6 @@ > **createToolFromFunction**\<`TParams`\>(`name`, `description`, `fn`, `options?`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) -Defined in: [mcp/toolConverter.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L253) - Create a tool from a function with automatic schema inference ## Type Parameters diff --git a/docs/api/functions/createToolMiddlewareChain.md b/docs/api/functions/createToolMiddlewareChain.md index 6d48ee7eb..9e2a3a895 100644 --- a/docs/api/functions/createToolMiddlewareChain.md +++ b/docs/api/functions/createToolMiddlewareChain.md @@ -8,8 +8,6 @@ > **createToolMiddlewareChain**(`middlewares`): [`ToolMiddleware`](../type-aliases/ToolMiddleware.md) -Defined in: [mcp/toolIntegration.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L174) - Create a middleware chain for tool execution ## Parameters diff --git a/docs/api/functions/createToolResultCache.md b/docs/api/functions/createToolResultCache.md index 44fb77c8e..30ecead2b 100644 --- a/docs/api/functions/createToolResultCache.md +++ b/docs/api/functions/createToolResultCache.md @@ -8,8 +8,6 @@ > **createToolResultCache**(`config?`): [`ToolResultCache`](../classes/ToolResultCache.md) -Defined in: [mcp/caching/toolCache.ts:586](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/caching/toolCache.ts#L586) - Create a tool result cache instance ## Parameters diff --git a/docs/api/functions/createToolRouter.md b/docs/api/functions/createToolRouter.md index 71e0481cc..ac62927a3 100644 --- a/docs/api/functions/createToolRouter.md +++ b/docs/api/functions/createToolRouter.md @@ -8,8 +8,6 @@ > **createToolRouter**(`config`): [`ToolRouter`](../classes/ToolRouter.md) -Defined in: [mcp/routing/toolRouter.ts:530](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/routing/toolRouter.ts#L530) - Factory function to create a ToolRouter instance ## Parameters diff --git a/docs/api/functions/createToolRoutes.md b/docs/api/functions/createToolRoutes.md index e0b9bd9a7..6f8187109 100644 --- a/docs/api/functions/createToolRoutes.md +++ b/docs/api/functions/createToolRoutes.md @@ -8,8 +8,6 @@ > **createToolRoutes**(`basePath?`): [`RouteGroup`](../type-aliases/RouteGroup.md) -Defined in: [server/routes/toolRoutes.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/server/routes/toolRoutes.ts#L27) - Create tool routes ## Parameters diff --git a/docs/api/functions/createToxicityScorer.md b/docs/api/functions/createToxicityScorer.md index 89c168b6b..894048faf 100644 --- a/docs/api/functions/createToxicityScorer.md +++ b/docs/api/functions/createToxicityScorer.md @@ -8,8 +8,6 @@ > **createToxicityScorer**(`config?`): `Promise`\<[`ToxicityScorer`](../classes/ToxicityScorer.md)\> -Defined in: [evaluation/scorers/llm/toxicityScorer.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/scorers/llm/toxicityScorer.ts#L152) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/createVectorQueryTool.md b/docs/api/functions/createVectorQueryTool.md index 9fd261f92..19d6b7065 100644 --- a/docs/api/functions/createVectorQueryTool.md +++ b/docs/api/functions/createVectorQueryTool.md @@ -8,8 +8,6 @@ > **createVectorQueryTool**(`config`, `vectorStore`): `object` -Defined in: [rag/retrieval/vectorQueryTool.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/vectorQueryTool.ts#L32) - Creates a vector query tool for semantic search Follows NeuroLink's factory pattern diff --git a/docs/api/functions/decideSearchPlan.md b/docs/api/functions/decideSearchPlan.md index 89d1a759e..ea98a21d4 100644 --- a/docs/api/functions/decideSearchPlan.md +++ b/docs/api/functions/decideSearchPlan.md @@ -8,8 +8,6 @@ > **decideSearchPlan**(`query`, `decide`, `capabilities`): `Promise`\<[`SearchPlanResult`](../type-aliases/SearchPlanResult.md) \| `null`\> -Defined in: [rag/retrieval/searchDecision.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/searchDecision.ts#L60) - Ask how this particular query should be retrieved. Returns `null` when nothing should change — no decision provider, a failed diff --git a/docs/api/functions/decisionBooleanConfidence.md b/docs/api/functions/decisionBooleanConfidence.md index 61c58cf54..9c7092985 100644 --- a/docs/api/functions/decisionBooleanConfidence.md +++ b/docs/api/functions/decisionBooleanConfidence.md @@ -8,8 +8,6 @@ > **decisionBooleanConfidence**(`probability`): `number` -Defined in: [utils/decisionAnswers.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/utils/decisionAnswers.ts#L73) - A yes/no answer carries no confidence of its own, so certainty has to be inferred from how far the probability sits from a coin flip. 0.5 → 0, and 0 or 1 → 1. diff --git a/docs/api/functions/decisionKey.md b/docs/api/functions/decisionKey.md index 6b7ab9dc0..bd1c09657 100644 --- a/docs/api/functions/decisionKey.md +++ b/docs/api/functions/decisionKey.md @@ -8,8 +8,6 @@ > **decisionKey**(`namespace`, `index`): `string` -Defined in: [utils/decisionAnswers.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/utils/decisionAnswers.ts#L127) - Build a question id that survives a round trip. Question ids are the only thing tying an answer back to what it was asked diff --git a/docs/api/functions/decodeJWTPayload.md b/docs/api/functions/decodeJWTPayload.md index 376cbcdc2..8d6796446 100644 --- a/docs/api/functions/decodeJWTPayload.md +++ b/docs/api/functions/decodeJWTPayload.md @@ -8,8 +8,6 @@ > **decodeJWTPayload**(`token`): `Record`\<`string`, `unknown`\> -Defined in: [client/auth.ts:486](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L486) - Decode a JWT token payload without verification ## Parameters diff --git a/docs/api/functions/dedupeTools.md b/docs/api/functions/dedupeTools.md index feac24679..c7c2811af 100644 --- a/docs/api/functions/dedupeTools.md +++ b/docs/api/functions/dedupeTools.md @@ -8,8 +8,6 @@ > **dedupeTools**\<`T`\>(`tools`, `options`): [`ToolDedupResult`](../type-aliases/ToolDedupResult.md)\<`Record`\<`string`, `T`\>\> -Defined in: [core/toolDedup.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolDedup.ts#L157) - Collapse near-duplicate tools in a name→Tool record. When `options.enabled` is falsy (the default), returns the original record diff --git a/docs/api/functions/detectAndRedactPII.md b/docs/api/functions/detectAndRedactPII.md index df2b7680b..e78ec6c91 100644 --- a/docs/api/functions/detectAndRedactPII.md +++ b/docs/api/functions/detectAndRedactPII.md @@ -8,8 +8,6 @@ > **detectAndRedactPII**(`text`, `config`): `Promise`\<[`PiiDetectionResult`](../type-aliases/PiiDetectionResult.md)\> -Defined in: [utils/piiDetector.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/utils/piiDetector.ts#L169) - Detect and optionally redact PII from a text string. Detection runs per-field (each named segment scanned independently) so that diff --git a/docs/api/functions/detectImageMimeType.md b/docs/api/functions/detectImageMimeType.md index 8391da771..d2923dc4e 100644 --- a/docs/api/functions/detectImageMimeType.md +++ b/docs/api/functions/detectImageMimeType.md @@ -8,8 +8,6 @@ > **detectImageMimeType**(`buffer`): `string` -Defined in: [utils/imageDetection.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/utils/imageDetection.ts#L89) - Detect an image's MIME type from its magic bytes. Returns `image/png` for buffers that match no known signature (the safest neutral default for the Vertex image path). diff --git a/docs/api/functions/elicitationResponseToProtocol.md b/docs/api/functions/elicitationResponseToProtocol.md index e25659ffc..5fc4b7ffa 100644 --- a/docs/api/functions/elicitationResponseToProtocol.md +++ b/docs/api/functions/elicitationResponseToProtocol.md @@ -8,8 +8,6 @@ > **elicitationResponseToProtocol**(`response`): [`ElicitationResponseMessage`](../type-aliases/ElicitationResponseMessage.md) -Defined in: [mcp/elicitationProtocol.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L226) - Convert ElicitationResponse to protocol message ## Parameters diff --git a/docs/api/functions/enrichCandidate.md b/docs/api/functions/enrichCandidate.md index 781ad6bd7..b060aca7e 100644 --- a/docs/api/functions/enrichCandidate.md +++ b/docs/api/functions/enrichCandidate.md @@ -8,8 +8,6 @@ > **enrichCandidate**(`id`, `member`, `difficulty`, `registry?`): [`ClassifierCandidate`](../type-aliases/ClassifierCandidate.md) -Defined in: [routing/modelCatalog.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelCatalog.ts#L312) - Enrich a pool member into a classifier candidate, pulling registry metadata the member did not declare. diff --git a/docs/api/functions/estimateVideoTokens.md b/docs/api/functions/estimateVideoTokens.md index fb74e84fe..8fa6bb53f 100644 --- a/docs/api/functions/estimateVideoTokens.md +++ b/docs/api/functions/estimateVideoTokens.md @@ -8,8 +8,6 @@ > **estimateVideoTokens**(`options`): `number` -Defined in: [adapters/videoFormatSupport.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/videoFormatSupport.ts#L333) - Rough token cost of putting one video in front of one provider. Two quite different prices, because two quite different payloads: a native diff --git a/docs/api/functions/evaluateBatch.md b/docs/api/functions/evaluateBatch.md index 51c9df4d4..ac928463d 100644 --- a/docs/api/functions/evaluateBatch.md +++ b/docs/api/functions/evaluateBatch.md @@ -8,8 +8,6 @@ > **evaluateBatch**(`pipeline`, `inputs`, `config?`): `Promise`\<[`BatchEvaluationResult`](../type-aliases/BatchEvaluationResult.md)\> -Defined in: [evaluation/pipeline/strategies/batchStrategy.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/batchStrategy.ts#L228) - Evaluate a batch of inputs using a pipeline ## Parameters diff --git a/docs/api/functions/executeMCP.md b/docs/api/functions/executeMCP.md index 5a2b173a8..ad6de86ec 100644 --- a/docs/api/functions/executeMCP.md +++ b/docs/api/functions/executeMCP.md @@ -8,8 +8,6 @@ > **executeMCP**\<`T`\>(`_name`, `_config`, `_args`, `_context?`): `Promise`\<`T`\> -Defined in: [mcp/index.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/index.ts#L204) - Execute an MCP operation - simplified ## Type Parameters diff --git a/docs/api/functions/executeWithCircuitBreaker.md b/docs/api/functions/executeWithCircuitBreaker.md index 7f8a579ce..6f1cd9a0a 100644 --- a/docs/api/functions/executeWithCircuitBreaker.md +++ b/docs/api/functions/executeWithCircuitBreaker.md @@ -8,8 +8,6 @@ > **executeWithCircuitBreaker**\<`T`\>(`breakerName`, `operation`, `operationType?`, `config?`): `Promise`\<`T`\> -Defined in: [rag/resilience/CircuitBreaker.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L550) - Convenience function to execute with circuit breaker ## Type Parameters diff --git a/docs/api/functions/exposeAgentAsTool.md b/docs/api/functions/exposeAgentAsTool.md index 967b8aa80..c6f3861a0 100644 --- a/docs/api/functions/exposeAgentAsTool.md +++ b/docs/api/functions/exposeAgentAsTool.md @@ -8,8 +8,6 @@ > **exposeAgentAsTool**(`agent`, `options?`): [`ExposureResult`](../type-aliases/ExposureResult.md) -Defined in: [mcp/agentExposure.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L30) - Expose an agent as an MCP tool ## Parameters diff --git a/docs/api/functions/exposeAgentsAsTools.md b/docs/api/functions/exposeAgentsAsTools.md index 97da0d2c1..581ec22ad 100644 --- a/docs/api/functions/exposeAgentsAsTools.md +++ b/docs/api/functions/exposeAgentsAsTools.md @@ -8,8 +8,6 @@ > **exposeAgentsAsTools**(`agents`, `options?`): [`ExposureResult`](../type-aliases/ExposureResult.md)[] -Defined in: [mcp/agentExposure.ts:364](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L364) - Batch expose agents as MCP tools ## Parameters diff --git a/docs/api/functions/exposeWorkflowAsTool.md b/docs/api/functions/exposeWorkflowAsTool.md index 3fb23d85f..79ace7fe0 100644 --- a/docs/api/functions/exposeWorkflowAsTool.md +++ b/docs/api/functions/exposeWorkflowAsTool.md @@ -8,8 +8,6 @@ > **exposeWorkflowAsTool**(`workflow`, `options?`): [`ExposureResult`](../type-aliases/ExposureResult.md) -Defined in: [mcp/agentExposure.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L195) - Expose a workflow as an MCP tool ## Parameters diff --git a/docs/api/functions/exposeWorkflowsAsTools.md b/docs/api/functions/exposeWorkflowsAsTools.md index aae522e80..e86ae955e 100644 --- a/docs/api/functions/exposeWorkflowsAsTools.md +++ b/docs/api/functions/exposeWorkflowsAsTools.md @@ -8,8 +8,6 @@ > **exposeWorkflowsAsTools**(`workflows`, `options?`): [`ExposureResult`](../type-aliases/ExposureResult.md)[] -Defined in: [mcp/agentExposure.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/agentExposure.ts#L374) - Batch expose workflows as MCP tools ## Parameters diff --git a/docs/api/functions/extractMetadata.md b/docs/api/functions/extractMetadata.md index 1a02b11e8..8b8f0e3d4 100644 --- a/docs/api/functions/extractMetadata.md +++ b/docs/api/functions/extractMetadata.md @@ -8,8 +8,6 @@ > **extractMetadata**(`chunks`, `params`, `options?`): `Promise`\<[`ExtractionResult`](../type-aliases/ExtractionResult.md)[]\> -Defined in: [rag/metadata/metadataExtractor.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/rag/metadata/metadataExtractor.ts#L384) - Convenience function to extract metadata from chunks ## Parameters diff --git a/docs/api/functions/extractToken.md b/docs/api/functions/extractToken.md index 10b8ce3af..3a8eca6a1 100644 --- a/docs/api/functions/extractToken.md +++ b/docs/api/functions/extractToken.md @@ -8,8 +8,6 @@ > **extractToken**(`context`, `config?`): `Promise`\<`string` \| `null`\> -Defined in: [auth/middleware/AuthMiddleware.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/auth/middleware/AuthMiddleware.ts#L85) - Extract token from request context based on configuration ## Parameters diff --git a/docs/api/functions/filterToolsByAnnotations.md b/docs/api/functions/filterToolsByAnnotations.md index 6b8df1ddb..1ad638796 100644 --- a/docs/api/functions/filterToolsByAnnotations.md +++ b/docs/api/functions/filterToolsByAnnotations.md @@ -8,8 +8,6 @@ > **filterToolsByAnnotations**(`tools`, `predicate`): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/toolAnnotations.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L278) - Filter tools by annotation predicates ## Parameters diff --git a/docs/api/functions/flushOpenTelemetry.md b/docs/api/functions/flushOpenTelemetry.md index e96eb068f..5d833bd6d 100644 --- a/docs/api/functions/flushOpenTelemetry.md +++ b/docs/api/functions/flushOpenTelemetry.md @@ -8,8 +8,6 @@ > **flushOpenTelemetry**(): `Promise`\<`void`\> -Defined in: [services/server/ai/observability/instrumentation.ts:1145](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1145) - Flush all pending spans to Langfuse ## Returns diff --git a/docs/api/functions/formatContextWithCitations.md b/docs/api/functions/formatContextWithCitations.md index b266d05ec..30d861f53 100644 --- a/docs/api/functions/formatContextWithCitations.md +++ b/docs/api/functions/formatContextWithCitations.md @@ -8,8 +8,6 @@ > **formatContextWithCitations**(`results`, `options?`): `object` -Defined in: [rag/pipeline/contextAssembly.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/contextAssembly.ts#L168) - Format context with inline citations ## Parameters diff --git a/docs/api/functions/gateDecisionBoolean.md b/docs/api/functions/gateDecisionBoolean.md index 8eb920eaa..65f89c08a 100644 --- a/docs/api/functions/gateDecisionBoolean.md +++ b/docs/api/functions/gateDecisionBoolean.md @@ -8,8 +8,6 @@ > **gateDecisionBoolean**(`answers`, `id`, `gate?`): `boolean` \| `undefined` -Defined in: [utils/decisionAnswers.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/utils/decisionAnswers.ts#L99) - Read a yes/no answer as an actionable decision, or `undefined` when there is not enough signal to act. diff --git a/docs/api/functions/generateOpenAPIFromConfig.md b/docs/api/functions/generateOpenAPIFromConfig.md index f8433b0b7..e60a0a9a3 100644 --- a/docs/api/functions/generateOpenAPIFromConfig.md +++ b/docs/api/functions/generateOpenAPIFromConfig.md @@ -8,8 +8,6 @@ > **generateOpenAPIFromConfig**(`serverConfig`, `routes?`): [`OpenAPISpec`](../type-aliases/OpenAPISpec.md) -Defined in: [server/openapi/generator.ts:556](https://github.com/juspay/neurolink/blob/release/src/lib/server/openapi/generator.ts#L556) - Generate OpenAPI spec from server adapter configuration ## Parameters diff --git a/docs/api/functions/generateOpenAPISpec.md b/docs/api/functions/generateOpenAPISpec.md index 947476fdd..8e081948e 100644 --- a/docs/api/functions/generateOpenAPISpec.md +++ b/docs/api/functions/generateOpenAPISpec.md @@ -8,8 +8,6 @@ > **generateOpenAPISpec**(`routes`, `config?`): [`OpenAPISpec`](../type-aliases/OpenAPISpec.md) -Defined in: [server/openapi/generator.ts:544](https://github.com/juspay/neurolink/blob/release/src/lib/server/openapi/generator.ts#L544) - Generate OpenAPI spec from routes ## Parameters diff --git a/docs/api/functions/generateSummaryStats.md b/docs/api/functions/generateSummaryStats.md index 5560300ff..2d4b37d21 100644 --- a/docs/api/functions/generateSummaryStats.md +++ b/docs/api/functions/generateSummaryStats.md @@ -8,8 +8,6 @@ > **generateSummaryStats**(`results`): [`SummaryStats`](../type-aliases/SummaryStats.md) -Defined in: [workflow/utils/workflowMetrics.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/utils/workflowMetrics.ts#L307) - Generate summary statistics for multiple executions ## Parameters diff --git a/docs/api/functions/generateText.md b/docs/api/functions/generateText.md index 4b3558289..a4cb6103f 100644 --- a/docs/api/functions/generateText.md +++ b/docs/api/functions/generateText.md @@ -8,8 +8,6 @@ > **generateText**(`options`): `Promise`\<[`TextGenerationResult`](../type-aliases/TextGenerationResult.md)\> -Defined in: [index.ts:1009](https://github.com/juspay/neurolink/blob/release/src/lib/index.ts#L1009) - Legacy generateText function for backward compatibility. Provides standalone text generation function for existing code. diff --git a/docs/api/functions/getAllWellKnownServers.md b/docs/api/functions/getAllWellKnownServers.md index 0e2cffe3b..47b0bccd6 100644 --- a/docs/api/functions/getAllWellKnownServers.md +++ b/docs/api/functions/getAllWellKnownServers.md @@ -8,8 +8,6 @@ > **getAllWellKnownServers**(): [`McpRegistryEntry`](../type-aliases/McpRegistryEntry.md)[] -Defined in: [mcp/mcpRegistryClient.ts:578](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L578) - Get all well-known servers ## Returns diff --git a/docs/api/functions/getAnalyticsMetrics.md b/docs/api/functions/getAnalyticsMetrics.md index f84e2ad11..4cb1010c4 100644 --- a/docs/api/functions/getAnalyticsMetrics.md +++ b/docs/api/functions/getAnalyticsMetrics.md @@ -8,8 +8,6 @@ > **getAnalyticsMetrics**(): `Map`\<`string`, `Record`\<`string`, `unknown`\>\> -Defined in: [middleware/builtin/analytics.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/middleware/builtin/analytics.ts#L146) - Get collected metrics from analytics middleware Note: This is a utility function for accessing metrics diff --git a/docs/api/functions/getAnnotationSummary.md b/docs/api/functions/getAnnotationSummary.md index 2a82b5cf7..acc00e164 100644 --- a/docs/api/functions/getAnnotationSummary.md +++ b/docs/api/functions/getAnnotationSummary.md @@ -8,8 +8,6 @@ > **getAnnotationSummary**(`annotations`): `string` -Defined in: [mcp/toolAnnotations.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L291) - Get human-readable summary of tool annotations ## Parameters diff --git a/docs/api/functions/getApiKeyFromEnv.md b/docs/api/functions/getApiKeyFromEnv.md index 2b9f9eff3..fde7ce6a3 100644 --- a/docs/api/functions/getApiKeyFromEnv.md +++ b/docs/api/functions/getApiKeyFromEnv.md @@ -8,8 +8,6 @@ > **getApiKeyFromEnv**(`envVar`, `options?`): `string` \| `undefined` -Defined in: [client/auth.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L551) - Create an API key from environment variable with validation ## Parameters diff --git a/docs/api/functions/getAuthContext.md b/docs/api/functions/getAuthContext.md index 8f1b08891..73ed7d70f 100644 --- a/docs/api/functions/getAuthContext.md +++ b/docs/api/functions/getAuthContext.md @@ -8,8 +8,6 @@ > **getAuthContext**(): [`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md) \| `undefined` -Defined in: [auth/authContext.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L63) - Get the current authentication context Returns the authenticated context for the current request, diff --git a/docs/api/functions/getAvailableProviders.md b/docs/api/functions/getAvailableProviders.md index 9c207162e..b898d9da8 100644 --- a/docs/api/functions/getAvailableProviders.md +++ b/docs/api/functions/getAvailableProviders.md @@ -8,8 +8,6 @@ > **getAvailableProviders**(): `string`[] -Defined in: [utils/providerUtils.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/utils/providerUtils.ts#L460) - Get available provider names ## Returns diff --git a/docs/api/functions/getAvailableStrategies.md b/docs/api/functions/getAvailableStrategies.md index 7bdc311f3..582a7ea3a 100644 --- a/docs/api/functions/getAvailableStrategies.md +++ b/docs/api/functions/getAvailableStrategies.md @@ -8,8 +8,6 @@ > **getAvailableStrategies**(): [`ChunkingStrategy`](../type-aliases/ChunkingStrategy.md)[] -Defined in: [rag/index.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/rag/index.ts#L250) - Get available chunking strategies ## Returns diff --git a/docs/api/functions/getBestProvider.md b/docs/api/functions/getBestProvider.md index 79ebc1e14..b372361b5 100644 --- a/docs/api/functions/getBestProvider.md +++ b/docs/api/functions/getBestProvider.md @@ -8,8 +8,6 @@ > **getBestProvider**(`requestedProvider?`): `Promise`\<`string`\> -Defined in: [utils/providerUtils.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/utils/providerUtils.ts#L30) - Get the best available provider based on real-time availability checks Enhanced version consolidated from providerUtils-fixed.ts diff --git a/docs/api/functions/getCircuitBreaker.md b/docs/api/functions/getCircuitBreaker.md index 9844713ea..bc79a31ef 100644 --- a/docs/api/functions/getCircuitBreaker.md +++ b/docs/api/functions/getCircuitBreaker.md @@ -8,8 +8,6 @@ > **getCircuitBreaker**(`name`, `config?`): [`RAGCircuitBreaker`](../classes/RAGCircuitBreaker.md) -Defined in: [rag/resilience/CircuitBreaker.ts:540](https://github.com/juspay/neurolink/blob/release/src/lib/rag/resilience/CircuitBreaker.ts#L540) - Convenience function to get a circuit breaker ## Parameters diff --git a/docs/api/functions/getCurrentSession.md b/docs/api/functions/getCurrentSession.md index 38ed5f88e..9dfefec02 100644 --- a/docs/api/functions/getCurrentSession.md +++ b/docs/api/functions/getCurrentSession.md @@ -8,8 +8,6 @@ > **getCurrentSession**(): [`AuthSession`](../type-aliases/AuthSession.md) \| `undefined` -Defined in: [auth/authContext.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L93) - Get the current session Convenience function to get just the session from context. diff --git a/docs/api/functions/getCurrentUser.md b/docs/api/functions/getCurrentUser.md index b49b530b9..e91e1f093 100644 --- a/docs/api/functions/getCurrentUser.md +++ b/docs/api/functions/getCurrentUser.md @@ -8,8 +8,6 @@ > **getCurrentUser**(): [`AuthUser`](../type-aliases/AuthUser.md) \| `undefined` -Defined in: [auth/authContext.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L82) - Get the current authenticated user Convenience function to get just the user from context. diff --git a/docs/api/functions/getDefaultChunkerConfig.md b/docs/api/functions/getDefaultChunkerConfig.md index 9e35f42a3..1a1fb5f6e 100644 --- a/docs/api/functions/getDefaultChunkerConfig.md +++ b/docs/api/functions/getDefaultChunkerConfig.md @@ -8,8 +8,6 @@ > **getDefaultChunkerConfig**(`strategy`): `Record`\<`string`, `unknown`\> -Defined in: [rag/index.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/rag/index.ts#L260) - Get default configuration for a chunking strategy ## Parameters diff --git a/docs/api/functions/getErrorMessage.md b/docs/api/functions/getErrorMessage.md index d1fbff2cf..8545fedb5 100644 --- a/docs/api/functions/getErrorMessage.md +++ b/docs/api/functions/getErrorMessage.md @@ -8,8 +8,6 @@ > **getErrorMessage**(`error`): `string` -Defined in: [types/common.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L126) - Safe error message extraction ## Parameters diff --git a/docs/api/functions/getEvaluatorFactory.md b/docs/api/functions/getEvaluatorFactory.md index 67219752b..b7136da74 100644 --- a/docs/api/functions/getEvaluatorFactory.md +++ b/docs/api/functions/getEvaluatorFactory.md @@ -8,8 +8,6 @@ > **getEvaluatorFactory**(): [`EvaluatorFactory`](../classes/EvaluatorFactory.md) -Defined in: [evaluation/EvaluatorFactory.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorFactory.ts#L373) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/getEvaluatorRegistry.md b/docs/api/functions/getEvaluatorRegistry.md index 851c9ee15..fac0e4691 100644 --- a/docs/api/functions/getEvaluatorRegistry.md +++ b/docs/api/functions/getEvaluatorRegistry.md @@ -8,8 +8,6 @@ > **getEvaluatorRegistry**(): `EvaluatorRegistry` -Defined in: [evaluation/EvaluatorRegistry.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/EvaluatorRegistry.ts#L245) - Evaluation System Exports A comprehensive evaluation framework for assessing AI response quality, diff --git a/docs/api/functions/getJWTExpiry.md b/docs/api/functions/getJWTExpiry.md index 73674c97d..26752fed3 100644 --- a/docs/api/functions/getJWTExpiry.md +++ b/docs/api/functions/getJWTExpiry.md @@ -8,8 +8,6 @@ > **getJWTExpiry**(`token`): `number` \| `null` -Defined in: [client/auth.ts:529](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L529) - Extract expiry time from a JWT token ## Parameters diff --git a/docs/api/functions/getLangfuseContext.md b/docs/api/functions/getLangfuseContext.md index 1d2d77915..329ecd32d 100644 --- a/docs/api/functions/getLangfuseContext.md +++ b/docs/api/functions/getLangfuseContext.md @@ -8,8 +8,6 @@ > **getLangfuseContext**(): [`LangfuseContext`](../type-aliases/LangfuseContext.md) \| `undefined` -Defined in: [services/server/ai/observability/instrumentation.ts:1442](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1442) - Get the current Langfuse context from AsyncLocalStorage Returns the current context including userId, sessionId, conversationId, diff --git a/docs/api/functions/getLangfuseHealthStatus.md b/docs/api/functions/getLangfuseHealthStatus.md index bd9820387..bf0ea6c83 100644 --- a/docs/api/functions/getLangfuseHealthStatus.md +++ b/docs/api/functions/getLangfuseHealthStatus.md @@ -8,8 +8,6 @@ > **getLangfuseHealthStatus**(): `object` -Defined in: [services/server/ai/observability/instrumentation.ts:1307](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1307) - Get health status for Langfuse observability ## Returns diff --git a/docs/api/functions/getLangfuseSpanProcessor.md b/docs/api/functions/getLangfuseSpanProcessor.md index af32e1c78..8533687e1 100644 --- a/docs/api/functions/getLangfuseSpanProcessor.md +++ b/docs/api/functions/getLangfuseSpanProcessor.md @@ -8,8 +8,6 @@ > **getLangfuseSpanProcessor**(): `SpanProcessor` \| `null` -Defined in: [services/server/ai/observability/instrumentation.ts:1276](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1276) - Get the Langfuse span processor ## Returns diff --git a/docs/api/functions/getLocalUsageDescriptors.md b/docs/api/functions/getLocalUsageDescriptors.md index ffe7444e2..f3a7989f1 100644 --- a/docs/api/functions/getLocalUsageDescriptors.md +++ b/docs/api/functions/getLocalUsageDescriptors.md @@ -8,8 +8,6 @@ > **getLocalUsageDescriptors**(): [`LocalUsageReaderDescriptor`](../type-aliases/LocalUsageReaderDescriptor.md)[] -Defined in: [localUsage/localUsageReaderRegistry.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/localUsage/localUsageReaderRegistry.ts#L26) - ## Returns [`LocalUsageReaderDescriptor`](../type-aliases/LocalUsageReaderDescriptor.md)[] diff --git a/docs/api/functions/getMCPStats.md b/docs/api/functions/getMCPStats.md index e5f360091..8a5d9c539 100644 --- a/docs/api/functions/getMCPStats.md +++ b/docs/api/functions/getMCPStats.md @@ -8,8 +8,6 @@ > **getMCPStats**(): `Promise`\<\{ `initialized`: `boolean`; `pluginsDiscovered`: `number`; `pluginsBySource`: `Record`\<`string`, `number`\>; `availablePlugins`: `string`[]; \}\> -Defined in: [mcp/index.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/index.ts#L222) - Get MCP ecosystem statistics - simplified ## Returns diff --git a/docs/api/functions/getMetricsAggregator.md b/docs/api/functions/getMetricsAggregator.md index 54eaa847f..dd79bde6f 100644 --- a/docs/api/functions/getMetricsAggregator.md +++ b/docs/api/functions/getMetricsAggregator.md @@ -8,8 +8,6 @@ > **getMetricsAggregator**(): [`MetricsAggregator`](../classes/MetricsAggregator.md) -Defined in: [observability/metricsAggregator.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L631) - Get the global metrics aggregator instance ## Returns diff --git a/docs/api/functions/getPoolStats.md b/docs/api/functions/getPoolStats.md index 5f62040fd..e7ab35292 100644 --- a/docs/api/functions/getPoolStats.md +++ b/docs/api/functions/getPoolStats.md @@ -8,8 +8,6 @@ > **getPoolStats**(): `object`[] -Defined in: [utils/redis.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/utils/redis.ts#L192) - Get stats about the connection pool ## Returns diff --git a/docs/api/functions/getPreset.md b/docs/api/functions/getPreset.md index 867b3fad4..7eacfe12b 100644 --- a/docs/api/functions/getPreset.md +++ b/docs/api/functions/getPreset.md @@ -8,8 +8,6 @@ > **getPreset**(`name`): [`PipelineConfig`](../type-aliases/PipelineConfig.md) -Defined in: [evaluation/pipeline/presets.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/presets.ts#L228) - Get a preset pipeline configuration by name ## Parameters diff --git a/docs/api/functions/getPresetNames.md b/docs/api/functions/getPresetNames.md index 148cdf92f..aeb531184 100644 --- a/docs/api/functions/getPresetNames.md +++ b/docs/api/functions/getPresetNames.md @@ -8,8 +8,6 @@ > **getPresetNames**(): `string`[] -Defined in: [evaluation/pipeline/presets.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/presets.ts#L235) - Get all available preset names ## Returns diff --git a/docs/api/functions/getRecommendedStrategy.md b/docs/api/functions/getRecommendedStrategy.md index 6fd4268f4..08316de44 100644 --- a/docs/api/functions/getRecommendedStrategy.md +++ b/docs/api/functions/getRecommendedStrategy.md @@ -8,8 +8,6 @@ > **getRecommendedStrategy**(`contentType`): [`ChunkingStrategy`](../type-aliases/ChunkingStrategy.md) -Defined in: [rag/index.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/rag/index.ts#L241) - Get recommended chunking strategy based on content type ## Parameters diff --git a/docs/api/functions/getRegisteredLocalUsageCliIds.md b/docs/api/functions/getRegisteredLocalUsageCliIds.md index c25455348..df28ec18a 100644 --- a/docs/api/functions/getRegisteredLocalUsageCliIds.md +++ b/docs/api/functions/getRegisteredLocalUsageCliIds.md @@ -8,8 +8,6 @@ > **getRegisteredLocalUsageCliIds**(): [`LocalUsageCliId`](../type-aliases/LocalUsageCliId.md)[] -Defined in: [localUsage/localUsageReaderRegistry.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/localUsage/localUsageReaderRegistry.ts#L30) - ## Returns [`LocalUsageCliId`](../type-aliases/LocalUsageCliId.md)[] diff --git a/docs/api/functions/getServerInfo.md b/docs/api/functions/getServerInfo.md index 36beccf77..0a90b19a2 100644 --- a/docs/api/functions/getServerInfo.md +++ b/docs/api/functions/getServerInfo.md @@ -8,8 +8,6 @@ > **getServerInfo**(`server`): `object` -Defined in: [mcp/factory.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/factory.ts#L156) - Utility function to get server info ## Parameters diff --git a/docs/api/functions/getSpanProcessors.md b/docs/api/functions/getSpanProcessors.md index 5ada61a57..6c385ddf5 100644 --- a/docs/api/functions/getSpanProcessors.md +++ b/docs/api/functions/getSpanProcessors.md @@ -8,8 +8,6 @@ > **getSpanProcessors**(): `SpanProcessor`[] -Defined in: [services/server/ai/observability/instrumentation.ts:1574](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1574) - Get all span processors that NeuroLink would use Convenience function that returns [ContextEnricher, LangfuseSpanProcessor] diff --git a/docs/api/functions/getTelemetryStatus.md b/docs/api/functions/getTelemetryStatus.md index bb39c4611..87cc78da3 100644 --- a/docs/api/functions/getTelemetryStatus.md +++ b/docs/api/functions/getTelemetryStatus.md @@ -8,8 +8,6 @@ > **getTelemetryStatus**(): `Promise`\<\{ `enabled`: `boolean`; `initialized`: `boolean`; `endpoint?`: `string`; `service?`: `string`; `version?`: `string`; \}\> -Defined in: [index.ts:799](https://github.com/juspay/neurolink/blob/release/src/lib/index.ts#L799) - ## Returns `Promise`\<\{ `enabled`: `boolean`; `initialized`: `boolean`; `endpoint?`: `string`; `service?`: `string`; `version?`: `string`; \}\> diff --git a/docs/api/functions/getToolSafetyLevel.md b/docs/api/functions/getToolSafetyLevel.md index 03962ccf6..3d14f2f24 100644 --- a/docs/api/functions/getToolSafetyLevel.md +++ b/docs/api/functions/getToolSafetyLevel.md @@ -8,8 +8,6 @@ > **getToolSafetyLevel**(`tool`): `"safe"` \| `"moderate"` \| `"dangerous"` -Defined in: [mcp/toolAnnotations.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L256) - Get tool safety level based on annotations ## Parameters diff --git a/docs/api/functions/getTracer.md b/docs/api/functions/getTracer.md index 453bc0123..ce75af3b8 100644 --- a/docs/api/functions/getTracer.md +++ b/docs/api/functions/getTracer.md @@ -8,8 +8,6 @@ > **getTracer**(`name?`, `version?`): `Tracer` -Defined in: [services/server/ai/observability/instrumentation.ts:1551](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1551) - Get an OpenTelemetry Tracer for creating custom spans This allows applications to create their own spans that will be diff --git a/docs/api/functions/getTracerProvider.md b/docs/api/functions/getTracerProvider.md index 798801204..a85c43d8a 100644 --- a/docs/api/functions/getTracerProvider.md +++ b/docs/api/functions/getTracerProvider.md @@ -8,8 +8,6 @@ > **getTracerProvider**(): `NodeTracerProvider` \| `null` -Defined in: [services/server/ai/observability/instrumentation.ts:1283](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1283) - Get the tracer provider ## Returns diff --git a/docs/api/functions/getVideoProviderConfig.md b/docs/api/functions/getVideoProviderConfig.md index bd272936b..e4d2f2e36 100644 --- a/docs/api/functions/getVideoProviderConfig.md +++ b/docs/api/functions/getVideoProviderConfig.md @@ -8,8 +8,6 @@ > **getVideoProviderConfig**(`provider`, `model?`): [`VideoProviderConfig`](../type-aliases/VideoProviderConfig.md) \| `null` -Defined in: [adapters/videoFormatSupport.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/videoFormatSupport.ts#L292) - The video-handling row for `provider`, or null when there is none. Null means "not described here", which is not the same as "takes frames": diff --git a/docs/api/functions/getWellKnownServer.md b/docs/api/functions/getWellKnownServer.md index b624f04c3..4fcbd0f73 100644 --- a/docs/api/functions/getWellKnownServer.md +++ b/docs/api/functions/getWellKnownServer.md @@ -8,8 +8,6 @@ > **getWellKnownServer**(`id`): [`McpRegistryEntry`](../type-aliases/McpRegistryEntry.md) \| `undefined` -Defined in: [mcp/mcpRegistryClient.ts:571](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/mcpRegistryClient.ts#L571) - Quick lookup function for well-known servers ## Parameters diff --git a/docs/api/functions/getWorkflow.md b/docs/api/functions/getWorkflow.md index b5c730080..5e5b86958 100644 --- a/docs/api/functions/getWorkflow.md +++ b/docs/api/functions/getWorkflow.md @@ -8,8 +8,6 @@ > **getWorkflow**(`workflowId`): [`WorkflowConfig`](../type-aliases/WorkflowConfig.md) \| `undefined` -Defined in: [workflow/core/workflowRegistry.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/core/workflowRegistry.ts#L125) - Get workflow configuration by ID ## Parameters diff --git a/docs/api/functions/hasAllPermissions.md b/docs/api/functions/hasAllPermissions.md index 7c1753b6f..a91aec549 100644 --- a/docs/api/functions/hasAllPermissions.md +++ b/docs/api/functions/hasAllPermissions.md @@ -8,8 +8,6 @@ > **hasAllPermissions**(`permissions`): `boolean` -Defined in: [auth/authContext.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L213) - Check if current user has all permissions ## Parameters diff --git a/docs/api/functions/hasAnyRole.md b/docs/api/functions/hasAnyRole.md index d85fa94c1..1d05b9d9d 100644 --- a/docs/api/functions/hasAnyRole.md +++ b/docs/api/functions/hasAnyRole.md @@ -8,8 +8,6 @@ > **hasAnyRole**(`roles`): `boolean` -Defined in: [auth/authContext.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L199) - Check if current user has any of the roles ## Parameters diff --git a/docs/api/functions/hasPermission.md b/docs/api/functions/hasPermission.md index 7ebf43e09..513fab4a1 100644 --- a/docs/api/functions/hasPermission.md +++ b/docs/api/functions/hasPermission.md @@ -8,8 +8,6 @@ > **hasPermission**(`permission`): `boolean` -Defined in: [auth/authContext.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L154) - Check if current user has a permission ## Parameters diff --git a/docs/api/functions/hasPricing.md b/docs/api/functions/hasPricing.md index 549cfcafe..c7ce5f22d 100644 --- a/docs/api/functions/hasPricing.md +++ b/docs/api/functions/hasPricing.md @@ -8,8 +8,6 @@ > **hasPricing**(`provider`, `model`): `boolean` -Defined in: [utils/pricing.ts:1094](https://github.com/juspay/neurolink/blob/release/src/lib/utils/pricing.ts#L1094) - ## Parameters ### provider diff --git a/docs/api/functions/hasRole.md b/docs/api/functions/hasRole.md index 3671ae8fb..a9b63580e 100644 --- a/docs/api/functions/hasRole.md +++ b/docs/api/functions/hasRole.md @@ -8,8 +8,6 @@ > **hasRole**(`role`): `boolean` -Defined in: [auth/authContext.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L188) - Check if current user has a role ## Parameters diff --git a/docs/api/functions/inferAnnotations.md b/docs/api/functions/inferAnnotations.md index 07bb722ca..0aab25824 100644 --- a/docs/api/functions/inferAnnotations.md +++ b/docs/api/functions/inferAnnotations.md @@ -8,8 +8,6 @@ > **inferAnnotations**(`tool`): [`MCPToolAnnotations`](../type-aliases/MCPToolAnnotations.md) -Defined in: [mcp/toolAnnotations.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L23) - Infer annotations from tool definition Uses heuristics based on tool description and name diff --git a/docs/api/functions/initializeMCPEcosystem.md b/docs/api/functions/initializeMCPEcosystem.md index 0e66a490f..39e799d3f 100644 --- a/docs/api/functions/initializeMCPEcosystem.md +++ b/docs/api/functions/initializeMCPEcosystem.md @@ -8,8 +8,6 @@ > **initializeMCPEcosystem**(): `Promise`\<`void`\> -Defined in: [mcp/index.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/index.ts#L189) - Initialize the MCP ecosystem - simplified ## Returns diff --git a/docs/api/functions/initializeOpenTelemetry.md b/docs/api/functions/initializeOpenTelemetry.md index 06e3620b1..581cd2144 100644 --- a/docs/api/functions/initializeOpenTelemetry.md +++ b/docs/api/functions/initializeOpenTelemetry.md @@ -8,8 +8,6 @@ > **initializeOpenTelemetry**(`config`): `Promise`\<`void`\> -Defined in: [services/server/ai/observability/instrumentation.ts:1086](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1086) - Initialize OpenTelemetry with Langfuse span processor This connects Vercel AI SDK's experimental_telemetry to Langfuse by: diff --git a/docs/api/functions/initializeTelemetry.md b/docs/api/functions/initializeTelemetry.md index 8cc4ed1bf..914c49cae 100644 --- a/docs/api/functions/initializeTelemetry.md +++ b/docs/api/functions/initializeTelemetry.md @@ -8,8 +8,6 @@ > **initializeTelemetry**(): `Promise`\<`boolean`\> -Defined in: [index.ts:790](https://github.com/juspay/neurolink/blob/release/src/lib/index.ts#L790) - ## Returns `Promise`\<`boolean`\> diff --git a/docs/api/functions/isAbortError.md b/docs/api/functions/isAbortError.md index 058be8252..4561b490f 100644 --- a/docs/api/functions/isAbortError.md +++ b/docs/api/functions/isAbortError.md @@ -8,8 +8,6 @@ > **isAbortError**(`error`): `boolean` -Defined in: [utils/errorHandling.ts:1417](https://github.com/juspay/neurolink/blob/release/src/lib/utils/errorHandling.ts#L1417) - Detect AbortError from any source (DOMException, plain Error, or message-based). Used to short-circuit retry/fallback loops when an abort signal fires. diff --git a/docs/api/functions/isAnthropicConfig.md b/docs/api/functions/isAnthropicConfig.md index ad4ba06cd..9c60a633b 100644 --- a/docs/api/functions/isAnthropicConfig.md +++ b/docs/api/functions/isAnthropicConfig.md @@ -8,8 +8,6 @@ > **isAnthropicConfig**(`config`): `config is AnthropicProviderConfig` -Defined in: [types/providers.ts:674](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L674) - Type guard to check if a configuration is an AnthropicProviderConfig ## Parameters diff --git a/docs/api/functions/isApiError.md b/docs/api/functions/isApiError.md index d7e7edfb6..6377307e9 100644 --- a/docs/api/functions/isApiError.md +++ b/docs/api/functions/isApiError.md @@ -8,8 +8,6 @@ > **isApiError**(`error`): `error is ClientApiError` -Defined in: [client/errors.ts:764](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L764) - Type guard for ClientApiError ## Parameters diff --git a/docs/api/functions/isAsyncFunction.md b/docs/api/functions/isAsyncFunction.md index dc27512ae..9d6148913 100644 --- a/docs/api/functions/isAsyncFunction.md +++ b/docs/api/functions/isAsyncFunction.md @@ -8,8 +8,6 @@ > **isAsyncFunction**(`value`): `value is AsyncFunction` -Defined in: [types/aliases.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L500) - Type guard for checking if value is an AsyncFunction ## Parameters diff --git a/docs/api/functions/isAudioContent.md b/docs/api/functions/isAudioContent.md index 00ce8ad19..ad56ae93a 100644 --- a/docs/api/functions/isAudioContent.md +++ b/docs/api/functions/isAudioContent.md @@ -8,8 +8,6 @@ > **isAudioContent**(`content`): `content is AudioContent` -Defined in: [types/multimodal.ts:637](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L637) - Type guard to check if content is AudioContent ## Parameters diff --git a/docs/api/functions/isAuthenticated.md b/docs/api/functions/isAuthenticated.md index 5e2ab32dc..a4d2ff28f 100644 --- a/docs/api/functions/isAuthenticated.md +++ b/docs/api/functions/isAuthenticated.md @@ -8,8 +8,6 @@ > **isAuthenticated**(): `boolean` -Defined in: [auth/authContext.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L102) - Check if the current request is authenticated ## Returns diff --git a/docs/api/functions/isCSVContent.md b/docs/api/functions/isCSVContent.md index a7c0bf9c7..150624a41 100644 --- a/docs/api/functions/isCSVContent.md +++ b/docs/api/functions/isCSVContent.md @@ -8,8 +8,6 @@ > **isCSVContent**(`content`): `content is CSVContent` -Defined in: [types/multimodal.ts:623](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L623) - Type guard to check if content is CSVContent ## Parameters diff --git a/docs/api/functions/isCliGenerateResult.md b/docs/api/functions/isCliGenerateResult.md index 8011e9c04..93402b910 100644 --- a/docs/api/functions/isCliGenerateResult.md +++ b/docs/api/functions/isCliGenerateResult.md @@ -8,8 +8,6 @@ > **isCliGenerateResult**(`value`): `value is CliGenerateResult` -Defined in: [types/cli.ts:600](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L600) - Type guard for generate result ## Parameters diff --git a/docs/api/functions/isCommandResult.md b/docs/api/functions/isCommandResult.md index ba2102ce0..f3bcea708 100644 --- a/docs/api/functions/isCommandResult.md +++ b/docs/api/functions/isCommandResult.md @@ -8,8 +8,6 @@ > **isCommandResult**(`value`): `value is CommandResult` -Defined in: [types/cli.ts:614](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L614) - Type guard for command result ## Parameters diff --git a/docs/api/functions/isElicitationProtocolMessage.md b/docs/api/functions/isElicitationProtocolMessage.md index 671a2f74a..024bb4ed6 100644 --- a/docs/api/functions/isElicitationProtocolMessage.md +++ b/docs/api/functions/isElicitationProtocolMessage.md @@ -8,8 +8,6 @@ > **isElicitationProtocolMessage**(`message`): `message is ElicitationProtocolPayload` -Defined in: [mcp/elicitationProtocol.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L109) - Check if a message is an elicitation protocol message ## Parameters diff --git a/docs/api/functions/isError.md b/docs/api/functions/isError.md index 0f842a8f8..9a29b8c69 100644 --- a/docs/api/functions/isError.md +++ b/docs/api/functions/isError.md @@ -8,8 +8,6 @@ > **isError**(`value`): `value is Error` -Defined in: [types/common.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L107) - Type guard to check if value is Error ## Parameters diff --git a/docs/api/functions/isErrorInfo.md b/docs/api/functions/isErrorInfo.md index 8de6967e1..b72d030db 100644 --- a/docs/api/functions/isErrorInfo.md +++ b/docs/api/functions/isErrorInfo.md @@ -8,8 +8,6 @@ > **isErrorInfo**(`value`): `value is ErrorInfo` -Defined in: [types/common.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L114) - Type guard to check if value is ErrorInfo ## Parameters diff --git a/docs/api/functions/isEvaluationError.md b/docs/api/functions/isEvaluationError.md index 0c802e466..00eed2092 100644 --- a/docs/api/functions/isEvaluationError.md +++ b/docs/api/functions/isEvaluationError.md @@ -8,8 +8,6 @@ > **isEvaluationError**(`error`): `error is NeuroLinkFeatureError` -Defined in: [evaluation/errors/EvaluationError.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L84) - Checks if an error is a NeuroLinkFeatureError from the Evaluation feature. ## Parameters diff --git a/docs/api/functions/isImageContent.md b/docs/api/functions/isImageContent.md index 0c7ac9159..f16ff6e79 100644 --- a/docs/api/functions/isImageContent.md +++ b/docs/api/functions/isImageContent.md @@ -8,8 +8,6 @@ > **isImageContent**(`content`): `content is ImageContent` -Defined in: [types/multimodal.ts:616](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L616) - Type guard to check if content is ImageContent ## Parameters diff --git a/docs/api/functions/isJWTExpired.md b/docs/api/functions/isJWTExpired.md index ba13e271d..9e874dc77 100644 --- a/docs/api/functions/isJWTExpired.md +++ b/docs/api/functions/isJWTExpired.md @@ -8,8 +8,6 @@ > **isJWTExpired**(`token`, `bufferMs?`): `boolean` -Defined in: [client/auth.ts:511](https://github.com/juspay/neurolink/blob/release/src/lib/client/auth.ts#L511) - Check if a JWT token is expired ## Parameters diff --git a/docs/api/functions/isJsonRecord.md b/docs/api/functions/isJsonRecord.md index 94a90f226..44a12847c 100644 --- a/docs/api/functions/isJsonRecord.md +++ b/docs/api/functions/isJsonRecord.md @@ -8,8 +8,6 @@ > **isJsonRecord**(`value`): `value is JsonRecord` -Defined in: [types/aliases.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L473) - Type guard for checking if value is a JsonRecord ## Parameters diff --git a/docs/api/functions/isLangfuseInternalSpan.md b/docs/api/functions/isLangfuseInternalSpan.md index e92243bc8..8e660fc9d 100644 --- a/docs/api/functions/isLangfuseInternalSpan.md +++ b/docs/api/functions/isLangfuseInternalSpan.md @@ -8,8 +8,6 @@ > **isLangfuseInternalSpan**(`span`): `boolean` -Defined in: [services/server/ai/observability/instrumentation.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L763) - True when a span is an internal NeuroLink wrapper that should NOT be sent to Langfuse. Internal wrappers carry the `langfuse.internal: true` attribute. diff --git a/docs/api/functions/isModelAccessDeniedMessage.md b/docs/api/functions/isModelAccessDeniedMessage.md index 8c038bbbf..cb37271e7 100644 --- a/docs/api/functions/isModelAccessDeniedMessage.md +++ b/docs/api/functions/isModelAccessDeniedMessage.md @@ -8,8 +8,6 @@ > **isModelAccessDeniedMessage**(`message`): `boolean` -Defined in: [types/errors.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L343) - Returns true when `message` looks like a model-access-denied response (LiteLLM "team not allowed", generic "not allowed to access model", or "team can only access models=[...]"). diff --git a/docs/api/functions/isMultimodalInput.md b/docs/api/functions/isMultimodalInput.md index e28804569..6b82737cb 100644 --- a/docs/api/functions/isMultimodalInput.md +++ b/docs/api/functions/isMultimodalInput.md @@ -8,8 +8,6 @@ > **isMultimodalInput**(`input`): `input is MultimodalInput` -Defined in: [types/multimodal.ts:692](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L692) - ## Parameters ### input diff --git a/docs/api/functions/isMultimodalMessageContent.md b/docs/api/functions/isMultimodalMessageContent.md index 4ed53cc53..1dea7786d 100644 --- a/docs/api/functions/isMultimodalMessageContent.md +++ b/docs/api/functions/isMultimodalMessageContent.md @@ -8,8 +8,6 @@ > **isMultimodalMessageContent**(`content`): `content is MessageContent[]` -Defined in: [types/multimodal.ts:719](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L719) - Type guard to check if message content is multimodal (array) ## Parameters diff --git a/docs/api/functions/isNativeVideoMimeType.md b/docs/api/functions/isNativeVideoMimeType.md index 21cd59cc8..c2c64f8d7 100644 --- a/docs/api/functions/isNativeVideoMimeType.md +++ b/docs/api/functions/isNativeVideoMimeType.md @@ -8,8 +8,6 @@ > **isNativeVideoMimeType**(`mimeType`): `boolean` -Defined in: [adapters/videoFormatSupport.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/videoFormatSupport.ts#L310) - Whether `mimeType` is a container a native provider will read as-is. ## Parameters diff --git a/docs/api/functions/isNeuroLinkError.md b/docs/api/functions/isNeuroLinkError.md index a23590d14..e8721bcb0 100644 --- a/docs/api/functions/isNeuroLinkError.md +++ b/docs/api/functions/isNeuroLinkError.md @@ -8,8 +8,6 @@ > **isNeuroLinkError**(`error`): `error is ClientNeuroLinkError` -Defined in: [client/errors.ts:757](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L757) - Type guard for NeuroLinkError ## Parameters diff --git a/docs/api/functions/isOpenTelemetryInitialized.md b/docs/api/functions/isOpenTelemetryInitialized.md index 542800320..8cd382a3c 100644 --- a/docs/api/functions/isOpenTelemetryInitialized.md +++ b/docs/api/functions/isOpenTelemetryInitialized.md @@ -8,8 +8,6 @@ > **isOpenTelemetryInitialized**(): `boolean` -Defined in: [services/server/ai/observability/instrumentation.ts:1298](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1298) - Check if OpenTelemetry is initialized ## Returns diff --git a/docs/api/functions/isPDFContent.md b/docs/api/functions/isPDFContent.md index cce9b4718..f6c1803f4 100644 --- a/docs/api/functions/isPDFContent.md +++ b/docs/api/functions/isPDFContent.md @@ -8,8 +8,6 @@ > **isPDFContent**(`content`): `content is PDFContent` -Defined in: [types/multimodal.ts:630](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L630) - Type guard to check if content is PDFContent ## Parameters diff --git a/docs/api/functions/isRetryableError.md b/docs/api/functions/isRetryableError.md index 87a6de7cb..ae1d4b896 100644 --- a/docs/api/functions/isRetryableError.md +++ b/docs/api/functions/isRetryableError.md @@ -8,8 +8,6 @@ > **isRetryableError**(`error`): `boolean` -Defined in: [client/errors.ts:735](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L735) - Check if an error is retryable ## Parameters diff --git a/docs/api/functions/isRetryableEvaluationError.md b/docs/api/functions/isRetryableEvaluationError.md index 1ba0d6d0a..403796f9a 100644 --- a/docs/api/functions/isRetryableEvaluationError.md +++ b/docs/api/functions/isRetryableEvaluationError.md @@ -8,8 +8,6 @@ > **isRetryableEvaluationError**(`error`): `boolean` -Defined in: [evaluation/errors/EvaluationError.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/errors/EvaluationError.ts#L63) - Checks if an error is retryable based on its code. Transient errors (timeout, rate limit, some provider errors) are retryable. diff --git a/docs/api/functions/isRetryableHTTPError.md b/docs/api/functions/isRetryableHTTPError.md index 128d45581..9deccabe2 100644 --- a/docs/api/functions/isRetryableHTTPError.md +++ b/docs/api/functions/isRetryableHTTPError.md @@ -8,8 +8,6 @@ > **isRetryableHTTPError**(`error`, `config?`): `boolean` -Defined in: [mcp/httpRetryHandler.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRetryHandler.ts#L64) - Check if an error is retryable for HTTP operations Considers: diff --git a/docs/api/functions/isRetryableStatus.md b/docs/api/functions/isRetryableStatus.md index c6892fe1c..1b4e78762 100644 --- a/docs/api/functions/isRetryableStatus.md +++ b/docs/api/functions/isRetryableStatus.md @@ -8,8 +8,6 @@ > **isRetryableStatus**(`status`): `boolean` -Defined in: [client/errors.ts:728](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L728) - Check if a status code is retryable ## Parameters diff --git a/docs/api/functions/isRetryableStatusCode.md b/docs/api/functions/isRetryableStatusCode.md index 41834b21f..4aa720976 100644 --- a/docs/api/functions/isRetryableStatusCode.md +++ b/docs/api/functions/isRetryableStatusCode.md @@ -8,8 +8,6 @@ > **isRetryableStatusCode**(`status`, `config?`): `boolean` -Defined in: [mcp/httpRetryHandler.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRetryHandler.ts#L44) - Check if an HTTP status code is retryable based on configuration ## Parameters diff --git a/docs/api/functions/isSTTResult.md b/docs/api/functions/isSTTResult.md index fb5dd74b1..0face4d37 100644 --- a/docs/api/functions/isSTTResult.md +++ b/docs/api/functions/isSTTResult.md @@ -8,8 +8,6 @@ > **isSTTResult**(`value`): `value is STTResult` -Defined in: [types/stt.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L216) - Type guard for STTResult ## Parameters diff --git a/docs/api/functions/isSafeToRetry.md b/docs/api/functions/isSafeToRetry.md index fe3fe4e31..98e7bc813 100644 --- a/docs/api/functions/isSafeToRetry.md +++ b/docs/api/functions/isSafeToRetry.md @@ -8,8 +8,6 @@ > **isSafeToRetry**(`tool`): `boolean` -Defined in: [mcp/toolAnnotations.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L249) - Check if a tool is safe for automatic retry ## Parameters diff --git a/docs/api/functions/isStandardRecord.md b/docs/api/functions/isStandardRecord.md index e32ff7a7f..8a2dab41e 100644 --- a/docs/api/functions/isStandardRecord.md +++ b/docs/api/functions/isStandardRecord.md @@ -8,8 +8,6 @@ > **isStandardRecord**(`value`): `value is StandardRecord` -Defined in: [types/aliases.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L466) - Type guard for checking if value is a StandardRecord ## Parameters diff --git a/docs/api/functions/isStringArray.md b/docs/api/functions/isStringArray.md index 01c97aba5..296afa71b 100644 --- a/docs/api/functions/isStringArray.md +++ b/docs/api/functions/isStringArray.md @@ -8,8 +8,6 @@ > **isStringArray**(`value`): `value is StringArray` -Defined in: [types/aliases.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L491) - Type guard for checking if value is a StringArray ## Parameters diff --git a/docs/api/functions/isTTSResult.md b/docs/api/functions/isTTSResult.md index b873295f4..cb99f7f9c 100644 --- a/docs/api/functions/isTTSResult.md +++ b/docs/api/functions/isTTSResult.md @@ -8,8 +8,6 @@ > **isTTSResult**(`value`): `value is TTSResult` -Defined in: [types/tts.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L232) - Type guard to check if an object is a TTSResult ## Parameters diff --git a/docs/api/functions/isTextContent.md b/docs/api/functions/isTextContent.md index 873a16240..46123658f 100644 --- a/docs/api/functions/isTextContent.md +++ b/docs/api/functions/isTextContent.md @@ -8,8 +8,6 @@ > **isTextContent**(`content`): `content is TextContent` -Defined in: [types/multimodal.ts:609](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L609) - Type guard to check if content is TextContent ## Parameters diff --git a/docs/api/functions/isTokenExpired.md b/docs/api/functions/isTokenExpired.md index 61db4ea19..86a52fc02 100644 --- a/docs/api/functions/isTokenExpired.md +++ b/docs/api/functions/isTokenExpired.md @@ -8,8 +8,6 @@ > **isTokenExpired**(`tokens`, `bufferSeconds?`): `boolean` -Defined in: [mcp/auth/tokenStorage.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/auth/tokenStorage.ts#L146) - Check if tokens are expired or about to expire ## Parameters diff --git a/docs/api/functions/isToolDefinition.md b/docs/api/functions/isToolDefinition.md index 17c1491af..0b1e4bd5d 100644 --- a/docs/api/functions/isToolDefinition.md +++ b/docs/api/functions/isToolDefinition.md @@ -8,8 +8,6 @@ > **isToolDefinition**(`value`): `value is ToolDefinition` -Defined in: [types/tools.ts:672](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L672) - Type guard for tool definition ## Parameters diff --git a/docs/api/functions/isToolResult.md b/docs/api/functions/isToolResult.md index ee36faab7..96b7e1e30 100644 --- a/docs/api/functions/isToolResult.md +++ b/docs/api/functions/isToolResult.md @@ -8,8 +8,6 @@ > **isToolResult**(`value`): `value is ToolResult` -Defined in: [types/tools.ts:660](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L660) - Type guard for tool result ## Parameters diff --git a/docs/api/functions/isTranscriptionSegment.md b/docs/api/functions/isTranscriptionSegment.md index f7dec9a5a..c62581d01 100644 --- a/docs/api/functions/isTranscriptionSegment.md +++ b/docs/api/functions/isTranscriptionSegment.md @@ -8,8 +8,6 @@ > **isTranscriptionSegment**(`value`): `value is TranscriptionSegment` -Defined in: [types/stt.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L257) - Type guard for TranscriptionSegment ## Parameters diff --git a/docs/api/functions/isUsingExternalTracerProvider.md b/docs/api/functions/isUsingExternalTracerProvider.md index 3b2438186..4d9478c5d 100644 --- a/docs/api/functions/isUsingExternalTracerProvider.md +++ b/docs/api/functions/isUsingExternalTracerProvider.md @@ -8,8 +8,6 @@ > **isUsingExternalTracerProvider**(): `boolean` -Defined in: [services/server/ai/observability/instrumentation.ts:1591](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1591) - Check if using external TracerProvider mode ## Returns diff --git a/docs/api/functions/isValidHexColor.md b/docs/api/functions/isValidHexColor.md index 3c99438f4..b621542c9 100644 --- a/docs/api/functions/isValidHexColor.md +++ b/docs/api/functions/isValidHexColor.md @@ -8,8 +8,6 @@ > **isValidHexColor**(`color`): `boolean` -Defined in: [types/ppt.ts:897](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L897) - Validate a hex color string (6 hex characters, no # prefix). ## Parameters diff --git a/docs/api/functions/isValidProvider.md b/docs/api/functions/isValidProvider.md index f9e1eeece..5688d8727 100644 --- a/docs/api/functions/isValidProvider.md +++ b/docs/api/functions/isValidProvider.md @@ -8,8 +8,6 @@ > **isValidProvider**(`provider`): `boolean` -Defined in: [utils/providerUtils.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/utils/providerUtils.ts#L469) - Validate provider name ## Parameters diff --git a/docs/api/functions/isValidRealtimeConfig.md b/docs/api/functions/isValidRealtimeConfig.md index 7e4a9fd97..b80534383 100644 --- a/docs/api/functions/isValidRealtimeConfig.md +++ b/docs/api/functions/isValidRealtimeConfig.md @@ -8,8 +8,6 @@ > **isValidRealtimeConfig**(`config`): `config is RealtimeConfig` -Defined in: [types/realtime.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/realtime.ts#L307) - Type guard for valid RealtimeConfig ## Parameters diff --git a/docs/api/functions/isValidSTTOptions.md b/docs/api/functions/isValidSTTOptions.md index 9fa2044a7..371e4eebc 100644 --- a/docs/api/functions/isValidSTTOptions.md +++ b/docs/api/functions/isValidSTTOptions.md @@ -8,8 +8,6 @@ > **isValidSTTOptions**(`options`): `options is STTOptions` -Defined in: [types/stt.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L232) - Type guard for valid STTOptions ## Parameters diff --git a/docs/api/functions/isValidTTSOptions.md b/docs/api/functions/isValidTTSOptions.md index 7adee3051..ae074fb37 100644 --- a/docs/api/functions/isValidTTSOptions.md +++ b/docs/api/functions/isValidTTSOptions.md @@ -8,8 +8,6 @@ > **isValidTTSOptions**(`options`): `options is TTSOptions` -Defined in: [types/tts.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L249) - Type guard to check if TTSOptions are valid ## Parameters diff --git a/docs/api/functions/isVertexVideoConfigured.md b/docs/api/functions/isVertexVideoConfigured.md index d3043d1a5..9601d2fad 100644 --- a/docs/api/functions/isVertexVideoConfigured.md +++ b/docs/api/functions/isVertexVideoConfigured.md @@ -8,8 +8,6 @@ > **isVertexVideoConfigured**(): `boolean` -Defined in: [adapters/video/vertexVideoHandler.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/vertexVideoHandler.ts#L101) - Check if Vertex AI is configured for video generation ## Returns diff --git a/docs/api/functions/isVideoContent.md b/docs/api/functions/isVideoContent.md index 90b26be3f..5756bb85f 100644 --- a/docs/api/functions/isVideoContent.md +++ b/docs/api/functions/isVideoContent.md @@ -8,8 +8,6 @@ > **isVideoContent**(`content`): `content is VideoContent` -Defined in: [types/multimodal.ts:644](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L644) - Type guard to check if content is VideoContent ## Parameters diff --git a/docs/api/functions/jsonSchema.md b/docs/api/functions/jsonSchema.md index b163bb746..d30b56f43 100644 --- a/docs/api/functions/jsonSchema.md +++ b/docs/api/functions/jsonSchema.md @@ -8,8 +8,6 @@ > **jsonSchema**\<`OBJECT`\>(`schema`, `options?`): [`Schema`](../type-aliases/Schema.md)\<`OBJECT`\> -Defined in: [utils/tool.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tool.ts#L42) - ## Type Parameters ### OBJECT diff --git a/docs/api/functions/langfuseShouldExportSpan.md b/docs/api/functions/langfuseShouldExportSpan.md index 1ea63a673..08c08cbd0 100644 --- a/docs/api/functions/langfuseShouldExportSpan.md +++ b/docs/api/functions/langfuseShouldExportSpan.md @@ -8,8 +8,6 @@ > **langfuseShouldExportSpan**(`__namedParameters`): `boolean` -Defined in: [services/server/ai/observability/instrumentation.ts:779](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L779) - Drop-in `shouldExportSpan` predicate for a `LangfuseSpanProcessor` that filters out NeuroLink internal wrapper spans. diff --git a/docs/api/functions/linearCombination.md b/docs/api/functions/linearCombination.md index e8e80fba8..de1810371 100644 --- a/docs/api/functions/linearCombination.md +++ b/docs/api/functions/linearCombination.md @@ -8,8 +8,6 @@ > **linearCombination**(`vectorScores`, `bm25Scores`, `alpha?`): `Map`\<`string`, `number`\> -Defined in: [rag/retrieval/hybridSearch.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/hybridSearch.ts#L175) - Linear Combination of normalized scores ## Parameters diff --git a/docs/api/functions/listMCPs.md b/docs/api/functions/listMCPs.md index 8cba03373..91ee46116 100644 --- a/docs/api/functions/listMCPs.md +++ b/docs/api/functions/listMCPs.md @@ -8,8 +8,6 @@ > **listMCPs**(): `Promise`\<[`McpMetadata`](../type-aliases/McpMetadata.md)[]\> -Defined in: [mcp/index.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/index.ts#L197) - List available MCPs - simplified ## Returns diff --git a/docs/api/functions/listWorkflows.md b/docs/api/functions/listWorkflows.md index c7b0367d7..95fd1923a 100644 --- a/docs/api/functions/listWorkflows.md +++ b/docs/api/functions/listWorkflows.md @@ -8,8 +8,6 @@ > **listWorkflows**(`options?`): [`WorkflowConfig`](../type-aliases/WorkflowConfig.md)[] -Defined in: [workflow/core/workflowRegistry.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/core/workflowRegistry.ts#L159) - List all registered workflows ## Parameters diff --git a/docs/api/functions/loadDocument.md b/docs/api/functions/loadDocument.md index 13c314a14..523d50341 100644 --- a/docs/api/functions/loadDocument.md +++ b/docs/api/functions/loadDocument.md @@ -8,8 +8,6 @@ > **loadDocument**(`source`, `options?`): `Promise`\<[`MDocument`](../classes/MDocument.md)\> -Defined in: [rag/document/loaders.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L647) - Load document from file path, URL, or content Automatically detects the document type and uses the appropriate loader. diff --git a/docs/api/functions/loadDocuments.md b/docs/api/functions/loadDocuments.md index dc07fc9c9..c5eebe367 100644 --- a/docs/api/functions/loadDocuments.md +++ b/docs/api/functions/loadDocuments.md @@ -8,8 +8,6 @@ > **loadDocuments**(`sources`, `options?`): `Promise`\<[`MDocument`](../classes/MDocument.md)[]\> -Defined in: [rag/document/loaders.ts:674](https://github.com/juspay/neurolink/blob/release/src/lib/rag/document/loaders.ts#L674) - Load multiple documents ## Parameters diff --git a/docs/api/functions/manifestToSources.md b/docs/api/functions/manifestToSources.md index b2bc2398e..3da0b27c6 100644 --- a/docs/api/functions/manifestToSources.md +++ b/docs/api/functions/manifestToSources.md @@ -8,8 +8,6 @@ > **manifestToSources**(`manifest`): [`KnowledgeSource`](../type-aliases/KnowledgeSource.md)[] -Defined in: [knowledge/resolve.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/resolve.ts#L68) - Expand a build manifest into sources — one per catalog. ## Parameters diff --git a/docs/api/functions/mapStatusToErrorCode.md b/docs/api/functions/mapStatusToErrorCode.md index 55c70ed53..ca3fee4e4 100644 --- a/docs/api/functions/mapStatusToErrorCode.md +++ b/docs/api/functions/mapStatusToErrorCode.md @@ -8,8 +8,6 @@ > **mapStatusToErrorCode**(`status`): [`ErrorCodeType`](../type-aliases/ErrorCodeType.md) -Defined in: [client/errors.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/client/errors.ts#L703) - Map HTTP status code to error code ## Parameters diff --git a/docs/api/functions/mcpProtocolToolToServerTool.md b/docs/api/functions/mcpProtocolToolToServerTool.md index 2803ca1aa..e97f26387 100644 --- a/docs/api/functions/mcpProtocolToolToServerTool.md +++ b/docs/api/functions/mcpProtocolToolToServerTool.md @@ -8,8 +8,6 @@ > **mcpProtocolToolToServerTool**(`protocolTool`, `executor`, `options?`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) -Defined in: [mcp/toolConverter.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L125) - Convert MCP protocol tool to MCPServerTool (For tools received from external MCP servers) diff --git a/docs/api/functions/mcpToolToNeuroLink.md b/docs/api/functions/mcpToolToNeuroLink.md index c7349567e..0b597ed0e 100644 --- a/docs/api/functions/mcpToolToNeuroLink.md +++ b/docs/api/functions/mcpToolToNeuroLink.md @@ -8,8 +8,6 @@ > **mcpToolToNeuroLink**(`tool`, `options?`): [`NeuroLinkTool`](../type-aliases/NeuroLinkTool.md) -Defined in: [mcp/toolConverter.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L95) - Convert MCP server tool to NeuroLink tool format ## Parameters diff --git a/docs/api/functions/mergeAnnotations.md b/docs/api/functions/mergeAnnotations.md index 479ce4a71..896b439ab 100644 --- a/docs/api/functions/mergeAnnotations.md +++ b/docs/api/functions/mergeAnnotations.md @@ -8,8 +8,6 @@ > **mergeAnnotations**(...`annotationSets`): [`MCPToolAnnotations`](../type-aliases/MCPToolAnnotations.md) -Defined in: [mcp/toolAnnotations.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L143) - Merge multiple annotation objects with precedence Later annotations override earlier ones diff --git a/docs/api/functions/neuroLinkToolToMCP.md b/docs/api/functions/neuroLinkToolToMCP.md index 428f7278d..812e7c810 100644 --- a/docs/api/functions/neuroLinkToolToMCP.md +++ b/docs/api/functions/neuroLinkToolToMCP.md @@ -8,8 +8,6 @@ > **neuroLinkToolToMCP**(`tool`, `options?`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) -Defined in: [mcp/toolConverter.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L29) - Convert NeuroLink tool to MCP server tool format ## Parameters diff --git a/docs/api/functions/normalizeAndValidate.md b/docs/api/functions/normalizeAndValidate.md index feeb1aca3..a2404bdc4 100644 --- a/docs/api/functions/normalizeAndValidate.md +++ b/docs/api/functions/normalizeAndValidate.md @@ -8,8 +8,6 @@ > **normalizeAndValidate**(`sources`, `options`): `Promise`\<[`KnowledgeNormalizeResult`](../type-aliases/KnowledgeNormalizeResult.md)\> -Defined in: [knowledge/resolve.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/resolve.ts#L105) - Resolve and validate every source into normalized entries. `validation.ok` is false when any error-level issue was found; the caller (index builder) must not swap in an index built from an invalid set. Async so the public diff --git a/docs/api/functions/normalizeHexColor.md b/docs/api/functions/normalizeHexColor.md index fe698b5a5..790382099 100644 --- a/docs/api/functions/normalizeHexColor.md +++ b/docs/api/functions/normalizeHexColor.md @@ -8,8 +8,6 @@ > **normalizeHexColor**(`color`): `string` -Defined in: [types/ppt.ts:904](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L904) - Normalize a hex color by stripping leading # if present. ## Parameters diff --git a/docs/api/functions/normalizePhrases.md b/docs/api/functions/normalizePhrases.md index 40102d6fd..5c0d0356a 100644 --- a/docs/api/functions/normalizePhrases.md +++ b/docs/api/functions/normalizePhrases.md @@ -8,8 +8,6 @@ > **normalizePhrases**(`phrases`): `string`[] -Defined in: [knowledge/normalize.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/normalize.ts#L71) - Normalize each candidate phrase and drop blanks/duplicates while preserving first-seen order. Used to build the exact-key and alias key sets. diff --git a/docs/api/functions/normalizeText.md b/docs/api/functions/normalizeText.md index 86d07e3f9..3b4b76d1a 100644 --- a/docs/api/functions/normalizeText.md +++ b/docs/api/functions/normalizeText.md @@ -8,8 +8,6 @@ > **normalizeText**(`input`): `string` -Defined in: [knowledge/normalize.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/normalize.ts#L37) - Normalize an arbitrary string into a single space-delimited lowercase phrase. Idempotent: `normalizeText(normalizeText(x)) === normalizeText(x)`. diff --git a/docs/api/functions/parseAllowedModels.md b/docs/api/functions/parseAllowedModels.md index e1b2c7ddd..3e90b0428 100644 --- a/docs/api/functions/parseAllowedModels.md +++ b/docs/api/functions/parseAllowedModels.md @@ -8,8 +8,6 @@ > **parseAllowedModels**(`message`): `string`[] \| `undefined` -Defined in: [types/errors.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L294) - Parse the `allowed_models` array out of a provider error message body. Currently targets the LiteLLM team-whitelist response shape: diff --git a/docs/api/functions/pipeAsyncIterableToDataStream.md b/docs/api/functions/pipeAsyncIterableToDataStream.md index 97983dd21..d11d88937 100644 --- a/docs/api/functions/pipeAsyncIterableToDataStream.md +++ b/docs/api/functions/pipeAsyncIterableToDataStream.md @@ -8,8 +8,6 @@ > **pipeAsyncIterableToDataStream**(`iterable`, `response`, `options?`): `Promise`\<`void`\> -Defined in: [server/streaming/dataStream.ts:339](https://github.com/juspay/neurolink/blob/release/src/lib/server/streaming/dataStream.ts#L339) - Pipe an async iterable to a data stream response ## Parameters diff --git a/docs/api/functions/pipelineToSpanAttributes.md b/docs/api/functions/pipelineToSpanAttributes.md index 837e1b653..914b2d493 100644 --- a/docs/api/functions/pipelineToSpanAttributes.md +++ b/docs/api/functions/pipelineToSpanAttributes.md @@ -8,8 +8,6 @@ > **pipelineToSpanAttributes**(`result`): [`EvaluationSpanAttributes`](../type-aliases/EvaluationSpanAttributes.md) -Defined in: [evaluation/hooks/observabilityHooks.ts:237](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L237) - Create span attributes from pipeline result ## Parameters diff --git a/docs/api/functions/prepareRAGTool.md b/docs/api/functions/prepareRAGTool.md index ceae41b82..3522276c3 100644 --- a/docs/api/functions/prepareRAGTool.md +++ b/docs/api/functions/prepareRAGTool.md @@ -8,8 +8,6 @@ > **prepareRAGTool**(`ragConfig`, `fallbackProvider?`): `Promise`\<[`RAGPreparedTool`](../type-aliases/RAGPreparedTool.md)\> -Defined in: [rag/ragIntegration.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/rag/ragIntegration.ts#L188) - Prepare RAG tools from the provided configuration. This function: diff --git a/docs/api/functions/processDocument.md b/docs/api/functions/processDocument.md index 00d3025b0..6e970af98 100644 --- a/docs/api/functions/processDocument.md +++ b/docs/api/functions/processDocument.md @@ -8,8 +8,6 @@ > **processDocument**(`text`, `options?`): `Promise`\<[`Chunk`](../type-aliases/Chunk.md)[]\> -Defined in: [rag/index.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/rag/index.ts#L179) - Process a document through the full RAG pipeline ## Parameters diff --git a/docs/api/functions/protocolMessageToElicitation.md b/docs/api/functions/protocolMessageToElicitation.md index 432335b81..4201db84f 100644 --- a/docs/api/functions/protocolMessageToElicitation.md +++ b/docs/api/functions/protocolMessageToElicitation.md @@ -8,8 +8,6 @@ > **protocolMessageToElicitation**(`message`): [`Elicitation`](../type-aliases/Elicitation.md) -Defined in: [mcp/elicitationProtocol.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/elicitationProtocol.ts#L132) - Convert protocol message to Elicitation type ## Parameters diff --git a/docs/api/functions/rankCatalogue.md b/docs/api/functions/rankCatalogue.md index 390d84020..7bebe0b8d 100644 --- a/docs/api/functions/rankCatalogue.md +++ b/docs/api/functions/rankCatalogue.md @@ -8,8 +8,6 @@ > **rankCatalogue**(`candidates`, `difficulty`, `input?`, `requiredCapabilities?`): [`ClassifierCandidate`](../type-aliases/ClassifierCandidate.md)[] -Defined in: [routing/modelCatalog.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelCatalog.ts#L205) - Rank candidates deterministically for a difficulty. The fallback that makes the catalogue safe to enable: with no decision provider configured this is the whole selection, and it never consults the network. diff --git a/docs/api/functions/reachableTextProviders.md b/docs/api/functions/reachableTextProviders.md index 7fdc6accc..c012cb8bb 100644 --- a/docs/api/functions/reachableTextProviders.md +++ b/docs/api/functions/reachableTextProviders.md @@ -8,8 +8,6 @@ > **reachableTextProviders**(): `Set`\<`string`\> -Defined in: [routing/modelCatalog.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelCatalog.ts#L109) - Provider names this host has credentials for AND that generate text. ## Returns diff --git a/docs/api/functions/readAllLocalUsage.md b/docs/api/functions/readAllLocalUsage.md index 5347e00f2..31d773ec9 100644 --- a/docs/api/functions/readAllLocalUsage.md +++ b/docs/api/functions/readAllLocalUsage.md @@ -8,8 +8,6 @@ > **readAllLocalUsage**(`options?`): `Promise`\<[`LocalUsageAggregateReport`](../type-aliases/LocalUsageAggregateReport.md)\> -Defined in: [localUsage/index.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/localUsage/index.ts#L36) - Scan every registered reader whose CLI is actually present on this machine. "Not installed" and "failed" are reported separately and deliberately: a CLI diff --git a/docs/api/functions/readDecisionBoolean.md b/docs/api/functions/readDecisionBoolean.md index dfeb9d606..946e136cd 100644 --- a/docs/api/functions/readDecisionBoolean.md +++ b/docs/api/functions/readDecisionBoolean.md @@ -8,8 +8,6 @@ > **readDecisionBoolean**(`answers`, `id`): `number` \| `undefined` -Defined in: [utils/decisionAnswers.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/utils/decisionAnswers.ts#L26) - Read a yes/no answer as a probability. Returns undefined when the id is absent or the answer was a different diff --git a/docs/api/functions/readDecisionChoice.md b/docs/api/functions/readDecisionChoice.md index 58d594b24..d45544267 100644 --- a/docs/api/functions/readDecisionChoice.md +++ b/docs/api/functions/readDecisionChoice.md @@ -8,8 +8,6 @@ > **readDecisionChoice**(`answers`, `id`): [`DecisionChoiceReading`](../type-aliases/DecisionChoiceReading.md) \| `undefined` -Defined in: [utils/decisionAnswers.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/utils/decisionAnswers.ts#L41) - Read a choice answer, including the full ranking. `ranked` is the distribution sorted highest-first. This is what makes one diff --git a/docs/api/functions/readDecisionScore.md b/docs/api/functions/readDecisionScore.md index 88566a0f7..b599e3eae 100644 --- a/docs/api/functions/readDecisionScore.md +++ b/docs/api/functions/readDecisionScore.md @@ -8,8 +8,6 @@ > **readDecisionScore**(`answers`, `id`): [`DecisionScoreReading`](../type-aliases/DecisionScoreReading.md) \| `undefined` -Defined in: [utils/decisionAnswers.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/utils/decisionAnswers.ts#L56) - The `decide` inference type — typed, calibrated judgements from a model that generates no text, alongside `generate` and `stream`. diff --git a/docs/api/functions/reciprocalRankFusion.md b/docs/api/functions/reciprocalRankFusion.md index d0fe42b88..2580cee96 100644 --- a/docs/api/functions/reciprocalRankFusion.md +++ b/docs/api/functions/reciprocalRankFusion.md @@ -8,8 +8,6 @@ > **reciprocalRankFusion**(`rankings`, `k?`): `Map`\<`string`, `number`\> -Defined in: [rag/retrieval/hybridSearch.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/rag/retrieval/hybridSearch.ts#L151) - Reciprocal Rank Fusion Combines rankings from multiple retrieval methods diff --git a/docs/api/functions/registerAllRoutes.md b/docs/api/functions/registerAllRoutes.md index 79152b8e7..dac1c325a 100644 --- a/docs/api/functions/registerAllRoutes.md +++ b/docs/api/functions/registerAllRoutes.md @@ -8,8 +8,6 @@ > **registerAllRoutes**(`adapter`, `basePath?`, `options?`): `void` -Defined in: [server/routes/index.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/server/routes/index.ts#L88) - Register all routes with a server adapter ## Parameters diff --git a/docs/api/functions/registerDefaultAvatarHandlers.md b/docs/api/functions/registerDefaultAvatarHandlers.md index b25dffce8..e525b1705 100644 --- a/docs/api/functions/registerDefaultAvatarHandlers.md +++ b/docs/api/functions/registerDefaultAvatarHandlers.md @@ -8,8 +8,6 @@ > **registerDefaultAvatarHandlers**(): `void` -Defined in: [avatar/index.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/avatar/index.ts#L89) - Register every shipped avatar handler whose backing credentials are present in the environment. Safe to call multiple times — existing registrations are preserved. diff --git a/docs/api/functions/registerDefaultMusicHandlers.md b/docs/api/functions/registerDefaultMusicHandlers.md index 79c2bd55a..421a38860 100644 --- a/docs/api/functions/registerDefaultMusicHandlers.md +++ b/docs/api/functions/registerDefaultMusicHandlers.md @@ -8,8 +8,6 @@ > **registerDefaultMusicHandlers**(): `void` -Defined in: [music/index.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/music/index.ts#L95) - Register every shipped music handler whose backing credentials are present in the environment. Safe to call multiple times — existing registrations are preserved. diff --git a/docs/api/functions/registerDefaultRealtimeHandlers.md b/docs/api/functions/registerDefaultRealtimeHandlers.md index dec09a472..8b0f9ccc3 100644 --- a/docs/api/functions/registerDefaultRealtimeHandlers.md +++ b/docs/api/functions/registerDefaultRealtimeHandlers.md @@ -8,8 +8,6 @@ > **registerDefaultRealtimeHandlers**(): `void` -Defined in: [voice/index.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/voice/index.ts#L333) - Register every shipped Realtime handler. Realtime handlers don't gate registration on isConfigured() because session-time API keys can be supplied per-call; missing creds surface when `connect()` is invoked. diff --git a/docs/api/functions/registerDefaultSTTHandlers.md b/docs/api/functions/registerDefaultSTTHandlers.md index c61ad9d44..e19103af3 100644 --- a/docs/api/functions/registerDefaultSTTHandlers.md +++ b/docs/api/functions/registerDefaultSTTHandlers.md @@ -8,8 +8,6 @@ > **registerDefaultSTTHandlers**(): `void` -Defined in: [voice/index.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/voice/index.ts#L317) - Register every shipped STT handler whose backing credentials are present in the environment. Safe to call multiple times. diff --git a/docs/api/functions/registerDefaultTTSHandlers.md b/docs/api/functions/registerDefaultTTSHandlers.md index 1def5254e..36c4522bc 100644 --- a/docs/api/functions/registerDefaultTTSHandlers.md +++ b/docs/api/functions/registerDefaultTTSHandlers.md @@ -8,8 +8,6 @@ > **registerDefaultTTSHandlers**(): `void` -Defined in: [voice/index.ts:302](https://github.com/juspay/neurolink/blob/release/src/lib/voice/index.ts#L302) - Register every shipped TTS handler whose backing credentials are present in the environment. Safe to call multiple times. diff --git a/docs/api/functions/registerDefaultVideoHandlers.md b/docs/api/functions/registerDefaultVideoHandlers.md index 262206860..e0b4d1fc6 100644 --- a/docs/api/functions/registerDefaultVideoHandlers.md +++ b/docs/api/functions/registerDefaultVideoHandlers.md @@ -8,8 +8,6 @@ > **registerDefaultVideoHandlers**(): `void` -Defined in: [adapters/video/index.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/video/index.ts#L82) - Register every shipped video handler whose backing credentials are present in the environment. Safe to call multiple times — existing registrations are preserved. diff --git a/docs/api/functions/registerLocalUsageReader.md b/docs/api/functions/registerLocalUsageReader.md index 4f45a2568..9d0f0930a 100644 --- a/docs/api/functions/registerLocalUsageReader.md +++ b/docs/api/functions/registerLocalUsageReader.md @@ -8,8 +8,6 @@ > **registerLocalUsageReader**(`registration`): `void` -Defined in: [localUsage/localUsageReaderRegistry.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/localUsage/localUsageReaderRegistry.ts#L20) - ## Parameters ### registration diff --git a/docs/api/functions/registerWorkflow.md b/docs/api/functions/registerWorkflow.md index d0241e419..420f6e16c 100644 --- a/docs/api/functions/registerWorkflow.md +++ b/docs/api/functions/registerWorkflow.md @@ -8,8 +8,6 @@ > **registerWorkflow**(`config`, `options?`): [`RegisterResult`](../type-aliases/RegisterResult.md) -Defined in: [workflow/core/workflowRegistry.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/core/workflowRegistry.ts#L39) - Register a new workflow ## Parameters diff --git a/docs/api/functions/renderCandidate.md b/docs/api/functions/renderCandidate.md index 4792cff5c..c7c92bec5 100644 --- a/docs/api/functions/renderCandidate.md +++ b/docs/api/functions/renderCandidate.md @@ -8,8 +8,6 @@ > **renderCandidate**(`candidate`): `string` -Defined in: [routing/modelCatalog.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/routing/modelCatalog.ts#L372) - Render one candidate as a single criteria line for the decision model. Terse on purpose: this text is multiplied by the candidate count inside a diff --git a/docs/api/functions/requireAuth.md b/docs/api/functions/requireAuth.md index 7ba6b7b1a..5e180d354 100644 --- a/docs/api/functions/requireAuth.md +++ b/docs/api/functions/requireAuth.md @@ -8,8 +8,6 @@ > **requireAuth**(): [`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md) -Defined in: [auth/authContext.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L123) - Require authentication Throws if no auth context is available. diff --git a/docs/api/functions/requirePermission.md b/docs/api/functions/requirePermission.md index 170a0b63e..86c09673e 100644 --- a/docs/api/functions/requirePermission.md +++ b/docs/api/functions/requirePermission.md @@ -8,8 +8,6 @@ > **requirePermission**(`permission`): `void` -Defined in: [auth/authContext.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L231) - Require a permission Throws if user doesn't have the permission. diff --git a/docs/api/functions/requireRole.md b/docs/api/functions/requireRole.md index 27ef431c5..f0276d6de 100644 --- a/docs/api/functions/requireRole.md +++ b/docs/api/functions/requireRole.md @@ -8,8 +8,6 @@ > **requireRole**(`role`): `void` -Defined in: [auth/authContext.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L248) - Require a role Throws if user doesn't have the role. diff --git a/docs/api/functions/requireUser.md b/docs/api/functions/requireUser.md index c680ed143..113cc23ad 100644 --- a/docs/api/functions/requireUser.md +++ b/docs/api/functions/requireUser.md @@ -8,8 +8,6 @@ > **requireUser**(`userId`): [`AuthenticatedContext`](../type-aliases/AuthenticatedContext.md) -Defined in: [auth/authContext.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L140) - Require a specific user Throws if no auth context or user doesn't match. diff --git a/docs/api/functions/requiresConfirmation.md b/docs/api/functions/requiresConfirmation.md index 4b2988a6f..70064a4d6 100644 --- a/docs/api/functions/requiresConfirmation.md +++ b/docs/api/functions/requiresConfirmation.md @@ -8,8 +8,6 @@ > **requiresConfirmation**(`tool`): `boolean` -Defined in: [mcp/toolAnnotations.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L240) - Check if a tool requires confirmation based on annotations ## Parameters diff --git a/docs/api/functions/rerank.md b/docs/api/functions/rerank.md index 1f74a580e..44b987573 100644 --- a/docs/api/functions/rerank.md +++ b/docs/api/functions/rerank.md @@ -8,8 +8,6 @@ > **rerank**(`results`, `query`, `model`, `options?`): `Promise`\<[`RerankResult`](../type-aliases/RerankResult.md)[]\> -Defined in: [rag/reranker/reranker.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L41) - Rerank vector search results using multi-factor scoring Combines three scoring factors: diff --git a/docs/api/functions/resetMetricsAggregator.md b/docs/api/functions/resetMetricsAggregator.md index 6bee92a4d..bd74c8900 100644 --- a/docs/api/functions/resetMetricsAggregator.md +++ b/docs/api/functions/resetMetricsAggregator.md @@ -8,8 +8,6 @@ > **resetMetricsAggregator**(): `void` -Defined in: [observability/metricsAggregator.ts:641](https://github.com/juspay/neurolink/blob/release/src/lib/observability/metricsAggregator.ts#L641) - Reset the global metrics aggregator (for testing) ## Returns diff --git a/docs/api/functions/resolveArtifactStorageType.md b/docs/api/functions/resolveArtifactStorageType.md index f40bc0a53..a3af499b1 100644 --- a/docs/api/functions/resolveArtifactStorageType.md +++ b/docs/api/functions/resolveArtifactStorageType.md @@ -8,8 +8,6 @@ > **resolveArtifactStorageType**(`config?`): [`ArtifactStorageType`](../type-aliases/ArtifactStorageType.md) -Defined in: [artifacts/artifactStoreFactory.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/artifacts/artifactStoreFactory.ts#L64) - Which backend `config` and the environment select. ## Parameters diff --git a/docs/api/functions/resolveDefaultDecisionProvider.md b/docs/api/functions/resolveDefaultDecisionProvider.md index 9670653f9..f375650c5 100644 --- a/docs/api/functions/resolveDefaultDecisionProvider.md +++ b/docs/api/functions/resolveDefaultDecisionProvider.md @@ -8,8 +8,6 @@ > **resolveDefaultDecisionProvider**(`credentials?`): `string` \| `undefined` -Defined in: [factories/providerDescriptors.ts:702](https://github.com/juspay/neurolink/blob/release/src/lib/factories/providerDescriptors.ts#L702) - The decision provider to use when a caller names none: the first DECISION_PROVIDERS entry that is fully configured, from the environment or from `credentials`. diff --git a/docs/api/functions/resolveEntry.md b/docs/api/functions/resolveEntry.md index 791c15a72..0584bb0ef 100644 --- a/docs/api/functions/resolveEntry.md +++ b/docs/api/functions/resolveEntry.md @@ -8,8 +8,6 @@ > **resolveEntry**(`input`, `version`): [`NormalizedKnowledgeEntry`](../type-aliases/NormalizedKnowledgeEntry.md) -Defined in: [knowledge/resolve.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/resolve.ts#L48) - Resolve one authored entry into a complete `NormalizedKnowledgeEntry`, materializing every omitted optional (optional arrays to `[]`, `body` to "", `kind` to "text", `status` to "active") so downstream code never re-checks diff --git a/docs/api/functions/resolveHistoryBudget.md b/docs/api/functions/resolveHistoryBudget.md index 7b546e046..deb4213d1 100644 --- a/docs/api/functions/resolveHistoryBudget.md +++ b/docs/api/functions/resolveHistoryBudget.md @@ -8,8 +8,6 @@ > **resolveHistoryBudget**(`result`, `compactionThreshold?`): `number` -Defined in: [context/budgetChecker.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/context/budgetChecker.ts#L52) - Tokens the CONVERSATION HISTORY may occupy, i.e. the model's available input space minus everything that rides alongside it (system prompt, current prompt, tool definitions, file attachments). diff --git a/docs/api/functions/resolveToolRoutingExclusions.md b/docs/api/functions/resolveToolRoutingExclusions.md index b35b381c6..c3ab6e717 100644 --- a/docs/api/functions/resolveToolRoutingExclusions.md +++ b/docs/api/functions/resolveToolRoutingExclusions.md @@ -8,8 +8,6 @@ > **resolveToolRoutingExclusions**(`params`): `Promise`\<`string`[]\> -Defined in: [core/toolRouting.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRouting.ts#L400) - Resolves which registered tool names to EXCLUDE for a single stream() turn. Returns an empty list on any skip/failure path — see module doc. diff --git a/docs/api/functions/retrieve.md b/docs/api/functions/retrieve.md index 9d22e9233..18bb25476 100644 --- a/docs/api/functions/retrieve.md +++ b/docs/api/functions/retrieve.md @@ -8,8 +8,6 @@ > **retrieve**(`snapshot`, `request`, `config`, `blockedDomains?`): [`KnowledgeSelection`](../type-aliases/KnowledgeSelection.md) -Defined in: [knowledge/retrieval.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/retrieval.ts#L160) - Run retrieval against a ready snapshot. Returns the primary selection, a bounded relationship expansion, the scored candidate list (diagnostics), and a confidence class. Context assembly is a separate, later step. diff --git a/docs/api/functions/runWithAuthContext.md b/docs/api/functions/runWithAuthContext.md index 0547a73cc..bfa4cce66 100644 --- a/docs/api/functions/runWithAuthContext.md +++ b/docs/api/functions/runWithAuthContext.md @@ -8,8 +8,6 @@ > **runWithAuthContext**\<`T`\>(`context`, `callback`): `T` \| `Promise`\<`T`\> -Defined in: [auth/authContext.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/auth/authContext.ts#L40) - Run a function with authentication context Sets up async local storage so getAuthContext() can be called diff --git a/docs/api/functions/runWithCurrentLangfuseContext.md b/docs/api/functions/runWithCurrentLangfuseContext.md index 180921966..1d255811b 100644 --- a/docs/api/functions/runWithCurrentLangfuseContext.md +++ b/docs/api/functions/runWithCurrentLangfuseContext.md @@ -8,8 +8,6 @@ > **runWithCurrentLangfuseContext**\<`T`\>(`fn`): () => `Promise`\<`T`\> -Defined in: [services/server/ai/observability/instrumentation.ts:1521](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1521) - Capture the current Langfuse AsyncLocalStorage context and return a wrapper that re-enters that context when executing the provided callback. diff --git a/docs/api/functions/runWorkflow.md b/docs/api/functions/runWorkflow.md index 51a93a8b1..8b19405ac 100644 --- a/docs/api/functions/runWorkflow.md +++ b/docs/api/functions/runWorkflow.md @@ -8,8 +8,6 @@ > **runWorkflow**(`config`, `options`): `Promise`\<[`WorkflowResult`](../type-aliases/WorkflowResult.md)\> -Defined in: [workflow/core/workflowRunner.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/core/workflowRunner.ts#L74) - Execute a complete workflow This is the main entry point that orchestrates: diff --git a/docs/api/functions/sanitizeToolName.md b/docs/api/functions/sanitizeToolName.md index b29a1ed4e..5eb38c692 100644 --- a/docs/api/functions/sanitizeToolName.md +++ b/docs/api/functions/sanitizeToolName.md @@ -8,8 +8,6 @@ > **sanitizeToolName**(`name`): `string` -Defined in: [mcp/toolConverter.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L318) - Sanitize tool name for MCP compatibility ## Parameters diff --git a/docs/api/functions/scorerToSpanAttributes.md b/docs/api/functions/scorerToSpanAttributes.md index e8b6fffa0..5e10d46b8 100644 --- a/docs/api/functions/scorerToSpanAttributes.md +++ b/docs/api/functions/scorerToSpanAttributes.md @@ -8,8 +8,6 @@ > **scorerToSpanAttributes**(`result`): [`EvaluationSpanAttributes`](../type-aliases/EvaluationSpanAttributes.md) -Defined in: [evaluation/hooks/observabilityHooks.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/observabilityHooks.ts#L216) - Create span attributes from scorer result ## Parameters diff --git a/docs/api/functions/selectIrrelevantMessages.md b/docs/api/functions/selectIrrelevantMessages.md index e5f835d07..bc746b607 100644 --- a/docs/api/functions/selectIrrelevantMessages.md +++ b/docs/api/functions/selectIrrelevantMessages.md @@ -8,8 +8,6 @@ > **selectIrrelevantMessages**(`messages`, `currentRequest`, `decide`, `options?`): `Promise`\<[`ContextRelevanceResult`](../type-aliases/ContextRelevanceResult.md) \| `null`\> -Defined in: [context/contextDecision.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/context/contextDecision.ts#L104) - Ask which earlier messages the current request still needs, and return the ones to drop. diff --git a/docs/api/functions/selectRelevantToolNames.md b/docs/api/functions/selectRelevantToolNames.md index ea69fd0cf..bf30d8c21 100644 --- a/docs/api/functions/selectRelevantToolNames.md +++ b/docs/api/functions/selectRelevantToolNames.md @@ -8,8 +8,6 @@ > **selectRelevantToolNames**(`query`, `items`, `opts`): `Promise`\<`string`[]\> -Defined in: [core/toolRoutingEmbedding.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingEmbedding.ts#L382) - Selects the most relevant tool names from a catalog given a query. Creates a temporary `ToolEmbeddingIndex`, runs `rank()`, and returns just diff --git a/docs/api/functions/selectServersByDecision.md b/docs/api/functions/selectServersByDecision.md index 434ec18c6..f8e093062 100644 --- a/docs/api/functions/selectServersByDecision.md +++ b/docs/api/functions/selectServersByDecision.md @@ -8,8 +8,6 @@ > **selectServersByDecision**(`userQuery`, `routableServers`, `decide`, `options?`): `Promise`\<[`ToolRoutingDecisionOutcome`](../type-aliases/ToolRoutingDecisionOutcome.md) \| `null`\> -Defined in: [core/toolRoutingDecision.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/core/toolRoutingDecision.ts#L108) - Ask one yes/no question per routable server and return the servers to keep. Returns `null` when the caller should fall through to its existing path: diff --git a/docs/api/functions/serverToolToMCPProtocol.md b/docs/api/functions/serverToolToMCPProtocol.md index 21ea65649..a6149a344 100644 --- a/docs/api/functions/serverToolToMCPProtocol.md +++ b/docs/api/functions/serverToolToMCPProtocol.md @@ -8,8 +8,6 @@ > **serverToolToMCPProtocol**(`tool`): [`MCPProtocolTool`](../type-aliases/MCPProtocolTool.md) -Defined in: [mcp/toolConverter.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L186) - Convert MCPServerTool to MCP protocol tool format (For exposing tools to external MCP clients) diff --git a/docs/api/functions/servesInferenceKind.md b/docs/api/functions/servesInferenceKind.md index b89554e63..61cceda8f 100644 --- a/docs/api/functions/servesInferenceKind.md +++ b/docs/api/functions/servesInferenceKind.md @@ -8,8 +8,6 @@ > **servesInferenceKind**(`descriptor`, `kind`): `boolean` -Defined in: [utils/decisionAnswers.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/utils/decisionAnswers.ts#L78) - Whether a descriptor declares support for a given inference type. ## Parameters diff --git a/docs/api/functions/setLangfuseContext.md b/docs/api/functions/setLangfuseContext.md index 74090fcc2..dc185452c 100644 --- a/docs/api/functions/setLangfuseContext.md +++ b/docs/api/functions/setLangfuseContext.md @@ -8,8 +8,6 @@ > **setLangfuseContext**\<`T`\>(`context`, `callback?`): `Promise`\<`void` \| `T`\> -Defined in: [services/server/ai/observability/instrumentation.ts:1366](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1366) - Set user and session context for Langfuse spans in the current async context Merges the provided context with existing AsyncLocalStorage context. If a callback is provided, diff --git a/docs/api/functions/shutdownOpenTelemetry.md b/docs/api/functions/shutdownOpenTelemetry.md index b37958104..b27ac6429 100644 --- a/docs/api/functions/shutdownOpenTelemetry.md +++ b/docs/api/functions/shutdownOpenTelemetry.md @@ -8,8 +8,6 @@ > **shutdownOpenTelemetry**(): `Promise`\<`void`\> -Defined in: [services/server/ai/observability/instrumentation.ts:1225](https://github.com/juspay/neurolink/blob/release/src/lib/services/server/ai/observability/instrumentation.ts#L1225) - Shutdown OpenTelemetry and Langfuse span processor ## Returns diff --git a/docs/api/functions/simpleRerank.md b/docs/api/functions/simpleRerank.md index f61f74eb9..b52ca9a58 100644 --- a/docs/api/functions/simpleRerank.md +++ b/docs/api/functions/simpleRerank.md @@ -8,8 +8,6 @@ > **simpleRerank**(`results`, `options?`): [`RerankResult`](../type-aliases/RerankResult.md)[] -Defined in: [rag/reranker/reranker.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/rag/reranker/reranker.ts#L333) - Simple position-based reranker (no LLM required) Uses only vector score and position diff --git a/docs/api/functions/sniffImageMimeType.md b/docs/api/functions/sniffImageMimeType.md index e954250f0..498a17881 100644 --- a/docs/api/functions/sniffImageMimeType.md +++ b/docs/api/functions/sniffImageMimeType.md @@ -8,8 +8,6 @@ > **sniffImageMimeType**(`buffer`): `string` \| `null` -Defined in: [utils/imageDetection.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/utils/imageDetection.ts#L20) - Detect an image's MIME type from its magic bytes, or `null` when the bytes match no known signature. diff --git a/docs/api/functions/startLangfuseAdapter.md b/docs/api/functions/startLangfuseAdapter.md index e927c3b31..30b2dd274 100644 --- a/docs/api/functions/startLangfuseAdapter.md +++ b/docs/api/functions/startLangfuseAdapter.md @@ -8,8 +8,6 @@ > **startLangfuseAdapter**(`config`): `LangfuseAdapter` -Defined in: [evaluation/hooks/langfuseAdapter.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/hooks/langfuseAdapter.ts#L197) - Create and start a Langfuse adapter ## Parameters diff --git a/docs/api/functions/stepCountIs.md b/docs/api/functions/stepCountIs.md index be4065ca7..116657f36 100644 --- a/docs/api/functions/stepCountIs.md +++ b/docs/api/functions/stepCountIs.md @@ -8,8 +8,6 @@ > **stepCountIs**(`stepCount`): (`__namedParameters`) => `boolean` -Defined in: [utils/tool.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tool.ts#L66) - ## Parameters ### stepCount diff --git a/docs/api/functions/streamBatchEvaluation.md b/docs/api/functions/streamBatchEvaluation.md index e1f63e83b..eca9041fd 100644 --- a/docs/api/functions/streamBatchEvaluation.md +++ b/docs/api/functions/streamBatchEvaluation.md @@ -8,8 +8,6 @@ > **streamBatchEvaluation**(`pipeline`, `inputs`, `config?`): `AsyncGenerator`\<[`BatchItemResult`](../type-aliases/BatchItemResult.md), \{ `total`: `number`; `succeeded`: `number`; `failed`: `number`; `averageScore`: `number`; `averageDuration`: `number`; `totalDuration`: `number`; `passingRate`: `number`; \}, `void`\> -Defined in: [evaluation/pipeline/strategies/batchStrategy.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/evaluation/pipeline/strategies/batchStrategy.ts#L240) - Stream batch evaluation results ## Parameters diff --git a/docs/api/functions/summarizeContext.md b/docs/api/functions/summarizeContext.md index 5d4615ce3..f0c316d93 100644 --- a/docs/api/functions/summarizeContext.md +++ b/docs/api/functions/summarizeContext.md @@ -8,8 +8,6 @@ > **summarizeContext**(`context`, `maxLength?`, `provider?`): `Promise`\<`string`\> -Defined in: [rag/pipeline/contextAssembly.ts:273](https://github.com/juspay/neurolink/blob/release/src/lib/rag/pipeline/contextAssembly.ts#L273) - Summarize context using LLM ## Parameters diff --git a/docs/api/functions/summaryPreservesContext.md b/docs/api/functions/summaryPreservesContext.md index 3868b0a99..6e04e1323 100644 --- a/docs/api/functions/summaryPreservesContext.md +++ b/docs/api/functions/summaryPreservesContext.md @@ -8,8 +8,6 @@ > **summaryPreservesContext**(`summary`, `replacedMessages`, `decide`, `options?`): `Promise`\<`boolean`\> -Defined in: [context/contextDecision.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/context/contextDecision.ts#L223) - Gate a generated summary before it replaces the messages it covers. Stage 3 accepts any non-empty string today, so a summarizer that returned diff --git a/docs/api/functions/supportsNativeVideo.md b/docs/api/functions/supportsNativeVideo.md index f482bad82..af90d28bd 100644 --- a/docs/api/functions/supportsNativeVideo.md +++ b/docs/api/functions/supportsNativeVideo.md @@ -8,8 +8,6 @@ > **supportsNativeVideo**(`provider`, `model?`): `boolean` -Defined in: [adapters/videoFormatSupport.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/adapters/videoFormatSupport.ts#L305) - Whether `provider` (optionally, running `model`) can be handed raw video bytes. See [getVideoProviderConfig](getVideoProviderConfig.md) for the Claude-on-Vertex case. diff --git a/docs/api/functions/toErrorInfo.md b/docs/api/functions/toErrorInfo.md index 4a6f9fbaa..52df96e64 100644 --- a/docs/api/functions/toErrorInfo.md +++ b/docs/api/functions/toErrorInfo.md @@ -8,8 +8,6 @@ > **toErrorInfo**(`error`): [`ErrorInfo`](../type-aliases/ErrorInfo.md) -Defined in: [types/common.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L142) - Safe error conversion ## Parameters diff --git a/docs/api/functions/tokenize.md b/docs/api/functions/tokenize.md index d302bfa61..2bce14e60 100644 --- a/docs/api/functions/tokenize.md +++ b/docs/api/functions/tokenize.md @@ -8,8 +8,6 @@ > **tokenize**(`input`): `string`[] -Defined in: [knowledge/normalize.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/normalize.ts#L62) - Normalize then split into tokens. Empty input yields an empty array. Numbers and alphanumeric identifiers are preserved as their own tokens. diff --git a/docs/api/functions/tool.md b/docs/api/functions/tool.md index f149e52a6..72fa29f47 100644 --- a/docs/api/functions/tool.md +++ b/docs/api/functions/tool.md @@ -10,8 +10,6 @@ > **tool**\<`INPUT`, `OUTPUT`\>(`definition`): [`Tool`](../type-aliases/Tool.md)\<`INPUT`, `OUTPUT`\> -Defined in: [utils/tool.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tool.ts#L28) - ### Type Parameters #### INPUT @@ -36,8 +34,6 @@ Defined in: [utils/tool.ts:28](https://github.com/juspay/neurolink/blob/release/ > **tool**\<`INPUT`\>(`definition`): [`Tool`](../type-aliases/Tool.md)\<`INPUT`, `never`\> -Defined in: [utils/tool.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/utils/tool.ts#L32) - ### Type Parameters #### INPUT diff --git a/docs/api/functions/validateAnnotations.md b/docs/api/functions/validateAnnotations.md index bd5fc4fa7..2e1a8a329 100644 --- a/docs/api/functions/validateAnnotations.md +++ b/docs/api/functions/validateAnnotations.md @@ -8,8 +8,6 @@ > **validateAnnotations**(`annotations`): `string`[] -Defined in: [mcp/toolAnnotations.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolAnnotations.ts#L168) - Validate tool annotations Returns list of validation errors (empty if valid) diff --git a/docs/api/functions/validateMCPTool.md b/docs/api/functions/validateMCPTool.md index 0cea3a094..3e745e5cc 100644 --- a/docs/api/functions/validateMCPTool.md +++ b/docs/api/functions/validateMCPTool.md @@ -8,8 +8,6 @@ > **validateMCPTool**(`tool`): `boolean` -Defined in: [mcp/factory.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/factory.ts#L144) - Utility function to validate tool interface using centralized validation Ensures proper async patterns and type safety diff --git a/docs/api/functions/validateParams.md b/docs/api/functions/validateParams.md index ffa651604..3351a6b3d 100644 --- a/docs/api/functions/validateParams.md +++ b/docs/api/functions/validateParams.md @@ -8,8 +8,6 @@ > **validateParams**\<`T`\>(`schema`, `params`, `requestId?`): [`ServerValidationResult`](../type-aliases/ServerValidationResult.md)\<`T`\> -Defined in: [server/utils/validation.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/server/utils/validation.ts#L306) - Validate path parameters against a Zod schema ## Type Parameters diff --git a/docs/api/functions/validateQuery.md b/docs/api/functions/validateQuery.md index 9e9bf2e8e..724c96ba8 100644 --- a/docs/api/functions/validateQuery.md +++ b/docs/api/functions/validateQuery.md @@ -8,8 +8,6 @@ > **validateQuery**\<`T`\>(`schema`, `query`, `requestId?`): [`ServerValidationResult`](../type-aliases/ServerValidationResult.md)\<`T`\> -Defined in: [server/utils/validation.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/server/utils/validation.ts#L274) - Validate query parameters against a Zod schema ## Type Parameters diff --git a/docs/api/functions/validateRequest.md b/docs/api/functions/validateRequest.md index 4cdb0fd64..f1c9bda60 100644 --- a/docs/api/functions/validateRequest.md +++ b/docs/api/functions/validateRequest.md @@ -8,8 +8,6 @@ > **validateRequest**\<`T`\>(`schema`, `data`, `requestId?`): [`ServerValidationResult`](../type-aliases/ServerValidationResult.md)\<`T`\> -Defined in: [server/utils/validation.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/server/utils/validation.ts#L242) - Validate request body against a Zod schema ## Type Parameters diff --git a/docs/api/functions/validateResponse.md b/docs/api/functions/validateResponse.md index b9a0cde48..d035a3b0c 100644 --- a/docs/api/functions/validateResponse.md +++ b/docs/api/functions/validateResponse.md @@ -8,8 +8,6 @@ > **validateResponse**(`responseText`, `config`, `retryCount?`): [`ResponseValidationResult`](../type-aliases/ResponseValidationResult.md) -Defined in: [utils/responseValidator.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/utils/responseValidator.ts#L243) - Validate (and optionally mutate) an LLM response. ## Parameters diff --git a/docs/api/functions/validateServerTools.md b/docs/api/functions/validateServerTools.md index 877502fc4..accff7ce7 100644 --- a/docs/api/functions/validateServerTools.md +++ b/docs/api/functions/validateServerTools.md @@ -8,8 +8,6 @@ > **validateServerTools**(`server`): `Promise`\<\{ `isValid`: `boolean`; `invalidTools`: `string`[]; `errors`: `string`[]; \}\> -Defined in: [mcp/factory.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/factory.ts#L178) - Async utility function to validate all tools in a server Ensures all registered tools follow proper async patterns diff --git a/docs/api/functions/validateTool.md b/docs/api/functions/validateTool.md index dbb825ddb..75000f23c 100644 --- a/docs/api/functions/validateTool.md +++ b/docs/api/functions/validateTool.md @@ -8,8 +8,6 @@ > **validateTool**(`name`, `tool`): `void` -Defined in: [sdk/toolRegistration.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/sdk/toolRegistration.ts#L331) - Validate tool configuration with detailed error messages ## Parameters diff --git a/docs/api/functions/validateToolName.md b/docs/api/functions/validateToolName.md index 24ad12314..11cf89672 100644 --- a/docs/api/functions/validateToolName.md +++ b/docs/api/functions/validateToolName.md @@ -8,8 +8,6 @@ > **validateToolName**(`name`): `object` -Defined in: [mcp/toolConverter.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolConverter.ts#L292) - Validate tool name according to MCP specification ## Parameters diff --git a/docs/api/functions/validateWorkflow.md b/docs/api/functions/validateWorkflow.md index 87dc9db83..ebb16584b 100644 --- a/docs/api/functions/validateWorkflow.md +++ b/docs/api/functions/validateWorkflow.md @@ -8,8 +8,6 @@ > **validateWorkflow**(`config`): [`WorkflowValidationResult`](../type-aliases/WorkflowValidationResult.md) -Defined in: [workflow/utils/workflowValidation.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/workflow/utils/workflowValidation.ts#L34) - Comprehensive workflow validation ## Parameters diff --git a/docs/api/functions/withHTTPRetry.md b/docs/api/functions/withHTTPRetry.md index 964aa5d73..16cf93300 100644 --- a/docs/api/functions/withHTTPRetry.md +++ b/docs/api/functions/withHTTPRetry.md @@ -8,8 +8,6 @@ > **withHTTPRetry**\<`T`\>(`operation`, `config?`): `Promise`\<`T`\> -Defined in: [mcp/httpRetryHandler.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/httpRetryHandler.ts#L166) - Execute an HTTP operation with retry logic Implements exponential backoff with jitter to avoid thundering herd problems. diff --git a/docs/api/functions/withRetry.md b/docs/api/functions/withRetry.md index 1e03e2215..0d56dd98a 100644 --- a/docs/api/functions/withRetry.md +++ b/docs/api/functions/withRetry.md @@ -8,8 +8,6 @@ > **withRetry**\<`T`\>(`operation`, `options`): `Promise`\<`T`\> -Defined in: [core/infrastructure/retry.ts:3](https://github.com/juspay/neurolink/blob/release/src/lib/core/infrastructure/retry.ts#L3) - ## Type Parameters ### T diff --git a/docs/api/functions/wrapError.md b/docs/api/functions/wrapError.md index f612f13cb..dabaac9d2 100644 --- a/docs/api/functions/wrapError.md +++ b/docs/api/functions/wrapError.md @@ -8,8 +8,6 @@ > **wrapError**(`error`, `requestId?`, `path?`, `method?`): [`ServerAdapterError`](../classes/ServerAdapterError.md) -Defined in: [server/errors.ts:607](https://github.com/juspay/neurolink/blob/release/src/lib/server/errors.ts#L607) - Helper to wrap errors as ServerAdapterError ## Parameters diff --git a/docs/api/functions/wrapToolWithElicitation.md b/docs/api/functions/wrapToolWithElicitation.md index 7004f40e0..273bbe354 100644 --- a/docs/api/functions/wrapToolWithElicitation.md +++ b/docs/api/functions/wrapToolWithElicitation.md @@ -8,8 +8,6 @@ > **wrapToolWithElicitation**(`tool`, `options?`): [`MCPServerTool`](../type-aliases/MCPServerTool.md) -Defined in: [mcp/toolIntegration.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L79) - Wrap a tool with elicitation support ## Parameters diff --git a/docs/api/functions/wrapToolsWithElicitation.md b/docs/api/functions/wrapToolsWithElicitation.md index 6bee1cfae..ad4be6cfa 100644 --- a/docs/api/functions/wrapToolsWithElicitation.md +++ b/docs/api/functions/wrapToolsWithElicitation.md @@ -8,8 +8,6 @@ > **wrapToolsWithElicitation**(`tools`, `options?`): [`MCPServerTool`](../type-aliases/MCPServerTool.md)[] -Defined in: [mcp/toolIntegration.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/mcp/toolIntegration.ts#L164) - Batch wrap tools with elicitation support ## Parameters diff --git a/docs/api/type-aliases/AIModelProviderConfig.md b/docs/api/type-aliases/AIModelProviderConfig.md index d7977698e..ca9214554 100644 --- a/docs/api/type-aliases/AIModelProviderConfig.md +++ b/docs/api/type-aliases/AIModelProviderConfig.md @@ -8,8 +8,6 @@ > **AIModelProviderConfig** = `object` -Defined in: [types/providers.ts:563](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L563) - Provider configuration specifying provider and its available models (from core types) ## Properties @@ -18,12 +16,8 @@ Provider configuration specifying provider and its available models (from core t > **provider**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/providers.ts:564](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L564) - --- ### models > **models**: [`SupportedModelName`](SupportedModelName.md)[] - -Defined in: [types/providers.ts:565](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L565) diff --git a/docs/api/type-aliases/AIProvider.md b/docs/api/type-aliases/AIProvider.md index 5d6b3c77e..5ad6321bc 100644 --- a/docs/api/type-aliases/AIProvider.md +++ b/docs/api/type-aliases/AIProvider.md @@ -8,8 +8,6 @@ > **AIProvider** = `object` -Defined in: [types/providers.ts:912](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L912) - AI Provider type with flexible parameter support ## Methods @@ -18,8 +16,6 @@ AI Provider type with flexible parameter support > **stream**(`optionsOrPrompt`, `analysisSchema?`): `Promise`\<[`StreamResult`](StreamResult.md)\> -Defined in: [types/providers.ts:914](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L914) - #### Parameters ##### optionsOrPrompt @@ -40,8 +36,6 @@ Defined in: [types/providers.ts:914](https://github.com/juspay/neurolink/blob/re > **generate**(`optionsOrPrompt`, `analysisSchema?`): `Promise`\<[`EnhancedGenerateResult`](EnhancedGenerateResult.md) \| `null`\> -Defined in: [types/providers.ts:919](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L919) - #### Parameters ##### optionsOrPrompt @@ -62,8 +56,6 @@ Defined in: [types/providers.ts:919](https://github.com/juspay/neurolink/blob/re > **gen**(`optionsOrPrompt`, `analysisSchema?`): `Promise`\<[`EnhancedGenerateResult`](EnhancedGenerateResult.md) \| `null`\> -Defined in: [types/providers.ts:924](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L924) - #### Parameters ##### optionsOrPrompt @@ -84,8 +76,6 @@ Defined in: [types/providers.ts:924](https://github.com/juspay/neurolink/blob/re > **embed**(`input`, `modelName?`): `Promise`\<`number`[]\> -Defined in: [types/providers.ts:934](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L934) - Generate an embedding vector for text or multi-modal input. Accepts either a plain string (text-only) or an EmbedInput object for multi-modal embeddings (text + image). @@ -110,8 +100,6 @@ for multi-modal embeddings (text + image). > **embedMany**(`texts`, `modelName?`): `Promise`\<`number`[][]\> -Defined in: [types/providers.ts:939](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L939) - Generate embedding vectors for multiple text inputs in batch. #### Parameters @@ -134,8 +122,6 @@ Generate embedding vectors for multiple text inputs in batch. > `optional` **decide**(`request`): `Promise`\<[`DecisionResult`](DecisionResult.md)\> -Defined in: [types/providers.ts:950](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L950) - Evaluate a state against a batch of typed questions — the `decide` inference type. Implemented by BaseProvider (throws by default, as `embed` does); only providers whose descriptor declares `"decide"` in @@ -160,8 +146,6 @@ must treat absence as "this provider cannot decide". > **setupToolExecutor**(`sdk`, `functionTag`): `void` -Defined in: [types/providers.ts:953](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L953) - #### Parameters ##### sdk @@ -188,8 +172,6 @@ Defined in: [types/providers.ts:953](https://github.com/juspay/neurolink/blob/re > **setTraceContext**(`ctx`): `void` -Defined in: [types/providers.ts:965](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L965) - Propagate trace context from NeuroLink SDK for parent-child span hierarchy. Use this method instead of accessing `_traceContext` directly. @@ -209,8 +191,6 @@ Use this method instead of accessing `_traceContext` directly. > `optional` **setFileToolRootPolicy**(`policy`): `void` -Defined in: [types/providers.ts:971](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L971) - Bind the built-in file tools to one request's root policy. Optional so custom provider implementations keep compiling; BaseProvider implements it. @@ -230,8 +210,6 @@ custom provider implementations keep compiling; BaseProvider implements it. > `optional` **supportsTools**(): `boolean` -Defined in: [types/providers.ts:980](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L980) - Whether this provider supports native tool/function calling for the current model. Implemented by BaseProvider (default true); overridden by providers with model-dependent or absent tool support (ollama, @@ -248,8 +226,6 @@ external AIProvider implementations — callers treat absence as `true`. > `optional` **ensureModelLimits**(): `Promise`\<`void`\> -Defined in: [types/providers.ts:990](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L990) - Ensure runtime-discovered model limits (context window, output-token ceiling) are registered before budget math runs. Implemented by BaseProvider (default no-op); providers with a discovery source override diff --git a/docs/api/type-aliases/AISDKModel.md b/docs/api/type-aliases/AISDKModel.md index e8f9348a7..94013115b 100644 --- a/docs/api/type-aliases/AISDKModel.md +++ b/docs/api/type-aliases/AISDKModel.md @@ -8,8 +8,6 @@ > **AISDKModel** = `object` -Defined in: [types/providers.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L82) - Generic AI SDK model interface ## Index Signature diff --git a/docs/api/type-aliases/AISDKUsage.md b/docs/api/type-aliases/AISDKUsage.md index 792fd0d5c..2a76fec7b 100644 --- a/docs/api/type-aliases/AISDKUsage.md +++ b/docs/api/type-aliases/AISDKUsage.md @@ -8,8 +8,6 @@ > **AISDKUsage** = `object` -Defined in: [types/stream.ts:1128](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1128) - Raw usage data from Vercel AI SDK. Covers both v4 (promptTokens / completionTokens) and @@ -26,8 +24,6 @@ extractTokenUsage() in tokenUtils.ts already handles both shapes. > `optional` **promptTokens?**: `number` -Defined in: [types/stream.ts:1130](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1130) - #### Deprecated AI SDK v4 name — use inputTokens @@ -38,8 +34,6 @@ AI SDK v4 name — use inputTokens > `optional` **completionTokens?**: `number` -Defined in: [types/stream.ts:1132](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1132) - #### Deprecated AI SDK v4 name — use outputTokens @@ -50,8 +44,6 @@ AI SDK v4 name — use outputTokens > `optional` **totalTokens?**: `number` -Defined in: [types/stream.ts:1134](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1134) - #### Deprecated AI SDK v4 name — use totalTokens @@ -62,8 +54,6 @@ AI SDK v4 name — use totalTokens > `optional` **inputTokens?**: `number` -Defined in: [types/stream.ts:1136](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1136) - AI SDK v6 name for prompt / input tokens --- @@ -72,6 +62,4 @@ AI SDK v6 name for prompt / input tokens > `optional` **outputTokens?**: `number` -Defined in: [types/stream.ts:1138](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1138) - AI SDK v6 name for completion / output tokens diff --git a/docs/api/type-aliases/APIValidationResult.md b/docs/api/type-aliases/APIValidationResult.md index 97e62e340..4fcc27ba6 100644 --- a/docs/api/type-aliases/APIValidationResult.md +++ b/docs/api/type-aliases/APIValidationResult.md @@ -8,8 +8,6 @@ > **APIValidationResult** = `object` -Defined in: [types/utilities.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L40) - Enhanced validation result with format checking ## Properties @@ -18,36 +16,26 @@ Enhanced validation result with format checking > **isValid**: `boolean` -Defined in: [types/utilities.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L41) - --- ### apiKey > **apiKey**: `string` -Defined in: [types/utilities.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L42) - --- ### formatValid? > `optional` **formatValid?**: `boolean` -Defined in: [types/utilities.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L43) - --- ### errorType? > `optional` **errorType?**: `"missing"` \| `"format"` \| `"config"` -Defined in: [types/utilities.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L44) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/utilities.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L45) diff --git a/docs/api/type-aliases/AWSCredentialConfig.md b/docs/api/type-aliases/AWSCredentialConfig.md index 668800b71..99cb53f50 100644 --- a/docs/api/type-aliases/AWSCredentialConfig.md +++ b/docs/api/type-aliases/AWSCredentialConfig.md @@ -8,8 +8,6 @@ > **AWSCredentialConfig** = `object` -Defined in: [types/providers.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L159) - AWS Credential Configuration for Bedrock provider ## Properties @@ -18,48 +16,36 @@ AWS Credential Configuration for Bedrock provider > `optional` **region?**: `string` -Defined in: [types/providers.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L160) - --- ### profile? > `optional` **profile?**: `string` -Defined in: [types/providers.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L161) - --- ### roleArn? > `optional` **roleArn?**: `string` -Defined in: [types/providers.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L162) - --- ### roleSessionName? > `optional` **roleSessionName?**: `string` -Defined in: [types/providers.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L163) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/providers.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L164) - --- ### ~~maxRetries?~~ > `optional` **maxRetries?**: `number` -Defined in: [types/providers.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L166) - #### Deprecated Prefer maxAttempts to match AWS SDK v3 config @@ -70,8 +56,6 @@ Prefer maxAttempts to match AWS SDK v3 config > `optional` **maxAttempts?**: `number` -Defined in: [types/providers.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L168) - Number of attempts as per AWS SDK v3 ("retry-mode") --- @@ -80,14 +64,10 @@ Number of attempts as per AWS SDK v3 ("retry-mode") > `optional` **enableDebugLogging?**: `boolean` -Defined in: [types/providers.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L169) - --- ### endpoint? > `optional` **endpoint?**: `string` -Defined in: [types/providers.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L171) - Optional service endpoint override (e.g., VPC/Gov endpoints) diff --git a/docs/api/type-aliases/AbortSignalMiddlewareOptions.md b/docs/api/type-aliases/AbortSignalMiddlewareOptions.md index 820900c15..e36444ac4 100644 --- a/docs/api/type-aliases/AbortSignalMiddlewareOptions.md +++ b/docs/api/type-aliases/AbortSignalMiddlewareOptions.md @@ -8,8 +8,6 @@ > **AbortSignalMiddlewareOptions** = `object` -Defined in: [types/middleware.ts:397](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L397) - Options for the abort-signal middleware. ## Properties @@ -18,8 +16,6 @@ Options for the abort-signal middleware. > `optional` **onAbort?**: (`ctx`) => `void` -Defined in: [types/middleware.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L398) - #### Parameters ##### ctx @@ -35,5 +31,3 @@ Defined in: [types/middleware.ts:398](https://github.com/juspay/neurolink/blob/r ### timeout? > `optional` **timeout?**: `number` - -Defined in: [types/middleware.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L399) diff --git a/docs/api/type-aliases/AccountAdmissionLease.md b/docs/api/type-aliases/AccountAdmissionLease.md index 6323710e6..519c35095 100644 --- a/docs/api/type-aliases/AccountAdmissionLease.md +++ b/docs/api/type-aliases/AccountAdmissionLease.md @@ -8,8 +8,6 @@ > **AccountAdmissionLease** = `object` -Defined in: [types/proxy.ts:1395](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1395) - A release handle for one in-flight request admitted to an OAuth account. ## Methods @@ -18,8 +16,6 @@ A release handle for one in-flight request admitted to an OAuth account. > **release**(): `void` -Defined in: [types/proxy.ts:1395](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1395) - #### Returns `void` diff --git a/docs/api/type-aliases/AccountAdmissionState.md b/docs/api/type-aliases/AccountAdmissionState.md index acc1822be..9cb6f9e16 100644 --- a/docs/api/type-aliases/AccountAdmissionState.md +++ b/docs/api/type-aliases/AccountAdmissionState.md @@ -8,8 +8,6 @@ > **AccountAdmissionState** = `object` -Defined in: [types/proxy.ts:1416](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1416) - In-process request admission state for an OAuth account. ## Properties @@ -18,12 +16,8 @@ In-process request admission state for an OAuth account. > **active**: `number` -Defined in: [types/proxy.ts:1417](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1417) - --- ### waiters > **waiters**: [`AccountAdmissionWaiter`](AccountAdmissionWaiter.md)[] - -Defined in: [types/proxy.ts:1418](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1418) diff --git a/docs/api/type-aliases/AccountAdmissionWaiter.md b/docs/api/type-aliases/AccountAdmissionWaiter.md index 2f504d5b7..5636fb08d 100644 --- a/docs/api/type-aliases/AccountAdmissionWaiter.md +++ b/docs/api/type-aliases/AccountAdmissionWaiter.md @@ -8,8 +8,6 @@ > **AccountAdmissionWaiter** = `object` -Defined in: [types/proxy.ts:1405](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1405) - One queued request waiting for per-account admission capacity. ## Properties @@ -18,16 +16,12 @@ One queued request waiting for per-account admission capacity. > **capacity**: `number` -Defined in: [types/proxy.ts:1406](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1406) - --- ### generation? > `optional` **generation?**: `number` -Defined in: [types/proxy.ts:1411](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1411) - Runtime-config generation of the snapshot the request queued under. The route always passes one (0 from its fallback snapshot when no runtime config store is attached); only direct callers such as test @@ -39,8 +33,6 @@ hooks leave it absent. > **resolve**: (`lease`) => `void` -Defined in: [types/proxy.ts:1412](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1412) - #### Parameters ##### lease diff --git a/docs/api/type-aliases/AccountAllowlist.md b/docs/api/type-aliases/AccountAllowlist.md index 86034492a..5c5ae4aaa 100644 --- a/docs/api/type-aliases/AccountAllowlist.md +++ b/docs/api/type-aliases/AccountAllowlist.md @@ -8,6 +8,4 @@ > **AccountAllowlist** = `ReadonlySet`\<`string`\> -Defined in: [types/proxy.ts:2013](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2013) - Normalized Anthropic account keys eligible for proxy routing. diff --git a/docs/api/type-aliases/AccountCooldownPlan.md b/docs/api/type-aliases/AccountCooldownPlan.md index 7e74d688d..61ed131e9 100644 --- a/docs/api/type-aliases/AccountCooldownPlan.md +++ b/docs/api/type-aliases/AccountCooldownPlan.md @@ -8,24 +8,18 @@ > **AccountCooldownPlan** = `object` -Defined in: [types/proxy.ts:1491](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1491) - ## Properties ### reason > **reason**: [`RateLimitCoolingReason`](RateLimitCoolingReason.md) -Defined in: [types/proxy.ts:1492](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1492) - --- ### scope > **scope**: `"account"` \| `"model"` -Defined in: [types/proxy.ts:1498](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1498) - Whether this limit applies to every request on the account or only to the requested model. Model scope must never be persisted as an account cooldown; the quota window itself remains the routing evidence. @@ -36,8 +30,6 @@ cooldown; the quota window itself remains the routing evidence. > **coolingUntil**: `number` -Defined in: [types/proxy.ts:1500](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1500) - Epoch-ms until which the limiting window is expected to recover. --- @@ -46,8 +38,6 @@ Epoch-ms until which the limiting window is expected to recover. > **rotateImmediately**: `boolean` -Defined in: [types/proxy.ts:1504](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1504) - When true (unified/5h/7d rejected), rotate immediately — retrying the same account is futile until its window resets. When false (transient burst), a small number of jittered same-account retries is allowed first. diff --git a/docs/api/type-aliases/AccountCoolingReason.md b/docs/api/type-aliases/AccountCoolingReason.md index 21218bb91..fa081d371 100644 --- a/docs/api/type-aliases/AccountCoolingReason.md +++ b/docs/api/type-aliases/AccountCoolingReason.md @@ -8,8 +8,6 @@ > **AccountCoolingReason** = _typeof_ `ACCOUNT_COOLING_REASONS`\[`number`\] -Defined in: [types/proxy.ts:2003](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2003) - Why an account is currently cooling. Drives cooldown duration and logging. - "weekly" : 7d unified limit rejected — cool until the weekly reset. diff --git a/docs/api/type-aliases/AccountPoolConfig.md b/docs/api/type-aliases/AccountPoolConfig.md index 2a1596c77..d4e41d86a 100644 --- a/docs/api/type-aliases/AccountPoolConfig.md +++ b/docs/api/type-aliases/AccountPoolConfig.md @@ -8,8 +8,6 @@ > **AccountPoolConfig** = `object` -Defined in: [types/subscription.ts:1178](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1178) - Configuration for AccountPool ## Properties @@ -18,28 +16,20 @@ Configuration for AccountPool > **strategy**: `"round-robin"` \| `"fill-first"` -Defined in: [types/subscription.ts:1179](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1179) - --- ### defaultCooldownMs? > `optional` **defaultCooldownMs?**: `number` -Defined in: [types/subscription.ts:1180](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1180) - --- ### maxCooldownMs? > `optional` **maxCooldownMs?**: `number` -Defined in: [types/subscription.ts:1181](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1181) - --- ### maxRetryAccounts? > `optional` **maxRetryAccounts?**: `number` - -Defined in: [types/subscription.ts:1182](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1182) diff --git a/docs/api/type-aliases/AccountQuota.md b/docs/api/type-aliases/AccountQuota.md index c4564e34b..aadb283a8 100644 --- a/docs/api/type-aliases/AccountQuota.md +++ b/docs/api/type-aliases/AccountQuota.md @@ -8,16 +8,12 @@ > **AccountQuota** = `object` -Defined in: [types/proxy.ts:1736](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1736) - ## Properties ### unifiedStatus? > `optional` **unifiedStatus?**: `string` -Defined in: [types/proxy.ts:1739](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1739) - Top-level unified status. A rejected value can be authoritative even while both 5h and 7d sub-window statuses still report allowed. @@ -27,8 +23,6 @@ while both 5h and 7d sub-window statuses still report allowed. > **sessionUsed**: `number` -Defined in: [types/proxy.ts:1741](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1741) - 0.0-1.0 utilization; ignore the numeric placeholder when status is unknown. --- @@ -37,8 +31,6 @@ Defined in: [types/proxy.ts:1741](https://github.com/juspay/neurolink/blob/relea > **sessionStatus**: `string` -Defined in: [types/proxy.ts:1743](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1743) - "allowed" | "throttled" | "rejected" | "unknown" --- @@ -47,8 +39,6 @@ Defined in: [types/proxy.ts:1743](https://github.com/juspay/neurolink/blob/relea > **sessionResetAt**: `number` -Defined in: [types/proxy.ts:1745](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1745) - Unix timestamp (seconds) when the 5h window resets --- @@ -57,8 +47,6 @@ Unix timestamp (seconds) when the 5h window resets > **weeklyUsed**: `number` -Defined in: [types/proxy.ts:1747](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1747) - 0.0-1.0 utilization; ignore the numeric placeholder when status is unknown. --- @@ -67,8 +55,6 @@ Defined in: [types/proxy.ts:1747](https://github.com/juspay/neurolink/blob/relea > **weeklyStatus**: `string` -Defined in: [types/proxy.ts:1749](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1749) - "allowed" | "throttled" | "rejected" | "unknown" --- @@ -77,8 +63,6 @@ Defined in: [types/proxy.ts:1749](https://github.com/juspay/neurolink/blob/relea > **weeklyResetAt**: `number` -Defined in: [types/proxy.ts:1751](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1751) - Unix timestamp (seconds) when the 7d window resets --- @@ -87,8 +71,6 @@ Unix timestamp (seconds) when the 7d window resets > **fallbackPercentage**: `number` -Defined in: [types/proxy.ts:1753](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1753) - 0.0-1.0 (from fallback-percentage) --- @@ -97,8 +79,6 @@ Defined in: [types/proxy.ts:1753](https://github.com/juspay/neurolink/blob/relea > `optional` **fallbackStatus?**: `string` -Defined in: [types/proxy.ts:1755](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1755) - Provider fallback availability, for example "available". --- @@ -107,8 +87,6 @@ Provider fallback availability, for example "available". > `optional` **upgradePaths?**: `string` -Defined in: [types/proxy.ts:1757](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1757) - Comma-separated provider upgrade paths, for example "overage". --- @@ -117,8 +95,6 @@ Comma-separated provider upgrade paths, for example "overage". > **overageStatus**: `string` -Defined in: [types/proxy.ts:1759](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1759) - "allowed" | "rejected" --- @@ -127,8 +103,6 @@ Defined in: [types/proxy.ts:1759](https://github.com/juspay/neurolink/blob/relea > `optional` **overageInUse?**: `boolean` -Defined in: [types/proxy.ts:1761](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1761) - Whether Anthropic reports that paid overage is actively serving traffic. --- @@ -137,8 +111,6 @@ Whether Anthropic reports that paid overage is actively serving traffic. > `optional` **overageDisabledReason?**: `string` -Defined in: [types/proxy.ts:1765](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1765) - Why overage is unavailable, verbatim from anthropic-ratelimit-unified-overage-disabled-reason (e.g. "org_level_disabled"). Present only when the provider states one. @@ -149,8 +121,6 @@ anthropic-ratelimit-unified-overage-disabled-reason (e.g. > `optional` **overageEnabled?**: `boolean` -Defined in: [types/proxy.ts:1769](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1769) - Authoritative extra-usage switch from the usage API's `extra_usage.is_enabled`. Unlike the header trio this is reported even for an account that has never served a request. @@ -161,8 +131,6 @@ an account that has never served a request. > `optional` **representativeClaim?**: `string` -Defined in: [types/proxy.ts:1772](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1772) - Which window Anthropic considers binding right now, verbatim from anthropic-ratelimit-unified-representative-claim (e.g. "five_hour"). @@ -172,8 +140,6 @@ anthropic-ratelimit-unified-representative-claim (e.g. "five_hour"). > **lastUpdated**: `number` -Defined in: [types/proxy.ts:1774](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1774) - Epoch ms when we last captured this data --- @@ -182,8 +148,6 @@ Epoch ms when we last captured this data > `optional` **windows?**: [`AccountQuotaWindow`](AccountQuotaWindow.md)[] -Defined in: [types/proxy.ts:1778](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1778) - Dynamic per-plan limit buckets from the usage API `limits[]` array (session / weekly_all / model-scoped weeklies such as Fable / future kinds). Absent on purely header-sourced snapshots. @@ -194,8 +158,6 @@ kinds). Absent on purely header-sourced snapshots. > `optional` **windowsUpdatedAt?**: `number` -Defined in: [types/proxy.ts:1780](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1780) - Epoch ms when `windows` was last refreshed from the usage API. --- @@ -204,6 +166,4 @@ Epoch ms when `windows` was last refreshed from the usage API. > `optional` **source?**: [`AccountQuotaSource`](AccountQuotaSource.md) -Defined in: [types/proxy.ts:1782](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1782) - Provenance of this snapshot's numbers. diff --git a/docs/api/type-aliases/AccountQuotaSource.md b/docs/api/type-aliases/AccountQuotaSource.md index 84f4bbaa4..58a3ff7db 100644 --- a/docs/api/type-aliases/AccountQuotaSource.md +++ b/docs/api/type-aliases/AccountQuotaSource.md @@ -8,8 +8,6 @@ > **AccountQuotaSource** = `"headers"` \| `"usage-api"` -Defined in: [types/proxy.ts:1790](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1790) - Where an AccountQuota snapshot came from. - "headers" : passive capture of anthropic-ratelimit-unified-\* response diff --git a/docs/api/type-aliases/AccountQuotaWindow.md b/docs/api/type-aliases/AccountQuotaWindow.md index 120da5b05..e27528f24 100644 --- a/docs/api/type-aliases/AccountQuotaWindow.md +++ b/docs/api/type-aliases/AccountQuotaWindow.md @@ -8,8 +8,6 @@ > **AccountQuotaWindow** = `object` -Defined in: [types/proxy.ts:1795](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1795) - One dynamic limit bucket from the usage API. Provider vocabulary (`kind`, `group`, `severity`) is preserved verbatim so buckets Anthropic adds later survive storage and display without a code change. @@ -20,8 +18,6 @@ survive storage and display without a code change. > **kind**: `string` -Defined in: [types/proxy.ts:1797](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1797) - Provider kind, verbatim ("session", "weekly_all", "weekly_scoped", ...). --- @@ -30,8 +26,6 @@ Provider kind, verbatim ("session", "weekly_all", "weekly_scoped", ...). > `optional` **group?**: `string` -Defined in: [types/proxy.ts:1799](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1799) - Provider group, verbatim ("session" | "weekly" | future values). --- @@ -40,8 +34,6 @@ Provider group, verbatim ("session" | "weekly" | future values). > **used**: `number` -Defined in: [types/proxy.ts:1801](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1801) - 0.0-1.0 utilization (provider percent / 100). --- @@ -50,8 +42,6 @@ Defined in: [types/proxy.ts:1801](https://github.com/juspay/neurolink/blob/relea > `optional` **severity?**: `string` -Defined in: [types/proxy.ts:1803](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1803) - Provider severity, verbatim ("normal", ...). --- @@ -60,8 +50,6 @@ Provider severity, verbatim ("normal", ...). > **status**: `string` -Defined in: [types/proxy.ts:1805](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1805) - Derived "allowed" | "rejected" (see usageToQuota status mapping). --- @@ -70,8 +58,6 @@ Derived "allowed" | "rejected" (see usageToQuota status mapping). > **resetsAt**: `number` -Defined in: [types/proxy.ts:1807](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1807) - Unix timestamp (seconds) when this window resets; 0 when unparseable. --- @@ -80,16 +66,12 @@ Unix timestamp (seconds) when this window resets; 0 when unparseable. > `optional` **isActive?**: `boolean` -Defined in: [types/proxy.ts:1808](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1808) - --- ### scopeModel? > `optional` **scopeModel?**: `string` -Defined in: [types/proxy.ts:1810](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1810) - Model display name for model-scoped windows (e.g. "Fable"). --- @@ -98,8 +80,6 @@ Model display name for model-scoped windows (e.g. "Fable"). > `optional` **scopeModelId?**: `string` -Defined in: [types/proxy.ts:1814](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1814) - Wire model id for the scope when the provider reports one (`scope.model.id`), which matches a request's `model` exactly and so beats display-name matching. Often null in practice. @@ -110,8 +90,6 @@ display-name matching. Often null in practice. > `optional` **scopeSurface?**: `string` -Defined in: [types/proxy.ts:1816](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1816) - Surface scope when the provider reports one. --- @@ -120,8 +98,6 @@ Surface scope when the provider reports one. > `optional` **updatedAt?**: `number` -Defined in: [types/proxy.ts:1821](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1821) - Epoch ms this individual window was observed. Lets a header-derived window and a usage-API window on the same account age independently — the flat `lastUpdated` refreshes on every response and would otherwise make a @@ -133,8 +109,6 @@ days-old scoped window look current. > `optional` **source?**: [`AccountQuotaSource`](AccountQuotaSource.md) -Defined in: [types/proxy.ts:1823](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1823) - Provenance of this window, mirroring AccountQuotaSource. --- @@ -143,6 +117,4 @@ Provenance of this window, mirroring AccountQuotaSource. > `optional` **headerWindow?**: `string` -Defined in: [types/proxy.ts:1825](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1825) - Raw unified header token for header-derived windows, e.g. "7d_oi". diff --git a/docs/api/type-aliases/AccountSelectionContext.md b/docs/api/type-aliases/AccountSelectionContext.md index 0f2e59189..72a96a650 100644 --- a/docs/api/type-aliases/AccountSelectionContext.md +++ b/docs/api/type-aliases/AccountSelectionContext.md @@ -8,8 +8,6 @@ > **AccountSelectionContext** = `object` -Defined in: [types/proxy.ts:2234](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2234) - Context recorded when an account is selected for a proxy request. ## Properties @@ -18,52 +16,38 @@ Context recorded when an account is selected for a proxy request. > **strategy**: `string` -Defined in: [types/proxy.ts:2235](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2235) - --- ### accountsTotal > **accountsTotal**: `number` -Defined in: [types/proxy.ts:2236](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2236) - --- ### accountsHealthy > **accountsHealthy**: `number` -Defined in: [types/proxy.ts:2237](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2237) - --- ### selectedAccount > **selectedAccount**: `string` -Defined in: [types/proxy.ts:2238](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2238) - --- ### accountType > **accountType**: `string` -Defined in: [types/proxy.ts:2239](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2239) - --- ### rateLimitBefore5h? > `optional` **rateLimitBefore5h?**: `number` -Defined in: [types/proxy.ts:2240](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2240) - --- ### rateLimitBefore7d? > `optional` **rateLimitBefore7d?**: `number` - -Defined in: [types/proxy.ts:2241](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2241) diff --git a/docs/api/type-aliases/AccountStats.md b/docs/api/type-aliases/AccountStats.md index 8bd128e47..93cc2365f 100644 --- a/docs/api/type-aliases/AccountStats.md +++ b/docs/api/type-aliases/AccountStats.md @@ -8,16 +8,12 @@ > **AccountStats** = `object` -Defined in: [types/proxy.ts:1595](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1595) - ## Properties ### key? > `optional` **key?**: `string` -Defined in: [types/proxy.ts:1601](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1601) - Provider-qualified account identity for rows written by current builds. Omitted only by legacy snapshots whose bare map keys are intentionally treated as unattributed rather than guessed at during status rendering. @@ -28,32 +24,24 @@ treated as unattributed rather than guessed at during status rendering. > **label**: `string` -Defined in: [types/proxy.ts:1602](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1602) - --- ### type > **type**: `string` -Defined in: [types/proxy.ts:1603](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1603) - --- ### attemptCount > **attemptCount**: `number` -Defined in: [types/proxy.ts:1604](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1604) - --- ### attemptErrorCount > **attemptErrorCount**: `number` -Defined in: [types/proxy.ts:1606](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1606) - Failed upstream attempts, including retries that later recovered. --- @@ -62,8 +50,6 @@ Failed upstream attempts, including retries that later recovered. > **successCount**: `number` -Defined in: [types/proxy.ts:1608](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1608) - Final requests successfully completed by this account. --- @@ -72,8 +58,6 @@ Final requests successfully completed by this account. > **errorCount**: `number` -Defined in: [types/proxy.ts:1610](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1610) - Final requests that terminated as errors on this account. --- @@ -82,8 +66,6 @@ Final requests that terminated as errors on this account. > **rateLimitCount**: `number` -Defined in: [types/proxy.ts:1612](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1612) - All upstream attempts that returned 429. --- @@ -92,28 +74,20 @@ All upstream attempts that returned 429. > **transientRateLimitCount**: `number` -Defined in: [types/proxy.ts:1613](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1613) - --- ### quotaRateLimitCount > **quotaRateLimitCount**: `number` -Defined in: [types/proxy.ts:1614](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1614) - --- ### lastAttemptAt > **lastAttemptAt**: `number` -Defined in: [types/proxy.ts:1615](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1615) - --- ### lastErrorAt? > `optional` **lastErrorAt?**: `number` - -Defined in: [types/proxy.ts:1616](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1616) diff --git a/docs/api/type-aliases/AccountUsageFetchResult.md b/docs/api/type-aliases/AccountUsageFetchResult.md index a9568f50b..8edf6af3d 100644 --- a/docs/api/type-aliases/AccountUsageFetchResult.md +++ b/docs/api/type-aliases/AccountUsageFetchResult.md @@ -8,6 +8,4 @@ > **AccountUsageFetchResult** = \{ `ok`: `true`; `usage`: [`AnthropicUsageResponse`](AnthropicUsageResponse.md); \} \| \{ `ok`: `false`; `reason`: `"not_oauth"` \| `"auth"` \| `"http"` \| `"network"` \| `"parse"`; `error`: `string`; `status?`: `number`; \} -Defined in: [types/proxy.ts:1861](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1861) - Outcome of one account's usage-endpoint fetch. Return-not-throw. diff --git a/docs/api/type-aliases/ActionAWSConfig.md b/docs/api/type-aliases/ActionAWSConfig.md index a6546e837..8e3d64a96 100644 --- a/docs/api/type-aliases/ActionAWSConfig.md +++ b/docs/api/type-aliases/ActionAWSConfig.md @@ -8,8 +8,6 @@ > **ActionAWSConfig** = `object` -Defined in: [types/action.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L35) - AWS credentials for Bedrock/SageMaker ## Properties @@ -18,44 +16,32 @@ AWS credentials for Bedrock/SageMaker > `optional` **awsAccessKeyId?**: `string` -Defined in: [types/action.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L36) - --- ### awsSecretAccessKey? > `optional` **awsSecretAccessKey?**: `string` -Defined in: [types/action.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L37) - --- ### awsRegion > **awsRegion**: `string` -Defined in: [types/action.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L38) - --- ### awsSessionToken? > `optional` **awsSessionToken?**: `string` -Defined in: [types/action.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L39) - --- ### bedrockModelId? > `optional` **bedrockModelId?**: `string` -Defined in: [types/action.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L40) - --- ### sagemakerEndpoint? > `optional` **sagemakerEndpoint?**: `string` - -Defined in: [types/action.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L41) diff --git a/docs/api/type-aliases/ActionCommentResult.md b/docs/api/type-aliases/ActionCommentResult.md index 519b32556..67e38d4e6 100644 --- a/docs/api/type-aliases/ActionCommentResult.md +++ b/docs/api/type-aliases/ActionCommentResult.md @@ -8,8 +8,6 @@ > **ActionCommentResult** = `object` -Defined in: [types/action.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L223) - GitHub comment posting result ## Properties @@ -18,28 +16,20 @@ GitHub comment posting result > **success**: `boolean` -Defined in: [types/action.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L224) - --- ### commentId? > `optional` **commentId?**: `number` -Defined in: [types/action.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L225) - --- ### commentUrl? > `optional` **commentUrl?**: `string` -Defined in: [types/action.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L226) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/action.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L227) diff --git a/docs/api/type-aliases/ActionEvaluation.md b/docs/api/type-aliases/ActionEvaluation.md index ed2e3f0e2..f3347653c 100644 --- a/docs/api/type-aliases/ActionEvaluation.md +++ b/docs/api/type-aliases/ActionEvaluation.md @@ -8,8 +8,6 @@ > **ActionEvaluation** = `object` -Defined in: [types/action.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L197) - Normalized evaluation for action output ## Properties @@ -18,28 +16,20 @@ Normalized evaluation for action output > **overallScore**: `number` -Defined in: [types/action.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L198) - --- ### relevance > **relevance**: `number` -Defined in: [types/action.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L199) - --- ### accuracy > **accuracy**: `number` -Defined in: [types/action.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L200) - --- ### completeness > **completeness**: `number` - -Defined in: [types/action.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L201) diff --git a/docs/api/type-aliases/ActionExecutionResult.md b/docs/api/type-aliases/ActionExecutionResult.md index 252bfb3f9..0433b0d88 100644 --- a/docs/api/type-aliases/ActionExecutionResult.md +++ b/docs/api/type-aliases/ActionExecutionResult.md @@ -8,8 +8,6 @@ > **ActionExecutionResult** = `object` -Defined in: [types/action.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L207) - CLI execution result (normalized) ## Properties @@ -18,76 +16,56 @@ CLI execution result (normalized) > **success**: `boolean` -Defined in: [types/action.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L208) - --- ### response > **response**: `string` -Defined in: [types/action.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L209) - --- ### responseJson? > `optional` **responseJson?**: `Record`\<`string`, `unknown`\> -Defined in: [types/action.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L210) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/action.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L211) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/action.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L212) - --- ### usage? > `optional` **usage?**: [`ActionTokenUsage`](ActionTokenUsage.md) -Defined in: [types/action.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L213) - --- ### cost? > `optional` **cost?**: `number` -Defined in: [types/action.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L214) - --- ### executionTime? > `optional` **executionTime?**: `number` -Defined in: [types/action.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L215) - --- ### evaluation? > `optional` **evaluation?**: [`ActionEvaluation`](ActionEvaluation.md) -Defined in: [types/action.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L216) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/action.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L217) diff --git a/docs/api/type-aliases/ActionGoogleCloudConfig.md b/docs/api/type-aliases/ActionGoogleCloudConfig.md index 5e6224ec7..2c9cc2677 100644 --- a/docs/api/type-aliases/ActionGoogleCloudConfig.md +++ b/docs/api/type-aliases/ActionGoogleCloudConfig.md @@ -8,8 +8,6 @@ > **ActionGoogleCloudConfig** = `object` -Defined in: [types/action.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L47) - Google Cloud configuration for Vertex AI ## Properties @@ -18,20 +16,14 @@ Google Cloud configuration for Vertex AI > `optional` **googleVertexProject?**: `string` -Defined in: [types/action.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L48) - --- ### googleVertexLocation > **googleVertexLocation**: `string` -Defined in: [types/action.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L49) - --- ### googleApplicationCredentials? > `optional` **googleApplicationCredentials?**: `string` - -Defined in: [types/action.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L50) diff --git a/docs/api/type-aliases/ActionInputValidation.md b/docs/api/type-aliases/ActionInputValidation.md index ff8999b16..0ff7fafdb 100644 --- a/docs/api/type-aliases/ActionInputValidation.md +++ b/docs/api/type-aliases/ActionInputValidation.md @@ -8,8 +8,6 @@ > **ActionInputValidation** = `object` -Defined in: [types/action.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L254) - Input validation result ## Properties @@ -18,20 +16,14 @@ Input validation result > **valid**: `boolean` -Defined in: [types/action.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L255) - --- ### errors > **errors**: `string`[] -Defined in: [types/action.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L256) - --- ### warnings > **warnings**: `string`[] - -Defined in: [types/action.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L257) diff --git a/docs/api/type-aliases/ActionInputs.md b/docs/api/type-aliases/ActionInputs.md index b1aa02ad6..896071a64 100644 --- a/docs/api/type-aliases/ActionInputs.md +++ b/docs/api/type-aliases/ActionInputs.md @@ -8,8 +8,6 @@ > **ActionInputs** = `object` -Defined in: [types/action.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L75) - Complete action inputs parsed from GitHub Action ## Properties @@ -18,204 +16,152 @@ Complete action inputs parsed from GitHub Action > **prompt**: `string` -Defined in: [types/action.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L77) - --- ### provider > **provider**: [`AIProviderName`](../enumerations/AIProviderName.md) \| `"auto"` -Defined in: [types/action.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L80) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/action.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L81) - --- ### temperature > **temperature**: `number` -Defined in: [types/action.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L84) - --- ### maxTokens > **maxTokens**: `number` -Defined in: [types/action.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L85) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/action.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L86) - --- ### command > **command**: `"generate"` \| `"stream"` \| `"batch"` -Defined in: [types/action.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L89) - --- ### providerKeys > **providerKeys**: [`ActionProviderKeys`](ActionProviderKeys.md) -Defined in: [types/action.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L92) - --- ### awsConfig > **awsConfig**: [`ActionAWSConfig`](ActionAWSConfig.md) -Defined in: [types/action.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L95) - --- ### googleCloudConfig > **googleCloudConfig**: [`ActionGoogleCloudConfig`](ActionGoogleCloudConfig.md) -Defined in: [types/action.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L96) - --- ### multimodal > **multimodal**: [`ActionMultimodalInputs`](ActionMultimodalInputs.md) -Defined in: [types/action.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L99) - --- ### thinking > **thinking**: [`ActionThinkingConfig`](ActionThinkingConfig.md) -Defined in: [types/action.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L102) - --- ### enableAnalytics > **enableAnalytics**: `boolean` -Defined in: [types/action.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L105) - --- ### enableEvaluation > **enableEvaluation**: `boolean` -Defined in: [types/action.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L106) - --- ### outputFormat > **outputFormat**: `"text"` \| `"json"` -Defined in: [types/action.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L109) - --- ### outputFile? > `optional` **outputFile?**: `string` -Defined in: [types/action.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L110) - --- ### enableTools > **enableTools**: `boolean` -Defined in: [types/action.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L113) - --- ### mcpConfigPath? > `optional` **mcpConfigPath?**: `string` -Defined in: [types/action.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L114) - --- ### postComment > **postComment**: `boolean` -Defined in: [types/action.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L117) - --- ### updateExistingComment > **updateExistingComment**: `boolean` -Defined in: [types/action.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L118) - --- ### commentTag > **commentTag**: `string` -Defined in: [types/action.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L119) - --- ### githubToken? > `optional` **githubToken?**: `string` -Defined in: [types/action.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L120) - --- ### timeout > **timeout**: `number` -Defined in: [types/action.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L123) - --- ### debug > **debug**: `boolean` -Defined in: [types/action.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L124) - --- ### neurolinkVersion > **neurolinkVersion**: `string` -Defined in: [types/action.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L125) - --- ### workingDirectory > **workingDirectory**: `string` - -Defined in: [types/action.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L126) diff --git a/docs/api/type-aliases/ActionMultimodalInputs.md b/docs/api/type-aliases/ActionMultimodalInputs.md index 1b0208551..df8731ccc 100644 --- a/docs/api/type-aliases/ActionMultimodalInputs.md +++ b/docs/api/type-aliases/ActionMultimodalInputs.md @@ -8,8 +8,6 @@ > **ActionMultimodalInputs** = `object` -Defined in: [types/action.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L65) - Multimodal input paths ## Properties @@ -18,28 +16,20 @@ Multimodal input paths > `optional` **imagePaths?**: `string`[] -Defined in: [types/action.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L66) - --- ### pdfPaths? > `optional` **pdfPaths?**: `string`[] -Defined in: [types/action.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L67) - --- ### csvPaths? > `optional` **csvPaths?**: `string`[] -Defined in: [types/action.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L68) - --- ### videoPaths? > `optional` **videoPaths?**: `string`[] - -Defined in: [types/action.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L69) diff --git a/docs/api/type-aliases/ActionOutput.md b/docs/api/type-aliases/ActionOutput.md index 70af2bd30..39ac62e4b 100644 --- a/docs/api/type-aliases/ActionOutput.md +++ b/docs/api/type-aliases/ActionOutput.md @@ -8,8 +8,6 @@ > **ActionOutput** = `object` -Defined in: [types/action.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L233) - Complete action output (snake_case to match action.yml outputs) ## Properties @@ -18,84 +16,62 @@ Complete action output (snake_case to match action.yml outputs) > **response**: `string` -Defined in: [types/action.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L234) - --- ### response_json > **response_json**: `string` -Defined in: [types/action.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L235) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/action.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L236) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/action.ts:237](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L237) - --- ### tokens_used? > `optional` **tokens_used?**: `string` -Defined in: [types/action.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L238) - --- ### prompt_tokens? > `optional` **prompt_tokens?**: `string` -Defined in: [types/action.ts:239](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L239) - --- ### completion_tokens? > `optional` **completion_tokens?**: `string` -Defined in: [types/action.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L240) - --- ### cost? > `optional` **cost?**: `string` -Defined in: [types/action.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L241) - --- ### execution_time? > `optional` **execution_time?**: `string` -Defined in: [types/action.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L242) - --- ### evaluation_score? > `optional` **evaluation_score?**: `string` -Defined in: [types/action.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L243) - --- ### comment_id? > `optional` **comment_id?**: `string` - -Defined in: [types/action.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L244) diff --git a/docs/api/type-aliases/ActionProviderKeys.md b/docs/api/type-aliases/ActionProviderKeys.md index c3d9446f3..9647fcab8 100644 --- a/docs/api/type-aliases/ActionProviderKeys.md +++ b/docs/api/type-aliases/ActionProviderKeys.md @@ -8,8 +8,6 @@ > **ActionProviderKeys** = `object` -Defined in: [types/action.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L16) - Provider API key configuration (verified providers only) ## Properties @@ -18,100 +16,74 @@ Provider API key configuration (verified providers only) > `optional` **openaiApiKey?**: `string` -Defined in: [types/action.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L17) - --- ### anthropicApiKey? > `optional` **anthropicApiKey?**: `string` -Defined in: [types/action.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L18) - --- ### googleAiApiKey? > `optional` **googleAiApiKey?**: `string` -Defined in: [types/action.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L19) - --- ### azureOpenaiApiKey? > `optional` **azureOpenaiApiKey?**: `string` -Defined in: [types/action.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L20) - --- ### azureOpenaiEndpoint? > `optional` **azureOpenaiEndpoint?**: `string` -Defined in: [types/action.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L21) - --- ### azureOpenaiDeployment? > `optional` **azureOpenaiDeployment?**: `string` -Defined in: [types/action.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L22) - --- ### mistralApiKey? > `optional` **mistralApiKey?**: `string` -Defined in: [types/action.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L23) - --- ### huggingfaceApiKey? > `optional` **huggingfaceApiKey?**: `string` -Defined in: [types/action.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L24) - --- ### openrouterApiKey? > `optional` **openrouterApiKey?**: `string` -Defined in: [types/action.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L25) - --- ### litellmApiKey? > `optional` **litellmApiKey?**: `string` -Defined in: [types/action.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L26) - --- ### litellmBaseUrl? > `optional` **litellmBaseUrl?**: `string` -Defined in: [types/action.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L27) - --- ### openaiCompatibleApiKey? > `optional` **openaiCompatibleApiKey?**: `string` -Defined in: [types/action.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L28) - --- ### openaiCompatibleBaseUrl? > `optional` **openaiCompatibleBaseUrl?**: `string` - -Defined in: [types/action.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L29) diff --git a/docs/api/type-aliases/ActionThinkingConfig.md b/docs/api/type-aliases/ActionThinkingConfig.md index c0ff36ba1..0da014063 100644 --- a/docs/api/type-aliases/ActionThinkingConfig.md +++ b/docs/api/type-aliases/ActionThinkingConfig.md @@ -8,8 +8,6 @@ > **ActionThinkingConfig** = `object` -Defined in: [types/action.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L56) - Extended thinking configuration ## Properties @@ -18,20 +16,14 @@ Extended thinking configuration > **enabled**: `boolean` -Defined in: [types/action.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L57) - --- ### level > **level**: `"minimal"` \| `"low"` \| `"medium"` \| `"high"` -Defined in: [types/action.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L58) - --- ### budget > **budget**: `number` - -Defined in: [types/action.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L59) diff --git a/docs/api/type-aliases/ActionTokenUsage.md b/docs/api/type-aliases/ActionTokenUsage.md index 3d8d8d4a2..ab1f29e40 100644 --- a/docs/api/type-aliases/ActionTokenUsage.md +++ b/docs/api/type-aliases/ActionTokenUsage.md @@ -8,8 +8,6 @@ > **ActionTokenUsage** = `object` -Defined in: [types/action.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L188) - Normalized token usage for action output ## Properties @@ -18,20 +16,14 @@ Normalized token usage for action output > **promptTokens**: `number` -Defined in: [types/action.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L189) - --- ### completionTokens > **completionTokens**: `number` -Defined in: [types/action.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L190) - --- ### totalTokens > **totalTokens**: `number` - -Defined in: [types/action.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L191) diff --git a/docs/api/type-aliases/AdaptiveSemaphoreConfig.md b/docs/api/type-aliases/AdaptiveSemaphoreConfig.md index 2e5da0e8f..b09c82b77 100644 --- a/docs/api/type-aliases/AdaptiveSemaphoreConfig.md +++ b/docs/api/type-aliases/AdaptiveSemaphoreConfig.md @@ -8,8 +8,6 @@ > **AdaptiveSemaphoreConfig** = `object` -Defined in: [types/providers.ts:1444](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1444) - Adaptive semaphore configuration for concurrency management ## Properties @@ -18,20 +16,14 @@ Adaptive semaphore configuration for concurrency management > **initialConcurrency**: `number` -Defined in: [types/providers.ts:1445](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1445) - --- ### maxConcurrency > **maxConcurrency**: `number` -Defined in: [types/providers.ts:1446](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1446) - --- ### minConcurrency > **minConcurrency**: `number` - -Defined in: [types/providers.ts:1447](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1447) diff --git a/docs/api/type-aliases/AdaptiveSemaphoreMetrics.md b/docs/api/type-aliases/AdaptiveSemaphoreMetrics.md index 33f2458cb..6f768e928 100644 --- a/docs/api/type-aliases/AdaptiveSemaphoreMetrics.md +++ b/docs/api/type-aliases/AdaptiveSemaphoreMetrics.md @@ -8,8 +8,6 @@ > **AdaptiveSemaphoreMetrics** = `object` -Defined in: [types/providers.ts:1453](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1453) - Metrics for adaptive semaphore performance tracking ## Properties @@ -18,44 +16,32 @@ Metrics for adaptive semaphore performance tracking > **activeRequests**: `number` -Defined in: [types/providers.ts:1454](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1454) - --- ### currentConcurrency > **currentConcurrency**: `number` -Defined in: [types/providers.ts:1455](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1455) - --- ### completedCount > **completedCount**: `number` -Defined in: [types/providers.ts:1456](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1456) - --- ### errorCount > **errorCount**: `number` -Defined in: [types/providers.ts:1457](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1457) - --- ### averageResponseTime > **averageResponseTime**: `number` -Defined in: [types/providers.ts:1458](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1458) - --- ### waitingCount > **waitingCount**: `number` - -Defined in: [types/providers.ts:1459](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1459) diff --git a/docs/api/type-aliases/AdditionalMemoryUser.md b/docs/api/type-aliases/AdditionalMemoryUser.md index 06cdb698b..26f052c02 100644 --- a/docs/api/type-aliases/AdditionalMemoryUser.md +++ b/docs/api/type-aliases/AdditionalMemoryUser.md @@ -8,8 +8,6 @@ > **AdditionalMemoryUser** = `object` -Defined in: [types/generate.ts:900](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L900) - Represents an additional user whose memory should be included in a generate/stream call. Allows per-user prompt overrides for different memory condensation strategies (e.g. personal preferences vs org-level policies). @@ -20,8 +18,6 @@ Allows per-user prompt overrides for different memory condensation strategies > **userId**: `string` -Defined in: [types/generate.ts:902](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L902) - The user/owner ID to retrieve or store memory for. --- @@ -30,8 +26,6 @@ The user/owner ID to retrieve or store memory for. > `optional` **label?**: `string` -Defined in: [types/generate.ts:908](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L908) - Human-readable label used in the formatted memory context. E.g. "Organization Policy", "Team Context", "User Preferences". If not provided, defaults to userId. @@ -42,8 +36,6 @@ If not provided, defaults to userId. > `optional` **read?**: `boolean` -Defined in: [types/generate.ts:910](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L910) - Whether to read this user's memory and include in context. Defaults to true. --- @@ -52,8 +44,6 @@ Whether to read this user's memory and include in context. Defaults to true. > `optional` **write?**: `boolean` -Defined in: [types/generate.ts:912](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L912) - Whether to write conversation into this user's memory. Defaults to true. --- @@ -62,8 +52,6 @@ Whether to write conversation into this user's memory. Defaults to true. > `optional` **prompt?**: `string` -Defined in: [types/generate.ts:914](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L914) - Custom condensation prompt for this user. Overrides the default Hippocampus prompt. --- @@ -72,6 +60,4 @@ Custom condensation prompt for this user. Overrides the default Hippocampus prom > `optional` **maxWords?**: `number` -Defined in: [types/generate.ts:916](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L916) - Max words for this user's condensed memory. Overrides the default maxWords. diff --git a/docs/api/type-aliases/AffinityRule.md b/docs/api/type-aliases/AffinityRule.md index 9b6a74d4e..be716f6b9 100644 --- a/docs/api/type-aliases/AffinityRule.md +++ b/docs/api/type-aliases/AffinityRule.md @@ -8,8 +8,6 @@ > **AffinityRule** = `object` -Defined in: [types/mcp.ts:2479](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2479) - Affinity rule for session-based routing ## Properties @@ -18,20 +16,14 @@ Affinity rule for session-based routing > **key**: `string` -Defined in: [types/mcp.ts:2480](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2480) - --- ### serverId > **serverId**: `string` -Defined in: [types/mcp.ts:2481](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2481) - --- ### expiresAt? > `optional` **expiresAt?**: `number` - -Defined in: [types/mcp.ts:2482](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2482) diff --git a/docs/api/type-aliases/AgentCapability.md b/docs/api/type-aliases/AgentCapability.md index 7092603fd..d67cc990a 100644 --- a/docs/api/type-aliases/AgentCapability.md +++ b/docs/api/type-aliases/AgentCapability.md @@ -8,8 +8,6 @@ > **AgentCapability** = `object` -Defined in: [types/agentNetwork.ts:1412](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1412) - Agent capability description ## Properties @@ -18,8 +16,6 @@ Agent capability description > **agentId**: `string` -Defined in: [types/agentNetwork.ts:1414](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1414) - Agent ID --- @@ -28,8 +24,6 @@ Agent ID > **skills**: `string`[] -Defined in: [types/agentNetwork.ts:1417](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1417) - Skills/capabilities --- @@ -38,8 +32,6 @@ Skills/capabilities > **currentLoad**: `number` -Defined in: [types/agentNetwork.ts:1420](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1420) - Current load (0-1) --- @@ -48,8 +40,6 @@ Current load (0-1) > **avgResponseTime**: `number` -Defined in: [types/agentNetwork.ts:1423](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1423) - Average response time in ms --- @@ -58,8 +48,6 @@ Average response time in ms > **successRate**: `number` -Defined in: [types/agentNetwork.ts:1426](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1426) - Success rate (0-1) --- @@ -68,6 +56,4 @@ Success rate (0-1) > `optional` **affinityTags?**: `string`[] -Defined in: [types/agentNetwork.ts:1429](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1429) - Affinity tags diff --git a/docs/api/type-aliases/AgentDefinition.md b/docs/api/type-aliases/AgentDefinition.md index 6b05c0f6e..aff785dce 100644 --- a/docs/api/type-aliases/AgentDefinition.md +++ b/docs/api/type-aliases/AgentDefinition.md @@ -8,8 +8,6 @@ > **AgentDefinition** = `object` -Defined in: [types/agentNetwork.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L20) - Agent definition for creating agents in the network ## Properties @@ -18,8 +16,6 @@ Agent definition for creating agents in the network > **id**: `string` -Defined in: [types/agentNetwork.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L22) - Unique identifier for the agent --- @@ -28,8 +24,6 @@ Unique identifier for the agent > **name**: `string` -Defined in: [types/agentNetwork.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L25) - Human-readable name --- @@ -38,8 +32,6 @@ Human-readable name > **description**: `string` -Defined in: [types/agentNetwork.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L28) - Description of the agent's capabilities (critical for routing) --- @@ -48,8 +40,6 @@ Description of the agent's capabilities (critical for routing) > **instructions**: `string` -Defined in: [types/agentNetwork.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L31) - System instructions for the agent --- @@ -58,8 +48,6 @@ System instructions for the agent > `optional` **provider?**: [`AIProviderName`](../enumerations/AIProviderName.md) \| `string` -Defined in: [types/agentNetwork.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L34) - Provider to use for this agent --- @@ -68,8 +56,6 @@ Provider to use for this agent > `optional` **model?**: `string` -Defined in: [types/agentNetwork.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L37) - Model to use for this agent --- @@ -78,8 +64,6 @@ Model to use for this agent > `optional` **tools?**: `string`[] -Defined in: [types/agentNetwork.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L40) - Tools available to this agent (tool names) --- @@ -88,8 +72,6 @@ Tools available to this agent (tool names) > `optional` **inputSchema?**: `z.ZodSchema` -Defined in: [types/agentNetwork.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L43) - Input schema for structured agent input --- @@ -98,8 +80,6 @@ Input schema for structured agent input > `optional` **outputSchema?**: `z.ZodSchema` -Defined in: [types/agentNetwork.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L46) - Output schema for structured agent output --- @@ -108,8 +88,6 @@ Output schema for structured agent output > `optional` **maxSteps?**: `number` -Defined in: [types/agentNetwork.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L49) - Maximum number of steps this agent can take (default: 10) --- @@ -118,8 +96,6 @@ Maximum number of steps this agent can take (default: 10) > `optional` **temperature?**: `number` -Defined in: [types/agentNetwork.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L52) - Temperature for generation (default: 0.7) --- @@ -128,8 +104,6 @@ Temperature for generation (default: 0.7) > `optional` **canDelegate?**: `boolean` -Defined in: [types/agentNetwork.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L55) - Whether this agent can delegate to other agents (default: false) --- @@ -138,8 +112,6 @@ Whether this agent can delegate to other agents (default: false) > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L58) - Custom metadata for routing decisions --- @@ -148,6 +120,4 @@ Custom metadata for routing decisions > `optional` **credentials?**: `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L61) - Per-agent credentials override diff --git a/docs/api/type-aliases/AgentExecuteRequest.md b/docs/api/type-aliases/AgentExecuteRequest.md index b650e20b5..ffd46a599 100644 --- a/docs/api/type-aliases/AgentExecuteRequest.md +++ b/docs/api/type-aliases/AgentExecuteRequest.md @@ -8,8 +8,6 @@ > **AgentExecuteRequest** = `object` -Defined in: [types/server.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L551) - Agent execution request ## Properties @@ -18,8 +16,6 @@ Agent execution request > **input**: `string` \| \{ `text`: `string`; `images?`: `string`[]; `files?`: `string`[]; \} -Defined in: [types/server.ts:553](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L553) - Input prompt or message --- @@ -28,8 +24,6 @@ Input prompt or message > `optional` **provider?**: `string` -Defined in: [types/server.ts:556](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L556) - Provider to use (optional) --- @@ -38,8 +32,6 @@ Provider to use (optional) > `optional` **model?**: `string` -Defined in: [types/server.ts:559](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L559) - Model to use (optional) --- @@ -48,8 +40,6 @@ Model to use (optional) > `optional` **systemPrompt?**: `string` -Defined in: [types/server.ts:562](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L562) - System prompt (optional) --- @@ -58,8 +48,6 @@ System prompt (optional) > `optional` **temperature?**: `number` -Defined in: [types/server.ts:565](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L565) - Temperature (0-1) --- @@ -68,8 +56,6 @@ Temperature (0-1) > `optional` **maxTokens?**: `number` -Defined in: [types/server.ts:568](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L568) - Maximum tokens --- @@ -78,8 +64,6 @@ Maximum tokens > `optional` **tools?**: `string`[] -Defined in: [types/server.ts:571](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L571) - Tools to enable --- @@ -88,8 +72,6 @@ Tools to enable > `optional` **stream?**: `boolean` -Defined in: [types/server.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L574) - Enable streaming --- @@ -98,8 +80,6 @@ Enable streaming > `optional` **sessionId?**: `string` -Defined in: [types/server.ts:577](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L577) - Session ID for conversation memory --- @@ -108,6 +88,4 @@ Session ID for conversation memory > `optional` **userId?**: `string` -Defined in: [types/server.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L580) - User ID for context diff --git a/docs/api/type-aliases/AgentExecuteResponse.md b/docs/api/type-aliases/AgentExecuteResponse.md index a06cc5ff5..d3d477f20 100644 --- a/docs/api/type-aliases/AgentExecuteResponse.md +++ b/docs/api/type-aliases/AgentExecuteResponse.md @@ -8,8 +8,6 @@ > **AgentExecuteResponse** = `object` -Defined in: [types/server.ts:586](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L586) - Agent execution response ## Properties @@ -18,8 +16,6 @@ Agent execution response > **content**: `string` -Defined in: [types/server.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L588) - Generated content --- @@ -28,8 +24,6 @@ Generated content > **provider**: `string` -Defined in: [types/server.ts:591](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L591) - Provider used --- @@ -38,8 +32,6 @@ Provider used > **model**: `string` -Defined in: [types/server.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L594) - Model used --- @@ -48,8 +40,6 @@ Model used > `optional` **usage?**: `object` -Defined in: [types/server.ts:597](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L597) - Token usage #### input @@ -100,8 +90,6 @@ Cache savings percentage > `optional` **toolCalls?**: `object`[] -Defined in: [types/server.ts:615](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L615) - Tool calls made #### name @@ -122,8 +110,6 @@ Tool calls made > `optional` **finishReason?**: `string` -Defined in: [types/server.ts:622](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L622) - Finish reason --- @@ -132,6 +118,4 @@ Finish reason > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/server.ts:625](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L625) - Response metadata diff --git a/docs/api/type-aliases/AgentExecutionContext.md b/docs/api/type-aliases/AgentExecutionContext.md index 90f757280..4a22b46a6 100644 --- a/docs/api/type-aliases/AgentExecutionContext.md +++ b/docs/api/type-aliases/AgentExecutionContext.md @@ -8,8 +8,6 @@ > **AgentExecutionContext** = `object` -Defined in: [types/agentNetwork.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L360) - Execution context passed to primitives ## Indexable @@ -24,8 +22,6 @@ Additional context data > `optional` **sessionId?**: `string` -Defined in: [types/agentNetwork.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L362) - Session ID for memory --- @@ -34,8 +30,6 @@ Session ID for memory > `optional` **traceId?**: `string` -Defined in: [types/agentNetwork.ts:365](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L365) - Trace ID for observability --- @@ -44,6 +38,4 @@ Trace ID for observability > `optional` **parentSpanId?**: `string` -Defined in: [types/agentNetwork.ts:368](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L368) - Parent span ID diff --git a/docs/api/type-aliases/AgentExecutionOptions.md b/docs/api/type-aliases/AgentExecutionOptions.md index 90d42d992..49a7bb931 100644 --- a/docs/api/type-aliases/AgentExecutionOptions.md +++ b/docs/api/type-aliases/AgentExecutionOptions.md @@ -8,8 +8,6 @@ > **AgentExecutionOptions** = `object` -Defined in: [types/agentNetwork.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L113) - Options for agent execution ## Properties @@ -18,8 +16,6 @@ Options for agent execution > `optional` **context?**: `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L115) - Additional context for the agent --- @@ -28,8 +24,6 @@ Additional context for the agent > `optional` **maxSteps?**: `number` -Defined in: [types/agentNetwork.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L118) - Override max steps for this execution --- @@ -38,8 +32,6 @@ Override max steps for this execution > `optional` **traceId?**: `string` -Defined in: [types/agentNetwork.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L121) - Trace ID for observability --- @@ -48,8 +40,6 @@ Trace ID for observability > `optional` **parentSpanId?**: `string` -Defined in: [types/agentNetwork.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L124) - Parent span ID for nested tracing --- @@ -58,8 +48,6 @@ Parent span ID for nested tracing > `optional` **timeout?**: `number` -Defined in: [types/agentNetwork.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L127) - Per-model-call timeout in milliseconds (see GenerateOptions.timeout) --- @@ -68,8 +56,6 @@ Per-model-call timeout in milliseconds (see GenerateOptions.timeout) > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/agentNetwork.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L133) - Abort signal threaded into every generate() the agent makes. An aborted parent stops the agent — no ghost runs. @@ -79,8 +65,6 @@ parent stops the agent — no ghost runs. > `optional` **turnTimeoutMs?**: `number` -Defined in: [types/agentNetwork.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L136) - Wall-clock cap for the whole agentic turn (ms). See GenerateOptions.turnTimeoutMs. --- @@ -89,8 +73,6 @@ Wall-clock cap for the whole agentic turn (ms). See GenerateOptions.turnTimeoutM > `optional` **wrapupTimeLeadMs?**: `number` -Defined in: [types/agentNetwork.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L139) - Remaining-time threshold for the wrap-up nudge (ms). See GenerateOptions.wrapupTimeLeadMs. --- @@ -99,8 +81,6 @@ Remaining-time threshold for the wrap-up nudge (ms). See GenerateOptions.wrapupT > `optional` **stallTimeoutMs?**: `number` -Defined in: [types/agentNetwork.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L142) - Max time with no progress before the turn ends as "stalled" (ms). See GenerateOptions.stallTimeoutMs. --- @@ -109,6 +89,4 @@ Max time with no progress before the turn ends as "stalled" (ms). See GenerateOp > `optional` **credentials?**: `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L145) - Per-execution credentials override diff --git a/docs/api/type-aliases/AgentInput.md b/docs/api/type-aliases/AgentInput.md index c833dbba9..ba2a5acc9 100644 --- a/docs/api/type-aliases/AgentInput.md +++ b/docs/api/type-aliases/AgentInput.md @@ -8,6 +8,4 @@ > **AgentInput** = `string` \| `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L67) - Agent input - can be a string or structured data diff --git a/docs/api/type-aliases/AgentInstance.md b/docs/api/type-aliases/AgentInstance.md index 3c5dfd7aa..0cef99f4f 100644 --- a/docs/api/type-aliases/AgentInstance.md +++ b/docs/api/type-aliases/AgentInstance.md @@ -8,8 +8,6 @@ > **AgentInstance** = `object` -Defined in: [types/agentNetwork.ts:608](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L608) - Interface for agent instances ## Properties @@ -18,8 +16,6 @@ Interface for agent instances > `readonly` **id**: `string` -Defined in: [types/agentNetwork.ts:610](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L610) - Agent ID --- @@ -28,8 +24,6 @@ Agent ID > `readonly` **name**: `string` -Defined in: [types/agentNetwork.ts:613](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L613) - Agent name --- @@ -38,8 +32,6 @@ Agent name > `readonly` **description**: `string` -Defined in: [types/agentNetwork.ts:616](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L616) - Agent description --- @@ -48,8 +40,6 @@ Agent description > `readonly` **instructions**: `string` -Defined in: [types/agentNetwork.ts:619](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L619) - Agent instructions ## Methods @@ -58,8 +48,6 @@ Agent instructions > **execute**(`input`, `options?`): `Promise`\<[`AgentResult`](AgentResult.md)\> -Defined in: [types/agentNetwork.ts:622](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L622) - Execute the agent #### Parameters @@ -82,8 +70,6 @@ Execute the agent > **stream**(`input`, `options?`): `AsyncIterable`\<[`AgentStreamChunk`](AgentStreamChunk.md)\> -Defined in: [types/agentNetwork.ts:628](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L628) - Stream execution results #### Parameters @@ -106,8 +92,6 @@ Stream execution results > **getStatus**(): [`AgentStatus`](AgentStatus.md) -Defined in: [types/agentNetwork.ts:634](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L634) - Get agent status #### Returns diff --git a/docs/api/type-aliases/AgentLegOptions.md b/docs/api/type-aliases/AgentLegOptions.md index dc937b79f..707439025 100644 --- a/docs/api/type-aliases/AgentLegOptions.md +++ b/docs/api/type-aliases/AgentLegOptions.md @@ -8,8 +8,6 @@ > **AgentLegOptions** = `object` -Defined in: [types/isolatedAgent.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L158) - Leg budget for leashed mode. Setting either enables leashed mode. ## Properties @@ -18,8 +16,6 @@ Leg budget for leashed mode. Setting either enables leashed mode. > `optional` **budgetMs?**: `number` -Defined in: [types/isolatedAgent.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L160) - Wall-clock budget for one leg (ms). --- @@ -28,6 +24,4 @@ Wall-clock budget for one leg (ms). > `optional` **budgetToolCalls?**: `number` -Defined in: [types/isolatedAgent.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L162) - Tool-call budget for one leg. diff --git a/docs/api/type-aliases/AgentMechanicalDigest.md b/docs/api/type-aliases/AgentMechanicalDigest.md index bf920358e..3afff3f91 100644 --- a/docs/api/type-aliases/AgentMechanicalDigest.md +++ b/docs/api/type-aliases/AgentMechanicalDigest.md @@ -8,8 +8,6 @@ > **AgentMechanicalDigest** = `object` -Defined in: [types/isolatedAgent.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L433) - Mechanical digest shape (delivery-guarantee fallback payload). ## Properties @@ -18,24 +16,18 @@ Mechanical digest shape (delivery-guarantee fallback payload). > **kind**: `"mechanical-digest"` -Defined in: [types/isolatedAgent.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L434) - --- ### toolsRun > **toolsRun**: `Record`\<`string`, \{ `calls`: `number`; `ok`: `number`; `failed`: `number`; \}\> -Defined in: [types/isolatedAgent.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L435) - --- ### excerpts > **excerpts**: `object`[] -Defined in: [types/isolatedAgent.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L436) - #### toolName > **toolName**: `string` diff --git a/docs/api/type-aliases/AgentMessage.md b/docs/api/type-aliases/AgentMessage.md index 7f291dfc4..8ef15815d 100644 --- a/docs/api/type-aliases/AgentMessage.md +++ b/docs/api/type-aliases/AgentMessage.md @@ -8,8 +8,6 @@ > **AgentMessage** = `object` -Defined in: [types/agentNetwork.ts:1090](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1090) - Message structure for agent communication ## Properties @@ -18,8 +16,6 @@ Message structure for agent communication > **id**: `string` -Defined in: [types/agentNetwork.ts:1092](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1092) - Unique message ID --- @@ -28,8 +24,6 @@ Unique message ID > **type**: [`MessageType`](MessageType.md) -Defined in: [types/agentNetwork.ts:1095](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1095) - Message type --- @@ -38,8 +32,6 @@ Message type > **topic**: `string` -Defined in: [types/agentNetwork.ts:1098](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1098) - Topic/channel for the message --- @@ -48,8 +40,6 @@ Topic/channel for the message > **senderId**: `string` -Defined in: [types/agentNetwork.ts:1101](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1101) - Sender agent ID --- @@ -58,8 +48,6 @@ Sender agent ID > `optional` **recipientId?**: `string` -Defined in: [types/agentNetwork.ts:1104](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1104) - Recipient agent ID (for direct messages) --- @@ -68,8 +56,6 @@ Recipient agent ID (for direct messages) > **payload**: `unknown` -Defined in: [types/agentNetwork.ts:1107](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1107) - Message payload --- @@ -78,8 +64,6 @@ Message payload > `optional` **correlationId?**: `string` -Defined in: [types/agentNetwork.ts:1110](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1110) - Correlation ID (for request-response) --- @@ -88,8 +72,6 @@ Correlation ID (for request-response) > `optional` **replyTo?**: `string` -Defined in: [types/agentNetwork.ts:1113](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1113) - Reply-to topic (for request-response) --- @@ -98,8 +80,6 @@ Reply-to topic (for request-response) > **priority**: [`MessagePriority`](MessagePriority.md) -Defined in: [types/agentNetwork.ts:1116](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1116) - Message priority --- @@ -108,8 +88,6 @@ Message priority > **timestamp**: `number` -Defined in: [types/agentNetwork.ts:1119](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1119) - Timestamp --- @@ -118,8 +96,6 @@ Timestamp > `optional` **ttl?**: `number` -Defined in: [types/agentNetwork.ts:1122](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1122) - Time-to-live in ms (after which message expires) --- @@ -128,6 +104,4 @@ Time-to-live in ms (after which message expires) > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:1125](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1125) - Message metadata diff --git a/docs/api/type-aliases/AgentNetworkConfig.md b/docs/api/type-aliases/AgentNetworkConfig.md index 519e37e9f..d7508730a 100644 --- a/docs/api/type-aliases/AgentNetworkConfig.md +++ b/docs/api/type-aliases/AgentNetworkConfig.md @@ -8,8 +8,6 @@ > **AgentNetworkConfig** = `object` -Defined in: [types/agentNetwork.ts:273](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L273) - Configuration for creating an agent network ## Properties @@ -18,8 +16,6 @@ Configuration for creating an agent network > `optional` **id?**: `string` -Defined in: [types/agentNetwork.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L275) - Unique identifier for the network (auto-generated if not provided) --- @@ -28,8 +24,6 @@ Unique identifier for the network (auto-generated if not provided) > **name**: `string` -Defined in: [types/agentNetwork.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L278) - Human-readable name --- @@ -38,8 +32,6 @@ Human-readable name > `optional` **description?**: `string` -Defined in: [types/agentNetwork.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L281) - Description of the network's purpose --- @@ -48,8 +40,6 @@ Description of the network's purpose > **agents**: [`AgentDefinition`](AgentDefinition.md)[] -Defined in: [types/agentNetwork.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L284) - Agents in the network --- @@ -58,8 +48,6 @@ Agents in the network > `optional` **workflows?**: [`NetworkWorkflowDefinition`](NetworkWorkflowDefinition.md)[] -Defined in: [types/agentNetwork.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L287) - Workflows available in the network --- @@ -68,8 +56,6 @@ Workflows available in the network > `optional` **tools?**: `string`[] -Defined in: [types/agentNetwork.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L290) - Additional tools available to all agents (tool names) --- @@ -78,8 +64,6 @@ Additional tools available to all agents (tool names) > `optional` **router?**: [`RouterConfig`](RouterConfig.md) -Defined in: [types/agentNetwork.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L293) - Routing agent configuration --- @@ -88,8 +72,6 @@ Routing agent configuration > `optional` **defaults?**: [`NetworkDefaults`](NetworkDefaults.md) -Defined in: [types/agentNetwork.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L296) - Default execution options --- @@ -98,6 +80,4 @@ Default execution options > `optional` **memory?**: [`NetworkMemoryConfig`](NetworkMemoryConfig.md) -Defined in: [types/agentNetwork.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L299) - Memory configuration for the network diff --git a/docs/api/type-aliases/AgentPrimitive.md b/docs/api/type-aliases/AgentPrimitive.md index 83ae6fd4b..77676ee81 100644 --- a/docs/api/type-aliases/AgentPrimitive.md +++ b/docs/api/type-aliases/AgentPrimitive.md @@ -8,8 +8,6 @@ > **AgentPrimitive** = [`NetworkPrimitive`](NetworkPrimitive.md) & `object` -Defined in: [types/agentNetwork.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L203) - Agent as a network primitive ## Type Declaration diff --git a/docs/api/type-aliases/AgentResult.md b/docs/api/type-aliases/AgentResult.md index 17683c547..3556f5c3d 100644 --- a/docs/api/type-aliases/AgentResult.md +++ b/docs/api/type-aliases/AgentResult.md @@ -8,8 +8,6 @@ > **AgentResult** = `object` -Defined in: [types/agentNetwork.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L72) - Result of agent execution ## Properties @@ -18,8 +16,6 @@ Result of agent execution > **content**: `string` -Defined in: [types/agentNetwork.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L74) - Generated content --- @@ -28,8 +24,6 @@ Generated content > `optional` **object?**: `unknown` -Defined in: [types/agentNetwork.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L77) - Structured output if schema was provided --- @@ -38,8 +32,6 @@ Structured output if schema was provided > `optional` **usage?**: [`TokenUsage`](TokenUsage.md) -Defined in: [types/agentNetwork.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L80) - Token usage for this execution --- @@ -48,8 +40,6 @@ Token usage for this execution > `optional` **toolsUsed?**: `string`[] -Defined in: [types/agentNetwork.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L83) - Tools used during execution --- @@ -58,8 +48,6 @@ Tools used during execution > `optional` **toolExecutions?**: [`ToolExecutionRecord`](ToolExecutionRecord.md)[] -Defined in: [types/agentNetwork.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L89) - Real per-call tool execution records from the underlying generate() turn (params, bounded result text, error flag, timing per call). @@ -69,8 +57,6 @@ turn (params, bounded result text, error flag, timing per call). > `optional` **stopReason?**: [`GenerateStopReason`](GenerateStopReason.md) -Defined in: [types/agentNetwork.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L95) - Why the agentic turn ended (`completed`, `step-cap`, `time-limit`, `stalled`, `aborted`, …) — see [GenerateStopReason](GenerateStopReason.md). @@ -80,8 +66,6 @@ Why the agentic turn ended (`completed`, `step-cap`, `time-limit`, > **duration**: `number` -Defined in: [types/agentNetwork.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L98) - Execution duration in milliseconds --- @@ -90,8 +74,6 @@ Execution duration in milliseconds > **status**: `"success"` \| `"error"` -Defined in: [types/agentNetwork.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L101) - Execution status --- @@ -100,8 +82,6 @@ Execution status > `optional` **error?**: `string` -Defined in: [types/agentNetwork.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L104) - Error message if status is error --- @@ -110,6 +90,4 @@ Error message if status is error > **agentId**: `string` -Defined in: [types/agentNetwork.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L107) - Agent ID that produced this result diff --git a/docs/api/type-aliases/AgentRoutingDecision.md b/docs/api/type-aliases/AgentRoutingDecision.md index 0757664c7..7a88e07d8 100644 --- a/docs/api/type-aliases/AgentRoutingDecision.md +++ b/docs/api/type-aliases/AgentRoutingDecision.md @@ -8,8 +8,6 @@ > **AgentRoutingDecision** = `object` -Defined in: [types/agentNetwork.ts:515](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L515) - Routing decision record ## Properties @@ -18,8 +16,6 @@ Routing decision record > **stepIndex**: `number` -Defined in: [types/agentNetwork.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L517) - Step at which decision was made --- @@ -28,8 +24,6 @@ Step at which decision was made > **taskDescription**: `string` -Defined in: [types/agentNetwork.ts:520](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L520) - Task description analyzed --- @@ -38,8 +32,6 @@ Task description analyzed > **selectedPrimitive**: `object` -Defined in: [types/agentNetwork.ts:523](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L523) - Selected primitive #### type @@ -60,8 +52,6 @@ Selected primitive > **confidence**: `number` -Defined in: [types/agentNetwork.ts:530](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L530) - Confidence score (0-1) --- @@ -70,8 +60,6 @@ Confidence score (0-1) > **reasoning**: `string` -Defined in: [types/agentNetwork.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L533) - Reasoning for the decision --- @@ -80,8 +68,6 @@ Reasoning for the decision > `optional` **alternatives?**: `object`[] -Defined in: [types/agentNetwork.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L536) - Alternative primitives considered #### type @@ -102,6 +88,4 @@ Alternative primitives considered > `optional` **formattedInput?**: `string` -Defined in: [types/agentNetwork.ts:543](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L543) - Formatted input for the selected primitive diff --git a/docs/api/type-aliases/AgentRunBudget.md b/docs/api/type-aliases/AgentRunBudget.md index 0bbb23a31..178bbe786 100644 --- a/docs/api/type-aliases/AgentRunBudget.md +++ b/docs/api/type-aliases/AgentRunBudget.md @@ -8,8 +8,6 @@ > **AgentRunBudget** = `object` -Defined in: [types/isolatedAgent.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L295) - Cumulative budget accounting for leashed runs. ## Properties @@ -18,8 +16,6 @@ Cumulative budget accounting for leashed runs. > **spentMs**: `number` -Defined in: [types/isolatedAgent.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L297) - Total wall-clock spent across legs (ms). --- @@ -28,8 +24,6 @@ Total wall-clock spent across legs (ms). > **remainingMs**: `number` -Defined in: [types/isolatedAgent.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L299) - Remaining wall-clock vs the leg budget (ms; 0 when exhausted). --- @@ -38,6 +32,4 @@ Remaining wall-clock vs the leg budget (ms; 0 when exhausted). > **spentToolCalls**: `number` -Defined in: [types/isolatedAgent.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L301) - Total tool calls across legs. diff --git a/docs/api/type-aliases/AgentRunEvent.md b/docs/api/type-aliases/AgentRunEvent.md index 771062643..348be4933 100644 --- a/docs/api/type-aliases/AgentRunEvent.md +++ b/docs/api/type-aliases/AgentRunEvent.md @@ -8,8 +8,6 @@ > **AgentRunEvent** = `object` -Defined in: [types/isolatedAgent.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L207) - Lifecycle event for `AgentRunOptions.onEvent`. Fire-and-forget — listener errors never break the run. @@ -24,16 +22,12 @@ live started/finished signals. > **type**: [`AgentRunEventType`](AgentRunEventType.md) -Defined in: [types/isolatedAgent.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L208) - --- ### runId > **runId**: `string` -Defined in: [types/isolatedAgent.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L210) - Run id (also the default tool-context sessionId). --- @@ -42,8 +36,6 @@ Run id (also the default tool-context sessionId). > **agentId**: `string` -Defined in: [types/isolatedAgent.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L212) - Agent definition id. --- @@ -52,8 +44,6 @@ Agent definition id. > **timestamp**: `number` -Defined in: [types/isolatedAgent.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L214) - Epoch milliseconds. --- @@ -62,8 +52,6 @@ Epoch milliseconds. > `optional` **phase?**: `"research"` \| `"extraction"` -Defined in: [types/isolatedAgent.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L216) - Current phase, on `phase` events. --- @@ -72,8 +60,6 @@ Current phase, on `phase` events. > `optional` **toolName?**: `string` -Defined in: [types/isolatedAgent.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L218) - Tool name, on tool_call/tool_result events. --- @@ -82,8 +68,6 @@ Tool name, on tool_call/tool_result events. > `optional` **params?**: `unknown` -Defined in: [types/isolatedAgent.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L220) - Tool params, on tool_call events. --- @@ -92,8 +76,6 @@ Tool params, on tool_call events. > `optional` **resultSummary?**: `string` -Defined in: [types/isolatedAgent.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L222) - Bounded result summary, on tool_result events. --- @@ -102,8 +84,6 @@ Bounded result summary, on tool_result events. > `optional` **isError?**: `boolean` -Defined in: [types/isolatedAgent.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L224) - Whether the tool result was an error, on tool_result events. --- @@ -112,8 +92,6 @@ Whether the tool result was an error, on tool_result events. > `optional` **legIndex?**: `number` -Defined in: [types/isolatedAgent.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L226) - Leg index, on leg_end events (leashed mode). --- @@ -122,8 +100,6 @@ Leg index, on leg_end events (leashed mode). > `optional` **wasteSignals?**: `string`[] -Defined in: [types/isolatedAgent.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L228) - Tripped waste signatures, on waste events. --- @@ -132,8 +108,6 @@ Tripped waste signatures, on waste events. > `optional` **error?**: `string` -Defined in: [types/isolatedAgent.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L230) - Error message, on error events. --- @@ -142,6 +116,4 @@ Error message, on error events. > `optional` **status?**: [`AgentRunStatus`](AgentRunStatus.md) -Defined in: [types/isolatedAgent.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L232) - Final status, on complete events. diff --git a/docs/api/type-aliases/AgentRunEventType.md b/docs/api/type-aliases/AgentRunEventType.md index 9089d026f..75a1a5330 100644 --- a/docs/api/type-aliases/AgentRunEventType.md +++ b/docs/api/type-aliases/AgentRunEventType.md @@ -8,6 +8,4 @@ > **AgentRunEventType** = `"start"` \| `"tool_call"` \| `"tool_result"` \| `"phase"` \| `"wrapup"` \| `"leg_end"` \| `"waste"` \| `"complete"` \| `"error"` -Defined in: [types/isolatedAgent.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L187) - Lifecycle event types emitted by an isolated agent run. diff --git a/docs/api/type-aliases/AgentRunLegInfo.md b/docs/api/type-aliases/AgentRunLegInfo.md index 4669559bf..b0d510844 100644 --- a/docs/api/type-aliases/AgentRunLegInfo.md +++ b/docs/api/type-aliases/AgentRunLegInfo.md @@ -8,8 +8,6 @@ > **AgentRunLegInfo** = `object` -Defined in: [types/isolatedAgent.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L285) - Per-leg accounting for leashed runs. ## Properties @@ -18,8 +16,6 @@ Per-leg accounting for leashed runs. > **index**: `number` -Defined in: [types/isolatedAgent.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L287) - 0-based leg index. --- @@ -28,8 +24,6 @@ Defined in: [types/isolatedAgent.ts:287](https://github.com/juspay/neurolink/blo > **toolCalls**: `number` -Defined in: [types/isolatedAgent.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L289) - Tool calls made this leg. --- @@ -38,6 +32,4 @@ Tool calls made this leg. > **durationMs**: `number` -Defined in: [types/isolatedAgent.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L291) - Wall-clock duration of this leg (ms). diff --git a/docs/api/type-aliases/AgentRunOptions.md b/docs/api/type-aliases/AgentRunOptions.md index 9bd5dd27e..579f8aee4 100644 --- a/docs/api/type-aliases/AgentRunOptions.md +++ b/docs/api/type-aliases/AgentRunOptions.md @@ -8,8 +8,6 @@ > **AgentRunOptions** = `object` -Defined in: [types/isolatedAgent.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L238) - Options for one isolated agent run (`NeuroLink.runIsolatedAgent`). ## Properties @@ -18,8 +16,6 @@ Options for one isolated agent run (`NeuroLink.runIsolatedAgent`). > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/isolatedAgent.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L244) - Parent cancellation. When provided it MUST be honored: an aborted parent stops research AND extraction cleanly, the outcome reports the run was cancelled, and no ghost workers survive. @@ -30,8 +26,6 @@ cancelled, and no ghost workers survive. > `optional` **overrides?**: [`AgentRunOverrides`](AgentRunOverrides.md) -Defined in: [types/isolatedAgent.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L246) - Per-run overrides (internal-caller knobs). --- @@ -40,8 +34,6 @@ Per-run overrides (internal-caller knobs). > `optional` **toolContext?**: `Record`\<`string`, `unknown`\> -Defined in: [types/isolatedAgent.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L252) - Set on the worker for EVERY tool call (merged into the worker's tool context), including a caller-supplied `sessionId`; the run id is used when no sessionId is supplied. @@ -52,8 +44,6 @@ when no sessionId is supplied. > `optional` **onEvent?**: (`event`) => `void` -Defined in: [types/isolatedAgent.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L254) - Lifecycle event stream. Fire-and-forget. #### Parameters @@ -72,8 +62,6 @@ Lifecycle event stream. Fire-and-forget. > `optional` **leg?**: [`AgentLegOptions`](AgentLegOptions.md) -Defined in: [types/isolatedAgent.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L256) - Leg budget — enables leashed mode. --- @@ -82,8 +70,6 @@ Leg budget — enables leashed mode. > `optional` **handleTtlMs?**: `number` -Defined in: [types/isolatedAgent.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L258) - TTL for a leashed handle in ms (default 600_000 = 10 min). --- @@ -92,8 +78,6 @@ TTL for a leashed handle in ms (default 600_000 = 10 min). > `optional` **waste?**: [`AgentWasteThresholds`](AgentWasteThresholds.md) -Defined in: [types/isolatedAgent.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L260) - Waste-signature thresholds (defaults apply when omitted). --- @@ -102,8 +86,6 @@ Waste-signature thresholds (defaults apply when omitted). > `optional` **capture?**: `object` -Defined in: [types/isolatedAgent.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L266) - Bounds for the run's tool execution records. Raise `maxResultChars` when the CALLER verifies evidence from `toolExecutions` (raw result texts must be available up to the cap). diff --git a/docs/api/type-aliases/AgentRunOutcome.md b/docs/api/type-aliases/AgentRunOutcome.md index f18d71362..25d7ea82b 100644 --- a/docs/api/type-aliases/AgentRunOutcome.md +++ b/docs/api/type-aliases/AgentRunOutcome.md @@ -8,8 +8,6 @@ > **AgentRunOutcome** = `object` -Defined in: [types/isolatedAgent.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L312) - Outcome of an isolated agent run. Delivery guarantee: a run with a non-empty execution record never returns @@ -23,16 +21,12 @@ successful payloads). > **status**: [`AgentRunStatus`](AgentRunStatus.md) -Defined in: [types/isolatedAgent.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L313) - --- ### data? > `optional` **data?**: `unknown` -Defined in: [types/isolatedAgent.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L315) - Schema-valid extraction output when `extraction.schema` was given. --- @@ -41,8 +35,6 @@ Schema-valid extraction output when `extraction.schema` was given. > `optional` **content?**: `string` -Defined in: [types/isolatedAgent.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L317) - Final research-pass text (the worker's own narrative). --- @@ -51,8 +43,6 @@ Final research-pass text (the worker's own narrative). > `optional` **stopReason?**: [`GenerateStopReason`](GenerateStopReason.md) \| `string` -Defined in: [types/isolatedAgent.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L319) - Why the research turn ended (honest — see GenerateStopReason). --- @@ -61,8 +51,6 @@ Why the research turn ended (honest — see GenerateStopReason). > **toolExecutions**: [`ToolExecutionRecord`](ToolExecutionRecord.md)[] -Defined in: [types/isolatedAgent.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L325) - Real tool execution records (params/results/timing). Terminal outcomes carry the WHOLE run's records (all legs — what `data` was built from); `in_progress` legs carry this leg's records only. @@ -73,8 +61,6 @@ carry the WHOLE run's records (all legs — what `data` was built from); > `optional` **usage?**: [`TokenUsage`](TokenUsage.md) -Defined in: [types/isolatedAgent.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L327) - Aggregated token usage for the run (research + extraction). --- @@ -83,8 +69,6 @@ Aggregated token usage for the run (research + extraction). > **durationMs**: `number` -Defined in: [types/isolatedAgent.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L329) - Wall-clock duration of this call (ms). --- @@ -93,8 +77,6 @@ Wall-clock duration of this call (ms). > `optional` **extractionSource?**: `string` -Defined in: [types/isolatedAgent.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L331) - Present when extraction fell back through the recovery ladder. --- @@ -103,8 +85,6 @@ Present when extraction fell back through the recovery ladder. > `optional` **extractionError?**: `string` -Defined in: [types/isolatedAgent.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L333) - Extraction/validation error summary when data is a mechanical digest. --- @@ -113,8 +93,6 @@ Extraction/validation error summary when data is a mechanical digest. > `optional` **handle?**: `string` -Defined in: [types/isolatedAgent.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L336) - Resume handle (status "in_progress" only). --- @@ -123,8 +101,6 @@ Resume handle (status "in_progress" only). > `optional` **leg?**: [`AgentRunLegInfo`](AgentRunLegInfo.md) -Defined in: [types/isolatedAgent.ts:338](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L338) - This leg's accounting. --- @@ -133,8 +109,6 @@ This leg's accounting. > `optional` **delta?**: `string`[] -Defined in: [types/isolatedAgent.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L340) - One-line query→outcome summaries for this leg. --- @@ -143,8 +117,6 @@ One-line query→outcome summaries for this leg. > `optional` **nextPlan?**: `string` -Defined in: [types/isolatedAgent.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L342) - The worker's own stated intent for the next leg. --- @@ -153,8 +125,6 @@ The worker's own stated intent for the next leg. > `optional` **wasteSignals?**: `string`[] -Defined in: [types/isolatedAgent.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L344) - Tripped waste signatures, if any. --- @@ -163,6 +133,4 @@ Tripped waste signatures, if any. > `optional` **budget?**: [`AgentRunBudget`](AgentRunBudget.md) -Defined in: [types/isolatedAgent.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L346) - Cumulative budget accounting. diff --git a/docs/api/type-aliases/AgentRunOverrides.md b/docs/api/type-aliases/AgentRunOverrides.md index d560a2e73..d4e8cd9b9 100644 --- a/docs/api/type-aliases/AgentRunOverrides.md +++ b/docs/api/type-aliases/AgentRunOverrides.md @@ -8,8 +8,6 @@ > **AgentRunOverrides** = `object` -Defined in: [types/isolatedAgent.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L140) - Per-run overrides for an isolated agent run (internal-caller knobs). ## Properties @@ -18,8 +16,6 @@ Per-run overrides for an isolated agent run (internal-caller knobs). > `optional` **turnTimeoutMs?**: `number` -Defined in: [types/isolatedAgent.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L142) - Wall-clock cap for the research pass (ms). --- @@ -28,8 +24,6 @@ Wall-clock cap for the research pass (ms). > `optional` **stallTimeoutMs?**: `number` -Defined in: [types/isolatedAgent.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L144) - Stall watchdog for the research pass (ms). --- @@ -38,8 +32,6 @@ Stall watchdog for the research pass (ms). > `optional` **wrapupTimeLeadMs?**: `number` -Defined in: [types/isolatedAgent.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L146) - Wrap-up lead for the research pass (ms). --- @@ -48,8 +40,6 @@ Wrap-up lead for the research pass (ms). > `optional` **maxSteps?**: `number` -Defined in: [types/isolatedAgent.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L148) - Max agentic steps for the research pass. --- @@ -58,8 +48,6 @@ Max agentic steps for the research pass. > `optional` **maxTokens?**: `number` -Defined in: [types/isolatedAgent.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L150) - Max output tokens per model call. --- @@ -68,8 +56,6 @@ Max output tokens per model call. > `optional` **model?**: `string` -Defined in: [types/isolatedAgent.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L152) - Model override (wins over the definition). --- @@ -78,6 +64,4 @@ Model override (wins over the definition). > `optional` **provider?**: `string` -Defined in: [types/isolatedAgent.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L154) - Provider override (wins over the definition). diff --git a/docs/api/type-aliases/AgentRunStatus.md b/docs/api/type-aliases/AgentRunStatus.md index 1013276b1..891dbf49f 100644 --- a/docs/api/type-aliases/AgentRunStatus.md +++ b/docs/api/type-aliases/AgentRunStatus.md @@ -8,6 +8,4 @@ > **AgentRunStatus** = `"completed"` \| `"partial"` \| `"in_progress"` \| `"insufficient_data"` \| `"error"` -Defined in: [types/isolatedAgent.ts:277](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L277) - Terminal (or leg-boundary) status of an isolated agent run. diff --git a/docs/api/type-aliases/AgentStatus.md b/docs/api/type-aliases/AgentStatus.md index e5badc294..226633e1f 100644 --- a/docs/api/type-aliases/AgentStatus.md +++ b/docs/api/type-aliases/AgentStatus.md @@ -8,8 +8,6 @@ > **AgentStatus** = `object` -Defined in: [types/agentNetwork.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L151) - Agent status information ## Properties @@ -18,8 +16,6 @@ Agent status information > **id**: `string` -Defined in: [types/agentNetwork.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L153) - Agent ID --- @@ -28,8 +24,6 @@ Agent ID > **name**: `string` -Defined in: [types/agentNetwork.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L156) - Agent name --- @@ -38,8 +32,6 @@ Agent name > **executionCount**: `number` -Defined in: [types/agentNetwork.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L159) - Number of executions --- @@ -48,8 +40,6 @@ Number of executions > `optional` **lastExecutionTime?**: `number` -Defined in: [types/agentNetwork.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L162) - Last execution time in ms --- @@ -58,6 +48,4 @@ Last execution time in ms > **available**: `boolean` -Defined in: [types/agentNetwork.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L165) - Whether agent is available diff --git a/docs/api/type-aliases/AgentStreamChunk.md b/docs/api/type-aliases/AgentStreamChunk.md index 0198f2fd3..d95965881 100644 --- a/docs/api/type-aliases/AgentStreamChunk.md +++ b/docs/api/type-aliases/AgentStreamChunk.md @@ -8,8 +8,6 @@ > **AgentStreamChunk** = `object` -Defined in: [types/agentNetwork.ts:656](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L656) - Agent stream chunk ## Properties @@ -18,8 +16,6 @@ Agent stream chunk > **type**: [`AgentStreamChunkType`](AgentStreamChunkType.md) -Defined in: [types/agentNetwork.ts:658](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L658) - Chunk type --- @@ -28,8 +24,6 @@ Chunk type > **agentId**: `string` -Defined in: [types/agentNetwork.ts:661](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L661) - Agent ID --- @@ -38,8 +32,6 @@ Agent ID > **timestamp**: `number` -Defined in: [types/agentNetwork.ts:664](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L664) - Timestamp --- @@ -48,8 +40,6 @@ Timestamp > **traceId**: `string` -Defined in: [types/agentNetwork.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L667) - Trace ID --- @@ -58,8 +48,6 @@ Trace ID > `optional` **content?**: `string` -Defined in: [types/agentNetwork.ts:670](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L670) - Content (for text chunks) --- @@ -68,8 +56,6 @@ Content (for text chunks) > `optional` **isPartial?**: `boolean` -Defined in: [types/agentNetwork.ts:673](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L673) - Whether content is partial (for text chunks) --- @@ -78,8 +64,6 @@ Whether content is partial (for text chunks) > `optional` **usage?**: [`TokenUsage`](TokenUsage.md) -Defined in: [types/agentNetwork.ts:676](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L676) - Token usage (for complete chunks) --- @@ -88,8 +72,6 @@ Token usage (for complete chunks) > `optional` **duration?**: `number` -Defined in: [types/agentNetwork.ts:679](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L679) - Duration in ms (for complete chunks) --- @@ -98,8 +80,6 @@ Duration in ms (for complete chunks) > `optional` **error?**: `string` -Defined in: [types/agentNetwork.ts:682](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L682) - Error message (for error chunks) --- @@ -108,8 +88,6 @@ Error message (for error chunks) > `optional` **toolName?**: `string` -Defined in: [types/agentNetwork.ts:685](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L685) - Tool name (for tool chunks) --- @@ -118,8 +96,6 @@ Tool name (for tool chunks) > `optional` **toolCallId?**: `string` -Defined in: [types/agentNetwork.ts:688](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L688) - Tool call ID (for tool chunks) --- @@ -128,8 +104,6 @@ Tool call ID (for tool chunks) > `optional` **args?**: `unknown` -Defined in: [types/agentNetwork.ts:691](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L691) - Tool arguments (for tool call chunks) --- @@ -138,8 +112,6 @@ Tool arguments (for tool call chunks) > `optional` **result?**: `unknown` -Defined in: [types/agentNetwork.ts:694](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L694) - Tool result (for tool result chunks) --- @@ -148,6 +120,4 @@ Tool result (for tool result chunks) > `optional` **success?**: `boolean` -Defined in: [types/agentNetwork.ts:697](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L697) - Whether tool succeeded (for tool result chunks) diff --git a/docs/api/type-aliases/AgentStreamChunkType.md b/docs/api/type-aliases/AgentStreamChunkType.md index 39efe5cd6..51ea44a74 100644 --- a/docs/api/type-aliases/AgentStreamChunkType.md +++ b/docs/api/type-aliases/AgentStreamChunkType.md @@ -8,6 +8,4 @@ > **AgentStreamChunkType** = `"agent-start"` \| `"agent-thinking"` \| `"agent-text"` \| `"agent-tool-call"` \| `"agent-tool-result"` \| `"agent-complete"` \| `"agent-error"` -Defined in: [types/agentNetwork.ts:644](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L644) - Agent-specific streaming chunk types diff --git a/docs/api/type-aliases/AgentTextChunk.md b/docs/api/type-aliases/AgentTextChunk.md index 69928873b..436701a1e 100644 --- a/docs/api/type-aliases/AgentTextChunk.md +++ b/docs/api/type-aliases/AgentTextChunk.md @@ -8,8 +8,6 @@ > **AgentTextChunk** = [`NetworkStreamChunkBase`](NetworkStreamChunkBase.md) & `object` -Defined in: [types/agentNetwork.ts:783](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L783) - Agent text generation event ## Type Declaration diff --git a/docs/api/type-aliases/AgentToolCallChunk.md b/docs/api/type-aliases/AgentToolCallChunk.md index 042d9cd2e..c717f9ddb 100644 --- a/docs/api/type-aliases/AgentToolCallChunk.md +++ b/docs/api/type-aliases/AgentToolCallChunk.md @@ -8,8 +8,6 @@ > **AgentToolCallChunk** = [`NetworkStreamChunkBase`](NetworkStreamChunkBase.md) & `object` -Defined in: [types/agentNetwork.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L793) - Agent tool call event ## Type Declaration diff --git a/docs/api/type-aliases/AgentToolRegistrationOptions.md b/docs/api/type-aliases/AgentToolRegistrationOptions.md index df23f2077..4c7403bcc 100644 --- a/docs/api/type-aliases/AgentToolRegistrationOptions.md +++ b/docs/api/type-aliases/AgentToolRegistrationOptions.md @@ -8,8 +8,6 @@ > **AgentToolRegistrationOptions** = `object` -Defined in: [types/isolatedAgent.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L467) - Options for `NeuroLink.registerAgentTool()` — wraps an isolated agent as a tool on the HOST instance so its existing generate() loop delegates without a second router generate. @@ -20,8 +18,6 @@ without a second router generate. > `optional` **name?**: `string` -Defined in: [types/isolatedAgent.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L469) - Tool name (default: the agent definition id). --- @@ -30,8 +26,6 @@ Tool name (default: the agent definition id). > `optional` **maxDelegationsPerTurn?**: `number` -Defined in: [types/isolatedAgent.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L475) - Max delegations to this tool per top-level generate() turn, counted in the loop itself. A refused call returns a recovery instruction, never a silent failure. @@ -42,8 +36,6 @@ silent failure. > `optional` **maxDepth?**: `number` -Defined in: [types/isolatedAgent.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L480) - Max delegation depth (via tool context `agentDepth`). At the limit the tool is withheld from the request entirely. @@ -53,8 +45,6 @@ tool is withheld from the request entirely. > `optional` **maxConcurrent?**: `number` -Defined in: [types/isolatedAgent.ts:489](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L489) - Process-wide concurrent delegation pool size. The pool is shared across all registered agent tools; the largest registered value wins (default 4) — registering raises the pool and can never lower it, so this is NOT a per-agent throttle. Nested delegations (agentDepth > 0) bypass the @@ -67,8 +57,6 @@ work behind a full pool would deadlock it. > `optional` **poolQueueTimeoutMs?**: `number` -Defined in: [types/isolatedAgent.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L491) - Queue timeout when the pool is saturated (ms, default 30_000). --- @@ -77,8 +65,6 @@ Queue timeout when the pool is saturated (ms, default 30_000). > `optional` **leg?**: [`AgentLegOptions`](AgentLegOptions.md) -Defined in: [types/isolatedAgent.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L493) - Leashed-by-default leg budget for this tool. --- @@ -87,8 +73,6 @@ Leashed-by-default leg budget for this tool. > `optional` **handleTtlMs?**: `number` -Defined in: [types/isolatedAgent.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L495) - Handle TTL for leashed delegations (ms, default 600_000). --- @@ -97,8 +81,6 @@ Handle TTL for leashed delegations (ms, default 600_000). > `optional` **waste?**: [`AgentWasteThresholds`](AgentWasteThresholds.md) -Defined in: [types/isolatedAgent.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L497) - Waste thresholds forwarded to each delegated run. --- @@ -107,6 +89,4 @@ Waste thresholds forwarded to each delegated run. > `optional` **overrides?**: [`AgentRunOverrides`](AgentRunOverrides.md) -Defined in: [types/isolatedAgent.ts:499](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L499) - Per-run overrides forwarded to each delegated run. diff --git a/docs/api/type-aliases/AgentToolResultChunk.md b/docs/api/type-aliases/AgentToolResultChunk.md index 6391c897e..55ebf5939 100644 --- a/docs/api/type-aliases/AgentToolResultChunk.md +++ b/docs/api/type-aliases/AgentToolResultChunk.md @@ -8,8 +8,6 @@ > **AgentToolResultChunk** = [`NetworkStreamChunkBase`](NetworkStreamChunkBase.md) & `object` -Defined in: [types/agentNetwork.ts:804](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L804) - Agent tool result event ## Type Declaration diff --git a/docs/api/type-aliases/AgentWasteThresholds.md b/docs/api/type-aliases/AgentWasteThresholds.md index d7bf90ecd..bbe408bfa 100644 --- a/docs/api/type-aliases/AgentWasteThresholds.md +++ b/docs/api/type-aliases/AgentWasteThresholds.md @@ -8,8 +8,6 @@ > **AgentWasteThresholds** = `object` -Defined in: [types/isolatedAgent.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L169) - Mechanical waste-signature thresholds, checked per tool call. A tripped signature ends the leg early with `wasteSignals` populated. @@ -19,8 +17,6 @@ signature ends the leg early with `wasteSignals` populated. > `optional` **duplicateCallLimit?**: `number` -Defined in: [types/isolatedAgent.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L174) - Max times the same call hash (tool + normalized params) may be seen in one run before tripping (default 2 — the third identical call trips). @@ -30,8 +26,6 @@ one run before tripping (default 2 — the third identical call trips). > `optional` **emptyResultStreakLimit?**: `number` -Defined in: [types/isolatedAgent.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L176) - Consecutive empty/zero-result calls before tripping (default 3). --- @@ -40,8 +34,6 @@ Consecutive empty/zero-result calls before tripping (default 3). > `optional` **errorStreakLimit?**: `number` -Defined in: [types/isolatedAgent.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L178) - Consecutive error results before tripping (default 3). --- @@ -50,7 +42,5 @@ Consecutive error results before tripping (default 3). > `optional` **noNewResultsLimit?**: `number` -Defined in: [types/isolatedAgent.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L183) - Calls without a new distinct result payload before tripping (default 8). diff --git a/docs/api/type-aliases/AgenticLoopAdapter.md b/docs/api/type-aliases/AgenticLoopAdapter.md index d1e69c91e..fe8e74531 100644 --- a/docs/api/type-aliases/AgenticLoopAdapter.md +++ b/docs/api/type-aliases/AgenticLoopAdapter.md @@ -8,8 +8,6 @@ > **AgenticLoopAdapter**\<`TConversation`, `TRaw`\> = `object` -Defined in: [types/loopEngine.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L178) - DESIGN DECISION — mid-turn tool-discovery hydration (Plan 08 blocker 2, Task 7): resolved by the single optional `resolveToolOnMiss` field below, NOT by a broader `dispatchTools?` full-dispatch override. A full-dispatch @@ -65,24 +63,18 @@ suite rather than asserted here. > `readonly` **providerLabel**: `string` -Defined in: [types/loopEngine.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L179) - --- ### maxSteps > `readonly` **maxSteps**: `number` -Defined in: [types/loopEngine.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L180) - --- ### toolFailureBreaker? > `readonly` `optional` **toolFailureBreaker?**: [`AgenticLoopToolFailureBreaker`](AgenticLoopToolFailureBreaker.md) -Defined in: [types/loopEngine.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L197) - Set only for adapter instances whose client has the TOOL_NOT_FOUND strike breaker today: both Gemini adapters (AI Studio, Vertex+Gemini) AND the Vertex+Claude call to createAnthropicLoopAdapter — NOT the native-Anthropic call to that same factory, and not Bedrock. See Verified Fact 4. --- @@ -91,8 +83,6 @@ Set only for adapter instances whose client has the TOOL_NOT_FOUND strike breake > `readonly` `optional` **appendPlanningNudge?**: (`conversation`, `text`) => `TConversation` -Defined in: [types/loopEngine.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L208) - Append a planning nudge to the conversation, in the provider's own message type. Supplied only by adapters whose caller can pass a step-boundary callback; the engine skips a nudge it has no way to write. @@ -122,8 +112,6 @@ that turn rather than open a second consecutive user message. > `readonly` `optional` **resolveToolOnMiss?**: (`name`) => \{ `execute`: (`args`, `opts`) => `Promise`\<`unknown`\>; \} \| `undefined` -Defined in: [types/loopEngine.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L221) - Second lookup path, consulted when a tool call names nothing executable in the caller's `options.tools` — used by adapters supporting mid-turn discovery to hydrate a tool the model just found via `search_tools`, or a @@ -148,8 +136,6 @@ override. > **buildStepRequest**(`conversation`, `step`): [`AgenticLoopStepRequest`](AgenticLoopStepRequest.md) -Defined in: [types/loopEngine.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L230) - #### Parameters ##### conversation @@ -170,8 +156,6 @@ Defined in: [types/loopEngine.ts:230](https://github.com/juspay/neurolink/blob/r > **executeStep**(`request`, `channel`, `signal`): `Promise`\<[`AgenticLoopStepResult`](AgenticLoopStepResult.md)\<`TRaw`\>\> -Defined in: [types/loopEngine.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L234) - #### Parameters ##### request @@ -196,8 +180,6 @@ Defined in: [types/loopEngine.ts:234](https://github.com/juspay/neurolink/blob/r > **buildToolResultMessages**(`conversation`, `stepResult`, `toolResults`, `step`): `TConversation` -Defined in: [types/loopEngine.ts:247](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L247) - `step` is the engine's own zero-based step index, not a count of times this hook ran. Adapters persist tool activity keyed by it, and the two numbers diverge: a malformed-call retry `continue`s before this hook is @@ -233,8 +215,6 @@ row after the first one. > **mapFinishReason**(`rawStopReason`, `hadToolCalls`): `string` -Defined in: [types/loopEngine.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L253) - #### Parameters ##### rawStopReason @@ -255,8 +235,6 @@ Defined in: [types/loopEngine.ts:253](https://github.com/juspay/neurolink/blob/r > `optional` **planReclaim**(`conversation`, `step`): [`AgenticLoopReclaimResult`](AgenticLoopReclaimResult.md)\<`TConversation`\> \| `undefined` -Defined in: [types/loopEngine.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L259) - Optional: in-turn context-budget reclaim, called once per step before buildStepRequest. #### Parameters @@ -279,8 +257,6 @@ Optional: in-turn context-budget reclaim, called once per step before buildStepR > `optional` **isMalformedStep**(`stepResult`): `boolean` -Defined in: [types/loopEngine.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L264) - Optional: Vertex+Gemini-only single-retry-on-malformed-call. #### Parameters @@ -299,8 +275,6 @@ Optional: Vertex+Gemini-only single-retry-on-malformed-call. > `optional` **buildMalformedRetryNote**(`conversation`, `step`): `TConversation` -Defined in: [types/loopEngine.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L265) - #### Parameters ##### conversation diff --git a/docs/api/type-aliases/AgenticLoopChunk.md b/docs/api/type-aliases/AgenticLoopChunk.md index 4f364eac5..4255e51a2 100644 --- a/docs/api/type-aliases/AgenticLoopChunk.md +++ b/docs/api/type-aliases/AgenticLoopChunk.md @@ -8,8 +8,6 @@ > **AgenticLoopChunk** = `object` -Defined in: [types/loopEngine.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L24) - One chunk on the engine's stream. `reasoning` is carried alongside `content` rather than instead of it: the @@ -25,12 +23,8 @@ silently, since the text path would keep working. > **content**: `string` -Defined in: [types/loopEngine.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L25) - --- ### reasoning? > `optional` **reasoning?**: `string` - -Defined in: [types/loopEngine.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L26) diff --git a/docs/api/type-aliases/AgenticLoopOptions.md b/docs/api/type-aliases/AgenticLoopOptions.md index 23707dd1f..259a72d7e 100644 --- a/docs/api/type-aliases/AgenticLoopOptions.md +++ b/docs/api/type-aliases/AgenticLoopOptions.md @@ -8,32 +8,24 @@ > **AgenticLoopOptions** = `object` -Defined in: [types/loopEngine.ts:611](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L611) - ## Properties ### tools? > `optional` **tools?**: `Record`\<`string`, \{ `execute?`: (`args`, `opts`) => `Promise`\<`unknown`\>; \}\> -Defined in: [types/loopEngine.ts:612](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L612) - --- ### abortSignal? > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/loopEngine.ts:621](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L621) - --- ### span? > `optional` **span?**: `Span` -Defined in: [types/loopEngine.ts:634](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L634) - Span the per-step provider retry annotates, via `withProviderRetry(..., span, ...)` — it records `gen_ai.provider.total_attempts` on every completed step, retried or not. @@ -51,8 +43,6 @@ because only they threaded a span before moving onto the engine. > `optional` **toolTimeoutMs?**: `number` \| `null` -Defined in: [types/loopEngine.ts:658](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L658) - Upper bound on a single `tool.execute()` (ms), or `null` for no bound. Defaults to `DEFAULT_TOOL_EXECUTION_TIMEOUT_MS` (300_000) when omitted. @@ -81,8 +71,6 @@ asked for. > `optional` **beforeStep?**: (`context`) => `Promise`\<[`ExecutionControlDecision`](ExecutionControlDecision.md) \| `undefined`\> -Defined in: [types/loopEngine.ts:672](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L672) - Step-boundary callback. Runs after a step's tool results have settled and been written into the conversation, and BEFORE the loop re-checks the step cap — the one point in a turn where raising the cap changes what happens diff --git a/docs/api/type-aliases/AgenticLoopReclaimResult.md b/docs/api/type-aliases/AgenticLoopReclaimResult.md index e9f16f9b6..d6741d2f4 100644 --- a/docs/api/type-aliases/AgenticLoopReclaimResult.md +++ b/docs/api/type-aliases/AgenticLoopReclaimResult.md @@ -8,8 +8,6 @@ > **AgenticLoopReclaimResult**\<`TConversation`\> = `object` -Defined in: [types/loopEngine.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L90) - ## Type Parameters ### TConversation @@ -22,16 +20,12 @@ Defined in: [types/loopEngine.ts:90](https://github.com/juspay/neurolink/blob/re > `optional` **conversation?**: `TConversation` -Defined in: [types/loopEngine.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L91) - --- ### stop? > `optional` **stop?**: `boolean` -Defined in: [types/loopEngine.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L107) - End the turn now, BEFORE this step's request is issued. A context guard does two things, and only one of them is "reclaim". When diff --git a/docs/api/type-aliases/AgenticLoopReportMetadata.md b/docs/api/type-aliases/AgenticLoopReportMetadata.md index afeb26562..27217d837 100644 --- a/docs/api/type-aliases/AgenticLoopReportMetadata.md +++ b/docs/api/type-aliases/AgenticLoopReportMetadata.md @@ -8,8 +8,6 @@ > **AgenticLoopReportMetadata** = `object` -Defined in: [types/conversation.ts:566](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L566) - Metadata for an individual agentic loop report A conversation session can have multiple reports tracked via this type @@ -19,8 +17,6 @@ A conversation session can have multiple reports tracked via this type > **reportId**: `string` -Defined in: [types/conversation.ts:568](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L568) - Unique identifier for this report --- @@ -29,8 +25,6 @@ Unique identifier for this report > **reportType**: [`AgenticLoopReportType`](AgenticLoopReportType.md) -Defined in: [types/conversation.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L570) - Platform/category of the report --- @@ -39,8 +33,6 @@ Platform/category of the report > **reportStatus**: [`AgenticLoopReportStatus`](AgenticLoopReportStatus.md) -Defined in: [types/conversation.ts:572](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L572) - Current status of the report --- @@ -49,8 +41,6 @@ Current status of the report > `optional` **auditPeriod?**: `object` -Defined in: [types/conversation.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L574) - Optional audit period date range for the report #### startDate diff --git a/docs/api/type-aliases/AgenticLoopReportStatus.md b/docs/api/type-aliases/AgenticLoopReportStatus.md index e8310a637..2182224fa 100644 --- a/docs/api/type-aliases/AgenticLoopReportStatus.md +++ b/docs/api/type-aliases/AgenticLoopReportStatus.md @@ -8,6 +8,4 @@ > **AgenticLoopReportStatus** = `"INPROGRESS"` \| `"COMPLETED"` \| `"CANCELLED"` \| `"FAILED"` -Defined in: [types/conversation.ts:556](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L556) - Status of an agentic loop report diff --git a/docs/api/type-aliases/AgenticLoopReportType.md b/docs/api/type-aliases/AgenticLoopReportType.md index 5994c8efb..5ad73c4f8 100644 --- a/docs/api/type-aliases/AgenticLoopReportType.md +++ b/docs/api/type-aliases/AgenticLoopReportType.md @@ -8,7 +8,5 @@ > **AgenticLoopReportType** = `"META"` \| `"GOOGLEADS"` \| `"GOOGLEGA4"` \| `"SHOPIFY"` \| `"BREEZE"` \| `"OTHER"` -Defined in: [types/conversation.ts:545](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L545) - Report type for agentic loop reports Identifies the platform or category of the report diff --git a/docs/api/type-aliases/AgenticLoopResult.md b/docs/api/type-aliases/AgenticLoopResult.md index 3f2a1266a..396e52a60 100644 --- a/docs/api/type-aliases/AgenticLoopResult.md +++ b/docs/api/type-aliases/AgenticLoopResult.md @@ -8,8 +8,6 @@ > **AgenticLoopResult**\<`TConversation`\> = `object` -Defined in: [types/loopEngine.ts:677](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L677) - ## Type Parameters ### TConversation @@ -22,24 +20,18 @@ Defined in: [types/loopEngine.ts:677](https://github.com/juspay/neurolink/blob/r > **text**: `string` -Defined in: [types/loopEngine.ts:678](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L678) - --- ### toolCalls > **toolCalls**: [`AgenticLoopToolCall`](AgenticLoopToolCall.md)[] -Defined in: [types/loopEngine.ts:679](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L679) - --- ### toolExecutions > **toolExecutions**: `object`[] -Defined in: [types/loopEngine.ts:692](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L692) - Every tool dispatch the loop performed, in order, including the ones that failed. @@ -77,40 +69,30 @@ refactor. > **usage**: [`AgenticLoopUsage`](AgenticLoopUsage.md) -Defined in: [types/loopEngine.ts:699](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L699) - --- ### finishReason > **finishReason**: `string` -Defined in: [types/loopEngine.ts:700](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L700) - --- ### rawStopReason > **rawStopReason**: `string` \| `undefined` -Defined in: [types/loopEngine.ts:701](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L701) - --- ### conversation > **conversation**: `TConversation` -Defined in: [types/loopEngine.ts:702](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L702) - --- ### aborted > **aborted**: `boolean` -Defined in: [types/loopEngine.ts:716](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L716) - True when the turn ended because its abort signal fired rather than because the model finished. diff --git a/docs/api/type-aliases/AgenticLoopStepRequest.md b/docs/api/type-aliases/AgenticLoopStepRequest.md index eae4c20ba..f7d253b93 100644 --- a/docs/api/type-aliases/AgenticLoopStepRequest.md +++ b/docs/api/type-aliases/AgenticLoopStepRequest.md @@ -8,24 +8,18 @@ > **AgenticLoopStepRequest** = `object` -Defined in: [types/loopEngine.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L74) - ## Properties ### raw > **raw**: `unknown` -Defined in: [types/loopEngine.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L75) - --- ### hydratedToolNames? > `optional` **hydratedToolNames?**: `string`[] -Defined in: [types/loopEngine.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L87) - Tools that became callable while this step's request was being built — mid-turn discovery hydrating a name the model had already tried. diff --git a/docs/api/type-aliases/AgenticLoopStepResult.md b/docs/api/type-aliases/AgenticLoopStepResult.md index 52a5d059d..27a635de9 100644 --- a/docs/api/type-aliases/AgenticLoopStepResult.md +++ b/docs/api/type-aliases/AgenticLoopStepResult.md @@ -8,8 +8,6 @@ > **AgenticLoopStepResult**\<`TRaw`\> = `object` -Defined in: [types/loopEngine.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L56) - ## Type Parameters ### TRaw @@ -22,40 +20,30 @@ Defined in: [types/loopEngine.ts:56](https://github.com/juspay/neurolink/blob/re > **text**: `string` -Defined in: [types/loopEngine.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L57) - --- ### reasoning? > `optional` **reasoning?**: `string` -Defined in: [types/loopEngine.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L58) - --- ### toolCalls > **toolCalls**: [`AgenticLoopToolCall`](AgenticLoopToolCall.md)[] -Defined in: [types/loopEngine.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L59) - --- ### usage > **usage**: [`AgenticLoopUsage`](AgenticLoopUsage.md) -Defined in: [types/loopEngine.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L60) - --- ### rawStopReason > **rawStopReason**: `string` \| `undefined` -Defined in: [types/loopEngine.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L62) - Provider's own raw stop/finish-reason string, e.g. "tool_use", "MAX_TOKENS" --- @@ -64,7 +52,5 @@ Provider's own raw stop/finish-reason string, e.g. "tool_use", "MAX_TOKENS" > **raw**: `TRaw` -Defined in: [types/loopEngine.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L65) - Adapter-private accumulated response data needed by buildToolResultMessages (e.g. Anthropic's ordered content blocks, Gemini's rawResponseParts). diff --git a/docs/api/type-aliases/AgenticLoopToolCall.md b/docs/api/type-aliases/AgenticLoopToolCall.md index 5dd63f4dd..4f582532e 100644 --- a/docs/api/type-aliases/AgenticLoopToolCall.md +++ b/docs/api/type-aliases/AgenticLoopToolCall.md @@ -8,28 +8,20 @@ > **AgenticLoopToolCall** = `object` -Defined in: [types/loopEngine.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L29) - ## Properties ### id > **id**: `string` -Defined in: [types/loopEngine.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L30) - --- ### name > **name**: `string` -Defined in: [types/loopEngine.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L31) - --- ### args > **args**: `Record`\<`string`, `unknown`\> - -Defined in: [types/loopEngine.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L32) diff --git a/docs/api/type-aliases/AgenticLoopToolCallResult.md b/docs/api/type-aliases/AgenticLoopToolCallResult.md index 6b27337ef..e68e8db78 100644 --- a/docs/api/type-aliases/AgenticLoopToolCallResult.md +++ b/docs/api/type-aliases/AgenticLoopToolCallResult.md @@ -8,8 +8,6 @@ > **AgenticLoopToolCallResult** = [`AgenticLoopToolCall`](AgenticLoopToolCall.md) & `object` -Defined in: [types/loopEngine.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L68) - ## Type Declaration ### output diff --git a/docs/api/type-aliases/AgenticLoopToolFailureBreaker.md b/docs/api/type-aliases/AgenticLoopToolFailureBreaker.md index 578e791c4..99c2cada7 100644 --- a/docs/api/type-aliases/AgenticLoopToolFailureBreaker.md +++ b/docs/api/type-aliases/AgenticLoopToolFailureBreaker.md @@ -8,24 +8,18 @@ > **AgenticLoopToolFailureBreaker** = `object` -Defined in: [types/loopEngine.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L110) - ## Properties ### maxRetries > **maxRetries**: `number` -Defined in: [types/loopEngine.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L111) - --- ### consecutive? > `optional` **consecutive?**: `boolean` -Defined in: [types/loopEngine.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L122) - Count CONSECUTIVE failures rather than lifetime ones: a clean result clears the strike count for that tool. @@ -41,8 +35,6 @@ tool for the rest of the turn. > `optional` **classifyResultFailure?**: (`output`) => `string` \| `undefined` -Defined in: [types/loopEngine.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L135) - Decide whether a RESOLVED tool result is really a failure. Some tools report failure without throwing: MCP `isError` payloads, a diff --git a/docs/api/type-aliases/AgenticLoopUsage.md b/docs/api/type-aliases/AgenticLoopUsage.md index 8384ba027..5cd5f821e 100644 --- a/docs/api/type-aliases/AgenticLoopUsage.md +++ b/docs/api/type-aliases/AgenticLoopUsage.md @@ -8,56 +8,42 @@ > **AgenticLoopUsage** = `object` -Defined in: [types/loopEngine.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L35) - ## Properties ### inputTokens > **inputTokens**: `number` -Defined in: [types/loopEngine.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L36) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/loopEngine.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L37) - --- ### cacheReadTokens? > `optional` **cacheReadTokens?**: `number` -Defined in: [types/loopEngine.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L38) - --- ### cacheWriteTokens? > `optional` **cacheWriteTokens?**: `number` -Defined in: [types/loopEngine.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L39) - --- ### reasoningTokens? > `optional` **reasoningTokens?**: `number` -Defined in: [types/loopEngine.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L40) - --- ### cacheWrite5mTokens? > `optional` **cacheWrite5mTokens?**: `number` -Defined in: [types/loopEngine.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L52) - Cache writes split by time-to-live, which Anthropic reports separately from the total under `cache_creation.ephemeral_5m_input_tokens` and `ephemeral_1h_input_tokens`. @@ -73,5 +59,3 @@ Undefined for providers that never report the split. ### cacheWrite1hTokens? > `optional` **cacheWrite1hTokens?**: `number` - -Defined in: [types/loopEngine.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L53) diff --git a/docs/api/type-aliases/AggregatedMetrics.md b/docs/api/type-aliases/AggregatedMetrics.md index 22e46d1b5..f6c0f11d9 100644 --- a/docs/api/type-aliases/AggregatedMetrics.md +++ b/docs/api/type-aliases/AggregatedMetrics.md @@ -8,8 +8,6 @@ > **AggregatedMetrics** = `object` -Defined in: [types/evaluation.ts:754](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L754) - Aggregated metrics across pipelines and scorers. ## Properties @@ -18,40 +16,30 @@ Aggregated metrics across pipelines and scorers. > **totalEvaluations**: `number` -Defined in: [types/evaluation.ts:755](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L755) - --- ### overallPassRate > **overallPassRate**: `number` -Defined in: [types/evaluation.ts:756](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L756) - --- ### averageScore > **averageScore**: `number` -Defined in: [types/evaluation.ts:757](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L757) - --- ### averageDuration > **averageDuration**: `number` -Defined in: [types/evaluation.ts:758](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L758) - --- ### scoreDistribution > **scoreDistribution**: `object` -Defined in: [types/evaluation.ts:759](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L759) - #### excellent > **excellent**: `number` @@ -78,28 +66,20 @@ Defined in: [types/evaluation.ts:759](https://github.com/juspay/neurolink/blob/r > **pipelineMetrics**: `Map`\<`string`, [`PipelineMetrics`](PipelineMetrics.md)\> -Defined in: [types/evaluation.ts:766](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L766) - --- ### scorerMetrics > **scorerMetrics**: `Map`\<`string`, [`ScorerMetrics`](ScorerMetrics.md)\> -Defined in: [types/evaluation.ts:767](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L767) - --- ### collectionStartTime > **collectionStartTime**: `number` -Defined in: [types/evaluation.ts:768](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L768) - --- ### lastUpdateTime > **lastUpdateTime**: `number` - -Defined in: [types/evaluation.ts:769](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L769) diff --git a/docs/api/type-aliases/AggregatedScores.md b/docs/api/type-aliases/AggregatedScores.md index 3fe7ccfe7..5df2e57ff 100644 --- a/docs/api/type-aliases/AggregatedScores.md +++ b/docs/api/type-aliases/AggregatedScores.md @@ -8,8 +8,6 @@ > **AggregatedScores** = `object` -Defined in: [types/scorer.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L71) - Aggregated scores from multiple scorers ## Properties @@ -18,8 +16,6 @@ Aggregated scores from multiple scorers > **scores**: [`ScoreResult`](ScoreResult.md)[] -Defined in: [types/scorer.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L73) - Individual score results --- @@ -28,8 +24,6 @@ Individual score results > **overallScore**: `number` -Defined in: [types/scorer.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L75) - Overall aggregated score --- @@ -38,8 +32,6 @@ Overall aggregated score > **aggregationMethod**: [`AggregationMethod`](AggregationMethod.md) -Defined in: [types/scorer.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L77) - Aggregation method used --- @@ -48,8 +40,6 @@ Aggregation method used > **passed**: `boolean` -Defined in: [types/scorer.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L79) - Whether overall evaluation passed --- @@ -58,8 +48,6 @@ Whether overall evaluation passed > **totalComputeTime**: `number` -Defined in: [types/scorer.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L81) - Total computation time (ms) --- @@ -68,8 +56,6 @@ Total computation time (ms) > **timestamp**: `number` -Defined in: [types/scorer.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L83) - Timestamp of evaluation --- @@ -78,6 +64,4 @@ Timestamp of evaluation > `optional` **correlationId?**: `string` -Defined in: [types/scorer.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L85) - Session/request ID for correlation diff --git a/docs/api/type-aliases/AggregatedUsage.md b/docs/api/type-aliases/AggregatedUsage.md index 0d9c3740d..f8691fdeb 100644 --- a/docs/api/type-aliases/AggregatedUsage.md +++ b/docs/api/type-aliases/AggregatedUsage.md @@ -8,8 +8,6 @@ > **AggregatedUsage** = `object` -Defined in: [types/workflow.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L398) - Aggregated token usage across all models ## Properties @@ -18,32 +16,24 @@ Aggregated token usage across all models > **totalInputTokens**: `number` -Defined in: [types/workflow.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L399) - --- ### totalOutputTokens > **totalOutputTokens**: `number` -Defined in: [types/workflow.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L400) - --- ### totalTokens > **totalTokens**: `number` -Defined in: [types/workflow.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L401) - --- ### byModel > **byModel**: `object`[] -Defined in: [types/workflow.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L404) - #### provider > **provider**: `string` @@ -74,8 +64,6 @@ Defined in: [types/workflow.ts:404](https://github.com/juspay/neurolink/blob/rel > `optional` **judgeUsage?**: `object` -Defined in: [types/workflow.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L414) - #### inputTokens > **inputTokens**: `number` diff --git a/docs/api/type-aliases/AggregationConfig.md b/docs/api/type-aliases/AggregationConfig.md index 7c384a32e..a170cbe2d 100644 --- a/docs/api/type-aliases/AggregationConfig.md +++ b/docs/api/type-aliases/AggregationConfig.md @@ -8,8 +8,6 @@ > **AggregationConfig** = `object` -Defined in: [types/scorer.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L363) - Aggregation configuration ## Properties @@ -18,8 +16,6 @@ Aggregation configuration > **method**: [`AggregationMethod`](AggregationMethod.md) -Defined in: [types/scorer.ts:365](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L365) - Aggregation method --- @@ -28,8 +24,6 @@ Aggregation method > `optional` **weights?**: `Record`\<`string`, `number`\> -Defined in: [types/scorer.ts:367](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L367) - Weights for weighted aggregation --- @@ -38,8 +32,6 @@ Weights for weighted aggregation > `optional` **customFn?**: (`scores`) => `number` -Defined in: [types/scorer.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L369) - Custom aggregation function #### Parameters diff --git a/docs/api/type-aliases/AggregationMethod.md b/docs/api/type-aliases/AggregationMethod.md index 9812e10b3..f977f9646 100644 --- a/docs/api/type-aliases/AggregationMethod.md +++ b/docs/api/type-aliases/AggregationMethod.md @@ -8,6 +8,4 @@ > **AggregationMethod** = `"average"` \| `"weighted"` \| `"minimum"` \| `"maximum"` \| `"custom"` -Defined in: [types/scorer.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L91) - Aggregation method for combining scores diff --git a/docs/api/type-aliases/AggregationRequest.md b/docs/api/type-aliases/AggregationRequest.md index 1fbfe41fb..14319a1e8 100644 --- a/docs/api/type-aliases/AggregationRequest.md +++ b/docs/api/type-aliases/AggregationRequest.md @@ -8,8 +8,6 @@ > **AggregationRequest** = `object` -Defined in: [types/agentNetwork.ts:1191](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1191) - Aggregation request payload ## Properties @@ -18,8 +16,6 @@ Aggregation request payload > **sessionId**: `string` -Defined in: [types/agentNetwork.ts:1193](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1193) - Protocol session ID --- @@ -28,8 +24,6 @@ Protocol session ID > **state**: [`ProtocolState`](ProtocolState.md) -Defined in: [types/agentNetwork.ts:1196](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1196) - Protocol state --- @@ -38,8 +32,6 @@ Protocol state > **data**: `object` -Defined in: [types/agentNetwork.ts:1199](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1199) - Aggregation data #### results diff --git a/docs/api/type-aliases/AggregationResult.md b/docs/api/type-aliases/AggregationResult.md index 812c1e049..e9d850782 100644 --- a/docs/api/type-aliases/AggregationResult.md +++ b/docs/api/type-aliases/AggregationResult.md @@ -8,8 +8,6 @@ > **AggregationResult** = `object` -Defined in: [types/evaluation.ts:527](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L527) - Comprehensive aggregation result. ## Properties @@ -18,72 +16,54 @@ Comprehensive aggregation result. > **count**: `number` -Defined in: [types/evaluation.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L528) - --- ### statistics > **statistics**: [`ScoreStatistics`](ScoreStatistics.md) -Defined in: [types/evaluation.ts:529](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L529) - --- ### distribution > **distribution**: [`ScoreDistribution`](ScoreDistribution.md) -Defined in: [types/evaluation.ts:530](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L530) - --- ### dimensions > **dimensions**: [`DimensionAnalysis`](DimensionAnalysis.md) -Defined in: [types/evaluation.ts:531](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L531) - --- ### sequenceTrend? > `optional` **sequenceTrend?**: [`TrendAnalysis`](TrendAnalysis.md) -Defined in: [types/evaluation.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L532) - --- ### alerts > **alerts**: [`AlertSummary`](AlertSummary.md) -Defined in: [types/evaluation.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L533) - --- ### passingRate > **passingRate**: `number` -Defined in: [types/evaluation.ts:534](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L534) - --- ### avgEvaluationTime > **avgEvaluationTime**: `number` -Defined in: [types/evaluation.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L535) - --- ### metadata > **metadata**: `object` -Defined in: [types/evaluation.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L536) - #### aggregatedAt > **aggregatedAt**: `string` diff --git a/docs/api/type-aliases/AiAnalysisProvider.md b/docs/api/type-aliases/AiAnalysisProvider.md index 07278e79d..993e82cf3 100644 --- a/docs/api/type-aliases/AiAnalysisProvider.md +++ b/docs/api/type-aliases/AiAnalysisProvider.md @@ -8,6 +8,4 @@ > **AiAnalysisProvider** = `"openai"` \| `"bedrock"` \| `"vertex"` \| `"anthropic"` \| `"google-ai"` \| `"azure"` \| `"huggingface"` \| `"ollama"` \| `"mistral"` -Defined in: [types/mcp.ts:2678](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2678) - Provider name accepted by the AI analysis MCP tools. diff --git a/docs/api/type-aliases/AiSdkStreamChunk.md b/docs/api/type-aliases/AiSdkStreamChunk.md index c6389cc67..719f1c5a9 100644 --- a/docs/api/type-aliases/AiSdkStreamChunk.md +++ b/docs/api/type-aliases/AiSdkStreamChunk.md @@ -8,8 +8,6 @@ > **AiSdkStreamChunk** = `object` -Defined in: [types/client.ts:1617](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1617) - Internal stream chunk format used by the AI-SDK adapter's push/pull queue. Distinct from the public NeuroLink `StreamChunk` (stream.ts) — this one mirrors the underlying `ai` package event shape (text-delta / finish). @@ -20,32 +18,24 @@ mirrors the underlying `ai` package event shape (text-delta / finish). > **type**: `"text-delta"` \| `"finish"` -Defined in: [types/client.ts:1618](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1618) - --- ### textDelta? > `optional` **textDelta?**: `string` -Defined in: [types/client.ts:1619](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1619) - --- ### finishReason? > `optional` **finishReason?**: `string` -Defined in: [types/client.ts:1620](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1620) - --- ### usage? > `optional` **usage?**: `object` -Defined in: [types/client.ts:1621](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1621) - #### promptTokens > **promptTokens**: `number` diff --git a/docs/api/type-aliases/AiSdkToolCall.md b/docs/api/type-aliases/AiSdkToolCall.md index c8b07322b..70dd8603d 100644 --- a/docs/api/type-aliases/AiSdkToolCall.md +++ b/docs/api/type-aliases/AiSdkToolCall.md @@ -8,8 +8,6 @@ > **AiSdkToolCall** = `object` -Defined in: [types/tools.ts:626](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L626) - AI SDK Tool Call format (from Vercel AI SDK) ## Properties @@ -18,28 +16,20 @@ AI SDK Tool Call format (from Vercel AI SDK) > **type**: `"tool-call"` -Defined in: [types/tools.ts:627](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L627) - --- ### toolCallId > **toolCallId**: `string` -Defined in: [types/tools.ts:628](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L628) - --- ### toolName > **toolName**: `string` -Defined in: [types/tools.ts:629](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L629) - --- ### params > **params**: [`ToolArgs`](ToolArgs.md) - -Defined in: [types/tools.ts:630](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L630) diff --git a/docs/api/type-aliases/AlertSeverity.md b/docs/api/type-aliases/AlertSeverity.md index 56bb1d283..f25116cc7 100644 --- a/docs/api/type-aliases/AlertSeverity.md +++ b/docs/api/type-aliases/AlertSeverity.md @@ -8,6 +8,4 @@ > **AlertSeverity** = `"low"` \| `"medium"` \| `"high"` \| `"none"` -Defined in: [types/evaluation.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L34) - Alert severity levels diff --git a/docs/api/type-aliases/AlertSummary.md b/docs/api/type-aliases/AlertSummary.md index 473887fa0..1f45d23df 100644 --- a/docs/api/type-aliases/AlertSummary.md +++ b/docs/api/type-aliases/AlertSummary.md @@ -8,8 +8,6 @@ > **AlertSummary** = `object` -Defined in: [types/evaluation.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L518) - Quality alerts summary. ## Properties @@ -18,36 +16,26 @@ Quality alerts summary. > **total**: `number` -Defined in: [types/evaluation.ts:519](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L519) - --- ### high > **high**: `number` -Defined in: [types/evaluation.ts:520](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L520) - --- ### medium > **medium**: `number` -Defined in: [types/evaluation.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L521) - --- ### offTopic > **offTopic**: `number` -Defined in: [types/evaluation.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L522) - --- ### alertRate > **alertRate**: `number` - -Defined in: [types/evaluation.ts:523](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L523) diff --git a/docs/api/type-aliases/AllToolsMap.md b/docs/api/type-aliases/AllToolsMap.md index 8f78f6545..96cdc6aa7 100644 --- a/docs/api/type-aliases/AllToolsMap.md +++ b/docs/api/type-aliases/AllToolsMap.md @@ -8,8 +8,6 @@ > **AllToolsMap** = `object` -Defined in: [types/tools.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L532) - Full directAgentTools map, with the opt-in bashTool appended. ## Properties @@ -18,44 +16,32 @@ Full directAgentTools map, with the opt-in bashTool appended. > **getCurrentTime**: [`Tool`](Tool.md) -Defined in: [types/tools.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L533) - --- ### calculateMath > **calculateMath**: [`Tool`](Tool.md) -Defined in: [types/tools.ts:534](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L534) - --- ### readFile > **readFile**: [`Tool`](Tool.md) -Defined in: [types/tools.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L535) - --- ### listDirectory > **listDirectory**: [`Tool`](Tool.md) -Defined in: [types/tools.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L536) - --- ### writeFile > **writeFile**: [`Tool`](Tool.md) -Defined in: [types/tools.ts:537](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L537) - --- ### executeBashCommand? > `optional` **executeBashCommand?**: [`Tool`](Tool.md) - -Defined in: [types/tools.ts:538](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L538) diff --git a/docs/api/type-aliases/AllowedCommand.md b/docs/api/type-aliases/AllowedCommand.md index ac832f167..e1ea4abfd 100644 --- a/docs/api/type-aliases/AllowedCommand.md +++ b/docs/api/type-aliases/AllowedCommand.md @@ -8,6 +8,4 @@ > **AllowedCommand** = `"ollama"` \| `"curl"` \| `"systemctl"` \| `"pkill"` \| `"killall"` \| `"open"` \| `"taskkill"` \| `"start"` -Defined in: [types/cli.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L24) - Ollama command utilities type diff --git a/docs/api/type-aliases/AnalyticsConfig.md b/docs/api/type-aliases/AnalyticsConfig.md index 0ad9dd1f8..803ecae9f 100644 --- a/docs/api/type-aliases/AnalyticsConfig.md +++ b/docs/api/type-aliases/AnalyticsConfig.md @@ -8,8 +8,6 @@ > **AnalyticsConfig** = `object` -Defined in: [types/config.ts:381](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L381) - Analytics configuration ## Properties @@ -18,64 +16,48 @@ Analytics configuration > `optional` **enabled?**: `boolean` -Defined in: [types/config.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L382) - --- ### trackTokens? > `optional` **trackTokens?**: `boolean` -Defined in: [types/config.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L383) - --- ### trackCosts? > `optional` **trackCosts?**: `boolean` -Defined in: [types/config.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L384) - --- ### trackPerformance? > `optional` **trackPerformance?**: `boolean` -Defined in: [types/config.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L385) - --- ### trackErrors? > `optional` **trackErrors?**: `boolean` -Defined in: [types/config.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L386) - --- ### exportFormat? > `optional` **exportFormat?**: `"json"` \| `"csv"` \| `"prometheus"` -Defined in: [types/config.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L387) - --- ### exportPath? > `optional` **exportPath?**: `string` -Defined in: [types/config.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L388) - --- ### retention? > `optional` **retention?**: `object` -Defined in: [types/config.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L389) - #### days? > `optional` **days?**: `number` diff --git a/docs/api/type-aliases/AnalyticsData.md b/docs/api/type-aliases/AnalyticsData.md index 486ab1ef7..1e1f07f91 100644 --- a/docs/api/type-aliases/AnalyticsData.md +++ b/docs/api/type-aliases/AnalyticsData.md @@ -8,8 +8,6 @@ > **AnalyticsData** = `object` -Defined in: [types/analytics.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L35) - Analytics data structure (consolidated from core analytics) ## Properties @@ -18,64 +16,48 @@ Analytics data structure (consolidated from core analytics) > **provider**: `string` -Defined in: [types/analytics.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L36) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/analytics.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L37) - --- ### tokenUsage > **tokenUsage**: [`TokenUsage`](TokenUsage.md) -Defined in: [types/analytics.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L38) - --- ### requestDuration > **requestDuration**: `number` -Defined in: [types/analytics.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L39) - --- ### timestamp > **timestamp**: `string` -Defined in: [types/analytics.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L40) - --- ### cost? > `optional` **cost?**: `number` -Defined in: [types/analytics.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L41) - --- ### context? > `optional` **context?**: [`JsonValue`](JsonValue.md) -Defined in: [types/analytics.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L42) - --- ### stepsUsed? > `optional` **stepsUsed?**: `number` -Defined in: [types/analytics.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L46) - Number of agentic steps (model calls) the turn used. --- @@ -84,8 +66,6 @@ Number of agentic steps (model calls) the turn used. > `optional` **toolCallCount?**: `number` -Defined in: [types/analytics.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L48) - Number of external tool calls the turn made (final_result excluded). --- @@ -94,8 +74,6 @@ Number of external tool calls the turn made (final_result excluded). > `optional` **stopReason?**: `string` -Defined in: [types/analytics.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L50) - Why the turn ended — see GenerateStopReason. --- @@ -104,8 +82,6 @@ Why the turn ended — see GenerateStopReason. > `optional` **elapsedMs?**: `number` -Defined in: [types/analytics.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L52) - Wall-clock duration of the turn in milliseconds. --- @@ -114,8 +90,6 @@ Wall-clock duration of the turn in milliseconds. > `optional` **rawFinishReason?**: `string` -Defined in: [types/analytics.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L54) - Verbatim provider finish/stop reason for the terminal model call. --- @@ -124,8 +98,6 @@ Verbatim provider finish/stop reason for the terminal model call. > `optional` **limits?**: [`ClaudeLimitSnapshot`](ClaudeLimitSnapshot.md) -Defined in: [types/analytics.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L61) - Account limit state observed on this request — subscription window headroom, reset times, and (via the NeuroLink Claude proxy) which account served it and how much the pool has left. Present for Anthropic traffic diff --git a/docs/api/type-aliases/AnalyticsErrorInfo.md b/docs/api/type-aliases/AnalyticsErrorInfo.md index c21cfe1e9..50cc9d45e 100644 --- a/docs/api/type-aliases/AnalyticsErrorInfo.md +++ b/docs/api/type-aliases/AnalyticsErrorInfo.md @@ -8,8 +8,6 @@ > **AnalyticsErrorInfo** = `object` -Defined in: [types/analytics.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L25) - Error info type for analytics ## Properties @@ -18,28 +16,20 @@ Error info type for analytics > **message**: `string` -Defined in: [types/analytics.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L26) - --- ### code? > `optional` **code?**: `string` \| `number` -Defined in: [types/analytics.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L27) - --- ### stack? > `optional` **stack?**: `string` -Defined in: [types/analytics.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L28) - --- ### details? > `optional` **details?**: [`UnknownRecord`](UnknownRecord.md) - -Defined in: [types/analytics.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L29) diff --git a/docs/api/type-aliases/AnalyticsQualityScore.md b/docs/api/type-aliases/AnalyticsQualityScore.md index 28d51133a..12872e692 100644 --- a/docs/api/type-aliases/AnalyticsQualityScore.md +++ b/docs/api/type-aliases/AnalyticsQualityScore.md @@ -8,8 +8,6 @@ > **AnalyticsQualityScore** = `object` -Defined in: [types/analytics.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L106) - Quality score subset captured on an analytics telemetry record. ## Properties @@ -18,36 +16,26 @@ Quality score subset captured on an analytics telemetry record. > **overall**: `number` -Defined in: [types/analytics.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L107) - --- ### relevance > **relevance**: `number` -Defined in: [types/analytics.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L108) - --- ### accuracy > **accuracy**: `number` -Defined in: [types/analytics.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L109) - --- ### completeness > **completeness**: `number` -Defined in: [types/analytics.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L110) - --- ### reasoning? > `optional` **reasoning?**: `string` - -Defined in: [types/analytics.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L111) diff --git a/docs/api/type-aliases/AnalyticsStorage.md b/docs/api/type-aliases/AnalyticsStorage.md index bdaf1c4ef..72222d24c 100644 --- a/docs/api/type-aliases/AnalyticsStorage.md +++ b/docs/api/type-aliases/AnalyticsStorage.md @@ -8,8 +8,6 @@ > **AnalyticsStorage** = `object` -Defined in: [types/analytics.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L138) - Pluggable storage backend for analytics telemetry records. ## Methods @@ -18,8 +16,6 @@ Pluggable storage backend for analytics telemetry records. > **saveRecord**(`record`): `Promise`\<`void`\> -Defined in: [types/analytics.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L140) - Save a telemetry record #### Parameters @@ -38,8 +34,6 @@ Save a telemetry record > **getRecords**(): `Promise`\<[`TelemetryRecord`](TelemetryRecord.md)[]\> -Defined in: [types/analytics.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L142) - Retrieve all records #### Returns @@ -52,8 +46,6 @@ Retrieve all records > **clear**(): `Promise`\<`void`\> -Defined in: [types/analytics.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L144) - Clear storage #### Returns diff --git a/docs/api/type-aliases/AnalyzeCsvToolArgs.md b/docs/api/type-aliases/AnalyzeCsvToolArgs.md index c7b80ab37..7c5280851 100644 --- a/docs/api/type-aliases/AnalyzeCsvToolArgs.md +++ b/docs/api/type-aliases/AnalyzeCsvToolArgs.md @@ -8,8 +8,6 @@ > **AnalyzeCsvToolArgs** = `object` -Defined in: [types/tools.ts:499](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L499) - Arguments of the built-in analyzeCSV tool, after schema defaults. ## Properties @@ -18,28 +16,20 @@ Arguments of the built-in analyzeCSV tool, after schema defaults. > **filePath**: `string` -Defined in: [types/tools.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L500) - --- ### operation > **operation**: `"count_by_column"` \| `"sum_by_column"` \| `"average_by_column"` \| `"min_max_by_column"` \| `"describe"` -Defined in: [types/tools.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L501) - --- ### column > **column**: `string` -Defined in: [types/tools.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L507) - --- ### maxRows? > `optional` **maxRows?**: `number` - -Defined in: [types/tools.ts:508](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L508) diff --git a/docs/api/type-aliases/AnalyzeUsageParams.md b/docs/api/type-aliases/AnalyzeUsageParams.md index be413f07e..e91aa4f36 100644 --- a/docs/api/type-aliases/AnalyzeUsageParams.md +++ b/docs/api/type-aliases/AnalyzeUsageParams.md @@ -8,8 +8,6 @@ > **AnalyzeUsageParams** = `object` -Defined in: [types/mcp.ts:2690](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2690) - Parsed input for the analyze-ai-usage MCP tool. ## Properties @@ -18,36 +16,26 @@ Parsed input for the analyze-ai-usage MCP tool. > `optional` **sessionId?**: `string` -Defined in: [types/mcp.ts:2691](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2691) - --- ### timeRange > **timeRange**: `"1h"` \| `"24h"` \| `"7d"` \| `"30d"` -Defined in: [types/mcp.ts:2692](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2692) - --- ### provider? > `optional` **provider?**: [`AiAnalysisProvider`](AiAnalysisProvider.md) -Defined in: [types/mcp.ts:2693](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2693) - --- ### includeTokenBreakdown > **includeTokenBreakdown**: `boolean` -Defined in: [types/mcp.ts:2694](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2694) - --- ### includeCostEstimation > **includeCostEstimation**: `boolean` - -Defined in: [types/mcp.ts:2695](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2695) diff --git a/docs/api/type-aliases/AnnotatedToolTarget.md b/docs/api/type-aliases/AnnotatedToolTarget.md index c0c54b3fe..2d6e44e75 100644 --- a/docs/api/type-aliases/AnnotatedToolTarget.md +++ b/docs/api/type-aliases/AnnotatedToolTarget.md @@ -8,8 +8,6 @@ > **AnnotatedToolTarget** = `object` -Defined in: [types/cli.ts:1663](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1663) - Tool target used by the annotation printer. ## Properties @@ -18,28 +16,20 @@ Tool target used by the annotation printer. > **name**: `string` -Defined in: [types/cli.ts:1664](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1664) - --- ### description > **description**: `string` -Defined in: [types/cli.ts:1665](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1665) - --- ### serverId > **serverId**: `string` -Defined in: [types/cli.ts:1666](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1666) - --- ### serverName > **serverName**: `string` - -Defined in: [types/cli.ts:1667](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1667) diff --git a/docs/api/type-aliases/AnthropicAttemptLogger.md b/docs/api/type-aliases/AnthropicAttemptLogger.md index 8e1e0d980..abc62aeac 100644 --- a/docs/api/type-aliases/AnthropicAttemptLogger.md +++ b/docs/api/type-aliases/AnthropicAttemptLogger.md @@ -8,8 +8,6 @@ > **AnthropicAttemptLogger** = (`status`, `errorType?`, `errorMessage?`, `extra?`) => `void` -Defined in: [types/proxy.ts:1298](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1298) - ## Parameters ### status diff --git a/docs/api/type-aliases/AnthropicAuthConfig.md b/docs/api/type-aliases/AnthropicAuthConfig.md index 9991f1150..710f07067 100644 --- a/docs/api/type-aliases/AnthropicAuthConfig.md +++ b/docs/api/type-aliases/AnthropicAuthConfig.md @@ -8,8 +8,6 @@ > **AnthropicAuthConfig** = `object` -Defined in: [types/subscription.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L244) - Anthropic authentication configuration ## Description @@ -23,8 +21,6 @@ Supports both API key and OAuth authentication methods. > **method**: [`AnthropicAuthMethod`](AnthropicAuthMethod.md) -Defined in: [types/subscription.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L249) - Authentication method to use #### See @@ -37,8 +33,6 @@ AnthropicAuthMethod > `optional` **apiKey?**: `string` -Defined in: [types/subscription.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L255) - API key for API key authentication method #### Description @@ -51,8 +45,6 @@ Required when method is "api_key" > `optional` **oauthToken?**: [`OAuthToken`](OAuthToken.md) -Defined in: [types/subscription.ts:261](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L261) - OAuth token object for OAuth authentication method #### Description @@ -65,8 +57,6 @@ Full OAuth token with access, refresh, and expiry information > `optional` **accessToken?**: `string` -Defined in: [types/subscription.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L268) - OAuth access token for OAuth authentication method #### Description @@ -83,8 +73,6 @@ Use oauthToken.accessToken instead > `optional` **refreshToken?**: `string` -Defined in: [types/subscription.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L275) - OAuth refresh token for obtaining new access tokens #### Description @@ -101,8 +89,6 @@ Use oauthToken.refreshToken instead > `optional` **tokenExpiry?**: `number` -Defined in: [types/subscription.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L282) - Token expiry timestamp in milliseconds (Unix epoch) #### Description @@ -119,8 +105,6 @@ Use oauthToken.expiresAt instead > `optional` **subscriptionTier?**: [`ClaudeSubscriptionTier`](ClaudeSubscriptionTier.md) -Defined in: [types/subscription.ts:288](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L288) - User's subscription tier #### Description @@ -133,8 +117,6 @@ Determines rate limits, features, and capabilities available > `optional` **autoRefresh?**: `boolean` -Defined in: [types/subscription.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L294) - Whether to automatically refresh OAuth tokens #### Description diff --git a/docs/api/type-aliases/AnthropicAuthConfigResult.md b/docs/api/type-aliases/AnthropicAuthConfigResult.md index db44c571c..2cee67318 100644 --- a/docs/api/type-aliases/AnthropicAuthConfigResult.md +++ b/docs/api/type-aliases/AnthropicAuthConfigResult.md @@ -8,8 +8,6 @@ > **AnthropicAuthConfigResult** = `object` -Defined in: [types/subscription.ts:1057](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1057) - Anthropic authentication configuration result for providerConfig Extended version with OAuth token details for configuration detection @@ -19,52 +17,38 @@ Extended version with OAuth token details for configuration detection > **method**: [`AnthropicAuthMethod`](AnthropicAuthMethod.md) -Defined in: [types/subscription.ts:1058](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1058) - --- ### tier > **tier**: [`ClaudeSubscriptionTier`](ClaudeSubscriptionTier.md) -Defined in: [types/subscription.ts:1059](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1059) - --- ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/subscription.ts:1060](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1060) - --- ### accessToken? > `optional` **accessToken?**: `string` -Defined in: [types/subscription.ts:1061](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1061) - --- ### refreshToken? > `optional` **refreshToken?**: `string` -Defined in: [types/subscription.ts:1062](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1062) - --- ### isConfigured > **isConfigured**: `boolean` -Defined in: [types/subscription.ts:1063](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1063) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/subscription.ts:1064](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1064) diff --git a/docs/api/type-aliases/AnthropicAuthMethod.md b/docs/api/type-aliases/AnthropicAuthMethod.md index ac414b3a7..a80736518 100644 --- a/docs/api/type-aliases/AnthropicAuthMethod.md +++ b/docs/api/type-aliases/AnthropicAuthMethod.md @@ -8,8 +8,6 @@ > **AnthropicAuthMethod** = `"api_key"` \| `"oauth"` -Defined in: [types/subscription.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L58) - Authentication methods supported for Anthropic API access ## Description diff --git a/docs/api/type-aliases/AnthropicAuthRetryResult.md b/docs/api/type-aliases/AnthropicAuthRetryResult.md index 8691b28a0..6138453fe 100644 --- a/docs/api/type-aliases/AnthropicAuthRetryResult.md +++ b/docs/api/type-aliases/AnthropicAuthRetryResult.md @@ -8,40 +8,30 @@ > **AnthropicAuthRetryResult** = `object` -Defined in: [types/proxy.ts:1442](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1442) - ## Properties ### response? > `optional` **response?**: `Response` \| `unknown` -Defined in: [types/proxy.ts:1443](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1443) - --- ### holdsAccountAdmission? > `optional` **holdsAccountAdmission?**: `boolean` -Defined in: [types/proxy.ts:1444](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1444) - --- ### continueLoop > **continueLoop**: `boolean` -Defined in: [types/proxy.ts:1445](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1445) - --- ### retryDelayMs? > `optional` **retryDelayMs?**: `number` -Defined in: [types/proxy.ts:1447](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1447) - Failure-path pacing before rotating after provider-wide overload. --- @@ -50,52 +40,38 @@ Failure-path pacing before rotating after provider-wide overload. > **lastError**: `unknown` -Defined in: [types/proxy.ts:1448](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1448) - --- ### authFailureMessage > **authFailureMessage**: `string` \| `null` -Defined in: [types/proxy.ts:1449](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1449) - --- ### entitlementFailure > **entitlementFailure**: [`AnthropicEntitlementFailure`](AnthropicEntitlementFailure.md) \| `null` -Defined in: [types/proxy.ts:1450](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1450) - --- ### sawRateLimit > **sawRateLimit**: `boolean` -Defined in: [types/proxy.ts:1451](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1451) - --- ### sawTransientFailure > **sawTransientFailure**: `boolean` -Defined in: [types/proxy.ts:1452](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1452) - --- ### sawNetworkError > **sawNetworkError**: `boolean` -Defined in: [types/proxy.ts:1453](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1453) - --- ### upstreamSpan? > `optional` **upstreamSpan?**: `Span` - -Defined in: [types/proxy.ts:1454](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1454) diff --git a/docs/api/type-aliases/AnthropicBetaFeatures.md b/docs/api/type-aliases/AnthropicBetaFeatures.md index 9a2a3a23a..bbc413bc7 100644 --- a/docs/api/type-aliases/AnthropicBetaFeatures.md +++ b/docs/api/type-aliases/AnthropicBetaFeatures.md @@ -8,8 +8,6 @@ > **AnthropicBetaFeatures** = `object` -Defined in: [types/subscription.ts:813](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L813) - Anthropic beta feature flags for beta header configuration ## Description @@ -27,8 +25,6 @@ https://docs.anthropic.com/en/api/versioning#beta-headers > `optional` **computerUse?**: `boolean` -Defined in: [types/subscription.ts:819](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L819) - Enable computer use capability #### Description @@ -42,8 +38,6 @@ Header value: "computer-use-2024-10-22" > `optional` **extendedThinking?**: `boolean` -Defined in: [types/subscription.ts:826](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L826) - Enable extended thinking/reasoning #### Description @@ -57,8 +51,6 @@ Header value: "extended-thinking-2025-01-24" > `optional` **promptCaching?**: `boolean` -Defined in: [types/subscription.ts:833](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L833) - Enable prompt caching #### Description @@ -72,8 +64,6 @@ Header value: "prompt-caching-2024-07-31" > `optional` **tokenCounting?**: `boolean` -Defined in: [types/subscription.ts:840](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L840) - Enable token counting #### Description @@ -87,8 +77,6 @@ Header value: "token-counting-2024-11-01" > `optional` **messageBatches?**: `boolean` -Defined in: [types/subscription.ts:847](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L847) - Enable message batches #### Description @@ -102,8 +90,6 @@ Header value: "message-batches-2024-09-24" > `optional` **pdfs?**: `boolean` -Defined in: [types/subscription.ts:854](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L854) - Enable PDF support #### Description @@ -117,8 +103,6 @@ Header value: "pdfs-2024-09-25" > `optional` **maxTokensOverride?**: `boolean` -Defined in: [types/subscription.ts:861](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L861) - Enable max tokens override (for higher output limits) #### Description @@ -132,8 +116,6 @@ Header value: "max-tokens-3-5-sonnet-2024-07-15" > `optional` **interleavedThinking?**: `boolean` -Defined in: [types/subscription.ts:868](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L868) - Enable interleaved thinking (for multi-turn reasoning) #### Description @@ -147,8 +129,6 @@ Header value: "interleaved-thinking-2025-01-24" > `optional` **filesApi?**: `boolean` -Defined in: [types/subscription.ts:875](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L875) - Enable files API #### Description @@ -162,8 +142,6 @@ Header value: "files-api-2025-01-15" > `optional` **mcpConnectors?**: `boolean` -Defined in: [types/subscription.ts:882](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L882) - Enable MCP connectors #### Description @@ -177,8 +155,6 @@ Header value: "mcp-connectors-2025-01-01" > `optional` **codeExecution?**: `boolean` -Defined in: [types/subscription.ts:889](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L889) - Enable code execution #### Description @@ -192,8 +168,6 @@ Header value: "code-execution-2025-01-24" > `optional` **custom?**: `string`[] -Defined in: [types/subscription.ts:895](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L895) - Custom beta features as raw strings #### Description diff --git a/docs/api/type-aliases/AnthropicBetaHeader.md b/docs/api/type-aliases/AnthropicBetaHeader.md index d508a4609..2f583ff70 100644 --- a/docs/api/type-aliases/AnthropicBetaHeader.md +++ b/docs/api/type-aliases/AnthropicBetaHeader.md @@ -8,8 +8,6 @@ > **AnthropicBetaHeader** = `"computer-use-2024-10-22"` \| `"extended-thinking-2025-01-24"` \| `"prompt-caching-2024-07-31"` \| `"token-counting-2024-11-01"` \| `"message-batches-2024-09-24"` \| `"pdfs-2024-09-25"` \| `"max-tokens-3-5-sonnet-2024-07-15"` \| `"interleaved-thinking-2025-01-24"` \| `"files-api-2025-01-15"` \| `"mcp-connectors-2025-01-01"` \| `"code-execution-2025-01-24"` \| `string` -Defined in: [types/subscription.ts:904](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L904) - Anthropic beta header string values ## Description diff --git a/docs/api/type-aliases/AnthropicEntitlementFailure.md b/docs/api/type-aliases/AnthropicEntitlementFailure.md index 56b97e728..b7dfccde2 100644 --- a/docs/api/type-aliases/AnthropicEntitlementFailure.md +++ b/docs/api/type-aliases/AnthropicEntitlementFailure.md @@ -8,8 +8,6 @@ > **AnthropicEntitlementFailure** = `object` -Defined in: [types/proxy.ts:3697](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3697) - Accounts rejected by an organization/plan entitlement policy during a single request. Anthropic answers such an account with a `permission_error` that no amount of retrying or token refreshing can fix, but which a _different_ @@ -22,16 +20,12 @@ client only once every account has been tried. > **status**: `number` -Defined in: [types/proxy.ts:3698](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3698) - --- ### accounts > **accounts**: `string`[] -Defined in: [types/proxy.ts:3700](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3700) - Labels of every account that rejected this request on entitlement. --- @@ -40,8 +34,6 @@ Labels of every account that rejected this request on entitlement. > **message**: `string` -Defined in: [types/proxy.ts:3702](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3702) - Upstream message from the first such rejection. --- @@ -49,5 +41,3 @@ Upstream message from the first such rejection. ### errorCode? > `optional` **errorCode?**: `string` - -Defined in: [types/proxy.ts:3703](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3703) diff --git a/docs/api/type-aliases/AnthropicGuardBlock.md b/docs/api/type-aliases/AnthropicGuardBlock.md index 886d8c10c..3fbf868b2 100644 --- a/docs/api/type-aliases/AnthropicGuardBlock.md +++ b/docs/api/type-aliases/AnthropicGuardBlock.md @@ -8,8 +8,6 @@ > **AnthropicGuardBlock** = `object` -Defined in: [types/context.ts:890](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L890) - Structural view of one Anthropic content block, loose enough to accept the official SDK's `ContentBlockParam` union and NeuroLink's own `VertexAnthropicMessage` blocks without a cast at either call site. @@ -20,16 +18,12 @@ official SDK's `ContentBlockParam` union and NeuroLink's own > **type**: `string` -Defined in: [types/context.ts:891](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L891) - --- ### content? > `optional` **content?**: `unknown` -Defined in: [types/context.ts:893](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L893) - Payload of a `tool_result` block. Other block kinds carry other fields. --- @@ -38,6 +32,4 @@ Payload of a `tool_result` block. Other block kinds carry other fields. > `optional` **text?**: `string` -Defined in: [types/context.ts:895](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L895) - Text of a `text` block. diff --git a/docs/api/type-aliases/AnthropicGuardMessage.md b/docs/api/type-aliases/AnthropicGuardMessage.md index 32fcd08a1..f19f23861 100644 --- a/docs/api/type-aliases/AnthropicGuardMessage.md +++ b/docs/api/type-aliases/AnthropicGuardMessage.md @@ -8,8 +8,6 @@ > **AnthropicGuardMessage** = `object` -Defined in: [types/context.ts:904](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L904) - Structural view of one Anthropic-shaped message, as used by both the direct Anthropic loop and the native Vertex+Claude path. Tool calls ride as `tool_use` blocks on an assistant message; their answers ride as @@ -21,8 +19,6 @@ Anthropic loop and the native Vertex+Claude path. Tool calls ride as > **role**: `"user"` \| `"assistant"` \| `"system"` -Defined in: [types/context.ts:910](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L910) - `system` is included because the installed `@anthropic-ai/sdk` widens `MessageParam["role"]` to accept it; narrowing here would make the SDK's own array unassignable at the call site. @@ -32,5 +28,3 @@ own array unassignable at the call site. ### content > **content**: `string` \| [`AnthropicGuardBlock`](AnthropicGuardBlock.md)[] - -Defined in: [types/context.ts:911](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L911) diff --git a/docs/api/type-aliases/AnthropicInvalidRequestFailure.md b/docs/api/type-aliases/AnthropicInvalidRequestFailure.md index db47e3107..62dbe1176 100644 --- a/docs/api/type-aliases/AnthropicInvalidRequestFailure.md +++ b/docs/api/type-aliases/AnthropicInvalidRequestFailure.md @@ -8,8 +8,6 @@ > **AnthropicInvalidRequestFailure** = `object` -Defined in: [types/claudeProxy.ts:6](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L6) - A deterministic upstream validation failure that must reach the caller. ## Properties @@ -18,20 +16,14 @@ A deterministic upstream validation failure that must reach the caller. > **status**: `number` -Defined in: [types/claudeProxy.ts:7](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L7) - --- ### body > **body**: `string` -Defined in: [types/claudeProxy.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L8) - --- ### contentType? > `optional` **contentType?**: `string` - -Defined in: [types/claudeProxy.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L9) diff --git a/docs/api/type-aliases/AnthropicLoopAdapterConfig.md b/docs/api/type-aliases/AnthropicLoopAdapterConfig.md index f30d741ac..fc4bf4014 100644 --- a/docs/api/type-aliases/AnthropicLoopAdapterConfig.md +++ b/docs/api/type-aliases/AnthropicLoopAdapterConfig.md @@ -8,8 +8,6 @@ > **AnthropicLoopAdapterConfig**\<`TMessage`\> = `object` -Defined in: [types/loopEngine.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L293) - Construction input for `createAnthropicLoopAdapter`, shared by direct Anthropic and Claude-on-Vertex. @@ -34,8 +32,6 @@ the adapter config match. > **client**: `object` -Defined in: [types/loopEngine.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L305) - Only `messages.create` is ever called, so only that is required. `Pick` looked equivalent and is not: it demands the @@ -54,16 +50,12 @@ can drive perfectly, rejected for members it never touches. > **maxSteps**: `number` -Defined in: [types/loopEngine.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L308) - --- ### buildParams > **buildParams**: (`conversation`, `step`) => `Anthropic.Messages.MessageCreateParamsNonStreaming` -Defined in: [types/loopEngine.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L321) - Returns the NON-streaming params. The adapter adds `stream: true` itself, so requiring the streaming variant here would force every caller to declare a literal `true` it does not control — and a caller whose params @@ -90,8 +82,6 @@ the adapter is about to overwrite. > **toolsRecord**: `Record`\<`string`, [`Tool`](Tool.md)\> -Defined in: [types/loopEngine.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L326) - The turn's live tool record, used for deferred-catalog resolution. --- @@ -100,8 +90,6 @@ The turn's live tool record, used for deferred-catalog resolution. > `optional` **finalResultToolName?**: `string` -Defined in: [types/loopEngine.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L333) - Name of the terminal structured-output tool when one is in play. A call to it ends the turn: its arguments ARE the answer, so it is reported as text and omitted from `toolCalls`, which routes it through the engine's @@ -113,8 +101,6 @@ ordinary zero-tool-calls exit. > `optional` **onTerminalResult?**: (`text`) => `void` -Defined in: [types/loopEngine.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L345) - Called with the terminal tool's payload when one was actually detected. The caller cannot infer this from the turn's result. A structured turn @@ -141,8 +127,6 @@ tell them apart would be guesswork, so the adapter says which happened. > `optional` **requestTimeoutMs?**: `number` -Defined in: [types/loopEngine.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L358) - Hard deadline for ONE `messages.create` request (ms). Composed with the engine's signal for the duration of that step only, so it bounds a stalled upstream even when the turn itself has no lifetime ceiling — and is armed @@ -160,8 +144,6 @@ otherwise be reported as a model turn that simply said less. > `optional` **requireTerminalEvent?**: `boolean` -Defined in: [types/loopEngine.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L369) - Require the upstream terminal event (`message_stop`) before a step counts as complete. @@ -177,16 +159,12 @@ existing caller sees from a flaky connection. > `optional` **toolFailureBreaker?**: [`AgenticLoopToolFailureBreaker`](AgenticLoopToolFailureBreaker.md) -Defined in: [types/loopEngine.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L370) - --- ### planReclaim? > `optional` **planReclaim?**: (`conversation`, `step`) => [`AgenticLoopReclaimResult`](AgenticLoopReclaimResult.md)\<`TMessage`[]\> \| `undefined` -Defined in: [types/loopEngine.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L383) - In-turn context reclaim, run once per step before the request is built. Returns the rebuilt conversation when it reclaimed, undefined while the request still fits — leaving history byte-identical in the common case so @@ -218,8 +196,6 @@ drops this overflows the window mid-turn. > `optional` **noteObservedPromptTokens?**: (`promptTokens`) => `void` -Defined in: [types/loopEngine.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L393) - Calibration feedback for the provider's reclaim guard: the FULL prompt size for the step just made — uncached input plus both cache tiers. Passing input_tokens alone reads a cache-hit step as tiny and lets the @@ -240,5 +216,3 @@ guard drift far under the real cost. ### abortSignal? > `optional` **abortSignal?**: `AbortSignal` - -Defined in: [types/loopEngine.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L394) diff --git a/docs/api/type-aliases/AnthropicLoopState.md b/docs/api/type-aliases/AnthropicLoopState.md index bf3b0c5bd..4787ce627 100644 --- a/docs/api/type-aliases/AnthropicLoopState.md +++ b/docs/api/type-aliases/AnthropicLoopState.md @@ -8,108 +8,80 @@ > **AnthropicLoopState** = `object` -Defined in: [types/proxy.ts:1322](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1322) - ## Properties ### lastError > **lastError**: `unknown` -Defined in: [types/proxy.ts:1323](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1323) - --- ### sawRateLimit > **sawRateLimit**: `boolean` -Defined in: [types/proxy.ts:1324](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1324) - --- ### sawNetworkError > **sawNetworkError**: `boolean` -Defined in: [types/proxy.ts:1325](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1325) - --- ### sawTransientFailure > **sawTransientFailure**: `boolean` -Defined in: [types/proxy.ts:1326](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1326) - --- ### invalidRequestFailure > **invalidRequestFailure**: \{ `status`: `number`; `body`: `string`; `contentType?`: `string`; \} \| `null` -Defined in: [types/proxy.ts:1327](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1327) - --- ### authFailureMessage > **authFailureMessage**: `string` \| `null` -Defined in: [types/proxy.ts:1332](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1332) - --- ### authCooldownMessage > **authCooldownMessage**: `string` \| `null` -Defined in: [types/proxy.ts:1333](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1333) - --- ### entitlementFailure > **entitlementFailure**: [`AnthropicEntitlementFailure`](AnthropicEntitlementFailure.md) \| `null` -Defined in: [types/proxy.ts:1334](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1334) - --- ### scopedExhaustion > **scopedExhaustion**: [`AnthropicScopedExhaustion`](AnthropicScopedExhaustion.md) \| `null` -Defined in: [types/proxy.ts:1335](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1335) - --- ### fallbackFailureMessage? > `optional` **fallbackFailureMessage?**: `string` -Defined in: [types/proxy.ts:1336](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1336) - --- ### attemptNumber > **attemptNumber**: `number` -Defined in: [types/proxy.ts:1337](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1337) - --- ### lastTransportErrorCode? > `optional` **lastTransportErrorCode?**: `string` -Defined in: [types/proxy.ts:1338](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1338) - --- ### lastTransportScope? > `optional` **lastTransportScope?**: [`ProxyNetworkTransportScope`](ProxyNetworkTransportScope.md) - -Defined in: [types/proxy.ts:1339](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1339) diff --git a/docs/api/type-aliases/AnthropicModelMetadata.md b/docs/api/type-aliases/AnthropicModelMetadata.md index 503890084..54830efad 100644 --- a/docs/api/type-aliases/AnthropicModelMetadata.md +++ b/docs/api/type-aliases/AnthropicModelMetadata.md @@ -8,8 +8,6 @@ > **AnthropicModelMetadata** = `object` -Defined in: [types/subscription.ts:1135](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1135) - Model metadata definition for Anthropic models ## Properties @@ -18,8 +16,6 @@ Model metadata definition for Anthropic models > **displayName**: `string` -Defined in: [types/subscription.ts:1137](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1137) - Human-readable display name --- @@ -28,8 +24,6 @@ Human-readable display name > **contextWindow**: `number` -Defined in: [types/subscription.ts:1139](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1139) - Maximum context window size in tokens --- @@ -38,8 +32,6 @@ Maximum context window size in tokens > **maxOutputTokens**: `number` -Defined in: [types/subscription.ts:1141](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1141) - Maximum output tokens --- @@ -48,8 +40,6 @@ Maximum output tokens > **supportsVision**: `boolean` -Defined in: [types/subscription.ts:1143](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1143) - Whether the model supports vision/image input --- @@ -58,8 +48,6 @@ Whether the model supports vision/image input > **supportsExtendedThinking**: `boolean` -Defined in: [types/subscription.ts:1145](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1145) - Whether the model supports extended thinking mode --- @@ -68,8 +56,6 @@ Whether the model supports extended thinking mode > **supportsToolUse**: `boolean` -Defined in: [types/subscription.ts:1147](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1147) - Whether the model supports tool/function calling --- @@ -78,8 +64,6 @@ Whether the model supports tool/function calling > **supportsStreaming**: `boolean` -Defined in: [types/subscription.ts:1149](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1149) - Whether the model supports streaming --- @@ -88,8 +72,6 @@ Whether the model supports streaming > **deprecated**: `boolean` -Defined in: [types/subscription.ts:1151](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1151) - Whether the model is deprecated --- @@ -98,8 +80,6 @@ Whether the model is deprecated > **family**: `"haiku"` \| `"sonnet"` \| `"opus"` -Defined in: [types/subscription.ts:1153](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1153) - Model family (haiku, sonnet, opus) --- @@ -108,6 +88,4 @@ Model family (haiku, sonnet, opus) > **description**: `string` -Defined in: [types/subscription.ts:1155](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1155) - Short description of the model diff --git a/docs/api/type-aliases/AnthropicNonOkResult.md b/docs/api/type-aliases/AnthropicNonOkResult.md index 01e4819f4..81f5098d7 100644 --- a/docs/api/type-aliases/AnthropicNonOkResult.md +++ b/docs/api/type-aliases/AnthropicNonOkResult.md @@ -8,40 +8,30 @@ > **AnthropicNonOkResult** = `object` -Defined in: [types/proxy.ts:1457](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1457) - ## Properties ### response? > `optional` **response?**: `Response` \| `unknown` -Defined in: [types/proxy.ts:1458](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1458) - --- ### continueLoop > **continueLoop**: `boolean` -Defined in: [types/proxy.ts:1459](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1459) - --- ### retrySameAccount? > `optional` **retrySameAccount?**: `boolean` -Defined in: [types/proxy.ts:1460](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1460) - --- ### retryDelayMs? > `optional` **retryDelayMs?**: `number` -Defined in: [types/proxy.ts:1462](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1462) - Failure-path pacing before rotating after provider-wide overload. --- @@ -50,44 +40,32 @@ Failure-path pacing before rotating after provider-wide overload. > **lastError**: `unknown` -Defined in: [types/proxy.ts:1463](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1463) - --- ### authFailureMessage > **authFailureMessage**: `string` \| `null` -Defined in: [types/proxy.ts:1464](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1464) - --- ### sawTransientFailure > **sawTransientFailure**: `boolean` -Defined in: [types/proxy.ts:1465](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1465) - --- ### invalidRequestFailure > **invalidRequestFailure**: \{ `status`: `number`; `body`: `string`; `contentType?`: `string`; \} \| `null` -Defined in: [types/proxy.ts:1466](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1466) - --- ### entitlementFailure > **entitlementFailure**: [`AnthropicEntitlementFailure`](AnthropicEntitlementFailure.md) \| `null` -Defined in: [types/proxy.ts:1471](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1471) - --- ### upstreamSpan? > `optional` **upstreamSpan?**: `Span` - -Defined in: [types/proxy.ts:1472](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1472) diff --git a/docs/api/type-aliases/AnthropicOAuthConfig.md b/docs/api/type-aliases/AnthropicOAuthConfig.md index d55f1b007..6bb1aaa9f 100644 --- a/docs/api/type-aliases/AnthropicOAuthConfig.md +++ b/docs/api/type-aliases/AnthropicOAuthConfig.md @@ -8,8 +8,6 @@ > **AnthropicOAuthConfig** = `object` -Defined in: [types/subscription.ts:1008](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1008) - OAuth configuration options for AnthropicOAuth class ## Properties @@ -18,8 +16,6 @@ OAuth configuration options for AnthropicOAuth class > `optional` **clientId?**: `string` -Defined in: [types/subscription.ts:1010](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1010) - OAuth client ID (optional, uses env var if not provided) --- @@ -28,8 +24,6 @@ OAuth client ID (optional, uses env var if not provided) > `optional` **clientSecret?**: `string` -Defined in: [types/subscription.ts:1012](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1012) - OAuth client secret (optional, for confidential clients) --- @@ -38,8 +32,6 @@ OAuth client secret (optional, for confidential clients) > `optional` **redirectUri?**: `string` -Defined in: [types/subscription.ts:1014](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1014) - Redirect URI for OAuth callback --- @@ -48,8 +40,6 @@ Redirect URI for OAuth callback > `optional` **scopes?**: `string`[] -Defined in: [types/subscription.ts:1016](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1016) - OAuth scopes to request --- @@ -58,8 +48,6 @@ OAuth scopes to request > `optional` **authorizationUrl?**: `string` -Defined in: [types/subscription.ts:1018](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1018) - Custom authorization endpoint URL --- @@ -68,8 +56,6 @@ Custom authorization endpoint URL > `optional` **tokenUrl?**: `string` -Defined in: [types/subscription.ts:1020](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1020) - Custom token endpoint URL --- @@ -78,8 +64,6 @@ Custom token endpoint URL > `optional` **validationUrl?**: `string` -Defined in: [types/subscription.ts:1022](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1022) - Custom token validation endpoint URL --- @@ -88,6 +72,4 @@ Custom token validation endpoint URL > `optional` **revocationUrl?**: `string` -Defined in: [types/subscription.ts:1024](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1024) - Custom token revocation endpoint URL diff --git a/docs/api/type-aliases/AnthropicPendingToolUse.md b/docs/api/type-aliases/AnthropicPendingToolUse.md index 2399d78b5..4c1012e72 100644 --- a/docs/api/type-aliases/AnthropicPendingToolUse.md +++ b/docs/api/type-aliases/AnthropicPendingToolUse.md @@ -8,8 +8,6 @@ > **AnthropicPendingToolUse** = `object` -Defined in: [types/providers.ts:1128](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1128) - A tool_use block being assembled across Anthropic `input_json_delta` events. ## Properties @@ -18,20 +16,14 @@ A tool_use block being assembled across Anthropic `input_json_delta` events. > **id**: `string` -Defined in: [types/providers.ts:1129](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1129) - --- ### name > **name**: `string` -Defined in: [types/providers.ts:1130](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1130) - --- ### inputJson > **inputJson**: `string` - -Defined in: [types/providers.ts:1131](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1131) diff --git a/docs/api/type-aliases/AnthropicProviderConfig.md b/docs/api/type-aliases/AnthropicProviderConfig.md index c5182ee37..eb9d81ff5 100644 --- a/docs/api/type-aliases/AnthropicProviderConfig.md +++ b/docs/api/type-aliases/AnthropicProviderConfig.md @@ -8,8 +8,6 @@ > **AnthropicProviderConfig** = [`IndividualProviderConfig`](IndividualProviderConfig.md) & `object` -Defined in: [types/providers.ts:605](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L605) - Anthropic-specific provider configuration ## Type Declaration diff --git a/docs/api/type-aliases/AnthropicRateLimitInfo.md b/docs/api/type-aliases/AnthropicRateLimitInfo.md index 650792d3a..ba4558a8d 100644 --- a/docs/api/type-aliases/AnthropicRateLimitInfo.md +++ b/docs/api/type-aliases/AnthropicRateLimitInfo.md @@ -8,8 +8,6 @@ > **AnthropicRateLimitInfo** = `object` -Defined in: [types/subscription.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L97) - Rate limit information parsed from Anthropic API response headers ## See @@ -22,8 +20,6 @@ https://docs.anthropic.com/en/api/rate-limits > `optional` **requestsLimit?**: `number` -Defined in: [types/subscription.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L101) - Maximum number of requests allowed in the current window --- @@ -32,8 +28,6 @@ Maximum number of requests allowed in the current window > `optional` **requestsRemaining?**: `number` -Defined in: [types/subscription.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L106) - Number of requests remaining in the current window --- @@ -42,8 +36,6 @@ Number of requests remaining in the current window > `optional` **requestsReset?**: `string` -Defined in: [types/subscription.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L111) - Time when the request limit resets (ISO 8601 timestamp) --- @@ -52,8 +44,6 @@ Time when the request limit resets (ISO 8601 timestamp) > `optional` **tokensLimit?**: `number` -Defined in: [types/subscription.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L116) - Maximum number of tokens allowed in the current window --- @@ -62,8 +52,6 @@ Maximum number of tokens allowed in the current window > `optional` **tokensRemaining?**: `number` -Defined in: [types/subscription.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L121) - Number of tokens remaining in the current window --- @@ -72,8 +60,6 @@ Number of tokens remaining in the current window > `optional` **tokensReset?**: `string` -Defined in: [types/subscription.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L126) - Time when the token limit resets (ISO 8601 timestamp) --- @@ -82,8 +68,6 @@ Time when the token limit resets (ISO 8601 timestamp) > `optional` **retryAfter?**: `number` -Defined in: [types/subscription.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L131) - Retry-After header value in seconds (present on 429 responses) --- @@ -92,8 +76,6 @@ Retry-After header value in seconds (present on 429 responses) > `optional` **sessionUtilization?**: `number` -Defined in: [types/subscription.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L141) - Subscription (OAuth) window utilization, 0.0-1.0 of capacity USED, from `anthropic-ratelimit-unified-5h-utilization`. @@ -107,8 +89,6 @@ absolute remaining count — there is no message or token figure to report. > `optional` **sessionStatus?**: `string` -Defined in: [types/subscription.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L143) - "allowed" | "throttled" | "rejected" for the 5h window. --- @@ -117,8 +97,6 @@ Defined in: [types/subscription.ts:143](https://github.com/juspay/neurolink/blob > `optional` **sessionResetAt?**: `number` -Defined in: [types/subscription.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L145) - Unix epoch seconds at which the 5h window resets. --- @@ -127,8 +105,6 @@ Unix epoch seconds at which the 5h window resets. > `optional` **sessionLeftPct?**: `number` -Defined in: [types/subscription.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L147) - Whole-percent capacity remaining in the 5h window (100 - utilization). --- @@ -137,8 +113,6 @@ Whole-percent capacity remaining in the 5h window (100 - utilization). > `optional` **weeklyUtilization?**: `number` -Defined in: [types/subscription.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L150) - 7d window utilization, 0.0-1.0 of capacity USED. --- @@ -147,32 +121,24 @@ Defined in: [types/subscription.ts:150](https://github.com/juspay/neurolink/blob > `optional` **weeklyStatus?**: `string` -Defined in: [types/subscription.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L151) - --- ### weeklyResetAt? > `optional` **weeklyResetAt?**: `number` -Defined in: [types/subscription.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L152) - --- ### weeklyLeftPct? > `optional` **weeklyLeftPct?**: `number` -Defined in: [types/subscription.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L153) - --- ### unifiedStatus? > `optional` **unifiedStatus?**: `string` -Defined in: [types/subscription.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L157) - Authoritative top-level unified status; can be "rejected" even while both sub-windows still report "allowed". @@ -182,6 +148,4 @@ sub-windows still report "allowed". > `optional` **overageStatus?**: `string` -Defined in: [types/subscription.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L159) - Whether overage is permitted once a window is exhausted. diff --git a/docs/api/type-aliases/AnthropicResponseMetadata.md b/docs/api/type-aliases/AnthropicResponseMetadata.md index fb071539f..8cbd177b7 100644 --- a/docs/api/type-aliases/AnthropicResponseMetadata.md +++ b/docs/api/type-aliases/AnthropicResponseMetadata.md @@ -8,8 +8,6 @@ > **AnthropicResponseMetadata** = `object` -Defined in: [types/subscription.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L221) - Response metadata including rate limit information ## Description @@ -22,8 +20,6 @@ Contains metadata from Anthropic API responses > `optional` **rateLimit?**: [`AnthropicRateLimitInfo`](AnthropicRateLimitInfo.md) -Defined in: [types/subscription.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L225) - Rate limit information from response headers --- @@ -32,8 +28,6 @@ Rate limit information from response headers > `optional` **requestId?**: `string` -Defined in: [types/subscription.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L230) - Request ID for debugging --- @@ -42,6 +36,4 @@ Request ID for debugging > `optional` **serverTiming?**: `string` -Defined in: [types/subscription.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L235) - Server timing information diff --git a/docs/api/type-aliases/AnthropicScopedExhaustion.md b/docs/api/type-aliases/AnthropicScopedExhaustion.md index 84ef44c99..508f9525d 100644 --- a/docs/api/type-aliases/AnthropicScopedExhaustion.md +++ b/docs/api/type-aliases/AnthropicScopedExhaustion.md @@ -8,8 +8,6 @@ > **AnthropicScopedExhaustion** = `object` -Defined in: [types/proxy.ts:3711](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3711) - Every account's model-scoped window for the requested model is spent. Unlike a cooldown this is per-model: the same accounts stay healthy for every other model, so the client is told to switch model rather than to back off. @@ -20,8 +18,6 @@ model, so the client is told to switch model rather than to back off. > **model**: `string` -Defined in: [types/proxy.ts:3713](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3713) - Wire model id from the request. --- @@ -30,8 +26,6 @@ Wire model id from the request. > **scopeModel**: `string` -Defined in: [types/proxy.ts:3715](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3715) - Display name of the exhausted window, e.g. "Fable". --- @@ -40,8 +34,6 @@ Display name of the exhausted window, e.g. "Fable". > **earliestResetMs**: `number` -Defined in: [types/proxy.ts:3717](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3717) - Epoch ms of the soonest reset across the exhausted accounts. --- @@ -50,14 +42,10 @@ Epoch ms of the soonest reset across the exhausted accounts. > **accounts**: `string`[] -Defined in: [types/proxy.ts:3718](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3718) - --- ### overageDisabledReason? > `optional` **overageDisabledReason?**: `string` -Defined in: [types/proxy.ts:3720](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3720) - Provider reason overage is unavailable, e.g. "org_level_disabled". diff --git a/docs/api/type-aliases/AnthropicStreamPreflightResult.md b/docs/api/type-aliases/AnthropicStreamPreflightResult.md index 65480568b..06fe7d9fa 100644 --- a/docs/api/type-aliases/AnthropicStreamPreflightResult.md +++ b/docs/api/type-aliases/AnthropicStreamPreflightResult.md @@ -8,6 +8,4 @@ > **AnthropicStreamPreflightResult** = \{ `kind`: `"ready"`; `chunks`: `Uint8Array`[]; \} \| \{ `kind`: `"empty"`; `chunks`: `Uint8Array`[]; \} \| \{ `kind`: `"transport_error"`; `chunks`: `Uint8Array`[]; `error`: `unknown`; \} \| \{ `kind`: `"sse_error"`; `chunks`: `Uint8Array`[]; `errorType`: `string`; `message`: `string`; \} -Defined in: [types/proxy.ts:1422](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1422) - Result of buffering only enough upstream SSE to make a retry-safe decision. diff --git a/docs/api/type-aliases/AnthropicSuccessResult.md b/docs/api/type-aliases/AnthropicSuccessResult.md index 70decae26..9ddf3a1cf 100644 --- a/docs/api/type-aliases/AnthropicSuccessResult.md +++ b/docs/api/type-aliases/AnthropicSuccessResult.md @@ -8,8 +8,6 @@ > **AnthropicSuccessResult** = \{ `retryNextAccount`: `true`; `failure?`: \{ `message`: `string`; `rateLimit`: `boolean`; `retryDelayMs?`: `number`; `sameAccountRetry?`: \{ `coolingUntil`: `number`; `retryAfterMs`: `number`; \}; \}; \} \| \{ `response`: `Response` \| `unknown`; `holdsAccountAdmission?`: `boolean`; `served`: `boolean`; \} -Defined in: [types/proxy.ts:1365](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1365) - ## Union Members ### Type Literal diff --git a/docs/api/type-aliases/AnthropicUpstreamBody.md b/docs/api/type-aliases/AnthropicUpstreamBody.md index c51dce660..dd71e3231 100644 --- a/docs/api/type-aliases/AnthropicUpstreamBody.md +++ b/docs/api/type-aliases/AnthropicUpstreamBody.md @@ -8,28 +8,20 @@ > **AnthropicUpstreamBody** = `object` -Defined in: [types/proxy.ts:1342](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1342) - ## Properties ### bodyStr > **bodyStr**: `string` -Defined in: [types/proxy.ts:1343](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1343) - --- ### sessionId? > `optional` **sessionId?**: `string` -Defined in: [types/proxy.ts:1344](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1344) - --- ### preparedContext > **preparedContext**: [`ProxyPreparedContext`](ProxyPreparedContext.md)\<[`ClaudeRequest`](ClaudeRequest.md)\> - -Defined in: [types/proxy.ts:1345](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1345) diff --git a/docs/api/type-aliases/AnthropicUpstreamBodyBuilder.md b/docs/api/type-aliases/AnthropicUpstreamBodyBuilder.md index aa42014b0..30638db3a 100644 --- a/docs/api/type-aliases/AnthropicUpstreamBodyBuilder.md +++ b/docs/api/type-aliases/AnthropicUpstreamBodyBuilder.md @@ -8,8 +8,6 @@ > **AnthropicUpstreamBodyBuilder** = (`token`) => [`AnthropicUpstreamBody`](AnthropicUpstreamBody.md) -Defined in: [types/proxy.ts:1348](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1348) - ## Parameters ### token diff --git a/docs/api/type-aliases/AnthropicUpstreamFetchResult.md b/docs/api/type-aliases/AnthropicUpstreamFetchResult.md index a4e434189..f90992664 100644 --- a/docs/api/type-aliases/AnthropicUpstreamFetchResult.md +++ b/docs/api/type-aliases/AnthropicUpstreamFetchResult.md @@ -8,48 +8,36 @@ > **AnthropicUpstreamFetchResult** = `object` -Defined in: [types/proxy.ts:1521](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1521) - ## Properties ### continueLoop > **continueLoop**: `boolean` -Defined in: [types/proxy.ts:1522](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1522) - --- ### retrySameAccount? > `optional` **retrySameAccount?**: `boolean` -Defined in: [types/proxy.ts:1523](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1523) - --- ### transportScope? > `optional` **transportScope?**: [`ProxyNetworkTransportScope`](ProxyNetworkTransportScope.md) -Defined in: [types/proxy.ts:1524](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1524) - --- ### errorCode? > `optional` **errorCode?**: `string` -Defined in: [types/proxy.ts:1525](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1525) - --- ### connectPhase? > `optional` **connectPhase?**: `boolean` -Defined in: [types/proxy.ts:1528](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1528) - The transport failure happened while connecting, before any request byte was sent, so retrying it cannot duplicate provider work. @@ -59,8 +47,6 @@ byte was sent, so retrying it cannot duplicate provider work. > `optional` **retryAfterMs?**: `number` -Defined in: [types/proxy.ts:1530](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1530) - When set, the caller should wait this many ms before retrying (from upstream retry-after). --- @@ -69,8 +55,6 @@ When set, the caller should wait this many ms before retrying (from upstream ret > `optional` **cooldownPlan?**: [`AccountCooldownPlan`](AccountCooldownPlan.md) -Defined in: [types/proxy.ts:1532](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1532) - Set on a genuine 429: how long / why to cool this account before rotating. --- @@ -79,8 +63,6 @@ Set on a genuine 429: how long / why to cool this account before rotating. > `optional` **quota?**: [`AccountQuota`](AccountQuota.md) -Defined in: [types/proxy.ts:1534](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1534) - Quota snapshot parsed from the response headers (429 or success), if present. --- @@ -89,8 +71,6 @@ Quota snapshot parsed from the response headers (429 or success), if present. > `optional` **terminalError?**: `object` -Defined in: [types/proxy.ts:1538](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1538) - A terminal upstream rejection already captured and classified by the fetch layer. The route must finalize it directly instead of feeding it through the generic non-OK handler a second time. @@ -117,36 +97,26 @@ through the generic non-OK handler a second time. > `optional` **response?**: `Response` -Defined in: [types/proxy.ts:1544](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1544) - --- ### lastError > **lastError**: `unknown` -Defined in: [types/proxy.ts:1545](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1545) - --- ### sawRateLimit > **sawRateLimit**: `boolean` -Defined in: [types/proxy.ts:1546](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1546) - --- ### sawNetworkError > **sawNetworkError**: `boolean` -Defined in: [types/proxy.ts:1547](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1547) - --- ### upstreamSpan? > `optional` **upstreamSpan?**: `Span` - -Defined in: [types/proxy.ts:1548](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1548) diff --git a/docs/api/type-aliases/AnthropicUsageLimit.md b/docs/api/type-aliases/AnthropicUsageLimit.md index 91c5615f2..268e3fe3b 100644 --- a/docs/api/type-aliases/AnthropicUsageLimit.md +++ b/docs/api/type-aliases/AnthropicUsageLimit.md @@ -8,8 +8,6 @@ > **AnthropicUsageLimit** = `object` -Defined in: [types/proxy.ts:1837](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1837) - One entry of the usage endpoint's generic `limits[]` array (wire shape). ## Properties @@ -18,24 +16,18 @@ One entry of the usage endpoint's generic `limits[]` array (wire shape). > `optional` **kind?**: `string` -Defined in: [types/proxy.ts:1838](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1838) - --- ### group? > `optional` **group?**: `string` -Defined in: [types/proxy.ts:1839](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1839) - --- ### percent? > `optional` **percent?**: `number` \| `null` -Defined in: [types/proxy.ts:1841](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1841) - 0-100 percent. --- @@ -44,28 +36,20 @@ Defined in: [types/proxy.ts:1841](https://github.com/juspay/neurolink/blob/relea > `optional` **severity?**: `string` \| `null` -Defined in: [types/proxy.ts:1842](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1842) - --- ### resets_at? > `optional` **resets_at?**: `string` \| `null` -Defined in: [types/proxy.ts:1843](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1843) - --- ### scope? > `optional` **scope?**: \{ `model?`: \{ `id?`: `string` \| `null`; `display_name?`: `string` \| `null`; \} \| `null`; `surface?`: `string` \| `null`; \} \| `null` -Defined in: [types/proxy.ts:1844](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1844) - --- ### is_active? > `optional` **is_active?**: `boolean` \| `null` - -Defined in: [types/proxy.ts:1848](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1848) diff --git a/docs/api/type-aliases/AnthropicUsageResponse.md b/docs/api/type-aliases/AnthropicUsageResponse.md index 79e31f17c..e28e0d232 100644 --- a/docs/api/type-aliases/AnthropicUsageResponse.md +++ b/docs/api/type-aliases/AnthropicUsageResponse.md @@ -8,8 +8,6 @@ > **AnthropicUsageResponse** = `object` -Defined in: [types/proxy.ts:1853](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1853) - Response body of GET https://api.anthropic.com/api/oauth/usage (loose — unknown keys are ignored, known keys may be absent or null). @@ -19,28 +17,20 @@ unknown keys are ignored, known keys may be absent or null). > `optional` **five_hour?**: [`AnthropicUsageWindow`](AnthropicUsageWindow.md) \| `null` -Defined in: [types/proxy.ts:1854](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1854) - --- ### seven_day? > `optional` **seven_day?**: [`AnthropicUsageWindow`](AnthropicUsageWindow.md) \| `null` -Defined in: [types/proxy.ts:1855](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1855) - --- ### limits? > `optional` **limits?**: [`AnthropicUsageLimit`](AnthropicUsageLimit.md)[] \| `null` -Defined in: [types/proxy.ts:1856](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1856) - --- ### extra_usage? > `optional` **extra_usage?**: \{ `is_enabled?`: `boolean` \| `null`; \} \| `null` - -Defined in: [types/proxy.ts:1857](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1857) diff --git a/docs/api/type-aliases/AnthropicUsageWindow.md b/docs/api/type-aliases/AnthropicUsageWindow.md index 8f06ccd7d..cd73c82c1 100644 --- a/docs/api/type-aliases/AnthropicUsageWindow.md +++ b/docs/api/type-aliases/AnthropicUsageWindow.md @@ -8,8 +8,6 @@ > **AnthropicUsageWindow** = `object` -Defined in: [types/proxy.ts:1829](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1829) - One utilization window from the OAuth usage endpoint (wire shape, loose). ## Properties @@ -18,8 +16,6 @@ One utilization window from the OAuth usage endpoint (wire shape, loose). > `optional` **utilization?**: `number` \| `null` -Defined in: [types/proxy.ts:1831](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1831) - 0-100 percent (note: NOT the 0-1 fraction used by headers). --- @@ -28,6 +24,4 @@ Defined in: [types/proxy.ts:1831](https://github.com/juspay/neurolink/blob/relea > `optional` **resets_at?**: `string` \| `null` -Defined in: [types/proxy.ts:1833](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1833) - ISO-8601 timestamp. diff --git a/docs/api/type-aliases/AnthropicVertexSettings.md b/docs/api/type-aliases/AnthropicVertexSettings.md index 3fcd1e751..e52f60de9 100644 --- a/docs/api/type-aliases/AnthropicVertexSettings.md +++ b/docs/api/type-aliases/AnthropicVertexSettings.md @@ -8,16 +8,12 @@ > **AnthropicVertexSettings** = `object` -Defined in: [types/providers.ts:1352](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1352) - ## Properties ### projectId > **projectId**: `string` -Defined in: [types/providers.ts:1354](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1354) - Google Cloud project ID --- @@ -26,8 +22,6 @@ Google Cloud project ID > **region**: `string` -Defined in: [types/providers.ts:1356](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1356) - Google Cloud region for Anthropic models (e.g., 'us-east5') --- @@ -36,8 +30,6 @@ Google Cloud region for Anthropic models (e.g., 'us-east5') > `optional` **timeout?**: `number` -Defined in: [types/providers.ts:1358](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1358) - SDK request timeout in milliseconds --- @@ -46,8 +38,6 @@ SDK request timeout in milliseconds > `optional` **maxRetries?**: `number` -Defined in: [types/providers.ts:1360](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1360) - SDK-internal retry budget (transport retries are the orchestrator's job) --- @@ -56,8 +46,6 @@ SDK-internal retry budget (transport retries are the orchestrator's job) > `optional` **baseURL?**: `string` -Defined in: [types/providers.ts:1366](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1366) - Endpoint override. The SDK derives `https://${region}-aiplatform.googleapis.com/v1` by default; a gateway or a compatible endpoint is reached by setting this instead. @@ -68,8 +56,6 @@ a compatible endpoint is reached by setting this instead. > `optional` **authClient?**: [`VertexAnthropicAuthClient`](VertexAnthropicAuthClient.md) -Defined in: [types/providers.ts:1376](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1376) - Supply the request credentials directly, bypassing Application Default Credentials. diff --git a/docs/api/type-aliases/AnyFunction.md b/docs/api/type-aliases/AnyFunction.md index c821ed9f0..55cf9f15f 100644 --- a/docs/api/type-aliases/AnyFunction.md +++ b/docs/api/type-aliases/AnyFunction.md @@ -8,8 +8,6 @@ > **AnyFunction**\<`TParams`, `TResult`\> = [`AsyncFunction`](AsyncFunction.md)\<`TParams`, `TResult`\> \| [`SyncFunction`](SyncFunction.md)\<`TParams`, `TResult`\> -Defined in: [types/common.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L100) - Union of async and sync functions ## Type Parameters diff --git a/docs/api/type-aliases/ApiKeyAuthOptions.md b/docs/api/type-aliases/ApiKeyAuthOptions.md index 0af7ee3cc..84aec876f 100644 --- a/docs/api/type-aliases/ApiKeyAuthOptions.md +++ b/docs/api/type-aliases/ApiKeyAuthOptions.md @@ -8,8 +8,6 @@ > **ApiKeyAuthOptions** = `object` -Defined in: [types/middleware.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L415) - Options for the API-key auth middleware. ## Properties @@ -18,12 +16,8 @@ Options for the API-key auth middleware. > `optional` **headerName?**: `string` -Defined in: [types/middleware.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L416) - --- ### skipPaths? > `optional` **skipPaths?**: `string`[] - -Defined in: [types/middleware.ts:417](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L417) diff --git a/docs/api/type-aliases/ApiResponse.md b/docs/api/type-aliases/ApiResponse.md index 76b55cd1f..e3fd7d7b3 100644 --- a/docs/api/type-aliases/ApiResponse.md +++ b/docs/api/type-aliases/ApiResponse.md @@ -8,8 +8,6 @@ > **ApiResponse**\<`TData`\> = `object` -Defined in: [types/aliases.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L190) - API response structure Standard response format across providers @@ -25,28 +23,20 @@ Standard response format across providers > **success**: `boolean` -Defined in: [types/aliases.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L191) - --- ### data? > `optional` **data?**: `TData` -Defined in: [types/aliases.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L192) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/aliases.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L193) - --- ### metadata? > `optional` **metadata?**: [`StandardRecord`](StandardRecord.md) - -Defined in: [types/aliases.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L194) diff --git a/docs/api/type-aliases/ArchiveDecompressionResult.md b/docs/api/type-aliases/ArchiveDecompressionResult.md index 488ca5f96..d2fcc3d89 100644 --- a/docs/api/type-aliases/ArchiveDecompressionResult.md +++ b/docs/api/type-aliases/ArchiveDecompressionResult.md @@ -8,8 +8,6 @@ > **ArchiveDecompressionResult** = \{ `status`: `"ok"`; `buffer`: `Buffer`; \} \| \{ `status`: `"tool-unavailable"`; \} \| \{ `status`: `"too-large"`; \} \| \{ `status`: `"failed"`; \} -Defined in: [types/processor.ts:901](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L901) - Outcome of decompressing a single-stream archive (.bz2, .xz, .zst). A plain `Buffer | null` collapsed two very different failures into one: a diff --git a/docs/api/type-aliases/ArchiveEntry.md b/docs/api/type-aliases/ArchiveEntry.md index 7ccde8d1d..052fa4743 100644 --- a/docs/api/type-aliases/ArchiveEntry.md +++ b/docs/api/type-aliases/ArchiveEntry.md @@ -8,8 +8,6 @@ > **ArchiveEntry** = `object` -Defined in: [types/processor.ts:942](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L942) - Metadata about an individual entry within an archive. ## Properties @@ -18,28 +16,20 @@ Metadata about an individual entry within an archive. > **name**: `string` -Defined in: [types/processor.ts:943](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L943) - --- ### uncompressedSize > **uncompressedSize**: `number` -Defined in: [types/processor.ts:944](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L944) - --- ### compressedSize > **compressedSize**: `number` -Defined in: [types/processor.ts:945](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L945) - --- ### isDirectory > **isDirectory**: `boolean` - -Defined in: [types/processor.ts:946](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L946) diff --git a/docs/api/type-aliases/ArchiveEntryReadResult.md b/docs/api/type-aliases/ArchiveEntryReadResult.md index b166c9892..a61060a87 100644 --- a/docs/api/type-aliases/ArchiveEntryReadResult.md +++ b/docs/api/type-aliases/ArchiveEntryReadResult.md @@ -7,5 +7,3 @@ # Type Alias: ArchiveEntryReadResult > **ArchiveEntryReadResult** = \{ `status`: `"ok"`; `buffer`: `Buffer`; \} \| \{ `status`: `"too-large"`; \} \| \{ `status`: `"unsupported-method"`; \} \| \{ `status`: `"corrupt"`; \} - -Defined in: [types/processor.ts:933](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L933) diff --git a/docs/api/type-aliases/ArchiveFormat.md b/docs/api/type-aliases/ArchiveFormat.md index e20cb2a36..4b0f03113 100644 --- a/docs/api/type-aliases/ArchiveFormat.md +++ b/docs/api/type-aliases/ArchiveFormat.md @@ -8,6 +8,4 @@ > **ArchiveFormat** = `"zip"` \| `"tar"` \| `"tar.gz"` \| `"tar.bz2"` \| `"gz"` \| `"bz2"` \| `"xz"` \| `"zst"` \| `"rar"` \| `"7z"` -Defined in: [types/processor.ts:880](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L880) - Supported archive format identifiers. diff --git a/docs/api/type-aliases/ArizeExporterConfig.md b/docs/api/type-aliases/ArizeExporterConfig.md index 0683353ba..3bd33f94a 100644 --- a/docs/api/type-aliases/ArizeExporterConfig.md +++ b/docs/api/type-aliases/ArizeExporterConfig.md @@ -8,8 +8,6 @@ > **ArizeExporterConfig** = [`ExporterConfig`](ExporterConfig.md) & `object` -Defined in: [types/exporter.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L140) - Arize exporter configuration ## Type Declaration diff --git a/docs/api/type-aliases/ArtifactMeta.md b/docs/api/type-aliases/ArtifactMeta.md index 792fa0f7f..568f65d03 100644 --- a/docs/api/type-aliases/ArtifactMeta.md +++ b/docs/api/type-aliases/ArtifactMeta.md @@ -8,8 +8,6 @@ > **ArtifactMeta** = `object` -Defined in: [types/artifact.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L18) - Metadata recorded alongside a stored artifact. ## Properties @@ -18,8 +16,6 @@ Metadata recorded alongside a stored artifact. > **toolName**: `string` -Defined in: [types/artifact.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L20) - Tool name that produced the output. --- @@ -28,8 +24,6 @@ Tool name that produced the output. > **serverId**: `string` -Defined in: [types/artifact.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L22) - MCP server ID. --- @@ -38,8 +32,6 @@ MCP server ID. > `optional` **sessionId?**: `string` -Defined in: [types/artifact.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L24) - Session that triggered the tool call (optional). --- @@ -48,8 +40,6 @@ Session that triggered the tool call (optional). > **sizeBytes**: `number` -Defined in: [types/artifact.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L26) - Serialized byte size of the full payload. --- @@ -58,8 +48,6 @@ Serialized byte size of the full payload. > **contentType**: `"json"` \| `"text"` -Defined in: [types/artifact.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L28) - Whether the payload is valid JSON or plain text. --- @@ -68,8 +56,6 @@ Whether the payload is valid JSON or plain text. > **createdAt**: `number` -Defined in: [types/artifact.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L30) - Unix epoch ms when the artifact was created. --- @@ -78,8 +64,6 @@ Unix epoch ms when the artifact was created. > `optional` **label?**: `string` -Defined in: [types/artifact.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L35) - Human label for a host-banked artifact (e.g. "delegate:auth-review"). Absent on artifacts written by the MCP output normalizer. @@ -89,6 +73,4 @@ Absent on artifacts written by the MCP output normalizer. > `optional` **kind?**: [`BankedArtifactKind`](BankedArtifactKind.md) -Defined in: [types/artifact.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L37) - What kind of output was banked. Absent for MCP surrogates. diff --git a/docs/api/type-aliases/ArtifactPageRequest.md b/docs/api/type-aliases/ArtifactPageRequest.md index 1755c94e9..afa1ba8c3 100644 --- a/docs/api/type-aliases/ArtifactPageRequest.md +++ b/docs/api/type-aliases/ArtifactPageRequest.md @@ -8,8 +8,6 @@ > **ArtifactPageRequest** = `object` -Defined in: [types/artifact.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L99) - Character window for a paginated artifact read. ## Properties @@ -18,8 +16,6 @@ Character window for a paginated artifact read. > `optional` **offset?**: `number` -Defined in: [types/artifact.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L101) - Character offset to start at. Default 0. --- @@ -28,6 +24,4 @@ Character offset to start at. Default 0. > `optional` **limit?**: `number` -Defined in: [types/artifact.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L103) - Maximum characters to return. Default: the rest of the payload. diff --git a/docs/api/type-aliases/ArtifactRef.md b/docs/api/type-aliases/ArtifactRef.md index e8dba1d23..86fd970f5 100644 --- a/docs/api/type-aliases/ArtifactRef.md +++ b/docs/api/type-aliases/ArtifactRef.md @@ -8,8 +8,6 @@ > **ArtifactRef** = `object` -Defined in: [types/artifact.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L41) - Lightweight descriptor returned after a successful ArtifactStore.store(). ## Properties @@ -18,8 +16,6 @@ Lightweight descriptor returned after a successful ArtifactStore.store(). > **id**: `string` -Defined in: [types/artifact.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L43) - UUID v4 — stable identifier used in surrogate results and metadata. --- @@ -28,8 +24,6 @@ UUID v4 — stable identifier used in surrogate results and metadata. > **preview**: `string` -Defined in: [types/artifact.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L45) - First N characters of the payload (for surrogate headers). --- @@ -38,8 +32,6 @@ First N characters of the payload (for surrogate headers). > **sizeBytes**: `number` -Defined in: [types/artifact.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L47) - Full serialized byte size. --- @@ -48,6 +40,4 @@ Full serialized byte size. > **meta**: [`ArtifactMeta`](ArtifactMeta.md) -Defined in: [types/artifact.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L49) - Stored metadata. diff --git a/docs/api/type-aliases/ArtifactSearchMatch.md b/docs/api/type-aliases/ArtifactSearchMatch.md index 5b422a04c..0519ee050 100644 --- a/docs/api/type-aliases/ArtifactSearchMatch.md +++ b/docs/api/type-aliases/ArtifactSearchMatch.md @@ -8,8 +8,6 @@ > **ArtifactSearchMatch** = `object` -Defined in: [types/artifact.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L125) - One hit from a literal search over an artifact. ## Properties @@ -18,8 +16,6 @@ One hit from a literal search over an artifact. > **offset**: `number` -Defined in: [types/artifact.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L127) - Character offset of the match — pass it back as `offset` to read there. --- @@ -28,8 +24,6 @@ Character offset of the match — pass it back as `offset` to read there. > **line**: `number` -Defined in: [types/artifact.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L129) - 1-based line number the match sits on. --- @@ -38,8 +32,6 @@ Defined in: [types/artifact.ts:129](https://github.com/juspay/neurolink/blob/rel > **snippetOffset**: `number` -Defined in: [types/artifact.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L131) - Character offset the snippet starts at (≤ `offset`). --- @@ -48,8 +40,6 @@ Character offset the snippet starts at (≤ `offset`). > **snippet**: `string` -Defined in: [types/artifact.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L137) - Bounded context around the match. Bounded on purpose: an MCP artifact is usually one compact JSON line, so "the matching line" would be the whole payload. diff --git a/docs/api/type-aliases/ArtifactSearchResult.md b/docs/api/type-aliases/ArtifactSearchResult.md index 55a9e28eb..9a09a25d0 100644 --- a/docs/api/type-aliases/ArtifactSearchResult.md +++ b/docs/api/type-aliases/ArtifactSearchResult.md @@ -8,8 +8,6 @@ > **ArtifactSearchResult** = `object` -Defined in: [types/artifact.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L141) - Result of a literal search over an artifact. ## Properties @@ -18,8 +16,6 @@ Result of a literal search over an artifact. > **matches**: [`ArtifactSearchMatch`](ArtifactSearchMatch.md)[] -Defined in: [types/artifact.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L143) - Matches returned, in payload order. --- @@ -28,8 +24,6 @@ Matches returned, in payload order. > **matchCount**: `number` -Defined in: [types/artifact.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L145) - `matches.length`. --- @@ -38,8 +32,6 @@ Defined in: [types/artifact.ts:145](https://github.com/juspay/neurolink/blob/rel > **totalMatches**: `number` -Defined in: [types/artifact.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L147) - Every match in the payload, including the ones not returned. --- @@ -48,8 +40,6 @@ Every match in the payload, including the ones not returned. > **truncated**: `boolean` -Defined in: [types/artifact.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L149) - True when `totalMatches > matchCount`. --- @@ -58,6 +48,4 @@ True when `totalMatches > matchCount`. > `optional` **nextSearchOffset?**: `number` -Defined in: [types/artifact.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L151) - Character offset to pass as `offset` to search for the next matches. diff --git a/docs/api/type-aliases/ArtifactStorageConfig.md b/docs/api/type-aliases/ArtifactStorageConfig.md index c7d790c9b..b60a38732 100644 --- a/docs/api/type-aliases/ArtifactStorageConfig.md +++ b/docs/api/type-aliases/ArtifactStorageConfig.md @@ -8,8 +8,6 @@ > **ArtifactStorageConfig** = `object` -Defined in: [types/artifact.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L266) - Artifact storage configuration (`new NeuroLink({ artifacts })`). Resolution order for the backend: `store` → `storage` → `STORAGE_TYPE` @@ -24,8 +22,6 @@ on Redis keeps its artifacts on the same Redis without new settings. > `optional` **storage?**: [`ArtifactStorageType`](ArtifactStorageType.md) -Defined in: [types/artifact.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L268) - Backend to use. Default: `STORAGE_TYPE` env var, else `"local"`. --- @@ -34,8 +30,6 @@ Backend to use. Default: `STORAGE_TYPE` env var, else `"local"`. > `optional` **redisConfig?**: [`RedisStorageConfig`](RedisStorageConfig.md) -Defined in: [types/artifact.ts:276](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L276) - Redis connection for `storage: "redis"`. `keyPrefix` defaults to `neurolink:artifact:` (NOT the conversation prefix). `ttl` is seconds, must be positive, and defaults to 86400; zero or negative is replaced by @@ -48,7 +42,5 @@ the default with a warning — artifacts in Redis always expire. > `optional` **store?**: [`ArtifactStore`](ArtifactStore.md) -Defined in: [types/artifact.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L281) - A ready-made backend. Wins over `storage`. Use this for S3, a database, or a wrapped store; `setArtifactStore()` does the same after construction. diff --git a/docs/api/type-aliases/ArtifactStorageType.md b/docs/api/type-aliases/ArtifactStorageType.md index 0ff812ba3..2c522112a 100644 --- a/docs/api/type-aliases/ArtifactStorageType.md +++ b/docs/api/type-aliases/ArtifactStorageType.md @@ -8,8 +8,6 @@ > **ArtifactStorageType** = `"local"` \| `"redis"` -Defined in: [types/artifact.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L255) - Where artifacts live. Mirrors conversation memory's `STORAGE_TYPE`: - "local" OS temp directory, per-process index with a cross-process diff --git a/docs/api/type-aliases/ArtifactStore.md b/docs/api/type-aliases/ArtifactStore.md index 10ef45ce4..c5a5dcbf1 100644 --- a/docs/api/type-aliases/ArtifactStore.md +++ b/docs/api/type-aliases/ArtifactStore.md @@ -8,8 +8,6 @@ > **ArtifactStore** = `object` -Defined in: [types/artifact.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L172) - Pluggable storage contract for externalized MCP tool outputs and banked payloads. @@ -29,8 +27,6 @@ uses them when present and falls back cleanly when absent. > **store**(`payload`, `meta`): `Promise`\<[`ArtifactRef`](ArtifactRef.md)\> -Defined in: [types/artifact.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L178) - Persist a payload and return a lightweight reference. #### Parameters @@ -57,8 +53,6 @@ Descriptor without `createdAt` (assigned internally). > **retrieve**(`id`): `Promise`\<`string` \| `null`\> -Defined in: [types/artifact.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L187) - Retrieve the full payload by artifact ID. Returns `null` if the artifact is not found or has been cleaned up. @@ -78,8 +72,6 @@ Returns `null` if the artifact is not found or has been cleaned up. > `optional` **retrieveRange**(`id`, `range`): `Promise`\<[`ArtifactWindow`](ArtifactWindow.md) \| `null`\> -Defined in: [types/artifact.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L204) - Retrieve one character window without materialising the whole payload. Optional. When present, `retrieve_context` and `readArtifact` call it for @@ -114,8 +106,6 @@ Returns `null` if the artifact is not found or has expired. > **delete**(`id`): `Promise`\<`void`\> -Defined in: [types/artifact.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L210) - Delete a single artifact. No-op if the ID does not exist. #### Parameters @@ -134,8 +124,6 @@ Delete a single artifact. No-op if the ID does not exist. > **cleanup**(`olderThanMs`): `Promise`\<`number`\> -Defined in: [types/artifact.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L216) - Delete all artifacts older than `olderThanMs` milliseconds. Returns the number of artifacts deleted. @@ -155,8 +143,6 @@ Returns the number of artifacts deleted. > **generatePreview**(`payload`): `string` -Defined in: [types/artifact.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L219) - Generate a short preview string from a serialized payload. #### Parameters @@ -175,8 +161,6 @@ Generate a short preview string from a serialized payload. > `optional` **close**(): `Promise`\<`void`\> -Defined in: [types/artifact.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L227) - Release whatever the store holds open (a pooled connection, a file handle). Optional. NeuroLink calls it — from `shutdown()`, and when `setArtifactStore()` replaces the store — only for stores it built diff --git a/docs/api/type-aliases/ArtifactWindow.md b/docs/api/type-aliases/ArtifactWindow.md index ed117cb01..8239f6dc9 100644 --- a/docs/api/type-aliases/ArtifactWindow.md +++ b/docs/api/type-aliases/ArtifactWindow.md @@ -8,8 +8,6 @@ > **ArtifactWindow** = `object` -Defined in: [types/artifact.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L115) - One window of an artifact, as returned by `ArtifactStore.retrieveRange` or by the shared reader when the store only supports whole-payload reads. @@ -24,8 +22,6 @@ lands exactly where the previous window ended. > **content**: `string` -Defined in: [types/artifact.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L117) - The characters in `[offset, offset + content.length)`. --- @@ -34,8 +30,6 @@ The characters in `[offset, offset + content.length)`. > **offset**: `number` -Defined in: [types/artifact.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L119) - Character offset this window starts at. --- @@ -44,6 +38,4 @@ Character offset this window starts at. > **totalLength**: `number` -Defined in: [types/artifact.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L121) - Total character length of the whole payload. diff --git a/docs/api/type-aliases/AspectRatio.md b/docs/api/type-aliases/AspectRatio.md index cc1d0758e..e955c56d1 100644 --- a/docs/api/type-aliases/AspectRatio.md +++ b/docs/api/type-aliases/AspectRatio.md @@ -8,6 +8,4 @@ > **AspectRatio** = `"1:1"` \| `"16:9"` \| `"9:16"` \| `"4:3"` \| `"3:4"` \| `"3:2"` \| `"2:3"` -Defined in: [types/imageGen.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L20) - Supported aspect ratios diff --git a/docs/api/type-aliases/AspectRatioOption.md b/docs/api/type-aliases/AspectRatioOption.md index 0b94237f1..0cc9ecd99 100644 --- a/docs/api/type-aliases/AspectRatioOption.md +++ b/docs/api/type-aliases/AspectRatioOption.md @@ -7,5 +7,3 @@ # Type Alias: AspectRatioOption > **AspectRatioOption** = `"16:9"` \| `"4:3"` - -Defined in: [types/ppt.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L44) diff --git a/docs/api/type-aliases/AssistantContent.md b/docs/api/type-aliases/AssistantContent.md index 3a2e8a097..eb1b52d39 100644 --- a/docs/api/type-aliases/AssistantContent.md +++ b/docs/api/type-aliases/AssistantContent.md @@ -7,5 +7,3 @@ # Type Alias: AssistantContent > **AssistantContent** = `string` \| ([`TextPart`](TextPart.md) \| [`FilePart`](FilePart.md) \| `ReasoningPart` \| [`ToolCallPart`](ToolCallPart.md) \| [`ToolResultPart`](ToolResultPart.md) \| [`ToolApprovalRequest`](ToolApprovalRequest.md))[] - -Defined in: [types/aiCompat.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L252) diff --git a/docs/api/type-aliases/AssistantModelMessage.md b/docs/api/type-aliases/AssistantModelMessage.md index 6cea8df99..388561e0d 100644 --- a/docs/api/type-aliases/AssistantModelMessage.md +++ b/docs/api/type-aliases/AssistantModelMessage.md @@ -8,28 +8,20 @@ > **AssistantModelMessage** = `object` -Defined in: [types/aiCompat.ts:277](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L277) - ## Properties ### role > **role**: `"assistant"` -Defined in: [types/aiCompat.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L278) - --- ### content > **content**: [`AssistantContent`](AssistantContent.md) -Defined in: [types/aiCompat.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L279) - --- ### providerOptions? > `optional` **providerOptions?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\> - -Defined in: [types/aiCompat.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L280) diff --git a/docs/api/type-aliases/AsyncApiResponse.md b/docs/api/type-aliases/AsyncApiResponse.md index 02971fd4c..89d06df62 100644 --- a/docs/api/type-aliases/AsyncApiResponse.md +++ b/docs/api/type-aliases/AsyncApiResponse.md @@ -8,8 +8,6 @@ > **AsyncApiResponse**\<`TData`\> = `Promise`\<[`ApiResponse`](ApiResponse.md)\<`TData`\>\> -Defined in: [types/aliases.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L200) - Async API response type ## Type Parameters diff --git a/docs/api/type-aliases/AsyncEventHandler.md b/docs/api/type-aliases/AsyncEventHandler.md index c6cdd4d09..62efc56ae 100644 --- a/docs/api/type-aliases/AsyncEventHandler.md +++ b/docs/api/type-aliases/AsyncEventHandler.md @@ -8,8 +8,6 @@ > **AsyncEventHandler**\<`TEvent`\> = (`event`) => `Promise`\<`void`\> -Defined in: [types/aliases.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L127) - Async event handler function type ## Type Parameters diff --git a/docs/api/type-aliases/AsyncFunction.md b/docs/api/type-aliases/AsyncFunction.md index d8afb3010..060777f09 100644 --- a/docs/api/type-aliases/AsyncFunction.md +++ b/docs/api/type-aliases/AsyncFunction.md @@ -8,8 +8,6 @@ > **AsyncFunction**\<`TParams`, `TResult`\> = (`params`) => `Promise`\<`TResult`\> -Defined in: [types/common.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L86) - Generic async function type ## Type Parameters diff --git a/docs/api/type-aliases/AsyncResult.md b/docs/api/type-aliases/AsyncResult.md index a7edce5e1..1d1f2d4fd 100644 --- a/docs/api/type-aliases/AsyncResult.md +++ b/docs/api/type-aliases/AsyncResult.md @@ -8,8 +8,6 @@ > **AsyncResult**\<`TData`, `TError`\> = `Promise`\<[`Result`](Result.md)\<`TData`, `TError`\>\> -Defined in: [types/aliases.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L259) - Async result type ## Type Parameters diff --git a/docs/api/type-aliases/AsyncTransformFunction.md b/docs/api/type-aliases/AsyncTransformFunction.md index 3a1d4ee54..727b7f1b9 100644 --- a/docs/api/type-aliases/AsyncTransformFunction.md +++ b/docs/api/type-aliases/AsyncTransformFunction.md @@ -8,8 +8,6 @@ > **AsyncTransformFunction**\<`TInput`, `TOutput`\> = (`input`) => `Promise`\<`TOutput`\> -Defined in: [types/aliases.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L148) - Async transformation function type ## Type Parameters diff --git a/docs/api/type-aliases/AtomicConsumeResult.md b/docs/api/type-aliases/AtomicConsumeResult.md index f23e897d2..42b9fd472 100644 --- a/docs/api/type-aliases/AtomicConsumeResult.md +++ b/docs/api/type-aliases/AtomicConsumeResult.md @@ -8,8 +8,6 @@ > **AtomicConsumeResult** = `object` -Defined in: [types/auth.ts:1369](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1369) - Result of an atomic consume operation against a token bucket. ## Properties @@ -18,12 +16,8 @@ Result of an atomic consume operation against a token bucket. > **bucket**: [`TokenBucket`](TokenBucket.md) -Defined in: [types/auth.ts:1370](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1370) - --- ### consumed > **consumed**: `boolean` - -Defined in: [types/auth.ts:1371](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1371) diff --git a/docs/api/type-aliases/AudienceOption.md b/docs/api/type-aliases/AudienceOption.md index 59b61fe14..af2a9d3ed 100644 --- a/docs/api/type-aliases/AudienceOption.md +++ b/docs/api/type-aliases/AudienceOption.md @@ -7,5 +7,3 @@ # Type Alias: AudienceOption > **AudienceOption** = `"business"` \| `"students"` \| `"technical"` \| `"general"` - -Defined in: [types/ppt.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L34) diff --git a/docs/api/type-aliases/AudioChunk.md b/docs/api/type-aliases/AudioChunk.md index 584c6a2a7..5cb271183 100644 --- a/docs/api/type-aliases/AudioChunk.md +++ b/docs/api/type-aliases/AudioChunk.md @@ -8,36 +8,26 @@ > **AudioChunk** = `object` -Defined in: [types/stream.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L166) - ## Properties ### data > **data**: `Buffer` -Defined in: [types/stream.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L167) - --- ### sampleRateHz > **sampleRateHz**: `number` -Defined in: [types/stream.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L168) - --- ### channels > **channels**: `number` -Defined in: [types/stream.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L169) - --- ### encoding > **encoding**: [`PCMEncoding`](PCMEncoding.md) - -Defined in: [types/stream.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L170) diff --git a/docs/api/type-aliases/AudioContent.md b/docs/api/type-aliases/AudioContent.md index c9634c8dc..95de2151b 100644 --- a/docs/api/type-aliases/AudioContent.md +++ b/docs/api/type-aliases/AudioContent.md @@ -8,8 +8,6 @@ > **AudioContent** = `object` -Defined in: [types/multimodal.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L126) - Audio content type for multimodal messages NOTE: This is for FILE-BASED audio input (not streaming). @@ -36,32 +34,24 @@ const audioContent: AudioContent = { > **type**: `"audio"` -Defined in: [types/multimodal.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L127) - --- ### data > **data**: `Buffer` \| `string` -Defined in: [types/multimodal.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L128) - --- ### mediaType? > `optional` **mediaType?**: `"audio/mpeg"` \| `"audio/wav"` \| `"audio/ogg"` \| `"audio/webm"` \| `"audio/aac"` \| `"audio/flac"` \| `"audio/mp4"` -Defined in: [types/multimodal.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L129) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/multimodal.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L137) - #### filename? > `optional` **filename?**: `string` diff --git a/docs/api/type-aliases/AudioConversionOptions.md b/docs/api/type-aliases/AudioConversionOptions.md index 7407181a9..386bb0217 100644 --- a/docs/api/type-aliases/AudioConversionOptions.md +++ b/docs/api/type-aliases/AudioConversionOptions.md @@ -8,8 +8,6 @@ > **AudioConversionOptions** = `object` -Defined in: [types/voice.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L108) - Audio conversion options ## Properties @@ -18,8 +16,6 @@ Audio conversion options > **targetFormat**: [`TTSAudioFormat`](TTSAudioFormat.md) -Defined in: [types/voice.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L110) - Target format --- @@ -28,8 +24,6 @@ Target format > `optional` **sampleRate?**: `number` -Defined in: [types/voice.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L112) - Target sample rate --- @@ -38,8 +32,6 @@ Target sample rate > `optional` **bitDepth?**: `number` -Defined in: [types/voice.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L114) - Target bit depth --- @@ -48,8 +40,6 @@ Target bit depth > `optional` **channels?**: `number` -Defined in: [types/voice.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L116) - Number of channels --- @@ -58,6 +48,4 @@ Number of channels > `optional` **normalize?**: `boolean` -Defined in: [types/voice.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L118) - Normalize audio level diff --git a/docs/api/type-aliases/AudioConversionResult.md b/docs/api/type-aliases/AudioConversionResult.md index bfa878576..c0f28d6d3 100644 --- a/docs/api/type-aliases/AudioConversionResult.md +++ b/docs/api/type-aliases/AudioConversionResult.md @@ -8,8 +8,6 @@ > **AudioConversionResult** = `object` -Defined in: [types/file.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L102) - Outcome of an audio-compatibility pass over one file. See `adapters/audioFormatSupport.ts`. As with images, `converted` is false @@ -23,22 +21,16 @@ from the resulting `mimeType`. > `readonly` **buffer**: `Buffer` -Defined in: [types/file.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L103) - --- ### mimeType > `readonly` **mimeType**: `string` -Defined in: [types/file.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L104) - --- ### converted > `readonly` **converted**: `boolean` -Defined in: [types/file.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L106) - True when the bytes were re-encoded; false when they were left alone. diff --git a/docs/api/type-aliases/AudioFormat.md b/docs/api/type-aliases/AudioFormat.md index f6b530edd..dd3c1e5a3 100644 --- a/docs/api/type-aliases/AudioFormat.md +++ b/docs/api/type-aliases/AudioFormat.md @@ -8,8 +8,6 @@ > **AudioFormat** = [`TTSAudioFormat`](TTSAudioFormat.md) -Defined in: [types/tts.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L178) - ## Deprecated Use `TTSAudioFormat` instead. diff --git a/docs/api/type-aliases/AudioFormatDetails.md b/docs/api/type-aliases/AudioFormatDetails.md index 0183ac1e4..09f3efb88 100644 --- a/docs/api/type-aliases/AudioFormatDetails.md +++ b/docs/api/type-aliases/AudioFormatDetails.md @@ -8,8 +8,6 @@ > **AudioFormatDetails** = `object` -Defined in: [types/voice.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L90) - Audio format details ## Properties @@ -18,8 +16,6 @@ Audio format details > **format**: [`TTSAudioFormat`](TTSAudioFormat.md) -Defined in: [types/voice.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L92) - Format name --- @@ -28,8 +24,6 @@ Format name > **mimeType**: `string` -Defined in: [types/voice.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L94) - MIME type --- @@ -38,8 +32,6 @@ MIME type > **extension**: `string` -Defined in: [types/voice.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L96) - File extension --- @@ -48,8 +40,6 @@ File extension > **supportsStreaming**: `boolean` -Defined in: [types/voice.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L98) - Whether format supports streaming --- @@ -58,8 +48,6 @@ Whether format supports streaming > **sampleRates**: `number`[] -Defined in: [types/voice.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L100) - Typical sample rates --- @@ -68,6 +56,4 @@ Typical sample rates > **bitDepths**: `number`[] -Defined in: [types/voice.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L102) - Bit depths diff --git a/docs/api/type-aliases/AudioInputSpec.md b/docs/api/type-aliases/AudioInputSpec.md index 8dda68799..a10c34743 100644 --- a/docs/api/type-aliases/AudioInputSpec.md +++ b/docs/api/type-aliases/AudioInputSpec.md @@ -8,36 +8,26 @@ > **AudioInputSpec** = `object` -Defined in: [types/stream.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L159) - ## Properties ### frames > **frames**: `AsyncIterable`\<`Buffer`\> -Defined in: [types/stream.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L160) - --- ### sampleRateHz? > `optional` **sampleRateHz?**: `number` -Defined in: [types/stream.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L161) - --- ### encoding? > `optional` **encoding?**: [`PCMEncoding`](PCMEncoding.md) -Defined in: [types/stream.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L162) - --- ### channels? > `optional` **channels?**: `1` - -Defined in: [types/stream.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L163) diff --git a/docs/api/type-aliases/AudioMetadata.md b/docs/api/type-aliases/AudioMetadata.md index cdc4363d6..96ee17633 100644 --- a/docs/api/type-aliases/AudioMetadata.md +++ b/docs/api/type-aliases/AudioMetadata.md @@ -8,60 +8,44 @@ > **AudioMetadata** = `object` -Defined in: [types/voice.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L409) - ## Properties ### format > **format**: [`TTSAudioFormat`](TTSAudioFormat.md) -Defined in: [types/voice.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L410) - --- ### duration > **duration**: `number` -Defined in: [types/voice.ts:411](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L411) - --- ### sampleRate > **sampleRate**: `number` -Defined in: [types/voice.ts:412](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L412) - --- ### channels > **channels**: `number` -Defined in: [types/voice.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L413) - --- ### bitDepth > **bitDepth**: `number` -Defined in: [types/voice.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L414) - --- ### samples > **samples**: `number` -Defined in: [types/voice.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L415) - --- ### size > **size**: `number` - -Defined in: [types/voice.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L416) diff --git a/docs/api/type-aliases/AudioProcessorOptions.md b/docs/api/type-aliases/AudioProcessorOptions.md index 8adad6488..d6a97f6a5 100644 --- a/docs/api/type-aliases/AudioProcessorOptions.md +++ b/docs/api/type-aliases/AudioProcessorOptions.md @@ -8,8 +8,6 @@ > **AudioProcessorOptions** = `object` -Defined in: [types/file.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L588) - Audio processor options ## Properties @@ -18,8 +16,6 @@ Audio processor options > `optional` **provider?**: `string` -Defined in: [types/file.ts:590](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L590) - AI provider to use for transcription (e.g., 'openai', 'google', 'azure') --- @@ -28,8 +24,6 @@ AI provider to use for transcription (e.g., 'openai', 'google', 'azure') > `optional` **transcriptionModel?**: `string` -Defined in: [types/file.ts:592](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L592) - Transcription model to use (e.g., 'whisper-1', 'chirp-3') --- @@ -38,8 +32,6 @@ Transcription model to use (e.g., 'whisper-1', 'chirp-3') > `optional` **language?**: `string` -Defined in: [types/file.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L594) - Language code for transcription (e.g., 'en', 'es', 'fr') --- @@ -48,8 +40,6 @@ Language code for transcription (e.g., 'en', 'es', 'fr') > `optional` **prompt?**: `string` -Defined in: [types/file.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L596) - Context or prompt to guide transcription accuracy --- @@ -58,8 +48,6 @@ Context or prompt to guide transcription accuracy > `optional` **maxDurationSeconds?**: `number` -Defined in: [types/file.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L598) - Maximum audio duration in seconds (default: 600) --- @@ -68,6 +56,4 @@ Maximum audio duration in seconds (default: 600) > `optional` **maxSizeMB?**: `number` -Defined in: [types/file.ts:600](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L600) - Maximum file size in megabytes diff --git a/docs/api/type-aliases/AudioProviderConfig.md b/docs/api/type-aliases/AudioProviderConfig.md index 95b4be282..679b79316 100644 --- a/docs/api/type-aliases/AudioProviderConfig.md +++ b/docs/api/type-aliases/AudioProviderConfig.md @@ -8,8 +8,6 @@ > **AudioProviderConfig** = `object` -Defined in: [types/file.ts:568](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L568) - Audio provider configuration for transcription services Describes the capabilities and limitations of each audio transcription provider @@ -45,8 +43,6 @@ const googleConfig: AudioProviderConfig = { > **maxSizeMB**: `number` -Defined in: [types/file.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L570) - Maximum audio file size in megabytes --- @@ -55,8 +51,6 @@ Maximum audio file size in megabytes > **maxDurationSeconds**: `number` -Defined in: [types/file.ts:572](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L572) - Maximum audio duration in seconds --- @@ -65,8 +59,6 @@ Maximum audio duration in seconds > **supportedFormats**: `string`[] -Defined in: [types/file.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L574) - Supported audio formats (e.g., 'mp3', 'wav', 'm4a', 'flac', 'ogg') --- @@ -75,8 +67,6 @@ Supported audio formats (e.g., 'mp3', 'wav', 'm4a', 'flac', 'ogg') > **supportsLanguageDetection**: `boolean` -Defined in: [types/file.ts:576](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L576) - Whether the provider supports automatic language detection --- @@ -85,8 +75,6 @@ Whether the provider supports automatic language detection > **requiresApiKey**: `boolean` -Defined in: [types/file.ts:578](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L578) - Whether the provider requires an API key for authentication --- @@ -95,8 +83,6 @@ Whether the provider requires an API key for authentication > `optional` **costPer60s?**: `number` -Defined in: [types/file.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L580) - Optional: Cost per 60 seconds of audio in USD --- @@ -105,6 +91,4 @@ Optional: Cost per 60 seconds of audio in USD > `optional` **costPer15s?**: `number` -Defined in: [types/file.ts:582](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L582) - Optional: Cost per 15 seconds of audio in USD diff --git a/docs/api/type-aliases/AudioSaveResult.md b/docs/api/type-aliases/AudioSaveResult.md index 53a6b6f0a..af5354b45 100644 --- a/docs/api/type-aliases/AudioSaveResult.md +++ b/docs/api/type-aliases/AudioSaveResult.md @@ -8,8 +8,6 @@ > **AudioSaveResult** = `object` -Defined in: [types/tts.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L146) - Result of saving audio to file ## Properties @@ -18,8 +16,6 @@ Result of saving audio to file > **success**: `boolean` -Defined in: [types/tts.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L148) - Whether the save was successful --- @@ -28,8 +24,6 @@ Whether the save was successful > **path**: `string` -Defined in: [types/tts.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L150) - Full path to the saved file --- @@ -38,8 +32,6 @@ Full path to the saved file > **size**: `number` -Defined in: [types/tts.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L152) - File size in bytes --- @@ -48,6 +40,4 @@ File size in bytes > `optional` **error?**: `string` -Defined in: [types/tts.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L154) - Error message if failed diff --git a/docs/api/type-aliases/AudioStreamChunk.md b/docs/api/type-aliases/AudioStreamChunk.md index d9499e004..c390b490c 100644 --- a/docs/api/type-aliases/AudioStreamChunk.md +++ b/docs/api/type-aliases/AudioStreamChunk.md @@ -8,8 +8,6 @@ > **AudioStreamChunk** = `object` -Defined in: [types/voice.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L124) - Audio stream chunk for streaming operations ## Properties @@ -18,8 +16,6 @@ Audio stream chunk for streaming operations > **data**: `Buffer` -Defined in: [types/voice.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L126) - Audio data --- @@ -28,8 +24,6 @@ Audio data > **index**: `number` -Defined in: [types/voice.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L128) - Chunk index --- @@ -38,8 +32,6 @@ Chunk index > **isFinal**: `boolean` -Defined in: [types/voice.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L130) - Whether this is the final chunk --- @@ -48,8 +40,6 @@ Whether this is the final chunk > **format**: [`TTSAudioFormat`](TTSAudioFormat.md) -Defined in: [types/voice.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L132) - Audio format --- @@ -58,8 +48,6 @@ Audio format > **sampleRate**: `number` -Defined in: [types/voice.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L134) - Sample rate --- @@ -68,8 +56,6 @@ Sample rate > **timestampMs**: `number` -Defined in: [types/voice.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L136) - Timestamp offset in milliseconds --- @@ -78,6 +64,4 @@ Timestamp offset in milliseconds > **durationMs**: `number` -Defined in: [types/voice.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L138) - Duration of this chunk in milliseconds diff --git a/docs/api/type-aliases/Auth0Config.md b/docs/api/type-aliases/Auth0Config.md index b5d8884dc..c38450142 100644 --- a/docs/api/type-aliases/Auth0Config.md +++ b/docs/api/type-aliases/Auth0Config.md @@ -8,8 +8,6 @@ > **Auth0Config** = `object` -Defined in: [types/auth.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L649) - Auth0 provider configuration ## Properties @@ -18,8 +16,6 @@ Auth0 provider configuration > **domain**: `string` -Defined in: [types/auth.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L651) - Auth0 domain (e.g., 'your-tenant.auth0.com') --- @@ -28,8 +24,6 @@ Auth0 domain (e.g., 'your-tenant.auth0.com') > **clientId**: `string` -Defined in: [types/auth.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L653) - Auth0 client ID --- @@ -38,8 +32,6 @@ Auth0 client ID > `optional` **clientSecret?**: `string` -Defined in: [types/auth.ts:655](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L655) - Auth0 client secret (for backend operations) --- @@ -48,8 +40,6 @@ Auth0 client secret (for backend operations) > `optional` **audience?**: `string` -Defined in: [types/auth.ts:657](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L657) - Auth0 audience (API identifier) --- @@ -58,8 +48,6 @@ Auth0 audience (API identifier) > `optional` **scope?**: `string` -Defined in: [types/auth.ts:659](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L659) - Auth0 scope --- @@ -68,8 +56,6 @@ Auth0 scope > `optional` **claimsNamespace?**: `string` -Defined in: [types/auth.ts:661](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L661) - Custom namespace for claims --- @@ -78,8 +64,6 @@ Custom namespace for claims > `optional` **managementApi?**: `object` -Defined in: [types/auth.ts:663](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L663) - Management API configuration #### clientId diff --git a/docs/api/type-aliases/Auth0TokenPayload.md b/docs/api/type-aliases/Auth0TokenPayload.md index b1bf81c1d..76404697b 100644 --- a/docs/api/type-aliases/Auth0TokenPayload.md +++ b/docs/api/type-aliases/Auth0TokenPayload.md @@ -8,8 +8,6 @@ > **Auth0TokenPayload** = `object` -Defined in: [types/auth.ts:1416](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1416) - Auth0 JWT payload structure. ## Properties @@ -18,84 +16,62 @@ Auth0 JWT payload structure. > **sub**: `string` -Defined in: [types/auth.ts:1417](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1417) - --- ### email? > `optional` **email?**: `string` -Defined in: [types/auth.ts:1418](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1418) - --- ### name? > `optional` **name?**: `string` -Defined in: [types/auth.ts:1419](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1419) - --- ### picture? > `optional` **picture?**: `string` -Defined in: [types/auth.ts:1420](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1420) - --- ### email_verified? > `optional` **email_verified?**: `boolean` -Defined in: [types/auth.ts:1421](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1421) - --- ### roles? > `optional` **roles?**: `string`[] -Defined in: [types/auth.ts:1422](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1422) - --- ### permissions? > `optional` **permissions?**: `string`[] -Defined in: [types/auth.ts:1423](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1423) - --- ### iat > **iat**: `number` -Defined in: [types/auth.ts:1424](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1424) - --- ### exp > **exp**: `number` -Defined in: [types/auth.ts:1425](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1425) - --- ### aud > **aud**: `string` \| `string`[] -Defined in: [types/auth.ts:1426](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1426) - --- ### iss > **iss**: `string` - -Defined in: [types/auth.ts:1427](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1427) diff --git a/docs/api/type-aliases/AuthCacheConfig.md b/docs/api/type-aliases/AuthCacheConfig.md index 5930995b9..fe026a828 100644 --- a/docs/api/type-aliases/AuthCacheConfig.md +++ b/docs/api/type-aliases/AuthCacheConfig.md @@ -8,8 +8,6 @@ > **AuthCacheConfig** = `object` -Defined in: [types/auth.ts:442](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L442) - Auth cache configuration ## Properties @@ -18,8 +16,6 @@ Auth cache configuration > `optional` **enabled?**: `boolean` -Defined in: [types/auth.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L444) - Enable caching --- @@ -28,8 +24,6 @@ Enable caching > `optional` **ttl?**: `number` -Defined in: [types/auth.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L446) - Cache TTL in seconds --- @@ -38,8 +32,6 @@ Cache TTL in seconds > `optional` **maxEntries?**: `number` -Defined in: [types/auth.ts:448](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L448) - Maximum cache entries --- @@ -48,6 +40,4 @@ Maximum cache entries > `optional` **prefix?**: `string` -Defined in: [types/auth.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L450) - Cache key prefix diff --git a/docs/api/type-aliases/AuthCommandArgs.md b/docs/api/type-aliases/AuthCommandArgs.md index a964304af..5c7cc3a16 100644 --- a/docs/api/type-aliases/AuthCommandArgs.md +++ b/docs/api/type-aliases/AuthCommandArgs.md @@ -8,8 +8,6 @@ > **AuthCommandArgs** = [`BaseCommandArgs`](BaseCommandArgs.md) & `object` -Defined in: [types/cli.ts:1117](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1117) - Auth command arguments interface ## Type Declaration diff --git a/docs/api/type-aliases/AuthErrorCode.md b/docs/api/type-aliases/AuthErrorCode.md index 3cefa8801..94bf7c7e7 100644 --- a/docs/api/type-aliases/AuthErrorCode.md +++ b/docs/api/type-aliases/AuthErrorCode.md @@ -8,6 +8,4 @@ > **AuthErrorCode** = `"AUTH-001"` \| `"AUTH-002"` \| `"AUTH-003"` \| `"AUTH-004"` \| `"AUTH-005"` \| `"AUTH-006"` \| `"AUTH-007"` \| `"AUTH-008"` \| `"AUTH-009"` \| `"AUTH-010"` \| `"AUTH-011"` \| `"AUTH-012"` \| `"AUTH-013"` \| `"AUTH-014"` \| `"AUTH-015"` \| `"AUTH-016"` \| `"AUTH-017"` \| `"AUTH-018"` \| `"AUTH-019"` \| `"AUTH-020"` -Defined in: [types/auth.ts:878](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L878) - Auth error codes diff --git a/docs/api/type-aliases/AuthErrorInfo.md b/docs/api/type-aliases/AuthErrorInfo.md index 95ff797e0..8aa6822e4 100644 --- a/docs/api/type-aliases/AuthErrorInfo.md +++ b/docs/api/type-aliases/AuthErrorInfo.md @@ -8,8 +8,6 @@ > **AuthErrorInfo** = `Error` & `object` -Defined in: [types/auth.ts:906](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L906) - Auth error information with additional context. Renamed from `AuthError` to `AuthErrorInfo` to avoid collision with the diff --git a/docs/api/type-aliases/AuthEventData.md b/docs/api/type-aliases/AuthEventData.md index f4f39bd5c..065a8e084 100644 --- a/docs/api/type-aliases/AuthEventData.md +++ b/docs/api/type-aliases/AuthEventData.md @@ -8,8 +8,6 @@ > **AuthEventData** = `object` -Defined in: [types/auth.ts:955](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L955) - Auth event data ## Properties @@ -18,52 +16,38 @@ Auth event data > **type**: [`AuthEventType`](AuthEventType.md) -Defined in: [types/auth.ts:956](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L956) - --- ### timestamp > **timestamp**: `Date` -Defined in: [types/auth.ts:957](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L957) - --- ### provider? > `optional` **provider?**: [`AuthProviderType`](AuthProviderType.md) -Defined in: [types/auth.ts:958](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L958) - --- ### user? > `optional` **user?**: [`AuthUser`](AuthUser.md) -Defined in: [types/auth.ts:959](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L959) - --- ### session? > `optional` **session?**: [`AuthSession`](AuthSession.md) -Defined in: [types/auth.ts:960](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L960) - --- ### error? > `optional` **error?**: [`AuthErrorInfo`](AuthErrorInfo.md) -Defined in: [types/auth.ts:961](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L961) - --- ### context? > `optional` **context?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> - -Defined in: [types/auth.ts:962](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L962) diff --git a/docs/api/type-aliases/AuthEventHandler.md b/docs/api/type-aliases/AuthEventHandler.md index f69c38821..5cf069136 100644 --- a/docs/api/type-aliases/AuthEventHandler.md +++ b/docs/api/type-aliases/AuthEventHandler.md @@ -8,8 +8,6 @@ > **AuthEventHandler** = (`event`) => `void` \| `Promise`\<`void`\> -Defined in: [types/auth.ts:968](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L968) - Auth event handler ## Parameters diff --git a/docs/api/type-aliases/AuthEventType.md b/docs/api/type-aliases/AuthEventType.md index 1d311b001..648c86e8b 100644 --- a/docs/api/type-aliases/AuthEventType.md +++ b/docs/api/type-aliases/AuthEventType.md @@ -8,6 +8,4 @@ > **AuthEventType** = `"token:validated"` \| `"token:expired"` \| `"token:invalid"` \| `"session:created"` \| `"session:refreshed"` \| `"session:expired"` \| `"session:revoked"` \| `"auth:success"` \| `"auth:failed"` \| `"rbac:allowed"` \| `"rbac:denied"` -Defined in: [types/auth.ts:939](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L939) - Auth event types for hooks diff --git a/docs/api/type-aliases/AuthEvents.md b/docs/api/type-aliases/AuthEvents.md index 8035fa3a2..26fe64734 100644 --- a/docs/api/type-aliases/AuthEvents.md +++ b/docs/api/type-aliases/AuthEvents.md @@ -8,8 +8,6 @@ > **AuthEvents** = `object` -Defined in: [types/auth.ts:928](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L928) - Auth events for EventEmitter ## Properties @@ -18,8 +16,6 @@ Auth events for EventEmitter > **auth:login**: (`user`) => `void` -Defined in: [types/auth.ts:929](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L929) - #### Parameters ##### user @@ -36,8 +32,6 @@ Defined in: [types/auth.ts:929](https://github.com/juspay/neurolink/blob/release > **auth:logout**: (`userId`) => `void` -Defined in: [types/auth.ts:930](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L930) - #### Parameters ##### userId @@ -54,8 +48,6 @@ Defined in: [types/auth.ts:930](https://github.com/juspay/neurolink/blob/release > **auth:tokenRefresh**: (`session`) => `void` -Defined in: [types/auth.ts:931](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L931) - #### Parameters ##### session @@ -72,8 +64,6 @@ Defined in: [types/auth.ts:931](https://github.com/juspay/neurolink/blob/release > **auth:unauthorized**: (`context`, `reason`) => `void` -Defined in: [types/auth.ts:932](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L932) - #### Parameters ##### context @@ -94,8 +84,6 @@ Defined in: [types/auth.ts:932](https://github.com/juspay/neurolink/blob/release > **auth:error**: (`error`, `context?`) => `void` -Defined in: [types/auth.ts:933](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L933) - #### Parameters ##### error diff --git a/docs/api/type-aliases/AuthHealthArgs.md b/docs/api/type-aliases/AuthHealthArgs.md index 0f6c3caa6..509570600 100644 --- a/docs/api/type-aliases/AuthHealthArgs.md +++ b/docs/api/type-aliases/AuthHealthArgs.md @@ -8,76 +8,56 @@ > **AuthHealthArgs** = `object` -Defined in: [types/cli.ts:1480](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1480) - ## Properties ### provider > **provider**: [`AuthProviderType`](AuthProviderType.md) -Defined in: [types/cli.ts:1481](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1481) - --- ### domain? > `optional` **domain?**: `string` -Defined in: [types/cli.ts:1482](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1482) - --- ### clientId? > `optional` **clientId?**: `string` -Defined in: [types/cli.ts:1483](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1483) - --- ### secretKey? > `optional` **secretKey?**: `string` -Defined in: [types/cli.ts:1484](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1484) - --- ### secret? > `optional` **secret?**: `string` -Defined in: [types/cli.ts:1485](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1485) - --- ### url? > `optional` **url?**: `string` -Defined in: [types/cli.ts:1486](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1486) - --- ### anonKey? > `optional` **anonKey?**: `string` -Defined in: [types/cli.ts:1487](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1487) - --- ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/cli.ts:1488](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1488) - --- ### format? > `optional` **format?**: `"text"` \| `"json"` - -Defined in: [types/cli.ts:1489](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1489) diff --git a/docs/api/type-aliases/AuthHealthCheck.md b/docs/api/type-aliases/AuthHealthCheck.md index 23ad76f9a..1e284e88b 100644 --- a/docs/api/type-aliases/AuthHealthCheck.md +++ b/docs/api/type-aliases/AuthHealthCheck.md @@ -8,8 +8,6 @@ > **AuthHealthCheck** = `object` -Defined in: [types/auth.ts:988](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L988) - Auth health check result ## Properties @@ -18,8 +16,6 @@ Auth health check result > **healthy**: `boolean` -Defined in: [types/auth.ts:990](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L990) - Overall health status --- @@ -28,8 +24,6 @@ Overall health status > **providerConnected**: `boolean` -Defined in: [types/auth.ts:992](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L992) - Provider connection status --- @@ -38,8 +32,6 @@ Provider connection status > **sessionStorageHealthy**: `boolean` -Defined in: [types/auth.ts:994](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L994) - Session storage status --- @@ -48,8 +40,6 @@ Session storage status > `optional` **lastSuccessfulAuth?**: `Date` -Defined in: [types/auth.ts:996](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L996) - Last successful authentication --- @@ -58,6 +48,4 @@ Last successful authentication > `optional` **error?**: `string` -Defined in: [types/auth.ts:998](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L998) - Error details if unhealthy diff --git a/docs/api/type-aliases/AuthJWKSCacheEntry.md b/docs/api/type-aliases/AuthJWKSCacheEntry.md index e57f9f3b2..6a0df2bfb 100644 --- a/docs/api/type-aliases/AuthJWKSCacheEntry.md +++ b/docs/api/type-aliases/AuthJWKSCacheEntry.md @@ -8,8 +8,6 @@ > **AuthJWKSCacheEntry** = `object` -Defined in: [types/auth.ts:1255](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1255) - Cached JWKS entry with TTL. Used by Cognito and Keycloak providers. ## Properties @@ -18,12 +16,8 @@ Cached JWKS entry with TTL. Used by Cognito and Keycloak providers. > **jwks**: [`JWKS`](JWKS.md) -Defined in: [types/auth.ts:1256](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1256) - --- ### expiresAt > **expiresAt**: `number` - -Defined in: [types/auth.ts:1257](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1257) diff --git a/docs/api/type-aliases/AuthLifecycle.md b/docs/api/type-aliases/AuthLifecycle.md index 0c9fc4d01..22134162e 100644 --- a/docs/api/type-aliases/AuthLifecycle.md +++ b/docs/api/type-aliases/AuthLifecycle.md @@ -8,8 +8,6 @@ > **AuthLifecycle** = `object` -Defined in: [types/auth.ts:1175](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1175) - Provider lifecycle hooks. ## Methods @@ -18,8 +16,6 @@ Provider lifecycle hooks. > `optional` **healthCheck**(): `Promise`\<[`AuthHealthCheck`](AuthHealthCheck.md)\> -Defined in: [types/auth.ts:1177](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1177) - Check provider health #### Returns @@ -32,8 +28,6 @@ Check provider health > `optional` **initialize**(): `Promise`\<`void`\> -Defined in: [types/auth.ts:1180](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1180) - Initialize the provider #### Returns @@ -46,8 +40,6 @@ Initialize the provider > `optional` **cleanup**(): `Promise`\<`void`\> -Defined in: [types/auth.ts:1183](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1183) - Cleanup provider resources #### Returns @@ -60,8 +52,6 @@ Cleanup provider resources > `optional` **dispose**(): `Promise`\<`void`\> -Defined in: [types/auth.ts:1186](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1186) - Clean up resources (alias for cleanup) #### Returns diff --git a/docs/api/type-aliases/AuthListDirectQuotaRefreshResult.md b/docs/api/type-aliases/AuthListDirectQuotaRefreshResult.md index a86ba73f9..2ed84561b 100644 --- a/docs/api/type-aliases/AuthListDirectQuotaRefreshResult.md +++ b/docs/api/type-aliases/AuthListDirectQuotaRefreshResult.md @@ -8,6 +8,4 @@ > **AuthListDirectQuotaRefreshResult** = \{ `status`: `"refreshed"`; `quota`: [`AccountQuota`](AccountQuota.md); \} \| \{ `status`: `"unavailable"` \| `"not_supported"`; `error?`: `string`; \} -Defined in: [types/cli.ts:1161](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1161) - One direct quota-adapter result used by `auth list --refresh`. diff --git a/docs/api/type-aliases/AuthListQuotaRefreshAdapter.md b/docs/api/type-aliases/AuthListQuotaRefreshAdapter.md index dae3deb2f..423ea334e 100644 --- a/docs/api/type-aliases/AuthListQuotaRefreshAdapter.md +++ b/docs/api/type-aliases/AuthListQuotaRefreshAdapter.md @@ -8,8 +8,6 @@ > **AuthListQuotaRefreshAdapter** = `object` -Defined in: [types/cli.ts:1166](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1166) - Provider-specific quota capability used by the generic auth-list refresh. ## Properties @@ -18,8 +16,6 @@ Provider-specific quota capability used by the generic auth-list refresh. > `optional` **supportsProxyRefresh?**: `boolean` -Defined in: [types/cli.ts:1168](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1168) - A successful local proxy `/limits` response is authoritative for this provider. --- @@ -28,8 +24,6 @@ A successful local proxy `/limits` response is authoritative for this provider. > **listAccounts**: () => `Promise`\<[`ProxyPassthroughAccount`](ProxyPassthroughAccount.md)[]\> -Defined in: [types/cli.ts:1169](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1169) - #### Returns `Promise`\<[`ProxyPassthroughAccount`](ProxyPassthroughAccount.md)[]\> @@ -40,8 +34,6 @@ Defined in: [types/cli.ts:1169](https://github.com/juspay/neurolink/blob/release > **priorQuotaKeys**: (`account`) => readonly `string`[] -Defined in: [types/cli.ts:1170](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1170) - #### Parameters ##### account @@ -58,8 +50,6 @@ readonly `string`[] > **refreshAccount**: (`account`, `options`) => `Promise`\<[`AuthListDirectQuotaRefreshResult`](AuthListDirectQuotaRefreshResult.md)\> -Defined in: [types/cli.ts:1171](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1171) - #### Parameters ##### account diff --git a/docs/api/type-aliases/AuthListRefreshAccountResult.md b/docs/api/type-aliases/AuthListRefreshAccountResult.md index 92fcfc07b..cfdf4263c 100644 --- a/docs/api/type-aliases/AuthListRefreshAccountResult.md +++ b/docs/api/type-aliases/AuthListRefreshAccountResult.md @@ -8,8 +8,6 @@ > **AuthListRefreshAccountResult** = `object` -Defined in: [types/cli.ts:1152](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1152) - Fresh-limit result for one provider-qualified account. ## Properties @@ -18,8 +16,6 @@ Fresh-limit result for one provider-qualified account. > **provider**: `string` -Defined in: [types/cli.ts:1154](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1154) - Provider prefix parsed from the configured account key. --- @@ -28,8 +24,6 @@ Provider prefix parsed from the configured account key. > **status**: [`AuthListRefreshStatus`](AuthListRefreshStatus.md) -Defined in: [types/cli.ts:1156](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1156) - A missing limit is explicit rather than being rendered as an unexplained dash. --- @@ -37,5 +31,3 @@ A missing limit is explicit rather than being rendered as an unexplained dash. ### error? > `optional` **error?**: `string` - -Defined in: [types/cli.ts:1157](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1157) diff --git a/docs/api/type-aliases/AuthListRefreshOutcome.md b/docs/api/type-aliases/AuthListRefreshOutcome.md index f0ef6b35d..ef642b545 100644 --- a/docs/api/type-aliases/AuthListRefreshOutcome.md +++ b/docs/api/type-aliases/AuthListRefreshOutcome.md @@ -8,8 +8,6 @@ > **AuthListRefreshOutcome** = `object` -Defined in: [types/cli.ts:1185](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1185) - Outcome of the `auth list --refresh` fresh-limit fetch. ## Properties @@ -18,8 +16,6 @@ Outcome of the `auth list --refresh` fresh-limit fetch. > **via**: `"proxy"` \| `"direct"` \| `"mixed"` \| `"none"` -Defined in: [types/cli.ts:1187](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1187) - How the fresh limits were obtained ("none" when every path failed). --- @@ -28,8 +24,6 @@ How the fresh limits were obtained ("none" when every path failed). > **quotas**: `Record`\<`string`, [`AccountQuota`](AccountQuota.md)\> \| `null` -Defined in: [types/cli.ts:1189](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1189) - Freshly fetched quotas keyed by provider-qualified account key. --- @@ -38,8 +32,6 @@ Freshly fetched quotas keyed by provider-qualified account key. > **accounts**: `Record`\<`string`, [`AuthListRefreshAccountResult`](AuthListRefreshAccountResult.md)\> -Defined in: [types/cli.ts:1191](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1191) - Per-account refresh status, also keyed by provider-qualified account key. --- @@ -48,6 +40,4 @@ Per-account refresh status, also keyed by provider-qualified account key. > **errors**: `string`[] -Defined in: [types/cli.ts:1193](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1193) - Per-account and transport errors, already formatted for display. diff --git a/docs/api/type-aliases/AuthListRefreshResultSetter.md b/docs/api/type-aliases/AuthListRefreshResultSetter.md index 91e4f4d3f..44cd0870b 100644 --- a/docs/api/type-aliases/AuthListRefreshResultSetter.md +++ b/docs/api/type-aliases/AuthListRefreshResultSetter.md @@ -8,8 +8,6 @@ > **AuthListRefreshResultSetter** = (`key`, `status`, `error?`) => `void` -Defined in: [types/cli.ts:1178](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1178) - Applies one account's explicit auth-list refresh state. ## Parameters diff --git a/docs/api/type-aliases/AuthListRefreshStatus.md b/docs/api/type-aliases/AuthListRefreshStatus.md index 172c3208f..8fba3bbf4 100644 --- a/docs/api/type-aliases/AuthListRefreshStatus.md +++ b/docs/api/type-aliases/AuthListRefreshStatus.md @@ -8,6 +8,4 @@ > **AuthListRefreshStatus** = `"refreshed"` \| `"snapshot"` \| `"unavailable"` \| `"not_supported"` -Defined in: [types/cli.ts:1145](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1145) - Refresh state for a provider-qualified account. diff --git a/docs/api/type-aliases/AuthMiddlewareConfig.md b/docs/api/type-aliases/AuthMiddlewareConfig.md index fb1c46188..31811344e 100644 --- a/docs/api/type-aliases/AuthMiddlewareConfig.md +++ b/docs/api/type-aliases/AuthMiddlewareConfig.md @@ -8,8 +8,6 @@ > **AuthMiddlewareConfig** = `object` -Defined in: [types/auth.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L594) - Auth middleware configuration ## Properties @@ -18,8 +16,6 @@ Auth middleware configuration > **provider**: [`AuthProviderType`](AuthProviderType.md) -Defined in: [types/auth.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L596) - Auth provider to use --- @@ -28,8 +24,6 @@ Auth provider to use > **providerConfig**: [`AuthProviderConfig`](AuthProviderConfig.md) -Defined in: [types/auth.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L598) - Provider configuration --- @@ -38,8 +32,6 @@ Provider configuration > `optional` **tokenExtraction?**: [`TokenExtractionConfig`](TokenExtractionConfig.md) -Defined in: [types/auth.ts:600](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L600) - Token extraction configuration --- @@ -48,8 +40,6 @@ Token extraction configuration > `optional` **publicRoutes?**: `string`[] -Defined in: [types/auth.ts:602](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L602) - Routes that don't require authentication --- @@ -58,8 +48,6 @@ Routes that don't require authentication > `optional` **optional?**: `boolean` -Defined in: [types/auth.ts:604](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L604) - Whether authentication is optional (request proceeds with or without auth) --- @@ -68,8 +56,6 @@ Whether authentication is optional (request proceeds with or without auth) > `optional` **onError?**: (`error`, `context`) => `void` \| `Promise`\<`void`\> -Defined in: [types/auth.ts:606](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L606) - Custom error handler #### Parameters @@ -92,8 +78,6 @@ Custom error handler > `optional` **onAuthenticated?**: (`context`) => `void` \| `Promise`\<`void`\> -Defined in: [types/auth.ts:611](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L611) - Hook called after successful authentication #### Parameters diff --git a/docs/api/type-aliases/AuthMiddlewareHandler.md b/docs/api/type-aliases/AuthMiddlewareHandler.md index 8c3b3ceac..1b28a5797 100644 --- a/docs/api/type-aliases/AuthMiddlewareHandler.md +++ b/docs/api/type-aliases/AuthMiddlewareHandler.md @@ -8,8 +8,6 @@ > **AuthMiddlewareHandler**\<`TContext`\> = (`context`) => `Promise`\<[`AuthMiddlewareResult`](AuthMiddlewareResult.md)\> -Defined in: [types/auth.ts:1313](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1313) - Middleware handler function type for the auth layer. ## Type Parameters diff --git a/docs/api/type-aliases/AuthMiddlewareOptions.md b/docs/api/type-aliases/AuthMiddlewareOptions.md index 14d70134e..23080b4b6 100644 --- a/docs/api/type-aliases/AuthMiddlewareOptions.md +++ b/docs/api/type-aliases/AuthMiddlewareOptions.md @@ -8,8 +8,6 @@ > **AuthMiddlewareOptions** = `object` -Defined in: [types/auth.ts:573](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L573) - Auth middleware options ## Properties @@ -18,8 +16,6 @@ Auth middleware options > **provider**: [`AuthProvider`](AuthProvider.md) -Defined in: [types/auth.ts:575](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L575) - Auth provider instance --- @@ -28,8 +24,6 @@ Auth provider instance > `optional` **excludePaths?**: `string`[] -Defined in: [types/auth.ts:577](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L577) - Routes to exclude from authentication --- @@ -38,8 +32,6 @@ Routes to exclude from authentication > `optional` **optional?**: `boolean` -Defined in: [types/auth.ts:579](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L579) - Whether auth is optional (continue if no token) --- @@ -48,8 +40,6 @@ Whether auth is optional (continue if no token) > `optional` **onUnauthorized?**: (`context`) => `Response` \| `Promise`\<`Response`\> -Defined in: [types/auth.ts:581](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L581) - Custom unauthorized handler #### Parameters @@ -68,8 +58,6 @@ Custom unauthorized handler > `optional` **onError?**: (`error`, `context`) => `Response` \| `Promise`\<`Response`\> -Defined in: [types/auth.ts:585](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L585) - Custom error handler #### Parameters diff --git a/docs/api/type-aliases/AuthMiddlewareResult.md b/docs/api/type-aliases/AuthMiddlewareResult.md index 2fa5f2d60..9d0cf8fb7 100644 --- a/docs/api/type-aliases/AuthMiddlewareResult.md +++ b/docs/api/type-aliases/AuthMiddlewareResult.md @@ -8,8 +8,6 @@ > **AuthMiddlewareResult** = `object` -Defined in: [types/auth.ts:1318](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1318) - Result produced by an auth middleware handler. ## Properties @@ -18,24 +16,18 @@ Result produced by an auth middleware handler. > **proceed**: `boolean` -Defined in: [types/auth.ts:1319](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1319) - --- ### context? > `optional` **context?**: [`AuthenticatedContext`](AuthenticatedContext.md) -Defined in: [types/auth.ts:1320](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1320) - --- ### error? > `optional` **error?**: `object` -Defined in: [types/auth.ts:1321](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1321) - #### statusCode > **statusCode**: `number` diff --git a/docs/api/type-aliases/AuthProvider.md b/docs/api/type-aliases/AuthProvider.md index a26d72a5f..cc4607595 100644 --- a/docs/api/type-aliases/AuthProvider.md +++ b/docs/api/type-aliases/AuthProvider.md @@ -8,8 +8,6 @@ > **AuthProvider** = [`AuthTokenValidator`](AuthTokenValidator.md) & [`AuthUserAuthorizer`](AuthUserAuthorizer.md) & [`AuthSessionManager`](AuthSessionManager.md) & [`AuthRequestHandler`](AuthRequestHandler.md) & [`AuthUserManager`](AuthUserManager.md) & [`AuthLifecycle`](AuthLifecycle.md) & `object` -Defined in: [types/auth.ts:1207](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1207) - Base interface for all authentication providers. Composed from focused sub-types so consumers can depend on only the diff --git a/docs/api/type-aliases/AuthProviderConfig.md b/docs/api/type-aliases/AuthProviderConfig.md index 5b9995085..6cfa0fc3a 100644 --- a/docs/api/type-aliases/AuthProviderConfig.md +++ b/docs/api/type-aliases/AuthProviderConfig.md @@ -8,8 +8,6 @@ > **AuthProviderConfig** = [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`Auth0Config`](Auth0Config.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`ClerkConfig`](ClerkConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`FirebaseConfig`](FirebaseConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`SupabaseConfig`](SupabaseConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`CognitoConfig`](CognitoConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`KeycloakConfig`](KeycloakConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`OAuth2Config`](OAuth2Config.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`JWTConfig`](JWTConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`BetterAuthConfig`](BetterAuthConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`WorkOSConfig`](WorkOSConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) & [`CustomAuthConfig`](CustomAuthConfig.md) & `object` \| [`BaseAuthProviderConfig`](BaseAuthProviderConfig.md) -Defined in: [types/auth.ts:857](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L857) - Configuration for AuthProvider. Discriminated union of base + each provider-specific config so that diff --git a/docs/api/type-aliases/AuthProviderConstructor.md b/docs/api/type-aliases/AuthProviderConstructor.md index a9290b93a..4f1b5d44c 100644 --- a/docs/api/type-aliases/AuthProviderConstructor.md +++ b/docs/api/type-aliases/AuthProviderConstructor.md @@ -8,8 +8,6 @@ > **AuthProviderConstructor** = (`config`) => `Promise`\<[`AuthProvider`](AuthProvider.md)\> -Defined in: [types/auth.ts:1265](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1265) - Async constructor for an auth provider given its config. ## Parameters diff --git a/docs/api/type-aliases/AuthProviderFactoryFn.md b/docs/api/type-aliases/AuthProviderFactoryFn.md index ecda143e2..9fc7a8201 100644 --- a/docs/api/type-aliases/AuthProviderFactoryFn.md +++ b/docs/api/type-aliases/AuthProviderFactoryFn.md @@ -8,8 +8,6 @@ > **AuthProviderFactoryFn** = (`config`) => `Promise`\<[`AuthProvider`](AuthProvider.md)\> -Defined in: [types/auth.ts:977](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L977) - Auth provider factory function type ## Parameters diff --git a/docs/api/type-aliases/AuthProviderHealthCheck.md b/docs/api/type-aliases/AuthProviderHealthCheck.md index 30a27bdfd..ff5e7df93 100644 --- a/docs/api/type-aliases/AuthProviderHealthCheck.md +++ b/docs/api/type-aliases/AuthProviderHealthCheck.md @@ -8,8 +8,6 @@ > **AuthProviderHealthCheck** = `object` -Defined in: [types/auth.ts:1004](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1004) - Health check result for auth providers (detailed) ## Properties @@ -18,8 +16,6 @@ Health check result for auth providers (detailed) > **healthy**: `boolean` -Defined in: [types/auth.ts:1006](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1006) - Provider is healthy --- @@ -28,8 +24,6 @@ Provider is healthy > **provider**: [`AuthProviderType`](AuthProviderType.md) -Defined in: [types/auth.ts:1008](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1008) - Provider type --- @@ -38,8 +32,6 @@ Provider type > `optional` **latency?**: `number` -Defined in: [types/auth.ts:1010](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1010) - Response time in ms --- @@ -48,8 +40,6 @@ Response time in ms > `optional` **lastCheck?**: `Date` -Defined in: [types/auth.ts:1012](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1012) - Last successful check --- @@ -58,8 +48,6 @@ Last successful check > `optional` **error?**: `string` -Defined in: [types/auth.ts:1014](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1014) - Error message if unhealthy --- @@ -68,6 +56,4 @@ Error message if unhealthy > `optional` **details?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/auth.ts:1016](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1016) - Additional details diff --git a/docs/api/type-aliases/AuthProviderHealthStatus.md b/docs/api/type-aliases/AuthProviderHealthStatus.md index 1b5df95c5..8351114f0 100644 --- a/docs/api/type-aliases/AuthProviderHealthStatus.md +++ b/docs/api/type-aliases/AuthProviderHealthStatus.md @@ -8,8 +8,6 @@ > **AuthProviderHealthStatus** = `object` -Defined in: [types/auth.ts:1056](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1056) - Auth-domain provider health status returned by AuthProviderRegistry. Not to be confused with the AI-provider `ProviderHealthStatus` union in @@ -21,36 +19,26 @@ Not to be confused with the AI-provider `ProviderHealthStatus` union in > **type**: [`AuthProviderType`](AuthProviderType.md) -Defined in: [types/auth.ts:1057](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1057) - --- ### healthy > **healthy**: `boolean` -Defined in: [types/auth.ts:1058](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1058) - --- ### lastCheck > **lastCheck**: `Date` -Defined in: [types/auth.ts:1059](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1059) - --- ### latency? > `optional` **latency?**: `number` -Defined in: [types/auth.ts:1060](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1060) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/auth.ts:1061](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1061) diff --git a/docs/api/type-aliases/AuthProviderMetadata.md b/docs/api/type-aliases/AuthProviderMetadata.md index c913fb146..ec8215597 100644 --- a/docs/api/type-aliases/AuthProviderMetadata.md +++ b/docs/api/type-aliases/AuthProviderMetadata.md @@ -8,8 +8,6 @@ > **AuthProviderMetadata** = `object` -Defined in: [types/auth.ts:1029](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1029) - Provider registration metadata used by AuthProviderRegistry. Previously defined in `AuthProviderRegistry.ts`; centralised here so all @@ -21,8 +19,6 @@ auth-domain types live in a single canonical file. > **type**: [`AuthProviderType`](AuthProviderType.md) -Defined in: [types/auth.ts:1031](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1031) - Provider type --- @@ -31,8 +27,6 @@ Provider type > **name**: `string` -Defined in: [types/auth.ts:1033](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1033) - Human-readable name --- @@ -41,8 +35,6 @@ Human-readable name > **description**: `string` -Defined in: [types/auth.ts:1035](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1035) - Description --- @@ -51,8 +43,6 @@ Description > `optional` **version?**: `string` -Defined in: [types/auth.ts:1037](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1037) - Version --- @@ -61,8 +51,6 @@ Version > `optional` **documentation?**: `string` -Defined in: [types/auth.ts:1039](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1039) - Documentation URL --- @@ -71,8 +59,6 @@ Documentation URL > **aliases**: `string`[] -Defined in: [types/auth.ts:1041](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1041) - Provider aliases --- @@ -81,8 +67,6 @@ Provider aliases > `optional` **features?**: `string`[] -Defined in: [types/auth.ts:1043](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1043) - Features supported by the provider --- @@ -91,8 +75,6 @@ Features supported by the provider > `optional` **requiresExternalDependencies?**: `boolean` -Defined in: [types/auth.ts:1045](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1045) - Whether provider requires external dependencies --- @@ -101,6 +83,4 @@ Whether provider requires external dependencies > `optional` **builtIn?**: `boolean` -Defined in: [types/auth.ts:1047](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1047) - Whether the provider ships built-in (no extra install) diff --git a/docs/api/type-aliases/AuthProviderRegistration.md b/docs/api/type-aliases/AuthProviderRegistration.md index 0341d8749..e5bdb26c3 100644 --- a/docs/api/type-aliases/AuthProviderRegistration.md +++ b/docs/api/type-aliases/AuthProviderRegistration.md @@ -8,8 +8,6 @@ > **AuthProviderRegistration** = `object` -Defined in: [types/auth.ts:1270](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1270) - Registration row for an auth provider in AuthProviderFactory. ## Properties @@ -18,20 +16,14 @@ Registration row for an auth provider in AuthProviderFactory. > **factory**: [`AuthProviderConstructor`](AuthProviderConstructor.md) -Defined in: [types/auth.ts:1271](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1271) - --- ### aliases > **aliases**: `string`[] -Defined in: [types/auth.ts:1272](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1272) - --- ### metadata? > `optional` **metadata?**: [`AuthProviderMetadata`](AuthProviderMetadata.md) - -Defined in: [types/auth.ts:1273](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1273) diff --git a/docs/api/type-aliases/AuthProviderType.md b/docs/api/type-aliases/AuthProviderType.md index 7546799b8..299dc1b3b 100644 --- a/docs/api/type-aliases/AuthProviderType.md +++ b/docs/api/type-aliases/AuthProviderType.md @@ -8,6 +8,4 @@ > **AuthProviderType** = `"auth0"` \| `"clerk"` \| `"firebase"` \| `"supabase"` \| `"cognito"` \| `"keycloak"` \| `"workos"` \| `"better-auth"` \| `"oauth2"` \| `"jwt"` \| `"custom"` -Defined in: [types/auth.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L98) - Supported authentication provider types diff --git a/docs/api/type-aliases/AuthProvidersArgs.md b/docs/api/type-aliases/AuthProvidersArgs.md index 1adc44719..3319bd112 100644 --- a/docs/api/type-aliases/AuthProvidersArgs.md +++ b/docs/api/type-aliases/AuthProvidersArgs.md @@ -8,8 +8,6 @@ > **AuthProvidersArgs** = `object` -Defined in: [types/cli.ts:1463](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1463) - Auth command argument types ## Properties @@ -17,5 +15,3 @@ Auth command argument types ### format? > `optional` **format?**: `"text"` \| `"json"` \| `"table"` - -Defined in: [types/cli.ts:1464](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1464) diff --git a/docs/api/type-aliases/AuthRateLimitConfig.md b/docs/api/type-aliases/AuthRateLimitConfig.md index 46dbc26bd..f0bff368e 100644 --- a/docs/api/type-aliases/AuthRateLimitConfig.md +++ b/docs/api/type-aliases/AuthRateLimitConfig.md @@ -8,8 +8,6 @@ > **AuthRateLimitConfig** = `object` -Defined in: [types/auth.ts:1350](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1350) - Rate limit configuration per user or role. ## Properties @@ -18,44 +16,32 @@ Rate limit configuration per user or role. > **maxRequests**: `number` -Defined in: [types/auth.ts:1351](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1351) - --- ### windowMs > **windowMs**: `number` -Defined in: [types/auth.ts:1352](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1352) - --- ### roleLimits? > `optional` **roleLimits?**: `Record`\<`string`, `number`\> -Defined in: [types/auth.ts:1353](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1353) - --- ### userLimits? > `optional` **userLimits?**: `Record`\<`string`, `number`\> -Defined in: [types/auth.ts:1354](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1354) - --- ### skipRoles? > `optional` **skipRoles?**: `string`[] -Defined in: [types/auth.ts:1355](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1355) - --- ### message? > `optional` **message?**: `string` - -Defined in: [types/auth.ts:1356](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1356) diff --git a/docs/api/type-aliases/AuthRateLimitRedisClient.md b/docs/api/type-aliases/AuthRateLimitRedisClient.md index b765d45a9..c7c0aae2d 100644 --- a/docs/api/type-aliases/AuthRateLimitRedisClient.md +++ b/docs/api/type-aliases/AuthRateLimitRedisClient.md @@ -8,8 +8,6 @@ > **AuthRateLimitRedisClient** = `object` -Defined in: [types/auth.ts:1394](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1394) - Minimal Redis client shape used by the rate-limiter to avoid a hard dependency on the full `RedisClientType`. Named with an Auth prefix to avoid collision with `RedisClientType` from the redis package. @@ -20,8 +18,6 @@ avoid collision with `RedisClientType` from the redis package. > **connect**(): `Promise`\<`void`\> -Defined in: [types/auth.ts:1395](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1395) - #### Returns `Promise`\<`void`\> @@ -32,8 +28,6 @@ Defined in: [types/auth.ts:1395](https://github.com/juspay/neurolink/blob/releas > **quit**(): `Promise`\<`void`\> -Defined in: [types/auth.ts:1396](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1396) - #### Returns `Promise`\<`void`\> @@ -44,8 +38,6 @@ Defined in: [types/auth.ts:1396](https://github.com/juspay/neurolink/blob/releas > **ping**(): `Promise`\<`string`\> -Defined in: [types/auth.ts:1397](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1397) - #### Returns `Promise`\<`string`\> @@ -56,8 +48,6 @@ Defined in: [types/auth.ts:1397](https://github.com/juspay/neurolink/blob/releas > **get**(`key`): `Promise`\<`string` \| `null`\> -Defined in: [types/auth.ts:1398](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1398) - #### Parameters ##### key @@ -74,8 +64,6 @@ Defined in: [types/auth.ts:1398](https://github.com/juspay/neurolink/blob/releas > **setEx**(`key`, `seconds`, `value`): `Promise`\<`void`\> -Defined in: [types/auth.ts:1399](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1399) - #### Parameters ##### key @@ -100,8 +88,6 @@ Defined in: [types/auth.ts:1399](https://github.com/juspay/neurolink/blob/releas > **del**(`key`): `Promise`\<`number`\> -Defined in: [types/auth.ts:1400](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1400) - #### Parameters ##### key @@ -118,8 +104,6 @@ Defined in: [types/auth.ts:1400](https://github.com/juspay/neurolink/blob/releas > **eval**(`script`, `numkeys`, ...`args`): `Promise`\<`unknown`\> -Defined in: [types/auth.ts:1401](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1401) - #### Parameters ##### script diff --git a/docs/api/type-aliases/AuthRequestContext.md b/docs/api/type-aliases/AuthRequestContext.md index 7147c659e..da62d71ac 100644 --- a/docs/api/type-aliases/AuthRequestContext.md +++ b/docs/api/type-aliases/AuthRequestContext.md @@ -8,8 +8,6 @@ > **AuthRequestContext** = `object` -Defined in: [types/auth.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L342) - Authentication request context ## Properties @@ -18,8 +16,6 @@ Authentication request context > `optional` **method?**: `string` -Defined in: [types/auth.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L344) - HTTP method --- @@ -28,8 +24,6 @@ HTTP method > `optional` **path?**: `string` -Defined in: [types/auth.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L346) - Request URL/path --- @@ -38,8 +32,6 @@ Request URL/path > **headers**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\> -Defined in: [types/auth.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L348) - HTTP request headers --- @@ -48,8 +40,6 @@ HTTP request headers > `optional` **cookies?**: `Record`\<`string`, `string`\> -Defined in: [types/auth.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L350) - Request cookies --- @@ -58,8 +48,6 @@ Request cookies > `optional` **query?**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\> -Defined in: [types/auth.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L352) - Query parameters --- @@ -68,8 +56,6 @@ Query parameters > `optional` **body?**: `unknown` -Defined in: [types/auth.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L354) - Request body (if available) --- @@ -78,8 +64,6 @@ Request body (if available) > `optional` **ip?**: `string` -Defined in: [types/auth.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L356) - IP address --- @@ -88,8 +72,6 @@ IP address > `optional` **ipAddress?**: `string` -Defined in: [types/auth.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L358) - IP address (alias for session builders that expect this field) --- @@ -98,8 +80,6 @@ IP address (alias for session builders that expect this field) > `optional` **userAgent?**: `string` -Defined in: [types/auth.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L360) - Request user agent --- @@ -108,6 +88,4 @@ Request user agent > `optional` **requestId?**: `string` -Defined in: [types/auth.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L362) - Request ID for tracing diff --git a/docs/api/type-aliases/AuthRequestHandler.md b/docs/api/type-aliases/AuthRequestHandler.md index 943a1ecc3..83172f8bb 100644 --- a/docs/api/type-aliases/AuthRequestHandler.md +++ b/docs/api/type-aliases/AuthRequestHandler.md @@ -8,8 +8,6 @@ > **AuthRequestHandler** = `object` -Defined in: [types/auth.ts:1139](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1139) - Request-level authentication. ## Methods @@ -18,8 +16,6 @@ Request-level authentication. > **authenticateRequest**(`context`): `Promise`\<[`AuthenticatedContext`](AuthenticatedContext.md) \| `null`\> -Defined in: [types/auth.ts:1141](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1141) - Authenticate a request and return full context #### Parameters diff --git a/docs/api/type-aliases/AuthResult.md b/docs/api/type-aliases/AuthResult.md index d32a638a0..80e9881a0 100644 --- a/docs/api/type-aliases/AuthResult.md +++ b/docs/api/type-aliases/AuthResult.md @@ -8,16 +8,12 @@ > **AuthResult** = `object` -Defined in: [types/server.ts:1306](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1306) - ## Properties ### id > **id**: `string` -Defined in: [types/server.ts:1308](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1308) - User ID --- @@ -26,8 +22,6 @@ User ID > `optional` **email?**: `string` -Defined in: [types/server.ts:1311](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1311) - User email (optional) --- @@ -36,8 +30,6 @@ User email (optional) > `optional` **roles?**: `string`[] -Defined in: [types/server.ts:1314](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1314) - User roles (optional) --- @@ -46,6 +38,4 @@ User roles (optional) > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/server.ts:1317](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1317) - Additional user data diff --git a/docs/api/type-aliases/AuthSession.md b/docs/api/type-aliases/AuthSession.md index ae91ba00c..b47c9999b 100644 --- a/docs/api/type-aliases/AuthSession.md +++ b/docs/api/type-aliases/AuthSession.md @@ -8,8 +8,6 @@ > **AuthSession** = `object` -Defined in: [types/auth.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L151) - Session information ## Properties @@ -18,8 +16,6 @@ Session information > **id**: `string` -Defined in: [types/auth.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L153) - Session identifier --- @@ -28,8 +24,6 @@ Session identifier > **user**: [`AuthUser`](AuthUser.md) -Defined in: [types/auth.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L155) - Associated user --- @@ -38,8 +32,6 @@ Associated user > `optional` **accessToken?**: `string` -Defined in: [types/auth.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L157) - Session access token --- @@ -48,8 +40,6 @@ Session access token > `optional` **refreshToken?**: `string` -Defined in: [types/auth.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L159) - Session refresh token --- @@ -58,8 +48,6 @@ Session refresh token > **createdAt**: `Date` -Defined in: [types/auth.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L161) - Session creation time --- @@ -68,8 +56,6 @@ Session creation time > **expiresAt**: `Date` -Defined in: [types/auth.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L163) - Session expiration time --- @@ -78,8 +64,6 @@ Session expiration time > **isValid**: `boolean` -Defined in: [types/auth.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L165) - Whether session is still valid --- @@ -88,8 +72,6 @@ Whether session is still valid > `optional` **lastActivityAt?**: `Date` -Defined in: [types/auth.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L167) - Last activity timestamp --- @@ -98,8 +80,6 @@ Last activity timestamp > `optional` **ipAddress?**: `string` -Defined in: [types/auth.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L169) - IP address of session origin --- @@ -108,8 +88,6 @@ IP address of session origin > `optional` **userAgent?**: `string` -Defined in: [types/auth.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L171) - User agent string --- @@ -118,8 +96,6 @@ User agent string > `optional` **deviceId?**: `string` -Defined in: [types/auth.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L173) - Device fingerprint --- @@ -128,6 +104,4 @@ Device fingerprint > `optional` **metadata?**: [`UnknownRecord`](UnknownRecord.md) -Defined in: [types/auth.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L175) - Session metadata diff --git a/docs/api/type-aliases/AuthSessionManager.md b/docs/api/type-aliases/AuthSessionManager.md index 8bb93ef12..c0e53da7f 100644 --- a/docs/api/type-aliases/AuthSessionManager.md +++ b/docs/api/type-aliases/AuthSessionManager.md @@ -8,8 +8,6 @@ > **AuthSessionManager** = `object` -Defined in: [types/auth.ts:1113](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1113) - Session management: create, read, refresh, destroy. ## Methods @@ -18,8 +16,6 @@ Session management: create, read, refresh, destroy. > **createSession**(`user`, `context?`): `Promise`\<[`AuthSession`](AuthSession.md)\> -Defined in: [types/auth.ts:1115](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1115) - Create a new session for a user #### Parameters @@ -42,8 +38,6 @@ Create a new session for a user > **getSession**(`sessionId`): `Promise`\<[`AuthSession`](AuthSession.md) \| `null`\> -Defined in: [types/auth.ts:1121](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1121) - Get an existing session by ID #### Parameters @@ -62,8 +56,6 @@ Get an existing session by ID > **refreshSession**(`sessionId`): `Promise`\<[`AuthSession`](AuthSession.md) \| `null`\> -Defined in: [types/auth.ts:1124](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1124) - Refresh/extend a session #### Parameters @@ -82,8 +74,6 @@ Refresh/extend a session > **destroySession**(`sessionId`): `Promise`\<`void`\> -Defined in: [types/auth.ts:1127](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1127) - Invalidate/destroy a session #### Parameters @@ -102,8 +92,6 @@ Invalidate/destroy a session > **getUserSessions**(`userId`): `Promise`\<[`AuthSession`](AuthSession.md)[]\> -Defined in: [types/auth.ts:1130](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1130) - Get all active sessions for a user #### Parameters @@ -122,8 +110,6 @@ Get all active sessions for a user > **destroyAllUserSessions**(`userId`): `Promise`\<`void`\> -Defined in: [types/auth.ts:1133](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1133) - Invalidate all sessions for a user (global logout) #### Parameters diff --git a/docs/api/type-aliases/AuthStatus.md b/docs/api/type-aliases/AuthStatus.md index 541328f90..c908fd41f 100644 --- a/docs/api/type-aliases/AuthStatus.md +++ b/docs/api/type-aliases/AuthStatus.md @@ -8,8 +8,6 @@ > **AuthStatus** = `object` -Defined in: [types/subscription.ts:1111](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1111) - Authentication status result ## Properties @@ -18,8 +16,6 @@ Authentication status result > **isAuthenticated**: `boolean` -Defined in: [types/subscription.ts:1113](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1113) - Whether the user is authenticated --- @@ -28,8 +24,6 @@ Whether the user is authenticated > **method**: `"api-key"` \| `"oauth"` \| `"none"` -Defined in: [types/subscription.ts:1115](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1115) - Authentication method in use --- @@ -38,8 +32,6 @@ Authentication method in use > `optional` **expiresAt?**: `Date` -Defined in: [types/subscription.ts:1117](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1117) - Token expiration time (for OAuth) --- @@ -48,8 +40,6 @@ Token expiration time (for OAuth) > `optional` **needsRefresh?**: `boolean` -Defined in: [types/subscription.ts:1119](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1119) - Whether token refresh is needed (for OAuth) --- @@ -58,8 +48,6 @@ Whether token refresh is needed (for OAuth) > `optional` **user?**: `object` -Defined in: [types/subscription.ts:1121](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1121) - User information (for OAuth) #### id? diff --git a/docs/api/type-aliases/AuthStatusResult.md b/docs/api/type-aliases/AuthStatusResult.md index c13d3d072..4ea00f686 100644 --- a/docs/api/type-aliases/AuthStatusResult.md +++ b/docs/api/type-aliases/AuthStatusResult.md @@ -8,8 +8,6 @@ > **AuthStatusResult** = `object` -Defined in: [types/cli.ts:1102](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1102) - Result of checking authentication status for a provider. ## Properties @@ -18,52 +16,38 @@ Result of checking authentication status for a provider. > **provider**: `string` -Defined in: [types/cli.ts:1103](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1103) - --- ### isAuthenticated > **isAuthenticated**: `boolean` -Defined in: [types/cli.ts:1104](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1104) - --- ### method > **method**: `"api-key"` \| `"oauth"` \| `"none"` -Defined in: [types/cli.ts:1105](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1105) - --- ### subscriptionTier? > `optional` **subscriptionTier?**: `string` -Defined in: [types/cli.ts:1106](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1106) - --- ### tokenExpiry? > `optional` **tokenExpiry?**: `string` -Defined in: [types/cli.ts:1107](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1107) - --- ### hasRefreshToken? > `optional` **hasRefreshToken?**: `boolean` -Defined in: [types/cli.ts:1108](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1108) - --- ### needsRefresh? > `optional` **needsRefresh?**: `boolean` - -Defined in: [types/cli.ts:1109](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1109) diff --git a/docs/api/type-aliases/AuthStrategy.md b/docs/api/type-aliases/AuthStrategy.md index 8c91548ff..2002d002b 100644 --- a/docs/api/type-aliases/AuthStrategy.md +++ b/docs/api/type-aliases/AuthStrategy.md @@ -8,6 +8,4 @@ > **AuthStrategy** = `"bearer"` \| `"apiKey"` \| `"basic"` \| `"custom"` \| `"none"` -Defined in: [types/server.ts:948](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L948) - Authentication strategy types diff --git a/docs/api/type-aliases/AuthTokenValidator.md b/docs/api/type-aliases/AuthTokenValidator.md index d0d8bf582..f6c8fc06a 100644 --- a/docs/api/type-aliases/AuthTokenValidator.md +++ b/docs/api/type-aliases/AuthTokenValidator.md @@ -8,8 +8,6 @@ > **AuthTokenValidator** = `object` -Defined in: [types/auth.ts:1071](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1071) - Token operations: validate, extract, refresh, revoke. ## Methods @@ -18,8 +16,6 @@ Token operations: validate, extract, refresh, revoke. > **authenticateToken**(`token`, `context?`): `Promise`\<[`TokenValidationResult`](TokenValidationResult.md)\> -Defined in: [types/auth.ts:1073](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1073) - Validate and decode an authentication token #### Parameters @@ -42,8 +38,6 @@ Validate and decode an authentication token > **extractToken**(`context`): `string` \| `Promise`\<`string` \| `null`\> \| `null` -Defined in: [types/auth.ts:1079](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1079) - Extract token from request context #### Parameters @@ -62,8 +56,6 @@ Extract token from request context > `optional` **refreshToken**(`refreshToken`): `Promise`\<[`TokenRefreshResult`](TokenRefreshResult.md)\> -Defined in: [types/auth.ts:1084](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1084) - Refresh an authentication token (optional) #### Parameters @@ -82,8 +74,6 @@ Refresh an authentication token (optional) > `optional` **revokeToken**(`token`): `Promise`\<`void`\> -Defined in: [types/auth.ts:1087](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1087) - Revoke a token / logout (optional) #### Parameters diff --git a/docs/api/type-aliases/AuthUser.md b/docs/api/type-aliases/AuthUser.md index 9411fbbcd..1b7e97190 100644 --- a/docs/api/type-aliases/AuthUser.md +++ b/docs/api/type-aliases/AuthUser.md @@ -8,8 +8,6 @@ > **AuthUser** = `object` -Defined in: [types/auth.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L119) - User information from authentication ## Properties @@ -18,8 +16,6 @@ User information from authentication > **id**: `string` -Defined in: [types/auth.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L121) - Unique user identifier --- @@ -28,8 +24,6 @@ Unique user identifier > `optional` **email?**: `string` -Defined in: [types/auth.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L123) - User's email address --- @@ -38,8 +32,6 @@ User's email address > `optional` **name?**: `string` -Defined in: [types/auth.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L125) - User's display name --- @@ -48,8 +40,6 @@ User's display name > `optional` **picture?**: `string` -Defined in: [types/auth.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L127) - Profile picture URL --- @@ -58,8 +48,6 @@ Profile picture URL > **roles**: `string`[] -Defined in: [types/auth.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L129) - User's roles --- @@ -68,8 +56,6 @@ User's roles > **permissions**: `string`[] -Defined in: [types/auth.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L131) - User's permissions --- @@ -78,8 +64,6 @@ User's permissions > `optional` **providerData?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/auth.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L133) - Provider-specific user data --- @@ -88,8 +72,6 @@ Provider-specific user data > `optional` **metadata?**: [`UnknownRecord`](UnknownRecord.md) -Defined in: [types/auth.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L135) - Provider-specific metadata --- @@ -98,8 +80,6 @@ Provider-specific metadata > `optional` **organizationId?**: `string` -Defined in: [types/auth.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L137) - Organization/tenant ID for multi-tenant apps --- @@ -108,8 +88,6 @@ Organization/tenant ID for multi-tenant apps > `optional` **emailVerified?**: `boolean` -Defined in: [types/auth.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L139) - Email verification status --- @@ -118,8 +96,6 @@ Email verification status > `optional` **createdAt?**: `Date` -Defined in: [types/auth.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L141) - Account creation timestamp --- @@ -128,8 +104,6 @@ Account creation timestamp > `optional` **updatedAt?**: `Date` -Defined in: [types/auth.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L143) - Last update timestamp --- @@ -138,6 +112,4 @@ Last update timestamp > `optional` **lastLoginAt?**: `Date` -Defined in: [types/auth.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L145) - Last login timestamp diff --git a/docs/api/type-aliases/AuthUserAuthorizer.md b/docs/api/type-aliases/AuthUserAuthorizer.md index f76f32c16..318ed5863 100644 --- a/docs/api/type-aliases/AuthUserAuthorizer.md +++ b/docs/api/type-aliases/AuthUserAuthorizer.md @@ -8,8 +8,6 @@ > **AuthUserAuthorizer** = `object` -Defined in: [types/auth.ts:1093](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1093) - Authorization: check roles and permissions. ## Methods @@ -18,8 +16,6 @@ Authorization: check roles and permissions. > **authorizeUser**(`user`, `permission`): `Promise`\<[`AuthorizationResult`](AuthorizationResult.md)\> -Defined in: [types/auth.ts:1095](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1095) - Check if a user is authorized to perform an action #### Parameters @@ -42,8 +38,6 @@ Check if a user is authorized to perform an action > **authorizeRoles**(`user`, `roles`): `Promise`\<[`AuthorizationResult`](AuthorizationResult.md)\> -Defined in: [types/auth.ts:1101](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1101) - Check if user has specific roles #### Parameters @@ -66,8 +60,6 @@ Check if user has specific roles > **authorizePermissions**(`user`, `permissions`): `Promise`\<[`AuthorizationResult`](AuthorizationResult.md)\> -Defined in: [types/auth.ts:1104](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1104) - Check if user has all specified permissions #### Parameters diff --git a/docs/api/type-aliases/AuthUserManager.md b/docs/api/type-aliases/AuthUserManager.md index be4bc8dc9..854cb8e07 100644 --- a/docs/api/type-aliases/AuthUserManager.md +++ b/docs/api/type-aliases/AuthUserManager.md @@ -8,8 +8,6 @@ > **AuthUserManager** = `object` -Defined in: [types/auth.ts:1149](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1149) - Optional user management operations. ## Methods @@ -18,8 +16,6 @@ Optional user management operations. > `optional` **getUser**(`userId`): `Promise`\<[`AuthUser`](AuthUser.md) \| `null`\> -Defined in: [types/auth.ts:1151](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1151) - Get user by ID #### Parameters @@ -38,8 +34,6 @@ Get user by ID > `optional` **getUserByEmail**(`email`): `Promise`\<[`AuthUser`](AuthUser.md) \| `null`\> -Defined in: [types/auth.ts:1154](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1154) - Get user by email #### Parameters @@ -58,8 +52,6 @@ Get user by email > `optional` **updateUserMetadata**(`userId`, `metadata`): `Promise`\<[`AuthUser`](AuthUser.md)\> -Defined in: [types/auth.ts:1157](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1157) - Update user metadata #### Parameters @@ -82,8 +74,6 @@ Update user metadata > `optional` **updateUserRoles**(`userId`, `roles`): `Promise`\<[`AuthUser`](AuthUser.md)\> -Defined in: [types/auth.ts:1163](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1163) - Update user roles #### Parameters @@ -106,8 +96,6 @@ Update user roles > `optional` **updateUserPermissions**(`userId`, `permissions`): `Promise`\<[`AuthUser`](AuthUser.md)\> -Defined in: [types/auth.ts:1166](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1166) - Update user permissions #### Parameters diff --git a/docs/api/type-aliases/AuthValidateArgs.md b/docs/api/type-aliases/AuthValidateArgs.md index 5240929cd..fce4ca828 100644 --- a/docs/api/type-aliases/AuthValidateArgs.md +++ b/docs/api/type-aliases/AuthValidateArgs.md @@ -8,84 +8,62 @@ > **AuthValidateArgs** = `object` -Defined in: [types/cli.ts:1467](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1467) - ## Properties ### token > **token**: `string` -Defined in: [types/cli.ts:1468](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1468) - --- ### provider > **provider**: [`AuthProviderType`](AuthProviderType.md) -Defined in: [types/cli.ts:1469](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1469) - --- ### domain? > `optional` **domain?**: `string` -Defined in: [types/cli.ts:1470](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1470) - --- ### clientId? > `optional` **clientId?**: `string` -Defined in: [types/cli.ts:1471](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1471) - --- ### secretKey? > `optional` **secretKey?**: `string` -Defined in: [types/cli.ts:1472](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1472) - --- ### secret? > `optional` **secret?**: `string` -Defined in: [types/cli.ts:1473](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1473) - --- ### url? > `optional` **url?**: `string` -Defined in: [types/cli.ts:1474](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1474) - --- ### anonKey? > `optional` **anonKey?**: `string` -Defined in: [types/cli.ts:1475](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1475) - --- ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/cli.ts:1476](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1476) - --- ### format? > `optional` **format?**: `"text"` \| `"json"` - -Defined in: [types/cli.ts:1477](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1477) diff --git a/docs/api/type-aliases/AuthenticatedContext.md b/docs/api/type-aliases/AuthenticatedContext.md index 4249728c5..9b5b15ecb 100644 --- a/docs/api/type-aliases/AuthenticatedContext.md +++ b/docs/api/type-aliases/AuthenticatedContext.md @@ -8,8 +8,6 @@ > **AuthenticatedContext** = [`AuthRequestContext`](AuthRequestContext.md) & `object` -Defined in: [types/auth.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L371) - Enhanced request context with authenticated user. Extends AuthRequestContext so it can be passed wherever a plain diff --git a/docs/api/type-aliases/AuthenticatedUser.md b/docs/api/type-aliases/AuthenticatedUser.md index 290684bf1..43c79c80f 100644 --- a/docs/api/type-aliases/AuthenticatedUser.md +++ b/docs/api/type-aliases/AuthenticatedUser.md @@ -8,8 +8,6 @@ > **AuthenticatedUser** = `object` -Defined in: [types/server.ts:924](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L924) - Authenticated user information ## Properties @@ -18,44 +16,32 @@ Authenticated user information > **id**: `string` -Defined in: [types/server.ts:925](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L925) - --- ### email? > `optional` **email?**: `string` -Defined in: [types/server.ts:926](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L926) - --- ### name? > `optional` **name?**: `string` -Defined in: [types/server.ts:927](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L927) - --- ### roles? > `optional` **roles?**: `string`[] -Defined in: [types/server.ts:928](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L928) - --- ### permissions? > `optional` **permissions?**: `string`[] -Defined in: [types/server.ts:929](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L929) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/server.ts:930](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L930) diff --git a/docs/api/type-aliases/AuthenticationState.md b/docs/api/type-aliases/AuthenticationState.md index 09026a2f9..a4a0780d2 100644 --- a/docs/api/type-aliases/AuthenticationState.md +++ b/docs/api/type-aliases/AuthenticationState.md @@ -8,8 +8,6 @@ > **AuthenticationState** = `object` -Defined in: [types/subscription.ts:638](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L638) - Authentication state for tracking auth status ## Description @@ -22,8 +20,6 @@ Represents the current authentication state > **isAuthenticated**: `boolean` -Defined in: [types/subscription.ts:640](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L640) - Whether the user is authenticated --- @@ -32,8 +28,6 @@ Whether the user is authenticated > `optional` **method?**: [`AnthropicAuthMethod`](AnthropicAuthMethod.md) -Defined in: [types/subscription.ts:642](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L642) - Current authentication method in use --- @@ -42,8 +36,6 @@ Current authentication method in use > `optional` **tier?**: [`ClaudeSubscriptionTier`](ClaudeSubscriptionTier.md) -Defined in: [types/subscription.ts:644](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L644) - Current subscription tier --- @@ -52,8 +44,6 @@ Current subscription tier > **needsRefresh**: `boolean` -Defined in: [types/subscription.ts:646](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L646) - Whether tokens need to be refreshed --- @@ -62,8 +52,6 @@ Whether tokens need to be refreshed > `optional` **error?**: `string` -Defined in: [types/subscription.ts:648](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L648) - Error message if authentication failed --- @@ -72,6 +60,4 @@ Error message if authentication failed > `optional` **lastAuthenticatedAt?**: `number` -Defined in: [types/subscription.ts:650](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L650) - Timestamp of last successful authentication diff --git a/docs/api/type-aliases/AuthorizationResult.md b/docs/api/type-aliases/AuthorizationResult.md index 0217967dc..8ba35c0a1 100644 --- a/docs/api/type-aliases/AuthorizationResult.md +++ b/docs/api/type-aliases/AuthorizationResult.md @@ -8,8 +8,6 @@ > **AuthorizationResult** = `object` -Defined in: [types/auth.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L318) - Authorization check result ## Properties @@ -18,8 +16,6 @@ Authorization check result > **authorized**: `boolean` -Defined in: [types/auth.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L320) - Whether the user is authorized --- @@ -28,8 +24,6 @@ Whether the user is authorized > `optional` **user?**: [`AuthUser`](AuthUser.md) -Defined in: [types/auth.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L322) - User being authorized --- @@ -38,8 +32,6 @@ User being authorized > `optional` **requiredRoles?**: `string`[] -Defined in: [types/auth.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L324) - Required roles that were checked --- @@ -48,8 +40,6 @@ Required roles that were checked > `optional` **requiredPermissions?**: `string`[] -Defined in: [types/auth.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L326) - Required permissions that were checked --- @@ -58,8 +48,6 @@ Required permissions that were checked > `optional` **reason?**: `string` -Defined in: [types/auth.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L328) - Reason for denial if not authorized --- @@ -68,8 +56,6 @@ Reason for denial if not authorized > `optional` **missingPermissions?**: `string`[] -Defined in: [types/auth.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L330) - Missing permissions if denied --- @@ -78,6 +64,4 @@ Missing permissions if denied > `optional` **missingRoles?**: `string`[] -Defined in: [types/auth.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L332) - Missing roles if denied diff --git a/docs/api/type-aliases/AuthorizationUrlResult.md b/docs/api/type-aliases/AuthorizationUrlResult.md index 541034dd1..7702d325a 100644 --- a/docs/api/type-aliases/AuthorizationUrlResult.md +++ b/docs/api/type-aliases/AuthorizationUrlResult.md @@ -8,8 +8,6 @@ > **AuthorizationUrlResult** = `object` -Defined in: [types/mcp.ts:949](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L949) - Authorization URL result from OAuth flow ## Properties @@ -18,20 +16,14 @@ Authorization URL result from OAuth flow > **url**: `string` -Defined in: [types/mcp.ts:950](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L950) - --- ### state > **state**: `string` -Defined in: [types/mcp.ts:951](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L951) - --- ### codeVerifier? > `optional` **codeVerifier?**: `string` - -Defined in: [types/mcp.ts:952](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L952) diff --git a/docs/api/type-aliases/AutoEvaluationConfig.md b/docs/api/type-aliases/AutoEvaluationConfig.md index 3f3ae959e..f13c83db8 100644 --- a/docs/api/type-aliases/AutoEvaluationConfig.md +++ b/docs/api/type-aliases/AutoEvaluationConfig.md @@ -8,8 +8,6 @@ > **AutoEvaluationConfig** = `object` -Defined in: [types/middleware.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L201) - Configuration for the Auto-Evaluation Middleware. ## Properties @@ -18,8 +16,6 @@ Configuration for the Auto-Evaluation Middleware. > `optional` **threshold?**: `number` -Defined in: [types/middleware.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L203) - The minimum score (1-10) for a response to be considered passing. --- @@ -28,8 +24,6 @@ The minimum score (1-10) for a response to be considered passing. > `optional` **maxRetries?**: `number` -Defined in: [types/middleware.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L205) - The maximum number of retry attempts before failing. --- @@ -38,8 +32,6 @@ The maximum number of retry attempts before failing. > `optional` **evaluationModel?**: `string` -Defined in: [types/middleware.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L207) - The model to use for the LLM-as-judge evaluation. --- @@ -48,8 +40,6 @@ The model to use for the LLM-as-judge evaluation. > `optional` **blocking?**: `boolean` -Defined in: [types/middleware.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L212) - If true, the middleware will wait for the evaluation to complete before returning. If the evaluation fails, it will throw an error. Defaults to true. @@ -59,8 +49,6 @@ If the evaluation fails, it will throw an error. Defaults to true. > `optional` **onEvaluationComplete?**: (`evaluation`) => `void` \| `Promise`\<`void`\> -Defined in: [types/middleware.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L214) - A callback function to be invoked with the evaluation result. #### Parameters @@ -79,8 +67,6 @@ A callback function to be invoked with the evaluation result. > `optional` **offTopicThreshold?**: `number` -Defined in: [types/middleware.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L216) - The score below which a response is considered off-topic. --- @@ -89,8 +75,6 @@ The score below which a response is considered off-topic. > `optional` **highSeverityThreshold?**: `number` -Defined in: [types/middleware.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L218) - The score below which a failing response is considered a high severity alert. --- @@ -99,12 +83,8 @@ The score below which a failing response is considered a high severity alert. > `optional` **promptGenerator?**: [`GetPromptFunction`](GetPromptFunction.md) -Defined in: [types/middleware.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L220) - --- ### provider? > `optional` **provider?**: `string` - -Defined in: [types/middleware.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L222) diff --git a/docs/api/type-aliases/AutoresearchEmitter.md b/docs/api/type-aliases/AutoresearchEmitter.md index 3f3800adb..968aad334 100644 --- a/docs/api/type-aliases/AutoresearchEmitter.md +++ b/docs/api/type-aliases/AutoresearchEmitter.md @@ -8,8 +8,6 @@ > **AutoresearchEmitter** = `object` -Defined in: [types/autoresearch.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L241) - Minimal emitter interface accepted by autoresearch subsystems. Matches the shape injected by NeuroLink via setEmitter(). @@ -19,8 +17,6 @@ Matches the shape injected by NeuroLink via setEmitter(). > **emit**(`event`, ...`args`): `boolean` -Defined in: [types/autoresearch.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L242) - #### Parameters ##### event diff --git a/docs/api/type-aliases/AutoresearchErrorEvent.md b/docs/api/type-aliases/AutoresearchErrorEvent.md index 56cc4969a..74a56cc23 100644 --- a/docs/api/type-aliases/AutoresearchErrorEvent.md +++ b/docs/api/type-aliases/AutoresearchErrorEvent.md @@ -8,44 +8,32 @@ > **AutoresearchErrorEvent** = `object` -Defined in: [types/autoresearch.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L206) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L207) - --- ### error > **error**: `string` -Defined in: [types/autoresearch.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L208) - --- ### code? > `optional` **code?**: `string` -Defined in: [types/autoresearch.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L209) - --- ### phase? > `optional` **phase?**: [`ExperimentPhase`](ExperimentPhase.md) -Defined in: [types/autoresearch.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L210) - --- ### runCount? > `optional` **runCount?**: `number` - -Defined in: [types/autoresearch.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L211) diff --git a/docs/api/type-aliases/AutoresearchEventMap.md b/docs/api/type-aliases/AutoresearchEventMap.md index c9bae144b..e71b15f84 100644 --- a/docs/api/type-aliases/AutoresearchEventMap.md +++ b/docs/api/type-aliases/AutoresearchEventMap.md @@ -8,8 +8,6 @@ > **AutoresearchEventMap** = `object` -Defined in: [types/autoresearch.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L219) - Union map of all autoresearch event names to their payload types. Used by TypedEventEmitter consumers for documentation; NeuroLinkEvents uses `unknown` payloads for flexibility. @@ -20,76 +18,56 @@ NeuroLinkEvents uses `unknown` payloads for flexibility. > **autoresearch:initialized**: [`AutoresearchInitializedEvent`](AutoresearchInitializedEvent.md) -Defined in: [types/autoresearch.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L220) - --- ### autoresearch:resumed > **autoresearch:resumed**: [`AutoresearchResumedEvent`](AutoresearchResumedEvent.md) -Defined in: [types/autoresearch.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L221) - --- ### autoresearch:phase-changed > **autoresearch:phase-changed**: [`AutoresearchPhaseChangedEvent`](AutoresearchPhaseChangedEvent.md) -Defined in: [types/autoresearch.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L222) - --- ### autoresearch:experiment-started > **autoresearch:experiment-started**: [`AutoresearchExperimentStartedEvent`](AutoresearchExperimentStartedEvent.md) -Defined in: [types/autoresearch.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L223) - --- ### autoresearch:experiment-completed > **autoresearch:experiment-completed**: [`AutoresearchExperimentCompletedEvent`](AutoresearchExperimentCompletedEvent.md) -Defined in: [types/autoresearch.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L224) - --- ### autoresearch:metric-improved > **autoresearch:metric-improved**: [`AutoresearchMetricImprovedEvent`](AutoresearchMetricImprovedEvent.md) -Defined in: [types/autoresearch.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L225) - --- ### autoresearch:revert > **autoresearch:revert**: [`AutoresearchRevertEvent`](AutoresearchRevertEvent.md) -Defined in: [types/autoresearch.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L226) - --- ### autoresearch:revert-failed > **autoresearch:revert-failed**: [`AutoresearchRevertFailedEvent`](AutoresearchRevertFailedEvent.md) -Defined in: [types/autoresearch.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L227) - --- ### autoresearch:state-updated > **autoresearch:state-updated**: [`AutoresearchStateUpdatedEvent`](AutoresearchStateUpdatedEvent.md) -Defined in: [types/autoresearch.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L228) - --- ### autoresearch:error > **autoresearch:error**: [`AutoresearchErrorEvent`](AutoresearchErrorEvent.md) - -Defined in: [types/autoresearch.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L229) diff --git a/docs/api/type-aliases/AutoresearchEventName.md b/docs/api/type-aliases/AutoresearchEventName.md index ac5f35bcd..2d893ef16 100644 --- a/docs/api/type-aliases/AutoresearchEventName.md +++ b/docs/api/type-aliases/AutoresearchEventName.md @@ -8,6 +8,4 @@ > **AutoresearchEventName** = keyof [`AutoresearchEventMap`](AutoresearchEventMap.md) -Defined in: [types/autoresearch.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L233) - All known autoresearch event names. diff --git a/docs/api/type-aliases/AutoresearchExperimentCompletedEvent.md b/docs/api/type-aliases/AutoresearchExperimentCompletedEvent.md index fec686854..be0746589 100644 --- a/docs/api/type-aliases/AutoresearchExperimentCompletedEvent.md +++ b/docs/api/type-aliases/AutoresearchExperimentCompletedEvent.md @@ -8,60 +8,44 @@ > **AutoresearchExperimentCompletedEvent** = `object` -Defined in: [types/autoresearch.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L165) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L166) - --- ### runCount > **runCount**: `number` -Defined in: [types/autoresearch.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L167) - --- ### status > **status**: [`ExperimentStatus`](ExperimentStatus.md) -Defined in: [types/autoresearch.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L168) - --- ### metric > **metric**: `number` \| `null` -Defined in: [types/autoresearch.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L169) - --- ### commit > **commit**: `string` -Defined in: [types/autoresearch.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L170) - --- ### description > **description**: `string` -Defined in: [types/autoresearch.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L171) - --- ### durationMs > **durationMs**: `number` - -Defined in: [types/autoresearch.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L172) diff --git a/docs/api/type-aliases/AutoresearchExperimentStartedEvent.md b/docs/api/type-aliases/AutoresearchExperimentStartedEvent.md index 5ff416acf..979d2acdc 100644 --- a/docs/api/type-aliases/AutoresearchExperimentStartedEvent.md +++ b/docs/api/type-aliases/AutoresearchExperimentStartedEvent.md @@ -8,28 +8,20 @@ > **AutoresearchExperimentStartedEvent** = `object` -Defined in: [types/autoresearch.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L159) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L160) - --- ### runCount > **runCount**: `number` -Defined in: [types/autoresearch.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L161) - --- ### description > **description**: `string` - -Defined in: [types/autoresearch.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L162) diff --git a/docs/api/type-aliases/AutoresearchInitArgs.md b/docs/api/type-aliases/AutoresearchInitArgs.md index 4d7b9084e..b474784dc 100644 --- a/docs/api/type-aliases/AutoresearchInitArgs.md +++ b/docs/api/type-aliases/AutoresearchInitArgs.md @@ -8,8 +8,6 @@ > **AutoresearchInitArgs** = `object` -Defined in: [types/cli.ts:1543](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1543) - Arguments for `neurolink autoresearch init`. ## Properties @@ -18,84 +16,62 @@ Arguments for `neurolink autoresearch init`. > **repoPath**: `string` -Defined in: [types/cli.ts:1544](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1544) - --- ### tag > **tag**: `string` -Defined in: [types/cli.ts:1545](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1545) - --- ### target > **target**: `string` -Defined in: [types/cli.ts:1546](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1546) - --- ### immutable > **immutable**: `string` -Defined in: [types/cli.ts:1547](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1547) - --- ### runCommand > **runCommand**: `string` -Defined in: [types/cli.ts:1548](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1548) - --- ### metricName > **metricName**: `string` -Defined in: [types/cli.ts:1549](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1549) - --- ### metricPattern > **metricPattern**: `string` -Defined in: [types/cli.ts:1550](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1550) - --- ### metricDirection > **metricDirection**: `string` -Defined in: [types/cli.ts:1551](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1551) - --- ### timeout > **timeout**: `number` -Defined in: [types/cli.ts:1552](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1552) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/cli.ts:1553](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1553) - --- ### model? > `optional` **model?**: `string` - -Defined in: [types/cli.ts:1554](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1554) diff --git a/docs/api/type-aliases/AutoresearchInitializedEvent.md b/docs/api/type-aliases/AutoresearchInitializedEvent.md index b85ddbcfc..f064e096c 100644 --- a/docs/api/type-aliases/AutoresearchInitializedEvent.md +++ b/docs/api/type-aliases/AutoresearchInitializedEvent.md @@ -8,32 +8,24 @@ > **AutoresearchInitializedEvent** = `object` -Defined in: [types/autoresearch.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L134) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L135) - --- ### branch > **branch**: `string` -Defined in: [types/autoresearch.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L136) - --- ### config > **config**: `object` -Defined in: [types/autoresearch.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L137) - #### repoPath > **repoPath**: `string` diff --git a/docs/api/type-aliases/AutoresearchMetricImprovedEvent.md b/docs/api/type-aliases/AutoresearchMetricImprovedEvent.md index 5730da2bd..cc763c78e 100644 --- a/docs/api/type-aliases/AutoresearchMetricImprovedEvent.md +++ b/docs/api/type-aliases/AutoresearchMetricImprovedEvent.md @@ -8,52 +8,38 @@ > **AutoresearchMetricImprovedEvent** = `object` -Defined in: [types/autoresearch.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L175) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L176) - --- ### previousBest > **previousBest**: `number` \| `null` -Defined in: [types/autoresearch.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L177) - --- ### newBest > **newBest**: `number` -Defined in: [types/autoresearch.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L178) - --- ### commit > **commit**: `string` -Defined in: [types/autoresearch.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L179) - --- ### direction > **direction**: [`MetricDirection`](MetricDirection.md) -Defined in: [types/autoresearch.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L180) - --- ### runCount > **runCount**: `number` - -Defined in: [types/autoresearch.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L181) diff --git a/docs/api/type-aliases/AutoresearchPhaseChangedEvent.md b/docs/api/type-aliases/AutoresearchPhaseChangedEvent.md index 79d6e6f61..2bcb658ee 100644 --- a/docs/api/type-aliases/AutoresearchPhaseChangedEvent.md +++ b/docs/api/type-aliases/AutoresearchPhaseChangedEvent.md @@ -8,36 +8,26 @@ > **AutoresearchPhaseChangedEvent** = `object` -Defined in: [types/autoresearch.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L152) - ## Properties ### from > **from**: [`ExperimentPhase`](ExperimentPhase.md) -Defined in: [types/autoresearch.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L153) - --- ### to > **to**: [`ExperimentPhase`](ExperimentPhase.md) -Defined in: [types/autoresearch.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L154) - --- ### runCount > **runCount**: `number` -Defined in: [types/autoresearch.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L155) - --- ### tag > **tag**: `string` - -Defined in: [types/autoresearch.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L156) diff --git a/docs/api/type-aliases/AutoresearchResumedEvent.md b/docs/api/type-aliases/AutoresearchResumedEvent.md index 413fe017f..1668253e9 100644 --- a/docs/api/type-aliases/AutoresearchResumedEvent.md +++ b/docs/api/type-aliases/AutoresearchResumedEvent.md @@ -8,36 +8,26 @@ > **AutoresearchResumedEvent** = `object` -Defined in: [types/autoresearch.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L145) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L146) - --- ### branch > **branch**: `string` -Defined in: [types/autoresearch.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L147) - --- ### runCount > **runCount**: `number` -Defined in: [types/autoresearch.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L148) - --- ### currentPhase > **currentPhase**: [`ExperimentPhase`](ExperimentPhase.md) - -Defined in: [types/autoresearch.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L149) diff --git a/docs/api/type-aliases/AutoresearchRevertEvent.md b/docs/api/type-aliases/AutoresearchRevertEvent.md index 713f1a104..93508ec69 100644 --- a/docs/api/type-aliases/AutoresearchRevertEvent.md +++ b/docs/api/type-aliases/AutoresearchRevertEvent.md @@ -8,36 +8,26 @@ > **AutoresearchRevertEvent** = `object` -Defined in: [types/autoresearch.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L184) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L185) - --- ### targetCommit > **targetCommit**: `string` -Defined in: [types/autoresearch.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L186) - --- ### reason > **reason**: [`ExperimentStatus`](ExperimentStatus.md) -Defined in: [types/autoresearch.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L187) - --- ### runCount > **runCount**: `number` - -Defined in: [types/autoresearch.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L188) diff --git a/docs/api/type-aliases/AutoresearchRevertFailedEvent.md b/docs/api/type-aliases/AutoresearchRevertFailedEvent.md index 853498428..963b5cd3a 100644 --- a/docs/api/type-aliases/AutoresearchRevertFailedEvent.md +++ b/docs/api/type-aliases/AutoresearchRevertFailedEvent.md @@ -8,36 +8,26 @@ > **AutoresearchRevertFailedEvent** = `object` -Defined in: [types/autoresearch.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L191) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L192) - --- ### targetCommit > **targetCommit**: `string` -Defined in: [types/autoresearch.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L193) - --- ### error > **error**: `string` -Defined in: [types/autoresearch.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L194) - --- ### runCount > **runCount**: `number` - -Defined in: [types/autoresearch.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L195) diff --git a/docs/api/type-aliases/AutoresearchStateUpdatedEvent.md b/docs/api/type-aliases/AutoresearchStateUpdatedEvent.md index 17e1401b0..8b34a9a74 100644 --- a/docs/api/type-aliases/AutoresearchStateUpdatedEvent.md +++ b/docs/api/type-aliases/AutoresearchStateUpdatedEvent.md @@ -8,44 +8,32 @@ > **AutoresearchStateUpdatedEvent** = `object` -Defined in: [types/autoresearch.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L198) - ## Properties ### tag > **tag**: `string` -Defined in: [types/autoresearch.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L199) - --- ### phase > **phase**: [`ExperimentPhase`](ExperimentPhase.md) -Defined in: [types/autoresearch.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L200) - --- ### runCount > **runCount**: `number` -Defined in: [types/autoresearch.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L201) - --- ### keepCount > **keepCount**: `number` -Defined in: [types/autoresearch.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L202) - --- ### bestMetric > **bestMetric**: `number` \| `null` - -Defined in: [types/autoresearch.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L203) diff --git a/docs/api/type-aliases/AutoresearchTaskConfig.md b/docs/api/type-aliases/AutoresearchTaskConfig.md index 4dd521838..22a7ecc15 100644 --- a/docs/api/type-aliases/AutoresearchTaskConfig.md +++ b/docs/api/type-aliases/AutoresearchTaskConfig.md @@ -8,8 +8,6 @@ > **AutoresearchTaskConfig** = `object` -Defined in: [types/task.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L28) - Configuration for autoresearch tasks. Embedded in TaskDefinition/Task when type === "autoresearch". @@ -19,132 +17,98 @@ Embedded in TaskDefinition/Task when type === "autoresearch". > **repoPath**: `string` -Defined in: [types/task.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L29) - --- ### mutablePaths > **mutablePaths**: `string`[] -Defined in: [types/task.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L30) - --- ### runCommand > **runCommand**: `string` -Defined in: [types/task.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L31) - --- ### metric > **metric**: [`MetricConfig`](MetricConfig.md) -Defined in: [types/task.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L32) - --- ### immutablePaths? > `optional` **immutablePaths?**: `string`[] -Defined in: [types/task.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L33) - --- ### timeoutMs? > `optional` **timeoutMs?**: `number` -Defined in: [types/task.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L34) - --- ### maxExperiments? > `optional` **maxExperiments?**: `number` -Defined in: [types/task.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L35) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/task.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L36) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/task.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L37) - --- ### thinkingLevel? > `optional` **thinkingLevel?**: [`ThinkingLevel`](ThinkingLevel.md) -Defined in: [types/task.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L38) - --- ### maxBudgetUsd? > `optional` **maxBudgetUsd?**: `number` -Defined in: [types/task.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L39) - --- ### programPath? > `optional` **programPath?**: `string` -Defined in: [types/task.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L42) - --- ### resultsPath? > `optional` **resultsPath?**: `string` -Defined in: [types/task.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L43) - --- ### statePath? > `optional` **statePath?**: `string` -Defined in: [types/task.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L44) - --- ### logPath? > `optional` **logPath?**: `string` -Defined in: [types/task.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L45) - --- ### branchPrefix? > `optional` **branchPrefix?**: `string` -Defined in: [types/task.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L46) - --- ### memoryMetric? > `optional` **memoryMetric?**: [`MemoryMetricConfig`](MemoryMetricConfig.md) - -Defined in: [types/task.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L47) diff --git a/docs/api/type-aliases/AvailableTool.md b/docs/api/type-aliases/AvailableTool.md index 9e9e77a5b..1afaed182 100644 --- a/docs/api/type-aliases/AvailableTool.md +++ b/docs/api/type-aliases/AvailableTool.md @@ -8,8 +8,6 @@ > **AvailableTool** = `object` -Defined in: [types/tools.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L594) - Available tool information ## Properties @@ -18,36 +16,26 @@ Available tool information > **name**: `string` -Defined in: [types/tools.ts:595](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L595) - --- ### description > **description**: `string` -Defined in: [types/tools.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L596) - --- ### serverId? > `optional` **serverId?**: `string` -Defined in: [types/tools.ts:597](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L597) - --- ### toolName? > `optional` **toolName?**: `string` -Defined in: [types/tools.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L598) - --- ### parameters? > `optional` **parameters?**: [`ToolParameterSchema`](ToolParameterSchema.md) - -Defined in: [types/tools.ts:599](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L599) diff --git a/docs/api/type-aliases/AvatarHandler.md b/docs/api/type-aliases/AvatarHandler.md index e3f105337..277bd6127 100644 --- a/docs/api/type-aliases/AvatarHandler.md +++ b/docs/api/type-aliases/AvatarHandler.md @@ -8,8 +8,6 @@ > **AvatarHandler** = `object` -Defined in: [types/avatar.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L120) - Handler contract for avatar / lip-sync providers. Implementations enforce their own timeouts. Recommended: @@ -23,8 +21,6 @@ Implementations enforce their own timeouts. Recommended: > `readonly` `optional` **maxAudioDurationSeconds?**: `number` -Defined in: [types/avatar.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L130) - Maximum supported audio length in seconds (provider-specific). --- @@ -33,8 +29,6 @@ Maximum supported audio length in seconds (provider-specific). > `readonly` `optional` **supportedFormats?**: readonly [`AvatarVideoFormat`](AvatarVideoFormat.md)[] -Defined in: [types/avatar.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L133) - Output formats supported by this handler. ## Methods @@ -43,8 +37,6 @@ Output formats supported by this handler. > **generate**(`options`): `Promise`\<[`AvatarResult`](AvatarResult.md)\> -Defined in: [types/avatar.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L124) - Generate a talking-head video from an image + audio (or pre-rendered text). #### Parameters @@ -63,8 +55,6 @@ Generate a talking-head video from an image + audio (or pre-rendered text). > **isConfigured**(): `boolean` -Defined in: [types/avatar.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L127) - Validate the provider is configured (auth, base URL, etc.). #### Returns diff --git a/docs/api/type-aliases/AvatarOptions.md b/docs/api/type-aliases/AvatarOptions.md index 0843d8eec..e954ddca3 100644 --- a/docs/api/type-aliases/AvatarOptions.md +++ b/docs/api/type-aliases/AvatarOptions.md @@ -8,8 +8,6 @@ > **AvatarOptions** = `object` -Defined in: [types/avatar.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L42) - Options for avatar video generation. ## Indexable @@ -24,8 +22,6 @@ Provider-specific additional options. > **image**: `Buffer` \| `string` -Defined in: [types/avatar.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L44) - Source portrait image (Buffer, file path, or HTTPS URL). --- @@ -34,8 +30,6 @@ Source portrait image (Buffer, file path, or HTTPS URL). > `optional` **audio?**: `Buffer` \| `string` -Defined in: [types/avatar.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L50) - Audio source — direct lip-sync. Either provide `audio` OR `text` (with optional `ttsProvider` / `voice`). @@ -45,8 +39,6 @@ Either provide `audio` OR `text` (with optional `ttsProvider` / `voice`). > `optional` **text?**: `string` -Defined in: [types/avatar.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L57) - Text for the avatar to speak. When provided without `audio`, the NeuroLink dispatcher first runs TTS (`ttsProvider`) to produce audio, then passes the audio to the avatar handler. @@ -57,8 +49,6 @@ then passes the audio to the avatar handler. > `optional` **ttsProvider?**: `string` -Defined in: [types/avatar.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L60) - TTS provider for text → audio when `text` is used. Default: "openai-tts". --- @@ -67,8 +57,6 @@ TTS provider for text → audio when `text` is used. Default: "openai-tts". > `optional` **voice?**: `string` -Defined in: [types/avatar.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L63) - Voice id passed through to the TTS provider when `text` is used. --- @@ -77,8 +65,6 @@ Voice id passed through to the TTS provider when `text` is used. > `optional` **provider?**: [`AvatarProviderName`](AvatarProviderName.md) -Defined in: [types/avatar.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L66) - Avatar provider override (e.g. "d-id", "heygen", "replicate"). --- @@ -87,8 +73,6 @@ Avatar provider override (e.g. "d-id", "heygen", "replicate"). > `optional` **quality?**: [`AvatarQuality`](AvatarQuality.md) -Defined in: [types/avatar.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L69) - Output quality preset. --- @@ -97,8 +81,6 @@ Output quality preset. > `optional` **format?**: [`AvatarVideoFormat`](AvatarVideoFormat.md) -Defined in: [types/avatar.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L72) - Output format (default: "mp4"). --- @@ -107,8 +89,6 @@ Output format (default: "mp4"). > `optional` **output?**: `string` -Defined in: [types/avatar.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L75) - Output file path (optional — buffer is always returned in the result). --- @@ -117,6 +97,4 @@ Output file path (optional — buffer is always returned in the result). > `optional` **timeout?**: `number` -Defined in: [types/avatar.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L78) - Per-call timeout in ms (default: 5 minutes). diff --git a/docs/api/type-aliases/AvatarProviderName.md b/docs/api/type-aliases/AvatarProviderName.md index 5ad3a9334..979fea300 100644 --- a/docs/api/type-aliases/AvatarProviderName.md +++ b/docs/api/type-aliases/AvatarProviderName.md @@ -8,8 +8,6 @@ > **AvatarProviderName** = `"d-id"` \| `"heygen"` \| `"replicate"` \| `"musetalk"` \| `string` & `object` -Defined in: [types/avatar.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L32) - Known avatar provider identifiers shipped with NeuroLink. `(string & {})` keeps the union open for custom provider names diff --git a/docs/api/type-aliases/AvatarQuality.md b/docs/api/type-aliases/AvatarQuality.md index 60c52679f..a32b89b1b 100644 --- a/docs/api/type-aliases/AvatarQuality.md +++ b/docs/api/type-aliases/AvatarQuality.md @@ -8,8 +8,6 @@ > **AvatarQuality** = `"standard"` \| `"hd"` -Defined in: [types/avatar.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L24) - Quality presets for avatar generation. Provider-specific mappings: - D-ID: "standard" → 720p, "hd" → 1080p diff --git a/docs/api/type-aliases/AvatarResult.md b/docs/api/type-aliases/AvatarResult.md index 7f0a14971..fe9c9e895 100644 --- a/docs/api/type-aliases/AvatarResult.md +++ b/docs/api/type-aliases/AvatarResult.md @@ -8,8 +8,6 @@ > **AvatarResult** = `object` -Defined in: [types/avatar.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L87) - Result of an avatar generation request. ## Properties @@ -18,8 +16,6 @@ Result of an avatar generation request. > **buffer**: `Buffer` -Defined in: [types/avatar.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L89) - Generated video buffer. --- @@ -28,8 +24,6 @@ Generated video buffer. > **format**: [`AvatarVideoFormat`](AvatarVideoFormat.md) -Defined in: [types/avatar.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L91) - Output format. --- @@ -38,8 +32,6 @@ Output format. > **size**: `number` -Defined in: [types/avatar.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L93) - File size in bytes. --- @@ -48,8 +40,6 @@ File size in bytes. > `optional` **duration?**: `number` -Defined in: [types/avatar.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L95) - Duration in seconds (when reported by the provider). --- @@ -58,8 +48,6 @@ Duration in seconds (when reported by the provider). > `optional` **provider?**: `string` -Defined in: [types/avatar.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L97) - Provider used. --- @@ -68,8 +56,6 @@ Provider used. > `optional` **metadata?**: `object` -Defined in: [types/avatar.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L99) - Performance / request metadata. #### Index Signature diff --git a/docs/api/type-aliases/AvatarVideoFormat.md b/docs/api/type-aliases/AvatarVideoFormat.md index 2a4ccac8b..bfe424976 100644 --- a/docs/api/type-aliases/AvatarVideoFormat.md +++ b/docs/api/type-aliases/AvatarVideoFormat.md @@ -8,6 +8,4 @@ > **AvatarVideoFormat** = `"mp4"` \| `"webm"` \| `"mov"` -Defined in: [types/avatar.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L16) - Output formats for avatar videos. diff --git a/docs/api/type-aliases/AzureNBest.md b/docs/api/type-aliases/AzureNBest.md index 01661fc23..ae5cb85f8 100644 --- a/docs/api/type-aliases/AzureNBest.md +++ b/docs/api/type-aliases/AzureNBest.md @@ -8,52 +8,38 @@ > **AzureNBest** = `object` -Defined in: [types/stt.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L405) - ## Properties ### Confidence > **Confidence**: `number` -Defined in: [types/stt.ts:406](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L406) - --- ### Lexical > **Lexical**: `string` -Defined in: [types/stt.ts:407](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L407) - --- ### ITN > **ITN**: `string` -Defined in: [types/stt.ts:408](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L408) - --- ### MaskedITN > **MaskedITN**: `string` -Defined in: [types/stt.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L409) - --- ### Display > **Display**: `string` -Defined in: [types/stt.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L410) - --- ### Words? > `optional` **Words?**: [`AzureWord`](AzureWord.md)[] - -Defined in: [types/stt.ts:411](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L411) diff --git a/docs/api/type-aliases/AzureOutputFormat.md b/docs/api/type-aliases/AzureOutputFormat.md index 98fa1ede7..48f209450 100644 --- a/docs/api/type-aliases/AzureOutputFormat.md +++ b/docs/api/type-aliases/AzureOutputFormat.md @@ -7,5 +7,3 @@ # Type Alias: AzureOutputFormat > **AzureOutputFormat** = `"simple"` \| `"detailed"` - -Defined in: [types/stt.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L279) diff --git a/docs/api/type-aliases/AzureRecognitionMode.md b/docs/api/type-aliases/AzureRecognitionMode.md index 365d3ca52..c1f106c04 100644 --- a/docs/api/type-aliases/AzureRecognitionMode.md +++ b/docs/api/type-aliases/AzureRecognitionMode.md @@ -7,5 +7,3 @@ # Type Alias: AzureRecognitionMode > **AzureRecognitionMode** = `"interactive"` \| `"conversation"` \| `"dictation"` - -Defined in: [types/stt.ts:277](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L277) diff --git a/docs/api/type-aliases/AzureRecognitionResult.md b/docs/api/type-aliases/AzureRecognitionResult.md index 91fb75392..805a8884c 100644 --- a/docs/api/type-aliases/AzureRecognitionResult.md +++ b/docs/api/type-aliases/AzureRecognitionResult.md @@ -8,44 +8,32 @@ > **AzureRecognitionResult** = `object` -Defined in: [types/stt.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L414) - ## Properties ### RecognitionStatus > **RecognitionStatus**: `"Success"` \| `"NoMatch"` \| `"InitialSilenceTimeout"` \| `"BabbleTimeout"` \| `"Error"` \| `string` -Defined in: [types/stt.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L415) - --- ### Offset? > `optional` **Offset?**: `number` -Defined in: [types/stt.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L422) - --- ### Duration? > `optional` **Duration?**: `number` -Defined in: [types/stt.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L423) - --- ### DisplayText? > `optional` **DisplayText?**: `string` -Defined in: [types/stt.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L424) - --- ### NBest? > `optional` **NBest?**: [`AzureNBest`](AzureNBest.md)[] - -Defined in: [types/stt.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L425) diff --git a/docs/api/type-aliases/AzureSTTOptions.md b/docs/api/type-aliases/AzureSTTOptions.md index 195e40576..57d6efbc0 100644 --- a/docs/api/type-aliases/AzureSTTOptions.md +++ b/docs/api/type-aliases/AzureSTTOptions.md @@ -8,8 +8,6 @@ > **AzureSTTOptions** = [`STTOptions`](STTOptions.md) & `object` -Defined in: [types/stt.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L281) - ## Type Declaration ### recognitionMode? diff --git a/docs/api/type-aliases/AzureSpeakerRecognitionResult.md b/docs/api/type-aliases/AzureSpeakerRecognitionResult.md index c74f55ae3..a9ada658e 100644 --- a/docs/api/type-aliases/AzureSpeakerRecognitionResult.md +++ b/docs/api/type-aliases/AzureSpeakerRecognitionResult.md @@ -8,8 +8,6 @@ > **AzureSpeakerRecognitionResult** = [`AzureRecognitionResult`](AzureRecognitionResult.md) & `object` -Defined in: [types/stt.ts:428](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L428) - ## Type Declaration ### SpeakerId? diff --git a/docs/api/type-aliases/AzureTTSOptions.md b/docs/api/type-aliases/AzureTTSOptions.md index 2e4938e5a..e3c0caa79 100644 --- a/docs/api/type-aliases/AzureTTSOptions.md +++ b/docs/api/type-aliases/AzureTTSOptions.md @@ -8,8 +8,6 @@ > **AzureTTSOptions** = [`TTSOptions`](TTSOptions.md) & `object` -Defined in: [types/voice.ts:451](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L451) - ## Type Declaration ### useSSML? diff --git a/docs/api/type-aliases/AzureVoiceInfo.md b/docs/api/type-aliases/AzureVoiceInfo.md index bb266e5f6..cf2822de7 100644 --- a/docs/api/type-aliases/AzureVoiceInfo.md +++ b/docs/api/type-aliases/AzureVoiceInfo.md @@ -8,84 +8,62 @@ > **AzureVoiceInfo** = `object` -Defined in: [types/stt.ts:616](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L616) - ## Properties ### Name > **Name**: `string` -Defined in: [types/stt.ts:617](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L617) - --- ### DisplayName > **DisplayName**: `string` -Defined in: [types/stt.ts:618](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L618) - --- ### LocalName > **LocalName**: `string` -Defined in: [types/stt.ts:619](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L619) - --- ### ShortName > **ShortName**: `string` -Defined in: [types/stt.ts:620](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L620) - --- ### Gender > **Gender**: `string` -Defined in: [types/stt.ts:623](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L623) - --- ### Locale > **Locale**: `string` -Defined in: [types/stt.ts:624](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L624) - --- ### LocaleName > **LocaleName**: `string` -Defined in: [types/stt.ts:625](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L625) - --- ### VoiceType > **VoiceType**: `string` -Defined in: [types/stt.ts:626](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L626) - --- ### Status > **Status**: `string` -Defined in: [types/stt.ts:627](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L627) - --- ### WordsPerMinute? > `optional` **WordsPerMinute?**: `string` - -Defined in: [types/stt.ts:628](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L628) diff --git a/docs/api/type-aliases/AzureWord.md b/docs/api/type-aliases/AzureWord.md index 3fd70d72c..f7cd4b09f 100644 --- a/docs/api/type-aliases/AzureWord.md +++ b/docs/api/type-aliases/AzureWord.md @@ -8,36 +8,26 @@ > **AzureWord** = `object` -Defined in: [types/stt.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L398) - ## Properties ### Word > **Word**: `string` -Defined in: [types/stt.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L399) - --- ### Offset > **Offset**: `number` -Defined in: [types/stt.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L400) - --- ### Duration > **Duration**: `number` -Defined in: [types/stt.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L401) - --- ### Confidence? > `optional` **Confidence?**: `number` - -Defined in: [types/stt.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L402) diff --git a/docs/api/type-aliases/BM25Index.md b/docs/api/type-aliases/BM25Index.md index 1b9ff8840..5d80b43d0 100644 --- a/docs/api/type-aliases/BM25Index.md +++ b/docs/api/type-aliases/BM25Index.md @@ -8,8 +8,6 @@ > **BM25Index** = `object` -Defined in: [types/rag.ts:465](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L465) - BM25 Index type Implementations should provide sparse retrieval capabilities @@ -19,8 +17,6 @@ Implementations should provide sparse retrieval capabilities > **search**(`query`, `topK?`): `Promise`\<[`BM25Result`](BM25Result.md)[]\> -Defined in: [types/rag.ts:472](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L472) - Search documents using BM25 algorithm #### Parameters @@ -49,8 +45,6 @@ Array of BM25 results > **addDocuments**(`documents`): `Promise`\<`void`\> -Defined in: [types/rag.ts:478](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L478) - Add documents to the index #### Parameters diff --git a/docs/api/type-aliases/BM25Result.md b/docs/api/type-aliases/BM25Result.md index 814f5e3f9..ca041bfcd 100644 --- a/docs/api/type-aliases/BM25Result.md +++ b/docs/api/type-aliases/BM25Result.md @@ -8,8 +8,6 @@ > **BM25Result** = `object` -Defined in: [types/rag.ts:1324](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1324) - BM25 search result ## Properties @@ -18,8 +16,6 @@ BM25 search result > **id**: `string` -Defined in: [types/rag.ts:1326](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1326) - Document ID --- @@ -28,8 +24,6 @@ Document ID > **score**: `number` -Defined in: [types/rag.ts:1328](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1328) - BM25 score --- @@ -38,8 +32,6 @@ BM25 score > **text**: `string` -Defined in: [types/rag.ts:1330](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1330) - Document text --- @@ -48,6 +40,4 @@ Document text > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1332](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1332) - Associated metadata diff --git a/docs/api/type-aliases/BackgroundColors.md b/docs/api/type-aliases/BackgroundColors.md index a9f8b1b92..13a6c32c3 100644 --- a/docs/api/type-aliases/BackgroundColors.md +++ b/docs/api/type-aliases/BackgroundColors.md @@ -8,8 +8,6 @@ > **BackgroundColors** = `object` -Defined in: [types/ppt.ts:1282](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1282) - Theme colors extracted for background rendering ## Properties @@ -18,28 +16,20 @@ Theme colors extracted for background rendering > **primary**: `string` -Defined in: [types/ppt.ts:1283](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1283) - --- ### secondary > **secondary**: `string` -Defined in: [types/ppt.ts:1284](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1284) - --- ### accent > **accent**: `string` -Defined in: [types/ppt.ts:1285](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1285) - --- ### background > **background**: `string` - -Defined in: [types/ppt.ts:1286](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1286) diff --git a/docs/api/type-aliases/BackgroundCommandAllowDecision.md b/docs/api/type-aliases/BackgroundCommandAllowDecision.md index c4ef4259a..9aa66c6b9 100644 --- a/docs/api/type-aliases/BackgroundCommandAllowDecision.md +++ b/docs/api/type-aliases/BackgroundCommandAllowDecision.md @@ -8,6 +8,4 @@ > **BackgroundCommandAllowDecision** = `true` \| `string` -Defined in: [types/backgroundCommand.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L46) - `true` to allow, or a string giving the reason the command was refused. diff --git a/docs/api/type-aliases/BackgroundCommandCounts.md b/docs/api/type-aliases/BackgroundCommandCounts.md index 1fa096b04..61e7383af 100644 --- a/docs/api/type-aliases/BackgroundCommandCounts.md +++ b/docs/api/type-aliases/BackgroundCommandCounts.md @@ -8,8 +8,6 @@ > **BackgroundCommandCounts** = `object` -Defined in: [types/backgroundCommand.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L177) - Outstanding commands for a session: `running` have not settled yet, and `finished` have settled without anyone having looked at them since. @@ -28,12 +26,8 @@ Carried on every command tool result and — via the checklist — on every > **running**: `number` -Defined in: [types/backgroundCommand.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L177) - --- ### finished > **finished**: `number` - -Defined in: [types/backgroundCommand.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L177) diff --git a/docs/api/type-aliases/BackgroundCommandCountsSource.md b/docs/api/type-aliases/BackgroundCommandCountsSource.md index be48070aa..0516b579b 100644 --- a/docs/api/type-aliases/BackgroundCommandCountsSource.md +++ b/docs/api/type-aliases/BackgroundCommandCountsSource.md @@ -8,8 +8,6 @@ > **BackgroundCommandCountsSource** = (`sessionId`) => [`BackgroundCommandCounts`](BackgroundCommandCounts.md) -Defined in: [types/backgroundCommand.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L180) - Supplies [BackgroundCommandCounts](BackgroundCommandCounts.md) to the task checklist. ## Parameters diff --git a/docs/api/type-aliases/BackgroundCommandHandle.md b/docs/api/type-aliases/BackgroundCommandHandle.md index be8a2c9cc..849fd83f0 100644 --- a/docs/api/type-aliases/BackgroundCommandHandle.md +++ b/docs/api/type-aliases/BackgroundCommandHandle.md @@ -8,8 +8,6 @@ > **BackgroundCommandHandle** = `object` -Defined in: [types/backgroundCommand.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L107) - Returned the moment a command is accepted — before it has produced output. ## Properties @@ -18,20 +16,14 @@ Returned the moment a command is accepted — before it has produced output. > **taskId**: `string` -Defined in: [types/backgroundCommand.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L108) - --- ### argv > **argv**: `string`[] -Defined in: [types/backgroundCommand.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L109) - --- ### startedAt > **startedAt**: `number` - -Defined in: [types/backgroundCommand.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L110) diff --git a/docs/api/type-aliases/BackgroundCommandOptions.md b/docs/api/type-aliases/BackgroundCommandOptions.md index 3e1fb4bca..da9c8e6f4 100644 --- a/docs/api/type-aliases/BackgroundCommandOptions.md +++ b/docs/api/type-aliases/BackgroundCommandOptions.md @@ -8,8 +8,6 @@ > **BackgroundCommandOptions** = `object` -Defined in: [types/backgroundCommand.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L84) - Per-start options. Only `timeoutMs` and `maxOutputBytes` fall back to the policy's defaults. The rest have their own omission behaviour: `env` inherits the parent environment, `label` defaults to `argv[0]`, `sessionId` @@ -22,8 +20,6 @@ fallback. > **cwd**: `string` -Defined in: [types/backgroundCommand.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L86) - Working directory. Must resolve inside `BackgroundCommandPolicy.cwdRoot`. --- @@ -32,8 +28,6 @@ Working directory. Must resolve inside `BackgroundCommandPolicy.cwdRoot`. > `optional` **timeoutMs?**: `number` -Defined in: [types/backgroundCommand.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L88) - Wall-clock budget in ms; SIGTERM then SIGKILL. --- @@ -42,8 +36,6 @@ Wall-clock budget in ms; SIGTERM then SIGKILL. > `optional` **maxOutputBytes?**: `number` -Defined in: [types/backgroundCommand.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L90) - Per-stream byte cap; hitting it kills the command with `output-limit`. --- @@ -52,8 +44,6 @@ Per-stream byte cap; hitting it kills the command with `output-limit`. > `optional` **env?**: `Record`\<`string`, `string`\> -Defined in: [types/backgroundCommand.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L97) - Environment for the child. When given it REPLACES the parent environment rather than extending it — the command gets exactly these variables and nothing else. Omit it to inherit the parent environment, which is what a @@ -65,8 +55,6 @@ repository's own checks normally need. > `optional` **label?**: `string` -Defined in: [types/backgroundCommand.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L99) - Short human label for logs and the banked artifacts. Defaults to argv[0]. --- @@ -75,8 +63,6 @@ Short human label for logs and the banked artifacts. Defaults to argv[0]. > `optional` **sessionId?**: `string` -Defined in: [types/backgroundCommand.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L101) - Session the command belongs to; scopes the outstanding counters. --- @@ -85,6 +71,4 @@ Session the command belongs to; scopes the outstanding counters. > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/backgroundCommand.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L103) - Parent cancellation — an aborted parent kills the command. diff --git a/docs/api/type-aliases/BackgroundCommandOutputPage.md b/docs/api/type-aliases/BackgroundCommandOutputPage.md index cdafd4d82..73a8c61c6 100644 --- a/docs/api/type-aliases/BackgroundCommandOutputPage.md +++ b/docs/api/type-aliases/BackgroundCommandOutputPage.md @@ -8,8 +8,6 @@ > **BackgroundCommandOutputPage** = `object` -Defined in: [types/backgroundCommand.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L144) - One character window of a command's output, read straight from the log file. ## Properties @@ -18,48 +16,36 @@ One character window of a command's output, read straight from the log file. > **taskId**: `string` -Defined in: [types/backgroundCommand.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L145) - --- ### stream > **stream**: [`BackgroundCommandStreamName`](BackgroundCommandStreamName.md) -Defined in: [types/backgroundCommand.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L146) - --- ### content > **content**: `string` -Defined in: [types/backgroundCommand.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L147) - --- ### offset > **offset**: `number` -Defined in: [types/backgroundCommand.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L148) - --- ### limit > **limit**: `number` -Defined in: [types/backgroundCommand.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L149) - --- ### totalSize > **totalSize**: `number` -Defined in: [types/backgroundCommand.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L151) - Characters in the whole stream, including what this page did not return. --- @@ -67,5 +53,3 @@ Characters in the whole stream, including what this page did not return. ### hasMore > **hasMore**: `boolean` - -Defined in: [types/backgroundCommand.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L152) diff --git a/docs/api/type-aliases/BackgroundCommandPageRequest.md b/docs/api/type-aliases/BackgroundCommandPageRequest.md index c8360cc8a..976218dce 100644 --- a/docs/api/type-aliases/BackgroundCommandPageRequest.md +++ b/docs/api/type-aliases/BackgroundCommandPageRequest.md @@ -8,8 +8,6 @@ > **BackgroundCommandPageRequest** = `object` -Defined in: [types/backgroundCommand.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L156) - Character window for a paginated output read. ## Properties @@ -18,16 +16,12 @@ Character window for a paginated output read. > **stream**: [`BackgroundCommandStreamName`](BackgroundCommandStreamName.md) -Defined in: [types/backgroundCommand.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L157) - --- ### offset? > `optional` **offset?**: `number` -Defined in: [types/backgroundCommand.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L159) - Character offset to start at. Default 0. --- @@ -36,6 +30,4 @@ Character offset to start at. Default 0. > `optional` **limit?**: `number` -Defined in: [types/backgroundCommand.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L161) - Maximum characters to return. Default 50_000, hard cap 200_000. diff --git a/docs/api/type-aliases/BackgroundCommandPolicy.md b/docs/api/type-aliases/BackgroundCommandPolicy.md index ac3590572..5e0c018d7 100644 --- a/docs/api/type-aliases/BackgroundCommandPolicy.md +++ b/docs/api/type-aliases/BackgroundCommandPolicy.md @@ -8,8 +8,6 @@ > **BackgroundCommandPolicy** = `object` -Defined in: [types/backgroundCommand.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L53) - What a host permits. There is no default policy: without one every start is refused, because "run whatever the model asks" is not a defensible default for a primitive that executes processes. @@ -20,8 +18,6 @@ for a primitive that executes processes. > **allowedExecutables**: `string`[] -Defined in: [types/backgroundCommand.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L59) - Executables that may be started, matched EXACTLY against `argv[0]` — no basename fallback, so allowlisting `git` never permits `/tmp/evil/git`. Required, and an empty list refuses everything. @@ -32,8 +28,6 @@ Required, and an empty list refuses everything. > `optional` **allowlist?**: (`argv`, `cwd`) => [`BackgroundCommandAllowDecision`](BackgroundCommandAllowDecision.md) -Defined in: [types/backgroundCommand.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L65) - Final say after the allowlist and the sandbox have passed. Return `true` to allow, or a string that is handed to the caller as the refusal reason (so put the recovery step in it). @@ -58,8 +52,6 @@ to allow, or a string that is handed to the caller as the refusal reason > **cwdRoot**: `string` -Defined in: [types/backgroundCommand.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L70) - Sandbox root. The resolved REAL cwd (symlinks followed) must be this directory or inside it. @@ -69,8 +61,6 @@ directory or inside it. > `optional` **defaultTimeoutMs?**: `number` -Defined in: [types/backgroundCommand.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L72) - Wall-clock budget when the caller names none. Default 120_000. --- @@ -79,6 +69,4 @@ Wall-clock budget when the caller names none. Default 120_000. > `optional` **maxOutputBytes?**: `number` -Defined in: [types/backgroundCommand.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L74) - Per-stream byte cap when the caller names none. Default 10_485_760. diff --git a/docs/api/type-aliases/BackgroundCommandRefusal.md b/docs/api/type-aliases/BackgroundCommandRefusal.md index cb2f7b461..7de69cf1c 100644 --- a/docs/api/type-aliases/BackgroundCommandRefusal.md +++ b/docs/api/type-aliases/BackgroundCommandRefusal.md @@ -8,8 +8,6 @@ > **BackgroundCommandRefusal** = `object` -Defined in: [types/backgroundCommand.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L193) - Refusal shape shared with the agent tool registrar: recovery text included. ## Properties @@ -18,12 +16,8 @@ Refusal shape shared with the agent tool registrar: recovery text included. > **isError**: `true` -Defined in: [types/backgroundCommand.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L193) - --- ### error > **error**: `string` - -Defined in: [types/backgroundCommand.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L193) diff --git a/docs/api/type-aliases/BackgroundCommandStartToolResult.md b/docs/api/type-aliases/BackgroundCommandStartToolResult.md index ff37362bf..ecaab0ac4 100644 --- a/docs/api/type-aliases/BackgroundCommandStartToolResult.md +++ b/docs/api/type-aliases/BackgroundCommandStartToolResult.md @@ -8,6 +8,4 @@ > **BackgroundCommandStartToolResult** = [`BackgroundCommandHandle`](BackgroundCommandHandle.md) & [`BackgroundCommandCounts`](BackgroundCommandCounts.md) -Defined in: [types/backgroundCommand.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L185) - What `run_command_bg` returns: the handle plus the outstanding counters. diff --git a/docs/api/type-aliases/BackgroundCommandState.md b/docs/api/type-aliases/BackgroundCommandState.md index 3bd0fe90c..cb6ff8fe5 100644 --- a/docs/api/type-aliases/BackgroundCommandState.md +++ b/docs/api/type-aliases/BackgroundCommandState.md @@ -8,8 +8,6 @@ > **BackgroundCommandState** = `"queued"` \| `"running"` \| `"exited"` \| `"killed"` \| `"timeout"` \| `"output-limit"` -Defined in: [types/backgroundCommand.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L37) - Lifecycle of one background command. `queued` is the window between the handle being returned and the OS diff --git a/docs/api/type-aliases/BackgroundCommandStatus.md b/docs/api/type-aliases/BackgroundCommandStatus.md index e94554b3a..e9cc97873 100644 --- a/docs/api/type-aliases/BackgroundCommandStatus.md +++ b/docs/api/type-aliases/BackgroundCommandStatus.md @@ -8,8 +8,6 @@ > **BackgroundCommandStatus** = `object` -Defined in: [types/backgroundCommand.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L120) - Everything known about one command right now. `stdout` / `stderr` appear once the command has settled and its streams have @@ -22,16 +20,12 @@ The preview is for orientation — the banked artifacts are the evidence. > **taskId**: `string` -Defined in: [types/backgroundCommand.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L121) - --- ### label > **label**: `string` -Defined in: [types/backgroundCommand.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L123) - Short human label, e.g. "git log" — which command this is. --- @@ -40,16 +34,12 @@ Short human label, e.g. "git log" — which command this is. > **state**: [`BackgroundCommandState`](BackgroundCommandState.md) -Defined in: [types/backgroundCommand.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L124) - --- ### exitCode? > `optional` **exitCode?**: `number` -Defined in: [types/backgroundCommand.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L126) - Process exit code, once it exited on its own. --- @@ -58,8 +48,6 @@ Process exit code, once it exited on its own. > `optional` **signal?**: `string` -Defined in: [types/backgroundCommand.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L128) - Signal that ended the process, when one did. --- @@ -68,16 +56,12 @@ Signal that ended the process, when one did. > **durationMs**: `number` -Defined in: [types/backgroundCommand.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L129) - --- ### stdoutBytes > **stdoutBytes**: `number` -Defined in: [types/backgroundCommand.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L131) - Bytes written to each stream's log file so far. --- @@ -86,16 +70,12 @@ Bytes written to each stream's log file so far. > **stderrBytes**: `number` -Defined in: [types/backgroundCommand.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L132) - --- ### stdout? > `optional` **stdout?**: [`BankedArtifactRef`](BankedArtifactRef.md) -Defined in: [types/backgroundCommand.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L134) - The FULL stdout, banked (N3). Present once settled. --- @@ -104,8 +84,6 @@ The FULL stdout, banked (N3). Present once settled. > `optional` **stderr?**: [`BankedArtifactRef`](BankedArtifactRef.md) -Defined in: [types/backgroundCommand.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L136) - The FULL stderr, banked (N3). Present once settled. --- @@ -114,8 +92,6 @@ The FULL stderr, banked (N3). Present once settled. > **tailPreview**: `string` -Defined in: [types/backgroundCommand.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L138) - Tail of the output so far, ≤ 2000 chars. Never a substitute for the files. --- @@ -124,6 +100,4 @@ Tail of the output so far, ≤ 2000 chars. Never a substitute for the files. > `optional` **error?**: `string` -Defined in: [types/backgroundCommand.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L140) - Why the command could not run, or how it was cut short. diff --git a/docs/api/type-aliases/BackgroundCommandStatusToolResult.md b/docs/api/type-aliases/BackgroundCommandStatusToolResult.md index 51d431ebc..8c955c153 100644 --- a/docs/api/type-aliases/BackgroundCommandStatusToolResult.md +++ b/docs/api/type-aliases/BackgroundCommandStatusToolResult.md @@ -8,6 +8,4 @@ > **BackgroundCommandStatusToolResult** = [`BackgroundCommandStatus`](BackgroundCommandStatus.md) & [`BackgroundCommandCounts`](BackgroundCommandCounts.md) -Defined in: [types/backgroundCommand.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L189) - What the monitor tools return: a status plus the outstanding counters. diff --git a/docs/api/type-aliases/BackgroundCommandStreamName.md b/docs/api/type-aliases/BackgroundCommandStreamName.md index 363194c03..6a5932f0c 100644 --- a/docs/api/type-aliases/BackgroundCommandStreamName.md +++ b/docs/api/type-aliases/BackgroundCommandStreamName.md @@ -8,6 +8,4 @@ > **BackgroundCommandStreamName** = `"stdout"` \| `"stderr"` -Defined in: [types/backgroundCommand.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/backgroundCommand.ts#L26) - Which of a command's two output streams a page or artifact refers to. diff --git a/docs/api/type-aliases/BackgroundStyle.md b/docs/api/type-aliases/BackgroundStyle.md index 67cb3f2dd..648891ef8 100644 --- a/docs/api/type-aliases/BackgroundStyle.md +++ b/docs/api/type-aliases/BackgroundStyle.md @@ -8,6 +8,4 @@ > **BackgroundStyle** = `"gradient-blue"` \| `"gradient-corporate"` \| `"gradient-warm"` \| `"gradient-dark"` \| `"gradient-subtle"` \| `"geometric"` \| `"corner-accent"` \| `"wave"` \| `"split"` \| `"solid"` -Defined in: [types/ppt.ts:1269](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1269) - Background style options diff --git a/docs/api/type-aliases/BackupInfo.md b/docs/api/type-aliases/BackupInfo.md index 66ff71a82..0902d1ad3 100644 --- a/docs/api/type-aliases/BackupInfo.md +++ b/docs/api/type-aliases/BackupInfo.md @@ -8,8 +8,6 @@ > **BackupInfo** = `object` -Defined in: [types/config.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L467) - Backup metadata information ## Properties @@ -18,28 +16,20 @@ Backup metadata information > **filename**: `string` -Defined in: [types/config.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L468) - --- ### path > **path**: `string` -Defined in: [types/config.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L469) - --- ### metadata > **metadata**: [`BackupMetadata`](BackupMetadata.md) -Defined in: [types/config.ts:470](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L470) - --- ### config > **config**: [`NeuroLinkConfig`](NeuroLinkConfig.md) - -Defined in: [types/config.ts:471](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L471) diff --git a/docs/api/type-aliases/BackupMetadata.md b/docs/api/type-aliases/BackupMetadata.md index 9f1149f31..c28bb0546 100644 --- a/docs/api/type-aliases/BackupMetadata.md +++ b/docs/api/type-aliases/BackupMetadata.md @@ -8,8 +8,6 @@ > **BackupMetadata** = `object` -Defined in: [types/config.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L477) - Backup metadata ## Properties @@ -18,52 +16,38 @@ Backup metadata > **reason**: `string` -Defined in: [types/config.ts:478](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L478) - --- ### timestamp > **timestamp**: `number` -Defined in: [types/config.ts:479](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L479) - --- ### version > **version**: `string` -Defined in: [types/config.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L480) - --- ### originalPath > **originalPath**: `string` -Defined in: [types/config.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L481) - --- ### hash? > `optional` **hash?**: `string` -Defined in: [types/config.ts:482](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L482) - --- ### size? > `optional` **size?**: `number` -Defined in: [types/config.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L483) - --- ### createdBy? > `optional` **createdBy?**: `string` - -Defined in: [types/config.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L484) diff --git a/docs/api/type-aliases/BadWordsConfig.md b/docs/api/type-aliases/BadWordsConfig.md index 3124d54c3..ceb7694bf 100644 --- a/docs/api/type-aliases/BadWordsConfig.md +++ b/docs/api/type-aliases/BadWordsConfig.md @@ -8,40 +8,30 @@ > **BadWordsConfig** = `object` -Defined in: [types/guardrails.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L88) - ## Properties ### enabled? > `optional` **enabled?**: `boolean` -Defined in: [types/guardrails.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L89) - --- ### list? > `optional` **list?**: `string`[] -Defined in: [types/guardrails.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L90) - --- ### regexPatterns? > `optional` **regexPatterns?**: `string`[] -Defined in: [types/guardrails.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L91) - --- ### replacementText? > `optional` **replacementText?**: `string` -Defined in: [types/guardrails.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L102) - Text to use when replacing filtered content. #### Default diff --git a/docs/api/type-aliases/BankArtifactOptions.md b/docs/api/type-aliases/BankArtifactOptions.md index 6b20aacd7..13ee74c88 100644 --- a/docs/api/type-aliases/BankArtifactOptions.md +++ b/docs/api/type-aliases/BankArtifactOptions.md @@ -8,8 +8,6 @@ > **BankArtifactOptions** = `object` -Defined in: [types/artifact.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L67) - How to bank one payload. Only `kind` and `label` are required. ## Properties @@ -18,8 +16,6 @@ How to bank one payload. Only `kind` and `label` are required. > **kind**: [`BankedArtifactKind`](BankedArtifactKind.md) -Defined in: [types/artifact.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L69) - What this payload is. --- @@ -28,8 +24,6 @@ What this payload is. > **label**: `string` -Defined in: [types/artifact.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L71) - Short human label, e.g. "delegate:auth-review" — shown in logs. --- @@ -38,8 +32,6 @@ Short human label, e.g. "delegate:auth-review" — shown in logs. > `optional` **sessionId?**: `string` -Defined in: [types/artifact.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L73) - Session the payload belongs to, recorded on the artifact metadata. --- @@ -48,8 +40,6 @@ Session the payload belongs to, recorded on the artifact metadata. > `optional` **contentType?**: `"json"` \| `"text"` -Defined in: [types/artifact.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L75) - Payload shape; decides the on-disk extension. Default "text". --- @@ -58,6 +48,4 @@ Payload shape; decides the on-disk extension. Default "text". > `optional` **previewChars?**: `number` -Defined in: [types/artifact.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L77) - Preview length in characters. Default 1000, hard cap 4000. diff --git a/docs/api/type-aliases/BankedArtifactKind.md b/docs/api/type-aliases/BankedArtifactKind.md index 8bcece239..f843d1ff5 100644 --- a/docs/api/type-aliases/BankedArtifactKind.md +++ b/docs/api/type-aliases/BankedArtifactKind.md @@ -8,7 +8,5 @@ > **BankedArtifactKind** = `"worker-report"` \| `"command-output"` \| `"stage-output"` \| `"other"` -Defined in: [types/artifact.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L60) - What a banked payload is, so previews and logs can say so without the caller re-explaining itself. "other" is the escape hatch, not the default. diff --git a/docs/api/type-aliases/BankedArtifactRef.md b/docs/api/type-aliases/BankedArtifactRef.md index 0552b2111..17f3607e0 100644 --- a/docs/api/type-aliases/BankedArtifactRef.md +++ b/docs/api/type-aliases/BankedArtifactRef.md @@ -8,8 +8,6 @@ > **BankedArtifactRef** = `object` -Defined in: [types/artifact.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L85) - What the conversation gets instead of the payload: an id, a bounded head slice, and the exact call that reads the rest. The FULL payload is always on disk — a preview is a pointer, never a replacement. @@ -20,8 +18,6 @@ disk — a preview is a pointer, never a replacement. > **artifactId**: `string` -Defined in: [types/artifact.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L87) - Id to pass to `retrieve_context({ artifactId })`. --- @@ -30,24 +26,18 @@ Id to pass to `retrieve_context({ artifactId })`. > **label**: `string` -Defined in: [types/artifact.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L88) - --- ### kind > **kind**: [`BankedArtifactKind`](BankedArtifactKind.md) -Defined in: [types/artifact.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L89) - --- ### sizeBytes > **sizeBytes**: `number` -Defined in: [types/artifact.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L91) - UTF-8 byte size of the complete payload. --- @@ -56,8 +46,6 @@ UTF-8 byte size of the complete payload. > **preview**: `string` -Defined in: [types/artifact.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L93) - Bounded head slice of the payload (characters, not bytes). --- @@ -66,6 +54,4 @@ Bounded head slice of the payload (characters, not bytes). > **readBackHint**: `string` -Defined in: [types/artifact.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L95) - Literal read-back call, so the model never has to guess the tool. diff --git a/docs/api/type-aliases/BaseAuthProviderConfig.md b/docs/api/type-aliases/BaseAuthProviderConfig.md index 850967922..2af77e20f 100644 --- a/docs/api/type-aliases/BaseAuthProviderConfig.md +++ b/docs/api/type-aliases/BaseAuthProviderConfig.md @@ -8,8 +8,6 @@ > **BaseAuthProviderConfig** = `object` -Defined in: [types/auth.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L398) - Base authentication provider configuration. Contains the common fields shared by every provider-specific config variant. @@ -21,8 +19,6 @@ Provider-specific fields are added via intersection in [AuthProviderConfig](Auth > **type**: [`AuthProviderType`](AuthProviderType.md) -Defined in: [types/auth.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L400) - Provider type --- @@ -31,8 +27,6 @@ Provider type > `optional` **required?**: `boolean` -Defined in: [types/auth.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L402) - Whether authentication is required --- @@ -41,8 +35,6 @@ Whether authentication is required > `optional` **debug?**: `boolean` -Defined in: [types/auth.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L404) - Enable debug logging --- @@ -51,8 +43,6 @@ Enable debug logging > `optional` **tokenValidation?**: [`TokenValidationConfig`](TokenValidationConfig.md) -Defined in: [types/auth.ts:406](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L406) - Custom token validation options --- @@ -61,8 +51,6 @@ Custom token validation options > `optional` **tokenExtraction?**: [`TokenExtractionStrategy`](TokenExtractionStrategy.md) -Defined in: [types/auth.ts:408](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L408) - Token extraction strategy --- @@ -71,8 +59,6 @@ Token extraction strategy > `optional` **session?**: [`SessionConfig`](SessionConfig.md) -Defined in: [types/auth.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L410) - Session configuration --- @@ -81,8 +67,6 @@ Session configuration > `optional` **rbac?**: [`RBACConfig`](RBACConfig.md) -Defined in: [types/auth.ts:412](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L412) - RBAC configuration --- @@ -91,8 +75,6 @@ RBAC configuration > `optional` **cache?**: [`AuthCacheConfig`](AuthCacheConfig.md) -Defined in: [types/auth.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L414) - Cache configuration --- @@ -101,6 +83,4 @@ Cache configuration > `optional` **options?**: [`UnknownRecord`](UnknownRecord.md) -Defined in: [types/auth.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L416) - Provider-specific options (generic extensibility point) diff --git a/docs/api/type-aliases/BaseChunkerConfig.md b/docs/api/type-aliases/BaseChunkerConfig.md index 8ebea2774..7fe5a77d5 100644 --- a/docs/api/type-aliases/BaseChunkerConfig.md +++ b/docs/api/type-aliases/BaseChunkerConfig.md @@ -8,8 +8,6 @@ > **BaseChunkerConfig** = `object` -Defined in: [types/rag.ts:886](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L886) - Base configuration for all chunkers ## Properties @@ -18,8 +16,6 @@ Base configuration for all chunkers > `optional` **maxSize?**: `number` -Defined in: [types/rag.ts:888](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L888) - Maximum chunk size (interpretation varies by strategy) --- @@ -28,8 +24,6 @@ Maximum chunk size (interpretation varies by strategy) > `optional` **minSize?**: `number` -Defined in: [types/rag.ts:890](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L890) - Minimum chunk size --- @@ -38,8 +32,6 @@ Minimum chunk size > `optional` **overlap?**: `number` -Defined in: [types/rag.ts:892](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L892) - Overlap between consecutive chunks --- @@ -48,8 +40,6 @@ Overlap between consecutive chunks > `optional` **trimWhitespace?**: `boolean` -Defined in: [types/rag.ts:894](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L894) - Whether to trim whitespace from chunks --- @@ -58,8 +48,6 @@ Whether to trim whitespace from chunks > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:896](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L896) - Custom metadata to add to all chunks --- @@ -68,6 +56,4 @@ Custom metadata to add to all chunks > `optional` **preserveMetadata?**: `boolean` -Defined in: [types/rag.ts:898](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L898) - Whether to preserve metadata from source document diff --git a/docs/api/type-aliases/BaseCommandArgs.md b/docs/api/type-aliases/BaseCommandArgs.md index b7c35944a..6caca540a 100644 --- a/docs/api/type-aliases/BaseCommandArgs.md +++ b/docs/api/type-aliases/BaseCommandArgs.md @@ -8,8 +8,6 @@ > **BaseCommandArgs** = `object` -Defined in: [types/cli.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L46) - Base command arguments type ## Indexable @@ -24,8 +22,6 @@ Index signature to allow additional properties > `optional` **debug?**: `boolean` -Defined in: [types/cli.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L48) - Enable debug output --- @@ -34,8 +30,6 @@ Enable debug output > `optional` **format?**: `"text"` \| `"json"` \| `"table"` \| `"yaml"` -Defined in: [types/cli.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L50) - Output format --- @@ -44,8 +38,6 @@ Output format > `optional` **verbose?**: `boolean` -Defined in: [types/cli.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L52) - Verbose output --- @@ -54,6 +46,4 @@ Verbose output > `optional` **quiet?**: `boolean` -Defined in: [types/cli.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L54) - Quiet mode diff --git a/docs/api/type-aliases/BaseContext.md b/docs/api/type-aliases/BaseContext.md index 5d20901b9..ba5db87f5 100644 --- a/docs/api/type-aliases/BaseContext.md +++ b/docs/api/type-aliases/BaseContext.md @@ -8,8 +8,6 @@ > **BaseContext** = `object` -Defined in: [types/context.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L14) - Base context type for all AI operations ## Indexable @@ -22,56 +20,42 @@ Base context type for all AI operations > `optional` **userId?**: `string` -Defined in: [types/context.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L16) - --- ### sessionId? > `optional` **sessionId?**: `string` -Defined in: [types/context.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L17) - --- ### requestId? > `optional` **requestId?**: `string` -Defined in: [types/context.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L18) - --- ### userRole? > `optional` **userRole?**: `string` -Defined in: [types/context.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L21) - --- ### userPreferences? > `optional` **userPreferences?**: [`JsonObject`](JsonObject.md) -Defined in: [types/context.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L22) - --- ### userMetadata? > `optional` **userMetadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/context.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L23) - --- ### applicationContext? > `optional` **applicationContext?**: `object` -Defined in: [types/context.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L26) - #### name > **name**: `string` @@ -90,20 +74,14 @@ Defined in: [types/context.ts:26](https://github.com/juspay/neurolink/blob/relea > `optional` **organizationId?**: `string` -Defined in: [types/context.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L33) - --- ### departmentId? > `optional` **departmentId?**: `string` -Defined in: [types/context.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L34) - --- ### projectId? > `optional` **projectId?**: `string` - -Defined in: [types/context.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L35) diff --git a/docs/api/type-aliases/BaseEvaluateArgs.md b/docs/api/type-aliases/BaseEvaluateArgs.md index a38c13f03..b880a12b4 100644 --- a/docs/api/type-aliases/BaseEvaluateArgs.md +++ b/docs/api/type-aliases/BaseEvaluateArgs.md @@ -8,8 +8,6 @@ > **BaseEvaluateArgs** = `object` -Defined in: [types/cli.ts:1579](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1579) - Base options shared across all `neurolink evaluate` subcommands. ## Properties @@ -18,20 +16,14 @@ Base options shared across all `neurolink evaluate` subcommands. > `optional` **json?**: `boolean` -Defined in: [types/cli.ts:1580](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1580) - --- ### verbose? > `optional` **verbose?**: `boolean` -Defined in: [types/cli.ts:1581](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1581) - --- ### format? > `optional` **format?**: `"text"` \| `"json"` \| `"table"` - -Defined in: [types/cli.ts:1582](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1582) diff --git a/docs/api/type-aliases/BaseExtractorConfig.md b/docs/api/type-aliases/BaseExtractorConfig.md index 9c8e56edc..ce2af47ba 100644 --- a/docs/api/type-aliases/BaseExtractorConfig.md +++ b/docs/api/type-aliases/BaseExtractorConfig.md @@ -8,8 +8,6 @@ > **BaseExtractorConfig** = `object` -Defined in: [types/rag.ts:1085](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1085) - Base configuration for metadata extractors ## Properties @@ -18,8 +16,6 @@ Base configuration for metadata extractors > `optional` **modelName?**: `string` -Defined in: [types/rag.ts:1087](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1087) - Language model to use for extraction --- @@ -28,8 +24,6 @@ Language model to use for extraction > `optional` **provider?**: `string` -Defined in: [types/rag.ts:1089](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1089) - Provider for the model --- @@ -38,8 +32,6 @@ Provider for the model > `optional` **promptTemplate?**: `string` -Defined in: [types/rag.ts:1091](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1091) - Custom prompt template --- @@ -48,8 +40,6 @@ Custom prompt template > `optional` **maxTokens?**: `number` -Defined in: [types/rag.ts:1093](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1093) - Maximum tokens for LLM response --- @@ -58,6 +48,4 @@ Maximum tokens for LLM response > `optional` **temperature?**: `number` -Defined in: [types/rag.ts:1095](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1095) - Temperature for LLM generation diff --git a/docs/api/type-aliases/BaseToolArgs.md b/docs/api/type-aliases/BaseToolArgs.md index e807d03c5..0c04d52c4 100644 --- a/docs/api/type-aliases/BaseToolArgs.md +++ b/docs/api/type-aliases/BaseToolArgs.md @@ -8,8 +8,6 @@ > **BaseToolArgs** = `object` -Defined in: [types/tools.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L58) - Standard tool input parameters ## Index Signature diff --git a/docs/api/type-aliases/BashToolResult.md b/docs/api/type-aliases/BashToolResult.md index c02986305..f2a5243d8 100644 --- a/docs/api/type-aliases/BashToolResult.md +++ b/docs/api/type-aliases/BashToolResult.md @@ -8,8 +8,6 @@ > **BashToolResult** = `object` -Defined in: [types/tools.ts:689](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L689) - Result shape returned by the built-in `bashTool` execute function in `src/lib/agent/directTools.ts`. Centralised here per CLAUDE.md rule 2 so callers (incl. the mcp-bash test suite) don't need to declare a @@ -21,36 +19,26 @@ local re-shaping of the runtime contract. > **success**: `boolean` -Defined in: [types/tools.ts:690](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L690) - --- ### code > **code**: `number` -Defined in: [types/tools.ts:691](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L691) - --- ### stdout > **stdout**: `string` -Defined in: [types/tools.ts:692](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L692) - --- ### stderr > **stderr**: `string` -Defined in: [types/tools.ts:693](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L693) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/tools.ts:694](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L694) diff --git a/docs/api/type-aliases/BasicContext.md b/docs/api/type-aliases/BasicContext.md index 5fbb861ab..1839cf594 100644 --- a/docs/api/type-aliases/BasicContext.md +++ b/docs/api/type-aliases/BasicContext.md @@ -8,8 +8,6 @@ > **BasicContext** = `object` -Defined in: [types/aliases.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L223) - Basic execution context Minimal context for tool execution @@ -19,20 +17,14 @@ Minimal context for tool execution > `optional` **sessionId?**: `string` -Defined in: [types/aliases.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L224) - --- ### userId? > `optional` **userId?**: `string` -Defined in: [types/aliases.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L225) - --- ### timestamp? > `optional` **timestamp?**: `number` - -Defined in: [types/aliases.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L226) diff --git a/docs/api/type-aliases/BasicToolsMap.md b/docs/api/type-aliases/BasicToolsMap.md index aa583cd38..29f72905a 100644 --- a/docs/api/type-aliases/BasicToolsMap.md +++ b/docs/api/type-aliases/BasicToolsMap.md @@ -8,8 +8,6 @@ > **BasicToolsMap** = `object` -Defined in: [types/tools.ts:512](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L512) - Subset of directAgentTools exposing only the "basic" category. ## Properties @@ -18,12 +16,8 @@ Subset of directAgentTools exposing only the "basic" category. > **getCurrentTime**: [`Tool`](Tool.md) -Defined in: [types/tools.ts:513](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L513) - --- ### calculateMath > **calculateMath**: [`Tool`](Tool.md) - -Defined in: [types/tools.ts:514](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L514) diff --git a/docs/api/type-aliases/BatchCommandArgs.md b/docs/api/type-aliases/BatchCommandArgs.md index 1f2d71f5f..e7d7a0383 100644 --- a/docs/api/type-aliases/BatchCommandArgs.md +++ b/docs/api/type-aliases/BatchCommandArgs.md @@ -8,8 +8,6 @@ > **BatchCommandArgs** = [`BaseCommandArgs`](BaseCommandArgs.md) & [`CliToolRoutingFlags`](CliToolRoutingFlags.md) & [`CliClassifierRouterFlags`](CliClassifierRouterFlags.md) & `object` -Defined in: [types/cli.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L168) - Batch command arguments ## Type Declaration diff --git a/docs/api/type-aliases/BatchConfig.md b/docs/api/type-aliases/BatchConfig.md index c54576f84..ecb92d43c 100644 --- a/docs/api/type-aliases/BatchConfig.md +++ b/docs/api/type-aliases/BatchConfig.md @@ -8,8 +8,6 @@ > **BatchConfig** = `object` -Defined in: [types/mcp.ts:2316](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2316) - Batch configuration options ## Properties @@ -18,8 +16,6 @@ Batch configuration options > **maxBatchSize**: `number` -Defined in: [types/mcp.ts:2320](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2320) - Maximum number of requests to batch together (default: 10) --- @@ -28,8 +24,6 @@ Maximum number of requests to batch together (default: 10) > **maxWaitMs**: `number` -Defined in: [types/mcp.ts:2325](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2325) - Maximum time to wait for a full batch in milliseconds (default: 100ms) --- @@ -38,8 +32,6 @@ Maximum time to wait for a full batch in milliseconds (default: 100ms) > `optional` **enableParallel?**: `boolean` -Defined in: [types/mcp.ts:2331](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2331) - Enable parallel execution of batched requests (default: true). Reserved for future parallel batch execution; currently stored but not read. @@ -49,8 +41,6 @@ Reserved for future parallel batch execution; currently stored but not read. > `optional` **maxConcurrentBatches?**: `number` -Defined in: [types/mcp.ts:2336](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2336) - Maximum concurrent batches in flight (default: 5) --- @@ -59,6 +49,4 @@ Maximum concurrent batches in flight (default: 5) > `optional` **groupByServer?**: `boolean` -Defined in: [types/mcp.ts:2341](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2341) - Group requests by server ID (default: true) diff --git a/docs/api/type-aliases/BatchEvaluationConfig.md b/docs/api/type-aliases/BatchEvaluationConfig.md index 402f9727a..39ec276a2 100644 --- a/docs/api/type-aliases/BatchEvaluationConfig.md +++ b/docs/api/type-aliases/BatchEvaluationConfig.md @@ -8,8 +8,6 @@ > **BatchEvaluationConfig** = [`EvaluationConfig`](EvaluationConfig.md) & `object` -Defined in: [types/evaluation.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L434) - Superset batch evaluation config. Union of pre-consolidation types (BatchEvaluationConfig in BatchEvaluator, BatchConfig in batchStrategy). diff --git a/docs/api/type-aliases/BatchEvaluationItem.md b/docs/api/type-aliases/BatchEvaluationItem.md index d909d38e6..2b40bb561 100644 --- a/docs/api/type-aliases/BatchEvaluationItem.md +++ b/docs/api/type-aliases/BatchEvaluationItem.md @@ -8,8 +8,6 @@ > **BatchEvaluationItem** = `object` -Defined in: [types/evaluation.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L400) - Input item for BatchEvaluator. ## Properties @@ -18,28 +16,20 @@ Input item for BatchEvaluator. > **id**: `string` -Defined in: [types/evaluation.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L401) - --- ### options > **options**: [`LanguageModelV3CallOptions`](LanguageModelV3CallOptions.md) -Defined in: [types/evaluation.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L402) - --- ### result > **result**: [`GenerateResult`](GenerateResult.md) -Defined in: [types/evaluation.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L403) - --- ### threshold? > `optional` **threshold?**: `number` - -Defined in: [types/evaluation.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L404) diff --git a/docs/api/type-aliases/BatchEvaluationItemResult.md b/docs/api/type-aliases/BatchEvaluationItemResult.md index 9ddbfa636..885615c59 100644 --- a/docs/api/type-aliases/BatchEvaluationItemResult.md +++ b/docs/api/type-aliases/BatchEvaluationItemResult.md @@ -8,8 +8,6 @@ > **BatchEvaluationItemResult** = `object` -Defined in: [types/evaluation.ts:408](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L408) - Result of a single item in BatchEvaluator. ## Properties @@ -18,32 +16,24 @@ Result of a single item in BatchEvaluator. > **id**: `string` -Defined in: [types/evaluation.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L409) - --- ### success > **success**: `boolean` -Defined in: [types/evaluation.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L410) - --- ### data? > `optional` **data?**: [`EvaluationData`](EvaluationData.md) -Defined in: [types/evaluation.ts:411](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L411) - --- ### error? > `optional` **error?**: `object` -Defined in: [types/evaluation.ts:412](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L412) - #### message > **message**: `string` @@ -62,12 +52,8 @@ Defined in: [types/evaluation.ts:412](https://github.com/juspay/neurolink/blob/r > **duration**: `number` -Defined in: [types/evaluation.ts:417](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L417) - --- ### retryCount > **retryCount**: `number` - -Defined in: [types/evaluation.ts:418](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L418) diff --git a/docs/api/type-aliases/BatchEvaluationResult.md b/docs/api/type-aliases/BatchEvaluationResult.md index b8a1ee46f..535d20365 100644 --- a/docs/api/type-aliases/BatchEvaluationResult.md +++ b/docs/api/type-aliases/BatchEvaluationResult.md @@ -8,8 +8,6 @@ > **BatchEvaluationResult** = `object` -Defined in: [types/evaluation.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L449) - Superset batch-result. `results` is a union of both item-result flavors; summary field names chosen from BatchEvaluator (`succeeded`, `passingRate`). @@ -19,16 +17,12 @@ summary field names chosen from BatchEvaluator (`succeeded`, `passingRate`). > **results**: [`BatchEvaluationItemResult`](BatchEvaluationItemResult.md)[] \| [`BatchItemResult`](BatchItemResult.md)[] -Defined in: [types/evaluation.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L450) - --- ### summary > **summary**: `object` -Defined in: [types/evaluation.ts:451](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L451) - #### total > **total**: `number` @@ -62,5 +56,3 @@ Defined in: [types/evaluation.ts:451](https://github.com/juspay/neurolink/blob/r ### allSucceeded? > `optional` **allSucceeded?**: `boolean` - -Defined in: [types/evaluation.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L460) diff --git a/docs/api/type-aliases/BatchExecutor.md b/docs/api/type-aliases/BatchExecutor.md index 2ac107cc8..7d43379b7 100644 --- a/docs/api/type-aliases/BatchExecutor.md +++ b/docs/api/type-aliases/BatchExecutor.md @@ -8,8 +8,6 @@ > **BatchExecutor**\<`T`\> = (`requests`) => `Promise`\<`object`[]\> -Defined in: [types/mcp.ts:2360](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2360) - Batch executor function type ## Type Parameters diff --git a/docs/api/type-aliases/BatchFileProcessingResult.md b/docs/api/type-aliases/BatchFileProcessingResult.md index 94289f43d..44be69f2a 100644 --- a/docs/api/type-aliases/BatchFileProcessingResult.md +++ b/docs/api/type-aliases/BatchFileProcessingResult.md @@ -8,8 +8,6 @@ > **BatchFileProcessingResult** = `object` -Defined in: [types/processor.ts:1100](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1100) - Result of processing multiple files through the registry. Categorizes files into successful, failed, and skipped. @@ -40,8 +38,6 @@ for (const { fileInfo, reason } of result.skipped) { > **successful**: `object`[] -Defined in: [types/processor.ts:1102](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1102) - Successfully processed files #### fileInfo @@ -62,8 +58,6 @@ Successfully processed files > **failed**: `object`[] -Defined in: [types/processor.ts:1108](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1108) - Files that failed to process #### fileInfo @@ -80,8 +74,6 @@ Files that failed to process > **skipped**: `object`[] -Defined in: [types/processor.ts:1113](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1113) - Files that were skipped (no processor found or over limit) #### fileInfo diff --git a/docs/api/type-aliases/BatchInferenceConfig.md b/docs/api/type-aliases/BatchInferenceConfig.md index 4abc1ef0f..d2f680d68 100644 --- a/docs/api/type-aliases/BatchInferenceConfig.md +++ b/docs/api/type-aliases/BatchInferenceConfig.md @@ -8,8 +8,6 @@ > **BatchInferenceConfig** = `object` -Defined in: [types/providers.ts:1825](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1825) - Batch inference job configuration ## Properties @@ -18,8 +16,6 @@ Batch inference job configuration > **inputS3Uri**: `string` -Defined in: [types/providers.ts:1827](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1827) - Input S3 location --- @@ -28,8 +24,6 @@ Input S3 location > **outputS3Uri**: `string` -Defined in: [types/providers.ts:1829](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1829) - Output S3 location --- @@ -38,8 +32,6 @@ Output S3 location > **modelName**: `string` -Defined in: [types/providers.ts:1831](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1831) - SageMaker model name --- @@ -48,8 +40,6 @@ SageMaker model name > **instanceType**: `string` -Defined in: [types/providers.ts:1833](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1833) - Instance type for batch job --- @@ -58,8 +48,6 @@ Instance type for batch job > **instanceCount**: `number` -Defined in: [types/providers.ts:1835](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1835) - Instance count for batch job --- @@ -68,8 +56,6 @@ Instance count for batch job > `optional` **maxPayloadInMB?**: `number` -Defined in: [types/providers.ts:1837](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1837) - Maximum payload size in MB --- @@ -78,6 +64,4 @@ Maximum payload size in MB > `optional` **batchStrategy?**: `"MultiRecord"` \| `"SingleRecord"` -Defined in: [types/providers.ts:1839](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1839) - Batch strategy diff --git a/docs/api/type-aliases/BatchItemResult.md b/docs/api/type-aliases/BatchItemResult.md index 4087a9d93..4e35a011e 100644 --- a/docs/api/type-aliases/BatchItemResult.md +++ b/docs/api/type-aliases/BatchItemResult.md @@ -8,8 +8,6 @@ > **BatchItemResult** = `object` -Defined in: [types/evaluation.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L422) - Result of a single item in the pipeline batchStrategy. ## Properties @@ -18,36 +16,26 @@ Result of a single item in the pipeline batchStrategy. > **index**: `number` -Defined in: [types/evaluation.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L423) - --- ### input > **input**: [`ScorerInput`](ScorerInput.md) -Defined in: [types/evaluation.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L424) - --- ### result? > `optional` **result?**: [`PipelineResult`](PipelineResult.md) -Defined in: [types/evaluation.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L425) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/evaluation.ts:426](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L426) - --- ### duration > **duration**: `number` - -Defined in: [types/evaluation.ts:427](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L427) diff --git a/docs/api/type-aliases/BatchOperationResult.md b/docs/api/type-aliases/BatchOperationResult.md index 33bc96af6..76e369bcb 100644 --- a/docs/api/type-aliases/BatchOperationResult.md +++ b/docs/api/type-aliases/BatchOperationResult.md @@ -8,8 +8,6 @@ > **BatchOperationResult** = `object` -Defined in: [types/aliases.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L396) - Batch operation result with count and errors Standard pattern for operations that process multiple items @@ -19,20 +17,14 @@ Standard pattern for operations that process multiple items > **success**: `boolean` -Defined in: [types/aliases.ts:397](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L397) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/aliases.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L398) - --- ### toolCount? > `optional` **toolCount?**: `number` - -Defined in: [types/aliases.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L399) diff --git a/docs/api/type-aliases/BatchProcessingSummary.md b/docs/api/type-aliases/BatchProcessingSummary.md index aaa416ee1..8ee841b3f 100644 --- a/docs/api/type-aliases/BatchProcessingSummary.md +++ b/docs/api/type-aliases/BatchProcessingSummary.md @@ -8,8 +8,6 @@ > **BatchProcessingSummary**\<`T`\> = `object` -Defined in: [types/processor.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L286) - Summary of batch file processing operations. ## Type Parameters @@ -24,8 +22,6 @@ Summary of batch file processing operations. > **totalFiles**: `number` -Defined in: [types/processor.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L290) - Total number of files attempted --- @@ -34,8 +30,6 @@ Total number of files attempted > **processedFiles**: [`ProcessedFileInfo`](ProcessedFileInfo.md)[] -Defined in: [types/processor.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L292) - Successfully processed files --- @@ -44,8 +38,6 @@ Successfully processed files > **failedFiles**: [`FailedFileInfo`](FailedFileInfo.md)[] -Defined in: [types/processor.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L294) - Files that failed to process --- @@ -54,8 +46,6 @@ Files that failed to process > **skippedFiles**: [`SkippedFileInfo`](SkippedFileInfo.md)[] -Defined in: [types/processor.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L296) - Files that were skipped (e.g., unsupported format) --- @@ -64,8 +54,6 @@ Files that were skipped (e.g., unsupported format) > **warnings**: [`FileWarning`](FileWarning.md)[] -Defined in: [types/processor.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L298) - Non-fatal warnings --- @@ -74,6 +62,4 @@ Non-fatal warnings > **results**: `T`[] -Defined in: [types/processor.ts:300](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L300) - Processed results (parallel array with processedFiles) diff --git a/docs/api/type-aliases/BatchProgress.md b/docs/api/type-aliases/BatchProgress.md index b4323e088..4c085fc1d 100644 --- a/docs/api/type-aliases/BatchProgress.md +++ b/docs/api/type-aliases/BatchProgress.md @@ -8,8 +8,6 @@ > **BatchProgress** = `object` -Defined in: [types/evaluation.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L389) - Superset batch progress. `pending` is canonical; `remaining` in the pipeline's batchStrategy was renamed during consolidation (same value). @@ -19,52 +17,38 @@ pipeline's batchStrategy was renamed during consolidation (same value). > **total**: `number` -Defined in: [types/evaluation.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L390) - --- ### completed > **completed**: `number` -Defined in: [types/evaluation.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L391) - --- ### failed > **failed**: `number` -Defined in: [types/evaluation.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L392) - --- ### pending > **pending**: `number` -Defined in: [types/evaluation.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L393) - --- ### percentComplete > **percentComplete**: `number` -Defined in: [types/evaluation.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L394) - --- ### succeeded? > `optional` **succeeded?**: `number` -Defined in: [types/evaluation.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L395) - --- ### estimatedTimeRemaining? > `optional` **estimatedTimeRemaining?**: `number` - -Defined in: [types/evaluation.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L396) diff --git a/docs/api/type-aliases/BatchResult.md b/docs/api/type-aliases/BatchResult.md index 3b886f2f6..1172e8020 100644 --- a/docs/api/type-aliases/BatchResult.md +++ b/docs/api/type-aliases/BatchResult.md @@ -8,8 +8,6 @@ > **BatchResult**\<`T`\> = `object` -Defined in: [types/mcp.ts:2348](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2348) - Batch execution result ## Type Parameters @@ -24,36 +22,26 @@ Batch execution result > **id**: `string` -Defined in: [types/mcp.ts:2349](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2349) - --- ### success > **success**: `boolean` -Defined in: [types/mcp.ts:2350](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2350) - --- ### result? > `optional` **result?**: `T` -Defined in: [types/mcp.ts:2351](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2351) - --- ### error? > `optional` **error?**: `Error` -Defined in: [types/mcp.ts:2352](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2352) - --- ### executionTime > **executionTime**: `number` - -Defined in: [types/mcp.ts:2353](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2353) diff --git a/docs/api/type-aliases/BatcherEvents.md b/docs/api/type-aliases/BatcherEvents.md index e205b30c4..65e601c03 100644 --- a/docs/api/type-aliases/BatcherEvents.md +++ b/docs/api/type-aliases/BatcherEvents.md @@ -8,8 +8,6 @@ > **BatcherEvents**\<`T`\> = `object` -Defined in: [types/mcp.ts:2368](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2368) - Batcher events ## Type Parameters @@ -24,8 +22,6 @@ Batcher events > **batchStarted**: `object` -Defined in: [types/mcp.ts:2369](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2369) - #### batchId > **batchId**: `string` @@ -40,8 +36,6 @@ Defined in: [types/mcp.ts:2369](https://github.com/juspay/neurolink/blob/release > **batchCompleted**: `object` -Defined in: [types/mcp.ts:2370](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2370) - #### batchId > **batchId**: `string` @@ -56,8 +50,6 @@ Defined in: [types/mcp.ts:2370](https://github.com/juspay/neurolink/blob/release > **batchFailed**: `object` -Defined in: [types/mcp.ts:2371](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2371) - #### batchId > **batchId**: `string` @@ -72,8 +64,6 @@ Defined in: [types/mcp.ts:2371](https://github.com/juspay/neurolink/blob/release > **requestQueued**: `object` -Defined in: [types/mcp.ts:2372](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2372) - #### requestId > **requestId**: `string` @@ -88,8 +78,6 @@ Defined in: [types/mcp.ts:2372](https://github.com/juspay/neurolink/blob/release > **flushTriggered**: `object` -Defined in: [types/mcp.ts:2373](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2373) - #### reason > **reason**: `"size"` \| `"timeout"` \| `"manual"` diff --git a/docs/api/type-aliases/BearerAuthOptions.md b/docs/api/type-aliases/BearerAuthOptions.md index 727eca087..4f8cacf6f 100644 --- a/docs/api/type-aliases/BearerAuthOptions.md +++ b/docs/api/type-aliases/BearerAuthOptions.md @@ -8,8 +8,6 @@ > **BearerAuthOptions** = `object` -Defined in: [types/middleware.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L403) - Options for the bearer-token auth middleware. ## Properties @@ -18,20 +16,14 @@ Options for the bearer-token auth middleware. > `optional` **required?**: `boolean` -Defined in: [types/middleware.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L404) - --- ### headerName? > `optional` **headerName?**: `string` -Defined in: [types/middleware.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L405) - --- ### skipPaths? > `optional` **skipPaths?**: `string`[] - -Defined in: [types/middleware.ts:406](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L406) diff --git a/docs/api/type-aliases/BeatovenComposeResponse.md b/docs/api/type-aliases/BeatovenComposeResponse.md index 928e110b9..d65082131 100644 --- a/docs/api/type-aliases/BeatovenComposeResponse.md +++ b/docs/api/type-aliases/BeatovenComposeResponse.md @@ -8,8 +8,6 @@ > **BeatovenComposeResponse** = `object` -Defined in: [types/music.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L183) - Beatoven.ai compose-track submit response. ## Properties @@ -18,12 +16,8 @@ Beatoven.ai compose-track submit response. > **task_id**: `string` -Defined in: [types/music.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L184) - --- ### status? > `optional` **status?**: `string` - -Defined in: [types/music.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L185) diff --git a/docs/api/type-aliases/BeatovenTaskStatus.md b/docs/api/type-aliases/BeatovenTaskStatus.md index a352d81e5..8291dce12 100644 --- a/docs/api/type-aliases/BeatovenTaskStatus.md +++ b/docs/api/type-aliases/BeatovenTaskStatus.md @@ -8,8 +8,6 @@ > **BeatovenTaskStatus** = `object` -Defined in: [types/music.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L169) - Beatoven.ai task status response. Used by `BeatovenMusic` handler to type-check polling responses. @@ -20,16 +18,12 @@ Used by `BeatovenMusic` handler to type-check polling responses. > **status**: `"composing"` \| `"running"` \| `"composed"` \| `"failed"` -Defined in: [types/music.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L170) - --- ### meta? > `optional` **meta?**: `object` -Defined in: [types/music.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L171) - #### track_url? > `optional` **track_url?**: `string` @@ -51,5 +45,3 @@ Defined in: [types/music.ts:171](https://github.com/juspay/neurolink/blob/releas ### message? > `optional` **message?**: `string` - -Defined in: [types/music.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L177) diff --git a/docs/api/type-aliases/BedrockConfigData.md b/docs/api/type-aliases/BedrockConfigData.md index f168f5310..81197eb7d 100644 --- a/docs/api/type-aliases/BedrockConfigData.md +++ b/docs/api/type-aliases/BedrockConfigData.md @@ -8,8 +8,6 @@ > **BedrockConfigData** = `object` -Defined in: [types/cli.ts:1722](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1722) - Captured Bedrock setup configuration data. ## Properties @@ -18,28 +16,20 @@ Captured Bedrock setup configuration data. > `optional` **accessKeyId?**: `string` -Defined in: [types/cli.ts:1723](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1723) - --- ### secretAccessKey? > `optional` **secretAccessKey?**: `string` -Defined in: [types/cli.ts:1724](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1724) - --- ### region? > `optional` **region?**: `string` -Defined in: [types/cli.ts:1725](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1725) - --- ### model? > `optional` **model?**: `string` - -Defined in: [types/cli.ts:1726](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1726) diff --git a/docs/api/type-aliases/BedrockConfigStatus.md b/docs/api/type-aliases/BedrockConfigStatus.md index f204e9787..d6d7cd656 100644 --- a/docs/api/type-aliases/BedrockConfigStatus.md +++ b/docs/api/type-aliases/BedrockConfigStatus.md @@ -8,8 +8,6 @@ > **BedrockConfigStatus** = `object` -Defined in: [types/cli.ts:1730](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1730) - Status of Bedrock setup configuration flags. ## Properties @@ -18,20 +16,14 @@ Status of Bedrock setup configuration flags. > **hasAccessKey**: `boolean` -Defined in: [types/cli.ts:1731](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1731) - --- ### hasSecretKey > **hasSecretKey**: `boolean` -Defined in: [types/cli.ts:1732](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1732) - --- ### hasRegion > **hasRegion**: `boolean` - -Defined in: [types/cli.ts:1733](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1733) diff --git a/docs/api/type-aliases/BedrockContentBlock.md b/docs/api/type-aliases/BedrockContentBlock.md index e7f05ff15..cfd37eebb 100644 --- a/docs/api/type-aliases/BedrockContentBlock.md +++ b/docs/api/type-aliases/BedrockContentBlock.md @@ -8,8 +8,6 @@ > **BedrockContentBlock** = `object` -Defined in: [types/providers.ts:1089](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1089) - Bedrock content block structure ## Properties @@ -18,16 +16,12 @@ Bedrock content block structure > `optional` **text?**: `string` -Defined in: [types/providers.ts:1090](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1090) - --- ### image? > `optional` **image?**: `object` -Defined in: [types/providers.ts:1091](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1091) - #### format > **format**: `"png"` \| `"jpeg"` \| `"gif"` \| `"webp"` @@ -46,8 +40,6 @@ Defined in: [types/providers.ts:1091](https://github.com/juspay/neurolink/blob/r > `optional` **document?**: `object` -Defined in: [types/providers.ts:1097](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1097) - #### format > **format**: `"pdf"` \| `"csv"` \| `"doc"` \| `"docx"` \| `"xls"` \| `"xlsx"` \| `"html"` \| `"txt"` \| `"md"` @@ -70,12 +62,8 @@ Defined in: [types/providers.ts:1097](https://github.com/juspay/neurolink/blob/r > `optional` **toolUse?**: [`BedrockToolUse`](BedrockToolUse.md) -Defined in: [types/providers.ts:1113](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1113) - --- ### toolResult? > `optional` **toolResult?**: [`BedrockToolResult`](BedrockToolResult.md) - -Defined in: [types/providers.ts:1114](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1114) diff --git a/docs/api/type-aliases/BedrockMessage.md b/docs/api/type-aliases/BedrockMessage.md index 269f650a8..da28c7ed3 100644 --- a/docs/api/type-aliases/BedrockMessage.md +++ b/docs/api/type-aliases/BedrockMessage.md @@ -8,8 +8,6 @@ > **BedrockMessage** = `object` -Defined in: [types/providers.ts:1137](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1137) - Bedrock message structure ## Properties @@ -18,12 +16,8 @@ Bedrock message structure > **role**: `"user"` \| `"assistant"` -Defined in: [types/providers.ts:1138](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1138) - --- ### content > **content**: [`BedrockContentBlock`](BedrockContentBlock.md)[] - -Defined in: [types/providers.ts:1139](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1139) diff --git a/docs/api/type-aliases/BedrockPendingContentBlock.md b/docs/api/type-aliases/BedrockPendingContentBlock.md index 76d886e5f..4ab266f1e 100644 --- a/docs/api/type-aliases/BedrockPendingContentBlock.md +++ b/docs/api/type-aliases/BedrockPendingContentBlock.md @@ -8,8 +8,6 @@ > **BedrockPendingContentBlock** = [`BedrockContentBlock`](BedrockContentBlock.md) & `object` -Defined in: [types/providers.ts:1123](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1123) - A Bedrock content block still being assembled from a ConverseStream event sequence. `_inputBuffer` holds the partial tool-call JSON that arrives across several `contentBlockDelta` events and is parsed away at diff --git a/docs/api/type-aliases/BedrockToolResult.md b/docs/api/type-aliases/BedrockToolResult.md index 5e227578c..0fe2f26d9 100644 --- a/docs/api/type-aliases/BedrockToolResult.md +++ b/docs/api/type-aliases/BedrockToolResult.md @@ -8,8 +8,6 @@ > **BedrockToolResult** = `object` -Defined in: [types/providers.ts:1080](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1080) - Bedrock tool result structure ## Properties @@ -18,16 +16,12 @@ Bedrock tool result structure > **toolUseId**: `string` -Defined in: [types/providers.ts:1081](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1081) - --- ### content > **content**: `object`[] -Defined in: [types/providers.ts:1082](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1082) - #### text > **text**: `string` @@ -37,5 +31,3 @@ Defined in: [types/providers.ts:1082](https://github.com/juspay/neurolink/blob/r ### status > **status**: `string` - -Defined in: [types/providers.ts:1083](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1083) diff --git a/docs/api/type-aliases/BedrockToolUse.md b/docs/api/type-aliases/BedrockToolUse.md index 582299d3f..38508d554 100644 --- a/docs/api/type-aliases/BedrockToolUse.md +++ b/docs/api/type-aliases/BedrockToolUse.md @@ -8,8 +8,6 @@ > **BedrockToolUse** = `object` -Defined in: [types/providers.ts:1071](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1071) - Bedrock tool usage structure ## Properties @@ -18,20 +16,14 @@ Bedrock tool usage structure > **toolUseId**: `string` -Defined in: [types/providers.ts:1072](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1072) - --- ### name > **name**: `string` -Defined in: [types/providers.ts:1073](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1073) - --- ### input > **input**: `Record`\<`string`, `unknown`\> - -Defined in: [types/providers.ts:1074](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1074) diff --git a/docs/api/type-aliases/BenchmarkParams.md b/docs/api/type-aliases/BenchmarkParams.md index 7079f59e3..6f2b7c13b 100644 --- a/docs/api/type-aliases/BenchmarkParams.md +++ b/docs/api/type-aliases/BenchmarkParams.md @@ -8,8 +8,6 @@ > **BenchmarkParams** = `object` -Defined in: [types/mcp.ts:2699](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2699) - Parsed input for the benchmark-provider-performance MCP tool. ## Properties @@ -18,36 +16,26 @@ Parsed input for the benchmark-provider-performance MCP tool. > `optional` **providers?**: [`AiAnalysisProvider`](AiAnalysisProvider.md)[] -Defined in: [types/mcp.ts:2700](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2700) - --- ### testPrompts? > `optional` **testPrompts?**: `string`[] -Defined in: [types/mcp.ts:2701](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2701) - --- ### iterations > **iterations**: `number` -Defined in: [types/mcp.ts:2702](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2702) - --- ### metrics > **metrics**: (`"latency"` \| `"quality"` \| `"cost"` \| `"tokens"`)[] -Defined in: [types/mcp.ts:2703](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2703) - --- ### maxTokens > **maxTokens**: `number` - -Defined in: [types/mcp.ts:2704](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2704) diff --git a/docs/api/type-aliases/BetterAuthConfig.md b/docs/api/type-aliases/BetterAuthConfig.md index 3a4010583..e3d8d7a5c 100644 --- a/docs/api/type-aliases/BetterAuthConfig.md +++ b/docs/api/type-aliases/BetterAuthConfig.md @@ -8,8 +8,6 @@ > **BetterAuthConfig** = `object` -Defined in: [types/auth.ts:797](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L797) - Better Auth provider configuration ## Properties @@ -18,8 +16,6 @@ Better Auth provider configuration > **secret**: `string` -Defined in: [types/auth.ts:799](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L799) - Better Auth secret --- @@ -28,8 +24,6 @@ Better Auth secret > **baseUrl**: `string` -Defined in: [types/auth.ts:801](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L801) - Better Auth base URL --- @@ -38,8 +32,6 @@ Better Auth base URL > `optional` **databaseUrl?**: `string` -Defined in: [types/auth.ts:803](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L803) - Database connection string --- @@ -48,8 +40,6 @@ Database connection string > `optional` **socialProviders?**: `object` -Defined in: [types/auth.ts:805](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L805) - Social providers configuration #### github? diff --git a/docs/api/type-aliases/BiasInstance.md b/docs/api/type-aliases/BiasInstance.md index 6187db150..93125c0ca 100644 --- a/docs/api/type-aliases/BiasInstance.md +++ b/docs/api/type-aliases/BiasInstance.md @@ -8,8 +8,6 @@ > **BiasInstance** = `object` -Defined in: [types/scorer.ts:643](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L643) - Bias instance reported by the bias-detection scorer. ## Properties @@ -18,28 +16,20 @@ Bias instance reported by the bias-detection scorer. > `optional` **type?**: `string` -Defined in: [types/scorer.ts:644](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L644) - --- ### text? > `optional` **text?**: `string` -Defined in: [types/scorer.ts:645](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L645) - --- ### explanation? > `optional` **explanation?**: `string` -Defined in: [types/scorer.ts:646](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L646) - --- ### severity? > `optional` **severity?**: `string` - -Defined in: [types/scorer.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L647) diff --git a/docs/api/type-aliases/BodyParserConfig.md b/docs/api/type-aliases/BodyParserConfig.md index 6d8f94c28..1c1af0ce0 100644 --- a/docs/api/type-aliases/BodyParserConfig.md +++ b/docs/api/type-aliases/BodyParserConfig.md @@ -8,8 +8,6 @@ > **BodyParserConfig** = `object` -Defined in: [types/server.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L154) - Body parser configuration ## Properties @@ -18,8 +16,6 @@ Body parser configuration > `optional` **enabled?**: `boolean` -Defined in: [types/server.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L156) - Enable body parsing (default: true) --- @@ -28,8 +24,6 @@ Enable body parsing (default: true) > `optional` **maxSize?**: `string` -Defined in: [types/server.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L159) - Maximum body size (default: "10mb") --- @@ -38,8 +32,6 @@ Maximum body size (default: "10mb") > `optional` **jsonLimit?**: `string` -Defined in: [types/server.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L162) - JSON body limit (default: "10mb") --- @@ -48,6 +40,4 @@ JSON body limit (default: "10mb") > `optional` **urlEncoded?**: `boolean` -Defined in: [types/server.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L165) - Enable URL-encoded body parsing diff --git a/docs/api/type-aliases/BooleanRecord.md b/docs/api/type-aliases/BooleanRecord.md index eacc9d699..7e07a3f2f 100644 --- a/docs/api/type-aliases/BooleanRecord.md +++ b/docs/api/type-aliases/BooleanRecord.md @@ -8,7 +8,5 @@ > **BooleanRecord** = `Record`\<`string`, `boolean`\> -Defined in: [types/aliases.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L82) - Boolean-valued record for feature flags and settings Common in configuration and capability objects diff --git a/docs/api/type-aliases/BoundedZipEntry.md b/docs/api/type-aliases/BoundedZipEntry.md index 2f53b471a..2490192c3 100644 --- a/docs/api/type-aliases/BoundedZipEntry.md +++ b/docs/api/type-aliases/BoundedZipEntry.md @@ -8,8 +8,6 @@ > **BoundedZipEntry** = `object` -Defined in: [types/processor.ts:928](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L928) - The slice of an adm-zip entry the bounded reader depends on. Structural rather than adm-zip's own `IZipEntry` so the reader states what it @@ -23,8 +21,6 @@ full when building a test double. > **getCompressedData**: () => `Buffer` -Defined in: [types/processor.ts:929](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L929) - #### Returns `Buffer` @@ -35,8 +31,6 @@ Defined in: [types/processor.ts:929](https://github.com/juspay/neurolink/blob/re > **header**: `object` -Defined in: [types/processor.ts:930](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L930) - #### method > **method**: `number` diff --git a/docs/api/type-aliases/BracketCountingState.md b/docs/api/type-aliases/BracketCountingState.md index 44f66f509..c439c5a8e 100644 --- a/docs/api/type-aliases/BracketCountingState.md +++ b/docs/api/type-aliases/BracketCountingState.md @@ -8,8 +8,6 @@ > **BracketCountingState** = `object` -Defined in: [types/common.ts:674](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L674) - Shared bracket counting state and utilities Used by both validateJSONCompleteness and StructuredOutputParser @@ -19,28 +17,20 @@ Used by both validateJSONCompleteness and StructuredOutputParser > **braceCount**: `number` -Defined in: [types/common.ts:675](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L675) - --- ### bracketCount > **bracketCount**: `number` -Defined in: [types/common.ts:676](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L676) - --- ### inString > **inString**: `boolean` -Defined in: [types/common.ts:677](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L677) - --- ### escapeNext > **escapeNext**: `boolean` - -Defined in: [types/common.ts:678](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L678) diff --git a/docs/api/type-aliases/BraintrustExporterConfig.md b/docs/api/type-aliases/BraintrustExporterConfig.md index 63f8d8579..a82e5edde 100644 --- a/docs/api/type-aliases/BraintrustExporterConfig.md +++ b/docs/api/type-aliases/BraintrustExporterConfig.md @@ -8,8 +8,6 @@ > **BraintrustExporterConfig** = [`ExporterConfig`](ExporterConfig.md) & `object` -Defined in: [types/exporter.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L127) - Braintrust exporter configuration ## Type Declaration diff --git a/docs/api/type-aliases/BudgetCheckParams.md b/docs/api/type-aliases/BudgetCheckParams.md index e8b806df7..7fe01745d 100644 --- a/docs/api/type-aliases/BudgetCheckParams.md +++ b/docs/api/type-aliases/BudgetCheckParams.md @@ -8,8 +8,6 @@ > **BudgetCheckParams** = `object` -Defined in: [types/context.ts:663](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L663) - Parameters for budget checking. ## Properties @@ -18,40 +16,30 @@ Parameters for budget checking. > **provider**: `string` -Defined in: [types/context.ts:664](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L664) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/context.ts:665](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L665) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/context.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L666) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/context.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L667) - --- ### conversationMessages? > `optional` **conversationMessages?**: `object`[] -Defined in: [types/context.ts:668](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L668) - #### role > **role**: `string` @@ -66,24 +54,18 @@ Defined in: [types/context.ts:668](https://github.com/juspay/neurolink/blob/rele > `optional` **currentPrompt?**: `string` -Defined in: [types/context.ts:669](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L669) - --- ### toolDefinitions? > `optional` **toolDefinitions?**: `unknown`[] -Defined in: [types/context.ts:670](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L670) - --- ### fileAttachments? > `optional` **fileAttachments?**: `object`[] -Defined in: [types/context.ts:671](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L671) - #### content > **content**: `string` @@ -94,6 +76,4 @@ Defined in: [types/context.ts:671](https://github.com/juspay/neurolink/blob/rele > `optional` **compactionThreshold?**: `number` -Defined in: [types/context.ts:673](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L673) - Compaction trigger threshold (0.0-1.0). Default: 0.80 diff --git a/docs/api/type-aliases/BudgetCheckResult.md b/docs/api/type-aliases/BudgetCheckResult.md index a0467d26d..b4dea3567 100644 --- a/docs/api/type-aliases/BudgetCheckResult.md +++ b/docs/api/type-aliases/BudgetCheckResult.md @@ -8,8 +8,6 @@ > **BudgetCheckResult** = `object` -Defined in: [types/context.ts:641](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L641) - Result of a context budget check. ## Properties @@ -18,8 +16,6 @@ Result of a context budget check. > **withinBudget**: `boolean` -Defined in: [types/context.ts:643](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L643) - Whether the request fits within the context window --- @@ -28,8 +24,6 @@ Whether the request fits within the context window > **estimatedInputTokens**: `number` -Defined in: [types/context.ts:645](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L645) - Estimated total input tokens --- @@ -38,8 +32,6 @@ Estimated total input tokens > **availableInputTokens**: `number` -Defined in: [types/context.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L647) - Available input tokens for this model --- @@ -48,8 +40,6 @@ Available input tokens for this model > **usageRatio**: `number` -Defined in: [types/context.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L649) - Usage ratio (0.0 - 1.0+) --- @@ -58,8 +48,6 @@ Usage ratio (0.0 - 1.0+) > **shouldCompact**: `boolean` -Defined in: [types/context.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L651) - Whether auto-compaction should trigger --- @@ -68,8 +56,6 @@ Whether auto-compaction should trigger > **breakdown**: `object` -Defined in: [types/context.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L653) - Breakdown of token usage by category #### systemPrompt diff --git a/docs/api/type-aliases/BudgetFileInput.md b/docs/api/type-aliases/BudgetFileInput.md index c99517134..01cb0085e 100644 --- a/docs/api/type-aliases/BudgetFileInput.md +++ b/docs/api/type-aliases/BudgetFileInput.md @@ -8,8 +8,6 @@ > **BudgetFileInput** = `object` -Defined in: [types/context.ts:784](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L784) - Input file for aggregate budget enforcement. ## Properties @@ -18,22 +16,16 @@ Input file for aggregate budget enforcement. > **name**: `string` -Defined in: [types/context.ts:785](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L785) - --- ### sizeBytes > **sizeBytes**: `number` -Defined in: [types/context.ts:786](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L786) - --- ### fileType? > `optional` **fileType?**: `string` -Defined in: [types/context.ts:788](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L788) - Optional file type hint for type-aware token estimation diff --git a/docs/api/type-aliases/BuildContentPlanningPromptOptions.md b/docs/api/type-aliases/BuildContentPlanningPromptOptions.md index 8acd5ec3e..602f6a0f5 100644 --- a/docs/api/type-aliases/BuildContentPlanningPromptOptions.md +++ b/docs/api/type-aliases/BuildContentPlanningPromptOptions.md @@ -8,8 +8,6 @@ > **BuildContentPlanningPromptOptions** = `object` -Defined in: [types/ppt.ts:1223](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1223) - Options for buildContentPlanningPrompt ## Properties @@ -18,52 +16,38 @@ Options for buildContentPlanningPrompt > **topic**: `string` -Defined in: [types/ppt.ts:1224](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1224) - --- ### pages > **pages**: `number` -Defined in: [types/ppt.ts:1225](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1225) - --- ### audience > **audience**: `string` -Defined in: [types/ppt.ts:1226](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1226) - --- ### tone > **tone**: `string` -Defined in: [types/ppt.ts:1227](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1227) - --- ### theme > **theme**: `string` -Defined in: [types/ppt.ts:1228](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1228) - --- ### generateAIImages > **generateAIImages**: `boolean` -Defined in: [types/ppt.ts:1229](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1229) - --- ### modelInfo > **modelInfo**: [`PPTModelInfo`](PPTModelInfo.md) - -Defined in: [types/ppt.ts:1230](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1230) diff --git a/docs/api/type-aliases/BuildRealtimeMcpToolsParams.md b/docs/api/type-aliases/BuildRealtimeMcpToolsParams.md index 7b002f03f..e10eb9ceb 100644 --- a/docs/api/type-aliases/BuildRealtimeMcpToolsParams.md +++ b/docs/api/type-aliases/BuildRealtimeMcpToolsParams.md @@ -8,8 +8,6 @@ > **BuildRealtimeMcpToolsParams** = `object` -Defined in: [types/livekit.ts:545](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L545) - Inputs to `buildRealtimeMcpTools`. ## Properties @@ -18,8 +16,6 @@ Inputs to `buildRealtimeMcpTools`. > **mcpUrl**: `string` -Defined in: [types/livekit.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L547) - Full URL of the MCP server (e.g. ".../ai/mcp/v2"). --- @@ -28,8 +24,6 @@ Full URL of the MCP server (e.g. ".../ai/mcp/v2"). > **authToken**: `string` -Defined in: [types/livekit.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L549) - Lighthouse access JWT forwarded as `x-auth-token`. --- @@ -38,8 +32,6 @@ Lighthouse access JWT forwarded as `x-auth-token`. > **xContext**: `string` -Defined in: [types/livekit.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L551) - base64(JSON) execution context forwarded as `x-context`. --- @@ -48,8 +40,6 @@ base64(JSON) execution context forwarded as `x-context`. > **publishEvent**: [`RealtimeEventPublisher`](RealtimeEventPublisher.md) -Defined in: [types/livekit.ts:553](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L553) - Publishes tool start/result events to the browser. --- @@ -58,8 +48,6 @@ Publishes tool start/result events to the browser. > **requestConfirmation**: [`RealtimeConfirmationRequester`](RealtimeConfirmationRequester.md) -Defined in: [types/livekit.ts:555](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L555) - Opens a HITL confirmation for destructive tools and awaits the decision. --- @@ -68,8 +56,6 @@ Opens a HITL confirmation for destructive tools and awaits the decision. > `optional` **toolTimeoutMs?**: `number` -Defined in: [types/livekit.ts:564](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L564) - Hard cap per MCP tool call, in milliseconds (default 30000). Without one, a stalled MCP server holds the realtime turn open forever: diff --git a/docs/api/type-aliases/BuiltInMiddlewareType.md b/docs/api/type-aliases/BuiltInMiddlewareType.md index 11bf25f8a..72d797522 100644 --- a/docs/api/type-aliases/BuiltInMiddlewareType.md +++ b/docs/api/type-aliases/BuiltInMiddlewareType.md @@ -8,6 +8,4 @@ > **BuiltInMiddlewareType** = `"analytics"` \| `"guardrails"` \| `"logging"` \| `"caching"` \| `"rateLimit"` \| `"retry"` \| `"timeout"` \| `"autoEvaluation"` \| `"lifecycle"` -Defined in: [types/middleware.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L150) - Built-in middleware types diff --git a/docs/api/type-aliases/BuiltInScorerDefinition.md b/docs/api/type-aliases/BuiltInScorerDefinition.md index 07416a8a4..b80ba2998 100644 --- a/docs/api/type-aliases/BuiltInScorerDefinition.md +++ b/docs/api/type-aliases/BuiltInScorerDefinition.md @@ -8,8 +8,6 @@ > **BuiltInScorerDefinition** = `object` -Defined in: [types/scorer.ts:632](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L632) - Row describing a built-in scorer in the scorer registry seed list. ## Properties @@ -18,20 +16,14 @@ Row describing a built-in scorer in the scorer registry seed list. > **metadata**: [`ScorerMetadata`](ScorerMetadata.md) -Defined in: [types/scorer.ts:633](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L633) - --- ### factory > **factory**: [`ScorerFactory`](ScorerFactory.md) -Defined in: [types/scorer.ts:634](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L634) - --- ### aliases? > `optional` **aliases?**: `string`[] - -Defined in: [types/scorer.ts:635](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L635) diff --git a/docs/api/type-aliases/BulletPoint.md b/docs/api/type-aliases/BulletPoint.md index 0a5c999f8..55d4414b3 100644 --- a/docs/api/type-aliases/BulletPoint.md +++ b/docs/api/type-aliases/BulletPoint.md @@ -8,8 +8,6 @@ > **BulletPoint** = `object` -Defined in: [types/ppt.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L268) - Bullet point with optional sub-bullets and styling Maps to: addText with bullet: true option @@ -22,24 +20,18 @@ Priority: bullet-level > slide-level > type-defaults > theme-defaults > **text**: `string` -Defined in: [types/ppt.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L269) - --- ### subBullets? > `optional` **subBullets?**: `string`[] -Defined in: [types/ppt.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L270) - --- ### icon? > `optional` **icon?**: `string` -Defined in: [types/ppt.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L272) - Icon code for custom bullet (Unicode). Ex: "2713" for checkmark --- @@ -48,8 +40,6 @@ Icon code for custom bullet (Unicode). Ex: "2713" for checkmark > `optional` **emphasis?**: `boolean` -Defined in: [types/ppt.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L274) - Highlight/emphasis for this bullet --- @@ -58,8 +48,6 @@ Highlight/emphasis for this bullet > `optional` **fontSize?**: `number` -Defined in: [types/ppt.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L278) - Font size override (default calculated based on bullet count) --- @@ -68,8 +56,6 @@ Font size override (default calculated based on bullet count) > `optional` **bulletStyle?**: [`BulletStyle`](BulletStyle.md) -Defined in: [types/ppt.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L280) - Bullet style override (default based on slide type) --- @@ -78,8 +64,6 @@ Bullet style override (default based on slide type) > `optional` **color?**: `string` -Defined in: [types/ppt.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L282) - Text color override (hex, e.g., "#FF0000") --- @@ -88,6 +72,4 @@ Text color override (hex, e.g., "#FF0000") > `optional` **bold?**: `boolean` -Defined in: [types/ppt.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L284) - Bold text override diff --git a/docs/api/type-aliases/BulletStyle.md b/docs/api/type-aliases/BulletStyle.md index a70128fa1..b8a0927bd 100644 --- a/docs/api/type-aliases/BulletStyle.md +++ b/docs/api/type-aliases/BulletStyle.md @@ -8,8 +8,6 @@ > **BulletStyle** = `"disc"` \| `"number"` \| `"checkmark"` \| `"arrow"` \| `"dash"` \| `"none"` -Defined in: [types/ppt.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L253) - Bullet style options for formatting - "disc": Standard bullet point (•) diff --git a/docs/api/type-aliases/CLIContext.md b/docs/api/type-aliases/CLIContext.md index d5639043a..2a88ec579 100644 --- a/docs/api/type-aliases/CLIContext.md +++ b/docs/api/type-aliases/CLIContext.md @@ -8,8 +8,6 @@ > **CLIContext** = `object` -Defined in: [types/cli.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L518) - CLI context ## Properties @@ -18,28 +16,20 @@ CLI context > **cwd**: `string` -Defined in: [types/cli.ts:519](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L519) - --- ### args > **args**: `string`[] -Defined in: [types/cli.ts:520](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L520) - --- ### env > **env**: `NodeJS.ProcessEnv` -Defined in: [types/cli.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L521) - --- ### exitCode? > `optional` **exitCode?**: `number` - -Defined in: [types/cli.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L522) diff --git a/docs/api/type-aliases/CLIMCPServerConfig.md b/docs/api/type-aliases/CLIMCPServerConfig.md index 16c63fcfa..47bf1455d 100644 --- a/docs/api/type-aliases/CLIMCPServerConfig.md +++ b/docs/api/type-aliases/CLIMCPServerConfig.md @@ -8,8 +8,6 @@ > **CLIMCPServerConfig** = `object` -Defined in: [types/cli.ts:740](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L740) - MCP server configuration for CLI ## Properties @@ -18,52 +16,38 @@ MCP server configuration for CLI > **name**: `string` -Defined in: [types/cli.ts:741](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L741) - --- ### transport > **transport**: `"stdio"` \| `"websocket"` \| `"tcp"` \| `"unix"` -Defined in: [types/cli.ts:742](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L742) - --- ### command? > `optional` **command?**: `string` -Defined in: [types/cli.ts:743](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L743) - --- ### args? > `optional` **args?**: `string`[] -Defined in: [types/cli.ts:744](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L744) - --- ### env? > `optional` **env?**: `Record`\<`string`, `string`\> -Defined in: [types/cli.ts:745](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L745) - --- ### url? > `optional` **url?**: `string` -Defined in: [types/cli.ts:746](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L746) - --- ### description? > `optional` **description?**: `string` - -Defined in: [types/cli.ts:747](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L747) diff --git a/docs/api/type-aliases/CLIProviderConfig.md b/docs/api/type-aliases/CLIProviderConfig.md index 24cb8fe7b..8cfe96676 100644 --- a/docs/api/type-aliases/CLIProviderConfig.md +++ b/docs/api/type-aliases/CLIProviderConfig.md @@ -8,8 +8,6 @@ > **CLIProviderConfig** = `object` -Defined in: [types/cli.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L649) - Provider configuration for interactive setup ## Properties @@ -18,32 +16,24 @@ Provider configuration for interactive setup > **id**: `string` -Defined in: [types/cli.ts:650](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L650) - --- ### name > **name**: `string` -Defined in: [types/cli.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L651) - --- ### description > **description**: `string` -Defined in: [types/cli.ts:652](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L652) - --- ### envVars > **envVars**: `object`[] -Defined in: [types/cli.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L653) - #### key > **key**: `string` diff --git a/docs/api/type-aliases/CLISetupResult.md b/docs/api/type-aliases/CLISetupResult.md index d045f0ce1..112fcddeb 100644 --- a/docs/api/type-aliases/CLISetupResult.md +++ b/docs/api/type-aliases/CLISetupResult.md @@ -8,8 +8,6 @@ > **CLISetupResult** = `object` -Defined in: [types/cli.ts:665](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L665) - Interactive setup result ## Properties @@ -18,32 +16,24 @@ Interactive setup result > **selectedProviders**: `string`[] -Defined in: [types/cli.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L666) - --- ### credentials > **credentials**: `Record`\<`string`, `string`\> -Defined in: [types/cli.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L667) - --- ### envFileBackup? > `optional` **envFileBackup?**: `string` -Defined in: [types/cli.ts:668](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L668) - --- ### testResults > **testResults**: `object`[] -Defined in: [types/cli.ts:669](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L669) - #### provider > **provider**: `string` diff --git a/docs/api/type-aliases/CORSConfig.md b/docs/api/type-aliases/CORSConfig.md index 88a882595..00c931f41 100644 --- a/docs/api/type-aliases/CORSConfig.md +++ b/docs/api/type-aliases/CORSConfig.md @@ -8,8 +8,6 @@ > **CORSConfig** = `object` -Defined in: [types/server.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L84) - CORS configuration ## Properties @@ -18,8 +16,6 @@ CORS configuration > `optional` **enabled?**: `boolean` -Defined in: [types/server.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L86) - Enable CORS (default: true) --- @@ -28,8 +24,6 @@ Enable CORS (default: true) > `optional` **origins?**: `string`[] -Defined in: [types/server.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L89) - Allowed origins (default: ["*"]) --- @@ -38,8 +32,6 @@ Allowed origins (default: ["*"]) > `optional` **methods?**: `string`[] -Defined in: [types/server.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L92) - Allowed HTTP methods --- @@ -48,8 +40,6 @@ Allowed HTTP methods > `optional` **headers?**: `string`[] -Defined in: [types/server.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L95) - Allowed headers --- @@ -58,8 +48,6 @@ Allowed headers > `optional` **credentials?**: `boolean` -Defined in: [types/server.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L98) - Allow credentials --- @@ -68,6 +56,4 @@ Allow credentials > `optional` **maxAge?**: `number` -Defined in: [types/server.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L101) - Preflight cache max age in seconds diff --git a/docs/api/type-aliases/CSVColumnDataType.md b/docs/api/type-aliases/CSVColumnDataType.md index b4cb34848..a4f93d6c0 100644 --- a/docs/api/type-aliases/CSVColumnDataType.md +++ b/docs/api/type-aliases/CSVColumnDataType.md @@ -8,6 +8,4 @@ > **CSVColumnDataType** = `"string"` \| `"number"` \| `"integer"` \| `"float"` \| `"boolean"` \| `"date"` \| `"datetime"` \| `"email"` \| `"url"` \| `"empty"` \| `"mixed"` -Defined in: [types/file.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L389) - Detected data type for a CSV column diff --git a/docs/api/type-aliases/CSVColumnMetadata.md b/docs/api/type-aliases/CSVColumnMetadata.md index 4d0e7b5c6..2de9aa78f 100644 --- a/docs/api/type-aliases/CSVColumnMetadata.md +++ b/docs/api/type-aliases/CSVColumnMetadata.md @@ -8,8 +8,6 @@ > **CSVColumnMetadata** = `object` -Defined in: [types/file.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L422) - Rich metadata for a single CSV column ## Properties @@ -18,16 +16,12 @@ Rich metadata for a single CSV column > **name**: `string` -Defined in: [types/file.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L423) - --- ### originalName? > `optional` **originalName?**: `string` -Defined in: [types/file.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L425) - Original header text before sanitization, when sanitizeColumnNames rewrote it (#378) --- @@ -36,24 +30,18 @@ Original header text before sanitization, when sanitizeColumnNames rewrote it (# > **index**: `number` -Defined in: [types/file.ts:426](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L426) - --- ### detectedType > **detectedType**: [`CSVColumnDataType`](CSVColumnDataType.md) -Defined in: [types/file.ts:427](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L427) - --- ### typeConfidence > **typeConfidence**: `number` -Defined in: [types/file.ts:429](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L429) - Confidence of type detection (0-100) --- @@ -62,8 +50,6 @@ Confidence of type detection (0-100) > **nullCount**: `number` -Defined in: [types/file.ts:431](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L431) - Count of null/empty values --- @@ -72,8 +58,6 @@ Count of null/empty values > **uniqueCount**: `number` -Defined in: [types/file.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L433) - Count of unique values --- @@ -82,8 +66,6 @@ Count of unique values > **sampleValues**: `string`[] -Defined in: [types/file.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L435) - Sample values from this column (up to 5) --- @@ -92,8 +74,6 @@ Sample values from this column (up to 5) > `optional` **minValue?**: `number` -Defined in: [types/file.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L437) - For numeric columns: min value --- @@ -102,8 +82,6 @@ For numeric columns: min value > `optional` **maxValue?**: `number` -Defined in: [types/file.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L439) - For numeric columns: max value --- @@ -112,8 +90,6 @@ For numeric columns: max value > `optional` **avgValue?**: `number` -Defined in: [types/file.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L441) - For numeric columns: average value --- @@ -122,8 +98,6 @@ For numeric columns: average value > `optional` **dateFormat?**: `string` -Defined in: [types/file.ts:443](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L443) - For date columns: detected format (e.g., 'YYYY-MM-DD', 'MM/DD/YYYY') --- @@ -132,6 +106,4 @@ For date columns: detected format (e.g., 'YYYY-MM-DD', 'MM/DD/YYYY') > `optional` **nameIssues?**: `string`[] -Defined in: [types/file.ts:445](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L445) - Column name validation issues diff --git a/docs/api/type-aliases/CSVContent.md b/docs/api/type-aliases/CSVContent.md index 1d4c305cf..24c917593 100644 --- a/docs/api/type-aliases/CSVContent.md +++ b/docs/api/type-aliases/CSVContent.md @@ -8,8 +8,6 @@ > **CSVContent** = `object` -Defined in: [types/multimodal.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L81) - CSV content type for multimodal messages ## Properties @@ -18,24 +16,18 @@ CSV content type for multimodal messages > **type**: `"csv"` -Defined in: [types/multimodal.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L82) - --- ### data > **data**: `Buffer` \| `string` -Defined in: [types/multimodal.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L83) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/multimodal.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L84) - #### filename? > `optional` **filename?**: `string` diff --git a/docs/api/type-aliases/CSVDataQualityWarning.md b/docs/api/type-aliases/CSVDataQualityWarning.md index 75bd52db7..b6250f6cc 100644 --- a/docs/api/type-aliases/CSVDataQualityWarning.md +++ b/docs/api/type-aliases/CSVDataQualityWarning.md @@ -8,8 +8,6 @@ > **CSVDataQualityWarning** = `object` -Defined in: [types/file.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L405) - Data quality warning for CSV columns ## Properties @@ -18,36 +16,26 @@ Data quality warning for CSV columns > **column**: `string` -Defined in: [types/file.ts:406](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L406) - --- ### type > **type**: `"empty_values"` \| `"invalid_name"` \| `"mixed_types"` \| `"high_null_rate"` \| `"duplicates"` \| `"inconsistent_format"` -Defined in: [types/file.ts:407](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L407) - --- ### message > **message**: `string` -Defined in: [types/file.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L414) - --- ### severity > **severity**: `"info"` \| `"warning"` \| `"error"` -Defined in: [types/file.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L415) - --- ### affectedRows? > `optional` **affectedRows?**: `number` - -Defined in: [types/file.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L416) diff --git a/docs/api/type-aliases/CSVLoaderOptions.md b/docs/api/type-aliases/CSVLoaderOptions.md index ea7c433cb..0367e2af1 100644 --- a/docs/api/type-aliases/CSVLoaderOptions.md +++ b/docs/api/type-aliases/CSVLoaderOptions.md @@ -8,8 +8,6 @@ > **CSVLoaderOptions** = [`LoaderOptions`](LoaderOptions.md) & `object` -Defined in: [types/rag.ts:623](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L623) - CSV loader options ## Type Declaration diff --git a/docs/api/type-aliases/CSVProcessorOptions.md b/docs/api/type-aliases/CSVProcessorOptions.md index 9ec3ef951..6b0c6d1d7 100644 --- a/docs/api/type-aliases/CSVProcessorOptions.md +++ b/docs/api/type-aliases/CSVProcessorOptions.md @@ -8,8 +8,6 @@ > **CSVProcessorOptions** = `object` -Defined in: [types/file.ts:464](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L464) - CSV processor options ## Properties @@ -18,48 +16,36 @@ CSV processor options > `optional` **maxRows?**: `number` -Defined in: [types/file.ts:465](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L465) - --- ### formatStyle? > `optional` **formatStyle?**: `"raw"` \| `"markdown"` \| `"json"` -Defined in: [types/file.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L466) - --- ### includeHeaders? > `optional` **includeHeaders?**: `boolean` -Defined in: [types/file.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L467) - --- ### sampleDataFormat? > `optional` **sampleDataFormat?**: [`SampleDataFormat`](SampleDataFormat.md) -Defined in: [types/file.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L468) - --- ### extension? > `optional` **extension?**: `string` \| `null` -Defined in: [types/file.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L469) - --- ### encoding? > `optional` **encoding?**: `string` -Defined in: [types/file.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L475) - Character encoding override (#362). When omitted, the encoding is detected from a BOM then `chardet`, falling back to UTF-8. Accepts any label `iconv-lite` supports (e.g. "utf-8", "utf-16le", "windows-1252", "latin1"). @@ -70,8 +56,6 @@ from a BOM then `chardet`, falling back to UTF-8. Accepts any label > `optional` **sanitizeColumnNames?**: `boolean` -Defined in: [types/file.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L480) - Rewrite column headers into valid identifiers (#378). Opt-in; default false preserves the raw header strings as object keys. @@ -81,8 +65,6 @@ preserves the raw header strings as object keys. > `optional` **columnNameCase?**: `"camelCase"` \| `"snake_case"` -Defined in: [types/file.ts:482](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L482) - Case style used when `sanitizeColumnNames` is on (#378). Default "snake_case". --- @@ -91,8 +73,6 @@ Case style used when `sanitizeColumnNames` is on (#378). Default "snake_case". > `optional` **parseTimeoutMs?**: `number` -Defined in: [types/file.ts:488](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L488) - Wall-clock cap for the streaming parse in milliseconds (#379). On timeout the parse returns the rows collected so far and flags `metadata.parseTimedOut`, rather than hanging forever. Defaults: 30s for strings, 5min for files. @@ -103,8 +83,6 @@ rather than hanging forever. Defaults: 30s for strings, 5min for files. > `optional` **skipEmptyLines?**: `boolean` -Defined in: [types/file.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L494) - Skip blank / whitespace-only data rows (#373). Default `true`: blank lines are excluded from the returned content (including raw CSV text) and from `metadata.rowCount`. Set to `false` to preserve empty lines literally. diff --git a/docs/api/type-aliases/CSVRow.md b/docs/api/type-aliases/CSVRow.md index f24e761fe..905a9d7a4 100644 --- a/docs/api/type-aliases/CSVRow.md +++ b/docs/api/type-aliases/CSVRow.md @@ -8,6 +8,4 @@ > **CSVRow** = `Record`\<`string`, `string` \| `undefined`\> -Defined in: [types/file.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L449) - A parsed CSV row: string-keyed with string (or missing) cell values (#384). diff --git a/docs/api/type-aliases/CacheConfig.md b/docs/api/type-aliases/CacheConfig.md index dc12560b5..bd39bd54f 100644 --- a/docs/api/type-aliases/CacheConfig.md +++ b/docs/api/type-aliases/CacheConfig.md @@ -8,8 +8,6 @@ > **CacheConfig** = `object` -Defined in: [types/config.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L344) - Cache configuration ## Properties @@ -18,44 +16,32 @@ Cache configuration > `optional` **enabled?**: `boolean` -Defined in: [types/config.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L345) - --- ### ttlMs? > `optional` **ttlMs?**: `number` -Defined in: [types/config.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L346) - --- ### strategy? > `optional` **strategy?**: `"memory"` \| `"writeThrough"` \| `"cacheAside"` -Defined in: [types/config.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L347) - --- ### maxSize? > `optional` **maxSize?**: `number` -Defined in: [types/config.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L348) - --- ### persistToDisk? > `optional` **persistToDisk?**: `boolean` -Defined in: [types/config.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L349) - --- ### diskPath? > `optional` **diskPath?**: `string` - -Defined in: [types/config.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L350) diff --git a/docs/api/type-aliases/CacheEntry.md b/docs/api/type-aliases/CacheEntry.md index f04155349..6c6a2b2de 100644 --- a/docs/api/type-aliases/CacheEntry.md +++ b/docs/api/type-aliases/CacheEntry.md @@ -8,36 +8,26 @@ > **CacheEntry** = `object` -Defined in: [types/server.ts:1337](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1337) - ## Properties ### data > **data**: `unknown` -Defined in: [types/server.ts:1338](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1338) - --- ### createdAt > **createdAt**: `number` -Defined in: [types/server.ts:1339](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1339) - --- ### ttlMs > **ttlMs**: `number` -Defined in: [types/server.ts:1340](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1340) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> - -Defined in: [types/server.ts:1341](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1341) diff --git a/docs/api/type-aliases/CacheEvents.md b/docs/api/type-aliases/CacheEvents.md index 9b26fa268..216f82785 100644 --- a/docs/api/type-aliases/CacheEvents.md +++ b/docs/api/type-aliases/CacheEvents.md @@ -8,8 +8,6 @@ > **CacheEvents** = `object` -Defined in: [types/mcp.ts:2435](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2435) - Cache events ## Properties @@ -18,8 +16,6 @@ Cache events > **hit**: `object` -Defined in: [types/mcp.ts:2436](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2436) - #### key > **key**: `string` @@ -34,8 +30,6 @@ Defined in: [types/mcp.ts:2436](https://github.com/juspay/neurolink/blob/release > **miss**: `object` -Defined in: [types/mcp.ts:2437](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2437) - #### key > **key**: `string` @@ -46,8 +40,6 @@ Defined in: [types/mcp.ts:2437](https://github.com/juspay/neurolink/blob/release > **set**: `object` -Defined in: [types/mcp.ts:2438](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2438) - #### key > **key**: `string` @@ -66,8 +58,6 @@ Defined in: [types/mcp.ts:2438](https://github.com/juspay/neurolink/blob/release > **evict**: `object` -Defined in: [types/mcp.ts:2439](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2439) - #### key > **key**: `string` @@ -82,8 +72,6 @@ Defined in: [types/mcp.ts:2439](https://github.com/juspay/neurolink/blob/release > **clear**: `object` -Defined in: [types/mcp.ts:2440](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2440) - #### entriesRemoved > **entriesRemoved**: `number` diff --git a/docs/api/type-aliases/CacheInterceptorOptions.md b/docs/api/type-aliases/CacheInterceptorOptions.md index 96f552346..861a1ff4a 100644 --- a/docs/api/type-aliases/CacheInterceptorOptions.md +++ b/docs/api/type-aliases/CacheInterceptorOptions.md @@ -8,8 +8,6 @@ > **CacheInterceptorOptions** = `object` -Defined in: [types/client.ts:1345](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1345) - Cache options ## Properties @@ -18,8 +16,6 @@ Cache options > **ttl**: `number` -Defined in: [types/client.ts:1347](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1347) - Cache TTL in milliseconds --- @@ -28,8 +24,6 @@ Cache TTL in milliseconds > `optional` **maxSize?**: `number` -Defined in: [types/client.ts:1349](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1349) - Maximum cache size --- @@ -38,8 +32,6 @@ Maximum cache size > `optional` **keyGenerator?**: (`request`) => `string` -Defined in: [types/client.ts:1351](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1351) - Cache key generator #### Parameters @@ -58,8 +50,6 @@ Cache key generator > `optional` **methods?**: `string`[] -Defined in: [types/client.ts:1353](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1353) - Methods to cache (default: ['GET']) --- @@ -68,8 +58,6 @@ Methods to cache (default: ['GET']) > `optional` **includePaths?**: `RegExp`[] -Defined in: [types/client.ts:1355](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1355) - Paths to cache (regex patterns) --- @@ -78,6 +66,4 @@ Paths to cache (regex patterns) > `optional` **excludePaths?**: `RegExp`[] -Defined in: [types/client.ts:1357](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1357) - Paths to exclude from cache diff --git a/docs/api/type-aliases/CacheOptions.md b/docs/api/type-aliases/CacheOptions.md index 22aca8a89..bd227b89f 100644 --- a/docs/api/type-aliases/CacheOptions.md +++ b/docs/api/type-aliases/CacheOptions.md @@ -8,8 +8,6 @@ > **CacheOptions** = `object` -Defined in: [types/tools.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L98) - Cache configuration options Moved from src/lib/mcp/contracts/mcpContract.ts @@ -19,20 +17,14 @@ Moved from src/lib/mcp/contracts/mcpContract.ts > `optional` **enabled?**: `boolean` -Defined in: [types/tools.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L99) - --- ### ttlMs? > `optional` **ttlMs?**: `number` -Defined in: [types/tools.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L100) - --- ### strategy? > `optional` **strategy?**: `"memory"` \| `"writeThrough"` \| `"cacheAside"` - -Defined in: [types/tools.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L101) diff --git a/docs/api/type-aliases/CacheStats.md b/docs/api/type-aliases/CacheStats.md index 0a560aa70..3af47472c 100644 --- a/docs/api/type-aliases/CacheStats.md +++ b/docs/api/type-aliases/CacheStats.md @@ -8,8 +8,6 @@ > **CacheStats** = `object` -Defined in: [types/mcp.ts:2422](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2422) - Cache statistics ## Properties @@ -18,44 +16,32 @@ Cache statistics > **hits**: `number` -Defined in: [types/mcp.ts:2423](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2423) - --- ### misses > **misses**: `number` -Defined in: [types/mcp.ts:2424](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2424) - --- ### evictions > **evictions**: `number` -Defined in: [types/mcp.ts:2425](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2425) - --- ### size > **size**: `number` -Defined in: [types/mcp.ts:2426](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2426) - --- ### maxSize > **maxSize**: `number` -Defined in: [types/mcp.ts:2427](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2427) - --- ### hitRate > **hitRate**: `number` - -Defined in: [types/mcp.ts:2428](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2428) diff --git a/docs/api/type-aliases/CacheStore.md b/docs/api/type-aliases/CacheStore.md index 326ca32c9..0af0dd20c 100644 --- a/docs/api/type-aliases/CacheStore.md +++ b/docs/api/type-aliases/CacheStore.md @@ -8,16 +8,12 @@ > **CacheStore** = `object` -Defined in: [types/server.ts:1320](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1320) - ## Methods ### get() > **get**(`key`): `Promise`\<[`CacheEntry`](CacheEntry.md) \| `undefined`\> -Defined in: [types/server.ts:1321](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1321) - #### Parameters ##### key @@ -34,8 +30,6 @@ Defined in: [types/server.ts:1321](https://github.com/juspay/neurolink/blob/rele > **set**(`key`, `entry`): `Promise`\<`void`\> -Defined in: [types/server.ts:1322](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1322) - #### Parameters ##### key @@ -56,8 +50,6 @@ Defined in: [types/server.ts:1322](https://github.com/juspay/neurolink/blob/rele > **delete**(`key`): `Promise`\<`void`\> -Defined in: [types/server.ts:1323](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1323) - #### Parameters ##### key @@ -74,8 +66,6 @@ Defined in: [types/server.ts:1323](https://github.com/juspay/neurolink/blob/rele > **clear**(): `Promise`\<`void`\> -Defined in: [types/server.ts:1324](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1324) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/type-aliases/CacheStrategy.md b/docs/api/type-aliases/CacheStrategy.md index 882bd9909..b2f9f2502 100644 --- a/docs/api/type-aliases/CacheStrategy.md +++ b/docs/api/type-aliases/CacheStrategy.md @@ -8,6 +8,4 @@ > **CacheStrategy** = `"lru"` \| `"fifo"` \| `"lfu"` -Defined in: [types/mcp.ts:2380](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2380) - Cache eviction strategy diff --git a/docs/api/type-aliases/CachedImage.md b/docs/api/type-aliases/CachedImage.md index 90d61d093..30587dae9 100644 --- a/docs/api/type-aliases/CachedImage.md +++ b/docs/api/type-aliases/CachedImage.md @@ -8,8 +8,6 @@ > **CachedImage** = `object` -Defined in: [types/utilities.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L234) - Cached image entry structure for image cache ## Properties @@ -18,8 +16,6 @@ Cached image entry structure for image cache > **dataUri**: `string` -Defined in: [types/utilities.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L236) - The image data as a base64 data URI --- @@ -28,8 +24,6 @@ The image data as a base64 data URI > **contentType**: `string` -Defined in: [types/utilities.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L238) - Content type of the image (e.g., "image/jpeg") --- @@ -38,8 +32,6 @@ Content type of the image (e.g., "image/jpeg") > **size**: `number` -Defined in: [types/utilities.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L240) - Size of the image in bytes --- @@ -48,8 +40,6 @@ Size of the image in bytes > **contentHash**: `string` -Defined in: [types/utilities.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L242) - SHA-256 hash of the image content for deduplication --- @@ -58,8 +48,6 @@ SHA-256 hash of the image content for deduplication > **createdAt**: `number` -Defined in: [types/utilities.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L244) - Timestamp when the entry was created --- @@ -68,8 +56,6 @@ Timestamp when the entry was created > **lastAccessedAt**: `number` -Defined in: [types/utilities.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L246) - Timestamp of last access --- @@ -78,6 +64,4 @@ Timestamp of last access > **accessCount**: `number` -Defined in: [types/utilities.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L248) - Number of times this entry was accessed diff --git a/docs/api/type-aliases/CachedSession.md b/docs/api/type-aliases/CachedSession.md index 3d7ab4d75..5c0f64764 100644 --- a/docs/api/type-aliases/CachedSession.md +++ b/docs/api/type-aliases/CachedSession.md @@ -8,8 +8,6 @@ > **CachedSession** = `object` -Defined in: [types/proxy.ts:2093](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2093) - Cached session entry with TTL for the SessionIdentity cloaking plugin. ## Properties @@ -18,12 +16,8 @@ Cached session entry with TTL for the SessionIdentity cloaking plugin. > **userId**: `string` -Defined in: [types/proxy.ts:2094](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2094) - --- ### expiresAt > **expiresAt**: `number` - -Defined in: [types/proxy.ts:2095](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2095) diff --git a/docs/api/type-aliases/CallRecord.md b/docs/api/type-aliases/CallRecord.md index 25b214bad..116174da9 100644 --- a/docs/api/type-aliases/CallRecord.md +++ b/docs/api/type-aliases/CallRecord.md @@ -8,8 +8,6 @@ > **CallRecord** = `object` -Defined in: [types/mcp.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L348) - Call record for circuit breaker statistics tracking. Superset shape: MCP breaker uses {timestamp, success, duration}; RAG breaker also tracks `operationType` (optional, for routing and @@ -21,28 +19,20 @@ metrics). Both import from here. > **timestamp**: `number` -Defined in: [types/mcp.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L349) - --- ### success > **success**: `boolean` -Defined in: [types/mcp.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L350) - --- ### duration > **duration**: `number` -Defined in: [types/mcp.ts:351](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L351) - --- ### operationType? > `optional` **operationType?**: `string` - -Defined in: [types/mcp.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L352) diff --git a/docs/api/type-aliases/CallbackResult.md b/docs/api/type-aliases/CallbackResult.md index 3d04ad6ec..18e70dda3 100644 --- a/docs/api/type-aliases/CallbackResult.md +++ b/docs/api/type-aliases/CallbackResult.md @@ -8,8 +8,6 @@ > **CallbackResult** = `object` -Defined in: [types/subscription.ts:1042](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1042) - Callback server result containing the authorization code ## Properties @@ -18,8 +16,6 @@ Callback server result containing the authorization code > **code**: `string` -Defined in: [types/subscription.ts:1044](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1044) - Authorization code from OAuth callback --- @@ -28,6 +24,4 @@ Authorization code from OAuth callback > `optional` **state?**: `string` -Defined in: [types/subscription.ts:1046](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1046) - State parameter for CSRF verification diff --git a/docs/api/type-aliases/CartesiaMessage.md b/docs/api/type-aliases/CartesiaMessage.md index 1279b0930..43312e9ae 100644 --- a/docs/api/type-aliases/CartesiaMessage.md +++ b/docs/api/type-aliases/CartesiaMessage.md @@ -8,8 +8,6 @@ > **CartesiaMessage** = `object` -Defined in: [types/tts.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L310) - Message envelope received from the Cartesia TTS WebSocket. ## Properties @@ -18,20 +16,14 @@ Message envelope received from the Cartesia TTS WebSocket. > `optional` **data?**: `string` -Defined in: [types/tts.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L311) - --- ### done? > `optional` **done?**: `boolean` -Defined in: [types/tts.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L312) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/tts.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L313) diff --git a/docs/api/type-aliases/CatalogBillingPolicy.md b/docs/api/type-aliases/CatalogBillingPolicy.md index 95cc866ba..cc96af39c 100644 --- a/docs/api/type-aliases/CatalogBillingPolicy.md +++ b/docs/api/type-aliases/CatalogBillingPolicy.md @@ -7,5 +7,3 @@ # Type Alias: CatalogBillingPolicy > **CatalogBillingPolicy** = `"free-tier"` \| `"free-with-card"` \| `"no-free-tier"` - -Defined in: [types/providerCatalog.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L87) diff --git a/docs/api/type-aliases/CatalogCapabilities.md b/docs/api/type-aliases/CatalogCapabilities.md index f6b5921a2..6ff52ae02 100644 --- a/docs/api/type-aliases/CatalogCapabilities.md +++ b/docs/api/type-aliases/CatalogCapabilities.md @@ -8,32 +8,24 @@ > **CatalogCapabilities** = `object` -Defined in: [types/providerCatalog.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L121) - ## Properties ### text > **text**: `boolean` -Defined in: [types/providerCatalog.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L122) - --- ### streaming > **streaming**: `boolean` -Defined in: [types/providerCatalog.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L123) - --- ### tools > **tools**: `boolean` \| `"model-dependent"` -Defined in: [types/providerCatalog.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L131) - "model-dependent" when tool support varies per served model and the vendor doesn't reject `tools` for unsupported ones (the model just never emits tool_calls) — e.g. HuggingFace's router. Maps to @@ -48,36 +40,26 @@ default, exactly like an entry that never set supportsTools at all. > **toolsWithStreaming**: `boolean` -Defined in: [types/providerCatalog.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L132) - --- ### structuredOutput > **structuredOutput**: `boolean` -Defined in: [types/providerCatalog.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L133) - --- ### structuredOutputWithTools > **structuredOutputWithTools**: `boolean` -Defined in: [types/providerCatalog.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L134) - --- ### embeddings > **embeddings**: `boolean` -Defined in: [types/providerCatalog.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L135) - --- ### thinking > **thinking**: `boolean` - -Defined in: [types/providerCatalog.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L136) diff --git a/docs/api/type-aliases/CatalogCredentialKey.md b/docs/api/type-aliases/CatalogCredentialKey.md index d66d58231..46d03a231 100644 --- a/docs/api/type-aliases/CatalogCredentialKey.md +++ b/docs/api/type-aliases/CatalogCredentialKey.md @@ -7,5 +7,3 @@ # Type Alias: CatalogCredentialKey > **CatalogCredentialKey** = `"apiRoute"` \| `"baseten"` \| `"cerebras"` \| `"cloudflare"` \| `"deepseek"` \| `"fireworks"` \| `"friendli"` \| `"gmicloud"` \| `"groq"` \| `"huggingFace"` \| `"inceptionLabs"` \| `"ioIntelligence"` \| `"mancer"` \| `"mistral"` \| `"perplexity"` \| `"sambanova"` \| `"together"` \| `"upstage"` \| `"xai"` - -Defined in: [types/providerCatalog.generated.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.generated.ts#L22) diff --git a/docs/api/type-aliases/CatalogErrorRuleClass.md b/docs/api/type-aliases/CatalogErrorRuleClass.md index 0b6d46428..504a25e03 100644 --- a/docs/api/type-aliases/CatalogErrorRuleClass.md +++ b/docs/api/type-aliases/CatalogErrorRuleClass.md @@ -7,5 +7,3 @@ # Type Alias: CatalogErrorRuleClass > **CatalogErrorRuleClass** = `"authentication"` \| `"rate-limit"` \| `"invalid-model"` \| `"network"` \| `"provider"` - -Defined in: [types/providerCatalog.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L57) diff --git a/docs/api/type-aliases/CatalogErrorRuleJson.md b/docs/api/type-aliases/CatalogErrorRuleJson.md index 9817b2706..1c98dd523 100644 --- a/docs/api/type-aliases/CatalogErrorRuleJson.md +++ b/docs/api/type-aliases/CatalogErrorRuleJson.md @@ -8,36 +8,26 @@ > **CatalogErrorRuleJson** = `object` -Defined in: [types/providerCatalog.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L64) - ## Properties ### status? > `optional` **status?**: `number` -Defined in: [types/providerCatalog.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L65) - --- ### pattern? > `optional` **pattern?**: `string` -Defined in: [types/providerCatalog.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L66) - --- ### class > **class**: [`CatalogErrorRuleClass`](CatalogErrorRuleClass.md) -Defined in: [types/providerCatalog.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L67) - --- ### message > **message**: `string` - -Defined in: [types/providerCatalog.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L68) diff --git a/docs/api/type-aliases/CatalogEvidence.md b/docs/api/type-aliases/CatalogEvidence.md index b28a29232..3b28351f4 100644 --- a/docs/api/type-aliases/CatalogEvidence.md +++ b/docs/api/type-aliases/CatalogEvidence.md @@ -8,44 +8,32 @@ > **CatalogEvidence** = `object` -Defined in: [types/providerCatalog.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L113) - ## Properties ### rosterVerified > **rosterVerified**: [`CatalogProbeEvidence`](CatalogProbeEvidence.md) -Defined in: [types/providerCatalog.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L114) - --- ### authProbe? > `optional` **authProbe?**: [`CatalogProbeEvidence`](CatalogProbeEvidence.md) -Defined in: [types/providerCatalog.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L115) - --- ### billingProbe? > `optional` **billingProbe?**: [`CatalogProbeEvidence`](CatalogProbeEvidence.md) -Defined in: [types/providerCatalog.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L116) - --- ### liveMatrix > **liveMatrix**: \{ `date`: `string`; `result`: `string`; \} \| `null` -Defined in: [types/providerCatalog.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L117) - --- ### addedInPR > **addedInPR**: `string` - -Defined in: [types/providerCatalog.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L118) diff --git a/docs/api/type-aliases/CatalogModelSpec.md b/docs/api/type-aliases/CatalogModelSpec.md index 3a6394fe3..50b798460 100644 --- a/docs/api/type-aliases/CatalogModelSpec.md +++ b/docs/api/type-aliases/CatalogModelSpec.md @@ -8,64 +8,48 @@ > **CatalogModelSpec** = `object` -Defined in: [types/providerCatalog.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L29) - ## Properties ### contextWindow? > `optional` **contextWindow?**: `number` -Defined in: [types/providerCatalog.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L30) - --- ### maxOutputTokens? > `optional` **maxOutputTokens?**: `number` -Defined in: [types/providerCatalog.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L31) - --- ### pricingPerMTok? > `optional` **pricingPerMTok?**: [`CatalogPricingPerMTok`](CatalogPricingPerMTok.md) -Defined in: [types/providerCatalog.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L32) - --- ### vision > **vision**: `boolean` -Defined in: [types/providerCatalog.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L33) - --- ### status > **status**: [`CatalogModelStatus`](CatalogModelStatus.md) -Defined in: [types/providerCatalog.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L34) - --- ### description > **description**: `string` -Defined in: [types/providerCatalog.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L35) - --- ### enumMember? > `optional` **enumMember?**: `string` -Defined in: [types/providerCatalog.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L41) - Enum member name override. Default is the derived constant-case of the model id; REQUIRED where the derived name differs from a pre-existing exported member (public-surface compatibility). diff --git a/docs/api/type-aliases/CatalogModelStatus.md b/docs/api/type-aliases/CatalogModelStatus.md index b0ad5a709..2925026b0 100644 --- a/docs/api/type-aliases/CatalogModelStatus.md +++ b/docs/api/type-aliases/CatalogModelStatus.md @@ -7,5 +7,3 @@ # Type Alias: CatalogModelStatus > **CatalogModelStatus** = `"production"` \| `"preview"` \| `"retired"` - -Defined in: [types/providerCatalog.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L14) diff --git a/docs/api/type-aliases/CatalogPricingPerMTok.md b/docs/api/type-aliases/CatalogPricingPerMTok.md index 7b5d57608..a9e007fc0 100644 --- a/docs/api/type-aliases/CatalogPricingPerMTok.md +++ b/docs/api/type-aliases/CatalogPricingPerMTok.md @@ -8,8 +8,6 @@ > **CatalogPricingPerMTok** = `object` -Defined in: [types/providerCatalog.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L8) - Single-JSON provider catalog — the authoring format for Tier-2 (zero-quirk OpenAI-compatible) providers. One src/lib/providers/catalog/.json file per provider is the single @@ -21,20 +19,14 @@ source of truth; see docs/superpowers/plans/2026-08-28-provider-json-catalog-spe > **input**: `number` -Defined in: [types/providerCatalog.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L9) - --- ### output > **output**: `number` -Defined in: [types/providerCatalog.ts:10](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L10) - --- ### cachedInput? > `optional` **cachedInput?**: `number` - -Defined in: [types/providerCatalog.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L11) diff --git a/docs/api/type-aliases/CatalogProbeEvidence.md b/docs/api/type-aliases/CatalogProbeEvidence.md index d8aa70d2a..9cc8f4d10 100644 --- a/docs/api/type-aliases/CatalogProbeEvidence.md +++ b/docs/api/type-aliases/CatalogProbeEvidence.md @@ -8,36 +8,26 @@ > **CatalogProbeEvidence** = `object` -Defined in: [types/providerCatalog.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L106) - ## Properties ### date > **date**: `string` -Defined in: [types/providerCatalog.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L107) - --- ### status? > `optional` **status?**: `number` -Defined in: [types/providerCatalog.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L108) - --- ### code? > `optional` **code?**: `string` -Defined in: [types/providerCatalog.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L109) - --- ### method? > `optional` **method?**: `string` - -Defined in: [types/providerCatalog.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L110) diff --git a/docs/api/type-aliases/CatalogProviderName.md b/docs/api/type-aliases/CatalogProviderName.md index 8877112da..ea9145050 100644 --- a/docs/api/type-aliases/CatalogProviderName.md +++ b/docs/api/type-aliases/CatalogProviderName.md @@ -7,5 +7,3 @@ # Type Alias: CatalogProviderName > **CatalogProviderName** = `"api-route"` \| `"baseten"` \| `"cerebras"` \| `"cloudflare"` \| `"deepseek"` \| `"fireworks"` \| `"friendli"` \| `"gmicloud"` \| `"groq"` \| `"huggingface"` \| `"inception-labs"` \| `"io-intelligence"` \| `"mancer"` \| `"mistral"` \| `"perplexity"` \| `"sambanova"` \| `"together-ai"` \| `"upstage"` \| `"xai"` - -Defined in: [types/providerCatalog.generated.ts:2](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.generated.ts#L2) diff --git a/docs/api/type-aliases/CatalogQuirks.md b/docs/api/type-aliases/CatalogQuirks.md index 285110f07..abff8c1a7 100644 --- a/docs/api/type-aliases/CatalogQuirks.md +++ b/docs/api/type-aliases/CatalogQuirks.md @@ -8,24 +8,18 @@ > **CatalogQuirks** = `object` -Defined in: [types/providerCatalog.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L71) - ## Properties ### timeoutErrorClass? > `optional` **timeoutErrorClass?**: `"provider"` -Defined in: [types/providerCatalog.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L72) - --- ### messageContentFormat? > `optional` **messageContentFormat?**: `"string"` -Defined in: [types/providerCatalog.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L78) - Vendor speaks OpenAI for chat but restricts how message content is encoded. "string": `messages[].content` must be a plain string — the content-parts array and the `null` OpenAI uses on an assistant @@ -38,16 +32,12 @@ ConfiguredOpenAICompatProvider so tool round-trips work. > `optional` **registryDefaultIgnoresModelEnvVar?**: `boolean` -Defined in: [types/providerCatalog.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L79) - --- ### responseFormatDowngrade? > `optional` **responseFormatDowngrade?**: `"json-schema-to-json-object"` -Defined in: [types/providerCatalog.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L84) - Vendor rejects `response_format: { type: "json_schema" }` outright but accepts `{ type: "json_object" }`. Normalized by ConfiguredOpenAICompatProvider so `generate({ schema })` keeps working diff --git a/docs/api/type-aliases/CatalogSetup.md b/docs/api/type-aliases/CatalogSetup.md index 1adcc2422..0f2f32fe2 100644 --- a/docs/api/type-aliases/CatalogSetup.md +++ b/docs/api/type-aliases/CatalogSetup.md @@ -8,48 +8,36 @@ > **CatalogSetup** = `object` -Defined in: [types/providerCatalog.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L92) - ## Properties ### url > **url**: `string` -Defined in: [types/providerCatalog.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L93) - --- ### apiKeyFormat > **apiKeyFormat**: `string` \| `null` -Defined in: [types/providerCatalog.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L94) - --- ### billingPolicy > **billingPolicy**: [`CatalogBillingPolicy`](CatalogBillingPolicy.md) -Defined in: [types/providerCatalog.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L95) - --- ### instructions > **instructions**: `string`[] -Defined in: [types/providerCatalog.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L96) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/providerCatalog.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L103) - Config-options description shown to callers for this credential. Default: "API key". Set explicitly where the legacy entry's description carries real information a generic "API key" loses diff --git a/docs/api/type-aliases/CatalogTimeouts.md b/docs/api/type-aliases/CatalogTimeouts.md index 7077c5880..02ad8bdcd 100644 --- a/docs/api/type-aliases/CatalogTimeouts.md +++ b/docs/api/type-aliases/CatalogTimeouts.md @@ -8,8 +8,6 @@ > **CatalogTimeouts** = `object` -Defined in: [types/providerCatalog.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L24) - Descriptor-only per-provider turn-budget override — mirrors ProviderDescriptor.timeouts field-for-field (src/lib/types/providers.ts). Consumed only by buildCatalogDescriptor() (providerDescriptors.ts), never @@ -23,12 +21,8 @@ value preserves its pre-migration hand-typed descriptor exactly. > `optional` **generateMs?**: `number` -Defined in: [types/providerCatalog.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L25) - --- ### streamMs? > `optional` **streamMs?**: `number` - -Defined in: [types/providerCatalog.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L26) diff --git a/docs/api/type-aliases/CatalogWire.md b/docs/api/type-aliases/CatalogWire.md index 92580e9aa..5858821fc 100644 --- a/docs/api/type-aliases/CatalogWire.md +++ b/docs/api/type-aliases/CatalogWire.md @@ -8,48 +8,36 @@ > **CatalogWire** = `object` -Defined in: [types/providerCatalog.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L44) - ## Properties ### baseURL? > `optional` **baseURL?**: `string` -Defined in: [types/providerCatalog.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L45) - --- ### baseURLTemplate? > `optional` **baseURLTemplate?**: `string` -Defined in: [types/providerCatalog.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L46) - --- ### extraCredentials? > `optional` **extraCredentials?**: `string`[] -Defined in: [types/providerCatalog.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L47) - --- ### missingCredentialMessage? > `optional` **missingCredentialMessage?**: `string` -Defined in: [types/providerCatalog.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L48) - --- ### envOverrides? > `optional` **envOverrides?**: `object` -Defined in: [types/providerCatalog.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L49) - #### apiKey? > `optional` **apiKey?**: `string` @@ -68,8 +56,6 @@ Defined in: [types/providerCatalog.ts:49](https://github.com/juspay/neurolink/bl > `optional` **apiKeyFallbackEnvVars?**: `string`[] -Defined in: [types/providerCatalog.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L54) - Additional env vars validateApiKey() tries, in order, when the primary apiKeyEnvVar is unset (e.g. HuggingFace's HF_TOKEN alongside HUGGINGFACE_API_KEY). Consumed by buildCatalogConfigOptions() via diff --git a/docs/api/type-aliases/CategoryMapping.md b/docs/api/type-aliases/CategoryMapping.md index 1790fcfed..9d7b67f27 100644 --- a/docs/api/type-aliases/CategoryMapping.md +++ b/docs/api/type-aliases/CategoryMapping.md @@ -8,8 +8,6 @@ > **CategoryMapping** = `object` -Defined in: [types/mcp.ts:2469](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2469) - Category to server mapping ## Properties @@ -18,20 +16,14 @@ Category to server mapping > **category**: `string` -Defined in: [types/mcp.ts:2470](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2470) - --- ### serverIds > **serverIds**: `string`[] -Defined in: [types/mcp.ts:2471](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2471) - --- ### priority? > `optional` **priority?**: `number` - -Defined in: [types/mcp.ts:2472](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2472) diff --git a/docs/api/type-aliases/CellValue.md b/docs/api/type-aliases/CellValue.md index 1bf419ba6..dd955aa00 100644 --- a/docs/api/type-aliases/CellValue.md +++ b/docs/api/type-aliases/CellValue.md @@ -8,6 +8,4 @@ > **CellValue** = `CellValue` -Defined in: [types/processor.ts:1124](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1124) - Alias for ExcelJS.CellValue to avoid leaking exceljs types across files. diff --git a/docs/api/type-aliases/CharacterChunkerConfig.md b/docs/api/type-aliases/CharacterChunkerConfig.md index 01d51b589..446b5bd9a 100644 --- a/docs/api/type-aliases/CharacterChunkerConfig.md +++ b/docs/api/type-aliases/CharacterChunkerConfig.md @@ -8,8 +8,6 @@ > **CharacterChunkerConfig** = [`BaseChunkerConfig`](BaseChunkerConfig.md) & `object` -Defined in: [types/rag.ts:905](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L905) - Character chunker configuration Simple character-based splitting diff --git a/docs/api/type-aliases/ChartSeries.md b/docs/api/type-aliases/ChartSeries.md index d9f0146fa..865901707 100644 --- a/docs/api/type-aliases/ChartSeries.md +++ b/docs/api/type-aliases/ChartSeries.md @@ -8,8 +8,6 @@ > **ChartSeries** = `object` -Defined in: [types/ppt.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L327) - Chart data series Maps to: addChart series format @@ -19,30 +17,22 @@ Maps to: addChart series format > **name**: `string` -Defined in: [types/ppt.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L328) - --- ### labels > **labels**: `string`[] -Defined in: [types/ppt.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L329) - --- ### values > **values**: `number`[] -Defined in: [types/ppt.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L330) - --- ### color? > `optional` **color?**: `string` -Defined in: [types/ppt.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L332) - Series color (hex) diff --git a/docs/api/type-aliases/ChatMessage.md b/docs/api/type-aliases/ChatMessage.md index d353380b9..5b3bb49cd 100644 --- a/docs/api/type-aliases/ChatMessage.md +++ b/docs/api/type-aliases/ChatMessage.md @@ -8,8 +8,6 @@ > **ChatMessage** = `object` -Defined in: [types/conversation.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L341) - Chat message format for conversation history ## Properties @@ -18,8 +16,6 @@ Chat message format for conversation history > **id**: `string` -Defined in: [types/conversation.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L343) - Unique message identifier (required for token-based memory) --- @@ -28,8 +24,6 @@ Unique message identifier (required for token-based memory) > **role**: `"user"` \| `"assistant"` \| `"system"` \| `"tool_call"` \| `"tool_result"` -Defined in: [types/conversation.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L346) - Role/type of the message --- @@ -38,8 +32,6 @@ Role/type of the message > **content**: `string` -Defined in: [types/conversation.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L349) - Content of the message --- @@ -48,8 +40,6 @@ Content of the message > `optional` **timestamp?**: `string` -Defined in: [types/conversation.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L357) - Message timestamp. Format: ISO 8601 string (e.g., "2025-01-01T12:30:00.000Z"). Optional - may be omitted for system-generated messages. @@ -61,8 +51,6 @@ Use `metadata.timestamp` for numeric Unix ms representation. > `optional` **tool?**: `string` -Defined in: [types/conversation.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L360) - Tool name (optional) - for tool_call/tool_result messages --- @@ -71,8 +59,6 @@ Tool name (optional) - for tool_call/tool_result messages > `optional` **toolCallId?**: `string` -Defined in: [types/conversation.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L372) - Provider tool-call correlation ID, carried on BOTH the `tool_call` and its matching `tool_result`. This is the only reliable way to pair the two: a step with parallel tool calls is persisted as every `tool_call` followed @@ -88,8 +74,6 @@ existed pair positionally within a batch (see repairToolPairs legacy mode). > `optional` **args?**: `Record`\<`string`, `unknown`\> -Defined in: [types/conversation.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L375) - Tool arguments (optional) - for tool_call messages --- @@ -98,8 +82,6 @@ Tool arguments (optional) - for tool_call messages > `optional` **result?**: [`ToolResultData`](ToolResultData.md) -Defined in: [types/conversation.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L378) - Tool result metadata (optional) - for tool_result messages --- @@ -108,8 +90,6 @@ Tool result metadata (optional) - for tool_result messages > `optional` **events?**: [`StreamEventSequence`](StreamEventSequence.md)[] -Defined in: [types/conversation.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L386) - Event sequence for rich history reconstruction Stores ordered events (text-chunk, ui-component, tool calls, HITL, etc.) Enables proper ordering and complete context restoration @@ -124,8 +104,6 @@ Enables proper ordering and complete context restoration > `optional` **metadata?**: [`ChatMessageMetadata`](ChatMessageMetadata.md) -Defined in: [types/conversation.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L389) - Message metadata --- @@ -134,8 +112,6 @@ Message metadata > `optional` **condenseId?**: `string` -Defined in: [types/conversation.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L392) - UUID identifying this condensation group --- @@ -144,8 +120,6 @@ UUID identifying this condensation group > `optional` **condenseParent?**: `string` -Defined in: [types/conversation.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L394) - Points to summary that replaces this message --- @@ -154,8 +128,6 @@ Points to summary that replaces this message > `optional` **truncationId?**: `string` -Defined in: [types/conversation.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L396) - UUID identifying this truncation group --- @@ -164,8 +136,6 @@ UUID identifying this truncation group > `optional` **truncationParent?**: `string` -Defined in: [types/conversation.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L398) - Points to truncation marker that hides this message --- @@ -174,6 +144,4 @@ Points to truncation marker that hides this message > `optional` **isTruncationMarker?**: `boolean` -Defined in: [types/conversation.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L400) - Marks this message as a truncation boundary marker diff --git a/docs/api/type-aliases/ChatMessageMetadata.md b/docs/api/type-aliases/ChatMessageMetadata.md index b7c21d39c..839da533d 100644 --- a/docs/api/type-aliases/ChatMessageMetadata.md +++ b/docs/api/type-aliases/ChatMessageMetadata.md @@ -8,8 +8,6 @@ > **ChatMessageMetadata** = `object` -Defined in: [types/conversation.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L268) - Metadata associated with a ChatMessage. ## Properties @@ -18,8 +16,6 @@ Metadata associated with a ChatMessage. > `optional` **isSummary?**: `boolean` -Defined in: [types/conversation.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L270) - Is this a summary message? --- @@ -28,8 +24,6 @@ Is this a summary message? > `optional` **summarizesFrom?**: `string` -Defined in: [types/conversation.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L272) - First message ID that this summary covers --- @@ -38,8 +32,6 @@ First message ID that this summary covers > `optional` **summarizesTo?**: `string` -Defined in: [types/conversation.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L274) - Last message ID that this summary covers --- @@ -48,8 +40,6 @@ Last message ID that this summary covers > `optional` **truncated?**: `boolean` -Defined in: [types/conversation.ts:276](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L276) - Was this message truncated due to token limits? --- @@ -58,8 +48,6 @@ Was this message truncated due to token limits? > `optional` **source?**: `string` -Defined in: [types/conversation.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L278) - Source of the message (e.g., provider name, user input) --- @@ -68,8 +56,6 @@ Source of the message (e.g., provider name, user input) > `optional` **language?**: `string` -Defined in: [types/conversation.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L280) - Language of the message content --- @@ -78,8 +64,6 @@ Language of the message content > `optional` **confidence?**: `number` -Defined in: [types/conversation.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L282) - Confidence score for AI-generated content --- @@ -88,8 +72,6 @@ Confidence score for AI-generated content > `optional` **timestamp?**: `number` -Defined in: [types/conversation.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L289) - Numeric timestamp for internal tracking and efficient comparisons. Format: Unix epoch milliseconds (number). Complements the ISO string `ChatMessage.timestamp` field. @@ -101,8 +83,6 @@ Use this for sorting, filtering, and performance-critical operations. > `optional` **modelUsed?**: `string` -Defined in: [types/conversation.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L291) - Model used to generate this message --- @@ -111,8 +91,6 @@ Model used to generate this message > `optional` **thoughtSignature?**: `string` -Defined in: [types/conversation.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L293) - Unique signature identifying thought/reasoning patterns --- @@ -121,8 +99,6 @@ Unique signature identifying thought/reasoning patterns > `optional` **thoughtHash?**: `string` -Defined in: [types/conversation.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L295) - Hash of the thinking/reasoning content for deduplication --- @@ -131,8 +107,6 @@ Hash of the thinking/reasoning content for deduplication > `optional` **thinkingExpanded?**: `boolean` -Defined in: [types/conversation.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L297) - Whether extended thinking was used for this message --- @@ -141,8 +115,6 @@ Whether extended thinking was used for this message > `optional` **stepIndex?**: `number` -Defined in: [types/conversation.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L299) - Step index for reconstructing parallel vs sequential tool calls --- @@ -151,8 +123,6 @@ Step index for reconstructing parallel vs sequential tool calls > `optional` **toolOutputPreview?**: `string` -Defined in: [types/conversation.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L309) - Head/tail preview of a large tool output. Only present on tool_result messages where the output exceeded truncation limits. When `sendToolPreview` is enabled in config, `buildContextMessages()` returns @@ -164,8 +134,6 @@ this value as the message content instead of the full output. > `optional` **originalSize?**: `number` -Defined in: [types/conversation.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L311) - Original byte size of the full tool output before any truncation --- @@ -174,8 +142,6 @@ Original byte size of the full tool output before any truncation > `optional` **artifactId?**: `string` -Defined in: [types/conversation.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L318) - Artifact store ID for an externalized MCP tool output. Set when `mcp.outputLimits.strategy = "externalize"` and the tool output exceeded `maxBytes`. Use retrieve_context with this ID to fetch the full @@ -187,8 +153,6 @@ payload from the local artifact store. > `optional` **isSkill?**: `boolean` -Defined in: [types/conversation.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L329) - Marks a pinned skill-activation message: the full instructions of a skill loaded via use_skill, persisted into session history so later turns replay it verbatim instead of re-fetching the skill. Pinned @@ -201,8 +165,6 @@ re-included after memory summarization. > `optional` **skillId?**: `string` -Defined in: [types/conversation.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L331) - Skill id of a pinned skill-activation message. --- @@ -211,8 +173,6 @@ Skill id of a pinned skill-activation message. > `optional` **skillName?**: `string` -Defined in: [types/conversation.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L333) - Skill name of a pinned skill-activation message. --- @@ -221,6 +181,4 @@ Skill name of a pinned skill-activation message. > `optional` **skillVersion?**: `number` -Defined in: [types/conversation.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L335) - Skill version captured at activation (sessions pin the activated version). diff --git a/docs/api/type-aliases/ChecklistCommandCounts.md b/docs/api/type-aliases/ChecklistCommandCounts.md index b98ff6ef8..928c77b4d 100644 --- a/docs/api/type-aliases/ChecklistCommandCounts.md +++ b/docs/api/type-aliases/ChecklistCommandCounts.md @@ -8,8 +8,6 @@ > **ChecklistCommandCounts** = `object` -Defined in: [types/tasks.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L59) - Background commands outstanding for a session. Populated by the background-command primitive; zero while that primitive is unused. @@ -19,12 +17,8 @@ background-command primitive; zero while that primitive is unused. > **running**: `number` -Defined in: [types/tasks.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L59) - --- ### finished > **finished**: `number` - -Defined in: [types/tasks.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L59) diff --git a/docs/api/type-aliases/ChecklistCommandCountsSource.md b/docs/api/type-aliases/ChecklistCommandCountsSource.md index bbe9b90e2..597bfc080 100644 --- a/docs/api/type-aliases/ChecklistCommandCountsSource.md +++ b/docs/api/type-aliases/ChecklistCommandCountsSource.md @@ -8,8 +8,6 @@ > **ChecklistCommandCountsSource** = (`sessionId`) => [`ChecklistCommandCounts`](ChecklistCommandCounts.md) -Defined in: [types/tasks.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L62) - Supplies [ChecklistCommandCounts](ChecklistCommandCounts.md) to every checklist tool result. ## Parameters diff --git a/docs/api/type-aliases/ChecklistCreateInput.md b/docs/api/type-aliases/ChecklistCreateInput.md index 32edd55a1..9c1efcc6d 100644 --- a/docs/api/type-aliases/ChecklistCreateInput.md +++ b/docs/api/type-aliases/ChecklistCreateInput.md @@ -8,12 +8,8 @@ > **ChecklistCreateInput** = `object` -Defined in: [types/tasks.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L36) - ## Properties ### titles > **titles**: `string`[] - -Defined in: [types/tasks.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L36) diff --git a/docs/api/type-aliases/ChecklistDelegateCounts.md b/docs/api/type-aliases/ChecklistDelegateCounts.md index 167dc8fb1..f06b796dd 100644 --- a/docs/api/type-aliases/ChecklistDelegateCounts.md +++ b/docs/api/type-aliases/ChecklistDelegateCounts.md @@ -8,8 +8,6 @@ > **ChecklistDelegateCounts** = `object` -Defined in: [types/tasks.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L48) - Background delegates outstanding for a session. Populated by the async delegation primitive; zero while that primitive is unused. @@ -19,12 +17,8 @@ delegation primitive; zero while that primitive is unused. > **pending**: `number` -Defined in: [types/tasks.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L48) - --- ### ready > **ready**: `number` - -Defined in: [types/tasks.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L48) diff --git a/docs/api/type-aliases/ChecklistDelegateCountsSource.md b/docs/api/type-aliases/ChecklistDelegateCountsSource.md index 9c4eb6f12..2b62a9a3f 100644 --- a/docs/api/type-aliases/ChecklistDelegateCountsSource.md +++ b/docs/api/type-aliases/ChecklistDelegateCountsSource.md @@ -8,8 +8,6 @@ > **ChecklistDelegateCountsSource** = (`sessionId`) => [`ChecklistDelegateCounts`](ChecklistDelegateCounts.md) -Defined in: [types/tasks.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L51) - Supplies [ChecklistDelegateCounts](ChecklistDelegateCounts.md) to every checklist tool result. ## Parameters diff --git a/docs/api/type-aliases/ChecklistItem.md b/docs/api/type-aliases/ChecklistItem.md index d8d727fa8..20c57b412 100644 --- a/docs/api/type-aliases/ChecklistItem.md +++ b/docs/api/type-aliases/ChecklistItem.md @@ -8,16 +8,12 @@ > **ChecklistItem** = `object` -Defined in: [types/tasks.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L18) - ## Properties ### id > **id**: `string` -Defined in: [types/tasks.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L20) - "t1", "t2", … — assigned by the engine, never by the model. --- @@ -26,24 +22,18 @@ Defined in: [types/tasks.ts:20](https://github.com/juspay/neurolink/blob/release > **title**: `string` -Defined in: [types/tasks.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L21) - --- ### status > **status**: [`ChecklistItemStatus`](ChecklistItemStatus.md) -Defined in: [types/tasks.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L22) - --- ### note? > `optional` **note?**: `string` -Defined in: [types/tasks.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L24) - Result note, or the REASON an item was closed unfinished. --- @@ -52,12 +42,8 @@ Result note, or the REASON an item was closed unfinished. > **createdAt**: `number` -Defined in: [types/tasks.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L25) - --- ### updatedAt > **updatedAt**: `number` - -Defined in: [types/tasks.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L26) diff --git a/docs/api/type-aliases/ChecklistItemStatus.md b/docs/api/type-aliases/ChecklistItemStatus.md index c58a98021..5477a8b2a 100644 --- a/docs/api/type-aliases/ChecklistItemStatus.md +++ b/docs/api/type-aliases/ChecklistItemStatus.md @@ -8,6 +8,4 @@ > **ChecklistItemStatus** = `"pending"` \| `"in_progress"` \| `"done"` \| `"closed"` -Defined in: [types/tasks.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L16) - Lifecycle of one checklist item. `closed` means "not done, and here is why". diff --git a/docs/api/type-aliases/ChecklistRefusal.md b/docs/api/type-aliases/ChecklistRefusal.md index 54d99dfc9..f47b507f6 100644 --- a/docs/api/type-aliases/ChecklistRefusal.md +++ b/docs/api/type-aliases/ChecklistRefusal.md @@ -8,8 +8,6 @@ > **ChecklistRefusal** = `object` -Defined in: [types/tasks.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L89) - Refusal shape shared with the agent tool registrar: recovery text included. ## Properties @@ -18,12 +16,8 @@ Refusal shape shared with the agent tool registrar: recovery text included. > **isError**: `true` -Defined in: [types/tasks.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L89) - --- ### error > **error**: `string` - -Defined in: [types/tasks.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L89) diff --git a/docs/api/type-aliases/ChecklistState.md b/docs/api/type-aliases/ChecklistState.md index 86ef1f029..d12af2b61 100644 --- a/docs/api/type-aliases/ChecklistState.md +++ b/docs/api/type-aliases/ChecklistState.md @@ -8,8 +8,6 @@ > **ChecklistState** = `object` -Defined in: [types/tasks.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L30) - Everything one session's checklist holds. Never stored in messages. ## Properties @@ -18,20 +16,14 @@ Everything one session's checklist holds. Never stored in messages. > **sessionId**: `string` -Defined in: [types/tasks.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L31) - --- ### items > **items**: [`ChecklistItem`](ChecklistItem.md)[] -Defined in: [types/tasks.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L32) - --- ### updatedAt > **updatedAt**: `number` - -Defined in: [types/tasks.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L33) diff --git a/docs/api/type-aliases/ChecklistToolResult.md b/docs/api/type-aliases/ChecklistToolResult.md index d0deabe81..f0e45027c 100644 --- a/docs/api/type-aliases/ChecklistToolResult.md +++ b/docs/api/type-aliases/ChecklistToolResult.md @@ -8,8 +8,6 @@ > **ChecklistToolResult** = `object` -Defined in: [types/tasks.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L71) - Every `tasks_*` tool returns this — the model re-anchors on the full list on each call, which is what makes the checklist survive compaction with no re-injection machinery. @@ -20,24 +18,18 @@ re-injection machinery. > **items**: [`ChecklistItem`](ChecklistItem.md)[] -Defined in: [types/tasks.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L72) - --- ### counts > **counts**: `Record`\<[`ChecklistItemStatus`](ChecklistItemStatus.md), `number`\> -Defined in: [types/tasks.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L73) - --- ### delegatesPending > **delegatesPending**: `number` -Defined in: [types/tasks.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L75) - Background delegates not yet collected (0 when delegation is unused). --- @@ -46,16 +38,12 @@ Background delegates not yet collected (0 when delegation is unused). > **delegatesReady**: `number` -Defined in: [types/tasks.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L76) - --- ### commandsRunning > **commandsRunning**: `number` -Defined in: [types/tasks.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L83) - Background commands still running (0 when the command primitive is unused). Carried here for the same reason the delegate counters are: the model learns "the build finished" from any `tasks_list`, with no polling @@ -67,6 +55,4 @@ and no change to the core loop. > **commandsFinished**: `number` -Defined in: [types/tasks.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L85) - Background commands that have settled and can be read. diff --git a/docs/api/type-aliases/ChecklistUpdateInput.md b/docs/api/type-aliases/ChecklistUpdateInput.md index ac9638835..49516e8c4 100644 --- a/docs/api/type-aliases/ChecklistUpdateInput.md +++ b/docs/api/type-aliases/ChecklistUpdateInput.md @@ -8,28 +8,20 @@ > **ChecklistUpdateInput** = `object` -Defined in: [types/tasks.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L38) - ## Properties ### id > **id**: `string` -Defined in: [types/tasks.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L39) - --- ### status > **status**: [`ChecklistItemStatus`](ChecklistItemStatus.md) -Defined in: [types/tasks.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L40) - --- ### note? > `optional` **note?**: `string` - -Defined in: [types/tasks.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/tasks.ts#L41) diff --git a/docs/api/type-aliases/ChromaClientLike.md b/docs/api/type-aliases/ChromaClientLike.md index 41ff9d782..4629f854e 100644 --- a/docs/api/type-aliases/ChromaClientLike.md +++ b/docs/api/type-aliases/ChromaClientLike.md @@ -8,8 +8,6 @@ > **ChromaClientLike** = `object` -Defined in: [types/vectorStoreChroma.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L65) - Minimal structural interface for a Chroma client, matching the subset of `ChromaClient` (from `chromadb`) the adapter calls. @@ -19,8 +17,6 @@ Minimal structural interface for a Chroma client, matching the subset of > **getOrCreateCollection**(`params`): `Promise`\<[`ChromaCollectionLike`](ChromaCollectionLike.md)\> -Defined in: [types/vectorStoreChroma.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L66) - #### Parameters ##### params diff --git a/docs/api/type-aliases/ChromaCollectionLike.md b/docs/api/type-aliases/ChromaCollectionLike.md index 40a096e96..cde6dc7fc 100644 --- a/docs/api/type-aliases/ChromaCollectionLike.md +++ b/docs/api/type-aliases/ChromaCollectionLike.md @@ -8,8 +8,6 @@ > **ChromaCollectionLike** = `object` -Defined in: [types/vectorStoreChroma.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L55) - Minimal structural interface for a Chroma collection handle, matching the subset of `Collection` (from `chromadb`) the adapter calls. @@ -19,8 +17,6 @@ subset of `Collection` (from `chromadb`) the adapter calls. > **upsert**(`params`): `Promise`\<`unknown`\> -Defined in: [types/vectorStoreChroma.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L56) - #### Parameters ##### params @@ -37,8 +33,6 @@ Defined in: [types/vectorStoreChroma.ts:56](https://github.com/juspay/neurolink/ > **query**(`params`): `Promise`\<[`ChromaQueryResponse`](ChromaQueryResponse.md)\> -Defined in: [types/vectorStoreChroma.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L57) - #### Parameters ##### params @@ -55,8 +49,6 @@ Defined in: [types/vectorStoreChroma.ts:57](https://github.com/juspay/neurolink/ > **delete**(`params`): `Promise`\<`unknown`\> -Defined in: [types/vectorStoreChroma.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L58) - #### Parameters ##### params diff --git a/docs/api/type-aliases/ChromaDeleteParams.md b/docs/api/type-aliases/ChromaDeleteParams.md index 08e2d2cef..e9465119e 100644 --- a/docs/api/type-aliases/ChromaDeleteParams.md +++ b/docs/api/type-aliases/ChromaDeleteParams.md @@ -8,20 +8,14 @@ > **ChromaDeleteParams** = `object` -Defined in: [types/vectorStoreChroma.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L46) - ## Properties ### ids? > `optional` **ids?**: `string`[] -Defined in: [types/vectorStoreChroma.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L47) - --- ### where? > `optional` **where?**: [`ChromaWhere`](ChromaWhere.md) - -Defined in: [types/vectorStoreChroma.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L48) diff --git a/docs/api/type-aliases/ChromaDistanceMetric.md b/docs/api/type-aliases/ChromaDistanceMetric.md index 38e573cc7..b4db84ed4 100644 --- a/docs/api/type-aliases/ChromaDistanceMetric.md +++ b/docs/api/type-aliases/ChromaDistanceMetric.md @@ -7,5 +7,3 @@ # Type Alias: ChromaDistanceMetric > **ChromaDistanceMetric** = `"cosine"` \| `"l2"` \| `"ip"` - -Defined in: [types/vectorStoreChroma.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L72) diff --git a/docs/api/type-aliases/ChromaIncludeField.md b/docs/api/type-aliases/ChromaIncludeField.md index 0dea816ac..51de922b8 100644 --- a/docs/api/type-aliases/ChromaIncludeField.md +++ b/docs/api/type-aliases/ChromaIncludeField.md @@ -7,5 +7,3 @@ # Type Alias: ChromaIncludeField > **ChromaIncludeField** = `"embeddings"` \| `"metadatas"` \| `"documents"` \| `"distances"` - -Defined in: [types/vectorStoreChroma.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L18) diff --git a/docs/api/type-aliases/ChromaMetadata.md b/docs/api/type-aliases/ChromaMetadata.md index 5fb0f03dc..c9db52e41 100644 --- a/docs/api/type-aliases/ChromaMetadata.md +++ b/docs/api/type-aliases/ChromaMetadata.md @@ -7,5 +7,3 @@ # Type Alias: ChromaMetadata > **ChromaMetadata** = `Record`\<`string`, [`ChromaMetadataValue`](ChromaMetadataValue.md)\> - -Defined in: [types/vectorStoreChroma.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L13) diff --git a/docs/api/type-aliases/ChromaMetadataValue.md b/docs/api/type-aliases/ChromaMetadataValue.md index 8f7df2e14..b46151efe 100644 --- a/docs/api/type-aliases/ChromaMetadataValue.md +++ b/docs/api/type-aliases/ChromaMetadataValue.md @@ -8,8 +8,6 @@ > **ChromaMetadataValue** = `string` \| `number` \| `boolean` -Defined in: [types/vectorStoreChroma.ts:12](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L12) - Structural types for the Chroma vector store adapter (`src/lib/rag/stores/chroma.ts`). diff --git a/docs/api/type-aliases/ChromaQueryParams.md b/docs/api/type-aliases/ChromaQueryParams.md index 4e03823c8..9fd19bda3 100644 --- a/docs/api/type-aliases/ChromaQueryParams.md +++ b/docs/api/type-aliases/ChromaQueryParams.md @@ -8,36 +8,26 @@ > **ChromaQueryParams** = `object` -Defined in: [types/vectorStoreChroma.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L31) - ## Properties ### queryEmbeddings > **queryEmbeddings**: `number`[][] -Defined in: [types/vectorStoreChroma.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L32) - --- ### nResults? > `optional` **nResults?**: `number` -Defined in: [types/vectorStoreChroma.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L33) - --- ### where? > `optional` **where?**: [`ChromaWhere`](ChromaWhere.md) -Defined in: [types/vectorStoreChroma.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L34) - --- ### include? > `optional` **include?**: [`ChromaIncludeField`](ChromaIncludeField.md)[] - -Defined in: [types/vectorStoreChroma.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L35) diff --git a/docs/api/type-aliases/ChromaQueryResponse.md b/docs/api/type-aliases/ChromaQueryResponse.md index c4c6fb901..02e177a5e 100644 --- a/docs/api/type-aliases/ChromaQueryResponse.md +++ b/docs/api/type-aliases/ChromaQueryResponse.md @@ -8,44 +8,32 @@ > **ChromaQueryResponse** = `object` -Defined in: [types/vectorStoreChroma.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L38) - ## Properties ### ids > **ids**: `string`[][] -Defined in: [types/vectorStoreChroma.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L39) - --- ### embeddings? > `optional` **embeddings?**: (`number`[] \| `null`)[][] \| `null` -Defined in: [types/vectorStoreChroma.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L40) - --- ### metadatas? > `optional` **metadatas?**: ([`ChromaMetadata`](ChromaMetadata.md) \| `null`)[][] \| `null` -Defined in: [types/vectorStoreChroma.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L41) - --- ### documents? > `optional` **documents?**: (`string` \| `null`)[][] \| `null` -Defined in: [types/vectorStoreChroma.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L42) - --- ### distances? > `optional` **distances?**: (`number` \| `null`)[][] \| `null` - -Defined in: [types/vectorStoreChroma.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L43) diff --git a/docs/api/type-aliases/ChromaUpsertParams.md b/docs/api/type-aliases/ChromaUpsertParams.md index b0c1f1d8c..b8ea21e09 100644 --- a/docs/api/type-aliases/ChromaUpsertParams.md +++ b/docs/api/type-aliases/ChromaUpsertParams.md @@ -8,36 +8,26 @@ > **ChromaUpsertParams** = `object` -Defined in: [types/vectorStoreChroma.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L24) - ## Properties ### ids > **ids**: `string`[] -Defined in: [types/vectorStoreChroma.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L25) - --- ### embeddings? > `optional` **embeddings?**: `number`[][] -Defined in: [types/vectorStoreChroma.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L26) - --- ### metadatas? > `optional` **metadatas?**: ([`ChromaMetadata`](ChromaMetadata.md) \| `null`)[] -Defined in: [types/vectorStoreChroma.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L27) - --- ### documents? > `optional` **documents?**: (`string` \| `null`)[] - -Defined in: [types/vectorStoreChroma.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L28) diff --git a/docs/api/type-aliases/ChromaVectorStoreOptions.md b/docs/api/type-aliases/ChromaVectorStoreOptions.md index 8776a8cf1..dcb583ef0 100644 --- a/docs/api/type-aliases/ChromaVectorStoreOptions.md +++ b/docs/api/type-aliases/ChromaVectorStoreOptions.md @@ -8,16 +8,12 @@ > **ChromaVectorStoreOptions** = `object` -Defined in: [types/vectorStoreChroma.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L74) - ## Properties ### distanceMetric? > `optional` **distanceMetric?**: [`ChromaDistanceMetric`](ChromaDistanceMetric.md) -Defined in: [types/vectorStoreChroma.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L81) - The distance metric configured on the underlying Chroma collection(s) (Chroma's `hnsw:space`). Used only to convert returned distances into a `score`; see `src/lib/rag/stores/chroma.ts` module doc comment. diff --git a/docs/api/type-aliases/ChromaWhere.md b/docs/api/type-aliases/ChromaWhere.md index 8df0c084b..a7179ecf3 100644 --- a/docs/api/type-aliases/ChromaWhere.md +++ b/docs/api/type-aliases/ChromaWhere.md @@ -8,6 +8,4 @@ > **ChromaWhere** = `Record`\<`string`, `unknown`\> -Defined in: [types/vectorStoreChroma.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStoreChroma.ts#L16) - Chroma's metadata `where` filter payload shape. diff --git a/docs/api/type-aliases/Chunk.md b/docs/api/type-aliases/Chunk.md index eb213269e..948d7e942 100644 --- a/docs/api/type-aliases/Chunk.md +++ b/docs/api/type-aliases/Chunk.md @@ -8,8 +8,6 @@ > **Chunk** = `object` -Defined in: [types/rag.ts:844](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L844) - Base chunk result with text and metadata ## Properties @@ -18,8 +16,6 @@ Base chunk result with text and metadata > **id**: `string` -Defined in: [types/rag.ts:846](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L846) - Unique identifier for the chunk --- @@ -28,8 +24,6 @@ Unique identifier for the chunk > **text**: `string` -Defined in: [types/rag.ts:848](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L848) - The text content of the chunk --- @@ -38,8 +32,6 @@ The text content of the chunk > **metadata**: [`ChunkMetadata`](ChunkMetadata.md) -Defined in: [types/rag.ts:850](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L850) - Metadata associated with the chunk --- @@ -48,6 +40,4 @@ Metadata associated with the chunk > `optional` **embedding?**: `number`[] -Defined in: [types/rag.ts:852](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L852) - Optional embedding vector (populated after embedding) diff --git a/docs/api/type-aliases/ChunkMetadata.md b/docs/api/type-aliases/ChunkMetadata.md index 618f5bc3c..c85ceb23e 100644 --- a/docs/api/type-aliases/ChunkMetadata.md +++ b/docs/api/type-aliases/ChunkMetadata.md @@ -8,8 +8,6 @@ > **ChunkMetadata** = `object` -Defined in: [types/rag.ts:808](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L808) - Chunk metadata for tracking source and position ## Properties @@ -18,8 +16,6 @@ Chunk metadata for tracking source and position > **documentId**: `string` -Defined in: [types/rag.ts:810](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L810) - Source document identifier --- @@ -28,8 +24,6 @@ Source document identifier > `optional` **source?**: `string` -Defined in: [types/rag.ts:812](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L812) - Original document filename or URL --- @@ -38,8 +32,6 @@ Original document filename or URL > **chunkIndex**: `number` -Defined in: [types/rag.ts:814](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L814) - Position in the original document (0-indexed) --- @@ -48,8 +40,6 @@ Position in the original document (0-indexed) > `optional` **totalChunks?**: `number` -Defined in: [types/rag.ts:816](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L816) - Total number of chunks from the document --- @@ -58,8 +48,6 @@ Total number of chunks from the document > `optional` **startPosition?**: `number` -Defined in: [types/rag.ts:818](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L818) - Start character position in original text --- @@ -68,8 +56,6 @@ Start character position in original text > `optional` **endPosition?**: `number` -Defined in: [types/rag.ts:820](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L820) - End character position in original text --- @@ -78,8 +64,6 @@ End character position in original text > `optional` **documentType?**: [`DocumentType`](DocumentType.md) -Defined in: [types/rag.ts:822](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L822) - Document type (markdown, html, json, etc.) --- @@ -88,8 +72,6 @@ Document type (markdown, html, json, etc.) > `optional` **custom?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:824](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L824) - Custom metadata from extraction --- @@ -98,8 +80,6 @@ Custom metadata from extraction > `optional` **title?**: `string` -Defined in: [types/rag.ts:826](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L826) - Extracted title (from metadata extraction) --- @@ -108,8 +88,6 @@ Extracted title (from metadata extraction) > `optional` **summary?**: `string` -Defined in: [types/rag.ts:828](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L828) - Extracted summary (from metadata extraction) --- @@ -118,8 +96,6 @@ Extracted summary (from metadata extraction) > `optional` **keywords?**: `string`[] -Defined in: [types/rag.ts:830](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L830) - Extracted keywords (from metadata extraction) --- @@ -128,8 +104,6 @@ Extracted keywords (from metadata extraction) > `optional` **headerLevel?**: `number` -Defined in: [types/rag.ts:832](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L832) - Header level for markdown/html chunks --- @@ -138,8 +112,6 @@ Header level for markdown/html chunks > `optional` **header?**: `string` -Defined in: [types/rag.ts:834](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L834) - Header text for structured documents --- @@ -148,8 +120,6 @@ Header text for structured documents > `optional` **jsonPath?**: `string` -Defined in: [types/rag.ts:836](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L836) - JSON path for JSON chunks --- @@ -158,6 +128,4 @@ JSON path for JSON chunks > `optional` **latexEnvironment?**: `string` -Defined in: [types/rag.ts:838](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L838) - LaTeX environment name diff --git a/docs/api/type-aliases/ChunkParams.md b/docs/api/type-aliases/ChunkParams.md index 1a3310181..64413c3b8 100644 --- a/docs/api/type-aliases/ChunkParams.md +++ b/docs/api/type-aliases/ChunkParams.md @@ -8,8 +8,6 @@ > **ChunkParams** = `object` -Defined in: [types/rag.ts:1532](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1532) - Chunk parameters for MDocument ## Properties @@ -18,8 +16,6 @@ Chunk parameters for MDocument > `optional` **strategy?**: [`ChunkingStrategy`](ChunkingStrategy.md) -Defined in: [types/rag.ts:1534](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1534) - Chunking strategy to use --- @@ -28,8 +24,6 @@ Chunking strategy to use > `optional` **config?**: [`ChunkerConfig`](ChunkerConfig.md) -Defined in: [types/rag.ts:1536](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1536) - Strategy-specific configuration --- @@ -38,6 +32,4 @@ Strategy-specific configuration > `optional` **extract?**: [`ExtractParams`](ExtractParams.md) -Defined in: [types/rag.ts:1538](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1538) - Metadata extraction options diff --git a/docs/api/type-aliases/Chunker.md b/docs/api/type-aliases/Chunker.md index 339d5b0d6..c3d969e07 100644 --- a/docs/api/type-aliases/Chunker.md +++ b/docs/api/type-aliases/Chunker.md @@ -8,8 +8,6 @@ > **Chunker** = `object` -Defined in: [types/rag.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L24) - Chunker type - all chunking strategies implement this ## Properties @@ -18,8 +16,6 @@ Chunker type - all chunking strategies implement this > `readonly` **strategy**: [`ChunkingStrategy`](ChunkingStrategy.md) -Defined in: [types/rag.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L26) - Strategy name for identification ## Methods @@ -28,8 +24,6 @@ Strategy name for identification > **chunk**(`text`, `config?`): `Promise`\<[`Chunk`](Chunk.md)[]\> -Defined in: [types/rag.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L34) - Split text into chunks #### Parameters diff --git a/docs/api/type-aliases/ChunkerConfig.md b/docs/api/type-aliases/ChunkerConfig.md index 99258bdcd..95a51df0f 100644 --- a/docs/api/type-aliases/ChunkerConfig.md +++ b/docs/api/type-aliases/ChunkerConfig.md @@ -8,6 +8,4 @@ > **ChunkerConfig** = [`CharacterChunkerConfig`](CharacterChunkerConfig.md) \| [`RecursiveChunkerConfig`](RecursiveChunkerConfig.md) \| [`SentenceChunkerConfig`](SentenceChunkerConfig.md) \| [`TokenChunkerConfig`](TokenChunkerConfig.md) \| [`MarkdownChunkerConfig`](MarkdownChunkerConfig.md) \| [`HTMLChunkerConfig`](HTMLChunkerConfig.md) \| [`JSONChunkerConfig`](JSONChunkerConfig.md) \| [`LaTeXChunkerConfig`](LaTeXChunkerConfig.md) \| [`SemanticChunkerConfig`](SemanticChunkerConfig.md) -Defined in: [types/rag.ts:1033](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1033) - Union type for all chunker configurations diff --git a/docs/api/type-aliases/ChunkerMetadata.md b/docs/api/type-aliases/ChunkerMetadata.md index 7d2ad1f96..8bf23cd60 100644 --- a/docs/api/type-aliases/ChunkerMetadata.md +++ b/docs/api/type-aliases/ChunkerMetadata.md @@ -8,8 +8,6 @@ > **ChunkerMetadata** = `object` -Defined in: [types/rag.ts:1051](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1051) - Chunker metadata for factory registration ## Properties @@ -18,8 +16,6 @@ Chunker metadata for factory registration > **description**: `string` -Defined in: [types/rag.ts:1053](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1053) - Human-readable description --- @@ -28,8 +24,6 @@ Human-readable description > `optional` **supportedTypes?**: [`DocumentType`](DocumentType.md)[] -Defined in: [types/rag.ts:1055](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1055) - Supported document types --- @@ -38,8 +32,6 @@ Supported document types > `optional` **requiresExternalDeps?**: `boolean` -Defined in: [types/rag.ts:1057](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1057) - Whether the chunker requires external dependencies --- @@ -48,8 +40,6 @@ Whether the chunker requires external dependencies > `optional` **defaultConfig?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1059](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1059) - Default configuration (can be any chunker-specific config) --- @@ -58,8 +48,6 @@ Default configuration (can be any chunker-specific config) > `optional` **supportedOptions?**: `string`[] -Defined in: [types/rag.ts:1061](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1061) - Supported configuration options --- @@ -68,8 +56,6 @@ Supported configuration options > `optional` **useCases?**: `string`[] -Defined in: [types/rag.ts:1063](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1063) - Use cases where this chunker excels --- @@ -78,6 +64,4 @@ Use cases where this chunker excels > `optional` **aliases?**: `string`[] -Defined in: [types/rag.ts:1065](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1065) - Alternative names/aliases for this chunker diff --git a/docs/api/type-aliases/ChunkerValidationResult.md b/docs/api/type-aliases/ChunkerValidationResult.md index de42efba0..4c73d607e 100644 --- a/docs/api/type-aliases/ChunkerValidationResult.md +++ b/docs/api/type-aliases/ChunkerValidationResult.md @@ -8,8 +8,6 @@ > **ChunkerValidationResult** = `object` -Defined in: [types/rag.ts:877](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L877) - Validation result for chunker configuration ## Properties @@ -18,20 +16,14 @@ Validation result for chunker configuration > **valid**: `boolean` -Defined in: [types/rag.ts:878](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L878) - --- ### errors > **errors**: `string`[] -Defined in: [types/rag.ts:879](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L879) - --- ### warnings > **warnings**: `string`[] - -Defined in: [types/rag.ts:880](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L880) diff --git a/docs/api/type-aliases/ChunkingStrategy.md b/docs/api/type-aliases/ChunkingStrategy.md index 433ed8098..16ac15b99 100644 --- a/docs/api/type-aliases/ChunkingStrategy.md +++ b/docs/api/type-aliases/ChunkingStrategy.md @@ -8,6 +8,4 @@ > **ChunkingStrategy** = `"character"` \| `"recursive"` \| `"sentence"` \| `"token"` \| `"markdown"` \| `"html"` \| `"json"` \| `"latex"` \| `"semantic"` \| `"semantic-markdown"` -Defined in: [types/rag.ts:862](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L862) - Available chunking strategy types diff --git a/docs/api/type-aliases/CircuitBreakerConfig.md b/docs/api/type-aliases/CircuitBreakerConfig.md index 7cd0691b9..042035b15 100644 --- a/docs/api/type-aliases/CircuitBreakerConfig.md +++ b/docs/api/type-aliases/CircuitBreakerConfig.md @@ -8,8 +8,6 @@ > **CircuitBreakerConfig** = `object` -Defined in: [types/mcp.ts:709](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L709) - Circuit breaker configuration Moved from src/lib/mcp/mcpCircuitBreaker.ts @@ -19,8 +17,6 @@ Moved from src/lib/mcp/mcpCircuitBreaker.ts > **failureThreshold**: `number` -Defined in: [types/mcp.ts:711](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L711) - Number of failures before opening the circuit --- @@ -29,8 +25,6 @@ Number of failures before opening the circuit > **resetTimeout**: `number` -Defined in: [types/mcp.ts:714](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L714) - Time to wait before attempting reset (milliseconds) --- @@ -39,8 +33,6 @@ Time to wait before attempting reset (milliseconds) > **halfOpenMaxCalls**: `number` -Defined in: [types/mcp.ts:717](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L717) - Maximum calls allowed in half-open state --- @@ -49,8 +41,6 @@ Maximum calls allowed in half-open state > **operationTimeout**: `number` -Defined in: [types/mcp.ts:720](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L720) - Timeout for individual operations (milliseconds) --- @@ -59,8 +49,6 @@ Timeout for individual operations (milliseconds) > **minimumCallsBeforeCalculation**: `number` -Defined in: [types/mcp.ts:723](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L723) - Minimum number of calls before calculating failure rate --- @@ -69,6 +57,4 @@ Minimum number of calls before calculating failure rate > **statisticsWindowSize**: `number` -Defined in: [types/mcp.ts:726](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L726) - Window size for calculating failure rate (milliseconds) diff --git a/docs/api/type-aliases/CircuitBreakerEvents.md b/docs/api/type-aliases/CircuitBreakerEvents.md index 036ac6528..c097b4a10 100644 --- a/docs/api/type-aliases/CircuitBreakerEvents.md +++ b/docs/api/type-aliases/CircuitBreakerEvents.md @@ -8,8 +8,6 @@ > **CircuitBreakerEvents** = `object` -Defined in: [types/mcp.ts:766](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L766) - Circuit breaker events Moved from src/lib/mcp/mcpCircuitBreaker.ts @@ -19,8 +17,6 @@ Moved from src/lib/mcp/mcpCircuitBreaker.ts > **stateChange**: `object` -Defined in: [types/mcp.ts:767](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L767) - #### oldState > **oldState**: [`CircuitBreakerState`](CircuitBreakerState.md) @@ -43,8 +39,6 @@ Defined in: [types/mcp.ts:767](https://github.com/juspay/neurolink/blob/release/ > **callSuccess**: `object` -Defined in: [types/mcp.ts:774](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L774) - #### duration > **duration**: `number` @@ -59,8 +53,6 @@ Defined in: [types/mcp.ts:774](https://github.com/juspay/neurolink/blob/release/ > **callFailure**: `object` -Defined in: [types/mcp.ts:779](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L779) - #### error > **error**: `string` @@ -79,8 +71,6 @@ Defined in: [types/mcp.ts:779](https://github.com/juspay/neurolink/blob/release/ > **circuitOpen**: `object` -Defined in: [types/mcp.ts:785](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L785) - #### failureRate > **failureRate**: `number` @@ -99,8 +89,6 @@ Defined in: [types/mcp.ts:785](https://github.com/juspay/neurolink/blob/release/ > **circuitHalfOpen**: `object` -Defined in: [types/mcp.ts:791](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L791) - #### timestamp > **timestamp**: `Date` @@ -111,8 +99,6 @@ Defined in: [types/mcp.ts:791](https://github.com/juspay/neurolink/blob/release/ > **circuitClosed**: `object` -Defined in: [types/mcp.ts:795](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L795) - #### timestamp > **timestamp**: `Date` diff --git a/docs/api/type-aliases/CircuitBreakerState.md b/docs/api/type-aliases/CircuitBreakerState.md index d1e4e59e7..d2f5c1871 100644 --- a/docs/api/type-aliases/CircuitBreakerState.md +++ b/docs/api/type-aliases/CircuitBreakerState.md @@ -8,7 +8,5 @@ > **CircuitBreakerState** = `"closed"` \| `"open"` \| `"half-open"` -Defined in: [types/mcp.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L703) - Circuit breaker states Moved from src/lib/mcp/mcpCircuitBreaker.ts diff --git a/docs/api/type-aliases/CircuitBreakerStats.md b/docs/api/type-aliases/CircuitBreakerStats.md index 63f48eb99..a2221f912 100644 --- a/docs/api/type-aliases/CircuitBreakerStats.md +++ b/docs/api/type-aliases/CircuitBreakerStats.md @@ -8,8 +8,6 @@ > **CircuitBreakerStats** = `object` -Defined in: [types/mcp.ts:733](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L733) - Circuit breaker statistics Moved from src/lib/mcp/mcpCircuitBreaker.ts @@ -19,8 +17,6 @@ Moved from src/lib/mcp/mcpCircuitBreaker.ts > **state**: [`CircuitBreakerState`](CircuitBreakerState.md) -Defined in: [types/mcp.ts:735](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L735) - Current state --- @@ -29,8 +25,6 @@ Current state > **totalCalls**: `number` -Defined in: [types/mcp.ts:738](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L738) - Total number of calls --- @@ -39,8 +33,6 @@ Total number of calls > **successfulCalls**: `number` -Defined in: [types/mcp.ts:741](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L741) - Number of successful calls --- @@ -49,8 +41,6 @@ Number of successful calls > **failedCalls**: `number` -Defined in: [types/mcp.ts:744](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L744) - Number of failed calls --- @@ -59,8 +49,6 @@ Number of failed calls > **failureRate**: `number` -Defined in: [types/mcp.ts:747](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L747) - Current failure rate (0-1) --- @@ -69,8 +57,6 @@ Current failure rate (0-1) > **windowCalls**: `number` -Defined in: [types/mcp.ts:750](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L750) - Calls in current time window --- @@ -79,8 +65,6 @@ Calls in current time window > **lastStateChange**: `Date` -Defined in: [types/mcp.ts:753](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L753) - Last state change timestamp --- @@ -89,8 +73,6 @@ Last state change timestamp > `optional` **nextRetryTime?**: `Date` -Defined in: [types/mcp.ts:756](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L756) - Next retry time (for open state) --- @@ -99,6 +81,4 @@ Next retry time (for open state) > **halfOpenCalls**: `number` -Defined in: [types/mcp.ts:759](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L759) - Half-open call count diff --git a/docs/api/type-aliases/CircuitState.md b/docs/api/type-aliases/CircuitState.md index 136a9e84d..15ebe5b81 100644 --- a/docs/api/type-aliases/CircuitState.md +++ b/docs/api/type-aliases/CircuitState.md @@ -8,6 +8,4 @@ > **CircuitState** = `"closed"` \| `"open"` \| `"half-open"` -Defined in: [types/rag.ts:669](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L669) - Circuit breaker state. diff --git a/docs/api/type-aliases/CitationFormat.md b/docs/api/type-aliases/CitationFormat.md index d64f579a4..03a3d2d55 100644 --- a/docs/api/type-aliases/CitationFormat.md +++ b/docs/api/type-aliases/CitationFormat.md @@ -8,6 +8,4 @@ > **CitationFormat** = `"inline"` \| `"footnote"` \| `"numbered"` \| `"none"` -Defined in: [types/rag.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L15) - Citation format options diff --git a/docs/api/type-aliases/ClaimItem.md b/docs/api/type-aliases/ClaimItem.md index 6777fa26b..a46c0aef9 100644 --- a/docs/api/type-aliases/ClaimItem.md +++ b/docs/api/type-aliases/ClaimItem.md @@ -8,8 +8,6 @@ > **ClaimItem** = `object` -Defined in: [types/scorer.ts:659](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L659) - Claim row reported by the faithfulness scorer. ## Properties @@ -18,20 +16,14 @@ Claim row reported by the faithfulness scorer. > `optional` **claim?**: `string` -Defined in: [types/scorer.ts:660](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L660) - --- ### supported? > `optional` **supported?**: `boolean` -Defined in: [types/scorer.ts:661](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L661) - --- ### evidence? > `optional` **evidence?**: `string` - -Defined in: [types/scorer.ts:662](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L662) diff --git a/docs/api/type-aliases/ClassificationScores.md b/docs/api/type-aliases/ClassificationScores.md index 591137194..28aaf9b3a 100644 --- a/docs/api/type-aliases/ClassificationScores.md +++ b/docs/api/type-aliases/ClassificationScores.md @@ -8,8 +8,6 @@ > **ClassificationScores** = `object` -Defined in: [types/taskClassification.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L26) - Internal scoring data used during classification analysis ## Properties @@ -18,8 +16,6 @@ Internal scoring data used during classification analysis > **fastScore**: `number` -Defined in: [types/taskClassification.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L28) - Score indicating likelihood of fast task --- @@ -28,8 +24,6 @@ Score indicating likelihood of fast task > **reasoningScore**: `number` -Defined in: [types/taskClassification.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L30) - Score indicating likelihood of reasoning task --- @@ -38,6 +32,4 @@ Score indicating likelihood of reasoning task > **reasons**: `string`[] -Defined in: [types/taskClassification.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L32) - Array of reasons contributing to the scores diff --git a/docs/api/type-aliases/ClassificationStats.md b/docs/api/type-aliases/ClassificationStats.md index fb9aaee4f..b5b6908ae 100644 --- a/docs/api/type-aliases/ClassificationStats.md +++ b/docs/api/type-aliases/ClassificationStats.md @@ -8,8 +8,6 @@ > **ClassificationStats** = `object` -Defined in: [types/taskClassification.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L38) - Statistics for batch classification analysis ## Properties @@ -18,8 +16,6 @@ Statistics for batch classification analysis > **total**: `number` -Defined in: [types/taskClassification.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L40) - Total number of prompts analyzed --- @@ -28,8 +24,6 @@ Total number of prompts analyzed > **fast**: `number` -Defined in: [types/taskClassification.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L42) - Number of prompts classified as fast --- @@ -38,8 +32,6 @@ Number of prompts classified as fast > **reasoning**: `number` -Defined in: [types/taskClassification.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L44) - Number of prompts classified as reasoning --- @@ -48,6 +40,4 @@ Number of prompts classified as reasoning > **averageConfidence**: `number` -Defined in: [types/taskClassification.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L46) - Average confidence across all classifications diff --git a/docs/api/type-aliases/ClassificationValidation.md b/docs/api/type-aliases/ClassificationValidation.md index e99b91802..368c7bb78 100644 --- a/docs/api/type-aliases/ClassificationValidation.md +++ b/docs/api/type-aliases/ClassificationValidation.md @@ -8,8 +8,6 @@ > **ClassificationValidation** = `object` -Defined in: [types/taskClassification.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L52) - Validation result for testing classification accuracy ## Properties @@ -18,8 +16,6 @@ Validation result for testing classification accuracy > **correct**: `boolean` -Defined in: [types/taskClassification.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L54) - Whether the classification matched the expected result --- @@ -28,6 +24,4 @@ Whether the classification matched the expected result > **classification**: [`TaskClassification`](TaskClassification.md) -Defined in: [types/taskClassification.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/taskClassification.ts#L56) - The actual classification result diff --git a/docs/api/type-aliases/ClassifierCandidate.md b/docs/api/type-aliases/ClassifierCandidate.md index eeb04346f..5e4b2f2b5 100644 --- a/docs/api/type-aliases/ClassifierCandidate.md +++ b/docs/api/type-aliases/ClassifierCandidate.md @@ -8,8 +8,6 @@ > **ClassifierCandidate** = `object` -Defined in: [types/classifierRouter.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L103) - Lightweight model descriptor handed to the LLM classifier so it can select a model directly from the pool by `id` — the generic path for custom models. @@ -19,56 +17,42 @@ model directly from the pool by `id` — the generic path for custom models. > **id**: `string` -Defined in: [types/classifierRouter.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L104) - --- ### provider > **provider**: `string` -Defined in: [types/classifierRouter.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L105) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/classifierRouter.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L106) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/classifierRouter.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L107) - --- ### tiers? > `optional` **tiers?**: [`ClassifierDifficulty`](ClassifierDifficulty.md)[] -Defined in: [types/classifierRouter.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L108) - --- ### capabilities? > `optional` **capabilities?**: `string`[] -Defined in: [types/classifierRouter.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L109) - --- ### contextWindow? > `optional` **contextWindow?**: `number` -Defined in: [types/classifierRouter.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L116) - Maximum input window, in tokens. Read from the model registry when the pool is built from the catalogue. Nothing in routing consulted this before — a request was routed to a model without ever asking whether it @@ -80,8 +64,6 @@ could hold the request. > `optional` **inputCostPer1K?**: `number` -Defined in: [types/classifierRouter.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L118) - USD per 1K input tokens, for the cheapest-that-works judgement. --- @@ -90,8 +72,6 @@ USD per 1K input tokens, for the cheapest-that-works judgement. > `optional` **outputCostPer1K?**: `number` -Defined in: [types/classifierRouter.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L120) - USD per 1K output tokens. --- @@ -100,8 +80,6 @@ USD per 1K output tokens. > `optional` **speed?**: `string` -Defined in: [types/classifierRouter.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L122) - Registry speed bucket ("fast" | "medium" | "slow"). --- @@ -110,8 +88,6 @@ Registry speed bucket ("fast" | "medium" | "slow"). > `optional` **quality?**: `string` -Defined in: [types/classifierRouter.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L124) - Registry quality bucket ("high" | "medium" | "low"). --- @@ -120,8 +96,6 @@ Registry quality bucket ("high" | "medium" | "low"). > `optional` **useCases?**: `Readonly`\<`Record`\<`string`, `number`\>\> -Defined in: [types/classifierRouter.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L130) - The registry's per-dimension suitability scores (1–10): coding, analysis, reasoning, conversation, creative, translation, summarization. Present only for registry-backed models. @@ -132,8 +106,6 @@ only for registry-backed models. > `optional` **score?**: `number` -Defined in: [types/classifierRouter.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L136) - Deterministic merit score for the difficulty this candidate was built for, higher is better. Computed by `enrichCandidate`; it is what the fallback ranker sorts on and is never sent to the model. @@ -144,8 +116,6 @@ fallback ranker sorts on and is never sent to the model. > `optional` **relativeCost?**: `number` -Defined in: [types/classifierRouter.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L148) - The host's own `cost` / `quality` from the pool member, if it declared them. These are RELATIVE scales, comparable only against other members of the same pool — never a currency and never a registry bucket. @@ -161,5 +131,3 @@ its own general benchmarks — does not get to overrule it. ### relativeQuality? > `optional` **relativeQuality?**: `number` - -Defined in: [types/classifierRouter.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L149) diff --git a/docs/api/type-aliases/ClassifierCatalogConfig.md b/docs/api/type-aliases/ClassifierCatalogConfig.md index f3ebd7fd3..d465614b8 100644 --- a/docs/api/type-aliases/ClassifierCatalogConfig.md +++ b/docs/api/type-aliases/ClassifierCatalogConfig.md @@ -8,8 +8,6 @@ > **ClassifierCatalogConfig** = `object` -Defined in: [types/classifierRouter.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L262) - How the model catalogue widens the declared pool. ## Properties @@ -18,16 +16,12 @@ How the model catalogue widens the declared pool. > **enabled**: `boolean` -Defined in: [types/classifierRouter.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L263) - --- ### maxModels? > `optional` **maxModels?**: `number` -Defined in: [types/classifierRouter.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L275) - Cap on catalogue-derived members. The binding constraint is the decision model's input ceiling — state plus the longest single question must stay under ~33K tokens, and the model question's `criteria` map is that @@ -44,8 +38,6 @@ grows past what one question can carry, not a limit anyone is hitting. > `optional` **providers?**: `string`[] -Defined in: [types/classifierRouter.ts:277](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L277) - Restrict the catalogue to these provider names. Omit for all configured. --- @@ -54,8 +46,6 @@ Restrict the catalogue to these provider names. Omit for all configured. > `optional` **minContextWindow?**: `number` -Defined in: [types/classifierRouter.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L279) - Drop models whose context window is below this. Default: 0 (keep all). --- @@ -64,6 +54,4 @@ Drop models whose context window is below this. Default: 0 (keep all). > `optional` **includeDeprecated?**: `boolean` -Defined in: [types/classifierRouter.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L281) - Include models flagged deprecated in the registry. Default: false. diff --git a/docs/api/type-aliases/ClassifierContextScope.md b/docs/api/type-aliases/ClassifierContextScope.md index ff32d036e..c84281d00 100644 --- a/docs/api/type-aliases/ClassifierContextScope.md +++ b/docs/api/type-aliases/ClassifierContextScope.md @@ -8,8 +8,6 @@ > **ClassifierContextScope** = `"current-message"` \| `"recent-turns"` \| `"full-conversation"` \| `"everything"` -Defined in: [types/classifierRouter.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L50) - How much of the available context a request actually needs, ordered narrowest → widest. This is a _rubric_, not a token count: a decision model is reliable at placing a request on an ordered scale and unreliable at diff --git a/docs/api/type-aliases/ClassifierDecideFn.md b/docs/api/type-aliases/ClassifierDecideFn.md index cfcf59712..9f181aa5d 100644 --- a/docs/api/type-aliases/ClassifierDecideFn.md +++ b/docs/api/type-aliases/ClassifierDecideFn.md @@ -8,8 +8,6 @@ > **ClassifierDecideFn** = [`DecisionCallerFn`](DecisionCallerFn.md) -Defined in: [types/classifierRouter.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L371) - Injected decision caller — typically a bound `NeuroLink.tryDecide`, which returns null on any failure. Keeps `ClassifierRouter` free of provider imports, exactly as `ClassifierGenerateFn` does. diff --git a/docs/api/type-aliases/ClassifierDecision.md b/docs/api/type-aliases/ClassifierDecision.md index 5f409fe49..e00e79c28 100644 --- a/docs/api/type-aliases/ClassifierDecision.md +++ b/docs/api/type-aliases/ClassifierDecision.md @@ -8,8 +8,6 @@ > **ClassifierDecision** = `object` -Defined in: [types/classifierRouter.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L60) - The classifier's verdict for a single request. Strategy-agnostic: produced by both the heuristic and the LLM classifier. @@ -19,8 +17,6 @@ by both the heuristic and the LLM classifier. > **difficulty**: [`ClassifierDifficulty`](ClassifierDifficulty.md) -Defined in: [types/classifierRouter.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L62) - The classified difficulty bucket. --- @@ -29,8 +25,6 @@ The classified difficulty bucket. > **confidence**: `number` -Defined in: [types/classifierRouter.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L64) - Confidence in the classification (0–1). --- @@ -39,8 +33,6 @@ Confidence in the classification (0–1). > `optional` **requiredCapabilities?**: `string`[] -Defined in: [types/classifierRouter.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L66) - Capability tags the request needs (e.g. "vision", "tools", "reasoning"). --- @@ -49,8 +41,6 @@ Capability tags the request needs (e.g. "vision", "tools", "reasoning"). > `optional` **suggestedTools?**: `string`[] -Defined in: [types/classifierRouter.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L68) - Tool names the classifier thinks the task needs (allowlist hint). --- @@ -59,8 +49,6 @@ Tool names the classifier thinks the task needs (allowlist hint). > `optional` **selectedModelId?**: `string` -Defined in: [types/classifierRouter.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L73) - When the LLM classifier picks a model directly, the chosen candidate id (matches a `ClassifierCandidate.id`). Ignored by the heuristic classifier. @@ -70,8 +58,6 @@ When the LLM classifier picks a model directly, the chosen candidate id > `optional` **selectedModelConfidence?**: `number` -Defined in: [types/classifierRouter.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L85) - Confidence in `selectedModelId`, when the strategy reports one. Separate from `confidence`, which is about the DIFFICULTY verdict: a @@ -88,8 +74,6 @@ which case the pick is honoured as it always was. > `optional` **contextScope?**: [`ClassifierContextScope`](ClassifierContextScope.md) -Defined in: [types/classifierRouter.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L92) - How much context the request needs. Only the decision strategy produces this — the heuristic has no way to judge it and the LLM classifier is not asked, since for it every extra field costs output tokens. For a decision @@ -101,8 +85,6 @@ model the question is very nearly free. > `optional` **contextScopeConfidence?**: `number` -Defined in: [types/classifierRouter.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L94) - Confidence in `contextScope`, 0-1. Calibrated for the decide strategy. --- @@ -111,6 +93,4 @@ Confidence in `contextScope`, 0-1. Calibrated for the decide strategy. > `optional` **reason?**: `string` -Defined in: [types/classifierRouter.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L96) - Human-readable explanation, emitted at debug level. diff --git a/docs/api/type-aliases/ClassifierDifficulty.md b/docs/api/type-aliases/ClassifierDifficulty.md index bb03f9f9f..75caf49a7 100644 --- a/docs/api/type-aliases/ClassifierDifficulty.md +++ b/docs/api/type-aliases/ClassifierDifficulty.md @@ -8,6 +8,4 @@ > **ClassifierDifficulty** = `"trivial"` \| `"simple"` \| `"moderate"` \| `"hard"` \| `"expert"` -Defined in: [types/classifierRouter.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L21) - Coarse difficulty buckets the classifier maps a request into. diff --git a/docs/api/type-aliases/ClassifierGenerateFn.md b/docs/api/type-aliases/ClassifierGenerateFn.md index ffc2698be..904df415f 100644 --- a/docs/api/type-aliases/ClassifierGenerateFn.md +++ b/docs/api/type-aliases/ClassifierGenerateFn.md @@ -8,8 +8,6 @@ > **ClassifierGenerateFn** = (`options`) => `Promise`\<[`ClassifierGenerateResult`](ClassifierGenerateResult.md)\> -Defined in: [types/classifierRouter.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L362) - Injected LLM caller — typically a bound `NeuroLink.generate`. ## Parameters diff --git a/docs/api/type-aliases/ClassifierGenerateOptions.md b/docs/api/type-aliases/ClassifierGenerateOptions.md index 2028d0586..16f87ad13 100644 --- a/docs/api/type-aliases/ClassifierGenerateOptions.md +++ b/docs/api/type-aliases/ClassifierGenerateOptions.md @@ -8,8 +8,6 @@ > **ClassifierGenerateOptions** = `object` -Defined in: [types/classifierRouter.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L341) - Minimal options accepted by the injected LLM-classifier `generate` fn. ## Properties @@ -18,8 +16,6 @@ Minimal options accepted by the injected LLM-classifier `generate` fn. > **input**: `object` -Defined in: [types/classifierRouter.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L342) - #### text > **text**: `string` @@ -30,76 +26,56 @@ Defined in: [types/classifierRouter.ts:342](https://github.com/juspay/neurolink/ > `optional` **systemPrompt?**: `string` -Defined in: [types/classifierRouter.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L343) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/classifierRouter.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L344) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/classifierRouter.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L345) - --- ### region? > `optional` **region?**: `string` -Defined in: [types/classifierRouter.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L346) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/classifierRouter.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L347) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/classifierRouter.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L348) - --- ### disableTools? > `optional` **disableTools?**: `boolean` -Defined in: [types/classifierRouter.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L349) - --- ### schema? > `optional` **schema?**: [`ValidationSchema`](ValidationSchema.md) -Defined in: [types/classifierRouter.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L350) - --- ### timeout? > `optional` **timeout?**: `number` \| `string` -Defined in: [types/classifierRouter.ts:351](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L351) - --- ### context? > `optional` **context?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/classifierRouter.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L352) diff --git a/docs/api/type-aliases/ClassifierGenerateResult.md b/docs/api/type-aliases/ClassifierGenerateResult.md index 77c9f80bb..f975006b7 100644 --- a/docs/api/type-aliases/ClassifierGenerateResult.md +++ b/docs/api/type-aliases/ClassifierGenerateResult.md @@ -8,8 +8,6 @@ > **ClassifierGenerateResult** = `object` -Defined in: [types/classifierRouter.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L356) - Minimal result shape the LLM classifier reads back. ## Properties @@ -18,12 +16,8 @@ Minimal result shape the LLM classifier reads back. > `optional` **content?**: `string` -Defined in: [types/classifierRouter.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L357) - --- ### structuredData? > `optional` **structuredData?**: `unknown` - -Defined in: [types/classifierRouter.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L358) diff --git a/docs/api/type-aliases/ClassifierLogger.md b/docs/api/type-aliases/ClassifierLogger.md index 8c7748b89..be33ffb6f 100644 --- a/docs/api/type-aliases/ClassifierLogger.md +++ b/docs/api/type-aliases/ClassifierLogger.md @@ -8,8 +8,6 @@ > **ClassifierLogger** = `object` -Defined in: [types/classifierRouter.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L374) - Minimal logger surface the router uses (debug/warn). ## Properties @@ -18,8 +16,6 @@ Minimal logger surface the router uses (debug/warn). > **debug**: (`message`, `meta?`) => `void` -Defined in: [types/classifierRouter.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L375) - #### Parameters ##### message @@ -40,8 +36,6 @@ Defined in: [types/classifierRouter.ts:375](https://github.com/juspay/neurolink/ > **warn**: (`message`, `meta?`) => `void` -Defined in: [types/classifierRouter.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L376) - #### Parameters ##### message diff --git a/docs/api/type-aliases/ClassifierModelMeta.md b/docs/api/type-aliases/ClassifierModelMeta.md index 2f28d86bd..9166d086e 100644 --- a/docs/api/type-aliases/ClassifierModelMeta.md +++ b/docs/api/type-aliases/ClassifierModelMeta.md @@ -8,8 +8,6 @@ > **ClassifierModelMeta** = `object` -Defined in: [types/classifierRouter.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L334) - Enriched per-model metadata used while ranking pool members. ## Properties @@ -18,20 +16,14 @@ Enriched per-model metadata used while ranking pool members. > `optional` **cost?**: `number` -Defined in: [types/classifierRouter.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L335) - --- ### quality? > `optional` **quality?**: `number` -Defined in: [types/classifierRouter.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L336) - --- ### capabilities? > `optional` **capabilities?**: `string`[] - -Defined in: [types/classifierRouter.ts:337](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L337) diff --git a/docs/api/type-aliases/ClassifierModelRef.md b/docs/api/type-aliases/ClassifierModelRef.md index 3e59d697a..6975266b1 100644 --- a/docs/api/type-aliases/ClassifierModelRef.md +++ b/docs/api/type-aliases/ClassifierModelRef.md @@ -8,8 +8,6 @@ > **ClassifierModelRef** = `object` -Defined in: [types/classifierRouter.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L194) - Provider/model the LLM classifier strategy itself runs on. ## Properties @@ -18,28 +16,20 @@ Provider/model the LLM classifier strategy itself runs on. > `optional` **provider?**: `string` -Defined in: [types/classifierRouter.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L195) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/classifierRouter.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L196) - --- ### region? > `optional` **region?**: `string` -Defined in: [types/classifierRouter.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L197) - --- ### temperature? > `optional` **temperature?**: `number` - -Defined in: [types/classifierRouter.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L198) diff --git a/docs/api/type-aliases/ClassifierRouterConfig.md b/docs/api/type-aliases/ClassifierRouterConfig.md index 006d9a08f..8a799849c 100644 --- a/docs/api/type-aliases/ClassifierRouterConfig.md +++ b/docs/api/type-aliases/ClassifierRouterConfig.md @@ -8,8 +8,6 @@ > **ClassifierRouterConfig** = `object` -Defined in: [types/classifierRouter.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L202) - Constructor-level configuration for the classifier router. ## Properties @@ -18,8 +16,6 @@ Constructor-level configuration for the classifier router. > **enabled**: `boolean` -Defined in: [types/classifierRouter.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L204) - Master switch. When false/absent, the router is never built. --- @@ -28,8 +24,6 @@ Master switch. When false/absent, the router is never built. > `optional` **classifier?**: [`ClassifierStrategyKind`](ClassifierStrategyKind.md) -Defined in: [types/classifierRouter.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L213) - Classification strategy. Default: "auto" — which resolves to "jev" when a decision provider is configured, in the environment or in SDK credentials (`TYPESAFE_API_KEY`, or `LAYA_API_KEY` with `LAYA_BASE_URL`) and @@ -43,8 +37,6 @@ key is unchanged. > `optional` **classifierModel?**: [`ClassifierModelRef`](ClassifierModelRef.md) -Defined in: [types/classifierRouter.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L215) - Model used by the "llm" strategy. Defaults to provider/model auto. --- @@ -53,8 +45,6 @@ Model used by the "llm" strategy. Defaults to provider/model auto. > `optional` **minUpgradeConfidence?**: `number` -Defined in: [types/classifierRouter.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L221) - How sure the classifier must be to route a request UP to a more capable (costlier) model. Being wrong here costs money, so the bar is low. Only meaningful for "jev", whose confidence is calibrated. Default: 0.3. @@ -65,8 +55,6 @@ Only meaningful for "jev", whose confidence is calibrated. Default: 0.3. > `optional` **minDowngradeConfidence?**: `number` -Defined in: [types/classifierRouter.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L227) - How sure it must be to route DOWN to a cheaper model. Being wrong here means a task handled by too small a model, so the bar is high. Default: 0.6. @@ -77,8 +65,6 @@ Default: 0.6. > **pool**: [`ClassifierRouterPoolMember`](ClassifierRouterPoolMember.md)[] -Defined in: [types/classifierRouter.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L229) - The available base pool the router selects a model from. --- @@ -87,8 +73,6 @@ The available base pool the router selects a model from. > `optional` **tierMap?**: `Partial`\<`Record`\<[`ClassifierDifficulty`](ClassifierDifficulty.md), [`ClassifierRouterPoolMember`](ClassifierRouterPoolMember.md)[]\>\> -Defined in: [types/classifierRouter.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L234) - Explicit difficulty → members map. When a difficulty has entries here they take precedence over metadata scoring of `pool`. @@ -98,8 +82,6 @@ take precedence over metadata scoring of `pool`. > `optional` **toolDirectives?**: `Partial`\<`Record`\<[`ClassifierDifficulty`](ClassifierDifficulty.md), [`ClassifierToolDirective`](ClassifierToolDirective.md)\>\> -Defined in: [types/classifierRouter.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L236) - Per-difficulty tool directives applied to the request. --- @@ -108,8 +90,6 @@ Per-difficulty tool directives applied to the request. > `optional` **timeoutMs?**: `number` -Defined in: [types/classifierRouter.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L240) - Hard timeout (ms) for the LLM classifier call. Default: 8000. --- @@ -118,8 +98,6 @@ Hard timeout (ms) for the LLM classifier call. Default: 8000. > `optional` **catalog?**: [`ClassifierCatalogConfig`](ClassifierCatalogConfig.md) -Defined in: [types/classifierRouter.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L251) - Widen the pool with every model the registry knows about that this host actually has credentials for. @@ -135,8 +113,6 @@ service with a negotiated model list. > `optional` **contextBudget?**: `boolean` -Defined in: [types/classifierRouter.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L258) - Ask the classifier how much context the request needs and use the answer to lower the compaction threshold. Default: true when the strategy resolves to a decision model, since the question rides along in a batch diff --git a/docs/api/type-aliases/ClassifierRouterDecision.md b/docs/api/type-aliases/ClassifierRouterDecision.md index 2fa3999a3..9c65bb6a1 100644 --- a/docs/api/type-aliases/ClassifierRouterDecision.md +++ b/docs/api/type-aliases/ClassifierRouterDecision.md @@ -8,8 +8,6 @@ > **ClassifierRouterDecision** = `object` -Defined in: [types/classifierRouter.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L289) - The router's combined decision: a provider/model/region override plus an optional tool narrowing. Any undefined field means "keep what the caller already configured". Returning `null` from the router is a valid no-op. @@ -20,32 +18,24 @@ already configured". Returning `null` from the router is a valid no-op. > `optional` **provider?**: `string` -Defined in: [types/classifierRouter.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L290) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/classifierRouter.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L291) - --- ### region? > `optional` **region?**: `string` -Defined in: [types/classifierRouter.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L292) - --- ### toolFilter? > `optional` **toolFilter?**: `string`[] -Defined in: [types/classifierRouter.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L294) - Allowlist applied to `options.toolFilter`. --- @@ -54,8 +44,6 @@ Allowlist applied to `options.toolFilter`. > `optional` **excludeTools?**: `string`[] -Defined in: [types/classifierRouter.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L296) - Denylist appended to `options.excludeTools`. --- @@ -64,8 +52,6 @@ Denylist appended to `options.excludeTools`. > `optional` **difficulty?**: [`ClassifierDifficulty`](ClassifierDifficulty.md) -Defined in: [types/classifierRouter.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L298) - The difficulty this decision was made for (debug/telemetry). --- @@ -74,8 +60,6 @@ The difficulty this decision was made for (debug/telemetry). > `optional` **compactionThreshold?**: `number` -Defined in: [types/classifierRouter.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L310) - Fraction of the model's window at which compaction should trigger for THIS request, replacing the fixed 0.8 default. @@ -92,8 +76,6 @@ unrecoverable. > `optional` **contextScope?**: [`ClassifierContextScope`](ClassifierContextScope.md) -Defined in: [types/classifierRouter.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L312) - The scope reading `compactionThreshold` was derived from. --- @@ -102,8 +84,6 @@ The scope reading `compactionThreshold` was derived from. > `optional` **modelFallbacks?**: [`ClassifierRouterPoolMember`](ClassifierRouterPoolMember.md)[] -Defined in: [types/classifierRouter.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L314) - Remaining ranked candidates, best-first, for downstream failover. --- @@ -112,6 +92,4 @@ Remaining ranked candidates, best-first, for downstream failover. > `optional` **reason?**: `string` -Defined in: [types/classifierRouter.ts:316](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L316) - Human-readable explanation, emitted at debug level. diff --git a/docs/api/type-aliases/ClassifierRouterDeps.md b/docs/api/type-aliases/ClassifierRouterDeps.md index 9a13e1a3c..6be4e04eb 100644 --- a/docs/api/type-aliases/ClassifierRouterDeps.md +++ b/docs/api/type-aliases/ClassifierRouterDeps.md @@ -8,8 +8,6 @@ > **ClassifierRouterDeps** = `object` -Defined in: [types/classifierRouter.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L383) - Injected dependencies — keep `ClassifierRouter` provider-import-free and unit-testable (mirrors the `toolRouting` generateFn-injection pattern). @@ -19,8 +17,6 @@ unit-testable (mirrors the `toolRouting` generateFn-injection pattern). > `optional` **generate?**: [`ClassifierGenerateFn`](ClassifierGenerateFn.md) -Defined in: [types/classifierRouter.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L385) - LLM caller for the "llm" strategy. Omit to disable LLM classification. --- @@ -29,8 +25,6 @@ LLM caller for the "llm" strategy. Omit to disable LLM classification. > `optional` **decide?**: [`ClassifierDecideFn`](ClassifierDecideFn.md) -Defined in: [types/classifierRouter.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L387) - Decision caller for the "jev" strategy. Omit to disable it. --- @@ -39,8 +33,6 @@ Decision caller for the "jev" strategy. Omit to disable it. > `optional` **hasDecisionProvider?**: () => `boolean` -Defined in: [types/classifierRouter.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L393) - Whether a decision provider is configured for this caller, counting the credentials it was given as well as the environment. Omit to check the environment alone. @@ -54,5 +46,3 @@ environment alone. ### logger? > `optional` **logger?**: [`ClassifierLogger`](ClassifierLogger.md) - -Defined in: [types/classifierRouter.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L394) diff --git a/docs/api/type-aliases/ClassifierRouterInput.md b/docs/api/type-aliases/ClassifierRouterInput.md index 0f47944e7..b6816240f 100644 --- a/docs/api/type-aliases/ClassifierRouterInput.md +++ b/docs/api/type-aliases/ClassifierRouterInput.md @@ -8,8 +8,6 @@ > **ClassifierRouterInput** = `object` -Defined in: [types/classifierRouter.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L320) - Lightweight request snapshot handed to the router. ## Properties @@ -18,56 +16,42 @@ Lightweight request snapshot handed to the router. > **prompt**: `string` -Defined in: [types/classifierRouter.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L321) - --- ### estimatedInputTokens? > `optional` **estimatedInputTokens?**: `number` -Defined in: [types/classifierRouter.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L322) - --- ### hasTools? > `optional` **hasTools?**: `boolean` -Defined in: [types/classifierRouter.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L323) - --- ### requiresVision? > `optional` **requiresVision?**: `boolean` -Defined in: [types/classifierRouter.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L324) - --- ### thinkingLevel? > `optional` **thinkingLevel?**: `string` -Defined in: [types/classifierRouter.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L325) - --- ### sessionId? > `optional` **sessionId?**: `string` -Defined in: [types/classifierRouter.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L326) - --- ### sessionBound? > `optional` **sessionBound?**: `boolean` -Defined in: [types/classifierRouter.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L328) - Whether this request is tied to a session, independent of the (withheld) session id itself. --- @@ -76,6 +60,4 @@ Whether this request is tied to a session, independent of the (withheld) session > `optional` **priorMessageCount?**: `number` -Defined in: [types/classifierRouter.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L330) - Number of prior conversation messages the caller supplied, when known. diff --git a/docs/api/type-aliases/ClassifierRouterPoolMember.md b/docs/api/type-aliases/ClassifierRouterPoolMember.md index 517fc5b68..5b2da5d24 100644 --- a/docs/api/type-aliases/ClassifierRouterPoolMember.md +++ b/docs/api/type-aliases/ClassifierRouterPoolMember.md @@ -8,8 +8,6 @@ > **ClassifierRouterPoolMember** = `object` -Defined in: [types/classifierRouter.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L157) - One candidate (provider, model, region) in the available base pool, with optional routing metadata. When `cost`/`quality`/`capabilities` are omitted, the router enriches them from the model registry (by `model` name/alias). @@ -20,32 +18,24 @@ the router enriches them from the model registry (by `model` name/alias). > **provider**: `string` -Defined in: [types/classifierRouter.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L158) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/classifierRouter.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L159) - --- ### region? > `optional` **region?**: `string` -Defined in: [types/classifierRouter.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L160) - --- ### id? > `optional` **id?**: `string` -Defined in: [types/classifierRouter.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L165) - Stable id the LLM classifier references when selecting a model directly. Defaults to `${provider}/${model}` (or just `provider`) when omitted. @@ -55,8 +45,6 @@ Defaults to `${provider}/${model}` (or just `provider`) when omitted. > `optional` **description?**: `string` -Defined in: [types/classifierRouter.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L172) - Plain-English description of when to use this model (e.g. "cheap & fast, for simple Q&A" / "powerful reasoning model for complex analysis"). Drives LLM-based model selection — the only metadata needed for custom models that @@ -68,8 +56,6 @@ are NOT in the registry (LiteLLM, OpenAI-compatible, self-hosted, …). > `optional` **tiers?**: [`ClassifierDifficulty`](ClassifierDifficulty.md)[] -Defined in: [types/classifierRouter.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L174) - Difficulty tiers this member is eligible for. Omit = eligible for all. --- @@ -78,8 +64,6 @@ Difficulty tiers this member is eligible for. Omit = eligible for all. > `optional` **cost?**: `number` -Defined in: [types/classifierRouter.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L176) - Relative cost (lower = cheaper). Preferred for easy tiers. --- @@ -88,8 +72,6 @@ Relative cost (lower = cheaper). Preferred for easy tiers. > `optional` **quality?**: `number` -Defined in: [types/classifierRouter.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L178) - Relative quality/capability (higher = more capable). Preferred for hard tiers. --- @@ -98,8 +80,6 @@ Relative quality/capability (higher = more capable). Preferred for hard tiers. > `optional` **capabilities?**: `string`[] -Defined in: [types/classifierRouter.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L180) - Capability tags this member supports (e.g. "vision", "tools"). --- @@ -108,6 +88,4 @@ Capability tags this member supports (e.g. "vision", "tools"). > `optional` **weight?**: `number` -Defined in: [types/classifierRouter.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L182) - Tiebreak weight when scores are equal. Default: 1. diff --git a/docs/api/type-aliases/ClassifierStrategyKind.md b/docs/api/type-aliases/ClassifierStrategyKind.md index b03d833b2..00bfdcebc 100644 --- a/docs/api/type-aliases/ClassifierStrategyKind.md +++ b/docs/api/type-aliases/ClassifierStrategyKind.md @@ -8,8 +8,6 @@ > **ClassifierStrategyKind** = `"heuristic"` \| `"llm"` \| `"jev"` \| `"auto"` -Defined in: [types/classifierRouter.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L39) - Which classification strategy to run. - `heuristic` — keyword/length scoring. Deterministic, zero latency. diff --git a/docs/api/type-aliases/ClassifierToolDirective.md b/docs/api/type-aliases/ClassifierToolDirective.md index 451e5acf3..7aefab8cd 100644 --- a/docs/api/type-aliases/ClassifierToolDirective.md +++ b/docs/api/type-aliases/ClassifierToolDirective.md @@ -8,8 +8,6 @@ > **ClassifierToolDirective** = `object` -Defined in: [types/classifierRouter.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L186) - Per-difficulty tool policy applied to the request. ## Properties @@ -18,8 +16,6 @@ Per-difficulty tool policy applied to the request. > `optional` **toolFilter?**: `string`[] -Defined in: [types/classifierRouter.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L188) - Allowlist of tool names to keep (maps to `options.toolFilter`). --- @@ -28,6 +24,4 @@ Allowlist of tool names to keep (maps to `options.toolFilter`). > `optional` **excludeTools?**: `string`[] -Defined in: [types/classifierRouter.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/classifierRouter.ts#L190) - Denylist of tool names to drop (appended to `options.excludeTools`). diff --git a/docs/api/type-aliases/ClaudeCacheControl.md b/docs/api/type-aliases/ClaudeCacheControl.md index 926dd2c17..8030c6203 100644 --- a/docs/api/type-aliases/ClaudeCacheControl.md +++ b/docs/api/type-aliases/ClaudeCacheControl.md @@ -8,8 +8,6 @@ > **ClaudeCacheControl** = `object` -Defined in: [types/proxy.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L73) - Anthropic prompt-cache breakpoint marker. Anthropic caching is explicit: the prefix up to each marker is cached, and a @@ -21,16 +19,12 @@ request carrying none is cached not at all. Four markers is the hard ceiling. > **type**: `"ephemeral"` -Defined in: [types/proxy.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L74) - --- ### ttl? > `optional` **ttl?**: `"5m"` \| `"1h"` -Defined in: [types/proxy.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L81) - How long the marked prefix stays cached. The API accepts a 5-minute or a 1-hour window, priced at 1.25x and 2x base input respectively; omitting it means 5 minutes. Without this field a caller cannot express the 1-hour diff --git a/docs/api/type-aliases/ClaudeCodeIdentity.md b/docs/api/type-aliases/ClaudeCodeIdentity.md index 10aad9d9b..6df78223c 100644 --- a/docs/api/type-aliases/ClaudeCodeIdentity.md +++ b/docs/api/type-aliases/ClaudeCodeIdentity.md @@ -8,8 +8,6 @@ > **ClaudeCodeIdentity** = `object` -Defined in: [types/auth.ts:1281](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1281) - Synthetic Claude Code client identity used for quota + identification. ## Properties @@ -18,28 +16,20 @@ Synthetic Claude Code client identity used for quota + identification. > **deviceId**: `string` -Defined in: [types/auth.ts:1282](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1282) - --- ### accountUuid > **accountUuid**: `string` -Defined in: [types/auth.ts:1283](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1283) - --- ### sessionId > **sessionId**: `string` -Defined in: [types/auth.ts:1284](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1284) - --- ### metadataUserId > **metadataUserId**: `string` - -Defined in: [types/auth.ts:1285](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1285) diff --git a/docs/api/type-aliases/ClaudeContentBlock.md b/docs/api/type-aliases/ClaudeContentBlock.md index b2f4bfcd5..f663db936 100644 --- a/docs/api/type-aliases/ClaudeContentBlock.md +++ b/docs/api/type-aliases/ClaudeContentBlock.md @@ -7,5 +7,3 @@ # Type Alias: ClaudeContentBlock > **ClaudeContentBlock** = [`ClaudeTextBlock`](ClaudeTextBlock.md) \| [`ClaudeImageBlock`](ClaudeImageBlock.md) \| [`ClaudeToolUseBlock`](ClaudeToolUseBlock.md) \| [`ClaudeToolResultBlock`](ClaudeToolResultBlock.md) \| [`ClaudeThinkingBlock`](ClaudeThinkingBlock.md) - -Defined in: [types/proxy.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L124) diff --git a/docs/api/type-aliases/ClaudeErrorResponse.md b/docs/api/type-aliases/ClaudeErrorResponse.md index b5c07f788..1b3bf99ad 100644 --- a/docs/api/type-aliases/ClaudeErrorResponse.md +++ b/docs/api/type-aliases/ClaudeErrorResponse.md @@ -8,8 +8,6 @@ > **ClaudeErrorResponse** = `object` -Defined in: [types/proxy.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L197) - Claude API error envelope. ## Properties @@ -18,16 +16,12 @@ Claude API error envelope. > **type**: `"error"` -Defined in: [types/proxy.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L198) - --- ### error > **error**: `object` -Defined in: [types/proxy.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L199) - #### type > **type**: `string` diff --git a/docs/api/type-aliases/ClaudeFinalRequestLogger.md b/docs/api/type-aliases/ClaudeFinalRequestLogger.md index 65e2aa240..375fcccdc 100644 --- a/docs/api/type-aliases/ClaudeFinalRequestLogger.md +++ b/docs/api/type-aliases/ClaudeFinalRequestLogger.md @@ -8,8 +8,6 @@ > **ClaudeFinalRequestLogger** = (`status`, `accountLabel`, `accountType`, `errorType?`, `errorMessage?`, `extra?`) => `void` -Defined in: [types/proxy.ts:1251](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1251) - ## Parameters ### status diff --git a/docs/api/type-aliases/ClaudeImageBlock.md b/docs/api/type-aliases/ClaudeImageBlock.md index 76b0cd422..042e93017 100644 --- a/docs/api/type-aliases/ClaudeImageBlock.md +++ b/docs/api/type-aliases/ClaudeImageBlock.md @@ -8,8 +8,6 @@ > **ClaudeImageBlock** = `object` -Defined in: [types/proxy.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L92) - A single image block in a Claude content array. ## Properties @@ -18,16 +16,12 @@ A single image block in a Claude content array. > **type**: `"image"` -Defined in: [types/proxy.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L93) - --- ### source > **source**: `object` -Defined in: [types/proxy.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L94) - #### type > **type**: `"base64"` \| `"url"` diff --git a/docs/api/type-aliases/ClaudeLimitCaptureSlot.md b/docs/api/type-aliases/ClaudeLimitCaptureSlot.md index 6491e5988..cc5647157 100644 --- a/docs/api/type-aliases/ClaudeLimitCaptureSlot.md +++ b/docs/api/type-aliases/ClaudeLimitCaptureSlot.md @@ -8,8 +8,6 @@ > **ClaudeLimitCaptureSlot** = `object` -Defined in: [types/subscription.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L211) - Per-request capture slot the Anthropic fetch wrapper writes into. Held in AsyncLocalStorage for the duration of a generate/stream call, so @@ -23,12 +21,8 @@ report real response headers. > `optional` **snapshot?**: [`ClaudeLimitSnapshot`](ClaudeLimitSnapshot.md) -Defined in: [types/subscription.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L212) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> - -Defined in: [types/subscription.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L213) diff --git a/docs/api/type-aliases/ClaudeLimitSnapshot.md b/docs/api/type-aliases/ClaudeLimitSnapshot.md index 775e7b610..ca309603e 100644 --- a/docs/api/type-aliases/ClaudeLimitSnapshot.md +++ b/docs/api/type-aliases/ClaudeLimitSnapshot.md @@ -8,8 +8,6 @@ > **ClaudeLimitSnapshot** = `object` -Defined in: [types/subscription.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L170) - Per-request limit snapshot as observed by the Anthropic provider. Assembled from response headers on every request — whether the provider is @@ -23,8 +21,6 @@ the proxy, which is the only party that knows them. > **rateLimit**: [`AnthropicRateLimitInfo`](AnthropicRateLimitInfo.md) -Defined in: [types/subscription.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L172) - Rate-limit figures parsed from `anthropic-ratelimit-*` headers. --- @@ -33,8 +29,6 @@ Rate-limit figures parsed from `anthropic-ratelimit-*` headers. > `optional` **quotaSource?**: `"live"` \| `"snapshot"` \| `"none"` -Defined in: [types/subscription.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L179) - Provenance of the quota numbers. "snapshot" means the proxy reported a previously captured reading rather than one from this response; "none" means no Anthropic account served the request (e.g. a fallback provider). @@ -46,8 +40,6 @@ Absent when talking directly to Anthropic, where any figures are live. > `optional` **account?**: `string` -Defined in: [types/subscription.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L181) - Proxy account label that served the request. --- @@ -56,8 +48,6 @@ Proxy account label that served the request. > `optional` **accountType?**: `string` -Defined in: [types/subscription.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L183) - "oauth" | "api_key" | "passthrough". --- @@ -66,8 +56,6 @@ Defined in: [types/subscription.ts:183](https://github.com/juspay/neurolink/blob > `optional` **servedBy?**: `string` -Defined in: [types/subscription.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L185) - Upstream that produced the response — "anthropic" or a fallback provider. --- @@ -76,8 +64,6 @@ Upstream that produced the response — "anthropic" or a fallback provider. > `optional` **accountCoolingUntil?**: `number` -Defined in: [types/subscription.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L187) - Epoch ms until which the serving account is cooling. --- @@ -86,16 +72,12 @@ Epoch ms until which the serving account is cooling. > `optional` **accountCoolingReason?**: `string` -Defined in: [types/subscription.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L188) - --- ### pool? > `optional` **pool?**: `object` -Defined in: [types/subscription.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L190) - Proxy account-pool headroom at response time. #### available? @@ -116,8 +98,6 @@ Proxy account-pool headroom at response time. > `optional` **requestId?**: `string` -Defined in: [types/subscription.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L196) - Anthropic request id, for correlating with provider-side logs. --- @@ -126,8 +106,6 @@ Anthropic request id, for correlating with provider-side logs. > `optional` **status?**: `number` -Defined in: [types/subscription.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L198) - HTTP status of the response the snapshot came from. --- @@ -136,6 +114,4 @@ HTTP status of the response the snapshot came from. > **capturedAt**: `number` -Defined in: [types/subscription.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L200) - Epoch ms when this snapshot was captured. diff --git a/docs/api/type-aliases/ClaudeLoggedErrorBuilder.md b/docs/api/type-aliases/ClaudeLoggedErrorBuilder.md index b5466cd74..c5c372df2 100644 --- a/docs/api/type-aliases/ClaudeLoggedErrorBuilder.md +++ b/docs/api/type-aliases/ClaudeLoggedErrorBuilder.md @@ -8,8 +8,6 @@ > **ClaudeLoggedErrorBuilder** = (`status`, `message`, `errorType?`, `extra?`) => [`ClaudeErrorResponse`](ClaudeErrorResponse.md) -Defined in: [types/proxy.ts:1272](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1272) - ## Parameters ### status diff --git a/docs/api/type-aliases/ClaudeMessage.md b/docs/api/type-aliases/ClaudeMessage.md index 1e72b70b5..e73de2780 100644 --- a/docs/api/type-aliases/ClaudeMessage.md +++ b/docs/api/type-aliases/ClaudeMessage.md @@ -8,8 +8,6 @@ > **ClaudeMessage** = `object` -Defined in: [types/proxy.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L132) - A single message in a Claude conversation. ## Properties @@ -18,12 +16,8 @@ A single message in a Claude conversation. > **role**: `"user"` \| `"assistant"` -Defined in: [types/proxy.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L133) - --- ### content > **content**: `string` \| [`ClaudeContentBlock`](ClaudeContentBlock.md)[] - -Defined in: [types/proxy.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L134) diff --git a/docs/api/type-aliases/ClaudeMetadata.md b/docs/api/type-aliases/ClaudeMetadata.md index 6b15b5094..488e34a02 100644 --- a/docs/api/type-aliases/ClaudeMetadata.md +++ b/docs/api/type-aliases/ClaudeMetadata.md @@ -8,8 +8,6 @@ > **ClaudeMetadata** = `object` -Defined in: [types/proxy.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L146) - Metadata attached to a Claude Messages API request. ## Properties @@ -17,5 +15,3 @@ Metadata attached to a Claude Messages API request. ### user_id? > `optional` **user_id?**: `string` - -Defined in: [types/proxy.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L147) diff --git a/docs/api/type-aliases/ClaudeProxyDeps.md b/docs/api/type-aliases/ClaudeProxyDeps.md index 04941e074..e73bdbf36 100644 --- a/docs/api/type-aliases/ClaudeProxyDeps.md +++ b/docs/api/type-aliases/ClaudeProxyDeps.md @@ -8,8 +8,6 @@ > **ClaudeProxyDeps** = `object` -Defined in: [types/proxy.ts:2046](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2046) - Dependencies for creating Claude proxy routes. ## Properties @@ -17,5 +15,3 @@ Dependencies for creating Claude proxy routes. ### modelRouter? > `optional` **modelRouter?**: [`ModelRouterInterface`](ModelRouterInterface.md) - -Defined in: [types/proxy.ts:2047](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2047) diff --git a/docs/api/type-aliases/ClaudeProxyModelTier.md b/docs/api/type-aliases/ClaudeProxyModelTier.md index 791809555..1f433c26d 100644 --- a/docs/api/type-aliases/ClaudeProxyModelTier.md +++ b/docs/api/type-aliases/ClaudeProxyModelTier.md @@ -8,6 +8,4 @@ > **ClaudeProxyModelTier** = `"opus"` \| `"sonnet"` \| `"haiku"` \| `"other"` -Defined in: [types/proxy.ts:2103](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2103) - Model tier classification for proxy routing decisions. diff --git a/docs/api/type-aliases/ClaudeProxyRouteRuntimeOptions.md b/docs/api/type-aliases/ClaudeProxyRouteRuntimeOptions.md index fd2062fbc..08fe44bd0 100644 --- a/docs/api/type-aliases/ClaudeProxyRouteRuntimeOptions.md +++ b/docs/api/type-aliases/ClaudeProxyRouteRuntimeOptions.md @@ -8,8 +8,6 @@ > **ClaudeProxyRouteRuntimeOptions** = `object` -Defined in: [types/proxy.ts:3822](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3822) - Optional runtime configuration wiring for Claude proxy route factories. ## Properties @@ -18,12 +16,8 @@ Optional runtime configuration wiring for Claude proxy route factories. > `optional` **accountAllowlist?**: [`AccountAllowlist`](AccountAllowlist.md) -Defined in: [types/proxy.ts:3823](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3823) - --- ### runtimeConfigProvider > **runtimeConfigProvider**: [`ProxyRuntimeConfigProvider`](ProxyRuntimeConfigProvider.md) - -Defined in: [types/proxy.ts:3824](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3824) diff --git a/docs/api/type-aliases/ClaudeQuotaInfo.md b/docs/api/type-aliases/ClaudeQuotaInfo.md index 4422c8200..725f01ece 100644 --- a/docs/api/type-aliases/ClaudeQuotaInfo.md +++ b/docs/api/type-aliases/ClaudeQuotaInfo.md @@ -8,8 +8,6 @@ > **ClaudeQuotaInfo** = `object` -Defined in: [types/subscription.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L345) - Claude quota information for tracking usage limits ## Description @@ -23,8 +21,6 @@ including message limits, token limits, and model access restrictions. > **maxMessagesPerPeriod**: `number` -Defined in: [types/subscription.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L350) - Maximum messages allowed per time period #### Description @@ -37,8 +33,6 @@ Number of messages the user can send within the reset period > **maxTokensPerPeriod**: `number` -Defined in: [types/subscription.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L356) - Maximum tokens allowed per time period #### Description @@ -51,8 +45,6 @@ Total tokens (input + output) allowed within the reset period > **maxTokensPerRequest**: `number` -Defined in: [types/subscription.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L362) - Maximum tokens per individual request #### Description @@ -65,8 +57,6 @@ Limit on tokens for a single API request > **resetPeriodMs**: `number` -Defined in: [types/subscription.ts:368](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L368) - Time period for quota reset in milliseconds #### Description @@ -79,8 +69,6 @@ Duration after which quota counters reset (e.g., 3600000 for 1 hour) > **nextResetTimestamp**: `number` -Defined in: [types/subscription.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L374) - Timestamp when quota will reset (Unix epoch in milliseconds) #### Description @@ -93,8 +81,6 @@ Next quota reset time > **availableModels**: `string`[] -Defined in: [types/subscription.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L380) - List of models accessible with current subscription #### Description @@ -107,8 +93,6 @@ Model identifiers the user has access to based on tier > **hasPriorityAccess**: `boolean` -Defined in: [types/subscription.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L386) - Whether priority queue access is enabled #### Description @@ -121,8 +105,6 @@ Priority access reduces wait times during high traffic > **maxConcurrentRequests**: `number` -Defined in: [types/subscription.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L392) - Maximum concurrent requests allowed #### Description @@ -135,8 +117,6 @@ Number of simultaneous API requests permitted > **hasExtendedThinking**: `boolean` -Defined in: [types/subscription.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L398) - Whether extended thinking is available #### Description @@ -149,8 +129,6 @@ Access to extended thinking/reasoning capabilities > **maxContextWindow**: `number` -Defined in: [types/subscription.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L404) - Maximum context window size in tokens #### Description diff --git a/docs/api/type-aliases/ClaudeRequest.md b/docs/api/type-aliases/ClaudeRequest.md index d9ce2006d..0cf258112 100644 --- a/docs/api/type-aliases/ClaudeRequest.md +++ b/docs/api/type-aliases/ClaudeRequest.md @@ -8,8 +8,6 @@ > **ClaudeRequest** = `object` -Defined in: [types/proxy.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L154) - Inbound Claude Messages API request body. Matches POST /v1/messages. @@ -19,96 +17,72 @@ Matches POST /v1/messages. > **model**: `string` -Defined in: [types/proxy.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L155) - --- ### messages > **messages**: [`ClaudeMessage`](ClaudeMessage.md)[] -Defined in: [types/proxy.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L156) - --- ### max_tokens > **max_tokens**: `number` -Defined in: [types/proxy.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L157) - --- ### system? > `optional` **system?**: `string` \| [`ClaudeTextBlock`](ClaudeTextBlock.md)[] -Defined in: [types/proxy.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L158) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/proxy.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L159) - --- ### top_p? > `optional` **top_p?**: `number` -Defined in: [types/proxy.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L160) - --- ### top_k? > `optional` **top_k?**: `number` -Defined in: [types/proxy.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L161) - --- ### stop_sequences? > `optional` **stop_sequences?**: `string`[] -Defined in: [types/proxy.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L162) - --- ### stream? > `optional` **stream?**: `boolean` -Defined in: [types/proxy.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L163) - --- ### tools? > `optional` **tools?**: [`ClaudeTool`](ClaudeTool.md)[] -Defined in: [types/proxy.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L164) - --- ### tool_choice? > `optional` **tool_choice?**: \{ `type`: `"auto"` \| `"any"` \| `"none"`; \} \| \{ `type`: `"tool"`; `name`: `string`; \} -Defined in: [types/proxy.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L165) - --- ### thinking? > `optional` **thinking?**: `object` -Defined in: [types/proxy.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L168) - #### type > **type**: `string` @@ -122,5 +96,3 @@ Defined in: [types/proxy.ts:168](https://github.com/juspay/neurolink/blob/releas ### metadata? > `optional` **metadata?**: [`ClaudeMetadata`](ClaudeMetadata.md) - -Defined in: [types/proxy.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L169) diff --git a/docs/api/type-aliases/ClaudeRequestRuntimeContext.md b/docs/api/type-aliases/ClaudeRequestRuntimeContext.md index 917ee0c5c..3a52246cb 100644 --- a/docs/api/type-aliases/ClaudeRequestRuntimeContext.md +++ b/docs/api/type-aliases/ClaudeRequestRuntimeContext.md @@ -8,44 +8,32 @@ > **ClaudeRequestRuntimeContext** = `object` -Defined in: [types/proxy.ts:1286](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1286) - ## Properties ### tracer? > `optional` **tracer?**: `ProxyTracer` -Defined in: [types/proxy.ts:1287](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1287) - --- ### requestStartTime > **requestStartTime**: `number` -Defined in: [types/proxy.ts:1288](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1288) - --- ### logProxyBody > **logProxyBody**: [`ProxyBodyCaptureLogger`](ProxyBodyCaptureLogger.md) -Defined in: [types/proxy.ts:1289](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1289) - --- ### logFinalRequest > **logFinalRequest**: [`ClaudeFinalRequestLogger`](ClaudeFinalRequestLogger.md) -Defined in: [types/proxy.ts:1290](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1290) - --- ### buildLoggedClaudeError > **buildLoggedClaudeError**: [`ClaudeLoggedErrorBuilder`](ClaudeLoggedErrorBuilder.md) - -Defined in: [types/proxy.ts:1291](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1291) diff --git a/docs/api/type-aliases/ClaudeResponse.md b/docs/api/type-aliases/ClaudeResponse.md index f51f7ff2d..622abb6cf 100644 --- a/docs/api/type-aliases/ClaudeResponse.md +++ b/docs/api/type-aliases/ClaudeResponse.md @@ -8,8 +8,6 @@ > **ClaudeResponse** = `object` -Defined in: [types/proxy.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L185) - Non-streaming response matching the Claude Messages API. ## Properties @@ -18,60 +16,44 @@ Non-streaming response matching the Claude Messages API. > **id**: `string` -Defined in: [types/proxy.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L186) - --- ### type > **type**: `"message"` -Defined in: [types/proxy.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L187) - --- ### role > **role**: `"assistant"` -Defined in: [types/proxy.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L188) - --- ### content > **content**: [`ClaudeContentBlock`](ClaudeContentBlock.md)[] -Defined in: [types/proxy.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L189) - --- ### model > **model**: `string` -Defined in: [types/proxy.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L190) - --- ### stop_reason > **stop_reason**: `string` \| `null` -Defined in: [types/proxy.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L191) - --- ### stop_sequence > **stop_sequence**: `string` \| `null` -Defined in: [types/proxy.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L192) - --- ### usage > **usage**: [`ClaudeUsage`](ClaudeUsage.md) - -Defined in: [types/proxy.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L193) diff --git a/docs/api/type-aliases/ClaudeSnapshot.md b/docs/api/type-aliases/ClaudeSnapshot.md index 18bb8a633..49d3bebba 100644 --- a/docs/api/type-aliases/ClaudeSnapshot.md +++ b/docs/api/type-aliases/ClaudeSnapshot.md @@ -8,8 +8,6 @@ > **ClaudeSnapshot** = `object` -Defined in: [types/proxy.ts:3673](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3673) - Snapshot of headers and body from a Claude Code request, used for polyfill. ## Properties @@ -18,36 +16,26 @@ Snapshot of headers and body from a Claude Code request, used for polyfill. > **accountKey**: `string` -Defined in: [types/proxy.ts:3674](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3674) - --- ### capturedAt > **capturedAt**: `string` -Defined in: [types/proxy.ts:3675](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3675) - --- ### source > **source**: `"claude-code"` -Defined in: [types/proxy.ts:3676](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3676) - --- ### headers > **headers**: `Record`\<`string`, `string`\> -Defined in: [types/proxy.ts:3677](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3677) - --- ### body? > `optional` **body?**: [`ClaudeSnapshotBody`](ClaudeSnapshotBody.md) - -Defined in: [types/proxy.ts:3678](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3678) diff --git a/docs/api/type-aliases/ClaudeSnapshotBody.md b/docs/api/type-aliases/ClaudeSnapshotBody.md index ea56ee470..a598f8566 100644 --- a/docs/api/type-aliases/ClaudeSnapshotBody.md +++ b/docs/api/type-aliases/ClaudeSnapshotBody.md @@ -8,8 +8,6 @@ > **ClaudeSnapshotBody** = `object` -Defined in: [types/proxy.ts:3665](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3665) - Parsed fields captured from a Claude Code client request body. ## Properties @@ -18,28 +16,20 @@ Parsed fields captured from a Claude Code client request body. > `optional` **metadataUserId?**: `string` -Defined in: [types/proxy.ts:3666](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3666) - --- ### billingHeader? > `optional` **billingHeader?**: `string` -Defined in: [types/proxy.ts:3667](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3667) - --- ### agentBlock? > `optional` **agentBlock?**: `string` -Defined in: [types/proxy.ts:3668](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3668) - --- ### sessionId? > `optional` **sessionId?**: `string` - -Defined in: [types/proxy.ts:3669](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3669) diff --git a/docs/api/type-aliases/ClaudeSubscriptionTier.md b/docs/api/type-aliases/ClaudeSubscriptionTier.md index b92b82477..7515e7e8f 100644 --- a/docs/api/type-aliases/ClaudeSubscriptionTier.md +++ b/docs/api/type-aliases/ClaudeSubscriptionTier.md @@ -8,8 +8,6 @@ > **ClaudeSubscriptionTier** = `"free"` \| `"pro"` \| `"max"` \| `"max_5"` \| `"max_20"` \| `"api"` -Defined in: [types/subscription.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L39) - Claude subscription tier levels ## Description diff --git a/docs/api/type-aliases/ClaudeTextBlock.md b/docs/api/type-aliases/ClaudeTextBlock.md index f894290a5..892e71246 100644 --- a/docs/api/type-aliases/ClaudeTextBlock.md +++ b/docs/api/type-aliases/ClaudeTextBlock.md @@ -8,8 +8,6 @@ > **ClaudeTextBlock** = `object` -Defined in: [types/proxy.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L85) - A single text block in a Claude content array. ## Properties @@ -18,20 +16,14 @@ A single text block in a Claude content array. > **type**: `"text"` -Defined in: [types/proxy.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L86) - --- ### text > **text**: `string` -Defined in: [types/proxy.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L87) - --- ### cache_control? > `optional` **cache_control?**: [`ClaudeCacheControl`](ClaudeCacheControl.md) - -Defined in: [types/proxy.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L88) diff --git a/docs/api/type-aliases/ClaudeThinkingBlock.md b/docs/api/type-aliases/ClaudeThinkingBlock.md index 12927c70e..24af8c107 100644 --- a/docs/api/type-aliases/ClaudeThinkingBlock.md +++ b/docs/api/type-aliases/ClaudeThinkingBlock.md @@ -8,8 +8,6 @@ > **ClaudeThinkingBlock** = `object` -Defined in: [types/proxy.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L119) - A thinking/reasoning block in a Claude content array. ## Properties @@ -18,12 +16,8 @@ A thinking/reasoning block in a Claude content array. > **type**: `"thinking"` -Defined in: [types/proxy.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L120) - --- ### thinking > **thinking**: `string` - -Defined in: [types/proxy.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L121) diff --git a/docs/api/type-aliases/ClaudeTokenValidationResult.md b/docs/api/type-aliases/ClaudeTokenValidationResult.md index 6251000d5..6701dae78 100644 --- a/docs/api/type-aliases/ClaudeTokenValidationResult.md +++ b/docs/api/type-aliases/ClaudeTokenValidationResult.md @@ -8,8 +8,6 @@ > **ClaudeTokenValidationResult** = `object` -Defined in: [types/subscription.ts:988](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L988) - Token validation result ## Properties @@ -18,8 +16,6 @@ Token validation result > **isValid**: `boolean` -Defined in: [types/subscription.ts:990](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L990) - Whether the token is valid --- @@ -28,8 +24,6 @@ Whether the token is valid > `optional` **expiresIn?**: `number` -Defined in: [types/subscription.ts:992](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L992) - Remaining time in seconds until expiration --- @@ -38,8 +32,6 @@ Remaining time in seconds until expiration > `optional` **scopes?**: `string`[] -Defined in: [types/subscription.ts:994](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L994) - Scopes associated with the token --- @@ -48,8 +40,6 @@ Scopes associated with the token > `optional` **user?**: `object` -Defined in: [types/subscription.ts:996](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L996) - User information if available #### id @@ -70,6 +60,4 @@ User information if available > `optional` **error?**: `string` -Defined in: [types/subscription.ts:1002](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1002) - Error message if validation failed diff --git a/docs/api/type-aliases/ClaudeTool.md b/docs/api/type-aliases/ClaudeTool.md index 89152e1be..ed7f3d817 100644 --- a/docs/api/type-aliases/ClaudeTool.md +++ b/docs/api/type-aliases/ClaudeTool.md @@ -8,8 +8,6 @@ > **ClaudeTool** = `object` -Defined in: [types/proxy.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L138) - Tool definition in the Claude Messages API format. ## Properties @@ -18,28 +16,20 @@ Tool definition in the Claude Messages API format. > **name**: `string` -Defined in: [types/proxy.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L139) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/proxy.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L140) - --- ### input_schema > **input_schema**: `Record`\<`string`, `unknown`\> -Defined in: [types/proxy.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L141) - --- ### cache_control? > `optional` **cache_control?**: [`ClaudeCacheControl`](ClaudeCacheControl.md) - -Defined in: [types/proxy.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L142) diff --git a/docs/api/type-aliases/ClaudeToolResultBlock.md b/docs/api/type-aliases/ClaudeToolResultBlock.md index 1751ec0a2..b3ace21e9 100644 --- a/docs/api/type-aliases/ClaudeToolResultBlock.md +++ b/docs/api/type-aliases/ClaudeToolResultBlock.md @@ -8,8 +8,6 @@ > **ClaudeToolResultBlock** = `object` -Defined in: [types/proxy.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L111) - Tool-result block sent back by the caller. ## Properties @@ -18,28 +16,20 @@ Tool-result block sent back by the caller. > **type**: `"tool_result"` -Defined in: [types/proxy.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L112) - --- ### tool_use_id > **tool_use_id**: `string` -Defined in: [types/proxy.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L113) - --- ### content > **content**: `string` \| [`ClaudeContentBlock`](ClaudeContentBlock.md)[] -Defined in: [types/proxy.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L114) - --- ### cache_control? > `optional` **cache_control?**: [`ClaudeCacheControl`](ClaudeCacheControl.md) - -Defined in: [types/proxy.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L115) diff --git a/docs/api/type-aliases/ClaudeToolUseBlock.md b/docs/api/type-aliases/ClaudeToolUseBlock.md index a5b115daa..3a70d8235 100644 --- a/docs/api/type-aliases/ClaudeToolUseBlock.md +++ b/docs/api/type-aliases/ClaudeToolUseBlock.md @@ -8,8 +8,6 @@ > **ClaudeToolUseBlock** = `object` -Defined in: [types/proxy.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L103) - Tool-use block returned by Claude in assistant messages. ## Properties @@ -18,28 +16,20 @@ Tool-use block returned by Claude in assistant messages. > **type**: `"tool_use"` -Defined in: [types/proxy.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L104) - --- ### id > **id**: `string` -Defined in: [types/proxy.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L105) - --- ### name > **name**: `string` -Defined in: [types/proxy.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L106) - --- ### input > **input**: `Record`\<`string`, `unknown`\> - -Defined in: [types/proxy.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L107) diff --git a/docs/api/type-aliases/ClaudeUsage.md b/docs/api/type-aliases/ClaudeUsage.md index 0812718fb..f35d489d9 100644 --- a/docs/api/type-aliases/ClaudeUsage.md +++ b/docs/api/type-aliases/ClaudeUsage.md @@ -8,8 +8,6 @@ > **ClaudeUsage** = `object` -Defined in: [types/proxy.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L177) - Usage counters returned in a Claude response. ## Properties @@ -18,28 +16,20 @@ Usage counters returned in a Claude response. > **input_tokens**: `number` -Defined in: [types/proxy.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L178) - --- ### output_tokens > **output_tokens**: `number` -Defined in: [types/proxy.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L179) - --- ### cache_creation_input_tokens? > `optional` **cache_creation_input_tokens?**: `number` -Defined in: [types/proxy.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L180) - --- ### cache_read_input_tokens? > `optional` **cache_read_input_tokens?**: `number` - -Defined in: [types/proxy.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L181) diff --git a/docs/api/type-aliases/ClaudeUsageInfo.md b/docs/api/type-aliases/ClaudeUsageInfo.md index ae81ad97f..a6f71dd2a 100644 --- a/docs/api/type-aliases/ClaudeUsageInfo.md +++ b/docs/api/type-aliases/ClaudeUsageInfo.md @@ -8,8 +8,6 @@ > **ClaudeUsageInfo** = `object` -Defined in: [types/subscription.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L413) - Claude usage information for tracking current consumption ## Description @@ -23,8 +21,6 @@ tracking messages sent, tokens consumed, and remaining quotas. > **messagesUsed**: `number` -Defined in: [types/subscription.ts:418](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L418) - Messages sent in current period #### Description @@ -37,8 +33,6 @@ Count of messages sent since last quota reset > **messagesRemaining**: `number` -Defined in: [types/subscription.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L424) - Messages remaining in current period #### Description @@ -51,8 +45,6 @@ Calculated as maxMessagesPerPeriod - messagesUsed > **tokensUsed**: `number` -Defined in: [types/subscription.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L430) - Tokens consumed in current period #### Description @@ -65,8 +57,6 @@ Total tokens (input + output) used since last reset > **tokensRemaining**: `number` -Defined in: [types/subscription.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L436) - Tokens remaining in current period #### Description @@ -79,8 +69,6 @@ Calculated as maxTokensPerPeriod - tokensUsed > **inputTokensUsed**: `number` -Defined in: [types/subscription.ts:442](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L442) - Input tokens consumed in current period #### Description @@ -93,8 +81,6 @@ Prompt/input tokens used since last reset > **outputTokensUsed**: `number` -Defined in: [types/subscription.ts:448](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L448) - Output tokens consumed in current period #### Description @@ -107,8 +93,6 @@ Response/output tokens used since last reset > **lastRequestTimestamp**: `number` -Defined in: [types/subscription.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L454) - Timestamp of last API request (Unix epoch in milliseconds) #### Description @@ -121,8 +105,6 @@ When the last successful request was made > **isRateLimited**: `boolean` -Defined in: [types/subscription.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L460) - Current rate limit status #### Description @@ -135,8 +117,6 @@ Whether the user is currently rate limited > `optional` **rateLimitExpiresAt?**: `number` -Defined in: [types/subscription.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L466) - Timestamp when rate limit expires (Unix epoch in milliseconds) #### Description @@ -149,8 +129,6 @@ When rate limiting will be lifted, if applicable > **requestCount**: `number` -Defined in: [types/subscription.ts:472](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L472) - Total requests made in current period #### Description @@ -163,8 +141,6 @@ Count of all API requests since last reset > **messageQuotaPercent**: `number` -Defined in: [types/subscription.ts:478](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L478) - Usage percentage of message quota #### Description @@ -177,8 +153,6 @@ Percentage of message quota consumed (0-100) > **tokenQuotaPercent**: `number` -Defined in: [types/subscription.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L484) - Usage percentage of token quota #### Description diff --git a/docs/api/type-aliases/ClerkConfig.md b/docs/api/type-aliases/ClerkConfig.md index 0d8a90a46..a762631e1 100644 --- a/docs/api/type-aliases/ClerkConfig.md +++ b/docs/api/type-aliases/ClerkConfig.md @@ -8,8 +8,6 @@ > **ClerkConfig** = `object` -Defined in: [types/auth.ts:672](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L672) - Clerk provider configuration ## Properties @@ -18,8 +16,6 @@ Clerk provider configuration > `optional` **publishableKey?**: `string` -Defined in: [types/auth.ts:674](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L674) - Clerk publishable key --- @@ -28,8 +24,6 @@ Clerk publishable key > **secretKey**: `string` -Defined in: [types/auth.ts:676](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L676) - Clerk secret key --- @@ -38,8 +32,6 @@ Clerk secret key > `optional` **jwtKey?**: `string` -Defined in: [types/auth.ts:678](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L678) - Clerk JWT key (for local validation) --- @@ -48,8 +40,6 @@ Clerk JWT key (for local validation) > `optional` **apiVersion?**: `string` -Defined in: [types/auth.ts:680](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L680) - Clerk API version --- @@ -58,8 +48,6 @@ Clerk API version > `optional` **jwksUrl?**: `string` -Defined in: [types/auth.ts:682](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L682) - JWKS endpoint override --- @@ -68,6 +56,4 @@ JWKS endpoint override > `optional` **allowedOrigins?**: `string`[] -Defined in: [types/auth.ts:684](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L684) - Allowed origins diff --git a/docs/api/type-aliases/CliAccountUsageTotals.md b/docs/api/type-aliases/CliAccountUsageTotals.md index 76f3344fe..9258dab92 100644 --- a/docs/api/type-aliases/CliAccountUsageTotals.md +++ b/docs/api/type-aliases/CliAccountUsageTotals.md @@ -8,8 +8,6 @@ > **CliAccountUsageTotals** = `object` -Defined in: [types/proxyClient.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L157) - Per-account token and cost totals derived from the proxy's own request log. `costUsd` is an **API-equivalent** figure: what the recorded tokens would @@ -23,56 +21,42 @@ label it as such. > **requests**: `number` -Defined in: [types/proxyClient.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L158) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/proxyClient.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L159) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/proxyClient.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L160) - --- ### cacheReadTokens > **cacheReadTokens**: `number` -Defined in: [types/proxyClient.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L161) - --- ### cacheCreationTokens > **cacheCreationTokens**: `number` -Defined in: [types/proxyClient.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L162) - --- ### costUsd > **costUsd**: `number` -Defined in: [types/proxyClient.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L163) - --- ### unpricedRequests > **unpricedRequests**: `number` -Defined in: [types/proxyClient.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L165) - Requests whose model carried no pricing row, so contributed no cost. --- @@ -81,8 +65,6 @@ Requests whose model carried no pricing row, so contributed no cost. > **unpricedModels**: `string`[] -Defined in: [types/proxyClient.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L167) - Distinct models with no pricing row, so an operator can chase them. --- @@ -91,8 +73,6 @@ Distinct models with no pricing row, so an operator can chase them. > **byClient**: `Record`\<`string`, [`CliClientUsageTotals`](CliClientUsageTotals.md)\> -Defined in: [types/proxyClient.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L174) - Same totals split by calling CLI, keyed by the derived client name. Empty for traffic logged before attribution existed — those rows carry no diff --git a/docs/api/type-aliases/CliAccountsResponse.md b/docs/api/type-aliases/CliAccountsResponse.md index acada80ae..575d57e9b 100644 --- a/docs/api/type-aliases/CliAccountsResponse.md +++ b/docs/api/type-aliases/CliAccountsResponse.md @@ -8,8 +8,6 @@ > **CliAccountsResponse** = `object` -Defined in: [types/proxyClient.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L230) - Response body of GET /accounts. ## Properties @@ -18,16 +16,12 @@ Response body of GET /accounts. > **generatedAt**: `number` -Defined in: [types/proxyClient.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L231) - --- ### usageDate > **usageDate**: `string` -Defined in: [types/proxyClient.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L233) - UTC date whose request log the usage totals cover. --- @@ -36,8 +30,6 @@ UTC date whose request log the usage totals cover. > **quotaFromSnapshot**: `boolean` -Defined in: [types/proxyClient.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L235) - True when quota came from the stored snapshot rather than a live fetch. --- @@ -46,8 +38,6 @@ True when quota came from the stored snapshot rather than a live fetch. > **usageError**: `string` \| `null` -Defined in: [types/proxyClient.ts:237](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L237) - Set when the usage totals could not be read at all. --- @@ -56,8 +46,6 @@ Set when the usage totals could not be read at all. > **quotaError**: `string` \| `null` -Defined in: [types/proxyClient.ts:239](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L239) - Set when the quota snapshot could not be read; rows still carry status. --- @@ -66,12 +54,8 @@ Set when the quota snapshot could not be read; rows still carry status. > **costBasis**: `"api-equivalent"` -Defined in: [types/proxyClient.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L240) - --- ### accounts > **accounts**: [`CliAccountsRow`](CliAccountsRow.md)[] - -Defined in: [types/proxyClient.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L241) diff --git a/docs/api/type-aliases/CliAccountsRow.md b/docs/api/type-aliases/CliAccountsRow.md index d71dc7407..5d0ddd9ea 100644 --- a/docs/api/type-aliases/CliAccountsRow.md +++ b/docs/api/type-aliases/CliAccountsRow.md @@ -8,8 +8,6 @@ > **CliAccountsRow** = `object` -Defined in: [types/proxyClient.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L188) - One row of GET /accounts. ## Properties @@ -18,8 +16,6 @@ One row of GET /accounts. > **label**: `string` -Defined in: [types/proxyClient.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L193) - Bare label, e.g. "someone@example.com". Display only: two rows can share it when one email is logged in to both engines. `key` is the identity. @@ -29,8 +25,6 @@ it when one email is logged in to both engines. `key` is the identity. > **key**: `string` \| `null` -Defined in: [types/proxyClient.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L198) - Full pool key, e.g. "anthropic:someone@example.com" or "codex:someone@example.com". Null only for plumbing rows. @@ -40,8 +34,6 @@ Full pool key, e.g. "anthropic:someone@example.com" or > `optional` **provider?**: `"anthropic"` \| `"codex"` \| `"vertex"` -Defined in: [types/proxyClient.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L206) - Which pool engine owns this login. Absent on plumbing rows. Consumers that key a list by row must key by `key`, not `label` — see above. @@ -54,8 +46,6 @@ model, with no OAuth account behind them, so they carry no token state. > **kind**: `"account"` \| `"internal"` \| `"translation"` -Defined in: [types/proxyClient.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L212) - What this row actually is. Only "account" rows are real logins; the proxy also tracks internal and translation pseudo-accounts, which have no quota and should not be rendered as credentials. @@ -66,88 +56,66 @@ and should not be rendered as credentials. > **type**: `string` -Defined in: [types/proxyClient.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L213) - --- ### status > **status**: `string` \| `null` -Defined in: [types/proxyClient.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L214) - --- ### cooling > **cooling**: `boolean` -Defined in: [types/proxyClient.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L215) - --- ### allowed > **allowed**: `boolean` \| `null` -Defined in: [types/proxyClient.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L216) - --- ### expired > **expired**: `boolean` \| `null` -Defined in: [types/proxyClient.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L217) - --- ### isPrimary > **isPrimary**: `boolean` -Defined in: [types/proxyClient.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L218) - --- ### requests > **requests**: `number` \| `null` -Defined in: [types/proxyClient.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L219) - --- ### errors > **errors**: `number` \| `null` -Defined in: [types/proxyClient.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L220) - --- ### rateLimits > **rateLimits**: `number` \| `null` -Defined in: [types/proxyClient.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L221) - --- ### quotaRateLimits > **quotaRateLimits**: `number` \| `null` -Defined in: [types/proxyClient.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L222) - --- ### quota > **quota**: [`JsonObject`](JsonObject.md) \| `null` -Defined in: [types/proxyClient.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L224) - Quota block from the limits snapshot, timestamps normalised to ms. --- @@ -156,6 +124,4 @@ Quota block from the limits snapshot, timestamps normalised to ms. > **usage**: [`CliAccountUsageTotals`](CliAccountUsageTotals.md) \| `null` -Defined in: [types/proxyClient.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L226) - Today's usage from the request log, or null when the log is unreadable. diff --git a/docs/api/type-aliases/CliAgentCommandArgs.md b/docs/api/type-aliases/CliAgentCommandArgs.md index cebcbffde..5960d6811 100644 --- a/docs/api/type-aliases/CliAgentCommandArgs.md +++ b/docs/api/type-aliases/CliAgentCommandArgs.md @@ -8,8 +8,6 @@ > **CliAgentCommandArgs** = [`BaseCommandArgs`](BaseCommandArgs.md) & `object` -Defined in: [types/cli.ts:2111](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2111) - Agent command arguments for multi-agent orchestration ## Type Declaration diff --git a/docs/api/type-aliases/CliAnalytics.md b/docs/api/type-aliases/CliAnalytics.md index 136de1cbb..34d4afebd 100644 --- a/docs/api/type-aliases/CliAnalytics.md +++ b/docs/api/type-aliases/CliAnalytics.md @@ -8,8 +8,6 @@ > **CliAnalytics** = `object` -Defined in: [types/action.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L147) - Raw CLI analytics format (actual CLI output) ## Properties @@ -18,44 +16,32 @@ Raw CLI analytics format (actual CLI output) > **provider**: `string` -Defined in: [types/action.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L148) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/action.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L149) - --- ### tokenUsage > **tokenUsage**: [`CliTokenUsage`](CliTokenUsage.md) -Defined in: [types/action.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L150) - --- ### requestDuration > **requestDuration**: `number` -Defined in: [types/action.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L151) - --- ### timestamp > **timestamp**: `string` -Defined in: [types/action.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L152) - --- ### cost? > `optional` **cost?**: `number` - -Defined in: [types/action.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L153) diff --git a/docs/api/type-aliases/CliAnalyticsDomainAnalyticsConfig.md b/docs/api/type-aliases/CliAnalyticsDomainAnalyticsConfig.md index b967642f6..12d8d9986 100644 --- a/docs/api/type-aliases/CliAnalyticsDomainAnalyticsConfig.md +++ b/docs/api/type-aliases/CliAnalyticsDomainAnalyticsConfig.md @@ -8,8 +8,6 @@ > **CliAnalyticsDomainAnalyticsConfig** = `object` -Defined in: [types/cli.ts:1890](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1890) - Analytics config for the analytics evaluation domain. ## Properties @@ -18,20 +16,14 @@ Analytics config for the analytics evaluation domain. > **trackDataQuality**: `boolean` -Defined in: [types/cli.ts:1891](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1891) - --- ### trackModelPerformance > **trackModelPerformance**: `boolean` -Defined in: [types/cli.ts:1892](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1892) - --- ### trackBusinessImpact > **trackBusinessImpact**: `boolean` - -Defined in: [types/cli.ts:1893](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1893) diff --git a/docs/api/type-aliases/CliAudioPlayerCommand.md b/docs/api/type-aliases/CliAudioPlayerCommand.md index d52e9d8fe..8aa7ce17c 100644 --- a/docs/api/type-aliases/CliAudioPlayerCommand.md +++ b/docs/api/type-aliases/CliAudioPlayerCommand.md @@ -8,8 +8,6 @@ > **CliAudioPlayerCommand** = `object` -Defined in: [types/cli.ts:2181](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2181) - A single audio-player invocation for CLI TTS playback: a binary plus its arguments for `execFile`. The player list is tried in order until one succeeds (see `src/cli/utils/audioPlayer.ts`). @@ -20,12 +18,8 @@ succeeds (see `src/cli/utils/audioPlayer.ts`). > **command**: `string` -Defined in: [types/cli.ts:2182](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2182) - --- ### args > **args**: `string`[] - -Defined in: [types/cli.ts:2183](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2183) diff --git a/docs/api/type-aliases/CliClassifierRouterFlags.md b/docs/api/type-aliases/CliClassifierRouterFlags.md index a96616dfb..a98fac15d 100644 --- a/docs/api/type-aliases/CliClassifierRouterFlags.md +++ b/docs/api/type-aliases/CliClassifierRouterFlags.md @@ -8,8 +8,6 @@ > **CliClassifierRouterFlags** = `object` -Defined in: [types/cli.ts:2070](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2070) - CLI flags for the classifier router (`--classifier-*`). Builds a ClassifierRouterConfig that is injected at SDK construction time. @@ -19,8 +17,6 @@ ClassifierRouterConfig that is injected at SDK construction time. > `optional` **classifierRouter?**: `boolean` -Defined in: [types/cli.ts:2072](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2072) - Master enable switch (--classifier-router). --- @@ -29,8 +25,6 @@ Master enable switch (--classifier-router). > `optional` **classifierStrategy?**: `string` -Defined in: [types/cli.ts:2079](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2079) - Strategy: "auto" (default), "heuristic", "llm" or "jev" (--classifier-strategy). "auto" resolves to "jev" when a decision provider is configured (TYPESAFE_API_KEY, or LAYA_API_KEY with @@ -42,8 +36,6 @@ LAYA_BASE_URL) and "heuristic" otherwise. > `optional` **classifierMinUpgradeConfidence?**: `number` -Defined in: [types/cli.ts:2085](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2085) - Minimum confidence required to route UP to a costlier model (--classifier-min-upgrade-confidence). Only meaningful for "jev", whose confidence is calibrated. Default: 0.3. @@ -54,8 +46,6 @@ confidence is calibrated. Default: 0.3. > `optional` **classifierMinDowngradeConfidence?**: `number` -Defined in: [types/cli.ts:2091](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2091) - Minimum confidence required to route DOWN to a cheaper model (--classifier-min-downgrade-confidence). Higher than the upgrade bar because the mistakes cost differently. Default: 0.6. @@ -66,8 +56,6 @@ because the mistakes cost differently. Default: 0.6. > `optional` **classifierModelProvider?**: `string` -Defined in: [types/cli.ts:2093](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2093) - LLM-classifier provider override (--classifier-model-provider). --- @@ -76,8 +64,6 @@ LLM-classifier provider override (--classifier-model-provider). > `optional` **classifierModelName?**: `string` -Defined in: [types/cli.ts:2095](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2095) - LLM-classifier model override (--classifier-model-name). --- @@ -86,8 +72,6 @@ LLM-classifier model override (--classifier-model-name). > `optional` **classifierModelRegion?**: `string` -Defined in: [types/cli.ts:2097](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2097) - LLM-classifier region override (--classifier-model-region). --- @@ -96,8 +80,6 @@ LLM-classifier region override (--classifier-model-region). > `optional` **classifierPool?**: `string` -Defined in: [types/cli.ts:2103](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2103) - Path to a JSON file OR inline JSON array of pool members (--classifier-pool). Each entry: { provider, model?, region?, description?, tiers?, cost?, quality?, capabilities?, id? }. @@ -108,6 +90,4 @@ tiers?, cost?, quality?, capabilities?, id? }. > `optional` **classifierTimeout?**: `number` -Defined in: [types/cli.ts:2105](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2105) - LLM-classifier hard timeout in ms (--classifier-timeout). diff --git a/docs/api/type-aliases/CliClientUsageTotals.md b/docs/api/type-aliases/CliClientUsageTotals.md index c93fe7ef0..565c0f627 100644 --- a/docs/api/type-aliases/CliClientUsageTotals.md +++ b/docs/api/type-aliases/CliClientUsageTotals.md @@ -8,8 +8,6 @@ > **CliClientUsageTotals** = `object` -Defined in: [types/proxyClient.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L178) - Per-CLI slice of an account's usage. See CliAccountUsageTotals.byClient. ## Properties @@ -18,44 +16,32 @@ Per-CLI slice of an account's usage. See CliAccountUsageTotals.byClient. > **requests**: `number` -Defined in: [types/proxyClient.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L179) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/proxyClient.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L180) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/proxyClient.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L181) - --- ### cacheReadTokens > **cacheReadTokens**: `number` -Defined in: [types/proxyClient.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L182) - --- ### cacheCreationTokens > **cacheCreationTokens**: `number` -Defined in: [types/proxyClient.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L183) - --- ### costUsd > **costUsd**: `number` - -Defined in: [types/proxyClient.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L184) diff --git a/docs/api/type-aliases/CliConfigProvider.md b/docs/api/type-aliases/CliConfigProvider.md index 63276c3cb..684cd3fce 100644 --- a/docs/api/type-aliases/CliConfigProvider.md +++ b/docs/api/type-aliases/CliConfigProvider.md @@ -8,6 +8,4 @@ > **CliConfigProvider** = `"auto"` \| `"openai"` \| `"bedrock"` \| `"vertex"` \| `"anthropic"` \| `"azure"` \| `"google-ai"` \| `"huggingface"` \| `"ollama"` \| `"mistral"` -Defined in: [types/cli.ts:1870](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1870) - Provider identifier recognized by the `neurolink config` command. diff --git a/docs/api/type-aliases/CliDecideArgs.md b/docs/api/type-aliases/CliDecideArgs.md index 4a5a8281f..6ed8d9186 100644 --- a/docs/api/type-aliases/CliDecideArgs.md +++ b/docs/api/type-aliases/CliDecideArgs.md @@ -8,8 +8,6 @@ > **CliDecideArgs** = `object` -Defined in: [types/cli.ts:1562](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1562) - Arguments for `neurolink decide` — the third inference type's CLI surface. ## Properties @@ -18,68 +16,50 @@ Arguments for `neurolink decide` — the third inference type's CLI surface. > `optional` **state?**: `string` -Defined in: [types/cli.ts:1563](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1563) - --- ### stateFile? > `optional` **stateFile?**: `string` -Defined in: [types/cli.ts:1564](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1564) - --- ### questions? > `optional` **questions?**: `string` -Defined in: [types/cli.ts:1565](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1565) - --- ### questionsFile? > `optional` **questionsFile?**: `string` -Defined in: [types/cli.ts:1566](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1566) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/cli.ts:1567](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1567) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/cli.ts:1568](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1568) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/cli.ts:1569](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1569) - --- ### format? > `optional` **format?**: `"text"` \| `"json"` -Defined in: [types/cli.ts:1570](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1570) - --- ### debug? > `optional` **debug?**: `boolean` - -Defined in: [types/cli.ts:1571](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1571) diff --git a/docs/api/type-aliases/CliDomainConfig.md b/docs/api/type-aliases/CliDomainConfig.md index b5fe3fd54..ee3d006b1 100644 --- a/docs/api/type-aliases/CliDomainConfig.md +++ b/docs/api/type-aliases/CliDomainConfig.md @@ -8,8 +8,6 @@ > **CliDomainConfig**\<`TAnalytics`\> = `object` -Defined in: [types/cli.ts:1911](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1911) - Generic shape of a single domain entry in the CLI config. ## Type Parameters @@ -24,12 +22,8 @@ Generic shape of a single domain entry in the CLI config. > **evaluationCriteria**: `string`[] -Defined in: [types/cli.ts:1914](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1914) - --- ### analyticsConfig > **analyticsConfig**: `TAnalytics` - -Defined in: [types/cli.ts:1915](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1915) diff --git a/docs/api/type-aliases/CliEcommerceAnalyticsConfig.md b/docs/api/type-aliases/CliEcommerceAnalyticsConfig.md index a9016f7fa..7df469e1b 100644 --- a/docs/api/type-aliases/CliEcommerceAnalyticsConfig.md +++ b/docs/api/type-aliases/CliEcommerceAnalyticsConfig.md @@ -8,8 +8,6 @@ > **CliEcommerceAnalyticsConfig** = `object` -Defined in: [types/cli.ts:1904](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1904) - Analytics config for the ecommerce evaluation domain. ## Properties @@ -18,20 +16,14 @@ Analytics config for the ecommerce evaluation domain. > **trackConversions**: `boolean` -Defined in: [types/cli.ts:1905](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1905) - --- ### trackUserBehavior > **trackUserBehavior**: `boolean` -Defined in: [types/cli.ts:1906](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1906) - --- ### trackRevenueImpact > **trackRevenueImpact**: `boolean` - -Defined in: [types/cli.ts:1907](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1907) diff --git a/docs/api/type-aliases/CliEvaluation.md b/docs/api/type-aliases/CliEvaluation.md index 16cc9a9c0..56b5fabec 100644 --- a/docs/api/type-aliases/CliEvaluation.md +++ b/docs/api/type-aliases/CliEvaluation.md @@ -8,8 +8,6 @@ > **CliEvaluation** = `object` -Defined in: [types/action.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L159) - Raw CLI evaluation format (actual CLI output, 1-10 scale) ## Properties @@ -18,44 +16,32 @@ Raw CLI evaluation format (actual CLI output, 1-10 scale) > **relevance**: `number` -Defined in: [types/action.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L160) - --- ### accuracy > **accuracy**: `number` -Defined in: [types/action.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L161) - --- ### completeness > **completeness**: `number` -Defined in: [types/action.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L162) - --- ### overall > **overall**: `number` -Defined in: [types/action.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L163) - --- ### isOffTopic > **isOffTopic**: `boolean` -Defined in: [types/action.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L164) - --- ### reasoning > **reasoning**: `string` - -Defined in: [types/action.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L165) diff --git a/docs/api/type-aliases/CliFileProcessingOptions.md b/docs/api/type-aliases/CliFileProcessingOptions.md index a6d0842a7..e58fd935a 100644 --- a/docs/api/type-aliases/CliFileProcessingOptions.md +++ b/docs/api/type-aliases/CliFileProcessingOptions.md @@ -8,8 +8,6 @@ > **CliFileProcessingOptions** = `object` -Defined in: [types/processor.ts:974](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L974) - Options for CLI file processing ## Properties @@ -18,8 +16,6 @@ Options for CLI file processing > `optional` **verbose?**: `boolean` -Defined in: [types/processor.ts:976](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L976) - Verbose output - shows processing details --- @@ -28,8 +24,6 @@ Verbose output - shows processing details > `optional` **processor?**: `string` -Defined in: [types/processor.ts:978](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L978) - Processor to use (bypasses auto-detection) --- @@ -38,6 +32,4 @@ Processor to use (bypasses auto-detection) > `optional` **outputFormat?**: `"json"` \| `"text"` \| `"raw"` -Defined in: [types/processor.ts:980](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L980) - Output format: json, text, or raw diff --git a/docs/api/type-aliases/CliFinanceAnalyticsConfig.md b/docs/api/type-aliases/CliFinanceAnalyticsConfig.md index adc5416c5..32d9b0a18 100644 --- a/docs/api/type-aliases/CliFinanceAnalyticsConfig.md +++ b/docs/api/type-aliases/CliFinanceAnalyticsConfig.md @@ -8,8 +8,6 @@ > **CliFinanceAnalyticsConfig** = `object` -Defined in: [types/cli.ts:1897](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1897) - Analytics config for the finance evaluation domain. ## Properties @@ -18,20 +16,14 @@ Analytics config for the finance evaluation domain. > **trackRiskMetrics**: `boolean` -Defined in: [types/cli.ts:1898](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1898) - --- ### trackRegulatory > **trackRegulatory**: `boolean` -Defined in: [types/cli.ts:1899](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1899) - --- ### trackPortfolioImpact > **trackPortfolioImpact**: `boolean` - -Defined in: [types/cli.ts:1900](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1900) diff --git a/docs/api/type-aliases/CliGeminiSnapshot.md b/docs/api/type-aliases/CliGeminiSnapshot.md index bc8e45195..2ea6381c4 100644 --- a/docs/api/type-aliases/CliGeminiSnapshot.md +++ b/docs/api/type-aliases/CliGeminiSnapshot.md @@ -8,8 +8,6 @@ > **CliGeminiSnapshot** = `object` -Defined in: [types/proxyClient.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L130) - Snapshot of the user's pre-existing Gemini CLI `~/.gemini/.env`. The whole file is kept rather than the managed keys alone: restoring must @@ -21,8 +19,6 @@ reproduce the user's comments, ordering and unrelated variables exactly. > **originalEnv**: `string` \| `null` -Defined in: [types/proxyClient.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L132) - The whole prior `.env`, or null when the user had no such file. --- @@ -31,8 +27,6 @@ The whole prior `.env`, or null when the user had no such file. > `optional` **written?**: `object` -Defined in: [types/proxyClient.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L139) - What the writer last wrote for each managed variable. Compared against the file on disk to detect a snapshot that has gone stale — one left behind by a restore whose cleanup failed, or overtaken by a user edit. Reusing such a diff --git a/docs/api/type-aliases/CliGenerateResult.md b/docs/api/type-aliases/CliGenerateResult.md index b8fb0361b..70580c036 100644 --- a/docs/api/type-aliases/CliGenerateResult.md +++ b/docs/api/type-aliases/CliGenerateResult.md @@ -8,8 +8,6 @@ > **CliGenerateResult** = [`CommandResult`](CommandResult.md) & `object` -Defined in: [types/cli.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L430) - Generate command result ## Type Declaration diff --git a/docs/api/type-aliases/CliGrokProxyModelSpec.md b/docs/api/type-aliases/CliGrokProxyModelSpec.md index fddb12495..68d24cc24 100644 --- a/docs/api/type-aliases/CliGrokProxyModelSpec.md +++ b/docs/api/type-aliases/CliGrokProxyModelSpec.md @@ -8,8 +8,6 @@ > **CliGrokProxyModelSpec** = `object` -Defined in: [types/proxyClient.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L106) - One Grok Build picker entry the proxy writer emits under `[model.]`. `contextWindow` is Grok's compaction limit and must be <= the upstream @@ -22,44 +20,32 @@ would become Anthropic adaptive thinking that the model rejects. > **id**: `string` -Defined in: [types/proxyClient.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L107) - --- ### name > **name**: `string` -Defined in: [types/proxyClient.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L108) - --- ### apiBackend > **apiBackend**: `"messages"` \| `"chat_completions"` -Defined in: [types/proxyClient.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L109) - --- ### contextWindow > **contextWindow**: `number` -Defined in: [types/proxyClient.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L110) - --- ### maxCompletionTokens > **maxCompletionTokens**: `number` -Defined in: [types/proxyClient.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L111) - --- ### supportsReasoningEffort > **supportsReasoningEffort**: `boolean` - -Defined in: [types/proxyClient.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L112) diff --git a/docs/api/type-aliases/CliGrokSnapshot.md b/docs/api/type-aliases/CliGrokSnapshot.md index 05f1b4f00..95b486ce6 100644 --- a/docs/api/type-aliases/CliGrokSnapshot.md +++ b/docs/api/type-aliases/CliGrokSnapshot.md @@ -8,8 +8,6 @@ > **CliGrokSnapshot** = `object` -Defined in: [types/proxyClient.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L119) - Snapshot of whether `~/.grok/config.toml` existed before the proxy wrote its managed block. Persisted to `~/.neurolink/grok-proxy-snapshot.json`. @@ -19,12 +17,8 @@ its managed block. Persisted to `~/.neurolink/grok-proxy-snapshot.json`. > **originalExisted**: `boolean` -Defined in: [types/proxyClient.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L120) - --- ### writtenBaseUrl > **writtenBaseUrl**: `string` - -Defined in: [types/proxyClient.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L121) diff --git a/docs/api/type-aliases/CliHealthcareAnalyticsConfig.md b/docs/api/type-aliases/CliHealthcareAnalyticsConfig.md index a21abfc50..2b942d31b 100644 --- a/docs/api/type-aliases/CliHealthcareAnalyticsConfig.md +++ b/docs/api/type-aliases/CliHealthcareAnalyticsConfig.md @@ -8,8 +8,6 @@ > **CliHealthcareAnalyticsConfig** = `object` -Defined in: [types/cli.ts:1883](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1883) - Analytics config for the healthcare evaluation domain. ## Properties @@ -18,20 +16,14 @@ Analytics config for the healthcare evaluation domain. > **trackPatientData**: `boolean` -Defined in: [types/cli.ts:1884](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1884) - --- ### trackDiagnosticAccuracy > **trackDiagnosticAccuracy**: `boolean` -Defined in: [types/cli.ts:1885](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1885) - --- ### trackTreatmentOutcomes > **trackTreatmentOutcomes**: `boolean` - -Defined in: [types/cli.ts:1886](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1886) diff --git a/docs/api/type-aliases/CliNetworkCommandArgs.md b/docs/api/type-aliases/CliNetworkCommandArgs.md index 8020818d0..9f530ef47 100644 --- a/docs/api/type-aliases/CliNetworkCommandArgs.md +++ b/docs/api/type-aliases/CliNetworkCommandArgs.md @@ -8,8 +8,6 @@ > **CliNetworkCommandArgs** = [`BaseCommandArgs`](BaseCommandArgs.md) & `object` -Defined in: [types/cli.ts:2147](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2147) - Network command arguments for agent network orchestration ## Type Declaration diff --git a/docs/api/type-aliases/CliNeuroLinkConfig.md b/docs/api/type-aliases/CliNeuroLinkConfig.md index 86a37f05d..6ac28421a 100644 --- a/docs/api/type-aliases/CliNeuroLinkConfig.md +++ b/docs/api/type-aliases/CliNeuroLinkConfig.md @@ -8,8 +8,6 @@ > **CliNeuroLinkConfig** = `object` -Defined in: [types/cli.ts:1924](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1924) - Materialized shape of the CLI config parsed from `~/.neurolink/config.json`. Matches the output of `ConfigSchema.parse()` defined in `src/cli/commands/config.ts`. The schema is annotated with @@ -21,16 +19,12 @@ Matches the output of `ConfigSchema.parse()` defined in > **defaultProvider**: [`CliConfigProvider`](CliConfigProvider.md) -Defined in: [types/cli.ts:1925](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1925) - --- ### providers > **providers**: `object` -Defined in: [types/cli.ts:1926](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1926) - #### openai? > `optional` **openai?**: `object` @@ -193,16 +187,12 @@ Defined in: [types/cli.ts:1926](https://github.com/juspay/neurolink/blob/release > **profiles**: `Record`\<`string`, `unknown`\> -Defined in: [types/cli.ts:1956](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1956) - --- ### preferences > **preferences**: `object` -Defined in: [types/cli.ts:1957](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1957) - #### outputFormat > **outputFormat**: `"text"` \| `"json"` \| `"yaml"` @@ -245,8 +235,6 @@ Defined in: [types/cli.ts:1957](https://github.com/juspay/neurolink/blob/release > **domains**: `object` -Defined in: [types/cli.ts:1968](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1968) - #### healthcare > **healthcare**: [`CliDomainConfig`](CliDomainConfig.md)\<[`CliHealthcareAnalyticsConfig`](CliHealthcareAnalyticsConfig.md)\> diff --git a/docs/api/type-aliases/CliOpenCodeSnapshot.md b/docs/api/type-aliases/CliOpenCodeSnapshot.md index 79f4cd1a7..ca52be279 100644 --- a/docs/api/type-aliases/CliOpenCodeSnapshot.md +++ b/docs/api/type-aliases/CliOpenCodeSnapshot.md @@ -8,8 +8,6 @@ > **CliOpenCodeSnapshot** = `object` -Defined in: [types/proxyClient.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L92) - Snapshot of the user's pre-existing OpenCode `provider.neurolink`. Persisted to `~/.neurolink/opencode-proxy-snapshot.json`, never inside @@ -22,8 +20,6 @@ unknown top-level keys, so an in-file snapshot made the CLI unstartable. > **original**: `unknown` -Defined in: [types/proxyClient.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L94) - The user's provider.neurolink before the proxy first touched it. --- @@ -32,6 +28,4 @@ The user's provider.neurolink before the proxy first touched it. > `optional` **written?**: `unknown` -Defined in: [types/proxyClient.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L96) - What the writer last wrote, so apply() can recognise its own block. diff --git a/docs/api/type-aliases/CliProcessingResult.md b/docs/api/type-aliases/CliProcessingResult.md index 6588a2f40..ba37f76ac 100644 --- a/docs/api/type-aliases/CliProcessingResult.md +++ b/docs/api/type-aliases/CliProcessingResult.md @@ -8,8 +8,6 @@ > **CliProcessingResult** = `object` -Defined in: [types/processor.ts:990](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L990) - Result of CLI file processing ## Properties @@ -18,8 +16,6 @@ Result of CLI file processing > **success**: `boolean` -Defined in: [types/processor.ts:992](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L992) - Whether processing succeeded --- @@ -28,8 +24,6 @@ Whether processing succeeded > **processorUsed**: `string` \| `null` -Defined in: [types/processor.ts:994](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L994) - Name of the processor that was used --- @@ -38,8 +32,6 @@ Name of the processor that was used > **output**: `string` -Defined in: [types/processor.ts:996](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L996) - Formatted output string --- @@ -48,6 +40,4 @@ Formatted output string > `optional` **error?**: `string` -Defined in: [types/processor.ts:998](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L998) - Error message if processing failed diff --git a/docs/api/type-aliases/CliProxyClientApplyOptions.md b/docs/api/type-aliases/CliProxyClientApplyOptions.md index b71a460d6..42eb842b5 100644 --- a/docs/api/type-aliases/CliProxyClientApplyOptions.md +++ b/docs/api/type-aliases/CliProxyClientApplyOptions.md @@ -8,8 +8,6 @@ > **CliProxyClientApplyOptions** = `object` -Defined in: [types/proxyClient.ts:4](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L4) - Options forwarded through `applyAllClients` into a configurator's `apply`. ## Properties @@ -18,8 +16,6 @@ Options forwarded through `applyAllClients` into a configurator's `apply`. > `optional` **configPath?**: `string` -Defined in: [types/proxyClient.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L11) - Absolute path of the proxy routing config this process loaded. The Grok writer reads `routing.model-mappings` from this file so a `proxy start --config` catalog matches `/v1/models`. Omit to use diff --git a/docs/api/type-aliases/CliProxyClientApplyResult.md b/docs/api/type-aliases/CliProxyClientApplyResult.md index e029db003..f8737f937 100644 --- a/docs/api/type-aliases/CliProxyClientApplyResult.md +++ b/docs/api/type-aliases/CliProxyClientApplyResult.md @@ -8,8 +8,6 @@ > **CliProxyClientApplyResult** = `object` -Defined in: [types/proxyClient.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L61) - Outcome of applying one configurator, for per-client CLI reporting. ## Properties @@ -18,24 +16,18 @@ Outcome of applying one configurator, for per-client CLI reporting. > **id**: `string` -Defined in: [types/proxyClient.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L62) - --- ### displayName > **displayName**: `string` -Defined in: [types/proxyClient.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L63) - --- ### applied > **applied**: `boolean` -Defined in: [types/proxyClient.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L65) - True only when the configurator actually wrote configuration. --- @@ -44,8 +36,6 @@ True only when the configurator actually wrote configuration. > `optional` **note?**: `string` -Defined in: [types/proxyClient.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L71) - Set when the write landed but is not yet in effect — see CliProxyClientConfigurator.postApplyNote. Callers must render this; a silent note is the failure it exists to prevent. @@ -56,6 +46,4 @@ silent note is the failure it exists to prevent. > `optional` **error?**: `Error` -Defined in: [types/proxyClient.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L73) - Present when the configurator threw; the caller decides how loud to be. diff --git a/docs/api/type-aliases/CliProxyClientConfigurator.md b/docs/api/type-aliases/CliProxyClientConfigurator.md index c05dee452..604dca3b8 100644 --- a/docs/api/type-aliases/CliProxyClientConfigurator.md +++ b/docs/api/type-aliases/CliProxyClientConfigurator.md @@ -8,8 +8,6 @@ > **CliProxyClientConfigurator** = `object` -Defined in: [types/proxyClient.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L21) - One AI coding CLI the proxy can point at itself. Adding a CLI means adding one implementation of this type and one line in @@ -22,8 +20,6 @@ to know the client exists. > **id**: `string` -Defined in: [types/proxyClient.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L23) - Stable kebab-case identifier, e.g. "claude-code". --- @@ -32,8 +28,6 @@ Stable kebab-case identifier, e.g. "claude-code". > **displayName**: `string` -Defined in: [types/proxyClient.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L25) - Human-readable name used in CLI output, e.g. "Claude Code". --- @@ -42,8 +36,6 @@ Human-readable name used in CLI output, e.g. "Claude Code". > **detect**: () => `Promise`\<`boolean`\> -Defined in: [types/proxyClient.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L30) - Whether this CLI appears to be installed. Configurators must not create config files for a CLI the user never installed. @@ -57,8 +49,6 @@ config files for a CLI the user never installed. > **apply**: (`proxyBaseUrl`, `options?`) => `Promise`\<`boolean`\> -Defined in: [types/proxyClient.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L37) - Point the CLI at the proxy. `proxyBaseUrl` is the bare proxy origin (e.g. "http://127.0.0.1:55669"); the configurator appends whatever path suffix its CLI needs. Returns false when nothing was written, so callers @@ -84,8 +74,6 @@ never print a success message for work that did not happen. > **restore**: (`proxyBaseUrl`) => `Promise`\<`boolean`\> -Defined in: [types/proxyClient.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L46) - Restore the user's previous configuration. `proxyBaseUrl` is the same bare origin; a configurator that finds a different URL configured must leave it alone and return false. @@ -106,8 +94,6 @@ alone and return false. > `optional` **postApplyNote?**: (`proxyBaseUrl`) => `Promise`\<`string` \| `null`\> -Defined in: [types/proxyClient.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L57) - Something the user must still do for apply() to take effect. Writing a file is not the same as being in effect. Copilot reads its diff --git a/docs/api/type-aliases/CliProxyClientRestoreResult.md b/docs/api/type-aliases/CliProxyClientRestoreResult.md index cd9ab0329..03871a903 100644 --- a/docs/api/type-aliases/CliProxyClientRestoreResult.md +++ b/docs/api/type-aliases/CliProxyClientRestoreResult.md @@ -8,8 +8,6 @@ > **CliProxyClientRestoreResult** = `object` -Defined in: [types/proxyClient.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L77) - Outcome of restoring one configurator. ## Properties @@ -18,24 +16,18 @@ Outcome of restoring one configurator. > **id**: `string` -Defined in: [types/proxyClient.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L78) - --- ### displayName > **displayName**: `string` -Defined in: [types/proxyClient.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L79) - --- ### restored > **restored**: `boolean` -Defined in: [types/proxyClient.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L81) - True only when a previous configuration was actually restored. --- @@ -43,5 +35,3 @@ True only when a previous configuration was actually restored. ### error? > `optional` **error?**: `Error` - -Defined in: [types/proxyClient.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L82) diff --git a/docs/api/type-aliases/CliProxyConfigDoc.md b/docs/api/type-aliases/CliProxyConfigDoc.md index 484a7f968..1c2bdcf1f 100644 --- a/docs/api/type-aliases/CliProxyConfigDoc.md +++ b/docs/api/type-aliases/CliProxyConfigDoc.md @@ -8,8 +8,6 @@ > **CliProxyConfigDoc** = `object` -Defined in: [types/proxy.ts:3643](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3643) - Snapshot of a parsed proxy config file used by CLI primary-account read/edit/write helpers. Tracks the original format and whether comments were present (so the CLI can warn that comments will not round-trip). @@ -20,20 +18,14 @@ were present (so the CLI can warn that comments will not round-trip). > **data**: `Record`\<`string`, `unknown`\> -Defined in: [types/proxy.ts:3644](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3644) - --- ### format > **format**: `"yaml"` \| `"json"` -Defined in: [types/proxy.ts:3645](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3645) - --- ### hadComments > **hadComments**: `boolean` - -Defined in: [types/proxy.ts:3646](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3646) diff --git a/docs/api/type-aliases/CliProxyRestartError.md b/docs/api/type-aliases/CliProxyRestartError.md index 599d86bd4..0a955e3b4 100644 --- a/docs/api/type-aliases/CliProxyRestartError.md +++ b/docs/api/type-aliases/CliProxyRestartError.md @@ -8,8 +8,6 @@ > **CliProxyRestartError** = `object` -Defined in: [types/proxyRestart.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyRestart.ts#L43) - CLI failure before a supervisor result can be authenticated or received. ## Properties @@ -18,20 +16,14 @@ CLI failure before a supervisor result can be authenticated or received. > **ok**: `false` -Defined in: [types/proxyRestart.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyRestart.ts#L44) - --- ### phase > **phase**: `"unverified"` -Defined in: [types/proxyRestart.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyRestart.ts#L45) - --- ### message > **message**: `string` - -Defined in: [types/proxyRestart.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyRestart.ts#L46) diff --git a/docs/api/type-aliases/CliProxyRestartOutput.md b/docs/api/type-aliases/CliProxyRestartOutput.md index fd9a2e8fb..39146da1a 100644 --- a/docs/api/type-aliases/CliProxyRestartOutput.md +++ b/docs/api/type-aliases/CliProxyRestartOutput.md @@ -8,6 +8,4 @@ > **CliProxyRestartOutput** = [`ProxyRestartResult`](ProxyRestartResult.md) \| [`CliProxyRestartError`](CliProxyRestartError.md) -Defined in: [types/proxyRestart.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyRestart.ts#L50) - JSON emitted by the restart CLI, including an unknown control outcome. diff --git a/docs/api/type-aliases/CliQwenSettings.md b/docs/api/type-aliases/CliQwenSettings.md index 81774d9b6..8330d407d 100644 --- a/docs/api/type-aliases/CliQwenSettings.md +++ b/docs/api/type-aliases/CliQwenSettings.md @@ -8,8 +8,6 @@ > **CliQwenSettings** = `Record`\<`string`, `unknown`\> -Defined in: [types/proxyClient.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L147) - Raw contents of a Qwen Code `settings.json`. Deliberately open-ended: the configurator rewrites only `security.auth` and must round-trip every other key the user has set, including ones this repo does not know about. diff --git a/docs/api/type-aliases/CliRedisClient.md b/docs/api/type-aliases/CliRedisClient.md index 5e4f2fede..6b51a0677 100644 --- a/docs/api/type-aliases/CliRedisClient.md +++ b/docs/api/type-aliases/CliRedisClient.md @@ -8,8 +8,6 @@ > **CliRedisClient** = `object` -Defined in: [types/cli.ts:1450](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1450) - Redis client type (awaited return of createRedisClient). ## Indexable @@ -22,8 +20,6 @@ Redis client type (awaited return of createRedisClient). > **get**: (`key`) => `Promise`\<`string` \| `null`\> -Defined in: [types/cli.ts:1451](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1451) - #### Parameters ##### key @@ -40,8 +36,6 @@ Defined in: [types/cli.ts:1451](https://github.com/juspay/neurolink/blob/release > **set**: (`key`, `value`, `options?`) => `Promise`\<`unknown`\> -Defined in: [types/cli.ts:1452](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1452) - #### Parameters ##### key @@ -66,8 +60,6 @@ Defined in: [types/cli.ts:1452](https://github.com/juspay/neurolink/blob/release > **del**: (`key`) => `Promise`\<`number`\> -Defined in: [types/cli.ts:1453](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1453) - #### Parameters ##### key @@ -84,8 +76,6 @@ Defined in: [types/cli.ts:1453](https://github.com/juspay/neurolink/blob/release > **keys**: (`pattern`) => `Promise`\<`string`[]\> -Defined in: [types/cli.ts:1454](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1454) - #### Parameters ##### pattern @@ -102,8 +92,6 @@ Defined in: [types/cli.ts:1454](https://github.com/juspay/neurolink/blob/release > **quit**: () => `Promise`\<`void`\> -Defined in: [types/cli.ts:1455](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1455) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/type-aliases/CliResponse.md b/docs/api/type-aliases/CliResponse.md index bcfb565ac..55c5f14da 100644 --- a/docs/api/type-aliases/CliResponse.md +++ b/docs/api/type-aliases/CliResponse.md @@ -8,8 +8,6 @@ > **CliResponse** = `object` -Defined in: [types/action.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L171) - Raw CLI response format (actual output structure) ## Properties @@ -18,52 +16,38 @@ Raw CLI response format (actual output structure) > **content**: `string` -Defined in: [types/action.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L172) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/action.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L173) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/action.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L174) - --- ### usage? > `optional` **usage?**: [`CliTokenUsage`](CliTokenUsage.md) -Defined in: [types/action.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L175) - --- ### responseTime? > `optional` **responseTime?**: `number` -Defined in: [types/action.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L176) - --- ### analytics? > `optional` **analytics?**: [`CliAnalytics`](CliAnalytics.md) -Defined in: [types/action.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L177) - --- ### evaluation? > `optional` **evaluation?**: [`CliEvaluation`](CliEvaluation.md) - -Defined in: [types/action.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L178) diff --git a/docs/api/type-aliases/CliServeFlatRoute.md b/docs/api/type-aliases/CliServeFlatRoute.md index f67770e73..f6b1a7b78 100644 --- a/docs/api/type-aliases/CliServeFlatRoute.md +++ b/docs/api/type-aliases/CliServeFlatRoute.md @@ -8,8 +8,6 @@ > **CliServeFlatRoute** = `object` -Defined in: [types/cli.ts:2028](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2028) - Flat per-route row used by the `neurolink serve routes` listing. ## Properties @@ -18,28 +16,20 @@ Flat per-route row used by the `neurolink serve routes` listing. > **method**: `string` -Defined in: [types/cli.ts:2029](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2029) - --- ### path > **path**: `string` -Defined in: [types/cli.ts:2030](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2030) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/cli.ts:2031](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2031) - --- ### group > **group**: `string` - -Defined in: [types/cli.ts:2032](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2032) diff --git a/docs/api/type-aliases/CliServeRouteGroup.md b/docs/api/type-aliases/CliServeRouteGroup.md index 8cd19c063..a06ba3b9d 100644 --- a/docs/api/type-aliases/CliServeRouteGroup.md +++ b/docs/api/type-aliases/CliServeRouteGroup.md @@ -8,8 +8,6 @@ > **CliServeRouteGroup** = `object` -Defined in: [types/cli.ts:2018](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2018) - Minimal route-group shape reflected at runtime by `neurolink serve routes`. Named with a `CliServe` prefix to disambiguate from the richer RouteGroup in server.ts (§Rule 9). @@ -20,16 +18,12 @@ in server.ts (§Rule 9). > **prefix**: `string` -Defined in: [types/cli.ts:2019](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2019) - --- ### routes > **routes**: `object`[] -Defined in: [types/cli.ts:2020](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2020) - #### method > **method**: `string` diff --git a/docs/api/type-aliases/CliStreamChunk.md b/docs/api/type-aliases/CliStreamChunk.md index 6c2ecd1cd..261cc301f 100644 --- a/docs/api/type-aliases/CliStreamChunk.md +++ b/docs/api/type-aliases/CliStreamChunk.md @@ -8,8 +8,6 @@ > **CliStreamChunk** = `object` -Defined in: [types/cli.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L473) - Stream result chunk ## Properties @@ -18,28 +16,20 @@ Stream result chunk > `optional` **content?**: `string` -Defined in: [types/cli.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L474) - --- ### delta? > `optional` **delta?**: `string` -Defined in: [types/cli.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L475) - --- ### done? > `optional` **done?**: `boolean` -Defined in: [types/cli.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L476) - --- ### metadata? > `optional` **metadata?**: [`UnknownRecord`](UnknownRecord.md) - -Defined in: [types/cli.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L477) diff --git a/docs/api/type-aliases/CliTokenUsage.md b/docs/api/type-aliases/CliTokenUsage.md index ceefe691f..c9041eea5 100644 --- a/docs/api/type-aliases/CliTokenUsage.md +++ b/docs/api/type-aliases/CliTokenUsage.md @@ -8,8 +8,6 @@ > **CliTokenUsage** = `object` -Defined in: [types/action.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L136) - Raw CLI token usage format (actual CLI output) ## Properties @@ -18,36 +16,26 @@ Raw CLI token usage format (actual CLI output) > **input**: `number` -Defined in: [types/action.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L137) - --- ### output > **output**: `number` -Defined in: [types/action.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L138) - --- ### total > **total**: `number` -Defined in: [types/action.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L139) - --- ### cacheCreationTokens? > `optional` **cacheCreationTokens?**: `number` -Defined in: [types/action.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L140) - --- ### cacheReadTokens? > `optional` **cacheReadTokens?**: `number` - -Defined in: [types/action.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L141) diff --git a/docs/api/type-aliases/CliToolRoutingFlags.md b/docs/api/type-aliases/CliToolRoutingFlags.md index 2be92a910..c29b281f4 100644 --- a/docs/api/type-aliases/CliToolRoutingFlags.md +++ b/docs/api/type-aliases/CliToolRoutingFlags.md @@ -8,8 +8,6 @@ > **CliToolRoutingFlags** = `object` -Defined in: [types/cli.ts:2043](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2043) - Raw CLI flag shape for the tool-routing family of options. Keys are camelCase as yargs delivers them after parsing kebab-case aliases. @@ -19,8 +17,6 @@ Keys are camelCase as yargs delivers them after parsing kebab-case aliases. > `optional` **toolRouting?**: `boolean` -Defined in: [types/cli.ts:2045](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2045) - Master enable switch (--tool-routing). --- @@ -29,8 +25,6 @@ Master enable switch (--tool-routing). > `optional` **toolRoutingTimeout?**: `number` -Defined in: [types/cli.ts:2047](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2047) - Router LLM hard timeout in ms (--tool-routing-timeout). --- @@ -39,8 +33,6 @@ Router LLM hard timeout in ms (--tool-routing-timeout). > `optional` **toolRoutingRouterProvider?**: `string` -Defined in: [types/cli.ts:2049](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2049) - Router LLM provider override (--tool-routing-router-provider). --- @@ -49,8 +41,6 @@ Router LLM provider override (--tool-routing-router-provider). > `optional` **toolRoutingRouterModel?**: `string` -Defined in: [types/cli.ts:2051](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2051) - Router LLM model override (--tool-routing-router-model). --- @@ -59,8 +49,6 @@ Router LLM model override (--tool-routing-router-model). > `optional` **toolRoutingRouterRegion?**: `string` -Defined in: [types/cli.ts:2053](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2053) - Router LLM region override (--tool-routing-router-region). --- @@ -69,8 +57,6 @@ Router LLM region override (--tool-routing-router-region). > `optional` **toolRoutingAlwaysInclude?**: `string`[] -Defined in: [types/cli.ts:2058](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2058) - Server ids that are always kept and never offered to the router (--tool-routing-always-include, repeatable). @@ -80,7 +66,5 @@ Server ids that are always kept and never offered to the router > `optional` **toolRoutingServers?**: `string` -Defined in: [types/cli.ts:2063](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2063) - Path to a JSON file OR inline JSON array of server descriptors (--tool-routing-servers). diff --git a/docs/api/type-aliases/CliValidatedFileOption.md b/docs/api/type-aliases/CliValidatedFileOption.md index a36b807fb..e7fc24baf 100644 --- a/docs/api/type-aliases/CliValidatedFileOption.md +++ b/docs/api/type-aliases/CliValidatedFileOption.md @@ -8,7 +8,5 @@ > **CliValidatedFileOption** = `"--image"` \| `"--csv"` \| `"--pdf"` \| `"--video"` \| `"--file"` -Defined in: [types/cli.ts:2194](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2194) - The CLI flags validated by `validateCliInputFiles` before a generate/stream/batch run starts (--image/--csv/--pdf/--video/--file). diff --git a/docs/api/type-aliases/ClientAgentExecuteOptions.md b/docs/api/type-aliases/ClientAgentExecuteOptions.md index ad864fe67..5cf3f68f9 100644 --- a/docs/api/type-aliases/ClientAgentExecuteOptions.md +++ b/docs/api/type-aliases/ClientAgentExecuteOptions.md @@ -8,8 +8,6 @@ > **ClientAgentExecuteOptions** = `object` -Defined in: [types/client.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L296) - Agent execution options ## Properties @@ -18,8 +16,6 @@ Agent execution options > **agentId**: `string` -Defined in: [types/client.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L298) - Agent ID --- @@ -28,8 +24,6 @@ Agent ID > **input**: `string` -Defined in: [types/client.ts:300](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L300) - Input message --- @@ -38,8 +32,6 @@ Input message > `optional` **sessionId?**: `string` -Defined in: [types/client.ts:302](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L302) - Session ID for conversation continuity --- @@ -48,8 +40,6 @@ Session ID for conversation continuity > `optional` **context?**: [`UnknownRecord`](UnknownRecord.md) -Defined in: [types/client.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L304) - User context --- @@ -58,8 +48,6 @@ User context > `optional` **stream?**: `boolean` -Defined in: [types/client.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L306) - Stream the response --- @@ -68,8 +56,6 @@ Stream the response > `optional` **tools?**: `object` -Defined in: [types/client.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L308) - Tool execution options #### enabled? diff --git a/docs/api/type-aliases/ClientAgentExecuteResult.md b/docs/api/type-aliases/ClientAgentExecuteResult.md index 0820e6732..363ed96e9 100644 --- a/docs/api/type-aliases/ClientAgentExecuteResult.md +++ b/docs/api/type-aliases/ClientAgentExecuteResult.md @@ -8,8 +8,6 @@ > **ClientAgentExecuteResult** = `object` -Defined in: [types/client.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L321) - Agent execution result ## Properties @@ -18,8 +16,6 @@ Agent execution result > **content**: `string` -Defined in: [types/client.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L323) - Response content --- @@ -28,8 +24,6 @@ Response content > **agentId**: `string` -Defined in: [types/client.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L325) - Agent ID --- @@ -38,8 +32,6 @@ Agent ID > **sessionId**: `string` -Defined in: [types/client.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L327) - Session ID --- @@ -48,8 +40,6 @@ Session ID > `optional` **toolsUsed?**: `string`[] -Defined in: [types/client.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L329) - Tools used --- @@ -58,8 +48,6 @@ Tools used > `optional` **toolExecutions?**: `object`[] -Defined in: [types/client.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L331) - Tool executions #### name @@ -84,8 +72,6 @@ Tool executions > `optional` **usage?**: `object` -Defined in: [types/client.ts:338](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L338) - Token usage #### promptTokens @@ -106,6 +92,4 @@ Token usage > `optional` **metadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/client.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L344) - Response metadata diff --git a/docs/api/type-aliases/ClientAgentInfo.md b/docs/api/type-aliases/ClientAgentInfo.md index 52e12d9fc..63ef20485 100644 --- a/docs/api/type-aliases/ClientAgentInfo.md +++ b/docs/api/type-aliases/ClientAgentInfo.md @@ -8,8 +8,6 @@ > **ClientAgentInfo** = `object` -Defined in: [types/client.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L350) - Agent information ## Properties @@ -18,8 +16,6 @@ Agent information > **id**: `string` -Defined in: [types/client.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L352) - Agent ID --- @@ -28,8 +24,6 @@ Agent ID > **name**: `string` -Defined in: [types/client.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L354) - Agent name --- @@ -38,8 +32,6 @@ Agent name > **description**: `string` -Defined in: [types/client.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L356) - Agent description --- @@ -48,8 +40,6 @@ Agent description > `optional` **tools?**: `string`[] -Defined in: [types/client.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L358) - Available tools for this agent --- @@ -58,8 +48,6 @@ Available tools for this agent > `optional` **capabilities?**: `object` -Defined in: [types/client.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L360) - Agent capabilities #### streaming diff --git a/docs/api/type-aliases/ClientApiError.md b/docs/api/type-aliases/ClientApiError.md index 198cdad58..eb1c272a2 100644 --- a/docs/api/type-aliases/ClientApiError.md +++ b/docs/api/type-aliases/ClientApiError.md @@ -8,8 +8,6 @@ > **ClientApiError** = `object` -Defined in: [types/client.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L98) - Error response from API ## Properties @@ -18,8 +16,6 @@ Error response from API > **code**: `string` -Defined in: [types/client.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L100) - Error code (e.g., "RATE_LIMIT_EXCEEDED", "INVALID_REQUEST") --- @@ -28,8 +24,6 @@ Error code (e.g., "RATE_LIMIT_EXCEEDED", "INVALID_REQUEST") > **message**: `string` -Defined in: [types/client.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L102) - Human-readable error message --- @@ -38,8 +32,6 @@ Human-readable error message > **status**: `number` -Defined in: [types/client.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L104) - HTTP status code --- @@ -48,8 +40,6 @@ HTTP status code > `optional` **details?**: [`JsonObject`](JsonObject.md) -Defined in: [types/client.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L106) - Additional error details --- @@ -58,8 +48,6 @@ Additional error details > `optional` **retryable?**: `boolean` -Defined in: [types/client.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L108) - Whether the error is retryable --- @@ -68,6 +56,4 @@ Whether the error is retryable > `optional` **requestId?**: `string` -Defined in: [types/client.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L110) - Request ID for tracing diff --git a/docs/api/type-aliases/ClientApiResponse.md b/docs/api/type-aliases/ClientApiResponse.md index 14377ee65..94470104e 100644 --- a/docs/api/type-aliases/ClientApiResponse.md +++ b/docs/api/type-aliases/ClientApiResponse.md @@ -8,8 +8,6 @@ > **ClientApiResponse**\<`T`\> = `object` -Defined in: [types/client.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L82) - Response wrapper with metadata for all API responses ## Type Parameters @@ -24,8 +22,6 @@ Response wrapper with metadata for all API responses > **data**: `T` -Defined in: [types/client.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L84) - Response data --- @@ -34,8 +30,6 @@ Response data > **status**: `number` -Defined in: [types/client.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L86) - HTTP status code --- @@ -44,8 +38,6 @@ HTTP status code > **headers**: `Record`\<`string`, `string`\> -Defined in: [types/client.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L88) - Response headers --- @@ -54,8 +46,6 @@ Response headers > **duration**: `number` -Defined in: [types/client.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L90) - Request duration in milliseconds --- @@ -64,6 +54,4 @@ Request duration in milliseconds > `optional` **requestId?**: `string` -Defined in: [types/client.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L92) - Request ID for tracing diff --git a/docs/api/type-aliases/ClientAuthConfig.md b/docs/api/type-aliases/ClientAuthConfig.md index a3af10bdd..f813e5ed7 100644 --- a/docs/api/type-aliases/ClientAuthConfig.md +++ b/docs/api/type-aliases/ClientAuthConfig.md @@ -8,8 +8,6 @@ > **ClientAuthConfig** = `object` -Defined in: [types/client.ts:1076](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1076) - Authentication configuration options ## Properties @@ -18,8 +16,6 @@ Authentication configuration options > `optional` **apiKey?**: `string` -Defined in: [types/client.ts:1078](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1078) - API key for header-based authentication --- @@ -28,8 +24,6 @@ API key for header-based authentication > `optional` **token?**: `string` -Defined in: [types/client.ts:1080](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1080) - Bearer token for JWT/OAuth authentication --- @@ -38,8 +32,6 @@ Bearer token for JWT/OAuth authentication > `optional` **refreshToken?**: () => `Promise`\<`string`\> -Defined in: [types/client.ts:1082](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1082) - Token refresh function for automatic token renewal #### Returns @@ -52,8 +44,6 @@ Token refresh function for automatic token renewal > `optional` **tokenExpiresAt?**: `number` -Defined in: [types/client.ts:1084](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1084) - Token expiry time in milliseconds --- @@ -62,8 +52,6 @@ Token expiry time in milliseconds > `optional` **refreshBufferMs?**: `number` -Defined in: [types/client.ts:1086](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1086) - Buffer time before expiry to refresh token (default: 60000ms) --- @@ -72,8 +60,6 @@ Buffer time before expiry to refresh token (default: 60000ms) > `optional` **headerName?**: `string` -Defined in: [types/client.ts:1088](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1088) - Custom authorization header name (default: "Authorization") --- @@ -82,6 +68,4 @@ Custom authorization header name (default: "Authorization") > `optional` **apiKeyHeaderName?**: `string` -Defined in: [types/client.ts:1090](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1090) - Custom API key header name (default: "X-API-Key") diff --git a/docs/api/type-aliases/ClientChatMessage.md b/docs/api/type-aliases/ClientChatMessage.md index 4478fa707..9a6c3b074 100644 --- a/docs/api/type-aliases/ClientChatMessage.md +++ b/docs/api/type-aliases/ClientChatMessage.md @@ -8,8 +8,6 @@ > **ClientChatMessage** = `object` -Defined in: [types/client.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L536) - Chat message for useChat hook ## Properties @@ -18,8 +16,6 @@ Chat message for useChat hook > **id**: `string` -Defined in: [types/client.ts:538](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L538) - Unique message ID --- @@ -28,8 +24,6 @@ Unique message ID > **role**: `"user"` \| `"assistant"` \| `"system"` \| `"tool"` -Defined in: [types/client.ts:540](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L540) - Message role --- @@ -38,8 +32,6 @@ Message role > **content**: `string` -Defined in: [types/client.ts:542](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L542) - Message content --- @@ -48,8 +40,6 @@ Message content > `optional` **toolCalls?**: [`StreamToolCall`](StreamToolCall.md)[] -Defined in: [types/client.ts:544](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L544) - Tool calls in this message --- @@ -58,8 +48,6 @@ Tool calls in this message > `optional` **toolResults?**: [`StreamToolResult`](StreamToolResult.md)[] -Defined in: [types/client.ts:546](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L546) - Tool results in this message --- @@ -68,8 +56,6 @@ Tool results in this message > **createdAt**: `Date` -Defined in: [types/client.ts:548](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L548) - Message timestamp --- @@ -78,6 +64,4 @@ Message timestamp > `optional` **metadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/client.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L550) - Additional metadata diff --git a/docs/api/type-aliases/ClientClientWebSocketState.md b/docs/api/type-aliases/ClientClientWebSocketState.md index 83e25b1f3..aaf941b38 100644 --- a/docs/api/type-aliases/ClientClientWebSocketState.md +++ b/docs/api/type-aliases/ClientClientWebSocketState.md @@ -8,8 +8,6 @@ > **ClientClientWebSocketState** = [`WSClientState`](WSClientState.md) -Defined in: [types/client.ts:1568](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1568) - ## See WSClientState diff --git a/docs/api/type-aliases/ClientConfig.md b/docs/api/type-aliases/ClientConfig.md index 659cf2c60..a74ad1aa0 100644 --- a/docs/api/type-aliases/ClientConfig.md +++ b/docs/api/type-aliases/ClientConfig.md @@ -8,8 +8,6 @@ > **ClientConfig** = `object` -Defined in: [types/client.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L22) - Client configuration options for initializing the NeuroLink client ## Properties @@ -18,8 +16,6 @@ Client configuration options for initializing the NeuroLink client > **baseUrl**: `string` -Defined in: [types/client.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L24) - Base URL for the NeuroLink API --- @@ -28,8 +24,6 @@ Base URL for the NeuroLink API > `optional` **apiKey?**: `string` -Defined in: [types/client.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L26) - API key for authentication (header-based) --- @@ -38,8 +32,6 @@ API key for authentication (header-based) > `optional` **token?**: `string` -Defined in: [types/client.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L28) - Bearer token for authentication --- @@ -48,8 +40,6 @@ Bearer token for authentication > `optional` **timeout?**: `number` -Defined in: [types/client.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L30) - Default timeout in milliseconds (default: 30000) --- @@ -58,8 +48,6 @@ Default timeout in milliseconds (default: 30000) > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/client.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L32) - Default headers to include in all requests --- @@ -68,8 +56,6 @@ Default headers to include in all requests > `optional` **retry?**: [`ClientRetryConfig`](ClientRetryConfig.md) -Defined in: [types/client.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L34) - Retry configuration for failed requests --- @@ -78,8 +64,6 @@ Retry configuration for failed requests > `optional` **debug?**: `boolean` -Defined in: [types/client.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L36) - Enable debug logging --- @@ -88,8 +72,6 @@ Enable debug logging > `optional` **fetch?**: _typeof_ `fetch` -Defined in: [types/client.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L38) - Custom fetch implementation (for environments without native fetch) --- @@ -98,6 +80,4 @@ Custom fetch implementation (for environments without native fetch) > `optional` **wsUrl?**: `string` -Defined in: [types/client.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L40) - WebSocket URL override (defaults to ws(s) version of baseUrl) diff --git a/docs/api/type-aliases/ClientControlMessage.md b/docs/api/type-aliases/ClientControlMessage.md index 552b1379e..4ebac869f 100644 --- a/docs/api/type-aliases/ClientControlMessage.md +++ b/docs/api/type-aliases/ClientControlMessage.md @@ -8,8 +8,6 @@ > **ClientControlMessage** = `object` -Defined in: [types/server.ts:1480](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1480) - Control message received from the voice client over WebSocket. ## Properties @@ -17,5 +15,3 @@ Control message received from the voice client over WebSocket. ### type? > `optional` **type?**: `string` - -Defined in: [types/server.ts:1481](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1481) diff --git a/docs/api/type-aliases/ClientGenerateRequestOptions.md b/docs/api/type-aliases/ClientGenerateRequestOptions.md index 9e675df55..75905739d 100644 --- a/docs/api/type-aliases/ClientGenerateRequestOptions.md +++ b/docs/api/type-aliases/ClientGenerateRequestOptions.md @@ -8,8 +8,6 @@ > **ClientGenerateRequestOptions** = `object` -Defined in: [types/client.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L230) - Generate request options (client-side version) ## Properties @@ -18,8 +16,6 @@ Generate request options (client-side version) > **input**: `object` -Defined in: [types/client.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L232) - Input for generation #### text @@ -40,8 +36,6 @@ Input for generation > `optional` **provider?**: `string` -Defined in: [types/client.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L238) - Provider to use --- @@ -50,8 +44,6 @@ Provider to use > `optional` **model?**: `string` -Defined in: [types/client.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L240) - Model to use --- @@ -60,8 +52,6 @@ Model to use > `optional` **temperature?**: `number` -Defined in: [types/client.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L242) - Temperature for generation --- @@ -70,8 +60,6 @@ Temperature for generation > `optional` **maxTokens?**: `number` -Defined in: [types/client.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L244) - Maximum tokens to generate --- @@ -80,8 +68,6 @@ Maximum tokens to generate > `optional` **systemPrompt?**: `string` -Defined in: [types/client.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L246) - System prompt --- @@ -90,8 +76,6 @@ System prompt > `optional` **enableTools?**: `boolean` -Defined in: [types/client.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L248) - Enable tool usage --- @@ -100,8 +84,6 @@ Enable tool usage > `optional` **tools?**: `string`[] -Defined in: [types/client.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L250) - Specific tools to enable --- @@ -110,6 +92,4 @@ Specific tools to enable > `optional` **context?**: [`UnknownRecord`](UnknownRecord.md) -Defined in: [types/client.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L252) - Context data diff --git a/docs/api/type-aliases/ClientGenerateResponse.md b/docs/api/type-aliases/ClientGenerateResponse.md index 8eae88171..720137c51 100644 --- a/docs/api/type-aliases/ClientGenerateResponse.md +++ b/docs/api/type-aliases/ClientGenerateResponse.md @@ -8,8 +8,6 @@ > **ClientGenerateResponse** = `object` -Defined in: [types/client.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L258) - Generate response (client-side version) ## Properties @@ -18,8 +16,6 @@ Generate response (client-side version) > **content**: `string` -Defined in: [types/client.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L260) - Generated content --- @@ -28,8 +24,6 @@ Generated content > `optional` **provider?**: `string` -Defined in: [types/client.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L262) - Provider used --- @@ -38,8 +32,6 @@ Provider used > `optional` **model?**: `string` -Defined in: [types/client.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L264) - Model used --- @@ -48,8 +40,6 @@ Model used > `optional` **usage?**: `object` -Defined in: [types/client.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L266) - Token usage #### promptTokens @@ -70,8 +60,6 @@ Token usage > `optional` **toolCalls?**: [`StreamToolCall`](StreamToolCall.md)[] -Defined in: [types/client.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L272) - Tool calls made --- @@ -80,8 +68,6 @@ Tool calls made > `optional` **toolResults?**: [`StreamToolResult`](StreamToolResult.md)[] -Defined in: [types/client.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L274) - Tool results --- @@ -90,8 +76,6 @@ Tool results > `optional` **finishReason?**: `string` -Defined in: [types/client.ts:276](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L276) - Finish reason --- @@ -100,6 +84,4 @@ Finish reason > `optional` **metadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/client.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L278) - Response metadata diff --git a/docs/api/type-aliases/ClientInternalConfig.md b/docs/api/type-aliases/ClientInternalConfig.md index 642c34a52..e8d5cf8dc 100644 --- a/docs/api/type-aliases/ClientInternalConfig.md +++ b/docs/api/type-aliases/ClientInternalConfig.md @@ -8,8 +8,6 @@ > **ClientInternalConfig** = `object` -Defined in: [types/client.ts:1597](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1597) - Superset internal config for SSE and WebSocket client wrappers. The 9 shared fields are required. Protocol-specific fields (useNativeEventSource for SSE; heartbeatInterval/queueSize for WS) @@ -21,92 +19,68 @@ are optional — each client populates only its own fields. > **baseUrl**: `string` -Defined in: [types/client.ts:1598](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1598) - --- ### apiKey > **apiKey**: `string` -Defined in: [types/client.ts:1599](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1599) - --- ### token > **token**: `string` -Defined in: [types/client.ts:1600](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1600) - --- ### timeout > **timeout**: `number` -Defined in: [types/client.ts:1601](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1601) - --- ### headers > **headers**: `Record`\<`string`, `string`\> -Defined in: [types/client.ts:1602](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1602) - --- ### autoReconnect > **autoReconnect**: `boolean` -Defined in: [types/client.ts:1603](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1603) - --- ### maxReconnectAttempts > **maxReconnectAttempts**: `number` -Defined in: [types/client.ts:1604](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1604) - --- ### reconnectDelay > **reconnectDelay**: `number` -Defined in: [types/client.ts:1605](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1605) - --- ### maxReconnectDelay > **maxReconnectDelay**: `number` -Defined in: [types/client.ts:1606](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1606) - --- ### useNativeEventSource? > `optional` **useNativeEventSource?**: `boolean` -Defined in: [types/client.ts:1607](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1607) - --- ### heartbeatInterval? > `optional` **heartbeatInterval?**: `number` -Defined in: [types/client.ts:1608](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1608) - --- ### queueSize? > `optional` **queueSize?**: `number` - -Defined in: [types/client.ts:1609](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1609) diff --git a/docs/api/type-aliases/ClientLanguageModel.md b/docs/api/type-aliases/ClientLanguageModel.md index 09a535f4f..3fcf5ae00 100644 --- a/docs/api/type-aliases/ClientLanguageModel.md +++ b/docs/api/type-aliases/ClientLanguageModel.md @@ -8,8 +8,6 @@ > **ClientLanguageModel** = `object` -Defined in: [types/client.ts:836](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L836) - AI SDK Language Model interface (Vercel AI SDK compatible) ## Properties @@ -18,8 +16,6 @@ AI SDK Language Model interface (Vercel AI SDK compatible) > **modelId**: `string` -Defined in: [types/client.ts:838](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L838) - Model specification string --- @@ -28,8 +24,6 @@ Model specification string > **provider**: `string` -Defined in: [types/client.ts:840](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L840) - Provider name --- @@ -38,8 +32,6 @@ Provider name > **doGenerate**: (`options`) => `Promise`\<[`ClientLanguageModelResponse`](ClientLanguageModelResponse.md)\> -Defined in: [types/client.ts:842](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L842) - Generate non-streaming response #### Parameters @@ -58,8 +50,6 @@ Generate non-streaming response > **doStream**: (`options`) => `Promise`\<[`ClientLanguageModelStreamResponse`](ClientLanguageModelStreamResponse.md)\> -Defined in: [types/client.ts:846](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L846) - Generate streaming response #### Parameters diff --git a/docs/api/type-aliases/ClientLanguageModelCallOptions.md b/docs/api/type-aliases/ClientLanguageModelCallOptions.md index 3accc9610..4cee4e36f 100644 --- a/docs/api/type-aliases/ClientLanguageModelCallOptions.md +++ b/docs/api/type-aliases/ClientLanguageModelCallOptions.md @@ -8,8 +8,6 @@ > **ClientLanguageModelCallOptions** = `object` -Defined in: [types/client.ts:854](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L854) - Language model call options ## Properties @@ -18,8 +16,6 @@ Language model call options > **prompt**: `string` -Defined in: [types/client.ts:856](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L856) - Input prompt --- @@ -28,8 +24,6 @@ Input prompt > `optional` **system?**: `string` -Defined in: [types/client.ts:858](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L858) - System prompt --- @@ -38,8 +32,6 @@ System prompt > `optional` **messages?**: `object`[] -Defined in: [types/client.ts:860](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L860) - Messages for conversation #### role @@ -56,8 +48,6 @@ Messages for conversation > `optional` **temperature?**: `number` -Defined in: [types/client.ts:865](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L865) - Temperature --- @@ -66,8 +56,6 @@ Temperature > `optional` **maxTokens?**: `number` -Defined in: [types/client.ts:867](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L867) - Maximum tokens --- @@ -76,8 +64,6 @@ Maximum tokens > `optional` **stopSequences?**: `string`[] -Defined in: [types/client.ts:869](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L869) - Stop sequences --- @@ -86,6 +72,4 @@ Stop sequences > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/client.ts:871](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L871) - Abort signal diff --git a/docs/api/type-aliases/ClientLanguageModelResponse.md b/docs/api/type-aliases/ClientLanguageModelResponse.md index 835b0adf2..5876b4443 100644 --- a/docs/api/type-aliases/ClientLanguageModelResponse.md +++ b/docs/api/type-aliases/ClientLanguageModelResponse.md @@ -8,8 +8,6 @@ > **ClientLanguageModelResponse** = `object` -Defined in: [types/client.ts:877](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L877) - Language model response ## Properties @@ -18,8 +16,6 @@ Language model response > **text**: `string` -Defined in: [types/client.ts:879](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L879) - Generated text --- @@ -28,8 +24,6 @@ Generated text > **finishReason**: `"stop"` \| `"length"` \| `"tool-calls"` \| `"content-filter"` \| `"error"` \| `"other"` -Defined in: [types/client.ts:881](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L881) - Finish reason --- @@ -38,8 +32,6 @@ Finish reason > **usage**: `object` -Defined in: [types/client.ts:889](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L889) - Usage information #### promptTokens @@ -56,6 +48,4 @@ Usage information > `optional` **rawResponse?**: `unknown` -Defined in: [types/client.ts:894](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L894) - Raw response diff --git a/docs/api/type-aliases/ClientLanguageModelStreamResponse.md b/docs/api/type-aliases/ClientLanguageModelStreamResponse.md index c6846c1a5..bfbdc5701 100644 --- a/docs/api/type-aliases/ClientLanguageModelStreamResponse.md +++ b/docs/api/type-aliases/ClientLanguageModelStreamResponse.md @@ -8,8 +8,6 @@ > **ClientLanguageModelStreamResponse** = `object` -Defined in: [types/client.ts:900](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L900) - Language model stream response ## Properties @@ -18,8 +16,6 @@ Language model stream response > **stream**: `AsyncIterable`\<\{ `type`: `"text-delta"` \| `"finish"`; `textDelta?`: `string`; `finishReason?`: `string`; `usage?`: \{ `promptTokens`: `number`; `completionTokens`: `number`; \}; \}\> -Defined in: [types/client.ts:902](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L902) - Stream of text deltas --- @@ -28,6 +24,4 @@ Stream of text deltas > `optional` **rawResponse?**: `unknown` -Defined in: [types/client.ts:912](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L912) - Raw response diff --git a/docs/api/type-aliases/ClientMiddleware.md b/docs/api/type-aliases/ClientMiddleware.md index 7087ea197..6040945e6 100644 --- a/docs/api/type-aliases/ClientMiddleware.md +++ b/docs/api/type-aliases/ClientMiddleware.md @@ -8,8 +8,6 @@ > **ClientMiddleware** = (`request`, `next`) => `Promise`\<[`ClientMiddlewareResponse`](ClientMiddlewareResponse.md)\> -Defined in: [types/client.ts:463](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L463) - ClientMiddleware function type ## Parameters diff --git a/docs/api/type-aliases/ClientMiddlewareContext.md b/docs/api/type-aliases/ClientMiddlewareContext.md index 06fa6ebc2..e21ec0590 100644 --- a/docs/api/type-aliases/ClientMiddlewareContext.md +++ b/docs/api/type-aliases/ClientMiddlewareContext.md @@ -8,8 +8,6 @@ > **ClientMiddlewareContext** = `object` -Defined in: [types/client.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L501) - ClientMiddleware context for passing data between middleware ## Indexable @@ -24,8 +22,6 @@ Additional context data > **startTime**: `number` -Defined in: [types/client.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L503) - Request start time --- @@ -34,8 +30,6 @@ Request start time > **requestId**: `string` -Defined in: [types/client.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L505) - Request ID --- @@ -44,6 +38,4 @@ Request ID > **retryCount**: `number` -Defined in: [types/client.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L507) - Retry count diff --git a/docs/api/type-aliases/ClientMiddlewareRequest.md b/docs/api/type-aliases/ClientMiddlewareRequest.md index e23d9b56f..442414151 100644 --- a/docs/api/type-aliases/ClientMiddlewareRequest.md +++ b/docs/api/type-aliases/ClientMiddlewareRequest.md @@ -8,8 +8,6 @@ > **ClientMiddlewareRequest** = `object` -Defined in: [types/client.ts:471](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L471) - ClientMiddleware request object ## Properties @@ -18,8 +16,6 @@ ClientMiddleware request object > **url**: `string` -Defined in: [types/client.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L473) - Request URL --- @@ -28,8 +24,6 @@ Request URL > **method**: `string` -Defined in: [types/client.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L475) - HTTP method --- @@ -38,8 +32,6 @@ HTTP method > **headers**: `Record`\<`string`, `string`\> -Defined in: [types/client.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L477) - Request headers --- @@ -48,8 +40,6 @@ Request headers > `optional` **body?**: `unknown` -Defined in: [types/client.ts:479](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L479) - Request body --- @@ -58,6 +48,4 @@ Request body > **context**: [`ClientMiddlewareContext`](ClientMiddlewareContext.md) -Defined in: [types/client.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L481) - ClientMiddleware context diff --git a/docs/api/type-aliases/ClientMiddlewareResponse.md b/docs/api/type-aliases/ClientMiddlewareResponse.md index 0ff20bf3d..3d1494efc 100644 --- a/docs/api/type-aliases/ClientMiddlewareResponse.md +++ b/docs/api/type-aliases/ClientMiddlewareResponse.md @@ -8,8 +8,6 @@ > **ClientMiddlewareResponse** = `object` -Defined in: [types/client.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L487) - ClientMiddleware response object ## Properties @@ -18,8 +16,6 @@ ClientMiddleware response object > **status**: `number` -Defined in: [types/client.ts:489](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L489) - HTTP status code --- @@ -28,8 +24,6 @@ HTTP status code > **headers**: `Record`\<`string`, `string`\> -Defined in: [types/client.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L491) - Response headers --- @@ -38,8 +32,6 @@ Response headers > **body**: `unknown` -Defined in: [types/client.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L493) - Response body --- @@ -48,6 +40,4 @@ Response body > **context**: [`ClientMiddlewareContext`](ClientMiddlewareContext.md) -Defined in: [types/client.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L495) - ClientMiddleware context diff --git a/docs/api/type-aliases/ClientModelOptions.md b/docs/api/type-aliases/ClientModelOptions.md index 405b2a89d..b02ca45bf 100644 --- a/docs/api/type-aliases/ClientModelOptions.md +++ b/docs/api/type-aliases/ClientModelOptions.md @@ -8,8 +8,6 @@ > **ClientModelOptions** = `object` -Defined in: [types/client.ts:936](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L936) - Model creation options for AI SDK adapter ## Properties @@ -18,8 +16,6 @@ Model creation options for AI SDK adapter > `optional` **modelId?**: `string` -Defined in: [types/client.ts:938](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L938) - Model ID --- @@ -28,8 +24,6 @@ Model ID > `optional` **provider?**: `string` -Defined in: [types/client.ts:940](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L940) - Provider name --- @@ -38,8 +32,6 @@ Provider name > `optional` **temperature?**: `number` -Defined in: [types/client.ts:942](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L942) - Temperature --- @@ -48,6 +40,4 @@ Temperature > `optional` **maxTokens?**: `number` -Defined in: [types/client.ts:944](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L944) - Maximum tokens diff --git a/docs/api/type-aliases/ClientOAuth2Config.md b/docs/api/type-aliases/ClientOAuth2Config.md index 2b7147ed1..dac7b6018 100644 --- a/docs/api/type-aliases/ClientOAuth2Config.md +++ b/docs/api/type-aliases/ClientOAuth2Config.md @@ -8,8 +8,6 @@ > **ClientOAuth2Config** = `object` -Defined in: [types/client.ts:1096](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1096) - OAuth2 client credentials configuration ## Properties @@ -18,8 +16,6 @@ OAuth2 client credentials configuration > **tokenUrl**: `string` -Defined in: [types/client.ts:1098](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1098) - Token endpoint URL --- @@ -28,8 +24,6 @@ Token endpoint URL > **clientId**: `string` -Defined in: [types/client.ts:1100](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1100) - OAuth2 client ID --- @@ -38,8 +32,6 @@ OAuth2 client ID > **clientSecret**: `string` -Defined in: [types/client.ts:1102](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1102) - OAuth2 client secret --- @@ -48,8 +40,6 @@ OAuth2 client secret > `optional` **scope?**: `string` -Defined in: [types/client.ts:1104](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1104) - OAuth2 scope (optional) --- @@ -58,6 +48,4 @@ OAuth2 scope (optional) > `optional` **audience?**: `string` -Defined in: [types/client.ts:1106](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1106) - Audience for the token (optional) diff --git a/docs/api/type-aliases/ClientProviderStatus.md b/docs/api/type-aliases/ClientProviderStatus.md index 2546696a0..bb10bc376 100644 --- a/docs/api/type-aliases/ClientProviderStatus.md +++ b/docs/api/type-aliases/ClientProviderStatus.md @@ -8,8 +8,6 @@ > **ClientProviderStatus** = `object` -Defined in: [types/client.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L116) - Provider status information ## Properties @@ -18,8 +16,6 @@ Provider status information > **name**: `string` -Defined in: [types/client.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L118) - Provider name --- @@ -28,8 +24,6 @@ Provider name > **status**: `"available"` \| `"degraded"` \| `"unavailable"` -Defined in: [types/client.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L120) - Provider availability status --- @@ -38,8 +32,6 @@ Provider availability status > **models**: `string`[] -Defined in: [types/client.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L122) - Available models for this provider --- @@ -48,8 +40,6 @@ Available models for this provider > `optional` **capabilities?**: `object` -Defined in: [types/client.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L124) - Provider capabilities #### streaming @@ -74,6 +64,4 @@ Provider capabilities > `optional` **lastChecked?**: `number` -Defined in: [types/client.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L131) - Last health check timestamp diff --git a/docs/api/type-aliases/ClientRequestOptions.md b/docs/api/type-aliases/ClientRequestOptions.md index 4c8ca3c98..af7352621 100644 --- a/docs/api/type-aliases/ClientRequestOptions.md +++ b/docs/api/type-aliases/ClientRequestOptions.md @@ -8,8 +8,6 @@ > **ClientRequestOptions** = `object` -Defined in: [types/client.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L64) - Request options that can be passed to individual API calls ## Properties @@ -18,8 +16,6 @@ Request options that can be passed to individual API calls > `optional` **timeout?**: `number` -Defined in: [types/client.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L66) - Request timeout override in milliseconds --- @@ -28,8 +24,6 @@ Request timeout override in milliseconds > `optional` **signal?**: `AbortSignal` -Defined in: [types/client.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L68) - Signal for request cancellation --- @@ -38,8 +32,6 @@ Signal for request cancellation > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/client.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L70) - Additional headers for this request --- @@ -48,6 +40,4 @@ Additional headers for this request > `optional` **skipRetry?**: `boolean` -Defined in: [types/client.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L72) - Skip retry for this request diff --git a/docs/api/type-aliases/ClientRetryConfig.md b/docs/api/type-aliases/ClientRetryConfig.md index acf90d3ec..7b5e0463a 100644 --- a/docs/api/type-aliases/ClientRetryConfig.md +++ b/docs/api/type-aliases/ClientRetryConfig.md @@ -8,8 +8,6 @@ > **ClientRetryConfig** = `object` -Defined in: [types/client.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L46) - Retry configuration for failed requests ## Properties @@ -18,8 +16,6 @@ Retry configuration for failed requests > **maxAttempts**: `number` -Defined in: [types/client.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L48) - Maximum number of retry attempts (default: 3) --- @@ -28,8 +24,6 @@ Maximum number of retry attempts (default: 3) > **initialDelayMs**: `number` -Defined in: [types/client.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L50) - Initial delay in milliseconds before first retry (default: 1000) --- @@ -38,8 +32,6 @@ Initial delay in milliseconds before first retry (default: 1000) > **maxDelayMs**: `number` -Defined in: [types/client.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L52) - Maximum delay in milliseconds between retries (default: 10000) --- @@ -48,8 +40,6 @@ Maximum delay in milliseconds between retries (default: 10000) > **backoffMultiplier**: `number` -Defined in: [types/client.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L54) - Backoff multiplier for exponential backoff (default: 2) --- @@ -58,8 +48,6 @@ Backoff multiplier for exponential backoff (default: 2) > `optional` **retryableStatusCodes?**: `number`[] -Defined in: [types/client.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L56) - HTTP status codes to retry on (default: [408, 429, 500, 502, 503, 504]) --- @@ -68,6 +56,4 @@ HTTP status codes to retry on (default: [408, 429, 500, 502, 503, 504]) > `optional` **retryOnNetworkError?**: `boolean` -Defined in: [types/client.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L58) - Whether to retry on network errors (default: true) diff --git a/docs/api/type-aliases/ClientSpeechRecognitionResult.md b/docs/api/type-aliases/ClientSpeechRecognitionResult.md index ebb0f56b9..ccbb6a1f6 100644 --- a/docs/api/type-aliases/ClientSpeechRecognitionResult.md +++ b/docs/api/type-aliases/ClientSpeechRecognitionResult.md @@ -8,8 +8,6 @@ > **ClientSpeechRecognitionResult** = `object` -Defined in: [types/client.ts:1044](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1044) - Speech recognition result ## Properties @@ -18,8 +16,6 @@ Speech recognition result > **transcript**: `string` -Defined in: [types/client.ts:1046](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1046) - Transcript text --- @@ -28,8 +24,6 @@ Transcript text > **confidence**: `number` -Defined in: [types/client.ts:1048](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1048) - Confidence score (0-1) --- @@ -38,6 +32,4 @@ Confidence score (0-1) > **isFinal**: `boolean` -Defined in: [types/client.ts:1050](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1050) - Whether this is the final result diff --git a/docs/api/type-aliases/ClientSpeechSynthesisOptions.md b/docs/api/type-aliases/ClientSpeechSynthesisOptions.md index 69ad9858e..839bb1626 100644 --- a/docs/api/type-aliases/ClientSpeechSynthesisOptions.md +++ b/docs/api/type-aliases/ClientSpeechSynthesisOptions.md @@ -8,8 +8,6 @@ > **ClientSpeechSynthesisOptions** = `object` -Defined in: [types/client.ts:1056](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1056) - Speech synthesis options ## Properties @@ -18,8 +16,6 @@ Speech synthesis options > `optional` **voice?**: `string` -Defined in: [types/client.ts:1058](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1058) - Voice to use --- @@ -28,8 +24,6 @@ Voice to use > `optional` **rate?**: `number` -Defined in: [types/client.ts:1060](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1060) - Speaking rate (0.1-10) --- @@ -38,8 +32,6 @@ Speaking rate (0.1-10) > `optional` **pitch?**: `number` -Defined in: [types/client.ts:1062](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1062) - Pitch (0-2) --- @@ -48,8 +40,6 @@ Pitch (0-2) > `optional` **volume?**: `number` -Defined in: [types/client.ts:1064](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1064) - Volume (0-1) --- @@ -58,6 +48,4 @@ Volume (0-1) > `optional` **lang?**: `string` -Defined in: [types/client.ts:1066](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1066) - Language code diff --git a/docs/api/type-aliases/ClientStreamCallbacks.md b/docs/api/type-aliases/ClientStreamCallbacks.md index 655dc3302..57a9a0b61 100644 --- a/docs/api/type-aliases/ClientStreamCallbacks.md +++ b/docs/api/type-aliases/ClientStreamCallbacks.md @@ -8,8 +8,6 @@ > **ClientStreamCallbacks** = `object` -Defined in: [types/client.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L182) - Streaming callback handlers ## Properties @@ -18,8 +16,6 @@ Streaming callback handlers > `optional` **onText?**: (`text`) => `void` -Defined in: [types/client.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L184) - Called for each text chunk #### Parameters @@ -38,8 +34,6 @@ Called for each text chunk > `optional` **onToolCall?**: (`toolCall`) => `void` -Defined in: [types/client.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L186) - Called for each tool call #### Parameters @@ -58,8 +52,6 @@ Called for each tool call > `optional` **onToolResult?**: (`toolResult`) => `void` -Defined in: [types/client.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L188) - Called for each tool result #### Parameters @@ -78,8 +70,6 @@ Called for each tool result > `optional` **onError?**: (`error`) => `void` -Defined in: [types/client.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L190) - Called on stream error #### Parameters @@ -98,8 +88,6 @@ Called on stream error > `optional` **onDone?**: (`result`) => `void` -Defined in: [types/client.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L192) - Called when stream completes #### Parameters @@ -118,8 +106,6 @@ Called when stream completes > `optional` **onMetadata?**: (`metadata`) => `void` -Defined in: [types/client.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L194) - Called for metadata updates #### Parameters @@ -138,8 +124,6 @@ Called for metadata updates > `optional` **onAudio?**: (`audio`) => `void` -Defined in: [types/client.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L196) - Called for audio chunks #### Parameters @@ -164,8 +148,6 @@ Called for audio chunks > `optional` **onThinking?**: (`thinking`) => `void` -Defined in: [types/client.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L198) - Called for thinking/reasoning output #### Parameters diff --git a/docs/api/type-aliases/ClientStreamEvent.md b/docs/api/type-aliases/ClientStreamEvent.md index 40433e629..d2c6afe67 100644 --- a/docs/api/type-aliases/ClientStreamEvent.md +++ b/docs/api/type-aliases/ClientStreamEvent.md @@ -8,8 +8,6 @@ > **ClientStreamEvent** = `object` -Defined in: [types/client.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L154) - Stream event from SSE/WebSocket ## Properties @@ -18,8 +16,6 @@ Stream event from SSE/WebSocket > **type**: [`ClientStreamEventType`](ClientStreamEventType.md) -Defined in: [types/client.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L156) - Event type --- @@ -28,8 +24,6 @@ Event type > `optional` **content?**: `string` -Defined in: [types/client.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L158) - Text content (for text events) --- @@ -38,8 +32,6 @@ Text content (for text events) > `optional` **toolCall?**: [`StreamToolCall`](StreamToolCall.md) -Defined in: [types/client.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L160) - Tool call data (for tool-call events) --- @@ -48,8 +40,6 @@ Tool call data (for tool-call events) > `optional` **toolResult?**: [`StreamToolResult`](StreamToolResult.md) -Defined in: [types/client.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L162) - Tool result data (for tool-result events) --- @@ -58,8 +48,6 @@ Tool result data (for tool-result events) > `optional` **error?**: [`ClientApiError`](ClientApiError.md) -Defined in: [types/client.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L164) - Error data (for error events) --- @@ -68,8 +56,6 @@ Error data (for error events) > `optional` **metadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/client.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L166) - Metadata (for metadata events) --- @@ -78,8 +64,6 @@ Metadata (for metadata events) > `optional` **audio?**: `object` -Defined in: [types/client.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L168) - Audio data (for audio events) #### data @@ -100,8 +84,6 @@ Audio data (for audio events) > `optional` **thinking?**: `string` -Defined in: [types/client.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L174) - Thinking/reasoning content (for thinking events) --- @@ -110,6 +92,4 @@ Thinking/reasoning content (for thinking events) > **timestamp**: `number` -Defined in: [types/client.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L176) - Event timestamp diff --git a/docs/api/type-aliases/ClientStreamEventType.md b/docs/api/type-aliases/ClientStreamEventType.md index dea413818..168c6ebbd 100644 --- a/docs/api/type-aliases/ClientStreamEventType.md +++ b/docs/api/type-aliases/ClientStreamEventType.md @@ -8,6 +8,4 @@ > **ClientStreamEventType** = `"text"` \| `"tool-call"` \| `"tool-result"` \| `"error"` \| `"done"` \| `"metadata"` \| `"audio"` \| `"thinking"` -Defined in: [types/client.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L141) - Stream event types for real-time communication diff --git a/docs/api/type-aliases/ClientStreamRequestOptions.md b/docs/api/type-aliases/ClientStreamRequestOptions.md index 5bc481558..aeeaf7ae5 100644 --- a/docs/api/type-aliases/ClientStreamRequestOptions.md +++ b/docs/api/type-aliases/ClientStreamRequestOptions.md @@ -8,8 +8,6 @@ > **ClientStreamRequestOptions** = [`ClientGenerateRequestOptions`](ClientGenerateRequestOptions.md) & `object` -Defined in: [types/client.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L284) - Stream request options (client-side version) ## Type Declaration diff --git a/docs/api/type-aliases/ClientStreamResult.md b/docs/api/type-aliases/ClientStreamResult.md index 9caf91507..caa927656 100644 --- a/docs/api/type-aliases/ClientStreamResult.md +++ b/docs/api/type-aliases/ClientStreamResult.md @@ -8,8 +8,6 @@ > **ClientStreamResult** = `object` -Defined in: [types/client.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L204) - Stream result with full response data ## Properties @@ -18,8 +16,6 @@ Stream result with full response data > **content**: `string` -Defined in: [types/client.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L206) - Full accumulated text content --- @@ -28,8 +24,6 @@ Full accumulated text content > `optional` **toolCalls?**: [`StreamToolCall`](StreamToolCall.md)[] -Defined in: [types/client.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L208) - All tool calls made --- @@ -38,8 +32,6 @@ All tool calls made > `optional` **toolResults?**: [`StreamToolResult`](StreamToolResult.md)[] -Defined in: [types/client.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L210) - All tool results --- @@ -48,8 +40,6 @@ All tool results > `optional` **usage?**: `object` -Defined in: [types/client.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L212) - Token usage information #### promptTokens @@ -70,8 +60,6 @@ Token usage information > `optional` **finishReason?**: `string` -Defined in: [types/client.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L218) - Finish reason --- @@ -80,6 +68,4 @@ Finish reason > `optional` **metadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/client.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L220) - Response metadata diff --git a/docs/api/type-aliases/ClientTokenRefreshResult.md b/docs/api/type-aliases/ClientTokenRefreshResult.md index bdd3b479f..575fd9725 100644 --- a/docs/api/type-aliases/ClientTokenRefreshResult.md +++ b/docs/api/type-aliases/ClientTokenRefreshResult.md @@ -8,8 +8,6 @@ > **ClientTokenRefreshResult** = `object` -Defined in: [types/client.ts:1112](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1112) - Token refresh result ## Properties @@ -18,8 +16,6 @@ Token refresh result > **accessToken**: `string` -Defined in: [types/client.ts:1114](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1114) - Access token --- @@ -28,8 +24,6 @@ Access token > **expiresIn**: `number` -Defined in: [types/client.ts:1116](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1116) - Token expiry time in seconds --- @@ -38,8 +32,6 @@ Token expiry time in seconds > **tokenType**: `string` -Defined in: [types/client.ts:1118](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1118) - Token type (usually "Bearer") --- @@ -48,8 +40,6 @@ Token type (usually "Bearer") > `optional` **refreshToken?**: `string` -Defined in: [types/client.ts:1120](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1120) - Refresh token (if provided) --- @@ -58,6 +48,4 @@ Refresh token (if provided) > `optional` **scope?**: `string` -Defined in: [types/client.ts:1122](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1122) - OAuth2 scope (if provided) diff --git a/docs/api/type-aliases/ClientToolInfo.md b/docs/api/type-aliases/ClientToolInfo.md index c7dfdbe4b..625089f70 100644 --- a/docs/api/type-aliases/ClientToolInfo.md +++ b/docs/api/type-aliases/ClientToolInfo.md @@ -8,8 +8,6 @@ > **ClientToolInfo** = `object` -Defined in: [types/client.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L441) - Tool information for client use ## Properties @@ -18,8 +16,6 @@ Tool information for client use > **name**: `string` -Defined in: [types/client.ts:443](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L443) - Tool name --- @@ -28,8 +24,6 @@ Tool name > **description**: `string` -Defined in: [types/client.ts:445](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L445) - Tool description --- @@ -38,8 +32,6 @@ Tool description > `optional` **category?**: `string` -Defined in: [types/client.ts:447](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L447) - Tool category --- @@ -48,8 +40,6 @@ Tool category > **serverId**: `string` -Defined in: [types/client.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L449) - Server ID --- @@ -58,8 +48,6 @@ Server ID > **inputSchema**: [`JsonObject`](JsonObject.md) -Defined in: [types/client.ts:451](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L451) - Input schema --- @@ -68,6 +56,4 @@ Input schema > `optional` **requiresConfirmation?**: `boolean` -Defined in: [types/client.ts:453](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L453) - Whether tool requires confirmation diff --git a/docs/api/type-aliases/ClientWebSocketConfig.md b/docs/api/type-aliases/ClientWebSocketConfig.md index 40676f1bd..274511419 100644 --- a/docs/api/type-aliases/ClientWebSocketConfig.md +++ b/docs/api/type-aliases/ClientWebSocketConfig.md @@ -8,8 +8,6 @@ > **ClientWebSocketConfig** = [`WSClientConfig`](WSClientConfig.md) -Defined in: [types/client.ts:1575](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1575) - ## See WSClientConfig diff --git a/docs/api/type-aliases/ClientWebSocketMessage.md b/docs/api/type-aliases/ClientWebSocketMessage.md index f449c38d1..3a8c787f9 100644 --- a/docs/api/type-aliases/ClientWebSocketMessage.md +++ b/docs/api/type-aliases/ClientWebSocketMessage.md @@ -8,8 +8,6 @@ > **ClientWebSocketMessage** = [`WSClientMessage`](WSClientMessage.md) -Defined in: [types/client.ts:1582](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1582) - ## See WSClientMessage diff --git a/docs/api/type-aliases/ClientWebSocketMessageHandler.md b/docs/api/type-aliases/ClientWebSocketMessageHandler.md index 9ee785232..0392a7dca 100644 --- a/docs/api/type-aliases/ClientWebSocketMessageHandler.md +++ b/docs/api/type-aliases/ClientWebSocketMessageHandler.md @@ -8,8 +8,6 @@ > **ClientWebSocketMessageHandler** = (`data`) => `void` -Defined in: [types/client.ts:982](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L982) - WebSocket message handler ## Parameters diff --git a/docs/api/type-aliases/ClientWebSocketOptions.md b/docs/api/type-aliases/ClientWebSocketOptions.md index dc05f70fa..90324a553 100644 --- a/docs/api/type-aliases/ClientWebSocketOptions.md +++ b/docs/api/type-aliases/ClientWebSocketOptions.md @@ -8,8 +8,6 @@ > **ClientWebSocketOptions** = `object` -Defined in: [types/client.ts:954](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L954) - WebSocket connection options ## Properties @@ -18,8 +16,6 @@ WebSocket connection options > **url**: `string` -Defined in: [types/client.ts:956](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L956) - WebSocket URL --- @@ -28,8 +24,6 @@ WebSocket URL > `optional` **protocols?**: `string` \| `string`[] -Defined in: [types/client.ts:958](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L958) - Protocols --- @@ -38,8 +32,6 @@ Protocols > `optional` **autoReconnect?**: `boolean` -Defined in: [types/client.ts:960](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L960) - Auto-reconnect on disconnect --- @@ -48,8 +40,6 @@ Auto-reconnect on disconnect > `optional` **reconnectInterval?**: `number` -Defined in: [types/client.ts:962](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L962) - Reconnect interval in ms --- @@ -58,8 +48,6 @@ Reconnect interval in ms > `optional` **maxReconnectAttempts?**: `number` -Defined in: [types/client.ts:964](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L964) - Maximum reconnect attempts --- @@ -68,6 +56,4 @@ Maximum reconnect attempts > `optional` **heartbeatInterval?**: `number` -Defined in: [types/client.ts:966](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L966) - Heartbeat interval in ms diff --git a/docs/api/type-aliases/ClientWebSocketState.md b/docs/api/type-aliases/ClientWebSocketState.md index df68e4bc8..766ec5d9c 100644 --- a/docs/api/type-aliases/ClientWebSocketState.md +++ b/docs/api/type-aliases/ClientWebSocketState.md @@ -8,6 +8,4 @@ > **ClientWebSocketState** = `"connecting"` \| `"connected"` \| `"disconnecting"` \| `"disconnected"` \| `"reconnecting"` -Defined in: [types/client.ts:972](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L972) - WebSocket connection state diff --git a/docs/api/type-aliases/ClientWorkflowExecuteOptions.md b/docs/api/type-aliases/ClientWorkflowExecuteOptions.md index 89643f23b..4424bb11d 100644 --- a/docs/api/type-aliases/ClientWorkflowExecuteOptions.md +++ b/docs/api/type-aliases/ClientWorkflowExecuteOptions.md @@ -8,8 +8,6 @@ > **ClientWorkflowExecuteOptions** = `object` -Defined in: [types/client.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L374) - Workflow execution options ## Properties @@ -18,8 +16,6 @@ Workflow execution options > **workflowId**: `string` -Defined in: [types/client.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L376) - Workflow ID --- @@ -28,8 +24,6 @@ Workflow ID > **input**: [`UnknownRecord`](UnknownRecord.md) -Defined in: [types/client.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L378) - Workflow input data --- @@ -38,8 +32,6 @@ Workflow input data > `optional` **sessionId?**: `string` -Defined in: [types/client.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L380) - Session ID for state persistence --- @@ -48,8 +40,6 @@ Session ID for state persistence > `optional` **resumeToken?**: `string` -Defined in: [types/client.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L382) - Resume from a suspended state --- @@ -58,6 +48,4 @@ Resume from a suspended state > `optional` **callbackUrl?**: `string` -Defined in: [types/client.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L384) - Callback URL for async completion diff --git a/docs/api/type-aliases/ClientWorkflowExecuteResult.md b/docs/api/type-aliases/ClientWorkflowExecuteResult.md index a7737ddc0..8b17ed2f1 100644 --- a/docs/api/type-aliases/ClientWorkflowExecuteResult.md +++ b/docs/api/type-aliases/ClientWorkflowExecuteResult.md @@ -8,8 +8,6 @@ > **ClientWorkflowExecuteResult** = `object` -Defined in: [types/client.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L390) - Workflow execution result ## Properties @@ -18,8 +16,6 @@ Workflow execution result > **runId**: `string` -Defined in: [types/client.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L392) - Workflow run ID --- @@ -28,8 +24,6 @@ Workflow run ID > **workflowId**: `string` -Defined in: [types/client.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L394) - Workflow ID --- @@ -38,8 +32,6 @@ Workflow ID > **status**: `"running"` \| `"completed"` \| `"failed"` \| `"suspended"` -Defined in: [types/client.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L396) - Execution status --- @@ -48,8 +40,6 @@ Execution status > `optional` **output?**: [`UnknownRecord`](UnknownRecord.md) -Defined in: [types/client.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L398) - Output data (if completed) --- @@ -58,8 +48,6 @@ Output data (if completed) > `optional` **error?**: [`ClientApiError`](ClientApiError.md) -Defined in: [types/client.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L400) - Error information (if failed) --- @@ -68,8 +56,6 @@ Error information (if failed) > `optional` **suspendToken?**: `string` -Defined in: [types/client.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L402) - Suspend token (if suspended) --- @@ -78,8 +64,6 @@ Suspend token (if suspended) > `optional` **steps?**: `object`[] -Defined in: [types/client.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L404) - Step results #### stepId @@ -104,6 +88,4 @@ Step results > `optional` **duration?**: `number` -Defined in: [types/client.ts:411](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L411) - Total execution duration diff --git a/docs/api/type-aliases/ClientWorkflowInfo.md b/docs/api/type-aliases/ClientWorkflowInfo.md index f62179261..ca933c7d0 100644 --- a/docs/api/type-aliases/ClientWorkflowInfo.md +++ b/docs/api/type-aliases/ClientWorkflowInfo.md @@ -8,8 +8,6 @@ > **ClientWorkflowInfo** = `object` -Defined in: [types/client.ts:417](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L417) - Workflow information ## Properties @@ -18,8 +16,6 @@ Workflow information > **id**: `string` -Defined in: [types/client.ts:419](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L419) - Workflow ID --- @@ -28,8 +24,6 @@ Workflow ID > **name**: `string` -Defined in: [types/client.ts:421](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L421) - Workflow name --- @@ -38,8 +32,6 @@ Workflow name > **description**: `string` -Defined in: [types/client.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L423) - Workflow description --- @@ -48,8 +40,6 @@ Workflow description > **version**: `string` -Defined in: [types/client.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L425) - Workflow version --- @@ -58,8 +48,6 @@ Workflow version > `optional` **steps?**: `object`[] -Defined in: [types/client.ts:427](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L427) - Steps in the workflow #### id diff --git a/docs/api/type-aliases/ClipCompletion.md b/docs/api/type-aliases/ClipCompletion.md index 543da2376..33febd8a9 100644 --- a/docs/api/type-aliases/ClipCompletion.md +++ b/docs/api/type-aliases/ClipCompletion.md @@ -8,6 +8,4 @@ > **ClipCompletion** = \{ `status`: `"pending"`; \} \| \{ `status`: `"success"`; `result`: [`ClipResult`](ClipResult.md); \} \| \{ `status`: `"failure"`; `error`: `Error`; \} -Defined in: [types/multimodal.ts:733](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L733) - Completion status for ordered circuit-breaker tracking. diff --git a/docs/api/type-aliases/ClipGenState.md b/docs/api/type-aliases/ClipGenState.md index 68475d329..0ce7e356d 100644 --- a/docs/api/type-aliases/ClipGenState.md +++ b/docs/api/type-aliases/ClipGenState.md @@ -8,8 +8,6 @@ > **ClipGenState** = `object` -Defined in: [types/multimodal.ts:739](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L739) - State shared across clip-generation tasks for circuit-breaker logic. ## Properties @@ -18,36 +16,26 @@ State shared across clip-generation tasks for circuit-breaker logic. > **consecutiveFailures**: `number` -Defined in: [types/multimodal.ts:740](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L740) - --- ### circuitOpen > **circuitOpen**: `boolean` -Defined in: [types/multimodal.ts:741](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L741) - --- ### results > **results**: ([`ClipResult`](ClipResult.md) \| `null`)[] -Defined in: [types/multimodal.ts:742](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L742) - --- ### completions > **completions**: [`ClipCompletion`](ClipCompletion.md)[] -Defined in: [types/multimodal.ts:743](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L743) - --- ### nextExpectedIndex > **nextExpectedIndex**: `number` - -Defined in: [types/multimodal.ts:744](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L744) diff --git a/docs/api/type-aliases/ClipResult.md b/docs/api/type-aliases/ClipResult.md index aa6e7978b..428ac1906 100644 --- a/docs/api/type-aliases/ClipResult.md +++ b/docs/api/type-aliases/ClipResult.md @@ -8,8 +8,6 @@ > **ClipResult** = `object` -Defined in: [types/multimodal.ts:730](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L730) - Result of a single director-mode clip generation. ## Properties @@ -18,12 +16,8 @@ Result of a single director-mode clip generation. > **buffer**: `Buffer` -Defined in: [types/multimodal.ts:730](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L730) - --- ### processingTime > **processingTime**: `number` - -Defined in: [types/multimodal.ts:730](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L730) diff --git a/docs/api/type-aliases/CloakingAccount.md b/docs/api/type-aliases/CloakingAccount.md index a9e1f0421..b09de1080 100644 --- a/docs/api/type-aliases/CloakingAccount.md +++ b/docs/api/type-aliases/CloakingAccount.md @@ -8,8 +8,6 @@ > **CloakingAccount** = `object` -Defined in: [types/proxy.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L372) - Minimal account shape needed by the cloaking pipeline. ## Properties @@ -18,52 +16,38 @@ Minimal account shape needed by the cloaking pipeline. > **id**: `string` -Defined in: [types/proxy.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L373) - --- ### type > **type**: `"api_key"` \| `"oauth"` -Defined in: [types/proxy.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L374) - --- ### status > **status**: `"healthy"` \| `"quota_exceeded"` \| `"error"` -Defined in: [types/proxy.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L375) - --- ### consecutiveFailures > **consecutiveFailures**: `number` -Defined in: [types/proxy.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L376) - --- ### requestCount > **requestCount**: `number` -Defined in: [types/proxy.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L377) - --- ### lastUsed > **lastUsed**: `number` -Defined in: [types/proxy.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L378) - --- ### apiKey? > `optional` **apiKey?**: `string` - -Defined in: [types/proxy.ts:379](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L379) diff --git a/docs/api/type-aliases/CloakingConfig.md b/docs/api/type-aliases/CloakingConfig.md index 18ddbfcde..ebae046d8 100644 --- a/docs/api/type-aliases/CloakingConfig.md +++ b/docs/api/type-aliases/CloakingConfig.md @@ -8,8 +8,6 @@ > **CloakingConfig** = `object` -Defined in: [types/subscription.ts:1259](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1259) - Cloaking plugin config ## Properties @@ -18,16 +16,12 @@ Cloaking plugin config > **mode**: `"auto"` \| `"always"` \| `"never"` -Defined in: [types/subscription.ts:1260](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1260) - --- ### plugins > **plugins**: `object` -Defined in: [types/subscription.ts:1261](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1261) - #### headerScrubber? > `optional` **headerScrubber?**: `boolean` diff --git a/docs/api/type-aliases/CloakingContext.md b/docs/api/type-aliases/CloakingContext.md index 6c09b0fbf..aeac788e1 100644 --- a/docs/api/type-aliases/CloakingContext.md +++ b/docs/api/type-aliases/CloakingContext.md @@ -8,8 +8,6 @@ > **CloakingContext** = `object` -Defined in: [types/proxy.ts:408](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L408) - Context passed through the cloaking pipeline. ## Properties @@ -18,24 +16,18 @@ Context passed through the cloaking pipeline. > **request**: [`CloakingRequest`](CloakingRequest.md) -Defined in: [types/proxy.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L409) - --- ### account > **account**: [`CloakingAccount`](CloakingAccount.md) -Defined in: [types/proxy.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L410) - --- ### config > **config**: `object` -Defined in: [types/proxy.ts:411](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L411) - #### mode > **mode**: [`CloakingMode`](CloakingMode.md) @@ -50,8 +42,6 @@ Defined in: [types/proxy.ts:411](https://github.com/juspay/neurolink/blob/releas > `optional` **response?**: `object` -Defined in: [types/proxy.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L415) - #### headers > **headers**: `Record`\<`string`, `string`\> diff --git a/docs/api/type-aliases/CloakingMode.md b/docs/api/type-aliases/CloakingMode.md index ea415f4b8..f8f03a3ce 100644 --- a/docs/api/type-aliases/CloakingMode.md +++ b/docs/api/type-aliases/CloakingMode.md @@ -8,6 +8,4 @@ > **CloakingMode** = `"auto"` \| `"always"` \| `"never"` -Defined in: [types/proxy.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L405) - Cloaking mode configuration. diff --git a/docs/api/type-aliases/CloakingPlugin.md b/docs/api/type-aliases/CloakingPlugin.md index b6bbfe700..eef94e322 100644 --- a/docs/api/type-aliases/CloakingPlugin.md +++ b/docs/api/type-aliases/CloakingPlugin.md @@ -8,8 +8,6 @@ > **CloakingPlugin** = `object` -Defined in: [types/proxy.ts:419](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L419) - Plugin interface for cloaking pipeline. ## Properties @@ -18,8 +16,6 @@ Plugin interface for cloaking pipeline. > **name**: `string` -Defined in: [types/proxy.ts:421](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L421) - Human-readable name for logging / debugging. --- @@ -28,8 +24,6 @@ Human-readable name for logging / debugging. > **order**: `number` -Defined in: [types/proxy.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L424) - Execution order -- lower numbers run first in processRequest. --- @@ -38,8 +32,6 @@ Execution order -- lower numbers run first in processRequest. > **enabled**: `boolean` -Defined in: [types/proxy.ts:427](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L427) - Whether this plugin is active. Disabled plugins are skipped. --- @@ -48,8 +40,6 @@ Whether this plugin is active. Disabled plugins are skipped. > **transformRequest**: (`ctx`) => `Promise`\<[`CloakingContext`](CloakingContext.md)\> -Defined in: [types/proxy.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L433) - Transform the outgoing request before it reaches the upstream API. Must return a (possibly mutated) context. @@ -69,8 +59,6 @@ Must return a (possibly mutated) context. > `optional` **transformResponse?**: (`ctx`) => `Promise`\<[`CloakingContext`](CloakingContext.md)\> -Defined in: [types/proxy.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L439) - Transform the incoming response before it reaches the client. Optional -- plugins that only touch requests can skip this. diff --git a/docs/api/type-aliases/CloakingRequest.md b/docs/api/type-aliases/CloakingRequest.md index 11f7c7b66..fe750873d 100644 --- a/docs/api/type-aliases/CloakingRequest.md +++ b/docs/api/type-aliases/CloakingRequest.md @@ -8,8 +8,6 @@ > **CloakingRequest** = `object` -Defined in: [types/proxy.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L383) - Request envelope for cloaking pipeline. ## Properties @@ -18,16 +16,12 @@ Request envelope for cloaking pipeline. > **headers**: `Record`\<`string`, `string` \| `undefined`\> -Defined in: [types/proxy.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L384) - --- ### body > **body**: `object` -Defined in: [types/proxy.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L385) - #### Index Signature \[`key`: `string`\]: `unknown` @@ -49,5 +43,3 @@ Defined in: [types/proxy.ts:385](https://github.com/juspay/neurolink/blob/releas ### url > **url**: `string` - -Defined in: [types/proxy.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L394) diff --git a/docs/api/type-aliases/CloakingResponse.md b/docs/api/type-aliases/CloakingResponse.md index bcc6ace8b..6abee84e8 100644 --- a/docs/api/type-aliases/CloakingResponse.md +++ b/docs/api/type-aliases/CloakingResponse.md @@ -8,8 +8,6 @@ > **CloakingResponse** = `object` -Defined in: [types/proxy.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L398) - Response envelope for cloaking pipeline. ## Properties @@ -18,20 +16,14 @@ Response envelope for cloaking pipeline. > **headers**: `Record`\<`string`, `string` \| `undefined`\> -Defined in: [types/proxy.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L399) - --- ### body > **body**: `Record`\<`string`, `unknown`\> -Defined in: [types/proxy.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L400) - --- ### status > **status**: `number` - -Defined in: [types/proxy.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L401) diff --git a/docs/api/type-aliases/CloseHandler.md b/docs/api/type-aliases/CloseHandler.md index 0947aaba8..443a69ef7 100644 --- a/docs/api/type-aliases/CloseHandler.md +++ b/docs/api/type-aliases/CloseHandler.md @@ -8,8 +8,6 @@ > **CloseHandler** = () => `void` -Defined in: [types/proxy.ts:2086](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2086) - Close handler for data stream writers. ## Returns diff --git a/docs/api/type-aliases/CobraInstance.md b/docs/api/type-aliases/CobraInstance.md index 895b50816..d869fa2ab 100644 --- a/docs/api/type-aliases/CobraInstance.md +++ b/docs/api/type-aliases/CobraInstance.md @@ -8,8 +8,6 @@ > **CobraInstance** = `object` -Defined in: [types/server.ts:1489](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1489) - Structural type for Picovoice Cobra VAD instance. Defined here so the optional `@picovoice/cobra-node` package is not required at typecheck time. @@ -20,16 +18,12 @@ is not required at typecheck time. > **frameLength**: `number` -Defined in: [types/server.ts:1490](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1490) - --- ### process > **process**: (`pcm`) => `number` -Defined in: [types/server.ts:1491](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1491) - #### Parameters ##### pcm @@ -46,8 +40,6 @@ Defined in: [types/server.ts:1491](https://github.com/juspay/neurolink/blob/rele > **release**: () => `void` -Defined in: [types/server.ts:1492](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1492) - #### Returns `void` diff --git a/docs/api/type-aliases/CodeLanguage.md b/docs/api/type-aliases/CodeLanguage.md index d1d9c91cd..dcef1b132 100644 --- a/docs/api/type-aliases/CodeLanguage.md +++ b/docs/api/type-aliases/CodeLanguage.md @@ -8,6 +8,4 @@ > **CodeLanguage** = `"javascript"` \| `"typescript"` \| `"python"` \| `"java"` \| `"c"` \| `"cpp"` \| `"csharp"` \| `"go"` \| `"rust"` \| `"sql"` \| `"bash"` \| `"any"` -Defined in: [types/scorer.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L517) - Code language types for the code-format validator. diff --git a/docs/api/type-aliases/CodexAttemptLogExtra.md b/docs/api/type-aliases/CodexAttemptLogExtra.md index 2520df356..3e2ad3a76 100644 --- a/docs/api/type-aliases/CodexAttemptLogExtra.md +++ b/docs/api/type-aliases/CodexAttemptLogExtra.md @@ -8,6 +8,4 @@ > **CodexAttemptLogExtra** = `Partial`\<`Pick`\<[`RequestAttemptLogEntry`](RequestAttemptLogEntry.md), `"inputTokens"` \| `"outputTokens"` \| `"cacheReadTokens"` \| `"cacheCreationTokens"` \| `"reasoningTokens"` \| `"inputIncludesCachedTokens"` \| `"errorType"` \| `"errorMessage"` \| `"errorCode"` \| `"transportScope"` \| `"retryable"` \| `"rateLimitKind"` \| `"cooldownReason"` \| `"quotaResetAt"` \| `"quotaScope"`\>\> -Defined in: [types/proxy.ts:1199](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1199) - Additional fields recorded for each upstream Codex account attempt. diff --git a/docs/api/type-aliases/CodexAuthFile.md b/docs/api/type-aliases/CodexAuthFile.md index 90d3fb946..beb3595da 100644 --- a/docs/api/type-aliases/CodexAuthFile.md +++ b/docs/api/type-aliases/CodexAuthFile.md @@ -8,8 +8,6 @@ > **CodexAuthFile** = `object` -Defined in: [types/codex.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L30) - Shape of `~/.codex/auth.json` written by the Codex CLI. ## Properties @@ -18,28 +16,20 @@ Shape of `~/.codex/auth.json` written by the Codex CLI. > `optional` **auth_mode?**: `string` -Defined in: [types/codex.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L31) - --- ### OPENAI_API_KEY? > `optional` **OPENAI_API_KEY?**: `string` \| `null` -Defined in: [types/codex.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L32) - --- ### tokens? > `optional` **tokens?**: [`CodexAuthFileTokens`](CodexAuthFileTokens.md) -Defined in: [types/codex.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L33) - --- ### last_refresh? > `optional` **last_refresh?**: `string` - -Defined in: [types/codex.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L34) diff --git a/docs/api/type-aliases/CodexAuthFileTokens.md b/docs/api/type-aliases/CodexAuthFileTokens.md index 6862c6046..acbc52df2 100644 --- a/docs/api/type-aliases/CodexAuthFileTokens.md +++ b/docs/api/type-aliases/CodexAuthFileTokens.md @@ -8,8 +8,6 @@ > **CodexAuthFileTokens** = `object` -Defined in: [types/codex.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L22) - Token block inside `~/.codex/auth.json`. ## Properties @@ -18,28 +16,20 @@ Token block inside `~/.codex/auth.json`. > `optional` **id_token?**: `string` -Defined in: [types/codex.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L23) - --- ### access_token > **access_token**: `string` -Defined in: [types/codex.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L24) - --- ### refresh_token? > `optional` **refresh_token?**: `string` -Defined in: [types/codex.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L25) - --- ### account_id? > `optional` **account_id?**: `string` - -Defined in: [types/codex.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L26) diff --git a/docs/api/type-aliases/CodexContentPart.md b/docs/api/type-aliases/CodexContentPart.md index 0b44c8fed..6b9d599b1 100644 --- a/docs/api/type-aliases/CodexContentPart.md +++ b/docs/api/type-aliases/CodexContentPart.md @@ -8,6 +8,4 @@ > **CodexContentPart** = \{ `type`: `"input_text"`; `text`: `string`; \} \| \{ `type`: `"output_text"`; `text`: `string`; \} \| \{ `type`: `"input_image"`; `image_url`: `string`; \} -Defined in: [types/codex.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L144) - A text or image content part accepted by the Codex Responses backend. diff --git a/docs/api/type-aliases/CodexFallbackResult.md b/docs/api/type-aliases/CodexFallbackResult.md index 205fbd0f0..4b5045f02 100644 --- a/docs/api/type-aliases/CodexFallbackResult.md +++ b/docs/api/type-aliases/CodexFallbackResult.md @@ -8,8 +8,6 @@ > **CodexFallbackResult** = `object` -Defined in: [types/codex.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L201) - Fully buffered Codex result rendered back as an Anthropic response. ## Properties @@ -18,24 +16,18 @@ Fully buffered Codex result rendered back as an Anthropic response. > **text**: `string` -Defined in: [types/codex.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L202) - --- ### toolCalls > **toolCalls**: `NonNullable`\<[`InternalResult`](InternalResult.md)\[`"toolCalls"`\]\> -Defined in: [types/codex.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L203) - --- ### usage? > `optional` **usage?**: `NonNullable`\<[`InternalResult`](InternalResult.md)\[`"usage"`\]\> & `object` -Defined in: [types/codex.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L204) - #### Type Declaration ##### inputTokensObserved? @@ -61,5 +53,3 @@ Numeric serializer compatibility must not imply provider observation. ### finishReason > **finishReason**: `"end_turn"` \| `"tool_use"` - -Defined in: [types/codex.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L211) diff --git a/docs/api/type-aliases/CodexFallbackStream.md b/docs/api/type-aliases/CodexFallbackStream.md index 1d9dc5f1e..939cab995 100644 --- a/docs/api/type-aliases/CodexFallbackStream.md +++ b/docs/api/type-aliases/CodexFallbackStream.md @@ -8,8 +8,6 @@ > **CodexFallbackStream** = `object` -Defined in: [types/codex.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L215) - Incremental Claude frames and explicit upstream cancellation. ## Properties @@ -18,16 +16,12 @@ Incremental Claude frames and explicit upstream cancellation. > **frames**: `AsyncGenerator`\<`string`, [`CodexFallbackResult`](CodexFallbackResult.md)\> -Defined in: [types/codex.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L216) - --- ### cancel > **cancel**: (`reason?`) => `Promise`\<`void`\> -Defined in: [types/codex.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L217) - #### Parameters ##### reason? diff --git a/docs/api/type-aliases/CodexFinalLogExtra.md b/docs/api/type-aliases/CodexFinalLogExtra.md index 467417b9f..817090fe3 100644 --- a/docs/api/type-aliases/CodexFinalLogExtra.md +++ b/docs/api/type-aliases/CodexFinalLogExtra.md @@ -8,6 +8,4 @@ > **CodexFinalLogExtra** = `Partial`\<`Pick`\<[`RequestLogEntry`](RequestLogEntry.md), `"errorType"` \| `"errorMessage"` \| `"errorCode"` \| `"transportScope"` \| `"inputTokens"` \| `"outputTokens"` \| `"cacheReadTokens"` \| `"cacheCreationTokens"` \| `"reasoningTokens"` \| `"terminalOutcome"` \| `"firstUsefulOutputMs"` \| `"firstUsefulOutputStatus"` \| `"firstUsefulOutputEvent"` \| `"retryable"`\>\> -Defined in: [types/proxy.ts:1178](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1178) - Additional fields recorded when a Codex response becomes client-final. diff --git a/docs/api/type-aliases/CodexImportedCredential.md b/docs/api/type-aliases/CodexImportedCredential.md index 61c46470c..9a0c3ba5b 100644 --- a/docs/api/type-aliases/CodexImportedCredential.md +++ b/docs/api/type-aliases/CodexImportedCredential.md @@ -8,8 +8,6 @@ > **CodexImportedCredential** = `object` -Defined in: [types/codex.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L38) - Result of importing a Codex credential (from auth.json or the OAuth flow). ## Properties @@ -18,32 +16,24 @@ Result of importing a Codex credential (from auth.json or the OAuth flow). > **accessToken**: `string` -Defined in: [types/codex.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L39) - --- ### refreshToken? > `optional` **refreshToken?**: `string` -Defined in: [types/codex.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L40) - --- ### idToken? > `optional` **idToken?**: `string` -Defined in: [types/codex.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L41) - --- ### accountId? > `optional` **accountId?**: `string` -Defined in: [types/codex.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L43) - ChatGPT account id (from auth.json or decoded from the access token). --- @@ -52,8 +42,6 @@ ChatGPT account id (from auth.json or decoded from the access token). > `optional` **expiresAt?**: `number` -Defined in: [types/codex.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L45) - Epoch ms when the access token expires (decoded from the JWT `exp`). --- @@ -62,8 +50,6 @@ Epoch ms when the access token expires (decoded from the JWT `exp`). > `optional` **planType?**: `string` -Defined in: [types/codex.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L47) - ChatGPT plan type decoded from the token, for display only. --- @@ -72,6 +58,4 @@ ChatGPT plan type decoded from the token, for display only. > `optional` **email?**: `string` -Defined in: [types/codex.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L49) - Account email decoded from the id token, for the account label. diff --git a/docs/api/type-aliases/CodexProxyStatusAccountIdentity.md b/docs/api/type-aliases/CodexProxyStatusAccountIdentity.md index cee18457c..3cb34612d 100644 --- a/docs/api/type-aliases/CodexProxyStatusAccountIdentity.md +++ b/docs/api/type-aliases/CodexProxyStatusAccountIdentity.md @@ -8,6 +8,4 @@ > **CodexProxyStatusAccountIdentity** = \{ `provider`: `"anthropic"`; `key`: `string`; \} \| \{ `provider`: `"codex"`; `key`: `string`; \} \| \{ `provider`: `"vertex"`; `key`: `string`; \} \| \{ `provider`: `"other"`; `key`: `null`; \} -Defined in: [types/codex.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L137) - Provider-qualified account identity used by proxy status rendering. diff --git a/docs/api/type-aliases/CodexQuotaError.md b/docs/api/type-aliases/CodexQuotaError.md index 1df426763..472a47136 100644 --- a/docs/api/type-aliases/CodexQuotaError.md +++ b/docs/api/type-aliases/CodexQuotaError.md @@ -8,8 +8,6 @@ > **CodexQuotaError** = `object` -Defined in: [types/codex.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L113) - Explicit plan-exhaustion evidence from a Codex error response. ## Properties @@ -18,20 +16,14 @@ Explicit plan-exhaustion evidence from a Codex error response. > **errorCode**: `string` -Defined in: [types/codex.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L114) - --- ### resetAt > **resetAt**: `number` -Defined in: [types/codex.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L115) - --- ### scope > **scope**: `"session"` \| `"weekly"` \| `"unknown"` - -Defined in: [types/codex.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L116) diff --git a/docs/api/type-aliases/CodexRateLimitWindow.md b/docs/api/type-aliases/CodexRateLimitWindow.md index 9e7ce56b7..ad19f140f 100644 --- a/docs/api/type-aliases/CodexRateLimitWindow.md +++ b/docs/api/type-aliases/CodexRateLimitWindow.md @@ -8,8 +8,6 @@ > **CodexRateLimitWindow** = `object` -Defined in: [types/codex.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L62) - One rate-limit window as reported by the Codex backend (primary/secondary). ## Properties @@ -18,32 +16,24 @@ One rate-limit window as reported by the Codex backend (primary/secondary). > `optional` **used_percent?**: `number` \| `null` -Defined in: [types/codex.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L63) - --- ### window_minutes? > `optional` **window_minutes?**: `number` \| `null` -Defined in: [types/codex.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L64) - --- ### resets_in_seconds? > `optional` **resets_in_seconds?**: `number` \| `null` -Defined in: [types/codex.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L65) - --- ### reset_after? > `optional` **reset_after?**: `number` \| `null` -Defined in: [types/codex.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L69) - Seconds until reset. Observed alias of `resets_in_seconds` on some responses; accepted defensively so a cooldown lands on the real reset instead of degrading to the transient ceiling. @@ -54,16 +44,12 @@ instead of degrading to the transient ceiling. > `optional` **resets_at?**: `number` \| `null` -Defined in: [types/codex.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L70) - --- ### reset_after_seconds? > `optional` **reset_after_seconds?**: `number` \| `null` -Defined in: [types/codex.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L72) - Current WHAM usage fields. --- @@ -71,5 +57,3 @@ Current WHAM usage fields. ### reset_at? > `optional` **reset_at?**: `number` \| `null` - -Defined in: [types/codex.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L73) diff --git a/docs/api/type-aliases/CodexRateLimits.md b/docs/api/type-aliases/CodexRateLimits.md index 93f397a4b..93d3b7dc6 100644 --- a/docs/api/type-aliases/CodexRateLimits.md +++ b/docs/api/type-aliases/CodexRateLimits.md @@ -8,8 +8,6 @@ > **CodexRateLimits** = `object` -Defined in: [types/codex.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L77) - Codex rate-limit block: a primary (short) and secondary (long) window. ## Properties @@ -18,28 +16,20 @@ Codex rate-limit block: a primary (short) and secondary (long) window. > `optional` **allowed?**: `boolean` -Defined in: [types/codex.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L78) - --- ### limit_reached? > `optional` **limit_reached?**: `boolean` -Defined in: [types/codex.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L79) - --- ### primary? > `optional` **primary?**: [`CodexRateLimitWindow`](CodexRateLimitWindow.md) \| `null` -Defined in: [types/codex.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L80) - --- ### secondary? > `optional` **secondary?**: [`CodexRateLimitWindow`](CodexRateLimitWindow.md) \| `null` - -Defined in: [types/codex.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L81) diff --git a/docs/api/type-aliases/CodexReasoningEffort.md b/docs/api/type-aliases/CodexReasoningEffort.md index eff12f0a7..9bc4ff57d 100644 --- a/docs/api/type-aliases/CodexReasoningEffort.md +++ b/docs/api/type-aliases/CodexReasoningEffort.md @@ -8,6 +8,4 @@ > **CodexReasoningEffort** = `"none"` \| `"minimal"` \| `"low"` \| `"medium"` \| `"high"` \| `"xhigh"` \| `"max"` -Defined in: [types/codex.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L168) - Codex reasoning settings; supported levels depend on the selected model. diff --git a/docs/api/type-aliases/CodexRefreshTokenStore.md b/docs/api/type-aliases/CodexRefreshTokenStore.md index 856affe57..c08412bd2 100644 --- a/docs/api/type-aliases/CodexRefreshTokenStore.md +++ b/docs/api/type-aliases/CodexRefreshTokenStore.md @@ -8,8 +8,6 @@ > **CodexRefreshTokenStore** = `object` -Defined in: [types/proxy.ts:1221](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1221) - Minimal persistence contract needed by Codex rotating-token refreshes. ## Methods @@ -18,8 +16,6 @@ Minimal persistence contract needed by Codex rotating-token refreshes. > **peekTokens**(`provider`): `Promise`\<[`StoredOAuthTokens`](StoredOAuthTokens.md) \| `null`\> -Defined in: [types/proxy.ts:1222](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1222) - #### Parameters ##### provider @@ -36,8 +32,6 @@ Defined in: [types/proxy.ts:1222](https://github.com/juspay/neurolink/blob/relea > **saveTokens**(`provider`, `tokens`): `Promise`\<`void`\> -Defined in: [types/proxy.ts:1223](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1223) - #### Parameters ##### provider diff --git a/docs/api/type-aliases/CodexResponsesInputItem.md b/docs/api/type-aliases/CodexResponsesInputItem.md index c585d3155..3559e8770 100644 --- a/docs/api/type-aliases/CodexResponsesInputItem.md +++ b/docs/api/type-aliases/CodexResponsesInputItem.md @@ -8,6 +8,4 @@ > **CodexResponsesInputItem** = \{ `role`: `"user"` \| `"assistant"`; `content`: [`CodexContentPart`](CodexContentPart.md)[]; \} \| \{ `type`: `"function_call"`; `call_id`: `string`; `name`: `string`; `arguments`: `string`; \} \| \{ `type`: `"function_call_output"`; `call_id`: `string`; `output`: `string`; \} -Defined in: [types/codex.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L150) - A single item in a Codex Responses request. diff --git a/docs/api/type-aliases/CodexResponsesRequest.md b/docs/api/type-aliases/CodexResponsesRequest.md index 365d83348..e43d68974 100644 --- a/docs/api/type-aliases/CodexResponsesRequest.md +++ b/docs/api/type-aliases/CodexResponsesRequest.md @@ -8,8 +8,6 @@ > **CodexResponsesRequest** = `object` -Defined in: [types/codex.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L178) - Request shape used to bridge Anthropic Messages traffic to Codex Responses. ## Properties @@ -18,40 +16,30 @@ Request shape used to bridge Anthropic Messages traffic to Codex Responses. > **model**: `string` -Defined in: [types/codex.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L179) - --- ### input > **input**: [`CodexResponsesInputItem`](CodexResponsesInputItem.md)[] -Defined in: [types/codex.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L180) - --- ### stream > **stream**: `true` -Defined in: [types/codex.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L181) - --- ### store > **store**: `false` -Defined in: [types/codex.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L182) - --- ### prompt_cache_key? > `optional` **prompt_cache_key?**: `string` -Defined in: [types/codex.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L184) - Pins one conversation to the cache that already holds its prefix. --- @@ -60,8 +48,6 @@ Pins one conversation to the cache that already holds its prefix. > `optional` **reasoning?**: `object` -Defined in: [types/codex.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L185) - #### effort > **effort**: [`CodexReasoningEffort`](CodexReasoningEffort.md) @@ -72,16 +58,12 @@ Defined in: [types/codex.ts:185](https://github.com/juspay/neurolink/blob/releas > `optional` **instructions?**: `string` -Defined in: [types/codex.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L186) - --- ### tools? > `optional` **tools?**: `object`[] -Defined in: [types/codex.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L187) - #### type > **type**: `"function"` @@ -103,5 +85,3 @@ Defined in: [types/codex.ts:187](https://github.com/juspay/neurolink/blob/releas ### tool_choice? > `optional` **tool_choice?**: `"auto"` \| `"required"` \| `"none"` \| \{ `type`: `"function"`; `name`: `string`; \} - -Defined in: [types/codex.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L193) diff --git a/docs/api/type-aliases/CodexRuntimeAccount.md b/docs/api/type-aliases/CodexRuntimeAccount.md index a03a21928..a0dd379be 100644 --- a/docs/api/type-aliases/CodexRuntimeAccount.md +++ b/docs/api/type-aliases/CodexRuntimeAccount.md @@ -8,8 +8,6 @@ > **CodexRuntimeAccount** = `object` -Defined in: [types/codex.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L120) - A Codex account with its runtime cooldown/quota state hydrated from disk. ## Properties @@ -18,80 +16,60 @@ A Codex account with its runtime cooldown/quota state hydrated from disk. > **key**: `string` -Defined in: [types/codex.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L121) - --- ### label > **label**: `string` -Defined in: [types/codex.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L122) - --- ### token > **token**: `string` -Defined in: [types/codex.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L123) - --- ### refreshToken? > `optional` **refreshToken?**: `string` -Defined in: [types/codex.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L124) - --- ### expiresAt? > `optional` **expiresAt?**: `number` -Defined in: [types/codex.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L125) - --- ### accountId? > `optional` **accountId?**: `string` -Defined in: [types/codex.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L126) - --- ### quota? > `optional` **quota?**: [`AccountQuota`](AccountQuota.md) -Defined in: [types/codex.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L127) - --- ### coolingUntil? > `optional` **coolingUntil?**: `number` -Defined in: [types/codex.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L128) - --- ### coolingReason? > `optional` **coolingReason?**: [`AccountCoolingReason`](AccountCoolingReason.md) -Defined in: [types/codex.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L129) - --- ### expiredCooldownUntil? > `optional` **expiredCooldownUntil?**: `number` -Defined in: [types/codex.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L133) - A persisted cooldown whose window has already passed. Present only when the account is therefore eligible again, so the success path can delete the spent record — nothing else ever reaps it. diff --git a/docs/api/type-aliases/CodexStreamEvidence.md b/docs/api/type-aliases/CodexStreamEvidence.md index 3b8273632..1a4fa90c0 100644 --- a/docs/api/type-aliases/CodexStreamEvidence.md +++ b/docs/api/type-aliases/CodexStreamEvidence.md @@ -8,8 +8,6 @@ > **CodexStreamEvidence** = `object` -Defined in: [types/proxy.ts:2798](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2798) - Semantic completion evidence observed in native Codex SSE bytes. ## Properties @@ -18,24 +16,18 @@ Semantic completion evidence observed in native Codex SSE bytes. > **completed**: `boolean` -Defined in: [types/proxy.ts:2799](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2799) - --- ### terminalBytes > **terminalBytes**: `number` -Defined in: [types/proxy.ts:2800](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2800) - --- ### observationIncomplete? > `optional` **observationIncomplete?**: `boolean` -Defined in: [types/proxy.ts:2802](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2802) - Malformed, oversized or undispatched frames prevent proving output absence. --- @@ -44,36 +36,26 @@ Malformed, oversized or undispatched frames prevent proving output absence. > `optional` **firstUsefulOutputAt?**: `number` -Defined in: [types/proxy.ts:2803](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2803) - --- ### firstUsefulOutputEvent? > `optional` **firstUsefulOutputEvent?**: `string` -Defined in: [types/proxy.ts:2804](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2804) - --- ### errorType? > `optional` **errorType?**: `string` -Defined in: [types/proxy.ts:2805](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2805) - --- ### errorMessage? > `optional` **errorMessage?**: `string` -Defined in: [types/proxy.ts:2806](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2806) - --- ### errorCode? > `optional` **errorCode?**: `string` - -Defined in: [types/proxy.ts:2807](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2807) diff --git a/docs/api/type-aliases/CodexStreamUsage.md b/docs/api/type-aliases/CodexStreamUsage.md index 1a3f2ec43..2b186726f 100644 --- a/docs/api/type-aliases/CodexStreamUsage.md +++ b/docs/api/type-aliases/CodexStreamUsage.md @@ -8,8 +8,6 @@ > **CodexStreamUsage** = `object` -Defined in: [types/proxy.ts:2767](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2767) - Token usage scraped from a Codex (OpenAI Responses) SSE stream. Verified against real traffic: captured from a live `codex exec` run through @@ -25,8 +23,6 @@ a null result as "not observed", never as "zero tokens". > `optional` **inputTokensObserved?**: `boolean` -Defined in: [types/proxy.ts:2769](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2769) - Distinguish missing provider usage from a reported zero. --- @@ -35,40 +31,30 @@ Distinguish missing provider usage from a reported zero. > `optional` **outputTokensObserved?**: `boolean` -Defined in: [types/proxy.ts:2770](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2770) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/proxy.ts:2771](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2771) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/proxy.ts:2772](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2772) - --- ### cacheReadTokens > **cacheReadTokens**: `number` -Defined in: [types/proxy.ts:2773](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2773) - --- ### cacheCreationTokens > **cacheCreationTokens**: `number` -Defined in: [types/proxy.ts:2775](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2775) - Cache writes, which bill at a premium over both reads and plain input. --- @@ -77,8 +63,6 @@ Cache writes, which bill at a premium over both reads and plain input. > `optional` **cacheReadTokensObserved?**: `boolean` -Defined in: [types/proxy.ts:2790](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2790) - Whether the provider supplied each cache count, tracked per field. Without this a reply that omits `input_tokens_details` is recorded as a @@ -98,22 +82,16 @@ zero, which is indistinguishable from a genuine zero once recorded. > `optional` **cacheCreationTokensObserved?**: `boolean` -Defined in: [types/proxy.ts:2791](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2791) - --- ### reasoningTokens > **reasoningTokens**: `number` -Defined in: [types/proxy.ts:2792](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2792) - --- ### reasoningTokensObserved? > `optional` **reasoningTokensObserved?**: `boolean` -Defined in: [types/proxy.ts:2794](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2794) - Whether the provider supplied a valid reasoning breakdown. diff --git a/docs/api/type-aliases/CodexTokenRefresher.md b/docs/api/type-aliases/CodexTokenRefresher.md index cd29ca688..c96b4d40d 100644 --- a/docs/api/type-aliases/CodexTokenRefresher.md +++ b/docs/api/type-aliases/CodexTokenRefresher.md @@ -8,8 +8,6 @@ > **CodexTokenRefresher** = (`refreshToken`) => `Promise`\<\{ `accessToken`: `string`; `refreshToken?`: `string`; `expiresAt?`: `number`; \}\> -Defined in: [types/proxy.ts:1227](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1227) - Result contract for a Codex OAuth refresh operation. ## Parameters diff --git a/docs/api/type-aliases/CodexTokenResponse.md b/docs/api/type-aliases/CodexTokenResponse.md index cd4589197..8aa3948a0 100644 --- a/docs/api/type-aliases/CodexTokenResponse.md +++ b/docs/api/type-aliases/CodexTokenResponse.md @@ -8,8 +8,6 @@ > **CodexTokenResponse** = `object` -Defined in: [types/codex.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L53) - Raw OpenAI OAuth token endpoint response. ## Properties @@ -18,36 +16,26 @@ Raw OpenAI OAuth token endpoint response. > `optional` **access_token?**: `string` -Defined in: [types/codex.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L54) - --- ### refresh_token? > `optional` **refresh_token?**: `string` -Defined in: [types/codex.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L55) - --- ### id_token? > `optional` **id_token?**: `string` -Defined in: [types/codex.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L56) - --- ### token_type? > `optional` **token_type?**: `string` -Defined in: [types/codex.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L57) - --- ### expires_in? > `optional` **expires_in?**: `number` - -Defined in: [types/codex.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L58) diff --git a/docs/api/type-aliases/CodexUsageFetchResult.md b/docs/api/type-aliases/CodexUsageFetchResult.md index 9bb721472..3fc4d166b 100644 --- a/docs/api/type-aliases/CodexUsageFetchResult.md +++ b/docs/api/type-aliases/CodexUsageFetchResult.md @@ -8,6 +8,4 @@ > **CodexUsageFetchResult** = \{ `ok`: `true`; `quota`: [`AccountQuota`](AccountQuota.md); \} \| \{ `ok`: `false`; `reason`: `"not_oauth"` \| `"auth"` \| `"rate_limited"` \| `"http"` \| `"network"` \| `"parse"`; \} -Defined in: [types/codex.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L99) - Result of a single Codex usage fetch. diff --git a/docs/api/type-aliases/CodexUsageResponse.md b/docs/api/type-aliases/CodexUsageResponse.md index 41693abe4..036e74824 100644 --- a/docs/api/type-aliases/CodexUsageResponse.md +++ b/docs/api/type-aliases/CodexUsageResponse.md @@ -8,8 +8,6 @@ > **CodexUsageResponse** = `object` -Defined in: [types/codex.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L85) - Loose shape of the Codex usage endpoint response. ## Properties @@ -18,8 +16,6 @@ Loose shape of the Codex usage endpoint response. > `optional` **rate_limits?**: [`CodexRateLimits`](CodexRateLimits.md) \| `null` -Defined in: [types/codex.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L87) - Legacy Codex usage payload. --- @@ -28,8 +24,6 @@ Legacy Codex usage payload. > `optional` **rate_limit?**: \{ `allowed?`: `boolean`; `limit_reached?`: `boolean`; `primary_window?`: [`CodexRateLimitWindow`](CodexRateLimitWindow.md) \| `null`; `secondary_window?`: [`CodexRateLimitWindow`](CodexRateLimitWindow.md) \| `null`; \} \| `null` -Defined in: [types/codex.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L89) - Current ChatGPT WHAM account-usage payload. --- @@ -37,5 +31,3 @@ Current ChatGPT WHAM account-usage payload. ### plan_type? > `optional` **plan_type?**: `string` \| `null` - -Defined in: [types/codex.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/codex.ts#L95) diff --git a/docs/api/type-aliases/CognitoConfig.md b/docs/api/type-aliases/CognitoConfig.md index b02baa186..ef288d1f1 100644 --- a/docs/api/type-aliases/CognitoConfig.md +++ b/docs/api/type-aliases/CognitoConfig.md @@ -8,8 +8,6 @@ > **CognitoConfig** = `object` -Defined in: [types/auth.ts:725](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L725) - AWS Cognito provider configuration ## Properties @@ -18,8 +16,6 @@ AWS Cognito provider configuration > **userPoolId**: `string` -Defined in: [types/auth.ts:727](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L727) - Cognito user pool ID --- @@ -28,8 +24,6 @@ Cognito user pool ID > **clientId**: `string` -Defined in: [types/auth.ts:729](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L729) - Cognito client ID --- @@ -38,8 +32,6 @@ Cognito client ID > `optional` **clientSecret?**: `string` -Defined in: [types/auth.ts:731](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L731) - Cognito client secret --- @@ -48,8 +40,6 @@ Cognito client secret > **region**: `string` -Defined in: [types/auth.ts:733](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L733) - AWS region --- @@ -58,6 +48,4 @@ AWS region > `optional` **customAttributes?**: `string`[] -Defined in: [types/auth.ts:735](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L735) - Custom attributes to extract as claims diff --git a/docs/api/type-aliases/CollectedChunkResult.md b/docs/api/type-aliases/CollectedChunkResult.md index 247b40f74..dd56a1dfa 100644 --- a/docs/api/type-aliases/CollectedChunkResult.md +++ b/docs/api/type-aliases/CollectedChunkResult.md @@ -8,32 +8,24 @@ > **CollectedChunkResult** = `object` -Defined in: [types/providers.ts:2158](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2158) - ## Properties ### rawResponseParts > **rawResponseParts**: `unknown`[] -Defined in: [types/providers.ts:2159](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2159) - --- ### stepFunctionCalls > **stepFunctionCalls**: [`NativeFunctionCall`](NativeFunctionCall.md)[] -Defined in: [types/providers.ts:2160](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2160) - --- ### finishReason? > `optional` **finishReason?**: `string` -Defined in: [types/providers.ts:2162](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2162) - Raw `Candidate.finishReason` from the last chunk that carried one. --- @@ -42,24 +34,18 @@ Raw `Candidate.finishReason` from the last chunk that carried one. > **inputTokens**: `number` -Defined in: [types/providers.ts:2163](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2163) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/providers.ts:2164](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2164) - --- ### cacheReadTokens? > `optional` **cacheReadTokens?**: `number` -Defined in: [types/providers.ts:2170](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2170) - Gemini cached-content tokens (overlapping: included in promptTokenCount). Surfaced so the call site can subtract from input and bill at cacheRead rate. Subtraction happens at the call site, not in the collector. @@ -70,8 +56,6 @@ rate. Subtraction happens at the call site, not in the collector. > `optional` **cacheCreationTokens?**: `number` -Defined in: [types/providers.ts:2172](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2172) - Cache creation tokens (symmetry; Gemini does not emit this). --- @@ -80,8 +64,6 @@ Cache creation tokens (symmetry; Gemini does not emit this). > `optional` **reasoningTokens?**: `number` -Defined in: [types/providers.ts:2178](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2178) - Gemini thinking tokens (usageMetadata.thoughtsTokenCount). Billed at the output rate but NOT included in candidatesTokenCount — Gemini reports totalTokenCount = prompt + candidates + thoughts. diff --git a/docs/api/type-aliases/ColorMap.md b/docs/api/type-aliases/ColorMap.md index 53ec929f8..2f910bfc8 100644 --- a/docs/api/type-aliases/ColorMap.md +++ b/docs/api/type-aliases/ColorMap.md @@ -8,8 +8,6 @@ > **ColorMap** = `object` -Defined in: [types/cli.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L528) - Color mapping for CLI output ## Index Signature diff --git a/docs/api/type-aliases/ColumnData.md b/docs/api/type-aliases/ColumnData.md index 3ba717b2d..807cb7c44 100644 --- a/docs/api/type-aliases/ColumnData.md +++ b/docs/api/type-aliases/ColumnData.md @@ -8,8 +8,6 @@ > **ColumnData** = `object` -Defined in: [types/ppt.ts:1303](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1303) - Column data structure for generic column rendering ## Properties @@ -18,20 +16,14 @@ Column data structure for generic column rendering > `optional` **title?**: `string` -Defined in: [types/ppt.ts:1304](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1304) - --- ### bullets? > `optional` **bullets?**: [`BulletPoint`](BulletPoint.md)[] -Defined in: [types/ppt.ts:1305](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1305) - --- ### image? > `optional` **image?**: `string` - -Defined in: [types/ppt.ts:1306](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1306) diff --git a/docs/api/type-aliases/CommandDefinition.md b/docs/api/type-aliases/CommandDefinition.md index b38301dad..dc0914875 100644 --- a/docs/api/type-aliases/CommandDefinition.md +++ b/docs/api/type-aliases/CommandDefinition.md @@ -8,8 +8,6 @@ > **CommandDefinition**\<`TArgs`\> = `object` -Defined in: [types/cli.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L500) - Command definition ## Type Parameters @@ -24,36 +22,26 @@ Command definition > **name**: `string` -Defined in: [types/cli.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L501) - --- ### description > **description**: `string` -Defined in: [types/cli.ts:502](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L502) - --- ### aliases? > `optional` **aliases?**: `string`[] -Defined in: [types/cli.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L503) - --- ### args? > `optional` **args?**: \{ \[K in keyof TArgs\]: \{ type: "string" \| "number" \| "boolean"; description: string; required?: boolean; default?: TArgs\[K\] \} \} -Defined in: [types/cli.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L504) - --- ### handler > **handler**: [`CommandHandler`](CommandHandler.md)\<`TArgs`\> - -Defined in: [types/cli.ts:512](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L512) diff --git a/docs/api/type-aliases/CommandHandler.md b/docs/api/type-aliases/CommandHandler.md index e3c9dde65..5b1a8ea67 100644 --- a/docs/api/type-aliases/CommandHandler.md +++ b/docs/api/type-aliases/CommandHandler.md @@ -8,8 +8,6 @@ > **CommandHandler**\<`TArgs`, `TResult`\> = (`args`) => `Promise`\<`TResult`\> -Defined in: [types/cli.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L493) - Command handler function type ## Type Parameters diff --git a/docs/api/type-aliases/CommandResult.md b/docs/api/type-aliases/CommandResult.md index c7bbb288d..e7eb6ef0a 100644 --- a/docs/api/type-aliases/CommandResult.md +++ b/docs/api/type-aliases/CommandResult.md @@ -8,8 +8,6 @@ > **CommandResult** = `object` -Defined in: [types/cli.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L410) - CLI command result ## Properties @@ -18,8 +16,6 @@ CLI command result > **success**: `boolean` -Defined in: [types/cli.ts:412](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L412) - Command success status --- @@ -28,8 +24,6 @@ Command success status > `optional` **data?**: `unknown` -Defined in: [types/cli.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L414) - Result data --- @@ -38,8 +32,6 @@ Result data > `optional` **error?**: `string` -Defined in: [types/cli.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L416) - Error message if failed --- @@ -48,8 +40,6 @@ Error message if failed > `optional` **content?**: `string` -Defined in: [types/cli.ts:418](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L418) - Output content --- @@ -58,8 +48,6 @@ Output content > `optional` **metadata?**: `object` -Defined in: [types/cli.ts:420](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L420) - Execution metadata #### executionTime? diff --git a/docs/api/type-aliases/CompactionConfig.md b/docs/api/type-aliases/CompactionConfig.md index 704b1ec29..240ad805d 100644 --- a/docs/api/type-aliases/CompactionConfig.md +++ b/docs/api/type-aliases/CompactionConfig.md @@ -8,8 +8,6 @@ > **CompactionConfig** = `object` -Defined in: [types/context.ts:625](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L625) - Configuration for the context compaction pipeline. ## Properties @@ -18,92 +16,68 @@ Configuration for the context compaction pipeline. > `optional` **enablePrune?**: `boolean` -Defined in: [types/context.ts:626](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L626) - --- ### enableDeduplicate? > `optional` **enableDeduplicate?**: `boolean` -Defined in: [types/context.ts:627](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L627) - --- ### enableSummarize? > `optional` **enableSummarize?**: `boolean` -Defined in: [types/context.ts:628](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L628) - --- ### enableTruncate? > `optional` **enableTruncate?**: `boolean` -Defined in: [types/context.ts:629](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L629) - --- ### pruneProtectTokens? > `optional` **pruneProtectTokens?**: `number` -Defined in: [types/context.ts:630](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L630) - --- ### pruneMinimumSavings? > `optional` **pruneMinimumSavings?**: `number` -Defined in: [types/context.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L631) - --- ### pruneProtectedTools? > `optional` **pruneProtectedTools?**: `string`[] -Defined in: [types/context.ts:632](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L632) - --- ### summarizationProvider? > `optional` **summarizationProvider?**: `string` -Defined in: [types/context.ts:633](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L633) - --- ### summarizationModel? > `optional` **summarizationModel?**: `string` -Defined in: [types/context.ts:634](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L634) - --- ### keepRecentRatio? > `optional` **keepRecentRatio?**: `number` -Defined in: [types/context.ts:635](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L635) - --- ### truncationFraction? > `optional` **truncationFraction?**: `number` -Defined in: [types/context.ts:636](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L636) - --- ### provider? > `optional` **provider?**: `string` - -Defined in: [types/context.ts:637](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L637) diff --git a/docs/api/type-aliases/CompactionResult.md b/docs/api/type-aliases/CompactionResult.md index 9ac9543b4..69e35017b 100644 --- a/docs/api/type-aliases/CompactionResult.md +++ b/docs/api/type-aliases/CompactionResult.md @@ -8,8 +8,6 @@ > **CompactionResult** = `object` -Defined in: [types/context.ts:615](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L615) - Result of multi-stage context compaction. ## Properties @@ -18,44 +16,32 @@ Result of multi-stage context compaction. > **compacted**: `boolean` -Defined in: [types/context.ts:616](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L616) - --- ### stagesUsed > **stagesUsed**: [`CompactionStage`](CompactionStage.md)[] -Defined in: [types/context.ts:617](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L617) - --- ### tokensBefore > **tokensBefore**: `number` -Defined in: [types/context.ts:618](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L618) - --- ### tokensAfter > **tokensAfter**: `number` -Defined in: [types/context.ts:619](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L619) - --- ### tokensSaved > **tokensSaved**: `number` -Defined in: [types/context.ts:620](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L620) - --- ### messages > **messages**: [`ChatMessage`](ChatMessage.md)[] - -Defined in: [types/context.ts:621](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L621) diff --git a/docs/api/type-aliases/CompactionStage.md b/docs/api/type-aliases/CompactionStage.md index ac44505d1..21e8f02a6 100644 --- a/docs/api/type-aliases/CompactionStage.md +++ b/docs/api/type-aliases/CompactionStage.md @@ -8,6 +8,4 @@ > **CompactionStage** = `"relevance"` \| `"prune"` \| `"deduplicate"` \| `"summarize"` \| `"truncate"` -Defined in: [types/context.ts:607](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L607) - Stages available in the compaction pipeline. diff --git a/docs/api/type-aliases/CompareProxyReplayOptions.md b/docs/api/type-aliases/CompareProxyReplayOptions.md index 789b8f8d7..c48587bfb 100644 --- a/docs/api/type-aliases/CompareProxyReplayOptions.md +++ b/docs/api/type-aliases/CompareProxyReplayOptions.md @@ -8,8 +8,6 @@ > **CompareProxyReplayOptions** = `object` -Defined in: [types/proxy.ts:3020](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3020) - Inputs for an explicitly authorized direct-upstream comparison. ## Properties @@ -18,48 +16,36 @@ Inputs for an explicitly authorized direct-upstream comparison. > **execute**: `boolean` -Defined in: [types/proxy.ts:3021](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3021) - --- ### headerValues? > `optional` **headerValues?**: `Record`\<`string`, `string`\> -Defined in: [types/proxy.ts:3022](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3022) - --- ### bodyOverride? > `optional` **bodyOverride?**: `string` -Defined in: [types/proxy.ts:3023](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3023) - --- ### urlOverride? > `optional` **urlOverride?**: `string` -Defined in: [types/proxy.ts:3024](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3024) - --- ### timeoutMs? > `optional` **timeoutMs?**: `number` -Defined in: [types/proxy.ts:3025](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3025) - --- ### now? > `optional` **now?**: () => `number` -Defined in: [types/proxy.ts:3026](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3026) - #### Returns `number` @@ -69,5 +55,3 @@ Defined in: [types/proxy.ts:3026](https://github.com/juspay/neurolink/blob/relea ### fetchImpl? > `optional` **fetchImpl?**: _typeof_ `fetch` - -Defined in: [types/proxy.ts:3027](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3027) diff --git a/docs/api/type-aliases/ComparisonColumn.md b/docs/api/type-aliases/ComparisonColumn.md index 958e6ca2b..5a3a78a11 100644 --- a/docs/api/type-aliases/ComparisonColumn.md +++ b/docs/api/type-aliases/ComparisonColumn.md @@ -8,8 +8,6 @@ > **ComparisonColumn** = `object` -Defined in: [types/ppt.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L413) - Comparison column for comparison slides ## Properties @@ -18,22 +16,16 @@ Comparison column for comparison slides > **title**: `string` -Defined in: [types/ppt.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L414) - --- ### items > **items**: `string`[] -Defined in: [types/ppt.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L415) - --- ### highlight? > `optional` **highlight?**: `boolean` -Defined in: [types/ppt.ts:417](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L417) - Highlight color for this column (e.g., for the "better" option) diff --git a/docs/api/type-aliases/CompatibilityCheckResult.md b/docs/api/type-aliases/CompatibilityCheckResult.md index 3aec9f3fa..df3475f74 100644 --- a/docs/api/type-aliases/CompatibilityCheckResult.md +++ b/docs/api/type-aliases/CompatibilityCheckResult.md @@ -8,8 +8,6 @@ > **CompatibilityCheckResult** = `object` -Defined in: [types/mcp.ts:1523](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1523) - Tool compatibility check result ## Properties @@ -18,28 +16,20 @@ Tool compatibility check result > **compatible**: `boolean` -Defined in: [types/mcp.ts:1524](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1524) - --- ### issues > **issues**: `string`[] -Defined in: [types/mcp.ts:1525](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1525) - --- ### warnings > **warnings**: `string`[] -Defined in: [types/mcp.ts:1526](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1526) - --- ### recommendations > **recommendations**: `string`[] - -Defined in: [types/mcp.ts:1527](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1527) diff --git a/docs/api/type-aliases/CompleteSlide.md b/docs/api/type-aliases/CompleteSlide.md index bf139abaa..97512ed91 100644 --- a/docs/api/type-aliases/CompleteSlide.md +++ b/docs/api/type-aliases/CompleteSlide.md @@ -8,8 +8,6 @@ > **CompleteSlide** = `object` -Defined in: [types/ppt.ts:863](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L863) - A fully generated slide ready for assembly ## Properties @@ -18,32 +16,24 @@ A fully generated slide ready for assembly > **slideNumber**: `number` -Defined in: [types/ppt.ts:864](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L864) - --- ### schema > **schema**: [`SlideSchema`](SlideSchema.md) -Defined in: [types/ppt.ts:865](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L865) - --- ### imageBuffer? > `optional` **imageBuffer?**: `Buffer` -Defined in: [types/ppt.ts:866](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L866) - --- ### imageMetadata? > `optional` **imageMetadata?**: `object` -Defined in: [types/ppt.ts:867](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L867) - #### prompt > **prompt**: `string` @@ -61,5 +51,3 @@ Defined in: [types/ppt.ts:867](https://github.com/juspay/neurolink/blob/release/ ### generationTime > **generationTime**: `number` - -Defined in: [types/ppt.ts:872](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L872) diff --git a/docs/api/type-aliases/CompressionOptions.md b/docs/api/type-aliases/CompressionOptions.md index 5ceb3962c..48e5292d0 100644 --- a/docs/api/type-aliases/CompressionOptions.md +++ b/docs/api/type-aliases/CompressionOptions.md @@ -8,8 +8,6 @@ > **CompressionOptions** = `object` -Defined in: [types/multimodal.ts:782](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L782) - Options consumed by compressImage(). ## Properties @@ -18,28 +16,20 @@ Options consumed by compressImage(). > **provider**: [`ProviderName`](ProviderName.md) -Defined in: [types/multimodal.ts:783](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L783) - --- ### quality? > `optional` **quality?**: `number` -Defined in: [types/multimodal.ts:784](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L784) - --- ### maxDimension? > `optional` **maxDimension?**: `number` -Defined in: [types/multimodal.ts:785](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L785) - --- ### format? > `optional` **format?**: [`SupportedFormat`](SupportedFormat.md) - -Defined in: [types/multimodal.ts:786](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L786) diff --git a/docs/api/type-aliases/CompressionResult.md b/docs/api/type-aliases/CompressionResult.md index b2e6cffc3..f4e3f15ee 100644 --- a/docs/api/type-aliases/CompressionResult.md +++ b/docs/api/type-aliases/CompressionResult.md @@ -8,8 +8,6 @@ > **CompressionResult** = `object` -Defined in: [types/multimodal.ts:790](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L790) - Result of compressImage() with metadata. ## Properties @@ -18,40 +16,30 @@ Result of compressImage() with metadata. > **buffer**: `Buffer` -Defined in: [types/multimodal.ts:791](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L791) - --- ### originalSize > **originalSize**: `number` -Defined in: [types/multimodal.ts:792](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L792) - --- ### compressedSize > **compressedSize**: `number` -Defined in: [types/multimodal.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L793) - --- ### compressionRatio > **compressionRatio**: `number` -Defined in: [types/multimodal.ts:794](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L794) - --- ### metadata > **metadata**: `object` -Defined in: [types/multimodal.ts:795](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L795) - #### width > **width**: `number` diff --git a/docs/api/type-aliases/ConditionOptions.md b/docs/api/type-aliases/ConditionOptions.md index bd2b9a232..7a411e67c 100644 --- a/docs/api/type-aliases/ConditionOptions.md +++ b/docs/api/type-aliases/ConditionOptions.md @@ -8,8 +8,6 @@ > **ConditionOptions** = `object` -Defined in: [types/workflow.ts:604](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L604) - Options for response conditioning ## Properties @@ -18,44 +16,32 @@ Options for response conditioning > **content**: `string` -Defined in: [types/workflow.ts:605](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L605) - --- ### selectedResponse > **selectedResponse**: [`EnsembleResponse`](EnsembleResponse.md) -Defined in: [types/workflow.ts:606](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L606) - --- ### allResponses > **allResponses**: [`EnsembleResponse`](EnsembleResponse.md)[] -Defined in: [types/workflow.ts:607](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L607) - --- ### judgeScores? > `optional` **judgeScores?**: [`JudgeScores`](JudgeScores.md) \| [`MultiJudgeScores`](MultiJudgeScores.md) -Defined in: [types/workflow.ts:608](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L608) - --- ### config? > `optional` **config?**: [`ConditioningConfig`](ConditioningConfig.md) -Defined in: [types/workflow.ts:609](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L609) - --- ### originalPrompt? > `optional` **originalPrompt?**: `string` - -Defined in: [types/workflow.ts:610](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L610) diff --git a/docs/api/type-aliases/ConditionResult.md b/docs/api/type-aliases/ConditionResult.md index ed4c85ebe..721a763be 100644 --- a/docs/api/type-aliases/ConditionResult.md +++ b/docs/api/type-aliases/ConditionResult.md @@ -8,8 +8,6 @@ > **ConditionResult** = `object` -Defined in: [types/workflow.ts:616](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L616) - Result of response conditioning ## Properties @@ -18,24 +16,18 @@ Result of response conditioning > **content**: `string` -Defined in: [types/workflow.ts:617](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L617) - --- ### conditioningTime > **conditioningTime**: `number` -Defined in: [types/workflow.ts:618](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L618) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/workflow.ts:619](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L619) - #### conditioningApplied > **conditioningApplied**: `boolean` diff --git a/docs/api/type-aliases/ConditioningConfig.md b/docs/api/type-aliases/ConditioningConfig.md index 968f52f1e..5e1f6f8fc 100644 --- a/docs/api/type-aliases/ConditioningConfig.md +++ b/docs/api/type-aliases/ConditioningConfig.md @@ -8,8 +8,6 @@ > **ConditioningConfig** = `object` -Defined in: [types/workflow.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L159) - Response conditioning configuration NOTE: Testing phase - stub only, no actual conditioning @@ -19,24 +17,18 @@ NOTE: Testing phase - stub only, no actual conditioning > `optional` **enabled?**: `boolean` -Defined in: [types/workflow.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L161) - --- ### useConfidence > **useConfidence**: `boolean` -Defined in: [types/workflow.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L162) - --- ### confidenceThresholds? > `optional` **confidenceThresholds?**: `object` -Defined in: [types/workflow.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L163) - #### high > **high**: `number` @@ -55,8 +47,6 @@ Defined in: [types/workflow.ts:163](https://github.com/juspay/neurolink/blob/rel > `optional` **synthesisModel?**: `object` -Defined in: [types/workflow.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L170) - #### provider > **provider**: `string` @@ -75,52 +65,38 @@ Defined in: [types/workflow.ts:170](https://github.com/juspay/neurolink/blob/rel > `optional` **toneAdjustment?**: [`ToneAdjustment`](ToneAdjustment.md) -Defined in: [types/workflow.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L177) - --- ### includeMetadata? > `optional` **includeMetadata?**: `boolean` -Defined in: [types/workflow.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L180) - --- ### metadataFields? > `optional` **metadataFields?**: `string`[] -Defined in: [types/workflow.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L181) - --- ### addConfidenceStatement? > `optional` **addConfidenceStatement?**: `boolean` -Defined in: [types/workflow.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L184) - --- ### addModelAttribution? > `optional` **addModelAttribution?**: `boolean` -Defined in: [types/workflow.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L185) - --- ### addExecutionTime? > `optional` **addExecutionTime?**: `boolean` -Defined in: [types/workflow.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L186) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> - -Defined in: [types/workflow.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L189) diff --git a/docs/api/type-aliases/ConfigSource.md b/docs/api/type-aliases/ConfigSource.md index e04a4a6ad..86abc1fa9 100644 --- a/docs/api/type-aliases/ConfigSource.md +++ b/docs/api/type-aliases/ConfigSource.md @@ -8,6 +8,4 @@ > **ConfigSource** = `"default"` \| `"environment"` \| `"file"` \| `"dynamic"` -Defined in: [types/model.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L19) - Model configuration source type diff --git a/docs/api/type-aliases/ConfigUpdateOptions.md b/docs/api/type-aliases/ConfigUpdateOptions.md index a5ed0556e..14b0f3982 100644 --- a/docs/api/type-aliases/ConfigUpdateOptions.md +++ b/docs/api/type-aliases/ConfigUpdateOptions.md @@ -8,8 +8,6 @@ > **ConfigUpdateOptions** = `object` -Defined in: [types/config.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L500) - Configuration update options ## Properties @@ -18,36 +16,26 @@ Configuration update options > `optional` **createBackup?**: `boolean` -Defined in: [types/config.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L501) - --- ### validate? > `optional` **validate?**: `boolean` -Defined in: [types/config.ts:502](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L502) - --- ### merge? > `optional` **merge?**: `boolean` -Defined in: [types/config.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L503) - --- ### reason? > `optional` **reason?**: `string` -Defined in: [types/config.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L504) - --- ### silent? > `optional` **silent?**: `boolean` - -Defined in: [types/config.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L505) diff --git a/docs/api/type-aliases/ConfigValidationResult.md b/docs/api/type-aliases/ConfigValidationResult.md index 9fc402d85..b71c0cb97 100644 --- a/docs/api/type-aliases/ConfigValidationResult.md +++ b/docs/api/type-aliases/ConfigValidationResult.md @@ -8,8 +8,6 @@ > **ConfigValidationResult** = `object` -Defined in: [types/config.ts:490](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L490) - Configuration validation result ## Properties @@ -18,28 +16,20 @@ Configuration validation result > **valid**: `boolean` -Defined in: [types/config.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L491) - --- ### errors > **errors**: `string`[] -Defined in: [types/config.ts:492](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L492) - --- ### warnings > **warnings**: `string`[] -Defined in: [types/config.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L493) - --- ### suggestions > **suggestions**: `string`[] - -Defined in: [types/config.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L494) diff --git a/docs/api/type-aliases/ConfirmationElicitation.md b/docs/api/type-aliases/ConfirmationElicitation.md index baa424a17..5c27cd7af 100644 --- a/docs/api/type-aliases/ConfirmationElicitation.md +++ b/docs/api/type-aliases/ConfirmationElicitation.md @@ -8,8 +8,6 @@ > **ConfirmationElicitation** = [`ElicitationRequest`](ElicitationRequest.md) & `object` -Defined in: [types/elicitation.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L78) - Confirmation elicitation ## Type Declaration diff --git a/docs/api/type-aliases/ConfirmationRequest.md b/docs/api/type-aliases/ConfirmationRequest.md index bbf7f37cd..75d367ec4 100644 --- a/docs/api/type-aliases/ConfirmationRequest.md +++ b/docs/api/type-aliases/ConfirmationRequest.md @@ -8,8 +8,6 @@ > **ConfirmationRequest** = `object` -Defined in: [types/hitl.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L61) - Internal confirmation request tracking Used by HITLManager to track pending confirmations @@ -19,8 +17,6 @@ Used by HITLManager to track pending confirmations > **confirmationId**: `string` -Defined in: [types/hitl.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L63) - Unique identifier for this confirmation request --- @@ -29,8 +25,6 @@ Unique identifier for this confirmation request > **toolName**: `string` -Defined in: [types/hitl.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L66) - Name of the tool requiring confirmation --- @@ -39,8 +33,6 @@ Name of the tool requiring confirmation > **arguments**: `unknown` -Defined in: [types/hitl.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L69) - Arguments that will be passed to the tool --- @@ -49,8 +41,6 @@ Arguments that will be passed to the tool > **timestamp**: `number` -Defined in: [types/hitl.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L72) - Timestamp when the request was created --- @@ -59,8 +49,6 @@ Timestamp when the request was created > **timeoutHandle**: `NodeJS.Timeout` -Defined in: [types/hitl.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L75) - Timeout handle for cleanup --- @@ -69,8 +57,6 @@ Timeout handle for cleanup > **resolve**: (`result`) => `void` -Defined in: [types/hitl.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L78) - Promise resolve function #### Parameters @@ -89,8 +75,6 @@ Promise resolve function > **reject**: (`error`) => `void` -Defined in: [types/hitl.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L81) - Promise reject function #### Parameters diff --git a/docs/api/type-aliases/ConfirmationRequestEvent.md b/docs/api/type-aliases/ConfirmationRequestEvent.md index 250da291f..5d6559d5f 100644 --- a/docs/api/type-aliases/ConfirmationRequestEvent.md +++ b/docs/api/type-aliases/ConfirmationRequestEvent.md @@ -8,8 +8,6 @@ > **ConfirmationRequestEvent** = `object` -Defined in: [types/hitl.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L106) - Event payload for confirmation requests Sent to frontends via EventEmitter when tool needs approval @@ -19,16 +17,12 @@ Sent to frontends via EventEmitter when tool needs approval > **type**: `"hitl:confirmation-request"` -Defined in: [types/hitl.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L107) - --- ### payload > **payload**: `object` -Defined in: [types/hitl.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L108) - #### confirmationId > **confirmationId**: `string` diff --git a/docs/api/type-aliases/ConfirmationResponseEvent.md b/docs/api/type-aliases/ConfirmationResponseEvent.md index 90e720270..f3df05086 100644 --- a/docs/api/type-aliases/ConfirmationResponseEvent.md +++ b/docs/api/type-aliases/ConfirmationResponseEvent.md @@ -8,8 +8,6 @@ > **ConfirmationResponseEvent** = `object` -Defined in: [types/hitl.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L151) - Event payload for confirmation responses Sent from frontends back to HITLManager with user decision @@ -19,16 +17,12 @@ Sent from frontends back to HITLManager with user decision > **type**: `"hitl:confirmation-response"` -Defined in: [types/hitl.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L152) - --- ### payload > **payload**: `object` -Defined in: [types/hitl.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L153) - #### confirmationId > **confirmationId**: `string` diff --git a/docs/api/type-aliases/ConfirmationResult.md b/docs/api/type-aliases/ConfirmationResult.md index 69d2441e9..a1ecf0e25 100644 --- a/docs/api/type-aliases/ConfirmationResult.md +++ b/docs/api/type-aliases/ConfirmationResult.md @@ -8,8 +8,6 @@ > **ConfirmationResult** = `object` -Defined in: [types/hitl.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L88) - Result of a confirmation request Contains user decision and potentially modified arguments @@ -19,8 +17,6 @@ Contains user decision and potentially modified arguments > **approved**: `boolean` -Defined in: [types/hitl.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L90) - Whether the user approved the tool execution --- @@ -29,8 +25,6 @@ Whether the user approved the tool execution > `optional` **reason?**: `string` -Defined in: [types/hitl.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L93) - Optional reason for rejection (if approved is false) --- @@ -39,8 +33,6 @@ Optional reason for rejection (if approved is false) > `optional` **modifiedArguments?**: `unknown` -Defined in: [types/hitl.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L96) - User-modified arguments (if allowArgumentModification is enabled) --- @@ -49,6 +41,4 @@ User-modified arguments (if allowArgumentModification is enabled) > **responseTime**: `number` -Defined in: [types/hitl.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L99) - Time taken for user to respond in milliseconds diff --git a/docs/api/type-aliases/ConfirmationTimeoutEvent.md b/docs/api/type-aliases/ConfirmationTimeoutEvent.md index 3382e31dd..fef3f75c9 100644 --- a/docs/api/type-aliases/ConfirmationTimeoutEvent.md +++ b/docs/api/type-aliases/ConfirmationTimeoutEvent.md @@ -8,8 +8,6 @@ > **ConfirmationTimeoutEvent** = `object` -Defined in: [types/hitl.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L184) - Event payload for confirmation timeouts Emitted when user doesn't respond within timeout period @@ -19,16 +17,12 @@ Emitted when user doesn't respond within timeout period > **type**: `"hitl:timeout"` -Defined in: [types/hitl.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L185) - --- ### payload > **payload**: `object` -Defined in: [types/hitl.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L186) - #### confirmationId > **confirmationId**: `string` diff --git a/docs/api/type-aliases/ConflictDetectionPlugin.md b/docs/api/type-aliases/ConflictDetectionPlugin.md index 90f11801f..63866249c 100644 --- a/docs/api/type-aliases/ConflictDetectionPlugin.md +++ b/docs/api/type-aliases/ConflictDetectionPlugin.md @@ -8,8 +8,6 @@ > **ConflictDetectionPlugin** = `object` -Defined in: [types/utilities.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L179) - Plugin-based conflict detection system Extensible and configurable enhancement conflict resolution @@ -19,8 +17,6 @@ Extensible and configurable enhancement conflict resolution > **name**: `string` -Defined in: [types/utilities.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L181) - Plugin name for identification --- @@ -29,8 +25,6 @@ Plugin name for identification > **version**: `string` -Defined in: [types/utilities.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L183) - Plugin version for compatibility checks ## Methods @@ -39,8 +33,6 @@ Plugin version for compatibility checks > **detectConflict**(`enhancementA`, `enhancementB`, `optionsA?`, `optionsB?`): `boolean` -Defined in: [types/utilities.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L185) - Check if two enhancement types conflict #### Parameters @@ -71,8 +63,6 @@ Check if two enhancement types conflict > `optional` **getConflictSeverity**(`enhancementA`, `enhancementB`): `"low"` \| `"medium"` \| `"high"` -Defined in: [types/utilities.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L192) - Get conflict severity (low, medium, high) #### Parameters @@ -95,8 +85,6 @@ Get conflict severity (low, medium, high) > `optional` **suggestResolution**(`enhancementA`, `enhancementB`): `string`[] -Defined in: [types/utilities.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L197) - Suggest resolution strategies #### Parameters diff --git a/docs/api/type-aliases/ConnectionResult.md b/docs/api/type-aliases/ConnectionResult.md index e63a4343c..0f2c15742 100644 --- a/docs/api/type-aliases/ConnectionResult.md +++ b/docs/api/type-aliases/ConnectionResult.md @@ -8,8 +8,6 @@ > **ConnectionResult** = `object` -Defined in: [types/aliases.ts:368](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L368) - Connection result with latency information Used for detailed connection testing with performance metrics @@ -19,20 +17,14 @@ Used for detailed connection testing with performance metrics > **connected**: `boolean` -Defined in: [types/aliases.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L369) - --- ### latency? > `optional` **latency?**: `number` -Defined in: [types/aliases.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L370) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/aliases.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L371) diff --git a/docs/api/type-aliases/ConnectivityResult.md b/docs/api/type-aliases/ConnectivityResult.md index 198b52209..b6fdefa6f 100644 --- a/docs/api/type-aliases/ConnectivityResult.md +++ b/docs/api/type-aliases/ConnectivityResult.md @@ -8,8 +8,6 @@ > **ConnectivityResult** = `object` -Defined in: [types/aliases.ts:359](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L359) - Connectivity test result for providers Standard format for testing provider connections @@ -19,12 +17,8 @@ Standard format for testing provider connections > **success**: `boolean` -Defined in: [types/aliases.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L360) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/aliases.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L361) diff --git a/docs/api/type-aliases/ConsoleOverride.md b/docs/api/type-aliases/ConsoleOverride.md index 0b957426f..4c952c444 100644 --- a/docs/api/type-aliases/ConsoleOverride.md +++ b/docs/api/type-aliases/ConsoleOverride.md @@ -8,8 +8,6 @@ > **ConsoleOverride** = `object` -Defined in: [types/cli.ts:562](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L562) - Console override for quiet mode ## Index Signature diff --git a/docs/api/type-aliases/Content.md b/docs/api/type-aliases/Content.md index 9a047e45e..75317738c 100644 --- a/docs/api/type-aliases/Content.md +++ b/docs/api/type-aliases/Content.md @@ -8,7 +8,5 @@ > **Content** = [`TextContent`](TextContent.md) \| [`ImageContent`](ImageContent.md) \| [`CSVContent`](CSVContent.md) \| [`PDFContent`](PDFContent.md) \| [`AudioContent`](AudioContent.md) \| [`VideoContent`](VideoContent.md) -Defined in: [types/multimodal.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L398) - Union type for all content types Covers text, images, documents, and multimedia diff --git a/docs/api/type-aliases/ContentBlockType.md b/docs/api/type-aliases/ContentBlockType.md index 03e15c95b..fcabce838 100644 --- a/docs/api/type-aliases/ContentBlockType.md +++ b/docs/api/type-aliases/ContentBlockType.md @@ -8,6 +8,4 @@ > **ContentBlockType** = `"text"` \| `"thinking"` \| `"tool_use"` \| `null` -Defined in: [types/proxy.ts:365](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L365) - The type of content block currently being streamed. diff --git a/docs/api/type-aliases/ContentFilteringResult.md b/docs/api/type-aliases/ContentFilteringResult.md index 57326907d..f63315db5 100644 --- a/docs/api/type-aliases/ContentFilteringResult.md +++ b/docs/api/type-aliases/ContentFilteringResult.md @@ -8,8 +8,6 @@ > **ContentFilteringResult** = `object` -Defined in: [types/guardrails.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L133) - Result from content filtering operation ## Properties @@ -18,32 +16,24 @@ Result from content filtering operation > **filteredText**: `string` -Defined in: [types/guardrails.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L134) - --- ### hasChanges > **hasChanges**: `boolean` -Defined in: [types/guardrails.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L135) - --- ### appliedFilters > **appliedFilters**: `string`[] -Defined in: [types/guardrails.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L136) - --- ### filteringStats > **filteringStats**: `object` -Defined in: [types/guardrails.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L137) - #### regexPatternsApplied > **regexPatternsApplied**: `number` diff --git a/docs/api/type-aliases/ContentPlan.md b/docs/api/type-aliases/ContentPlan.md index daa7cf86b..df30dd75d 100644 --- a/docs/api/type-aliases/ContentPlan.md +++ b/docs/api/type-aliases/ContentPlan.md @@ -8,8 +8,6 @@ > **ContentPlan** = `object` -Defined in: [types/ppt.ts:713](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L713) - Complete content plan generated by AI ## Properties @@ -18,8 +16,6 @@ Complete content plan generated by AI > **title**: `string` -Defined in: [types/ppt.ts:715](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L715) - Presentation title --- @@ -28,8 +24,6 @@ Presentation title > **totalSlides**: `number` -Defined in: [types/ppt.ts:717](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L717) - Total number of slides --- @@ -38,8 +32,6 @@ Total number of slides > **audience**: `string` -Defined in: [types/ppt.ts:719](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L719) - Target audience used for content --- @@ -48,8 +40,6 @@ Target audience used for content > **tone**: `string` -Defined in: [types/ppt.ts:721](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L721) - Tone used for content --- @@ -58,8 +48,6 @@ Tone used for content > **theme**: `string` -Defined in: [types/ppt.ts:723](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L723) - Theme to apply --- @@ -68,8 +56,6 @@ Theme to apply > **slides**: [`SlideSchema`](SlideSchema.md)[] -Defined in: [types/ppt.ts:725](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L725) - Array of slide schemas --- @@ -78,6 +64,4 @@ Array of slide schemas > `optional` **keyMessages?**: `string`[] -Defined in: [types/ppt.ts:727](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L727) - Key messages/themes identified diff --git a/docs/api/type-aliases/ContentSimilarityConfig.md b/docs/api/type-aliases/ContentSimilarityConfig.md index f52950dc6..c4bd1fe3e 100644 --- a/docs/api/type-aliases/ContentSimilarityConfig.md +++ b/docs/api/type-aliases/ContentSimilarityConfig.md @@ -8,8 +8,6 @@ > **ContentSimilarityConfig** = [`RuleScorerConfig`](RuleScorerConfig.md) & `object` -Defined in: [types/scorer.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L476) - Configuration specific to content similarity scoring. ## Type Declaration diff --git a/docs/api/type-aliases/Context.md b/docs/api/type-aliases/Context.md index 36704fcf8..8150d42aa 100644 --- a/docs/api/type-aliases/Context.md +++ b/docs/api/type-aliases/Context.md @@ -8,36 +8,26 @@ > **Context** = `object` -Defined in: [types/common.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L253) - ## Properties ### traceName? > `optional` **traceName?**: `string` -Defined in: [types/common.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L254) - --- ### userId? > `optional` **userId?**: `string` -Defined in: [types/common.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L255) - --- ### sessionId? > `optional` **sessionId?**: `string` -Defined in: [types/common.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L256) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `string` \| `number` \| `boolean`\> - -Defined in: [types/common.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L257) diff --git a/docs/api/type-aliases/ContextAssemblyOptions.md b/docs/api/type-aliases/ContextAssemblyOptions.md index 891bda7c1..22f7b32af 100644 --- a/docs/api/type-aliases/ContextAssemblyOptions.md +++ b/docs/api/type-aliases/ContextAssemblyOptions.md @@ -8,8 +8,6 @@ > **ContextAssemblyOptions** = `object` -Defined in: [types/rag.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L44) - Context assembly options ## Properties @@ -18,8 +16,6 @@ Context assembly options > `optional` **maxChars?**: `number` -Defined in: [types/rag.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L46) - Maximum characters in assembled context --- @@ -28,8 +24,6 @@ Maximum characters in assembled context > `optional` **maxTokens?**: `number` -Defined in: [types/rag.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L48) - Maximum tokens (approximate, 4 chars/token) --- @@ -38,8 +32,6 @@ Maximum tokens (approximate, 4 chars/token) > `optional` **citationFormat?**: [`CitationFormat`](CitationFormat.md) -Defined in: [types/rag.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L50) - Citation format to use --- @@ -48,8 +40,6 @@ Citation format to use > `optional` **separator?**: `string` -Defined in: [types/rag.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L52) - Separator between chunks --- @@ -58,8 +48,6 @@ Separator between chunks > `optional` **includeMetadata?**: `boolean` -Defined in: [types/rag.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L54) - Include chunk metadata in context --- @@ -68,8 +56,6 @@ Include chunk metadata in context > `optional` **deduplicate?**: `boolean` -Defined in: [types/rag.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L56) - Deduplicate overlapping content --- @@ -78,8 +64,6 @@ Deduplicate overlapping content > `optional` **dedupeThreshold?**: `number` -Defined in: [types/rag.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L58) - Similarity threshold for deduplication (0-1) --- @@ -88,8 +72,6 @@ Similarity threshold for deduplication (0-1) > `optional` **orderByRelevance?**: `boolean` -Defined in: [types/rag.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L60) - Order by relevance score --- @@ -98,8 +80,6 @@ Order by relevance score > `optional` **includeSectionHeaders?**: `boolean` -Defined in: [types/rag.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L62) - Include section headers --- @@ -108,6 +88,4 @@ Include section headers > `optional` **headerTemplate?**: `string` -Defined in: [types/rag.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L64) - Header template (use {index}, {source}, {score} placeholders) diff --git a/docs/api/type-aliases/ContextCompactRequest.md b/docs/api/type-aliases/ContextCompactRequest.md index eb338b49f..7738b9667 100644 --- a/docs/api/type-aliases/ContextCompactRequest.md +++ b/docs/api/type-aliases/ContextCompactRequest.md @@ -8,8 +8,6 @@ > **ContextCompactRequest** = `object` -Defined in: [types/context.ts:1095](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1095) - Per-call context handed to `ContextCompactor.compact`. ## Properties @@ -18,7 +16,5 @@ Per-call context handed to `ContextCompactor.compact`. > `optional` **currentRequest?**: `string` -Defined in: [types/context.ts:1100](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1100) - The request being prepared. Without it the relevance stage cannot run — "is this message still needed?" is meaningless without knowing what for. diff --git a/docs/api/type-aliases/ContextCompactorDeps.md b/docs/api/type-aliases/ContextCompactorDeps.md index 068997249..63c8c1feb 100644 --- a/docs/api/type-aliases/ContextCompactorDeps.md +++ b/docs/api/type-aliases/ContextCompactorDeps.md @@ -8,8 +8,6 @@ > **ContextCompactorDeps** = `object` -Defined in: [types/context.ts:1085](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1085) - Injected dependencies for ContextCompactor. Deliberately separate from `CompactionConfig`: that type is spread into a @@ -23,8 +21,6 @@ decision provider configured. > `optional` **decide?**: [`DecisionCallerFn`](DecisionCallerFn.md) -Defined in: [types/context.ts:1087](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1087) - Fail-open decision caller. Omitted = the previous pipeline, exactly. --- @@ -33,8 +29,6 @@ Fail-open decision caller. Omitted = the previous pipeline, exactly. > `optional` **relevance?**: [`ContextRelevanceOptions`](ContextRelevanceOptions.md) -Defined in: [types/context.ts:1089](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1089) - Tuning for the relevance stage. --- @@ -43,8 +37,6 @@ Tuning for the relevance stage. > `optional` **summaryGate?**: `object` -Defined in: [types/context.ts:1091](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1091) - Tuning for the post-summarization quality gate. #### timeoutMs? diff --git a/docs/api/type-aliases/ContextConfig.md b/docs/api/type-aliases/ContextConfig.md index 6debb0aea..b83352aa9 100644 --- a/docs/api/type-aliases/ContextConfig.md +++ b/docs/api/type-aliases/ContextConfig.md @@ -8,8 +8,6 @@ > **ContextConfig** = `object` -Defined in: [types/context.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L55) - Context configuration for AI generation ## Properties @@ -18,44 +16,32 @@ Context configuration for AI generation > **mode**: `ContextIntegrationMode` -Defined in: [types/context.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L56) - --- ### includeInPrompt? > `optional` **includeInPrompt?**: `boolean` -Defined in: [types/context.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L57) - --- ### includeInAnalytics? > `optional` **includeInAnalytics?**: `boolean` -Defined in: [types/context.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L58) - --- ### includeInEvaluation? > `optional` **includeInEvaluation?**: `boolean` -Defined in: [types/context.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L59) - --- ### template? > `optional` **template?**: `string` -Defined in: [types/context.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L60) - --- ### maxLength? > `optional` **maxLength?**: `number` - -Defined in: [types/context.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L61) diff --git a/docs/api/type-aliases/ContextRelevanceOptions.md b/docs/api/type-aliases/ContextRelevanceOptions.md index 29ceced67..5fef2b0c0 100644 --- a/docs/api/type-aliases/ContextRelevanceOptions.md +++ b/docs/api/type-aliases/ContextRelevanceOptions.md @@ -8,8 +8,6 @@ > **ContextRelevanceOptions** = `object` -Defined in: [types/context.ts:1050](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1050) - Tuning for the relevance stage of context compaction. ## Properties @@ -18,8 +16,6 @@ Tuning for the relevance stage of context compaction. > `optional` **protectRecent?**: `number` -Defined in: [types/context.ts:1052](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1052) - Trailing messages never eligible for dropping. Default 6. --- @@ -28,8 +24,6 @@ Trailing messages never eligible for dropping. Default 6. > `optional` **minDropConfidence?**: `number` -Defined in: [types/context.ts:1054](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1054) - Confidence required to drop a message. Default 0.6. --- @@ -38,8 +32,6 @@ Confidence required to drop a message. Default 0.6. > `optional` **maxDropRatio?**: `number` -Defined in: [types/context.ts:1056](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1056) - Ceiling on the share of eligible messages one pass may drop. Default 0.5. --- @@ -48,6 +40,4 @@ Ceiling on the share of eligible messages one pass may drop. Default 0.5. > `optional` **timeoutMs?**: `number` -Defined in: [types/context.ts:1058](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1058) - Per-call timeout override for the decision request. diff --git a/docs/api/type-aliases/ContextRelevanceResult.md b/docs/api/type-aliases/ContextRelevanceResult.md index 75f1cc413..14e3b70d9 100644 --- a/docs/api/type-aliases/ContextRelevanceResult.md +++ b/docs/api/type-aliases/ContextRelevanceResult.md @@ -8,8 +8,6 @@ > **ContextRelevanceResult** = `object` -Defined in: [types/context.ts:1062](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1062) - What the relevance stage concluded. ## Properties @@ -18,8 +16,6 @@ What the relevance stage concluded. > **messages**: [`ChatMessage`](ChatMessage.md)[] -Defined in: [types/context.ts:1064](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1064) - The surviving messages, in their original order. --- @@ -28,8 +24,6 @@ The surviving messages, in their original order. > **droppedIndices**: `number`[] -Defined in: [types/context.ts:1066](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1066) - Indices into the ORIGINAL array that were dropped. --- @@ -38,8 +32,6 @@ Indices into the ORIGINAL array that were dropped. > **askedCount**: `number` -Defined in: [types/context.ts:1068](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1068) - How many messages were asked about. --- @@ -48,8 +40,6 @@ How many messages were asked about. > **answeredCount**: `number` -Defined in: [types/context.ts:1070](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1070) - How many came back with a usable, confident answer. --- @@ -58,8 +48,6 @@ How many came back with a usable, confident answer. > **model**: `string` -Defined in: [types/context.ts:1072](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1072) - Resolved decision model id, for telemetry. --- @@ -68,6 +56,4 @@ Resolved decision model id, for telemetry. > **latencyMs**: `number` -Defined in: [types/context.ts:1074](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1074) - Round trip in milliseconds. diff --git a/docs/api/type-aliases/ContextScoreItem.md b/docs/api/type-aliases/ContextScoreItem.md index f935de88e..97435a7e7 100644 --- a/docs/api/type-aliases/ContextScoreItem.md +++ b/docs/api/type-aliases/ContextScoreItem.md @@ -8,8 +8,6 @@ > **ContextScoreItem** = `object` -Defined in: [types/scorer.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L651) - Context score row reported by the context-relevancy scorer. ## Properties @@ -18,28 +16,20 @@ Context score row reported by the context-relevancy scorer. > `optional` **index?**: `number` -Defined in: [types/scorer.ts:652](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L652) - --- ### score? > `optional` **score?**: `number` -Defined in: [types/scorer.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L653) - --- ### reasoning? > `optional` **reasoning?**: `string` -Defined in: [types/scorer.ts:654](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L654) - --- ### keyInfo? > `optional` **keyInfo?**: `string`[] - -Defined in: [types/scorer.ts:655](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L655) diff --git a/docs/api/type-aliases/ContextWindow.md b/docs/api/type-aliases/ContextWindow.md index 3ea4f60f1..c98629bee 100644 --- a/docs/api/type-aliases/ContextWindow.md +++ b/docs/api/type-aliases/ContextWindow.md @@ -8,8 +8,6 @@ > **ContextWindow** = `object` -Defined in: [types/rag.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L70) - Context window representation ## Properties @@ -18,8 +16,6 @@ Context window representation > **text**: `string` -Defined in: [types/rag.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L72) - Assembled context text --- @@ -28,8 +24,6 @@ Assembled context text > **chunkCount**: `number` -Defined in: [types/rag.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L74) - Number of chunks included --- @@ -38,8 +32,6 @@ Number of chunks included > **charCount**: `number` -Defined in: [types/rag.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L76) - Total character count --- @@ -48,8 +40,6 @@ Total character count > **tokenCount**: `number` -Defined in: [types/rag.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L78) - Estimated token count --- @@ -58,8 +48,6 @@ Estimated token count > **truncatedChunks**: `number` -Defined in: [types/rag.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L80) - Chunks that were truncated/excluded --- @@ -68,6 +56,4 @@ Chunks that were truncated/excluded > **citations**: `Map`\<`string`, `string`\> -Defined in: [types/rag.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L82) - Citation map (id -> citation text) diff --git a/docs/api/type-aliases/ConversationBase.md b/docs/api/type-aliases/ConversationBase.md index eea60564c..2ccf0b1d5 100644 --- a/docs/api/type-aliases/ConversationBase.md +++ b/docs/api/type-aliases/ConversationBase.md @@ -8,8 +8,6 @@ > **ConversationBase** = `object` -Defined in: [types/conversation.ts:622](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L622) - Base conversation metadata (shared fields across all conversation types) Contains essential conversation information without heavy data arrays @@ -19,8 +17,6 @@ Contains essential conversation information without heavy data arrays > **id**: `string` -Defined in: [types/conversation.ts:624](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L624) - Unique conversation identifier (UUID v4) --- @@ -29,8 +25,6 @@ Unique conversation identifier (UUID v4) > **title**: `string` -Defined in: [types/conversation.ts:627](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L627) - Auto-generated conversation title --- @@ -39,8 +33,6 @@ Auto-generated conversation title > **sessionId**: `string` -Defined in: [types/conversation.ts:630](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L630) - Session identifier --- @@ -49,8 +41,6 @@ Session identifier > **userId**: `string` -Defined in: [types/conversation.ts:633](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L633) - User identifier --- @@ -59,8 +49,6 @@ User identifier > **createdAt**: `string` -Defined in: [types/conversation.ts:636](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L636) - When this conversation was first created --- @@ -69,8 +57,6 @@ When this conversation was first created > **updatedAt**: `string` -Defined in: [types/conversation.ts:639](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L639) - When this conversation was last updated --- @@ -79,8 +65,6 @@ When this conversation was last updated > `optional` **summarizedUpToMessageId?**: `string` -Defined in: [types/conversation.ts:642](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L642) - Pointer to last summarized message (token-based memory) --- @@ -89,8 +73,6 @@ Pointer to last summarized message (token-based memory) > `optional` **summarizedMessage?**: `string` -Defined in: [types/conversation.ts:645](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L645) - Stored summary message that condenses conversation history up to summarizedUpToMessageId --- @@ -99,8 +81,6 @@ Stored summary message that condenses conversation history up to summarizedUpToM > `optional` **tokenThreshold?**: `number` -Defined in: [types/conversation.ts:648](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L648) - Per-session token threshold override --- @@ -109,8 +89,6 @@ Per-session token threshold override > `optional` **lastTokenCount?**: `number` -Defined in: [types/conversation.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L651) - Cached token count for efficiency --- @@ -119,8 +97,6 @@ Cached token count for efficiency > `optional` **lastCountedAt?**: `number` -Defined in: [types/conversation.ts:654](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L654) - Timestamp of last token count --- @@ -129,8 +105,6 @@ Timestamp of last token count > `optional` **lastApiTokenCount?**: `object` -Defined in: [types/conversation.ts:657](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L657) - API-reported token count from last request #### inputTokens? @@ -159,8 +133,6 @@ API-reported token count from last request > `optional` **additionalMetadata?**: `object` -Defined in: [types/conversation.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L666) - Additional metadata for extensible conversation-level data #### Index Signature diff --git a/docs/api/type-aliases/ConversationChoice.md b/docs/api/type-aliases/ConversationChoice.md index 5cf1451de..ba85ad150 100644 --- a/docs/api/type-aliases/ConversationChoice.md +++ b/docs/api/type-aliases/ConversationChoice.md @@ -8,8 +8,6 @@ > **ConversationChoice** = `object` -Defined in: [types/cli.ts:569](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L569) - Conversation choice for inquirer prompt ## Properties @@ -18,20 +16,14 @@ Conversation choice for inquirer prompt > **name**: `string` -Defined in: [types/cli.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L570) - --- ### value > **value**: `string` \| `"NEW_CONVERSATION"` -Defined in: [types/cli.ts:571](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L571) - --- ### short > **short**: `string` - -Defined in: [types/cli.ts:572](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L572) diff --git a/docs/api/type-aliases/ConversationData.md b/docs/api/type-aliases/ConversationData.md index 9d9e61aed..e232668af 100644 --- a/docs/api/type-aliases/ConversationData.md +++ b/docs/api/type-aliases/ConversationData.md @@ -8,8 +8,6 @@ > **ConversationData** = [`RedisConversationObject`](RedisConversationObject.md) & `object` -Defined in: [types/conversation.ts:687](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L687) - Full conversation data for session restoration and manipulation Extends Redis storage object with additional loop mode metadata diff --git a/docs/api/type-aliases/ConversationEntry.md b/docs/api/type-aliases/ConversationEntry.md index 0f6caf2e0..5e3f1a181 100644 --- a/docs/api/type-aliases/ConversationEntry.md +++ b/docs/api/type-aliases/ConversationEntry.md @@ -8,28 +8,20 @@ > **ConversationEntry** = `object` -Defined in: [types/task.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L254) - ## Properties ### role > **role**: `"user"` \| `"assistant"` -Defined in: [types/task.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L255) - --- ### content > **content**: `string` -Defined in: [types/task.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L256) - --- ### timestamp > **timestamp**: `string` - -Defined in: [types/task.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L257) diff --git a/docs/api/type-aliases/ConversationMemoryConfig.md b/docs/api/type-aliases/ConversationMemoryConfig.md index 90cc3cf9f..4c6445d95 100644 --- a/docs/api/type-aliases/ConversationMemoryConfig.md +++ b/docs/api/type-aliases/ConversationMemoryConfig.md @@ -8,8 +8,6 @@ > **ConversationMemoryConfig** = `object` -Defined in: [types/conversation.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L72) - Configuration for conversation memory feature ## Properties @@ -18,8 +16,6 @@ Configuration for conversation memory feature > **enabled**: `boolean` -Defined in: [types/conversation.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L74) - Enable conversation memory feature --- @@ -28,8 +24,6 @@ Enable conversation memory feature > `optional` **maxSessions?**: `number` -Defined in: [types/conversation.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L77) - Maximum number of sessions to keep in memory (default: 50) --- @@ -38,8 +32,6 @@ Maximum number of sessions to keep in memory (default: 50) > `optional` **enableSummarization?**: `boolean` -Defined in: [types/conversation.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L80) - Enable automatic summarization --- @@ -48,8 +40,6 @@ Enable automatic summarization > `optional` **tokenThreshold?**: `number` -Defined in: [types/conversation.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L83) - Token threshold to trigger summarization (optional - defaults to 80% of model context) --- @@ -58,8 +48,6 @@ Token threshold to trigger summarization (optional - defaults to 80% of model co > `optional` **summarizationProvider?**: `string` -Defined in: [types/conversation.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L86) - Provider to use for summarization --- @@ -68,8 +56,6 @@ Provider to use for summarization > `optional` **summarizationModel?**: `string` -Defined in: [types/conversation.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L89) - Model to use for summarization --- @@ -78,8 +64,6 @@ Model to use for summarization > `optional` **summarizationTimeoutMs?**: `number` -Defined in: [types/conversation.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L97) - Wall-clock cap for one summarization generate call, in milliseconds (default: 60000). A summary that overruns is dropped, not fatal — the turn continues without it — so size this for the slowest summary a real @@ -91,8 +75,6 @@ conversation produces rather than losing compaction summaries silently. > `optional` **memory?**: [`HippocampusMemory`](HippocampusMemory.md) -Defined in: [types/conversation.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L100) - Memory SDK config (condensed key-value memory per user). Set enabled: true to activate. --- @@ -101,8 +83,6 @@ Memory SDK config (condensed key-value memory per user). Set enabled: true to ac > `optional` **redisConfig?**: [`RedisStorageConfig`](RedisStorageConfig.md) -Defined in: [types/conversation.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L103) - Redis configuration (optional) - overrides environment variables --- @@ -111,8 +91,6 @@ Redis configuration (optional) - overrides environment variables > `optional` **contextCompaction?**: `object` -Defined in: [types/conversation.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L106) - Context compaction configuration #### enabled? @@ -179,8 +157,6 @@ File read budget as fraction of remaining context (default: 0.60) > `optional` **fileSummarization?**: `object` -Defined in: [types/conversation.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L136) - Configuration for automatic file content summarization when files exceed context budget #### enabled? @@ -213,8 +189,6 @@ Configuration for automatic file content summarization when files exceed context > `optional` **maxTurnsPerSession?**: `number` -Defined in: [types/conversation.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L146) - #### Deprecated Use tokenThreshold instead - Maximum number of conversation turns to keep per session (default: 20) @@ -225,8 +199,6 @@ Use tokenThreshold instead - Maximum number of conversation turns to keep per se > `optional` **summarizationThresholdTurns?**: `number` -Defined in: [types/conversation.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L149) - #### Deprecated Use tokenThreshold instead - Turn count to trigger summarization @@ -237,8 +209,6 @@ Use tokenThreshold instead - Turn count to trigger summarization > `optional` **summarizationTargetTurns?**: `number` -Defined in: [types/conversation.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L152) - #### Deprecated Use tokenThreshold instead - Target turn count for the summary diff --git a/docs/api/type-aliases/ConversationMemoryEvents.md b/docs/api/type-aliases/ConversationMemoryEvents.md index 22bb73d12..f6e8b2f13 100644 --- a/docs/api/type-aliases/ConversationMemoryEvents.md +++ b/docs/api/type-aliases/ConversationMemoryEvents.md @@ -8,8 +8,6 @@ > **ConversationMemoryEvents** = `object` -Defined in: [types/conversation.ts:412](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L412) - Events emitted by conversation memory system ## Properties @@ -18,8 +16,6 @@ Events emitted by conversation memory system > **session:created**: `object` -Defined in: [types/conversation.ts:417](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L417) - Emitted when a new session is created. The timestamp field is Unix epoch milliseconds. @@ -43,8 +39,6 @@ Event timestamp as Unix epoch milliseconds > **turn:stored**: `object` -Defined in: [types/conversation.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L425) - Emitted when a conversation turn is stored #### sessionId @@ -65,8 +59,6 @@ Emitted when a conversation turn is stored > **session:cleanup**: `object` -Defined in: [types/conversation.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L432) - Emitted when a session is cleaned up #### sessionId @@ -87,8 +79,6 @@ Emitted when a session is cleaned up > **context:injected**: `object` -Defined in: [types/conversation.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L439) - Emitted when context is injected #### sessionId diff --git a/docs/api/type-aliases/ConversationMemoryStats.md b/docs/api/type-aliases/ConversationMemoryStats.md index 9d039a97d..a0c3a45dd 100644 --- a/docs/api/type-aliases/ConversationMemoryStats.md +++ b/docs/api/type-aliases/ConversationMemoryStats.md @@ -8,8 +8,6 @@ > **ConversationMemoryStats** = `object` -Defined in: [types/conversation.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L225) - Statistics about conversation memory usage (simplified for pure in-memory storage) ## Properties @@ -18,8 +16,6 @@ Statistics about conversation memory usage (simplified for pure in-memory storag > **totalSessions**: `number` -Defined in: [types/conversation.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L227) - Total number of active sessions --- @@ -28,6 +24,4 @@ Total number of active sessions > **totalTurns**: `number` -Defined in: [types/conversation.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L230) - Total number of conversation turns across all sessions diff --git a/docs/api/type-aliases/ConversationMessage.md b/docs/api/type-aliases/ConversationMessage.md index 90a8b0899..dcc61a9fc 100644 --- a/docs/api/type-aliases/ConversationMessage.md +++ b/docs/api/type-aliases/ConversationMessage.md @@ -8,8 +8,6 @@ > **ConversationMessage** = `object` -Defined in: [types/server.ts:1351](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1351) - Subset of Message that excludes the system role (assistant+user only). ## Properties @@ -18,12 +16,8 @@ Subset of Message that excludes the system role (assistant+user only). > **role**: `"user"` \| `"assistant"` -Defined in: [types/server.ts:1352](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1352) - --- ### content > **content**: `string` - -Defined in: [types/server.ts:1353](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1353) diff --git a/docs/api/type-aliases/ConversationSummary.md b/docs/api/type-aliases/ConversationSummary.md index fedcfb5b7..8f4f807af 100644 --- a/docs/api/type-aliases/ConversationSummary.md +++ b/docs/api/type-aliases/ConversationSummary.md @@ -8,8 +8,6 @@ > **ConversationSummary** = [`ConversationBase`](ConversationBase.md) & `object` -Defined in: [types/conversation.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L703) - Conversation summary for listing and selection Contains conversation preview information without heavy message arrays diff --git a/docs/api/type-aliases/CoordinationContext.md b/docs/api/type-aliases/CoordinationContext.md index 35677ee11..b6e523240 100644 --- a/docs/api/type-aliases/CoordinationContext.md +++ b/docs/api/type-aliases/CoordinationContext.md @@ -8,8 +8,6 @@ > **CoordinationContext** = [`AgentExecutionContext`](AgentExecutionContext.md) & `object` -Defined in: [types/agentNetwork.ts:1255](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1255) - Context passed during coordination ## Type Declaration diff --git a/docs/api/type-aliases/CoordinationResult.md b/docs/api/type-aliases/CoordinationResult.md index ba862329b..f5bcb9291 100644 --- a/docs/api/type-aliases/CoordinationResult.md +++ b/docs/api/type-aliases/CoordinationResult.md @@ -8,8 +8,6 @@ > **CoordinationResult** = `object` -Defined in: [types/agentNetwork.ts:1279](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1279) - Result of a coordinated execution ## Properties @@ -18,8 +16,6 @@ Result of a coordinated execution > **success**: `boolean` -Defined in: [types/agentNetwork.ts:1281](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1281) - Whether coordination was successful --- @@ -28,8 +24,6 @@ Whether coordination was successful > **agentResults**: `Map`\<`string`, [`AgentResult`](AgentResult.md)\> -Defined in: [types/agentNetwork.ts:1284](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1284) - Results from all agents --- @@ -38,8 +32,6 @@ Results from all agents > **steps**: [`NetworkExecutionStep`](NetworkExecutionStep.md)[] -Defined in: [types/agentNetwork.ts:1287](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1287) - Execution steps taken --- @@ -48,8 +40,6 @@ Execution steps taken > `optional` **finalOutput?**: `string` -Defined in: [types/agentNetwork.ts:1290](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1290) - Final combined output --- @@ -58,8 +48,6 @@ Final combined output > **errors**: `object`[] -Defined in: [types/agentNetwork.ts:1293](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1293) - Any errors encountered #### agentId @@ -76,8 +64,6 @@ Any errors encountered > **duration**: `number` -Defined in: [types/agentNetwork.ts:1296](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1296) - Total duration in ms --- @@ -86,8 +72,6 @@ Total duration in ms > **metadata**: `object` -Defined in: [types/agentNetwork.ts:1299](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1299) - Execution metadata #### executionId diff --git a/docs/api/type-aliases/CoordinationStrategy.md b/docs/api/type-aliases/CoordinationStrategy.md index 3490bb9d0..8029c09b9 100644 --- a/docs/api/type-aliases/CoordinationStrategy.md +++ b/docs/api/type-aliases/CoordinationStrategy.md @@ -8,6 +8,4 @@ > **CoordinationStrategy** = `"sequential"` \| `"parallel"` \| `"pipeline"` \| `"roundRobin"` \| `"leastBusy"` \| `"custom"` -Defined in: [types/agentNetwork.ts:1213](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1213) - Coordination strategy for multi-agent execution diff --git a/docs/api/type-aliases/CoordinatorConfig.md b/docs/api/type-aliases/CoordinatorConfig.md index 4bc8ede29..ff5c12b47 100644 --- a/docs/api/type-aliases/CoordinatorConfig.md +++ b/docs/api/type-aliases/CoordinatorConfig.md @@ -8,8 +8,6 @@ > **CoordinatorConfig** = `object` -Defined in: [types/agentNetwork.ts:1224](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1224) - Configuration for the coordinator ## Properties @@ -18,8 +16,6 @@ Configuration for the coordinator > **strategy**: [`CoordinationStrategy`](CoordinationStrategy.md) -Defined in: [types/agentNetwork.ts:1226](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1226) - Coordination strategy to use --- @@ -28,8 +24,6 @@ Coordination strategy to use > `optional` **maxConcurrency?**: `number` -Defined in: [types/agentNetwork.ts:1229](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1229) - Maximum concurrent agent executions (for parallel strategy) --- @@ -38,8 +32,6 @@ Maximum concurrent agent executions (for parallel strategy) > `optional` **agentTimeout?**: `number` -Defined in: [types/agentNetwork.ts:1232](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1232) - Timeout for individual agent execution in ms --- @@ -48,8 +40,6 @@ Timeout for individual agent execution in ms > `optional` **continueOnFailure?**: `boolean` -Defined in: [types/agentNetwork.ts:1235](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1235) - Whether to continue on agent failure --- @@ -58,8 +48,6 @@ Whether to continue on agent failure > `optional` **customCoordinator?**: (`agents`, `task`, `context`) => `Promise`\<[`CoordinationResult`](CoordinationResult.md)\> -Defined in: [types/agentNetwork.ts:1238](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1238) - Custom coordination logic (for custom strategy) #### Parameters @@ -86,8 +74,6 @@ Custom coordination logic (for custom strategy) > `optional` **retry?**: `object` -Defined in: [types/agentNetwork.ts:1245](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1245) - Retry configuration #### maxRetries diff --git a/docs/api/type-aliases/CoreMessage.md b/docs/api/type-aliases/CoreMessage.md index c83f895c5..0c1461c71 100644 --- a/docs/api/type-aliases/CoreMessage.md +++ b/docs/api/type-aliases/CoreMessage.md @@ -8,8 +8,6 @@ > **CoreMessage** = `object` -Defined in: [types/agentNetwork.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L394) - Core message format (simplified) ## Properties @@ -18,12 +16,8 @@ Core message format (simplified) > **role**: `"user"` \| `"assistant"` \| `"system"` -Defined in: [types/agentNetwork.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L395) - --- ### content > **content**: `string` - -Defined in: [types/agentNetwork.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L396) diff --git a/docs/api/type-aliases/CostAnalysisOptions.md b/docs/api/type-aliases/CostAnalysisOptions.md index 750b1cd66..626f5d457 100644 --- a/docs/api/type-aliases/CostAnalysisOptions.md +++ b/docs/api/type-aliases/CostAnalysisOptions.md @@ -8,28 +8,20 @@ > **CostAnalysisOptions** = `object` -Defined in: [types/analytics.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L189) - ## Properties ### timeRange? > `optional` **timeRange?**: [`TimeRangeOption`](TimeRangeOption.md) \| `string` -Defined in: [types/analytics.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L190) - --- ### groupBy? > `optional` **groupBy?**: `string` \| `string`[] -Defined in: [types/analytics.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L191) - --- ### includeProjections? > `optional` **includeProjections?**: `boolean` - -Defined in: [types/analytics.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L192) diff --git a/docs/api/type-aliases/CostAnalysisResult.md b/docs/api/type-aliases/CostAnalysisResult.md index d95c7a58c..be0d0376c 100644 --- a/docs/api/type-aliases/CostAnalysisResult.md +++ b/docs/api/type-aliases/CostAnalysisResult.md @@ -8,72 +8,54 @@ > **CostAnalysisResult** = `object` -Defined in: [types/analytics.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L208) - ## Properties ### totalCost > **totalCost**: `number` -Defined in: [types/analytics.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L209) - --- ### totalTokens > **totalTokens**: `number` -Defined in: [types/analytics.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L210) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/analytics.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L211) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/analytics.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L212) - --- ### requestCount > **requestCount**: `number` -Defined in: [types/analytics.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L213) - --- ### groups > **groups**: `Record`\<`string`, [`CostGroupItem`](CostGroupItem.md)\> -Defined in: [types/analytics.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L214) - --- ### providers > **providers**: [`CostGroupItem`](CostGroupItem.md)[] -Defined in: [types/analytics.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L215) - --- ### projections? > `optional` **projections?**: `object` -Defined in: [types/analytics.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L216) - #### nextMonth > **nextMonth**: `number` diff --git a/docs/api/type-aliases/CostEstimate.md b/docs/api/type-aliases/CostEstimate.md index 732f13142..d88045821 100644 --- a/docs/api/type-aliases/CostEstimate.md +++ b/docs/api/type-aliases/CostEstimate.md @@ -8,8 +8,6 @@ > **CostEstimate** = `object` -Defined in: [types/providers.ts:1897](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1897) - Cost estimation data ## Properties @@ -18,8 +16,6 @@ Cost estimation data > **estimatedCost**: `number` -Defined in: [types/providers.ts:1899](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1899) - Estimated cost in USD --- @@ -28,8 +24,6 @@ Estimated cost in USD > **currency**: `string` -Defined in: [types/providers.ts:1901](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1901) - Currency code --- @@ -38,8 +32,6 @@ Currency code > **breakdown**: `object` -Defined in: [types/providers.ts:1903](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1903) - Cost breakdown #### instanceCost @@ -66,8 +58,6 @@ Total processing hours > `optional` **period?**: `object` -Defined in: [types/providers.ts:1912](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1912) - Time period for estimate #### start diff --git a/docs/api/type-aliases/CostEstimationParams.md b/docs/api/type-aliases/CostEstimationParams.md index 8e79d1dc1..295e499c8 100644 --- a/docs/api/type-aliases/CostEstimationParams.md +++ b/docs/api/type-aliases/CostEstimationParams.md @@ -8,8 +8,6 @@ > **CostEstimationParams** = `object` -Defined in: [types/evaluationProviders.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L94) - Provider cost estimation parameters ## Properties @@ -18,28 +16,20 @@ Provider cost estimation parameters > **provider**: `string` -Defined in: [types/evaluationProviders.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L95) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/evaluationProviders.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L96) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/evaluationProviders.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L97) - --- ### model? > `optional` **model?**: `string` - -Defined in: [types/evaluationProviders.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L98) diff --git a/docs/api/type-aliases/CostGroupItem.md b/docs/api/type-aliases/CostGroupItem.md index 90143a929..9ad064e59 100644 --- a/docs/api/type-aliases/CostGroupItem.md +++ b/docs/api/type-aliases/CostGroupItem.md @@ -8,84 +8,62 @@ > **CostGroupItem** = `object` -Defined in: [types/analytics.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L195) - ## Properties ### groupKey > **groupKey**: `string` -Defined in: [types/analytics.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L196) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/analytics.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L197) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/analytics.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L198) - --- ### userId? > `optional` **userId?**: `string` -Defined in: [types/analytics.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L199) - --- ### totalCost > **totalCost**: `number` -Defined in: [types/analytics.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L200) - --- ### costPerToken > **costPerToken**: `number` -Defined in: [types/analytics.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L201) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/analytics.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L202) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/analytics.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L203) - --- ### totalTokens > **totalTokens**: `number` -Defined in: [types/analytics.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L204) - --- ### requestCount > **requestCount**: `number` - -Defined in: [types/analytics.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L205) diff --git a/docs/api/type-aliases/CreateRoutesOptions.md b/docs/api/type-aliases/CreateRoutesOptions.md index fc809e460..f5bb7b6b0 100644 --- a/docs/api/type-aliases/CreateRoutesOptions.md +++ b/docs/api/type-aliases/CreateRoutesOptions.md @@ -8,8 +8,6 @@ > **CreateRoutesOptions** = `object` -Defined in: [types/server.ts:1401](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1401) - Options for createAllRoutes / createRoutes. ## Properties @@ -18,16 +16,12 @@ Options for createAllRoutes / createRoutes. > `optional` **enableSwagger?**: `boolean` -Defined in: [types/server.ts:1402](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1402) - --- ### getRoutes? > `optional` **getRoutes?**: () => [`RouteDefinition`](RouteDefinition.md)[] -Defined in: [types/server.ts:1403](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1403) - #### Returns [`RouteDefinition`](RouteDefinition.md)[] @@ -38,8 +32,6 @@ Defined in: [types/server.ts:1403](https://github.com/juspay/neurolink/blob/rele > `optional` **proxy?**: `boolean` -Defined in: [types/server.ts:1405](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1405) - Enable every proxy door: Claude, OpenAI, Codex and Gemini. --- @@ -48,24 +40,18 @@ Enable every proxy door: Claude, OpenAI, Codex and Gemini. > `optional` **claudeProxy?**: `boolean` -Defined in: [types/server.ts:1406](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1406) - --- ### openaiProxy? > `optional` **openaiProxy?**: `boolean` -Defined in: [types/server.ts:1407](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1407) - --- ### codexProxy? > `optional` **codexProxy?**: `boolean` -Defined in: [types/server.ts:1415](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1415) - Enable the Codex door on its own. Codex was reachable only from `neurolink proxy start` until this existed — @@ -78,6 +64,4 @@ expose it even deliberately. > `optional` **geminiProxy?**: `boolean` -Defined in: [types/server.ts:1417](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1417) - Enable the Gemini door on its own, for the same reason. diff --git a/docs/api/type-aliases/CreateThinkingConfigOptions.md b/docs/api/type-aliases/CreateThinkingConfigOptions.md index 49b603510..0e3defa7d 100644 --- a/docs/api/type-aliases/CreateThinkingConfigOptions.md +++ b/docs/api/type-aliases/CreateThinkingConfigOptions.md @@ -8,8 +8,6 @@ > **CreateThinkingConfigOptions** = `object` -Defined in: [types/config.ts:627](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L627) - Options for creating a thinkingConfig from CLI-style options. ## Properties @@ -18,8 +16,6 @@ Options for creating a thinkingConfig from CLI-style options. > `optional` **thinking?**: `boolean` -Defined in: [types/config.ts:629](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L629) - Enable thinking mode --- @@ -28,8 +24,6 @@ Enable thinking mode > `optional` **thinkingBudget?**: `number` -Defined in: [types/config.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L631) - Token budget for thinking (defaults to 10000) --- @@ -38,6 +32,4 @@ Token budget for thinking (defaults to 10000) > `optional` **thinkingLevel?**: [`ThinkingLevel`](ThinkingLevel.md) -Defined in: [types/config.ts:633](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L633) - Thinking level for Gemini 3 models diff --git a/docs/api/type-aliases/CredentialValidationResult.md b/docs/api/type-aliases/CredentialValidationResult.md index 1cc213fad..b1c22a87d 100644 --- a/docs/api/type-aliases/CredentialValidationResult.md +++ b/docs/api/type-aliases/CredentialValidationResult.md @@ -8,8 +8,6 @@ > **CredentialValidationResult** = `object` -Defined in: [types/providers.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L388) - AWS Credential Validation Result ## Properties @@ -18,56 +16,42 @@ AWS Credential Validation Result > **isValid**: `boolean` -Defined in: [types/providers.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L389) - --- ### credentialSource > **credentialSource**: `string` -Defined in: [types/providers.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L390) - --- ### region > **region**: `string` -Defined in: [types/providers.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L391) - --- ### hasExpiration > **hasExpiration**: `boolean` -Defined in: [types/providers.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L392) - --- ### expirationTime? > `optional` **expirationTime?**: `Date` -Defined in: [types/providers.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L393) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/providers.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L394) - --- ### debugInfo > **debugInfo**: `object` -Defined in: [types/providers.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L395) - #### accessKeyId > **accessKeyId**: `string` diff --git a/docs/api/type-aliases/CronSchedule.md b/docs/api/type-aliases/CronSchedule.md index e06af8c33..c9255d088 100644 --- a/docs/api/type-aliases/CronSchedule.md +++ b/docs/api/type-aliases/CronSchedule.md @@ -8,24 +8,18 @@ > **CronSchedule** = `object` -Defined in: [types/task.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L54) - ## Properties ### type > **type**: `"cron"` -Defined in: [types/task.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L55) - --- ### expression > **expression**: `string` -Defined in: [types/task.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L57) - Standard 5-field cron expression, e.g. "0 9 \* \* \*" --- @@ -34,6 +28,4 @@ Standard 5-field cron expression, e.g. "0 9 \* \* \*" > `optional` **timezone?**: `string` -Defined in: [types/task.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L59) - IANA timezone, e.g. "America/New_York" diff --git a/docs/api/type-aliases/CustomAuthConfig.md b/docs/api/type-aliases/CustomAuthConfig.md index c64badc5e..db0cdda66 100644 --- a/docs/api/type-aliases/CustomAuthConfig.md +++ b/docs/api/type-aliases/CustomAuthConfig.md @@ -8,8 +8,6 @@ > **CustomAuthConfig** = `object` -Defined in: [types/auth.ts:827](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L827) - Custom auth provider configuration ## Properties @@ -18,8 +16,6 @@ Custom auth provider configuration > **validateToken**: (`token`, `context?`) => `Promise`\<[`TokenValidationResult`](TokenValidationResult.md)\> -Defined in: [types/auth.ts:829](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L829) - Custom token validation function #### Parameters @@ -42,8 +38,6 @@ Custom token validation function > `optional` **getUser?**: (`userId`) => `Promise`\<[`AuthUser`](AuthUser.md) \| `null`\> -Defined in: [types/auth.ts:834](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L834) - Custom user fetching function #### Parameters @@ -62,8 +56,6 @@ Custom user fetching function > `optional` **createSession?**: (`user`, `context?`) => `Promise`\<[`AuthSession`](AuthSession.md)\> -Defined in: [types/auth.ts:836](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L836) - Custom session creation function #### Parameters diff --git a/docs/api/type-aliases/CustomSchemaExtractorConfig.md b/docs/api/type-aliases/CustomSchemaExtractorConfig.md index d6a28f533..a301b9943 100644 --- a/docs/api/type-aliases/CustomSchemaExtractorConfig.md +++ b/docs/api/type-aliases/CustomSchemaExtractorConfig.md @@ -8,8 +8,6 @@ > **CustomSchemaExtractorConfig** = [`BaseExtractorConfig`](BaseExtractorConfig.md) & `object` -Defined in: [types/rag.ts:1145](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1145) - Custom schema extractor configuration ## Type Declaration diff --git a/docs/api/type-aliases/DIDTalkResponse.md b/docs/api/type-aliases/DIDTalkResponse.md index 7cf63edb2..800bbb003 100644 --- a/docs/api/type-aliases/DIDTalkResponse.md +++ b/docs/api/type-aliases/DIDTalkResponse.md @@ -8,8 +8,6 @@ > **DIDTalkResponse** = `object` -Defined in: [types/avatar.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L156) - D-ID `/talks` API response shape. Used by `DIDAvatar` handler to type-check upstream responses. Lives here @@ -22,32 +20,24 @@ the types barrel. > **id**: `string` -Defined in: [types/avatar.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L157) - --- ### status? > `optional` **status?**: `string` -Defined in: [types/avatar.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L158) - --- ### result_url? > `optional` **result_url?**: `string` -Defined in: [types/avatar.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L159) - --- ### error? > `optional` **error?**: `object` -Defined in: [types/avatar.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L160) - #### kind? > `optional` **kind?**: `string` @@ -61,5 +51,3 @@ Defined in: [types/avatar.ts:160](https://github.com/juspay/neurolink/blob/relea ### duration? > `optional` **duration?**: `number` - -Defined in: [types/avatar.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L161) diff --git a/docs/api/type-aliases/DataContent.md b/docs/api/type-aliases/DataContent.md index 8f10046ae..a756aa28c 100644 --- a/docs/api/type-aliases/DataContent.md +++ b/docs/api/type-aliases/DataContent.md @@ -7,5 +7,3 @@ # Type Alias: DataContent > **DataContent** = `string` \| `Uint8Array` \| `ArrayBuffer` \| `Buffer` - -Defined in: [types/aiCompat.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L203) diff --git a/docs/api/type-aliases/DataStreamEvent.md b/docs/api/type-aliases/DataStreamEvent.md index cd8509b1b..bbdadb312 100644 --- a/docs/api/type-aliases/DataStreamEvent.md +++ b/docs/api/type-aliases/DataStreamEvent.md @@ -8,8 +8,6 @@ > **DataStreamEvent** = `object` -Defined in: [types/server.ts:1299](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1299) - Base data stream event ## Properties @@ -18,28 +16,20 @@ Base data stream event > **type**: [`DataStreamEventType`](DataStreamEventType.md) -Defined in: [types/server.ts:1300](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1300) - --- ### id? > `optional` **id?**: `string` -Defined in: [types/server.ts:1301](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1301) - --- ### timestamp > **timestamp**: `number` -Defined in: [types/server.ts:1302](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1302) - --- ### data > **data**: `unknown` - -Defined in: [types/server.ts:1303](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1303) diff --git a/docs/api/type-aliases/DataStreamEventType.md b/docs/api/type-aliases/DataStreamEventType.md index 5e3eb4f4a..b6f380bd5 100644 --- a/docs/api/type-aliases/DataStreamEventType.md +++ b/docs/api/type-aliases/DataStreamEventType.md @@ -7,5 +7,3 @@ # Type Alias: DataStreamEventType > **DataStreamEventType** = `"text-start"` \| `"text-delta"` \| `"text-end"` \| `"tool-call"` \| `"tool-result"` \| `"data"` \| `"error"` \| `"finish"` - -Defined in: [types/server.ts:1327](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1327) diff --git a/docs/api/type-aliases/DataStreamResponseConfig.md b/docs/api/type-aliases/DataStreamResponseConfig.md index c4bf26c6b..c95703057 100644 --- a/docs/api/type-aliases/DataStreamResponseConfig.md +++ b/docs/api/type-aliases/DataStreamResponseConfig.md @@ -8,8 +8,6 @@ > **DataStreamResponseConfig** = `object` -Defined in: [types/server.ts:1446](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1446) - Configuration for the DataStreamResponse wrapper. ## Properties @@ -18,28 +16,20 @@ Configuration for the DataStreamResponse wrapper. > `optional` **contentType?**: `"text/event-stream"` \| `"application/x-ndjson"` -Defined in: [types/server.ts:1447](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1447) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/server.ts:1448](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1448) - --- ### keepAliveInterval? > `optional` **keepAliveInterval?**: `number` -Defined in: [types/server.ts:1449](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1449) - --- ### includeTimestamps? > `optional` **includeTimestamps?**: `boolean` - -Defined in: [types/server.ts:1450](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1450) diff --git a/docs/api/type-aliases/DataStreamWriter.md b/docs/api/type-aliases/DataStreamWriter.md index 352defb33..da3efa8f2 100644 --- a/docs/api/type-aliases/DataStreamWriter.md +++ b/docs/api/type-aliases/DataStreamWriter.md @@ -8,8 +8,6 @@ > **DataStreamWriter** = `object` -Defined in: [types/server.ts:864](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L864) - Data stream writer interface ## Methods @@ -18,8 +16,6 @@ Data stream writer interface > **writeTextStart**(`id`): `Promise`\<`void`\> -Defined in: [types/server.ts:866](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L866) - Write text start event #### Parameters @@ -38,8 +34,6 @@ Write text start event > **writeTextDelta**(`id`, `delta`): `Promise`\<`void`\> -Defined in: [types/server.ts:869](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L869) - Write text delta event #### Parameters @@ -62,8 +56,6 @@ Write text delta event > **writeTextEnd**(`id`): `Promise`\<`void`\> -Defined in: [types/server.ts:872](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L872) - Write text end event #### Parameters @@ -82,8 +74,6 @@ Write text end event > **writeToolCall**(`toolCall`): `Promise`\<`void`\> -Defined in: [types/server.ts:875](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L875) - Write tool call event #### Parameters @@ -112,8 +102,6 @@ Write tool call event > **writeToolResult**(`toolResult`): `Promise`\<`void`\> -Defined in: [types/server.ts:882](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L882) - Write tool result event #### Parameters @@ -142,8 +130,6 @@ Write tool result event > **writeData**(`data`): `Promise`\<`void`\> -Defined in: [types/server.ts:889](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L889) - Write arbitrary data event #### Parameters @@ -162,8 +148,6 @@ Write arbitrary data event > **writeError**(`error`): `Promise`\<`void`\> -Defined in: [types/server.ts:892](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L892) - Write error event #### Parameters @@ -188,8 +172,6 @@ Write error event > **close**(): `Promise`\<`void`\> -Defined in: [types/server.ts:895](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L895) - Close the stream #### Returns diff --git a/docs/api/type-aliases/DataStreamWriterConfig.md b/docs/api/type-aliases/DataStreamWriterConfig.md index 0965848d3..b62f9bc2d 100644 --- a/docs/api/type-aliases/DataStreamWriterConfig.md +++ b/docs/api/type-aliases/DataStreamWriterConfig.md @@ -8,8 +8,6 @@ > **DataStreamWriterConfig** = `object` -Defined in: [types/server.ts:1438](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1438) - Configuration for DataStreamWriter. ## Properties @@ -18,8 +16,6 @@ Configuration for DataStreamWriter. > **write**: (`chunk`) => `void` \| `Promise`\<`void`\> -Defined in: [types/server.ts:1439](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1439) - #### Parameters ##### chunk @@ -36,8 +32,6 @@ Defined in: [types/server.ts:1439](https://github.com/juspay/neurolink/blob/rele > `optional` **close?**: () => `void` \| `Promise`\<`void`\> -Defined in: [types/server.ts:1440](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1440) - #### Returns `void` \| `Promise`\<`void`\> @@ -48,12 +42,8 @@ Defined in: [types/server.ts:1440](https://github.com/juspay/neurolink/blob/rele > `optional` **format?**: `"sse"` \| `"ndjson"` -Defined in: [types/server.ts:1441](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1441) - --- ### includeTimestamps? > `optional` **includeTimestamps?**: `boolean` - -Defined in: [types/server.ts:1442](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1442) diff --git a/docs/api/type-aliases/DatadogExporterConfig.md b/docs/api/type-aliases/DatadogExporterConfig.md index 78bbde974..fed1cd3e6 100644 --- a/docs/api/type-aliases/DatadogExporterConfig.md +++ b/docs/api/type-aliases/DatadogExporterConfig.md @@ -8,8 +8,6 @@ > **DatadogExporterConfig** = [`ExporterConfig`](ExporterConfig.md) & `object` -Defined in: [types/exporter.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L97) - Datadog exporter configuration ## Type Declaration diff --git a/docs/api/type-aliases/DebugResult.md b/docs/api/type-aliases/DebugResult.md index 0c185e887..7ef1d4e8d 100644 --- a/docs/api/type-aliases/DebugResult.md +++ b/docs/api/type-aliases/DebugResult.md @@ -8,8 +8,6 @@ > **DebugResult** = `object` -Defined in: [types/mcp.ts:2661](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2661) - Result of the AI debugging workflow. ## Properties @@ -18,8 +16,6 @@ Result of the AI debugging workflow. > **issues**: `object`[] -Defined in: [types/mcp.ts:2662](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2662) - #### type > **type**: `string` @@ -42,20 +38,14 @@ Defined in: [types/mcp.ts:2662](https://github.com/juspay/neurolink/blob/release > **suggestions**: `string`[] -Defined in: [types/mcp.ts:2668](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2668) - --- ### possibleCauses > **possibleCauses**: `string`[] -Defined in: [types/mcp.ts:2669](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2669) - --- ### fixedOutput? > `optional` **fixedOutput?**: `string` - -Defined in: [types/mcp.ts:2670](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2670) diff --git a/docs/api/type-aliases/DecisionAnswer.md b/docs/api/type-aliases/DecisionAnswer.md index 685949e9b..d339b8d41 100644 --- a/docs/api/type-aliases/DecisionAnswer.md +++ b/docs/api/type-aliases/DecisionAnswer.md @@ -7,5 +7,3 @@ # Type Alias: DecisionAnswer > **DecisionAnswer** = [`DecisionBooleanAnswer`](DecisionBooleanAnswer.md) \| [`DecisionChoiceAnswer`](DecisionChoiceAnswer.md) \| [`DecisionScoreAnswer`](DecisionScoreAnswer.md) - -Defined in: [types/decision.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L110) diff --git a/docs/api/type-aliases/DecisionAnswerMap.md b/docs/api/type-aliases/DecisionAnswerMap.md index a85b370c6..3d645e0b2 100644 --- a/docs/api/type-aliases/DecisionAnswerMap.md +++ b/docs/api/type-aliases/DecisionAnswerMap.md @@ -7,5 +7,3 @@ # Type Alias: DecisionAnswerMap > **DecisionAnswerMap** = `Readonly`\<`Record`\<`string`, [`DecisionAnswer`](DecisionAnswer.md)\>\> - -Defined in: [types/decision.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L115) diff --git a/docs/api/type-aliases/DecisionBooleanAnswer.md b/docs/api/type-aliases/DecisionBooleanAnswer.md index ba0783801..10df3269e 100644 --- a/docs/api/type-aliases/DecisionBooleanAnswer.md +++ b/docs/api/type-aliases/DecisionBooleanAnswer.md @@ -8,22 +8,16 @@ > **DecisionBooleanAnswer** = `object` -Defined in: [types/decision.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L83) - ## Properties ### type > **type**: `"boolean"` -Defined in: [types/decision.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L84) - --- ### probability > **probability**: `number` -Defined in: [types/decision.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L86) - Probability the statement is true, 0–1. diff --git a/docs/api/type-aliases/DecisionBooleanGate.md b/docs/api/type-aliases/DecisionBooleanGate.md index 401a988cb..ecbb35c22 100644 --- a/docs/api/type-aliases/DecisionBooleanGate.md +++ b/docs/api/type-aliases/DecisionBooleanGate.md @@ -8,8 +8,6 @@ > **DecisionBooleanGate** = `object` -Defined in: [types/decision.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L264) - Shared gate for acting on a yes/no answer. A `boolean` answer carries no confidence of its own, so two separate bars @@ -23,8 +21,6 @@ as a yes. > `optional` **minProbability?**: `number` -Defined in: [types/decision.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L266) - Minimum probability to read the answer as "yes". Default 0.5. --- @@ -33,6 +29,4 @@ Minimum probability to read the answer as "yes". Default 0.5. > `optional` **minConfidence?**: `number` -Defined in: [types/decision.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L268) - Minimum [decisionBooleanConfidence](../functions/decisionBooleanConfidence.md) to act at all. Default 0.4. diff --git a/docs/api/type-aliases/DecisionBooleanQuestion.md b/docs/api/type-aliases/DecisionBooleanQuestion.md index b4ba5b41e..1657aace6 100644 --- a/docs/api/type-aliases/DecisionBooleanQuestion.md +++ b/docs/api/type-aliases/DecisionBooleanQuestion.md @@ -8,8 +8,6 @@ > **DecisionBooleanQuestion** = `object` -Defined in: [types/decision.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L43) - A yes/no question. Answered with a probability and **no confidence of its own** — gate it on distance from 0.5 via [decisionBooleanConfidence](../functions/decisionBooleanConfidence.md). @@ -19,24 +17,18 @@ own** — gate it on distance from 0.5 via [decisionBooleanConfidence](../functi > **type**: `"boolean"` -Defined in: [types/decision.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L44) - --- ### instructions > **instructions**: [`DecisionInput`](DecisionInput.md) -Defined in: [types/decision.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L45) - --- ### criteria? > `optional` **criteria?**: `object` -Defined in: [types/decision.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L47) - Optional descriptions of what a yes and a no mean. #### true? diff --git a/docs/api/type-aliases/DecisionCallerFn.md b/docs/api/type-aliases/DecisionCallerFn.md index 67c75695e..6f2f06d86 100644 --- a/docs/api/type-aliases/DecisionCallerFn.md +++ b/docs/api/type-aliases/DecisionCallerFn.md @@ -8,8 +8,6 @@ > **DecisionCallerFn** = (`options`) => `Promise`\<[`DecisionResult`](DecisionResult.md) \| `null`\> -Defined in: [types/decision.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L252) - Injected fail-open decision caller — typically a bound `NeuroLink.tryDecide`, which returns `null` on any failure rather than throwing. diff --git a/docs/api/type-aliases/DecisionChoiceAnswer.md b/docs/api/type-aliases/DecisionChoiceAnswer.md index 23e47c0be..50934ccfc 100644 --- a/docs/api/type-aliases/DecisionChoiceAnswer.md +++ b/docs/api/type-aliases/DecisionChoiceAnswer.md @@ -8,24 +8,18 @@ > **DecisionChoiceAnswer** = `object` -Defined in: [types/decision.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L89) - ## Properties ### type > **type**: `"choice"` -Defined in: [types/decision.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L90) - --- ### choice > **choice**: `string` -Defined in: [types/decision.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L92) - The highest-probability option name. --- @@ -34,8 +28,6 @@ The highest-probability option name. > **probabilities**: `Readonly`\<`Record`\<`string`, `number`\>\> -Defined in: [types/decision.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L94) - Every option mapped to its probability. Key order is not stable. --- @@ -44,6 +36,4 @@ Every option mapped to its probability. Key order is not stable. > **confidence**: `number` -Defined in: [types/decision.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L96) - Calibrated certainty, 0–1, derived from the distribution. diff --git a/docs/api/type-aliases/DecisionChoiceQuestion.md b/docs/api/type-aliases/DecisionChoiceQuestion.md index 0cca43eb4..2416532be 100644 --- a/docs/api/type-aliases/DecisionChoiceQuestion.md +++ b/docs/api/type-aliases/DecisionChoiceQuestion.md @@ -8,8 +8,6 @@ > **DecisionChoiceQuestion** = `object` -Defined in: [types/decision.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L59) - Pick one option. `criteria` maps option name → rubric description. The answer carries the full probability distribution, not just the winner, @@ -21,20 +19,14 @@ so a single choice question over N options also **ranks** all N. > **type**: `"choice"` -Defined in: [types/decision.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L60) - --- ### instructions > **instructions**: [`DecisionInput`](DecisionInput.md) -Defined in: [types/decision.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L61) - --- ### criteria > **criteria**: `Readonly`\<`Record`\<`string`, [`DecisionInput`](DecisionInput.md) \| `null`\>\> - -Defined in: [types/decision.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L62) diff --git a/docs/api/type-aliases/DecisionChoiceReading.md b/docs/api/type-aliases/DecisionChoiceReading.md index 54a3221ab..fc9106691 100644 --- a/docs/api/type-aliases/DecisionChoiceReading.md +++ b/docs/api/type-aliases/DecisionChoiceReading.md @@ -8,8 +8,6 @@ > **DecisionChoiceReading** = `object` -Defined in: [types/decision.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L209) - Narrowed view of a choice answer, safe to consume without re-narrowing. Returned by the reader helpers so call sites need no type assertion. @@ -19,31 +17,23 @@ Returned by the reader helpers so call sites need no type assertion. > **choice**: `string` -Defined in: [types/decision.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L210) - --- ### confidence > **confidence**: `number` -Defined in: [types/decision.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L211) - --- ### probabilities > **probabilities**: `Readonly`\<`Record`\<`string`, `number`\>\> -Defined in: [types/decision.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L212) - --- ### ranked > **ranked**: readonly `object`[] -Defined in: [types/decision.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L217) - Every option ordered by probability, highest first. A choice question is therefore also a ranking — the basis for catalogue selection. diff --git a/docs/api/type-aliases/DecisionError.md b/docs/api/type-aliases/DecisionError.md index 797135b6f..79e5ed7d7 100644 --- a/docs/api/type-aliases/DecisionError.md +++ b/docs/api/type-aliases/DecisionError.md @@ -8,46 +8,34 @@ > **DecisionError** = `object` -Defined in: [types/decision.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L189) - ## Properties ### kind > **kind**: [`DecisionErrorKind`](DecisionErrorKind.md) -Defined in: [types/decision.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L190) - --- ### message > **message**: `string` -Defined in: [types/decision.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L191) - --- ### status? > `optional` **status?**: `number` -Defined in: [types/decision.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L192) - --- ### requestId? > `optional` **requestId?**: `string` -Defined in: [types/decision.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L193) - --- ### retryable > **retryable**: `boolean` -Defined in: [types/decision.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L195) - True when a retry could plausibly succeed. diff --git a/docs/api/type-aliases/DecisionErrorKind.md b/docs/api/type-aliases/DecisionErrorKind.md index 4ab394571..e34d2f74d 100644 --- a/docs/api/type-aliases/DecisionErrorKind.md +++ b/docs/api/type-aliases/DecisionErrorKind.md @@ -8,7 +8,5 @@ > **DecisionErrorKind** = `"authentication"` \| `"invalid_request"` \| `"max_tokens_exceeded"` \| `"rate_limit"` \| `"overloaded"` \| `"server"` \| `"timeout"` \| `"network"` -Defined in: [types/decision.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L179) - Why a decision call failed, normalised across vendors. TypeSafe alone returns two different error envelopes, so a provider must flatten them. diff --git a/docs/api/type-aliases/DecisionInput.md b/docs/api/type-aliases/DecisionInput.md index 0184850f0..cb3b0b38d 100644 --- a/docs/api/type-aliases/DecisionInput.md +++ b/docs/api/type-aliases/DecisionInput.md @@ -8,8 +8,6 @@ > **DecisionInput** = `string` \| `number` \| `boolean` \| readonly `DecisionInput`[] \| \{\[`key`: `string`\]: `DecisionInput`; \} -Defined in: [types/decision.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L29) - Anything a decision model accepts as free-form content. `state` may be a plain string or structured JSON (chat logs, records); `instructions` and `criteria` values likewise. diff --git a/docs/api/type-aliases/DecisionLimits.md b/docs/api/type-aliases/DecisionLimits.md index 4f17b52fd..d661cf4de 100644 --- a/docs/api/type-aliases/DecisionLimits.md +++ b/docs/api/type-aliases/DecisionLimits.md @@ -8,8 +8,6 @@ > **DecisionLimits** = `object` -Defined in: [types/decision.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L154) - Input a decision provider can actually read, declared on its descriptor. A request over either limit is refused before any network call with @@ -23,8 +21,6 @@ silently cut off. Every internal consumer already treats that error as > **maxStateTokens**: `number` -Defined in: [types/decision.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L160) - Estimated tokens of `state` (serialized first when it is not a string) for any model NOT listed in `models` — an alias, a typo, a self-hosted name — so it should be the tightest window the provider has. @@ -35,16 +31,12 @@ name — so it should be the tightest window the provider has. > **maxQuestions**: `number` -Defined in: [types/decision.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L161) - --- ### nonAsciiTokensPerChar? > `optional` **nonAsciiTokensPerChar?**: `number` -Defined in: [types/decision.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L168) - Tokens charged per non-ASCII character. The default estimate assumes ~4 characters per token, which holds for English and is several times too generous for other scripts on an English tokenizer. Absent = default @@ -56,6 +48,4 @@ estimate for every character. > `optional` **models?**: `Readonly`\<`Record`\<`string`, \{ `maxStateTokens`: `number`; `nonAsciiTokensPerChar?`: `number`; \}\>\> -Defined in: [types/decision.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L170) - Per-model limits, keyed by model id; each field overrides the one above. diff --git a/docs/api/type-aliases/DecisionModelCard.md b/docs/api/type-aliases/DecisionModelCard.md index 5627d26d4..d33f65533 100644 --- a/docs/api/type-aliases/DecisionModelCard.md +++ b/docs/api/type-aliases/DecisionModelCard.md @@ -8,8 +8,6 @@ > **DecisionModelCard** = `object` -Defined in: [types/decision.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L199) - One entry from a decision provider's model listing. ## Properties @@ -18,20 +16,14 @@ One entry from a decision provider's model listing. > **name**: `string` -Defined in: [types/decision.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L200) - --- ### description > **description**: `string` -Defined in: [types/decision.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L201) - --- ### releaseDate > **releaseDate**: `string` - -Defined in: [types/decision.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L202) diff --git a/docs/api/type-aliases/DecisionOptions.md b/docs/api/type-aliases/DecisionOptions.md index fd46b775e..d9f67f923 100644 --- a/docs/api/type-aliases/DecisionOptions.md +++ b/docs/api/type-aliases/DecisionOptions.md @@ -8,8 +8,6 @@ > **DecisionOptions** = [`DecisionRequest`](DecisionRequest.md) & `object` -Defined in: [types/decision.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L231) - What `NeuroLink.decide()` accepts: a decision request plus the usual provider/credential selection every inference type shares. diff --git a/docs/api/type-aliases/DecisionQuestion.md b/docs/api/type-aliases/DecisionQuestion.md index 90dfec638..ef6965031 100644 --- a/docs/api/type-aliases/DecisionQuestion.md +++ b/docs/api/type-aliases/DecisionQuestion.md @@ -7,5 +7,3 @@ # Type Alias: DecisionQuestion > **DecisionQuestion** = [`DecisionBooleanQuestion`](DecisionBooleanQuestion.md) \| [`DecisionChoiceQuestion`](DecisionChoiceQuestion.md) \| [`DecisionScoreQuestion`](DecisionScoreQuestion.md) - -Defined in: [types/decision.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L75) diff --git a/docs/api/type-aliases/DecisionQuestionMap.md b/docs/api/type-aliases/DecisionQuestionMap.md index 4493f1a53..bb5fbc132 100644 --- a/docs/api/type-aliases/DecisionQuestionMap.md +++ b/docs/api/type-aliases/DecisionQuestionMap.md @@ -8,6 +8,4 @@ > **DecisionQuestionMap** = `Readonly`\<`Record`\<`string`, [`DecisionQuestion`](DecisionQuestion.md)\>\> -Defined in: [types/decision.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L81) - Questions keyed by an id you choose; answers return under the same ids. diff --git a/docs/api/type-aliases/DecisionRequest.md b/docs/api/type-aliases/DecisionRequest.md index b719aa76f..89756be27 100644 --- a/docs/api/type-aliases/DecisionRequest.md +++ b/docs/api/type-aliases/DecisionRequest.md @@ -8,32 +8,24 @@ > **DecisionRequest** = `object` -Defined in: [types/decision.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L122) - ## Properties ### state > **state**: [`DecisionState`](DecisionState.md) -Defined in: [types/decision.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L123) - --- ### questions > **questions**: [`DecisionQuestionMap`](DecisionQuestionMap.md) -Defined in: [types/decision.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L124) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/decision.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L126) - Overrides the provider's configured model for this call only. --- @@ -42,14 +34,10 @@ Overrides the provider's configured model for this call only. > `optional` **signal?**: `AbortSignal` -Defined in: [types/decision.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L127) - --- ### timeoutMs? > `optional` **timeoutMs?**: `number` -Defined in: [types/decision.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L129) - Overrides the configured timeout for this call only. diff --git a/docs/api/type-aliases/DecisionResult.md b/docs/api/type-aliases/DecisionResult.md index 08086f194..01f268b91 100644 --- a/docs/api/type-aliases/DecisionResult.md +++ b/docs/api/type-aliases/DecisionResult.md @@ -8,16 +8,12 @@ > **DecisionResult** = `object` -Defined in: [types/decision.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L132) - ## Properties ### model > **model**: `string` -Defined in: [types/decision.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L134) - The RESOLVED model id (e.g. "jev-1.13.0"), not the alias sent. --- @@ -26,32 +22,24 @@ The RESOLVED model id (e.g. "jev-1.13.0"), not the alias sent. > **provider**: `string` -Defined in: [types/decision.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L135) - --- ### answers > **answers**: [`DecisionAnswerMap`](DecisionAnswerMap.md) -Defined in: [types/decision.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L136) - --- ### usage > **usage**: [`DecisionUsage`](DecisionUsage.md) -Defined in: [types/decision.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L137) - --- ### requestId? > `optional` **requestId?**: `string` -Defined in: [types/decision.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L139) - Vendor request id, for support escalation. --- @@ -60,8 +48,6 @@ Vendor request id, for support escalation. > **latencyMs**: `number` -Defined in: [types/decision.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L141) - Wall-clock round trip measured client-side. --- @@ -70,6 +56,4 @@ Wall-clock round trip measured client-side. > `optional` **upstreamMs?**: `number` -Defined in: [types/decision.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L143) - Server-side time behind the edge; isolates model time from network. diff --git a/docs/api/type-aliases/DecisionScoreAnswer.md b/docs/api/type-aliases/DecisionScoreAnswer.md index 2183ac072..bc7846793 100644 --- a/docs/api/type-aliases/DecisionScoreAnswer.md +++ b/docs/api/type-aliases/DecisionScoreAnswer.md @@ -8,24 +8,18 @@ > **DecisionScoreAnswer** = `object` -Defined in: [types/decision.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L99) - ## Properties ### type > **type**: `"score"` -Defined in: [types/decision.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L100) - --- ### score > **score**: `number` -Defined in: [types/decision.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L102) - Probability-weighted level index; lands between levels. --- @@ -34,8 +28,6 @@ Probability-weighted level index; lands between levels. > **legend**: `Readonly`\<`Record`\<`string`, `string`\>\> -Defined in: [types/decision.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L104) - Level index (as a string key) → the description supplied. --- @@ -44,8 +36,6 @@ Level index (as a string key) → the description supplied. > **probabilities**: `Readonly`\<`Record`\<`string`, `number`\>\> -Defined in: [types/decision.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L106) - Level index (as a string key) → probability. --- @@ -53,5 +43,3 @@ Level index (as a string key) → probability. ### confidence > **confidence**: `number` - -Defined in: [types/decision.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L107) diff --git a/docs/api/type-aliases/DecisionScoreQuestion.md b/docs/api/type-aliases/DecisionScoreQuestion.md index e7773c8b5..8211e9627 100644 --- a/docs/api/type-aliases/DecisionScoreQuestion.md +++ b/docs/api/type-aliases/DecisionScoreQuestion.md @@ -8,8 +8,6 @@ > **DecisionScoreQuestion** = `object` -Defined in: [types/decision.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L69) - Rate against an ordered rubric. The answer is the **0-based index**, so a four-level rubric scores 0–3. At least two levels are required. @@ -19,20 +17,14 @@ four-level rubric scores 0–3. At least two levels are required. > **type**: `"score"` -Defined in: [types/decision.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L70) - --- ### instructions > **instructions**: [`DecisionInput`](DecisionInput.md) -Defined in: [types/decision.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L71) - --- ### criteria > **criteria**: readonly ([`DecisionInput`](DecisionInput.md) \| `null`)[] - -Defined in: [types/decision.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L72) diff --git a/docs/api/type-aliases/DecisionScoreReading.md b/docs/api/type-aliases/DecisionScoreReading.md index c111a691d..debad3890 100644 --- a/docs/api/type-aliases/DecisionScoreReading.md +++ b/docs/api/type-aliases/DecisionScoreReading.md @@ -8,36 +8,26 @@ > **DecisionScoreReading** = `object` -Defined in: [types/decision.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L220) - ## Properties ### score > **score**: `number` -Defined in: [types/decision.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L221) - --- ### confidence > **confidence**: `number` -Defined in: [types/decision.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L222) - --- ### legend > **legend**: `Readonly`\<`Record`\<`string`, `string`\>\> -Defined in: [types/decision.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L223) - --- ### probabilities > **probabilities**: `Readonly`\<`Record`\<`string`, `number`\>\> - -Defined in: [types/decision.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L224) diff --git a/docs/api/type-aliases/DecisionState.md b/docs/api/type-aliases/DecisionState.md index 7ccee5fbd..1717d29cd 100644 --- a/docs/api/type-aliases/DecisionState.md +++ b/docs/api/type-aliases/DecisionState.md @@ -8,6 +8,4 @@ > **DecisionState** = [`DecisionInput`](DecisionInput.md) -Defined in: [types/decision.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L37) - The content being judged. One shared state per request. diff --git a/docs/api/type-aliases/DecisionUsage.md b/docs/api/type-aliases/DecisionUsage.md index 3a60f6ae4..d16ad904f 100644 --- a/docs/api/type-aliases/DecisionUsage.md +++ b/docs/api/type-aliases/DecisionUsage.md @@ -8,20 +8,14 @@ > **DecisionUsage** = `object` -Defined in: [types/decision.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L117) - ## Properties ### inputTokens > **inputTokens**: `number` -Defined in: [types/decision.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L118) - --- ### outputTokens > **outputTokens**: `number` - -Defined in: [types/decision.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/decision.ts#L119) diff --git a/docs/api/type-aliases/DecodedBuffer.md b/docs/api/type-aliases/DecodedBuffer.md index 7e11d1ed6..c70ea9086 100644 --- a/docs/api/type-aliases/DecodedBuffer.md +++ b/docs/api/type-aliases/DecodedBuffer.md @@ -8,8 +8,6 @@ > **DecodedBuffer** = `object` -Defined in: [types/file.ts:452](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L452) - Result of decoding a buffer with encoding detection (#362). ## Properties @@ -18,8 +16,6 @@ Result of decoding a buffer with encoding detection (#362). > **text**: `string` -Defined in: [types/file.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L454) - Decoded text with any BOM removed. --- @@ -28,8 +24,6 @@ Decoded text with any BOM removed. > **encoding**: `string` -Defined in: [types/file.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L456) - iconv-lite label actually used to decode. --- @@ -38,6 +32,4 @@ iconv-lite label actually used to decode. > **confidence**: `number` -Defined in: [types/file.ts:458](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L458) - Detection confidence 0-100 (100 for BOM/override, 0 for the UTF-8 fallback). diff --git a/docs/api/type-aliases/DeduplicationResult.md b/docs/api/type-aliases/DeduplicationResult.md index 9ce519895..290c14a82 100644 --- a/docs/api/type-aliases/DeduplicationResult.md +++ b/docs/api/type-aliases/DeduplicationResult.md @@ -8,8 +8,6 @@ > **DeduplicationResult** = `object` -Defined in: [types/context.ts:1030](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1030) - Result of file read deduplication (Stage 2). ## Properties @@ -18,20 +16,14 @@ Result of file read deduplication (Stage 2). > **deduplicated**: `boolean` -Defined in: [types/context.ts:1031](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1031) - --- ### messages > **messages**: [`ChatMessage`](ChatMessage.md)[] -Defined in: [types/context.ts:1032](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1032) - --- ### filesDeduped > **filesDeduped**: `number` - -Defined in: [types/context.ts:1033](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1033) diff --git a/docs/api/type-aliases/DeepgramAlternative.md b/docs/api/type-aliases/DeepgramAlternative.md index fce1d083f..1ff35abee 100644 --- a/docs/api/type-aliases/DeepgramAlternative.md +++ b/docs/api/type-aliases/DeepgramAlternative.md @@ -8,40 +8,30 @@ > **DeepgramAlternative** = `object` -Defined in: [types/stt.ts:443](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L443) - ## Properties ### transcript > **transcript**: `string` -Defined in: [types/stt.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L444) - --- ### confidence > **confidence**: `number` -Defined in: [types/stt.ts:445](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L445) - --- ### words > **words**: [`DeepgramWord`](DeepgramWord.md)[] -Defined in: [types/stt.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L446) - --- ### paragraphs? > `optional` **paragraphs?**: `object` -Defined in: [types/stt.ts:447](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L447) - #### transcript > **transcript**: `string` diff --git a/docs/api/type-aliases/DeepgramChannel.md b/docs/api/type-aliases/DeepgramChannel.md index c0c047ad0..798c6cd93 100644 --- a/docs/api/type-aliases/DeepgramChannel.md +++ b/docs/api/type-aliases/DeepgramChannel.md @@ -8,12 +8,8 @@ > **DeepgramChannel** = `object` -Defined in: [types/stt.ts:459](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L459) - ## Properties ### alternatives > **alternatives**: [`DeepgramAlternative`](DeepgramAlternative.md)[] - -Defined in: [types/stt.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L460) diff --git a/docs/api/type-aliases/DeepgramModel.md b/docs/api/type-aliases/DeepgramModel.md index 0cdb2487b..d953f2928 100644 --- a/docs/api/type-aliases/DeepgramModel.md +++ b/docs/api/type-aliases/DeepgramModel.md @@ -7,5 +7,3 @@ # Type Alias: DeepgramModel > **DeepgramModel** = `"nova-2"` \| `"nova-2-general"` \| `"nova-2-meeting"` \| `"nova-2-phonecall"` \| `"nova-2-voicemail"` \| `"nova-2-finance"` \| `"nova-2-medical"` \| `"nova"` \| `"enhanced"` \| `"base"` - -Defined in: [types/stt.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L303) diff --git a/docs/api/type-aliases/DeepgramResponse.md b/docs/api/type-aliases/DeepgramResponse.md index 888ea3a07..48c70450d 100644 --- a/docs/api/type-aliases/DeepgramResponse.md +++ b/docs/api/type-aliases/DeepgramResponse.md @@ -8,16 +8,12 @@ > **DeepgramResponse** = `object` -Defined in: [types/stt.ts:479](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L479) - ## Properties ### metadata > **metadata**: `object` -Defined in: [types/stt.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L480) - #### request_id > **request_id**: `string` @@ -55,5 +51,3 @@ Defined in: [types/stt.ts:480](https://github.com/juspay/neurolink/blob/release/ ### results > **results**: [`DeepgramResult`](DeepgramResult.md) - -Defined in: [types/stt.ts:490](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L490) diff --git a/docs/api/type-aliases/DeepgramResult.md b/docs/api/type-aliases/DeepgramResult.md index 4a912186f..8836665d6 100644 --- a/docs/api/type-aliases/DeepgramResult.md +++ b/docs/api/type-aliases/DeepgramResult.md @@ -8,20 +8,14 @@ > **DeepgramResult** = `object` -Defined in: [types/stt.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L474) - ## Properties ### channels > **channels**: [`DeepgramChannel`](DeepgramChannel.md)[] -Defined in: [types/stt.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L475) - --- ### utterances? > `optional` **utterances?**: [`DeepgramUtterance`](DeepgramUtterance.md)[] - -Defined in: [types/stt.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L476) diff --git a/docs/api/type-aliases/DeepgramSTTOptions.md b/docs/api/type-aliases/DeepgramSTTOptions.md index 87493ee2d..abd652e08 100644 --- a/docs/api/type-aliases/DeepgramSTTOptions.md +++ b/docs/api/type-aliases/DeepgramSTTOptions.md @@ -8,8 +8,6 @@ > **DeepgramSTTOptions** = [`STTOptions`](STTOptions.md) & `object` -Defined in: [types/stt.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L315) - ## Type Declaration ### model? diff --git a/docs/api/type-aliases/DeepgramUtterance.md b/docs/api/type-aliases/DeepgramUtterance.md index 53e781ad7..92f7954c4 100644 --- a/docs/api/type-aliases/DeepgramUtterance.md +++ b/docs/api/type-aliases/DeepgramUtterance.md @@ -8,68 +8,50 @@ > **DeepgramUtterance** = `object` -Defined in: [types/stt.ts:463](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L463) - ## Properties ### start > **start**: `number` -Defined in: [types/stt.ts:464](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L464) - --- ### end > **end**: `number` -Defined in: [types/stt.ts:465](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L465) - --- ### confidence > **confidence**: `number` -Defined in: [types/stt.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L466) - --- ### channel > **channel**: `number` -Defined in: [types/stt.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L467) - --- ### transcript > **transcript**: `string` -Defined in: [types/stt.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L468) - --- ### words > **words**: [`DeepgramWord`](DeepgramWord.md)[] -Defined in: [types/stt.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L469) - --- ### speaker? > `optional` **speaker?**: `number` -Defined in: [types/stt.ts:470](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L470) - --- ### id? > `optional` **id?**: `string` - -Defined in: [types/stt.ts:471](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L471) diff --git a/docs/api/type-aliases/DeepgramWord.md b/docs/api/type-aliases/DeepgramWord.md index fb09e532a..9c20823d7 100644 --- a/docs/api/type-aliases/DeepgramWord.md +++ b/docs/api/type-aliases/DeepgramWord.md @@ -8,52 +8,38 @@ > **DeepgramWord** = `object` -Defined in: [types/stt.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L434) - ## Properties ### word > **word**: `string` -Defined in: [types/stt.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L435) - --- ### start > **start**: `number` -Defined in: [types/stt.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L436) - --- ### end > **end**: `number` -Defined in: [types/stt.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L437) - --- ### confidence > **confidence**: `number` -Defined in: [types/stt.ts:438](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L438) - --- ### speaker? > `optional` **speaker?**: `number` -Defined in: [types/stt.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L439) - --- ### punctuated_word? > `optional` **punctuated_word?**: `string` - -Defined in: [types/stt.ts:440](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L440) diff --git a/docs/api/type-aliases/DefaultRequestRouterConfig.md b/docs/api/type-aliases/DefaultRequestRouterConfig.md index 866047d3a..6b1225168 100644 --- a/docs/api/type-aliases/DefaultRequestRouterConfig.md +++ b/docs/api/type-aliases/DefaultRequestRouterConfig.md @@ -8,8 +8,6 @@ > **DefaultRequestRouterConfig** = `object` -Defined in: [types/requestRouter.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L70) - Configuration for the built-in heuristic request router produced by `createDefaultRequestRouter`. All fields are optional; sensible defaults apply when omitted. @@ -20,8 +18,6 @@ apply when omitted. > `optional` **largeInputTokenThreshold?**: `number` -Defined in: [types/requestRouter.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L75) - Token threshold above which the "large" tier is selected. Default: 32_000. @@ -31,8 +27,6 @@ Default: 32_000. > `optional` **visionTier?**: [`ModelTierEntry`](ModelTierEntry.md) -Defined in: [types/requestRouter.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L77) - Provider/model to use for vision requests. --- @@ -41,8 +35,6 @@ Provider/model to use for vision requests. > `optional` **largeTier?**: [`ModelTierEntry`](ModelTierEntry.md) -Defined in: [types/requestRouter.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L79) - Provider/model to use for large inputs or tool-heavy requests. --- @@ -51,6 +43,4 @@ Provider/model to use for large inputs or tool-heavy requests. > `optional` **smallTier?**: [`ModelTierEntry`](ModelTierEntry.md) -Defined in: [types/requestRouter.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L81) - Provider/model to use for fast/small requests. diff --git a/docs/api/type-aliases/DeferredClaudeAccountFailure.md b/docs/api/type-aliases/DeferredClaudeAccountFailure.md index d665350a1..8600f52bb 100644 --- a/docs/api/type-aliases/DeferredClaudeAccountFailure.md +++ b/docs/api/type-aliases/DeferredClaudeAccountFailure.md @@ -8,8 +8,6 @@ > **DeferredClaudeAccountFailure** = `object` -Defined in: [types/claudeProxy.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L13) - A credential failure deferred until peer and provider fallbacks are tried. ## Properties @@ -18,28 +16,20 @@ A credential failure deferred until peer and provider fallbacks are tried. > **status**: `number` -Defined in: [types/claudeProxy.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L14) - --- ### message > **message**: `string` -Defined in: [types/claudeProxy.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L15) - --- ### errorType > **errorType**: `string` -Defined in: [types/claudeProxy.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L16) - --- ### responseHeaders? > `optional` **responseHeaders?**: `Record`\<`string`, `string`\> - -Defined in: [types/claudeProxy.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/claudeProxy.ts#L17) diff --git a/docs/api/type-aliases/DeferredToolIndexEntry.md b/docs/api/type-aliases/DeferredToolIndexEntry.md index dbf97addc..7891f1140 100644 --- a/docs/api/type-aliases/DeferredToolIndexEntry.md +++ b/docs/api/type-aliases/DeferredToolIndexEntry.md @@ -8,8 +8,6 @@ > **DeferredToolIndexEntry** = `object` -Defined in: [types/toolResolution.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/toolResolution.ts#L72) - One entry in the deferred-tool catalog embedded in the `search_tools` meta-tool description when `tools.discovery` is enabled. @@ -19,16 +17,12 @@ meta-tool description when `tools.discovery` is enabled. > **name**: `string` -Defined in: [types/toolResolution.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/toolResolution.ts#L73) - --- ### summary > **summary**: `string` -Defined in: [types/toolResolution.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/toolResolution.ts#L75) - One-line description (truncated) shown in the search_tools catalog. --- @@ -37,6 +31,4 @@ One-line description (truncated) shown in the search_tools catalog. > `optional` **serverId?**: `string` -Defined in: [types/toolResolution.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/toolResolution.ts#L77) - Originating MCP server id, when known. diff --git a/docs/api/type-aliases/DeferredToolResolver.md b/docs/api/type-aliases/DeferredToolResolver.md index d4424c0c7..b587e88de 100644 --- a/docs/api/type-aliases/DeferredToolResolver.md +++ b/docs/api/type-aliases/DeferredToolResolver.md @@ -8,8 +8,6 @@ > **DeferredToolResolver** = (`name`) => [`Tool`](Tool.md) \| `undefined` -Defined in: [types/toolResolution.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/toolResolution.ts#L88) - Resolver attached (under a symbol key, invisible to enumeration) to the hot tool record by `partitionToolsForDiscovery`. Given a deferred tool's name it hydrates that tool into the record, persists the session pin, and diff --git a/docs/api/type-aliases/DeferredUsage.md b/docs/api/type-aliases/DeferredUsage.md index 9d391bc12..3615c6570 100644 --- a/docs/api/type-aliases/DeferredUsage.md +++ b/docs/api/type-aliases/DeferredUsage.md @@ -8,8 +8,6 @@ > **DeferredUsage** = `object` -Defined in: [types/common.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L390) - Aggregated usage resolved by a provider's deferred-analytics pair after a multi-step stream loop ends. The cache fields are optional — only providers with prompt caching (Anthropic) populate them. @@ -20,46 +18,34 @@ with prompt caching (Anthropic) populate them. > **promptTokens**: `number` -Defined in: [types/common.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L391) - --- ### completionTokens > **completionTokens**: `number` -Defined in: [types/common.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L392) - --- ### totalTokens > **totalTokens**: `number` -Defined in: [types/common.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L393) - --- ### cacheReadTokens? > `optional` **cacheReadTokens?**: `number` -Defined in: [types/common.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L394) - --- ### cacheCreationTokens? > `optional` **cacheCreationTokens?**: `number` -Defined in: [types/common.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L395) - --- ### reasoningTokens? > `optional` **reasoningTokens?**: `number` -Defined in: [types/common.ts:397](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L397) - Reasoning/thinking tokens — a SUBSET already included in completionTokens. diff --git a/docs/api/type-aliases/DelegateCollectMode.md b/docs/api/type-aliases/DelegateCollectMode.md index 3f11aa55f..fcbc642c9 100644 --- a/docs/api/type-aliases/DelegateCollectMode.md +++ b/docs/api/type-aliases/DelegateCollectMode.md @@ -8,6 +8,4 @@ > **DelegateCollectMode** = `"any"` \| `"all"` -Defined in: [types/delegation.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L95) - `any` returns the first worker to finish; `all` waits for every one. diff --git a/docs/api/type-aliases/DelegateCollectRequest.md b/docs/api/type-aliases/DelegateCollectRequest.md index a1e806302..5eefc9abb 100644 --- a/docs/api/type-aliases/DelegateCollectRequest.md +++ b/docs/api/type-aliases/DelegateCollectRequest.md @@ -8,7 +8,5 @@ > **DelegateCollectRequest** = \{ `mode`: [`DelegateCollectMode`](DelegateCollectMode.md); `waitMs?`: `number`; `sessionId?`: `string`; \} \| \{ `workerId`: `string`; `waitMs?`: `number`; `sessionId?`: `string`; \} -Defined in: [types/delegation.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L101) - What to collect. `waitMs` of 0 polls (return what is ready right now); omitting it uses the runtime default. diff --git a/docs/api/type-aliases/DelegateCollectResult.md b/docs/api/type-aliases/DelegateCollectResult.md index 8ba100c37..f1c1cb4aa 100644 --- a/docs/api/type-aliases/DelegateCollectResult.md +++ b/docs/api/type-aliases/DelegateCollectResult.md @@ -8,8 +8,6 @@ > **DelegateCollectResult** = `object` -Defined in: [types/delegation.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L110) - Outcomes claimed by one collect call, in COMPLETION order — the order workers finished in, which has nothing to do with the order they were spawned in. @@ -20,8 +18,6 @@ spawned in. > **completed**: [`DelegateOutcome`](DelegateOutcome.md)[] -Defined in: [types/delegation.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L112) - Claimed exactly once: these outcomes are gone from the registry. --- @@ -30,8 +26,6 @@ Claimed exactly once: these outcomes are gone from the registry. > **pending**: `number` -Defined in: [types/delegation.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L114) - Still running or waiting for a pool slot. --- @@ -40,8 +34,6 @@ Still running or waiting for a pool slot. > **ready**: `number` -Defined in: [types/delegation.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L116) - Finished but not yet claimed. --- @@ -50,8 +42,6 @@ Finished but not yet claimed. > **timedOut**: `boolean` -Defined in: [types/delegation.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L124) - True when the wait expired before this call claimed what it asked for: for a named worker, that worker's outcome; for `any`, any outcome while work was still pending; for `all`, pending work remained when the wait diff --git a/docs/api/type-aliases/DelegateHandle.md b/docs/api/type-aliases/DelegateHandle.md index 98af76444..8f97016d8 100644 --- a/docs/api/type-aliases/DelegateHandle.md +++ b/docs/api/type-aliases/DelegateHandle.md @@ -8,8 +8,6 @@ > **DelegateHandle** = `object` -Defined in: [types/delegation.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L59) - Returned the moment a worker is spawned — before it has run anything. `queued` is true when the process-wide delegation pool was full and the worker is waiting for a slot. @@ -20,20 +18,14 @@ worker is waiting for a slot. > **workerId**: `string` -Defined in: [types/delegation.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L60) - --- ### spawnedAt > **spawnedAt**: `number` -Defined in: [types/delegation.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L61) - --- ### queued > **queued**: `boolean` - -Defined in: [types/delegation.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L62) diff --git a/docs/api/type-aliases/DelegateJobPhase.md b/docs/api/type-aliases/DelegateJobPhase.md index 661d0cbf7..d2aff5213 100644 --- a/docs/api/type-aliases/DelegateJobPhase.md +++ b/docs/api/type-aliases/DelegateJobPhase.md @@ -8,6 +8,4 @@ > **DelegateJobPhase** = `"queued"` \| `"running"` \| `"ready"` \| `"claimed"` -Defined in: [types/delegation.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L128) - Lifecycle of one background job. `claimed` jobs are dropped immediately. diff --git a/docs/api/type-aliases/DelegateOutcome.md b/docs/api/type-aliases/DelegateOutcome.md index 97127c46f..a056bef9a 100644 --- a/docs/api/type-aliases/DelegateOutcome.md +++ b/docs/api/type-aliases/DelegateOutcome.md @@ -8,8 +8,6 @@ > **DelegateOutcome** = `object` -Defined in: [types/delegation.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L72) - A settled worker, claimed exactly once. `summary` is bounded; `report` points at the COMPLETE report on disk. The @@ -22,16 +20,12 @@ report is what the evidence lives in. > **workerId**: `string` -Defined in: [types/delegation.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L73) - --- ### label > **label**: `string` -Defined in: [types/delegation.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L75) - Human label the spawn was given (defaults to the worker id). --- @@ -40,8 +34,6 @@ Human label the spawn was given (defaults to the worker id). > **status**: [`AgentRunStatus`](AgentRunStatus.md) -Defined in: [types/delegation.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L77) - Reused from the isolated-agent runner — no parallel taxonomy. --- @@ -50,8 +42,6 @@ Reused from the isolated-agent runner — no parallel taxonomy. > **ok**: `boolean` -Defined in: [types/delegation.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L79) - True for `completed` and `partial`: the worker produced usable evidence. --- @@ -60,8 +50,6 @@ True for `completed` and `partial`: the worker produced usable evidence. > **summary**: `string` -Defined in: [types/delegation.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L81) - Bounded narrative for the conversation. Never the whole report. --- @@ -70,8 +58,6 @@ Bounded narrative for the conversation. Never the whole report. > **report**: [`BankedArtifactRef`](BankedArtifactRef.md) -Defined in: [types/delegation.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L83) - The FULL report, always banked to a file. --- @@ -80,24 +66,18 @@ The FULL report, always banked to a file. > **durationMs**: `number` -Defined in: [types/delegation.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L84) - --- ### toolCallsUsed > **toolCallsUsed**: `number` -Defined in: [types/delegation.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L85) - --- ### wasteSignals? > `optional` **wasteSignals?**: `string`[] -Defined in: [types/delegation.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L87) - Mechanical waste signatures the runner tripped, if any. --- @@ -106,8 +86,6 @@ Mechanical waste signatures the runner tripped, if any. > `optional` **handle?**: `string` -Defined in: [types/delegation.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L89) - `continueAgent()` handle when the worker was cut short mid-investigation. --- @@ -116,6 +94,4 @@ Defined in: [types/delegation.ts:89](https://github.com/juspay/neurolink/blob/re > `optional` **error?**: `string` -Defined in: [types/delegation.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L91) - Why the worker failed, when it did. diff --git a/docs/api/type-aliases/DelegateRefusal.md b/docs/api/type-aliases/DelegateRefusal.md index edc9f7a53..03650df48 100644 --- a/docs/api/type-aliases/DelegateRefusal.md +++ b/docs/api/type-aliases/DelegateRefusal.md @@ -8,8 +8,6 @@ > **DelegateRefusal** = `object` -Defined in: [types/delegation.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L214) - Refusal shape shared with the agent tool registrar: recovery text included. ## Properties @@ -18,12 +16,8 @@ Refusal shape shared with the agent tool registrar: recovery text included. > **isError**: `true` -Defined in: [types/delegation.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L214) - --- ### error > **error**: `string` - -Defined in: [types/delegation.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L214) diff --git a/docs/api/type-aliases/DelegateRegistrationOptions.md b/docs/api/type-aliases/DelegateRegistrationOptions.md index 7ee9132cc..db7348997 100644 --- a/docs/api/type-aliases/DelegateRegistrationOptions.md +++ b/docs/api/type-aliases/DelegateRegistrationOptions.md @@ -8,8 +8,6 @@ > **DelegateRegistrationOptions** = `object` -Defined in: [types/delegation.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L189) - Options for `NeuroLink.registerDelegationTools()`. ## Properties @@ -18,8 +16,6 @@ Options for `NeuroLink.registerDelegationTools()`. > `optional` **maxDepth?**: `number` -Defined in: [types/delegation.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L195) - Caller depth at which further delegation is refused. Default 1: a background worker does not spawn background workers, because nothing would ever collect them. @@ -30,8 +26,6 @@ would ever collect them. > `optional` **maxConcurrent?**: `number` -Defined in: [types/delegation.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L200) - Raise the process-wide delegation pool to at least this many concurrent workers. The pool is shared with `registerAgentTool` and only ever rises. @@ -41,8 +35,6 @@ workers. The pool is shared with `registerAgentTool` and only ever rises. > `optional` **poolQueueTimeoutMs?**: `number` -Defined in: [types/delegation.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L202) - Queue wait before a spawned worker gives up on a pool slot (ms). --- @@ -51,6 +43,4 @@ Queue wait before a spawned worker gives up on a pool slot (ms). > `optional` **spawnDefaults?**: [`DelegateSpawnDefaults`](DelegateSpawnDefaults.md) -Defined in: [types/delegation.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L204) - Provider/model for model-invoked spawns — see [DelegateSpawnDefaults](DelegateSpawnDefaults.md). diff --git a/docs/api/type-aliases/DelegateRuntimeSettings.md b/docs/api/type-aliases/DelegateRuntimeSettings.md index b5fa48717..975b39a2e 100644 --- a/docs/api/type-aliases/DelegateRuntimeSettings.md +++ b/docs/api/type-aliases/DelegateRuntimeSettings.md @@ -8,8 +8,6 @@ > **DelegateRuntimeSettings** = `object` -Defined in: [types/delegation.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L177) - Per-host delegation policy, resolved from registration options. ## Properties @@ -18,8 +16,6 @@ Per-host delegation policy, resolved from registration options. > **maxDepth**: `number` -Defined in: [types/delegation.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L179) - Caller depth at which `delegate_task` refuses rather than spawning. --- @@ -28,8 +24,6 @@ Caller depth at which `delegate_task` refuses rather than spawning. > **poolQueueTimeoutMs**: `number` -Defined in: [types/delegation.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L181) - How long a spawned worker waits for a pool slot before giving up (ms). --- @@ -38,8 +32,6 @@ How long a spawned worker waits for a pool slot before giving up (ms). > **defaultCollectWaitMs**: `number` -Defined in: [types/delegation.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L183) - Default `waitMs` for a collect that does not name one (ms). --- @@ -48,6 +40,4 @@ Default `waitMs` for a collect that does not name one (ms). > `optional` **spawnDefaults?**: [`DelegateSpawnDefaults`](DelegateSpawnDefaults.md) -Defined in: [types/delegation.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L185) - Defaults merged under every model-invoked `delegate_task` spawn. diff --git a/docs/api/type-aliases/DelegateSpawnDefaults.md b/docs/api/type-aliases/DelegateSpawnDefaults.md index 128a11e22..d166736b1 100644 --- a/docs/api/type-aliases/DelegateSpawnDefaults.md +++ b/docs/api/type-aliases/DelegateSpawnDefaults.md @@ -8,8 +8,6 @@ > **DelegateSpawnDefaults** = `object` -Defined in: [types/delegation.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L171) - Provider/model a model-invoked `delegate_task` spawn falls back to. The spawn schema deliberately exposes no `provider` — a model cannot name a provider it cannot see — so without a default the worker instance falls back to provider @@ -24,12 +22,8 @@ unconfigured providers before reaching the configured one. The model's own > `optional` **provider?**: `string` -Defined in: [types/delegation.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L172) - --- ### model? > `optional` **model?**: `string` - -Defined in: [types/delegation.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L173) diff --git a/docs/api/type-aliases/DelegateSpawnOptions.md b/docs/api/type-aliases/DelegateSpawnOptions.md index eed18f52f..30c6cd8d7 100644 --- a/docs/api/type-aliases/DelegateSpawnOptions.md +++ b/docs/api/type-aliases/DelegateSpawnOptions.md @@ -8,8 +8,6 @@ > **DelegateSpawnOptions** = `object` -Defined in: [types/delegation.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L23) - What a supervisor hands down when it spawns a background worker. ## Properties @@ -18,8 +16,6 @@ What a supervisor hands down when it spawns a background worker. > **task**: `string` -Defined in: [types/delegation.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L25) - The task, in the supervisor's own words. Required and non-empty. --- @@ -28,8 +24,6 @@ The task, in the supervisor's own words. Required and non-empty. > `optional` **scope?**: `string` -Defined in: [types/delegation.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L27) - What the worker may look at — files, directories, systems. --- @@ -38,8 +32,6 @@ What the worker may look at — files, directories, systems. > `optional` **context?**: `string` -Defined in: [types/delegation.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L29) - Brief slice of context handed down (never the whole rulebook). --- @@ -48,8 +40,6 @@ Brief slice of context handed down (never the whole rulebook). > `optional` **model?**: `string` -Defined in: [types/delegation.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L31) - Model override for this worker. --- @@ -58,8 +48,6 @@ Model override for this worker. > `optional` **provider?**: `string` -Defined in: [types/delegation.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L33) - Provider override for this worker. --- @@ -68,8 +56,6 @@ Provider override for this worker. > `optional` **tools?**: `string`[] -Defined in: [types/delegation.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L35) - Read-only tool allowlist for the worker (tool names). --- @@ -78,8 +64,6 @@ Read-only tool allowlist for the worker (tool names). > `optional` **sessionId?**: `string` -Defined in: [types/delegation.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L41) - Caller's session. Collection is scoped to it, and it is the key the task checklist's `delegatesPending` / `delegatesReady` counters are read by. Defaults to the session the host's tool context declares. @@ -90,8 +74,6 @@ Defaults to the session the host's tool context declares. > `optional` **depth?**: `number` -Defined in: [types/delegation.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L43) - Caller's delegation depth; the worker runs one level deeper. --- @@ -100,8 +82,6 @@ Caller's delegation depth; the worker runs one level deeper. > `optional` **label?**: `string` -Defined in: [types/delegation.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L45) - Short human label used in logs and in the banked report's name. --- @@ -110,8 +90,6 @@ Short human label used in logs and in the banked report's name. > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/delegation.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L47) - Parent cancellation — an aborted parent cancels this worker. --- @@ -120,8 +98,6 @@ Parent cancellation — an aborted parent cancels this worker. > `optional` **maxSteps?**: `number` -Defined in: [types/delegation.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L49) - Max agentic steps for the worker's research pass. --- @@ -130,6 +106,4 @@ Max agentic steps for the worker's research pass. > `optional` **budgetMs?**: `number` -Defined in: [types/delegation.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L51) - Wall-clock budget for the worker's research pass (ms). diff --git a/docs/api/type-aliases/DelegateSpawnToolResult.md b/docs/api/type-aliases/DelegateSpawnToolResult.md index 803f77ec6..5c0e51ee3 100644 --- a/docs/api/type-aliases/DelegateSpawnToolResult.md +++ b/docs/api/type-aliases/DelegateSpawnToolResult.md @@ -8,8 +8,6 @@ > **DelegateSpawnToolResult** = [`DelegateHandle`](DelegateHandle.md) & `object` -Defined in: [types/delegation.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/delegation.ts#L208) - What `delegate_task` returns: the handle plus the outstanding counters. ## Type Declaration diff --git a/docs/api/type-aliases/DelegationCondition.md b/docs/api/type-aliases/DelegationCondition.md index 3e67200e1..8742af707 100644 --- a/docs/api/type-aliases/DelegationCondition.md +++ b/docs/api/type-aliases/DelegationCondition.md @@ -8,6 +8,4 @@ > **DelegationCondition** = \{ `type`: `"keyword"`; `keywords`: `string`[]; \} \| \{ `type`: `"complexity"`; `threshold`: `"simple"` \| `"moderate"` \| `"complex"`; \} \| \{ `type`: `"toolRequired"`; `tools`: `string`[]; \} \| \{ `type`: `"custom"`; `evaluator`: (`task`) => `boolean`; \} -Defined in: [types/agentNetwork.ts:951](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L951) - Delegation condition types diff --git a/docs/api/type-aliases/DelegationRule.md b/docs/api/type-aliases/DelegationRule.md index 4e44f1043..51a2d4426 100644 --- a/docs/api/type-aliases/DelegationRule.md +++ b/docs/api/type-aliases/DelegationRule.md @@ -8,8 +8,6 @@ > **DelegationRule** = `object` -Defined in: [types/agentNetwork.ts:937](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L937) - Delegation rule for hierarchical networks ## Properties @@ -18,8 +16,6 @@ Delegation rule for hierarchical networks > **condition**: [`DelegationCondition`](DelegationCondition.md) -Defined in: [types/agentNetwork.ts:939](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L939) - Rule condition --- @@ -28,8 +24,6 @@ Rule condition > **targetNetwork**: `string` -Defined in: [types/agentNetwork.ts:942](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L942) - Target network or agent --- @@ -38,6 +32,4 @@ Target network or agent > **priority**: `number` -Defined in: [types/agentNetwork.ts:945](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L945) - Priority (higher = checked first) diff --git a/docs/api/type-aliases/DeprecatedRouteInfo.md b/docs/api/type-aliases/DeprecatedRouteInfo.md index 8b9ca8a3a..40160bd39 100644 --- a/docs/api/type-aliases/DeprecatedRouteInfo.md +++ b/docs/api/type-aliases/DeprecatedRouteInfo.md @@ -8,8 +8,6 @@ > **DeprecatedRouteInfo** = `object` -Defined in: [types/proxy.ts:2073](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2073) - Information about a deprecated route. ## Properties @@ -18,20 +16,14 @@ Information about a deprecated route. > **method**: `string` -Defined in: [types/proxy.ts:2074](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2074) - --- ### path > **path**: `string` -Defined in: [types/proxy.ts:2075](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2075) - --- ### deprecation > **deprecation**: [`RouteDeprecation`](RouteDeprecation.md) - -Defined in: [types/proxy.ts:2076](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2076) diff --git a/docs/api/type-aliases/DeprecationConfig.md b/docs/api/type-aliases/DeprecationConfig.md index 32ae74852..d95f2ef12 100644 --- a/docs/api/type-aliases/DeprecationConfig.md +++ b/docs/api/type-aliases/DeprecationConfig.md @@ -8,8 +8,6 @@ > **DeprecationConfig** = `object` -Defined in: [types/middleware.ts:421](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L421) - Configuration for the route-deprecation middleware. ## Properties @@ -18,20 +16,14 @@ Configuration for the route-deprecation middleware. > **routes**: [`RouteDefinition`](RouteDefinition.md)[] -Defined in: [types/middleware.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L422) - --- ### noticeHeader? > `optional` **noticeHeader?**: `string` -Defined in: [types/middleware.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L423) - --- ### includeLink? > `optional` **includeLink?**: `boolean` - -Defined in: [types/middleware.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L424) diff --git a/docs/api/type-aliases/DetachableTransferableProxySocket.md b/docs/api/type-aliases/DetachableTransferableProxySocket.md index b4469e64e..1c1c3bed6 100644 --- a/docs/api/type-aliases/DetachableTransferableProxySocket.md +++ b/docs/api/type-aliases/DetachableTransferableProxySocket.md @@ -8,6 +8,4 @@ > **DetachableTransferableProxySocket** = [`TransferableProxySocket`](TransferableProxySocket.md) & `Pick`\<`Socket`, `"off"`\> -Defined in: [types/proxy.ts:3430](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3430) - A transferred socket whose temporary handoff listeners can be detached. diff --git a/docs/api/type-aliases/DetectedPII.md b/docs/api/type-aliases/DetectedPII.md index 4ea7553d3..58c09e0a2 100644 --- a/docs/api/type-aliases/DetectedPII.md +++ b/docs/api/type-aliases/DetectedPII.md @@ -8,32 +8,24 @@ > **DetectedPII** = `object` -Defined in: [types/ioProcessor.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L35) - ## Properties ### type > **type**: [`PiiType`](PiiType.md) \| `"custom"` -Defined in: [types/ioProcessor.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L36) - --- ### value > **value**: `string` -Defined in: [types/ioProcessor.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L37) - --- ### position > **position**: `object` -Defined in: [types/ioProcessor.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L38) - #### start > **start**: `number` @@ -48,6 +40,4 @@ Defined in: [types/ioProcessor.ts:38](https://github.com/juspay/neurolink/blob/r > **field**: `string` -Defined in: [types/ioProcessor.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L40) - Which field the PII was found in (e.g. "text", "messages[2]") diff --git a/docs/api/type-aliases/DetectionStrategy.md b/docs/api/type-aliases/DetectionStrategy.md index dd0f49281..c7d3c4e02 100644 --- a/docs/api/type-aliases/DetectionStrategy.md +++ b/docs/api/type-aliases/DetectionStrategy.md @@ -8,8 +8,6 @@ > **DetectionStrategy** = `object` -Defined in: [types/file.ts:870](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L870) - Contract implemented by each file-detection strategy. ## Methods @@ -18,8 +16,6 @@ Contract implemented by each file-detection strategy. > **detect**(`input`): `Promise`\<[`FileDetectionResult`](FileDetectionResult.md)\> -Defined in: [types/file.ts:871](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L871) - #### Parameters ##### input diff --git a/docs/api/type-aliases/DetectionTestConfig.md b/docs/api/type-aliases/DetectionTestConfig.md index 1b5f0f3e0..376e21bb0 100644 --- a/docs/api/type-aliases/DetectionTestConfig.md +++ b/docs/api/type-aliases/DetectionTestConfig.md @@ -8,8 +8,6 @@ > **DetectionTestConfig** = `object` -Defined in: [types/providers.ts:2398](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2398) - Configuration object for a detection test wrapper. ## Properties @@ -18,8 +16,6 @@ Configuration object for a detection test wrapper. > **test**: () => `Promise`\<`void`\> -Defined in: [types/providers.ts:2399](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2399) - #### Returns `Promise`\<`void`\> @@ -30,32 +26,24 @@ Defined in: [types/providers.ts:2399](https://github.com/juspay/neurolink/blob/r > **index**: `number` -Defined in: [types/providers.ts:2400](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2400) - --- ### testName > **testName**: `string` -Defined in: [types/providers.ts:2401](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2401) - --- ### endpointName > **endpointName**: `string` -Defined in: [types/providers.ts:2402](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2402) - --- ### semaphore > **semaphore**: `object` -Defined in: [types/providers.ts:2403](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2403) - #### acquire() > **acquire**(): `Promise`\<`void`\> @@ -78,8 +66,6 @@ Defined in: [types/providers.ts:2403](https://github.com/juspay/neurolink/blob/r > **incrementRateLimit**: () => `void` -Defined in: [types/providers.ts:2407](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2407) - #### Returns `void` @@ -90,16 +76,12 @@ Defined in: [types/providers.ts:2407](https://github.com/juspay/neurolink/blob/r > **maxRateLimitRetries**: `number` -Defined in: [types/providers.ts:2408](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2408) - --- ### rateLimitState > **rateLimitState**: `object` -Defined in: [types/providers.ts:2409](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2409) - #### count > **count**: `number` diff --git a/docs/api/type-aliases/DiagnosticReport.md b/docs/api/type-aliases/DiagnosticReport.md index 5ecd7524d..d6f3efc2a 100644 --- a/docs/api/type-aliases/DiagnosticReport.md +++ b/docs/api/type-aliases/DiagnosticReport.md @@ -8,8 +8,6 @@ > **DiagnosticReport** = `object` -Defined in: [types/providers.ts:2434](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2434) - Aggregated SageMaker diagnostic report. ## Properties @@ -18,24 +16,18 @@ Aggregated SageMaker diagnostic report. > **overallStatus**: `"healthy"` \| `"issues"` \| `"critical"` -Defined in: [types/providers.ts:2435](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2435) - --- ### results > **results**: [`DiagnosticResult`](DiagnosticResult.md)[] -Defined in: [types/providers.ts:2436](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2436) - --- ### summary > **summary**: `object` -Defined in: [types/providers.ts:2437](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2437) - #### total > **total**: `number` diff --git a/docs/api/type-aliases/DiagnosticResult.md b/docs/api/type-aliases/DiagnosticResult.md index e9b3978b3..87e03ecac 100644 --- a/docs/api/type-aliases/DiagnosticResult.md +++ b/docs/api/type-aliases/DiagnosticResult.md @@ -8,8 +8,6 @@ > **DiagnosticResult** = `object` -Defined in: [types/providers.ts:2424](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2424) - Individual SageMaker diagnostic result. ## Properties @@ -18,44 +16,32 @@ Individual SageMaker diagnostic result. > **name**: `string` -Defined in: [types/providers.ts:2425](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2425) - --- ### category > **category**: `"configuration"` \| `"connectivity"` \| `"streaming"` -Defined in: [types/providers.ts:2426](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2426) - --- ### status > **status**: `"pass"` \| `"fail"` \| `"warning"` -Defined in: [types/providers.ts:2427](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2427) - --- ### message > **message**: `string` -Defined in: [types/providers.ts:2428](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2428) - --- ### details? > `optional` **details?**: `string` -Defined in: [types/providers.ts:2429](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2429) - --- ### recommendation? > `optional` **recommendation?**: `string` - -Defined in: [types/providers.ts:2430](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2430) diff --git a/docs/api/type-aliases/DimensionAnalysis.md b/docs/api/type-aliases/DimensionAnalysis.md index 5d4d5c413..095928d21 100644 --- a/docs/api/type-aliases/DimensionAnalysis.md +++ b/docs/api/type-aliases/DimensionAnalysis.md @@ -8,8 +8,6 @@ > **DimensionAnalysis** = `object` -Defined in: [types/evaluation.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L505) - Dimension-specific analysis for RAGAS metrics. ## Properties @@ -18,40 +16,30 @@ Dimension-specific analysis for RAGAS metrics. > **relevance**: [`ScoreStatistics`](ScoreStatistics.md) -Defined in: [types/evaluation.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L506) - --- ### accuracy > **accuracy**: [`ScoreStatistics`](ScoreStatistics.md) -Defined in: [types/evaluation.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L507) - --- ### completeness > **completeness**: [`ScoreStatistics`](ScoreStatistics.md) -Defined in: [types/evaluation.ts:508](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L508) - --- ### overall > **overall**: [`ScoreStatistics`](ScoreStatistics.md) -Defined in: [types/evaluation.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L509) - --- ### correlations > **correlations**: `object` -Defined in: [types/evaluation.ts:510](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L510) - #### relevanceAccuracy > **relevanceAccuracy**: `number` diff --git a/docs/api/type-aliases/DirectEvaluateArgs.md b/docs/api/type-aliases/DirectEvaluateArgs.md index c3fcb224e..2d3a64efa 100644 --- a/docs/api/type-aliases/DirectEvaluateArgs.md +++ b/docs/api/type-aliases/DirectEvaluateArgs.md @@ -8,8 +8,6 @@ > **DirectEvaluateArgs** = [`BaseEvaluateArgs`](BaseEvaluateArgs.md) & `object` -Defined in: [types/cli.ts:1586](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1586) - Arguments for the bare `neurolink evaluate` invocation. ## Type Declaration diff --git a/docs/api/type-aliases/DirectorModeOptions.md b/docs/api/type-aliases/DirectorModeOptions.md index 1fdb40230..4c1a653f7 100644 --- a/docs/api/type-aliases/DirectorModeOptions.md +++ b/docs/api/type-aliases/DirectorModeOptions.md @@ -8,8 +8,6 @@ > **DirectorModeOptions** = `object` -Defined in: [types/multimodal.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L256) - Director Mode configuration options. Used when `input.segments` is provided to control transition generation. @@ -19,8 +17,6 @@ Used when `input.segments` is provided to control transition generation. > `optional` **transitionPrompts?**: `string`[] -Defined in: [types/multimodal.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L262) - Prompts for generating transition clips (array of N-1 entries for N segments). transitionPrompts[i] is used for the transition between segment i and segment i+1. If omitted, defaults to "Smooth cinematic transition between scenes". @@ -31,8 +27,6 @@ If omitted, defaults to "Smooth cinematic transition between scenes". > `optional` **transitionDurations?**: (`4` \| `6` \| `8`)[] -Defined in: [types/multimodal.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L270) - Duration of each transition clip in seconds (array of N-1 entries for N segments). Each value must be 4, 6, or 8 (4 recommended for seamless feel). If omitted, all transitions default to 4 seconds. diff --git a/docs/api/type-aliases/DirectorSegment.md b/docs/api/type-aliases/DirectorSegment.md index 4ca7419bb..516300695 100644 --- a/docs/api/type-aliases/DirectorSegment.md +++ b/docs/api/type-aliases/DirectorSegment.md @@ -8,8 +8,6 @@ > **DirectorSegment** = `object` -Defined in: [types/multimodal.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L245) - A single segment in Director Mode, representing one video clip. ## Properties @@ -18,8 +16,6 @@ A single segment in Director Mode, representing one video clip. > **prompt**: `string` -Defined in: [types/multimodal.ts:247](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L247) - Prompt describing the video content for this segment --- @@ -28,6 +24,4 @@ Prompt describing the video content for this segment > **image**: `Buffer` \| `string` \| [`ImageWithAltText`](ImageWithAltText.md) -Defined in: [types/multimodal.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L249) - Input image for this segment (Buffer, URL string, file path, or ImageWithAltText) diff --git a/docs/api/type-aliases/DiscoveredMcp.md b/docs/api/type-aliases/DiscoveredMcp.md index 41d63c2fb..0023976ab 100644 --- a/docs/api/type-aliases/DiscoveredMcp.md +++ b/docs/api/type-aliases/DiscoveredMcp.md @@ -8,8 +8,6 @@ > **DiscoveredMcp**\<`TTools`\> = `object` -Defined in: [types/mcp.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L547) - Discovered MCP server/plugin definition Moved from src/lib/mcp/contracts/mcpContract.ts @@ -29,36 +27,26 @@ Moved from src/lib/mcp/contracts/mcpContract.ts > **metadata**: [`McpMetadata`](McpMetadata.md) -Defined in: [types/mcp.ts:548](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L548) - --- ### tools? > `optional` **tools?**: `TTools` -Defined in: [types/mcp.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L549) - --- ### capabilities? > `optional` **capabilities?**: `string`[] -Defined in: [types/mcp.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L550) - --- ### version? > `optional` **version?**: `string` -Defined in: [types/mcp.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L551) - --- ### configuration? > `optional` **configuration?**: `Record`\<`string`, `string` \| `number` \| `boolean`\> - -Defined in: [types/mcp.ts:552](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L552) diff --git a/docs/api/type-aliases/DistributableTask.md b/docs/api/type-aliases/DistributableTask.md index 8d247cfda..73a104f66 100644 --- a/docs/api/type-aliases/DistributableTask.md +++ b/docs/api/type-aliases/DistributableTask.md @@ -8,8 +8,6 @@ > **DistributableTask** = `object` -Defined in: [types/agentNetwork.ts:1354](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1354) - Task definition for distribution ## Properties @@ -18,8 +16,6 @@ Task definition for distribution > **id**: `string` -Defined in: [types/agentNetwork.ts:1356](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1356) - Unique task ID --- @@ -28,8 +24,6 @@ Unique task ID > **input**: `string` -Defined in: [types/agentNetwork.ts:1359](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1359) - Task description/input --- @@ -38,8 +32,6 @@ Task description/input > **priority**: [`TaskPriority`](TaskPriority.md) -Defined in: [types/agentNetwork.ts:1362](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1362) - Task priority --- @@ -48,8 +40,6 @@ Task priority > `optional` **requiredSkills?**: `string`[] -Defined in: [types/agentNetwork.ts:1365](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1365) - Required skills/capabilities --- @@ -58,8 +48,6 @@ Required skills/capabilities > `optional` **preferredAgent?**: `string` -Defined in: [types/agentNetwork.ts:1368](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1368) - Preferred agent (for affinity) --- @@ -68,8 +56,6 @@ Preferred agent (for affinity) > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:1371](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1371) - Task metadata --- @@ -78,8 +64,6 @@ Task metadata > `optional` **deadline?**: `number` -Defined in: [types/agentNetwork.ts:1374](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1374) - Deadline timestamp --- @@ -88,8 +72,6 @@ Deadline timestamp > `optional` **parentTaskId?**: `string` -Defined in: [types/agentNetwork.ts:1377](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1377) - Parent task ID (for subtasks) --- @@ -98,6 +80,4 @@ Parent task ID (for subtasks) > `optional` **dependencies?**: `string`[] -Defined in: [types/agentNetwork.ts:1380](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1380) - Dependencies (task IDs) diff --git a/docs/api/type-aliases/DistributionResult.md b/docs/api/type-aliases/DistributionResult.md index 68e33f7f1..b34a9b339 100644 --- a/docs/api/type-aliases/DistributionResult.md +++ b/docs/api/type-aliases/DistributionResult.md @@ -8,8 +8,6 @@ > **DistributionResult** = `object` -Defined in: [types/agentNetwork.ts:1386](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1386) - Result of task distribution ## Properties @@ -18,8 +16,6 @@ Result of task distribution > **taskId**: `string` -Defined in: [types/agentNetwork.ts:1388](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1388) - Task ID --- @@ -28,8 +24,6 @@ Task ID > **agentId**: `string` -Defined in: [types/agentNetwork.ts:1391](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1391) - Assigned agent ID --- @@ -38,8 +32,6 @@ Assigned agent ID > `optional` **result?**: [`AgentResult`](AgentResult.md) -Defined in: [types/agentNetwork.ts:1394](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1394) - Execution result --- @@ -48,8 +40,6 @@ Execution result > **distributedAt**: `number` -Defined in: [types/agentNetwork.ts:1397](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1397) - Distribution timestamp --- @@ -58,8 +48,6 @@ Distribution timestamp > `optional` **completedAt?**: `number` -Defined in: [types/agentNetwork.ts:1400](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1400) - Completion timestamp --- @@ -68,8 +56,6 @@ Completion timestamp > **status**: `"pending"` \| `"running"` \| `"completed"` \| `"failed"` -Defined in: [types/agentNetwork.ts:1403](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1403) - Status --- @@ -78,6 +64,4 @@ Status > `optional` **error?**: `string` -Defined in: [types/agentNetwork.ts:1406](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1406) - Error if failed diff --git a/docs/api/type-aliases/DistributionStrategy.md b/docs/api/type-aliases/DistributionStrategy.md index 0e221af37..d515d4c93 100644 --- a/docs/api/type-aliases/DistributionStrategy.md +++ b/docs/api/type-aliases/DistributionStrategy.md @@ -8,6 +8,4 @@ > **DistributionStrategy** = `"skillBased"` \| `"loadBalanced"` \| `"priority"` \| `"affinity"` \| `"broadcast"` -Defined in: [types/agentNetwork.ts:1334](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1334) - Distribution strategy for tasks diff --git a/docs/api/type-aliases/DoGenerateModel.md b/docs/api/type-aliases/DoGenerateModel.md index 4dc1b4622..6f81dc958 100644 --- a/docs/api/type-aliases/DoGenerateModel.md +++ b/docs/api/type-aliases/DoGenerateModel.md @@ -8,8 +8,6 @@ > **DoGenerateModel** = `object` -Defined in: [types/cli.ts:1431](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1431) - Type for language models that expose the low-level doGenerate method. Used by SageMaker CLI commands for direct endpoint testing and benchmarking. @@ -19,8 +17,6 @@ Used by SageMaker CLI commands for direct endpoint testing and benchmarking. > **doGenerate**(`options`): `Promise`\<\{ `text?`: `string`; `finishReason?`: `string`; `usage`: \{ `promptTokens?`: `number`; `completionTokens?`: `number`; `inputTokens?`: `number`; `outputTokens?`: `number`; `totalTokens?`: `number`; \}; \}\> -Defined in: [types/cli.ts:1432](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1432) - #### Parameters ##### options diff --git a/docs/api/type-aliases/DocsCommandArgs.md b/docs/api/type-aliases/DocsCommandArgs.md index 0bbb8b7f6..5740743d1 100644 --- a/docs/api/type-aliases/DocsCommandArgs.md +++ b/docs/api/type-aliases/DocsCommandArgs.md @@ -8,8 +8,6 @@ > **DocsCommandArgs** = `object` -Defined in: [types/cli.ts:1295](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1295) - Docs command arguments ## Properties @@ -18,12 +16,8 @@ Docs command arguments > `optional` **transport?**: `"stdio"` \| `"http"` -Defined in: [types/cli.ts:1296](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1296) - --- ### port? > `optional` **port?**: `number` - -Defined in: [types/cli.ts:1297](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1297) diff --git a/docs/api/type-aliases/DocumentLoader.md b/docs/api/type-aliases/DocumentLoader.md index 99abdb15e..0c4e6abf7 100644 --- a/docs/api/type-aliases/DocumentLoader.md +++ b/docs/api/type-aliases/DocumentLoader.md @@ -8,8 +8,6 @@ > **DocumentLoader** = `object` -Defined in: [types/rag.ts:644](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L644) - Abstract document loader type ## Methods @@ -18,8 +16,6 @@ Abstract document loader type > **load**(`source`, `options?`): `Promise`\<[`MDocument`](../classes/MDocument.md)\> -Defined in: [types/rag.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L651) - Load document from source #### Parameters @@ -48,8 +44,6 @@ Promise resolving to MDocument > **canHandle**(`source`): `boolean` -Defined in: [types/rag.ts:661](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L661) - Check if loader can handle the source #### Parameters diff --git a/docs/api/type-aliases/DocumentState.md b/docs/api/type-aliases/DocumentState.md index 110a25504..8a99f0b89 100644 --- a/docs/api/type-aliases/DocumentState.md +++ b/docs/api/type-aliases/DocumentState.md @@ -8,8 +8,6 @@ > **DocumentState** = `object` -Defined in: [types/rag.ts:1598](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1598) - Document processing state held by MDocument. ## Properties @@ -18,44 +16,32 @@ Document processing state held by MDocument. > **content**: `string` -Defined in: [types/rag.ts:1599](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1599) - --- ### type > **type**: [`DocumentType`](DocumentType.md) -Defined in: [types/rag.ts:1600](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1600) - --- ### metadata > **metadata**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1601](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1601) - --- ### chunks > **chunks**: [`Chunk`](Chunk.md)[] -Defined in: [types/rag.ts:1602](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1602) - --- ### embeddings > **embeddings**: `number`[][] -Defined in: [types/rag.ts:1603](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1603) - --- ### history > **history**: `string`[] - -Defined in: [types/rag.ts:1604](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1604) diff --git a/docs/api/type-aliases/DocumentType.md b/docs/api/type-aliases/DocumentType.md index 7d9cf36ae..0bee83aef 100644 --- a/docs/api/type-aliases/DocumentType.md +++ b/docs/api/type-aliases/DocumentType.md @@ -8,6 +8,4 @@ > **DocumentType** = `"text"` \| `"markdown"` \| `"html"` \| `"json"` \| `"latex"` \| `"csv"` \| `"pdf"` -Defined in: [types/rag.ts:796](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L796) - Supported document types for processing diff --git a/docs/api/type-aliases/DocumentationResult.md b/docs/api/type-aliases/DocumentationResult.md index 2edf8a34a..0fe3bb728 100644 --- a/docs/api/type-aliases/DocumentationResult.md +++ b/docs/api/type-aliases/DocumentationResult.md @@ -8,8 +8,6 @@ > **DocumentationResult** = `object` -Defined in: [types/mcp.ts:2653](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2653) - Result of the AI documentation-generation workflow. ## Properties @@ -18,28 +16,20 @@ Result of the AI documentation-generation workflow. > **documentation**: `string` -Defined in: [types/mcp.ts:2654](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2654) - --- ### sections > **sections**: `string`[] -Defined in: [types/mcp.ts:2655](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2655) - --- ### examples > **examples**: `string`[] -Defined in: [types/mcp.ts:2656](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2656) - --- ### coverage > **coverage**: `number` - -Defined in: [types/mcp.ts:2657](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2657) diff --git a/docs/api/type-aliases/DomainConfig.md b/docs/api/type-aliases/DomainConfig.md index 464fc7d66..60ae4733e 100644 --- a/docs/api/type-aliases/DomainConfig.md +++ b/docs/api/type-aliases/DomainConfig.md @@ -8,8 +8,6 @@ > **DomainConfig** = `object` -Defined in: [types/domain.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L37) - Domain configuration type ## Properties @@ -18,48 +16,36 @@ Domain configuration type > **domainType**: [`DomainType`](DomainType.md) -Defined in: [types/domain.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L38) - --- ### domainName > **domainName**: `string` -Defined in: [types/domain.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L39) - --- ### description > **description**: `string` -Defined in: [types/domain.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L40) - --- ### evaluationCriteria > **evaluationCriteria**: [`DomainEvaluationCriteria`](DomainEvaluationCriteria.md) -Defined in: [types/domain.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L41) - --- ### customData? > `optional` **customData?**: [`JsonObject`](JsonObject.md) -Defined in: [types/domain.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L42) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/domain.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L43) - #### version > **version**: `string` diff --git a/docs/api/type-aliases/DomainConfigOptions.md b/docs/api/type-aliases/DomainConfigOptions.md index 8fdf30a97..24dfd7d1e 100644 --- a/docs/api/type-aliases/DomainConfigOptions.md +++ b/docs/api/type-aliases/DomainConfigOptions.md @@ -8,8 +8,6 @@ > **DomainConfigOptions** = `object` -Defined in: [types/domain.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L72) - Domain configuration options for factory ## Properties @@ -18,28 +16,20 @@ Domain configuration options for factory > **domainType**: [`DomainType`](DomainType.md) -Defined in: [types/domain.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L73) - --- ### customConfig? > `optional` **customConfig?**: `Partial`\<[`DomainConfig`](DomainConfig.md)\> -Defined in: [types/domain.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L74) - --- ### validateDomainData? > `optional` **validateDomainData?**: `boolean` -Defined in: [types/domain.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L75) - --- ### includeDefaults? > `optional` **includeDefaults?**: `boolean` - -Defined in: [types/domain.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L76) diff --git a/docs/api/type-aliases/DomainEvaluationCriteria.md b/docs/api/type-aliases/DomainEvaluationCriteria.md index 9334fff8c..f9eaa3544 100644 --- a/docs/api/type-aliases/DomainEvaluationCriteria.md +++ b/docs/api/type-aliases/DomainEvaluationCriteria.md @@ -8,8 +8,6 @@ > **DomainEvaluationCriteria** = `object` -Defined in: [types/domain.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L24) - Domain evaluation criteria type ## Properties @@ -18,52 +16,38 @@ Domain evaluation criteria type > **accuracyWeight**: `number` -Defined in: [types/domain.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L25) - --- ### completenessWeight > **completenessWeight**: `number` -Defined in: [types/domain.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L26) - --- ### relevanceWeight > **relevanceWeight**: `number` -Defined in: [types/domain.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L27) - --- ### terminologyWeight > **terminologyWeight**: `number` -Defined in: [types/domain.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L28) - --- ### domainSpecificRules > **domainSpecificRules**: `string`[] -Defined in: [types/domain.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L29) - --- ### failurePatterns > **failurePatterns**: `string`[] -Defined in: [types/domain.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L30) - --- ### successPatterns > **successPatterns**: `string`[] - -Defined in: [types/domain.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L31) diff --git a/docs/api/type-aliases/DomainTemplate.md b/docs/api/type-aliases/DomainTemplate.md index f40c62f87..4d2584402 100644 --- a/docs/api/type-aliases/DomainTemplate.md +++ b/docs/api/type-aliases/DomainTemplate.md @@ -8,8 +8,6 @@ > **DomainTemplate** = `object` -Defined in: [types/domain.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L53) - Domain template for factory registration ## Properties @@ -18,20 +16,14 @@ Domain template for factory registration > **domainType**: [`DomainType`](DomainType.md) -Defined in: [types/domain.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L54) - --- ### template > **template**: `Partial`\<[`DomainConfig`](DomainConfig.md)\> -Defined in: [types/domain.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L55) - --- ### isDefault? > `optional` **isDefault?**: `boolean` - -Defined in: [types/domain.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L56) diff --git a/docs/api/type-aliases/DomainType.md b/docs/api/type-aliases/DomainType.md index 8580500c5..c1c218d4e 100644 --- a/docs/api/type-aliases/DomainType.md +++ b/docs/api/type-aliases/DomainType.md @@ -8,6 +8,4 @@ > **DomainType** = `"healthcare"` \| `"finance"` \| `"analytics"` \| `"ecommerce"` \| `"education"` \| `"legal"` \| `"technology"` \| `"generic"` -Defined in: [types/domain.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L11) - Supported domain types for factory configuration diff --git a/docs/api/type-aliases/DomainValidationRule.md b/docs/api/type-aliases/DomainValidationRule.md index e5d5459d3..80194059a 100644 --- a/docs/api/type-aliases/DomainValidationRule.md +++ b/docs/api/type-aliases/DomainValidationRule.md @@ -8,8 +8,6 @@ > **DomainValidationRule** = `object` -Defined in: [types/domain.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L62) - Domain validation rule ## Properties @@ -18,24 +16,18 @@ Domain validation rule > **ruleName**: `string` -Defined in: [types/domain.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L63) - --- ### ruleType > **ruleType**: `"required"` \| `"pattern"` \| `"range"` \| `"custom"` -Defined in: [types/domain.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L64) - --- ### validation > **validation**: (`value`) => `boolean` -Defined in: [types/domain.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L65) - #### Parameters ##### value @@ -51,5 +43,3 @@ Defined in: [types/domain.ts:65](https://github.com/juspay/neurolink/blob/releas ### errorMessage > **errorMessage**: `string` - -Defined in: [types/domain.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/domain.ts#L66) diff --git a/docs/api/type-aliases/DynamicArgument.md b/docs/api/type-aliases/DynamicArgument.md index 0194c9523..8934f1d07 100644 --- a/docs/api/type-aliases/DynamicArgument.md +++ b/docs/api/type-aliases/DynamicArgument.md @@ -8,8 +8,6 @@ > **DynamicArgument**\<`T`\> = `T` \| (() => `T`) \| (() => `Promise`\<`T`\>) \| ((`context`) => `T`) \| ((`context`) => `Promise`\<`T`\>) -Defined in: [types/dynamic.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L44) - A value that can be static, a function, or a context-aware function. ## Type Parameters diff --git a/docs/api/type-aliases/DynamicCacheEntry.md b/docs/api/type-aliases/DynamicCacheEntry.md index db74fd7ef..960213b02 100644 --- a/docs/api/type-aliases/DynamicCacheEntry.md +++ b/docs/api/type-aliases/DynamicCacheEntry.md @@ -8,8 +8,6 @@ > **DynamicCacheEntry**\<`T`\> = `object` -Defined in: [types/dynamic.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L139) - ## Type Parameters ### T @@ -22,28 +20,20 @@ Defined in: [types/dynamic.ts:139](https://github.com/juspay/neurolink/blob/rele > **value**: `T` -Defined in: [types/dynamic.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L140) - --- ### resolvedAt > **resolvedAt**: `number` -Defined in: [types/dynamic.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L141) - --- ### expiresAt > **expiresAt**: `number` -Defined in: [types/dynamic.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L142) - --- ### key > **key**: `string` - -Defined in: [types/dynamic.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L143) diff --git a/docs/api/type-aliases/DynamicConfig.md b/docs/api/type-aliases/DynamicConfig.md index 5d4e9cf61..2582b89b8 100644 --- a/docs/api/type-aliases/DynamicConfig.md +++ b/docs/api/type-aliases/DynamicConfig.md @@ -8,8 +8,6 @@ > **DynamicConfig**\<`T`\> = `{ [K in keyof T]: DynamicArgument }` -Defined in: [types/dynamic.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L127) - ## Type Parameters ### T diff --git a/docs/api/type-aliases/DynamicModelConfig.md b/docs/api/type-aliases/DynamicModelConfig.md index 3e176bb83..c83a79479 100644 --- a/docs/api/type-aliases/DynamicModelConfig.md +++ b/docs/api/type-aliases/DynamicModelConfig.md @@ -8,6 +8,4 @@ > **DynamicModelConfig** = `z.infer`\<_typeof_ [`ModelConfigSchema`](../variables/ModelConfigSchema.md)\> -Defined in: [types/model.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L106) - Dynamic model configuration type diff --git a/docs/api/type-aliases/DynamicOptions.md b/docs/api/type-aliases/DynamicOptions.md index 803bb207d..db26a2a17 100644 --- a/docs/api/type-aliases/DynamicOptions.md +++ b/docs/api/type-aliases/DynamicOptions.md @@ -8,8 +8,6 @@ > **DynamicOptions** = `object` -Defined in: [types/dynamic.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L59) - Dynamic options for generate() and stream() — pass functions instead of static values for context-aware resolution. @@ -19,8 +17,6 @@ instead of static values for context-aware resolution. > `optional` **useKnowledgeGrounding?**: `boolean` -Defined in: [types/dynamic.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L65) - Opt this call into the knowledge grounding configured on the NeuroLink instance. This flag is intentionally static because grounding runs before dynamic arguments are resolved. @@ -31,8 +27,6 @@ dynamic arguments are resolved. > `optional` **knowledgeContext?**: [`KnowledgeRequestScope`](KnowledgeRequestScope.md) -Defined in: [types/dynamic.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L70) - Enabled integrations used to scope knowledge retrieval for this turn. This scope is intentionally static for the same reason. @@ -42,48 +36,36 @@ This scope is intentionally static for the same reason. > `optional` **model?**: [`DynamicArgument`](DynamicArgument.md)\<`string`\> -Defined in: [types/dynamic.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L71) - --- ### provider? > `optional` **provider?**: [`DynamicArgument`](DynamicArgument.md)\<[`AIProviderName`](../enumerations/AIProviderName.md) \| `string`\> -Defined in: [types/dynamic.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L72) - --- ### temperature? > `optional` **temperature?**: [`DynamicArgument`](DynamicArgument.md)\<`number`\> -Defined in: [types/dynamic.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L73) - --- ### maxTokens? > `optional` **maxTokens?**: [`DynamicArgument`](DynamicArgument.md)\<`number`\> -Defined in: [types/dynamic.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L74) - --- ### systemPrompt? > `optional` **systemPrompt?**: [`DynamicArgument`](DynamicArgument.md)\<`string`\> -Defined in: [types/dynamic.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L75) - --- ### tools? > `optional` **tools?**: [`DynamicArgument`](DynamicArgument.md)\<`string`[]\> -Defined in: [types/dynamic.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L82) - Resolves to a `string[]` of tool names to enable. The resolved array is merged into `enabledToolNames` (and from there into `toolFilter`) — it does NOT replace `GenerateOptions.tools`, @@ -95,48 +77,36 @@ which is a `Record` map of tool definitions. > `optional` **timeout?**: [`DynamicArgument`](DynamicArgument.md)\<`number`\> -Defined in: [types/dynamic.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L83) - --- ### thinkingLevel? > `optional` **thinkingLevel?**: [`DynamicArgument`](DynamicArgument.md)\<`"minimal"` \| `"low"` \| `"medium"` \| `"high"`\> -Defined in: [types/dynamic.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L84) - --- ### disableTools? > `optional` **disableTools?**: [`DynamicArgument`](DynamicArgument.md)\<`boolean`\> -Defined in: [types/dynamic.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L85) - --- ### enableAnalytics? > `optional` **enableAnalytics?**: [`DynamicArgument`](DynamicArgument.md)\<`boolean`\> -Defined in: [types/dynamic.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L86) - --- ### enableEvaluation? > `optional` **enableEvaluation?**: [`DynamicArgument`](DynamicArgument.md)\<`boolean`\> -Defined in: [types/dynamic.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L87) - --- ### input > **input**: `object` -Defined in: [types/dynamic.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L88) - #### text > **text**: `string` @@ -155,8 +125,6 @@ Defined in: [types/dynamic.ts:88](https://github.com/juspay/neurolink/blob/relea > `optional` **dynamicContext?**: `Record`\<`string`, `unknown`\> -Defined in: [types/dynamic.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L100) - Context passed to dynamic resolver functions — any shape you want. This is intentionally separate from `GenerateOptions.context` (which is diff --git a/docs/api/type-aliases/DynamicResolutionContext.md b/docs/api/type-aliases/DynamicResolutionContext.md index c90d57ed5..18c057f2f 100644 --- a/docs/api/type-aliases/DynamicResolutionContext.md +++ b/docs/api/type-aliases/DynamicResolutionContext.md @@ -8,8 +8,6 @@ > **DynamicResolutionContext** = `object` -Defined in: [types/dynamic.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L22) - Context passed to context-aware dynamic argument functions. `requestContext` is whatever the consumer passed as `dynamicContext` — NeuroLink does not prescribe its shape. @@ -20,8 +18,6 @@ NeuroLink does not prescribe its shape. > **requestContext**: `Record`\<`string`, `unknown`\> -Defined in: [types/dynamic.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L24) - Consumer-provided context (any shape) --- @@ -30,6 +26,4 @@ Consumer-provided context (any shape) > `optional` **signal?**: `AbortSignal` -Defined in: [types/dynamic.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/dynamic.ts#L26) - Abort signal for cancellation diff --git a/docs/api/type-aliases/EffectivePPTProviderResult.md b/docs/api/type-aliases/EffectivePPTProviderResult.md index 11ca5c653..e9cdd8530 100644 --- a/docs/api/type-aliases/EffectivePPTProviderResult.md +++ b/docs/api/type-aliases/EffectivePPTProviderResult.md @@ -8,8 +8,6 @@ > **EffectivePPTProviderResult** = `object` -Defined in: [types/ppt.ts:1236](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1236) - Result from getEffectivePPTProvider ## Properties @@ -18,8 +16,6 @@ Result from getEffectivePPTProvider > **provider**: `unknown` -Defined in: [types/ppt.ts:1238](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1238) - The provider to use for PPT generation --- @@ -28,8 +24,6 @@ The provider to use for PPT generation > **providerName**: `string` -Defined in: [types/ppt.ts:1240](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1240) - Provider name --- @@ -38,8 +32,6 @@ Provider name > **modelName**: `string` -Defined in: [types/ppt.ts:1242](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1242) - Model name --- @@ -48,6 +40,4 @@ Model name > **wasAutoSelected**: `boolean` -Defined in: [types/ppt.ts:1244](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1244) - Whether auto-selection was performed diff --git a/docs/api/type-aliases/ElevenLabsModel.md b/docs/api/type-aliases/ElevenLabsModel.md index 982bef983..1feca35c5 100644 --- a/docs/api/type-aliases/ElevenLabsModel.md +++ b/docs/api/type-aliases/ElevenLabsModel.md @@ -7,5 +7,3 @@ # Type Alias: ElevenLabsModel > **ElevenLabsModel** = `"eleven_multilingual_v2"` \| `"eleven_turbo_v2_5"` \| `"eleven_turbo_v2"` \| `"eleven_monolingual_v1"` - -Defined in: [types/voice.ts:470](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L470) diff --git a/docs/api/type-aliases/ElevenLabsTTSOptions.md b/docs/api/type-aliases/ElevenLabsTTSOptions.md index 38eb855c4..d3c210b87 100644 --- a/docs/api/type-aliases/ElevenLabsTTSOptions.md +++ b/docs/api/type-aliases/ElevenLabsTTSOptions.md @@ -8,8 +8,6 @@ > **ElevenLabsTTSOptions** = [`TTSOptions`](TTSOptions.md) & `object` -Defined in: [types/voice.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L476) - ## Type Declaration ### model? diff --git a/docs/api/type-aliases/ElevenLabsVoice.md b/docs/api/type-aliases/ElevenLabsVoice.md index 305531ced..73d9e3e76 100644 --- a/docs/api/type-aliases/ElevenLabsVoice.md +++ b/docs/api/type-aliases/ElevenLabsVoice.md @@ -8,40 +8,30 @@ > **ElevenLabsVoice** = `object` -Defined in: [types/stt.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L596) - ## Properties ### voice_id > **voice_id**: `string` -Defined in: [types/stt.ts:597](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L597) - --- ### name > **name**: `string` -Defined in: [types/stt.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L598) - --- ### category > **category**: `string` -Defined in: [types/stt.ts:599](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L599) - --- ### labels? > `optional` **labels?**: `object` -Defined in: [types/stt.ts:600](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L600) - #### accent? > `optional` **accent?**: `string` @@ -67,5 +57,3 @@ Defined in: [types/stt.ts:600](https://github.com/juspay/neurolink/blob/release/ ### preview_url? > `optional` **preview_url?**: `string` - -Defined in: [types/stt.ts:607](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L607) diff --git a/docs/api/type-aliases/ElevenLabsVoicesResponse.md b/docs/api/type-aliases/ElevenLabsVoicesResponse.md index d6aa080d3..4a722ec5d 100644 --- a/docs/api/type-aliases/ElevenLabsVoicesResponse.md +++ b/docs/api/type-aliases/ElevenLabsVoicesResponse.md @@ -8,12 +8,8 @@ > **ElevenLabsVoicesResponse** = `object` -Defined in: [types/stt.ts:610](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L610) - ## Properties ### voices > **voices**: [`ElevenLabsVoice`](ElevenLabsVoice.md)[] - -Defined in: [types/stt.ts:611](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L611) diff --git a/docs/api/type-aliases/Elicitation.md b/docs/api/type-aliases/Elicitation.md index bf794d960..c8b3c9a0c 100644 --- a/docs/api/type-aliases/Elicitation.md +++ b/docs/api/type-aliases/Elicitation.md @@ -8,6 +8,4 @@ > **Elicitation** = [`ConfirmationElicitation`](ConfirmationElicitation.md) \| [`TextElicitation`](TextElicitation.md) \| [`SelectElicitation`](SelectElicitation.md) \| [`MultiSelectElicitation`](MultiSelectElicitation.md) \| [`FormElicitation`](FormElicitation.md) \| [`FileElicitation`](FileElicitation.md) \| [`SecretElicitation`](SecretElicitation.md) -Defined in: [types/elicitation.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L207) - Union of all elicitation types diff --git a/docs/api/type-aliases/ElicitationCancelMessage.md b/docs/api/type-aliases/ElicitationCancelMessage.md index 58d53b6ab..a166b7c9d 100644 --- a/docs/api/type-aliases/ElicitationCancelMessage.md +++ b/docs/api/type-aliases/ElicitationCancelMessage.md @@ -8,8 +8,6 @@ > **ElicitationCancelMessage** = `object` -Defined in: [types/mcp.ts:1401](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1401) - Elicitation cancel protocol message ## Properties @@ -18,28 +16,20 @@ Elicitation cancel protocol message > **jsonrpc**: `"2.0"` -Defined in: [types/mcp.ts:1402](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1402) - --- ### id > **id**: `string` -Defined in: [types/mcp.ts:1403](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1403) - --- ### method > **method**: `"elicitation/cancel"` -Defined in: [types/mcp.ts:1404](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1404) - --- ### params > **params**: [`ElicitationCancelParams`](ElicitationCancelParams.md) - -Defined in: [types/mcp.ts:1405](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1405) diff --git a/docs/api/type-aliases/ElicitationCancelParams.md b/docs/api/type-aliases/ElicitationCancelParams.md index c60dbbc7a..bc0d9b3e4 100644 --- a/docs/api/type-aliases/ElicitationCancelParams.md +++ b/docs/api/type-aliases/ElicitationCancelParams.md @@ -8,8 +8,6 @@ > **ElicitationCancelParams** = `object` -Defined in: [types/mcp.ts:1356](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1356) - Cancel params type ## Properties @@ -18,12 +16,8 @@ Cancel params type > **requestId**: `string` -Defined in: [types/mcp.ts:1357](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1357) - --- ### reason? > `optional` **reason?**: `string` - -Defined in: [types/mcp.ts:1358](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1358) diff --git a/docs/api/type-aliases/ElicitationContext.md b/docs/api/type-aliases/ElicitationContext.md index e5c03836e..e0105de8a 100644 --- a/docs/api/type-aliases/ElicitationContext.md +++ b/docs/api/type-aliases/ElicitationContext.md @@ -8,8 +8,6 @@ > **ElicitationContext** = `object` -Defined in: [types/elicitation.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L291) - Elicitation context passed to tools ## Properties @@ -18,8 +16,6 @@ Elicitation context passed to tools > **confirm**: (`message`, `options?`) => `Promise`\<`boolean`\> -Defined in: [types/elicitation.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L295) - Request user confirmation #### Parameters @@ -48,8 +44,6 @@ Request user confirmation > **getText**: (`message`, `options?`) => `Promise`\<`string` \| `undefined`\> -Defined in: [types/elicitation.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L303) - Request text input #### Parameters @@ -78,8 +72,6 @@ Request text input > **select**: \<`T`\>(`message`, `options`) => `Promise`\<`T` \| `undefined`\> -Defined in: [types/elicitation.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L311) - Request selection #### Type Parameters @@ -108,8 +100,6 @@ Request selection > **multiSelect**: \<`T`\>(`message`, `options`) => `Promise`\<`T`[] \| `undefined`\> -Defined in: [types/elicitation.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L319) - Request multiple selections #### Type Parameters @@ -138,8 +128,6 @@ Request multiple selections > **form**: \<`T`\>(`message`, `fields`) => `Promise`\<`T` \| `undefined`\> -Defined in: [types/elicitation.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L327) - Request form input #### Type Parameters @@ -168,8 +156,6 @@ Request form input > **request**: (`elicitation`) => `Promise`\<[`ElicitationResponse`](ElicitationResponse.md)\> -Defined in: [types/elicitation.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L335) - Request raw elicitation #### Parameters diff --git a/docs/api/type-aliases/ElicitationHandler.md b/docs/api/type-aliases/ElicitationHandler.md index a5af0b1b8..4ecc0ecca 100644 --- a/docs/api/type-aliases/ElicitationHandler.md +++ b/docs/api/type-aliases/ElicitationHandler.md @@ -8,8 +8,6 @@ > **ElicitationHandler** = (`request`) => `Promise`\<[`ElicitationResponse`](ElicitationResponse.md)\> -Defined in: [types/elicitation.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L259) - Elicitation handler function type ## Parameters diff --git a/docs/api/type-aliases/ElicitationManagerConfig.md b/docs/api/type-aliases/ElicitationManagerConfig.md index ac7c31194..591a94e14 100644 --- a/docs/api/type-aliases/ElicitationManagerConfig.md +++ b/docs/api/type-aliases/ElicitationManagerConfig.md @@ -8,8 +8,6 @@ > **ElicitationManagerConfig** = `object` -Defined in: [types/elicitation.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L266) - Elicitation manager configuration ## Properties @@ -18,8 +16,6 @@ Elicitation manager configuration > `optional` **defaultTimeout?**: `number` -Defined in: [types/elicitation.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L270) - Default timeout for elicitation requests --- @@ -28,8 +24,6 @@ Default timeout for elicitation requests > `optional` **enabled?**: `boolean` -Defined in: [types/elicitation.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L275) - Whether to allow elicitation (can be disabled for automated environments) --- @@ -38,8 +32,6 @@ Whether to allow elicitation (can be disabled for automated environments) > `optional` **handler?**: [`ElicitationHandler`](ElicitationHandler.md) -Defined in: [types/elicitation.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L280) - Handler for processing elicitation requests --- @@ -48,6 +40,4 @@ Handler for processing elicitation requests > `optional` **fallbackBehavior?**: `"timeout"` \| `"default"` \| `"error"` -Defined in: [types/elicitation.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L285) - Fallback behavior when no handler is available diff --git a/docs/api/type-aliases/ElicitationProtocolAdapterConfig.md b/docs/api/type-aliases/ElicitationProtocolAdapterConfig.md index c979519d9..a926b81d8 100644 --- a/docs/api/type-aliases/ElicitationProtocolAdapterConfig.md +++ b/docs/api/type-aliases/ElicitationProtocolAdapterConfig.md @@ -8,8 +8,6 @@ > **ElicitationProtocolAdapterConfig** = `object` -Defined in: [types/mcp.ts:1429](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1429) - Protocol adapter configuration ## Properties @@ -18,28 +16,20 @@ Protocol adapter configuration > `optional` **manager?**: [`ElicitationManager`](../classes/ElicitationManager.md) -Defined in: [types/mcp.ts:1430](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1430) - --- ### defaultTimeout? > `optional` **defaultTimeout?**: `number` -Defined in: [types/mcp.ts:1431](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1431) - --- ### enableLogging? > `optional` **enableLogging?**: `boolean` -Defined in: [types/mcp.ts:1432](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1432) - --- ### customHandler? > `optional` **customHandler?**: [`ElicitationProtocolHandler`](ElicitationProtocolHandler.md) - -Defined in: [types/mcp.ts:1433](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1433) diff --git a/docs/api/type-aliases/ElicitationProtocolHandler.md b/docs/api/type-aliases/ElicitationProtocolHandler.md index 7271f462d..5d5adc4c0 100644 --- a/docs/api/type-aliases/ElicitationProtocolHandler.md +++ b/docs/api/type-aliases/ElicitationProtocolHandler.md @@ -8,8 +8,6 @@ > **ElicitationProtocolHandler** = (`message`) => `Promise`\<[`ElicitationProtocolPayload`](ElicitationProtocolPayload.md) \| `void`\> -Defined in: [types/mcp.ts:1421](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1421) - Protocol handler function type ## Parameters diff --git a/docs/api/type-aliases/ElicitationProtocolMessage.md b/docs/api/type-aliases/ElicitationProtocolMessage.md index be6ef7a42..02dd003da 100644 --- a/docs/api/type-aliases/ElicitationProtocolMessage.md +++ b/docs/api/type-aliases/ElicitationProtocolMessage.md @@ -8,8 +8,6 @@ > **ElicitationProtocolMessage** = `object` -Defined in: [types/mcp.ts:1365](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1365) - Base protocol message structure ## Properties @@ -18,28 +16,20 @@ Base protocol message structure > **jsonrpc**: `"2.0"` -Defined in: [types/mcp.ts:1366](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1366) - --- ### id > **id**: `string` -Defined in: [types/mcp.ts:1367](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1367) - --- ### method > **method**: [`ElicitationProtocolMessageType`](ElicitationProtocolMessageType.md) -Defined in: [types/mcp.ts:1368](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1368) - --- ### params > **params**: [`ElicitationRequestParams`](ElicitationRequestParams.md) \| [`ElicitationResponseParams`](ElicitationResponseParams.md) \| [`ElicitationCancelParams`](ElicitationCancelParams.md) - -Defined in: [types/mcp.ts:1369](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1369) diff --git a/docs/api/type-aliases/ElicitationProtocolMessageType.md b/docs/api/type-aliases/ElicitationProtocolMessageType.md index 215498f7b..660932bbb 100644 --- a/docs/api/type-aliases/ElicitationProtocolMessageType.md +++ b/docs/api/type-aliases/ElicitationProtocolMessageType.md @@ -8,6 +8,4 @@ > **ElicitationProtocolMessageType** = `"elicitation/request"` \| `"elicitation/response"` \| `"elicitation/cancel"` -Defined in: [types/mcp.ts:1319](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1319) - MCP elicitation protocol message types diff --git a/docs/api/type-aliases/ElicitationProtocolPayload.md b/docs/api/type-aliases/ElicitationProtocolPayload.md index 8ae9ea0cc..e9be7a974 100644 --- a/docs/api/type-aliases/ElicitationProtocolPayload.md +++ b/docs/api/type-aliases/ElicitationProtocolPayload.md @@ -8,6 +8,4 @@ > **ElicitationProtocolPayload** = [`ElicitationRequestMessage`](ElicitationRequestMessage.md) \| [`ElicitationResponseMessage`](ElicitationResponseMessage.md) \| [`ElicitationCancelMessage`](ElicitationCancelMessage.md) -Defined in: [types/mcp.ts:1412](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1412) - Protocol message union type diff --git a/docs/api/type-aliases/ElicitationRequest.md b/docs/api/type-aliases/ElicitationRequest.md index ad5d9b7a3..045bd09a1 100644 --- a/docs/api/type-aliases/ElicitationRequest.md +++ b/docs/api/type-aliases/ElicitationRequest.md @@ -8,8 +8,6 @@ > **ElicitationRequest** = `object` -Defined in: [types/elicitation.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L28) - Base elicitation request ## Properties @@ -18,8 +16,6 @@ Base elicitation request > **id**: `string` -Defined in: [types/elicitation.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L32) - Unique request identifier --- @@ -28,8 +24,6 @@ Unique request identifier > **type**: [`ElicitationType`](ElicitationType.md) -Defined in: [types/elicitation.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L37) - Type of elicitation --- @@ -38,8 +32,6 @@ Type of elicitation > **message**: `string` -Defined in: [types/elicitation.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L42) - Message to display to user --- @@ -48,8 +40,6 @@ Message to display to user > **toolName**: `string` -Defined in: [types/elicitation.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L47) - Tool requesting the elicitation --- @@ -58,8 +48,6 @@ Tool requesting the elicitation > `optional` **serverId?**: `string` -Defined in: [types/elicitation.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L52) - Server ID of the requesting tool --- @@ -68,8 +56,6 @@ Server ID of the requesting tool > `optional` **timeout?**: `number` -Defined in: [types/elicitation.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L57) - Request timeout in milliseconds --- @@ -78,8 +64,6 @@ Request timeout in milliseconds > `optional` **optional?**: `boolean` -Defined in: [types/elicitation.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L62) - Whether the request can be skipped --- @@ -88,8 +72,6 @@ Whether the request can be skipped > `optional` **defaultValue?**: [`JsonValue`](JsonValue.md) -Defined in: [types/elicitation.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L67) - Default value if skipped or timed out --- @@ -98,6 +80,4 @@ Default value if skipped or timed out > `optional` **context?**: [`JsonObject`](JsonObject.md) -Defined in: [types/elicitation.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L72) - Additional context for the request diff --git a/docs/api/type-aliases/ElicitationRequestMessage.md b/docs/api/type-aliases/ElicitationRequestMessage.md index 69a6b577f..d0b5ec324 100644 --- a/docs/api/type-aliases/ElicitationRequestMessage.md +++ b/docs/api/type-aliases/ElicitationRequestMessage.md @@ -8,8 +8,6 @@ > **ElicitationRequestMessage** = `object` -Defined in: [types/mcp.ts:1379](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1379) - Elicitation request protocol message ## Properties @@ -18,28 +16,20 @@ Elicitation request protocol message > **jsonrpc**: `"2.0"` -Defined in: [types/mcp.ts:1380](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1380) - --- ### id > **id**: `string` -Defined in: [types/mcp.ts:1381](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1381) - --- ### method > **method**: `"elicitation/request"` -Defined in: [types/mcp.ts:1382](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1382) - --- ### params > **params**: [`ElicitationRequestParams`](ElicitationRequestParams.md) - -Defined in: [types/mcp.ts:1383](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1383) diff --git a/docs/api/type-aliases/ElicitationRequestParams.md b/docs/api/type-aliases/ElicitationRequestParams.md index fb53af6ed..a1a7c606d 100644 --- a/docs/api/type-aliases/ElicitationRequestParams.md +++ b/docs/api/type-aliases/ElicitationRequestParams.md @@ -8,8 +8,6 @@ > **ElicitationRequestParams** = `object` -Defined in: [types/mcp.ts:1328](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1328) - Request params type ## Properties @@ -18,60 +16,44 @@ Request params type > **type**: [`ElicitationType`](ElicitationType.md) -Defined in: [types/mcp.ts:1329](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1329) - --- ### message > **message**: `string` -Defined in: [types/mcp.ts:1330](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1330) - --- ### toolName > **toolName**: `string` -Defined in: [types/mcp.ts:1331](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1331) - --- ### serverId? > `optional` **serverId?**: `string` -Defined in: [types/mcp.ts:1332](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1332) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/mcp.ts:1333](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1333) - --- ### optional? > `optional` **optional?**: `boolean` -Defined in: [types/mcp.ts:1334](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1334) - --- ### defaultValue? > `optional` **defaultValue?**: [`JsonValue`](JsonValue.md) -Defined in: [types/mcp.ts:1335](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1335) - --- ### options? > `optional` **options?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> - -Defined in: [types/mcp.ts:1336](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1336) diff --git a/docs/api/type-aliases/ElicitationResponse.md b/docs/api/type-aliases/ElicitationResponse.md index 72d81cab0..7fe3a53f3 100644 --- a/docs/api/type-aliases/ElicitationResponse.md +++ b/docs/api/type-aliases/ElicitationResponse.md @@ -8,8 +8,6 @@ > **ElicitationResponse** = `object` -Defined in: [types/elicitation.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L219) - Elicitation response ## Properties @@ -18,8 +16,6 @@ Elicitation response > **requestId**: `string` -Defined in: [types/elicitation.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L223) - Request ID this responds to --- @@ -28,8 +24,6 @@ Request ID this responds to > **responded**: `boolean` -Defined in: [types/elicitation.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L228) - Whether the user provided a response --- @@ -38,8 +32,6 @@ Whether the user provided a response > `optional` **value?**: [`JsonValue`](JsonValue.md) -Defined in: [types/elicitation.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L233) - The user's response value --- @@ -48,8 +40,6 @@ The user's response value > `optional` **cancelled?**: `boolean` -Defined in: [types/elicitation.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L238) - Whether the request was cancelled --- @@ -58,8 +48,6 @@ Whether the request was cancelled > `optional` **timedOut?**: `boolean` -Defined in: [types/elicitation.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L243) - Whether the request timed out --- @@ -68,8 +56,6 @@ Whether the request timed out > `optional` **error?**: `string` -Defined in: [types/elicitation.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L248) - Error message if response failed --- @@ -78,6 +64,4 @@ Error message if response failed > **timestamp**: `number` -Defined in: [types/elicitation.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L253) - Response timestamp diff --git a/docs/api/type-aliases/ElicitationResponseMessage.md b/docs/api/type-aliases/ElicitationResponseMessage.md index def2fe9e9..31137790c 100644 --- a/docs/api/type-aliases/ElicitationResponseMessage.md +++ b/docs/api/type-aliases/ElicitationResponseMessage.md @@ -8,8 +8,6 @@ > **ElicitationResponseMessage** = `object` -Defined in: [types/mcp.ts:1390](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1390) - Elicitation response protocol message ## Properties @@ -18,28 +16,20 @@ Elicitation response protocol message > **jsonrpc**: `"2.0"` -Defined in: [types/mcp.ts:1391](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1391) - --- ### id > **id**: `string` -Defined in: [types/mcp.ts:1392](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1392) - --- ### method > **method**: `"elicitation/response"` -Defined in: [types/mcp.ts:1393](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1393) - --- ### params > **params**: [`ElicitationResponseParams`](ElicitationResponseParams.md) - -Defined in: [types/mcp.ts:1394](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1394) diff --git a/docs/api/type-aliases/ElicitationResponseParams.md b/docs/api/type-aliases/ElicitationResponseParams.md index 42d0ed551..c5c13ca72 100644 --- a/docs/api/type-aliases/ElicitationResponseParams.md +++ b/docs/api/type-aliases/ElicitationResponseParams.md @@ -8,8 +8,6 @@ > **ElicitationResponseParams** = `object` -Defined in: [types/mcp.ts:1343](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1343) - Response params type ## Properties @@ -18,44 +16,32 @@ Response params type > **requestId**: `string` -Defined in: [types/mcp.ts:1344](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1344) - --- ### responded > **responded**: `boolean` -Defined in: [types/mcp.ts:1345](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1345) - --- ### value? > `optional` **value?**: [`JsonValue`](JsonValue.md) -Defined in: [types/mcp.ts:1346](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1346) - --- ### cancelled? > `optional` **cancelled?**: `boolean` -Defined in: [types/mcp.ts:1347](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1347) - --- ### timedOut? > `optional` **timedOut?**: `boolean` -Defined in: [types/mcp.ts:1348](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1348) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/mcp.ts:1349](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1349) diff --git a/docs/api/type-aliases/ElicitationType.md b/docs/api/type-aliases/ElicitationType.md index 4b52833b9..4ff48d505 100644 --- a/docs/api/type-aliases/ElicitationType.md +++ b/docs/api/type-aliases/ElicitationType.md @@ -8,6 +8,4 @@ > **ElicitationType** = `"confirmation"` \| `"text"` \| `"select"` \| `"multiselect"` \| `"form"` \| `"file"` \| `"secret"` -Defined in: [types/elicitation.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L16) - Elicitation request types diff --git a/docs/api/type-aliases/EmbedInput.md b/docs/api/type-aliases/EmbedInput.md index d36fd138f..9082ae4fa 100644 --- a/docs/api/type-aliases/EmbedInput.md +++ b/docs/api/type-aliases/EmbedInput.md @@ -8,8 +8,6 @@ > **EmbedInput** = `object` -Defined in: [types/providers.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L114) - Multi-modal embedding input — accepts text, image, or both. Used by providers that support multi-modal embeddings (e.g. Bedrock Titan Image, Nova Multimodal). @@ -19,8 +17,6 @@ Used by providers that support multi-modal embeddings (e.g. Bedrock Titan Image, > `optional` **text?**: `string` -Defined in: [types/providers.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L116) - Text content to embed --- @@ -29,8 +25,6 @@ Text content to embed > `optional` **image?**: `Buffer` \| `string` -Defined in: [types/providers.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L118) - Image data as Buffer or base64 string --- @@ -39,6 +33,4 @@ Image data as Buffer or base64 string > `optional` **mimeType?**: `string` -Defined in: [types/providers.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L120) - MIME type of the image (e.g. "image/png", "image/jpeg") diff --git a/docs/api/type-aliases/EmbedManyRequest.md b/docs/api/type-aliases/EmbedManyRequest.md index 9972308d7..d5b68ec01 100644 --- a/docs/api/type-aliases/EmbedManyRequest.md +++ b/docs/api/type-aliases/EmbedManyRequest.md @@ -8,8 +8,6 @@ > **EmbedManyRequest** = `object` -Defined in: [types/server.ts:662](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L662) - Embed many request (batch texts) ## Properties @@ -18,8 +16,6 @@ Embed many request (batch texts) > **texts**: `string`[] -Defined in: [types/server.ts:664](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L664) - Texts to embed --- @@ -28,8 +24,6 @@ Texts to embed > `optional` **provider?**: `string` -Defined in: [types/server.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L667) - Provider to use (optional) --- @@ -38,6 +32,4 @@ Provider to use (optional) > `optional` **model?**: `string` -Defined in: [types/server.ts:670](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L670) - Embedding model to use (optional) diff --git a/docs/api/type-aliases/EmbedManyResponse.md b/docs/api/type-aliases/EmbedManyResponse.md index fa4a191d3..d3f828dc5 100644 --- a/docs/api/type-aliases/EmbedManyResponse.md +++ b/docs/api/type-aliases/EmbedManyResponse.md @@ -8,8 +8,6 @@ > **EmbedManyResponse** = `object` -Defined in: [types/server.ts:676](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L676) - Embed many response (batch texts) ## Properties @@ -18,8 +16,6 @@ Embed many response (batch texts) > **embeddings**: `number`[][] -Defined in: [types/server.ts:678](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L678) - The embedding vectors --- @@ -28,8 +24,6 @@ The embedding vectors > **provider**: `string` -Defined in: [types/server.ts:681](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L681) - Provider used --- @@ -38,8 +32,6 @@ Provider used > **model**: `string` -Defined in: [types/server.ts:684](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L684) - Model used --- @@ -48,8 +40,6 @@ Model used > **count**: `number` -Defined in: [types/server.ts:687](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L687) - Number of embeddings --- @@ -58,6 +48,4 @@ Number of embeddings > **dimension**: `number` -Defined in: [types/server.ts:690](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L690) - Embedding dimension diff --git a/docs/api/type-aliases/EmbedRequest.md b/docs/api/type-aliases/EmbedRequest.md index c7ee4f1a3..c069dbfca 100644 --- a/docs/api/type-aliases/EmbedRequest.md +++ b/docs/api/type-aliases/EmbedRequest.md @@ -8,8 +8,6 @@ > **EmbedRequest** = `object` -Defined in: [types/server.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L631) - Embed request (single text) ## Properties @@ -18,8 +16,6 @@ Embed request (single text) > **text**: `string` -Defined in: [types/server.ts:633](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L633) - Text to embed --- @@ -28,8 +24,6 @@ Text to embed > `optional` **provider?**: `string` -Defined in: [types/server.ts:636](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L636) - Provider to use (optional) --- @@ -38,6 +32,4 @@ Provider to use (optional) > `optional` **model?**: `string` -Defined in: [types/server.ts:639](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L639) - Embedding model to use (optional) diff --git a/docs/api/type-aliases/EmbedResponse.md b/docs/api/type-aliases/EmbedResponse.md index 1480ee494..befcc53ee 100644 --- a/docs/api/type-aliases/EmbedResponse.md +++ b/docs/api/type-aliases/EmbedResponse.md @@ -8,8 +8,6 @@ > **EmbedResponse** = `object` -Defined in: [types/server.ts:645](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L645) - Embed response (single text) ## Properties @@ -18,8 +16,6 @@ Embed response (single text) > **embedding**: `number`[] -Defined in: [types/server.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L647) - The embedding vector --- @@ -28,8 +24,6 @@ The embedding vector > **provider**: `string` -Defined in: [types/server.ts:650](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L650) - Provider used --- @@ -38,8 +32,6 @@ Provider used > **model**: `string` -Defined in: [types/server.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L653) - Model used --- @@ -48,6 +40,4 @@ Model used > **dimension**: `number` -Defined in: [types/server.ts:656](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L656) - Embedding dimension diff --git a/docs/api/type-aliases/EmbeddingModality.md b/docs/api/type-aliases/EmbeddingModality.md index 689bd3967..9634df418 100644 --- a/docs/api/type-aliases/EmbeddingModality.md +++ b/docs/api/type-aliases/EmbeddingModality.md @@ -8,6 +8,4 @@ > **EmbeddingModality** = `"text"` \| `"image"` \| `"multimodal"` -Defined in: [types/rag.ts:1653](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1653) - Modality of an embedding model diff --git a/docs/api/type-aliases/EmbeddingModel.md b/docs/api/type-aliases/EmbeddingModel.md index 5a96c4b49..71689ed8d 100644 --- a/docs/api/type-aliases/EmbeddingModel.md +++ b/docs/api/type-aliases/EmbeddingModel.md @@ -7,5 +7,3 @@ # Type Alias: EmbeddingModel > **EmbeddingModel** = `string` \| `Record`\<`string`, `unknown`\> - -Defined in: [types/aiCompat.ts:537](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L537) diff --git a/docs/api/type-aliases/EmbeddingModelConfig.md b/docs/api/type-aliases/EmbeddingModelConfig.md index 4a6062d85..2119173ea 100644 --- a/docs/api/type-aliases/EmbeddingModelConfig.md +++ b/docs/api/type-aliases/EmbeddingModelConfig.md @@ -8,8 +8,6 @@ > **EmbeddingModelConfig** = `object` -Defined in: [types/rag.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L233) - Embedding model configuration ## Properties @@ -18,12 +16,8 @@ Embedding model configuration > **provider**: `string` -Defined in: [types/rag.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L234) - --- ### modelName > **modelName**: `string` - -Defined in: [types/rag.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L235) diff --git a/docs/api/type-aliases/EndpointHealth.md b/docs/api/type-aliases/EndpointHealth.md index 89e1a839e..66b7ed1d5 100644 --- a/docs/api/type-aliases/EndpointHealth.md +++ b/docs/api/type-aliases/EndpointHealth.md @@ -8,8 +8,6 @@ > **EndpointHealth** = `object` -Defined in: [types/providers.ts:2385](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2385) - Endpoint health and metadata information. ## Properties @@ -18,32 +16,24 @@ Endpoint health and metadata information. > **status**: `"healthy"` \| `"unhealthy"` \| `"unknown"` -Defined in: [types/providers.ts:2386](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2386) - --- ### responseTime > **responseTime**: `number` -Defined in: [types/providers.ts:2387](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2387) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:2388](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2388) - --- ### modelInfo? > `optional` **modelInfo?**: `object` -Defined in: [types/providers.ts:2389](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2389) - #### name? > `optional` **name?**: `string` diff --git a/docs/api/type-aliases/EndpointMetrics.md b/docs/api/type-aliases/EndpointMetrics.md index f7f0f4240..433fd2470 100644 --- a/docs/api/type-aliases/EndpointMetrics.md +++ b/docs/api/type-aliases/EndpointMetrics.md @@ -8,8 +8,6 @@ > **EndpointMetrics** = `object` -Defined in: [types/providers.ts:1875](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1875) - Endpoint metrics and monitoring data ## Properties @@ -18,8 +16,6 @@ Endpoint metrics and monitoring data > **endpointName**: `string` -Defined in: [types/providers.ts:1877](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1877) - Endpoint name --- @@ -28,8 +24,6 @@ Endpoint name > **invocations**: `number` -Defined in: [types/providers.ts:1879](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1879) - Total invocations --- @@ -38,8 +32,6 @@ Total invocations > **averageLatency**: `number` -Defined in: [types/providers.ts:1881](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1881) - Average latency in milliseconds --- @@ -48,8 +40,6 @@ Average latency in milliseconds > **errorRate**: `number` -Defined in: [types/providers.ts:1883](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1883) - Error rate percentage --- @@ -58,8 +48,6 @@ Error rate percentage > `optional` **cpuUtilization?**: `number` -Defined in: [types/providers.ts:1885](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1885) - CPU utilization percentage --- @@ -68,8 +56,6 @@ CPU utilization percentage > `optional` **memoryUtilization?**: `number` -Defined in: [types/providers.ts:1887](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1887) - Memory utilization percentage --- @@ -78,8 +64,6 @@ Memory utilization percentage > **instanceCount**: `number` -Defined in: [types/providers.ts:1889](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1889) - Instance count --- @@ -88,6 +72,4 @@ Instance count > **timestamp**: `string` -Defined in: [types/providers.ts:1891](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1891) - Timestamp of metrics as ISO 8601 date string diff --git a/docs/api/type-aliases/EnhancedContext.md b/docs/api/type-aliases/EnhancedContext.md index 0b7dbd316..12ca814d5 100644 --- a/docs/api/type-aliases/EnhancedContext.md +++ b/docs/api/type-aliases/EnhancedContext.md @@ -8,8 +8,6 @@ > **EnhancedContext** = [`BasicContext`](BasicContext.md) & `object` -Defined in: [types/aliases.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L233) - Enhanced execution context Extended context with additional metadata diff --git a/docs/api/type-aliases/EnhancedConversationTurn.md b/docs/api/type-aliases/EnhancedConversationTurn.md index d2b929f74..386f7f132 100644 --- a/docs/api/type-aliases/EnhancedConversationTurn.md +++ b/docs/api/type-aliases/EnhancedConversationTurn.md @@ -8,8 +8,6 @@ > **EnhancedConversationTurn** = `object` -Defined in: [types/evaluation.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L181) - Represents a single turn in an enhanced conversation history, including tool executions and evaluations for richer context. @@ -19,8 +17,6 @@ including tool executions and evaluations for richer context. > **role**: `"user"` \| `"assistant"` -Defined in: [types/evaluation.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L183) - The role of the speaker, either 'user' or 'assistant'. --- @@ -29,8 +25,6 @@ The role of the speaker, either 'user' or 'assistant'. > **content**: `string` -Defined in: [types/evaluation.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L185) - The content of the message. --- @@ -39,8 +33,6 @@ The content of the message. > **timestamp**: `string` -Defined in: [types/evaluation.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L187) - The timestamp of the message. --- @@ -49,8 +41,6 @@ The timestamp of the message. > `optional` **toolExecutions?**: [`ToolExecution`](ToolExecution.md)[] -Defined in: [types/evaluation.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L189) - Any tools that were executed as part of this turn. --- @@ -59,6 +49,4 @@ Any tools that were executed as part of this turn. > `optional` **evaluation?**: [`EvaluationResult`](EvaluationResult.md) -Defined in: [types/evaluation.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L191) - The evaluation result for this turn, if applicable. diff --git a/docs/api/type-aliases/EnhancedEvaluationContext.md b/docs/api/type-aliases/EnhancedEvaluationContext.md index cc1a0e179..5e927fe80 100644 --- a/docs/api/type-aliases/EnhancedEvaluationContext.md +++ b/docs/api/type-aliases/EnhancedEvaluationContext.md @@ -8,8 +8,6 @@ > **EnhancedEvaluationContext** = `object` -Defined in: [types/evaluation.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L198) - Contains all the rich context needed for a thorough, RAGAS-style evaluation. This object is constructed by the `ContextBuilder` and used by the `RAGASEvaluator`. @@ -19,8 +17,6 @@ This object is constructed by the `ContextBuilder` and used by the `RAGASEvaluat > **userQuery**: `string` -Defined in: [types/evaluation.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L200) - The original user query. --- @@ -29,8 +25,6 @@ The original user query. > **queryAnalysis**: [`QueryIntentAnalysis`](QueryIntentAnalysis.md) -Defined in: [types/evaluation.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L202) - An analysis of the user's query intent. --- @@ -39,8 +33,6 @@ An analysis of the user's query intent. > **aiResponse**: `string` -Defined in: [types/evaluation.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L205) - The AI's response that is being evaluated. --- @@ -49,8 +41,6 @@ The AI's response that is being evaluated. > **provider**: `string` -Defined in: [types/evaluation.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L207) - The AI provider that generated the response. --- @@ -59,8 +49,6 @@ The AI provider that generated the response. > **model**: `string` -Defined in: [types/evaluation.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L209) - The specific model that generated the response. --- @@ -69,8 +57,6 @@ The specific model that generated the response. > **generationParams**: `object` -Defined in: [types/evaluation.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L212) - The parameters used for the generation call. #### temperature? @@ -91,8 +77,6 @@ The parameters used for the generation call. > **toolExecutions**: [`ToolExecution`](ToolExecution.md)[] -Defined in: [types/evaluation.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L219) - A list of tools that were executed. --- @@ -101,8 +85,6 @@ A list of tools that were executed. > **conversationHistory**: [`EnhancedConversationTurn`](EnhancedConversationTurn.md)[] -Defined in: [types/evaluation.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L222) - The history of the conversation leading up to this turn. --- @@ -111,8 +93,6 @@ The history of the conversation leading up to this turn. > **responseTime**: `number` -Defined in: [types/evaluation.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L225) - The response time of the AI in milliseconds. --- @@ -121,8 +101,6 @@ The response time of the AI in milliseconds. > **tokenUsage**: [`TokenUsage`](TokenUsage.md) -Defined in: [types/evaluation.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L227) - The token usage for the generation. --- @@ -131,8 +109,6 @@ The token usage for the generation. > `optional` **previousEvaluations?**: [`EvaluationResult`](EvaluationResult.md)[] -Defined in: [types/evaluation.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L230) - The results of any previous evaluation attempts for this response. --- @@ -141,6 +117,4 @@ The results of any previous evaluation attempts for this response. > **attemptNumber**: `number` -Defined in: [types/evaluation.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L232) - The current attempt number for this evaluation (1-based). diff --git a/docs/api/type-aliases/EnhancedEvaluationResult.md b/docs/api/type-aliases/EnhancedEvaluationResult.md index c6d355563..46019cdbb 100644 --- a/docs/api/type-aliases/EnhancedEvaluationResult.md +++ b/docs/api/type-aliases/EnhancedEvaluationResult.md @@ -8,8 +8,6 @@ > **EnhancedEvaluationResult** = [`EvaluationData`](EvaluationData.md) & `object` -Defined in: [types/evaluation.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L120) - Evaluation result type Extends EvaluationData with additional fields diff --git a/docs/api/type-aliases/EnhancedExecutionContext.md b/docs/api/type-aliases/EnhancedExecutionContext.md index 3334339ec..414198ae2 100644 --- a/docs/api/type-aliases/EnhancedExecutionContext.md +++ b/docs/api/type-aliases/EnhancedExecutionContext.md @@ -8,8 +8,6 @@ > **EnhancedExecutionContext** = [`NeuroLinkExecutionContext`](NeuroLinkExecutionContext.md) & `object` -Defined in: [types/mcp.ts:2259](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2259) - Tool execution context with elicitation support ## Type Declaration diff --git a/docs/api/type-aliases/EnhancedGenerateResult.md b/docs/api/type-aliases/EnhancedGenerateResult.md index dcaca7ec6..de0150cc9 100644 --- a/docs/api/type-aliases/EnhancedGenerateResult.md +++ b/docs/api/type-aliases/EnhancedGenerateResult.md @@ -8,8 +8,6 @@ > **EnhancedGenerateResult** = [`GenerateResult`](GenerateResult.md) & `object` -Defined in: [types/generate.ts:1851](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1851) - ## Type Declaration ### analytics? diff --git a/docs/api/type-aliases/EnhancedGroundingMetadata.md b/docs/api/type-aliases/EnhancedGroundingMetadata.md index f92e690e7..31e31c3cd 100644 --- a/docs/api/type-aliases/EnhancedGroundingMetadata.md +++ b/docs/api/type-aliases/EnhancedGroundingMetadata.md @@ -8,8 +8,6 @@ > **EnhancedGroundingMetadata** = `object` -Defined in: [types/grounding.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L130) - Comprehensive grounding metadata containing all information about how an AI response is grounded in external sources. This is the primary type used to represent the complete grounding context for a response. @@ -41,8 +39,6 @@ const metadata: EnhancedGroundingMetadata = { > **query**: `string` -Defined in: [types/grounding.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L132) - The original user query that triggered the grounded response --- @@ -51,8 +47,6 @@ The original user query that triggered the grounded response > `optional` **webSearchQueries?**: `string`[] -Defined in: [types/grounding.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L134) - Array of search queries used to find grounding sources --- @@ -61,8 +55,6 @@ Array of search queries used to find grounding sources > **searchResults**: [`EnhancedSearchResult`](EnhancedSearchResult.md)[] -Defined in: [types/grounding.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L136) - Array of search results returned from web search --- @@ -71,8 +63,6 @@ Array of search results returned from web search > `optional` **segmentAttributions?**: [`SegmentAttribution`](SegmentAttribution.md)[] -Defined in: [types/grounding.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L138) - Fine-grained attributions mapping response segments to sources --- @@ -81,8 +71,6 @@ Fine-grained attributions mapping response segments to sources > **sources**: [`EnhancedGroundingSource`](EnhancedGroundingSource.md)[] -Defined in: [types/grounding.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L140) - Array of all sources used to ground the response --- @@ -91,8 +79,6 @@ Array of all sources used to ground the response > `optional` **averageConfidence?**: `number` -Defined in: [types/grounding.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L142) - Average confidence score across all grounding attributions (0-1) --- @@ -101,6 +87,4 @@ Average confidence score across all grounding attributions (0-1) > **grounded**: `boolean` -Defined in: [types/grounding.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L144) - Whether the response is successfully grounded in sources diff --git a/docs/api/type-aliases/EnhancedGroundingSource.md b/docs/api/type-aliases/EnhancedGroundingSource.md index d9232c27e..120569ec7 100644 --- a/docs/api/type-aliases/EnhancedGroundingSource.md +++ b/docs/api/type-aliases/EnhancedGroundingSource.md @@ -8,8 +8,6 @@ > **EnhancedGroundingSource** = `object` -Defined in: [types/grounding.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L27) - Represents a grounding source with enhanced metadata for search results. Used when grounding responses with web search or retrieval results to provide detailed information about each source that supports the AI response. @@ -33,8 +31,6 @@ const source: EnhancedGroundingSource = { > **uri**: `string` -Defined in: [types/grounding.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L29) - The full URI/URL of the source document --- @@ -43,8 +39,6 @@ The full URI/URL of the source document > **title**: `string` -Defined in: [types/grounding.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L31) - The title of the source document or web page --- @@ -53,8 +47,6 @@ The title of the source document or web page > **domain**: `string` -Defined in: [types/grounding.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L33) - The domain name extracted from the URI (e.g., "example.com") --- @@ -63,8 +55,6 @@ The domain name extracted from the URI (e.g., "example.com") > `optional` **confidenceScore?**: `number` -Defined in: [types/grounding.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L35) - Confidence score (0-1) indicating how well this source supports the response --- @@ -73,8 +63,6 @@ Confidence score (0-1) indicating how well this source supports the response > `optional` **isPrimary?**: `boolean` -Defined in: [types/grounding.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L37) - Whether this is a primary source for the grounded response --- @@ -83,6 +71,4 @@ Whether this is a primary source for the grounded response > `optional` **chunkIndex?**: `number` -Defined in: [types/grounding.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L39) - Index of the chunk within the source document that was used diff --git a/docs/api/type-aliases/EnhancedProvider.md b/docs/api/type-aliases/EnhancedProvider.md index d05f6211f..08209c8dd 100644 --- a/docs/api/type-aliases/EnhancedProvider.md +++ b/docs/api/type-aliases/EnhancedProvider.md @@ -8,8 +8,6 @@ > **EnhancedProvider** = `object` -Defined in: [types/generate.ts:1273](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1273) - Enhanced provider type with generate method ## Methods @@ -18,8 +16,6 @@ Enhanced provider type with generate method > **generate**(`options`): `Promise`\<[`GenerateResult`](GenerateResult.md)\> -Defined in: [types/generate.ts:1274](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1274) - #### Parameters ##### options @@ -36,8 +32,6 @@ Defined in: [types/generate.ts:1274](https://github.com/juspay/neurolink/blob/re > **getName**(): `string` -Defined in: [types/generate.ts:1275](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1275) - #### Returns `string` @@ -48,8 +42,6 @@ Defined in: [types/generate.ts:1275](https://github.com/juspay/neurolink/blob/re > **isAvailable**(): `Promise`\<`boolean`\> -Defined in: [types/generate.ts:1276](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1276) - #### Returns `Promise`\<`boolean`\> diff --git a/docs/api/type-aliases/EnhancedSearchResult.md b/docs/api/type-aliases/EnhancedSearchResult.md index c105dd2bd..c0a0869ef 100644 --- a/docs/api/type-aliases/EnhancedSearchResult.md +++ b/docs/api/type-aliases/EnhancedSearchResult.md @@ -8,8 +8,6 @@ > **EnhancedSearchResult** = `object` -Defined in: [types/grounding.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L102) - Represents a search result returned from web search grounding. Contains the essential information from a web search result that can be used to ground and verify AI responses. @@ -30,8 +28,6 @@ const result: EnhancedSearchResult = { > **uri**: `string` -Defined in: [types/grounding.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L104) - The full URI/URL of the search result --- @@ -40,8 +36,6 @@ The full URI/URL of the search result > **title**: `string` -Defined in: [types/grounding.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L106) - The title of the search result page --- @@ -50,6 +44,4 @@ The title of the search result page > `optional` **snippet?**: `string` -Defined in: [types/grounding.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L108) - Optional text snippet from the search result showing relevant content diff --git a/docs/api/type-aliases/EnhancedStreamProvider.md b/docs/api/type-aliases/EnhancedStreamProvider.md index db1042b58..3b0fd65b0 100644 --- a/docs/api/type-aliases/EnhancedStreamProvider.md +++ b/docs/api/type-aliases/EnhancedStreamProvider.md @@ -8,8 +8,6 @@ > **EnhancedStreamProvider** = `object` -Defined in: [types/stream.ts:1075](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1075) - Enhanced provider type with stream method ## Methods @@ -18,8 +16,6 @@ Enhanced provider type with stream method > **stream**(`options`): `Promise`\<[`StreamResult`](StreamResult.md)\> -Defined in: [types/stream.ts:1076](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1076) - #### Parameters ##### options @@ -36,8 +32,6 @@ Defined in: [types/stream.ts:1076](https://github.com/juspay/neurolink/blob/rele > **getName**(): `string` -Defined in: [types/stream.ts:1077](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1077) - #### Returns `string` @@ -48,8 +42,6 @@ Defined in: [types/stream.ts:1077](https://github.com/juspay/neurolink/blob/rele > **isAvailable**(): `Promise`\<`boolean`\> -Defined in: [types/stream.ts:1078](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L1078) - #### Returns `Promise`\<`boolean`\> diff --git a/docs/api/type-aliases/EnhancedToolInfo.md b/docs/api/type-aliases/EnhancedToolInfo.md index f902b477b..09660c2d7 100644 --- a/docs/api/type-aliases/EnhancedToolInfo.md +++ b/docs/api/type-aliases/EnhancedToolInfo.md @@ -8,8 +8,6 @@ > **EnhancedToolInfo** = [`ExternalMCPToolInfo`](ExternalMCPToolInfo.md) & `object` -Defined in: [types/mcp.ts:1440](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1440) - Enhanced tool info with annotations ## Type Declaration diff --git a/docs/api/type-aliases/EnhancedValidationResult.md b/docs/api/type-aliases/EnhancedValidationResult.md index 1ff410737..ba22f2d16 100644 --- a/docs/api/type-aliases/EnhancedValidationResult.md +++ b/docs/api/type-aliases/EnhancedValidationResult.md @@ -8,8 +8,6 @@ > **EnhancedValidationResult** = `object` -Defined in: [types/tools.ts:646](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L646) - Result of a validation operation Contains validation status, errors, warnings, and suggestions for improvement @@ -19,8 +17,6 @@ Contains validation status, errors, warnings, and suggestions for improvement > **isValid**: `boolean` -Defined in: [types/tools.ts:648](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L648) - Whether the validation passed without errors --- @@ -29,8 +25,6 @@ Whether the validation passed without errors > **errors**: `ValidationError`[] -Defined in: [types/tools.ts:650](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L650) - Array of validation errors that must be fixed --- @@ -39,8 +33,6 @@ Array of validation errors that must be fixed > **warnings**: `string`[] -Defined in: [types/tools.ts:652](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L652) - Array of warning messages that should be addressed --- @@ -49,6 +41,4 @@ Array of warning messages that should be addressed > **suggestions**: [`StringArray`](StringArray.md) -Defined in: [types/tools.ts:654](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L654) - Array of suggestions to improve the validated object diff --git a/docs/api/type-aliases/EnhancementOptions.md b/docs/api/type-aliases/EnhancementOptions.md index 4cb247d0c..627363cc5 100644 --- a/docs/api/type-aliases/EnhancementOptions.md +++ b/docs/api/type-aliases/EnhancementOptions.md @@ -8,8 +8,6 @@ > **EnhancementOptions** = `object` -Defined in: [types/utilities.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L127) - Enhancement options for modifying GenerateOptions ## Properties @@ -18,16 +16,12 @@ Enhancement options for modifying GenerateOptions > **enhancementType**: [`EnhancementType`](EnhancementType.md) -Defined in: [types/utilities.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L128) - --- ### streamingOptions? > `optional` **streamingOptions?**: `object` -Defined in: [types/utilities.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L129) - #### enabled? > `optional` **enabled?**: `boolean` @@ -54,8 +48,6 @@ Defined in: [types/utilities.ts:129](https://github.com/juspay/neurolink/blob/re > `optional` **mcpOptions?**: `object` -Defined in: [types/utilities.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L136) - #### enableToolRegistry? > `optional` **enableToolRegistry?**: `boolean` @@ -74,8 +66,6 @@ Defined in: [types/utilities.ts:136](https://github.com/juspay/neurolink/blob/re > `optional` **legacyMigration?**: `object` -Defined in: [types/utilities.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L141) - #### legacyContext? > `optional` **legacyContext?**: `Record`\<`string`, `unknown`\> @@ -94,8 +84,6 @@ Defined in: [types/utilities.ts:141](https://github.com/juspay/neurolink/blob/re > `optional` **domainConfiguration?**: `object` -Defined in: [types/utilities.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L146) - #### domainType > **domainType**: `string` @@ -122,8 +110,6 @@ Defined in: [types/utilities.ts:146](https://github.com/juspay/neurolink/blob/re > `optional` **performance?**: `object` -Defined in: [types/utilities.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L153) - #### enableAnalytics? > `optional` **enableAnalytics?**: `boolean` diff --git a/docs/api/type-aliases/EnhancementResult.md b/docs/api/type-aliases/EnhancementResult.md index e5872238e..218e00d60 100644 --- a/docs/api/type-aliases/EnhancementResult.md +++ b/docs/api/type-aliases/EnhancementResult.md @@ -8,8 +8,6 @@ > **EnhancementResult** = `object` -Defined in: [types/utilities.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L163) - Enhancement result with metadata ## Properties @@ -18,16 +16,12 @@ Enhancement result with metadata > **options**: [`UnifiedGenerationOptions`](UnifiedGenerationOptions.md) -Defined in: [types/utilities.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L164) - --- ### metadata > **metadata**: `object` -Defined in: [types/utilities.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L165) - #### enhancementApplied > **enhancementApplied**: `boolean` diff --git a/docs/api/type-aliases/EnhancementType.md b/docs/api/type-aliases/EnhancementType.md index 29cf7bff3..4669a08e3 100644 --- a/docs/api/type-aliases/EnhancementType.md +++ b/docs/api/type-aliases/EnhancementType.md @@ -8,6 +8,4 @@ > **EnhancementType** = `"streaming-optimization"` \| `"mcp-integration"` \| `"legacy-migration"` \| `"context-conversion"` \| `"domain-configuration"` \| `"batch-parallel-enhancement"` \| `"batch-hybrid-enhancement"` \| `"batch-dependency-enhancement"` -Defined in: [types/utilities.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L114) - Enhancement types for different optimization strategies diff --git a/docs/api/type-aliases/EnsembleExecutionResult.md b/docs/api/type-aliases/EnsembleExecutionResult.md index c09f09ea5..66df9532f 100644 --- a/docs/api/type-aliases/EnsembleExecutionResult.md +++ b/docs/api/type-aliases/EnsembleExecutionResult.md @@ -8,8 +8,6 @@ > **EnsembleExecutionResult** = `object` -Defined in: [types/workflow.ts:548](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L548) - Result of ensemble execution ## Properties @@ -18,36 +16,26 @@ Result of ensemble execution > **responses**: [`EnsembleResponse`](EnsembleResponse.md)[] -Defined in: [types/workflow.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L549) - --- ### totalTime > **totalTime**: `number` -Defined in: [types/workflow.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L550) - --- ### successCount > **successCount**: `number` -Defined in: [types/workflow.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L551) - --- ### failureCount > **failureCount**: `number` -Defined in: [types/workflow.ts:552](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L552) - --- ### errors > **errors**: [`WorkflowError`](../classes/WorkflowError.md)[] - -Defined in: [types/workflow.ts:553](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L553) diff --git a/docs/api/type-aliases/EnsembleResponse.md b/docs/api/type-aliases/EnsembleResponse.md index 2bbe55b95..0c3cb9cd8 100644 --- a/docs/api/type-aliases/EnsembleResponse.md +++ b/docs/api/type-aliases/EnsembleResponse.md @@ -8,8 +8,6 @@ > **EnsembleResponse** = `object` -Defined in: [types/workflow.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L307) - Single ensemble model response ## Properties @@ -18,48 +16,36 @@ Single ensemble model response > **provider**: `string` -Defined in: [types/workflow.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L309) - --- ### model > **model**: `string` -Defined in: [types/workflow.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L310) - --- ### modelLabel? > `optional` **modelLabel?**: `string` -Defined in: [types/workflow.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L311) - --- ### content > **content**: `string` -Defined in: [types/workflow.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L314) - --- ### responseTime > **responseTime**: `number` -Defined in: [types/workflow.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L317) - --- ### usage? > `optional` **usage?**: `object` -Defined in: [types/workflow.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L320) - #### inputTokens > **inputTokens**: `number` @@ -78,28 +64,20 @@ Defined in: [types/workflow.ts:320](https://github.com/juspay/neurolink/blob/rel > **status**: `"success"` \| `"failure"` \| `"timeout"` \| `"partial"` -Defined in: [types/workflow.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L327) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/workflow.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L328) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/workflow.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L331) - --- ### timestamp > **timestamp**: `string` - -Defined in: [types/workflow.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L332) diff --git a/docs/api/type-aliases/Entity.md b/docs/api/type-aliases/Entity.md index 3f65cd281..aca2ed4a1 100644 --- a/docs/api/type-aliases/Entity.md +++ b/docs/api/type-aliases/Entity.md @@ -8,8 +8,6 @@ > **Entity** = `object` -Defined in: [types/agentNetwork.ts:870](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L870) - Entity extracted from task ## Properties @@ -18,8 +16,6 @@ Entity extracted from task > **type**: `string` -Defined in: [types/agentNetwork.ts:872](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L872) - Entity type --- @@ -28,8 +24,6 @@ Entity type > **value**: `string` -Defined in: [types/agentNetwork.ts:875](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L875) - Entity value --- @@ -38,6 +32,4 @@ Entity value > **confidence**: `number` -Defined in: [types/agentNetwork.ts:878](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L878) - Confidence score diff --git a/docs/api/type-aliases/EntityId.md b/docs/api/type-aliases/EntityId.md index ea2311636..3668b8b3e 100644 --- a/docs/api/type-aliases/EntityId.md +++ b/docs/api/type-aliases/EntityId.md @@ -8,8 +8,6 @@ > **EntityId** = `string` & `object` -Defined in: [types/aliases.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L312) - ID type for entity identifiers ## Type Declaration diff --git a/docs/api/type-aliases/EnvBackupResult.md b/docs/api/type-aliases/EnvBackupResult.md index ccc20ce2d..c437e7c70 100644 --- a/docs/api/type-aliases/EnvBackupResult.md +++ b/docs/api/type-aliases/EnvBackupResult.md @@ -8,8 +8,6 @@ > **EnvBackupResult** = `object` -Defined in: [types/cli.ts:630](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L630) - Environment file backup result ## Properties @@ -18,12 +16,8 @@ Environment file backup result > `optional` **backupPath?**: `string` -Defined in: [types/cli.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L631) - --- ### existed > **existed**: `boolean` - -Defined in: [types/cli.ts:632](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L632) diff --git a/docs/api/type-aliases/EnvUpdateResult.md b/docs/api/type-aliases/EnvUpdateResult.md index 194fee8d3..d19dfda31 100644 --- a/docs/api/type-aliases/EnvUpdateResult.md +++ b/docs/api/type-aliases/EnvUpdateResult.md @@ -8,8 +8,6 @@ > **EnvUpdateResult** = `object` -Defined in: [types/cli.ts:638](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L638) - Environment file update result ## Properties @@ -18,36 +16,26 @@ Environment file update result > **backup**: [`EnvBackupResult`](EnvBackupResult.md) -Defined in: [types/cli.ts:639](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L639) - --- ### updated > **updated**: `string`[] -Defined in: [types/cli.ts:640](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L640) - --- ### added > **added**: `string`[] -Defined in: [types/cli.ts:641](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L641) - --- ### unchanged > **unchanged**: `string`[] -Defined in: [types/cli.ts:642](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L642) - --- ### deleted > **deleted**: `string`[] - -Defined in: [types/cli.ts:643](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L643) diff --git a/docs/api/type-aliases/EnvVarValidationResult.md b/docs/api/type-aliases/EnvVarValidationResult.md index 55d0170f3..7773022c6 100644 --- a/docs/api/type-aliases/EnvVarValidationResult.md +++ b/docs/api/type-aliases/EnvVarValidationResult.md @@ -8,8 +8,6 @@ > **EnvVarValidationResult** = `object` -Defined in: [types/utilities.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L224) - Validation results for environment variables ## Properties @@ -18,28 +16,20 @@ Validation results for environment variables > **isValid**: `boolean` -Defined in: [types/utilities.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L225) - --- ### missingVars > **missingVars**: `string`[] -Defined in: [types/utilities.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L226) - --- ### invalidVars > **invalidVars**: `string`[] -Defined in: [types/utilities.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L227) - --- ### warnings > **warnings**: `string`[] - -Defined in: [types/utilities.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L228) diff --git a/docs/api/type-aliases/EphemeralContext.md b/docs/api/type-aliases/EphemeralContext.md index a566230f9..deb28ccd1 100644 --- a/docs/api/type-aliases/EphemeralContext.md +++ b/docs/api/type-aliases/EphemeralContext.md @@ -8,8 +8,6 @@ > **EphemeralContext** = `object` -Defined in: [types/knowledge.ts:367](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L367) - A block of context assembled for a single generation call without becoming durable conversation. The NeuroLink call boundary injects its content into the effective system prompt and never persists it as a user message. @@ -20,24 +18,18 @@ the effective system prompt and never persists it as a user message. > **content**: `string` -Defined in: [types/knowledge.ts:368](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L368) - --- ### kind > **kind**: `"knowledge"` -Defined in: [types/knowledge.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L369) - --- ### trusted > **trusted**: `boolean` -Defined in: [types/knowledge.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L371) - Host-supplied reviewed content is trusted reference data. --- @@ -46,12 +38,8 @@ Host-supplied reviewed content is trusted reference data. > `optional` **citations?**: [`KnowledgeCitation`](KnowledgeCitation.md)[] -Defined in: [types/knowledge.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L372) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/knowledge.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L373) diff --git a/docs/api/type-aliases/ErrorCategoryType.md b/docs/api/type-aliases/ErrorCategoryType.md index df4abd0ae..bea9dc578 100644 --- a/docs/api/type-aliases/ErrorCategoryType.md +++ b/docs/api/type-aliases/ErrorCategoryType.md @@ -7,5 +7,3 @@ # Type Alias: ErrorCategoryType > **ErrorCategoryType** = _typeof_ [`ErrorCategory`](../variables/ErrorCategory.md)\[keyof _typeof_ [`ErrorCategory`](../variables/ErrorCategory.md)\] - -Defined in: [types/server.ts:1085](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1085) diff --git a/docs/api/type-aliases/ErrorCode.md b/docs/api/type-aliases/ErrorCode.md index fa27255d9..8ba60d3f8 100644 --- a/docs/api/type-aliases/ErrorCode.md +++ b/docs/api/type-aliases/ErrorCode.md @@ -8,6 +8,4 @@ > **ErrorCode** = `string` -Defined in: [types/common.ts:458](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L458) - Error code type (string-based). diff --git a/docs/api/type-aliases/ErrorCodeType.md b/docs/api/type-aliases/ErrorCodeType.md index 7e4282c34..835e9c406 100644 --- a/docs/api/type-aliases/ErrorCodeType.md +++ b/docs/api/type-aliases/ErrorCodeType.md @@ -8,7 +8,5 @@ > **ErrorCodeType** = `"BAD_REQUEST"` \| `"UNAUTHORIZED"` \| `"FORBIDDEN"` \| `"NOT_FOUND"` \| `"METHOD_NOT_ALLOWED"` \| `"CONFLICT"` \| `"PAYLOAD_TOO_LARGE"` \| `"RATE_LIMITED"` \| `"INVALID_REQUEST"` \| `"VALIDATION_ERROR"` \| `"INTERNAL_ERROR"` \| `"SERVICE_UNAVAILABLE"` \| `"GATEWAY_TIMEOUT"` \| `"BAD_GATEWAY"` \| `"NETWORK_ERROR"` \| `"TIMEOUT"` \| `"CONNECTION_REFUSED"` \| `"DNS_ERROR"` \| `"CONFIGURATION_ERROR"` \| `"SERIALIZATION_ERROR"` \| `"STREAM_ERROR"` \| `"ABORT_ERROR"` \| `"PROVIDER_ERROR"` \| `"MODEL_NOT_FOUND"` \| `"CONTEXT_LENGTH_EXCEEDED"` \| `"CONTENT_FILTERED"` \| `"UNKNOWN"` -Defined in: [types/client.ts:1245](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1245) - Standard error codes for NeuroLink API errors. Mirrors the `ErrorCode` const object in client/errors.ts — keep in sync. diff --git a/docs/api/type-aliases/ErrorHandlerOptions.md b/docs/api/type-aliases/ErrorHandlerOptions.md index cb20e1b3d..7c26567fb 100644 --- a/docs/api/type-aliases/ErrorHandlerOptions.md +++ b/docs/api/type-aliases/ErrorHandlerOptions.md @@ -8,8 +8,6 @@ > **ErrorHandlerOptions** = `object` -Defined in: [types/client.ts:1383](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1383) - Error handling interceptor options ## Properties @@ -18,8 +16,6 @@ Error handling interceptor options > `optional` **onError?**: (`error`, `request`) => `Error` \| `void` -Defined in: [types/client.ts:1385](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1385) - Custom error handler #### Parameters @@ -42,8 +38,6 @@ Custom error handler > `optional` **transformError?**: (`error`) => [`ClientApiError`](ClientApiError.md) -Defined in: [types/client.ts:1387](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1387) - Transform error response #### Parameters @@ -62,8 +56,6 @@ Transform error response > `optional` **reportError?**: (`error`, `context`) => `void` \| `Promise`\<`void`\> -Defined in: [types/client.ts:1389](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1389) - Report errors to external service #### Parameters diff --git a/docs/api/type-aliases/ErrorInfo.md b/docs/api/type-aliases/ErrorInfo.md index 65bc6ef49..90caea0aa 100644 --- a/docs/api/type-aliases/ErrorInfo.md +++ b/docs/api/type-aliases/ErrorInfo.md @@ -8,8 +8,6 @@ > **ErrorInfo** = `object` -Defined in: [types/common.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L60) - Type-safe error handling ## Properties @@ -18,28 +16,20 @@ Type-safe error handling > **message**: `string` -Defined in: [types/common.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L61) - --- ### code? > `optional` **code?**: `string` \| `number` -Defined in: [types/common.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L62) - --- ### stack? > `optional` **stack?**: `string` -Defined in: [types/common.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L63) - --- ### cause? > `optional` **cause?**: `unknown` - -Defined in: [types/common.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L64) diff --git a/docs/api/type-aliases/ErrorResponse.md b/docs/api/type-aliases/ErrorResponse.md index 615d75aac..b414ae801 100644 --- a/docs/api/type-aliases/ErrorResponse.md +++ b/docs/api/type-aliases/ErrorResponse.md @@ -8,8 +8,6 @@ > **ErrorResponse** = `object` -Defined in: [types/server.ts:1182](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1182) - Standardized error response format ## Properties @@ -18,8 +16,6 @@ Standardized error response format > **error**: `object` -Defined in: [types/server.ts:1183](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1183) - #### code > **code**: `string` @@ -38,8 +34,6 @@ Defined in: [types/server.ts:1183](https://github.com/juspay/neurolink/blob/rele > `optional` **metadata?**: `object` -Defined in: [types/server.ts:1188](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1188) - #### timestamp > **timestamp**: `string` @@ -53,5 +47,3 @@ Defined in: [types/server.ts:1188](https://github.com/juspay/neurolink/blob/rele ### httpStatus? > `optional` **httpStatus?**: `number` - -Defined in: [types/server.ts:1192](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1192) diff --git a/docs/api/type-aliases/ErrorSeverityType.md b/docs/api/type-aliases/ErrorSeverityType.md index 0bc4d5b90..df8b34160 100644 --- a/docs/api/type-aliases/ErrorSeverityType.md +++ b/docs/api/type-aliases/ErrorSeverityType.md @@ -7,5 +7,3 @@ # Type Alias: ErrorSeverityType > **ErrorSeverityType** = _typeof_ [`ErrorSeverity`](../variables/ErrorSeverity.md)\[keyof _typeof_ [`ErrorSeverity`](../variables/ErrorSeverity.md)\] - -Defined in: [types/server.ts:1098](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1098) diff --git a/docs/api/type-aliases/EscalationResult.md b/docs/api/type-aliases/EscalationResult.md index 8b586be50..8be12faeb 100644 --- a/docs/api/type-aliases/EscalationResult.md +++ b/docs/api/type-aliases/EscalationResult.md @@ -8,8 +8,6 @@ > **EscalationResult** = `object` -Defined in: [types/agentNetwork.ts:1048](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1048) - Result of escalation ## Properties @@ -18,8 +16,6 @@ Result of escalation > **handled**: `boolean` -Defined in: [types/agentNetwork.ts:1050](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1050) - Whether escalation was handled --- @@ -28,8 +24,6 @@ Whether escalation was handled > `optional` **handler?**: `string` -Defined in: [types/agentNetwork.ts:1053](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1053) - Handler that processed escalation --- @@ -38,8 +32,6 @@ Handler that processed escalation > `optional` **resolution?**: `string` -Defined in: [types/agentNetwork.ts:1056](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1056) - Resolution --- @@ -48,6 +40,4 @@ Resolution > **timestamp**: `number` -Defined in: [types/agentNetwork.ts:1059](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1059) - Timestamp diff --git a/docs/api/type-aliases/EvaluatePresetsArgs.md b/docs/api/type-aliases/EvaluatePresetsArgs.md index e8113e074..f0a911477 100644 --- a/docs/api/type-aliases/EvaluatePresetsArgs.md +++ b/docs/api/type-aliases/EvaluatePresetsArgs.md @@ -8,8 +8,6 @@ > **EvaluatePresetsArgs** = `object` -Defined in: [types/cli.ts:1627](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1627) - Arguments for `neurolink evaluate presets`. ## Properties @@ -18,12 +16,8 @@ Arguments for `neurolink evaluate presets`. > `optional` **preset?**: `string` -Defined in: [types/cli.ts:1628](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1628) - --- ### json? > `optional` **json?**: `boolean` - -Defined in: [types/cli.ts:1629](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1629) diff --git a/docs/api/type-aliases/EvaluateReportArgs.md b/docs/api/type-aliases/EvaluateReportArgs.md index 3cd03e890..5a66fa346 100644 --- a/docs/api/type-aliases/EvaluateReportArgs.md +++ b/docs/api/type-aliases/EvaluateReportArgs.md @@ -8,8 +8,6 @@ > **EvaluateReportArgs** = [`BaseEvaluateArgs`](BaseEvaluateArgs.md) & `object` -Defined in: [types/cli.ts:1614](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1614) - Arguments for `neurolink evaluate report`. ## Type Declaration diff --git a/docs/api/type-aliases/EvaluateRunArgs.md b/docs/api/type-aliases/EvaluateRunArgs.md index c2bc282b6..abdc56c79 100644 --- a/docs/api/type-aliases/EvaluateRunArgs.md +++ b/docs/api/type-aliases/EvaluateRunArgs.md @@ -8,8 +8,6 @@ > **EvaluateRunArgs** = [`BaseEvaluateArgs`](BaseEvaluateArgs.md) & `object` -Defined in: [types/cli.ts:1595](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1595) - Arguments for `neurolink evaluate run`. ## Type Declaration diff --git a/docs/api/type-aliases/EvaluateScoreArgs.md b/docs/api/type-aliases/EvaluateScoreArgs.md index 6efc20dcd..1cd16bb84 100644 --- a/docs/api/type-aliases/EvaluateScoreArgs.md +++ b/docs/api/type-aliases/EvaluateScoreArgs.md @@ -8,8 +8,6 @@ > **EvaluateScoreArgs** = [`BaseEvaluateArgs`](BaseEvaluateArgs.md) & `object` -Defined in: [types/cli.ts:1605](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1605) - Arguments for `neurolink evaluate score`. ## Type Declaration diff --git a/docs/api/type-aliases/EvaluateScorersArgs.md b/docs/api/type-aliases/EvaluateScorersArgs.md index 8349d8960..31aa58527 100644 --- a/docs/api/type-aliases/EvaluateScorersArgs.md +++ b/docs/api/type-aliases/EvaluateScorersArgs.md @@ -8,8 +8,6 @@ > **EvaluateScorersArgs** = `object` -Defined in: [types/cli.ts:1633](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1633) - Arguments for `neurolink evaluate scorers` (list-scorers). ## Properties @@ -18,28 +16,20 @@ Arguments for `neurolink evaluate scorers` (list-scorers). > `optional` **category?**: `string` -Defined in: [types/cli.ts:1634](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1634) - --- ### type? > `optional` **type?**: `string` -Defined in: [types/cli.ts:1635](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1635) - --- ### json? > `optional` **json?**: `boolean` -Defined in: [types/cli.ts:1636](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1636) - --- ### detailed? > `optional` **detailed?**: `boolean` - -Defined in: [types/cli.ts:1637](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1637) diff --git a/docs/api/type-aliases/EvaluationAction.md b/docs/api/type-aliases/EvaluationAction.md index e74990e61..81e5fc3fa 100644 --- a/docs/api/type-aliases/EvaluationAction.md +++ b/docs/api/type-aliases/EvaluationAction.md @@ -7,5 +7,3 @@ # Type Alias: EvaluationAction > **EvaluationAction** = `"allow"` \| `"block"` \| `"sanitize"` \| `"warn"` - -Defined in: [types/guardrails.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L36) diff --git a/docs/api/type-aliases/EvaluationActionResult.md b/docs/api/type-aliases/EvaluationActionResult.md index 314012504..9e1a939eb 100644 --- a/docs/api/type-aliases/EvaluationActionResult.md +++ b/docs/api/type-aliases/EvaluationActionResult.md @@ -8,20 +8,14 @@ > **EvaluationActionResult** = `object` -Defined in: [types/guardrails.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L119) - ## Properties ### shouldBlock > **shouldBlock**: `boolean` -Defined in: [types/guardrails.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L120) - --- ### sanitizedInput? > `optional` **sanitizedInput?**: `string` - -Defined in: [types/guardrails.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L121) diff --git a/docs/api/type-aliases/EvaluationActions.md b/docs/api/type-aliases/EvaluationActions.md index 5aa5f4963..f95bb24cc 100644 --- a/docs/api/type-aliases/EvaluationActions.md +++ b/docs/api/type-aliases/EvaluationActions.md @@ -8,28 +8,20 @@ > **EvaluationActions** = `object` -Defined in: [types/guardrails.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L40) - ## Properties ### onUnsafe? > `optional` **onUnsafe?**: `"block"` \| `"sanitize"` \| `"warn"` \| `"log"` -Defined in: [types/guardrails.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L41) - --- ### onInappropriate? > `optional` **onInappropriate?**: `"block"` \| `"sanitize"` \| `"warn"` \| `"log"` -Defined in: [types/guardrails.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L42) - --- ### onSuspicious? > `optional` **onSuspicious?**: `"warn"` \| `"log"` \| `"allow"` - -Defined in: [types/guardrails.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L43) diff --git a/docs/api/type-aliases/EvaluationConfig.md b/docs/api/type-aliases/EvaluationConfig.md index 25a96ca9b..103883c3b 100644 --- a/docs/api/type-aliases/EvaluationConfig.md +++ b/docs/api/type-aliases/EvaluationConfig.md @@ -8,8 +8,6 @@ > **EvaluationConfig** = `object` -Defined in: [types/evaluation.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L283) - Configuration for the main `Evaluator` class. ## Properties @@ -18,8 +16,6 @@ Configuration for the main `Evaluator` class. > `optional` **threshold?**: `number` -Defined in: [types/evaluation.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L285) - The minimum score (1-10) for a response to be considered passing. --- @@ -28,8 +24,6 @@ The minimum score (1-10) for a response to be considered passing. > `optional` **evaluationStrategy?**: `"ragas"` \| `"custom"` -Defined in: [types/evaluation.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L287) - The evaluation strategy to use. Currently only 'ragas' is supported. --- @@ -38,8 +32,6 @@ The evaluation strategy to use. Currently only 'ragas' is supported. > `optional` **evaluationModel?**: `string` -Defined in: [types/evaluation.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L289) - The model to use for the LLM-as-judge evaluation. --- @@ -48,8 +40,6 @@ The model to use for the LLM-as-judge evaluation. > `optional` **maxAttempts?**: `number` -Defined in: [types/evaluation.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L291) - The maximum number of evaluation attempts before failing. --- @@ -58,8 +48,6 @@ The maximum number of evaluation attempts before failing. > `optional` **provider?**: `string` -Defined in: [types/evaluation.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L293) - The provider to use for the evaluation model. --- @@ -68,8 +56,6 @@ The provider to use for the evaluation model. > `optional` **customEvaluator?**: (`options`, `result`) => `Promise`\<\{ `evaluationResult`: [`EvaluationResult`](EvaluationResult.md); `evalContext`: [`EnhancedEvaluationContext`](EnhancedEvaluationContext.md); \}\> -Defined in: [types/evaluation.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L295) - A custom evaluator function to override the default behavior. #### Parameters @@ -92,8 +78,6 @@ A custom evaluator function to override the default behavior. > `optional` **offTopicThreshold?**: `number` -Defined in: [types/evaluation.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L303) - The score below which a response is considered off-topic. --- @@ -102,8 +86,6 @@ The score below which a response is considered off-topic. > `optional` **highSeverityThreshold?**: `number` -Defined in: [types/evaluation.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L305) - The score below which a failing response is considered a high severity alert. --- @@ -112,6 +94,4 @@ The score below which a failing response is considered a high severity alert. > `optional` **promptGenerator?**: [`GetPromptFunction`](GetPromptFunction.md) -Defined in: [types/evaluation.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L307) - An optional function to generate custom evaluation prompts. diff --git a/docs/api/type-aliases/EvaluationContext.md b/docs/api/type-aliases/EvaluationContext.md index b130932cb..088af883e 100644 --- a/docs/api/type-aliases/EvaluationContext.md +++ b/docs/api/type-aliases/EvaluationContext.md @@ -8,8 +8,6 @@ > **EvaluationContext** = `object` -Defined in: [types/evaluation.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L95) - Enhanced evaluation context for comprehensive response assessment ## Properties @@ -18,48 +16,36 @@ Enhanced evaluation context for comprehensive response assessment > **userQuery**: `string` -Defined in: [types/evaluation.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L96) - --- ### aiResponse > **aiResponse**: `string` -Defined in: [types/evaluation.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L97) - --- ### context? > `optional` **context?**: `Record`\<`string`, `unknown`\> -Defined in: [types/evaluation.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L98) - --- ### primaryDomain? > `optional` **primaryDomain?**: `string` -Defined in: [types/evaluation.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L99) - --- ### assistantRole? > `optional` **assistantRole?**: `string` -Defined in: [types/evaluation.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L100) - --- ### conversationHistory? > `optional` **conversationHistory?**: `object`[] -Defined in: [types/evaluation.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L101) - #### role > **role**: `"user"` \| `"assistant"` @@ -78,8 +64,6 @@ Defined in: [types/evaluation.ts:101](https://github.com/juspay/neurolink/blob/r > `optional` **toolUsage?**: `object`[] -Defined in: [types/evaluation.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L106) - #### toolName > **toolName**: `string` @@ -102,12 +86,8 @@ Defined in: [types/evaluation.ts:106](https://github.com/juspay/neurolink/blob/r > `optional` **expectedOutcome?**: `string` -Defined in: [types/evaluation.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L112) - --- ### evaluationCriteria? > `optional` **evaluationCriteria?**: `string`[] - -Defined in: [types/evaluation.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L113) diff --git a/docs/api/type-aliases/EvaluationCriteria.md b/docs/api/type-aliases/EvaluationCriteria.md index 75da12a62..fd7e448e5 100644 --- a/docs/api/type-aliases/EvaluationCriteria.md +++ b/docs/api/type-aliases/EvaluationCriteria.md @@ -8,8 +8,6 @@ > **EvaluationCriteria** = `object` -Defined in: [types/evaluation.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L153) - Evaluation criteria type as specified in core module refactoring ## Properties @@ -18,28 +16,20 @@ Evaluation criteria type as specified in core module refactoring > **relevance**: `boolean` -Defined in: [types/evaluation.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L154) - --- ### accuracy > **accuracy**: `boolean` -Defined in: [types/evaluation.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L155) - --- ### completeness > **completeness**: `boolean` -Defined in: [types/evaluation.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L156) - --- ### domainSpecific? > `optional` **domainSpecific?**: `boolean` - -Defined in: [types/evaluation.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L157) diff --git a/docs/api/type-aliases/EvaluationData.md b/docs/api/type-aliases/EvaluationData.md index 107bf2d1f..8b7d8aaee 100644 --- a/docs/api/type-aliases/EvaluationData.md +++ b/docs/api/type-aliases/EvaluationData.md @@ -8,8 +8,6 @@ > **EvaluationData** = `object` -Defined in: [types/evaluation.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L39) - Response quality evaluation scores - Comprehensive evaluation type ## Properties @@ -18,152 +16,114 @@ Response quality evaluation scores - Comprehensive evaluation type > **relevance**: `number` -Defined in: [types/evaluation.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L41) - --- ### accuracy > **accuracy**: `number` -Defined in: [types/evaluation.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L42) - --- ### completeness > **completeness**: `number` -Defined in: [types/evaluation.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L43) - --- ### overall > **overall**: `number` -Defined in: [types/evaluation.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L44) - --- ### domainAlignment? > `optional` **domainAlignment?**: `number` -Defined in: [types/evaluation.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L45) - --- ### terminologyAccuracy? > `optional` **terminologyAccuracy?**: `number` -Defined in: [types/evaluation.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L46) - --- ### toolEffectiveness? > `optional` **toolEffectiveness?**: `number` -Defined in: [types/evaluation.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L47) - --- ### responseContent? > `optional` **responseContent?**: `string` -Defined in: [types/evaluation.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L50) - --- ### queryContent? > `optional` **queryContent?**: `string` -Defined in: [types/evaluation.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L51) - --- ### isOffTopic > **isOffTopic**: `boolean` -Defined in: [types/evaluation.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L54) - --- ### alertSeverity > **alertSeverity**: [`AlertSeverity`](AlertSeverity.md) -Defined in: [types/evaluation.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L55) - --- ### reasoning > **reasoning**: `string` -Defined in: [types/evaluation.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L56) - --- ### suggestedImprovements? > `optional` **suggestedImprovements?**: `string` -Defined in: [types/evaluation.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L57) - --- ### evaluationModel > **evaluationModel**: `string` -Defined in: [types/evaluation.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L60) - --- ### evaluationTime > **evaluationTime**: `number` -Defined in: [types/evaluation.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L61) - --- ### evaluationDomain? > `optional` **evaluationDomain?**: `string` -Defined in: [types/evaluation.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L62) - --- ### evaluationProvider? > `optional` **evaluationProvider?**: `string` -Defined in: [types/evaluation.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L65) - --- ### evaluationAttempt? > `optional` **evaluationAttempt?**: `number` -Defined in: [types/evaluation.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L66) - --- ### evaluationConfig? > `optional` **evaluationConfig?**: `object` -Defined in: [types/evaluation.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L67) - #### mode > **mode**: `string` @@ -182,8 +142,6 @@ Defined in: [types/evaluation.ts:67](https://github.com/juspay/neurolink/blob/re > `optional` **domainConfig?**: `object` -Defined in: [types/evaluation.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L74) - #### domainName > **domainName**: `string` @@ -214,8 +172,6 @@ Defined in: [types/evaluation.ts:74](https://github.com/juspay/neurolink/blob/re > `optional` **domainEvaluation?**: `object` -Defined in: [types/evaluation.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L84) - #### domainRelevance > **domainRelevance**: `number` diff --git a/docs/api/type-aliases/EvaluationErrorCode.md b/docs/api/type-aliases/EvaluationErrorCode.md index 0f0ca1337..2bf900cc9 100644 --- a/docs/api/type-aliases/EvaluationErrorCode.md +++ b/docs/api/type-aliases/EvaluationErrorCode.md @@ -8,6 +8,4 @@ > **EvaluationErrorCode** = `"EVALUATION_FAILED"` \| `"PARSE_ERROR"` \| `"STRATEGY_NOT_FOUND"` \| `"PROVIDER_ERROR"` \| `"CONFIGURATION_ERROR"` \| `"CUSTOM_EVALUATOR_ERROR"` \| `"BATCH_EVALUATION_ERROR"` \| `"AGGREGATION_ERROR"` \| `"REGISTRY_ERROR"` \| `"MAX_RETRIES_EXCEEDED"` \| `"TIMEOUT_ERROR"` \| `"RATE_LIMIT_ERROR"` -Defined in: [types/evaluation.ts:595](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L595) - Canonical evaluation error code. diff --git a/docs/api/type-aliases/EvaluationErrorContext.md b/docs/api/type-aliases/EvaluationErrorContext.md index ca08a2ae8..9ff4b089f 100644 --- a/docs/api/type-aliases/EvaluationErrorContext.md +++ b/docs/api/type-aliases/EvaluationErrorContext.md @@ -8,8 +8,6 @@ > **EvaluationErrorContext** = `object` -Defined in: [types/evaluation.ts:610](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L610) - Extended evaluation context for error details. ## Properties @@ -18,68 +16,50 @@ Extended evaluation context for error details. > `optional` **userQueryLength?**: `number` -Defined in: [types/evaluation.ts:611](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L611) - --- ### aiResponseLength? > `optional` **aiResponseLength?**: `number` -Defined in: [types/evaluation.ts:612](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L612) - --- ### attemptNumber? > `optional` **attemptNumber?**: `number` -Defined in: [types/evaluation.ts:613](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L613) - --- ### previousScores? > `optional` **previousScores?**: `number`[] -Defined in: [types/evaluation.ts:614](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L614) - --- ### strategy? > `optional` **strategy?**: `string` -Defined in: [types/evaluation.ts:615](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L615) - --- ### evaluationModel? > `optional` **evaluationModel?**: `string` -Defined in: [types/evaluation.ts:616](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L616) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/evaluation.ts:617](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L617) - --- ### rawResponseLength? > `optional` **rawResponseLength?**: `number` -Defined in: [types/evaluation.ts:618](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L618) - --- ### additionalContext? > `optional` **additionalContext?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/evaluation.ts:619](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L619) diff --git a/docs/api/type-aliases/EvaluationEvents.md b/docs/api/type-aliases/EvaluationEvents.md index a3438b7af..cfaf91508 100644 --- a/docs/api/type-aliases/EvaluationEvents.md +++ b/docs/api/type-aliases/EvaluationEvents.md @@ -8,8 +8,6 @@ > **EvaluationEvents** = `object` -Defined in: [types/evaluation.ts:659](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L659) - Events emitted by the evaluation pipeline. ## Properties @@ -18,8 +16,6 @@ Events emitted by the evaluation pipeline. > **scorer:start**: `object` -Defined in: [types/evaluation.ts:660](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L660) - #### scorerId > **scorerId**: `string` @@ -42,8 +38,6 @@ Defined in: [types/evaluation.ts:660](https://github.com/juspay/neurolink/blob/r > **scorer:end**: `object` -Defined in: [types/evaluation.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L666) - #### scorerId > **scorerId**: `string` @@ -74,8 +68,6 @@ Defined in: [types/evaluation.ts:666](https://github.com/juspay/neurolink/blob/r > **scorer:error**: `object` -Defined in: [types/evaluation.ts:674](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L674) - #### scorerId > **scorerId**: `string` @@ -102,8 +94,6 @@ Defined in: [types/evaluation.ts:674](https://github.com/juspay/neurolink/blob/r > **pipeline:start**: `object` -Defined in: [types/evaluation.ts:681](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L681) - #### pipelineName > **pipelineName**: `string` @@ -130,8 +120,6 @@ Defined in: [types/evaluation.ts:681](https://github.com/juspay/neurolink/blob/r > **pipeline:end**: `object` -Defined in: [types/evaluation.ts:688](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L688) - #### pipelineName > **pipelineName**: `string` @@ -158,8 +146,6 @@ Defined in: [types/evaluation.ts:688](https://github.com/juspay/neurolink/blob/r > **pipeline:error**: `object` -Defined in: [types/evaluation.ts:695](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L695) - #### pipelineName > **pipelineName**: `string` diff --git a/docs/api/type-aliases/EvaluationIssue.md b/docs/api/type-aliases/EvaluationIssue.md index 135413adf..fa06e6f3b 100644 --- a/docs/api/type-aliases/EvaluationIssue.md +++ b/docs/api/type-aliases/EvaluationIssue.md @@ -8,28 +8,20 @@ > **EvaluationIssue** = `object` -Defined in: [types/guardrails.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L124) - ## Properties ### category > **category**: [`IssueCategory`](IssueCategory.md) -Defined in: [types/guardrails.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L125) - --- ### severity > **severity**: [`IssueSeverity`](IssueSeverity.md) -Defined in: [types/guardrails.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L126) - --- ### description > **description**: `string` - -Defined in: [types/guardrails.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L127) diff --git a/docs/api/type-aliases/EvaluationMode.md b/docs/api/type-aliases/EvaluationMode.md index 95dd3ce28..3aec0066f 100644 --- a/docs/api/type-aliases/EvaluationMode.md +++ b/docs/api/type-aliases/EvaluationMode.md @@ -8,6 +8,4 @@ > **EvaluationMode** = `"basic"` \| `"detailed"` \| `"domain-aware"` \| `"disabled"` -Defined in: [types/evaluation.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L29) - Evaluation modes diff --git a/docs/api/type-aliases/EvaluationProvider.md b/docs/api/type-aliases/EvaluationProvider.md index efa387d9c..ee2b2c23e 100644 --- a/docs/api/type-aliases/EvaluationProvider.md +++ b/docs/api/type-aliases/EvaluationProvider.md @@ -8,6 +8,4 @@ > **EvaluationProvider** = `"openai"` \| `"anthropic"` \| `"vertex"` \| `"google-ai"` \| `"local"` -Defined in: [types/evaluation.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L19) - Evaluation provider type as specified in core module refactoring diff --git a/docs/api/type-aliases/EvaluationRequest.md b/docs/api/type-aliases/EvaluationRequest.md index c1afad1ee..b1437fe51 100644 --- a/docs/api/type-aliases/EvaluationRequest.md +++ b/docs/api/type-aliases/EvaluationRequest.md @@ -8,8 +8,6 @@ > **EvaluationRequest** = `object` -Defined in: [types/evaluation.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L143) - Evaluation request type as specified in core module refactoring ## Properties @@ -18,28 +16,20 @@ Evaluation request type as specified in core module refactoring > **content**: `string` -Defined in: [types/evaluation.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L144) - --- ### context? > `optional` **context?**: `string` -Defined in: [types/evaluation.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L145) - --- ### domain? > `optional` **domain?**: `string` -Defined in: [types/evaluation.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L146) - --- ### criteria > **criteria**: [`EvaluationCriteria`](EvaluationCriteria.md) - -Defined in: [types/evaluation.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L147) diff --git a/docs/api/type-aliases/EvaluationResult.md b/docs/api/type-aliases/EvaluationResult.md index f1ea17e82..c26098718 100644 --- a/docs/api/type-aliases/EvaluationResult.md +++ b/docs/api/type-aliases/EvaluationResult.md @@ -8,8 +8,6 @@ > **EvaluationResult** = `object` -Defined in: [types/evaluation.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L238) - Represents the result of a single evaluation attempt, based on RAGAS principles. ## Properties @@ -18,8 +16,6 @@ Represents the result of a single evaluation attempt, based on RAGAS principles. > **finalScore**: `number` -Defined in: [types/evaluation.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L240) - The final, overall score for the response, typically from 1 to 10. --- @@ -28,8 +24,6 @@ The final, overall score for the response, typically from 1 to 10. > **relevanceScore**: `number` -Defined in: [types/evaluation.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L243) - How well the response addresses the user's query. --- @@ -38,8 +32,6 @@ How well the response addresses the user's query. > **accuracyScore**: `number` -Defined in: [types/evaluation.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L245) - The factual accuracy of the information in the response. --- @@ -48,8 +40,6 @@ The factual accuracy of the information in the response. > **completenessScore**: `number` -Defined in: [types/evaluation.ts:247](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L247) - How completely the response answers the user's query. --- @@ -58,8 +48,6 @@ How completely the response answers the user's query. > **isPassing**: `boolean` -Defined in: [types/evaluation.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L250) - Whether the final score meets the passing threshold. --- @@ -68,8 +56,6 @@ Whether the final score meets the passing threshold. > **reasoning**: `string` -Defined in: [types/evaluation.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L252) - Constructive response from the judge LLM on how to improve the response. --- @@ -78,8 +64,6 @@ Constructive response from the judge LLM on how to improve the response. > **suggestedImprovements**: `string` -Defined in: [types/evaluation.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L254) - Specific suggestions for improving the response. --- @@ -88,8 +72,6 @@ Specific suggestions for improving the response. > **rawEvaluationResponse**: `string` -Defined in: [types/evaluation.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L256) - The raw, unparsed response from the judge LLM. --- @@ -98,8 +80,6 @@ The raw, unparsed response from the judge LLM. > **evaluationModel**: `string` -Defined in: [types/evaluation.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L259) - The model used to perform the evaluation. --- @@ -108,8 +88,6 @@ The model used to perform the evaluation. > **evaluationTime**: `number` -Defined in: [types/evaluation.ts:261](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L261) - The time taken for the evaluation in milliseconds. --- @@ -118,6 +96,4 @@ The time taken for the evaluation in milliseconds. > **attemptNumber**: `number` -Defined in: [types/evaluation.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L263) - The attempt number for this evaluation. diff --git a/docs/api/type-aliases/EvaluationSpanAttributes.md b/docs/api/type-aliases/EvaluationSpanAttributes.md index 760a589ea..750e6bc9d 100644 --- a/docs/api/type-aliases/EvaluationSpanAttributes.md +++ b/docs/api/type-aliases/EvaluationSpanAttributes.md @@ -8,8 +8,6 @@ > **EvaluationSpanAttributes** = `Record`\<`string`, `string` \| `number` \| `boolean`\> -Defined in: [types/evaluation.ts:708](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L708) - Flat span attribute map used by the evaluation observability layer. Named EvaluationSpanAttributes to disambiguate from the richer telemetry SpanAttributes in span.ts (§Rule 9 domain prefix). diff --git a/docs/api/type-aliases/EvaluationStrategyConfig.md b/docs/api/type-aliases/EvaluationStrategyConfig.md index 93353a258..e0978de62 100644 --- a/docs/api/type-aliases/EvaluationStrategyConfig.md +++ b/docs/api/type-aliases/EvaluationStrategyConfig.md @@ -8,8 +8,6 @@ > **EvaluationStrategyConfig** = `object` -Defined in: [types/evaluation.ts:555](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L555) - Configuration for evaluation strategies. ## Properties @@ -18,32 +16,24 @@ Configuration for evaluation strategies. > `optional` **evaluationModel?**: `string` -Defined in: [types/evaluation.ts:556](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L556) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/evaluation.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L557) - --- ### threshold? > `optional` **threshold?**: `number` -Defined in: [types/evaluation.ts:558](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L558) - --- ### promptGenerator? > `optional` **promptGenerator?**: (`context`) => `string` -Defined in: [types/evaluation.ts:559](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L559) - #### Parameters ##### context @@ -77,5 +67,3 @@ Defined in: [types/evaluation.ts:559](https://github.com/juspay/neurolink/blob/r ### options? > `optional` **options?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/evaluation.ts:566](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L566) diff --git a/docs/api/type-aliases/EvaluationStrategyFunction.md b/docs/api/type-aliases/EvaluationStrategyFunction.md index c5aeaf390..cf20cb7c3 100644 --- a/docs/api/type-aliases/EvaluationStrategyFunction.md +++ b/docs/api/type-aliases/EvaluationStrategyFunction.md @@ -8,8 +8,6 @@ > **EvaluationStrategyFunction** = (`options`, `result`, `config?`) => `Promise`\<\{ `evaluationResult`: [`EvaluationResult`](EvaluationResult.md); `evalContext`: [`EnhancedEvaluationContext`](EnhancedEvaluationContext.md); \}\> -Defined in: [types/evaluation.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L570) - Function that performs evaluation and returns results. ## Parameters diff --git a/docs/api/type-aliases/EvaluationStrategyMetadata.md b/docs/api/type-aliases/EvaluationStrategyMetadata.md index 37f7f2780..cbe75f23f 100644 --- a/docs/api/type-aliases/EvaluationStrategyMetadata.md +++ b/docs/api/type-aliases/EvaluationStrategyMetadata.md @@ -8,8 +8,6 @@ > **EvaluationStrategyMetadata** = `object` -Defined in: [types/evaluation.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L580) - Metadata for registered evaluation strategies. ## Properties @@ -18,52 +16,38 @@ Metadata for registered evaluation strategies. > **name**: `string` -Defined in: [types/evaluation.ts:581](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L581) - --- ### description > **description**: `string` -Defined in: [types/evaluation.ts:582](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L582) - --- ### requiresLLM > **requiresLLM**: `boolean` -Defined in: [types/evaluation.ts:583](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L583) - --- ### defaultModel? > `optional` **defaultModel?**: `string` -Defined in: [types/evaluation.ts:584](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L584) - --- ### defaultProvider? > `optional` **defaultProvider?**: `string` -Defined in: [types/evaluation.ts:585](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L585) - --- ### version > **version**: `string` -Defined in: [types/evaluation.ts:586](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L586) - --- ### features > **features**: `string`[] - -Defined in: [types/evaluation.ts:587](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L587) diff --git a/docs/api/type-aliases/EvaluationThresholds.md b/docs/api/type-aliases/EvaluationThresholds.md index 265167135..6c88a67ab 100644 --- a/docs/api/type-aliases/EvaluationThresholds.md +++ b/docs/api/type-aliases/EvaluationThresholds.md @@ -8,28 +8,20 @@ > **EvaluationThresholds** = `object` -Defined in: [types/guardrails.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L46) - ## Properties ### safetyScore? > `optional` **safetyScore?**: `number` -Defined in: [types/guardrails.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L47) - --- ### appropriatenessScore? > `optional` **appropriatenessScore?**: `number` -Defined in: [types/guardrails.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L48) - --- ### confidenceLevel? > `optional` **confidenceLevel?**: `number` - -Defined in: [types/guardrails.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L49) diff --git a/docs/api/type-aliases/EvaluationTraceContext.md b/docs/api/type-aliases/EvaluationTraceContext.md index bbe5302ad..c8e94636f 100644 --- a/docs/api/type-aliases/EvaluationTraceContext.md +++ b/docs/api/type-aliases/EvaluationTraceContext.md @@ -8,8 +8,6 @@ > **EvaluationTraceContext** = `object` -Defined in: [types/scorer.ts:429](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L429) - Evaluation trace context for observability ## Properties @@ -18,8 +16,6 @@ Evaluation trace context for observability > **traceId**: `string` -Defined in: [types/scorer.ts:431](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L431) - Trace ID --- @@ -28,8 +24,6 @@ Trace ID > `optional` **spanId?**: `string` -Defined in: [types/scorer.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L433) - Span ID --- @@ -38,8 +32,6 @@ Span ID > `optional` **parentSpanId?**: `string` -Defined in: [types/scorer.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L435) - Parent span ID --- @@ -48,8 +40,6 @@ Parent span ID > `optional` **sessionId?**: `string` -Defined in: [types/scorer.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L437) - Session ID --- @@ -58,8 +48,6 @@ Session ID > `optional` **userId?**: `string` -Defined in: [types/scorer.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L439) - User ID --- @@ -68,6 +56,4 @@ User ID > `optional` **attributes?**: `Record`\<`string`, `string` \| `number` \| `boolean`\> -Defined in: [types/scorer.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L441) - Custom attributes diff --git a/docs/api/type-aliases/EvaluatorPreset.md b/docs/api/type-aliases/EvaluatorPreset.md index f4182c67f..eb30959a4 100644 --- a/docs/api/type-aliases/EvaluatorPreset.md +++ b/docs/api/type-aliases/EvaluatorPreset.md @@ -8,8 +8,6 @@ > **EvaluatorPreset** = `object` -Defined in: [types/evaluation.ts:548](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L548) - Configuration preset for common evaluation scenarios. ## Properties @@ -18,20 +16,14 @@ Configuration preset for common evaluation scenarios. > **name**: `string` -Defined in: [types/evaluation.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L549) - --- ### description > **description**: `string` -Defined in: [types/evaluation.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L550) - --- ### config? > `optional` **config?**: [`EvaluationConfig`](EvaluationConfig.md) - -Defined in: [types/evaluation.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L551) diff --git a/docs/api/type-aliases/EventHandler.md b/docs/api/type-aliases/EventHandler.md index 1ff55aa05..a43a12fca 100644 --- a/docs/api/type-aliases/EventHandler.md +++ b/docs/api/type-aliases/EventHandler.md @@ -8,8 +8,6 @@ > **EventHandler**\<`TEvent`\> = (`event`) => `void` \| `Promise`\<`void`\> -Defined in: [types/aliases.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L120) - Event handler function type Common in event-driven architectures diff --git a/docs/api/type-aliases/ExcelJSCell.md b/docs/api/type-aliases/ExcelJSCell.md index 91cfd8a21..1fcabafdd 100644 --- a/docs/api/type-aliases/ExcelJSCell.md +++ b/docs/api/type-aliases/ExcelJSCell.md @@ -8,8 +8,6 @@ > **ExcelJSCell** = `object` -Defined in: [types/processor.ts:690](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L690) - Structural types for exceljs objects. Defined here so the optional exceljs package is not required at typecheck time. @@ -18,5 +16,3 @@ Defined here so the optional exceljs package is not required at typecheck time. ### value > **value**: [`CellValue`](CellValue.md) - -Defined in: [types/processor.ts:691](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L691) diff --git a/docs/api/type-aliases/ExcelJSRow.md b/docs/api/type-aliases/ExcelJSRow.md index 477d6d116..d7ec02b14 100644 --- a/docs/api/type-aliases/ExcelJSRow.md +++ b/docs/api/type-aliases/ExcelJSRow.md @@ -8,24 +8,18 @@ > **ExcelJSRow** = `object` -Defined in: [types/processor.ts:694](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L694) - ## Properties ### values > **values**: ([`CellValue`](CellValue.md) \| `undefined`)[] -Defined in: [types/processor.ts:695](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L695) - --- ### eachCell > **eachCell**: (`opts`, `callback`) => `void` -Defined in: [types/processor.ts:696](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L696) - #### Parameters ##### opts diff --git a/docs/api/type-aliases/ExcelJSWorkbook.md b/docs/api/type-aliases/ExcelJSWorkbook.md index cad7619f5..168f11812 100644 --- a/docs/api/type-aliases/ExcelJSWorkbook.md +++ b/docs/api/type-aliases/ExcelJSWorkbook.md @@ -8,24 +8,18 @@ > **ExcelJSWorkbook** = `object` -Defined in: [types/processor.ts:715](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L715) - ## Properties ### worksheets > **worksheets**: [`ExcelJSWorksheet`](ExcelJSWorksheet.md)[] -Defined in: [types/processor.ts:716](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L716) - --- ### getWorksheet > **getWorksheet**: (`name`) => [`ExcelJSWorksheet`](ExcelJSWorksheet.md) \| `undefined` -Defined in: [types/processor.ts:717](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L717) - #### Parameters ##### name @@ -42,8 +36,6 @@ Defined in: [types/processor.ts:717](https://github.com/juspay/neurolink/blob/re > **xlsx**: `object` -Defined in: [types/processor.ts:718](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L718) - #### load > **load**: (`buffer`) => `Promise`\<`void`\> diff --git a/docs/api/type-aliases/ExcelJSWorksheet.md b/docs/api/type-aliases/ExcelJSWorksheet.md index 1478e3431..1b08600c0 100644 --- a/docs/api/type-aliases/ExcelJSWorksheet.md +++ b/docs/api/type-aliases/ExcelJSWorksheet.md @@ -8,32 +8,24 @@ > **ExcelJSWorksheet** = `object` -Defined in: [types/processor.ts:702](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L702) - ## Properties ### name > **name**: `string` -Defined in: [types/processor.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L703) - --- ### rowCount > **rowCount**: `number` -Defined in: [types/processor.ts:704](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L704) - --- ### eachRow > **eachRow**: \{(`callback`): `void`; (`opts`, `callback`): `void`; \} -Defined in: [types/processor.ts:705](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L705) - #### Call Signature > (`callback`): `void` @@ -74,8 +66,6 @@ Defined in: [types/processor.ts:705](https://github.com/juspay/neurolink/blob/re > **getRow**: (`rowNumber`) => [`ExcelJSRow`](ExcelJSRow.md) -Defined in: [types/processor.ts:712](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L712) - #### Parameters ##### rowNumber diff --git a/docs/api/type-aliases/ExcelWorksheet.md b/docs/api/type-aliases/ExcelWorksheet.md index eed28a51b..04dd94f2c 100644 --- a/docs/api/type-aliases/ExcelWorksheet.md +++ b/docs/api/type-aliases/ExcelWorksheet.md @@ -8,8 +8,6 @@ > **ExcelWorksheet** = `object` -Defined in: [types/processor.ts:726](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L726) - Single worksheet extracted from an Excel file. ## Properties @@ -18,8 +16,6 @@ Single worksheet extracted from an Excel file. > **name**: `string` -Defined in: [types/processor.ts:728](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L728) - Name of the worksheet (tab name in Excel) --- @@ -28,8 +24,6 @@ Name of the worksheet (tab name in Excel) > **rows**: (`string` \| `number` \| `boolean` \| `null`)[][] -Defined in: [types/processor.ts:730](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L730) - Row data as a 2D array. Each inner array represents a row. --- @@ -38,8 +32,6 @@ Row data as a 2D array. Each inner array represents a row. > **headers**: `string`[] -Defined in: [types/processor.ts:732](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L732) - Headers extracted from the first row --- @@ -48,8 +40,6 @@ Headers extracted from the first row > **rowCount**: `number` -Defined in: [types/processor.ts:734](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L734) - Number of rows extracted (may be less than actual if truncated) --- @@ -58,6 +48,4 @@ Number of rows extracted (may be less than actual if truncated) > **columnCount**: `number` -Defined in: [types/processor.ts:736](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L736) - Number of columns (based on headers or first row) diff --git a/docs/api/type-aliases/ExecuteEnsembleOptions.md b/docs/api/type-aliases/ExecuteEnsembleOptions.md index ad8d469b2..80daafdb4 100644 --- a/docs/api/type-aliases/ExecuteEnsembleOptions.md +++ b/docs/api/type-aliases/ExecuteEnsembleOptions.md @@ -8,8 +8,6 @@ > **ExecuteEnsembleOptions** = `object` -Defined in: [types/workflow.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L535) - Options for ensemble execution ## Properties @@ -18,40 +16,30 @@ Options for ensemble execution > **prompt**: `string` -Defined in: [types/workflow.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L536) - --- ### models > **models**: [`WorkflowModelConfig`](WorkflowModelConfig.md)[] -Defined in: [types/workflow.ts:537](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L537) - --- ### executionConfig? > `optional` **executionConfig?**: [`ExecutionConfig`](ExecutionConfig.md) -Defined in: [types/workflow.ts:538](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L538) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/workflow.ts:539](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L539) - --- ### workflowDefaults? > `optional` **workflowDefaults?**: `object` -Defined in: [types/workflow.ts:540](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L540) - #### systemPrompt? > `optional` **systemPrompt?**: `string` diff --git a/docs/api/type-aliases/ExecuteLayerOptions.md b/docs/api/type-aliases/ExecuteLayerOptions.md index f09b78222..ce2d01789 100644 --- a/docs/api/type-aliases/ExecuteLayerOptions.md +++ b/docs/api/type-aliases/ExecuteLayerOptions.md @@ -8,8 +8,6 @@ > **ExecuteLayerOptions** = `object` -Defined in: [types/workflow.ts:645](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L645) - Options for layer execution ## Properties @@ -18,28 +16,20 @@ Options for layer execution > **group**: [`ModelGroup`](ModelGroup.md) -Defined in: [types/workflow.ts:646](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L646) - --- ### prompt > **prompt**: `string` -Defined in: [types/workflow.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L647) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/workflow.ts:648](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L648) - --- ### workflowDefaultSystemPrompt? > `optional` **workflowDefaultSystemPrompt?**: `string` - -Defined in: [types/workflow.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L649) diff --git a/docs/api/type-aliases/ExecuteModelOptions.md b/docs/api/type-aliases/ExecuteModelOptions.md index 443bcb61a..fd3f97d29 100644 --- a/docs/api/type-aliases/ExecuteModelOptions.md +++ b/docs/api/type-aliases/ExecuteModelOptions.md @@ -8,8 +8,6 @@ > **ExecuteModelOptions** = `object` -Defined in: [types/workflow.ts:559](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L559) - Options for single model execution (internal) ## Properties @@ -18,28 +16,20 @@ Options for single model execution (internal) > **model**: [`WorkflowModelConfig`](WorkflowModelConfig.md) -Defined in: [types/workflow.ts:560](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L560) - --- ### prompt > **prompt**: `string` -Defined in: [types/workflow.ts:561](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L561) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/workflow.ts:562](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L562) - --- ### timeout > **timeout**: `number` - -Defined in: [types/workflow.ts:563](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L563) diff --git a/docs/api/type-aliases/ExecutionConfig.md b/docs/api/type-aliases/ExecutionConfig.md index 660d1a166..64105ee22 100644 --- a/docs/api/type-aliases/ExecutionConfig.md +++ b/docs/api/type-aliases/ExecutionConfig.md @@ -8,8 +8,6 @@ > **ExecutionConfig** = `object` -Defined in: [types/workflow.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L195) - Workflow execution configuration ## Properties @@ -18,108 +16,80 @@ Workflow execution configuration > `optional` **timeout?**: `number` -Defined in: [types/workflow.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L197) - --- ### modelTimeout? > `optional` **modelTimeout?**: `number` -Defined in: [types/workflow.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L198) - --- ### judgeTimeout? > `optional` **judgeTimeout?**: `number` -Defined in: [types/workflow.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L199) - --- ### retries? > `optional` **retries?**: `number` -Defined in: [types/workflow.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L202) - --- ### retryDelay? > `optional` **retryDelay?**: `number` -Defined in: [types/workflow.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L203) - --- ### retryableErrors? > `optional` **retryableErrors?**: `string`[] -Defined in: [types/workflow.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L204) - --- ### parallelism? > `optional` **parallelism?**: `number` -Defined in: [types/workflow.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L207) - --- ### earlyTermination? > `optional` **earlyTermination?**: `boolean` -Defined in: [types/workflow.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L208) - --- ### minResponses? > `optional` **minResponses?**: `number` -Defined in: [types/workflow.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L209) - --- ### maxCost? > `optional` **maxCost?**: `number` -Defined in: [types/workflow.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L212) - --- ### costThreshold? > `optional` **costThreshold?**: `number` -Defined in: [types/workflow.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L213) - --- ### enableMetrics? > `optional` **enableMetrics?**: `boolean` -Defined in: [types/workflow.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L216) - --- ### enableTracing? > `optional` **enableTracing?**: `boolean` -Defined in: [types/workflow.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L217) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> - -Defined in: [types/workflow.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L220) diff --git a/docs/api/type-aliases/ExecutionContext.md b/docs/api/type-aliases/ExecutionContext.md index 473424139..f9e925f27 100644 --- a/docs/api/type-aliases/ExecutionContext.md +++ b/docs/api/type-aliases/ExecutionContext.md @@ -8,8 +8,6 @@ > **ExecutionContext**\<`T`\> = `object` -Defined in: [types/tools.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L76) - Generic execution context for MCP operations Moved from src/lib/mcp/contracts/mcpContract.ts @@ -25,76 +23,56 @@ Moved from src/lib/mcp/contracts/mcpContract.ts > `optional` **sessionId?**: `string` -Defined in: [types/tools.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L78) - --- ### userId? > `optional` **userId?**: `string` -Defined in: [types/tools.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L79) - --- ### config? > `optional` **config?**: `T` -Defined in: [types/tools.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L82) - --- ### metadata? > `optional` **metadata?**: [`StandardRecord`](StandardRecord.md) -Defined in: [types/tools.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L83) - --- ### cacheOptions? > `optional` **cacheOptions?**: [`CacheOptions`](CacheOptions.md) -Defined in: [types/tools.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L86) - --- ### fallbackOptions? > `optional` **fallbackOptions?**: [`FallbackOptions`](FallbackOptions.md) -Defined in: [types/tools.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L87) - --- ### timeoutMs? > `optional` **timeoutMs?**: `number` -Defined in: [types/tools.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L88) - --- ### maxRetries? > `optional` **maxRetries?**: `number` -Defined in: [types/tools.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L89) - --- ### startTime? > `optional` **startTime?**: `number` -Defined in: [types/tools.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L90) - --- ### hitlState? > `optional` **hitlState?**: [`HITLExecutionState`](HITLExecutionState.md) - -Defined in: [types/tools.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L91) diff --git a/docs/api/type-aliases/ExecutionControlDecision.md b/docs/api/type-aliases/ExecutionControlDecision.md index 45aac05a3..2d713cbf3 100644 --- a/docs/api/type-aliases/ExecutionControlDecision.md +++ b/docs/api/type-aliases/ExecutionControlDecision.md @@ -8,8 +8,6 @@ > **ExecutionControlDecision** = `object` -Defined in: [types/stream.ts:273](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L273) - What a `beforeStep` callback may change about the rest of the turn. Returning nothing is a decision too: it declines the renewal, so the @@ -22,8 +20,6 @@ outcome exactly as it would with no callback at all. > `optional` **maxSteps?**: `number` -Defined in: [types/stream.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L279) - A new absolute step cap. Must be finite and greater than the cap in force; anything else is ignored, so a callback cannot shorten a turn by returning a smaller number or unbound one by returning Infinity. @@ -34,8 +30,6 @@ a smaller number or unbound one by returning Infinity. > `optional` **nudge?**: `string` -Defined in: [types/stream.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L285) - A planning nudge appended to the conversation before the next step, in the same loop and the same history — this is how a caller tells the model that its budget changed without restarting the turn. diff --git a/docs/api/type-aliases/ExecutionControlOptions.md b/docs/api/type-aliases/ExecutionControlOptions.md index 955a37f42..c97032111 100644 --- a/docs/api/type-aliases/ExecutionControlOptions.md +++ b/docs/api/type-aliases/ExecutionControlOptions.md @@ -8,8 +8,6 @@ > **ExecutionControlOptions** = `object` -Defined in: [types/stream.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L305) - Opt-in execution policy for one streamed turn. Supported only on the native Anthropic stream path today; any other provider REJECTS it rather than ignoring it, because silently dropping a policy the caller set is how a turn @@ -32,8 +30,6 @@ restores exactly the old behaviour. > **requestTimeoutMs**: `number` -Defined in: [types/stream.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L314) - Hard deadline for a single HTTP request (ms). Required, finite, positive. This is the floor that makes the rest of the contract safe: whatever the @@ -47,8 +43,6 @@ error. A step boundary cannot reset a deadline already running. > `optional` **lifetimeTimeoutMs?**: `number` \| `null` -Defined in: [types/stream.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L334) - The turn's wall-clock ceiling (ms). - `null` — no lifetime timer is armed at all. This is the case that cannot @@ -73,8 +67,6 @@ present holding `undefined`: both say "no opinion", and both inherit. > `optional` **beforeStep?**: (`context`) => [`ExecutionControlDecision`](ExecutionControlDecision.md) \| `undefined` \| `Promise`\<[`ExecutionControlDecision`](ExecutionControlDecision.md) \| `undefined`\> -Defined in: [types/stream.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L341) - Runs at each step boundary. May renew the step cap and append a planning nudge. It is itself bounded by `beforeStepTimeoutMs` and cancelled with the turn; a callback that throws, or outlives its budget, is treated as @@ -96,8 +88,6 @@ declining to renew. > `optional` **beforeStepTimeoutMs?**: `number` -Defined in: [types/stream.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L352) - Bound on `beforeStep` itself (ms, finite and positive; default 30_000). A boundary callback sits between two model calls, so an unbounded one stalls the turn in a place no other timer is watching. diff --git a/docs/api/type-aliases/ExecutionControlStepContext.md b/docs/api/type-aliases/ExecutionControlStepContext.md index eed19087c..cacce2783 100644 --- a/docs/api/type-aliases/ExecutionControlStepContext.md +++ b/docs/api/type-aliases/ExecutionControlStepContext.md @@ -8,8 +8,6 @@ > **ExecutionControlStepContext** = `object` -Defined in: [types/stream.ts:247](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L247) - What a `beforeStep` callback is told at a step boundary. The boundary is reached only after that step's tool results have settled and @@ -23,8 +21,6 @@ a step already in flight. > **stepIndex**: `number` -Defined in: [types/stream.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L249) - Zero-based index of the step that just settled. --- @@ -33,8 +29,6 @@ Zero-based index of the step that just settled. > **stepsCompleted**: `number` -Defined in: [types/stream.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L251) - Steps that have completed in this turn, including the one that just settled. --- @@ -43,8 +37,6 @@ Steps that have completed in this turn, including the one that just settled. > **maxSteps**: `number` -Defined in: [types/stream.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L253) - The step cap currently in force — the number a renewal must exceed. --- @@ -53,8 +45,6 @@ The step cap currently in force — the number a renewal must exceed. > **elapsedMs**: `number` -Defined in: [types/stream.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L255) - Milliseconds since the turn's first request was built. --- @@ -63,8 +53,6 @@ Milliseconds since the turn's first request was built. > **toolNames**: `string`[] -Defined in: [types/stream.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L257) - Names of the tools dispatched on the step that just settled, in order. --- @@ -73,8 +61,6 @@ Names of the tools dispatched on the step that just settled, in order. > **signal**: `AbortSignal` -Defined in: [types/stream.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L263) - Fires when the turn is cancelled or the callback outlives its own budget. A callback that does real work (reading a live budget, asking a service) must honour it — the turn does not wait for a callback that ignores it. diff --git a/docs/api/type-aliases/ExecutionRequest.md b/docs/api/type-aliases/ExecutionRequest.md index f61978e97..e67ac9e86 100644 --- a/docs/api/type-aliases/ExecutionRequest.md +++ b/docs/api/type-aliases/ExecutionRequest.md @@ -8,8 +8,6 @@ > **ExecutionRequest** = `object` -Defined in: [types/agentNetwork.ts:1532](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1532) - Execution request ## Properties @@ -18,28 +16,20 @@ Execution request > **networkId**: `string` -Defined in: [types/agentNetwork.ts:1533](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1533) - --- ### input > **input**: [`NetworkExecutionInput`](NetworkExecutionInput.md) -Defined in: [types/agentNetwork.ts:1534](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1534) - --- ### options? > `optional` **options?**: [`NetworkExecutionOptions`](NetworkExecutionOptions.md) -Defined in: [types/agentNetwork.ts:1535](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1535) - --- ### priority? > `optional` **priority?**: `"high"` \| `"normal"` \| `"low"` - -Defined in: [types/agentNetwork.ts:1536](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1536) diff --git a/docs/api/type-aliases/ExecutionStrategy.md b/docs/api/type-aliases/ExecutionStrategy.md index 1be66f3ca..a9f49143d 100644 --- a/docs/api/type-aliases/ExecutionStrategy.md +++ b/docs/api/type-aliases/ExecutionStrategy.md @@ -8,6 +8,4 @@ > **ExecutionStrategy** = `"parallel"` \| `"sequential"` -Defined in: [types/workflow.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L35) - Execution strategy for model groups diff --git a/docs/api/type-aliases/ExifOrientationProbe.md b/docs/api/type-aliases/ExifOrientationProbe.md index 85a765dac..d9481d111 100644 --- a/docs/api/type-aliases/ExifOrientationProbe.md +++ b/docs/api/type-aliases/ExifOrientationProbe.md @@ -8,8 +8,6 @@ > **ExifOrientationProbe** = `"absent"` \| `"present"` \| `"inconclusive"` -Defined in: [types/file.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L78) - What a bounded header probe could establish about an image's EXIF orientation tag, without decoding the image or reading all of its bytes. diff --git a/docs/api/type-aliases/ExperimentPhase.md b/docs/api/type-aliases/ExperimentPhase.md index 0b241dd54..e935dc8f0 100644 --- a/docs/api/type-aliases/ExperimentPhase.md +++ b/docs/api/type-aliases/ExperimentPhase.md @@ -7,5 +7,3 @@ # Type Alias: ExperimentPhase > **ExperimentPhase** = `"bootstrap"` \| `"baseline"` \| `"propose"` \| `"edit"` \| `"commit"` \| `"run"` \| `"evaluate"` \| `"record"` \| `"accept_or_revert"` - -Defined in: [types/autoresearch.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L55) diff --git a/docs/api/type-aliases/ExperimentRecord.md b/docs/api/type-aliases/ExperimentRecord.md index cd03b25e2..d201b578d 100644 --- a/docs/api/type-aliases/ExperimentRecord.md +++ b/docs/api/type-aliases/ExperimentRecord.md @@ -8,52 +8,38 @@ > **ExperimentRecord** = `object` -Defined in: [types/autoresearch.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L95) - ## Properties ### commit > **commit**: `string` -Defined in: [types/autoresearch.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L96) - --- ### metric > **metric**: `number` \| `null` -Defined in: [types/autoresearch.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L97) - --- ### memoryGb > **memoryGb**: `number` \| `null` -Defined in: [types/autoresearch.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L98) - --- ### status > **status**: [`ExperimentStatus`](ExperimentStatus.md) -Defined in: [types/autoresearch.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L99) - --- ### description > **description**: `string` -Defined in: [types/autoresearch.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L100) - --- ### timestamp > **timestamp**: `string` - -Defined in: [types/autoresearch.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L101) diff --git a/docs/api/type-aliases/ExperimentStats.md b/docs/api/type-aliases/ExperimentStats.md index 6d5ff4353..9f437cd45 100644 --- a/docs/api/type-aliases/ExperimentStats.md +++ b/docs/api/type-aliases/ExperimentStats.md @@ -8,68 +8,50 @@ > **ExperimentStats** = `object` -Defined in: [types/autoresearch.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L104) - ## Properties ### total > **total**: `number` -Defined in: [types/autoresearch.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L105) - --- ### keepCount > **keepCount**: `number` -Defined in: [types/autoresearch.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L106) - --- ### discardCount > **discardCount**: `number` -Defined in: [types/autoresearch.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L107) - --- ### crashCount > **crashCount**: `number` -Defined in: [types/autoresearch.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L108) - --- ### timeoutCount > **timeoutCount**: `number` -Defined in: [types/autoresearch.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L109) - --- ### keepRate > **keepRate**: `number` -Defined in: [types/autoresearch.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L110) - --- ### bestMetric > **bestMetric**: `number` \| `null` -Defined in: [types/autoresearch.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L111) - --- ### bestCommit > **bestCommit**: `string` \| `null` - -Defined in: [types/autoresearch.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L112) diff --git a/docs/api/type-aliases/ExperimentStatus.md b/docs/api/type-aliases/ExperimentStatus.md index a4ec98e11..1de1b6c41 100644 --- a/docs/api/type-aliases/ExperimentStatus.md +++ b/docs/api/type-aliases/ExperimentStatus.md @@ -7,5 +7,3 @@ # Type Alias: ExperimentStatus > **ExperimentStatus** = `"keep"` \| `"discard"` \| `"crash"` \| `"timeout"` - -Defined in: [types/autoresearch.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L53) diff --git a/docs/api/type-aliases/ExperimentSummary.md b/docs/api/type-aliases/ExperimentSummary.md index b62bdbdd3..9113f06b7 100644 --- a/docs/api/type-aliases/ExperimentSummary.md +++ b/docs/api/type-aliases/ExperimentSummary.md @@ -8,52 +8,38 @@ > **ExperimentSummary** = `object` -Defined in: [types/autoresearch.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L86) - ## Properties ### crashed > **crashed**: `boolean` -Defined in: [types/autoresearch.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L87) - --- ### timedOut > **timedOut**: `boolean` -Defined in: [types/autoresearch.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L88) - --- ### metric > **metric**: `number` \| `null` -Defined in: [types/autoresearch.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L89) - --- ### memoryValue > **memoryValue**: `number` \| `null` -Defined in: [types/autoresearch.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L90) - --- ### trainingSeconds > **trainingSeconds**: `number` \| `null` -Defined in: [types/autoresearch.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L91) - --- ### rawTail > **rawTail**: `string` - -Defined in: [types/autoresearch.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L92) diff --git a/docs/api/type-aliases/ExportError.md b/docs/api/type-aliases/ExportError.md index db4c1f90b..28b600e77 100644 --- a/docs/api/type-aliases/ExportError.md +++ b/docs/api/type-aliases/ExportError.md @@ -8,8 +8,6 @@ > **ExportError** = `object` -Defined in: [types/exporter.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L31) - Export error details ## Properties @@ -18,20 +16,14 @@ Export error details > **spanId**: `string` -Defined in: [types/exporter.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L32) - --- ### error > **error**: `string` -Defined in: [types/exporter.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L33) - --- ### retryable > **retryable**: `boolean` - -Defined in: [types/exporter.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L34) diff --git a/docs/api/type-aliases/ExportProxyReplayOptions.md b/docs/api/type-aliases/ExportProxyReplayOptions.md index 7b76e551b..ef6b408d3 100644 --- a/docs/api/type-aliases/ExportProxyReplayOptions.md +++ b/docs/api/type-aliases/ExportProxyReplayOptions.md @@ -8,8 +8,6 @@ > **ExportProxyReplayOptions** = `object` -Defined in: [types/proxy.ts:3013](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3013) - Inputs for deterministic proxy replay bundle export. ## Properties @@ -18,20 +16,14 @@ Inputs for deterministic proxy replay bundle export. > **requestId**: `string` -Defined in: [types/proxy.ts:3014](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3014) - --- ### logsDir? > `optional` **logsDir?**: `string` -Defined in: [types/proxy.ts:3015](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3015) - --- ### attempt? > `optional` **attempt?**: `number` - -Defined in: [types/proxy.ts:3016](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3016) diff --git a/docs/api/type-aliases/ExportResult.md b/docs/api/type-aliases/ExportResult.md index d27fc889d..5d5b24e28 100644 --- a/docs/api/type-aliases/ExportResult.md +++ b/docs/api/type-aliases/ExportResult.md @@ -8,8 +8,6 @@ > **ExportResult** = `object` -Defined in: [types/exporter.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L40) - Export result with status and metadata ## Properties @@ -18,36 +16,26 @@ Export result with status and metadata > **success**: `boolean` -Defined in: [types/exporter.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L41) - --- ### exportedCount > **exportedCount**: `number` -Defined in: [types/exporter.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L42) - --- ### failedCount > **failedCount**: `number` -Defined in: [types/exporter.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L43) - --- ### errors? > `optional` **errors?**: [`ExportError`](ExportError.md)[] -Defined in: [types/exporter.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L44) - --- ### durationMs > **durationMs**: `number` - -Defined in: [types/exporter.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L45) diff --git a/docs/api/type-aliases/ExporterConfig.md b/docs/api/type-aliases/ExporterConfig.md index e4820cdac..9c38c632a 100644 --- a/docs/api/type-aliases/ExporterConfig.md +++ b/docs/api/type-aliases/ExporterConfig.md @@ -8,8 +8,6 @@ > **ExporterConfig** = `object` -Defined in: [types/exporter.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L9) - Base configuration for all exporters ## Properties @@ -18,8 +16,6 @@ Base configuration for all exporters > **enabled**: `boolean` -Defined in: [types/exporter.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L11) - Whether the exporter is enabled --- @@ -28,8 +24,6 @@ Whether the exporter is enabled > `optional` **maxBufferSize?**: `number` -Defined in: [types/exporter.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L13) - Maximum spans to buffer before auto-flush --- @@ -38,8 +32,6 @@ Maximum spans to buffer before auto-flush > `optional` **flushIntervalMs?**: `number` -Defined in: [types/exporter.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L15) - Flush interval in milliseconds --- @@ -48,8 +40,6 @@ Flush interval in milliseconds > `optional` **timeoutMs?**: `number` -Defined in: [types/exporter.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L17) - Request timeout in milliseconds --- @@ -58,8 +48,6 @@ Request timeout in milliseconds > `optional` **retries?**: `number` -Defined in: [types/exporter.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L19) - Number of retry attempts --- @@ -68,8 +56,6 @@ Number of retry attempts > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/exporter.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L21) - Custom headers for HTTP requests --- @@ -78,8 +64,6 @@ Custom headers for HTTP requests > `optional` **environment?**: `string` -Defined in: [types/exporter.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L23) - Environment name (dev, staging, prod) --- @@ -88,6 +72,4 @@ Environment name (dev, staging, prod) > `optional` **version?**: `string` -Defined in: [types/exporter.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L25) - Service/application version diff --git a/docs/api/type-aliases/ExporterHealthStatus.md b/docs/api/type-aliases/ExporterHealthStatus.md index 51f63765f..1ec0eccf9 100644 --- a/docs/api/type-aliases/ExporterHealthStatus.md +++ b/docs/api/type-aliases/ExporterHealthStatus.md @@ -8,8 +8,6 @@ > **ExporterHealthStatus** = `object` -Defined in: [types/exporter.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L51) - Exporter health status ## Properties @@ -18,44 +16,32 @@ Exporter health status > **healthy**: `boolean` -Defined in: [types/exporter.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L52) - --- ### name > **name**: `string` -Defined in: [types/exporter.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L53) - --- ### latencyMs? > `optional` **latencyMs?**: `number` -Defined in: [types/exporter.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L54) - --- ### lastExportTime? > `optional` **lastExportTime?**: `number` -Defined in: [types/exporter.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L55) - --- ### pendingSpans > **pendingSpans**: `number` -Defined in: [types/exporter.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L56) - --- ### errors? > `optional` **errors?**: `string`[] - -Defined in: [types/exporter.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L57) diff --git a/docs/api/type-aliases/ExporterName.md b/docs/api/type-aliases/ExporterName.md index caecad3d3..9c1ec6e65 100644 --- a/docs/api/type-aliases/ExporterName.md +++ b/docs/api/type-aliases/ExporterName.md @@ -8,6 +8,4 @@ > **ExporterName** = `"langfuse"` \| `"langsmith"` \| `"otel"` \| `"datadog"` \| `"sentry"` \| `"braintrust"` \| `"arize"` \| `"posthog"` \| `"laminar"` -Defined in: [types/cli.ts:1251](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1251) - Available exporter names diff --git a/docs/api/type-aliases/ExporterPlugin.md b/docs/api/type-aliases/ExporterPlugin.md index 194e13074..9e24ef25b 100644 --- a/docs/api/type-aliases/ExporterPlugin.md +++ b/docs/api/type-aliases/ExporterPlugin.md @@ -8,8 +8,6 @@ > **ExporterPlugin** = `object` -Defined in: [types/exporter.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L201) - Exporter plugin interface for custom exporters ## Properties @@ -18,24 +16,18 @@ Exporter plugin interface for custom exporters > **name**: `string` -Defined in: [types/exporter.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L202) - --- ### version > **version**: `string` -Defined in: [types/exporter.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L203) - ## Methods ### create() > **create**(`config`): `unknown` -Defined in: [types/exporter.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L204) - #### Parameters ##### config diff --git a/docs/api/type-aliases/ExposableAgent.md b/docs/api/type-aliases/ExposableAgent.md index dfff48ff3..b91479cc6 100644 --- a/docs/api/type-aliases/ExposableAgent.md +++ b/docs/api/type-aliases/ExposableAgent.md @@ -8,8 +8,6 @@ > **ExposableAgent** = `object` -Defined in: [types/mcp.ts:1140](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1140) - Agent definition for MCP exposure ## Properties @@ -18,8 +16,6 @@ Agent definition for MCP exposure > **id**: `string` -Defined in: [types/mcp.ts:1144](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1144) - Unique agent identifier --- @@ -28,8 +24,6 @@ Unique agent identifier > **name**: `string` -Defined in: [types/mcp.ts:1149](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1149) - Human-readable agent name --- @@ -38,8 +32,6 @@ Human-readable agent name > **description**: `string` -Defined in: [types/mcp.ts:1154](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1154) - Agent description for AI models --- @@ -48,8 +40,6 @@ Agent description for AI models > `optional` **inputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:1159](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1159) - Input schema for the agent --- @@ -58,8 +48,6 @@ Input schema for the agent > `optional` **outputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:1164](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1164) - Output schema for the agent --- @@ -68,8 +56,6 @@ Output schema for the agent > **execute**: (`input`, `context?`) => `Promise`\<`unknown`\> -Defined in: [types/mcp.ts:1169](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1169) - Agent execution function #### Parameters @@ -92,8 +78,6 @@ Agent execution function > `optional` **metadata?**: `object` -Defined in: [types/mcp.ts:1177](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1177) - Additional agent metadata #### version? diff --git a/docs/api/type-aliases/ExposableWorkflow.md b/docs/api/type-aliases/ExposableWorkflow.md index d733fb559..f1fac187f 100644 --- a/docs/api/type-aliases/ExposableWorkflow.md +++ b/docs/api/type-aliases/ExposableWorkflow.md @@ -8,8 +8,6 @@ > **ExposableWorkflow** = `object` -Defined in: [types/mcp.ts:1191](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1191) - Workflow definition for MCP exposure ## Properties @@ -18,8 +16,6 @@ Workflow definition for MCP exposure > **id**: `string` -Defined in: [types/mcp.ts:1195](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1195) - Unique workflow identifier --- @@ -28,8 +24,6 @@ Unique workflow identifier > **name**: `string` -Defined in: [types/mcp.ts:1200](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1200) - Human-readable workflow name --- @@ -38,8 +32,6 @@ Human-readable workflow name > **description**: `string` -Defined in: [types/mcp.ts:1205](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1205) - Workflow description --- @@ -48,8 +40,6 @@ Workflow description > `optional` **steps?**: `object`[] -Defined in: [types/mcp.ts:1210](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1210) - Workflow steps (for documentation) #### id @@ -70,8 +60,6 @@ Workflow steps (for documentation) > `optional` **inputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:1219](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1219) - Input schema for the workflow --- @@ -80,8 +68,6 @@ Input schema for the workflow > `optional` **outputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:1224](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1224) - Output schema for the workflow --- @@ -90,8 +76,6 @@ Output schema for the workflow > **execute**: (`input`, `context?`) => `Promise`\<`unknown`\> -Defined in: [types/mcp.ts:1229](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1229) - Workflow execution function #### Parameters @@ -114,8 +98,6 @@ Workflow execution function > `optional` **metadata?**: `object` -Defined in: [types/mcp.ts:1237](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1237) - Workflow metadata #### version? diff --git a/docs/api/type-aliases/ExposureOptions.md b/docs/api/type-aliases/ExposureOptions.md index 412556718..c0817fec8 100644 --- a/docs/api/type-aliases/ExposureOptions.md +++ b/docs/api/type-aliases/ExposureOptions.md @@ -8,8 +8,6 @@ > **ExposureOptions** = `object` -Defined in: [types/mcp.ts:1252](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1252) - Options for exposing agents/workflows as MCP tools ## Properties @@ -18,8 +16,6 @@ Options for exposing agents/workflows as MCP tools > `optional` **prefix?**: `string` -Defined in: [types/mcp.ts:1256](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1256) - Prefix for tool names --- @@ -28,8 +24,6 @@ Prefix for tool names > `optional` **defaultAnnotations?**: [`MCPToolAnnotations`](MCPToolAnnotations.md) -Defined in: [types/mcp.ts:1261](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1261) - Default annotations for all exposed tools --- @@ -38,8 +32,6 @@ Default annotations for all exposed tools > `optional` **includeMetadataInDescription?**: `boolean` -Defined in: [types/mcp.ts:1266](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1266) - Whether to include metadata in tool description --- @@ -48,8 +40,6 @@ Whether to include metadata in tool description > `optional` **nameTransformer?**: (`name`) => `string` -Defined in: [types/mcp.ts:1271](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1271) - Custom name transformer #### Parameters @@ -68,8 +58,6 @@ Custom name transformer > `optional` **wrapWithContext?**: `boolean` -Defined in: [types/mcp.ts:1276](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1276) - Add execution context wrapper --- @@ -78,8 +66,6 @@ Add execution context wrapper > `optional` **executionTimeout?**: `number` -Defined in: [types/mcp.ts:1281](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1281) - Timeout for agent/workflow execution (ms) --- @@ -88,6 +74,4 @@ Timeout for agent/workflow execution (ms) > `optional` **enableLogging?**: `boolean` -Defined in: [types/mcp.ts:1286](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1286) - Enable execution logging diff --git a/docs/api/type-aliases/ExposureResult.md b/docs/api/type-aliases/ExposureResult.md index 3d34dd732..a732bdba5 100644 --- a/docs/api/type-aliases/ExposureResult.md +++ b/docs/api/type-aliases/ExposureResult.md @@ -8,8 +8,6 @@ > **ExposureResult** = `object` -Defined in: [types/mcp.ts:1293](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1293) - Exposure result ## Properties @@ -18,8 +16,6 @@ Exposure result > **tool**: [`MCPServerTool`](MCPServerTool.md) -Defined in: [types/mcp.ts:1297](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1297) - Generated MCP tool --- @@ -28,8 +24,6 @@ Generated MCP tool > **sourceType**: `"agent"` \| `"workflow"` -Defined in: [types/mcp.ts:1302](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1302) - Original source type --- @@ -38,8 +32,6 @@ Original source type > **sourceId**: `string` -Defined in: [types/mcp.ts:1307](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1307) - Original source ID --- @@ -48,6 +40,4 @@ Original source ID > **toolName**: `string` -Defined in: [types/mcp.ts:1312](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1312) - Generated tool name diff --git a/docs/api/type-aliases/ExpressMiddleware.md b/docs/api/type-aliases/ExpressMiddleware.md index f4148faab..4d0f739ae 100644 --- a/docs/api/type-aliases/ExpressMiddleware.md +++ b/docs/api/type-aliases/ExpressMiddleware.md @@ -8,8 +8,6 @@ > **ExpressMiddleware** = (`req`, `res`, `next`) => `Promise`\<`void`\> -Defined in: [types/auth.ts:1332](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1332) - Express-style auth middleware signature. ## Parameters diff --git a/docs/api/type-aliases/ExtendedObservabilityConfig.md b/docs/api/type-aliases/ExtendedObservabilityConfig.md index 2d61406f1..4a1b95a80 100644 --- a/docs/api/type-aliases/ExtendedObservabilityConfig.md +++ b/docs/api/type-aliases/ExtendedObservabilityConfig.md @@ -8,8 +8,6 @@ > **ExtendedObservabilityConfig** = `object` -Defined in: [types/exporter.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L210) - Extended observability configuration for NeuroLink SDK ## Properties @@ -18,8 +16,6 @@ Extended observability configuration for NeuroLink SDK > `optional` **langfuse?**: [`LangfuseExporterConfig`](LangfuseExporterConfig.md) -Defined in: [types/exporter.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L212) - Langfuse configuration --- @@ -28,8 +24,6 @@ Langfuse configuration > `optional` **langsmith?**: [`LangSmithExporterConfig`](LangSmithExporterConfig.md) -Defined in: [types/exporter.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L214) - LangSmith configuration --- @@ -38,8 +32,6 @@ LangSmith configuration > `optional` **datadog?**: [`DatadogExporterConfig`](DatadogExporterConfig.md) -Defined in: [types/exporter.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L216) - Datadog configuration --- @@ -48,8 +40,6 @@ Datadog configuration > `optional` **sentry?**: [`SentryExporterConfig`](SentryExporterConfig.md) -Defined in: [types/exporter.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L218) - Sentry configuration --- @@ -58,8 +48,6 @@ Sentry configuration > `optional` **braintrust?**: [`BraintrustExporterConfig`](BraintrustExporterConfig.md) -Defined in: [types/exporter.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L220) - Braintrust configuration --- @@ -68,8 +56,6 @@ Braintrust configuration > `optional` **arize?**: [`ArizeExporterConfig`](ArizeExporterConfig.md) -Defined in: [types/exporter.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L222) - Arize configuration --- @@ -78,8 +64,6 @@ Arize configuration > `optional` **posthog?**: [`PostHogExporterConfig`](PostHogExporterConfig.md) -Defined in: [types/exporter.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L224) - PostHog configuration --- @@ -88,8 +72,6 @@ PostHog configuration > `optional` **laminar?**: [`LaminarExporterConfig`](LaminarExporterConfig.md) -Defined in: [types/exporter.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L226) - Laminar configuration --- @@ -98,8 +80,6 @@ Laminar configuration > `optional` **openTelemetry?**: [`OtelExporterConfig`](OtelExporterConfig.md) -Defined in: [types/exporter.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L228) - OpenTelemetry configuration --- @@ -108,6 +88,4 @@ OpenTelemetry configuration > `optional` **sampling?**: [`SamplerConfig`](SamplerConfig.md) -Defined in: [types/exporter.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L230) - Sampling configuration diff --git a/docs/api/type-aliases/ExtendedPropertySchema.md b/docs/api/type-aliases/ExtendedPropertySchema.md index 53c339403..732140336 100644 --- a/docs/api/type-aliases/ExtendedPropertySchema.md +++ b/docs/api/type-aliases/ExtendedPropertySchema.md @@ -8,8 +8,6 @@ > **ExtendedPropertySchema** = [`PropertySchema`](PropertySchema.md) & `object` -Defined in: [types/middleware.ts:516](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L516) - PropertySchema with an extra `format` tag for common schemas. ## Type Declaration diff --git a/docs/api/type-aliases/ExtendedTool.md b/docs/api/type-aliases/ExtendedTool.md index a43a0a4c9..b55cd576a 100644 --- a/docs/api/type-aliases/ExtendedTool.md +++ b/docs/api/type-aliases/ExtendedTool.md @@ -8,6 +8,4 @@ > **ExtendedTool** = [`Tool`](Tool.md) & `Partial`\<[`ExternalMCPToolInfo`](ExternalMCPToolInfo.md)\> -Defined in: [types/providers.ts:1058](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1058) - Extended tool type that combines AI SDK tools with external MCP tool info diff --git a/docs/api/type-aliases/ExtendedValidationSchema.md b/docs/api/type-aliases/ExtendedValidationSchema.md index 8a9f553ae..4fab52b74 100644 --- a/docs/api/type-aliases/ExtendedValidationSchema.md +++ b/docs/api/type-aliases/ExtendedValidationSchema.md @@ -8,8 +8,6 @@ > **ExtendedValidationSchema** = `object` -Defined in: [types/middleware.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L521) - Extended validation schema for common schemas. ## Properties @@ -18,36 +16,26 @@ Extended validation schema for common schemas. > `optional` **type?**: `string` -Defined in: [types/middleware.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L522) - --- ### format? > `optional` **format?**: `string` -Defined in: [types/middleware.ts:523](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L523) - --- ### required? > `optional` **required?**: `string`[] -Defined in: [types/middleware.ts:524](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L524) - --- ### properties? > `optional` **properties?**: `Record`\<`string`, [`ExtendedPropertySchema`](ExtendedPropertySchema.md)\> -Defined in: [types/middleware.ts:525](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L525) - --- ### additionalProperties? > `optional` **additionalProperties?**: `boolean` - -Defined in: [types/middleware.ts:526](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L526) diff --git a/docs/api/type-aliases/ExternalMCPConfigValidation.md b/docs/api/type-aliases/ExternalMCPConfigValidation.md index 72faeaa11..f1bff05e6 100644 --- a/docs/api/type-aliases/ExternalMCPConfigValidation.md +++ b/docs/api/type-aliases/ExternalMCPConfigValidation.md @@ -8,8 +8,6 @@ > **ExternalMCPConfigValidation** = `object` -Defined in: [types/externalMcp.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L223) - External MCP server configuration validation result ## Properties @@ -18,8 +16,6 @@ External MCP server configuration validation result > **isValid**: `boolean` -Defined in: [types/externalMcp.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L225) - Whether the configuration is valid --- @@ -28,8 +24,6 @@ Whether the configuration is valid > **errors**: `string`[] -Defined in: [types/externalMcp.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L228) - Validation errors --- @@ -38,8 +32,6 @@ Validation errors > **warnings**: `string`[] -Defined in: [types/externalMcp.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L231) - Validation warnings --- @@ -48,6 +40,4 @@ Validation warnings > **suggestions**: `string`[] -Defined in: [types/externalMcp.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L234) - Suggestions for improvement diff --git a/docs/api/type-aliases/ExternalMCPManagerConfig.md b/docs/api/type-aliases/ExternalMCPManagerConfig.md index 466b41ae4..b18871ec2 100644 --- a/docs/api/type-aliases/ExternalMCPManagerConfig.md +++ b/docs/api/type-aliases/ExternalMCPManagerConfig.md @@ -8,8 +8,6 @@ > **ExternalMCPManagerConfig** = `object` -Defined in: [types/externalMcp.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L402) - External MCP manager configuration ## Properties @@ -18,8 +16,6 @@ External MCP manager configuration > `optional` **maxServers?**: `number` -Defined in: [types/externalMcp.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L404) - Maximum number of concurrent servers --- @@ -28,8 +24,6 @@ Maximum number of concurrent servers > `optional` **defaultTimeout?**: `number` -Defined in: [types/externalMcp.ts:407](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L407) - Default timeout for operations --- @@ -38,8 +32,6 @@ Default timeout for operations > `optional` **defaultHealthCheckInterval?**: `number` -Defined in: [types/externalMcp.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L410) - Default health check interval --- @@ -48,8 +40,6 @@ Default health check interval > `optional` **enableAutoRestart?**: `boolean` -Defined in: [types/externalMcp.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L413) - Whether to enable automatic restart --- @@ -58,8 +48,6 @@ Whether to enable automatic restart > `optional` **maxRestartAttempts?**: `number` -Defined in: [types/externalMcp.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L416) - Maximum restart attempts per server --- @@ -68,8 +56,6 @@ Maximum restart attempts per server > `optional` **restartBackoffMultiplier?**: `number` -Defined in: [types/externalMcp.ts:419](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L419) - Restart backoff multiplier --- @@ -78,8 +64,6 @@ Restart backoff multiplier > `optional` **enablePerformanceMonitoring?**: `boolean` -Defined in: [types/externalMcp.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L422) - Whether to enable performance monitoring --- @@ -88,6 +72,4 @@ Whether to enable performance monitoring > `optional` **logLevel?**: `"debug"` \| `"info"` \| `"warn"` \| `"error"` -Defined in: [types/externalMcp.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L425) - Log level for external MCP operations diff --git a/docs/api/type-aliases/ExternalMCPOperationResult.md b/docs/api/type-aliases/ExternalMCPOperationResult.md index 5d5bb31d8..2a72593d7 100644 --- a/docs/api/type-aliases/ExternalMCPOperationResult.md +++ b/docs/api/type-aliases/ExternalMCPOperationResult.md @@ -8,8 +8,6 @@ > **ExternalMCPOperationResult**\<`T`\> = `object` -Defined in: [types/externalMcp.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L240) - External MCP server operation result ## Type Parameters @@ -24,8 +22,6 @@ External MCP server operation result > **success**: `boolean` -Defined in: [types/externalMcp.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L242) - Whether the operation was successful --- @@ -34,8 +30,6 @@ Whether the operation was successful > `optional` **data?**: `T` -Defined in: [types/externalMcp.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L245) - Result data if successful --- @@ -44,8 +38,6 @@ Result data if successful > `optional` **error?**: `string` -Defined in: [types/externalMcp.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L248) - Error message if failed --- @@ -54,8 +46,6 @@ Error message if failed > `optional` **serverId?**: `string` -Defined in: [types/externalMcp.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L251) - Server ID --- @@ -64,8 +54,6 @@ Server ID > `optional` **duration?**: `number` -Defined in: [types/externalMcp.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L254) - Operation duration in milliseconds --- @@ -74,8 +62,6 @@ Operation duration in milliseconds > `optional` **metadata?**: `object` & `object` -Defined in: [types/externalMcp.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L266) - Additional metadata. The two typed optional fields are intersected with the pre-existing diff --git a/docs/api/type-aliases/ExternalMCPServerConfig.md b/docs/api/type-aliases/ExternalMCPServerConfig.md index d34a5fabd..90220b10f 100644 --- a/docs/api/type-aliases/ExternalMCPServerConfig.md +++ b/docs/api/type-aliases/ExternalMCPServerConfig.md @@ -8,8 +8,6 @@ > **ExternalMCPServerConfig** = `object` -Defined in: [types/externalMcp.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L24) - External MCP server configuration for process spawning ## Properties @@ -18,8 +16,6 @@ External MCP server configuration for process spawning > **id**: `string` -Defined in: [types/externalMcp.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L26) - Unique identifier for the server --- @@ -28,8 +24,6 @@ Unique identifier for the server > **command**: `string` -Defined in: [types/externalMcp.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L29) - Command to execute (e.g., 'npx', 'node', 'python') --- @@ -38,8 +32,6 @@ Command to execute (e.g., 'npx', 'node', 'python') > **args**: `string`[] -Defined in: [types/externalMcp.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L32) - Arguments to pass to the command --- @@ -48,8 +40,6 @@ Arguments to pass to the command > `optional` **env?**: `Record`\<`string`, `string`\> -Defined in: [types/externalMcp.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L35) - Environment variables for the process --- @@ -58,8 +48,6 @@ Environment variables for the process > **transport**: [`MCPTransportType`](MCPTransportType.md) -Defined in: [types/externalMcp.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L38) - Transport protocol to use --- @@ -68,8 +56,6 @@ Transport protocol to use > `optional` **timeout?**: `number` -Defined in: [types/externalMcp.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L41) - Connection timeout in milliseconds (default: 10000) --- @@ -78,8 +64,6 @@ Connection timeout in milliseconds (default: 10000) > `optional` **retries?**: `number` -Defined in: [types/externalMcp.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L44) - Maximum retry attempts for connection (default: 3) --- @@ -88,8 +72,6 @@ Maximum retry attempts for connection (default: 3) > `optional` **healthCheckInterval?**: `number` -Defined in: [types/externalMcp.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L47) - Health check interval in milliseconds (default: 30000) --- @@ -98,8 +80,6 @@ Health check interval in milliseconds (default: 30000) > `optional` **autoRestart?**: `boolean` -Defined in: [types/externalMcp.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L50) - Whether to automatically restart on failure (default: true) --- @@ -108,8 +88,6 @@ Whether to automatically restart on failure (default: true) > `optional` **cwd?**: `string` -Defined in: [types/externalMcp.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L53) - Working directory for the process --- @@ -118,8 +96,6 @@ Working directory for the process > `optional` **url?**: `string` -Defined in: [types/externalMcp.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L56) - URL for SSE/WebSocket/HTTP transports --- @@ -128,8 +104,6 @@ URL for SSE/WebSocket/HTTP transports > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/externalMcp.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L59) - HTTP headers for authentication and configuration (HTTP/SSE/WebSocket) --- @@ -138,8 +112,6 @@ HTTP headers for authentication and configuration (HTTP/SSE/WebSocket) > `optional` **blockedTools?**: `string`[] -Defined in: [types/externalMcp.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L62) - List of tool names to block/blacklist from this server --- @@ -148,6 +120,4 @@ List of tool names to block/blacklist from this server > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/externalMcp.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L65) - Additional metadata diff --git a/docs/api/type-aliases/ExternalMCPServerEvents.md b/docs/api/type-aliases/ExternalMCPServerEvents.md index fcd1cfee3..a9e0184bf 100644 --- a/docs/api/type-aliases/ExternalMCPServerEvents.md +++ b/docs/api/type-aliases/ExternalMCPServerEvents.md @@ -8,8 +8,6 @@ > **ExternalMCPServerEvents** = `object` -Defined in: [types/externalMcp.ts:339](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L339) - External MCP server events ## Properties @@ -18,8 +16,6 @@ External MCP server events > **statusChanged**: `object` -Defined in: [types/externalMcp.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L341) - Server status changed #### serverId @@ -48,8 +44,6 @@ Server status changed > **connected**: `object` -Defined in: [types/externalMcp.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L350) - Server connected successfully #### serverId @@ -74,8 +68,6 @@ Server connected successfully > **disconnected**: `object` -Defined in: [types/externalMcp.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L358) - Server disconnected #### serverId @@ -100,8 +92,6 @@ Server disconnected > **failed**: `object` -Defined in: [types/externalMcp.ts:366](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L366) - Server failed #### serverId @@ -126,8 +116,6 @@ Server failed > **toolDiscovered**: `object` -Defined in: [types/externalMcp.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L374) - Tool discovered #### serverId @@ -156,8 +144,6 @@ Tool discovered > **toolRemoved**: `object` -Defined in: [types/externalMcp.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L383) - Tool removed #### serverId @@ -182,8 +168,6 @@ Tool removed > **healthCheck**: `object` -Defined in: [types/externalMcp.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L391) - Health check completed #### serverId diff --git a/docs/api/type-aliases/ExternalMCPServerHealth.md b/docs/api/type-aliases/ExternalMCPServerHealth.md index 21d923b16..03f3e5a95 100644 --- a/docs/api/type-aliases/ExternalMCPServerHealth.md +++ b/docs/api/type-aliases/ExternalMCPServerHealth.md @@ -8,8 +8,6 @@ > **ExternalMCPServerHealth** = `object` -Defined in: [types/externalMcp.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L189) - External MCP server health status ## Properties @@ -18,8 +16,6 @@ External MCP server health status > **serverId**: `string` -Defined in: [types/externalMcp.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L191) - Server ID --- @@ -28,8 +24,6 @@ Server ID > **isHealthy**: `boolean` -Defined in: [types/externalMcp.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L194) - Whether the server is healthy --- @@ -38,8 +32,6 @@ Whether the server is healthy > **status**: [`ExternalMCPServerStatus`](ExternalMCPServerStatus.md) -Defined in: [types/externalMcp.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L197) - Current status --- @@ -48,8 +40,6 @@ Current status > **checkedAt**: `Date` -Defined in: [types/externalMcp.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L200) - When the health check was performed --- @@ -58,8 +48,6 @@ When the health check was performed > `optional` **responseTime?**: `number` -Defined in: [types/externalMcp.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L203) - Response time for health check --- @@ -68,8 +56,6 @@ Response time for health check > **toolCount**: `number` -Defined in: [types/externalMcp.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L206) - Number of available tools --- @@ -78,8 +64,6 @@ Number of available tools > **issues**: `string`[] -Defined in: [types/externalMcp.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L209) - Any health issues detected --- @@ -88,8 +72,6 @@ Any health issues detected > **performance**: `object` -Defined in: [types/externalMcp.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L212) - Performance metrics #### uptime diff --git a/docs/api/type-aliases/ExternalMCPServerInstance.md b/docs/api/type-aliases/ExternalMCPServerInstance.md index 46e9be0fd..6b0f42a23 100644 --- a/docs/api/type-aliases/ExternalMCPServerInstance.md +++ b/docs/api/type-aliases/ExternalMCPServerInstance.md @@ -8,8 +8,6 @@ > **ExternalMCPServerInstance** = `object` -Defined in: [types/externalMcp.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L71) - Runtime state of an external MCP server instance ## Properties @@ -18,8 +16,6 @@ Runtime state of an external MCP server instance > **config**: [`ExternalMCPServerConfig`](ExternalMCPServerConfig.md) -Defined in: [types/externalMcp.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L73) - Server configuration --- @@ -28,8 +24,6 @@ Server configuration > **process**: `ChildProcess` \| `null` -Defined in: [types/externalMcp.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L79) - Child process handle. Always null for stdio servers: the SDK transport owns the process and does not expose the handle. Use `pid`. @@ -39,8 +33,6 @@ owns the process and does not expose the handle. Use `pid`. > `optional` **pid?**: `number` -Defined in: [types/externalMcp.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L82) - OS process id of the stdio server, once connected --- @@ -49,8 +41,6 @@ OS process id of the stdio server, once connected > **client**: `Client` \| `null` -Defined in: [types/externalMcp.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L85) - MCP client instance --- @@ -59,8 +49,6 @@ MCP client instance > **transport**: `Transport` \| `null` -Defined in: [types/externalMcp.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L88) - Transport instance --- @@ -69,8 +57,6 @@ Transport instance > **status**: [`ExternalMCPServerStatus`](ExternalMCPServerStatus.md) -Defined in: [types/externalMcp.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L91) - Current server status --- @@ -79,8 +65,6 @@ Current server status > `optional` **lastError?**: `string` -Defined in: [types/externalMcp.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L94) - Last error message if any --- @@ -89,8 +73,6 @@ Last error message if any > `optional` **startTime?**: `Date` -Defined in: [types/externalMcp.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L97) - When the server was started --- @@ -99,8 +81,6 @@ When the server was started > `optional` **lastHealthCheck?**: `Date` -Defined in: [types/externalMcp.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L100) - When the server was last seen healthy --- @@ -109,8 +89,6 @@ When the server was last seen healthy > **reconnectAttempts**: `number` -Defined in: [types/externalMcp.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L103) - Number of reconnection attempts --- @@ -119,8 +97,6 @@ Number of reconnection attempts > **maxReconnectAttempts**: `number` -Defined in: [types/externalMcp.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L106) - Maximum reconnection attempts before giving up --- @@ -129,8 +105,6 @@ Maximum reconnection attempts before giving up > **tools**: `Map`\<`string`, [`ExternalMCPToolInfo`](ExternalMCPToolInfo.md)\> -Defined in: [types/externalMcp.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L109) - Available tools from this server --- @@ -139,8 +113,6 @@ Available tools from this server > `optional` **toolsArray?**: `object`[] -Defined in: [types/externalMcp.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L112) - Cached tools array for ZERO conversion - MCP format #### name @@ -161,8 +133,6 @@ Cached tools array for ZERO conversion - MCP format > `optional` **capabilities?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/externalMcp.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L119) - Server capabilities reported by MCP --- @@ -171,8 +141,6 @@ Server capabilities reported by MCP > `optional` **healthTimer?**: `NodeJS.Timeout` -Defined in: [types/externalMcp.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L122) - Health monitoring timer --- @@ -181,8 +149,6 @@ Health monitoring timer > `optional` **restartTimer?**: `NodeJS.Timeout` -Defined in: [types/externalMcp.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L125) - Restart backoff timer --- @@ -191,8 +157,6 @@ Restart backoff timer > **metrics**: `object` -Defined in: [types/externalMcp.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L128) - Performance metrics #### totalConnections diff --git a/docs/api/type-aliases/ExternalMCPServerStatus.md b/docs/api/type-aliases/ExternalMCPServerStatus.md index 9d77e3c3e..a29d08fce 100644 --- a/docs/api/type-aliases/ExternalMCPServerStatus.md +++ b/docs/api/type-aliases/ExternalMCPServerStatus.md @@ -8,6 +8,4 @@ > **ExternalMCPServerStatus** = `"initializing"` \| `"connecting"` \| `"connected"` \| `"disconnected"` \| `"failed"` \| `"restarting"` \| `"stopping"` \| `"stopped"` -Defined in: [types/externalMcp.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L141) - External MCP server status states diff --git a/docs/api/type-aliases/ExternalMCPToolContext.md b/docs/api/type-aliases/ExternalMCPToolContext.md index fea187e7e..db777b506 100644 --- a/docs/api/type-aliases/ExternalMCPToolContext.md +++ b/docs/api/type-aliases/ExternalMCPToolContext.md @@ -8,8 +8,6 @@ > **ExternalMCPToolContext** = `object` -Defined in: [types/externalMcp.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L283) - External MCP tool execution context ## Properties @@ -18,8 +16,6 @@ External MCP tool execution context > **sessionId**: `string` -Defined in: [types/externalMcp.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L285) - Execution session ID --- @@ -28,8 +24,6 @@ Execution session ID > `optional` **userId?**: `string` -Defined in: [types/externalMcp.ts:288](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L288) - User ID if available --- @@ -38,8 +32,6 @@ User ID if available > **serverId**: `string` -Defined in: [types/externalMcp.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L291) - Server ID executing the tool --- @@ -48,8 +40,6 @@ Server ID executing the tool > **toolName**: `string` -Defined in: [types/externalMcp.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L294) - Tool name being executed --- @@ -58,8 +48,6 @@ Tool name being executed > `optional` **timeout?**: `number` -Defined in: [types/externalMcp.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L297) - Execution timeout in milliseconds --- @@ -68,6 +56,4 @@ Execution timeout in milliseconds > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/externalMcp.ts:300](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L300) - Additional context data diff --git a/docs/api/type-aliases/ExternalMCPToolInfo.md b/docs/api/type-aliases/ExternalMCPToolInfo.md index 8233d9d80..4e8a15490 100644 --- a/docs/api/type-aliases/ExternalMCPToolInfo.md +++ b/docs/api/type-aliases/ExternalMCPToolInfo.md @@ -8,8 +8,6 @@ > **ExternalMCPToolInfo** = `object` -Defined in: [types/externalMcp.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L154) - Tool information from external MCP server ## Properties @@ -18,8 +16,6 @@ Tool information from external MCP server > **name**: `string` -Defined in: [types/externalMcp.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L156) - Tool name --- @@ -28,8 +24,6 @@ Tool name > **description**: `string` -Defined in: [types/externalMcp.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L159) - Tool description --- @@ -38,8 +32,6 @@ Tool description > **serverId**: `string` -Defined in: [types/externalMcp.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L162) - Server ID that provides this tool --- @@ -48,8 +40,6 @@ Server ID that provides this tool > `optional` **inputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/externalMcp.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L165) - Input schema (JSON Schema) --- @@ -58,8 +48,6 @@ Input schema (JSON Schema) > **isAvailable**: `boolean` -Defined in: [types/externalMcp.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L168) - Whether the tool is currently available --- @@ -68,8 +56,6 @@ Whether the tool is currently available > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/externalMcp.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L171) - Tool metadata --- @@ -78,8 +64,6 @@ Tool metadata > `optional` **lastCalled?**: `Date` -Defined in: [types/externalMcp.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L174) - When the tool was last successfully called --- @@ -88,8 +72,6 @@ When the tool was last successfully called > **stats**: `object` -Defined in: [types/externalMcp.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L177) - Tool execution statistics #### totalCalls diff --git a/docs/api/type-aliases/ExternalMCPToolResult.md b/docs/api/type-aliases/ExternalMCPToolResult.md index d230158e3..93f19248f 100644 --- a/docs/api/type-aliases/ExternalMCPToolResult.md +++ b/docs/api/type-aliases/ExternalMCPToolResult.md @@ -8,8 +8,6 @@ > **ExternalMCPToolResult** = `object` -Defined in: [types/externalMcp.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L306) - External MCP tool execution result ## Properties @@ -18,8 +16,6 @@ External MCP tool execution result > **success**: `boolean` -Defined in: [types/externalMcp.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L308) - Whether the execution was successful --- @@ -28,8 +24,6 @@ Whether the execution was successful > `optional` **data?**: `unknown` -Defined in: [types/externalMcp.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L311) - Result data if successful --- @@ -38,8 +32,6 @@ Result data if successful > `optional` **error?**: `string` -Defined in: [types/externalMcp.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L314) - Error message if failed --- @@ -48,8 +40,6 @@ Error message if failed > `optional` **isErrorResult?**: `boolean` -Defined in: [types/externalMcp.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L322) - True when the call completed at the transport level but the MCP result itself is `{ isError: true }`. `success` stays true for such results so the resolved MCP error payload still reaches the caller unchanged; this @@ -61,8 +51,6 @@ flag is what lets stats and telemetry count the call as a failure. > **duration**: `number` -Defined in: [types/externalMcp.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L325) - Execution duration in milliseconds --- @@ -71,8 +59,6 @@ Execution duration in milliseconds > `optional` **metadata?**: `object` -Defined in: [types/externalMcp.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/externalMcp.ts#L328) - Tool execution metadata #### Index Signature diff --git a/docs/api/type-aliases/ExternalToolExecutionOptions.md b/docs/api/type-aliases/ExternalToolExecutionOptions.md index 9d5e18c51..5b2ac1971 100644 --- a/docs/api/type-aliases/ExternalToolExecutionOptions.md +++ b/docs/api/type-aliases/ExternalToolExecutionOptions.md @@ -8,8 +8,6 @@ > **ExternalToolExecutionOptions** = `object` -Defined in: [types/mcp.ts:617](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L617) - External MCP tool execution options Moved from src/lib/mcp/toolDiscoveryService.ts @@ -19,8 +17,6 @@ Moved from src/lib/mcp/toolDiscoveryService.ts > `optional` **timeout?**: `number` -Defined in: [types/mcp.ts:619](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L619) - Execution timeout in milliseconds --- @@ -29,8 +25,6 @@ Execution timeout in milliseconds > `optional` **context?**: `Partial`\<[`ExternalMCPToolContext`](ExternalMCPToolContext.md)\> -Defined in: [types/mcp.ts:622](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L622) - Additional context for execution --- @@ -39,8 +33,6 @@ Additional context for execution > `optional` **validateInput?**: `boolean` -Defined in: [types/mcp.ts:625](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L625) - Whether to validate input parameters --- @@ -49,6 +41,4 @@ Whether to validate input parameters > `optional` **validateOutput?**: `boolean` -Defined in: [types/mcp.ts:628](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L628) - Whether to validate output diff --git a/docs/api/type-aliases/ExtractChunksOptions.md b/docs/api/type-aliases/ExtractChunksOptions.md index 0dc46e492..54ab32452 100644 --- a/docs/api/type-aliases/ExtractChunksOptions.md +++ b/docs/api/type-aliases/ExtractChunksOptions.md @@ -8,8 +8,6 @@ > **ExtractChunksOptions** = `object` -Defined in: [types/rag.ts:1582](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1582) - Options for the recursive JSON chunk extractor. ## Properties @@ -18,60 +16,44 @@ Options for the recursive JSON chunk extractor. > **data**: `unknown` -Defined in: [types/rag.ts:1583](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1583) - --- ### path > **path**: `string` -Defined in: [types/rag.ts:1584](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1584) - --- ### depth > **depth**: `number` -Defined in: [types/rag.ts:1585](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1585) - --- ### maxDepth > **maxDepth**: `number` -Defined in: [types/rag.ts:1586](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1586) - --- ### maxSize > **maxSize**: `number` -Defined in: [types/rag.ts:1587](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1587) - --- ### splitKeys > **splitKeys**: `string`[] -Defined in: [types/rag.ts:1588](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1588) - --- ### preserveKeys > **preserveKeys**: `string`[] -Defined in: [types/rag.ts:1589](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1589) - --- ### includeJsonPath > **includeJsonPath**: `boolean` - -Defined in: [types/rag.ts:1590](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1590) diff --git a/docs/api/type-aliases/ExtractParams.md b/docs/api/type-aliases/ExtractParams.md index 647722c40..91f15f44d 100644 --- a/docs/api/type-aliases/ExtractParams.md +++ b/docs/api/type-aliases/ExtractParams.md @@ -8,8 +8,6 @@ > **ExtractParams** = `object` -Defined in: [types/rag.ts:1155](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1155) - Combined extraction parameters ## Properties @@ -18,8 +16,6 @@ Combined extraction parameters > `optional` **title?**: `boolean` \| [`TitleExtractorConfig`](TitleExtractorConfig.md) -Defined in: [types/rag.ts:1157](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1157) - Extract document title --- @@ -28,8 +24,6 @@ Extract document title > `optional` **summary?**: `boolean` \| [`SummaryExtractorConfig`](SummaryExtractorConfig.md) -Defined in: [types/rag.ts:1159](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1159) - Extract document summary --- @@ -38,8 +32,6 @@ Extract document summary > `optional` **keywords?**: `boolean` \| [`KeywordExtractorConfig`](KeywordExtractorConfig.md) -Defined in: [types/rag.ts:1161](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1161) - Extract keywords --- @@ -48,8 +40,6 @@ Extract keywords > `optional` **questions?**: `boolean` \| [`QuestionExtractorConfig`](QuestionExtractorConfig.md) -Defined in: [types/rag.ts:1163](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1163) - Generate Q&A pairs --- @@ -58,6 +48,4 @@ Generate Q&A pairs > `optional` **custom?**: [`CustomSchemaExtractorConfig`](CustomSchemaExtractorConfig.md) -Defined in: [types/rag.ts:1165](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1165) - Custom schema extraction diff --git a/docs/api/type-aliases/ExtractionResult.md b/docs/api/type-aliases/ExtractionResult.md index f3daeca67..efeedd0af 100644 --- a/docs/api/type-aliases/ExtractionResult.md +++ b/docs/api/type-aliases/ExtractionResult.md @@ -8,8 +8,6 @@ > **ExtractionResult** = `object` -Defined in: [types/rag.ts:1171](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1171) - Extraction result for a single chunk ## Properties @@ -18,8 +16,6 @@ Extraction result for a single chunk > `optional` **title?**: `string` -Defined in: [types/rag.ts:1173](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1173) - Extracted title --- @@ -28,8 +24,6 @@ Extracted title > `optional` **summary?**: `string` -Defined in: [types/rag.ts:1175](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1175) - Extracted summary --- @@ -38,8 +32,6 @@ Extracted summary > `optional` **keywords?**: `string`[] -Defined in: [types/rag.ts:1177](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1177) - Extracted keywords --- @@ -48,8 +40,6 @@ Extracted keywords > `optional` **questions?**: `object`[] -Defined in: [types/rag.ts:1179](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1179) - Generated Q&A pairs #### question @@ -66,6 +56,4 @@ Generated Q&A pairs > `optional` **custom?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1181](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1181) - Custom schema extraction result diff --git a/docs/api/type-aliases/ExtractorType.md b/docs/api/type-aliases/ExtractorType.md index 9a4816404..2f41a6363 100644 --- a/docs/api/type-aliases/ExtractorType.md +++ b/docs/api/type-aliases/ExtractorType.md @@ -8,6 +8,4 @@ > **ExtractorType** = `"title"` \| `"summary"` \| `"keywords"` \| `"questions"` \| `"custom"` -Defined in: [types/rag.ts:1075](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1075) - Metadata extraction types diff --git a/docs/api/type-aliases/FactoryEnhancedProvider.md b/docs/api/type-aliases/FactoryEnhancedProvider.md index 63246ebeb..1e08d30db 100644 --- a/docs/api/type-aliases/FactoryEnhancedProvider.md +++ b/docs/api/type-aliases/FactoryEnhancedProvider.md @@ -8,8 +8,6 @@ > **FactoryEnhancedProvider** = [`EnhancedProvider`](EnhancedProvider.md) & `object` -Defined in: [types/generate.ts:1283](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1283) - Factory-enhanced provider type Supports domain configuration and streaming optimizations diff --git a/docs/api/type-aliases/FactoryFunction.md b/docs/api/type-aliases/FactoryFunction.md index 053ffe47a..35da7797d 100644 --- a/docs/api/type-aliases/FactoryFunction.md +++ b/docs/api/type-aliases/FactoryFunction.md @@ -8,8 +8,6 @@ > **FactoryFunction**\<`TInstance`, `TConfig`\> = (`config?`) => `Promise`\<`TInstance`\> -Defined in: [types/common.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L436) - Factory function type for creating instances. ## Type Parameters diff --git a/docs/api/type-aliases/FactoryRegistration.md b/docs/api/type-aliases/FactoryRegistration.md index dcbc78430..cf1a5923a 100644 --- a/docs/api/type-aliases/FactoryRegistration.md +++ b/docs/api/type-aliases/FactoryRegistration.md @@ -8,8 +8,6 @@ > **FactoryRegistration**\<`TInstance`, `TConfig`\> = `object` -Defined in: [types/common.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L441) - Factory registration entry. ## Type Parameters @@ -28,20 +26,14 @@ Factory registration entry. > **factory**: [`FactoryFunction`](FactoryFunction.md)\<`TInstance`, `TConfig`\> -Defined in: [types/common.ts:442](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L442) - --- ### aliases > **aliases**: `string`[] -Defined in: [types/common.ts:443](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L443) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/common.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L444) diff --git a/docs/api/type-aliases/FailedFileInfo.md b/docs/api/type-aliases/FailedFileInfo.md index 05d418be9..86f95d942 100644 --- a/docs/api/type-aliases/FailedFileInfo.md +++ b/docs/api/type-aliases/FailedFileInfo.md @@ -8,8 +8,6 @@ > **FailedFileInfo** = `object` -Defined in: [types/processor.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L240) - Information about a file that failed to process. ## Properties @@ -18,8 +16,6 @@ Information about a file that failed to process. > **fileId**: `string` -Defined in: [types/processor.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L242) - File identifier --- @@ -28,8 +24,6 @@ File identifier > **filename**: `string` -Defined in: [types/processor.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L244) - Filename --- @@ -38,8 +32,6 @@ Filename > **mimetype**: `string` -Defined in: [types/processor.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L246) - MIME type --- @@ -48,8 +40,6 @@ MIME type > **size**: `number` -Defined in: [types/processor.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L248) - Size in bytes --- @@ -58,6 +48,4 @@ Size in bytes > **error**: [`FileProcessingError`](FileProcessingError.md) -Defined in: [types/processor.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L250) - Error that caused the failure diff --git a/docs/api/type-aliases/FallbackConfig.md b/docs/api/type-aliases/FallbackConfig.md index a8ea74e61..fbc743d88 100644 --- a/docs/api/type-aliases/FallbackConfig.md +++ b/docs/api/type-aliases/FallbackConfig.md @@ -8,8 +8,6 @@ > **FallbackConfig** = `object` -Defined in: [types/config.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L356) - Fallback configuration ## Properties @@ -18,52 +16,38 @@ Fallback configuration > `optional` **enabled?**: `boolean` -Defined in: [types/config.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L357) - --- ### maxAttempts? > `optional` **maxAttempts?**: `number` -Defined in: [types/config.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L358) - --- ### delayMs? > `optional` **delayMs?**: `number` -Defined in: [types/config.ts:359](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L359) - --- ### circuitBreaker? > `optional` **circuitBreaker?**: `boolean` -Defined in: [types/config.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L360) - --- ### commonResponses? > `optional` **commonResponses?**: `Record`\<`string`, `string`\> -Defined in: [types/config.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L361) - --- ### localFallbackPath? > `optional` **localFallbackPath?**: `string` -Defined in: [types/config.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L362) - --- ### degradedMode? > `optional` **degradedMode?**: `boolean` - -Defined in: [types/config.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L363) diff --git a/docs/api/type-aliases/FallbackEntry.md b/docs/api/type-aliases/FallbackEntry.md index 63e8e831c..af08558cb 100644 --- a/docs/api/type-aliases/FallbackEntry.md +++ b/docs/api/type-aliases/FallbackEntry.md @@ -8,8 +8,6 @@ > **FallbackEntry** = `object` -Defined in: [types/subscription.ts:1193](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1193) - A fallback chain entry ## Properties @@ -18,22 +16,16 @@ A fallback chain entry > **provider**: `string` -Defined in: [types/subscription.ts:1194](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1194) - --- ### model > **model**: `string` -Defined in: [types/subscription.ts:1195](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1195) - --- ### reasoningEffort? > `optional` **reasoningEffort?**: [`CodexReasoningEffort`](CodexReasoningEffort.md) -Defined in: [types/subscription.ts:1197](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1197) - Explicit Codex fallback effort. Omit to use the upstream default. diff --git a/docs/api/type-aliases/FallbackInfo.md b/docs/api/type-aliases/FallbackInfo.md index 99ecafcad..bbc5df0e7 100644 --- a/docs/api/type-aliases/FallbackInfo.md +++ b/docs/api/type-aliases/FallbackInfo.md @@ -8,8 +8,6 @@ > **FallbackInfo** = `object` -Defined in: [types/cli.ts:1004](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1004) - A fallback chain entry (serialisable subset of FallbackEntry) ## Properties @@ -18,12 +16,8 @@ A fallback chain entry (serialisable subset of FallbackEntry) > **provider**: `string` -Defined in: [types/cli.ts:1004](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1004) - --- ### model > **model**: `string` - -Defined in: [types/cli.ts:1004](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1004) diff --git a/docs/api/type-aliases/FallbackOptions.md b/docs/api/type-aliases/FallbackOptions.md index 2bd8d60fd..dd6055894 100644 --- a/docs/api/type-aliases/FallbackOptions.md +++ b/docs/api/type-aliases/FallbackOptions.md @@ -8,8 +8,6 @@ > **FallbackOptions** = `object` -Defined in: [types/tools.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L108) - Fallback configuration options Moved from src/lib/mcp/contracts/mcpContract.ts @@ -19,28 +17,20 @@ Moved from src/lib/mcp/contracts/mcpContract.ts > `optional` **enabled?**: `boolean` -Defined in: [types/tools.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L109) - --- ### maxAttempts? > `optional` **maxAttempts?**: `number` -Defined in: [types/tools.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L110) - --- ### delayMs? > `optional` **delayMs?**: `number` -Defined in: [types/tools.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L111) - --- ### circuitBreaker? > `optional` **circuitBreaker?**: `boolean` - -Defined in: [types/tools.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L112) diff --git a/docs/api/type-aliases/FastifyRateLimitContext.md b/docs/api/type-aliases/FastifyRateLimitContext.md index c4a6fb630..138bedeb7 100644 --- a/docs/api/type-aliases/FastifyRateLimitContext.md +++ b/docs/api/type-aliases/FastifyRateLimitContext.md @@ -8,8 +8,6 @@ > **FastifyRateLimitContext** = `object` -Defined in: [types/proxy.ts:2061](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2061) - Rate limit context (Fastify adapter). ## Properties @@ -18,12 +16,8 @@ Rate limit context (Fastify adapter). > **ttl**: `number` -Defined in: [types/proxy.ts:2062](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2062) - --- ### ban? > `optional` **ban?**: `boolean` - -Defined in: [types/proxy.ts:2063](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2063) diff --git a/docs/api/type-aliases/FeatureConfig.md b/docs/api/type-aliases/FeatureConfig.md index d8e61369a..76e74a692 100644 --- a/docs/api/type-aliases/FeatureConfig.md +++ b/docs/api/type-aliases/FeatureConfig.md @@ -8,8 +8,6 @@ > **FeatureConfig** = [`BooleanRecord`](BooleanRecord.md) & `object` -Defined in: [types/aliases.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L322) - Feature flag configuration Common structure for feature toggles diff --git a/docs/api/type-aliases/FeatureItem.md b/docs/api/type-aliases/FeatureItem.md index 84931f9ba..30a43f95c 100644 --- a/docs/api/type-aliases/FeatureItem.md +++ b/docs/api/type-aliases/FeatureItem.md @@ -8,8 +8,6 @@ > **FeatureItem** = `object` -Defined in: [types/ppt.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L401) - Feature item for features slides Maps to: addImage/addShape (icon) + addText @@ -19,24 +17,18 @@ Maps to: addImage/addShape (icon) + addText > **title**: `string` -Defined in: [types/ppt.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L402) - --- ### description > **description**: `string` -Defined in: [types/ppt.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L403) - --- ### icon? > `optional` **icon?**: `string` -Defined in: [types/ppt.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L405) - Icon code (Unicode) or image prompt --- @@ -45,6 +37,4 @@ Icon code (Unicode) or image prompt > `optional` **iconPrompt?**: `string` -Defined in: [types/ppt.ts:407](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L407) - Image prompt if using AI-generated icon diff --git a/docs/api/type-aliases/FfprobeData.md b/docs/api/type-aliases/FfprobeData.md index de4d7a7d9..6bd34192d 100644 --- a/docs/api/type-aliases/FfprobeData.md +++ b/docs/api/type-aliases/FfprobeData.md @@ -8,24 +8,18 @@ > **FfprobeData** = `object` -Defined in: [types/processor.ts:675](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L675) - ## Properties ### streams > **streams**: [`FfprobeStream`](FfprobeStream.md)[] -Defined in: [types/processor.ts:676](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L676) - --- ### format > **format**: `object` -Defined in: [types/processor.ts:677](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L677) - #### Index Signature \[`key`: `string`\]: `unknown` diff --git a/docs/api/type-aliases/FfprobeStream.md b/docs/api/type-aliases/FfprobeStream.md index 8f12987e0..b14bf5667 100644 --- a/docs/api/type-aliases/FfprobeStream.md +++ b/docs/api/type-aliases/FfprobeStream.md @@ -8,8 +8,6 @@ > **FfprobeStream** = `object` -Defined in: [types/processor.ts:661](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L661) - Structural types for fluent-ffmpeg probe data. Defined here so the optional fluent-ffmpeg package is not required at typecheck time. @@ -23,76 +21,56 @@ Defined here so the optional fluent-ffmpeg package is not required at typecheck > `optional` **codec_type?**: `string` -Defined in: [types/processor.ts:662](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L662) - --- ### codec_name? > `optional` **codec_name?**: `string` -Defined in: [types/processor.ts:663](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L663) - --- ### width? > `optional` **width?**: `number` -Defined in: [types/processor.ts:664](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L664) - --- ### height? > `optional` **height?**: `number` -Defined in: [types/processor.ts:665](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L665) - --- ### r_frame_rate? > `optional` **r_frame_rate?**: `string` -Defined in: [types/processor.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L666) - --- ### avg_frame_rate? > `optional` **avg_frame_rate?**: `string` -Defined in: [types/processor.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L667) - --- ### bit_rate? > `optional` **bit_rate?**: `number` \| `string` -Defined in: [types/processor.ts:668](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L668) - --- ### channels? > `optional` **channels?**: `number` -Defined in: [types/processor.ts:669](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L669) - --- ### sample_rate? > `optional` **sample_rate?**: `number` \| `string` -Defined in: [types/processor.ts:670](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L670) - --- ### tags? > `optional` **tags?**: `Record`\<`string`, `string` \| `number`\> - -Defined in: [types/processor.ts:671](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L671) diff --git a/docs/api/type-aliases/FileDetectionResult.md b/docs/api/type-aliases/FileDetectionResult.md index c83127b10..e9f8fde8e 100644 --- a/docs/api/type-aliases/FileDetectionResult.md +++ b/docs/api/type-aliases/FileDetectionResult.md @@ -8,8 +8,6 @@ > **FileDetectionResult** = `object` -Defined in: [types/file.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L294) - File detection result with confidence scoring ## Properties @@ -18,40 +16,30 @@ File detection result with confidence scoring > **type**: [`FileType`](FileType.md) -Defined in: [types/file.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L295) - --- ### mimeType > **mimeType**: `string` -Defined in: [types/file.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L296) - --- ### extension > **extension**: `string` \| `null` -Defined in: [types/file.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L297) - --- ### source > **source**: [`FileSource`](FileSource.md) -Defined in: [types/file.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L298) - --- ### metadata > **metadata**: `object` -Defined in: [types/file.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L299) - #### size? > `optional` **size?**: `number` diff --git a/docs/api/type-aliases/FileDetectorOptions.md b/docs/api/type-aliases/FileDetectorOptions.md index 3b26d2291..586929893 100644 --- a/docs/api/type-aliases/FileDetectorOptions.md +++ b/docs/api/type-aliases/FileDetectorOptions.md @@ -8,8 +8,6 @@ > **FileDetectorOptions** = `object` -Defined in: [types/file.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L667) - File detector options ## Properties @@ -18,32 +16,24 @@ File detector options > `optional` **maxSize?**: `number` -Defined in: [types/file.ts:668](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L668) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/file.ts:669](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L669) - --- ### allowedTypes? > `optional` **allowedTypes?**: [`FileType`](FileType.md)[] -Defined in: [types/file.ts:670](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L670) - --- ### allowedBaseDir? > `optional` **allowedBaseDir?**: `string` -Defined in: [types/file.ts:680](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L680) - When set, local file paths must resolve inside this base directory; anything that escapes it (absolute path, `../` traversal, or a symlink pointing outside) is rejected. Containment is enforced on the real, @@ -58,56 +48,42 @@ filesystem access; SDK callers loading their own files can omit it. > `optional` **audioOptions?**: [`AudioProcessorOptions`](AudioProcessorOptions.md) -Defined in: [types/file.ts:681](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L681) - --- ### csvOptions? > `optional` **csvOptions?**: [`CSVProcessorOptions`](CSVProcessorOptions.md) -Defined in: [types/file.ts:682](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L682) - --- ### officeOptions? > `optional` **officeOptions?**: [`OfficeProcessorOptions`](OfficeProcessorOptions.md) -Defined in: [types/file.ts:683](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L683) - --- ### videoOptions? > `optional` **videoOptions?**: [`VideoProcessorOptions`](VideoProcessorOptions.md) -Defined in: [types/file.ts:684](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L684) - --- ### confidenceThreshold? > `optional` **confidenceThreshold?**: `number` -Defined in: [types/file.ts:685](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L685) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/file.ts:686](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L686) - --- ### maxRetries? > `optional` **maxRetries?**: `number` -Defined in: [types/file.ts:688](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L688) - Maximum number of retry attempts for network requests (default: 3) --- @@ -116,8 +92,6 @@ Maximum number of retry attempts for network requests (default: 3) > `optional` **retryDelay?**: `number` -Defined in: [types/file.ts:690](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L690) - Initial retry delay in milliseconds with exponential backoff (default: 1000) --- @@ -126,8 +100,6 @@ Initial retry delay in milliseconds with exponential backoff (default: 1000) > `optional` **mimetypeHint?**: `string` -Defined in: [types/file.ts:700](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L700) - Caller-provided MIME type hint (e.g. "text/plain", "application/json"). Used when the filename has no extension and magic-byte detection cannot identify the content — the common Slack/Curator extension-less-buffer @@ -142,8 +114,6 @@ hint (the lazy FileReferenceRegistry path has its own hint-handling). > `optional` **filenameHint?**: `string` -Defined in: [types/file.ts:711](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L711) - Caller-provided filename hint, the companion to [mimetypeHint](#mimetypehint). The unified file path unwraps a `FileWithMetadata` to its `buffer` before diff --git a/docs/api/type-aliases/FileElicitation.md b/docs/api/type-aliases/FileElicitation.md index ff69cd46e..b8bad9a19 100644 --- a/docs/api/type-aliases/FileElicitation.md +++ b/docs/api/type-aliases/FileElicitation.md @@ -8,8 +8,6 @@ > **FileElicitation** = [`ElicitationRequest`](ElicitationRequest.md) & `object` -Defined in: [types/elicitation.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L177) - File elicitation ## Type Declaration diff --git a/docs/api/type-aliases/FileExtractionParams.md b/docs/api/type-aliases/FileExtractionParams.md index f588a43db..9c321fa36 100644 --- a/docs/api/type-aliases/FileExtractionParams.md +++ b/docs/api/type-aliases/FileExtractionParams.md @@ -8,8 +8,6 @@ > **FileExtractionParams** = `object` -Defined in: [types/fileReference.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L195) - Parameters for targeted content extraction via extract_file_content tool. Different file types use different subsets of these parameters. @@ -19,8 +17,6 @@ Different file types use different subsets of these parameters. > **file_id**: `string` -Defined in: [types/fileReference.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L197) - File ID (UUID) or filename --- @@ -29,8 +25,6 @@ File ID (UUID) or filename > `optional` **start_time?**: `number` -Defined in: [types/fileReference.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L201) - Start timestamp in seconds (video) --- @@ -39,8 +33,6 @@ Start timestamp in seconds (video) > `optional` **end_time?**: `number` -Defined in: [types/fileReference.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L203) - End timestamp in seconds (video) --- @@ -49,8 +41,6 @@ End timestamp in seconds (video) > `optional` **frame_count?**: `number` -Defined in: [types/fileReference.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L205) - Number of frames to extract in range (video, default: 5) --- @@ -59,8 +49,6 @@ Number of frames to extract in range (video, default: 5) > `optional` **pages?**: `number`[] -Defined in: [types/fileReference.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L209) - Specific page/slide numbers (1-indexed) --- @@ -69,8 +57,6 @@ Specific page/slide numbers (1-indexed) > `optional` **page_range?**: `object` -Defined in: [types/fileReference.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L211) - Page range (1-indexed, inclusive) #### start @@ -87,8 +73,6 @@ Page range (1-indexed, inclusive) > `optional` **sheet?**: `string` \| `number` -Defined in: [types/fileReference.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L215) - Sheet name or 0-based index --- @@ -97,8 +81,6 @@ Sheet name or 0-based index > `optional` **row_range?**: `object` -Defined in: [types/fileReference.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L217) - Row range (1-indexed) #### start @@ -115,8 +97,6 @@ Row range (1-indexed) > `optional` **columns?**: `string`[] -Defined in: [types/fileReference.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L219) - Specific columns (e.g., ["A", "B", "D"]) --- @@ -125,8 +105,6 @@ Specific columns (e.g., ["A", "B", "D"]) > `optional` **entry_path?**: `string` -Defined in: [types/fileReference.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L223) - File path within the archive --- @@ -135,6 +113,4 @@ File path within the archive > `optional` **format?**: `"text"` \| `"detailed"` \| `"summary"` -Defined in: [types/fileReference.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L227) - Output format hint diff --git a/docs/api/type-aliases/FileExtractionResult.md b/docs/api/type-aliases/FileExtractionResult.md index 65f2889d1..9bb7601e8 100644 --- a/docs/api/type-aliases/FileExtractionResult.md +++ b/docs/api/type-aliases/FileExtractionResult.md @@ -8,8 +8,6 @@ > **FileExtractionResult** = `object` -Defined in: [types/fileReference.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L234) - Result of targeted content extraction. May contain text, images, or both depending on the extraction type. @@ -19,8 +17,6 @@ May contain text, images, or both depending on the extraction type. > **success**: `boolean` -Defined in: [types/fileReference.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L236) - Whether the extraction succeeded --- @@ -29,8 +25,6 @@ Whether the extraction succeeded > `optional` **text?**: `string` -Defined in: [types/fileReference.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L238) - Extracted text content --- @@ -39,8 +33,6 @@ Extracted text content > `optional` **images?**: `Buffer`[] -Defined in: [types/fileReference.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L240) - Extracted images as JPEG buffers (e.g., video frames, slide renders) --- @@ -49,8 +41,6 @@ Extracted images as JPEG buffers (e.g., video frames, slide renders) > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/fileReference.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L242) - Metadata about the extraction --- @@ -59,6 +49,4 @@ Metadata about the extraction > `optional` **error?**: `string` -Defined in: [types/fileReference.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L244) - Error message if extraction failed diff --git a/docs/api/type-aliases/FileForSummarization.md b/docs/api/type-aliases/FileForSummarization.md index cf2a0bd5b..5e5a68dfa 100644 --- a/docs/api/type-aliases/FileForSummarization.md +++ b/docs/api/type-aliases/FileForSummarization.md @@ -8,8 +8,6 @@ > **FileForSummarization** = `object` -Defined in: [types/context.ts:677](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L677) - A file prepared for potential summarization. ## Properties @@ -18,8 +16,6 @@ A file prepared for potential summarization. > **fileName**: `string` -Defined in: [types/context.ts:679](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L679) - Display name (e.g. "report.pdf") --- @@ -28,8 +24,6 @@ Display name (e.g. "report.pdf") > **fileType**: `string` -Defined in: [types/context.ts:681](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L681) - Human-readable type label (e.g. "PDF Document") --- @@ -38,8 +32,6 @@ Human-readable type label (e.g. "PDF Document") > **content**: `string` -Defined in: [types/context.ts:683](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L683) - Extracted text content --- @@ -48,8 +40,6 @@ Extracted text content > **estimatedTokens**: `number` -Defined in: [types/context.ts:685](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L685) - Estimated token count (provider-adjusted) --- @@ -58,8 +48,6 @@ Estimated token count (provider-adjusted) > `optional` **mimeType?**: `string` -Defined in: [types/context.ts:687](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L687) - Optional MIME type --- @@ -68,6 +56,4 @@ Optional MIME type > `optional` **originalSize?**: `number` -Defined in: [types/context.ts:689](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L689) - Original byte size on disk diff --git a/docs/api/type-aliases/FileFormatEntry.md b/docs/api/type-aliases/FileFormatEntry.md index 351ea3faa..5c1fb8918 100644 --- a/docs/api/type-aliases/FileFormatEntry.md +++ b/docs/api/type-aliases/FileFormatEntry.md @@ -8,8 +8,6 @@ > **FileFormatEntry** = `object` -Defined in: [types/file.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L248) - One format in the canonical file-type registry. `extensions[0]` and `mimeTypes[0]` are canonical; the remaining entries are @@ -21,8 +19,6 @@ aliases accepted on input. See `processors/config/fileTypeRegistry.ts`. > `readonly` **label**: `string` -Defined in: [types/file.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L250) - Human-readable format name, used in registry-conflict errors. --- @@ -31,8 +27,6 @@ Human-readable format name, used in registry-conflict errors. > `readonly` **extensions**: readonly `string`[] -Defined in: [types/file.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L252) - Extensions with leading dots, lowercase; first is canonical. --- @@ -41,8 +35,6 @@ Extensions with leading dots, lowercase; first is canonical. > `readonly` **mimeTypes**: readonly `string`[] -Defined in: [types/file.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L254) - MIME types, lowercase; first is canonical. --- @@ -51,8 +43,6 @@ MIME types, lowercase; first is canonical. > `readonly` **fileType**: [`FileType`](FileType.md) -Defined in: [types/file.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L256) - Routing type the detector emits for this format. --- @@ -61,6 +51,4 @@ Routing type the detector emits for this format. > `readonly` **modality**: [`FileModality`](FileModality.md) -Defined in: [types/file.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L258) - Category a human would put this format in. diff --git a/docs/api/type-aliases/FileInfo.md b/docs/api/type-aliases/FileInfo.md index 96831c23a..bde005dff 100644 --- a/docs/api/type-aliases/FileInfo.md +++ b/docs/api/type-aliases/FileInfo.md @@ -8,8 +8,6 @@ > **FileInfo** = `object` -Defined in: [types/processor.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L31) - Generic file information - provider agnostic. Replaces Slack-specific SlackFileInfo with a universal interface. @@ -31,8 +29,6 @@ const fileInfo: FileInfo = { > **id**: `string` -Defined in: [types/processor.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L33) - Unique identifier for the file --- @@ -41,8 +37,6 @@ Unique identifier for the file > **name**: `string` -Defined in: [types/processor.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L35) - Original filename --- @@ -51,8 +45,6 @@ Original filename > **mimetype**: `string` -Defined in: [types/processor.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L37) - MIME type of the file --- @@ -61,8 +53,6 @@ MIME type of the file > **size**: `number` -Defined in: [types/processor.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L39) - File size in bytes --- @@ -71,8 +61,6 @@ File size in bytes > `optional` **url?**: `string` -Defined in: [types/processor.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L41) - Download URL (optional - use when file needs to be fetched) --- @@ -81,8 +69,6 @@ Download URL (optional - use when file needs to be fetched) > `optional` **buffer?**: `Buffer` -Defined in: [types/processor.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L43) - Direct file content (optional - use when file is already in memory) --- @@ -91,6 +77,4 @@ Direct file content (optional - use when file is already in memory) > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/processor.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L45) - Extensibility - additional provider-specific metadata diff --git a/docs/api/type-aliases/FileInput.md b/docs/api/type-aliases/FileInput.md index 8e1714fdc..8b198fc0c 100644 --- a/docs/api/type-aliases/FileInput.md +++ b/docs/api/type-aliases/FileInput.md @@ -8,6 +8,4 @@ > **FileInput** = `Buffer` \| `string` \| [`FileWithMetadata`](FileWithMetadata.md) -Defined in: [types/file.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L284) - File input can be Buffer, string (path/URL/data URI), or an object with metadata. diff --git a/docs/api/type-aliases/FileModality.md b/docs/api/type-aliases/FileModality.md index d7a1a46ac..ef39f2d79 100644 --- a/docs/api/type-aliases/FileModality.md +++ b/docs/api/type-aliases/FileModality.md @@ -8,8 +8,6 @@ > **FileModality** = `"image"` \| `"audio"` \| `"video"` \| `"document"` \| `"data"` \| `"archive"` -Defined in: [types/file.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L234) - Broad category a file format belongs to, as a human would name it. Distinct from [FileType](FileType.md), which is the _routing_ type the detector diff --git a/docs/api/type-aliases/FilePart.md b/docs/api/type-aliases/FilePart.md index 99eefe95c..f0ac6a963 100644 --- a/docs/api/type-aliases/FilePart.md +++ b/docs/api/type-aliases/FilePart.md @@ -8,44 +8,32 @@ > **FilePart** = `object` -Defined in: [types/aiCompat.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L218) - ## Properties ### type > **type**: `"file"` -Defined in: [types/aiCompat.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L219) - --- ### data > **data**: [`DataContent`](DataContent.md) \| `URL` -Defined in: [types/aiCompat.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L220) - --- ### filename? > `optional` **filename?**: `string` -Defined in: [types/aiCompat.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L221) - --- ### mediaType > **mediaType**: `string` -Defined in: [types/aiCompat.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L222) - --- ### providerOptions? > `optional` **providerOptions?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\> - -Defined in: [types/aiCompat.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L223) diff --git a/docs/api/type-aliases/FileProcessingError.md b/docs/api/type-aliases/FileProcessingError.md index 947b0f17b..c830d46a4 100644 --- a/docs/api/type-aliases/FileProcessingError.md +++ b/docs/api/type-aliases/FileProcessingError.md @@ -8,8 +8,6 @@ > **FileProcessingError** = `object` -Defined in: [types/processor.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L98) - Structured file processing error with user-friendly messaging. This is the canonical error type used across all processor infrastructure. @@ -19,8 +17,6 @@ This is the canonical error type used across all processor infrastructure. > **code**: [`FileErrorCode`](../enumerations/FileErrorCode.md) \| `string` -Defined in: [types/processor.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L100) - Error code from FileErrorCode enum --- @@ -29,8 +25,6 @@ Error code from FileErrorCode enum > **message**: `string` -Defined in: [types/processor.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L102) - Technical error message --- @@ -39,8 +33,6 @@ Technical error message > **userMessage**: `string` -Defined in: [types/processor.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L104) - User-friendly error message --- @@ -49,8 +41,6 @@ User-friendly error message > `optional` **suggestedAction?**: `string` -Defined in: [types/processor.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L106) - Suggested action to resolve the error --- @@ -59,8 +49,6 @@ Suggested action to resolve the error > `optional` **retryable?**: `boolean` -Defined in: [types/processor.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L108) - Whether this error is potentially retryable --- @@ -69,8 +57,6 @@ Whether this error is potentially retryable > `optional` **details?**: `Record`\<`string`, `unknown`\> -Defined in: [types/processor.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L110) - Additional context/details about the error --- @@ -79,8 +65,6 @@ Additional context/details about the error > `optional` **technicalDetails?**: `string` -Defined in: [types/processor.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L112) - Technical details (usually from original error) --- @@ -89,6 +73,4 @@ Technical details (usually from original error) > `optional` **originalError?**: `Error` -Defined in: [types/processor.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L114) - Original error that caused this failure diff --git a/docs/api/type-aliases/FileProcessingOptions.md b/docs/api/type-aliases/FileProcessingOptions.md index 4f5cfcc6d..d1379aa57 100644 --- a/docs/api/type-aliases/FileProcessingOptions.md +++ b/docs/api/type-aliases/FileProcessingOptions.md @@ -8,8 +8,6 @@ > **FileProcessingOptions** = [`ProcessOptions`](ProcessOptions.md) & `object` -Defined in: [types/processor.ts:1059](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1059) - Options for processing files through the registry. Extends base ProcessOptions with registry-specific options. diff --git a/docs/api/type-aliases/FileProcessingResult.md b/docs/api/type-aliases/FileProcessingResult.md index 2d8d7ca84..7834fd8d0 100644 --- a/docs/api/type-aliases/FileProcessingResult.md +++ b/docs/api/type-aliases/FileProcessingResult.md @@ -8,8 +8,6 @@ > **FileProcessingResult** = `object` -Defined in: [types/file.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L309) - File processing result after detection and conversion ## Properties @@ -18,32 +16,24 @@ File processing result after detection and conversion > **type**: [`FileType`](FileType.md) -Defined in: [types/file.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L310) - --- ### content > **content**: `string` \| `Buffer` -Defined in: [types/file.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L311) - --- ### mimeType > **mimeType**: `string` -Defined in: [types/file.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L312) - --- ### images? > `optional` **images?**: (`Buffer` \| `string`)[] -Defined in: [types/file.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L314) - Additional images extracted from the file (e.g., video keyframes, audio cover art) --- @@ -52,8 +42,6 @@ Additional images extracted from the file (e.g., video keyframes, audio cover ar > **metadata**: `object` -Defined in: [types/file.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L315) - #### confidence > **confidence**: `number` diff --git a/docs/api/type-aliases/FileProcessingSummary.md b/docs/api/type-aliases/FileProcessingSummary.md index 2a0459a5a..142e5de52 100644 --- a/docs/api/type-aliases/FileProcessingSummary.md +++ b/docs/api/type-aliases/FileProcessingSummary.md @@ -8,8 +8,6 @@ > **FileProcessingSummary** = `object` -Defined in: [types/processor.ts:1131](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1131) - Summary of file processing operations. ## Properties @@ -18,16 +16,12 @@ Summary of file processing operations. > **totalFiles**: `number` -Defined in: [types/processor.ts:1132](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1132) - --- ### processedFiles > **processedFiles**: `object`[] -Defined in: [types/processor.ts:1133](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1133) - #### filename > **filename**: `string` @@ -46,8 +40,6 @@ Defined in: [types/processor.ts:1133](https://github.com/juspay/neurolink/blob/r > **failedFiles**: `object`[] -Defined in: [types/processor.ts:1138](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1138) - #### filename > **filename**: `string` @@ -62,8 +54,6 @@ Defined in: [types/processor.ts:1138](https://github.com/juspay/neurolink/blob/r > **skippedFiles**: `object`[] -Defined in: [types/processor.ts:1142](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1142) - #### filename > **filename**: `string` @@ -82,8 +72,6 @@ Defined in: [types/processor.ts:1142](https://github.com/juspay/neurolink/blob/r > **warnings**: `object`[] -Defined in: [types/processor.ts:1147](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1147) - #### filename > **filename**: `string` diff --git a/docs/api/type-aliases/FileProcessorConfig.md b/docs/api/type-aliases/FileProcessorConfig.md index 708014e4f..81581cd5a 100644 --- a/docs/api/type-aliases/FileProcessorConfig.md +++ b/docs/api/type-aliases/FileProcessorConfig.md @@ -8,8 +8,6 @@ > **FileProcessorConfig** = `object` -Defined in: [types/processor.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L56) - Configuration for file processors. Defines constraints and defaults for a specific file type processor. @@ -19,8 +17,6 @@ Defines constraints and defaults for a specific file type processor. > **maxSizeMB**: `number` -Defined in: [types/processor.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L58) - Maximum file size in megabytes --- @@ -29,8 +25,6 @@ Maximum file size in megabytes > **timeoutMs**: `number` -Defined in: [types/processor.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L60) - Download/processing timeout in milliseconds --- @@ -39,8 +33,6 @@ Download/processing timeout in milliseconds > **supportedMimeTypes**: `string`[] -Defined in: [types/processor.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L62) - List of supported MIME types --- @@ -49,8 +41,6 @@ List of supported MIME types > **supportedExtensions**: `string`[] -Defined in: [types/processor.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L64) - List of supported file extensions (with leading dot) --- @@ -59,8 +49,6 @@ List of supported file extensions (with leading dot) > **fileTypeName**: `string` -Defined in: [types/processor.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L66) - Human-readable name for this file type (e.g., 'image', 'PDF') --- @@ -69,6 +57,4 @@ Human-readable name for this file type (e.g., 'image', 'PDF') > **defaultFilename**: `string` -Defined in: [types/processor.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L68) - Default filename when original name is not available diff --git a/docs/api/type-aliases/FileReadResult.md b/docs/api/type-aliases/FileReadResult.md index b0e785c8e..52138b2fc 100644 --- a/docs/api/type-aliases/FileReadResult.md +++ b/docs/api/type-aliases/FileReadResult.md @@ -8,8 +8,6 @@ > **FileReadResult** = `object` -Defined in: [types/fileReference.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L134) - Result of reading a file section ## Properties @@ -18,8 +16,6 @@ Result of reading a file section > **content**: `string` -Defined in: [types/fileReference.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L136) - The content that was read --- @@ -28,8 +24,6 @@ The content that was read > **startLine**: `number` -Defined in: [types/fileReference.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L138) - Starting line number (1-indexed) --- @@ -38,8 +32,6 @@ Starting line number (1-indexed) > **endLine**: `number` -Defined in: [types/fileReference.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L140) - Ending line number (1-indexed) --- @@ -48,8 +40,6 @@ Ending line number (1-indexed) > **totalLines**: `number` -Defined in: [types/fileReference.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L142) - Total lines in the file --- @@ -58,8 +48,6 @@ Total lines in the file > **truncated**: `boolean` -Defined in: [types/fileReference.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L144) - Whether the content was truncated to fit token budget --- @@ -68,6 +56,4 @@ Whether the content was truncated to fit token budget > **estimatedTokens**: `number` -Defined in: [types/fileReference.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L146) - Number of tokens in the returned content diff --git a/docs/api/type-aliases/FileReference.md b/docs/api/type-aliases/FileReference.md index e54858802..b72b93c69 100644 --- a/docs/api/type-aliases/FileReference.md +++ b/docs/api/type-aliases/FileReference.md @@ -8,8 +8,6 @@ > **FileReference** = `object` -Defined in: [types/fileReference.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L63) - A lightweight reference to a file registered for on-demand processing. Registration is fast (~1ms): only stat + magic bytes + first 1KB preview. @@ -21,8 +19,6 @@ Full processing is deferred until the LLM requests it via tools. > **id**: `string` -Defined in: [types/fileReference.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L65) - Unique identifier (UUID v4) --- @@ -31,8 +27,6 @@ Unique identifier (UUID v4) > **source**: [`FileSource`](FileSource.md) -Defined in: [types/fileReference.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L67) - How the file was provided --- @@ -41,8 +35,6 @@ How the file was provided > `optional` **originalPath?**: `string` -Defined in: [types/fileReference.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L69) - Original file path or URL --- @@ -51,8 +43,6 @@ Original file path or URL > **filename**: `string` -Defined in: [types/fileReference.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L71) - Display name --- @@ -61,8 +51,6 @@ Display name > **sizeBytes**: `number` -Defined in: [types/fileReference.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L73) - Original file size in bytes --- @@ -71,8 +59,6 @@ Original file size in bytes > **detectedType**: [`FileType`](FileType.md) -Defined in: [types/fileReference.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L75) - Detected file type from magic bytes / extension --- @@ -81,8 +67,6 @@ Detected file type from magic bytes / extension > **mimeType**: `string` -Defined in: [types/fileReference.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L77) - Detected MIME type --- @@ -91,8 +75,6 @@ Detected MIME type > **sizeTier**: [`SizeTier`](SizeTier.md) -Defined in: [types/fileReference.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L79) - Size tier determining processing strategy --- @@ -101,8 +83,6 @@ Size tier determining processing strategy > **estimatedTokens**: `number` -Defined in: [types/fileReference.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L81) - Estimated tokens after processing (type-aware) --- @@ -111,8 +91,6 @@ Estimated tokens after processing (type-aware) > **preview**: `string` -Defined in: [types/fileReference.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L83) - First ~500 tokens of content (lightweight preview) --- @@ -121,8 +99,6 @@ First ~500 tokens of content (lightweight preview) > **status**: [`FileReferenceStatus`](FileReferenceStatus.md) -Defined in: [types/fileReference.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L85) - Current processing status --- @@ -131,8 +107,6 @@ Current processing status > `optional` **summary?**: `string` -Defined in: [types/fileReference.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L87) - LLM-generated summary (populated lazily via summarize_file tool) --- @@ -141,8 +115,6 @@ LLM-generated summary (populated lazily via summarize_file tool) > `optional` **outlineSections?**: [`OutlineSection`](OutlineSection.md)[] -Defined in: [types/fileReference.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L89) - Structural outline for code/docs (populated lazily) --- @@ -151,8 +123,6 @@ Structural outline for code/docs (populated lazily) > `optional` **tempPath?**: `string` -Defined in: [types/fileReference.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L91) - Path in temp directory where buffer is persisted --- @@ -161,8 +131,6 @@ Path in temp directory where buffer is persisted > `optional` **providerId?**: `string` -Defined in: [types/fileReference.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L93) - Provider file API ID (for Anthropic Files API, Gemini File API, etc.) --- @@ -171,8 +139,6 @@ Provider file API ID (for Anthropic Files API, Gemini File API, etc.) > `optional` **processedContent?**: `string` -Defined in: [types/fileReference.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L95) - Full processed content (cached after first full processing) --- @@ -181,8 +147,6 @@ Full processed content (cached after first full processing) > `optional` **extractedImages?**: `Buffer`[] -Defined in: [types/fileReference.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L97) - Extracted images (e.g., video keyframes, PPTX slide images) --- @@ -191,8 +155,6 @@ Extracted images (e.g., video keyframes, PPTX slide images) > **registeredAt**: `number` -Defined in: [types/fileReference.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L99) - Timestamp when the file was registered --- @@ -201,8 +163,6 @@ Timestamp when the file was registered > **lastAccessedAt**: `number` -Defined in: [types/fileReference.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L101) - Timestamp when the file was last accessed (for LRU eviction) --- @@ -211,8 +171,6 @@ Timestamp when the file was last accessed (for LRU eviction) > `optional` **totalLines?**: `number` -Defined in: [types/fileReference.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L103) - Total line count (for text files, populated on first read) --- @@ -221,6 +179,4 @@ Total line count (for text files, populated on first read) > `optional` **extension?**: `string` -Defined in: [types/fileReference.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L105) - File extension (e.g., 'py', 'xlsx', 'mp4') diff --git a/docs/api/type-aliases/FileReferenceStatus.md b/docs/api/type-aliases/FileReferenceStatus.md index 9cb3011aa..5d25f4efd 100644 --- a/docs/api/type-aliases/FileReferenceStatus.md +++ b/docs/api/type-aliases/FileReferenceStatus.md @@ -8,6 +8,4 @@ > **FileReferenceStatus** = `"registered"` \| `"previewed"` \| `"processing"` \| `"processed"` \| `"error"` -Defined in: [types/fileReference.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L32) - Processing status of a file reference diff --git a/docs/api/type-aliases/FileRegistrationOptions.md b/docs/api/type-aliases/FileRegistrationOptions.md index e77c68800..e2aa8ad5c 100644 --- a/docs/api/type-aliases/FileRegistrationOptions.md +++ b/docs/api/type-aliases/FileRegistrationOptions.md @@ -8,8 +8,6 @@ > **FileRegistrationOptions** = `object` -Defined in: [types/fileReference.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L111) - Options for registering a file ## Properties @@ -18,8 +16,6 @@ Options for registering a file > `optional` **filename?**: `string` -Defined in: [types/fileReference.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L113) - Override filename detection --- @@ -28,8 +24,6 @@ Override filename detection > `optional` **fileType?**: [`FileType`](FileType.md) -Defined in: [types/fileReference.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L115) - Override file type detection --- @@ -38,8 +32,6 @@ Override file type detection > `optional` **mimetype?**: `string` -Defined in: [types/fileReference.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L124) - Caller-provided MIME type hint (e.g. "text/plain", "application/json"). Used when the filename has no extension and magic-byte detection cannot identify the content (common for Slack/Curator-style buffers where the @@ -53,8 +45,6 @@ override still wins over this hint. > `optional` **maxPreviewChars?**: `number` -Defined in: [types/fileReference.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L126) - Maximum preview length in characters --- @@ -63,6 +53,4 @@ Maximum preview length in characters > `optional` **skipTempPersist?**: `boolean` -Defined in: [types/fileReference.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L128) - Skip persisting buffer to temp directory diff --git a/docs/api/type-aliases/FileRegistryOptions.md b/docs/api/type-aliases/FileRegistryOptions.md index f7b5bffd2..ccd88e0af 100644 --- a/docs/api/type-aliases/FileRegistryOptions.md +++ b/docs/api/type-aliases/FileRegistryOptions.md @@ -8,8 +8,6 @@ > **FileRegistryOptions** = `object` -Defined in: [types/fileReference.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L250) - Options for the file reference registry ## Properties @@ -18,8 +16,6 @@ Options for the file reference registry > `optional` **tempDir?**: `string` -Defined in: [types/fileReference.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L252) - Directory for persisting file buffers (default: os.tmpdir()/neurolink-files/) --- @@ -28,8 +24,6 @@ Directory for persisting file buffers (default: os.tmpdir()/neurolink-files/) > `optional` **maxFiles?**: `number` -Defined in: [types/fileReference.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L254) - Maximum number of file references to keep (LRU eviction, default: 100) --- @@ -38,8 +32,6 @@ Maximum number of file references to keep (LRU eviction, default: 100) > `optional` **maxTempBytes?**: `number` -Defined in: [types/fileReference.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L256) - Maximum total bytes to persist to temp (default: 1GB) --- @@ -48,6 +40,4 @@ Maximum total bytes to persist to temp (default: 1GB) > `optional` **defaultPreviewChars?**: `number` -Defined in: [types/fileReference.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L258) - Default preview length in characters (default: 2000) diff --git a/docs/api/type-aliases/FileSearchMatch.md b/docs/api/type-aliases/FileSearchMatch.md index 28f277a04..410aeb10f 100644 --- a/docs/api/type-aliases/FileSearchMatch.md +++ b/docs/api/type-aliases/FileSearchMatch.md @@ -8,8 +8,6 @@ > **FileSearchMatch** = `object` -Defined in: [types/fileReference.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L164) - A single search match within a file ## Properties @@ -18,8 +16,6 @@ A single search match within a file > **lineNumber**: `number` -Defined in: [types/fileReference.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L166) - Line number (1-indexed) --- @@ -28,8 +24,6 @@ Line number (1-indexed) > **line**: `string` -Defined in: [types/fileReference.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L168) - The matching line content --- @@ -38,8 +32,6 @@ The matching line content > **contextBefore**: `string`[] -Defined in: [types/fileReference.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L170) - Context lines before the match --- @@ -48,6 +40,4 @@ Context lines before the match > **contextAfter**: `string`[] -Defined in: [types/fileReference.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L172) - Context lines after the match diff --git a/docs/api/type-aliases/FileSearchResult.md b/docs/api/type-aliases/FileSearchResult.md index 20ef136e9..d8afac99d 100644 --- a/docs/api/type-aliases/FileSearchResult.md +++ b/docs/api/type-aliases/FileSearchResult.md @@ -8,8 +8,6 @@ > **FileSearchResult** = `object` -Defined in: [types/fileReference.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L152) - Result of searching within a file ## Properties @@ -18,8 +16,6 @@ Result of searching within a file > **matches**: [`FileSearchMatch`](FileSearchMatch.md)[] -Defined in: [types/fileReference.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L154) - Matching lines with context --- @@ -28,8 +24,6 @@ Matching lines with context > **totalMatches**: `number` -Defined in: [types/fileReference.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L156) - Total number of matches found --- @@ -38,6 +32,4 @@ Total number of matches found > **truncated**: `boolean` -Defined in: [types/fileReference.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L158) - Whether results were truncated diff --git a/docs/api/type-aliases/FileSource.md b/docs/api/type-aliases/FileSource.md index a3fcf3ff0..9f047a604 100644 --- a/docs/api/type-aliases/FileSource.md +++ b/docs/api/type-aliases/FileSource.md @@ -8,6 +8,4 @@ > **FileSource** = `"url"` \| `"path"` \| `"buffer"` \| `"datauri"` -Defined in: [types/file.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L289) - File source type for tracking input origin diff --git a/docs/api/type-aliases/FileSummarizationCheckParams.md b/docs/api/type-aliases/FileSummarizationCheckParams.md index 4d4322494..ff648acf8 100644 --- a/docs/api/type-aliases/FileSummarizationCheckParams.md +++ b/docs/api/type-aliases/FileSummarizationCheckParams.md @@ -8,8 +8,6 @@ > **FileSummarizationCheckParams** = `object` -Defined in: [types/context.ts:693](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L693) - Parameters for `shouldSummarizeFiles()`. ## Properties @@ -18,8 +16,6 @@ Parameters for `shouldSummarizeFiles()`. > **provider**: `string` -Defined in: [types/context.ts:695](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L695) - AI provider name (e.g. "vertex", "anthropic") --- @@ -28,8 +24,6 @@ AI provider name (e.g. "vertex", "anthropic") > `optional` **model?**: `string` -Defined in: [types/context.ts:697](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L697) - Model name (optional -- falls back to provider default) --- @@ -38,8 +32,6 @@ Model name (optional -- falls back to provider default) > **systemPromptTokens**: `number` -Defined in: [types/context.ts:699](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L699) - Token estimate for the system prompt --- @@ -48,8 +40,6 @@ Token estimate for the system prompt > **conversationHistoryTokens**: `number` -Defined in: [types/context.ts:701](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L701) - Token estimate for conversation history --- @@ -58,8 +48,6 @@ Token estimate for conversation history > **currentPromptTokens**: `number` -Defined in: [types/context.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L703) - Token estimate for the current user prompt --- @@ -68,8 +56,6 @@ Token estimate for the current user prompt > **toolDefinitionTokens**: `number` -Defined in: [types/context.ts:705](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L705) - Token estimate for tool definitions --- @@ -78,8 +64,6 @@ Token estimate for tool definitions > **fileTokens**: `number` -Defined in: [types/context.ts:707](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L707) - Token estimate for all attached files (sum) --- @@ -88,8 +72,6 @@ Token estimate for all attached files (sum) > `optional` **fileCount?**: `number` -Defined in: [types/context.ts:709](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L709) - Number of attached files --- @@ -98,8 +80,6 @@ Number of attached files > `optional` **maxTokens?**: `number` -Defined in: [types/context.ts:711](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L711) - Explicit maxTokens (output reserve) from user config --- @@ -108,8 +88,6 @@ Explicit maxTokens (output reserve) from user config > `optional` **threshold?**: `number` -Defined in: [types/context.ts:713](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L713) - Context usage fraction that triggers summarization (0.0-1.0, default 0.80) --- @@ -118,8 +96,6 @@ Context usage fraction that triggers summarization (0.0-1.0, default 0.80) > `optional` **minTokensPerFile?**: `number` -Defined in: [types/context.ts:715](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L715) - Minimum tokens per file in the summarization plan --- @@ -128,6 +104,4 @@ Minimum tokens per file in the summarization plan > `optional` **maxTokensPerFile?**: `number` -Defined in: [types/context.ts:717](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L717) - Maximum tokens per file in the summarization plan diff --git a/docs/api/type-aliases/FileSummarizationCheckResult.md b/docs/api/type-aliases/FileSummarizationCheckResult.md index 80154f265..14478fd76 100644 --- a/docs/api/type-aliases/FileSummarizationCheckResult.md +++ b/docs/api/type-aliases/FileSummarizationCheckResult.md @@ -8,8 +8,6 @@ > **FileSummarizationCheckResult** = `object` -Defined in: [types/context.ts:721](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L721) - Result of `shouldSummarizeFiles()`. ## Properties @@ -18,8 +16,6 @@ Result of `shouldSummarizeFiles()`. > **needsSummarization**: `boolean` -Defined in: [types/context.ts:723](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L723) - Whether summarization is needed --- @@ -28,8 +24,6 @@ Whether summarization is needed > **totalEstimatedTokens**: `number` -Defined in: [types/context.ts:725](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L725) - Total estimated input tokens (all categories) --- @@ -38,8 +32,6 @@ Total estimated input tokens (all categories) > **availableInputTokens**: `number` -Defined in: [types/context.ts:727](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L727) - Available input tokens for the model --- @@ -48,8 +40,6 @@ Available input tokens for the model > **availableBudgetForFiles**: `number` -Defined in: [types/context.ts:729](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L729) - Budget remaining for files after non-file content --- @@ -58,6 +48,4 @@ Budget remaining for files after non-file content > `optional` **perFileBudget?**: `number` -Defined in: [types/context.ts:731](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L731) - If summarizing, the per-file token budget (undefined when not needed) diff --git a/docs/api/type-aliases/FileSummarizationPlanEntry.md b/docs/api/type-aliases/FileSummarizationPlanEntry.md index c045ce946..b8ee3fe6a 100644 --- a/docs/api/type-aliases/FileSummarizationPlanEntry.md +++ b/docs/api/type-aliases/FileSummarizationPlanEntry.md @@ -8,8 +8,6 @@ > **FileSummarizationPlanEntry** = `object` -Defined in: [types/context.ts:765](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L765) - Plan entry for a single file. ## Properties @@ -18,20 +16,14 @@ Plan entry for a single file. > **file**: [`FileForSummarization`](FileForSummarization.md) -Defined in: [types/context.ts:766](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L766) - --- ### action > **action**: `"summarize"` \| `"keep"` -Defined in: [types/context.ts:767](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L767) - --- ### targetTokens? > `optional` **targetTokens?**: `number` - -Defined in: [types/context.ts:768](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L768) diff --git a/docs/api/type-aliases/FileSummarizationPromptParams.md b/docs/api/type-aliases/FileSummarizationPromptParams.md index af7060061..454ee3f74 100644 --- a/docs/api/type-aliases/FileSummarizationPromptParams.md +++ b/docs/api/type-aliases/FileSummarizationPromptParams.md @@ -8,8 +8,6 @@ > **FileSummarizationPromptParams** = `object` -Defined in: [types/context.ts:735](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L735) - Parameters for `buildFileSummarizationPrompt()`. ## Properties @@ -18,8 +16,6 @@ Parameters for `buildFileSummarizationPrompt()`. > **fileName**: `string` -Defined in: [types/context.ts:737](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L737) - File display name --- @@ -28,8 +24,6 @@ File display name > **fileType**: `string` -Defined in: [types/context.ts:739](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L739) - File type label --- @@ -38,8 +32,6 @@ File type label > **fileContent**: `string` -Defined in: [types/context.ts:741](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L741) - Full extracted text of the file --- @@ -48,8 +40,6 @@ Full extracted text of the file > **userPrompt**: `string` -Defined in: [types/context.ts:743](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L743) - The user's original prompt / question --- @@ -58,6 +48,4 @@ The user's original prompt / question > **targetTokens**: `number` -Defined in: [types/context.ts:745](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L745) - Target output token count for the summary diff --git a/docs/api/type-aliases/FileSummarizationServiceOptions.md b/docs/api/type-aliases/FileSummarizationServiceOptions.md index 47e7b3fcb..4eaab1b05 100644 --- a/docs/api/type-aliases/FileSummarizationServiceOptions.md +++ b/docs/api/type-aliases/FileSummarizationServiceOptions.md @@ -8,8 +8,6 @@ > **FileSummarizationServiceOptions** = `object` -Defined in: [types/context.ts:1037](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1037) - Options for FileSummarizationService. ## Properties @@ -18,12 +16,8 @@ Options for FileSummarizationService. > `optional` **provider?**: `string` -Defined in: [types/context.ts:1038](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1038) - --- ### model? > `optional` **model?**: `string` - -Defined in: [types/context.ts:1039](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1039) diff --git a/docs/api/type-aliases/FileToolRootPolicy.md b/docs/api/type-aliases/FileToolRootPolicy.md index 71b37de06..2dce16eb0 100644 --- a/docs/api/type-aliases/FileToolRootPolicy.md +++ b/docs/api/type-aliases/FileToolRootPolicy.md @@ -8,8 +8,6 @@ > **FileToolRootPolicy** = `object` -Defined in: [types/fileToolRoots.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileToolRoots.ts#L16) - The directories the built-in file tools (readFile, listDirectory, writeFile, analyzeCSV) and bash's `cwd` argument may touch for one request. @@ -22,5 +20,3 @@ directory, read at call time. An empty array denies all file access. ### roots > `readonly` **roots**: readonly `string`[] \| `null` - -Defined in: [types/fileToolRoots.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileToolRoots.ts#L17) diff --git a/docs/api/type-aliases/FileType.md b/docs/api/type-aliases/FileType.md index 4a5a24efe..36e46322a 100644 --- a/docs/api/type-aliases/FileType.md +++ b/docs/api/type-aliases/FileType.md @@ -8,6 +8,4 @@ > **FileType** = `"csv"` \| `"image"` \| `"pdf"` \| `"audio"` \| `"video"` \| `"archive"` \| `"text"` \| `"svg"` \| `"docx"` \| `"pptx"` \| `"xlsx"` \| `"unknown"` -Defined in: [types/file.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L8) - Supported file types for multimodal input diff --git a/docs/api/type-aliases/FileWarning.md b/docs/api/type-aliases/FileWarning.md index 3fc6b7c5b..bbe954b4a 100644 --- a/docs/api/type-aliases/FileWarning.md +++ b/docs/api/type-aliases/FileWarning.md @@ -8,8 +8,6 @@ > **FileWarning** = `object` -Defined in: [types/processor.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L274) - Warning about a file (non-fatal issue). ## Properties @@ -18,8 +16,6 @@ Warning about a file (non-fatal issue). > **fileId**: `string` -Defined in: [types/processor.ts:276](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L276) - File identifier --- @@ -28,8 +24,6 @@ File identifier > **filename**: `string` -Defined in: [types/processor.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L278) - Filename --- @@ -38,6 +32,4 @@ Filename > **message**: `string` -Defined in: [types/processor.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L280) - Warning message diff --git a/docs/api/type-aliases/FileWithMetadata.md b/docs/api/type-aliases/FileWithMetadata.md index a61a2a389..cc9fe40b2 100644 --- a/docs/api/type-aliases/FileWithMetadata.md +++ b/docs/api/type-aliases/FileWithMetadata.md @@ -8,8 +8,6 @@ > **FileWithMetadata** = `object` -Defined in: [types/file.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L275) - File with metadata — allows callers to pass filename alongside a Buffer. This is the recommended way for applications (e.g. Slack bots) to pass @@ -34,20 +32,14 @@ files: [ > **buffer**: `Buffer` -Defined in: [types/file.ts:276](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L276) - --- ### filename > **filename**: `string` -Defined in: [types/file.ts:277](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L277) - --- ### mimetype? > `optional` **mimetype?**: `string` - -Defined in: [types/file.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L278) diff --git a/docs/api/type-aliases/FilesystemToolsMap.md b/docs/api/type-aliases/FilesystemToolsMap.md index 0bf786ee3..62dcbd881 100644 --- a/docs/api/type-aliases/FilesystemToolsMap.md +++ b/docs/api/type-aliases/FilesystemToolsMap.md @@ -8,8 +8,6 @@ > **FilesystemToolsMap** = `object` -Defined in: [types/tools.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L518) - Subset of directAgentTools exposing only the "filesystem" category. ## Properties @@ -18,20 +16,14 @@ Subset of directAgentTools exposing only the "filesystem" category. > **readFile**: [`Tool`](Tool.md) -Defined in: [types/tools.ts:519](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L519) - --- ### listDirectory > **listDirectory**: [`Tool`](Tool.md) -Defined in: [types/tools.ts:520](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L520) - --- ### writeFile > **writeFile**: [`Tool`](Tool.md) - -Defined in: [types/tools.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L521) diff --git a/docs/api/type-aliases/FinishEvent.md b/docs/api/type-aliases/FinishEvent.md index d6b986be5..e18fcaec4 100644 --- a/docs/api/type-aliases/FinishEvent.md +++ b/docs/api/type-aliases/FinishEvent.md @@ -8,8 +8,6 @@ > **FinishEvent** = [`DataStreamEvent`](DataStreamEvent.md) & `object` -Defined in: [types/server.ts:1425](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1425) - Data stream finish event. ## Type Declaration diff --git a/docs/api/type-aliases/FinishReason.md b/docs/api/type-aliases/FinishReason.md index 9e1f11f7a..04159806a 100644 --- a/docs/api/type-aliases/FinishReason.md +++ b/docs/api/type-aliases/FinishReason.md @@ -7,5 +7,3 @@ # Type Alias: FinishReason > **FinishReason** = `"stop"` \| `"length"` \| `"content-filter"` \| `"tool-calls"` \| `"error"` \| `"other"` - -Defined in: [types/aiCompat.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L299) diff --git a/docs/api/type-aliases/FirebaseConfig.md b/docs/api/type-aliases/FirebaseConfig.md index 5d884bbb9..b199111ed 100644 --- a/docs/api/type-aliases/FirebaseConfig.md +++ b/docs/api/type-aliases/FirebaseConfig.md @@ -8,8 +8,6 @@ > **FirebaseConfig** = `object` -Defined in: [types/auth.ts:690](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L690) - Firebase provider configuration ## Properties @@ -18,8 +16,6 @@ Firebase provider configuration > **projectId**: `string` -Defined in: [types/auth.ts:692](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L692) - Firebase project ID --- @@ -28,8 +24,6 @@ Firebase project ID > `optional` **apiKey?**: `string` -Defined in: [types/auth.ts:694](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L694) - Firebase API key --- @@ -38,8 +32,6 @@ Firebase API key > `optional` **serviceAccount?**: `object` -Defined in: [types/auth.ts:696](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L696) - Service account credentials #### clientEmail @@ -56,8 +48,6 @@ Service account credentials > `optional` **databaseURL?**: `string` -Defined in: [types/auth.ts:701](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L701) - Firebase database URL --- @@ -66,8 +56,6 @@ Firebase database URL > `optional` **rolesClaimKey?**: `string` -Defined in: [types/auth.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L703) - Custom claims key for roles --- @@ -76,6 +64,4 @@ Custom claims key for roles > `optional` **permissionsClaimKey?**: `string` -Defined in: [types/auth.ts:705](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L705) - Custom claims key for permissions diff --git a/docs/api/type-aliases/FixedWindowRateLimitConfig.md b/docs/api/type-aliases/FixedWindowRateLimitConfig.md index 5577856bc..6b4c04a6c 100644 --- a/docs/api/type-aliases/FixedWindowRateLimitConfig.md +++ b/docs/api/type-aliases/FixedWindowRateLimitConfig.md @@ -8,8 +8,6 @@ > **FixedWindowRateLimitConfig** = `object` -Defined in: [types/middleware.ts:453](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L453) - Simple fixed-window rate-limit configuration. ## Properties @@ -18,40 +16,30 @@ Simple fixed-window rate-limit configuration. > **maxRequests**: `number` -Defined in: [types/middleware.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L454) - --- ### windowMs > **windowMs**: `number` -Defined in: [types/middleware.ts:455](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L455) - --- ### message? > `optional` **message?**: `string` -Defined in: [types/middleware.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L456) - --- ### skipPaths? > `optional` **skipPaths?**: `string`[] -Defined in: [types/middleware.ts:457](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L457) - --- ### keyGenerator? > `optional` **keyGenerator?**: (`ctx`) => `string` -Defined in: [types/middleware.ts:458](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L458) - #### Parameters ##### ctx @@ -68,8 +56,6 @@ Defined in: [types/middleware.ts:458](https://github.com/juspay/neurolink/blob/r > `optional` **onRateLimitExceeded?**: (`ctx`, `retryAfter`) => `unknown` -Defined in: [types/middleware.ts:459](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L459) - #### Parameters ##### ctx diff --git a/docs/api/type-aliases/FlaggedItem.md b/docs/api/type-aliases/FlaggedItem.md index d3b645275..b26c3eef0 100644 --- a/docs/api/type-aliases/FlaggedItem.md +++ b/docs/api/type-aliases/FlaggedItem.md @@ -8,8 +8,6 @@ > **FlaggedItem** = `object` -Defined in: [types/scorer.ts:681](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L681) - Flagged content row reported by the toxicity scorer. ## Properties @@ -18,20 +16,14 @@ Flagged content row reported by the toxicity scorer. > `optional` **text?**: `string` -Defined in: [types/scorer.ts:682](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L682) - --- ### category? > `optional` **category?**: `string` -Defined in: [types/scorer.ts:683](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L683) - --- ### severity? > `optional` **severity?**: `string` - -Defined in: [types/scorer.ts:684](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L684) diff --git a/docs/api/type-aliases/FlexibleSchema.md b/docs/api/type-aliases/FlexibleSchema.md index e0b7831bf..8a2121307 100644 --- a/docs/api/type-aliases/FlexibleSchema.md +++ b/docs/api/type-aliases/FlexibleSchema.md @@ -8,8 +8,6 @@ > **FlexibleSchema**\<`SCHEMA`\> = [`Schema`](Schema.md)\<`SCHEMA`\> \| `LazySchema`\<`SCHEMA`\> \| `ZodSchema`\<`SCHEMA`\> \| `StandardSchema`\<`SCHEMA`\> -Defined in: [types/aiCompat.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L69) - ## Type Parameters ### SCHEMA diff --git a/docs/api/type-aliases/FlexibleValidationResult.md b/docs/api/type-aliases/FlexibleValidationResult.md index 92dcd6637..b4dad4263 100644 --- a/docs/api/type-aliases/FlexibleValidationResult.md +++ b/docs/api/type-aliases/FlexibleValidationResult.md @@ -8,8 +8,6 @@ > **FlexibleValidationResult** = `object` -Defined in: [types/mcp.ts:850](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L850) - Flexible validation result Moved from src/lib/mcp/flexibleToolValidator.ts @@ -19,8 +17,6 @@ Moved from src/lib/mcp/flexibleToolValidator.ts > **isValid**: `boolean` -Defined in: [types/mcp.ts:852](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L852) - Whether validation passed --- @@ -29,8 +25,6 @@ Whether validation passed > `optional` **error?**: `string` -Defined in: [types/mcp.ts:855](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L855) - Validation error message (for simple cases) --- @@ -39,8 +33,6 @@ Validation error message (for simple cases) > `optional` **warnings?**: `string`[] -Defined in: [types/mcp.ts:858](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L858) - Validation warnings --- @@ -49,8 +41,6 @@ Validation warnings > `optional` **normalizedParams?**: `Record`\<`string`, `unknown`\> -Defined in: [types/mcp.ts:861](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L861) - Normalized parameters (if valid) --- @@ -59,8 +49,6 @@ Normalized parameters (if valid) > `optional` **metadata?**: `object` -Defined in: [types/mcp.ts:864](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L864) - Validation metadata #### validationTime? diff --git a/docs/api/type-aliases/FormElicitation.md b/docs/api/type-aliases/FormElicitation.md index e9d4ece50..c3dd64914 100644 --- a/docs/api/type-aliases/FormElicitation.md +++ b/docs/api/type-aliases/FormElicitation.md @@ -8,8 +8,6 @@ > **FormElicitation** = [`ElicitationRequest`](ElicitationRequest.md) & `object` -Defined in: [types/elicitation.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L168) - Form elicitation ## Type Declaration diff --git a/docs/api/type-aliases/FormField.md b/docs/api/type-aliases/FormField.md index 16e13b5a3..6e558888f 100644 --- a/docs/api/type-aliases/FormField.md +++ b/docs/api/type-aliases/FormField.md @@ -8,8 +8,6 @@ > **FormField** = `object` -Defined in: [types/elicitation.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L148) - Form field definition ## Properties @@ -18,56 +16,42 @@ Form field definition > **name**: `string` -Defined in: [types/elicitation.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L149) - --- ### label > **label**: `string` -Defined in: [types/elicitation.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L150) - --- ### type > **type**: `"text"` \| `"number"` \| `"boolean"` \| `"select"` \| `"date"` \| `"password"` -Defined in: [types/elicitation.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L151) - --- ### required? > `optional` **required?**: `boolean` -Defined in: [types/elicitation.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L152) - --- ### defaultValue? > `optional` **defaultValue?**: [`JsonValue`](JsonValue.md) -Defined in: [types/elicitation.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L153) - --- ### options? > `optional` **options?**: [`SelectOption`](SelectOption.md)[] -Defined in: [types/elicitation.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L154) - --- ### validation? > `optional` **validation?**: `object` -Defined in: [types/elicitation.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L155) - #### min? > `optional` **min?**: `number` @@ -90,12 +74,8 @@ Defined in: [types/elicitation.ts:155](https://github.com/juspay/neurolink/blob/ > `optional` **placeholder?**: `string` -Defined in: [types/elicitation.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L161) - --- ### description? > `optional` **description?**: `string` - -Defined in: [types/elicitation.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L162) diff --git a/docs/api/type-aliases/FormatScorerConfig.md b/docs/api/type-aliases/FormatScorerConfig.md index 325475694..72f6e0b8c 100644 --- a/docs/api/type-aliases/FormatScorerConfig.md +++ b/docs/api/type-aliases/FormatScorerConfig.md @@ -8,8 +8,6 @@ > **FormatScorerConfig** = [`RuleScorerConfig`](RuleScorerConfig.md) & `object` -Defined in: [types/scorer.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L532) - Configuration specific to format scoring. ## Type Declaration diff --git a/docs/api/type-aliases/FormatType.md b/docs/api/type-aliases/FormatType.md index 8c86c681f..2e0cb73c7 100644 --- a/docs/api/type-aliases/FormatType.md +++ b/docs/api/type-aliases/FormatType.md @@ -8,6 +8,4 @@ > **FormatType** = `"json"` \| `"markdown"` \| `"code"` \| `"list"` \| `"numbered-list"` \| `"bullet-list"` \| `"table"` \| `"yaml"` \| `"xml"` \| `"plain"` \| `"html"` \| `"custom"` -Defined in: [types/scorer.ts:502](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L502) - Expected format types evaluated by the format scorer. diff --git a/docs/api/type-aliases/FormatValidationResult.md b/docs/api/type-aliases/FormatValidationResult.md index f5e226745..d9a339b3a 100644 --- a/docs/api/type-aliases/FormatValidationResult.md +++ b/docs/api/type-aliases/FormatValidationResult.md @@ -8,8 +8,6 @@ > **FormatValidationResult** = `object` -Defined in: [types/scorer.ts:555](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L555) - Format validation result. ## Properties @@ -18,28 +16,20 @@ Format validation result. > **isValid**: `boolean` -Defined in: [types/scorer.ts:556](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L556) - --- ### detectedFormat > **detectedFormat**: [`FormatType`](FormatType.md) \| `null` -Defined in: [types/scorer.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L557) - --- ### issues > **issues**: `string`[] -Defined in: [types/scorer.ts:558](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L558) - --- ### structureAnalysis? > `optional` **structureAnalysis?**: `object` - -Defined in: [types/scorer.ts:559](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L559) diff --git a/docs/api/type-aliases/Frame.md b/docs/api/type-aliases/Frame.md index 1ead7354b..7cfb53d92 100644 --- a/docs/api/type-aliases/Frame.md +++ b/docs/api/type-aliases/Frame.md @@ -7,5 +7,3 @@ # Type Alias: Frame > **Frame** = \{ `type`: `"audio"`; `data`: `Int16Array`; \} \| \{ `type`: `"vad_start"`; \} \| \{ `type`: `"vad_stop"`; \} \| \{ `type`: `"transcript"`; `text`: `string`; `final`: `boolean`; \} \| \{ `type`: `"llm_token"`; `text`: `string`; \} \| \{ `type`: `"tts_audio"`; `data`: `Buffer`; \} \| \{ `type`: `"interrupt"`; \} - -Defined in: [types/server.ts:1166](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1166) diff --git a/docs/api/type-aliases/FrameworkFieldsConfig.md b/docs/api/type-aliases/FrameworkFieldsConfig.md index 8f2f10bf0..8c71c73e8 100644 --- a/docs/api/type-aliases/FrameworkFieldsConfig.md +++ b/docs/api/type-aliases/FrameworkFieldsConfig.md @@ -8,8 +8,6 @@ > **FrameworkFieldsConfig** = `object` -Defined in: [types/context.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L83) - Configuration for framework fields exclusion Can be customized per application or environment @@ -19,28 +17,20 @@ Can be customized per application or environment > **defaultFields**: `string`[] -Defined in: [types/context.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L85) - --- ### additionalFields? > `optional` **additionalFields?**: `string`[] -Defined in: [types/context.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L88) - --- ### overrideFields? > `optional` **overrideFields?**: `string`[] -Defined in: [types/context.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L91) - --- ### includeFields? > `optional` **includeFields?**: `string`[] - -Defined in: [types/context.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L94) diff --git a/docs/api/type-aliases/FunctionParameters.md b/docs/api/type-aliases/FunctionParameters.md index 378f4bf44..799db6abf 100644 --- a/docs/api/type-aliases/FunctionParameters.md +++ b/docs/api/type-aliases/FunctionParameters.md @@ -8,8 +8,6 @@ > **FunctionParameters** = `object` -Defined in: [types/common.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L79) - Function parameter type for dynamic functions ## Index Signature diff --git a/docs/api/type-aliases/GcpAuthMethodStatus.md b/docs/api/type-aliases/GcpAuthMethodStatus.md index cfbe87205..6891c2ab2 100644 --- a/docs/api/type-aliases/GcpAuthMethodStatus.md +++ b/docs/api/type-aliases/GcpAuthMethodStatus.md @@ -8,8 +8,6 @@ > **GcpAuthMethodStatus** = `object` -Defined in: [types/cli.ts:1741](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1741) - Status of each GCP auth method tried by setup-gcp. ## Properties @@ -18,8 +16,6 @@ Status of each GCP auth method tried by setup-gcp. > **method1**: `object` -Defined in: [types/cli.ts:1742](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1742) - #### complete > **complete**: `boolean` @@ -38,8 +34,6 @@ Defined in: [types/cli.ts:1742](https://github.com/juspay/neurolink/blob/release > **method2**: `object` -Defined in: [types/cli.ts:1747](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1747) - #### complete > **complete**: `boolean` @@ -58,8 +52,6 @@ Defined in: [types/cli.ts:1747](https://github.com/juspay/neurolink/blob/release > **method3**: `object` -Defined in: [types/cli.ts:1752](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1752) - #### complete > **complete**: `boolean` @@ -82,8 +74,6 @@ Defined in: [types/cli.ts:1752](https://github.com/juspay/neurolink/blob/release > **common**: `object` -Defined in: [types/cli.ts:1758](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1758) - #### hasProject > **hasProject**: `boolean` diff --git a/docs/api/type-aliases/GeminiGuardContent.md b/docs/api/type-aliases/GeminiGuardContent.md index f109455b3..bb9f1da35 100644 --- a/docs/api/type-aliases/GeminiGuardContent.md +++ b/docs/api/type-aliases/GeminiGuardContent.md @@ -8,8 +8,6 @@ > **GeminiGuardContent** = `object` -Defined in: [types/context.ts:919](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L919) - Structural view of one Gemini history entry, loose enough to accept both the native Vertex loop's `{ role, parts }` array and `@google/genai` contents without a cast at either call site. @@ -20,12 +18,8 @@ without a cast at either call site. > **role**: `string` -Defined in: [types/context.ts:920](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L920) - --- ### parts > **parts**: `unknown`[] - -Defined in: [types/context.ts:921](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L921) diff --git a/docs/api/type-aliases/GeminiLoopAdapterConfig.md b/docs/api/type-aliases/GeminiLoopAdapterConfig.md index 84638a7fa..4b421099e 100644 --- a/docs/api/type-aliases/GeminiLoopAdapterConfig.md +++ b/docs/api/type-aliases/GeminiLoopAdapterConfig.md @@ -7,5 +7,3 @@ # Type Alias: GeminiLoopAdapterConfig > **GeminiLoopAdapterConfig** = [`GeminiLoopAdapterCoreConfig`](GeminiLoopAdapterCoreConfig.md) & [`GeminiMalformedRetryConfig`](GeminiMalformedRetryConfig.md) - -Defined in: [types/loopEngine.ts:608](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L608) diff --git a/docs/api/type-aliases/GeminiLoopAdapterCoreConfig.md b/docs/api/type-aliases/GeminiLoopAdapterCoreConfig.md index e9366d8c3..c7016bbfa 100644 --- a/docs/api/type-aliases/GeminiLoopAdapterCoreConfig.md +++ b/docs/api/type-aliases/GeminiLoopAdapterCoreConfig.md @@ -8,8 +8,6 @@ > **GeminiLoopAdapterCoreConfig** = `object` -Defined in: [types/loopEngine.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L476) - Construction input for `createGeminiLoopAdapter`, shared by Google AI Studio and Vertex Gemini. Both issue `models.generateContentStream` and consume the same response shape, so one adapter serves four hand-rolled loops. @@ -20,8 +18,6 @@ same response shape, so one adapter serves four hand-rolled loops. > **providerLabel**: `string` -Defined in: [types/loopEngine.ts:478](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L478) - Used in log lines and generated tool-call ids. --- @@ -30,16 +26,12 @@ Used in log lines and generated tool-call ids. > **maxSteps**: `number` -Defined in: [types/loopEngine.ts:479](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L479) - --- ### buildRequest > **buildRequest**: (`conversation`, `step`) => `unknown` -Defined in: [types/loopEngine.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L481) - Build one step's request object (model, contents, config). #### Parameters @@ -62,8 +54,6 @@ Build one step's request object (model, contents, config). > **sendStep**: (`request`, `signal`) => `Promise`\<`AsyncIterable`\<\{\[`key`: `string`\]: `unknown`; `functionCalls?`: [`NativeFunctionCall`](NativeFunctionCall.md)[]; \}\>\> -Defined in: [types/loopEngine.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L483) - Issue the request. Kept injectable so each provider keeps its own client. #### Parameters @@ -86,8 +76,6 @@ Issue the request. Kept injectable so each provider keeps its own client. > **liveTools**: `Record`\<`string`, [`Tool`](Tool.md)\> -Defined in: [types/loopEngine.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L497) - The turn's live tool record. Mid-turn `search_tools` discovery hydrates into this, which is what both the declaration refresh and `resolveToolOnMiss` read. @@ -98,8 +86,6 @@ into this, which is what both the declaration refresh and > `optional` **declarations?**: [`NativeToolDeclarationsResult`](NativeToolDeclarationsResult.md) -Defined in: [types/loopEngine.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L503) - Declarations built for this turn. Carries `originalNameMap`, which keeps Google's function-name sanitization on the adapter side of the engine boundary. @@ -110,16 +96,12 @@ boundary. > `optional` **toolFailureBreaker?**: [`AgenticLoopToolFailureBreaker`](AgenticLoopToolFailureBreaker.md) -Defined in: [types/loopEngine.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L504) - --- ### planReclaim? > `optional` **planReclaim?**: (`conversation`, `step`) => [`AgenticLoopReclaimResult`](AgenticLoopReclaimResult.md)\<[`GeminiTurnContent`](GeminiTurnContent.md)[]\> \| `undefined` -Defined in: [types/loopEngine.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L517) - In-turn context reclaim, run once per step before the request is built. Returns the rebuilt conversation when it reclaimed, undefined when the request still fits. @@ -151,8 +133,6 @@ window mid-turn and loses every completed step. > `optional` **noteUsage?**: (`inputTokens`, `outputTokens`) => `void` -Defined in: [types/loopEngine.ts:525](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L525) - Usage feedback for the provider's own context guard, called after each step with that step's real token counts. @@ -176,8 +156,6 @@ step with that step's real token counts. > `optional` **toolGuards?**: [`ToolExecutionGuards`](ToolExecutionGuards.md) -Defined in: [types/loopEngine.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L535) - The same guards `buildDedupedEngineTools` wraps declared tools in, applied to one hydrated mid-turn. @@ -192,8 +170,6 @@ the one most likely to be called repeatedly with the same arguments. > `optional` **finalResultToolName?**: `string` -Defined in: [types/loopEngine.ts:543](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L543) - Name of the terminal structured-output tool when one is in play. A call to it ends the turn: its arguments ARE the answer, so it is reported as text and omitted from `toolCalls`, which routes it through the engine's @@ -206,8 +182,6 @@ the breaker, never recorded as a tool execution. > `optional` **onTerminalResult?**: (`text`) => `void` -Defined in: [types/loopEngine.ts:553](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L553) - Called with the terminal tool's payload when one was actually detected. The caller cannot infer this from the turn's result: a structured turn @@ -232,8 +206,6 @@ differently. Comparing strings to tell them apart would be guesswork. > `optional` **collectStep?**: (`stream`, `channel`) => `Promise`\<[`CollectedChunkResult`](CollectedChunkResult.md)\> -Defined in: [types/loopEngine.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L567) - Fold one step's raw stream into the shape the adapter reports. Defaults to `collectStreamChunksIncremental`, which is what AI Studio and diff --git a/docs/api/type-aliases/GeminiMalformedRetryConfig.md b/docs/api/type-aliases/GeminiMalformedRetryConfig.md index 1daec580b..127f000d0 100644 --- a/docs/api/type-aliases/GeminiMalformedRetryConfig.md +++ b/docs/api/type-aliases/GeminiMalformedRetryConfig.md @@ -8,8 +8,6 @@ > **GeminiMalformedRetryConfig** = \{ `enableMalformedRetry`: `true`; `buildMalformedRetryNote`: (`conversation`, `step`) => [`GeminiTurnContent`](GeminiTurnContent.md)[]; \} \| \{ `enableMalformedRetry?`: `false`; `buildMalformedRetryNote?`: `never`; \} -Defined in: [types/loopEngine.ts:590](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L590) - Opt in to the single MALFORMED_FUNCTION_CALL retry. Vertex Gemini only. AI Studio has no such retry today (confirmed: zero diff --git a/docs/api/type-aliases/GeminiMessage.md b/docs/api/type-aliases/GeminiMessage.md index 29720fe47..84fc43f7d 100644 --- a/docs/api/type-aliases/GeminiMessage.md +++ b/docs/api/type-aliases/GeminiMessage.md @@ -8,16 +8,12 @@ > **GeminiMessage** = `object` -Defined in: [types/stt.ts:724](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L724) - ## Properties ### setup? > `optional` **setup?**: `object` -Defined in: [types/stt.ts:725](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L725) - #### model > **model**: `string` @@ -64,8 +60,6 @@ Defined in: [types/stt.ts:725](https://github.com/juspay/neurolink/blob/release/ > `optional` **realtimeInput?**: `object` -Defined in: [types/stt.ts:742](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L742) - #### mediaChunks > **mediaChunks**: `object`[] @@ -76,8 +70,6 @@ Defined in: [types/stt.ts:742](https://github.com/juspay/neurolink/blob/release/ > `optional` **clientContent?**: `object` -Defined in: [types/stt.ts:748](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L748) - #### turns > **turns**: `object`[] diff --git a/docs/api/type-aliases/GeminiMultimodalInput.md b/docs/api/type-aliases/GeminiMultimodalInput.md index 2f6b68954..ac438709c 100644 --- a/docs/api/type-aliases/GeminiMultimodalInput.md +++ b/docs/api/type-aliases/GeminiMultimodalInput.md @@ -8,8 +8,6 @@ > **GeminiMultimodalInput** = `object` -Defined in: [types/providers.ts:2507](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2507) - Subset of `GenerateOptions["input"]` consumed by the shared Gemini-native multimodal-parts builder. Kept narrow so the helper doesn't depend on the full `GenerateOptions` shape. The `images` field mirrors the public @@ -22,32 +20,24 @@ value SDK callers pass in (plain Buffer/string or `ImageWithAltText`). > `optional` **text?**: `string` -Defined in: [types/providers.ts:2508](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2508) - --- ### pdfFiles? > `optional` **pdfFiles?**: (`Buffer` \| `string`)[] -Defined in: [types/providers.ts:2509](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2509) - --- ### images? > `optional` **images?**: (`Buffer` \| `string` \| \{ `data`: `Buffer` \| `string`; `altText?`: `string`; \})[] -Defined in: [types/providers.ts:2510](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2510) - --- ### nativeAudioFiles? > `optional` **nativeAudioFiles?**: [`MultimodalAudioEntry`](MultimodalAudioEntry.md)[] -Defined in: [types/providers.ts:2516](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2516) - Audio collected during file detection, carried through to the native request as `inlineData`. Distinct from the user-facing `audioFiles`: these are already-materialised bytes with a resolved mime type. @@ -58,8 +48,6 @@ are already-materialised bytes with a resolved mime type. > `optional` **nativeVideoFiles?**: [`MultimodalVideoEntry`](MultimodalVideoEntry.md)[] -Defined in: [types/providers.ts:2523](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2523) - Video collected during file detection, carried through to the native request as `inlineData`. Distinct from the user-facing `videoFiles`: these are already-materialised bytes with a resolved mime type and, where it diff --git a/docs/api/type-aliases/GeminiResponse.md b/docs/api/type-aliases/GeminiResponse.md index 5cb38d0af..0ae2ab630 100644 --- a/docs/api/type-aliases/GeminiResponse.md +++ b/docs/api/type-aliases/GeminiResponse.md @@ -8,24 +8,18 @@ > **GeminiResponse** = `object` -Defined in: [types/stt.ts:757](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L757) - ## Properties ### setupComplete? > `optional` **setupComplete?**: `Record`\<`string`, `unknown`\> -Defined in: [types/stt.ts:758](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L758) - --- ### serverContent? > `optional` **serverContent?**: `object` -Defined in: [types/stt.ts:759](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L759) - #### modelTurn? > `optional` **modelTurn?**: `object` @@ -48,8 +42,6 @@ Defined in: [types/stt.ts:759](https://github.com/juspay/neurolink/blob/release/ > `optional` **toolCall?**: `object` -Defined in: [types/stt.ts:772](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L772) - #### functionCalls > **functionCalls**: `object`[] @@ -60,8 +52,6 @@ Defined in: [types/stt.ts:772](https://github.com/juspay/neurolink/blob/release/ > `optional` **toolCallCancellation?**: `object` -Defined in: [types/stt.ts:779](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L779) - #### ids > **ids**: `string`[] diff --git a/docs/api/type-aliases/GeminiStepRaw.md b/docs/api/type-aliases/GeminiStepRaw.md index b388c0bdc..e1a8b71bd 100644 --- a/docs/api/type-aliases/GeminiStepRaw.md +++ b/docs/api/type-aliases/GeminiStepRaw.md @@ -8,8 +8,6 @@ > **GeminiStepRaw** = `object` -Defined in: [types/loopEngine.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L460) - What one Gemini step produced, carried to `buildToolResultMessages`. ## Properties @@ -18,12 +16,8 @@ What one Gemini step produced, carried to `buildToolResultMessages`. > **rawResponseParts**: `unknown`[] -Defined in: [types/loopEngine.ts:461](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L461) - --- ### stepFunctionCalls > **stepFunctionCalls**: [`NativeFunctionCall`](NativeFunctionCall.md)[] - -Defined in: [types/loopEngine.ts:462](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L462) diff --git a/docs/api/type-aliases/GeminiToolExecutionGuards.md b/docs/api/type-aliases/GeminiToolExecutionGuards.md index 8b934c59b..a2febdd01 100644 --- a/docs/api/type-aliases/GeminiToolExecutionGuards.md +++ b/docs/api/type-aliases/GeminiToolExecutionGuards.md @@ -8,8 +8,6 @@ > **GeminiToolExecutionGuards** = [`ToolExecutionGuards`](ToolExecutionGuards.md) -Defined in: [types/loopEngine.ts:457](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L457) - ## Deprecated Renamed to `ToolExecutionGuards` — the guards were never diff --git a/docs/api/type-aliases/GeminiTurnContent.md b/docs/api/type-aliases/GeminiTurnContent.md index ece9da30d..a5f3a2378 100644 --- a/docs/api/type-aliases/GeminiTurnContent.md +++ b/docs/api/type-aliases/GeminiTurnContent.md @@ -8,8 +8,6 @@ > **GeminiTurnContent** = `object` -Defined in: [types/loopEngine.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L466) - One turn entry in a Gemini conversation: a role plus its content parts. ## Properties @@ -18,12 +16,8 @@ One turn entry in a Gemini conversation: a role plus its content parts. > **role**: `string` -Defined in: [types/loopEngine.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L467) - --- ### parts > **parts**: `unknown`[] - -Defined in: [types/loopEngine.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/types/loopEngine.ts#L468) diff --git a/docs/api/type-aliases/GenAIClient.md b/docs/api/type-aliases/GenAIClient.md index fba82e5a2..d954f00da 100644 --- a/docs/api/type-aliases/GenAIClient.md +++ b/docs/api/type-aliases/GenAIClient.md @@ -8,8 +8,6 @@ > **GenAIClient** = `object` -Defined in: [types/providers.ts:1284](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1284) - Google AI client interface ## Properties @@ -18,8 +16,6 @@ Google AI client interface > **live**: `object` -Defined in: [types/providers.ts:1285](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1285) - #### connect > **connect**: (`config`) => `Promise`\<[`GenAILiveSession`](GenAILiveSession.md)\> @@ -39,5 +35,3 @@ Defined in: [types/providers.ts:1285](https://github.com/juspay/neurolink/blob/r ### models > **models**: [`GenAIModelsAPI`](GenAIModelsAPI.md) - -Defined in: [types/providers.ts:1286](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1286) diff --git a/docs/api/type-aliases/GenAIGenerateContentResponse.md b/docs/api/type-aliases/GenAIGenerateContentResponse.md index 1f4e02c28..9a9971b6f 100644 --- a/docs/api/type-aliases/GenAIGenerateContentResponse.md +++ b/docs/api/type-aliases/GenAIGenerateContentResponse.md @@ -8,8 +8,6 @@ > **GenAIGenerateContentResponse** = `object` -Defined in: [types/providers.ts:1244](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1244) - Google AI generate content response ## Properties @@ -18,8 +16,6 @@ Google AI generate content response > `optional` **candidates?**: `object`[] -Defined in: [types/providers.ts:1245](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1245) - #### content? > `optional` **content?**: `object` diff --git a/docs/api/type-aliases/GenAILiveMedia.md b/docs/api/type-aliases/GenAILiveMedia.md index 51592c59d..22e6b851e 100644 --- a/docs/api/type-aliases/GenAILiveMedia.md +++ b/docs/api/type-aliases/GenAILiveMedia.md @@ -8,8 +8,6 @@ > **GenAILiveMedia** = `object` -Defined in: [types/providers.ts:1149](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1149) - Google AI Live media configuration ## Properties @@ -18,12 +16,8 @@ Google AI Live media configuration > **data**: `string` -Defined in: [types/providers.ts:1150](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1150) - --- ### mimeType > **mimeType**: `string` - -Defined in: [types/providers.ts:1151](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1151) diff --git a/docs/api/type-aliases/GenAILiveSession.md b/docs/api/type-aliases/GenAILiveSession.md index a8857c6a7..05c0b1696 100644 --- a/docs/api/type-aliases/GenAILiveSession.md +++ b/docs/api/type-aliases/GenAILiveSession.md @@ -8,8 +8,6 @@ > **GenAILiveSession** = `object` -Defined in: [types/providers.ts:1210](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1210) - Google AI Live session interface ## Properties @@ -18,8 +16,6 @@ Google AI Live session interface > `optional` **sendRealtimeInput?**: (`payload`) => `Promise`\<`void`\> \| `void` -Defined in: [types/providers.ts:1211](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1211) - #### Parameters ##### payload @@ -42,8 +38,6 @@ Defined in: [types/providers.ts:1211](https://github.com/juspay/neurolink/blob/r > `optional` **sendInput?**: (`payload`) => `Promise`\<`void`\> \| `void` -Defined in: [types/providers.ts:1215](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1215) - #### Parameters ##### payload @@ -66,8 +60,6 @@ Defined in: [types/providers.ts:1215](https://github.com/juspay/neurolink/blob/r > `optional` **close?**: (`code?`, `reason?`) => `Promise`\<`void`\> \| `void` -Defined in: [types/providers.ts:1219](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1219) - #### Parameters ##### code? diff --git a/docs/api/type-aliases/GenAIModelsAPI.md b/docs/api/type-aliases/GenAIModelsAPI.md index 41aadf78e..18f3319e7 100644 --- a/docs/api/type-aliases/GenAIModelsAPI.md +++ b/docs/api/type-aliases/GenAIModelsAPI.md @@ -8,8 +8,6 @@ > **GenAIModelsAPI** = `object` -Defined in: [types/providers.ts:1261](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1261) - Google AI models API interface ## Properties @@ -18,8 +16,6 @@ Google AI models API interface > **generateContentStream**: (`params`) => `Promise`\<`AsyncIterable`\<[`GenAIStreamChunk`](GenAIStreamChunk.md)\>\> -Defined in: [types/providers.ts:1262](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1262) - #### Parameters ##### params @@ -46,8 +42,6 @@ Defined in: [types/providers.ts:1262](https://github.com/juspay/neurolink/blob/r > **generateContent**: (`params`) => `Promise`\<[`GenAIGenerateContentResponse`](GenAIGenerateContentResponse.md)\> -Defined in: [types/providers.ts:1267](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1267) - #### Parameters ##### params @@ -74,8 +68,6 @@ Defined in: [types/providers.ts:1267](https://github.com/juspay/neurolink/blob/r > **embedContent**: (`params`) => `Promise`\<\{ `embeddings?`: `object`[]; \}\> -Defined in: [types/providers.ts:1272](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1272) - #### Parameters ##### params diff --git a/docs/api/type-aliases/GenAIStreamChunk.md b/docs/api/type-aliases/GenAIStreamChunk.md index 9cdb40795..abd1686d0 100644 --- a/docs/api/type-aliases/GenAIStreamChunk.md +++ b/docs/api/type-aliases/GenAIStreamChunk.md @@ -8,8 +8,6 @@ > **GenAIStreamChunk** = `object` -Defined in: [types/providers.ts:1225](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1225) - Google AI generateContentStream response chunk ## Properties @@ -18,16 +16,12 @@ Google AI generateContentStream response chunk > `optional` **text?**: `string` -Defined in: [types/providers.ts:1226](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1226) - --- ### functionCalls? > `optional` **functionCalls?**: `object`[] -Defined in: [types/providers.ts:1227](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1227) - #### name > **name**: `string` @@ -42,8 +36,6 @@ Defined in: [types/providers.ts:1227](https://github.com/juspay/neurolink/blob/r > `optional` **candidates?**: `object`[] -Defined in: [types/providers.ts:1228](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1228) - #### content? > `optional` **content?**: `object` diff --git a/docs/api/type-aliases/Gender.md b/docs/api/type-aliases/Gender.md index 1538aa452..c5a26d51d 100644 --- a/docs/api/type-aliases/Gender.md +++ b/docs/api/type-aliases/Gender.md @@ -8,8 +8,6 @@ > **Gender** = [`TTSGender`](TTSGender.md) -Defined in: [types/tts.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L184) - ## Deprecated Use `TTSGender` instead. diff --git a/docs/api/type-aliases/GenerateCommandArgs.md b/docs/api/type-aliases/GenerateCommandArgs.md index 7b51d511e..837130ba4 100644 --- a/docs/api/type-aliases/GenerateCommandArgs.md +++ b/docs/api/type-aliases/GenerateCommandArgs.md @@ -8,8 +8,6 @@ > **GenerateCommandArgs** = [`BaseCommandArgs`](BaseCommandArgs.md) & [`CliToolRoutingFlags`](CliToolRoutingFlags.md) & [`CliClassifierRouterFlags`](CliClassifierRouterFlags.md) & `object` -Defined in: [types/cli.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L62) - Generate command arguments ## Type Declaration diff --git a/docs/api/type-aliases/GenerateOptions.md b/docs/api/type-aliases/GenerateOptions.md index 7c8a3cf55..9e08d6767 100644 --- a/docs/api/type-aliases/GenerateOptions.md +++ b/docs/api/type-aliases/GenerateOptions.md @@ -8,8 +8,6 @@ > **GenerateOptions** = `object` -Defined in: [types/generate.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L56) - Generate function options type - Primary method for content generation Supports multimodal content while maintaining backward compatibility @@ -19,8 +17,6 @@ Supports multimodal content while maintaining backward compatibility > `optional` **input?**: `object` -Defined in: [types/generate.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L62) - Input content for generation. Optional for media-only modes (avatar, music, video) where all configuration lives in `output`; the SDK synthesises an empty `input` automatically when this field is omitted. @@ -115,8 +111,6 @@ Must contain 2-10 segments. > `optional` **output?**: `object` -Defined in: [types/generate.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L140) - Output configuration options #### format? @@ -199,16 +193,12 @@ output: { > `optional` **csvOptions?**: [`CSVProcessorOptions`](CSVProcessorOptions.md) -Defined in: [types/generate.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L182) - --- ### pdfOptions? > `optional` **pdfOptions?**: `object` -Defined in: [types/generate.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L185) - PDF processing options (#258). #### password? @@ -244,8 +234,6 @@ not sent to the model at all. Defaults to PDF_LIMITS.DEFAULT_MAX_PAGES (20). > `optional` **imageOptions?**: `object` -Defined in: [types/generate.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L208) - Options for images that need transcoding before a vision provider can read them (HEIC, TIFF, BMP, ICO, JPEG 2000, AVIF — see `adapters/imageFormatSupport.ts`). @@ -263,8 +251,6 @@ module's own default, unchanged unless a caller opts in here. > `optional` **videoOptions?**: `object` -Defined in: [types/generate.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L217) - #### frames? > `optional` **frames?**: `number` @@ -295,8 +281,6 @@ Not implemented yet (#433) — warns rather than silently doing nothing. > `optional` **tts?**: [`TTSOptions`](TTSOptions.md) -Defined in: [types/generate.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L260) - Text-to-Speech (TTS) configuration Enable audio generation from the text response. The generated audio will be @@ -334,8 +318,6 @@ const result = await neurolink.generate({ > `optional` **stt?**: [`STTOptions`](STTOptions.md) & `object` -Defined in: [types/generate.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L279) - Speech-to-Text (STT) configuration Enable audio transcription. When enabled, the audio provided via `stt.audio` @@ -374,8 +356,6 @@ const result = await neurolink.generate({ > `optional` **thinkingConfig?**: `object` -Defined in: [types/generate.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L321) - Thinking/reasoning configuration for extended thinking models Enables extended thinking capabilities for supported models. @@ -442,48 +422,36 @@ const result = await neurolink.generate({ > `optional` **provider?**: [`AIProviderName`](../enumerations/AIProviderName.md) \| `string` -Defined in: [types/generate.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L331) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/generate.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L332) - --- ### region? > `optional` **region?**: `string` -Defined in: [types/generate.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L333) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/generate.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L334) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/generate.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L335) - --- ### compactionThreshold? > `optional` **compactionThreshold?**: `number` -Defined in: [types/generate.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L342) - Fraction of the model's context window at which history is compacted for this request, replacing the 0.8 default. Filled in per request by the classifier router when a decision provider is configured; always at or @@ -495,8 +463,6 @@ below the default, never above. See `TextGenerationOptions`. > `optional` **topP?**: `number` -Defined in: [types/generate.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L344) - Top-p (nucleus) sampling parameter. Controls diversity of generated tokens. --- @@ -505,8 +471,6 @@ Top-p (nucleus) sampling parameter. Controls diversity of generated tokens. > `optional` **topK?**: `number` -Defined in: [types/generate.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L346) - Top-k sampling parameter. Limits the number of tokens considered. (Google/Gemini models only) --- @@ -515,8 +479,6 @@ Top-k sampling parameter. Limits the number of tokens considered. (Google/Gemini > `optional` **stopSequences?**: `string`[] -Defined in: [types/generate.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L348) - Stop sequences that will halt generation when encountered. --- @@ -525,16 +487,12 @@ Stop sequences that will halt generation when encountered. > `optional` **systemPrompt?**: `string` -Defined in: [types/generate.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L349) - --- ### agentMode? > `optional` **agentMode?**: [`TerminalAgentModeOption`](TerminalAgentModeOption.md) -Defined in: [types/generate.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L354) - Opt-in terminal agent mode: prepends Neurolink's versioned autonomous-agent instructions to `systemPrompt`. Omitted means no change in behaviour. @@ -544,8 +502,6 @@ instructions to `systemPrompt`. Omitted means no change in behaviour. > `optional` **schema?**: [`ValidationSchema`](ValidationSchema.md) -Defined in: [types/generate.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L400) - Zod schema for structured output validation #### Important @@ -601,16 +557,12 @@ https://ai.google.dev/gemini-api/docs/function-calling > `optional` **tools?**: `Record`\<`string`, [`Tool`](Tool.md)\> -Defined in: [types/generate.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L401) - --- ### enabledToolNames? > `optional` **enabledToolNames?**: `string`[] -Defined in: [types/generate.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L415) - Filter available tools by name. Only tools with names in this array will be made available. Used by dynamic arguments to dynamically select which tools to enable. @@ -630,8 +582,6 @@ await neurolink.generate({ > `optional` **timeout?**: `number` \| `string` -Defined in: [types/generate.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L436) - Request timeout (e.g. 30000, '30s', '2m'). PER-STEP semantics in agentic loops: on providers that run a native @@ -657,8 +607,6 @@ provider+model with the same doomed budget. > `optional` **turnTimeoutMs?**: `number` -Defined in: [types/generate.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L456) - Hard wall-clock cap for the WHOLE agentic turn (all model calls + tool executions), in milliseconds. When the deadline passes the turn ends gracefully with `stopReason: "time-limit"` and an honest time message — @@ -683,8 +631,6 @@ wrap-up nudge is applied). An honest partial beats a discarded turn. > `optional` **stallTimeoutMs?**: `number` -Defined in: [types/generate.ts:471](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L471) - Maximum time with NO progress — no stream chunk received, no tool execution started or finished, no step started — before the turn ends with `stopReason: "stalled"`. Catches wedged tools and hung model calls @@ -704,8 +650,6 @@ without this note a caller would reasonably read silence as coverage. > `optional` **wrapupTimeLeadMs?**: `number` -Defined in: [types/generate.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L483) - When the remaining turn time drops below this, a wrap-up nudge rides the next tool-result turn telling the model to consolidate what it has and produce its final answer. Defaults to 120_000 when `turnTimeoutMs` is @@ -722,8 +666,6 @@ exact override semantics. > `optional` **toolTimeoutMs?**: `number` \| `null` -Defined in: [types/generate.ts:502](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L502) - Per-tool-execution timeout in milliseconds (default 300_000), or `null` for no bound at all. @@ -747,8 +689,6 @@ with no bound anywhere. > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/generate.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L504) - AbortSignal for external cancellation of the AI call --- @@ -757,8 +697,6 @@ AbortSignal for external cancellation of the AI call > `optional` **toolExecutionCapture?**: [`ToolExecutionCaptureOptions`](ToolExecutionCaptureOptions.md) -Defined in: [types/generate.ts:511](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L511) - Bounds for the per-call tool execution records surfaced on `GenerateResult.toolExecutions`. Capture is on by default (maxResultChars 8192, maxRecords 500); pass larger caps when the caller @@ -770,8 +708,6 @@ needs full result texts. > `optional` **disableToolCallRepair?**: `boolean` -Defined in: [types/generate.ts:513](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L513) - Disable the schema-driven tool call repair mechanism (BZ-665). Default: false (repair enabled). --- @@ -780,8 +716,6 @@ Disable the schema-driven tool call repair mechanism (BZ-665). Default: false (r > `optional` **disableTools?**: `boolean` -Defined in: [types/generate.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L533) - Disable tool execution (including built-in tools) Optional with schemas: the tools↔schema exclusion applies only to Google @@ -807,8 +741,6 @@ await neurolink.generate({ > `optional` **toolFilter?**: `string`[] -Defined in: [types/generate.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L536) - Include only these tools by name (whitelist). If set, only matching tools are available. --- @@ -817,8 +749,6 @@ Include only these tools by name (whitelist). If set, only matching tools are av > `optional` **excludeTools?**: `string`[] -Defined in: [types/generate.ts:539](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L539) - Exclude these tools by name (blacklist). Applied after toolFilter. --- @@ -827,8 +757,6 @@ Exclude these tools by name (blacklist). Applied after toolFilter. > `optional` **skipToolPromptInjection?**: `boolean` -Defined in: [types/generate.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L547) - Skip injecting tool schemas into the system prompt. When true, tools are ONLY passed natively via the provider's `tools` parameter, avoiding duplicate tool definitions (~30K tokens savings per call). @@ -840,8 +768,6 @@ Default: false (backward compatible — tool schemas are injected into system pr > `optional` **disableToolCache?**: `boolean` -Defined in: [types/generate.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L550) - Disable tool result caching for this request (overrides global mcp.cache.enabled) --- @@ -850,8 +776,6 @@ Disable tool result caching for this request (overrides global mcp.cache.enabled > `optional` **disableInternalFallback?**: `boolean` -Defined in: [types/generate.ts:564](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L564) - Disable NeuroLink's internal fallback for this request: the static provider-priority walk that runs when no provider was requested, and the catalog model-fallback walk a provider performs when its model is @@ -869,8 +793,6 @@ caller's own fallback and are unaffected. Mirrors the same flag on > `optional` **maxSteps?**: `number` -Defined in: [types/generate.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L567) - Maximum number of tool execution steps (default: 200) --- @@ -879,8 +801,6 @@ Maximum number of tool execution steps (default: 200) > `optional` **toolRoots?**: `string`[] -Defined in: [types/generate.ts:575](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L575) - Directories the built-in file tools and bash's `cwd` argument may touch for this call. Can only narrow the instance's `tools.fileRoots` (or the working-directory default); a root outside them is rejected before any @@ -892,8 +812,6 @@ model call. An empty array denies all file access. > `optional` **toolChoice?**: [`ToolChoice`](ToolChoice.md)\<`Record`\<`string`, [`Tool`](Tool.md)\>\> -Defined in: [types/generate.ts:590](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L590) - Tool choice configuration for the generation. Controls whether and which tools the model must call. @@ -912,8 +830,6 @@ will cause infinite tool calls until `maxSteps` is exhausted. > `optional` **prepareStep?**: (`options`) => `PromiseLike`\<\{ `model?`: [`LanguageModel`](LanguageModel.md); `toolChoice?`: [`ToolChoice`](ToolChoice.md)\<`Record`\<`string`, [`Tool`](Tool.md)\>\>; `experimental_activeTools?`: `string`[]; \} \| `undefined`\> -Defined in: [types/generate.ts:615](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L615) - Optional callback that runs before each step in a multi-step generation. Allows dynamically changing `toolChoice` and available tools per step. @@ -969,48 +885,36 @@ https://ai-sdk.dev/docs/reference/ai-sdk-core/generate-text#parameters > `optional` **enableEvaluation?**: `boolean` -Defined in: [types/generate.ts:630](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L630) - --- ### enableAnalytics? > `optional` **enableAnalytics?**: `boolean` -Defined in: [types/generate.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L631) - --- ### context? > `optional` **context?**: [`StandardRecord`](StandardRecord.md) -Defined in: [types/generate.ts:632](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L632) - --- ### evaluationDomain? > `optional` **evaluationDomain?**: `string` -Defined in: [types/generate.ts:635](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L635) - --- ### toolUsageContext? > `optional` **toolUsageContext?**: `string` -Defined in: [types/generate.ts:636](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L636) - --- ### ~~conversationHistory?~~ > `optional` **conversationHistory?**: `object`[] -Defined in: [types/generate.ts:643](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L643) - #### ~~role~~ > **role**: `string` @@ -1032,8 +936,6 @@ correctly wired through the entire generate pipeline. > `optional` **conversationMessages?**: [`ChatMessage`](ChatMessage.md)[] -Defined in: [types/generate.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L651) - Previous conversation as a ChatMessage array. Messages are injected as proper multi-turn conversation history before the current prompt, so the AI model sees them as real prior exchanges (not text dumped into the prompt). @@ -1045,8 +947,6 @@ Used by task continuation mode and available to external callers. > `optional` **factoryConfig?**: `object` -Defined in: [types/generate.ts:654](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L654) - #### domainType? > `optional` **domainType?**: `string` @@ -1073,8 +973,6 @@ Defined in: [types/generate.ts:654](https://github.com/juspay/neurolink/blob/rel > `optional` **streaming?**: `object` -Defined in: [types/generate.ts:668](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L668) - #### enabled? > `optional` **enabled?**: `boolean` @@ -1101,24 +999,18 @@ Defined in: [types/generate.ts:668](https://github.com/juspay/neurolink/blob/rel > `optional` **workflow?**: `string` -Defined in: [types/generate.ts:677](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L677) - --- ### workflowConfig? > `optional` **workflowConfig?**: [`WorkflowConfig`](WorkflowConfig.md) -Defined in: [types/generate.ts:678](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L678) - --- ### rag? > `optional` **rag?**: [`RAGConfig`](RAGConfig.md) -Defined in: [types/generate.ts:712](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L712) - RAG (Retrieval-Augmented Generation) configuration. When provided, NeuroLink automatically loads the specified files, chunks them, @@ -1156,8 +1048,6 @@ const result = await neurolink.generate({ > `optional` **maxBudgetUsd?**: `number` -Defined in: [types/generate.ts:727](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L727) - Maximum budget in USD for this session. When the accumulated cost of all generate() calls on this NeuroLink instance exceeds this value, subsequent calls will throw a budget-exceeded error before making the API request. @@ -1177,8 +1067,6 @@ const result = await neurolink.generate({ > `optional` **requestId?**: `string` -Defined in: [types/generate.ts:734](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L734) - Optional request identifier for observability and log correlation. When provided, this ID is forwarded to spans, logs, and telemetry so callers can correlate generation traces back to their own request lifecycle. @@ -1189,8 +1077,6 @@ callers can correlate generation traces back to their own request lifecycle. > `optional` **middleware?**: [`MiddlewareFactoryOptions`](MiddlewareFactoryOptions.md) -Defined in: [types/generate.ts:749](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L749) - Per-call middleware configuration. --- @@ -1199,8 +1085,6 @@ Per-call middleware configuration. > `optional` **onFinish?**: [`OnFinishCallback`](OnFinishCallback.md) -Defined in: [types/generate.ts:752](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L752) - Callback invoked when generation completes successfully. --- @@ -1209,8 +1093,6 @@ Callback invoked when generation completes successfully. > `optional` **onError?**: [`OnErrorCallback`](OnErrorCallback.md) -Defined in: [types/generate.ts:755](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L755) - Callback invoked when generation encounters an error. --- @@ -1219,8 +1101,6 @@ Callback invoked when generation encounters an error. > `optional` **requestContext?**: `Record`\<`string`, `unknown`\> -Defined in: [types/generate.ts:758](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L758) - Pre-validated user context for the request --- @@ -1229,8 +1109,6 @@ Pre-validated user context for the request > `optional` **useKnowledgeGrounding?**: `boolean` -Defined in: [types/generate.ts:764](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L764) - Opt this generation call into the knowledge grounding configured on the NeuroLink instance. Defaults to `false` when omitted. @@ -1240,8 +1118,6 @@ NeuroLink instance. Defaults to `false` when omitted. > `optional` **knowledgeContext?**: [`KnowledgeRequestScope`](KnowledgeRequestScope.md) -Defined in: [types/generate.ts:771](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L771) - Enabled integrations used to scope knowledge retrieval for this turn. Used only when `useKnowledgeGrounding` is true and knowledge grounding is enabled on the NeuroLink instance. @@ -1252,8 +1128,6 @@ enabled on the NeuroLink instance. > `optional` **auth?**: `object` -Defined in: [types/generate.ts:774](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L774) - Raw auth token — validated by configured auth provider #### token @@ -1266,8 +1140,6 @@ Raw auth token — validated by configured auth provider > `optional` **credentials?**: [`NeurolinkCredentials`](NeurolinkCredentials.md) -Defined in: [types/generate.ts:781](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L781) - Per-provider credential overrides for this request. Overrides instance-level credentials set in `new NeuroLink({ credentials })`. Unset providers fall through to instance credentials, then environment variables. @@ -1278,8 +1150,6 @@ Unset providers fall through to instance credentials, then environment variables > `optional` **providerFallback?**: (`error`) => `Promise`\<\{ `provider?`: `string`; `model?`: `string`; \} \| `null`\> -Defined in: [types/generate.ts:792](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L792) - Curator P2-3: per-call fallback callback. Overrides any instance-level `providerFallback` set on `new NeuroLink({...})`. Invoked for any error except a genuine caller cancel — i.e. this @@ -1304,8 +1174,6 @@ retry, `null` to bubble. > `optional` **modelChain?**: `string`[] -Defined in: [types/generate.ts:802](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L802) - Curator P2-3: per-call ordered model chain. Overrides any instance-level `modelChain`. Without an explicit `providerFallback` callback the chain only advances on model-access-denied errors — @@ -1317,8 +1185,6 @@ other failures (network, 5xx, timeouts) bubble immediately. > `optional` **memory?**: `object` -Defined in: [types/generate.ts:812](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L812) - Per-call memory control. Override the global memory SDK behavior for this specific call. @@ -1357,8 +1223,6 @@ Primary user is still determined by context.userId. > `optional` **piiDetection?**: `object` -Defined in: [types/generate.ts:831](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L831) - PII detection — scans and optionally redacts PII from input before the LLM call. #### enabled? @@ -1397,8 +1261,6 @@ PII detection — scans and optionally redacts PII from input before the LLM cal > `optional` **responseValidation?**: `object` -Defined in: [types/generate.ts:856](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L856) - Response validation — validates and optionally transforms the LLM response. Supports retry-with-feedback when `retryOnFailure: true`. @@ -1464,8 +1326,6 @@ Supports retry-with-feedback when `retryOnFailure: true`. > `optional` **inputValidation?**: `object` -Defined in: [types/generate.ts:874](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L874) - Input validation — validates input text before any processing. #### trimWhitespace? @@ -1490,8 +1350,6 @@ Input validation — validates input text before any processing. > `optional` **processors?**: [`ProcessorPipelineConfig`](ProcessorPipelineConfig.md) -Defined in: [types/generate.ts:884](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L884) - #### Deprecated Use `piiDetection`, `responseValidation`, and `inputValidation` instead. @@ -1502,8 +1360,6 @@ Use `piiDetection`, `responseValidation`, and `inputValidation` instead. > `optional` **skills?**: [`SkillsCallOptions`](SkillsCallOptions.md) -Defined in: [types/generate.ts:892](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L892) - Per-call skills control. Only effective when the instance was constructed with `skills.enabled: true`. Lets a call disable the prompt index, or narrow it by scope/tags. Per-call wins over diff --git a/docs/api/type-aliases/GenerateOptionsNormalized.md b/docs/api/type-aliases/GenerateOptionsNormalized.md index 536ffc1e9..97dfa25d0 100644 --- a/docs/api/type-aliases/GenerateOptionsNormalized.md +++ b/docs/api/type-aliases/GenerateOptionsNormalized.md @@ -8,8 +8,6 @@ > **GenerateOptionsNormalized** = [`GenerateOptions`](GenerateOptions.md) & `object` -Defined in: [types/generate.ts:1878](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1878) - Internal alias used by messageBuilder helpers after the entry-point (`buildMultimodalMessagesArray`) has guaranteed that `input` is non-null. All private helper functions that receive post-normalised options should diff --git a/docs/api/type-aliases/GenerateResult.md b/docs/api/type-aliases/GenerateResult.md index 341ea6a28..0c01fa5cc 100644 --- a/docs/api/type-aliases/GenerateResult.md +++ b/docs/api/type-aliases/GenerateResult.md @@ -8,8 +8,6 @@ > **GenerateResult** = `object` & [`MediaGenerationOutputs`](MediaGenerationOutputs.md) -Defined in: [types/generate.ts:1108](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1108) - Generate function result type - Primary output format Future-ready for multi-modal outputs while maintaining text focus diff --git a/docs/api/type-aliases/GenerateStopReason.md b/docs/api/type-aliases/GenerateStopReason.md index 22fe25779..216685873 100644 --- a/docs/api/type-aliases/GenerateStopReason.md +++ b/docs/api/type-aliases/GenerateStopReason.md @@ -8,8 +8,6 @@ > **GenerateStopReason** = `"completed"` \| `"step-cap"` \| `"context-cap"` \| `"time-limit"` \| `"stalled"` \| `"aborted"` \| `"provider-error"` -Defined in: [types/generate.ts:985](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L985) - Why an agentic turn ended — the discriminator consumers should branch on instead of sniffing the provider-shaped `finishReason` (whose values are overloaded: e.g. "tool-calls" historically covered both step-cap exits and diff --git a/docs/api/type-aliases/GenerateTextResult.md b/docs/api/type-aliases/GenerateTextResult.md index e1b2d6037..cabbf2a48 100644 --- a/docs/api/type-aliases/GenerateTextResult.md +++ b/docs/api/type-aliases/GenerateTextResult.md @@ -8,8 +8,6 @@ > **GenerateTextResult**\<`TOOLS`, `OUTPUT`\> = [`StepResult`](StepResult.md)\<`TOOLS`\> & `object` -Defined in: [types/aiCompat.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L574) - ## Type Declaration ### steps diff --git a/docs/api/type-aliases/GeneratedReport.md b/docs/api/type-aliases/GeneratedReport.md index 98fb630d4..81c2f3a44 100644 --- a/docs/api/type-aliases/GeneratedReport.md +++ b/docs/api/type-aliases/GeneratedReport.md @@ -8,8 +8,6 @@ > **GeneratedReport** = `object` -Defined in: [types/evaluation.ts:777](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L777) - Generated evaluation report envelope. ## Properties @@ -18,24 +16,18 @@ Generated evaluation report envelope. > **format**: [`ReportFormat`](ReportFormat.md) -Defined in: [types/evaluation.ts:778](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L778) - --- ### content > **content**: `string` -Defined in: [types/evaluation.ts:779](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L779) - --- ### metadata > **metadata**: `object` -Defined in: [types/evaluation.ts:780](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L780) - #### generatedAt > **generatedAt**: `number` diff --git a/docs/api/type-aliases/GenerationModelConfig.md b/docs/api/type-aliases/GenerationModelConfig.md index d0381c950..49a752093 100644 --- a/docs/api/type-aliases/GenerationModelConfig.md +++ b/docs/api/type-aliases/GenerationModelConfig.md @@ -8,8 +8,6 @@ > **GenerationModelConfig** = `object` -Defined in: [types/rag.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L241) - Generation model configuration ## Properties @@ -18,28 +16,20 @@ Generation model configuration > **provider**: `string` -Defined in: [types/rag.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L242) - --- ### modelName > **modelName**: `string` -Defined in: [types/rag.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L243) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/rag.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L244) - --- ### maxTokens? > `optional` **maxTokens?**: `number` - -Defined in: [types/rag.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L245) diff --git a/docs/api/type-aliases/GetPromptFunction.md b/docs/api/type-aliases/GetPromptFunction.md index b8d5b5928..ab257015c 100644 --- a/docs/api/type-aliases/GetPromptFunction.md +++ b/docs/api/type-aliases/GetPromptFunction.md @@ -8,8 +8,6 @@ > **GetPromptFunction** = (`context`) => `string` -Defined in: [types/evaluation.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L313) - A function that generates the main body of an evaluation prompt. ## Parameters diff --git a/docs/api/type-aliases/GitToolLogFormat.md b/docs/api/type-aliases/GitToolLogFormat.md index 2d1766edc..17894b0be 100644 --- a/docs/api/type-aliases/GitToolLogFormat.md +++ b/docs/api/type-aliases/GitToolLogFormat.md @@ -8,6 +8,4 @@ > **GitToolLogFormat** = `"oneline"` \| `"full"` \| `"stat"` \| `"name-only"` -Defined in: [types/gitTools.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L27) - How `git log` should render each commit. Presets only — never a raw format. diff --git a/docs/api/type-aliases/GitToolRefusal.md b/docs/api/type-aliases/GitToolRefusal.md index 17e64c0e7..6be8242b6 100644 --- a/docs/api/type-aliases/GitToolRefusal.md +++ b/docs/api/type-aliases/GitToolRefusal.md @@ -8,8 +8,6 @@ > **GitToolRefusal** = `object` -Defined in: [types/gitTools.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L71) - Refusal shape shared with the agent tool registrar: recovery text included. ## Properties @@ -18,12 +16,8 @@ Refusal shape shared with the agent tool registrar: recovery text included. > **isError**: `true` -Defined in: [types/gitTools.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L71) - --- ### error > **error**: `string` - -Defined in: [types/gitTools.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L71) diff --git a/docs/api/type-aliases/GitToolResult.md b/docs/api/type-aliases/GitToolResult.md index 56313e5aa..53556bc65 100644 --- a/docs/api/type-aliases/GitToolResult.md +++ b/docs/api/type-aliases/GitToolResult.md @@ -8,8 +8,6 @@ > **GitToolResult** = `object` -Defined in: [types/gitTools.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L53) - What every git tool returns. `preview` is a bounded head slice for the conversation; `output` points at @@ -22,8 +20,6 @@ preview looks empty may still have banked megabytes. > **command**: `string`[] -Defined in: [types/gitTools.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L55) - The exact argv that ran, so the result is reproducible by hand. --- @@ -32,8 +28,6 @@ The exact argv that ran, so the result is reproducible by hand. > **ok**: `boolean` -Defined in: [types/gitTools.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L57) - True when git exited 0. --- @@ -42,24 +36,18 @@ True when git exited 0. > `optional` **exitCode?**: `number` -Defined in: [types/gitTools.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L58) - --- ### state > **state**: [`BackgroundCommandState`](BackgroundCommandState.md) -Defined in: [types/gitTools.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L59) - --- ### preview > **preview**: `string` -Defined in: [types/gitTools.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L61) - Bounded head slice of stdout. --- @@ -68,8 +56,6 @@ Bounded head slice of stdout. > **output**: [`BankedArtifactRef`](BankedArtifactRef.md) -Defined in: [types/gitTools.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L63) - The FULL stdout, banked (N3). --- @@ -78,8 +64,6 @@ The FULL stdout, banked (N3). > **readBackHint**: `string` -Defined in: [types/gitTools.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L65) - Literal `retrieve_context` call that reads the rest of stdout. --- @@ -88,6 +72,4 @@ Literal `retrieve_context` call that reads the rest of stdout. > `optional` **stderrPreview?**: `string` -Defined in: [types/gitTools.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L67) - Bounded head slice of stderr, present only when git wrote something there. diff --git a/docs/api/type-aliases/GitToolRuntimeSettings.md b/docs/api/type-aliases/GitToolRuntimeSettings.md index 895c5ce7e..1219ba423 100644 --- a/docs/api/type-aliases/GitToolRuntimeSettings.md +++ b/docs/api/type-aliases/GitToolRuntimeSettings.md @@ -8,8 +8,6 @@ > **GitToolRuntimeSettings** = `object` -Defined in: [types/gitTools.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L83) - Resolved git toolset settings for one host. Deliberately not marked internal: it is the return type of @@ -25,36 +23,26 @@ in the doc comment, so it cannot even be named here to explain itself.) > **repoRoot**: `string` -Defined in: [types/gitTools.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L84) - --- ### timeoutMs > **timeoutMs**: `number` -Defined in: [types/gitTools.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L85) - --- ### maxOutputBytes > **maxOutputBytes**: `number` -Defined in: [types/gitTools.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L86) - --- ### previewChars > **previewChars**: `number` -Defined in: [types/gitTools.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L87) - --- ### gitExecutable > **gitExecutable**: `string` - -Defined in: [types/gitTools.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L88) diff --git a/docs/api/type-aliases/GitToolsetOptions.md b/docs/api/type-aliases/GitToolsetOptions.md index 288c1f2ad..3aa84881b 100644 --- a/docs/api/type-aliases/GitToolsetOptions.md +++ b/docs/api/type-aliases/GitToolsetOptions.md @@ -8,8 +8,6 @@ > **GitToolsetOptions** = `object` -Defined in: [types/gitTools.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L30) - Options for `NeuroLink.registerGitTools()`. ## Properties @@ -18,8 +16,6 @@ Options for `NeuroLink.registerGitTools()`. > **repoRoot**: `string` -Defined in: [types/gitTools.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L35) - Repository root. Every git tool runs here, and every path argument must resolve inside it. @@ -29,8 +25,6 @@ resolve inside it. > `optional` **timeoutMs?**: `number` -Defined in: [types/gitTools.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L37) - Wall-clock budget per git invocation (ms). Default 60_000. --- @@ -39,8 +33,6 @@ Wall-clock budget per git invocation (ms). Default 60_000. > `optional` **maxOutputBytes?**: `number` -Defined in: [types/gitTools.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L39) - Byte cap per stream. Default 33_554_432 (a big diff is still a diff). --- @@ -49,8 +41,6 @@ Byte cap per stream. Default 33_554_432 (a big diff is still a diff). > `optional` **previewChars?**: `number` -Defined in: [types/gitTools.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L41) - Characters of output returned inline. Default 2000, hard cap 4000. --- @@ -59,6 +49,4 @@ Characters of output returned inline. Default 2000, hard cap 4000. > `optional` **gitExecutable?**: `string` -Defined in: [types/gitTools.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L43) - Executable to run. Default "git"; name an absolute path to pin it. diff --git a/docs/api/type-aliases/GlobalInstallerExecFile.md b/docs/api/type-aliases/GlobalInstallerExecFile.md index 557cdfa77..081e61231 100644 --- a/docs/api/type-aliases/GlobalInstallerExecFile.md +++ b/docs/api/type-aliases/GlobalInstallerExecFile.md @@ -8,6 +8,4 @@ > **GlobalInstallerExecFile** = `execFileSync` -Defined in: [types/proxy.ts:3307](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3307) - Injectable command runner used by global-installer tests. diff --git a/docs/api/type-aliases/GlobalInstallerKind.md b/docs/api/type-aliases/GlobalInstallerKind.md index 2d85b6f78..0c331e01e 100644 --- a/docs/api/type-aliases/GlobalInstallerKind.md +++ b/docs/api/type-aliases/GlobalInstallerKind.md @@ -8,6 +8,4 @@ > **GlobalInstallerKind** = `"npm"` \| `"pnpm"` -Defined in: [types/proxy.ts:3285](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3285) - Supported global package managers for proxy self-updates. diff --git a/docs/api/type-aliases/GlobalInstallerProbe.md b/docs/api/type-aliases/GlobalInstallerProbe.md index e749a6acf..efbcc9ef0 100644 --- a/docs/api/type-aliases/GlobalInstallerProbe.md +++ b/docs/api/type-aliases/GlobalInstallerProbe.md @@ -8,8 +8,6 @@ > **GlobalInstallerProbe** = `object` -Defined in: [types/proxy.ts:3288](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3288) - Result of probing one global package-manager executable. ## Properties @@ -18,68 +16,50 @@ Result of probing one global package-manager executable. > **kind**: [`GlobalInstallerKind`](GlobalInstallerKind.md) -Defined in: [types/proxy.ts:3289](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3289) - --- ### bin > **bin**: `string` -Defined in: [types/proxy.ts:3290](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3290) - --- ### version? > `optional` **version?**: `string` -Defined in: [types/proxy.ts:3291](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3291) - --- ### globalRoot? > `optional` **globalRoot?**: `string` -Defined in: [types/proxy.ts:3292](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3292) - --- ### globalBinDir? > `optional` **globalBinDir?**: `string` -Defined in: [types/proxy.ts:3293](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3293) - --- ### working > **working**: `boolean` -Defined in: [types/proxy.ts:3294](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3294) - --- ### installable > **installable**: `boolean` -Defined in: [types/proxy.ts:3295](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3295) - --- ### matchesCurrentInstall > **matchesCurrentInstall**: `boolean` -Defined in: [types/proxy.ts:3296](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3296) - --- ### reason? > `optional` **reason?**: `string` - -Defined in: [types/proxy.ts:3297](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3297) diff --git a/docs/api/type-aliases/GlobalInstallerResolution.md b/docs/api/type-aliases/GlobalInstallerResolution.md index 974139cf9..52c8090ad 100644 --- a/docs/api/type-aliases/GlobalInstallerResolution.md +++ b/docs/api/type-aliases/GlobalInstallerResolution.md @@ -8,8 +8,6 @@ > **GlobalInstallerResolution** = `object` -Defined in: [types/proxy.ts:3301](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3301) - Selected package manager plus all candidates considered. ## Properties @@ -18,12 +16,8 @@ Selected package manager plus all candidates considered. > `optional` **installer?**: [`GlobalInstallerProbe`](GlobalInstallerProbe.md) -Defined in: [types/proxy.ts:3302](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3302) - --- ### tried > **tried**: [`GlobalInstallerProbe`](GlobalInstallerProbe.md)[] - -Defined in: [types/proxy.ts:3303](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3303) diff --git a/docs/api/type-aliases/GoogleAudioConfig.md b/docs/api/type-aliases/GoogleAudioConfig.md index 719d8e8ac..2b26161a8 100644 --- a/docs/api/type-aliases/GoogleAudioConfig.md +++ b/docs/api/type-aliases/GoogleAudioConfig.md @@ -8,52 +8,38 @@ > **GoogleAudioConfig** = `object` -Defined in: [types/stt.ts:633](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L633) - ## Properties ### audioEncoding > **audioEncoding**: `string` -Defined in: [types/stt.ts:634](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L634) - --- ### speakingRate? > `optional` **speakingRate?**: `number` -Defined in: [types/stt.ts:635](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L635) - --- ### pitch? > `optional` **pitch?**: `number` -Defined in: [types/stt.ts:636](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L636) - --- ### volumeGainDb? > `optional` **volumeGainDb?**: `number` -Defined in: [types/stt.ts:637](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L637) - --- ### sampleRateHertz? > `optional` **sampleRateHertz?**: `number` -Defined in: [types/stt.ts:638](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L638) - --- ### effectsProfileId? > `optional` **effectsProfileId?**: `string`[] - -Defined in: [types/stt.ts:639](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L639) diff --git a/docs/api/type-aliases/GoogleAudioEncoding.md b/docs/api/type-aliases/GoogleAudioEncoding.md index 9f418436f..90d18820f 100644 --- a/docs/api/type-aliases/GoogleAudioEncoding.md +++ b/docs/api/type-aliases/GoogleAudioEncoding.md @@ -8,6 +8,4 @@ > **GoogleAudioEncoding** = `"MP3"` \| `"LINEAR16"` \| `"OGG_OPUS"` -Defined in: [types/tts.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/tts.ts#L227) - Valid Google TTS audio formats diff --git a/docs/api/type-aliases/GoogleFilesAPIUploadResult.md b/docs/api/type-aliases/GoogleFilesAPIUploadResult.md index 14d50519c..6a33ff8a1 100644 --- a/docs/api/type-aliases/GoogleFilesAPIUploadResult.md +++ b/docs/api/type-aliases/GoogleFilesAPIUploadResult.md @@ -8,8 +8,6 @@ > **GoogleFilesAPIUploadResult** = `object` -Defined in: [types/file.ts:717](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L717) - Google AI Studio Files API types ## Properties @@ -18,8 +16,6 @@ Google AI Studio Files API types > **file**: `object` -Defined in: [types/file.ts:718](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L718) - #### name > **name**: `string` diff --git a/docs/api/type-aliases/GoogleGenAIClass.md b/docs/api/type-aliases/GoogleGenAIClass.md index 579227873..0e8773b34 100644 --- a/docs/api/type-aliases/GoogleGenAIClass.md +++ b/docs/api/type-aliases/GoogleGenAIClass.md @@ -8,8 +8,6 @@ > **GoogleGenAIClass** = (`cfg`) => [`GenAIClient`](GenAIClient.md) -Defined in: [types/providers.ts:1304](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1304) - Google GenAI constructor type Supports both API key (Google AI Studio) and Vertex AI configurations diff --git a/docs/api/type-aliases/GoogleGenAIHttpOptions.md b/docs/api/type-aliases/GoogleGenAIHttpOptions.md index ba91749e8..bfa5b7222 100644 --- a/docs/api/type-aliases/GoogleGenAIHttpOptions.md +++ b/docs/api/type-aliases/GoogleGenAIHttpOptions.md @@ -8,8 +8,6 @@ > **GoogleGenAIHttpOptions** = `object` -Defined in: [types/providers.ts:1293](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1293) - HTTP options for Google GenAI SDK Allows custom fetch implementation for proxy support @@ -19,8 +17,6 @@ Allows custom fetch implementation for proxy support > `optional` **fetch?**: _typeof_ `fetch` -Defined in: [types/providers.ts:1295](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1295) - Custom fetch implementation for proxy support --- @@ -29,6 +25,4 @@ Custom fetch implementation for proxy support > `optional` **baseUrl?**: `string` -Defined in: [types/providers.ts:1297](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1297) - Override the API base URL (e.g. a corporate proxy or mock endpoint) diff --git a/docs/api/type-aliases/GoogleListVoicesResponse.md b/docs/api/type-aliases/GoogleListVoicesResponse.md index 399ab9007..2b8ee69db 100644 --- a/docs/api/type-aliases/GoogleListVoicesResponse.md +++ b/docs/api/type-aliases/GoogleListVoicesResponse.md @@ -8,12 +8,8 @@ > **GoogleListVoicesResponse** = `object` -Defined in: [types/stt.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L666) - ## Properties ### voices > **voices**: [`GoogleVoiceInfo`](GoogleVoiceInfo.md)[] - -Defined in: [types/stt.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L667) diff --git a/docs/api/type-aliases/GoogleLiveAudioQueueItem.md b/docs/api/type-aliases/GoogleLiveAudioQueueItem.md index 7e5676202..7cc257aba 100644 --- a/docs/api/type-aliases/GoogleLiveAudioQueueItem.md +++ b/docs/api/type-aliases/GoogleLiveAudioQueueItem.md @@ -8,7 +8,5 @@ > **GoogleLiveAudioQueueItem** = \{ `type`: `"audio"`; `audio`: [`AudioChunk`](AudioChunk.md); \} \| \{ `type`: `"end"`; \} \| \{ `type`: `"error"`; `error`: `unknown`; \} -Defined in: [types/providers.ts:2467](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2467) - Event pushed through the Google AI Studio voice session's internal queue while audio chunks stream back from the Gemini Live API. diff --git a/docs/api/type-aliases/GoogleLongRunningRecognizeResponse.md b/docs/api/type-aliases/GoogleLongRunningRecognizeResponse.md index 2b5b4a4ba..0f60a72ec 100644 --- a/docs/api/type-aliases/GoogleLongRunningRecognizeResponse.md +++ b/docs/api/type-aliases/GoogleLongRunningRecognizeResponse.md @@ -8,20 +8,14 @@ > **GoogleLongRunningRecognizeResponse** = `object` -Defined in: [types/stt.ts:516](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L516) - ## Properties ### results > **results**: [`GoogleSpeechRecognitionResult`](GoogleSpeechRecognitionResult.md)[] -Defined in: [types/stt.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L517) - --- ### totalBilledTime? > `optional` **totalBilledTime?**: `string` - -Defined in: [types/stt.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L518) diff --git a/docs/api/type-aliases/GoogleOperationResponse.md b/docs/api/type-aliases/GoogleOperationResponse.md index 2281b46b6..5e2572505 100644 --- a/docs/api/type-aliases/GoogleOperationResponse.md +++ b/docs/api/type-aliases/GoogleOperationResponse.md @@ -8,32 +8,24 @@ > **GoogleOperationResponse** = `object` -Defined in: [types/stt.ts:526](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L526) - ## Properties ### name > **name**: `string` -Defined in: [types/stt.ts:527](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L527) - --- ### done > **done**: `boolean` -Defined in: [types/stt.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L528) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/stt.ts:529](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L529) - #### progressPercent? > `optional` **progressPercent?**: `number` @@ -52,16 +44,12 @@ Defined in: [types/stt.ts:529](https://github.com/juspay/neurolink/blob/release/ > `optional` **response?**: [`GoogleLongRunningRecognizeResponse`](GoogleLongRunningRecognizeResponse.md) -Defined in: [types/stt.ts:534](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L534) - --- ### error? > `optional` **error?**: `object` -Defined in: [types/stt.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L535) - #### code > **code**: `number` diff --git a/docs/api/type-aliases/GoogleRecognitionAudio.md b/docs/api/type-aliases/GoogleRecognitionAudio.md index 52eb74bf8..4819599b3 100644 --- a/docs/api/type-aliases/GoogleRecognitionAudio.md +++ b/docs/api/type-aliases/GoogleRecognitionAudio.md @@ -8,12 +8,8 @@ > **GoogleRecognitionAudio** = `object` -Defined in: [types/stt.ts:556](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L556) - ## Properties ### content > **content**: `string` - -Defined in: [types/stt.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L557) diff --git a/docs/api/type-aliases/GoogleRecognitionConfig.md b/docs/api/type-aliases/GoogleRecognitionConfig.md index ffd5ff600..fce858d57 100644 --- a/docs/api/type-aliases/GoogleRecognitionConfig.md +++ b/docs/api/type-aliases/GoogleRecognitionConfig.md @@ -8,100 +8,74 @@ > **GoogleRecognitionConfig** = `object` -Defined in: [types/stt.ts:541](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L541) - ## Properties ### encoding > **encoding**: `string` -Defined in: [types/stt.ts:542](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L542) - --- ### sampleRateHertz? > `optional` **sampleRateHertz?**: `number` -Defined in: [types/stt.ts:543](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L543) - --- ### languageCode > **languageCode**: `string` -Defined in: [types/stt.ts:544](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L544) - --- ### enableAutomaticPunctuation? > `optional` **enableAutomaticPunctuation?**: `boolean` -Defined in: [types/stt.ts:545](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L545) - --- ### enableWordTimeOffsets? > `optional` **enableWordTimeOffsets?**: `boolean` -Defined in: [types/stt.ts:546](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L546) - --- ### enableWordConfidence? > `optional` **enableWordConfidence?**: `boolean` -Defined in: [types/stt.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L547) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/stt.ts:548](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L548) - --- ### useEnhanced? > `optional` **useEnhanced?**: `boolean` -Defined in: [types/stt.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L549) - --- ### maxAlternatives? > `optional` **maxAlternatives?**: `number` -Defined in: [types/stt.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L550) - --- ### profanityFilter? > `optional` **profanityFilter?**: `boolean` -Defined in: [types/stt.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L551) - --- ### enableSpeakerDiarization? > `optional` **enableSpeakerDiarization?**: `boolean` -Defined in: [types/stt.ts:552](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L552) - --- ### diarizationSpeakerCount? > `optional` **diarizationSpeakerCount?**: `number` - -Defined in: [types/stt.ts:553](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L553) diff --git a/docs/api/type-aliases/GoogleRecognizeResponse.md b/docs/api/type-aliases/GoogleRecognizeResponse.md index 8882dfde1..641efee8e 100644 --- a/docs/api/type-aliases/GoogleRecognizeResponse.md +++ b/docs/api/type-aliases/GoogleRecognizeResponse.md @@ -8,20 +8,14 @@ > **GoogleRecognizeResponse** = `object` -Defined in: [types/stt.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L521) - ## Properties ### results? > `optional` **results?**: [`GoogleSpeechRecognitionResult`](GoogleSpeechRecognitionResult.md)[] -Defined in: [types/stt.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L522) - --- ### totalBilledTime? > `optional` **totalBilledTime?**: `string` - -Defined in: [types/stt.ts:523](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L523) diff --git a/docs/api/type-aliases/GoogleSTTAudioEncoding.md b/docs/api/type-aliases/GoogleSTTAudioEncoding.md index a66b1f5c1..dedb6443e 100644 --- a/docs/api/type-aliases/GoogleSTTAudioEncoding.md +++ b/docs/api/type-aliases/GoogleSTTAudioEncoding.md @@ -7,5 +7,3 @@ # Type Alias: GoogleSTTAudioEncoding > **GoogleSTTAudioEncoding** = `"ENCODING_UNSPECIFIED"` \| `"LINEAR16"` \| `"FLAC"` \| `"MULAW"` \| `"AMR"` \| `"AMR_WB"` \| `"OGG_OPUS"` \| `"SPEEX_WITH_HEADER_BYTE"` \| `"MP3"` \| `"WEBM_OPUS"` - -Defined in: [types/stt.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L345) diff --git a/docs/api/type-aliases/GoogleSTTModel.md b/docs/api/type-aliases/GoogleSTTModel.md index 931756560..1e03ff3d1 100644 --- a/docs/api/type-aliases/GoogleSTTModel.md +++ b/docs/api/type-aliases/GoogleSTTModel.md @@ -7,5 +7,3 @@ # Type Alias: GoogleSTTModel > **GoogleSTTModel** = `"latest_short"` \| `"latest_long"` \| `"telephony"` \| `"medical_conversation"` \| `"medical_dictation"` \| `"command_and_search"` \| `"phone_call"` \| `"video"` \| `"default"` - -Defined in: [types/stt.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L334) diff --git a/docs/api/type-aliases/GoogleSTTOptions.md b/docs/api/type-aliases/GoogleSTTOptions.md index 484c027bc..1c386cd51 100644 --- a/docs/api/type-aliases/GoogleSTTOptions.md +++ b/docs/api/type-aliases/GoogleSTTOptions.md @@ -8,8 +8,6 @@ > **GoogleSTTOptions** = [`STTOptions`](STTOptions.md) & `object` -Defined in: [types/stt.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L357) - ## Type Declaration ### model? diff --git a/docs/api/type-aliases/GoogleSpeechRecognitionAlternative.md b/docs/api/type-aliases/GoogleSpeechRecognitionAlternative.md index 3695aedeb..56295f6e1 100644 --- a/docs/api/type-aliases/GoogleSpeechRecognitionAlternative.md +++ b/docs/api/type-aliases/GoogleSpeechRecognitionAlternative.md @@ -8,28 +8,20 @@ > **GoogleSpeechRecognitionAlternative** = `object` -Defined in: [types/stt.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L503) - ## Properties ### transcript > **transcript**: `string` -Defined in: [types/stt.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L504) - --- ### confidence > **confidence**: `number` -Defined in: [types/stt.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L505) - --- ### words? > `optional` **words?**: [`GoogleWordInfo`](GoogleWordInfo.md)[] - -Defined in: [types/stt.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L506) diff --git a/docs/api/type-aliases/GoogleSpeechRecognitionResult.md b/docs/api/type-aliases/GoogleSpeechRecognitionResult.md index 21f0ff371..2c7564ed2 100644 --- a/docs/api/type-aliases/GoogleSpeechRecognitionResult.md +++ b/docs/api/type-aliases/GoogleSpeechRecognitionResult.md @@ -8,36 +8,26 @@ > **GoogleSpeechRecognitionResult** = `object` -Defined in: [types/stt.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L509) - ## Properties ### alternatives > **alternatives**: [`GoogleSpeechRecognitionAlternative`](GoogleSpeechRecognitionAlternative.md)[] -Defined in: [types/stt.ts:510](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L510) - --- ### channelTag? > `optional` **channelTag?**: `number` -Defined in: [types/stt.ts:511](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L511) - --- ### languageCode? > `optional` **languageCode?**: `string` -Defined in: [types/stt.ts:512](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L512) - --- ### resultEndTime? > `optional` **resultEndTime?**: `string` - -Defined in: [types/stt.ts:513](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L513) diff --git a/docs/api/type-aliases/GoogleSynthesisInput.md b/docs/api/type-aliases/GoogleSynthesisInput.md index 779e0ff5e..61ddb125d 100644 --- a/docs/api/type-aliases/GoogleSynthesisInput.md +++ b/docs/api/type-aliases/GoogleSynthesisInput.md @@ -8,20 +8,14 @@ > **GoogleSynthesisInput** = `object` -Defined in: [types/stt.ts:648](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L648) - ## Properties ### text? > `optional` **text?**: `string` -Defined in: [types/stt.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L649) - --- ### ssml? > `optional` **ssml?**: `string` - -Defined in: [types/stt.ts:650](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L650) diff --git a/docs/api/type-aliases/GoogleSynthesizeRequest.md b/docs/api/type-aliases/GoogleSynthesizeRequest.md index 2d2cd0f07..b79b5a80c 100644 --- a/docs/api/type-aliases/GoogleSynthesizeRequest.md +++ b/docs/api/type-aliases/GoogleSynthesizeRequest.md @@ -8,28 +8,20 @@ > **GoogleSynthesizeRequest** = `object` -Defined in: [types/stt.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L653) - ## Properties ### input > **input**: [`GoogleSynthesisInput`](GoogleSynthesisInput.md) -Defined in: [types/stt.ts:654](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L654) - --- ### voice > **voice**: [`GoogleVoiceSelectionParams`](GoogleVoiceSelectionParams.md) -Defined in: [types/stt.ts:655](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L655) - --- ### audioConfig > **audioConfig**: [`GoogleAudioConfig`](GoogleAudioConfig.md) - -Defined in: [types/stt.ts:656](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L656) diff --git a/docs/api/type-aliases/GoogleSynthesizeResponse.md b/docs/api/type-aliases/GoogleSynthesizeResponse.md index 05345250a..458d38973 100644 --- a/docs/api/type-aliases/GoogleSynthesizeResponse.md +++ b/docs/api/type-aliases/GoogleSynthesizeResponse.md @@ -8,12 +8,8 @@ > **GoogleSynthesizeResponse** = `object` -Defined in: [types/stt.ts:670](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L670) - ## Properties ### audioContent > **audioContent**: `string` - -Defined in: [types/stt.ts:671](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L671) diff --git a/docs/api/type-aliases/GoogleTTSOptions.md b/docs/api/type-aliases/GoogleTTSOptions.md index 2b448d661..9b1f7bea1 100644 --- a/docs/api/type-aliases/GoogleTTSOptions.md +++ b/docs/api/type-aliases/GoogleTTSOptions.md @@ -8,8 +8,6 @@ > **GoogleTTSOptions** = [`TTSOptions`](TTSOptions.md) & `object` -Defined in: [types/voice.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L491) - ## Type Declaration ### voiceType? diff --git a/docs/api/type-aliases/GoogleVertexProviderSettings.md b/docs/api/type-aliases/GoogleVertexProviderSettings.md index e45aa4aba..420c8b651 100644 --- a/docs/api/type-aliases/GoogleVertexProviderSettings.md +++ b/docs/api/type-aliases/GoogleVertexProviderSettings.md @@ -8,8 +8,6 @@ > **GoogleVertexProviderSettings** = `object` -Defined in: [types/providers.ts:1326](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1326) - Google Vertex AI provider settings for native SDK configuration Used with @google/genai SDK in vertexai mode @@ -22,8 +20,6 @@ or the temporary credentials file approach, not through these settings fields. > **project**: `string` -Defined in: [types/providers.ts:1328](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1328) - Google Cloud project ID --- @@ -32,8 +28,6 @@ Google Cloud project ID > **location**: `string` -Defined in: [types/providers.ts:1330](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1330) - Google Cloud region/location (e.g., 'us-central1') --- @@ -42,6 +36,4 @@ Google Cloud region/location (e.g., 'us-central1') > `optional` **fetch?**: _typeof_ `fetch` -Defined in: [types/providers.ts:1332](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1332) - Optional custom fetch implementation diff --git a/docs/api/type-aliases/GoogleVoiceInfo.md b/docs/api/type-aliases/GoogleVoiceInfo.md index b1102ce8d..4073afd44 100644 --- a/docs/api/type-aliases/GoogleVoiceInfo.md +++ b/docs/api/type-aliases/GoogleVoiceInfo.md @@ -8,36 +8,26 @@ > **GoogleVoiceInfo** = `object` -Defined in: [types/stt.ts:659](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L659) - ## Properties ### languageCodes > **languageCodes**: `string`[] -Defined in: [types/stt.ts:660](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L660) - --- ### name > **name**: `string` -Defined in: [types/stt.ts:661](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L661) - --- ### ssmlGender > **ssmlGender**: `string` -Defined in: [types/stt.ts:662](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L662) - --- ### naturalSampleRateHertz > **naturalSampleRateHertz**: `number` - -Defined in: [types/stt.ts:663](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L663) diff --git a/docs/api/type-aliases/GoogleVoiceSelectionParams.md b/docs/api/type-aliases/GoogleVoiceSelectionParams.md index 58e2862e6..037beadca 100644 --- a/docs/api/type-aliases/GoogleVoiceSelectionParams.md +++ b/docs/api/type-aliases/GoogleVoiceSelectionParams.md @@ -8,28 +8,20 @@ > **GoogleVoiceSelectionParams** = `object` -Defined in: [types/stt.ts:642](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L642) - ## Properties ### languageCode > **languageCode**: `string` -Defined in: [types/stt.ts:643](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L643) - --- ### name? > `optional` **name?**: `string` -Defined in: [types/stt.ts:644](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L644) - --- ### ssmlGender? > `optional` **ssmlGender?**: `string` - -Defined in: [types/stt.ts:645](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L645) diff --git a/docs/api/type-aliases/GoogleVoiceType.md b/docs/api/type-aliases/GoogleVoiceType.md index 4a4fbf6d5..17907e0d3 100644 --- a/docs/api/type-aliases/GoogleVoiceType.md +++ b/docs/api/type-aliases/GoogleVoiceType.md @@ -7,5 +7,3 @@ # Type Alias: GoogleVoiceType > **GoogleVoiceType** = `"Standard"` \| `"WaveNet"` \| `"Neural2"` \| `"Studio"` \| `"Polyglot"` - -Defined in: [types/voice.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L484) diff --git a/docs/api/type-aliases/GoogleWordInfo.md b/docs/api/type-aliases/GoogleWordInfo.md index b20ec3644..5771a33cc 100644 --- a/docs/api/type-aliases/GoogleWordInfo.md +++ b/docs/api/type-aliases/GoogleWordInfo.md @@ -8,44 +8,32 @@ > **GoogleWordInfo** = `object` -Defined in: [types/stt.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L495) - ## Properties ### startTime > **startTime**: `string` -Defined in: [types/stt.ts:496](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L496) - --- ### endTime > **endTime**: `string` -Defined in: [types/stt.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L497) - --- ### word > **word**: `string` -Defined in: [types/stt.ts:498](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L498) - --- ### confidence? > `optional` **confidence?**: `number` -Defined in: [types/stt.ts:499](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L499) - --- ### speakerTag? > `optional` **speakerTag?**: `number` - -Defined in: [types/stt.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L500) diff --git a/docs/api/type-aliases/GraphChunk.md b/docs/api/type-aliases/GraphChunk.md index d184dee60..c0aea2256 100644 --- a/docs/api/type-aliases/GraphChunk.md +++ b/docs/api/type-aliases/GraphChunk.md @@ -8,8 +8,6 @@ > **GraphChunk** = `object` -Defined in: [types/rag.ts:1411](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1411) - Chunk input for graph creation ## Properties @@ -18,8 +16,6 @@ Chunk input for graph creation > **text**: `string` -Defined in: [types/rag.ts:1413](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1413) - Chunk text content --- @@ -28,6 +24,4 @@ Chunk text content > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1415](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1415) - Chunk metadata diff --git a/docs/api/type-aliases/GraphEdge.md b/docs/api/type-aliases/GraphEdge.md index a2d04dc60..83493a360 100644 --- a/docs/api/type-aliases/GraphEdge.md +++ b/docs/api/type-aliases/GraphEdge.md @@ -8,8 +8,6 @@ > **GraphEdge** = `object` -Defined in: [types/rag.ts:1397](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1397) - Graph edge representing semantic relationship ## Properties @@ -18,8 +16,6 @@ Graph edge representing semantic relationship > **source**: `string` -Defined in: [types/rag.ts:1399](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1399) - Source node ID --- @@ -28,8 +24,6 @@ Source node ID > **target**: `string` -Defined in: [types/rag.ts:1401](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1401) - Target node ID --- @@ -38,8 +32,6 @@ Target node ID > **weight**: `number` -Defined in: [types/rag.ts:1403](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1403) - Edge weight (similarity score) --- @@ -48,6 +40,4 @@ Edge weight (similarity score) > `optional` **type?**: `string` -Defined in: [types/rag.ts:1405](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1405) - Edge type diff --git a/docs/api/type-aliases/GraphEmbedding.md b/docs/api/type-aliases/GraphEmbedding.md index 2f01b4b2f..28763d0be 100644 --- a/docs/api/type-aliases/GraphEmbedding.md +++ b/docs/api/type-aliases/GraphEmbedding.md @@ -8,8 +8,6 @@ > **GraphEmbedding** = `object` -Defined in: [types/rag.ts:1421](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1421) - Embedding input for graph creation ## Properties @@ -18,6 +16,4 @@ Embedding input for graph creation > **vector**: `number`[] -Defined in: [types/rag.ts:1423](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1423) - Embedding vector diff --git a/docs/api/type-aliases/GraphNode.md b/docs/api/type-aliases/GraphNode.md index 8216cf49d..dab57b03a 100644 --- a/docs/api/type-aliases/GraphNode.md +++ b/docs/api/type-aliases/GraphNode.md @@ -8,8 +8,6 @@ > **GraphNode** = `object` -Defined in: [types/rag.ts:1383](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1383) - Graph node representing a document chunk ## Properties @@ -18,8 +16,6 @@ Graph node representing a document chunk > **id**: `string` -Defined in: [types/rag.ts:1385](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1385) - Unique node identifier --- @@ -28,8 +24,6 @@ Unique node identifier > **content**: `string` -Defined in: [types/rag.ts:1387](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1387) - Text content of the node --- @@ -38,8 +32,6 @@ Text content of the node > **metadata**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1389](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1389) - Node metadata --- @@ -48,6 +40,4 @@ Node metadata > `optional` **embedding?**: `number`[] -Defined in: [types/rag.ts:1391](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1391) - Embedding vector diff --git a/docs/api/type-aliases/GraphQueryParams.md b/docs/api/type-aliases/GraphQueryParams.md index 2bddb3f35..0615752b1 100644 --- a/docs/api/type-aliases/GraphQueryParams.md +++ b/docs/api/type-aliases/GraphQueryParams.md @@ -8,8 +8,6 @@ > **GraphQueryParams** = `object` -Defined in: [types/rag.ts:1453](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1453) - Graph query parameters ## Properties @@ -18,8 +16,6 @@ Graph query parameters > **query**: `number`[] -Defined in: [types/rag.ts:1455](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1455) - Query embedding vector --- @@ -28,8 +24,6 @@ Query embedding vector > `optional` **topK?**: `number` -Defined in: [types/rag.ts:1457](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1457) - Number of results to return (default: 10) --- @@ -38,8 +32,6 @@ Number of results to return (default: 10) > `optional` **randomWalkSteps?**: `number` -Defined in: [types/rag.ts:1459](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1459) - Random walk steps (default: 100) --- @@ -48,6 +40,4 @@ Random walk steps (default: 100) > `optional` **restartProb?**: `number` -Defined in: [types/rag.ts:1461](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1461) - Restart probability for random walk (default: 0.15) diff --git a/docs/api/type-aliases/GraphRAGConfig.md b/docs/api/type-aliases/GraphRAGConfig.md index 38eb02693..09b0ee00a 100644 --- a/docs/api/type-aliases/GraphRAGConfig.md +++ b/docs/api/type-aliases/GraphRAGConfig.md @@ -8,8 +8,6 @@ > **GraphRAGConfig** = `object` -Defined in: [types/rag.ts:1443](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1443) - Graph RAG configuration ## Properties @@ -18,8 +16,6 @@ Graph RAG configuration > `optional` **dimension?**: `number` -Defined in: [types/rag.ts:1445](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1445) - Embedding vector dimension (default: 1536) --- @@ -28,6 +24,4 @@ Embedding vector dimension (default: 1536) > `optional` **threshold?**: `number` -Defined in: [types/rag.ts:1447](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1447) - Similarity threshold for edge creation (default: 0.7) diff --git a/docs/api/type-aliases/GraphStats.md b/docs/api/type-aliases/GraphStats.md index 2e866f219..0a78292b4 100644 --- a/docs/api/type-aliases/GraphStats.md +++ b/docs/api/type-aliases/GraphStats.md @@ -8,8 +8,6 @@ > **GraphStats** = `object` -Defined in: [types/rag.ts:1467](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1467) - Graph statistics ## Properties @@ -18,28 +16,20 @@ Graph statistics > **nodeCount**: `number` -Defined in: [types/rag.ts:1468](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1468) - --- ### edgeCount > **edgeCount**: `number` -Defined in: [types/rag.ts:1469](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1469) - --- ### avgDegree > **avgDegree**: `number` -Defined in: [types/rag.ts:1470](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1470) - --- ### threshold > **threshold**: `number` - -Defined in: [types/rag.ts:1471](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1471) diff --git a/docs/api/type-aliases/GridPosition.md b/docs/api/type-aliases/GridPosition.md index d1e467a76..d210857ea 100644 --- a/docs/api/type-aliases/GridPosition.md +++ b/docs/api/type-aliases/GridPosition.md @@ -8,8 +8,6 @@ > **GridPosition** = `object` -Defined in: [types/ppt.ts:1312](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1312) - Grid position for zones ## Properties @@ -18,28 +16,20 @@ Grid position for zones > **x**: `number` -Defined in: [types/ppt.ts:1313](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1313) - --- ### y > **y**: `number` -Defined in: [types/ppt.ts:1314](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1314) - --- ### w > **w**: `number` -Defined in: [types/ppt.ts:1315](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1315) - --- ### h > **h**: `number` - -Defined in: [types/ppt.ts:1316](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1316) diff --git a/docs/api/type-aliases/GroundingChunk.md b/docs/api/type-aliases/GroundingChunk.md index 6e9b5fb8a..b3ac2ac96 100644 --- a/docs/api/type-aliases/GroundingChunk.md +++ b/docs/api/type-aliases/GroundingChunk.md @@ -8,8 +8,6 @@ > **GroundingChunk** = `object` -Defined in: [types/grounding.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L161) - Represents a grounding chunk from raw provider responses. This is the low-level representation of a grounding source chunk as returned directly from AI providers like Google Vertex AI. @@ -32,8 +30,6 @@ const chunk: GroundingChunk = { > `optional` **web?**: `object` -Defined in: [types/grounding.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L163) - Web source information for this grounding chunk #### uri? @@ -54,6 +50,4 @@ The title of the web source > `optional` **confidenceScore?**: `number` -Defined in: [types/grounding.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L170) - Confidence score for this grounding chunk (0-1) diff --git a/docs/api/type-aliases/GroundingSupport.md b/docs/api/type-aliases/GroundingSupport.md index f682a8935..ebc7411cb 100644 --- a/docs/api/type-aliases/GroundingSupport.md +++ b/docs/api/type-aliases/GroundingSupport.md @@ -8,8 +8,6 @@ > **GroundingSupport** = `object` -Defined in: [types/grounding.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L190) - Represents grounding support information from raw provider responses. Contains segment information and links to the grounding chunks that support that segment, as returned directly from AI providers. @@ -35,8 +33,6 @@ const support: GroundingSupport = { > `optional` **segment?**: `object` -Defined in: [types/grounding.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L192) - The text segment that is being grounded #### text? @@ -69,8 +65,6 @@ Index of the response part this segment belongs to > `optional` **groundingChunkIndices?**: `number`[] -Defined in: [types/grounding.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L203) - Indices into the groundingChunks array that support this segment --- @@ -79,6 +73,4 @@ Indices into the groundingChunks array that support this segment > `optional` **confidenceScores?**: `number`[] -Defined in: [types/grounding.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/grounding.ts#L205) - Confidence scores corresponding to each grounding chunk index diff --git a/docs/api/type-aliases/GuardrailsMiddlewareConfig.md b/docs/api/type-aliases/GuardrailsMiddlewareConfig.md index e82a2f8ee..effccd88b 100644 --- a/docs/api/type-aliases/GuardrailsMiddlewareConfig.md +++ b/docs/api/type-aliases/GuardrailsMiddlewareConfig.md @@ -8,8 +8,6 @@ > **GuardrailsMiddlewareConfig** = `object` -Defined in: [types/guardrails.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L113) - Configuration for the Guardrails middleware ## Properties @@ -18,20 +16,14 @@ Configuration for the Guardrails middleware > `optional` **badWords?**: [`BadWordsConfig`](BadWordsConfig.md) -Defined in: [types/guardrails.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L114) - --- ### modelFilter? > `optional` **modelFilter?**: [`ModelFilterConfig`](ModelFilterConfig.md) -Defined in: [types/guardrails.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L115) - --- ### precallEvaluation? > `optional` **precallEvaluation?**: [`PrecallEvaluationConfig`](PrecallEvaluationConfig.md) - -Defined in: [types/guardrails.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L116) diff --git a/docs/api/type-aliases/HITLAuditLog.md b/docs/api/type-aliases/HITLAuditLog.md index aef55c1b9..d4b7d6f1f 100644 --- a/docs/api/type-aliases/HITLAuditLog.md +++ b/docs/api/type-aliases/HITLAuditLog.md @@ -8,8 +8,6 @@ > **HITLAuditLog** = `object` -Defined in: [types/hitl.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L202) - HITL audit log entry Used for compliance and debugging purposes @@ -19,8 +17,6 @@ Used for compliance and debugging purposes > **timestamp**: `string` -Defined in: [types/hitl.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L204) - ISO timestamp of the event --- @@ -29,8 +25,6 @@ ISO timestamp of the event > **eventType**: `"confirmation-requested"` \| `"confirmation-approved"` \| `"confirmation-rejected"` \| `"confirmation-timeout"` \| `"confirmation-auto-approved"` -Defined in: [types/hitl.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L207) - Type of HITL event --- @@ -39,8 +33,6 @@ Type of HITL event > **toolName**: `string` -Defined in: [types/hitl.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L215) - Tool that was involved --- @@ -49,8 +41,6 @@ Tool that was involved > `optional` **userId?**: `string` -Defined in: [types/hitl.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L218) - User who made the decision (if applicable) --- @@ -59,8 +49,6 @@ User who made the decision (if applicable) > `optional` **sessionId?**: `string` -Defined in: [types/hitl.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L221) - Session identifier --- @@ -69,8 +57,6 @@ Session identifier > **arguments**: `unknown` -Defined in: [types/hitl.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L224) - Tool arguments (may be sanitized for security) --- @@ -79,8 +65,6 @@ Tool arguments (may be sanitized for security) > `optional` **reason?**: `string` -Defined in: [types/hitl.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L227) - Reason for rejection (if applicable) --- @@ -89,8 +73,6 @@ Reason for rejection (if applicable) > `optional` **ipAddress?**: `string` -Defined in: [types/hitl.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L230) - IP address of the user (if available) --- @@ -99,8 +81,6 @@ IP address of the user (if available) > `optional` **userAgent?**: `string` -Defined in: [types/hitl.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L233) - User agent string (if available) --- @@ -109,6 +89,4 @@ User agent string (if available) > `optional` **responseTime?**: `number` -Defined in: [types/hitl.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L236) - Response time in milliseconds (if applicable) diff --git a/docs/api/type-aliases/HITLConfig.md b/docs/api/type-aliases/HITLConfig.md index 28942aa39..326b44fee 100644 --- a/docs/api/type-aliases/HITLConfig.md +++ b/docs/api/type-aliases/HITLConfig.md @@ -8,8 +8,6 @@ > **HITLConfig** = `object` -Defined in: [types/hitl.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L13) - Core HITL configuration interface Controls how the HITL system behaves and what tools require confirmation @@ -19,8 +17,6 @@ Controls how the HITL system behaves and what tools require confirmation > **enabled**: `boolean` -Defined in: [types/hitl.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L15) - Master enable/disable switch for HITL functionality --- @@ -29,8 +25,6 @@ Master enable/disable switch for HITL functionality > **dangerousActions**: `string`[] -Defined in: [types/hitl.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L18) - Keywords that trigger HITL confirmation (e.g., "delete", "remove", "drop") --- @@ -39,8 +33,6 @@ Keywords that trigger HITL confirmation (e.g., "delete", "remove", "drop") > `optional` **timeout?**: `number` -Defined in: [types/hitl.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L21) - Timeout in milliseconds for user confirmation (default: 30000) --- @@ -49,8 +41,6 @@ Timeout in milliseconds for user confirmation (default: 30000) > `optional` **confirmationMethod?**: `"event"` -Defined in: [types/hitl.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L24) - Communication method - currently only "event" is supported (default: "event") --- @@ -59,8 +49,6 @@ Communication method - currently only "event" is supported (default: "event") > `optional` **allowArgumentModification?**: `boolean` -Defined in: [types/hitl.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L27) - Whether users can modify tool arguments during approval (default: true) --- @@ -69,8 +57,6 @@ Whether users can modify tool arguments during approval (default: true) > `optional` **autoApproveOnTimeout?**: `boolean` -Defined in: [types/hitl.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L30) - Auto-approve requests when they timeout (default: false - rejects on timeout) --- @@ -79,8 +65,6 @@ Auto-approve requests when they timeout (default: false - rejects on timeout) > `optional` **auditLogging?**: `boolean` -Defined in: [types/hitl.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L33) - Enable audit logging for compliance and debugging (default: false) --- @@ -89,6 +73,4 @@ Enable audit logging for compliance and debugging (default: false) > `optional` **customRules?**: [`HITLRule`](HITLRule.md)[] -Defined in: [types/hitl.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L36) - Advanced custom rules for complex tool scenarios (default: []) diff --git a/docs/api/type-aliases/HITLExecutionState.md b/docs/api/type-aliases/HITLExecutionState.md index 1b77b6fb1..70e492dce 100644 --- a/docs/api/type-aliases/HITLExecutionState.md +++ b/docs/api/type-aliases/HITLExecutionState.md @@ -8,12 +8,8 @@ > **HITLExecutionState** = `object` -Defined in: [types/hitl.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L321) - ## Properties ### triggered > **triggered**: `boolean` - -Defined in: [types/hitl.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L322) diff --git a/docs/api/type-aliases/HITLRule.md b/docs/api/type-aliases/HITLRule.md index cda22e222..b3593a9d8 100644 --- a/docs/api/type-aliases/HITLRule.md +++ b/docs/api/type-aliases/HITLRule.md @@ -8,8 +8,6 @@ > **HITLRule** = `object` -Defined in: [types/hitl.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L43) - Custom rule for advanced HITL scenarios Allows enterprises to define complex conditions for when tools require confirmation @@ -19,8 +17,6 @@ Allows enterprises to define complex conditions for when tools require confirmat > **name**: `string` -Defined in: [types/hitl.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L45) - Human-readable name for the rule --- @@ -29,8 +25,6 @@ Human-readable name for the rule > **condition**: (`toolName`, `args`) => `boolean` -Defined in: [types/hitl.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L48) - Function that determines if a tool requires confirmation #### Parameters @@ -53,8 +47,6 @@ Function that determines if a tool requires confirmation > **requiresConfirmation**: `boolean` -Defined in: [types/hitl.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L51) - Whether this rule requires confirmation when triggered --- @@ -63,6 +55,4 @@ Whether this rule requires confirmation when triggered > `optional` **customMessage?**: `string` -Defined in: [types/hitl.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L54) - Custom message to show users when this rule is triggered diff --git a/docs/api/type-aliases/HITLStatistics.md b/docs/api/type-aliases/HITLStatistics.md index 43799af10..2e09657f5 100644 --- a/docs/api/type-aliases/HITLStatistics.md +++ b/docs/api/type-aliases/HITLStatistics.md @@ -8,8 +8,6 @@ > **HITLStatistics** = `object` -Defined in: [types/hitl.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L243) - HITL statistics interface Provides metrics about HITL usage for monitoring @@ -19,8 +17,6 @@ Provides metrics about HITL usage for monitoring > **totalRequests**: `number` -Defined in: [types/hitl.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L245) - Total number of confirmation requests made --- @@ -29,8 +25,6 @@ Total number of confirmation requests made > **pendingRequests**: `number` -Defined in: [types/hitl.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L248) - Number of pending confirmations --- @@ -39,8 +33,6 @@ Number of pending confirmations > **averageResponseTime**: `number` -Defined in: [types/hitl.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L251) - Average response time for user decisions --- @@ -49,8 +41,6 @@ Average response time for user decisions > **approvedRequests**: `number` -Defined in: [types/hitl.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L254) - Number of approved requests --- @@ -59,8 +49,6 @@ Number of approved requests > **rejectedRequests**: `number` -Defined in: [types/hitl.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L257) - Number of rejected requests --- @@ -69,6 +57,4 @@ Number of rejected requests > **timedOutRequests**: `number` -Defined in: [types/hitl.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/types/hitl.ts#L260) - Number of timed out requests diff --git a/docs/api/type-aliases/HTMLChunkerConfig.md b/docs/api/type-aliases/HTMLChunkerConfig.md index cf89a838f..66b2890b1 100644 --- a/docs/api/type-aliases/HTMLChunkerConfig.md +++ b/docs/api/type-aliases/HTMLChunkerConfig.md @@ -8,8 +8,6 @@ > **HTMLChunkerConfig** = [`BaseChunkerConfig`](BaseChunkerConfig.md) & `object` -Defined in: [types/rag.ts:972](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L972) - HTML chunker configuration HTML structure-aware splitting diff --git a/docs/api/type-aliases/HTTPRetryConfig.md b/docs/api/type-aliases/HTTPRetryConfig.md index b875d7d32..1d1d2eb07 100644 --- a/docs/api/type-aliases/HTTPRetryConfig.md +++ b/docs/api/type-aliases/HTTPRetryConfig.md @@ -8,8 +8,6 @@ > **HTTPRetryConfig** = `object` -Defined in: [types/mcp.ts:983](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L983) - HTTP retry configuration for MCP transport ## Properties @@ -18,8 +16,6 @@ HTTP retry configuration for MCP transport > **maxAttempts**: `number` -Defined in: [types/mcp.ts:985](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L985) - Maximum retry attempts (default: 3) --- @@ -28,8 +24,6 @@ Maximum retry attempts (default: 3) > **initialDelay**: `number` -Defined in: [types/mcp.ts:987](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L987) - Initial delay in ms (default: 1000) --- @@ -38,8 +32,6 @@ Initial delay in ms (default: 1000) > **maxDelay**: `number` -Defined in: [types/mcp.ts:989](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L989) - Maximum delay in ms (default: 30000) --- @@ -48,8 +40,6 @@ Maximum delay in ms (default: 30000) > **backoffMultiplier**: `number` -Defined in: [types/mcp.ts:991](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L991) - Backoff multiplier (default: 2) --- @@ -58,6 +48,4 @@ Backoff multiplier (default: 2) > **retryableStatusCodes**: `number`[] -Defined in: [types/mcp.ts:993](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L993) - HTTP status codes that trigger retry diff --git a/docs/api/type-aliases/HallucinationItem.md b/docs/api/type-aliases/HallucinationItem.md index 5ef711651..3c5b832db 100644 --- a/docs/api/type-aliases/HallucinationItem.md +++ b/docs/api/type-aliases/HallucinationItem.md @@ -8,8 +8,6 @@ > **HallucinationItem** = `object` -Defined in: [types/scorer.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L666) - Hallucination row reported by the hallucination scorer. ## Properties @@ -18,20 +16,14 @@ Hallucination row reported by the hallucination scorer. > `optional` **text?**: `string` -Defined in: [types/scorer.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L667) - --- ### reason? > `optional` **reason?**: `string` -Defined in: [types/scorer.ts:668](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L668) - --- ### severity? > `optional` **severity?**: `string` - -Defined in: [types/scorer.ts:669](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L669) diff --git a/docs/api/type-aliases/HeaderScrubberOptions.md b/docs/api/type-aliases/HeaderScrubberOptions.md index b115380d9..6d2d7c106 100644 --- a/docs/api/type-aliases/HeaderScrubberOptions.md +++ b/docs/api/type-aliases/HeaderScrubberOptions.md @@ -8,8 +8,6 @@ > **HeaderScrubberOptions** = `object` -Defined in: [types/proxy.ts:447](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L447) - Options for the HeaderScrubber cloaking plugin. ## Properties @@ -18,6 +16,4 @@ Options for the HeaderScrubber cloaking plugin. > `optional` **extraHeaders?**: `string`[] -Defined in: [types/proxy.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L449) - Additional header names (lower-cased) to strip. diff --git a/docs/api/type-aliases/HealthMetrics.md b/docs/api/type-aliases/HealthMetrics.md index f322c81cc..f11c87512 100644 --- a/docs/api/type-aliases/HealthMetrics.md +++ b/docs/api/type-aliases/HealthMetrics.md @@ -8,52 +8,38 @@ > **HealthMetrics** = `object` -Defined in: [types/observability.ts:470](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L470) - ## Properties ### timestamp > **timestamp**: `number` -Defined in: [types/observability.ts:471](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L471) - --- ### memoryUsage > **memoryUsage**: `NodeJS.MemoryUsage` -Defined in: [types/observability.ts:472](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L472) - --- ### uptime > **uptime**: `number` -Defined in: [types/observability.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L473) - --- ### activeConnections > **activeConnections**: `number` -Defined in: [types/observability.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L474) - --- ### errorRate > **errorRate**: `number` -Defined in: [types/observability.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L475) - --- ### averageResponseTime > **averageResponseTime**: `number` - -Defined in: [types/observability.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L476) diff --git a/docs/api/type-aliases/HealthResponse.md b/docs/api/type-aliases/HealthResponse.md index 2d323b905..0d9ea1ff1 100644 --- a/docs/api/type-aliases/HealthResponse.md +++ b/docs/api/type-aliases/HealthResponse.md @@ -8,8 +8,6 @@ > **HealthResponse** = `object` -Defined in: [types/server.ts:756](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L756) - Health check response ## Properties @@ -18,8 +16,6 @@ Health check response > **status**: `"ok"` \| `"degraded"` \| `"unhealthy"` -Defined in: [types/server.ts:758](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L758) - Health status --- @@ -28,8 +24,6 @@ Health status > **timestamp**: `string` -Defined in: [types/server.ts:761](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L761) - Timestamp --- @@ -38,8 +32,6 @@ Timestamp > **uptime**: `number` -Defined in: [types/server.ts:764](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L764) - Server uptime in milliseconds --- @@ -48,6 +40,4 @@ Server uptime in milliseconds > **version**: `string` -Defined in: [types/server.ts:767](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L767) - Version information diff --git a/docs/api/type-aliases/HeyGenVideoStatusResponse.md b/docs/api/type-aliases/HeyGenVideoStatusResponse.md index 35a5a0925..3054a0cba 100644 --- a/docs/api/type-aliases/HeyGenVideoStatusResponse.md +++ b/docs/api/type-aliases/HeyGenVideoStatusResponse.md @@ -8,8 +8,6 @@ > **HeyGenVideoStatusResponse** = `object` -Defined in: [types/avatar.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L167) - HeyGen `/v1/video_status.get` response shape. ## Properties @@ -18,16 +16,12 @@ HeyGen `/v1/video_status.get` response shape. > `optional` **code?**: `number` -Defined in: [types/avatar.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L168) - --- ### data? > `optional` **data?**: `object` -Defined in: [types/avatar.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L169) - #### id? > `optional` **id?**: `string` @@ -69,5 +63,3 @@ Defined in: [types/avatar.ts:169](https://github.com/juspay/neurolink/blob/relea ### message? > `optional` **message?**: `string` - -Defined in: [types/avatar.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/avatar.ts#L181) diff --git a/docs/api/type-aliases/HierarchicalExecutionTrace.md b/docs/api/type-aliases/HierarchicalExecutionTrace.md index e32653e1d..dbca955e1 100644 --- a/docs/api/type-aliases/HierarchicalExecutionTrace.md +++ b/docs/api/type-aliases/HierarchicalExecutionTrace.md @@ -8,8 +8,6 @@ > **HierarchicalExecutionTrace** = [`NetworkExecutionTrace`](NetworkExecutionTrace.md) & `object` -Defined in: [types/agentNetwork.ts:960](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L960) - Hierarchical execution trace ## Type Declaration diff --git a/docs/api/type-aliases/HierarchicalNetworkConfig.md b/docs/api/type-aliases/HierarchicalNetworkConfig.md index 39860448e..173451536 100644 --- a/docs/api/type-aliases/HierarchicalNetworkConfig.md +++ b/docs/api/type-aliases/HierarchicalNetworkConfig.md @@ -8,8 +8,6 @@ > **HierarchicalNetworkConfig** = [`AgentNetworkConfig`](AgentNetworkConfig.md) & `object` -Defined in: [types/agentNetwork.ts:923](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L923) - Configuration for hierarchical networks ## Type Declaration diff --git a/docs/api/type-aliases/HippocampusAddOptions.md b/docs/api/type-aliases/HippocampusAddOptions.md index 0a8ebad31..0db1271af 100644 --- a/docs/api/type-aliases/HippocampusAddOptions.md +++ b/docs/api/type-aliases/HippocampusAddOptions.md @@ -8,8 +8,6 @@ > **HippocampusAddOptions** = `object` -Defined in: [types/memory.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L65) - Per-call options accepted by `Hippocampus.add`. ## Properties @@ -18,12 +16,8 @@ Per-call options accepted by `Hippocampus.add`. > `optional` **prompt?**: `string` -Defined in: [types/memory.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L66) - --- ### maxWords? > `optional` **maxWords?**: `number` - -Defined in: [types/memory.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L67) diff --git a/docs/api/type-aliases/HippocampusConfig.md b/docs/api/type-aliases/HippocampusConfig.md index 943d42964..f65997437 100644 --- a/docs/api/type-aliases/HippocampusConfig.md +++ b/docs/api/type-aliases/HippocampusConfig.md @@ -8,8 +8,6 @@ > **HippocampusConfig** = `object` -Defined in: [types/memory.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L71) - Constructor config accepted by the Hippocampus class. ## Properties @@ -18,24 +16,18 @@ Constructor config accepted by the Hippocampus class. > `optional` **storage?**: [`HippocampusStorageConfig`](HippocampusStorageConfig.md) -Defined in: [types/memory.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L72) - --- ### prompt? > `optional` **prompt?**: `string` -Defined in: [types/memory.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L73) - --- ### neurolink? > `optional` **neurolink?**: `object` -Defined in: [types/memory.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L74) - #### provider? > `optional` **provider?**: `string` @@ -53,5 +45,3 @@ Defined in: [types/memory.ts:74](https://github.com/juspay/neurolink/blob/releas ### maxWords? > `optional` **maxWords?**: `number` - -Defined in: [types/memory.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L79) diff --git a/docs/api/type-aliases/HippocampusLike.md b/docs/api/type-aliases/HippocampusLike.md index ad68cd7b0..19a3fab8f 100644 --- a/docs/api/type-aliases/HippocampusLike.md +++ b/docs/api/type-aliases/HippocampusLike.md @@ -8,8 +8,6 @@ > **HippocampusLike** = `object` -Defined in: [types/memory.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L87) - Subset of the @juspay/hippocampus client surface that NeuroLink core actually calls. Defining this locally lets the initializer / SDK code avoid a value or even a type import from the optional package. @@ -20,8 +18,6 @@ avoid a value or even a type import from the optional package. > **add**: (`ownerId`, `content`, `options?`) => `Promise`\<`string`\> -Defined in: [types/memory.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L88) - #### Parameters ##### ownerId @@ -46,8 +42,6 @@ Defined in: [types/memory.ts:88](https://github.com/juspay/neurolink/blob/releas > **get**: (`ownerId`) => `Promise`\<`string` \| `null`\> -Defined in: [types/memory.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L93) - #### Parameters ##### ownerId @@ -64,8 +58,6 @@ Defined in: [types/memory.ts:93](https://github.com/juspay/neurolink/blob/releas > **delete**: (`ownerId`) => `Promise`\<`void`\> -Defined in: [types/memory.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L94) - #### Parameters ##### ownerId @@ -82,8 +74,6 @@ Defined in: [types/memory.ts:94](https://github.com/juspay/neurolink/blob/releas > **close**: () => `Promise`\<`void`\> -Defined in: [types/memory.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L95) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/type-aliases/HippocampusMemory.md b/docs/api/type-aliases/HippocampusMemory.md index 927f52d68..2706c1d77 100644 --- a/docs/api/type-aliases/HippocampusMemory.md +++ b/docs/api/type-aliases/HippocampusMemory.md @@ -8,8 +8,6 @@ > **HippocampusMemory** = [`HippocampusConfig`](HippocampusConfig.md) & `object` -Defined in: [types/memory.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L103) - Consumer-facing memory config. Same shape as before — the `enabled` flag toggles activation while the rest is passed straight through to the Hippocampus constructor when the optional package is installed. diff --git a/docs/api/type-aliases/HippocampusModule.md b/docs/api/type-aliases/HippocampusModule.md index ff52524e9..2d5f883fc 100644 --- a/docs/api/type-aliases/HippocampusModule.md +++ b/docs/api/type-aliases/HippocampusModule.md @@ -8,8 +8,6 @@ > **HippocampusModule** = `object` -Defined in: [types/memory.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L110) - Shape of the dynamically-required `@juspay/hippocampus` module surface that NeuroLink's lazy initializer reaches for. Only the constructor is surfaced here; the rest of the module is irrelevant to core. @@ -20,8 +18,6 @@ surfaced here; the rest of the module is irrelevant to core. > **Hippocampus**: (`config?`) => [`HippocampusLike`](HippocampusLike.md) -Defined in: [types/memory.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L111) - #### Parameters ##### config? diff --git a/docs/api/type-aliases/HippocampusStorageConfig.md b/docs/api/type-aliases/HippocampusStorageConfig.md index 35f50fe73..ab18738d6 100644 --- a/docs/api/type-aliases/HippocampusStorageConfig.md +++ b/docs/api/type-aliases/HippocampusStorageConfig.md @@ -8,8 +8,6 @@ > **HippocampusStorageConfig** = [`MemorySqliteStorageConfig`](MemorySqliteStorageConfig.md) \| [`MemoryRedisStorageConfig`](MemoryRedisStorageConfig.md) \| [`MemoryS3StorageConfig`](MemoryS3StorageConfig.md) \| [`MemoryCustomStorageConfig`](MemoryCustomStorageConfig.md) -Defined in: [types/memory.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L58) - Storage configuration accepted by the optional Hippocampus client. Re-exported with the legacy `StorageConfig` name from `conversation.ts` to preserve the existing public type surface. diff --git a/docs/api/type-aliases/HonoRateLimitEntry.md b/docs/api/type-aliases/HonoRateLimitEntry.md index 8c4727449..385181768 100644 --- a/docs/api/type-aliases/HonoRateLimitEntry.md +++ b/docs/api/type-aliases/HonoRateLimitEntry.md @@ -8,8 +8,6 @@ > **HonoRateLimitEntry** = `object` -Defined in: [types/proxy.ts:2067](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2067) - Rate limit store entry (Hono adapter). ## Properties @@ -18,12 +16,8 @@ Rate limit store entry (Hono adapter). > **count**: `number` -Defined in: [types/proxy.ts:2068](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2068) - --- ### resetAt > **resetAt**: `number` - -Defined in: [types/proxy.ts:2069](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2069) diff --git a/docs/api/type-aliases/HttpMethod.md b/docs/api/type-aliases/HttpMethod.md index b0af05898..1c1e027d8 100644 --- a/docs/api/type-aliases/HttpMethod.md +++ b/docs/api/type-aliases/HttpMethod.md @@ -8,6 +8,4 @@ > **HttpMethod** = `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"PATCH"` \| `"OPTIONS"` -Defined in: [types/server.ts:364](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L364) - HTTP methods supported by server adapters diff --git a/docs/api/type-aliases/HybridSearchConfig.md b/docs/api/type-aliases/HybridSearchConfig.md index 792739ba7..d28e059f4 100644 --- a/docs/api/type-aliases/HybridSearchConfig.md +++ b/docs/api/type-aliases/HybridSearchConfig.md @@ -8,8 +8,6 @@ > **HybridSearchConfig** = `object` -Defined in: [types/rag.ts:1338](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1338) - Hybrid search configuration ## Properties @@ -18,8 +16,6 @@ Hybrid search configuration > `optional` **vectorWeight?**: `number` -Defined in: [types/rag.ts:1340](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1340) - Weight for vector search (0-1) --- @@ -28,8 +24,6 @@ Weight for vector search (0-1) > `optional` **bm25Weight?**: `number` -Defined in: [types/rag.ts:1342](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1342) - Weight for BM25 search (0-1) --- @@ -38,8 +32,6 @@ Weight for BM25 search (0-1) > `optional` **fusionMethod?**: `"rrf"` \| `"linear"` -Defined in: [types/rag.ts:1344](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1344) - Fusion method --- @@ -48,8 +40,6 @@ Fusion method > `optional` **rrfK?**: `number` -Defined in: [types/rag.ts:1346](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1346) - RRF k parameter --- @@ -58,8 +48,6 @@ RRF k parameter > `optional` **topK?**: `number` -Defined in: [types/rag.ts:1348](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1348) - Number of results to return --- @@ -68,8 +56,6 @@ Number of results to return > `optional` **enableReranking?**: `boolean` -Defined in: [types/rag.ts:1350](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1350) - Enable reranking --- @@ -78,6 +64,4 @@ Enable reranking > `optional` **reranker?**: [`RerankerConfig`](RerankerConfig.md) -Defined in: [types/rag.ts:1352](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1352) - Reranker configuration diff --git a/docs/api/type-aliases/HybridSearchOptions.md b/docs/api/type-aliases/HybridSearchOptions.md index 919d718ae..42909d954 100644 --- a/docs/api/type-aliases/HybridSearchOptions.md +++ b/docs/api/type-aliases/HybridSearchOptions.md @@ -8,8 +8,6 @@ > **HybridSearchOptions** = `object` -Defined in: [types/rag.ts:490](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L490) - Hybrid search configuration for creating a search function ## Properties @@ -18,8 +16,6 @@ Hybrid search configuration for creating a search function > **vectorStore**: [`VectorStore`](VectorStore.md) -Defined in: [types/rag.ts:492](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L492) - Vector store instance --- @@ -28,8 +24,6 @@ Vector store instance > **bm25Index**: [`BM25Index`](BM25Index.md) -Defined in: [types/rag.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L494) - BM25 index instance --- @@ -38,8 +32,6 @@ BM25 index instance > **indexName**: `string` -Defined in: [types/rag.ts:496](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L496) - Index name for vector store --- @@ -48,8 +40,6 @@ Index name for vector store > `optional` **embeddingModel?**: `object` -Defined in: [types/rag.ts:498](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L498) - Embedding model configuration (optional - uses defaults from ProviderFactory if not specified) #### provider? @@ -66,6 +56,4 @@ Embedding model configuration (optional - uses defaults from ProviderFactory if > `optional` **defaultConfig?**: [`HybridSearchConfig`](HybridSearchConfig.md) -Defined in: [types/rag.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L503) - Default search configuration diff --git a/docs/api/type-aliases/HybridSearchResult.md b/docs/api/type-aliases/HybridSearchResult.md index c6cd94894..cb043d1ae 100644 --- a/docs/api/type-aliases/HybridSearchResult.md +++ b/docs/api/type-aliases/HybridSearchResult.md @@ -8,8 +8,6 @@ > **HybridSearchResult** = `object` -Defined in: [types/rag.ts:1358](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1358) - Hybrid search result ## Properties @@ -18,8 +16,6 @@ Hybrid search result > **id**: `string` -Defined in: [types/rag.ts:1360](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1360) - Document ID --- @@ -28,8 +24,6 @@ Document ID > **score**: `number` -Defined in: [types/rag.ts:1362](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1362) - Combined score --- @@ -38,8 +32,6 @@ Combined score > **text**: `string` -Defined in: [types/rag.ts:1364](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1364) - Document text --- @@ -48,8 +40,6 @@ Document text > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1366](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1366) - Associated metadata --- @@ -58,8 +48,6 @@ Associated metadata > `optional` **scores?**: `object` -Defined in: [types/rag.ts:1368](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1368) - Score breakdown #### vector? diff --git a/docs/api/type-aliases/HyperlinkProps.md b/docs/api/type-aliases/HyperlinkProps.md index 3039433a7..50d1065f8 100644 --- a/docs/api/type-aliases/HyperlinkProps.md +++ b/docs/api/type-aliases/HyperlinkProps.md @@ -8,8 +8,6 @@ > **HyperlinkProps** = `object` -Defined in: [types/ppt.ts:834](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L834) - Hyperlink properties Maps to: pptxgenjs HyperlinkProps @@ -19,8 +17,6 @@ Maps to: pptxgenjs HyperlinkProps > `optional` **url?**: `string` -Defined in: [types/ppt.ts:836](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L836) - Link to external URL --- @@ -29,8 +25,6 @@ Link to external URL > `optional` **slide?**: `number` -Defined in: [types/ppt.ts:838](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L838) - Link to slide number --- @@ -39,6 +33,4 @@ Link to slide number > `optional` **tooltip?**: `string` -Defined in: [types/ppt.ts:840](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L840) - Tooltip text diff --git a/docs/api/type-aliases/IConversationMemoryManager.md b/docs/api/type-aliases/IConversationMemoryManager.md index 8d6244886..d7c8748f3 100644 --- a/docs/api/type-aliases/IConversationMemoryManager.md +++ b/docs/api/type-aliases/IConversationMemoryManager.md @@ -8,8 +8,6 @@ > **IConversationMemoryManager** = `object` -Defined in: [types/conversationMemoryInterface.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L20) - Common type for all conversation memory manager implementations. Provides a consistent API for storing, retrieving, and managing conversation history. @@ -19,16 +17,12 @@ Provides a consistent API for storing, retrieving, and managing conversation his > **config**: [`ConversationMemoryConfig`](ConversationMemoryConfig.md) -Defined in: [types/conversationMemoryInterface.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L21) - ## Methods ### initialize() > **initialize**(): `void` \| `Promise`\<`void`\> -Defined in: [types/conversationMemoryInterface.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L24) - Initialize the memory manager #### Returns @@ -41,8 +35,6 @@ Initialize the memory manager > **storeConversationTurn**(`options`): `Promise`\<`void`\> -Defined in: [types/conversationMemoryInterface.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L27) - Store a conversation turn #### Parameters @@ -61,8 +53,6 @@ Store a conversation turn > **getSession**(`sessionId`, `userId?`): [`SessionMemory`](SessionMemory.md) \| `Promise`\<[`SessionMemory`](SessionMemory.md) \| `undefined`\> \| `undefined` -Defined in: [types/conversationMemoryInterface.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L30) - Get session by ID #### Parameters @@ -85,8 +75,6 @@ Get session by ID > **buildContextMessages**(`sessionId`, `userId?`, `enableSummarization?`, `requestId?`): [`ChatMessage`](ChatMessage.md)[] \| `Promise`\<[`ChatMessage`](ChatMessage.md)[]\> -Defined in: [types/conversationMemoryInterface.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L36) - Build context messages for AI prompt injection #### Parameters @@ -117,8 +105,6 @@ Build context messages for AI prompt injection > **clearSession**(`sessionId`, `userId?`): `boolean` \| `Promise`\<`boolean`\> -Defined in: [types/conversationMemoryInterface.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L44) - Clear a specific session #### Parameters @@ -141,8 +127,6 @@ Clear a specific session > **clearAllSessions**(): `void` \| `Promise`\<`void`\> -Defined in: [types/conversationMemoryInterface.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L47) - Clear all sessions #### Returns @@ -155,8 +139,6 @@ Clear all sessions > **getStats**(): [`ConversationMemoryStats`](ConversationMemoryStats.md) \| `Promise`\<[`ConversationMemoryStats`](ConversationMemoryStats.md)\> -Defined in: [types/conversationMemoryInterface.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L50) - Get memory statistics #### Returns @@ -171,8 +153,6 @@ Get memory statistics > `optional` **listSessions**(`userId?`): `Promise`\<[`SessionListItem`](SessionListItem.md)[]\> -Defined in: [types/conversationMemoryInterface.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L53) - List all sessions with metadata (optional - for session management) ##### Parameters @@ -189,8 +169,6 @@ List all sessions with metadata (optional - for session management) > `optional` **listSessions**(`userId?`): `Promise`\<[`SessionListItem`](SessionListItem.md)[]\> -Defined in: [types/conversationMemoryInterface.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L56) - List all sessions with metadata (optional - for session management) ##### Parameters @@ -209,8 +187,6 @@ List all sessions with metadata (optional - for session management) > **getSessionMessages**(`sessionId`, `userId?`): `Promise`\<[`ChatMessage`](ChatMessage.md)[]\> -Defined in: [types/conversationMemoryInterface.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L58) - Get raw messages array for a session (no context filtering or summarization) #### Parameters @@ -233,8 +209,6 @@ Get raw messages array for a session (no context filtering or summarization) > **setSessionMessages**(`sessionId`, `messages`, `userId?`): `Promise`\<`void`\> -Defined in: [types/conversationMemoryInterface.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L64) - Replace the entire messages array for a session #### Parameters @@ -261,8 +235,6 @@ Replace the entire messages array for a session > `optional` **storeToolExecution**(`sessionId`, `userId`, `toolCalls`, `toolResults`, `currentTime?`): `Promise`\<`void`\> -Defined in: [types/conversationMemoryInterface.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L80) - Persist a step's tool calls and results as `tool_call` / `tool_result` messages on the session. @@ -304,8 +276,6 @@ depending on `STORAGE_TYPE`. > `optional` **close**(): `Promise`\<`void`\> -Defined in: [types/conversationMemoryInterface.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversationMemoryInterface.ts#L100) - Close/shutdown the memory manager and release resources (e.g., Redis connections) #### Returns diff --git a/docs/api/type-aliases/IdeogramImageResponse.md b/docs/api/type-aliases/IdeogramImageResponse.md index 9ce7a0636..637a2d2b0 100644 --- a/docs/api/type-aliases/IdeogramImageResponse.md +++ b/docs/api/type-aliases/IdeogramImageResponse.md @@ -8,8 +8,6 @@ > **IdeogramImageResponse** = `object` -Defined in: [types/providers.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L346) - Ideogram /api/v1/ideogram-v3/generate response shape. ## Properties @@ -18,16 +16,12 @@ Ideogram /api/v1/ideogram-v3/generate response shape. > `optional` **created?**: `string` -Defined in: [types/providers.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L347) - --- ### data > **data**: `object`[] -Defined in: [types/providers.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L348) - #### prompt? > `optional` **prompt?**: `string` diff --git a/docs/api/type-aliases/ImageCacheConfig.md b/docs/api/type-aliases/ImageCacheConfig.md index 5ef22a351..4a7b19e26 100644 --- a/docs/api/type-aliases/ImageCacheConfig.md +++ b/docs/api/type-aliases/ImageCacheConfig.md @@ -8,8 +8,6 @@ > **ImageCacheConfig** = `object` -Defined in: [types/utilities.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L254) - Configuration options for the image cache ## Properties @@ -18,8 +16,6 @@ Configuration options for the image cache > `optional` **maxSize?**: `number` -Defined in: [types/utilities.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L256) - Maximum number of entries in the cache (default: 100) --- @@ -28,8 +24,6 @@ Maximum number of entries in the cache (default: 100) > `optional` **ttlMs?**: `number` -Defined in: [types/utilities.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L258) - Time-to-live in milliseconds (default: 30 minutes) --- @@ -38,6 +32,4 @@ Time-to-live in milliseconds (default: 30 minutes) > `optional` **maxImageSize?**: `number` -Defined in: [types/utilities.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L260) - Maximum size per image in bytes (default: 10MB) diff --git a/docs/api/type-aliases/ImageCacheStats.md b/docs/api/type-aliases/ImageCacheStats.md index 6439299f1..b969ea593 100644 --- a/docs/api/type-aliases/ImageCacheStats.md +++ b/docs/api/type-aliases/ImageCacheStats.md @@ -8,8 +8,6 @@ > **ImageCacheStats** = `object` -Defined in: [types/utilities.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L266) - Cache statistics for monitoring ## Properties @@ -18,8 +16,6 @@ Cache statistics for monitoring > **hits**: `number` -Defined in: [types/utilities.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L268) - Number of cache hits --- @@ -28,8 +24,6 @@ Number of cache hits > **misses**: `number` -Defined in: [types/utilities.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L270) - Number of cache misses --- @@ -38,8 +32,6 @@ Number of cache misses > **evictions**: `number` -Defined in: [types/utilities.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L272) - Number of entries evicted due to size limits --- @@ -48,8 +40,6 @@ Number of entries evicted due to size limits > **expirations**: `number` -Defined in: [types/utilities.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L274) - Number of entries expired due to TTL --- @@ -58,8 +48,6 @@ Number of entries expired due to TTL > **totalRequests**: `number` -Defined in: [types/utilities.ts:276](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L276) - Total number of requests --- @@ -68,8 +56,6 @@ Total number of requests > **size**: `number` -Defined in: [types/utilities.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L278) - Current number of entries in cache --- @@ -78,8 +64,6 @@ Current number of entries in cache > **totalBytes**: `number` -Defined in: [types/utilities.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L280) - Total size of cached images in bytes --- @@ -88,6 +72,4 @@ Total size of cached images in bytes > **hitRate**: `number` -Defined in: [types/utilities.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L282) - Cache hit rate as percentage diff --git a/docs/api/type-aliases/ImageChunkMetadata.md b/docs/api/type-aliases/ImageChunkMetadata.md index 30de873f0..03bfdbe7a 100644 --- a/docs/api/type-aliases/ImageChunkMetadata.md +++ b/docs/api/type-aliases/ImageChunkMetadata.md @@ -8,8 +8,6 @@ > **ImageChunkMetadata** = `object` -Defined in: [types/rag.ts:1672](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1672) - Image metadata attached to multi-modal chunks ## Properties @@ -18,8 +16,6 @@ Image metadata attached to multi-modal chunks > `optional` **width?**: `number` -Defined in: [types/rag.ts:1674](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1674) - Image width in pixels --- @@ -28,8 +24,6 @@ Image width in pixels > `optional` **height?**: `number` -Defined in: [types/rag.ts:1676](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1676) - Image height in pixels --- @@ -38,8 +32,6 @@ Image height in pixels > `optional` **mimeType?**: `string` -Defined in: [types/rag.ts:1678](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1678) - Image MIME type --- @@ -48,8 +40,6 @@ Image MIME type > `optional` **format?**: `string` -Defined in: [types/rag.ts:1680](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1680) - Image format (jpeg, png, webp, etc.) --- @@ -58,8 +48,6 @@ Image format (jpeg, png, webp, etc.) > `optional` **source?**: `string` -Defined in: [types/rag.ts:1682](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1682) - Original file path or URL --- @@ -68,6 +56,4 @@ Original file path or URL > **hasImage**: `boolean` -Defined in: [types/rag.ts:1684](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1684) - Whether this chunk contains image data diff --git a/docs/api/type-aliases/ImageContent.md b/docs/api/type-aliases/ImageContent.md index ade264f83..5f39bce0a 100644 --- a/docs/api/type-aliases/ImageContent.md +++ b/docs/api/type-aliases/ImageContent.md @@ -8,8 +8,6 @@ > **ImageContent** = `object` -Defined in: [types/multimodal.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L58) - Image content type for multimodal messages ## Properties @@ -18,24 +16,18 @@ Image content type for multimodal messages > **type**: `"image"` -Defined in: [types/multimodal.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L59) - --- ### data > **data**: `Buffer` \| `string` -Defined in: [types/multimodal.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L60) - --- ### altText? > `optional` **altText?**: `string` -Defined in: [types/multimodal.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L62) - Alternative text for accessibility (screen readers, SEO) --- @@ -44,16 +36,12 @@ Alternative text for accessibility (screen readers, SEO) > `optional` **mediaType?**: `"image/jpeg"` \| `"image/png"` \| `"image/gif"` \| `"image/webp"` \| `"image/bmp"` \| `"image/tiff"` -Defined in: [types/multimodal.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L63) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/multimodal.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L70) - #### description? > `optional` **description?**: `string` diff --git a/docs/api/type-aliases/ImageDocument.md b/docs/api/type-aliases/ImageDocument.md index 52bef815e..d138ae648 100644 --- a/docs/api/type-aliases/ImageDocument.md +++ b/docs/api/type-aliases/ImageDocument.md @@ -8,8 +8,6 @@ > **ImageDocument** = `object` -Defined in: [types/rag.ts:1768](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1768) - Image document loaded for RAG ingestion ## Properties @@ -18,8 +16,6 @@ Image document loaded for RAG ingestion > **id**: `string` -Defined in: [types/rag.ts:1770](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1770) - Unique identifier for this image document --- @@ -28,8 +24,6 @@ Unique identifier for this image document > **text**: `string` -Defined in: [types/rag.ts:1772](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1772) - Text representation (filename, alt text, or caption) --- @@ -38,8 +32,6 @@ Text representation (filename, alt text, or caption) > **image**: `Buffer` -Defined in: [types/rag.ts:1774](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1774) - Raw image data --- @@ -48,8 +40,6 @@ Raw image data > **mimeType**: `string` -Defined in: [types/rag.ts:1776](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1776) - Image MIME type --- @@ -58,8 +48,6 @@ Image MIME type > **metadata**: `object` -Defined in: [types/rag.ts:1778](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1778) - Metadata about the image #### source diff --git a/docs/api/type-aliases/ImageGenConfig.md b/docs/api/type-aliases/ImageGenConfig.md index 4155d5b3f..fcbffd9f7 100644 --- a/docs/api/type-aliases/ImageGenConfig.md +++ b/docs/api/type-aliases/ImageGenConfig.md @@ -8,8 +8,6 @@ > **ImageGenConfig** = `object` -Defined in: [types/imageGen.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L169) - Configuration for the ImageGenService ## Properties @@ -18,8 +16,6 @@ Configuration for the ImageGenService > **enabled**: `boolean` -Defined in: [types/imageGen.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L173) - Whether image generation is enabled --- @@ -28,8 +24,6 @@ Whether image generation is enabled > **defaultModel**: `string` -Defined in: [types/imageGen.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L178) - Default model to use for generation --- @@ -38,8 +32,6 @@ Default model to use for generation > **defaultProvider**: [`ImageGenProvider`](ImageGenProvider.md) \| `string` -Defined in: [types/imageGen.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L183) - Default provider for image generation --- @@ -48,8 +40,6 @@ Default provider for image generation > `optional` **defaultRegion?**: `string` -Defined in: [types/imageGen.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L188) - Default region for the provider (if applicable) --- @@ -58,8 +48,6 @@ Default region for the provider (if applicable) > **timeout**: `number` -Defined in: [types/imageGen.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L193) - Timeout for generation requests in milliseconds --- @@ -68,8 +56,6 @@ Timeout for generation requests in milliseconds > `optional` **defaultTemperature?**: `number` -Defined in: [types/imageGen.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L198) - Default temperature for generation --- @@ -78,8 +64,6 @@ Default temperature for generation > `optional` **maxImages?**: `number` -Defined in: [types/imageGen.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L203) - Maximum number of images per request --- @@ -88,8 +72,6 @@ Maximum number of images per request > `optional` **maxReferenceImages?**: `number` -Defined in: [types/imageGen.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L208) - Maximum number of reference images allowed --- @@ -98,6 +80,4 @@ Maximum number of reference images allowed > `optional` **maxReferencePdfs?**: `number` -Defined in: [types/imageGen.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L213) - Maximum number of reference PDFs allowed diff --git a/docs/api/type-aliases/ImageGenOptions.md b/docs/api/type-aliases/ImageGenOptions.md index 81ebcf109..e39f89d3d 100644 --- a/docs/api/type-aliases/ImageGenOptions.md +++ b/docs/api/type-aliases/ImageGenOptions.md @@ -8,8 +8,6 @@ > **ImageGenOptions** = `object` -Defined in: [types/imageGen.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L47) - Options for image generation requests ## Properties @@ -18,8 +16,6 @@ Options for image generation requests > **prompt**: `string` -Defined in: [types/imageGen.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L52) - Text prompt describing the image to generate Should be detailed and specific for best results @@ -29,8 +25,6 @@ Should be detailed and specific for best results > `optional` **images?**: (`Buffer` \| `string`)[] -Defined in: [types/imageGen.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L59) - Reference images for style/content guidance (optional) Can be Buffer (raw data) or string (base64 encoded) Max 5 images recommended @@ -41,8 +35,6 @@ Max 5 images recommended > `optional` **pdfFiles?**: `Buffer`[] -Defined in: [types/imageGen.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L66) - Reference PDF files for context (optional) Used for generating images based on document content Max 1 PDF recommended @@ -53,8 +45,6 @@ Max 1 PDF recommended > `optional` **model?**: `string` -Defined in: [types/imageGen.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L72) - Override default model e.g., "imagen-3.0-generate-001", "dall-e-3" @@ -64,8 +54,6 @@ e.g., "imagen-3.0-generate-001", "dall-e-3" > `optional` **provider?**: [`ImageGenProvider`](ImageGenProvider.md) \| `string` -Defined in: [types/imageGen.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L78) - Override default provider e.g., "vertex", "openai" @@ -75,8 +63,6 @@ e.g., "vertex", "openai" > `optional` **region?**: `string` -Defined in: [types/imageGen.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L83) - Region for provider (e.g., for Vertex AI) --- @@ -85,8 +71,6 @@ Region for provider (e.g., for Vertex AI) > `optional` **negativePrompt?**: `string` -Defined in: [types/imageGen.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L89) - What to avoid in the generated image (optional) e.g., "blurry, low quality, text overlays" @@ -96,8 +80,6 @@ e.g., "blurry, low quality, text overlays" > `optional` **aspectRatio?**: [`AspectRatio`](AspectRatio.md) \| `string` -Defined in: [types/imageGen.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L95) - Aspect ratio for the generated image e.g., "16:9", "1:1", "4:3", "9:16" @@ -107,8 +89,6 @@ e.g., "16:9", "1:1", "4:3", "9:16" > `optional` **style?**: [`StylePreset`](StylePreset.md) \| `string` -Defined in: [types/imageGen.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L101) - Style preset for the image e.g., "realistic", "artistic", "cartoon", "watercolor", "photorealistic" @@ -118,8 +98,6 @@ e.g., "realistic", "artistic", "cartoon", "watercolor", "photorealistic" > `optional` **numberOfImages?**: `number` -Defined in: [types/imageGen.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L106) - Number of images to generate (default: 1) --- @@ -128,7 +106,5 @@ Number of images to generate (default: 1) > `optional` **temperature?**: `number` -Defined in: [types/imageGen.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L112) - Sampling temperature for generation (0-1) Higher values = more creative/random diff --git a/docs/api/type-aliases/ImageGenProvider.md b/docs/api/type-aliases/ImageGenProvider.md index a493610a9..1dffcc6a6 100644 --- a/docs/api/type-aliases/ImageGenProvider.md +++ b/docs/api/type-aliases/ImageGenProvider.md @@ -8,6 +8,4 @@ > **ImageGenProvider** = `"vertex"` \| `"openai"` \| `"anthropic"` \| `"bedrock"` -Defined in: [types/imageGen.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L15) - Supported image generation providers diff --git a/docs/api/type-aliases/ImageGenResult.md b/docs/api/type-aliases/ImageGenResult.md index 06a311f6e..187fdf892 100644 --- a/docs/api/type-aliases/ImageGenResult.md +++ b/docs/api/type-aliases/ImageGenResult.md @@ -8,8 +8,6 @@ > **ImageGenResult** = `object` -Defined in: [types/imageGen.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L118) - Result of an image generation request ## Properties @@ -18,8 +16,6 @@ Result of an image generation request > **success**: `boolean` -Defined in: [types/imageGen.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L122) - Whether generation was successful --- @@ -28,8 +24,6 @@ Whether generation was successful > `optional` **imageBuffer?**: `Buffer` -Defined in: [types/imageGen.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L127) - Generated image as Buffer (if successful) --- @@ -38,8 +32,6 @@ Generated image as Buffer (if successful) > `optional` **base64?**: `string` -Defined in: [types/imageGen.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L132) - Generated image as base64 string (if successful) --- @@ -48,8 +40,6 @@ Generated image as base64 string (if successful) > `optional` **mimeType?**: `string` -Defined in: [types/imageGen.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L138) - MIME type of the generated image e.g., "image/png", "image/jpeg" @@ -59,8 +49,6 @@ e.g., "image/png", "image/jpeg" > `optional` **model?**: `string` -Defined in: [types/imageGen.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L143) - Model used for generation --- @@ -69,8 +57,6 @@ Model used for generation > `optional` **provider?**: `string` -Defined in: [types/imageGen.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L148) - Provider used for generation --- @@ -79,8 +65,6 @@ Provider used for generation > `optional` **error?**: `string` -Defined in: [types/imageGen.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L153) - Error message if generation failed --- @@ -89,8 +73,6 @@ Error message if generation failed > `optional` **generationTimeMs?**: `number` -Defined in: [types/imageGen.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L158) - Time taken for generation in milliseconds --- @@ -99,6 +81,4 @@ Time taken for generation in milliseconds > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/imageGen.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L163) - Additional metadata from the provider diff --git a/docs/api/type-aliases/ImageGenToolContext.md b/docs/api/type-aliases/ImageGenToolContext.md index 4f19b9fdb..86788ba31 100644 --- a/docs/api/type-aliases/ImageGenToolContext.md +++ b/docs/api/type-aliases/ImageGenToolContext.md @@ -8,8 +8,6 @@ > **ImageGenToolContext** = `object` -Defined in: [types/imageGen.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L285) - Context for tool execution (optional) ## Properties @@ -18,8 +16,6 @@ Context for tool execution (optional) > `optional` **referenceImages?**: (`Buffer` \| `string`)[] -Defined in: [types/imageGen.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L289) - Reference images to use for generation --- @@ -28,8 +24,6 @@ Reference images to use for generation > `optional` **referencePdfs?**: `Buffer`[] -Defined in: [types/imageGen.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L294) - Reference PDFs to use for generation --- @@ -38,8 +32,6 @@ Reference PDFs to use for generation > `optional` **userId?**: `string` -Defined in: [types/imageGen.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L299) - User ID for tracking/logging --- @@ -48,8 +40,6 @@ User ID for tracking/logging > `optional` **sessionId?**: `string` -Defined in: [types/imageGen.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L304) - Session ID for tracking/logging --- @@ -58,6 +48,4 @@ Session ID for tracking/logging > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/imageGen.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L309) - Additional metadata diff --git a/docs/api/type-aliases/ImageGenToolDefinition.md b/docs/api/type-aliases/ImageGenToolDefinition.md index 75a3875e7..3007cdd74 100644 --- a/docs/api/type-aliases/ImageGenToolDefinition.md +++ b/docs/api/type-aliases/ImageGenToolDefinition.md @@ -8,8 +8,6 @@ > **ImageGenToolDefinition** = `object` -Defined in: [types/imageGen.ts:316](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L316) - Tool definition interface compatible with AI SDK / MCP (moved from image-gen/imageGenTools.ts) @@ -19,24 +17,18 @@ Tool definition interface compatible with AI SDK / MCP > **name**: `string` -Defined in: [types/imageGen.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L317) - --- ### description > **description**: `string` -Defined in: [types/imageGen.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L318) - --- ### inputSchema > **inputSchema**: `object` -Defined in: [types/imageGen.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L319) - #### type > **type**: `"object"` @@ -55,8 +47,6 @@ Defined in: [types/imageGen.ts:319](https://github.com/juspay/neurolink/blob/rel > **execute**: (`params`, `context?`) => `Promise`\<[`ImageGenToolResponse`](ImageGenToolResponse.md)\> -Defined in: [types/imageGen.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L331) - #### Parameters ##### params diff --git a/docs/api/type-aliases/ImageGenToolParams.md b/docs/api/type-aliases/ImageGenToolParams.md index f9d292b05..7b7395a4d 100644 --- a/docs/api/type-aliases/ImageGenToolParams.md +++ b/docs/api/type-aliases/ImageGenToolParams.md @@ -8,8 +8,6 @@ > **ImageGenToolParams** = `object` -Defined in: [types/imageGen.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L234) - Tool parameters for AI model use ## Properties @@ -18,8 +16,6 @@ Tool parameters for AI model use > **prompt**: `string` -Defined in: [types/imageGen.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L238) - Detailed description of the image to generate --- @@ -28,8 +24,6 @@ Detailed description of the image to generate > `optional` **negativePrompt?**: `string` -Defined in: [types/imageGen.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L243) - What to avoid in the generated image (optional) --- @@ -38,8 +32,6 @@ What to avoid in the generated image (optional) > `optional` **aspectRatio?**: [`AspectRatio`](AspectRatio.md) \| `string` -Defined in: [types/imageGen.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L248) - Aspect ratio like "16:9", "1:1", "4:3" (optional) --- @@ -48,6 +40,4 @@ Aspect ratio like "16:9", "1:1", "4:3" (optional) > `optional` **style?**: [`StylePreset`](StylePreset.md) \| `string` -Defined in: [types/imageGen.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L253) - Style like "realistic", "artistic", "cartoon" (optional) diff --git a/docs/api/type-aliases/ImageGenToolResponse.md b/docs/api/type-aliases/ImageGenToolResponse.md index 70ec9390f..da968ab7e 100644 --- a/docs/api/type-aliases/ImageGenToolResponse.md +++ b/docs/api/type-aliases/ImageGenToolResponse.md @@ -8,8 +8,6 @@ > **ImageGenToolResponse** = `object` -Defined in: [types/imageGen.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L259) - Response from the image generation tool ## Properties @@ -18,8 +16,6 @@ Response from the image generation tool > **success**: `boolean` -Defined in: [types/imageGen.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L263) - Whether the tool execution was successful --- @@ -28,8 +24,6 @@ Whether the tool execution was successful > `optional` **image?**: `string` -Defined in: [types/imageGen.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L269) - Data URI of the generated image (if successful) Format: data:image/png;base64,... @@ -39,8 +33,6 @@ Format: data:image/png;base64,... > `optional` **message?**: `string` -Defined in: [types/imageGen.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L274) - Human-readable message about the result --- @@ -49,6 +41,4 @@ Human-readable message about the result > `optional` **error?**: `string` -Defined in: [types/imageGen.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/imageGen.ts#L279) - Error message if execution failed diff --git a/docs/api/type-aliases/ImageLoaderOptions.md b/docs/api/type-aliases/ImageLoaderOptions.md index fbcddcfd3..cb9d87605 100644 --- a/docs/api/type-aliases/ImageLoaderOptions.md +++ b/docs/api/type-aliases/ImageLoaderOptions.md @@ -8,8 +8,6 @@ > **ImageLoaderOptions** = `object` -Defined in: [types/rag.ts:1795](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1795) - Options for loading images ## Properties @@ -18,8 +16,6 @@ Options for loading images > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1797](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1797) - Custom metadata to attach to the image document --- @@ -28,8 +24,6 @@ Custom metadata to attach to the image document > `optional` **maxImageSize?**: `number` -Defined in: [types/rag.ts:1799](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1799) - Maximum image file size in bytes (default: 10MB) --- @@ -38,8 +32,6 @@ Maximum image file size in bytes (default: 10MB) > `optional` **fetchTimeout?**: `number` -Defined in: [types/rag.ts:1801](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1801) - Timeout for URL fetches in milliseconds (default: 30000) --- @@ -48,6 +40,4 @@ Timeout for URL fetches in milliseconds (default: 30000) > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/rag.ts:1803](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1803) - Custom headers for URL fetches diff --git a/docs/api/type-aliases/ImageModel.md b/docs/api/type-aliases/ImageModel.md index 8fe345824..56260daff 100644 --- a/docs/api/type-aliases/ImageModel.md +++ b/docs/api/type-aliases/ImageModel.md @@ -7,5 +7,3 @@ # Type Alias: ImageModel > **ImageModel** = `string` \| `Record`\<`string`, `unknown`\> - -Defined in: [types/aiCompat.ts:538](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L538) diff --git a/docs/api/type-aliases/ImageOrientationNormalization.md b/docs/api/type-aliases/ImageOrientationNormalization.md index 77d7e327a..542c06de4 100644 --- a/docs/api/type-aliases/ImageOrientationNormalization.md +++ b/docs/api/type-aliases/ImageOrientationNormalization.md @@ -8,8 +8,6 @@ > **ImageOrientationNormalization** = `object` -Defined in: [types/file.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L88) - Outcome of an EXIF-orientation pass over one image. See `adapters/imageFormatSupport.ts` — `normalized` is false both when the @@ -23,14 +21,10 @@ treat it as a success flag; either way `buffer` is safe to send as-is. > `readonly` **buffer**: `Buffer` -Defined in: [types/file.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L89) - --- ### normalized > `readonly` **normalized**: `boolean` -Defined in: [types/file.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L91) - True when the bytes were re-encoded to apply and strip EXIF orientation. diff --git a/docs/api/type-aliases/ImagePart.md b/docs/api/type-aliases/ImagePart.md index 3555dd164..e5c6c6c10 100644 --- a/docs/api/type-aliases/ImagePart.md +++ b/docs/api/type-aliases/ImagePart.md @@ -8,36 +8,26 @@ > **ImagePart** = `object` -Defined in: [types/aiCompat.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L211) - ## Properties ### type > **type**: `"image"` -Defined in: [types/aiCompat.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L212) - --- ### image > **image**: [`DataContent`](DataContent.md) \| `URL` -Defined in: [types/aiCompat.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L213) - --- ### mediaType? > `optional` **mediaType?**: `string` -Defined in: [types/aiCompat.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L214) - --- ### providerOptions? > `optional` **providerOptions?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\> - -Defined in: [types/aiCompat.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L215) diff --git a/docs/api/type-aliases/ImageValidationResult.md b/docs/api/type-aliases/ImageValidationResult.md index c88f48189..339e8ad24 100644 --- a/docs/api/type-aliases/ImageValidationResult.md +++ b/docs/api/type-aliases/ImageValidationResult.md @@ -8,8 +8,6 @@ > **ImageValidationResult** = `object` -Defined in: [types/ppt.ts:1250](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1250) - Result of image buffer validation ## Properties @@ -18,28 +16,20 @@ Result of image buffer validation > **isValid**: `boolean` -Defined in: [types/ppt.ts:1251](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1251) - --- ### mimeType > **mimeType**: `string` -Defined in: [types/ppt.ts:1252](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1252) - --- ### format > **format**: `string` -Defined in: [types/ppt.ts:1253](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1253) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/ppt.ts:1254](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1254) diff --git a/docs/api/type-aliases/ImageWithAltText.md b/docs/api/type-aliases/ImageWithAltText.md index f84ffd5f5..6be0ea85c 100644 --- a/docs/api/type-aliases/ImageWithAltText.md +++ b/docs/api/type-aliases/ImageWithAltText.md @@ -8,8 +8,6 @@ > **ImageWithAltText** = `object` -Defined in: [types/multimodal.ts:422](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L422) - Image data with optional alt text for accessibility Use this when you need to provide alt text for screen readers and SEO @@ -28,8 +26,6 @@ const imageWithAlt: ImageWithAltText = { > **data**: `Buffer` \| `string` -Defined in: [types/multimodal.ts:424](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L424) - Image data as Buffer, base64 string, URL, or data URI --- @@ -38,6 +34,4 @@ Image data as Buffer, base64 string, URL, or data URI > `optional` **altText?**: `string` -Defined in: [types/multimodal.ts:426](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L426) - Alternative text for accessibility (screen readers, SEO) diff --git a/docs/api/type-aliases/InMemoryAnalyticsStorageOptions.md b/docs/api/type-aliases/InMemoryAnalyticsStorageOptions.md index 221a5b858..90b75806c 100644 --- a/docs/api/type-aliases/InMemoryAnalyticsStorageOptions.md +++ b/docs/api/type-aliases/InMemoryAnalyticsStorageOptions.md @@ -8,8 +8,6 @@ > **InMemoryAnalyticsStorageOptions** = `object` -Defined in: [types/analytics.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L150) - Options for the bounded in-memory analytics storage backend. ## Properties @@ -18,6 +16,4 @@ Options for the bounded in-memory analytics storage backend. > `optional` **maxRecords?**: `number` -Defined in: [types/analytics.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L152) - Maximum records to retain. Oldest records are evicted when exceeded. diff --git a/docs/api/type-aliases/IncomingRequest.md b/docs/api/type-aliases/IncomingRequest.md index eedef4254..9b72c6cda 100644 --- a/docs/api/type-aliases/IncomingRequest.md +++ b/docs/api/type-aliases/IncomingRequest.md @@ -8,8 +8,6 @@ > **IncomingRequest** = `object` -Defined in: [types/auth.ts:1293](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1293) - Minimal request object accepted by the auth middleware. ## Properties @@ -18,76 +16,56 @@ Minimal request object accepted by the auth middleware. > `optional` **method?**: `string` -Defined in: [types/auth.ts:1294](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1294) - --- ### url? > `optional` **url?**: `string` -Defined in: [types/auth.ts:1295](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1295) - --- ### path? > `optional` **path?**: `string` -Defined in: [types/auth.ts:1296](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1296) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\> -Defined in: [types/auth.ts:1297](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1297) - --- ### cookies? > `optional` **cookies?**: `Record`\<`string`, `string`\> -Defined in: [types/auth.ts:1298](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1298) - --- ### query? > `optional` **query?**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\> -Defined in: [types/auth.ts:1299](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1299) - --- ### body? > `optional` **body?**: `unknown` -Defined in: [types/auth.ts:1300](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1300) - --- ### ip? > `optional` **ip?**: `string` -Defined in: [types/auth.ts:1301](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1301) - --- ### user? > `optional` **user?**: [`AuthUser`](AuthUser.md) -Defined in: [types/auth.ts:1302](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1302) - --- ### authContext? > `optional` **authContext?**: [`AuthenticatedContext`](AuthenticatedContext.md) - -Defined in: [types/auth.ts:1303](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1303) diff --git a/docs/api/type-aliases/IndexEntry.md b/docs/api/type-aliases/IndexEntry.md index 2941c8a52..f0fc1c3a7 100644 --- a/docs/api/type-aliases/IndexEntry.md +++ b/docs/api/type-aliases/IndexEntry.md @@ -8,8 +8,6 @@ > **IndexEntry** = [`ArtifactMeta`](ArtifactMeta.md) & `object` -Defined in: [types/artifact.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/artifact.ts#L234) - In-memory index row tracked by LocalTempArtifactStore. Combines metadata with the on-disk path. diff --git a/docs/api/type-aliases/IndexedKnowledgeDocument.md b/docs/api/type-aliases/IndexedKnowledgeDocument.md index 0cbbb26d6..69341a9e8 100644 --- a/docs/api/type-aliases/IndexedKnowledgeDocument.md +++ b/docs/api/type-aliases/IndexedKnowledgeDocument.md @@ -8,8 +8,6 @@ > **IndexedKnowledgeDocument** = `object` -Defined in: [types/knowledge.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L279) - The internal search document built from a normalized entry. `exactKeys` and `fields` hold pre-tokenized normalized text. Internal to NeuroLink. @@ -19,16 +17,12 @@ The internal search document built from a normalized entry. `exactKeys` and > **id**: `string` -Defined in: [types/knowledge.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L280) - --- ### exactKeys > **exactKeys**: `string`[] -Defined in: [types/knowledge.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L282) - Normalized whole-phrase keys for exact/alias resolution. --- @@ -37,8 +31,6 @@ Normalized whole-phrase keys for exact/alias resolution. > **fields**: `object` -Defined in: [types/knowledge.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L284) - Per-field normalized token arrays fed to the field-aware BM25 scorer. #### title diff --git a/docs/api/type-aliases/IndividualProviderConfig.md b/docs/api/type-aliases/IndividualProviderConfig.md index 5da6be6c4..e8c0662ea 100644 --- a/docs/api/type-aliases/IndividualProviderConfig.md +++ b/docs/api/type-aliases/IndividualProviderConfig.md @@ -8,8 +8,6 @@ > **IndividualProviderConfig** = `object` -Defined in: [types/providers.ts:571](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L571) - Provider configuration for individual providers ## Indexable @@ -22,48 +20,36 @@ Provider configuration for individual providers > `optional` **apiKey?**: `string` -Defined in: [types/providers.ts:572](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L572) - --- ### baseURL? > `optional` **baseURL?**: `string` -Defined in: [types/providers.ts:573](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L573) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/providers.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L574) - --- ### retries? > `optional` **retries?**: `number` -Defined in: [types/providers.ts:575](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L575) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/providers.ts:576](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L576) - --- ### subscriptionTier? > `optional` **subscriptionTier?**: [`ClaudeSubscriptionTier`](ClaudeSubscriptionTier.md) -Defined in: [types/providers.ts:581](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L581) - The subscription tier for the provider (e.g., Claude Pro, Max, Team, Enterprise) Used to determine rate limits, available features, and pricing @@ -73,8 +59,6 @@ Used to determine rate limits, available features, and pricing > `optional` **authMethod?**: [`AnthropicAuthMethod`](AnthropicAuthMethod.md) -Defined in: [types/providers.ts:586](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L586) - The authentication method to use for the provider Supports API key, OAuth, session token, or environment variable @@ -84,8 +68,6 @@ Supports API key, OAuth, session token, or environment variable > `optional` **authConfig?**: [`AnthropicAuthConfig`](AnthropicAuthConfig.md) -Defined in: [types/providers.ts:590](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L590) - Detailed authentication configuration including credentials and options --- @@ -94,7 +76,5 @@ Detailed authentication configuration including credentials and options > `optional` **enableBetaFeatures?**: `boolean` -Defined in: [types/providers.ts:595](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L595) - Whether to enable beta features for the provider Beta features may be unstable or subject to change diff --git a/docs/api/type-aliases/InferSchema.md b/docs/api/type-aliases/InferSchema.md index c8d154efe..0ad3edc02 100644 --- a/docs/api/type-aliases/InferSchema.md +++ b/docs/api/type-aliases/InferSchema.md @@ -8,8 +8,6 @@ > **InferSchema**\<`SCHEMA`\> = `SCHEMA` _extends_ `ZodSchema`\ ? `T` : `SCHEMA` _extends_ `StandardSchema`\ ? `T` : `SCHEMA` _extends_ `LazySchema`\ ? `T` : `SCHEMA` _extends_ [`Schema`](Schema.md)\ ? `T` : `never` -Defined in: [types/aiCompat.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L75) - ## Type Parameters ### SCHEMA diff --git a/docs/api/type-aliases/InferToolInput.md b/docs/api/type-aliases/InferToolInput.md index c55754014..eaf11e9f6 100644 --- a/docs/api/type-aliases/InferToolInput.md +++ b/docs/api/type-aliases/InferToolInput.md @@ -8,8 +8,6 @@ > **InferToolInput**\<`TOOL`\> = `TOOL` _extends_ [`Tool`](Tool.md)\ ? `INPUT` : `never` -Defined in: [types/aiCompat.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L179) - ## Type Parameters ### TOOL diff --git a/docs/api/type-aliases/InferToolOutput.md b/docs/api/type-aliases/InferToolOutput.md index 48e28c446..5bea45fcc 100644 --- a/docs/api/type-aliases/InferToolOutput.md +++ b/docs/api/type-aliases/InferToolOutput.md @@ -8,8 +8,6 @@ > **InferToolOutput**\<`TOOL`\> = `TOOL` _extends_ [`Tool`](Tool.md)\<`any`, infer OUTPUT\> ? `OUTPUT` : `never` -Defined in: [types/aiCompat.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L182) - ## Type Parameters ### TOOL diff --git a/docs/api/type-aliases/InferenceKind.md b/docs/api/type-aliases/InferenceKind.md index 8b90f7ca0..4ece9348d 100644 --- a/docs/api/type-aliases/InferenceKind.md +++ b/docs/api/type-aliases/InferenceKind.md @@ -8,8 +8,6 @@ > **InferenceKind** = `"generate"` \| `"stream"` \| `"decide"` -Defined in: [types/providers.ts:2244](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2244) - The kinds of inference a provider can serve. `generate` and `stream` both produce text. `decide` produces typed, diff --git a/docs/api/type-aliases/InfraRegistryEntry.md b/docs/api/type-aliases/InfraRegistryEntry.md index 6940c9809..dc4bd8a52 100644 --- a/docs/api/type-aliases/InfraRegistryEntry.md +++ b/docs/api/type-aliases/InfraRegistryEntry.md @@ -8,8 +8,6 @@ > **InfraRegistryEntry**\<`TItem`, `TMetadata`\> = `object` -Defined in: [types/common.ts:451](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L451) - Registry entry for lazy-loaded items in BaseRegistry. Named InfraRegistryEntry to avoid collision with workflowTypes.ts RegistryEntry. @@ -29,8 +27,6 @@ Named InfraRegistryEntry to avoid collision with workflowTypes.ts RegistryEntry. > **factory**: () => `Promise`\<`TItem`\> -Defined in: [types/common.ts:452](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L452) - #### Returns `Promise`\<`TItem`\> @@ -41,12 +37,8 @@ Defined in: [types/common.ts:452](https://github.com/juspay/neurolink/blob/relea > **metadata**: `TMetadata` -Defined in: [types/common.ts:453](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L453) - --- ### instance? > `optional` **instance?**: `TItem` - -Defined in: [types/common.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L454) diff --git a/docs/api/type-aliases/InfraRetryOptions.md b/docs/api/type-aliases/InfraRetryOptions.md index 3927aafa9..17f5094ef 100644 --- a/docs/api/type-aliases/InfraRetryOptions.md +++ b/docs/api/type-aliases/InfraRetryOptions.md @@ -8,8 +8,6 @@ > **InfraRetryOptions** = `object` -Defined in: [types/common.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L324) - Simple retry options for infrastructure-level retry logic. Named InfraRetryOptions to avoid collision with utilities.ts RetryOptions and common.ts AsyncRetryOptions. @@ -20,32 +18,24 @@ common.ts AsyncRetryOptions. > **maxRetries**: `number` -Defined in: [types/common.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L325) - --- ### baseDelayMs > **baseDelayMs**: `number` -Defined in: [types/common.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L326) - --- ### maxDelayMs? > `optional` **maxDelayMs?**: `number` -Defined in: [types/common.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L327) - --- ### shouldRetry? > `optional` **shouldRetry?**: (`error`) => `boolean` -Defined in: [types/common.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L328) - #### Parameters ##### error diff --git a/docs/api/type-aliases/IngestOptions.md b/docs/api/type-aliases/IngestOptions.md index 3df4c79aa..a3e09e43c 100644 --- a/docs/api/type-aliases/IngestOptions.md +++ b/docs/api/type-aliases/IngestOptions.md @@ -8,8 +8,6 @@ > **IngestOptions** = `object` -Defined in: [types/rag.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L299) - Ingestion options ## Properties @@ -18,8 +16,6 @@ Ingestion options > `optional` **strategy?**: [`ChunkingStrategy`](ChunkingStrategy.md) -Defined in: [types/rag.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L301) - Chunking strategy override --- @@ -28,8 +24,6 @@ Chunking strategy override > `optional` **chunkSize?**: `number` -Defined in: [types/rag.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L303) - Chunk size override --- @@ -38,8 +32,6 @@ Chunk size override > `optional` **chunkOverlap?**: `number` -Defined in: [types/rag.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L305) - Chunk overlap override --- @@ -48,8 +40,6 @@ Chunk overlap override > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L307) - Custom metadata to add --- @@ -58,6 +48,4 @@ Custom metadata to add > `optional` **extractMetadata?**: `boolean` -Defined in: [types/rag.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L309) - Extract metadata using LLM diff --git a/docs/api/type-aliases/InstalledVersionValidation.md b/docs/api/type-aliases/InstalledVersionValidation.md index 648aab176..ba3b8558e 100644 --- a/docs/api/type-aliases/InstalledVersionValidation.md +++ b/docs/api/type-aliases/InstalledVersionValidation.md @@ -8,8 +8,6 @@ > **InstalledVersionValidation** = `object` -Defined in: [types/proxy.ts:3278](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3278) - Result of validating a newly installed CLI through the stable trampoline. ## Properties @@ -18,20 +16,14 @@ Result of validating a newly installed CLI through the stable trampoline. > `optional` **version?**: `string` -Defined in: [types/proxy.ts:3279](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3279) - --- ### attempts > **attempts**: `number` -Defined in: [types/proxy.ts:3280](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3280) - --- ### failure? > `optional` **failure?**: `string` - -Defined in: [types/proxy.ts:3281](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3281) diff --git a/docs/api/type-aliases/InteractiveProviderConfig.md b/docs/api/type-aliases/InteractiveProviderConfig.md index bfcfb4cd1..b827fad58 100644 --- a/docs/api/type-aliases/InteractiveProviderConfig.md +++ b/docs/api/type-aliases/InteractiveProviderConfig.md @@ -8,8 +8,6 @@ > **InteractiveProviderConfig** = `object` -Defined in: [types/cli.ts:1840](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1840) - Provider config row used by the interactive setup wizard. ## Properties @@ -18,32 +16,24 @@ Provider config row used by the interactive setup wizard. > **id**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/cli.ts:1841](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1841) - --- ### name > **name**: `string` -Defined in: [types/cli.ts:1842](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1842) - --- ### description > **description**: `string` -Defined in: [types/cli.ts:1843](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1843) - --- ### envVars > **envVars**: `object`[] -Defined in: [types/cli.ts:1844](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1844) - #### key > **key**: `string` diff --git a/docs/api/type-aliases/InternalResult.md b/docs/api/type-aliases/InternalResult.md index eb7e2a8d6..5277e45a3 100644 --- a/docs/api/type-aliases/InternalResult.md +++ b/docs/api/type-aliases/InternalResult.md @@ -8,8 +8,6 @@ > **InternalResult** = `object` -Defined in: [types/proxy.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L280) - Minimal subset of NeuroLink's GenerateResult that the proxy layer consumes. Kept intentionally narrow so the proxy layer does not depend on every field of the full type. @@ -20,32 +18,24 @@ field of the full type. > **content**: `string` -Defined in: [types/proxy.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L281) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/proxy.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L282) - --- ### finishReason? > `optional` **finishReason?**: `string` -Defined in: [types/proxy.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L283) - --- ### reasoning? > `optional` **reasoning?**: `string` -Defined in: [types/proxy.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L285) - Thinking/reasoning text from provider (Anthropic thinking blocks, Gemini thought parts) --- @@ -54,8 +44,6 @@ Thinking/reasoning text from provider (Anthropic thinking blocks, Gemini thought > `optional` **usage?**: `object` -Defined in: [types/proxy.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L286) - #### input > **input**: `number` @@ -86,8 +74,6 @@ Defined in: [types/proxy.ts:286](https://github.com/juspay/neurolink/blob/releas > `optional` **toolCalls?**: `object`[] -Defined in: [types/proxy.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L294) - #### toolCallId > **toolCallId**: `string` diff --git a/docs/api/type-aliases/InternalStreamEvent.md b/docs/api/type-aliases/InternalStreamEvent.md index 85b25df61..e870e318e 100644 --- a/docs/api/type-aliases/InternalStreamEvent.md +++ b/docs/api/type-aliases/InternalStreamEvent.md @@ -8,8 +8,6 @@ > **InternalStreamEvent** = `object` -Defined in: [types/common.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L161) - Stream event types for real-time communication ## Properties @@ -18,28 +16,20 @@ Stream event types for real-time communication > **type**: `"stream:chunk"` \| `"stream:complete"` \| `"stream:error"` -Defined in: [types/common.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L162) - --- ### content? > `optional` **content?**: `string` -Defined in: [types/common.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L163) - --- ### metadata? > `optional` **metadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/common.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L164) - --- ### timestamp > **timestamp**: `number` - -Defined in: [types/common.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L165) diff --git a/docs/api/type-aliases/IntervalSchedule.md b/docs/api/type-aliases/IntervalSchedule.md index a48e151f9..6dd98ea91 100644 --- a/docs/api/type-aliases/IntervalSchedule.md +++ b/docs/api/type-aliases/IntervalSchedule.md @@ -8,22 +8,16 @@ > **IntervalSchedule** = `object` -Defined in: [types/task.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L62) - ## Properties ### type > **type**: `"interval"` -Defined in: [types/task.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L63) - --- ### every > **every**: `number` -Defined in: [types/task.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L65) - Interval in milliseconds diff --git a/docs/api/type-aliases/InvokeEndpointParams.md b/docs/api/type-aliases/InvokeEndpointParams.md index 2200c0969..97e33663f 100644 --- a/docs/api/type-aliases/InvokeEndpointParams.md +++ b/docs/api/type-aliases/InvokeEndpointParams.md @@ -8,8 +8,6 @@ > **InvokeEndpointParams** = `object` -Defined in: [types/providers.ts:1582](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1582) - Parameters for SageMaker endpoint invocation ## Properties @@ -18,8 +16,6 @@ Parameters for SageMaker endpoint invocation > **EndpointName**: `string` -Defined in: [types/providers.ts:1584](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1584) - Endpoint name to invoke --- @@ -28,8 +24,6 @@ Endpoint name to invoke > **Body**: `string` \| `Uint8Array` -Defined in: [types/providers.ts:1586](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1586) - Request body as string or Uint8Array --- @@ -38,8 +32,6 @@ Request body as string or Uint8Array > `optional` **ContentType?**: `string` -Defined in: [types/providers.ts:1588](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1588) - Content type of the request --- @@ -48,8 +40,6 @@ Content type of the request > `optional` **Accept?**: `string` -Defined in: [types/providers.ts:1590](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1590) - Accept header for response format --- @@ -58,8 +48,6 @@ Accept header for response format > `optional` **CustomAttributes?**: `string` -Defined in: [types/providers.ts:1592](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1592) - Custom attributes for the request --- @@ -68,8 +56,6 @@ Custom attributes for the request > `optional` **TargetModel?**: `string` -Defined in: [types/providers.ts:1594](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1594) - Target model for multi-model endpoints --- @@ -78,8 +64,6 @@ Target model for multi-model endpoints > `optional` **TargetVariant?**: `string` -Defined in: [types/providers.ts:1596](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1596) - Target variant for A/B testing --- @@ -88,8 +72,6 @@ Target variant for A/B testing > `optional` **InferenceId?**: `string` -Defined in: [types/providers.ts:1598](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1598) - Inference ID for request tracking --- @@ -98,8 +80,6 @@ Inference ID for request tracking > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/providers.ts:1608](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1608) - Cancels the in-flight HTTP request, not just the loop around it. Named in camelCase deliberately: every other field here mirrors an AWS diff --git a/docs/api/type-aliases/InvokeEndpointResponse.md b/docs/api/type-aliases/InvokeEndpointResponse.md index f35ab187c..a84a9d151 100644 --- a/docs/api/type-aliases/InvokeEndpointResponse.md +++ b/docs/api/type-aliases/InvokeEndpointResponse.md @@ -8,8 +8,6 @@ > **InvokeEndpointResponse** = `object` -Defined in: [types/providers.ts:1614](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1614) - Response from SageMaker endpoint invocation ## Properties @@ -18,8 +16,6 @@ Response from SageMaker endpoint invocation > `optional` **Body?**: `Uint8Array` -Defined in: [types/providers.ts:1616](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1616) - Response body --- @@ -28,8 +24,6 @@ Response body > `optional` **ContentType?**: `string` -Defined in: [types/providers.ts:1618](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1618) - Content type of the response --- @@ -38,8 +32,6 @@ Content type of the response > `optional` **InvokedProductionVariant?**: `string` -Defined in: [types/providers.ts:1620](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1620) - Invoked production variant --- @@ -48,6 +40,4 @@ Invoked production variant > `optional` **CustomAttributes?**: `string` -Defined in: [types/providers.ts:1622](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1622) - Custom attributes in the response diff --git a/docs/api/type-aliases/IsolatedAgentDefinition.md b/docs/api/type-aliases/IsolatedAgentDefinition.md index 7253c799b..aaf587f76 100644 --- a/docs/api/type-aliases/IsolatedAgentDefinition.md +++ b/docs/api/type-aliases/IsolatedAgentDefinition.md @@ -8,8 +8,6 @@ > **IsolatedAgentDefinition** = [`AgentDefinition`](AgentDefinition.md) & `object` -Defined in: [types/isolatedAgent.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L131) - Definition of an isolated sub-agent: a standard AgentDefinition plus optional structured extraction. diff --git a/docs/api/type-aliases/IsolatedAgentExtraction.md b/docs/api/type-aliases/IsolatedAgentExtraction.md index 9d79353fe..9ac8adfbf 100644 --- a/docs/api/type-aliases/IsolatedAgentExtraction.md +++ b/docs/api/type-aliases/IsolatedAgentExtraction.md @@ -8,8 +8,6 @@ > **IsolatedAgentExtraction** = `object` -Defined in: [types/isolatedAgent.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L92) - Structured-extraction configuration for an isolated agent run. The extraction pass always runs tools-off on its own timeout, fed from the @@ -22,8 +20,6 @@ provider error still extracts from the records instead of losing the run. > **schema**: `z.ZodSchema` -Defined in: [types/isolatedAgent.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L94) - Local validator (lenient — may carry defaults/catch). Required. --- @@ -32,8 +28,6 @@ Local validator (lenient — may carry defaults/catch). Required. > `optional` **wireSchema?**: `z.ZodSchema` -Defined in: [types/isolatedAgent.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L99) - Provider-attached wire schema (strict: no defaults/catch, which many providers reject in constrained decoding). Falls back to `schema`. @@ -43,8 +37,6 @@ providers reject in constrained decoding). Falls back to `schema`. > `optional` **shapeDoc?**: `string` -Defined in: [types/isolatedAgent.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L104) - Human/model-readable JSON shape description used in the extraction prompt and in corrective retries alongside validation errors. @@ -54,8 +46,6 @@ prompt and in corrective retries alongside validation errors. > `optional` **coerce?**: (`candidate`) => `unknown` -Defined in: [types/isolatedAgent.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L109) - Normalizer applied to every recovery candidate before validation (e.g. wrap a bare top-level array into the expected envelope). @@ -75,8 +65,6 @@ Normalizer applied to every recovery candidate before validation > `optional` **maxRetries?**: `number` -Defined in: [types/isolatedAgent.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L111) - Corrective re-ask attempts after ladder failure (default 2). --- @@ -85,8 +73,6 @@ Corrective re-ask attempts after ladder failure (default 2). > `optional` **timeoutMs?**: `number` -Defined in: [types/isolatedAgent.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L116) - Per-attempt extraction timeout in ms (default 60_000). Never carved out of the research budget. @@ -96,8 +82,6 @@ of the research budget. > `optional` **totalTimeoutMs?**: `number` -Defined in: [types/isolatedAgent.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/isolatedAgent.ts#L124) - Phase-level deadline bounding ALL extraction attempts (ms). Defaults to `(maxRetries + 1) × timeoutMs` — i.e. 180s at the defaults. Callers that derive an outer tool-execution ceiling from the leg budget must add this diff --git a/docs/api/type-aliases/IssueCategory.md b/docs/api/type-aliases/IssueCategory.md index 120206b32..5f3981d40 100644 --- a/docs/api/type-aliases/IssueCategory.md +++ b/docs/api/type-aliases/IssueCategory.md @@ -7,5 +7,3 @@ # Type Alias: IssueCategory > **IssueCategory** = `"explicit_content"` \| `"hate_speech"` \| `"violence"` \| `"personal_info"` \| `"spam"` \| `"other"` - -Defined in: [types/guardrails.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L26) diff --git a/docs/api/type-aliases/IssueSeverity.md b/docs/api/type-aliases/IssueSeverity.md index b020fce38..c28402b43 100644 --- a/docs/api/type-aliases/IssueSeverity.md +++ b/docs/api/type-aliases/IssueSeverity.md @@ -7,5 +7,3 @@ # Type Alias: IssueSeverity > **IssueSeverity** = `"low"` \| `"medium"` \| `"high"` \| `"critical"` - -Defined in: [types/guardrails.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L34) diff --git a/docs/api/type-aliases/JSONChunkerConfig.md b/docs/api/type-aliases/JSONChunkerConfig.md index 364c3e995..cadcb71e0 100644 --- a/docs/api/type-aliases/JSONChunkerConfig.md +++ b/docs/api/type-aliases/JSONChunkerConfig.md @@ -8,8 +8,6 @@ > **JSONChunkerConfig** = [`BaseChunkerConfig`](BaseChunkerConfig.md) & `object` -Defined in: [types/rag.ts:987](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L987) - JSON chunker configuration JSON structure-aware splitting diff --git a/docs/api/type-aliases/JSONOutput.md b/docs/api/type-aliases/JSONOutput.md index 1388d3610..ccc52af2c 100644 --- a/docs/api/type-aliases/JSONOutput.md +++ b/docs/api/type-aliases/JSONOutput.md @@ -8,8 +8,6 @@ > **JSONOutput** = `object` -Defined in: [types/cli.ts:548](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L548) - JSON output structure ## Properties @@ -18,32 +16,24 @@ JSON output structure > **success**: `boolean` -Defined in: [types/cli.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L549) - --- ### data? > `optional` **data?**: [`JsonValue`](JsonValue.md) -Defined in: [types/cli.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L550) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/cli.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L551) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/cli.ts:552](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L552) - #### timestamp > **timestamp**: `number` diff --git a/docs/api/type-aliases/JWK.md b/docs/api/type-aliases/JWK.md index 194da38de..71a54aeec 100644 --- a/docs/api/type-aliases/JWK.md +++ b/docs/api/type-aliases/JWK.md @@ -8,8 +8,6 @@ > **JWK** = `object` -Defined in: [types/auth.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L241) - JWKS (JSON Web Key Set) types ## Properties @@ -18,68 +16,50 @@ JWKS (JSON Web Key Set) types > **kty**: `string` -Defined in: [types/auth.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L242) - --- ### kid? > `optional` **kid?**: `string` -Defined in: [types/auth.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L243) - --- ### use? > `optional` **use?**: `string` -Defined in: [types/auth.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L244) - --- ### alg? > `optional` **alg?**: `string` -Defined in: [types/auth.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L245) - --- ### n? > `optional` **n?**: `string` -Defined in: [types/auth.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L246) - --- ### e? > `optional` **e?**: `string` -Defined in: [types/auth.ts:247](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L247) - --- ### x? > `optional` **x?**: `string` -Defined in: [types/auth.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L248) - --- ### y? > `optional` **y?**: `string` -Defined in: [types/auth.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L249) - --- ### crv? > `optional` **crv?**: `string` - -Defined in: [types/auth.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L250) diff --git a/docs/api/type-aliases/JWKS.md b/docs/api/type-aliases/JWKS.md index c7b784661..639926407 100644 --- a/docs/api/type-aliases/JWKS.md +++ b/docs/api/type-aliases/JWKS.md @@ -8,12 +8,8 @@ > **JWKS** = `object` -Defined in: [types/auth.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L253) - ## Properties ### keys > **keys**: [`JWK`](JWK.md)[] - -Defined in: [types/auth.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L254) diff --git a/docs/api/type-aliases/JWTConfig.md b/docs/api/type-aliases/JWTConfig.md index cd5135df3..f10793ad2 100644 --- a/docs/api/type-aliases/JWTConfig.md +++ b/docs/api/type-aliases/JWTConfig.md @@ -8,8 +8,6 @@ > **JWTConfig** = `object` -Defined in: [types/auth.ts:781](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L781) - JWT provider configuration ## Properties @@ -18,8 +16,6 @@ JWT provider configuration > `optional` **secret?**: `string` -Defined in: [types/auth.ts:783](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L783) - JWT secret for HMAC algorithms --- @@ -28,8 +24,6 @@ JWT secret for HMAC algorithms > `optional` **publicKey?**: `string` -Defined in: [types/auth.ts:785](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L785) - Public key for RSA/EC algorithms --- @@ -38,8 +32,6 @@ Public key for RSA/EC algorithms > `optional` **algorithms?**: `string`[] -Defined in: [types/auth.ts:787](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L787) - Supported algorithms --- @@ -48,8 +40,6 @@ Supported algorithms > `optional` **issuer?**: `string` -Defined in: [types/auth.ts:789](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L789) - Token issuer --- @@ -58,6 +48,4 @@ Token issuer > `optional` **audience?**: `string` \| `string`[] -Defined in: [types/auth.ts:791](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L791) - Token audience diff --git a/docs/api/type-aliases/JinaEmbeddingsResponse.md b/docs/api/type-aliases/JinaEmbeddingsResponse.md index 1462d6736..0e1835894 100644 --- a/docs/api/type-aliases/JinaEmbeddingsResponse.md +++ b/docs/api/type-aliases/JinaEmbeddingsResponse.md @@ -8,8 +8,6 @@ > **JinaEmbeddingsResponse** = `object` -Defined in: [types/providers.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L312) - Jina AI /embeddings response shape (compatible with OpenAI's shape). ## Properties @@ -18,16 +16,12 @@ Jina AI /embeddings response shape (compatible with OpenAI's shape). > `optional` **object?**: `string` -Defined in: [types/providers.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L313) - --- ### data > **data**: `object`[] -Defined in: [types/providers.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L314) - #### object? > `optional` **object?**: `string` @@ -46,16 +40,12 @@ Defined in: [types/providers.ts:314](https://github.com/juspay/neurolink/blob/re > `optional` **model?**: `string` -Defined in: [types/providers.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L315) - --- ### usage? > `optional` **usage?**: `object` -Defined in: [types/providers.ts:316](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L316) - #### total_tokens? > `optional` **total_tokens?**: `number` diff --git a/docs/api/type-aliases/JinaRerankResponse.md b/docs/api/type-aliases/JinaRerankResponse.md index 7d50bd3b6..e116226ce 100644 --- a/docs/api/type-aliases/JinaRerankResponse.md +++ b/docs/api/type-aliases/JinaRerankResponse.md @@ -8,8 +8,6 @@ > **JinaRerankResponse** = `object` -Defined in: [types/providers.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L322) - Jina AI /rerank response shape. ## Properties @@ -18,16 +16,12 @@ Jina AI /rerank response shape. > `optional` **model?**: `string` -Defined in: [types/providers.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L323) - --- ### results > **results**: `object`[] -Defined in: [types/providers.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L324) - #### index > **index**: `number` @@ -50,8 +44,6 @@ Defined in: [types/providers.ts:324](https://github.com/juspay/neurolink/blob/re > `optional` **usage?**: `object` -Defined in: [types/providers.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L329) - #### total_tokens? > `optional` **total_tokens?**: `number` diff --git a/docs/api/type-aliases/JsonArray.md b/docs/api/type-aliases/JsonArray.md index 98f1d984f..239e8bc2c 100644 --- a/docs/api/type-aliases/JsonArray.md +++ b/docs/api/type-aliases/JsonArray.md @@ -7,5 +7,3 @@ # Type Alias: JsonArray > **JsonArray** = [`JsonValue`](JsonValue.md)[] - -Defined in: [types/common.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L55) diff --git a/docs/api/type-aliases/JsonCoercionResult.md b/docs/api/type-aliases/JsonCoercionResult.md index 6a955da43..77c61bbc7 100644 --- a/docs/api/type-aliases/JsonCoercionResult.md +++ b/docs/api/type-aliases/JsonCoercionResult.md @@ -8,8 +8,6 @@ > **JsonCoercionResult** = `object` -Defined in: [types/utilities.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L326) - Result of coercing arbitrary model text into canonical, valid JSON. `content` is a JSON.stringify of the recovered object; `structuredData` is the parsed object itself. @@ -20,24 +18,18 @@ the parsed object itself. > **content**: `string` -Defined in: [types/utilities.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L327) - --- ### structuredData > **structuredData**: `unknown` -Defined in: [types/utilities.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L328) - --- ### repaired > **repaired**: `boolean` -Defined in: [types/utilities.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L330) - True when jsonrepair altered the model text to make it parse. --- @@ -46,7 +38,5 @@ True when jsonrepair altered the model text to make it parse. > **truncated**: `boolean` -Defined in: [types/utilities.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L335) - True when the recovered object came from a truncated (unclosed) span — the response likely hit the output-token cap and data may be incomplete. diff --git a/docs/api/type-aliases/JsonObject.md b/docs/api/type-aliases/JsonObject.md index d75dad83e..585e254d5 100644 --- a/docs/api/type-aliases/JsonObject.md +++ b/docs/api/type-aliases/JsonObject.md @@ -8,8 +8,6 @@ > **JsonObject** = `object` -Defined in: [types/common.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L51) - Re-export commonly used types from other modules Provides one-stop shop for type imports diff --git a/docs/api/type-aliases/JsonRecord.md b/docs/api/type-aliases/JsonRecord.md index d50801e72..b5719cdd1 100644 --- a/docs/api/type-aliases/JsonRecord.md +++ b/docs/api/type-aliases/JsonRecord.md @@ -8,7 +8,5 @@ > **JsonRecord** = `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/aliases.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L94) - JSON-safe record type for API communication Ensures values are JSON-serializable diff --git a/docs/api/type-aliases/JsonTypeGuard.md b/docs/api/type-aliases/JsonTypeGuard.md index 677768610..35226e5de 100644 --- a/docs/api/type-aliases/JsonTypeGuard.md +++ b/docs/api/type-aliases/JsonTypeGuard.md @@ -8,8 +8,6 @@ > **JsonTypeGuard**\<`T`\> = (`parsed`) => `parsed is T` -Defined in: [types/processor.ts:780](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L780) - Type guard function signature for JSON parsing. ## Type Parameters diff --git a/docs/api/type-aliases/JsonValue.md b/docs/api/type-aliases/JsonValue.md index ea4eaa799..0af42f936 100644 --- a/docs/api/type-aliases/JsonValue.md +++ b/docs/api/type-aliases/JsonValue.md @@ -8,6 +8,4 @@ > **JsonValue** = `string` \| `number` \| `boolean` \| `null` \| [`JsonObject`](JsonObject.md) \| [`JsonArray`](JsonArray.md) -Defined in: [types/common.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L43) - JSON-serializable value type diff --git a/docs/api/type-aliases/JudgeConfig.md b/docs/api/type-aliases/JudgeConfig.md index fee23b313..47ba0f3d3 100644 --- a/docs/api/type-aliases/JudgeConfig.md +++ b/docs/api/type-aliases/JudgeConfig.md @@ -8,8 +8,6 @@ > **JudgeConfig** = `object` -Defined in: [types/workflow.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L126) - Judge model configuration NOTE: Testing phase uses fixed 0-100 scoring scale @@ -19,104 +17,78 @@ NOTE: Testing phase uses fixed 0-100 scoring scale > **provider**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/workflow.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L128) - --- ### model > **model**: `string` -Defined in: [types/workflow.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L129) - --- ### criteria > **criteria**: `string`[] -Defined in: [types/workflow.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L130) - --- ### outputFormat > **outputFormat**: [`JudgeOutputFormat`](JudgeOutputFormat.md) -Defined in: [types/workflow.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L131) - --- ### customPrompt? > `optional` **customPrompt?**: `string` -Defined in: [types/workflow.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L134) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/workflow.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L135) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/workflow.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L136) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/workflow.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L137) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/workflow.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L138) - --- ### blindEvaluation? > `optional` **blindEvaluation?**: `boolean` -Defined in: [types/workflow.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L141) - --- ### includeReasoning > **includeReasoning**: `boolean` -Defined in: [types/workflow.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L142) - --- ### synthesizeImprovedResponse? > `optional` **synthesizeImprovedResponse?**: `boolean` -Defined in: [types/workflow.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L143) - --- ### scoreScale > **scoreScale**: `object` -Defined in: [types/workflow.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L144) - #### min > **min**: `0` @@ -131,12 +103,8 @@ Defined in: [types/workflow.ts:144](https://github.com/juspay/neurolink/blob/rel > `optional` **label?**: `string` -Defined in: [types/workflow.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L151) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> - -Defined in: [types/workflow.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L152) diff --git a/docs/api/type-aliases/JudgeOutputFormat.md b/docs/api/type-aliases/JudgeOutputFormat.md index 0117a21b2..1a106063d 100644 --- a/docs/api/type-aliases/JudgeOutputFormat.md +++ b/docs/api/type-aliases/JudgeOutputFormat.md @@ -8,6 +8,4 @@ > **JudgeOutputFormat** = `"scores"` \| `"ranking"` \| `"best"` \| `"detailed"` -Defined in: [types/workflow.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L25) - Judge output format options diff --git a/docs/api/type-aliases/JudgeScoreResult.md b/docs/api/type-aliases/JudgeScoreResult.md index 326068af1..13f660e26 100644 --- a/docs/api/type-aliases/JudgeScoreResult.md +++ b/docs/api/type-aliases/JudgeScoreResult.md @@ -8,8 +8,6 @@ > **JudgeScoreResult** = `object` -Defined in: [types/workflow.ts:583](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L583) - Result of judge scoring ## Properties @@ -18,20 +16,14 @@ Result of judge scoring > **scores**: [`JudgeScores`](JudgeScores.md) \| [`MultiJudgeScores`](MultiJudgeScores.md) -Defined in: [types/workflow.ts:584](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L584) - --- ### judgeTime > **judgeTime**: `number` -Defined in: [types/workflow.ts:585](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L585) - --- ### error? > `optional` **error?**: [`WorkflowError`](../classes/WorkflowError.md) - -Defined in: [types/workflow.ts:586](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L586) diff --git a/docs/api/type-aliases/JudgeScores.md b/docs/api/type-aliases/JudgeScores.md index 68f0d9fa8..401c01a85 100644 --- a/docs/api/type-aliases/JudgeScores.md +++ b/docs/api/type-aliases/JudgeScores.md @@ -8,8 +8,6 @@ > **JudgeScores** = `object` -Defined in: [types/workflow.ts:339](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L339) - Judge scoring results NOTE: Scores are 0-100 for standardized evaluation @@ -19,92 +17,68 @@ NOTE: Scores are 0-100 for standardized evaluation > **judgeProvider**: `string` -Defined in: [types/workflow.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L341) - --- ### judgeModel > **judgeModel**: `string` -Defined in: [types/workflow.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L342) - --- ### scores > **scores**: `Record`\<`string`, `number`\> -Defined in: [types/workflow.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L345) - --- ### ranking? > `optional` **ranking?**: `string`[] -Defined in: [types/workflow.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L346) - --- ### bestResponse? > `optional` **bestResponse?**: `string` -Defined in: [types/workflow.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L347) - --- ### criteria > **criteria**: `string`[] -Defined in: [types/workflow.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L350) - --- ### reasoning? > `optional` **reasoning?**: `string` -Defined in: [types/workflow.ts:351](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L351) - --- ### synthesizedResponse? > `optional` **synthesizedResponse?**: `string` -Defined in: [types/workflow.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L352) - --- ### confidenceInJudgment? > `optional` **confidenceInJudgment?**: `number` -Defined in: [types/workflow.ts:353](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L353) - --- ### judgeTime > **judgeTime**: `number` -Defined in: [types/workflow.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L356) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/workflow.ts:359](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L359) - --- ### timestamp > **timestamp**: `string` - -Defined in: [types/workflow.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L360) diff --git a/docs/api/type-aliases/KeycloakConfig.md b/docs/api/type-aliases/KeycloakConfig.md index 991f00bf6..a9a08a586 100644 --- a/docs/api/type-aliases/KeycloakConfig.md +++ b/docs/api/type-aliases/KeycloakConfig.md @@ -8,8 +8,6 @@ > **KeycloakConfig** = `object` -Defined in: [types/auth.ts:741](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L741) - Keycloak provider configuration ## Properties @@ -18,8 +16,6 @@ Keycloak provider configuration > **serverUrl**: `string` -Defined in: [types/auth.ts:743](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L743) - Keycloak server URL --- @@ -28,8 +24,6 @@ Keycloak server URL > **realm**: `string` -Defined in: [types/auth.ts:745](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L745) - Keycloak realm --- @@ -38,8 +32,6 @@ Keycloak realm > **clientId**: `string` -Defined in: [types/auth.ts:747](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L747) - Client ID --- @@ -48,8 +40,6 @@ Client ID > `optional` **clientSecret?**: `string` -Defined in: [types/auth.ts:749](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L749) - Client secret --- @@ -58,6 +48,4 @@ Client secret > `optional` **verifyToken?**: `boolean` -Defined in: [types/auth.ts:751](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L751) - Verify token signature diff --git a/docs/api/type-aliases/KeywordCoverageConfig.md b/docs/api/type-aliases/KeywordCoverageConfig.md index bd82da3dd..f0e991a45 100644 --- a/docs/api/type-aliases/KeywordCoverageConfig.md +++ b/docs/api/type-aliases/KeywordCoverageConfig.md @@ -8,8 +8,6 @@ > **KeywordCoverageConfig** = [`RuleScorerConfig`](RuleScorerConfig.md) & `object` -Defined in: [types/scorer.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L567) - Configuration specific to keyword coverage scoring. ## Type Declaration diff --git a/docs/api/type-aliases/KeywordCoverageDetails.md b/docs/api/type-aliases/KeywordCoverageDetails.md index 12e35e690..1fe3863be 100644 --- a/docs/api/type-aliases/KeywordCoverageDetails.md +++ b/docs/api/type-aliases/KeywordCoverageDetails.md @@ -8,8 +8,6 @@ > **KeywordCoverageDetails** = `object` -Defined in: [types/scorer.ts:577](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L577) - Keyword coverage result details. ## Properties @@ -18,36 +16,26 @@ Keyword coverage result details. > **totalKeywords**: `number` -Defined in: [types/scorer.ts:578](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L578) - --- ### foundKeywords > **foundKeywords**: `string`[] -Defined in: [types/scorer.ts:579](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L579) - --- ### missingKeywords > **missingKeywords**: `string`[] -Defined in: [types/scorer.ts:580](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L580) - --- ### coverageRatio > **coverageRatio**: `number` -Defined in: [types/scorer.ts:581](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L581) - --- ### weightedCoverage > **weightedCoverage**: `number` - -Defined in: [types/scorer.ts:582](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L582) diff --git a/docs/api/type-aliases/KeywordExtractorConfig.md b/docs/api/type-aliases/KeywordExtractorConfig.md index 8adee3a74..c86fb0a10 100644 --- a/docs/api/type-aliases/KeywordExtractorConfig.md +++ b/docs/api/type-aliases/KeywordExtractorConfig.md @@ -8,8 +8,6 @@ > **KeywordExtractorConfig** = [`BaseExtractorConfig`](BaseExtractorConfig.md) & `object` -Defined in: [types/rag.ts:1123](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1123) - Keyword extractor configuration ## Type Declaration diff --git a/docs/api/type-aliases/KlingTaskResponse.md b/docs/api/type-aliases/KlingTaskResponse.md index f818c73d8..061ecbb43 100644 --- a/docs/api/type-aliases/KlingTaskResponse.md +++ b/docs/api/type-aliases/KlingTaskResponse.md @@ -8,8 +8,6 @@ > **KlingTaskResponse** = `object` -Defined in: [types/video.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/video.ts#L130) - Kling (PiAPI) task status response. ## Properties @@ -18,24 +16,18 @@ Kling (PiAPI) task status response. > `optional` **status?**: `string` -Defined in: [types/video.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/video.ts#L131) - --- ### video_url? > `optional` **video_url?**: `string` -Defined in: [types/video.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/video.ts#L132) - --- ### output? > `optional` **output?**: `object` -Defined in: [types/video.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/video.ts#L133) - #### video_url? > `optional` **video_url?**: `string` @@ -45,5 +37,3 @@ Defined in: [types/video.ts:133](https://github.com/juspay/neurolink/blob/releas ### error? > `optional` **error?**: `string` - -Defined in: [types/video.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/video.ts#L134) diff --git a/docs/api/type-aliases/KnowledgeAssembledContext.md b/docs/api/type-aliases/KnowledgeAssembledContext.md index e0e80de24..1d4b6a8ee 100644 --- a/docs/api/type-aliases/KnowledgeAssembledContext.md +++ b/docs/api/type-aliases/KnowledgeAssembledContext.md @@ -8,8 +8,6 @@ > **KnowledgeAssembledContext** = `object` -Defined in: [types/knowledge.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L473) - The assembled ephemeral-context string plus its diagnostics. ## Properties @@ -18,28 +16,20 @@ The assembled ephemeral-context string plus its diagnostics. > **assembledContext**: `string` -Defined in: [types/knowledge.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L474) - --- ### citations > **citations**: [`KnowledgeCitation`](KnowledgeCitation.md)[] -Defined in: [types/knowledge.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L475) - --- ### contextTokens > **contextTokens**: `number` -Defined in: [types/knowledge.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L476) - --- ### truncated > **truncated**: `boolean` - -Defined in: [types/knowledge.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L477) diff --git a/docs/api/type-aliases/KnowledgeCitation.md b/docs/api/type-aliases/KnowledgeCitation.md index 1a0a20671..82ed66b0b 100644 --- a/docs/api/type-aliases/KnowledgeCitation.md +++ b/docs/api/type-aliases/KnowledgeCitation.md @@ -8,8 +8,6 @@ > **KnowledgeCitation** = `object` -Defined in: [types/knowledge.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L335) - A stable citation to a specific knowledge entry version. ## Properties @@ -18,12 +16,8 @@ A stable citation to a specific knowledge entry version. > **id**: `string` -Defined in: [types/knowledge.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L336) - --- ### version > **version**: `string` - -Defined in: [types/knowledge.ts:337](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L337) diff --git a/docs/api/type-aliases/KnowledgeContextConfig.md b/docs/api/type-aliases/KnowledgeContextConfig.md index cbe4b107a..f25b1b26e 100644 --- a/docs/api/type-aliases/KnowledgeContextConfig.md +++ b/docs/api/type-aliases/KnowledgeContextConfig.md @@ -8,8 +8,6 @@ > **KnowledgeContextConfig** = `object` -Defined in: [types/knowledge.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L200) - Ephemeral-context assembly limits. ## Properties @@ -18,8 +16,6 @@ Ephemeral-context assembly limits. > `optional` **maxTokens?**: `number` -Defined in: [types/knowledge.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L202) - Hard token budget for the assembled grounding block. Default: 4000. --- @@ -28,6 +24,4 @@ Hard token budget for the assembled grounding block. Default: 4000. > `optional` **includeCitations?**: `boolean` -Defined in: [types/knowledge.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L204) - Emit `[KB:@]` citations. Default: true. diff --git a/docs/api/type-aliases/KnowledgeConversationTurn.md b/docs/api/type-aliases/KnowledgeConversationTurn.md index 36c2282c4..62bdf9fc6 100644 --- a/docs/api/type-aliases/KnowledgeConversationTurn.md +++ b/docs/api/type-aliases/KnowledgeConversationTurn.md @@ -8,8 +8,6 @@ > **KnowledgeConversationTurn** = `object` -Defined in: [types/knowledge.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L256) - One bounded recent conversation turn used to contextualize the query. ## Properties @@ -18,12 +16,8 @@ One bounded recent conversation turn used to contextualize the query. > **role**: `"user"` \| `"assistant"` -Defined in: [types/knowledge.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L257) - --- ### text > **text**: `string` - -Defined in: [types/knowledge.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L258) diff --git a/docs/api/type-aliases/KnowledgeEngineStatus.md b/docs/api/type-aliases/KnowledgeEngineStatus.md index c70067246..d97f2d20e 100644 --- a/docs/api/type-aliases/KnowledgeEngineStatus.md +++ b/docs/api/type-aliases/KnowledgeEngineStatus.md @@ -8,8 +8,6 @@ > **KnowledgeEngineStatus** = `object` -Defined in: [types/knowledge.ts:499](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L499) - Snapshot of engine health for telemetry and host introspection. ## Properties @@ -18,36 +16,26 @@ Snapshot of engine health for telemetry and host introspection. > **enabled**: `boolean` -Defined in: [types/knowledge.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L500) - --- ### ready > **ready**: `boolean` -Defined in: [types/knowledge.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L501) - --- ### entryCount > **entryCount**: `number` -Defined in: [types/knowledge.ts:502](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L502) - --- ### lastError > **lastError**: `string` \| `null` -Defined in: [types/knowledge.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L503) - --- ### validationIssues > **validationIssues**: [`KnowledgeValidationIssue`](KnowledgeValidationIssue.md)[] - -Defined in: [types/knowledge.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L504) diff --git a/docs/api/type-aliases/KnowledgeEntryInput.md b/docs/api/type-aliases/KnowledgeEntryInput.md index d09cbc64b..3565430d7 100644 --- a/docs/api/type-aliases/KnowledgeEntryInput.md +++ b/docs/api/type-aliases/KnowledgeEntryInput.md @@ -8,8 +8,6 @@ > **KnowledgeEntryInput** = `object` -Defined in: [types/knowledge.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L81) - The record a host author writes. `id`, `title`, `summary`, `domain`, and `integrations` are required; every other field is optional and omitted optionals fall back to SDK defaults during normalization. @@ -20,8 +18,6 @@ optionals fall back to SDK defaults during normalization. > **id**: `string` -Defined in: [types/knowledge.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L83) - Stable unique id (e.g. "account.multi-step-flow"). Drives exact-match lookup and citations. --- @@ -30,8 +26,6 @@ Stable unique id (e.g. "account.multi-step-flow"). Drives exact-match lookup and > **title**: `string` -Defined in: [types/knowledge.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L85) - Human-readable name of the concept/setting. Highest-weighted search field. --- @@ -40,8 +34,6 @@ Human-readable name of the concept/setting. Highest-weighted search field. > **summary**: `string` -Defined in: [types/knowledge.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L87) - One-line searchable description — the short answer when a full body is unnecessary. --- @@ -50,8 +42,6 @@ One-line searchable description — the short answer when a full body is unneces > **domain**: `string` -Defined in: [types/knowledge.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L89) - Primary grouping and the main retrieval filter (e.g. "account-settings"). --- @@ -60,8 +50,6 @@ Primary grouping and the main retrieval filter (e.g. "account-settings"). > **integrations**: `string`[] -Defined in: [types/knowledge.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L91) - Integration identifiers this entry applies to. Empty array = applies to all integrations. --- @@ -70,8 +58,6 @@ Integration identifiers this entry applies to. Empty array = applies to all inte > `optional` **kind?**: [`KnowledgeEntryKind`](KnowledgeEntryKind.md) -Defined in: [types/knowledge.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L93) - What the entry is (concept, configuration, procedure, …). Default "text". Labels context, not ranking. --- @@ -80,8 +66,6 @@ What the entry is (concept, configuration, procedure, …). Default "text". Labe > `optional` **status?**: [`KnowledgeStatus`](KnowledgeStatus.md) -Defined in: [types/knowledge.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L95) - Lifecycle state. Default "active"; only active entries are retrievable. --- @@ -90,8 +74,6 @@ Lifecycle state. Default "active"; only active entries are retrievable. > `optional` **body?**: `string` -Defined in: [types/knowledge.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L97) - Full explanatory content (Markdown). Use only when the summary is insufficient. --- @@ -100,8 +82,6 @@ Full explanatory content (Markdown). Use only when the summary is insufficient. > `optional` **aliases?**: `string`[] -Defined in: [types/knowledge.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L99) - Reviewed alternate phrasings or raw identifiers that resolve to exact and alias matches. --- @@ -110,8 +90,6 @@ Reviewed alternate phrasings or raw identifiers that resolve to exact and alias > `optional` **keywords?**: `string`[] -Defined in: [types/knowledge.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L101) - Extra search terms that aid recall but are not full aliases. --- @@ -120,8 +98,6 @@ Extra search terms that aid recall but are not full aliases. > `optional` **relatedEntryIds?**: `string`[] -Defined in: [types/knowledge.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L103) - Ids of directly related entries, pulled in by bounded relationship expansion. --- @@ -130,6 +106,4 @@ Ids of directly related entries, pulled in by bounded relationship expansion. > `optional` **parentEntryId?**: `string` -Defined in: [types/knowledge.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L105) - Id of the parent entry when this is a subtype or child. diff --git a/docs/api/type-aliases/KnowledgeEntryKind.md b/docs/api/type-aliases/KnowledgeEntryKind.md index 5f17119dc..b1e7c05bc 100644 --- a/docs/api/type-aliases/KnowledgeEntryKind.md +++ b/docs/api/type-aliases/KnowledgeEntryKind.md @@ -8,6 +8,4 @@ > **KnowledgeEntryKind** = `"concept"` \| `"text"` \| `"configuration"` \| `"tool"` \| `"procedure"` \| `"policy"` \| `"troubleshooting"` -Defined in: [types/knowledge.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L38) - What a knowledge entry primarily is. Drives context labelling, not ranking. diff --git a/docs/api/type-aliases/KnowledgeFieldName.md b/docs/api/type-aliases/KnowledgeFieldName.md index f55a293db..7acb9df0c 100644 --- a/docs/api/type-aliases/KnowledgeFieldName.md +++ b/docs/api/type-aliases/KnowledgeFieldName.md @@ -8,6 +8,4 @@ > **KnowledgeFieldName** = `"title"` \| `"aliases"` \| `"keywords"` \| `"summary"` \| `"body"` -Defined in: [types/knowledge.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L65) - The five weighted text fields used by the field-aware lexical scorer. diff --git a/docs/api/type-aliases/KnowledgeFieldWeights.md b/docs/api/type-aliases/KnowledgeFieldWeights.md index 87d88005a..3850819ed 100644 --- a/docs/api/type-aliases/KnowledgeFieldWeights.md +++ b/docs/api/type-aliases/KnowledgeFieldWeights.md @@ -8,8 +8,6 @@ > **KnowledgeFieldWeights** = `object` -Defined in: [types/knowledge.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L173) - Relative weight applied to a lexical match in each field. Title/alias matches outrank body matches. Tunable through evaluation. @@ -19,36 +17,26 @@ matches outrank body matches. Tunable through evaluation. > **title**: `number` -Defined in: [types/knowledge.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L174) - --- ### aliases > **aliases**: `number` -Defined in: [types/knowledge.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L175) - --- ### keywords > **keywords**: `number` -Defined in: [types/knowledge.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L176) - --- ### summary > **summary**: `number` -Defined in: [types/knowledge.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L177) - --- ### body > **body**: `number` - -Defined in: [types/knowledge.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L178) diff --git a/docs/api/type-aliases/KnowledgeGroundingConfig.md b/docs/api/type-aliases/KnowledgeGroundingConfig.md index 13244699c..80bbd2326 100644 --- a/docs/api/type-aliases/KnowledgeGroundingConfig.md +++ b/docs/api/type-aliases/KnowledgeGroundingConfig.md @@ -8,8 +8,6 @@ > **KnowledgeGroundingConfig** = `object` -Defined in: [types/knowledge.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L211) - Constructor-level configuration for knowledge grounding. Sources are fixed for the lifetime of a NeuroLink instance so the index can be built once. @@ -19,8 +17,6 @@ for the lifetime of a NeuroLink instance so the index can be built once. > **enabled**: `boolean` -Defined in: [types/knowledge.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L213) - Master switch. Grounding runs only when true AND at least one source is loaded. --- @@ -29,8 +25,6 @@ Master switch. Grounding runs only when true AND at least one source is loaded. > **sources**: [`KnowledgeSource`](KnowledgeSource.md)[] -Defined in: [types/knowledge.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L219) - Knowledge sources used to build the instance's immutable in-memory index. Required alongside `enabled`; pass an empty array only when intentionally configuring no retrievable content. @@ -41,8 +35,6 @@ configuring no retrievable content. > `optional` **blockedDomains?**: `string`[] -Defined in: [types/knowledge.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L221) - Exclude these domains from retrieval. Empty/omitted means all domains are eligible. --- @@ -51,22 +43,16 @@ Exclude these domains from retrieval. Empty/omitted means all domains are eligib > `optional` **retrieval?**: [`KnowledgeRetrievalConfig`](KnowledgeRetrievalConfig.md) -Defined in: [types/knowledge.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L222) - --- ### context? > `optional` **context?**: [`KnowledgeContextConfig`](KnowledgeContextConfig.md) -Defined in: [types/knowledge.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L223) - --- ### timeoutMs? > `optional` **timeoutMs?**: `number` -Defined in: [types/knowledge.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L225) - Hard ceiling for one grounding operation before it fails open. Default: 800ms. diff --git a/docs/api/type-aliases/KnowledgeGroundingInput.md b/docs/api/type-aliases/KnowledgeGroundingInput.md index 5ea2effb6..505b7192a 100644 --- a/docs/api/type-aliases/KnowledgeGroundingInput.md +++ b/docs/api/type-aliases/KnowledgeGroundingInput.md @@ -8,8 +8,6 @@ > **KnowledgeGroundingInput** = `object` -Defined in: [types/knowledge.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L481) - Per-turn input to `KnowledgeGroundingEngine.ground()`. ## Properties @@ -18,20 +16,14 @@ Per-turn input to `KnowledgeGroundingEngine.ground()`. > **query**: `string` -Defined in: [types/knowledge.ts:482](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L482) - --- ### recentTurns? > `optional` **recentTurns?**: [`KnowledgeConversationTurn`](KnowledgeConversationTurn.md)[] -Defined in: [types/knowledge.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L483) - --- ### scope? > `optional` **scope?**: [`KnowledgeRequestScope`](KnowledgeRequestScope.md) - -Defined in: [types/knowledge.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L484) diff --git a/docs/api/type-aliases/KnowledgeGroundingMetadata.md b/docs/api/type-aliases/KnowledgeGroundingMetadata.md index f3f670c36..552ddf7a5 100644 --- a/docs/api/type-aliases/KnowledgeGroundingMetadata.md +++ b/docs/api/type-aliases/KnowledgeGroundingMetadata.md @@ -8,8 +8,6 @@ > **KnowledgeGroundingMetadata** = `object` -Defined in: [types/knowledge.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L380) - Aggregate, content-free diagnostics attached to a generation/stream result so the host can evaluate retrieval without the SDK exposing entry bodies. @@ -19,70 +17,52 @@ so the host can evaluate retrieval without the SDK exposing entry bodies. > **retrievalMode**: [`KnowledgeRetrievalMode`](KnowledgeRetrievalMode.md) -Defined in: [types/knowledge.ts:381](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L381) - --- ### selectedIds > **selectedIds**: `string`[] -Defined in: [types/knowledge.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L382) - --- ### expandedIds > **expandedIds**: `string`[] -Defined in: [types/knowledge.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L383) - --- ### candidateCount > **candidateCount**: `number` -Defined in: [types/knowledge.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L384) - --- ### contextTokens > **contextTokens**: `number` -Defined in: [types/knowledge.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L385) - --- ### truncated > **truncated**: `boolean` -Defined in: [types/knowledge.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L386) - --- ### durationMs > **durationMs**: `number` -Defined in: [types/knowledge.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L387) - --- ### confidence? > `optional` **confidence?**: [`KnowledgeRetrievalConfidence`](KnowledgeRetrievalConfidence.md) -Defined in: [types/knowledge.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L388) - --- ### failureReason? > `optional` **failureReason?**: `string` -Defined in: [types/knowledge.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L390) - Present when grounding failed open; names the failure class. diff --git a/docs/api/type-aliases/KnowledgeGroundingOutcome.md b/docs/api/type-aliases/KnowledgeGroundingOutcome.md index d571b45fd..fb7bfe5e2 100644 --- a/docs/api/type-aliases/KnowledgeGroundingOutcome.md +++ b/docs/api/type-aliases/KnowledgeGroundingOutcome.md @@ -8,8 +8,6 @@ > **KnowledgeGroundingOutcome** = `object` -Defined in: [types/knowledge.ts:492](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L492) - The engine's per-turn output: the ephemeral context to inject (null on no-match, when disabled, or on fail-open), the aggregate metadata for the result, and the full retrieval for host diagnostics. @@ -20,20 +18,14 @@ result, and the full retrieval for host diagnostics. > **ephemeralContext**: [`EphemeralContext`](EphemeralContext.md) \| `null` -Defined in: [types/knowledge.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L493) - --- ### metadata > **metadata**: [`KnowledgeGroundingMetadata`](KnowledgeGroundingMetadata.md) -Defined in: [types/knowledge.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L494) - --- ### retrieval > **retrieval**: [`KnowledgeRetrievalResult`](KnowledgeRetrievalResult.md) \| `null` - -Defined in: [types/knowledge.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L495) diff --git a/docs/api/type-aliases/KnowledgeIndexSnapshot.md b/docs/api/type-aliases/KnowledgeIndexSnapshot.md index e432ed83b..6e7b434a2 100644 --- a/docs/api/type-aliases/KnowledgeIndexSnapshot.md +++ b/docs/api/type-aliases/KnowledgeIndexSnapshot.md @@ -8,8 +8,6 @@ > **KnowledgeIndexSnapshot** = `object` -Defined in: [types/knowledge.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L317) - Immutable, ready-to-query index built once at client construction. Sessions and turns search this snapshot; it is never mutated in place. @@ -19,16 +17,12 @@ and turns search this snapshot; it is never mutated in place. > **entriesById**: `Map`\<`string`, [`NormalizedKnowledgeEntry`](NormalizedKnowledgeEntry.md)\> -Defined in: [types/knowledge.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L318) - --- ### exactIndex > **exactIndex**: `Map`\<`string`, `Set`\<`string`\>\> -Defined in: [types/knowledge.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L320) - Normalized entry id or title phrase -> entry ids. --- @@ -37,8 +31,6 @@ Normalized entry id or title phrase -> entry ids. > **aliasIndex**: `Map`\<`string`, `Set`\<`string`\>\> -Defined in: [types/knowledge.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L322) - Normalized reviewed alias phrase -> entry ids. --- @@ -47,8 +39,6 @@ Normalized reviewed alias phrase -> entry ids. > **relationIndex**: `Map`\<`string`, `string`[]\> -Defined in: [types/knowledge.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L324) - Entry id -> directly related entry ids, for bounded expansion. --- @@ -57,8 +47,6 @@ Entry id -> directly related entry ids, for bounded expansion. > **lexical**: [`KnowledgeLexicalSearcher`](KnowledgeLexicalSearcher.md) -Defined in: [types/knowledge.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L326) - Field-aware BM25 over all documents. --- @@ -66,5 +54,3 @@ Field-aware BM25 over all documents. ### entryCount > **entryCount**: `number` - -Defined in: [types/knowledge.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L327) diff --git a/docs/api/type-aliases/KnowledgeLexicalMatch.md b/docs/api/type-aliases/KnowledgeLexicalMatch.md index 930dd2f06..b610b1999 100644 --- a/docs/api/type-aliases/KnowledgeLexicalMatch.md +++ b/docs/api/type-aliases/KnowledgeLexicalMatch.md @@ -8,8 +8,6 @@ > **KnowledgeLexicalMatch** = `object` -Defined in: [types/knowledge.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L294) - One lexical match with its per-field score breakdown, for tuning and traces. ## Properties @@ -18,20 +16,14 @@ One lexical match with its per-field score breakdown, for tuning and traces. > **id**: `string` -Defined in: [types/knowledge.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L295) - --- ### score > **score**: `number` -Defined in: [types/knowledge.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L296) - --- ### fieldScores > **fieldScores**: `Partial`\<`Record`\<[`KnowledgeFieldName`](KnowledgeFieldName.md), `number`\>\> - -Defined in: [types/knowledge.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L297) diff --git a/docs/api/type-aliases/KnowledgeLexicalSearcher.md b/docs/api/type-aliases/KnowledgeLexicalSearcher.md index 086b6d6a8..f0713dc39 100644 --- a/docs/api/type-aliases/KnowledgeLexicalSearcher.md +++ b/docs/api/type-aliases/KnowledgeLexicalSearcher.md @@ -8,8 +8,6 @@ > **KnowledgeLexicalSearcher** = `object` -Defined in: [types/knowledge.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L305) - Structural contract of the field-aware lexical index held in a snapshot. A concrete class in the knowledge runtime module satisfies this shape; typing it structurally keeps this types file free of runtime imports. @@ -20,8 +18,6 @@ it structurally keeps this types file free of runtime imports. > **search**: (`queryTokens`, `topK`, `eligibleEntryIds?`) => [`KnowledgeLexicalMatch`](KnowledgeLexicalMatch.md)[] -Defined in: [types/knowledge.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L306) - #### Parameters ##### queryTokens diff --git a/docs/api/type-aliases/KnowledgeManifest.md b/docs/api/type-aliases/KnowledgeManifest.md index b3a05fb95..5412f014b 100644 --- a/docs/api/type-aliases/KnowledgeManifest.md +++ b/docs/api/type-aliases/KnowledgeManifest.md @@ -8,8 +8,6 @@ > **KnowledgeManifest** = `object` -Defined in: [types/knowledge.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L146) - The versioned build artifact a host emits at build time. NeuroLink can consume it directly (each catalog becomes a structured source) so hosts do not need to construct `KnowledgeSource[]` by hand. @@ -20,28 +18,20 @@ not need to construct `KnowledgeSource[]` by hand. > **schemaVersion**: `string` -Defined in: [types/knowledge.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L147) - --- ### contentVersion > **contentVersion**: `string` -Defined in: [types/knowledge.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L148) - --- ### generatedAt > **generatedAt**: `string` -Defined in: [types/knowledge.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L149) - --- ### catalogs > **catalogs**: [`KnowledgeManifestCatalog`](KnowledgeManifestCatalog.md)[] - -Defined in: [types/knowledge.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L150) diff --git a/docs/api/type-aliases/KnowledgeManifestCatalog.md b/docs/api/type-aliases/KnowledgeManifestCatalog.md index c297a55ba..b2caf1f37 100644 --- a/docs/api/type-aliases/KnowledgeManifestCatalog.md +++ b/docs/api/type-aliases/KnowledgeManifestCatalog.md @@ -8,8 +8,6 @@ > **KnowledgeManifestCatalog** = `object` -Defined in: [types/knowledge.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L136) - One catalog inside a build manifest — a source id and its entries. ## Properties @@ -18,12 +16,8 @@ One catalog inside a build manifest — a source id and its entries. > **id**: `string` -Defined in: [types/knowledge.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L137) - --- ### entries > **entries**: [`KnowledgeEntryInput`](KnowledgeEntryInput.md)[] - -Defined in: [types/knowledge.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L138) diff --git a/docs/api/type-aliases/KnowledgeNormalizeOptions.md b/docs/api/type-aliases/KnowledgeNormalizeOptions.md index fdb047d6f..7b0f73f14 100644 --- a/docs/api/type-aliases/KnowledgeNormalizeOptions.md +++ b/docs/api/type-aliases/KnowledgeNormalizeOptions.md @@ -8,8 +8,6 @@ > **KnowledgeNormalizeOptions** = `object` -Defined in: [types/knowledge.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L432) - Options for normalizing + validating a set of sources before indexing. ## Properties @@ -17,5 +15,3 @@ Options for normalizing + validating a set of sources before indexing. ### manifestVersion > **manifestVersion**: `string` - -Defined in: [types/knowledge.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L433) diff --git a/docs/api/type-aliases/KnowledgeNormalizeResult.md b/docs/api/type-aliases/KnowledgeNormalizeResult.md index 347595735..706d00270 100644 --- a/docs/api/type-aliases/KnowledgeNormalizeResult.md +++ b/docs/api/type-aliases/KnowledgeNormalizeResult.md @@ -8,8 +8,6 @@ > **KnowledgeNormalizeResult** = `object` -Defined in: [types/knowledge.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L437) - Normalized entries paired with the validation outcome. ## Properties @@ -18,12 +16,8 @@ Normalized entries paired with the validation outcome. > **entries**: [`NormalizedKnowledgeEntry`](NormalizedKnowledgeEntry.md)[] -Defined in: [types/knowledge.ts:438](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L438) - --- ### validation > **validation**: [`KnowledgeValidationResult`](KnowledgeValidationResult.md) - -Defined in: [types/knowledge.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L439) diff --git a/docs/api/type-aliases/KnowledgeRequestScope.md b/docs/api/type-aliases/KnowledgeRequestScope.md index 713d626a4..cfb375108 100644 --- a/docs/api/type-aliases/KnowledgeRequestScope.md +++ b/docs/api/type-aliases/KnowledgeRequestScope.md @@ -8,8 +8,6 @@ > **KnowledgeRequestScope** = `object` -Defined in: [types/knowledge.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L236) - Per-call scope the host attaches to `GenerateOptions` / `StreamOptions`. Supplies the enabled integrations for this turn only. @@ -19,6 +17,4 @@ Supplies the enabled integrations for this turn only. > `optional` **enabledIntegrations?**: `string`[] -Defined in: [types/knowledge.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L238) - Installed/enabled integrations used to filter integration-specific entries. diff --git a/docs/api/type-aliases/KnowledgeResolvedRetrieval.md b/docs/api/type-aliases/KnowledgeResolvedRetrieval.md index bc4897d7e..b2f378991 100644 --- a/docs/api/type-aliases/KnowledgeResolvedRetrieval.md +++ b/docs/api/type-aliases/KnowledgeResolvedRetrieval.md @@ -8,8 +8,6 @@ > **KnowledgeResolvedRetrieval** = `object` -Defined in: [types/knowledge.ts:443](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L443) - Retrieval tuning after config + SDK defaults are merged. ## Properties @@ -18,44 +16,32 @@ Retrieval tuning after config + SDK defaults are merged. > **candidateLimit**: `number` -Defined in: [types/knowledge.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L444) - --- ### resultLimit > **resultLimit**: `number` -Defined in: [types/knowledge.ts:445](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L445) - --- ### relationLimit > **relationLimit**: `number` -Defined in: [types/knowledge.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L446) - --- ### fieldWeights > **fieldWeights**: [`KnowledgeFieldWeights`](KnowledgeFieldWeights.md) -Defined in: [types/knowledge.ts:447](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L447) - --- ### exactBoost > **exactBoost**: `number` -Defined in: [types/knowledge.ts:448](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L448) - --- ### aliasBoost > **aliasBoost**: `number` - -Defined in: [types/knowledge.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L449) diff --git a/docs/api/type-aliases/KnowledgeRetrievalConfidence.md b/docs/api/type-aliases/KnowledgeRetrievalConfidence.md index 5c3f2eb97..19a0ae0be 100644 --- a/docs/api/type-aliases/KnowledgeRetrievalConfidence.md +++ b/docs/api/type-aliases/KnowledgeRetrievalConfidence.md @@ -8,8 +8,6 @@ > **KnowledgeRetrievalConfidence** = `"high"` \| `"medium"` \| `"low"` \| `"none"` -Defined in: [types/knowledge.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L62) - Confidence class returned with every retrieval so the host prompt can instruct the model to qualify low-confidence answers rather than present them as authoritative. diff --git a/docs/api/type-aliases/KnowledgeRetrievalConfig.md b/docs/api/type-aliases/KnowledgeRetrievalConfig.md index d62af6ad3..724f17d8d 100644 --- a/docs/api/type-aliases/KnowledgeRetrievalConfig.md +++ b/docs/api/type-aliases/KnowledgeRetrievalConfig.md @@ -8,8 +8,6 @@ > **KnowledgeRetrievalConfig** = `object` -Defined in: [types/knowledge.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L182) - Lexical retrieval tuning. All fields optional; the engine supplies defaults. ## Properties @@ -18,8 +16,6 @@ Lexical retrieval tuning. All fields optional; the engine supplies defaults. > `optional` **mode?**: [`KnowledgeRetrievalMode`](KnowledgeRetrievalMode.md) -Defined in: [types/knowledge.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L184) - Retrieval mode. Default: "lexical". --- @@ -28,8 +24,6 @@ Retrieval mode. Default: "lexical". > `optional` **candidateLimit?**: `number` -Defined in: [types/knowledge.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L186) - How many scored candidates enter relationship expansion. Default: 24. --- @@ -38,8 +32,6 @@ How many scored candidates enter relationship expansion. Default: 24. > `optional` **resultLimit?**: `number` -Defined in: [types/knowledge.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L188) - How many primary entries survive into the assembled context. Default: 8. --- @@ -48,8 +40,6 @@ How many primary entries survive into the assembled context. Default: 8. > `optional` **relationLimit?**: `number` -Defined in: [types/knowledge.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L190) - Cap on relationship-expanded entries added after primary retrieval. Default: 4. --- @@ -58,8 +48,6 @@ Cap on relationship-expanded entries added after primary retrieval. Default: 4. > `optional` **fieldWeights?**: [`KnowledgeFieldWeights`](KnowledgeFieldWeights.md) -Defined in: [types/knowledge.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L192) - Per-field BM25 weights. --- @@ -68,8 +56,6 @@ Per-field BM25 weights. > `optional` **exactBoost?**: `number` -Defined in: [types/knowledge.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L194) - Additive boost for an exact entry-id / configuration-key match. Dominant. Default: 100. --- @@ -78,6 +64,4 @@ Additive boost for an exact entry-id / configuration-key match. Dominant. Defaul > `optional` **aliasBoost?**: `number` -Defined in: [types/knowledge.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L196) - Additive boost for an exact reviewed-alias phrase match. Default: 60. diff --git a/docs/api/type-aliases/KnowledgeRetrievalMode.md b/docs/api/type-aliases/KnowledgeRetrievalMode.md index bdad6e71d..31743ef8e 100644 --- a/docs/api/type-aliases/KnowledgeRetrievalMode.md +++ b/docs/api/type-aliases/KnowledgeRetrievalMode.md @@ -8,8 +8,6 @@ > **KnowledgeRetrievalMode** = `"lexical"` -Defined in: [types/knowledge.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L55) - Retrieval mode. Only `"lexical"` is supported in the first release; the literal is a union of one to reserve a clean upgrade path to `"hybrid"` / `"vector"` without a breaking change. diff --git a/docs/api/type-aliases/KnowledgeRetrievalRequest.md b/docs/api/type-aliases/KnowledgeRetrievalRequest.md index 58f30eae0..87a01ce24 100644 --- a/docs/api/type-aliases/KnowledgeRetrievalRequest.md +++ b/docs/api/type-aliases/KnowledgeRetrievalRequest.md @@ -8,8 +8,6 @@ > **KnowledgeRetrievalRequest** = `object` -Defined in: [types/knowledge.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L265) - The fully-resolved retrieval request the engine builds internally from the user query, a bounded recent window, and host scope. @@ -19,20 +17,14 @@ user query, a bounded recent window, and host scope. > **query**: `string` -Defined in: [types/knowledge.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L266) - --- ### recentTurns > **recentTurns**: [`KnowledgeConversationTurn`](KnowledgeConversationTurn.md)[] -Defined in: [types/knowledge.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L267) - --- ### enabledIntegrations > **enabledIntegrations**: `string`[] - -Defined in: [types/knowledge.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L268) diff --git a/docs/api/type-aliases/KnowledgeRetrievalResult.md b/docs/api/type-aliases/KnowledgeRetrievalResult.md index f3ab3cede..cb4c89fdb 100644 --- a/docs/api/type-aliases/KnowledgeRetrievalResult.md +++ b/docs/api/type-aliases/KnowledgeRetrievalResult.md @@ -8,8 +8,6 @@ > **KnowledgeRetrievalResult** = `object` -Defined in: [types/knowledge.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L344) - The result of one retrieval: the selected entries, the assembled ephemeral context string, a confidence class, and assembly diagnostics. @@ -19,40 +17,30 @@ context string, a confidence class, and assembly diagnostics. > **entries**: [`NormalizedKnowledgeEntry`](NormalizedKnowledgeEntry.md)[] -Defined in: [types/knowledge.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L345) - --- ### assembledContext > **assembledContext**: `string` -Defined in: [types/knowledge.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L346) - --- ### confidence > **confidence**: [`KnowledgeRetrievalConfidence`](KnowledgeRetrievalConfidence.md) -Defined in: [types/knowledge.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L347) - --- ### citations > **citations**: [`KnowledgeCitation`](KnowledgeCitation.md)[] -Defined in: [types/knowledge.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L348) - --- ### selectedEntryIds > **selectedEntryIds**: `string`[] -Defined in: [types/knowledge.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L350) - Ids of the primary (non-expanded) entries, in final order. --- @@ -61,8 +49,6 @@ Ids of the primary (non-expanded) entries, in final order. > **expandedEntryIds**: `string`[] -Defined in: [types/knowledge.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L352) - Ids added by bounded relationship expansion. --- @@ -71,8 +57,6 @@ Ids added by bounded relationship expansion. > **candidateCount**: `number` -Defined in: [types/knowledge.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L354) - Candidates scored before truncation to the result limit. --- @@ -81,8 +65,6 @@ Candidates scored before truncation to the result limit. > **contextTokens**: `number` -Defined in: [types/knowledge.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L356) - Estimated token size of `assembledContext`. --- @@ -91,8 +73,6 @@ Estimated token size of `assembledContext`. > **truncated**: `boolean` -Defined in: [types/knowledge.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L358) - True when any entry body was truncated or entries were dropped for budget. --- @@ -100,5 +80,3 @@ True when any entry body was truncated or entries were dropped for budget. ### durationMs > **durationMs**: `number` - -Defined in: [types/knowledge.ts:359](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L359) diff --git a/docs/api/type-aliases/KnowledgeScoredCandidate.md b/docs/api/type-aliases/KnowledgeScoredCandidate.md index 91a2b3561..87617e9f4 100644 --- a/docs/api/type-aliases/KnowledgeScoredCandidate.md +++ b/docs/api/type-aliases/KnowledgeScoredCandidate.md @@ -8,8 +8,6 @@ > **KnowledgeScoredCandidate** = `object` -Defined in: [types/knowledge.ts:453](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L453) - One scored retrieval candidate with its signal breakdown, for traces. ## Properties @@ -18,52 +16,38 @@ One scored retrieval candidate with its signal breakdown, for traces. > **id**: `string` -Defined in: [types/knowledge.ts:454](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L454) - --- ### score > **score**: `number` -Defined in: [types/knowledge.ts:455](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L455) - --- ### exact > **exact**: `boolean` -Defined in: [types/knowledge.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L456) - --- ### alias > **alias**: `boolean` -Defined in: [types/knowledge.ts:457](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L457) - --- ### lexical > **lexical**: `number` -Defined in: [types/knowledge.ts:458](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L458) - --- ### fieldScores > **fieldScores**: `Partial`\<`Record`\<[`KnowledgeFieldName`](KnowledgeFieldName.md), `number`\>\> -Defined in: [types/knowledge.ts:459](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L459) - --- ### matchedPhrases > **matchedPhrases**: `string`[] - -Defined in: [types/knowledge.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L460) diff --git a/docs/api/type-aliases/KnowledgeSelection.md b/docs/api/type-aliases/KnowledgeSelection.md index d24f5eadf..0445c2d95 100644 --- a/docs/api/type-aliases/KnowledgeSelection.md +++ b/docs/api/type-aliases/KnowledgeSelection.md @@ -8,8 +8,6 @@ > **KnowledgeSelection** = `object` -Defined in: [types/knowledge.ts:464](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L464) - The selected primary + relationship-expanded entries for one turn. ## Properties @@ -18,36 +16,26 @@ The selected primary + relationship-expanded entries for one turn. > **primary**: [`NormalizedKnowledgeEntry`](NormalizedKnowledgeEntry.md)[] -Defined in: [types/knowledge.ts:465](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L465) - --- ### expanded > **expanded**: [`NormalizedKnowledgeEntry`](NormalizedKnowledgeEntry.md)[] -Defined in: [types/knowledge.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L466) - --- ### candidates > **candidates**: [`KnowledgeScoredCandidate`](KnowledgeScoredCandidate.md)[] -Defined in: [types/knowledge.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L467) - --- ### confidence > **confidence**: [`KnowledgeRetrievalConfidence`](KnowledgeRetrievalConfidence.md) -Defined in: [types/knowledge.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L468) - --- ### candidateCount > **candidateCount**: `number` - -Defined in: [types/knowledge.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L469) diff --git a/docs/api/type-aliases/KnowledgeSource.md b/docs/api/type-aliases/KnowledgeSource.md index c290d8aea..fcad5cf77 100644 --- a/docs/api/type-aliases/KnowledgeSource.md +++ b/docs/api/type-aliases/KnowledgeSource.md @@ -8,8 +8,6 @@ > **KnowledgeSource** = `object` -Defined in: [types/knowledge.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L159) - A configured knowledge source: inline structured entries passed to the engine. Markdown/provider source kinds were intentionally dropped for now; re-introduce this as a discriminated union (with a `type` tag) if another @@ -21,20 +19,14 @@ source kind is needed later. > **id**: `string` -Defined in: [types/knowledge.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L160) - --- ### version? > `optional` **version?**: `string` -Defined in: [types/knowledge.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L161) - --- ### entries > **entries**: [`KnowledgeEntryInput`](KnowledgeEntryInput.md)[] - -Defined in: [types/knowledge.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L162) diff --git a/docs/api/type-aliases/KnowledgeStatus.md b/docs/api/type-aliases/KnowledgeStatus.md index ce4d04d74..44dcb80d3 100644 --- a/docs/api/type-aliases/KnowledgeStatus.md +++ b/docs/api/type-aliases/KnowledgeStatus.md @@ -8,6 +8,4 @@ > **KnowledgeStatus** = `"draft"` \| `"active"` \| `"deprecated"` -Defined in: [types/knowledge.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L48) - Lifecycle state. Only `active` entries are retrievable by default. diff --git a/docs/api/type-aliases/KnowledgeValidationIssue.md b/docs/api/type-aliases/KnowledgeValidationIssue.md index 9e111f4f0..a14004559 100644 --- a/docs/api/type-aliases/KnowledgeValidationIssue.md +++ b/docs/api/type-aliases/KnowledgeValidationIssue.md @@ -8,8 +8,6 @@ > **KnowledgeValidationIssue** = `object` -Defined in: [types/knowledge.ts:398](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L398) - A single validation problem found while normalizing/indexing a source. ## Properties @@ -18,36 +16,26 @@ A single validation problem found while normalizing/indexing a source. > **level**: `"error"` \| `"warning"` -Defined in: [types/knowledge.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L399) - --- ### code > **code**: `string` -Defined in: [types/knowledge.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L400) - --- ### message > **message**: `string` -Defined in: [types/knowledge.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L401) - --- ### entryId? > `optional` **entryId?**: `string` -Defined in: [types/knowledge.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L402) - --- ### sourceId? > `optional` **sourceId?**: `string` - -Defined in: [types/knowledge.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L403) diff --git a/docs/api/type-aliases/KnowledgeValidationResult.md b/docs/api/type-aliases/KnowledgeValidationResult.md index 2d6628a55..c9058225d 100644 --- a/docs/api/type-aliases/KnowledgeValidationResult.md +++ b/docs/api/type-aliases/KnowledgeValidationResult.md @@ -8,8 +8,6 @@ > **KnowledgeValidationResult** = `object` -Defined in: [types/knowledge.ts:407](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L407) - Outcome of validating a set of sources before indexing. ## Properties @@ -18,12 +16,8 @@ Outcome of validating a set of sources before indexing. > **ok**: `boolean` -Defined in: [types/knowledge.ts:408](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L408) - --- ### issues > **issues**: [`KnowledgeValidationIssue`](KnowledgeValidationIssue.md)[] - -Defined in: [types/knowledge.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L409) diff --git a/docs/api/type-aliases/KoaRateLimitEntry.md b/docs/api/type-aliases/KoaRateLimitEntry.md index 0f6f2784f..561993b70 100644 --- a/docs/api/type-aliases/KoaRateLimitEntry.md +++ b/docs/api/type-aliases/KoaRateLimitEntry.md @@ -8,8 +8,6 @@ > **KoaRateLimitEntry** = `object` -Defined in: [types/proxy.ts:2055](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2055) - Rate limit store entry (Koa adapter). ## Properties @@ -18,12 +16,8 @@ Rate limit store entry (Koa adapter). > **count**: `number` -Defined in: [types/proxy.ts:2056](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2056) - --- ### resetAt > **resetAt**: `number` - -Defined in: [types/proxy.ts:2057](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2057) diff --git a/docs/api/type-aliases/LLMScorer.md b/docs/api/type-aliases/LLMScorer.md index 608ede6a8..03a944782 100644 --- a/docs/api/type-aliases/LLMScorer.md +++ b/docs/api/type-aliases/LLMScorer.md @@ -8,8 +8,6 @@ > **LLMScorer** = [`Scorer`](Scorer.md) & `object` -Defined in: [types/scorer.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L291) - Extended interface for LLM-based scorers ## Type Declaration diff --git a/docs/api/type-aliases/LLMScorerConfig.md b/docs/api/type-aliases/LLMScorerConfig.md index b1add423d..d8b93100a 100644 --- a/docs/api/type-aliases/LLMScorerConfig.md +++ b/docs/api/type-aliases/LLMScorerConfig.md @@ -8,8 +8,6 @@ > **LLMScorerConfig** = [`ScorerConfig`](ScorerConfig.md) & `object` -Defined in: [types/scorer.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L165) - LLM-based scorer configuration ## Type Declaration diff --git a/docs/api/type-aliases/LaTeXChunkerConfig.md b/docs/api/type-aliases/LaTeXChunkerConfig.md index 8773a28ae..b0503d97a 100644 --- a/docs/api/type-aliases/LaTeXChunkerConfig.md +++ b/docs/api/type-aliases/LaTeXChunkerConfig.md @@ -8,8 +8,6 @@ > **LaTeXChunkerConfig** = [`BaseChunkerConfig`](BaseChunkerConfig.md) & `object` -Defined in: [types/rag.ts:1002](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1002) - LaTeX chunker configuration LaTeX structure-aware splitting diff --git a/docs/api/type-aliases/LaminarExporterConfig.md b/docs/api/type-aliases/LaminarExporterConfig.md index 176be543d..4c4f3f107 100644 --- a/docs/api/type-aliases/LaminarExporterConfig.md +++ b/docs/api/type-aliases/LaminarExporterConfig.md @@ -8,8 +8,6 @@ > **LaminarExporterConfig** = [`ExporterConfig`](ExporterConfig.md) & `object` -Defined in: [types/exporter.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L171) - Laminar exporter configuration ## Type Declaration diff --git a/docs/api/type-aliases/LangSmithExporterConfig.md b/docs/api/type-aliases/LangSmithExporterConfig.md index 0effa8408..5e035eed6 100644 --- a/docs/api/type-aliases/LangSmithExporterConfig.md +++ b/docs/api/type-aliases/LangSmithExporterConfig.md @@ -8,8 +8,6 @@ > **LangSmithExporterConfig** = [`ExporterConfig`](ExporterConfig.md) & `object` -Defined in: [types/exporter.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L84) - LangSmith exporter configuration ## Type Declaration diff --git a/docs/api/type-aliases/LangSmithRun.md b/docs/api/type-aliases/LangSmithRun.md index 4dba5d590..d4bb865a7 100644 --- a/docs/api/type-aliases/LangSmithRun.md +++ b/docs/api/type-aliases/LangSmithRun.md @@ -8,8 +8,6 @@ > **LangSmithRun** = `object` -Defined in: [types/span.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L249) - LangSmith-specific run format ## Properties @@ -18,92 +16,68 @@ LangSmith-specific run format > **id**: `string` -Defined in: [types/span.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L250) - --- ### trace_id > **trace_id**: `string` -Defined in: [types/span.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L251) - --- ### parent_run_id? > `optional` **parent_run_id?**: `string` -Defined in: [types/span.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L252) - --- ### name > **name**: `string` -Defined in: [types/span.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L253) - --- ### run_type > **run_type**: `"llm"` \| `"chain"` \| `"tool"` \| `"retriever"` \| `"embedding"` -Defined in: [types/span.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L254) - --- ### start_time > **start_time**: `string` -Defined in: [types/span.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L255) - --- ### end_time? > `optional` **end_time?**: `string` -Defined in: [types/span.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L256) - --- ### extra > **extra**: `Record`\<`string`, `unknown`\> -Defined in: [types/span.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L257) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/span.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L258) - --- ### inputs? > `optional` **inputs?**: `unknown` -Defined in: [types/span.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L259) - --- ### outputs? > `optional` **outputs?**: `unknown` -Defined in: [types/span.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L260) - --- ### tags? > `optional` **tags?**: `string`[] - -Defined in: [types/span.ts:261](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L261) diff --git a/docs/api/type-aliases/LangfuseAdapterConfig.md b/docs/api/type-aliases/LangfuseAdapterConfig.md index b5524aed5..9f9927e80 100644 --- a/docs/api/type-aliases/LangfuseAdapterConfig.md +++ b/docs/api/type-aliases/LangfuseAdapterConfig.md @@ -8,8 +8,6 @@ > **LangfuseAdapterConfig** = `object` -Defined in: [types/evaluation.ts:645](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L645) - Langfuse adapter configuration. ## Properties @@ -18,44 +16,32 @@ Langfuse adapter configuration. > **client**: [`LangfuseClient`](LangfuseClient.md) -Defined in: [types/evaluation.ts:646](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L646) - --- ### scorePrefix? > `optional` **scorePrefix?**: `string` -Defined in: [types/evaluation.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L647) - --- ### includeMetadata? > `optional` **includeMetadata?**: `boolean` -Defined in: [types/evaluation.ts:648](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L648) - --- ### tags? > `optional` **tags?**: `string`[] -Defined in: [types/evaluation.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L649) - --- ### sendPipelineScores? > `optional` **sendPipelineScores?**: `boolean` -Defined in: [types/evaluation.ts:650](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L650) - --- ### sendScorerScores? > `optional` **sendScorerScores?**: `boolean` - -Defined in: [types/evaluation.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L651) diff --git a/docs/api/type-aliases/LangfuseClient.md b/docs/api/type-aliases/LangfuseClient.md index 6bcd504a8..7524a6606 100644 --- a/docs/api/type-aliases/LangfuseClient.md +++ b/docs/api/type-aliases/LangfuseClient.md @@ -8,8 +8,6 @@ > **LangfuseClient** = `object` -Defined in: [types/evaluation.ts:627](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L627) - Minimal Langfuse client interface for evaluation hooks. ## Properties @@ -18,8 +16,6 @@ Minimal Langfuse client interface for evaluation hooks. > **score**: (`params`) => `Promise`\<`unknown`\> -Defined in: [types/evaluation.ts:628](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L628) - #### Parameters ##### params @@ -58,8 +54,6 @@ Defined in: [types/evaluation.ts:628](https://github.com/juspay/neurolink/blob/r > `optional` **trace?**: (`params`) => `object` -Defined in: [types/evaluation.ts:636](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L636) - #### Parameters ##### params @@ -90,8 +84,6 @@ Defined in: [types/evaluation.ts:636](https://github.com/juspay/neurolink/blob/r > `optional` **shutdown?**: () => `Promise`\<`void`\> -Defined in: [types/evaluation.ts:641](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L641) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/type-aliases/LangfuseConfig.md b/docs/api/type-aliases/LangfuseConfig.md index 91a2a3a91..e2e6b5227 100644 --- a/docs/api/type-aliases/LangfuseConfig.md +++ b/docs/api/type-aliases/LangfuseConfig.md @@ -8,8 +8,6 @@ > **LangfuseConfig** = `object` -Defined in: [types/observability.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L71) - Langfuse observability configuration ## Properties @@ -18,8 +16,6 @@ Langfuse observability configuration > **enabled**: `boolean` -Defined in: [types/observability.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L73) - Whether Langfuse is enabled --- @@ -28,8 +24,6 @@ Whether Langfuse is enabled > **publicKey**: `string` -Defined in: [types/observability.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L75) - Langfuse public key --- @@ -38,8 +32,6 @@ Langfuse public key > **secretKey**: `string` -Defined in: [types/observability.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L82) - Langfuse secret key #### Sensitive @@ -53,8 +45,6 @@ Do NOT log, expose, or share this key. Follow best practices for secret manageme > `optional` **baseUrl?**: `string` -Defined in: [types/observability.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L84) - Langfuse base URL (default: https://cloud.langfuse.com) --- @@ -63,8 +53,6 @@ Langfuse base URL (default: https://cloud.langfuse.com) > `optional` **environment?**: `string` -Defined in: [types/observability.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L86) - Environment name (e.g., dev, staging, prod) --- @@ -73,8 +61,6 @@ Environment name (e.g., dev, staging, prod) > `optional` **release?**: `string` -Defined in: [types/observability.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L88) - Release/version identifier --- @@ -83,8 +69,6 @@ Release/version identifier > `optional` **userId?**: `string` -Defined in: [types/observability.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L90) - Optional default user id to attach to spans --- @@ -93,8 +77,6 @@ Optional default user id to attach to spans > `optional` **sessionId?**: `string` -Defined in: [types/observability.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L92) - Optional default session id to attach to spans --- @@ -103,8 +85,6 @@ Optional default session id to attach to spans > `optional` **useExternalTracerProvider?**: `boolean` -Defined in: [types/observability.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L104) - If true, NeuroLink will NOT create or register its own TracerProvider. Instead, it will only create the LangfuseSpanProcessor and ContextEnricher, which the parent application must add to its own TracerProvider. @@ -123,8 +103,6 @@ false; > `optional` **autoDetectExternalProvider?**: `boolean` -Defined in: [types/observability.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L114) - If true, NeuroLink will automatically detect if a TracerProvider is already registered globally and skip its own registration to avoid conflicts. @@ -142,8 +120,6 @@ false; > `optional` **skipLangfuseSpanProcessor?**: `boolean` -Defined in: [types/observability.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L125) - If true, NeuroLink will NOT register its own LangfuseSpanProcessor with the global TracerProvider when using external provider mode. Only the ContextEnricher will be registered. Use this when the host application already registers a @@ -162,8 +138,6 @@ false; > `optional` **autoDetectOperationName?**: `boolean` -Defined in: [types/observability.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L147) - Enable auto-detection of operation names from span names. When true (default), AI operation spans (ai.streamText, ai.generateText, etc.) @@ -195,8 +169,6 @@ true; > `optional` **traceNameFormat?**: [`TraceNameFormat`](TraceNameFormat.md) -Defined in: [types/observability.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L169) - Format for trace names in Langfuse. Controls how userId and operationName are combined to form the trace name. diff --git a/docs/api/type-aliases/LangfuseContext.md b/docs/api/type-aliases/LangfuseContext.md index 9771607a7..d039634dd 100644 --- a/docs/api/type-aliases/LangfuseContext.md +++ b/docs/api/type-aliases/LangfuseContext.md @@ -8,8 +8,6 @@ > **LangfuseContext** = `object` -Defined in: [types/observability.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L278) - Extended context for Langfuse spans. Supports all Langfuse trace attributes for rich observability. @@ -19,24 +17,18 @@ Supports all Langfuse trace attributes for rich observability. > `optional` **userId?**: `string` \| `null` -Defined in: [types/observability.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L279) - --- ### sessionId? > `optional` **sessionId?**: `string` \| `null` -Defined in: [types/observability.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L280) - --- ### conversationId? > `optional` **conversationId?**: `string` \| `null` -Defined in: [types/observability.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L282) - Conversation/thread identifier for grouping related traces --- @@ -45,8 +37,6 @@ Conversation/thread identifier for grouping related traces > `optional` **requestId?**: `string` \| `null` -Defined in: [types/observability.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L284) - Request identifier for correlating with application logs --- @@ -55,8 +45,6 @@ Request identifier for correlating with application logs > `optional` **traceName?**: `string` \| `null` -Defined in: [types/observability.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L286) - Custom trace name for better organization in Langfuse UI --- @@ -65,8 +53,6 @@ Custom trace name for better organization in Langfuse UI > `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` -Defined in: [types/observability.ts:288](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L288) - Custom metadata to attach to spans --- @@ -75,8 +61,6 @@ Custom metadata to attach to spans > `optional` **operationName?**: `string` \| `null` -Defined in: [types/observability.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L293) - Explicit operation name (e.g., "ai.streamText", "chat", "embeddings"). If set, overrides auto-detection from the span name. @@ -86,8 +70,6 @@ If set, overrides auto-detection from the span name. > `optional` **autoDetectOperationName?**: `boolean` -Defined in: [types/observability.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L298) - Override global autoDetectOperationName setting for this context. When undefined, uses the global setting (defaults to true). @@ -97,8 +79,6 @@ When undefined, uses the global setting (defaults to true). > `optional` **customAttributes?**: `Record`\<`string`, `string` \| `number` \| `boolean`\> -Defined in: [types/observability.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L304) - Custom attributes to set on all spans within this context. These attributes are propagated to every span created within the AsyncLocalStorage context. diff --git a/docs/api/type-aliases/LangfuseExporterConfig.md b/docs/api/type-aliases/LangfuseExporterConfig.md index ce8783bdf..7dac9e788 100644 --- a/docs/api/type-aliases/LangfuseExporterConfig.md +++ b/docs/api/type-aliases/LangfuseExporterConfig.md @@ -8,8 +8,6 @@ > **LangfuseExporterConfig** = [`ExporterConfig`](ExporterConfig.md) & `object` -Defined in: [types/exporter.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L63) - Langfuse exporter configuration ## Type Declaration diff --git a/docs/api/type-aliases/LangfuseSpan.md b/docs/api/type-aliases/LangfuseSpan.md index 0edde887a..092b8d43a 100644 --- a/docs/api/type-aliases/LangfuseSpan.md +++ b/docs/api/type-aliases/LangfuseSpan.md @@ -8,8 +8,6 @@ > **LangfuseSpan** = `object` -Defined in: [types/span.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L227) - Langfuse-specific span format ## Properties @@ -18,96 +16,72 @@ Langfuse-specific span format > **id**: `string` -Defined in: [types/span.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L228) - --- ### traceId > **traceId**: `string` -Defined in: [types/span.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L229) - --- ### parentObservationId? > `optional` **parentObservationId?**: `string` -Defined in: [types/span.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L230) - --- ### name > **name**: `string` -Defined in: [types/span.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L231) - --- ### startTime > **startTime**: `string` -Defined in: [types/span.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L232) - --- ### endTime? > `optional` **endTime?**: `string` -Defined in: [types/span.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L233) - --- ### metadata > **metadata**: `Record`\<`string`, `unknown`\> -Defined in: [types/span.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L234) - --- ### level > **level**: `"DEBUG"` \| `"DEFAULT"` \| `"WARNING"` \| `"ERROR"` -Defined in: [types/span.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L235) - --- ### statusMessage? > `optional` **statusMessage?**: `string` -Defined in: [types/span.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L236) - --- ### input? > `optional` **input?**: `unknown` -Defined in: [types/span.ts:237](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L237) - --- ### output? > `optional` **output?**: `unknown` -Defined in: [types/span.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L238) - --- ### usage? > `optional` **usage?**: `object` -Defined in: [types/span.ts:239](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L239) - #### promptTokens? > `optional` **promptTokens?**: `number` diff --git a/docs/api/type-aliases/LangfuseSpanAttributes.md b/docs/api/type-aliases/LangfuseSpanAttributes.md index 43191987f..9deaf2a99 100644 --- a/docs/api/type-aliases/LangfuseSpanAttributes.md +++ b/docs/api/type-aliases/LangfuseSpanAttributes.md @@ -8,8 +8,6 @@ > **LangfuseSpanAttributes** = `object` -Defined in: [types/observability.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L40) - Standard GenAI semantic convention attributes from OpenTelemetry These are the attributes that Vercel AI SDK's experimental_telemetry creates @@ -27,148 +25,110 @@ https://opentelemetry.io/docs/specs/semconv/gen-ai/ > `optional` **gen_ai.system?**: `string` -Defined in: [types/observability.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L42) - --- ### gen_ai.request.model? > `optional` **gen_ai.request.model?**: `string` -Defined in: [types/observability.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L43) - --- ### gen_ai.response.model? > `optional` **gen_ai.response.model?**: `string` -Defined in: [types/observability.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L44) - --- ### gen_ai.request.max_tokens? > `optional` **gen_ai.request.max_tokens?**: `number` -Defined in: [types/observability.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L45) - --- ### gen_ai.request.temperature? > `optional` **gen_ai.request.temperature?**: `number` -Defined in: [types/observability.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L46) - --- ### gen_ai.request.top_p? > `optional` **gen_ai.request.top_p?**: `number` -Defined in: [types/observability.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L47) - --- ### gen_ai.usage.input_tokens? > `optional` **gen_ai.usage.input_tokens?**: `number` -Defined in: [types/observability.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L48) - --- ### gen_ai.usage.output_tokens? > `optional` **gen_ai.usage.output_tokens?**: `number` -Defined in: [types/observability.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L49) - --- ### gen_ai.usage.total_tokens? > `optional` **gen_ai.usage.total_tokens?**: `number` -Defined in: [types/observability.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L50) - --- ### gen_ai.response.finish_reasons? > `optional` **gen_ai.response.finish_reasons?**: `string`[] -Defined in: [types/observability.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L51) - --- ### gen_ai.prompt? > `optional` **gen_ai.prompt?**: `string` -Defined in: [types/observability.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L52) - --- ### gen_ai.completion? > `optional` **gen_ai.completion?**: `string` -Defined in: [types/observability.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L53) - --- ### ai.model.id? > `optional` **ai.model.id?**: `string` -Defined in: [types/observability.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L56) - --- ### ai.model.provider? > `optional` **ai.model.provider?**: `string` -Defined in: [types/observability.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L57) - --- ### ai.operationId? > `optional` **ai.operationId?**: `string` -Defined in: [types/observability.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L58) - --- ### ai.telemetry.functionId? > `optional` **ai.telemetry.functionId?**: `string` -Defined in: [types/observability.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L59) - --- ### ai.finishReason? > `optional` **ai.finishReason?**: `string` -Defined in: [types/observability.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L60) - --- ### ai.usage.promptTokens? > `optional` **ai.usage.promptTokens?**: `number` -Defined in: [types/observability.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L61) - --- ### ai.usage.completionTokens? > `optional` **ai.usage.completionTokens?**: `number` - -Defined in: [types/observability.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L62) diff --git a/docs/api/type-aliases/LanguageModel.md b/docs/api/type-aliases/LanguageModel.md index e37c64134..badf47309 100644 --- a/docs/api/type-aliases/LanguageModel.md +++ b/docs/api/type-aliases/LanguageModel.md @@ -8,6 +8,4 @@ > **LanguageModel** = `string` \| [`LanguageModelV3`](LanguageModelV3.md) -Defined in: [types/aiCompat.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L535) - Upstream also admits a v2 model and a bare id string. diff --git a/docs/api/type-aliases/LanguageModelMiddleware.md b/docs/api/type-aliases/LanguageModelMiddleware.md index 6cc52aabb..499d96258 100644 --- a/docs/api/type-aliases/LanguageModelMiddleware.md +++ b/docs/api/type-aliases/LanguageModelMiddleware.md @@ -7,5 +7,3 @@ # Type Alias: LanguageModelMiddleware > **LanguageModelMiddleware** = [`LanguageModelV3Middleware`](LanguageModelV3Middleware.md) - -Defined in: [types/aiCompat.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L532) diff --git a/docs/api/type-aliases/LanguageModelObject.md b/docs/api/type-aliases/LanguageModelObject.md index cfc639c49..3018a430d 100644 --- a/docs/api/type-aliases/LanguageModelObject.md +++ b/docs/api/type-aliases/LanguageModelObject.md @@ -8,8 +8,6 @@ > **LanguageModelObject** = `object` -Defined in: [types/providers.ts:2186](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2186) - Language model object shape (LanguageModelV2/V3). ## Properties @@ -18,12 +16,8 @@ Language model object shape (LanguageModelV2/V3). > `readonly` **modelId**: `string` -Defined in: [types/providers.ts:2187](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2187) - --- ### provider > `readonly` **provider**: `string` - -Defined in: [types/providers.ts:2188](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2188) diff --git a/docs/api/type-aliases/LanguageModelRequestMetadata.md b/docs/api/type-aliases/LanguageModelRequestMetadata.md index abd08fb40..b3a2b71dc 100644 --- a/docs/api/type-aliases/LanguageModelRequestMetadata.md +++ b/docs/api/type-aliases/LanguageModelRequestMetadata.md @@ -8,12 +8,8 @@ > **LanguageModelRequestMetadata** = `object` -Defined in: [types/aiCompat.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L324) - ## Properties ### body? > `optional` **body?**: `unknown` - -Defined in: [types/aiCompat.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L324) diff --git a/docs/api/type-aliases/LanguageModelResponseMetadata.md b/docs/api/type-aliases/LanguageModelResponseMetadata.md index 8c447ea74..7f7056378 100644 --- a/docs/api/type-aliases/LanguageModelResponseMetadata.md +++ b/docs/api/type-aliases/LanguageModelResponseMetadata.md @@ -8,36 +8,26 @@ > **LanguageModelResponseMetadata** = `object` -Defined in: [types/aiCompat.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L326) - ## Properties ### id > **id**: `string` -Defined in: [types/aiCompat.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L327) - --- ### timestamp > **timestamp**: `Date` -Defined in: [types/aiCompat.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L328) - --- ### modelId > **modelId**: `string` -Defined in: [types/aiCompat.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L329) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> - -Defined in: [types/aiCompat.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L330) diff --git a/docs/api/type-aliases/LanguageModelUsage.md b/docs/api/type-aliases/LanguageModelUsage.md index 4b5cd51a6..cf5970b43 100644 --- a/docs/api/type-aliases/LanguageModelUsage.md +++ b/docs/api/type-aliases/LanguageModelUsage.md @@ -8,40 +8,30 @@ > **LanguageModelUsage** = `object` -Defined in: [types/aiCompat.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L307) - ## Properties ### inputTokens > **inputTokens**: `number` \| `undefined` -Defined in: [types/aiCompat.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L308) - --- ### outputTokens > **outputTokens**: `number` \| `undefined` -Defined in: [types/aiCompat.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L309) - --- ### totalTokens > **totalTokens**: `number` \| `undefined` -Defined in: [types/aiCompat.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L310) - --- ### inputTokenDetails? > `optional` **inputTokenDetails?**: `object` -Defined in: [types/aiCompat.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L311) - #### noCacheTokens? > `optional` **noCacheTokens?**: `number` @@ -60,8 +50,6 @@ Defined in: [types/aiCompat.ts:311](https://github.com/juspay/neurolink/blob/rel > `optional` **outputTokenDetails?**: `object` -Defined in: [types/aiCompat.ts:316](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L316) - #### textTokens? > `optional` **textTokens?**: `number` @@ -76,12 +64,8 @@ Defined in: [types/aiCompat.ts:316](https://github.com/juspay/neurolink/blob/rel > `optional` **reasoningTokens?**: `number` -Defined in: [types/aiCompat.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L320) - --- ### cachedInputTokens? > `optional` **cachedInputTokens?**: `number` - -Defined in: [types/aiCompat.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L321) diff --git a/docs/api/type-aliases/LanguageModelV3.md b/docs/api/type-aliases/LanguageModelV3.md index 3221f0839..c44e90845 100644 --- a/docs/api/type-aliases/LanguageModelV3.md +++ b/docs/api/type-aliases/LanguageModelV3.md @@ -8,48 +8,36 @@ > **LanguageModelV3** = `object` -Defined in: [types/aiCompat.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L491) - ## Properties ### specificationVersion > `readonly` **specificationVersion**: `"v3"` -Defined in: [types/aiCompat.ts:492](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L492) - --- ### provider > `readonly` **provider**: `string` -Defined in: [types/aiCompat.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L493) - --- ### modelId > `readonly` **modelId**: `string` -Defined in: [types/aiCompat.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L494) - --- ### supportedUrls > `readonly` **supportedUrls**: `Record`\<`string`, `RegExp`[]\> \| `PromiseLike`\<`Record`\<`string`, `RegExp`[]\>\> -Defined in: [types/aiCompat.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L495) - ## Methods ### doGenerate() > **doGenerate**(`options`): `PromiseLike`\<[`LanguageModelV3GenerateResult`](LanguageModelV3GenerateResult.md)\> -Defined in: [types/aiCompat.ts:498](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L498) - #### Parameters ##### options @@ -66,8 +54,6 @@ Defined in: [types/aiCompat.ts:498](https://github.com/juspay/neurolink/blob/rel > **doStream**(`options`): `PromiseLike`\<[`LanguageModelV3StreamResult`](LanguageModelV3StreamResult.md)\> -Defined in: [types/aiCompat.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L501) - #### Parameters ##### options diff --git a/docs/api/type-aliases/LanguageModelV3CallOptions.md b/docs/api/type-aliases/LanguageModelV3CallOptions.md index ba6cfd9fb..64a1f2322 100644 --- a/docs/api/type-aliases/LanguageModelV3CallOptions.md +++ b/docs/api/type-aliases/LanguageModelV3CallOptions.md @@ -8,104 +8,78 @@ > **LanguageModelV3CallOptions** = `object` -Defined in: [types/aiCompat.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L336) - ## Properties ### prompt > **prompt**: [`LanguageModelV3Prompt`](LanguageModelV3Prompt.md) -Defined in: [types/aiCompat.ts:339](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L339) - --- ### maxOutputTokens? > `optional` **maxOutputTokens?**: `number` -Defined in: [types/aiCompat.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L340) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/aiCompat.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L341) - --- ### topP? > `optional` **topP?**: `number` -Defined in: [types/aiCompat.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L342) - --- ### topK? > `optional` **topK?**: `number` -Defined in: [types/aiCompat.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L343) - --- ### presencePenalty? > `optional` **presencePenalty?**: `number` -Defined in: [types/aiCompat.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L344) - --- ### frequencyPenalty? > `optional` **frequencyPenalty?**: `number` -Defined in: [types/aiCompat.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L345) - --- ### stopSequences? > `optional` **stopSequences?**: `string`[] -Defined in: [types/aiCompat.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L346) - --- ### seed? > `optional` **seed?**: `number` -Defined in: [types/aiCompat.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L347) - --- ### tools? > `optional` **tools?**: (\{ `type`: `"function"`; `name`: `string`; `description?`: `string`; `inputSchema?`: `unknown`; `strict?`: `boolean`; `providerOptions?`: `Record`\<`string`, `Record`\<`string`, `unknown`\>\>; \} \| \{ `type`: `"provider-defined"`; `id`: `string`; `name`: `string`; `args`: `Record`\<`string`, `unknown`\>; \})[] -Defined in: [types/aiCompat.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L350) - --- ### toolChoice? > `optional` **toolChoice?**: [`LanguageModelV3ToolChoice`](LanguageModelV3ToolChoice.md) -Defined in: [types/aiCompat.ts:366](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L366) - --- ### responseFormat? > `optional` **responseFormat?**: `object` -Defined in: [types/aiCompat.ts:367](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L367) - #### type > **type**: `"text"` \| `"json"` @@ -128,28 +102,20 @@ Defined in: [types/aiCompat.ts:367](https://github.com/juspay/neurolink/blob/rel > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/aiCompat.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L373) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string` \| `undefined`\> -Defined in: [types/aiCompat.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L374) - --- ### includeRawChunks? > `optional` **includeRawChunks?**: `boolean` -Defined in: [types/aiCompat.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L375) - --- ### providerOptions? > `optional` **providerOptions?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\> - -Defined in: [types/aiCompat.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L376) diff --git a/docs/api/type-aliases/LanguageModelV3Content.md b/docs/api/type-aliases/LanguageModelV3Content.md index 2372a47af..a2acecbc8 100644 --- a/docs/api/type-aliases/LanguageModelV3Content.md +++ b/docs/api/type-aliases/LanguageModelV3Content.md @@ -7,5 +7,3 @@ # Type Alias: LanguageModelV3Content > **LanguageModelV3Content** = \{ `type`: `"text"`; `text`: `string`; \} \| \{ `type`: `"reasoning"`; `text`: `string`; `providerOptions?`: `Record`\<`string`, `Record`\<`string`, `unknown`\>\>; \} \| \{ `type`: `"file"`; `data`: `unknown`; `mediaType`: `string`; \} \| [`LanguageModelV3ToolCall`](LanguageModelV3ToolCall.md) \| [`LanguageModelV3Source`](LanguageModelV3Source.md) \| `object` & `Record`\<`string`, `unknown`\> \| `object` & `Record`\<`string`, `unknown`\> - -Defined in: [types/aiCompat.ts:401](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L401) diff --git a/docs/api/type-aliases/LanguageModelV3GenerateResult.md b/docs/api/type-aliases/LanguageModelV3GenerateResult.md index cc202a1a3..cd9c63883 100644 --- a/docs/api/type-aliases/LanguageModelV3GenerateResult.md +++ b/docs/api/type-aliases/LanguageModelV3GenerateResult.md @@ -8,60 +8,44 @@ > **LanguageModelV3GenerateResult** = `object` -Defined in: [types/aiCompat.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L434) - ## Properties ### content > **content**: [`LanguageModelV3Content`](LanguageModelV3Content.md)[] -Defined in: [types/aiCompat.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L435) - --- ### finishReason > **finishReason**: `LanguageModelV3FinishReason` -Defined in: [types/aiCompat.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L436) - --- ### usage > **usage**: `LanguageModelV3Usage` -Defined in: [types/aiCompat.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L437) - --- ### warnings? > `optional` **warnings?**: `unknown`[] -Defined in: [types/aiCompat.ts:438](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L438) - --- ### request? > `optional` **request?**: `unknown` -Defined in: [types/aiCompat.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L439) - --- ### response? > `optional` **response?**: `unknown` -Defined in: [types/aiCompat.ts:440](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L440) - --- ### providerMetadata? > `optional` **providerMetadata?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\> - -Defined in: [types/aiCompat.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L441) diff --git a/docs/api/type-aliases/LanguageModelV3Message.md b/docs/api/type-aliases/LanguageModelV3Message.md index e9200f5b8..63d476ede 100644 --- a/docs/api/type-aliases/LanguageModelV3Message.md +++ b/docs/api/type-aliases/LanguageModelV3Message.md @@ -7,5 +7,3 @@ # Type Alias: LanguageModelV3Message > **LanguageModelV3Message** = [`ModelMessage`](ModelMessage.md) - -Defined in: [types/aiCompat.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L333) diff --git a/docs/api/type-aliases/LanguageModelV3Middleware.md b/docs/api/type-aliases/LanguageModelV3Middleware.md index f9d9dbb5e..63a23f233 100644 --- a/docs/api/type-aliases/LanguageModelV3Middleware.md +++ b/docs/api/type-aliases/LanguageModelV3Middleware.md @@ -8,24 +8,18 @@ > **LanguageModelV3Middleware** = `object` -Defined in: [types/aiCompat.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L506) - ## Properties ### specificationVersion > `readonly` **specificationVersion**: `"v3"` -Defined in: [types/aiCompat.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L507) - --- ### overrideProvider? > `optional` **overrideProvider?**: (`options`) => `string` -Defined in: [types/aiCompat.ts:508](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L508) - #### Parameters ##### options @@ -44,8 +38,6 @@ Defined in: [types/aiCompat.ts:508](https://github.com/juspay/neurolink/blob/rel > `optional` **overrideModelId?**: (`options`) => `string` -Defined in: [types/aiCompat.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L509) - #### Parameters ##### options @@ -64,8 +56,6 @@ Defined in: [types/aiCompat.ts:509](https://github.com/juspay/neurolink/blob/rel > `optional` **overrideSupportedUrls?**: (`options`) => `Record`\<`string`, `RegExp`[]\> \| `PromiseLike`\<`Record`\<`string`, `RegExp`[]\>\> -Defined in: [types/aiCompat.ts:510](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L510) - #### Parameters ##### options @@ -84,8 +74,6 @@ Defined in: [types/aiCompat.ts:510](https://github.com/juspay/neurolink/blob/rel > `optional` **transformParams?**: (`options`) => `PromiseLike`\<[`LanguageModelV3CallOptions`](LanguageModelV3CallOptions.md)\> -Defined in: [types/aiCompat.ts:513](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L513) - #### Parameters ##### options @@ -112,8 +100,6 @@ Defined in: [types/aiCompat.ts:513](https://github.com/juspay/neurolink/blob/rel > `optional` **wrapGenerate?**: (`options`) => `PromiseLike`\<[`LanguageModelV3GenerateResult`](LanguageModelV3GenerateResult.md)\> -Defined in: [types/aiCompat.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L518) - #### Parameters ##### options @@ -144,8 +130,6 @@ Defined in: [types/aiCompat.ts:518](https://github.com/juspay/neurolink/blob/rel > `optional` **wrapStream?**: (`options`) => `PromiseLike`\<[`LanguageModelV3StreamResult`](LanguageModelV3StreamResult.md)\> -Defined in: [types/aiCompat.ts:524](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L524) - #### Parameters ##### options diff --git a/docs/api/type-aliases/LanguageModelV3Prompt.md b/docs/api/type-aliases/LanguageModelV3Prompt.md index 4d8d1b760..fb484e9d3 100644 --- a/docs/api/type-aliases/LanguageModelV3Prompt.md +++ b/docs/api/type-aliases/LanguageModelV3Prompt.md @@ -7,5 +7,3 @@ # Type Alias: LanguageModelV3Prompt > **LanguageModelV3Prompt** = [`ModelMessage`](ModelMessage.md)[] - -Defined in: [types/aiCompat.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L334) diff --git a/docs/api/type-aliases/LanguageModelV3Source.md b/docs/api/type-aliases/LanguageModelV3Source.md index 837d2f904..314aa8b17 100644 --- a/docs/api/type-aliases/LanguageModelV3Source.md +++ b/docs/api/type-aliases/LanguageModelV3Source.md @@ -8,44 +8,32 @@ > **LanguageModelV3Source** = `object` -Defined in: [types/aiCompat.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L387) - ## Properties ### type > **type**: `"source"` -Defined in: [types/aiCompat.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L388) - --- ### sourceType > **sourceType**: `string` -Defined in: [types/aiCompat.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L389) - --- ### id > **id**: `string` -Defined in: [types/aiCompat.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L390) - --- ### url? > `optional` **url?**: `string` -Defined in: [types/aiCompat.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L391) - --- ### title? > `optional` **title?**: `string` - -Defined in: [types/aiCompat.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L392) diff --git a/docs/api/type-aliases/LanguageModelV3StreamPart.md b/docs/api/type-aliases/LanguageModelV3StreamPart.md index 610a3b3c8..5089e8b84 100644 --- a/docs/api/type-aliases/LanguageModelV3StreamPart.md +++ b/docs/api/type-aliases/LanguageModelV3StreamPart.md @@ -8,7 +8,5 @@ > **LanguageModelV3StreamPart** = \{ `type`: `"text-start"`; `id?`: `string`; \} \| \{ `type`: `"text-delta"`; `id?`: `string`; `delta`: `string`; \} \| \{ `type`: `"text-end"`; `id?`: `string`; \} \| \{ `type`: `"reasoning-start"`; `id?`: `string`; \} \| \{ `type`: `"reasoning-delta"`; `id?`: `string`; `delta`: `string`; \} \| \{ `type`: `"reasoning-end"`; `id?`: `string`; \} \| \{ `type`: `"tool-call"`; `toolCallId`: `string`; `toolName`: `string`; `input`: `string`; `providerExecuted?`: `boolean`; \} \| `object` & `Record`\<`string`, `unknown`\> \| `object` & `Record`\<`string`, `unknown`\> \| `object` & `Record`\<`string`, `unknown`\> \| `object` & `Record`\<`string`, `unknown`\> \| \{ `type`: `"source"`; `sourceType`: `string`; `id`: `string`; `url?`: `string`; `title?`: `string`; \} \| `object` & `Record`\<`string`, `unknown`\> \| `object` & `Record`\<`string`, `unknown`\> \| `object` & `Record`\<`string`, `unknown`\> \| `object` & `Record`\<`string`, `unknown`\> \| \{ `type`: `"error"`; `error`: `unknown`; \} \| \{ `type`: `"finish"`; `finishReason`: `LanguageModelV3FinishReason`; `usage`: `LanguageModelV3Usage`; `providerMetadata?`: `Record`\<`string`, `Record`\<`string`, `unknown`\>\>; \} -Defined in: [types/aiCompat.ts:448](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L448) - Discriminated rather than a loose record: consumers switch on `type` and read variant-specific fields (a finish part's usage, a tool-call's input). diff --git a/docs/api/type-aliases/LanguageModelV3StreamResult.md b/docs/api/type-aliases/LanguageModelV3StreamResult.md index 6faab1774..480ac1c6f 100644 --- a/docs/api/type-aliases/LanguageModelV3StreamResult.md +++ b/docs/api/type-aliases/LanguageModelV3StreamResult.md @@ -8,28 +8,20 @@ > **LanguageModelV3StreamResult** = `object` -Defined in: [types/aiCompat.ts:485](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L485) - ## Properties ### stream > **stream**: `ReadableStream`\<[`LanguageModelV3StreamPart`](LanguageModelV3StreamPart.md)\> -Defined in: [types/aiCompat.ts:486](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L486) - --- ### request? > `optional` **request?**: `unknown` -Defined in: [types/aiCompat.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L487) - --- ### response? > `optional` **response?**: `unknown` - -Defined in: [types/aiCompat.ts:488](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L488) diff --git a/docs/api/type-aliases/LanguageModelV3ToolCall.md b/docs/api/type-aliases/LanguageModelV3ToolCall.md index 8658bc86b..31b9a6ae0 100644 --- a/docs/api/type-aliases/LanguageModelV3ToolCall.md +++ b/docs/api/type-aliases/LanguageModelV3ToolCall.md @@ -8,44 +8,32 @@ > **LanguageModelV3ToolCall** = `object` -Defined in: [types/aiCompat.ts:379](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L379) - ## Properties ### type > **type**: `"tool-call"` -Defined in: [types/aiCompat.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L380) - --- ### toolCallId > **toolCallId**: `string` -Defined in: [types/aiCompat.ts:381](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L381) - --- ### toolName > **toolName**: `string` -Defined in: [types/aiCompat.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L382) - --- ### input > **input**: `string` -Defined in: [types/aiCompat.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L383) - --- ### providerExecuted? > `optional` **providerExecuted?**: `boolean` - -Defined in: [types/aiCompat.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L384) diff --git a/docs/api/type-aliases/LanguageModelV3ToolChoice.md b/docs/api/type-aliases/LanguageModelV3ToolChoice.md index 7fd507f6a..e2ad94707 100644 --- a/docs/api/type-aliases/LanguageModelV3ToolChoice.md +++ b/docs/api/type-aliases/LanguageModelV3ToolChoice.md @@ -7,5 +7,3 @@ # Type Alias: LanguageModelV3ToolChoice > **LanguageModelV3ToolChoice** = \{ `type`: `"auto"`; \} \| \{ `type`: `"none"`; \} \| \{ `type`: `"required"`; \} \| \{ `type`: `"tool"`; `toolName`: `string`; \} - -Defined in: [types/aiCompat.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L395) diff --git a/docs/api/type-aliases/LatencyStats.md b/docs/api/type-aliases/LatencyStats.md index 167614844..b945ce9c0 100644 --- a/docs/api/type-aliases/LatencyStats.md +++ b/docs/api/type-aliases/LatencyStats.md @@ -8,8 +8,6 @@ > **LatencyStats** = `object` -Defined in: [types/observability.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L311) - Latency statistics with percentile calculations ## Properties @@ -18,8 +16,6 @@ Latency statistics with percentile calculations > **min**: `number` -Defined in: [types/observability.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L313) - Minimum latency in milliseconds --- @@ -28,8 +24,6 @@ Minimum latency in milliseconds > **max**: `number` -Defined in: [types/observability.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L315) - Maximum latency in milliseconds --- @@ -38,8 +32,6 @@ Maximum latency in milliseconds > **mean**: `number` -Defined in: [types/observability.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L317) - Mean/average latency in milliseconds --- @@ -48,8 +40,6 @@ Mean/average latency in milliseconds > **median**: `number` -Defined in: [types/observability.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L319) - Median latency (p50) in milliseconds --- @@ -58,8 +48,6 @@ Median latency (p50) in milliseconds > **p50**: `number` -Defined in: [types/observability.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L321) - 50th percentile latency in milliseconds --- @@ -68,8 +56,6 @@ Defined in: [types/observability.ts:321](https://github.com/juspay/neurolink/blo > **p75**: `number` -Defined in: [types/observability.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L323) - 75th percentile latency in milliseconds --- @@ -78,8 +64,6 @@ Defined in: [types/observability.ts:323](https://github.com/juspay/neurolink/blo > **p90**: `number` -Defined in: [types/observability.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L325) - 90th percentile latency in milliseconds --- @@ -88,8 +72,6 @@ Defined in: [types/observability.ts:325](https://github.com/juspay/neurolink/blo > **p95**: `number` -Defined in: [types/observability.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L327) - 95th percentile latency in milliseconds --- @@ -98,8 +80,6 @@ Defined in: [types/observability.ts:327](https://github.com/juspay/neurolink/blo > **p99**: `number` -Defined in: [types/observability.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L329) - 99th percentile latency in milliseconds --- @@ -108,8 +88,6 @@ Defined in: [types/observability.ts:329](https://github.com/juspay/neurolink/blo > **stdDev**: `number` -Defined in: [types/observability.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L331) - Standard deviation in milliseconds --- @@ -118,6 +96,4 @@ Standard deviation in milliseconds > **count**: `number` -Defined in: [types/observability.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L333) - Total number of samples diff --git a/docs/api/type-aliases/LayerExecutionResult.md b/docs/api/type-aliases/LayerExecutionResult.md index f426923d2..6261908ac 100644 --- a/docs/api/type-aliases/LayerExecutionResult.md +++ b/docs/api/type-aliases/LayerExecutionResult.md @@ -8,8 +8,6 @@ > **LayerExecutionResult** = `object` -Defined in: [types/workflow.ts:633](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L633) - Result of executing a single layer/group ## Properties @@ -18,44 +16,32 @@ Result of executing a single layer/group > **groupId**: `string` -Defined in: [types/workflow.ts:634](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L634) - --- ### responses > **responses**: [`EnsembleResponse`](EnsembleResponse.md)[] -Defined in: [types/workflow.ts:635](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L635) - --- ### successCount > **successCount**: `number` -Defined in: [types/workflow.ts:636](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L636) - --- ### failureCount > **failureCount**: `number` -Defined in: [types/workflow.ts:637](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L637) - --- ### executionTime > **executionTime**: `number` -Defined in: [types/workflow.ts:638](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L638) - --- ### shouldContinue > **shouldContinue**: `boolean` - -Defined in: [types/workflow.ts:639](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L639) diff --git a/docs/api/type-aliases/LengthConstraintType.md b/docs/api/type-aliases/LengthConstraintType.md index 304c8337e..21c3f9282 100644 --- a/docs/api/type-aliases/LengthConstraintType.md +++ b/docs/api/type-aliases/LengthConstraintType.md @@ -8,6 +8,4 @@ > **LengthConstraintType** = `"exact"` \| `"range"` \| `"minimum"` \| `"maximum"` \| `"ratio"` -Defined in: [types/scorer.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L598) - Length constraint type. diff --git a/docs/api/type-aliases/LengthMeasurement.md b/docs/api/type-aliases/LengthMeasurement.md index cd92594be..61530d2d5 100644 --- a/docs/api/type-aliases/LengthMeasurement.md +++ b/docs/api/type-aliases/LengthMeasurement.md @@ -8,8 +8,6 @@ > **LengthMeasurement** = `object` -Defined in: [types/scorer.ts:619](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L619) - Length measurement result. ## Properties @@ -18,36 +16,26 @@ Length measurement result. > **words**: `number` -Defined in: [types/scorer.ts:620](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L620) - --- ### characters > **characters**: `number` -Defined in: [types/scorer.ts:621](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L621) - --- ### sentences > **sentences**: `number` -Defined in: [types/scorer.ts:622](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L622) - --- ### paragraphs > **paragraphs**: `number` -Defined in: [types/scorer.ts:623](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L623) - --- ### estimatedTokens > **estimatedTokens**: `number` - -Defined in: [types/scorer.ts:624](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L624) diff --git a/docs/api/type-aliases/LengthScorerConfig.md b/docs/api/type-aliases/LengthScorerConfig.md index d6d866847..ead6fdd45 100644 --- a/docs/api/type-aliases/LengthScorerConfig.md +++ b/docs/api/type-aliases/LengthScorerConfig.md @@ -8,8 +8,6 @@ > **LengthScorerConfig** = [`RuleScorerConfig`](RuleScorerConfig.md) & `object` -Defined in: [types/scorer.ts:606](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L606) - Configuration specific to length scoring. ## Type Declaration diff --git a/docs/api/type-aliases/LengthUnit.md b/docs/api/type-aliases/LengthUnit.md index ccc5e5e63..dbc89d724 100644 --- a/docs/api/type-aliases/LengthUnit.md +++ b/docs/api/type-aliases/LengthUnit.md @@ -8,6 +8,4 @@ > **LengthUnit** = `"words"` \| `"characters"` \| `"sentences"` \| `"paragraphs"` \| `"tokens"` -Defined in: [types/scorer.ts:590](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L590) - Length measurement unit. diff --git a/docs/api/type-aliases/LifecycleChunkPayload.md b/docs/api/type-aliases/LifecycleChunkPayload.md index 8d83b1320..0872e2961 100644 --- a/docs/api/type-aliases/LifecycleChunkPayload.md +++ b/docs/api/type-aliases/LifecycleChunkPayload.md @@ -8,8 +8,6 @@ > **LifecycleChunkPayload** = `object` -Defined in: [types/middleware.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L330) - Payload delivered to onChunk callbacks for each streaming chunk. ## Properties @@ -18,8 +16,6 @@ Payload delivered to onChunk callbacks for each streaming chunk. > **type**: `string` -Defined in: [types/middleware.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L332) - Chunk type from the AI SDK stream --- @@ -28,8 +24,6 @@ Chunk type from the AI SDK stream > `optional` **textDelta?**: `string` -Defined in: [types/middleware.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L334) - Text content for text-delta chunks --- @@ -38,6 +32,4 @@ Text content for text-delta chunks > **sequenceNumber**: `number` -Defined in: [types/middleware.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L336) - Zero-based chunk sequence number diff --git a/docs/api/type-aliases/LifecycleErrorPayload.md b/docs/api/type-aliases/LifecycleErrorPayload.md index 722df847c..e5ae1bc4a 100644 --- a/docs/api/type-aliases/LifecycleErrorPayload.md +++ b/docs/api/type-aliases/LifecycleErrorPayload.md @@ -8,8 +8,6 @@ > **LifecycleErrorPayload** = `object` -Defined in: [types/middleware.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L318) - Payload delivered to onError callbacks when generation or streaming fails. ## Properties @@ -18,8 +16,6 @@ Payload delivered to onError callbacks when generation or streaming fails. > **error**: `Error` -Defined in: [types/middleware.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L320) - The error that occurred --- @@ -28,8 +24,6 @@ The error that occurred > **duration**: `number` -Defined in: [types/middleware.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L322) - Wall-clock duration until failure in milliseconds --- @@ -38,6 +32,4 @@ Wall-clock duration until failure in milliseconds > **recoverable**: `boolean` -Defined in: [types/middleware.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L324) - Whether the error is likely recoverable (rate limit, timeout, network) diff --git a/docs/api/type-aliases/LifecycleFinishPayload.md b/docs/api/type-aliases/LifecycleFinishPayload.md index 4934d951a..174e1c693 100644 --- a/docs/api/type-aliases/LifecycleFinishPayload.md +++ b/docs/api/type-aliases/LifecycleFinishPayload.md @@ -8,8 +8,6 @@ > **LifecycleFinishPayload** = `object` -Defined in: [types/middleware.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L304) - Payload delivered to onFinish callbacks after generation or streaming completes. ## Properties @@ -18,8 +16,6 @@ Payload delivered to onFinish callbacks after generation or streaming completes. > **text**: `string` -Defined in: [types/middleware.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L306) - The generated text content --- @@ -28,8 +24,6 @@ The generated text content > `optional` **usage?**: `object` -Defined in: [types/middleware.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L308) - Token usage from the provider #### promptTokens @@ -46,8 +40,6 @@ Token usage from the provider > **duration**: `number` -Defined in: [types/middleware.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L310) - Wall-clock duration in milliseconds --- @@ -56,6 +48,4 @@ Wall-clock duration in milliseconds > `optional` **finishReason?**: `string` -Defined in: [types/middleware.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L312) - Why generation stopped diff --git a/docs/api/type-aliases/LifecycleMiddlewareConfig.md b/docs/api/type-aliases/LifecycleMiddlewareConfig.md index 80db51c48..901b46cb5 100644 --- a/docs/api/type-aliases/LifecycleMiddlewareConfig.md +++ b/docs/api/type-aliases/LifecycleMiddlewareConfig.md @@ -8,8 +8,6 @@ > **LifecycleMiddlewareConfig** = `object` -Defined in: [types/middleware.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L358) - Configuration for the lifecycle middleware. Pass callbacks to observe generation/streaming lifecycle events. @@ -19,32 +17,24 @@ Pass callbacks to observe generation/streaming lifecycle events. > `optional` **onFinish?**: [`OnFinishCallback`](OnFinishCallback.md) -Defined in: [types/middleware.ts:359](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L359) - --- ### onError? > `optional` **onError?**: [`OnErrorCallback`](OnErrorCallback.md) -Defined in: [types/middleware.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L360) - --- ### onChunk? > `optional` **onChunk?**: [`OnChunkCallback`](OnChunkCallback.md) -Defined in: [types/middleware.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L361) - --- ### timeoutMs? > `optional` **timeoutMs?**: `number` -Defined in: [types/middleware.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L372) - Per-callback deadline in milliseconds applied to every `onChunk` / `onFinish` / `onError` invocation. When a callback exceeds this it is logged and abandoned — generate()/stream() diff --git a/docs/api/type-aliases/ListOptions.md b/docs/api/type-aliases/ListOptions.md index 4ac8ea561..160d4ac9c 100644 --- a/docs/api/type-aliases/ListOptions.md +++ b/docs/api/type-aliases/ListOptions.md @@ -8,8 +8,6 @@ > **ListOptions** = `object` -Defined in: [types/workflow.ts:683](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L683) - Options for workflow listing ## Properties @@ -18,28 +16,20 @@ Options for workflow listing > `optional` **type?**: `string` -Defined in: [types/workflow.ts:684](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L684) - --- ### tags? > `optional` **tags?**: `string`[] -Defined in: [types/workflow.ts:685](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L685) - --- ### limit? > `optional` **limit?**: `number` -Defined in: [types/workflow.ts:686](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L686) - --- ### offset? > `optional` **offset?**: `number` - -Defined in: [types/workflow.ts:687](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L687) diff --git a/docs/api/type-aliases/LiveConnectCallbacks.md b/docs/api/type-aliases/LiveConnectCallbacks.md index 462f7c70f..dd8367798 100644 --- a/docs/api/type-aliases/LiveConnectCallbacks.md +++ b/docs/api/type-aliases/LiveConnectCallbacks.md @@ -8,8 +8,6 @@ > **LiveConnectCallbacks** = `object` -Defined in: [types/providers.ts:1186](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1186) - Live connection callbacks ## Properties @@ -18,8 +16,6 @@ Live connection callbacks > `optional` **onopen?**: () => `void` -Defined in: [types/providers.ts:1187](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1187) - #### Returns `void` @@ -30,8 +26,6 @@ Defined in: [types/providers.ts:1187](https://github.com/juspay/neurolink/blob/r > `optional` **onmessage?**: (`message`) => `void` -Defined in: [types/providers.ts:1188](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1188) - #### Parameters ##### message @@ -48,8 +42,6 @@ Defined in: [types/providers.ts:1188](https://github.com/juspay/neurolink/blob/r > `optional` **onerror?**: (`e`) => `void` -Defined in: [types/providers.ts:1189](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1189) - #### Parameters ##### e @@ -68,8 +60,6 @@ Defined in: [types/providers.ts:1189](https://github.com/juspay/neurolink/blob/r > `optional` **onclose?**: (`e`) => `void` -Defined in: [types/providers.ts:1190](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1190) - #### Parameters ##### e diff --git a/docs/api/type-aliases/LiveConnectConfig.md b/docs/api/type-aliases/LiveConnectConfig.md index 3131a3d58..dbc126bff 100644 --- a/docs/api/type-aliases/LiveConnectConfig.md +++ b/docs/api/type-aliases/LiveConnectConfig.md @@ -8,8 +8,6 @@ > **LiveConnectConfig** = `object` -Defined in: [types/providers.ts:1196](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1196) - Live connection configuration ## Properties @@ -18,24 +16,18 @@ Live connection configuration > **model**: `string` -Defined in: [types/providers.ts:1197](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1197) - --- ### callbacks > **callbacks**: [`LiveConnectCallbacks`](LiveConnectCallbacks.md) -Defined in: [types/providers.ts:1198](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1198) - --- ### config > **config**: `object` -Defined in: [types/providers.ts:1199](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1199) - #### responseModalities > **responseModalities**: (`"TEXT"` \| `"IMAGE"` \| `"AUDIO"`)[] diff --git a/docs/api/type-aliases/LiveKitBrainConfig.md b/docs/api/type-aliases/LiveKitBrainConfig.md index 78332a22a..c25fc3fc3 100644 --- a/docs/api/type-aliases/LiveKitBrainConfig.md +++ b/docs/api/type-aliases/LiveKitBrainConfig.md @@ -8,8 +8,6 @@ > **LiveKitBrainConfig** = `object` -Defined in: [types/livekit.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L39) - Configuration for the transport-agnostic voice brain. The brain owns the conversation: it calls `neurolink.stream()` with a stable @@ -22,8 +20,6 @@ leaves tool-calling to the NeuroLink instance. > **neurolink**: [`LiveKitNeuroLinkStreamer`](LiveKitNeuroLinkStreamer.md) -Defined in: [types/livekit.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L41) - Configured NeuroLink instance (memory + tools registered on it). --- @@ -32,8 +28,6 @@ Configured NeuroLink instance (memory + tools registered on it). > `optional` **provider?**: `string` -Defined in: [types/livekit.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L43) - LLM provider name passed to `stream()` (e.g. "bedrock"). --- @@ -42,8 +36,6 @@ LLM provider name passed to `stream()` (e.g. "bedrock"). > `optional` **model?**: `string` -Defined in: [types/livekit.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L45) - LLM model name passed to `stream()` (e.g. "claude-sonnet-4-6"). --- @@ -52,8 +44,6 @@ LLM model name passed to `stream()` (e.g. "claude-sonnet-4-6"). > `optional` **systemPrompt?**: `string` -Defined in: [types/livekit.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L47) - System prompt applied to every turn. --- @@ -62,8 +52,6 @@ System prompt applied to every turn. > `optional` **temperature?**: `number` -Defined in: [types/livekit.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L49) - Sampling temperature for spoken-style responses. --- @@ -72,8 +60,6 @@ Sampling temperature for spoken-style responses. > `optional` **maxTokens?**: `number` -Defined in: [types/livekit.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L51) - Upper bound on tokens per turn. --- @@ -82,6 +68,4 @@ Upper bound on tokens per turn. > `optional` **userId?**: `string` -Defined in: [types/livekit.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L53) - Optional user identifier recorded alongside memory. diff --git a/docs/api/type-aliases/LiveKitBrainDefaults.md b/docs/api/type-aliases/LiveKitBrainDefaults.md index 3d32ba5c3..ce3298421 100644 --- a/docs/api/type-aliases/LiveKitBrainDefaults.md +++ b/docs/api/type-aliases/LiveKitBrainDefaults.md @@ -8,8 +8,6 @@ > **LiveKitBrainDefaults** = `object` -Defined in: [types/livekit.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L211) - LLM defaults resolved from the environment for the brain. ## Properties @@ -18,12 +16,8 @@ LLM defaults resolved from the environment for the brain. > **provider**: `string` -Defined in: [types/livekit.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L212) - --- ### model > **model**: `string` - -Defined in: [types/livekit.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L213) diff --git a/docs/api/type-aliases/LiveKitBrainTurn.md b/docs/api/type-aliases/LiveKitBrainTurn.md index a2890cf4d..8576ea984 100644 --- a/docs/api/type-aliases/LiveKitBrainTurn.md +++ b/docs/api/type-aliases/LiveKitBrainTurn.md @@ -8,8 +8,6 @@ > **LiveKitBrainTurn** = `object` -Defined in: [types/livekit.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L57) - A single user turn handed to the brain. ## Properties @@ -18,8 +16,6 @@ A single user turn handed to the brain. > **transcript**: `string` -Defined in: [types/livekit.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L59) - Final transcript of the user's utterance. --- @@ -28,8 +24,6 @@ Final transcript of the user's utterance. > **conversationId**: `string` -Defined in: [types/livekit.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L61) - Stable conversation id keying NeuroLink memory for this session. --- @@ -38,6 +32,4 @@ Stable conversation id keying NeuroLink memory for this session. > `optional` **signal?**: `AbortSignal` -Defined in: [types/livekit.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L63) - Cancellation signal; aborting stops the in-flight LLM and tool calls. diff --git a/docs/api/type-aliases/LiveKitBridgeRoom.md b/docs/api/type-aliases/LiveKitBridgeRoom.md index 6815aa20b..cefc2da85 100644 --- a/docs/api/type-aliases/LiveKitBridgeRoom.md +++ b/docs/api/type-aliases/LiveKitBridgeRoom.md @@ -8,8 +8,6 @@ > **LiveKitBridgeRoom** = `object` -Defined in: [types/livekit.ts:364](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L364) - Minimal structural view of the LiveKit room the bridge needs: a local participant to publish on, and event (un)subscription. Declared structurally so `src/lib/types` carries no dependency on `@livekit/rtc-node`; the real @@ -21,8 +19,6 @@ so `src/lib/types` carries no dependency on `@livekit/rtc-node`; the real > `optional` **localParticipant?**: `object` -Defined in: [types/livekit.ts:365](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L365) - #### publishData() > **publishData**(`data`, `options`): `Promise`\<`void`\> @@ -73,8 +69,6 @@ Defined in: [types/livekit.ts:365](https://github.com/juspay/neurolink/blob/rele > **on**(`event`, `listener`): `unknown` -Defined in: [types/livekit.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L375) - #### Parameters ##### event @@ -95,8 +89,6 @@ Defined in: [types/livekit.ts:375](https://github.com/juspay/neurolink/blob/rele > **off**(`event`, `listener`): `unknown` -Defined in: [types/livekit.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L376) - #### Parameters ##### event diff --git a/docs/api/type-aliases/LiveKitEventBridgeConfig.md b/docs/api/type-aliases/LiveKitEventBridgeConfig.md index 0f028b27d..0c97b81ec 100644 --- a/docs/api/type-aliases/LiveKitEventBridgeConfig.md +++ b/docs/api/type-aliases/LiveKitEventBridgeConfig.md @@ -8,8 +8,6 @@ > **LiveKitEventBridgeConfig** = `object` -Defined in: [types/livekit.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L342) - Configuration for the data-channel event bridge, set on `LiveKitVoiceAgentConfig.events`. @@ -19,8 +17,6 @@ Configuration for the data-channel event bridge, set on > `optional` **enabled?**: `boolean` -Defined in: [types/livekit.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L344) - Master switch — the bridge is inert unless this is `true`. --- @@ -29,8 +25,6 @@ Master switch — the bridge is inert unless this is `true`. > `optional` **eventsTopic?**: `string` -Defined in: [types/livekit.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L346) - Data-channel topic for outbound events (default "ai-events"). --- @@ -39,8 +33,6 @@ Data-channel topic for outbound events (default "ai-events"). > `optional` **controlTopic?**: `string` -Defined in: [types/livekit.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L348) - Data-channel topic for inbound control messages (default "ai-control"). --- @@ -49,8 +41,6 @@ Data-channel topic for inbound control messages (default "ai-control"). > `optional` **include?**: [`LiveKitVoiceEventType`](LiveKitVoiceEventType.md)[] -Defined in: [types/livekit.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L350) - If set, only these event types are forwarded (default: all). --- @@ -59,7 +49,5 @@ If set, only these event types are forwarded (default: all). > `optional` **maxInlineBytes?**: `number` -Defined in: [types/livekit.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L355) - Payloads encoded larger than this many bytes are sent via the chunked text stream API instead of a single reliable data packet (default 12000). diff --git a/docs/api/type-aliases/LiveKitEventBridgeHandle.md b/docs/api/type-aliases/LiveKitEventBridgeHandle.md index 2bb6de510..f4f4acda6 100644 --- a/docs/api/type-aliases/LiveKitEventBridgeHandle.md +++ b/docs/api/type-aliases/LiveKitEventBridgeHandle.md @@ -8,8 +8,6 @@ > **LiveKitEventBridgeHandle** = `object` -Defined in: [types/livekit.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L403) - Handle returned by `attachEventBridge` for teardown. ## Properties @@ -18,8 +16,6 @@ Handle returned by `attachEventBridge` for teardown. > **dispose**: () => `void` -Defined in: [types/livekit.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L405) - Remove all listeners and stop publishing. Idempotent. #### Returns diff --git a/docs/api/type-aliases/LiveKitEventBridgeParams.md b/docs/api/type-aliases/LiveKitEventBridgeParams.md index c31390fe7..09e05a008 100644 --- a/docs/api/type-aliases/LiveKitEventBridgeParams.md +++ b/docs/api/type-aliases/LiveKitEventBridgeParams.md @@ -8,8 +8,6 @@ > **LiveKitEventBridgeParams** = `object` -Defined in: [types/livekit.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L393) - Inputs to `attachEventBridge`. ## Properties @@ -18,8 +16,6 @@ Inputs to `attachEventBridge`. > **room**: [`LiveKitBridgeRoom`](LiveKitBridgeRoom.md) -Defined in: [types/livekit.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L395) - The LiveKit room for this call (from the job context). --- @@ -28,8 +24,6 @@ The LiveKit room for this call (from the job context). > **emitter**: `TypedEventEmitter`\<[`NeuroLinkEvents`](NeuroLinkEvents.md)\> -Defined in: [types/livekit.ts:397](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L397) - NeuroLink's event emitter (`neurolink.getEventEmitter()`). --- @@ -38,6 +32,4 @@ NeuroLink's event emitter (`neurolink.getEventEmitter()`). > `optional` **options?**: [`LiveKitEventBridgeConfig`](LiveKitEventBridgeConfig.md) -Defined in: [types/livekit.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L399) - Bridge options (topics, filtering, chunking threshold). diff --git a/docs/api/type-aliases/LiveKitInterruptionConfig.md b/docs/api/type-aliases/LiveKitInterruptionConfig.md index 8e05d80af..31f6d8d36 100644 --- a/docs/api/type-aliases/LiveKitInterruptionConfig.md +++ b/docs/api/type-aliases/LiveKitInterruptionConfig.md @@ -8,8 +8,6 @@ > **LiveKitInterruptionConfig** = `object` -Defined in: [types/livekit.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L135) - Interruption (barge-in) tuning. Requiring real words / a minimum duration stops background noise from cutting off the assistant. @@ -19,8 +17,6 @@ stops background noise from cutting off the assistant. > `optional` **minWords?**: `number` -Defined in: [types/livekit.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L137) - Minimum recognized words to count as an interruption (default 2). --- @@ -29,6 +25,4 @@ Minimum recognized words to count as an interruption (default 2). > `optional` **minDuration?**: `number` -Defined in: [types/livekit.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L139) - Minimum audio duration to count as an interruption, ms (default 600). diff --git a/docs/api/type-aliases/LiveKitNeuroLinkStreamer.md b/docs/api/type-aliases/LiveKitNeuroLinkStreamer.md index 55d2867a2..62657e3ad 100644 --- a/docs/api/type-aliases/LiveKitNeuroLinkStreamer.md +++ b/docs/api/type-aliases/LiveKitNeuroLinkStreamer.md @@ -8,8 +8,6 @@ > **LiveKitNeuroLinkStreamer** = `object` -Defined in: [types/livekit.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L27) - Minimal structural shape of the NeuroLink instance the brain depends on. Declared structurally (rather than importing the `NeuroLink` class) so the @@ -26,8 +24,6 @@ to forward tool/text/HITL events to the browser. > **stream**: (`options`) => `Promise`\<[`StreamResult`](StreamResult.md)\> -Defined in: [types/livekit.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L28) - #### Parameters ##### options @@ -44,8 +40,6 @@ Defined in: [types/livekit.ts:28](https://github.com/juspay/neurolink/blob/relea > `optional` **getEventEmitter?**: () => `TypedEventEmitter`\<[`NeuroLinkEvents`](NeuroLinkEvents.md)\> -Defined in: [types/livekit.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L29) - #### Returns `TypedEventEmitter`\<[`NeuroLinkEvents`](NeuroLinkEvents.md)\> diff --git a/docs/api/type-aliases/LiveKitRoomCallContext.md b/docs/api/type-aliases/LiveKitRoomCallContext.md index 45893725b..accb9b9bf 100644 --- a/docs/api/type-aliases/LiveKitRoomCallContext.md +++ b/docs/api/type-aliases/LiveKitRoomCallContext.md @@ -8,8 +8,6 @@ > **LiveKitRoomCallContext** = `object` -Defined in: [types/livekit.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L501) - Auth token + base64 MCP execution context decoded from a room's metadata. ## Properties @@ -18,8 +16,6 @@ Auth token + base64 MCP execution context decoded from a room's metadata. > **authToken**: `string` -Defined in: [types/livekit.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L503) - Lighthouse access JWT used as `x-auth-token` to the MCP server. --- @@ -28,6 +24,4 @@ Lighthouse access JWT used as `x-auth-token` to the MCP server. > **xContext**: `string` -Defined in: [types/livekit.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L505) - base64(JSON) MCP execution context used as `x-context` (or "" if absent). diff --git a/docs/api/type-aliases/LiveKitServerConfig.md b/docs/api/type-aliases/LiveKitServerConfig.md index 0b7441c26..460562182 100644 --- a/docs/api/type-aliases/LiveKitServerConfig.md +++ b/docs/api/type-aliases/LiveKitServerConfig.md @@ -8,8 +8,6 @@ > **LiveKitServerConfig** = `object` -Defined in: [types/livekit.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L201) - Resolved LiveKit server connection settings. ## Properties @@ -18,8 +16,6 @@ Resolved LiveKit server connection settings. > **url**: `string` -Defined in: [types/livekit.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L203) - LiveKit server URL (ws/wss). --- @@ -28,8 +24,6 @@ LiveKit server URL (ws/wss). > **apiKey**: `string` -Defined in: [types/livekit.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L205) - API key for token signing and worker registration. --- @@ -38,6 +32,4 @@ API key for token signing and worker registration. > **apiSecret**: `string` -Defined in: [types/livekit.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L207) - API secret for token signing and worker registration. diff --git a/docs/api/type-aliases/LiveKitServerCredentials.md b/docs/api/type-aliases/LiveKitServerCredentials.md index d9dd2eb54..9488786af 100644 --- a/docs/api/type-aliases/LiveKitServerCredentials.md +++ b/docs/api/type-aliases/LiveKitServerCredentials.md @@ -8,8 +8,6 @@ > **LiveKitServerCredentials** = `object` -Defined in: [types/livekit.ts:412](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L412) - Credentials for LiveKit server-side REST calls (room create, agent dispatch). `url` accepts `ws(s)://` or `http(s)://`; helpers convert it to https. @@ -19,20 +17,14 @@ Credentials for LiveKit server-side REST calls (room create, agent dispatch). > **url**: `string` -Defined in: [types/livekit.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L413) - --- ### apiKey > **apiKey**: `string` -Defined in: [types/livekit.ts:414](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L414) - --- ### apiSecret > **apiSecret**: `string` - -Defined in: [types/livekit.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L415) diff --git a/docs/api/type-aliases/LiveKitSttConfig.md b/docs/api/type-aliases/LiveKitSttConfig.md index d3867057b..e180711ad 100644 --- a/docs/api/type-aliases/LiveKitSttConfig.md +++ b/docs/api/type-aliases/LiveKitSttConfig.md @@ -8,8 +8,6 @@ > **LiveKitSttConfig** = `object` -Defined in: [types/livekit.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L77) - Speech-to-text plugin selection for the LiveKit worker. ## Properties @@ -18,32 +16,24 @@ Speech-to-text plugin selection for the LiveKit worker. > **provider**: `string` -Defined in: [types/livekit.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L78) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/livekit.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L79) - --- ### language? > `optional` **language?**: `string` -Defined in: [types/livekit.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L80) - --- ### maxEndpointDelayMs? > `optional` **maxEndpointDelayMs?**: `number` -Defined in: [types/livekit.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L86) - Soniox only: maximum delay (ms) between speech cessation and the STT endpoint. Raise it so Soniox does not finalize on short pauses — that lets VAD silence (not the STT endpoint) decide when the turn ends. diff --git a/docs/api/type-aliases/LiveKitTokenRequest.md b/docs/api/type-aliases/LiveKitTokenRequest.md index b9909cd49..4ea55bc10 100644 --- a/docs/api/type-aliases/LiveKitTokenRequest.md +++ b/docs/api/type-aliases/LiveKitTokenRequest.md @@ -8,8 +8,6 @@ > **LiveKitTokenRequest** = `object` -Defined in: [types/livekit.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L217) - Arguments for minting a browser join token. ## Properties @@ -18,8 +16,6 @@ Arguments for minting a browser join token. > **identity**: `string` -Defined in: [types/livekit.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L219) - Participant identity (e.g. the authenticated user id). --- @@ -28,8 +24,6 @@ Participant identity (e.g. the authenticated user id). > **room**: `string` -Defined in: [types/livekit.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L221) - Room name to join (auto-created on first join). --- @@ -38,8 +32,6 @@ Room name to join (auto-created on first join). > **apiKey**: `string` -Defined in: [types/livekit.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L223) - LiveKit API key. --- @@ -48,8 +40,6 @@ LiveKit API key. > **apiSecret**: `string` -Defined in: [types/livekit.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L225) - LiveKit API secret. --- @@ -58,6 +48,4 @@ LiveKit API secret. > `optional` **ttlSeconds?**: `number` -Defined in: [types/livekit.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L227) - Token lifetime in seconds (default 600; clamped to a 3600 max). diff --git a/docs/api/type-aliases/LiveKitToolEventFields.md b/docs/api/type-aliases/LiveKitToolEventFields.md index a25c26da6..98ae5d123 100644 --- a/docs/api/type-aliases/LiveKitToolEventFields.md +++ b/docs/api/type-aliases/LiveKitToolEventFields.md @@ -8,8 +8,6 @@ > **LiveKitToolEventFields** = `object` -Defined in: [types/livekit.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L383) - Normalized tool fields extracted from a `tool:start` / `tool:end` emitter payload, used internally by the event bridge. @@ -19,44 +17,32 @@ payload, used internally by the event bridge. > **name**: `string` -Defined in: [types/livekit.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L384) - --- ### id? > `optional` **id?**: `string` -Defined in: [types/livekit.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L385) - --- ### input? > `optional` **input?**: `unknown` -Defined in: [types/livekit.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L386) - --- ### result? > `optional` **result?**: `unknown` -Defined in: [types/livekit.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L387) - --- ### success? > `optional` **success?**: `boolean` -Defined in: [types/livekit.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L388) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/livekit.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L389) diff --git a/docs/api/type-aliases/LiveKitTtsConfig.md b/docs/api/type-aliases/LiveKitTtsConfig.md index 9f4ca7f11..d0f782897 100644 --- a/docs/api/type-aliases/LiveKitTtsConfig.md +++ b/docs/api/type-aliases/LiveKitTtsConfig.md @@ -8,8 +8,6 @@ > **LiveKitTtsConfig** = `object` -Defined in: [types/livekit.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L90) - Text-to-speech plugin selection for the LiveKit worker. ## Properties @@ -18,20 +16,14 @@ Text-to-speech plugin selection for the LiveKit worker. > **provider**: `string` -Defined in: [types/livekit.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L91) - --- ### voice? > `optional` **voice?**: `string` -Defined in: [types/livekit.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L92) - --- ### model? > `optional` **model?**: `string` - -Defined in: [types/livekit.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L93) diff --git a/docs/api/type-aliases/LiveKitTurnConfig.md b/docs/api/type-aliases/LiveKitTurnConfig.md index 62e8fb737..9493ad758 100644 --- a/docs/api/type-aliases/LiveKitTurnConfig.md +++ b/docs/api/type-aliases/LiveKitTurnConfig.md @@ -8,8 +8,6 @@ > **LiveKitTurnConfig** = `object` -Defined in: [types/livekit.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L125) - Turn-detection (end-of-utterance) tuning. `mode` selects what decides the user's turn is over: @@ -32,20 +30,14 @@ window in milliseconds (in VAD mode the effective end delay is > `optional` **mode?**: `"stt"` \| `"vad"` \| `"realtime_llm"` \| `"manual"` -Defined in: [types/livekit.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L126) - --- ### minEndpointingDelay? > `optional` **minEndpointingDelay?**: `number` -Defined in: [types/livekit.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L127) - --- ### maxEndpointingDelay? > `optional` **maxEndpointingDelay?**: `number` - -Defined in: [types/livekit.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L128) diff --git a/docs/api/type-aliases/LiveKitVadConfig.md b/docs/api/type-aliases/LiveKitVadConfig.md index c77a3a868..9f7f7c4c1 100644 --- a/docs/api/type-aliases/LiveKitVadConfig.md +++ b/docs/api/type-aliases/LiveKitVadConfig.md @@ -8,8 +8,6 @@ > **LiveKitVadConfig** = `object` -Defined in: [types/livekit.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L100) - Silero VAD tuning. Stricter values reject background noise (higher threshold, longer minimum speech). Durations are in seconds. @@ -19,8 +17,6 @@ longer minimum speech). Durations are in seconds. > `optional` **activationThreshold?**: `number` -Defined in: [types/livekit.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L102) - Probability cutoff for "this is speech" (default 0.6). Higher = stricter. --- @@ -29,8 +25,6 @@ Probability cutoff for "this is speech" (default 0.6). Higher = stricter. > `optional` **minSpeechDuration?**: `number` -Defined in: [types/livekit.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L104) - Minimum speech length before a turn starts, seconds (default 0.2). --- @@ -39,6 +33,4 @@ Minimum speech length before a turn starts, seconds (default 0.2). > `optional` **minSilenceDuration?**: `number` -Defined in: [types/livekit.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L106) - Silence before a turn ends, seconds (default 0.6) — tolerates pauses. diff --git a/docs/api/type-aliases/LiveKitVoiceAgentConfig.md b/docs/api/type-aliases/LiveKitVoiceAgentConfig.md index 3a484749a..3e8a9afd5 100644 --- a/docs/api/type-aliases/LiveKitVoiceAgentConfig.md +++ b/docs/api/type-aliases/LiveKitVoiceAgentConfig.md @@ -8,8 +8,6 @@ > **LiveKitVoiceAgentConfig** = `object` -Defined in: [types/livekit.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L151) - Options for `defineVoiceAgent` — the agent definition placed as the default export of the worker entry file. @@ -24,8 +22,6 @@ process** to build the brain (and register its tools) for that call. > **createNeuroLink**: () => [`LiveKitNeuroLinkStreamer`](LiveKitNeuroLinkStreamer.md) \| `Promise`\<[`LiveKitNeuroLinkStreamer`](LiveKitNeuroLinkStreamer.md)\> -Defined in: [types/livekit.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L156) - Factory that builds the NeuroLink instance for a job process. Called once per call, inside the job's own process. @@ -39,8 +35,6 @@ Called once per call, inside the job's own process. > **stt**: [`LiveKitSttConfig`](LiveKitSttConfig.md) -Defined in: [types/livekit.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L160) - Realtime speech-to-text selection. --- @@ -49,8 +43,6 @@ Realtime speech-to-text selection. > **tts**: [`LiveKitTtsConfig`](LiveKitTtsConfig.md) -Defined in: [types/livekit.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L162) - Realtime text-to-speech selection. --- @@ -59,8 +51,6 @@ Realtime text-to-speech selection. > `optional` **provider?**: `string` -Defined in: [types/livekit.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L164) - LLM provider/model overrides (default to env-resolved values). --- @@ -69,40 +59,30 @@ LLM provider/model overrides (default to env-resolved values). > `optional` **model?**: `string` -Defined in: [types/livekit.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L165) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/livekit.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L166) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/livekit.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L167) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/livekit.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L168) - --- ### conversationIdPrefix? > `optional` **conversationIdPrefix?**: `string` -Defined in: [types/livekit.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L170) - Prefix used when deriving a per-room conversation id (default "voice"). --- @@ -111,8 +91,6 @@ Prefix used when deriving a per-room conversation id (default "voice"). > `optional` **userId?**: `string` -Defined in: [types/livekit.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L172) - Optional user id recorded alongside memory. --- @@ -121,16 +99,12 @@ Optional user id recorded alongside memory. > `optional` **greeting?**: `string` -Defined in: [types/livekit.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L173) - --- ### vad? > `optional` **vad?**: [`LiveKitVadConfig`](LiveKitVadConfig.md) -Defined in: [types/livekit.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L175) - Silero VAD tuning (stricter = ignores background noise). --- @@ -139,8 +113,6 @@ Silero VAD tuning (stricter = ignores background noise). > `optional` **turn?**: [`LiveKitTurnConfig`](LiveKitTurnConfig.md) -Defined in: [types/livekit.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L177) - Turn-detection tuning (VAD vs STT endpointing, delays). --- @@ -149,8 +121,6 @@ Turn-detection tuning (VAD vs STT endpointing, delays). > `optional` **interruption?**: [`LiveKitInterruptionConfig`](LiveKitInterruptionConfig.md) -Defined in: [types/livekit.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L179) - Interruption tuning (require words/duration so noise can't barge in). --- @@ -159,8 +129,6 @@ Interruption tuning (require words/duration so noise can't barge in). > `optional` **events?**: [`LiveKitEventBridgeConfig`](LiveKitEventBridgeConfig.md) -Defined in: [types/livekit.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L186) - Data-channel event bridge: forward NeuroLink events (text, tool calls, tool results, HITL prompts, status) to the browser over the LiveKit data channel, and accept control messages (HITL responses) back. Disabled diff --git a/docs/api/type-aliases/LiveKitVoiceBrain.md b/docs/api/type-aliases/LiveKitVoiceBrain.md index bc45fbd3f..3ee747b4e 100644 --- a/docs/api/type-aliases/LiveKitVoiceBrain.md +++ b/docs/api/type-aliases/LiveKitVoiceBrain.md @@ -8,8 +8,6 @@ > **LiveKitVoiceBrain** = `object` -Defined in: [types/livekit.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L70) - The brain's public surface: stream the assistant reply as text deltas. The transport layer converts these deltas into audio (TTS). @@ -19,8 +17,6 @@ The transport layer converts these deltas into audio (TTS). > **streamReply**: (`turn`) => `AsyncGenerator`\<`string`, `void`, `unknown`\> -Defined in: [types/livekit.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L71) - #### Parameters ##### turn diff --git a/docs/api/type-aliases/LiveKitVoiceControlMessage.md b/docs/api/type-aliases/LiveKitVoiceControlMessage.md index 6527a6737..c5c8a172b 100644 --- a/docs/api/type-aliases/LiveKitVoiceControlMessage.md +++ b/docs/api/type-aliases/LiveKitVoiceControlMessage.md @@ -8,6 +8,4 @@ > **LiveKitVoiceControlMessage** = \{ `action`: `"hitl:accept"`; `confirmationId`: `string`; `modifiedArguments?`: `unknown`; \} \| \{ `action`: `"hitl:reject"`; `confirmationId`: `string`; `reason?`: `string`; \} -Defined in: [types/livekit.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L330) - Control messages sent from the browser back to the agent. diff --git a/docs/api/type-aliases/LiveKitVoiceDoneEvent.md b/docs/api/type-aliases/LiveKitVoiceDoneEvent.md index ee171d2e1..cd499a1bf 100644 --- a/docs/api/type-aliases/LiveKitVoiceDoneEvent.md +++ b/docs/api/type-aliases/LiveKitVoiceDoneEvent.md @@ -8,8 +8,6 @@ > **LiveKitVoiceDoneEvent** = `object` -Defined in: [types/livekit.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L305) - The current turn has finished. ## Properties @@ -18,16 +16,12 @@ The current turn has finished. > **type**: `"done"` -Defined in: [types/livekit.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L306) - --- ### data > **data**: `object` -Defined in: [types/livekit.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L307) - #### reason? > `optional` **reason?**: `string` diff --git a/docs/api/type-aliases/LiveKitVoiceEvent.md b/docs/api/type-aliases/LiveKitVoiceEvent.md index 04c198c41..4445e0d6c 100644 --- a/docs/api/type-aliases/LiveKitVoiceEvent.md +++ b/docs/api/type-aliases/LiveKitVoiceEvent.md @@ -8,6 +8,4 @@ > **LiveKitVoiceEvent** = [`LiveKitVoiceUserTextEvent`](LiveKitVoiceUserTextEvent.md) \| [`LiveKitVoiceTextEvent`](LiveKitVoiceTextEvent.md) \| [`LiveKitVoiceToolStartEvent`](LiveKitVoiceToolStartEvent.md) \| [`LiveKitVoiceToolResultEvent`](LiveKitVoiceToolResultEvent.md) \| [`LiveKitVoiceStatusEvent`](LiveKitVoiceStatusEvent.md) \| [`LiveKitVoiceHitlPromptEvent`](LiveKitVoiceHitlPromptEvent.md) \| [`LiveKitVoiceDoneEvent`](LiveKitVoiceDoneEvent.md) -Defined in: [types/livekit.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L311) - Discriminated union of all outbound voice events (before enveloping). diff --git a/docs/api/type-aliases/LiveKitVoiceEventEnvelope.md b/docs/api/type-aliases/LiveKitVoiceEventEnvelope.md index b30fb4862..894b11b5b 100644 --- a/docs/api/type-aliases/LiveKitVoiceEventEnvelope.md +++ b/docs/api/type-aliases/LiveKitVoiceEventEnvelope.md @@ -8,8 +8,6 @@ > **LiveKitVoiceEventEnvelope** = [`LiveKitVoiceEvent`](LiveKitVoiceEvent.md) & `object` -Defined in: [types/livekit.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L324) - Wire format published to the browser: a `LiveKitVoiceEvent` plus a monotonic sequence number and a timestamp so the client can order and de-duplicate. diff --git a/docs/api/type-aliases/LiveKitVoiceEventType.md b/docs/api/type-aliases/LiveKitVoiceEventType.md index bd65c1198..67d7a6945 100644 --- a/docs/api/type-aliases/LiveKitVoiceEventType.md +++ b/docs/api/type-aliases/LiveKitVoiceEventType.md @@ -8,6 +8,4 @@ > **LiveKitVoiceEventType** = `"user-text"` \| `"text"` \| `"tool-start"` \| `"tool-result"` \| `"status"` \| `"hitl-prompt"` \| `"done"` -Defined in: [types/livekit.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L231) - Discriminant tags for outbound voice events. diff --git a/docs/api/type-aliases/LiveKitVoiceHitlPromptEvent.md b/docs/api/type-aliases/LiveKitVoiceHitlPromptEvent.md index cf9ad497f..124416ced 100644 --- a/docs/api/type-aliases/LiveKitVoiceHitlPromptEvent.md +++ b/docs/api/type-aliases/LiveKitVoiceHitlPromptEvent.md @@ -8,8 +8,6 @@ > **LiveKitVoiceHitlPromptEvent** = `object` -Defined in: [types/livekit.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L292) - A human-in-the-loop confirmation the user must approve or reject. ## Properties @@ -18,16 +16,12 @@ A human-in-the-loop confirmation the user must approve or reject. > **type**: `"hitl-prompt"` -Defined in: [types/livekit.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L293) - --- ### data > **data**: `object` -Defined in: [types/livekit.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L294) - #### confirmationId > **confirmationId**: `string` diff --git a/docs/api/type-aliases/LiveKitVoiceStatusEvent.md b/docs/api/type-aliases/LiveKitVoiceStatusEvent.md index a7b4d5d13..dc6899459 100644 --- a/docs/api/type-aliases/LiveKitVoiceStatusEvent.md +++ b/docs/api/type-aliases/LiveKitVoiceStatusEvent.md @@ -8,8 +8,6 @@ > **LiveKitVoiceStatusEvent** = `object` -Defined in: [types/livekit.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L283) - Coarse agent state, useful for UI indicators (e.g. "thinking…"). ## Properties @@ -18,16 +16,12 @@ Coarse agent state, useful for UI indicators (e.g. "thinking…"). > **type**: `"status"` -Defined in: [types/livekit.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L284) - --- ### data > **data**: `object` -Defined in: [types/livekit.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L285) - #### state > **state**: `"thinking"` \| `"speaking"` \| `"listening"` \| `"error"` diff --git a/docs/api/type-aliases/LiveKitVoiceTextEvent.md b/docs/api/type-aliases/LiveKitVoiceTextEvent.md index 22073966c..93be9efc7 100644 --- a/docs/api/type-aliases/LiveKitVoiceTextEvent.md +++ b/docs/api/type-aliases/LiveKitVoiceTextEvent.md @@ -8,8 +8,6 @@ > **LiveKitVoiceTextEvent** = `object` -Defined in: [types/livekit.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L256) - A streamed chunk of the assistant's spoken/written reply. ## Properties @@ -18,16 +16,12 @@ A streamed chunk of the assistant's spoken/written reply. > **type**: `"text"` -Defined in: [types/livekit.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L257) - --- ### data > **data**: `object` -Defined in: [types/livekit.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L258) - #### delta > **delta**: `string` diff --git a/docs/api/type-aliases/LiveKitVoiceToolResultEvent.md b/docs/api/type-aliases/LiveKitVoiceToolResultEvent.md index d2423cc70..11d89ef77 100644 --- a/docs/api/type-aliases/LiveKitVoiceToolResultEvent.md +++ b/docs/api/type-aliases/LiveKitVoiceToolResultEvent.md @@ -8,8 +8,6 @@ > **LiveKitVoiceToolResultEvent** = `object` -Defined in: [types/livekit.ts:271](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L271) - A tool invocation has finished. `result` carries the tool's structured output (for example, a chart payload) for the client to render. @@ -19,16 +17,12 @@ output (for example, a chart payload) for the client to render. > **type**: `"tool-result"` -Defined in: [types/livekit.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L272) - --- ### data > **data**: `object` -Defined in: [types/livekit.ts:273](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L273) - #### id? > `optional` **id?**: `string` diff --git a/docs/api/type-aliases/LiveKitVoiceToolStartEvent.md b/docs/api/type-aliases/LiveKitVoiceToolStartEvent.md index 0ffad50b1..e90a0b924 100644 --- a/docs/api/type-aliases/LiveKitVoiceToolStartEvent.md +++ b/docs/api/type-aliases/LiveKitVoiceToolStartEvent.md @@ -8,8 +8,6 @@ > **LiveKitVoiceToolStartEvent** = `object` -Defined in: [types/livekit.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L262) - A tool invocation has started (best-effort status; may not always fire). ## Properties @@ -18,16 +16,12 @@ A tool invocation has started (best-effort status; may not always fire). > **type**: `"tool-start"` -Defined in: [types/livekit.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L263) - --- ### data > **data**: `object` -Defined in: [types/livekit.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L264) - #### id? > `optional` **id?**: `string` diff --git a/docs/api/type-aliases/LiveKitVoiceUserTextEvent.md b/docs/api/type-aliases/LiveKitVoiceUserTextEvent.md index ae0c84d1d..905478745 100644 --- a/docs/api/type-aliases/LiveKitVoiceUserTextEvent.md +++ b/docs/api/type-aliases/LiveKitVoiceUserTextEvent.md @@ -8,8 +8,6 @@ > **LiveKitVoiceUserTextEvent** = `object` -Defined in: [types/livekit.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L250) - A user STT transcript for display. Interim partials stream with `final: false`; the end-of-utterance result has `final: true`. The client updates one live bubble and commits it on `final`. @@ -25,16 +23,12 @@ so the merged utterance shows as one bubble. > **type**: `"user-text"` -Defined in: [types/livekit.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L251) - --- ### data > **data**: `object` -Defined in: [types/livekit.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L252) - #### text > **text**: `string` diff --git a/docs/api/type-aliases/LiveKitWorkerLaunchOptions.md b/docs/api/type-aliases/LiveKitWorkerLaunchOptions.md index af2b36a88..346ef3781 100644 --- a/docs/api/type-aliases/LiveKitWorkerLaunchOptions.md +++ b/docs/api/type-aliases/LiveKitWorkerLaunchOptions.md @@ -8,8 +8,6 @@ > **LiveKitWorkerLaunchOptions** = `object` -Defined in: [types/livekit.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L190) - Options for `startVoiceAgentWorker` — launches the LiveKit Agents worker. ## Properties @@ -18,8 +16,6 @@ Options for `startVoiceAgentWorker` — launches the LiveKit Agents worker. > **agentFile**: `string` -Defined in: [types/livekit.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L195) - Absolute path to the entry file whose default export is the result of `defineVoiceAgent`. LiveKit re-imports this file in each job process. @@ -29,6 +25,4 @@ Absolute path to the entry file whose default export is the result of > `optional` **agentName?**: `string` -Defined in: [types/livekit.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/livekit.ts#L197) - Name the worker registers under for dispatch (default "neurolink-voice"). diff --git a/docs/api/type-aliases/LiveServerContent.md b/docs/api/type-aliases/LiveServerContent.md index 2c30afcdc..c6abde60f 100644 --- a/docs/api/type-aliases/LiveServerContent.md +++ b/docs/api/type-aliases/LiveServerContent.md @@ -8,8 +8,6 @@ > **LiveServerContent** = `object` -Defined in: [types/providers.ts:1171](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1171) - Live server content structure ## Properties @@ -18,12 +16,8 @@ Live server content structure > `optional` **modelTurn?**: [`LiveServerMessageModelTurn`](LiveServerMessageModelTurn.md) -Defined in: [types/providers.ts:1172](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1172) - --- ### interrupted? > `optional` **interrupted?**: `boolean` - -Defined in: [types/providers.ts:1173](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1173) diff --git a/docs/api/type-aliases/LiveServerMessage.md b/docs/api/type-aliases/LiveServerMessage.md index 4c615d592..d64318553 100644 --- a/docs/api/type-aliases/LiveServerMessage.md +++ b/docs/api/type-aliases/LiveServerMessage.md @@ -8,8 +8,6 @@ > **LiveServerMessage** = `object` -Defined in: [types/providers.ts:1179](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1179) - Live server message structure ## Properties @@ -17,5 +15,3 @@ Live server message structure ### serverContent? > `optional` **serverContent?**: [`LiveServerContent`](LiveServerContent.md) - -Defined in: [types/providers.ts:1180](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1180) diff --git a/docs/api/type-aliases/LiveServerMessageModelTurn.md b/docs/api/type-aliases/LiveServerMessageModelTurn.md index 54d9d2e0d..0e8fed647 100644 --- a/docs/api/type-aliases/LiveServerMessageModelTurn.md +++ b/docs/api/type-aliases/LiveServerMessageModelTurn.md @@ -8,8 +8,6 @@ > **LiveServerMessageModelTurn** = `object` -Defined in: [types/providers.ts:1164](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1164) - Live server message model turn ## Properties @@ -18,8 +16,6 @@ Live server message model turn > `optional` **parts?**: `object`[] -Defined in: [types/providers.ts:1165](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1165) - #### inlineData? > `optional` **inlineData?**: [`LiveServerMessagePartInlineData`](LiveServerMessagePartInlineData.md) diff --git a/docs/api/type-aliases/LiveServerMessagePartInlineData.md b/docs/api/type-aliases/LiveServerMessagePartInlineData.md index 8a31609f6..028b0a009 100644 --- a/docs/api/type-aliases/LiveServerMessagePartInlineData.md +++ b/docs/api/type-aliases/LiveServerMessagePartInlineData.md @@ -8,8 +8,6 @@ > **LiveServerMessagePartInlineData** = `object` -Defined in: [types/providers.ts:1157](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1157) - Live server message inline data ## Properties @@ -17,5 +15,3 @@ Live server message inline data ### data? > `optional` **data?**: `string` - -Defined in: [types/providers.ts:1158](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1158) diff --git a/docs/api/type-aliases/LoadBalancingStrategy.md b/docs/api/type-aliases/LoadBalancingStrategy.md index c19ac2464..291ec87da 100644 --- a/docs/api/type-aliases/LoadBalancingStrategy.md +++ b/docs/api/type-aliases/LoadBalancingStrategy.md @@ -8,6 +8,4 @@ > **LoadBalancingStrategy** = `"round-robin"` \| `"least-loaded"` \| `"random"` \| `"weighted"` \| `"failover-only"` -Defined in: [types/mcp.ts:1790](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1790) - Load balancing strategies diff --git a/docs/api/type-aliases/LoadProxyConfigOptions.md b/docs/api/type-aliases/LoadProxyConfigOptions.md index dc99e64fa..795347218 100644 --- a/docs/api/type-aliases/LoadProxyConfigOptions.md +++ b/docs/api/type-aliases/LoadProxyConfigOptions.md @@ -8,8 +8,6 @@ > **LoadProxyConfigOptions** = `object` -Defined in: [types/proxy.ts:537](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L537) - Options for loadProxyConfig. ## Properties @@ -18,8 +16,6 @@ Options for loadProxyConfig. > `optional` **resolveEnv?**: `boolean` -Defined in: [types/proxy.ts:539](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L539) - Resolve environment variables in string values (default: true) --- @@ -28,6 +24,4 @@ Resolve environment variables in string values (default: true) > `optional` **env?**: `Record`\<`string`, `string` \| `undefined`\> -Defined in: [types/proxy.ts:541](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L541) - Custom environment object (defaults to process.env) diff --git a/docs/api/type-aliases/LoadedClaudeAccountContext.md b/docs/api/type-aliases/LoadedClaudeAccountContext.md index 3ba65b9ee..53bea1ada 100644 --- a/docs/api/type-aliases/LoadedClaudeAccountContext.md +++ b/docs/api/type-aliases/LoadedClaudeAccountContext.md @@ -8,84 +8,62 @@ > **LoadedClaudeAccountContext** = `object` -Defined in: [types/proxy.ts:1352](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1352) - ## Properties ### accounts > **accounts**: [`ProxyPassthroughAccount`](ProxyPassthroughAccount.md)[] -Defined in: [types/proxy.ts:1353](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1353) - --- ### enabledAccounts > **enabledAccounts**: [`ProxyPassthroughAccount`](ProxyPassthroughAccount.md)[] -Defined in: [types/proxy.ts:1354](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1354) - --- ### orderedAccounts > **orderedAccounts**: [`ProxyPassthroughAccount`](ProxyPassthroughAccount.md)[] -Defined in: [types/proxy.ts:1355](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1355) - --- ### bodyStr > **bodyStr**: `string` -Defined in: [types/proxy.ts:1356](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1356) - --- ### requestStart > **requestStart**: `number` -Defined in: [types/proxy.ts:1357](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1357) - --- ### toolCount > **toolCount**: `number` -Defined in: [types/proxy.ts:1358](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1358) - --- ### url > **url**: `string` -Defined in: [types/proxy.ts:1359](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1359) - --- ### clientHeaders > **clientHeaders**: `Record`\<`string`, `string` \| `undefined`\> -Defined in: [types/proxy.ts:1360](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1360) - --- ### isClaudeClientRequest > **isClaudeClientRequest**: `boolean` -Defined in: [types/proxy.ts:1361](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1361) - --- ### sessionId? > `optional` **sessionId?**: `string` - -Defined in: [types/proxy.ts:1362](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1362) diff --git a/docs/api/type-aliases/LoadedProxyConfig.md b/docs/api/type-aliases/LoadedProxyConfig.md index 45568c5bb..69ff42a22 100644 --- a/docs/api/type-aliases/LoadedProxyConfig.md +++ b/docs/api/type-aliases/LoadedProxyConfig.md @@ -8,8 +8,6 @@ > **LoadedProxyConfig** = `object` -Defined in: [types/proxy.ts:3737](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3737) - Partial proxy config consumed by the start command. ## Properties @@ -18,8 +16,6 @@ Partial proxy config consumed by the start command. > `optional` **routing?**: `Partial`\<[`ProxyModelRouterConfig`](ProxyModelRouterConfig.md)\> & `object` -Defined in: [types/proxy.ts:3738](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3738) - #### Type Declaration ##### strategy? diff --git a/docs/api/type-aliases/LoaderOptions.md b/docs/api/type-aliases/LoaderOptions.md index 56e778425..881afa347 100644 --- a/docs/api/type-aliases/LoaderOptions.md +++ b/docs/api/type-aliases/LoaderOptions.md @@ -8,8 +8,6 @@ > **LoaderOptions** = `object` -Defined in: [types/rag.ts:581](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L581) - Document loader options ## Properties @@ -18,8 +16,6 @@ Document loader options > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:583](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L583) - Custom metadata to add to document --- @@ -28,8 +24,6 @@ Custom metadata to add to document > `optional` **encoding?**: `BufferEncoding` -Defined in: [types/rag.ts:585](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L585) - Encoding for text files --- @@ -38,6 +32,4 @@ Encoding for text files > `optional` **type?**: [`DocumentType`](DocumentType.md) -Defined in: [types/rag.ts:587](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L587) - Document type override diff --git a/docs/api/type-aliases/LocalUsageAggregateOptions.md b/docs/api/type-aliases/LocalUsageAggregateOptions.md index 009a91f58..85c99a993 100644 --- a/docs/api/type-aliases/LocalUsageAggregateOptions.md +++ b/docs/api/type-aliases/LocalUsageAggregateOptions.md @@ -8,8 +8,6 @@ > **LocalUsageAggregateOptions** = [`LocalUsageScanOptions`](LocalUsageScanOptions.md) & `object` -Defined in: [types/localUsage.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L441) - Options for scanning every registered reader at once. `only` is not a convenience filter applied to the results — it decides which diff --git a/docs/api/type-aliases/LocalUsageAggregateReport.md b/docs/api/type-aliases/LocalUsageAggregateReport.md index c4a30fb7f..b47b1148f 100644 --- a/docs/api/type-aliases/LocalUsageAggregateReport.md +++ b/docs/api/type-aliases/LocalUsageAggregateReport.md @@ -8,8 +8,6 @@ > **LocalUsageAggregateReport** = `object` -Defined in: [types/localUsage.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L229) - Top-level output of scanning every registered, detected reader. ## Properties @@ -18,16 +16,12 @@ Top-level output of scanning every registered, detected reader. > **generatedAt**: `string` -Defined in: [types/localUsage.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L230) - --- ### totals > **totals**: `Partial`\<`Record`\<[`LocalUsageCliId`](LocalUsageCliId.md), [`LocalUsageTotals`](LocalUsageTotals.md)\>\> -Defined in: [types/localUsage.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L232) - Only CLIs whose store was detected AND scanned appear here. --- @@ -36,8 +30,6 @@ Only CLIs whose store was detected AND scanned appear here. > **failures**: [`LocalUsageReaderFailure`](LocalUsageReaderFailure.md)[] -Defined in: [types/localUsage.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L234) - CLIs whose reader could not be created, detected, or scanned, and why. --- @@ -46,8 +38,6 @@ CLIs whose reader could not be created, detected, or scanned, and why. > **scanErrors**: [`LocalUsageScanError`](LocalUsageScanError.md)[] -Defined in: [types/localUsage.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L243) - Per-file problems from readers that otherwise succeeded. Distinct from `failures`, which is a reader that threw. A scan can read @@ -61,6 +51,4 @@ always collected these — nothing consumed them until now. > **notInstalled**: [`LocalUsageCliId`](LocalUsageCliId.md)[] -Defined in: [types/localUsage.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L245) - CLIs with no local store on this machine — absent, not failed. diff --git a/docs/api/type-aliases/LocalUsageClaudeRawUsage.md b/docs/api/type-aliases/LocalUsageClaudeRawUsage.md index 9d0b9d6d9..69705fc07 100644 --- a/docs/api/type-aliases/LocalUsageClaudeRawUsage.md +++ b/docs/api/type-aliases/LocalUsageClaudeRawUsage.md @@ -8,8 +8,6 @@ > **LocalUsageClaudeRawUsage** = `object` -Defined in: [types/localUsage.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L253) - The `message.usage` object exactly as Claude Code writes it into a transcript line — snake_case, and every field optional because older transcripts predate some of them. @@ -20,28 +18,20 @@ transcripts predate some of them. > `optional` **input_tokens?**: `number` -Defined in: [types/localUsage.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L254) - --- ### output_tokens? > `optional` **output_tokens?**: `number` -Defined in: [types/localUsage.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L255) - --- ### cache_read_input_tokens? > `optional` **cache_read_input_tokens?**: `number` -Defined in: [types/localUsage.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L256) - --- ### cache_creation_input_tokens? > `optional` **cache_creation_input_tokens?**: `number` - -Defined in: [types/localUsage.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L257) diff --git a/docs/api/type-aliases/LocalUsageCliId.md b/docs/api/type-aliases/LocalUsageCliId.md index ff5fac452..8ade71908 100644 --- a/docs/api/type-aliases/LocalUsageCliId.md +++ b/docs/api/type-aliases/LocalUsageCliId.md @@ -8,8 +8,6 @@ > **LocalUsageCliId** = `"claude-code"` \| `"codex"` \| `"gemini-cli"` \| `"opencode"` \| `"qwen-code"` \| `"copilot"` \| `"copilot-cli"` \| `"cursor"` \| `"grok"` \| `"hermes"` \| `"amp"` \| `"kiro"` \| `"antigravity"` -Defined in: [types/localUsage.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L19) - Stable identifier for one CLI this subsystem can read local usage from. Kebab-case, matching `CliProxyClientConfigurator.id`'s convention — a different registry, but the same repo-wide convention for CLI identifiers. diff --git a/docs/api/type-aliases/LocalUsageCodexSessionRollup.md b/docs/api/type-aliases/LocalUsageCodexSessionRollup.md index 5e22477ad..f31a64ec5 100644 --- a/docs/api/type-aliases/LocalUsageCodexSessionRollup.md +++ b/docs/api/type-aliases/LocalUsageCodexSessionRollup.md @@ -8,8 +8,6 @@ > **LocalUsageCodexSessionRollup** = `object` -Defined in: [types/localUsage.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L266) - One Codex rollout reduced to its session-level totals. The token figures here are the session's CUMULATIVE counter, not a sum of @@ -21,38 +19,28 @@ per-turn values — see `codexReader.ts` for why summing overstates by ~63%. > `optional` **model?**: `string` -Defined in: [types/localUsage.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L267) - --- ### input > **input**: `number` -Defined in: [types/localUsage.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L268) - --- ### output > **output**: `number` -Defined in: [types/localUsage.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L269) - --- ### cached > **cached**: `number` -Defined in: [types/localUsage.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L270) - --- ### billableEvents > **billableEvents**: `number` -Defined in: [types/localUsage.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L272) - token_count events where the cumulative total actually advanced. diff --git a/docs/api/type-aliases/LocalUsageCommandArgs.md b/docs/api/type-aliases/LocalUsageCommandArgs.md index 81a93e58e..9a9a6706f 100644 --- a/docs/api/type-aliases/LocalUsageCommandArgs.md +++ b/docs/api/type-aliases/LocalUsageCommandArgs.md @@ -8,8 +8,6 @@ > **LocalUsageCommandArgs** = `object` -Defined in: [types/localUsage.ts:427](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L427) - Arguments for the `neurolink usage local` command. ## Properties @@ -18,20 +16,14 @@ Arguments for the `neurolink usage local` command. > **since**: `number` -Defined in: [types/localUsage.ts:428](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L428) - --- ### json > **json**: `boolean` -Defined in: [types/localUsage.ts:429](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L429) - --- ### cli? > `optional` **cli?**: `string` - -Defined in: [types/localUsage.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L430) diff --git a/docs/api/type-aliases/LocalUsageContextPart.md b/docs/api/type-aliases/LocalUsageContextPart.md index 4648b396f..b4b960973 100644 --- a/docs/api/type-aliases/LocalUsageContextPart.md +++ b/docs/api/type-aliases/LocalUsageContextPart.md @@ -8,8 +8,6 @@ > **LocalUsageContextPart** = `object` -Defined in: [types/localUsage.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L413) - One entry in Cursor's context breakdown — `system_prompt`, `tools`, `rules` and friends — carrying the token count that entry occupies in context. @@ -19,12 +17,8 @@ and friends — carrying the token count that entry occupies in context. > **name**: `string` -Defined in: [types/localUsage.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L413) - --- ### tokens > **tokens**: `number` - -Defined in: [types/localUsage.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L413) diff --git a/docs/api/type-aliases/LocalUsageCopilotUsageRow.md b/docs/api/type-aliases/LocalUsageCopilotUsageRow.md index c693eae76..7737122c1 100644 --- a/docs/api/type-aliases/LocalUsageCopilotUsageRow.md +++ b/docs/api/type-aliases/LocalUsageCopilotUsageRow.md @@ -8,8 +8,6 @@ > **LocalUsageCopilotUsageRow** = `object` -Defined in: [types/localUsage.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L324) - One row of Copilot CLI's `assistant_usage_events` SQLite table, restricted to the columns `copilotCliReader.ts` actually reads. `cache_read_tokens` and `cache_write_tokens` are both subsets of `input_tokens` — see that @@ -21,52 +19,38 @@ reader's module header for the arithmetic proof. > **model**: `string` \| `null` -Defined in: [types/localUsage.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L325) - --- ### input_tokens > **input_tokens**: `number` \| `null` -Defined in: [types/localUsage.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L326) - --- ### output_tokens > **output_tokens**: `number` \| `null` -Defined in: [types/localUsage.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L327) - --- ### cache_read_tokens > **cache_read_tokens**: `number` \| `null` -Defined in: [types/localUsage.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L328) - --- ### cache_write_tokens > **cache_write_tokens**: `number` \| `null` -Defined in: [types/localUsage.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L329) - --- ### reasoning_tokens > **reasoning_tokens**: `number` \| `null` -Defined in: [types/localUsage.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L330) - --- ### created_at > **created_at**: `string` \| `null` - -Defined in: [types/localUsage.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L331) diff --git a/docs/api/type-aliases/LocalUsageCostConfidence.md b/docs/api/type-aliases/LocalUsageCostConfidence.md index 8a50d47b1..db0f31e5f 100644 --- a/docs/api/type-aliases/LocalUsageCostConfidence.md +++ b/docs/api/type-aliases/LocalUsageCostConfidence.md @@ -8,8 +8,6 @@ > **LocalUsageCostConfidence** = `"modeled"` \| `"unavailable"` \| `"heuristic"` -Defined in: [types/localUsage.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L100) - How much to trust a computed cost figure. Not decoration: some CLIs are flat-rate subscriptions where a per-request diff --git a/docs/api/type-aliases/LocalUsageDedupStrategy.md b/docs/api/type-aliases/LocalUsageDedupStrategy.md index 6b3b8ed09..38f9409c5 100644 --- a/docs/api/type-aliases/LocalUsageDedupStrategy.md +++ b/docs/api/type-aliases/LocalUsageDedupStrategy.md @@ -8,8 +8,6 @@ > **LocalUsageDedupStrategy** = `"message-id-keep-max"` \| `"last-write-wins"` \| `"rowid-high-water-mark"` \| `"session-dag"` -Defined in: [types/localUsage.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L108) - How a reader avoids counting the same turn twice. Metadata on the descriptor, for introspection and for the person writing the diff --git a/docs/api/type-aliases/LocalUsageGeminiCliTokens.md b/docs/api/type-aliases/LocalUsageGeminiCliTokens.md index e909389d2..96857cbe2 100644 --- a/docs/api/type-aliases/LocalUsageGeminiCliTokens.md +++ b/docs/api/type-aliases/LocalUsageGeminiCliTokens.md @@ -8,8 +8,6 @@ > **LocalUsageGeminiCliTokens** = `object` -Defined in: [types/localUsage.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L297) - The `tokens` object exactly as Gemini CLI writes it onto a `type: "gemini"` message record — mapped straight from the GenAI response's own `usageMetadata` by the CLI's own `recordMessageTokens()`. See @@ -22,44 +20,32 @@ than added, and why `thoughts`/`tool` fold into output. > `optional` **input?**: `number` -Defined in: [types/localUsage.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L298) - --- ### output? > `optional` **output?**: `number` -Defined in: [types/localUsage.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L299) - --- ### cached? > `optional` **cached?**: `number` -Defined in: [types/localUsage.ts:300](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L300) - --- ### thoughts? > `optional` **thoughts?**: `number` -Defined in: [types/localUsage.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L301) - --- ### tool? > `optional` **tool?**: `number` -Defined in: [types/localUsage.ts:302](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L302) - --- ### total? > `optional` **total?**: `number` - -Defined in: [types/localUsage.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L303) diff --git a/docs/api/type-aliases/LocalUsageGeminiMessageRecord.md b/docs/api/type-aliases/LocalUsageGeminiMessageRecord.md index 4aac2ff41..79a127d53 100644 --- a/docs/api/type-aliases/LocalUsageGeminiMessageRecord.md +++ b/docs/api/type-aliases/LocalUsageGeminiMessageRecord.md @@ -8,8 +8,6 @@ > **LocalUsageGeminiMessageRecord** = `object` -Defined in: [types/localUsage.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L311) - A `type: "gemini"` message record as read out of a chat transcript line — whether it arrived bare-appended or unwrapped from a `$set.messages[]` bootstrap entry. See `geminiCliReader.ts` for both shapes. @@ -20,28 +18,20 @@ bootstrap entry. See `geminiCliReader.ts` for both shapes. > `optional` **id?**: `string` -Defined in: [types/localUsage.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L312) - --- ### type? > `optional` **type?**: `string` -Defined in: [types/localUsage.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L313) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/localUsage.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L314) - --- ### tokens? > `optional` **tokens?**: [`LocalUsageGeminiCliTokens`](LocalUsageGeminiCliTokens.md) - -Defined in: [types/localUsage.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L315) diff --git a/docs/api/type-aliases/LocalUsageGrokTurn.md b/docs/api/type-aliases/LocalUsageGrokTurn.md index 137f94ced..329313c44 100644 --- a/docs/api/type-aliases/LocalUsageGrokTurn.md +++ b/docs/api/type-aliases/LocalUsageGrokTurn.md @@ -8,8 +8,6 @@ > **LocalUsageGrokTurn** = `object` -Defined in: [types/localUsage.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L382) - One Grok Build completed turn after validation: every count a finite, non-negative safe integer, and the `modelUsage` keys collected. `turns` is the ledger's `numTurns`, which decides whether the next record continues @@ -21,52 +19,38 @@ this process run or starts a fresh one — see `grokReader.ts`. > **input**: `number` -Defined in: [types/localUsage.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L383) - --- ### output > **output**: `number` -Defined in: [types/localUsage.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L384) - --- ### cacheRead > **cacheRead**: `number` -Defined in: [types/localUsage.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L385) - --- ### cacheCreation > **cacheCreation**: `number` -Defined in: [types/localUsage.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L386) - --- ### calls > **calls**: `number` -Defined in: [types/localUsage.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L387) - --- ### turns > **turns**: `number` -Defined in: [types/localUsage.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L388) - --- ### models > **models**: `string`[] - -Defined in: [types/localUsage.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L389) diff --git a/docs/api/type-aliases/LocalUsageGrokTurnUsage.md b/docs/api/type-aliases/LocalUsageGrokTurnUsage.md index daeddf307..fe554ce60 100644 --- a/docs/api/type-aliases/LocalUsageGrokTurnUsage.md +++ b/docs/api/type-aliases/LocalUsageGrokTurnUsage.md @@ -8,8 +8,6 @@ > **LocalUsageGrokTurnUsage** = `object` -Defined in: [types/localUsage.ts:365](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L365) - The `usage` object on a Grok Build `turn_completed` session update, as appended to a session's `updates.jsonl`. camelCase, from the CLI's own serde definitions and confirmed on a real run. `modelUsage` holds the same @@ -23,60 +21,44 @@ is how a reader tells a cumulative run from a fresh one — see > `optional` **inputTokens?**: `number` -Defined in: [types/localUsage.ts:366](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L366) - --- ### outputTokens? > `optional` **outputTokens?**: `number` -Defined in: [types/localUsage.ts:367](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L367) - --- ### cachedReadTokens? > `optional` **cachedReadTokens?**: `number` -Defined in: [types/localUsage.ts:368](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L368) - --- ### cacheCreationTokens? > `optional` **cacheCreationTokens?**: `number` -Defined in: [types/localUsage.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L369) - --- ### reasoningTokens? > `optional` **reasoningTokens?**: `number` -Defined in: [types/localUsage.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L370) - --- ### modelCalls? > `optional` **modelCalls?**: `number` -Defined in: [types/localUsage.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L371) - --- ### numTurns? > `optional` **numTurns?**: `number` -Defined in: [types/localUsage.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L372) - --- ### modelUsage? > `optional` **modelUsage?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/localUsage.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L373) diff --git a/docs/api/type-aliases/LocalUsageHermesUsageRow.md b/docs/api/type-aliases/LocalUsageHermesUsageRow.md index 2ded57212..134693827 100644 --- a/docs/api/type-aliases/LocalUsageHermesUsageRow.md +++ b/docs/api/type-aliases/LocalUsageHermesUsageRow.md @@ -8,8 +8,6 @@ > **LocalUsageHermesUsageRow** = `object` -Defined in: [types/localUsage.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L342) - One usage row as this subsystem reads it out of Hermes Agent's `state.db` — either a `session_model_usage` row, or a `sessions` row projected onto the same columns for a session that predates that table. Every column but the @@ -23,92 +21,68 @@ epoch SECONDS, coalesced from whichever timestamp the schema has. > **session_id**: `string` -Defined in: [types/localUsage.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L343) - --- ### model > **model**: `string` \| `null` -Defined in: [types/localUsage.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L344) - --- ### api_call_count > **api_call_count**: `number` \| `null` -Defined in: [types/localUsage.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L345) - --- ### input_tokens > **input_tokens**: `number` \| `null` -Defined in: [types/localUsage.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L346) - --- ### output_tokens > **output_tokens**: `number` \| `null` -Defined in: [types/localUsage.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L347) - --- ### cache_read_tokens? > `optional` **cache_read_tokens?**: `number` \| `null` -Defined in: [types/localUsage.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L348) - --- ### cache_write_tokens? > `optional` **cache_write_tokens?**: `number` \| `null` -Defined in: [types/localUsage.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L349) - --- ### reasoning_tokens? > `optional` **reasoning_tokens?**: `number` \| `null` -Defined in: [types/localUsage.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L350) - --- ### estimated_cost_usd? > `optional` **estimated_cost_usd?**: `number` \| `null` -Defined in: [types/localUsage.ts:351](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L351) - --- ### actual_cost_usd? > `optional` **actual_cost_usd?**: `number` \| `null` -Defined in: [types/localUsage.ts:352](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L352) - --- ### cost_status? > `optional` **cost_status?**: `string` \| `null` -Defined in: [types/localUsage.ts:353](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L353) - --- ### at? > `optional` **at?**: `number` \| `null` - -Defined in: [types/localUsage.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L354) diff --git a/docs/api/type-aliases/LocalUsageQwenRawUsage.md b/docs/api/type-aliases/LocalUsageQwenRawUsage.md index 091f49f9f..1ab0acbd8 100644 --- a/docs/api/type-aliases/LocalUsageQwenRawUsage.md +++ b/docs/api/type-aliases/LocalUsageQwenRawUsage.md @@ -8,8 +8,6 @@ > **LocalUsageQwenRawUsage** = `object` -Defined in: [types/localUsage.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L282) - The `usageMetadata` object exactly as Qwen Code writes it into a transcript line — Google GenAI's `usageMetadata` shape, camelCase, every field optional because not every assistant record carries one. See @@ -22,36 +20,26 @@ optional because not every assistant record carries one. See > `optional` **promptTokenCount?**: `number` -Defined in: [types/localUsage.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L283) - --- ### candidatesTokenCount? > `optional` **candidatesTokenCount?**: `number` -Defined in: [types/localUsage.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L284) - --- ### thoughtsTokenCount? > `optional` **thoughtsTokenCount?**: `number` -Defined in: [types/localUsage.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L285) - --- ### totalTokenCount? > `optional` **totalTokenCount?**: `number` -Defined in: [types/localUsage.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L286) - --- ### cachedContentTokenCount? > `optional` **cachedContentTokenCount?**: `number` - -Defined in: [types/localUsage.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L287) diff --git a/docs/api/type-aliases/LocalUsageReader.md b/docs/api/type-aliases/LocalUsageReader.md index 8997a6ffb..01e3b6949 100644 --- a/docs/api/type-aliases/LocalUsageReader.md +++ b/docs/api/type-aliases/LocalUsageReader.md @@ -8,8 +8,6 @@ > **LocalUsageReader** = `object` -Defined in: [types/localUsage.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L200) - The contract every reader implements — one per CLI. ## Properties @@ -18,16 +16,12 @@ The contract every reader implements — one per CLI. > **descriptor**: [`LocalUsageReaderDescriptor`](LocalUsageReaderDescriptor.md) -Defined in: [types/localUsage.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L201) - --- ### detect > **detect**: () => `Promise`\<`boolean`\> -Defined in: [types/localUsage.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L207) - Whether this CLI's local store appears to exist on this machine at all — the same "do not report on something never installed" discipline the proxy client configurators use before writing a config. @@ -42,8 +36,6 @@ client configurators use before writing a config. > **scan**: (`options?`) => `Promise`\<[`LocalUsageScanResult`](LocalUsageScanResult.md)\> -Defined in: [types/localUsage.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L208) - #### Parameters ##### options? diff --git a/docs/api/type-aliases/LocalUsageReaderDescriptor.md b/docs/api/type-aliases/LocalUsageReaderDescriptor.md index 3262457a6..b62ae4c6e 100644 --- a/docs/api/type-aliases/LocalUsageReaderDescriptor.md +++ b/docs/api/type-aliases/LocalUsageReaderDescriptor.md @@ -8,8 +8,6 @@ > **LocalUsageReaderDescriptor** = `object` -Defined in: [types/localUsage.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L167) - Static metadata, available without constructing a reader. ## Properties @@ -18,24 +16,18 @@ Static metadata, available without constructing a reader. > **id**: [`LocalUsageCliId`](LocalUsageCliId.md) -Defined in: [types/localUsage.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L168) - --- ### displayName > **displayName**: `string` -Defined in: [types/localUsage.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L169) - --- ### verified > **verified**: `boolean` -Defined in: [types/localUsage.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L175) - True only for readers checked against real data on a real machine. An honesty marker, not a completeness claim — an unverified reader may still be correct, it just has not been shown to be. @@ -46,24 +38,18 @@ be correct, it just has not been shown to be. > **dedupStrategy**: [`LocalUsageDedupStrategy`](LocalUsageDedupStrategy.md) -Defined in: [types/localUsage.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L176) - --- ### costConfidence > **costConfidence**: [`LocalUsageCostConfidence`](LocalUsageCostConfidence.md) -Defined in: [types/localUsage.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L177) - --- ### requiresSqlite > **requiresSqlite**: `boolean` -Defined in: [types/localUsage.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L179) - Whether reading this CLI's store needs a SQLite binding. --- @@ -72,7 +58,5 @@ Whether reading this CLI's store needs a SQLite binding. > `optional` **requestUnit?**: [`LocalUsageRequestUnit`](LocalUsageRequestUnit.md) -Defined in: [types/localUsage.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L184) - What `LocalUsageTotals.requests` counts for this reader. Absent means "turn", which is what every reader except Cursor records. diff --git a/docs/api/type-aliases/LocalUsageReaderFactoryFn.md b/docs/api/type-aliases/LocalUsageReaderFactoryFn.md index 5fa086085..70f30226c 100644 --- a/docs/api/type-aliases/LocalUsageReaderFactoryFn.md +++ b/docs/api/type-aliases/LocalUsageReaderFactoryFn.md @@ -8,8 +8,6 @@ > **LocalUsageReaderFactoryFn** = () => `Promise`\<[`LocalUsageReader`](LocalUsageReader.md)\> -Defined in: [types/localUsage.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L213) - Async factory stored in the registry — a reader needs no credentials, only the filesystem, so this takes no arguments. diff --git a/docs/api/type-aliases/LocalUsageReaderFailure.md b/docs/api/type-aliases/LocalUsageReaderFailure.md index b11daa2e9..b9c1b7525 100644 --- a/docs/api/type-aliases/LocalUsageReaderFailure.md +++ b/docs/api/type-aliases/LocalUsageReaderFailure.md @@ -8,8 +8,6 @@ > **LocalUsageReaderFailure** = `object` -Defined in: [types/localUsage.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L223) - A whole reader failing — not installed, or threw — so the aggregate report can carry successes and failures side by side rather than losing both. @@ -19,12 +17,8 @@ can carry successes and failures side by side rather than losing both. > **cliId**: [`LocalUsageCliId`](LocalUsageCliId.md) -Defined in: [types/localUsage.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L224) - --- ### message > **message**: `string` - -Defined in: [types/localUsage.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L225) diff --git a/docs/api/type-aliases/LocalUsageReaderRegistration.md b/docs/api/type-aliases/LocalUsageReaderRegistration.md index b650f6f08..1948cb046 100644 --- a/docs/api/type-aliases/LocalUsageReaderRegistration.md +++ b/docs/api/type-aliases/LocalUsageReaderRegistration.md @@ -8,8 +8,6 @@ > **LocalUsageReaderRegistration** = `object` -Defined in: [types/localUsage.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L216) - One entry in the registry map. ## Properties @@ -18,12 +16,8 @@ One entry in the registry map. > **descriptor**: [`LocalUsageReaderDescriptor`](LocalUsageReaderDescriptor.md) -Defined in: [types/localUsage.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L217) - --- ### factory > **factory**: [`LocalUsageReaderFactoryFn`](LocalUsageReaderFactoryFn.md) - -Defined in: [types/localUsage.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L218) diff --git a/docs/api/type-aliases/LocalUsageRequestUnit.md b/docs/api/type-aliases/LocalUsageRequestUnit.md index e6b3c3ca7..0f5ad7686 100644 --- a/docs/api/type-aliases/LocalUsageRequestUnit.md +++ b/docs/api/type-aliases/LocalUsageRequestUnit.md @@ -8,8 +8,6 @@ > **LocalUsageRequestUnit** = `"turn"` \| `"session-snapshot"` -Defined in: [types/localUsage.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L128) - What one unit of `LocalUsageTotals.requests` actually counts. Not cosmetic. Every reader but one counts assistant turns, so the CLI could diff --git a/docs/api/type-aliases/LocalUsageScanError.md b/docs/api/type-aliases/LocalUsageScanError.md index 3b44cbe50..d5748f8b4 100644 --- a/docs/api/type-aliases/LocalUsageScanError.md +++ b/docs/api/type-aliases/LocalUsageScanError.md @@ -8,8 +8,6 @@ > **LocalUsageScanError** = `object` -Defined in: [types/localUsage.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L151) - A non-fatal per-file problem, surfaced instead of aborting the scan. ## Properties @@ -18,20 +16,14 @@ A non-fatal per-file problem, surfaced instead of aborting the scan. > **cliId**: [`LocalUsageCliId`](LocalUsageCliId.md) -Defined in: [types/localUsage.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L152) - --- ### filePath > **filePath**: `string` -Defined in: [types/localUsage.ts:153](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L153) - --- ### message > **message**: `string` - -Defined in: [types/localUsage.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L154) diff --git a/docs/api/type-aliases/LocalUsageScanOptions.md b/docs/api/type-aliases/LocalUsageScanOptions.md index 9ac8b2e43..d891e29d1 100644 --- a/docs/api/type-aliases/LocalUsageScanOptions.md +++ b/docs/api/type-aliases/LocalUsageScanOptions.md @@ -8,8 +8,6 @@ > **LocalUsageScanOptions** = `object` -Defined in: [types/localUsage.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L188) - Options accepted by every reader's `scan()` and by the aggregator. ## Properties @@ -18,8 +16,6 @@ Options accepted by every reader's `scan()` and by the aggregator. > `optional` **sinceDays?**: `number` -Defined in: [types/localUsage.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L196) - Only read files modified within this many days. Defaults to 30. This is a real constraint rather than a convenience: one developer machine diff --git a/docs/api/type-aliases/LocalUsageScanResult.md b/docs/api/type-aliases/LocalUsageScanResult.md index 459ab8262..1fbc0b519 100644 --- a/docs/api/type-aliases/LocalUsageScanResult.md +++ b/docs/api/type-aliases/LocalUsageScanResult.md @@ -8,8 +8,6 @@ > **LocalUsageScanResult** = `object` -Defined in: [types/localUsage.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L158) - What one reader's `scan()` returns. ## Properties @@ -18,24 +16,18 @@ What one reader's `scan()` returns. > **cliId**: [`LocalUsageCliId`](LocalUsageCliId.md) -Defined in: [types/localUsage.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L159) - --- ### totals > **totals**: [`LocalUsageTotals`](LocalUsageTotals.md) -Defined in: [types/localUsage.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L160) - --- ### filesScanned > **filesScanned**: `number` -Defined in: [types/localUsage.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L162) - Files opened during this scan, after any time filter. --- @@ -43,5 +35,3 @@ Files opened during this scan, after any time filter. ### errors > **errors**: [`LocalUsageScanError`](LocalUsageScanError.md)[] - -Defined in: [types/localUsage.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L163) diff --git a/docs/api/type-aliases/LocalUsageSqliteDatabase.md b/docs/api/type-aliases/LocalUsageSqliteDatabase.md index 250eb9754..b0145d1b6 100644 --- a/docs/api/type-aliases/LocalUsageSqliteDatabase.md +++ b/docs/api/type-aliases/LocalUsageSqliteDatabase.md @@ -8,16 +8,12 @@ > **LocalUsageSqliteDatabase** = `object` -Defined in: [types/localUsage.ts:415](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L415) - ## Properties ### prepare > **prepare**: (`sql`) => `object` -Defined in: [types/localUsage.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L416) - #### Parameters ##### sql @@ -48,8 +44,6 @@ Defined in: [types/localUsage.ts:416](https://github.com/juspay/neurolink/blob/r > **close**: () => `void` -Defined in: [types/localUsage.ts:417](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L417) - #### Returns `void` diff --git a/docs/api/type-aliases/LocalUsageSqliteDatabaseCtor.md b/docs/api/type-aliases/LocalUsageSqliteDatabaseCtor.md index 9352458ba..8524a15ec 100644 --- a/docs/api/type-aliases/LocalUsageSqliteDatabaseCtor.md +++ b/docs/api/type-aliases/LocalUsageSqliteDatabaseCtor.md @@ -8,8 +8,6 @@ > **LocalUsageSqliteDatabaseCtor** = (`path`, `options?`) => [`LocalUsageSqliteDatabase`](LocalUsageSqliteDatabase.md) -Defined in: [types/localUsage.ts:421](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L421) - Constructor shape for the same. ## Parameters diff --git a/docs/api/type-aliases/LocalUsageTotals.md b/docs/api/type-aliases/LocalUsageTotals.md index c4dd211ac..34009e145 100644 --- a/docs/api/type-aliases/LocalUsageTotals.md +++ b/docs/api/type-aliases/LocalUsageTotals.md @@ -8,8 +8,6 @@ > **LocalUsageTotals** = `object` -Defined in: [types/localUsage.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L131) - Aggregated totals for one CLI, one scan. ## Properties @@ -18,56 +16,42 @@ Aggregated totals for one CLI, one scan. > **requests**: `number` -Defined in: [types/localUsage.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L132) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/localUsage.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L133) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/localUsage.ts:134](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L134) - --- ### cacheReadTokens > **cacheReadTokens**: `number` -Defined in: [types/localUsage.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L135) - --- ### cacheCreationTokens > **cacheCreationTokens**: `number` -Defined in: [types/localUsage.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L136) - --- ### costUsd > **costUsd**: `number` -Defined in: [types/localUsage.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L137) - --- ### costConfidence > **costConfidence**: [`LocalUsageCostConfidence`](LocalUsageCostConfidence.md) -Defined in: [types/localUsage.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L143) - The weakest confidence contributing to `costUsd`. A totals row mixing modeled and heuristic entries must report the weaker one, otherwise the aggregate looks better-sourced than its worst input. @@ -78,8 +62,6 @@ aggregate looks better-sourced than its worst input. > **unpricedRequests**: `number` -Defined in: [types/localUsage.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L145) - Turns whose model had no pricing entry, so contributed 0 to costUsd. --- @@ -88,6 +70,4 @@ Turns whose model had no pricing entry, so contributed 0 to costUsd. > **unpricedModels**: `string`[] -Defined in: [types/localUsage.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L147) - Distinct model ids behind `unpricedRequests`, for diagnosis. diff --git a/docs/api/type-aliases/LocalUsageWireField.md b/docs/api/type-aliases/LocalUsageWireField.md index 05ab8a16e..5e261e01c 100644 --- a/docs/api/type-aliases/LocalUsageWireField.md +++ b/docs/api/type-aliases/LocalUsageWireField.md @@ -8,8 +8,6 @@ > **LocalUsageWireField** = \{ `field`: `number`; `kind`: `"varint"`; `value`: `number`; \} \| \{ `field`: `number`; `kind`: `"bytes"`; `value`: `Uint8Array`; \} -Defined in: [types/localUsage.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/types/localUsage.ts#L405) - One decoded protobuf field from a Cursor root blob. Wire types 0 (varint) and 2 (length-delimited) only — the two Cursor actually uses; fixed-width fields are skipped by the decoder rather than represented. diff --git a/docs/api/type-aliases/LogEntry.md b/docs/api/type-aliases/LogEntry.md index 83802f9e1..4f0d782eb 100644 --- a/docs/api/type-aliases/LogEntry.md +++ b/docs/api/type-aliases/LogEntry.md @@ -8,8 +8,6 @@ > **LogEntry** = `object` -Defined in: [types/utilities.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L66) - Represents a single log entry in the logging system. Each entry contains metadata about the log event along with the actual message. @@ -19,8 +17,6 @@ Each entry contains metadata about the log event along with the actual message. > **level**: [`LogLevel`](LogLevel.md) -Defined in: [types/utilities.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L68) - The severity level of the log entry --- @@ -29,8 +25,6 @@ The severity level of the log entry > **message**: `string` -Defined in: [types/utilities.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L70) - The text message to be logged --- @@ -39,8 +33,6 @@ The text message to be logged > **timestamp**: `Date` -Defined in: [types/utilities.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L72) - When the log entry was created --- @@ -49,6 +41,4 @@ When the log entry was created > `optional` **data?**: `unknown` -Defined in: [types/utilities.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L74) - Optional additional data associated with the log entry (objects, arrays, etc.) diff --git a/docs/api/type-aliases/LogLevel.md b/docs/api/type-aliases/LogLevel.md index 7207e0af7..c9e6a9c0a 100644 --- a/docs/api/type-aliases/LogLevel.md +++ b/docs/api/type-aliases/LogLevel.md @@ -8,8 +8,6 @@ > **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` -Defined in: [types/utilities.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L16) - Represents the available logging severity levels. - debug: Detailed information for debugging purposes diff --git a/docs/api/type-aliases/Logger.md b/docs/api/type-aliases/Logger.md index 9aca9a099..d1b3e0621 100644 --- a/docs/api/type-aliases/Logger.md +++ b/docs/api/type-aliases/Logger.md @@ -8,8 +8,6 @@ > **Logger** = `object` -Defined in: [types/utilities.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L81) - Logger interface matching the logger object shape Used for SDK tool contexts and other components that need a logger @@ -19,8 +17,6 @@ Used for SDK tool contexts and other components that need a logger > **debug**: (...`args`) => `void` -Defined in: [types/utilities.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L82) - #### Parameters ##### args @@ -37,8 +33,6 @@ Defined in: [types/utilities.ts:82](https://github.com/juspay/neurolink/blob/rel > **info**: (...`args`) => `void` -Defined in: [types/utilities.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L83) - #### Parameters ##### args @@ -55,8 +49,6 @@ Defined in: [types/utilities.ts:83](https://github.com/juspay/neurolink/blob/rel > **warn**: (...`args`) => `void` -Defined in: [types/utilities.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L84) - #### Parameters ##### args @@ -73,8 +65,6 @@ Defined in: [types/utilities.ts:84](https://github.com/juspay/neurolink/blob/rel > **error**: (...`args`) => `void` -Defined in: [types/utilities.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L85) - #### Parameters ##### args @@ -91,8 +81,6 @@ Defined in: [types/utilities.ts:85](https://github.com/juspay/neurolink/blob/rel > **always**: (...`args`) => `void` -Defined in: [types/utilities.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L86) - #### Parameters ##### args @@ -109,8 +97,6 @@ Defined in: [types/utilities.ts:86](https://github.com/juspay/neurolink/blob/rel > **table**: (`data`) => `void` -Defined in: [types/utilities.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L87) - #### Parameters ##### data @@ -127,8 +113,6 @@ Defined in: [types/utilities.ts:87](https://github.com/juspay/neurolink/blob/rel > **setLogLevel**: (`level`) => `void` -Defined in: [types/utilities.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L88) - #### Parameters ##### level @@ -145,8 +129,6 @@ Defined in: [types/utilities.ts:88](https://github.com/juspay/neurolink/blob/rel > **getLogs**: (`level?`) => [`LogEntry`](LogEntry.md)[] -Defined in: [types/utilities.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L89) - #### Parameters ##### level? @@ -163,8 +145,6 @@ Defined in: [types/utilities.ts:89](https://github.com/juspay/neurolink/blob/rel > **clearLogs**: () => `void` -Defined in: [types/utilities.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L90) - #### Returns `void` @@ -175,8 +155,6 @@ Defined in: [types/utilities.ts:90](https://github.com/juspay/neurolink/blob/rel > **setEventEmitter**: (`emitter`) => `void` -Defined in: [types/utilities.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L91) - #### Parameters ##### emitter @@ -195,8 +173,6 @@ Defined in: [types/utilities.ts:91](https://github.com/juspay/neurolink/blob/rel > **clearEventEmitter**: () => `void` -Defined in: [types/utilities.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L94) - #### Returns `void` diff --git a/docs/api/type-aliases/LoggingConfig.md b/docs/api/type-aliases/LoggingConfig.md index 10f8d4a21..1ba051d60 100644 --- a/docs/api/type-aliases/LoggingConfig.md +++ b/docs/api/type-aliases/LoggingConfig.md @@ -8,8 +8,6 @@ > **LoggingConfig** = `object` -Defined in: [types/server.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L181) - Logging configuration ## Properties @@ -18,8 +16,6 @@ Logging configuration > `optional` **enabled?**: `boolean` -Defined in: [types/server.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L183) - Enable request logging (default: true) --- @@ -28,8 +24,6 @@ Enable request logging (default: true) > `optional` **level?**: `"debug"` \| `"info"` \| `"warn"` \| `"error"` -Defined in: [types/server.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L186) - Log level --- @@ -38,8 +32,6 @@ Log level > `optional` **includeBody?**: `boolean` -Defined in: [types/server.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L189) - Include request body in logs --- @@ -48,6 +40,4 @@ Include request body in logs > `optional` **includeResponse?**: `boolean` -Defined in: [types/server.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L192) - Include response body in logs diff --git a/docs/api/type-aliases/LoggingInterceptorOptions.md b/docs/api/type-aliases/LoggingInterceptorOptions.md index 3daac2c07..bd7c9b0fd 100644 --- a/docs/api/type-aliases/LoggingInterceptorOptions.md +++ b/docs/api/type-aliases/LoggingInterceptorOptions.md @@ -8,8 +8,6 @@ > **LoggingInterceptorOptions** = `object` -Defined in: [types/client.ts:1282](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1282) - Logging interceptor options ## Properties @@ -18,8 +16,6 @@ Logging interceptor options > `optional` **logRequest?**: `boolean` -Defined in: [types/client.ts:1284](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1284) - Log request details --- @@ -28,8 +24,6 @@ Log request details > `optional` **logResponse?**: `boolean` -Defined in: [types/client.ts:1286](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1286) - Log response details --- @@ -38,8 +32,6 @@ Log response details > `optional` **logBody?**: `boolean` -Defined in: [types/client.ts:1288](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1288) - Log request body --- @@ -48,8 +40,6 @@ Log request body > `optional` **logResponseBody?**: `boolean` -Defined in: [types/client.ts:1290](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1290) - Log response body --- @@ -58,8 +48,6 @@ Log response body > `optional` **logger?**: (`message`, `data?`) => `void` -Defined in: [types/client.ts:1292](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1292) - Custom logger function #### Parameters @@ -82,6 +70,4 @@ Custom logger function > `optional` **redactFields?**: `string`[] -Defined in: [types/client.ts:1294](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L1294) - Redact sensitive fields diff --git a/docs/api/type-aliases/LogoConfig.md b/docs/api/type-aliases/LogoConfig.md index a9a26b533..8eb930a4e 100644 --- a/docs/api/type-aliases/LogoConfig.md +++ b/docs/api/type-aliases/LogoConfig.md @@ -8,8 +8,6 @@ > **LogoConfig** = `object` -Defined in: [types/ppt.ts:1332](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1332) - Logo configuration options ## Properties @@ -18,8 +16,6 @@ Logo configuration options > **data**: `Buffer` \| `string` -Defined in: [types/ppt.ts:1334](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1334) - Logo data - Buffer, base64 string, data URI, or file path --- @@ -28,8 +24,6 @@ Logo data - Buffer, base64 string, data URI, or file path > `optional` **position?**: [`LogoPosition`](LogoPosition.md) -Defined in: [types/ppt.ts:1336](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1336) - Position on slides (default: "bottom-right") --- @@ -38,8 +32,6 @@ Position on slides (default: "bottom-right") > `optional` **width?**: `number` -Defined in: [types/ppt.ts:1338](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1338) - Width in inches (default: 1) --- @@ -48,8 +40,6 @@ Width in inches (default: 1) > `optional` **height?**: `number` -Defined in: [types/ppt.ts:1340](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1340) - Height in inches (default: 0.4) --- @@ -58,6 +48,4 @@ Height in inches (default: 0.4) > `optional` **showOn?**: `"all-slides"` \| `"title-only"` \| `"title-and-closing"` -Defined in: [types/ppt.ts:1342](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1342) - Show on all slides or specific types (default: "all-slides") diff --git a/docs/api/type-aliases/LogoPosition.md b/docs/api/type-aliases/LogoPosition.md index 2e692d1a3..2cdd68ddc 100644 --- a/docs/api/type-aliases/LogoPosition.md +++ b/docs/api/type-aliases/LogoPosition.md @@ -8,6 +8,4 @@ > **LogoPosition** = `"top-left"` \| `"top-right"` \| `"bottom-left"` \| `"bottom-right"` \| `"title-only"` -Defined in: [types/ppt.ts:1322](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1322) - Logo position options for slides diff --git a/docs/api/type-aliases/LoopGuardEntry.md b/docs/api/type-aliases/LoopGuardEntry.md index 225ddee7d..e7efbc0b8 100644 --- a/docs/api/type-aliases/LoopGuardEntry.md +++ b/docs/api/type-aliases/LoopGuardEntry.md @@ -8,8 +8,6 @@ > **LoopGuardEntry** = `object` -Defined in: [types/context.ts:860](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L860) - Provider-neutral view of ONE message in an agent loop's history. Every native provider loop keeps its history in a different shape (AI-SDK @@ -24,8 +22,6 @@ do, and apply the answer themselves. > **kind**: `"other"` \| `"toolCall"` \| `"toolResult"` -Defined in: [types/context.ts:862](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L862) - `toolCall` and `toolResult` form the batches the policy keeps intact. --- @@ -34,8 +30,6 @@ Defined in: [types/context.ts:862](https://github.com/juspay/neurolink/blob/rele > **tokens**: `number` -Defined in: [types/context.ts:864](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L864) - Estimated tokens this entry currently costs. --- @@ -44,8 +38,6 @@ Estimated tokens this entry currently costs. > `optional` **previewTokens?**: `number` -Defined in: [types/context.ts:870](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L870) - Tokens this entry would cost with its payload replaced by a head/tail preview. Omitted when the entry cannot usefully shrink — which is exactly the case that forces the policy to drop batches instead. diff --git a/docs/api/type-aliases/LoopGuardPlan.md b/docs/api/type-aliases/LoopGuardPlan.md index 773d2d0f5..873628269 100644 --- a/docs/api/type-aliases/LoopGuardPlan.md +++ b/docs/api/type-aliases/LoopGuardPlan.md @@ -8,8 +8,6 @@ > **LoopGuardPlan** = `object` -Defined in: [types/context.ts:874](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L874) - What the caller should do to reclaim budget. Indices refer to the input array. ## Properties @@ -18,8 +16,6 @@ What the caller should do to reclaim budget. Indices refer to the input array. > **fire**: `boolean` -Defined in: [types/context.ts:876](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L876) - False when the loop is under threshold and nothing should change. --- @@ -28,8 +24,6 @@ False when the loop is under threshold and nothing should change. > **truncate**: `number`[] -Defined in: [types/context.ts:878](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L878) - Entries whose payload should be replaced by a preview. --- @@ -38,8 +32,6 @@ Entries whose payload should be replaced by a preview. > **drop**: `number`[] -Defined in: [types/context.ts:880](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L880) - Entries to remove entirely — always whole batches, never a partial pair. --- @@ -48,6 +40,4 @@ Entries to remove entirely — always whole batches, never a partial pair. > **projectedTokens**: `number` -Defined in: [types/context.ts:882](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L882) - Estimated total after applying the plan, including fixed overhead. diff --git a/docs/api/type-aliases/LoopGuardPolicy.md b/docs/api/type-aliases/LoopGuardPolicy.md index e28cee4c4..2275bded3 100644 --- a/docs/api/type-aliases/LoopGuardPolicy.md +++ b/docs/api/type-aliases/LoopGuardPolicy.md @@ -8,8 +8,6 @@ > **LoopGuardPolicy** = `object` -Defined in: [types/context.ts:925](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L925) - Tuning for planLoopGuardReclaim. ## Properties @@ -18,16 +16,12 @@ Tuning for planLoopGuardReclaim. > **availableInputTokens**: `number` -Defined in: [types/context.ts:926](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L926) - --- ### fixedOverheadTokens > **fixedOverheadTokens**: `number` -Defined in: [types/context.ts:928](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L928) - System prompt + tool definitions — rides outside the message array. --- @@ -36,8 +30,6 @@ System prompt + tool definitions — rides outside the message array. > `optional` **thresholdRatio?**: `number` -Defined in: [types/context.ts:930](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L930) - Fraction of the window at which the guard fires. --- @@ -46,8 +38,6 @@ Fraction of the window at which the guard fires. > `optional` **lowWaterRatio?**: `number` -Defined in: [types/context.ts:932](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L932) - Fraction of the window the guard reclaims down to once it fires. --- @@ -56,8 +46,6 @@ Fraction of the window the guard reclaims down to once it fires. > `optional` **protectedTailCount?**: `number` -Defined in: [types/context.ts:934](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L934) - Newest entries the guard must never modify. --- @@ -66,6 +54,4 @@ Newest entries the guard must never modify. > `optional` **calibration?**: `number` -Defined in: [types/context.ts:936](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L936) - Observed/estimated token ratio, used to tighten both marks. diff --git a/docs/api/type-aliases/LoopSessionState.md b/docs/api/type-aliases/LoopSessionState.md index 5f372b55a..aa952db04 100644 --- a/docs/api/type-aliases/LoopSessionState.md +++ b/docs/api/type-aliases/LoopSessionState.md @@ -8,8 +8,6 @@ > **LoopSessionState** = `object` -Defined in: [types/common.ts:715](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L715) - State snapshot for the active REPL loop session. ## Properties @@ -18,36 +16,26 @@ State snapshot for the active REPL loop session. > **neurolinkInstance**: [`NeuroLink`](../classes/NeuroLink.md) -Defined in: [types/common.ts:716](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L716) - --- ### sessionId > **sessionId**: `string` -Defined in: [types/common.ts:717](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L717) - --- ### isActive > **isActive**: `boolean` -Defined in: [types/common.ts:718](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L718) - --- ### conversationMemoryConfig? > `optional` **conversationMemoryConfig?**: [`ConversationMemoryConfig`](ConversationMemoryConfig.md) -Defined in: [types/common.ts:719](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L719) - --- ### sessionVariables > **sessionVariables**: `Record`\<`string`, [`SessionVariableValue`](SessionVariableValue.md)\> - -Defined in: [types/common.ts:720](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L720) diff --git a/docs/api/type-aliases/LyriaResponse.md b/docs/api/type-aliases/LyriaResponse.md index df4132be5..4ef2de113 100644 --- a/docs/api/type-aliases/LyriaResponse.md +++ b/docs/api/type-aliases/LyriaResponse.md @@ -8,8 +8,6 @@ > **LyriaResponse** = `object` -Defined in: [types/music.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L194) - Google Lyria 3 Pro :generateContent response shape. The audio comes back as a part with `inlineData: { mimeType, data }` @@ -21,8 +19,6 @@ where `data` is base64-encoded WAV. > `optional` **candidates?**: `object`[] -Defined in: [types/music.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L195) - #### content? > `optional` **content?**: `object` @@ -45,8 +41,6 @@ Defined in: [types/music.ts:195](https://github.com/juspay/neurolink/blob/releas > `optional` **usageMetadata?**: `object` -Defined in: [types/music.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L208) - #### promptTokenCount? > `optional` **promptTokenCount?**: `number` diff --git a/docs/api/type-aliases/MCPClientResult.md b/docs/api/type-aliases/MCPClientResult.md index 503c0b730..16aa7ef96 100644 --- a/docs/api/type-aliases/MCPClientResult.md +++ b/docs/api/type-aliases/MCPClientResult.md @@ -8,8 +8,6 @@ > **MCPClientResult** = `object` -Defined in: [types/mcp.ts:823](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L823) - MCP client creation result Moved from src/lib/mcp/mcpClientFactory.ts @@ -19,8 +17,6 @@ Moved from src/lib/mcp/mcpClientFactory.ts > **success**: `boolean` -Defined in: [types/mcp.ts:825](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L825) - Whether client creation was successful --- @@ -29,8 +25,6 @@ Whether client creation was successful > `optional` **client?**: `Client` -Defined in: [types/mcp.ts:828](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L828) - Created client instance --- @@ -39,8 +33,6 @@ Created client instance > `optional` **transport?**: `Transport` -Defined in: [types/mcp.ts:831](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L831) - Created transport instance --- @@ -49,8 +41,6 @@ Created transport instance > `optional` **process?**: `ChildProcess` -Defined in: [types/mcp.ts:834](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L834) - Created process (for stdio transport) --- @@ -59,8 +49,6 @@ Created process (for stdio transport) > `optional` **error?**: `string` -Defined in: [types/mcp.ts:837](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L837) - Error message if failed --- @@ -69,8 +57,6 @@ Error message if failed > **duration**: `number` -Defined in: [types/mcp.ts:840](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L840) - Creation duration in milliseconds --- @@ -79,6 +65,4 @@ Creation duration in milliseconds > `optional` **capabilities?**: `ClientCapabilities` -Defined in: [types/mcp.ts:843](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L843) - Server capabilities reported during handshake diff --git a/docs/api/type-aliases/MCPCommandArgs.md b/docs/api/type-aliases/MCPCommandArgs.md index e7f201e92..aa315dbcb 100644 --- a/docs/api/type-aliases/MCPCommandArgs.md +++ b/docs/api/type-aliases/MCPCommandArgs.md @@ -8,8 +8,6 @@ > **MCPCommandArgs** = [`BaseCommandArgs`](BaseCommandArgs.md) & `object` -Defined in: [types/cli.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L199) - MCP command arguments - Enhanced with transport and server management ## Type Declaration diff --git a/docs/api/type-aliases/MCPConnectedServer.md b/docs/api/type-aliases/MCPConnectedServer.md index 98957f594..99e2e9c5c 100644 --- a/docs/api/type-aliases/MCPConnectedServer.md +++ b/docs/api/type-aliases/MCPConnectedServer.md @@ -8,8 +8,6 @@ > **MCPConnectedServer** = `object` -Defined in: [types/mcp.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L264) - Connected MCP Server - High Reusability ## Properties @@ -18,60 +16,44 @@ Connected MCP Server - High Reusability > **name**: `string` -Defined in: [types/mcp.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L265) - --- ### transport > **transport**: [`MCPTransportType`](MCPTransportType.md) -Defined in: [types/mcp.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L266) - --- ### connected > **connected**: `boolean` -Defined in: [types/mcp.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L267) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/mcp.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L268) - --- ### tools > **tools**: [`MCPToolInfo`](MCPToolInfo.md)[] -Defined in: [types/mcp.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L269) - --- ### lastSeen? > `optional` **lastSeen?**: `Date` -Defined in: [types/mcp.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L270) - --- ### connectionTime? > `optional` **connectionTime?**: `Date` -Defined in: [types/mcp.ts:271](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L271) - --- ### metadata? > `optional` **metadata?**: [`MCPServerMetadata`](MCPServerMetadata.md) - -Defined in: [types/mcp.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L272) diff --git a/docs/api/type-aliases/MCPDiscoveredServer.md b/docs/api/type-aliases/MCPDiscoveredServer.md index ba80cba02..5f2acfa04 100644 --- a/docs/api/type-aliases/MCPDiscoveredServer.md +++ b/docs/api/type-aliases/MCPDiscoveredServer.md @@ -8,8 +8,6 @@ > **MCPDiscoveredServer** = `object` -Defined in: [types/mcp.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L249) - Auto-discovered MCP Server - High Reusability ## Properties @@ -18,68 +16,50 @@ Auto-discovered MCP Server - High Reusability > **name**: `string` -Defined in: [types/mcp.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L250) - --- ### status > **status**: [`MCPServerConnectionStatus`](MCPServerConnectionStatus.md) -Defined in: [types/mcp.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L251) - --- ### source > **source**: `string` -Defined in: [types/mcp.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L252) - --- ### transport > **transport**: [`MCPTransportType`](MCPTransportType.md) -Defined in: [types/mcp.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L253) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/mcp.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L254) - --- ### url? > `optional` **url?**: `string` -Defined in: [types/mcp.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L255) - --- ### args? > `optional` **args?**: `string`[] -Defined in: [types/mcp.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L256) - --- ### env? > `optional` **env?**: `Record`\<`string`, `string`\> -Defined in: [types/mcp.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L257) - --- ### metadata? > `optional` **metadata?**: [`MCPServerMetadata`](MCPServerMetadata.md) - -Defined in: [types/mcp.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L258) diff --git a/docs/api/type-aliases/MCPDiscoveryResult.md b/docs/api/type-aliases/MCPDiscoveryResult.md index 7c701bd53..ead370f74 100644 --- a/docs/api/type-aliases/MCPDiscoveryResult.md +++ b/docs/api/type-aliases/MCPDiscoveryResult.md @@ -8,8 +8,6 @@ > **MCPDiscoveryResult** = `object` -Defined in: [types/cli.ts:1998](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1998) - Per-server discovery result produced by `neurolink mcp discover`. ## Properties @@ -18,32 +16,24 @@ Per-server discovery result produced by `neurolink mcp discover`. > **serverId**: `string` -Defined in: [types/cli.ts:1999](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1999) - --- ### serverName > **serverName**: `string` -Defined in: [types/cli.ts:2000](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2000) - --- ### toolCount > **toolCount**: `number` -Defined in: [types/cli.ts:2001](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2001) - --- ### tools > **tools**: `object`[] -Defined in: [types/cli.ts:2002](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2002) - #### name > **name**: `string` diff --git a/docs/api/type-aliases/MCPEnhancementsConfig.md b/docs/api/type-aliases/MCPEnhancementsConfig.md index ef2a80f18..72be7e291 100644 --- a/docs/api/type-aliases/MCPEnhancementsConfig.md +++ b/docs/api/type-aliases/MCPEnhancementsConfig.md @@ -8,8 +8,6 @@ > **MCPEnhancementsConfig** = `object` -Defined in: [types/config.ts:210](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L210) - Configuration for MCP enhancement modules wired into generate()/stream() paths. These modules are automatically applied during tool execution when configured: @@ -27,8 +25,6 @@ These modules are automatically applied during tool execution when configured: > `optional` **cache?**: `object` -Defined in: [types/config.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L212) - Tool result caching. Default: enabled. Set enabled: false to opt out. #### enabled? @@ -59,8 +55,6 @@ Eviction strategy. Default: 'lru' > `optional` **annotations?**: `object` -Defined in: [types/config.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L222) - Tool annotation auto-inference. Default: enabled. #### enabled? @@ -79,8 +73,6 @@ Auto-infer annotations from tool name/description. Default: true > `optional` **router?**: `object` -Defined in: [types/config.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L228) - Tool routing for multi-server environments. Auto-activates when 2+ external servers exist. #### enabled? @@ -105,8 +97,6 @@ Enable session affinity. Default: false > `optional` **batcher?**: `object` -Defined in: [types/config.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L236) - Request batching for programmatic executeTool() calls. Default: disabled. #### enabled? @@ -131,8 +121,6 @@ Max wait before flushing batch in ms. Default: 100 > `optional` **discovery?**: `object` -Defined in: [types/config.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L244) - Enhanced tool discovery. Default: enabled. #### enabled? @@ -145,8 +133,6 @@ Enhanced tool discovery. Default: enabled. > `optional` **middleware?**: [`ToolMiddleware`](ToolMiddleware.md)[] -Defined in: [types/config.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L248) - Global tool middleware applied to every tool execution. Default: empty. --- @@ -155,8 +141,6 @@ Global tool middleware applied to every tool execution. Default: empty. > `optional` **outputLimits?**: `object` -Defined in: [types/config.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L274) - Large MCP tool output handling. MCP servers can return arbitrarily large payloads. Without limits these diff --git a/docs/api/type-aliases/MCPExecutableTool.md b/docs/api/type-aliases/MCPExecutableTool.md index e0e1169d2..d3a365c1d 100644 --- a/docs/api/type-aliases/MCPExecutableTool.md +++ b/docs/api/type-aliases/MCPExecutableTool.md @@ -8,7 +8,5 @@ > **MCPExecutableTool** = [`MCPServerInfo`](MCPServerInfo.md)\[`"tools"`\]\[`0`\] -Defined in: [types/mcp.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L293) - MCP Executable Tool - Tool with execution capability Extracted from MCPServerInfo.tools array for better readability diff --git a/docs/api/type-aliases/MCPHTTPTransportOptions.md b/docs/api/type-aliases/MCPHTTPTransportOptions.md index 903e1ae7b..efacfb930 100644 --- a/docs/api/type-aliases/MCPHTTPTransportOptions.md +++ b/docs/api/type-aliases/MCPHTTPTransportOptions.md @@ -8,8 +8,6 @@ > **MCPHTTPTransportOptions** = `object` -Defined in: [types/mcp.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L205) - HTTP Transport Options for fine-grained control ## Properties @@ -18,8 +16,6 @@ HTTP Transport Options for fine-grained control > `optional` **connectionTimeout?**: `number` -Defined in: [types/mcp.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L207) - Connection timeout in milliseconds (default: 30000) --- @@ -28,8 +24,6 @@ Connection timeout in milliseconds (default: 30000) > `optional` **requestTimeout?**: `number` -Defined in: [types/mcp.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L209) - Request timeout in milliseconds (default: 60000) --- @@ -38,8 +32,6 @@ Request timeout in milliseconds (default: 60000) > `optional` **idleTimeout?**: `number` -Defined in: [types/mcp.ts:211](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L211) - Idle timeout for connection pool (default: 120000) --- @@ -48,6 +40,4 @@ Idle timeout for connection pool (default: 120000) > `optional` **keepAliveTimeout?**: `number` -Defined in: [types/mcp.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L213) - Keep-alive timeout (default: 30000) diff --git a/docs/api/type-aliases/MCPOAuthConfig.md b/docs/api/type-aliases/MCPOAuthConfig.md index 8ce28e98d..8ce47352e 100644 --- a/docs/api/type-aliases/MCPOAuthConfig.md +++ b/docs/api/type-aliases/MCPOAuthConfig.md @@ -8,8 +8,6 @@ > **MCPOAuthConfig** = `object` -Defined in: [types/mcp.ts:918](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L918) - OAuth 2.1 configuration for MCP servers ## Properties @@ -18,8 +16,6 @@ OAuth 2.1 configuration for MCP servers > **clientId**: `string` -Defined in: [types/mcp.ts:920](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L920) - OAuth client ID --- @@ -28,8 +24,6 @@ OAuth client ID > `optional` **clientSecret?**: `string` -Defined in: [types/mcp.ts:922](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L922) - OAuth client secret (optional for public clients with PKCE) --- @@ -38,8 +32,6 @@ OAuth client secret (optional for public clients with PKCE) > **authorizationUrl**: `string` -Defined in: [types/mcp.ts:924](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L924) - Authorization endpoint URL --- @@ -48,8 +40,6 @@ Authorization endpoint URL > **tokenUrl**: `string` -Defined in: [types/mcp.ts:926](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L926) - Token endpoint URL --- @@ -58,8 +48,6 @@ Token endpoint URL > **redirectUrl**: `string` -Defined in: [types/mcp.ts:928](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L928) - Redirect URI for OAuth callback --- @@ -68,8 +56,6 @@ Redirect URI for OAuth callback > `optional` **scope?**: `string` -Defined in: [types/mcp.ts:930](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L930) - OAuth scope (space-separated) --- @@ -78,8 +64,6 @@ OAuth scope (space-separated) > `optional` **usePKCE?**: `boolean` -Defined in: [types/mcp.ts:932](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L932) - Enable PKCE (Proof Key for Code Exchange) - recommended for OAuth 2.1 --- @@ -88,6 +72,4 @@ Enable PKCE (Proof Key for Code Exchange) - recommended for OAuth 2.1 > `optional` **additionalParams?**: `Record`\<`string`, `string`\> -Defined in: [types/mcp.ts:934](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L934) - Additional authorization parameters diff --git a/docs/api/type-aliases/MCPPrompt.md b/docs/api/type-aliases/MCPPrompt.md index 93d4b5533..5f8c59550 100644 --- a/docs/api/type-aliases/MCPPrompt.md +++ b/docs/api/type-aliases/MCPPrompt.md @@ -8,8 +8,6 @@ > **MCPPrompt** = `object` -Defined in: [types/mcp.ts:2029](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2029) - MCP Prompt definition ## Properties @@ -18,8 +16,6 @@ MCP Prompt definition > **name**: `string` -Defined in: [types/mcp.ts:2033](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2033) - Unique prompt name --- @@ -28,8 +24,6 @@ Unique prompt name > `optional` **description?**: `string` -Defined in: [types/mcp.ts:2038](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2038) - Human-readable description --- @@ -38,8 +32,6 @@ Human-readable description > `optional` **arguments?**: `object`[] -Defined in: [types/mcp.ts:2043](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2043) - Prompt arguments schema #### name diff --git a/docs/api/type-aliases/MCPProtocolTool.md b/docs/api/type-aliases/MCPProtocolTool.md index 290c12d70..41e94268d 100644 --- a/docs/api/type-aliases/MCPProtocolTool.md +++ b/docs/api/type-aliases/MCPProtocolTool.md @@ -8,8 +8,6 @@ > **MCPProtocolTool** = `object` -Defined in: [types/mcp.ts:2197](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2197) - MCP protocol tool format (from @modelcontextprotocol/sdk) ## Properties @@ -18,8 +16,6 @@ MCP protocol tool format (from @modelcontextprotocol/sdk) > **name**: `string` -Defined in: [types/mcp.ts:2201](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2201) - Tool name --- @@ -28,8 +24,6 @@ Tool name > `optional` **description?**: `string` -Defined in: [types/mcp.ts:2206](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2206) - Tool description --- @@ -38,8 +32,6 @@ Tool description > **inputSchema**: `object` -Defined in: [types/mcp.ts:2211](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2211) - JSON Schema for input #### type @@ -60,8 +52,6 @@ JSON Schema for input > `optional` **annotations?**: `object` -Defined in: [types/mcp.ts:2220](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2220) - Optional annotations (MCP 2024-11-05+) #### title? diff --git a/docs/api/type-aliases/MCPRegistryClientConfig.md b/docs/api/type-aliases/MCPRegistryClientConfig.md index 05d7906de..799e1317f 100644 --- a/docs/api/type-aliases/MCPRegistryClientConfig.md +++ b/docs/api/type-aliases/MCPRegistryClientConfig.md @@ -8,8 +8,6 @@ > **MCPRegistryClientConfig** = `object` -Defined in: [types/mcp.ts:1759](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1759) - Registry client configuration ## Properties @@ -18,8 +16,6 @@ Registry client configuration > `optional` **registries?**: [`RegistryConfig`](RegistryConfig.md)[] -Defined in: [types/mcp.ts:1763](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1763) - Default registries to use --- @@ -28,8 +24,6 @@ Default registries to use > `optional` **enableCache?**: `boolean` -Defined in: [types/mcp.ts:1768](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1768) - Enable automatic caching --- @@ -38,8 +32,6 @@ Enable automatic caching > `optional` **defaultCacheTTL?**: `number` -Defined in: [types/mcp.ts:1773](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1773) - Default cache TTL --- @@ -48,8 +40,6 @@ Default cache TTL > `optional` **timeout?**: `number` -Defined in: [types/mcp.ts:1778](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1778) - Request timeout --- @@ -58,6 +48,4 @@ Request timeout > `optional` **userAgent?**: `string` -Defined in: [types/mcp.ts:1783](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1783) - User agent string diff --git a/docs/api/type-aliases/MCPResource.md b/docs/api/type-aliases/MCPResource.md index 56418d43f..78180c0ac 100644 --- a/docs/api/type-aliases/MCPResource.md +++ b/docs/api/type-aliases/MCPResource.md @@ -8,8 +8,6 @@ > **MCPResource** = `object` -Defined in: [types/mcp.ts:1936](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1936) - MCP Resource definition ## Properties @@ -18,8 +16,6 @@ MCP Resource definition > **uri**: `string` -Defined in: [types/mcp.ts:1940](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1940) - Unique resource URI --- @@ -28,8 +24,6 @@ Unique resource URI > **name**: `string` -Defined in: [types/mcp.ts:1945](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1945) - Human-readable name --- @@ -38,8 +32,6 @@ Human-readable name > `optional` **description?**: `string` -Defined in: [types/mcp.ts:1950](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1950) - Resource description --- @@ -48,8 +40,6 @@ Resource description > `optional` **mimeType?**: `string` -Defined in: [types/mcp.ts:1955](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1955) - MIME type of the resource content --- @@ -58,8 +48,6 @@ MIME type of the resource content > `optional` **size?**: `number` -Defined in: [types/mcp.ts:1960](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1960) - Resource size in bytes (if known) --- @@ -68,8 +56,6 @@ Resource size in bytes (if known) > `optional` **dynamic?**: `boolean` -Defined in: [types/mcp.ts:1965](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1965) - Whether the resource content can change --- @@ -78,8 +64,6 @@ Whether the resource content can change > `optional` **annotations?**: `object` -Defined in: [types/mcp.ts:1970](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1970) - Resource annotations/metadata #### audience? diff --git a/docs/api/type-aliases/MCPServerBaseConfig.md b/docs/api/type-aliases/MCPServerBaseConfig.md index 60e2f21ce..d6b4e49e5 100644 --- a/docs/api/type-aliases/MCPServerBaseConfig.md +++ b/docs/api/type-aliases/MCPServerBaseConfig.md @@ -8,8 +8,6 @@ > **MCPServerBaseConfig** = `object` -Defined in: [types/mcp.ts:1104](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1104) - Base configuration for an MCP server. ## Properties @@ -18,8 +16,6 @@ Base configuration for an MCP server. > **id**: `string` -Defined in: [types/mcp.ts:1106](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1106) - Unique server identifier --- @@ -28,8 +24,6 @@ Unique server identifier > **name**: `string` -Defined in: [types/mcp.ts:1108](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1108) - Human-readable server name --- @@ -38,8 +32,6 @@ Human-readable server name > `optional` **description?**: `string` -Defined in: [types/mcp.ts:1110](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1110) - Server description --- @@ -48,8 +40,6 @@ Server description > `optional` **version?**: `string` -Defined in: [types/mcp.ts:1112](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1112) - Server version --- @@ -58,8 +48,6 @@ Server version > `optional` **category?**: [`MCPServerCategory`](MCPServerCategory.md) -Defined in: [types/mcp.ts:1114](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1114) - Server category for organization --- @@ -68,8 +56,6 @@ Server category for organization > `optional` **transport?**: [`MCPTransportType`](MCPTransportType.md) -Defined in: [types/mcp.ts:1116](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1116) - Transport protocol preference --- @@ -78,8 +64,6 @@ Transport protocol preference > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/mcp.ts:1118](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1118) - Custom metadata --- @@ -88,8 +72,6 @@ Custom metadata > `optional` **defaultTimeoutMs?**: `number` -Defined in: [types/mcp.ts:1120](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1120) - Default timeout for tool execution in milliseconds (default: 30000) --- @@ -98,6 +80,4 @@ Default timeout for tool execution in milliseconds (default: 30000) > `optional` **defaultAnnotations?**: [`MCPToolAnnotations`](MCPToolAnnotations.md) -Defined in: [types/mcp.ts:1122](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1122) - Global tool annotations applied to all tools diff --git a/docs/api/type-aliases/MCPServerCategory.md b/docs/api/type-aliases/MCPServerCategory.md index b4d513fd0..80c3dc85f 100644 --- a/docs/api/type-aliases/MCPServerCategory.md +++ b/docs/api/type-aliases/MCPServerCategory.md @@ -8,6 +8,4 @@ > **MCPServerCategory** = `"external"` \| `"in-memory"` \| `"built-in"` \| `"user-defined"` \| `"custom"` \| `"uncategorized"` -Defined in: [types/mcp.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L61) - MCP Server Category Types - Deployment and server type classification diff --git a/docs/api/type-aliases/MCPServerConfig.md b/docs/api/type-aliases/MCPServerConfig.md index 96dcb28af..06fb6aaef 100644 --- a/docs/api/type-aliases/MCPServerConfig.md +++ b/docs/api/type-aliases/MCPServerConfig.md @@ -8,8 +8,6 @@ > **MCPServerConfig** = `object` -Defined in: [types/mcp.ts:531](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L531) - MCP Server Configuration for creation Moved from src/lib/mcp/factory.ts @@ -19,68 +17,50 @@ Moved from src/lib/mcp/factory.ts > **id**: `string` -Defined in: [types/mcp.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L532) - --- ### title > **title**: `string` -Defined in: [types/mcp.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L533) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/mcp.ts:534](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L534) - --- ### version? > `optional` **version?**: `string` -Defined in: [types/mcp.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L535) - --- ### category? > `optional` **category?**: [`MCPServerDomainCategory`](MCPServerDomainCategory.md) -Defined in: [types/mcp.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L536) - --- ### visibility? > `optional` **visibility?**: `"public"` \| `"private"` \| `"organization"` -Defined in: [types/mcp.ts:537](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L537) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/mcp.ts:538](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L538) - --- ### dependencies? > `optional` **dependencies?**: `string`[] -Defined in: [types/mcp.ts:539](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L539) - --- ### capabilities? > `optional` **capabilities?**: `string`[] - -Defined in: [types/mcp.ts:540](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L540) diff --git a/docs/api/type-aliases/MCPServerConnectionStatus.md b/docs/api/type-aliases/MCPServerConnectionStatus.md index 4da502e06..c1a3bfa6f 100644 --- a/docs/api/type-aliases/MCPServerConnectionStatus.md +++ b/docs/api/type-aliases/MCPServerConnectionStatus.md @@ -8,6 +8,4 @@ > **MCPServerConnectionStatus** = `"initializing"` \| `"connecting"` \| `"connected"` \| `"disconnected"` \| `"failed"` \| `"restarting"` \| `"stopping"` \| `"stopped"` -Defined in: [types/mcp.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L40) - MCP Server Connection Status - Individual server status diff --git a/docs/api/type-aliases/MCPServerDomainCategory.md b/docs/api/type-aliases/MCPServerDomainCategory.md index ae344d788..fc14c2152 100644 --- a/docs/api/type-aliases/MCPServerDomainCategory.md +++ b/docs/api/type-aliases/MCPServerDomainCategory.md @@ -8,6 +8,4 @@ > **MCPServerDomainCategory** = `"aiProviders"` \| `"frameworks"` \| `"development"` \| `"business"` \| `"content"` \| `"data"` \| `"integrations"` \| `"automation"` \| `"analysis"` \| `"custom"` -Defined in: [types/mcp.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L72) - MCP Server Domain Categories - Functional domain classification diff --git a/docs/api/type-aliases/MCPServerEvents.md b/docs/api/type-aliases/MCPServerEvents.md index e578e61a0..fefa0a404 100644 --- a/docs/api/type-aliases/MCPServerEvents.md +++ b/docs/api/type-aliases/MCPServerEvents.md @@ -8,8 +8,6 @@ > **MCPServerEvents** = `object` -Defined in: [types/mcp.ts:1128](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1128) - Server lifecycle events. ## Properties @@ -18,8 +16,6 @@ Server lifecycle events. > **toolRegistered**: `object` -Defined in: [types/mcp.ts:1129](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1129) - #### toolName > **toolName**: `string` @@ -34,8 +30,6 @@ Defined in: [types/mcp.ts:1129](https://github.com/juspay/neurolink/blob/release > **toolExecuted**: `object` -Defined in: [types/mcp.ts:1130](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1130) - #### toolName > **toolName**: `string` @@ -54,8 +48,6 @@ Defined in: [types/mcp.ts:1130](https://github.com/juspay/neurolink/blob/release > **toolError**: `object` -Defined in: [types/mcp.ts:1131](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1131) - #### toolName > **toolName**: `string` @@ -70,8 +62,6 @@ Defined in: [types/mcp.ts:1131](https://github.com/juspay/neurolink/blob/release > **serverReady**: `object` -Defined in: [types/mcp.ts:1132](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1132) - #### tools > **tools**: `string`[] @@ -82,8 +72,6 @@ Defined in: [types/mcp.ts:1132](https://github.com/juspay/neurolink/blob/release > **serverStopped**: `object` -Defined in: [types/mcp.ts:1133](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1133) - #### reason? > `optional` **reason?**: `string` diff --git a/docs/api/type-aliases/MCPServerInfo.md b/docs/api/type-aliases/MCPServerInfo.md index 9e2c0d06b..1e0d63768 100644 --- a/docs/api/type-aliases/MCPServerInfo.md +++ b/docs/api/type-aliases/MCPServerInfo.md @@ -8,8 +8,6 @@ > **MCPServerInfo** = `object` -Defined in: [types/mcp.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L89) - Universal MCP Server - Unified configuration and runtime state MCP 2024-11-05 specification compliant Replaces both MCPServerInfo and MCPServerConfig @@ -20,48 +18,36 @@ Replaces both MCPServerInfo and MCPServerConfig > **id**: `string` -Defined in: [types/mcp.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L91) - --- ### name > **name**: `string` -Defined in: [types/mcp.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L92) - --- ### description > **description**: `string` -Defined in: [types/mcp.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L93) - --- ### transport > **transport**: [`MCPTransportType`](MCPTransportType.md) -Defined in: [types/mcp.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L94) - --- ### status > **status**: [`MCPServerConnectionStatus`](MCPServerConnectionStatus.md) -Defined in: [types/mcp.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L95) - --- ### tools > **tools**: `object`[] -Defined in: [types/mcp.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L98) - #### name > **name**: `string` @@ -98,48 +84,36 @@ Defined in: [types/mcp.ts:98](https://github.com/juspay/neurolink/blob/release/s > `optional` **command?**: `string` -Defined in: [types/mcp.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L109) - --- ### args? > `optional` **args?**: `string`[] -Defined in: [types/mcp.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L110) - --- ### env? > `optional` **env?**: `Record`\<`string`, `string`\> -Defined in: [types/mcp.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L111) - --- ### url? > `optional` **url?**: `string` -Defined in: [types/mcp.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L112) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/mcp.ts:113](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L113) - --- ### httpOptions? > `optional` **httpOptions?**: [`MCPHTTPTransportOptions`](MCPHTTPTransportOptions.md) -Defined in: [types/mcp.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L115) - HTTP transport-specific options --- @@ -148,64 +122,48 @@ HTTP transport-specific options > `optional` **timeout?**: `number` -Defined in: [types/mcp.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L116) - --- ### retries? > `optional` **retries?**: `number` -Defined in: [types/mcp.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L117) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/mcp.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L118) - --- ### installed? > `optional` **installed?**: `boolean` -Defined in: [types/mcp.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L119) - --- ### cwd? > `optional` **cwd?**: `string` -Defined in: [types/mcp.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L122) - --- ### autoRestart? > `optional` **autoRestart?**: `boolean` -Defined in: [types/mcp.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L123) - --- ### healthCheckInterval? > `optional` **healthCheckInterval?**: `number` -Defined in: [types/mcp.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L124) - --- ### minTools? > `optional` **minTools?**: `number` -Defined in: [types/mcp.ts:135](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L135) - Minimum number of tools that must be discovered for this server's registration to be considered ready (default: 0 — no minimum, so a resource/prompt-only server that legitimately exposes zero tools still @@ -220,8 +178,6 @@ server connected/healthy, and tears the connection back down. > `optional` **retryConfig?**: `object` -Defined in: [types/mcp.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L138) - Retry configuration for HTTP transport #### maxAttempts? @@ -246,8 +202,6 @@ Retry configuration for HTTP transport > `optional` **rateLimiting?**: `object` -Defined in: [types/mcp.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L146) - Rate limiting configuration for HTTP transport #### requestsPerMinute? @@ -280,16 +234,12 @@ Use token bucket algorithm (default: true) > `optional` **blockedTools?**: `string`[] -Defined in: [types/mcp.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L158) - --- ### auth? > `optional` **auth?**: `object` -Defined in: [types/mcp.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L161) - Authentication configuration for HTTP/SSE/WebSocket transports #### type @@ -370,8 +320,6 @@ Header name for API key (default: "X-API-Key") > `optional` **metadata?**: `object` -Defined in: [types/mcp.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L190) - #### Index Signature \[`key`: `string`\]: `unknown` diff --git a/docs/api/type-aliases/MCPServerMetadata.md b/docs/api/type-aliases/MCPServerMetadata.md index 2d546e83f..4d5f6118a 100644 --- a/docs/api/type-aliases/MCPServerMetadata.md +++ b/docs/api/type-aliases/MCPServerMetadata.md @@ -8,8 +8,6 @@ > **MCPServerMetadata** = `object` & `object` -Defined in: [types/mcp.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L298) - MCP Server Metadata - Extensible ## Type Declaration diff --git a/docs/api/type-aliases/MCPServerReadiness.md b/docs/api/type-aliases/MCPServerReadiness.md index 844bb85a6..469db2c15 100644 --- a/docs/api/type-aliases/MCPServerReadiness.md +++ b/docs/api/type-aliases/MCPServerReadiness.md @@ -8,8 +8,6 @@ > **MCPServerReadiness** = `"ready"` \| `"insufficient_tools"` \| `"failed"` -Defined in: [types/mcp.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L56) - Readiness of an external MCP server registration, distinct from raw connection status: a server can be "connected" at the transport level yet still be gated as not ready when it discovers fewer tools than its diff --git a/docs/api/type-aliases/MCPServerRegistryEntry.md b/docs/api/type-aliases/MCPServerRegistryEntry.md index f8857e43b..23129d21f 100644 --- a/docs/api/type-aliases/MCPServerRegistryEntry.md +++ b/docs/api/type-aliases/MCPServerRegistryEntry.md @@ -8,6 +8,4 @@ > **MCPServerRegistryEntry** = \[`string`, [`MCPServerInfo`](MCPServerInfo.md)\] -Defined in: [types/mcp.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L323) - MCP Server Registry Entry - For Object.entries() usage diff --git a/docs/api/type-aliases/MCPServerStatus.md b/docs/api/type-aliases/MCPServerStatus.md index a04b71c35..7cc179f4b 100644 --- a/docs/api/type-aliases/MCPServerStatus.md +++ b/docs/api/type-aliases/MCPServerStatus.md @@ -8,8 +8,6 @@ > **MCPServerStatus** = `object` -Defined in: [types/mcp.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L219) - MCP Server Status for CLI Operations - High Reusability ## Properties @@ -18,8 +16,6 @@ MCP Server Status for CLI Operations - High Reusability > **mcpInitialized**: `boolean` -Defined in: [types/mcp.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L221) - Whether MCP is initialized --- @@ -28,8 +24,6 @@ Whether MCP is initialized > **totalServers**: `number` -Defined in: [types/mcp.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L223) - Total number of servers --- @@ -38,8 +32,6 @@ Total number of servers > **availableServers**: `number` -Defined in: [types/mcp.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L225) - Number of available servers --- @@ -48,8 +40,6 @@ Number of available servers > **autoDiscoveredCount**: `number` -Defined in: [types/mcp.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L227) - Number of auto-discovered servers --- @@ -58,8 +48,6 @@ Number of auto-discovered servers > **totalTools**: `number` -Defined in: [types/mcp.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L229) - Total number of tools --- @@ -68,8 +56,6 @@ Total number of tools > **customToolsCount**: `number` -Defined in: [types/mcp.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L231) - Number of custom tools --- @@ -78,8 +64,6 @@ Number of custom tools > **inMemoryServersCount**: `number` -Defined in: [types/mcp.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L233) - Number of in-memory servers --- @@ -88,8 +72,6 @@ Number of in-memory servers > `optional` **error?**: `string` -Defined in: [types/mcp.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L235) - Error message --- @@ -98,8 +80,6 @@ Error message > `optional` **autoDiscoveredServers?**: [`MCPDiscoveredServer`](MCPDiscoveredServer.md)[] -Defined in: [types/mcp.ts:237](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L237) - Auto-discovered servers from various sources --- @@ -108,8 +88,6 @@ Auto-discovered servers from various sources > **connectedServers**: [`MCPConnectedServer`](MCPConnectedServer.md)[] -Defined in: [types/mcp.ts:239](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L239) - Currently connected servers --- @@ -118,8 +96,6 @@ Currently connected servers > **availableTools**: [`MCPToolInfo`](MCPToolInfo.md)[] -Defined in: [types/mcp.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L241) - Available tools across all servers --- @@ -128,6 +104,4 @@ Available tools across all servers > `optional` **serverRegistry?**: `Record`\<`string`, [`MCPServerInfo`](MCPServerInfo.md)\> -Defined in: [types/mcp.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L243) - Server registry entries diff --git a/docs/api/type-aliases/MCPServerStatusResponse.md b/docs/api/type-aliases/MCPServerStatusResponse.md index 2f3629583..bfcbb065c 100644 --- a/docs/api/type-aliases/MCPServerStatusResponse.md +++ b/docs/api/type-aliases/MCPServerStatusResponse.md @@ -8,8 +8,6 @@ > **MCPServerStatusResponse** = `object` -Defined in: [types/server.ts:733](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L733) - MCP server status response ## Properties @@ -18,8 +16,6 @@ MCP server status response > **serverId**: `string` -Defined in: [types/server.ts:735](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L735) - Server ID --- @@ -28,8 +24,6 @@ Server ID > **name**: `string` -Defined in: [types/server.ts:738](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L738) - Server name --- @@ -38,8 +32,6 @@ Server name > **status**: [`ExternalMCPServerStatus`](ExternalMCPServerStatus.md) -Defined in: [types/server.ts:741](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L741) - Connection status --- @@ -48,8 +40,6 @@ Connection status > **toolCount**: `number` -Defined in: [types/server.ts:744](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L744) - Available tools count --- @@ -58,8 +48,6 @@ Available tools count > `optional` **lastHealthCheck?**: `string` -Defined in: [types/server.ts:747](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L747) - Last health check time --- @@ -68,6 +56,4 @@ Last health check time > `optional` **error?**: `string` -Defined in: [types/server.ts:750](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L750) - Error message if failed diff --git a/docs/api/type-aliases/MCPServerTool.md b/docs/api/type-aliases/MCPServerTool.md index 8826c1354..71c008330 100644 --- a/docs/api/type-aliases/MCPServerTool.md +++ b/docs/api/type-aliases/MCPServerTool.md @@ -8,8 +8,6 @@ > **MCPServerTool** = `object` -Defined in: [types/mcp.ts:1084](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1084) - Enhanced tool definition with annotations. ## Properties @@ -18,48 +16,36 @@ Enhanced tool definition with annotations. > **name**: `string` -Defined in: [types/mcp.ts:1085](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1085) - --- ### description > **description**: `string` -Defined in: [types/mcp.ts:1086](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1086) - --- ### inputSchema? > `optional` **inputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:1087](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1087) - --- ### outputSchema? > `optional` **outputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:1088](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1088) - --- ### annotations? > `optional` **annotations?**: [`MCPToolAnnotations`](MCPToolAnnotations.md) -Defined in: [types/mcp.ts:1089](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1089) - --- ### execute > **execute**: (`params`, `context?`) => `Promise`\<[`ToolResult`](ToolResult.md) \| `unknown`\> -Defined in: [types/mcp.ts:1090](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1090) - #### Parameters ##### params @@ -79,5 +65,3 @@ Defined in: [types/mcp.ts:1090](https://github.com/juspay/neurolink/blob/release ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/mcp.ts:1094](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1094) diff --git a/docs/api/type-aliases/MCPStatus.md b/docs/api/type-aliases/MCPStatus.md index b3bf7d140..dd67e7319 100644 --- a/docs/api/type-aliases/MCPStatus.md +++ b/docs/api/type-aliases/MCPStatus.md @@ -8,8 +8,6 @@ > **MCPStatus** = `object` -Defined in: [types/mcp.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L325) - ## Indexable > \[`key`: `string`\]: `unknown` @@ -20,100 +18,74 @@ Defined in: [types/mcp.ts:325](https://github.com/juspay/neurolink/blob/release/ > **mcpInitialized**: `boolean` -Defined in: [types/mcp.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L326) - --- ### totalServers > **totalServers**: `number` -Defined in: [types/mcp.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L327) - --- ### availableServers > **availableServers**: `number` -Defined in: [types/mcp.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L328) - --- ### autoDiscoveredCount > **autoDiscoveredCount**: `number` -Defined in: [types/mcp.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L329) - --- ### totalTools > **totalTools**: `number` -Defined in: [types/mcp.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L330) - --- ### autoDiscoveredServers > **autoDiscoveredServers**: [`MCPServerInfo`](MCPServerInfo.md)[] -Defined in: [types/mcp.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L331) - --- ### customToolsCount > **customToolsCount**: `number` -Defined in: [types/mcp.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L332) - --- ### inMemoryServersCount > **inMemoryServersCount**: `number` -Defined in: [types/mcp.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L333) - --- ### externalMCPServersCount? > `optional` **externalMCPServersCount?**: `number` -Defined in: [types/mcp.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L334) - --- ### externalMCPConnectedCount? > `optional` **externalMCPConnectedCount?**: `number` -Defined in: [types/mcp.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L335) - --- ### externalMCPFailedCount? > `optional` **externalMCPFailedCount?**: `number` -Defined in: [types/mcp.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L336) - --- ### externalMCPServers? > `optional` **externalMCPServers?**: [`MCPServerInfo`](MCPServerInfo.md)[] -Defined in: [types/mcp.ts:337](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L337) - --- ### error? > `optional` **error?**: `string` - -Defined in: [types/mcp.ts:338](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L338) diff --git a/docs/api/type-aliases/MCPTool.md b/docs/api/type-aliases/MCPTool.md index cce89ac48..b71a85b50 100644 --- a/docs/api/type-aliases/MCPTool.md +++ b/docs/api/type-aliases/MCPTool.md @@ -8,8 +8,6 @@ > **MCPTool** = [`ToolInfo`](ToolInfo.md) & `object` -Defined in: [types/mcp.ts:2574](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2574) - MCP Tool type with annotations ## Type Declaration diff --git a/docs/api/type-aliases/MCPToolAnnotations.md b/docs/api/type-aliases/MCPToolAnnotations.md index 4ba95abb3..3e8b01a9e 100644 --- a/docs/api/type-aliases/MCPToolAnnotations.md +++ b/docs/api/type-aliases/MCPToolAnnotations.md @@ -8,8 +8,6 @@ > **MCPToolAnnotations** = `object` -Defined in: [types/mcp.ts:1052](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1052) - Tool annotation metadata for MCP tools. Provides hints to AI models about tool behavior and safety. @@ -19,8 +17,6 @@ Provides hints to AI models about tool behavior and safety. > `optional` **title?**: `string` -Defined in: [types/mcp.ts:1054](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1054) - Human-readable title for the tool --- @@ -29,8 +25,6 @@ Human-readable title for the tool > `optional` **readOnlyHint?**: `boolean` -Defined in: [types/mcp.ts:1056](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1056) - Whether the tool only reads data without side effects --- @@ -39,8 +33,6 @@ Whether the tool only reads data without side effects > `optional` **destructiveHint?**: `boolean` -Defined in: [types/mcp.ts:1058](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1058) - Whether the tool performs destructive operations --- @@ -49,8 +41,6 @@ Whether the tool performs destructive operations > `optional` **idempotentHint?**: `boolean` -Defined in: [types/mcp.ts:1060](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1060) - Whether the tool can be safely retried without side effects --- @@ -59,8 +49,6 @@ Whether the tool can be safely retried without side effects > `optional` **requiresConfirmation?**: `boolean` -Defined in: [types/mcp.ts:1062](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1062) - Whether the tool requires user confirmation before execution --- @@ -69,8 +57,6 @@ Whether the tool requires user confirmation before execution > `optional` **openWorldHint?**: `boolean` -Defined in: [types/mcp.ts:1064](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1064) - Whether the tool operates on an open world of resources --- @@ -79,8 +65,6 @@ Whether the tool operates on an open world of resources > `optional` **tags?**: `string`[] -Defined in: [types/mcp.ts:1066](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1066) - Custom tags for categorization and filtering --- @@ -89,8 +73,6 @@ Custom tags for categorization and filtering > `optional` **estimatedDuration?**: `number` -Defined in: [types/mcp.ts:1068](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1068) - Estimated execution time in milliseconds --- @@ -99,8 +81,6 @@ Estimated execution time in milliseconds > `optional` **rateLimitHint?**: `number` -Defined in: [types/mcp.ts:1070](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1070) - Rate limit hint (calls per minute) --- @@ -109,8 +89,6 @@ Rate limit hint (calls per minute) > `optional` **costHint?**: `number` -Defined in: [types/mcp.ts:1072](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1072) - Cost hint (arbitrary units for comparison) --- @@ -119,8 +97,6 @@ Cost hint (arbitrary units for comparison) > `optional` **complexity?**: `"simple"` \| `"medium"` \| `"complex"` -Defined in: [types/mcp.ts:1074](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1074) - Complexity level for UI display --- @@ -129,8 +105,6 @@ Complexity level for UI display > `optional` **auditRequired?**: `boolean` -Defined in: [types/mcp.ts:1076](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1076) - Whether tool execution should be audited/logged --- @@ -139,6 +113,4 @@ Whether tool execution should be audited/logged > `optional` **securityLevel?**: `"public"` \| `"internal"` \| `"restricted"` -Defined in: [types/mcp.ts:1078](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1078) - Security classification for the tool diff --git a/docs/api/type-aliases/MCPToolInfo.md b/docs/api/type-aliases/MCPToolInfo.md index 7381d2bbd..76339671e 100644 --- a/docs/api/type-aliases/MCPToolInfo.md +++ b/docs/api/type-aliases/MCPToolInfo.md @@ -8,8 +8,6 @@ > **MCPToolInfo** = `object` -Defined in: [types/mcp.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L278) - MCP Tool Information - High Reusability ## Properties @@ -18,60 +16,44 @@ MCP Tool Information - High Reusability > **name**: `string` -Defined in: [types/mcp.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L279) - --- ### description > **description**: `string` -Defined in: [types/mcp.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L280) - --- ### serverId > **serverId**: `string` -Defined in: [types/mcp.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L281) - --- ### isExternal > **isExternal**: `boolean` -Defined in: [types/mcp.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L282) - --- ### isImplemented? > `optional` **isImplemented?**: `boolean` -Defined in: [types/mcp.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L283) - --- ### inputSchema? > `optional` **inputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L284) - --- ### outputSchema? > `optional` **outputSchema?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L285) - --- ### metadata? > `optional` **metadata?**: [`MCPToolMetadata`](MCPToolMetadata.md) - -Defined in: [types/mcp.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L286) diff --git a/docs/api/type-aliases/MCPToolMetadata.md b/docs/api/type-aliases/MCPToolMetadata.md index bd57a665e..bb1cca3cf 100644 --- a/docs/api/type-aliases/MCPToolMetadata.md +++ b/docs/api/type-aliases/MCPToolMetadata.md @@ -8,8 +8,6 @@ > **MCPToolMetadata** = `object` & `object` -Defined in: [types/mcp.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L311) - MCP Tool Metadata - Extensible ## Type Declaration diff --git a/docs/api/type-aliases/MCPToolWithServer.md b/docs/api/type-aliases/MCPToolWithServer.md index ae2e2fba5..169d03c20 100644 --- a/docs/api/type-aliases/MCPToolWithServer.md +++ b/docs/api/type-aliases/MCPToolWithServer.md @@ -8,8 +8,6 @@ > **MCPToolWithServer** = `object` -Defined in: [types/cli.ts:1981](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1981) - Row in the MCP tools listing produced by `neurolink mcp tools`. ## Properties @@ -18,56 +16,42 @@ Row in the MCP tools listing produced by `neurolink mcp tools`. > **name**: `string` -Defined in: [types/cli.ts:1982](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1982) - --- ### description > **description**: `string` -Defined in: [types/cli.ts:1983](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1983) - --- ### serverId > **serverId**: `string` -Defined in: [types/cli.ts:1984](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1984) - --- ### serverName > **serverName**: `string` -Defined in: [types/cli.ts:1985](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1985) - --- ### inputSchema? > `optional` **inputSchema?**: `object` -Defined in: [types/cli.ts:1986](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1986) - --- ### category? > `optional` **category?**: `string` -Defined in: [types/cli.ts:1987](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1987) - --- ### annotations? > `optional` **annotations?**: `object` -Defined in: [types/cli.ts:1988](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1988) - #### readOnlyHint? > `optional` **readOnlyHint?**: `boolean` diff --git a/docs/api/type-aliases/MCPTransportType.md b/docs/api/type-aliases/MCPTransportType.md index 5676e21ec..b1e4a800e 100644 --- a/docs/api/type-aliases/MCPTransportType.md +++ b/docs/api/type-aliases/MCPTransportType.md @@ -8,6 +8,4 @@ > **MCPTransportType** = `"stdio"` \| `"sse"` \| `"websocket"` \| `"http"` \| `"ws"` \| `"tcp"` \| `"unix"` -Defined in: [types/mcp.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L28) - MCP Transport Types - Maximally Reusable diff --git a/docs/api/type-aliases/MDocumentConfig.md b/docs/api/type-aliases/MDocumentConfig.md index 1afe7157a..f5cf7bcce 100644 --- a/docs/api/type-aliases/MDocumentConfig.md +++ b/docs/api/type-aliases/MDocumentConfig.md @@ -8,8 +8,6 @@ > **MDocumentConfig** = `object` -Defined in: [types/rag.ts:1522](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1522) - MDocument configuration ## Properties @@ -18,8 +16,6 @@ MDocument configuration > **type**: [`DocumentType`](DocumentType.md) -Defined in: [types/rag.ts:1524](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1524) - Document type --- @@ -28,6 +24,4 @@ Document type > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/rag.ts:1526](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1526) - Custom metadata diff --git a/docs/api/type-aliases/ManagedLogFile.md b/docs/api/type-aliases/ManagedLogFile.md index 0c3a368cf..a7c92cf28 100644 --- a/docs/api/type-aliases/ManagedLogFile.md +++ b/docs/api/type-aliases/ManagedLogFile.md @@ -8,8 +8,6 @@ > **ManagedLogFile** = `object` -Defined in: [types/proxy.ts:3052](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3052) - File the proxy logger tracks for rotation and cleanup. ## Properties @@ -18,20 +16,14 @@ File the proxy logger tracks for rotation and cleanup. > **path**: `string` -Defined in: [types/proxy.ts:3053](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3053) - --- ### mtime > **mtime**: `number` -Defined in: [types/proxy.ts:3054](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3054) - --- ### size > **size**: `number` - -Defined in: [types/proxy.ts:3055](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3055) diff --git a/docs/api/type-aliases/ManifestFamilyRule.md b/docs/api/type-aliases/ManifestFamilyRule.md index 8cd731fc8..0262d41bf 100644 --- a/docs/api/type-aliases/ManifestFamilyRule.md +++ b/docs/api/type-aliases/ManifestFamilyRule.md @@ -8,8 +8,6 @@ > **ManifestFamilyRule** = `object` -Defined in: [types/model.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L332) - A regex-driven patch applied to an unlisted, gateway-shaped model id that matches `pattern` (e.g. "vertex_ai/claude-sonnet-5@20260203"). Generalizes the pattern VISION_FAMILY_RULES (src/lib/adapters/providerImageAdapter.ts) @@ -22,12 +20,8 @@ already use independently, keyed per-provider instead of globally. > **pattern**: `RegExp` -Defined in: [types/model.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L333) - --- ### patch > **patch**: `Partial`\<[`ProviderModelManifestEntry`](ProviderModelManifestEntry.md)\> - -Defined in: [types/model.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L334) diff --git a/docs/api/type-aliases/MarkdownChunkerConfig.md b/docs/api/type-aliases/MarkdownChunkerConfig.md index bf7abe0af..e0c919867 100644 --- a/docs/api/type-aliases/MarkdownChunkerConfig.md +++ b/docs/api/type-aliases/MarkdownChunkerConfig.md @@ -8,8 +8,6 @@ > **MarkdownChunkerConfig** = [`BaseChunkerConfig`](BaseChunkerConfig.md) & `object` -Defined in: [types/rag.ts:957](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L957) - Markdown chunker configuration Structure-aware markdown splitting diff --git a/docs/api/type-aliases/Maybe.md b/docs/api/type-aliases/Maybe.md index 01a1ce94c..735898e73 100644 --- a/docs/api/type-aliases/Maybe.md +++ b/docs/api/type-aliases/Maybe.md @@ -8,8 +8,6 @@ > **Maybe**\<`T`\> = `T` \| `null` \| `undefined` -Defined in: [types/aliases.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L290) - Maybe type (combines null and undefined) ## Type Parameters diff --git a/docs/api/type-aliases/McpCacheConfig.md b/docs/api/type-aliases/McpCacheConfig.md index 3d3dda671..dd23fc8e5 100644 --- a/docs/api/type-aliases/McpCacheConfig.md +++ b/docs/api/type-aliases/McpCacheConfig.md @@ -8,8 +8,6 @@ > **McpCacheConfig** = `object` -Defined in: [types/mcp.ts:2386](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2386) - Cache configuration options ## Properties @@ -18,8 +16,6 @@ Cache configuration options > **ttl**: `number` -Defined in: [types/mcp.ts:2390](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2390) - Time-to-live in milliseconds (default: 5 minutes) --- @@ -28,8 +24,6 @@ Time-to-live in milliseconds (default: 5 minutes) > **maxSize**: `number` -Defined in: [types/mcp.ts:2395](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2395) - Maximum number of entries (default: 500) --- @@ -38,8 +32,6 @@ Maximum number of entries (default: 500) > **strategy**: [`CacheStrategy`](CacheStrategy.md) -Defined in: [types/mcp.ts:2400](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2400) - Eviction strategy (default: 'lru') --- @@ -48,8 +40,6 @@ Eviction strategy (default: 'lru') > `optional` **enableAutoCleanup?**: `boolean` -Defined in: [types/mcp.ts:2405](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2405) - Enable automatic cleanup of expired entries --- @@ -58,8 +48,6 @@ Enable automatic cleanup of expired entries > `optional` **cleanupInterval?**: `number` -Defined in: [types/mcp.ts:2410](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2410) - Cleanup interval in milliseconds (default: 60 seconds) --- @@ -68,6 +56,4 @@ Cleanup interval in milliseconds (default: 60 seconds) > `optional` **namespace?**: `string` -Defined in: [types/mcp.ts:2415](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2415) - Namespace for cache keys (optional) diff --git a/docs/api/type-aliases/McpCacheEntry.md b/docs/api/type-aliases/McpCacheEntry.md index d97716d52..19e9e6c12 100644 --- a/docs/api/type-aliases/McpCacheEntry.md +++ b/docs/api/type-aliases/McpCacheEntry.md @@ -8,8 +8,6 @@ > **McpCacheEntry**\<`T`\> = `object` -Defined in: [types/mcp.ts:2603](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2603) - Cached entry held by ToolCache. Named McpCacheEntry to disambiguate from the response-caching middleware's CacheEntry in server.ts (Rule 9). @@ -25,44 +23,32 @@ the response-caching middleware's CacheEntry in server.ts (Rule 9). > **value**: `T` -Defined in: [types/mcp.ts:2604](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2604) - --- ### expires > **expires**: `number` -Defined in: [types/mcp.ts:2605](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2605) - --- ### createdAt > **createdAt**: `number` -Defined in: [types/mcp.ts:2606](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2606) - --- ### accessedAt > **accessedAt**: `number` -Defined in: [types/mcp.ts:2607](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2607) - --- ### accessCount > **accessCount**: `number` -Defined in: [types/mcp.ts:2608](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2608) - --- ### key > **key**: `string` - -Defined in: [types/mcp.ts:2609](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2609) diff --git a/docs/api/type-aliases/McpMetadata.md b/docs/api/type-aliases/McpMetadata.md index 1ead37bbf..39a97310d 100644 --- a/docs/api/type-aliases/McpMetadata.md +++ b/docs/api/type-aliases/McpMetadata.md @@ -8,8 +8,6 @@ > **McpMetadata** = `object` -Defined in: [types/mcp.ts:560](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L560) - MCP server metadata Moved from src/lib/mcp/contracts/mcpContract.ts @@ -19,52 +17,38 @@ Moved from src/lib/mcp/contracts/mcpContract.ts > **name**: `string` -Defined in: [types/mcp.ts:561](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L561) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/mcp.ts:562](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L562) - --- ### version? > `optional` **version?**: `string` -Defined in: [types/mcp.ts:563](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L563) - --- ### author? > `optional` **author?**: `string` -Defined in: [types/mcp.ts:564](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L564) - --- ### homepage? > `optional` **homepage?**: `string` -Defined in: [types/mcp.ts:565](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L565) - --- ### repository? > `optional` **repository?**: `string` -Defined in: [types/mcp.ts:566](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L566) - --- ### category? > `optional` **category?**: `string` - -Defined in: [types/mcp.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L567) diff --git a/docs/api/type-aliases/McpOperationConfig.md b/docs/api/type-aliases/McpOperationConfig.md index 801d15cc8..69abe9b68 100644 --- a/docs/api/type-aliases/McpOperationConfig.md +++ b/docs/api/type-aliases/McpOperationConfig.md @@ -8,6 +8,4 @@ > **McpOperationConfig** = _typeof_ `MCP_OPERATION_CONFIGS`\[keyof _typeof_ `MCP_OPERATION_CONFIGS`\] -Defined in: [types/config.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L588) - MCP-specific operation config. diff --git a/docs/api/type-aliases/McpOutputContext.md b/docs/api/type-aliases/McpOutputContext.md index 55df1bad2..5918a25f9 100644 --- a/docs/api/type-aliases/McpOutputContext.md +++ b/docs/api/type-aliases/McpOutputContext.md @@ -8,8 +8,6 @@ > **McpOutputContext** = `object` -Defined in: [types/mcpOutput.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L28) - Contextual info passed alongside the raw MCP callResult. ## Properties @@ -18,20 +16,14 @@ Contextual info passed alongside the raw MCP callResult. > **toolName**: `string` -Defined in: [types/mcpOutput.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L29) - --- ### serverId > **serverId**: `string` -Defined in: [types/mcpOutput.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L30) - --- ### sessionId? > `optional` **sessionId?**: `string` - -Defined in: [types/mcpOutput.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L31) diff --git a/docs/api/type-aliases/McpOutputNormalizerConfig.md b/docs/api/type-aliases/McpOutputNormalizerConfig.md index 8ad593260..9298d0c2a 100644 --- a/docs/api/type-aliases/McpOutputNormalizerConfig.md +++ b/docs/api/type-aliases/McpOutputNormalizerConfig.md @@ -8,8 +8,6 @@ > **McpOutputNormalizerConfig** = `object` -Defined in: [types/mcpOutput.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L19) - Configuration for McpOutputNormalizer. ## Properties @@ -18,16 +16,12 @@ Configuration for McpOutputNormalizer. > **strategy**: [`McpOutputStrategy`](McpOutputStrategy.md) -Defined in: [types/mcpOutput.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L20) - --- ### maxBytes > **maxBytes**: `number` -Defined in: [types/mcpOutput.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L22) - Byte ceiling above which the strategy fires. --- @@ -36,6 +30,4 @@ Byte ceiling above which the strategy fires. > **warnBytes**: `number` -Defined in: [types/mcpOutput.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L24) - Bytes at which a warning is emitted while still inline. diff --git a/docs/api/type-aliases/McpOutputStrategy.md b/docs/api/type-aliases/McpOutputStrategy.md index 6d9ec1681..d0de04249 100644 --- a/docs/api/type-aliases/McpOutputStrategy.md +++ b/docs/api/type-aliases/McpOutputStrategy.md @@ -8,8 +8,6 @@ > **McpOutputStrategy** = `"inline"` \| `"externalize"` -Defined in: [types/mcpOutput.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L16) - Two honest strategies for oversized MCP tool outputs: - "inline" Full payload always sent to the model (warning logged above warnBytes). diff --git a/docs/api/type-aliases/McpRegistry.md b/docs/api/type-aliases/McpRegistry.md index 372f5e02e..74ff76bdd 100644 --- a/docs/api/type-aliases/McpRegistry.md +++ b/docs/api/type-aliases/McpRegistry.md @@ -8,8 +8,6 @@ > **McpRegistry** = `object` -Defined in: [types/mcp.ts:804](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L804) - MCP Registry type with optional methods for maximum flexibility Moved from src/lib/mcp/registry.ts @@ -19,8 +17,6 @@ Moved from src/lib/mcp/registry.ts > `optional` **registerServer**(`serverId`, `serverConfig?`, `context?`): `Promise`\<`void`\> -Defined in: [types/mcp.ts:806](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L806) - #### Parameters ##### serverId @@ -45,8 +41,6 @@ Defined in: [types/mcp.ts:806](https://github.com/juspay/neurolink/blob/release/ > `optional` **executeTool**\<`T`\>(`toolName`, `args?`, `context?`): `Promise`\<`T`\> -Defined in: [types/mcp.ts:811](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L811) - #### Type Parameters ##### T @@ -77,8 +71,6 @@ Defined in: [types/mcp.ts:811](https://github.com/juspay/neurolink/blob/release/ > `optional` **listTools**(`context?`): `Promise`\<[`ToolInfo`](ToolInfo.md)[]\> -Defined in: [types/mcp.ts:816](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L816) - #### Parameters ##### context? diff --git a/docs/api/type-aliases/McpRegistryEntry.md b/docs/api/type-aliases/McpRegistryEntry.md index 6212528a4..227d29c67 100644 --- a/docs/api/type-aliases/McpRegistryEntry.md +++ b/docs/api/type-aliases/McpRegistryEntry.md @@ -8,8 +8,6 @@ > **McpRegistryEntry** = `object` -Defined in: [types/mcp.ts:1544](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1544) - Registry entry for an MCP server ## Properties @@ -18,8 +16,6 @@ Registry entry for an MCP server > **id**: `string` -Defined in: [types/mcp.ts:1548](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1548) - Unique identifier --- @@ -28,8 +24,6 @@ Unique identifier > **name**: `string` -Defined in: [types/mcp.ts:1553](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1553) - Server name --- @@ -38,8 +32,6 @@ Server name > **description**: `string` -Defined in: [types/mcp.ts:1558](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1558) - Server description --- @@ -48,8 +40,6 @@ Server description > **version**: `string` -Defined in: [types/mcp.ts:1563](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1563) - Server version --- @@ -58,8 +48,6 @@ Server version > `optional` **author?**: `string` -Defined in: [types/mcp.ts:1568](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1568) - Author or maintainer --- @@ -68,8 +56,6 @@ Author or maintainer > `optional` **license?**: `string` -Defined in: [types/mcp.ts:1573](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1573) - License --- @@ -78,8 +64,6 @@ License > `optional` **homepage?**: `string` -Defined in: [types/mcp.ts:1578](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1578) - Homepage URL --- @@ -88,8 +72,6 @@ Homepage URL > `optional` **repository?**: `string` -Defined in: [types/mcp.ts:1583](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1583) - Repository URL --- @@ -98,8 +80,6 @@ Repository URL > `optional` **npmPackage?**: `string` -Defined in: [types/mcp.ts:1588](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1588) - NPM package name (if applicable) --- @@ -108,8 +88,6 @@ NPM package name (if applicable) > `optional` **installCommand?**: `string` -Defined in: [types/mcp.ts:1593](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1593) - Installation command --- @@ -118,8 +96,6 @@ Installation command > `optional` **command?**: `string` -Defined in: [types/mcp.ts:1598](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1598) - Command to run the server --- @@ -128,8 +104,6 @@ Command to run the server > `optional` **args?**: `string`[] -Defined in: [types/mcp.ts:1603](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1603) - Command arguments --- @@ -138,8 +112,6 @@ Command arguments > `optional` **requiredEnvVars?**: `string`[] -Defined in: [types/mcp.ts:1608](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1608) - Required environment variables --- @@ -148,8 +120,6 @@ Required environment variables > `optional` **transports?**: [`MCPTransportType`](MCPTransportType.md)[] -Defined in: [types/mcp.ts:1613](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1613) - Supported transport types --- @@ -158,8 +128,6 @@ Supported transport types > `optional` **categories?**: `string`[] -Defined in: [types/mcp.ts:1618](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1618) - Server categories --- @@ -168,8 +136,6 @@ Server categories > `optional` **tags?**: `string`[] -Defined in: [types/mcp.ts:1623](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1623) - Server tags --- @@ -178,8 +144,6 @@ Server tags > `optional` **tools?**: `string`[] -Defined in: [types/mcp.ts:1628](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1628) - Tool names provided by the server --- @@ -188,8 +152,6 @@ Tool names provided by the server > `optional` **downloads?**: `number` -Defined in: [types/mcp.ts:1633](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1633) - Download count (popularity metric) --- @@ -198,8 +160,6 @@ Download count (popularity metric) > `optional` **stars?**: `number` -Defined in: [types/mcp.ts:1638](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1638) - Star count (if from GitHub) --- @@ -208,8 +168,6 @@ Star count (if from GitHub) > `optional` **lastUpdated?**: `string` -Defined in: [types/mcp.ts:1643](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1643) - Last updated date --- @@ -218,8 +176,6 @@ Last updated date > `optional` **verified?**: `boolean` -Defined in: [types/mcp.ts:1648](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1648) - Verification status --- @@ -228,6 +184,4 @@ Verification status > `optional` **metadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:1653](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1653) - Custom metadata diff --git a/docs/api/type-aliases/McpServerWeight.md b/docs/api/type-aliases/McpServerWeight.md index cf9fc01ba..e626d6e99 100644 --- a/docs/api/type-aliases/McpServerWeight.md +++ b/docs/api/type-aliases/McpServerWeight.md @@ -8,8 +8,6 @@ > **McpServerWeight** = `object` -Defined in: [types/mcp.ts:2459](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2459) - Server routing weight configuration ## Properties @@ -18,20 +16,14 @@ Server routing weight configuration > **serverId**: `string` -Defined in: [types/mcp.ts:2460](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2460) - --- ### weight > **weight**: `number` -Defined in: [types/mcp.ts:2461](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2461) - --- ### capabilities? > `optional` **capabilities?**: `string`[] - -Defined in: [types/mcp.ts:2462](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2462) diff --git a/docs/api/type-aliases/MediaGenerationOutputs.md b/docs/api/type-aliases/MediaGenerationOutputs.md index acfe358d5..fecb08123 100644 --- a/docs/api/type-aliases/MediaGenerationOutputs.md +++ b/docs/api/type-aliases/MediaGenerationOutputs.md @@ -8,8 +8,6 @@ > **MediaGenerationOutputs** = `object` -Defined in: [types/generate.ts:1000](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1000) - Media generation/processing outputs shared by GenerateResult and TextGenerationResult. Extracted so both result types intersect (&) this single definition instead of each declaring its own drifting copy of the @@ -21,8 +19,6 @@ same audio/video/avatar/music/ppt/image/transcription fields. > `optional` **audio?**: [`TTSResult`](TTSResult.md) -Defined in: [types/generate.ts:1029](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1029) - Text-to-Speech audio result Contains the generated audio buffer and metadata when TTS is enabled. @@ -57,8 +53,6 @@ if (result.audio) { > `optional` **ttsMetadata?**: [`TTSMetadata`](TTSMetadata.md) -Defined in: [types/generate.ts:1043](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1043) - What happened during TTS synthesis, including why it failed. `generate()` degrades gracefully when synthesis fails: it returns the text @@ -77,8 +71,6 @@ neurolink.ts describes, on a different field. > `optional` **video?**: [`VideoGenerationResult`](VideoGenerationResult.md) -Defined in: [types/generate.ts:1067](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1067) - Video generation result Contains the generated video buffer and metadata when video mode is enabled. @@ -109,8 +101,6 @@ if (result.video) { > `optional` **avatar?**: [`AvatarResult`](AvatarResult.md) -Defined in: [types/generate.ts:1071](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1071) - Avatar (talking-head) generation result (present when output.mode is "avatar") --- @@ -119,8 +109,6 @@ Avatar (talking-head) generation result (present when output.mode is "avatar") > `optional` **music?**: [`MusicResult`](MusicResult.md) -Defined in: [types/generate.ts:1075](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1075) - Music generation result (present when output.mode is "music") --- @@ -129,8 +117,6 @@ Music generation result (present when output.mode is "music") > `optional` **ppt?**: [`PPTGenerationResult`](PPTGenerationResult.md) -Defined in: [types/generate.ts:1093](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1093) - PowerPoint generation result (present when output.mode is "ppt") #### Example @@ -154,8 +140,6 @@ if (result.ppt) { > `optional` **imageOutput?**: \{ `base64`: `string`; `mimeType?`: `string`; \} \| `null` -Defined in: [types/generate.ts:1099](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1099) - Standard format for image generation. `mimeType` is set when the provider can identify the encoded format (sniffed from the image bytes, e.g. Recraft returns WebP), so callers do not have to assume PNG. @@ -166,6 +150,4 @@ Recraft returns WebP), so callers do not have to assume PNG. > `optional` **transcription?**: [`STTResult`](STTResult.md) -Defined in: [types/generate.ts:1101](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1101) - STT transcription result (present when stt.enabled is true and audio input was provided) diff --git a/docs/api/type-aliases/MediaHandlerDescriptor.md b/docs/api/type-aliases/MediaHandlerDescriptor.md index 210d644ec..9c3b8f4ec 100644 --- a/docs/api/type-aliases/MediaHandlerDescriptor.md +++ b/docs/api/type-aliases/MediaHandlerDescriptor.md @@ -8,28 +8,20 @@ > **MediaHandlerDescriptor** = `object` -Defined in: [types/mediaCatalog.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/mediaCatalog.ts#L16) - ## Properties ### kind > `readonly` **kind**: [`MediaHandlerKind`](MediaHandlerKind.md) -Defined in: [types/mediaCatalog.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/mediaCatalog.ts#L17) - --- ### name > `readonly` **name**: `string` -Defined in: [types/mediaCatalog.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/mediaCatalog.ts#L18) - --- ### aliases? > `readonly` `optional` **aliases?**: readonly `string`[] - -Defined in: [types/mediaCatalog.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/mediaCatalog.ts#L19) diff --git a/docs/api/type-aliases/MediaHandlerKind.md b/docs/api/type-aliases/MediaHandlerKind.md index 33ee322db..cfb3c4f01 100644 --- a/docs/api/type-aliases/MediaHandlerKind.md +++ b/docs/api/type-aliases/MediaHandlerKind.md @@ -8,8 +8,6 @@ > **MediaHandlerKind** = `"tts"` \| `"stt"` \| `"realtime"` \| `"video"` \| `"avatar"` \| `"music"` -Defined in: [types/mediaCatalog.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/types/mediaCatalog.ts#L8) - Types backing the static media-handler catalog (src/lib/factories/mediaHandlerCatalog.ts) — the single source of truth for provider names/aliases across the six media-generation ecosystems diff --git a/docs/api/type-aliases/MemoryCustomStorageConfig.md b/docs/api/type-aliases/MemoryCustomStorageConfig.md index 985235102..3c8485e4c 100644 --- a/docs/api/type-aliases/MemoryCustomStorageConfig.md +++ b/docs/api/type-aliases/MemoryCustomStorageConfig.md @@ -8,24 +8,18 @@ > **MemoryCustomStorageConfig** = `object` -Defined in: [types/memory.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L45) - ## Properties ### type > **type**: `"custom"` -Defined in: [types/memory.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L46) - --- ### onGet > **onGet**: (`ownerId`) => `Promise`\<`string` \| `null`\> -Defined in: [types/memory.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L47) - #### Parameters ##### ownerId @@ -42,8 +36,6 @@ Defined in: [types/memory.ts:47](https://github.com/juspay/neurolink/blob/releas > **onSet**: (`ownerId`, `memory`) => `Promise`\<`void`\> -Defined in: [types/memory.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L48) - #### Parameters ##### ownerId @@ -64,8 +56,6 @@ Defined in: [types/memory.ts:48](https://github.com/juspay/neurolink/blob/releas > **onDelete**: (`ownerId`) => `Promise`\<`void`\> -Defined in: [types/memory.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L49) - #### Parameters ##### ownerId @@ -82,8 +72,6 @@ Defined in: [types/memory.ts:49](https://github.com/juspay/neurolink/blob/releas > `optional` **onClose?**: () => `Promise`\<`void`\> -Defined in: [types/memory.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L50) - #### Returns `Promise`\<`void`\> diff --git a/docs/api/type-aliases/MemoryMetricConfig.md b/docs/api/type-aliases/MemoryMetricConfig.md index 980be50c4..7a4531e24 100644 --- a/docs/api/type-aliases/MemoryMetricConfig.md +++ b/docs/api/type-aliases/MemoryMetricConfig.md @@ -8,20 +8,14 @@ > **MemoryMetricConfig** = `object` -Defined in: [types/autoresearch.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L25) - ## Properties ### name > **name**: `string` -Defined in: [types/autoresearch.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L26) - --- ### pattern > **pattern**: `string` - -Defined in: [types/autoresearch.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L27) diff --git a/docs/api/type-aliases/MemoryRedisStorageConfig.md b/docs/api/type-aliases/MemoryRedisStorageConfig.md index 1b366233e..72939d6c4 100644 --- a/docs/api/type-aliases/MemoryRedisStorageConfig.md +++ b/docs/api/type-aliases/MemoryRedisStorageConfig.md @@ -8,60 +8,44 @@ > **MemoryRedisStorageConfig** = `object` -Defined in: [types/memory.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L29) - ## Properties ### type > **type**: `"redis"` -Defined in: [types/memory.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L30) - --- ### host? > `optional` **host?**: `string` -Defined in: [types/memory.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L31) - --- ### port? > `optional` **port?**: `number` -Defined in: [types/memory.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L32) - --- ### password? > `optional` **password?**: `string` -Defined in: [types/memory.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L33) - --- ### db? > `optional` **db?**: `number` -Defined in: [types/memory.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L34) - --- ### keyPrefix? > `optional` **keyPrefix?**: `string` -Defined in: [types/memory.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L35) - --- ### ttl? > `optional` **ttl?**: `number` - -Defined in: [types/memory.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L36) diff --git a/docs/api/type-aliases/MemoryS3StorageConfig.md b/docs/api/type-aliases/MemoryS3StorageConfig.md index 648f2bd57..c25ef5eac 100644 --- a/docs/api/type-aliases/MemoryS3StorageConfig.md +++ b/docs/api/type-aliases/MemoryS3StorageConfig.md @@ -8,28 +8,20 @@ > **MemoryS3StorageConfig** = `object` -Defined in: [types/memory.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L39) - ## Properties ### type > **type**: `"s3"` -Defined in: [types/memory.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L40) - --- ### bucket > **bucket**: `string` -Defined in: [types/memory.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L41) - --- ### prefix? > `optional` **prefix?**: `string` - -Defined in: [types/memory.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L42) diff --git a/docs/api/type-aliases/MemorySqliteStorageConfig.md b/docs/api/type-aliases/MemorySqliteStorageConfig.md index 93871e5f7..f105d644a 100644 --- a/docs/api/type-aliases/MemorySqliteStorageConfig.md +++ b/docs/api/type-aliases/MemorySqliteStorageConfig.md @@ -8,8 +8,6 @@ > **MemorySqliteStorageConfig** = `object` -Defined in: [types/memory.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L23) - Local structural types for the optional @juspay/hippocampus integration. These mirror the public shapes that ship with @juspay/hippocampus's @@ -37,14 +35,10 @@ Naming: > **type**: `"sqlite"` -Defined in: [types/memory.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L24) - --- ### path? > `optional` **path?**: `string` -Defined in: [types/memory.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/memory.ts#L26) - Path to SQLite file. Default: ./data/hippocampus.sqlite diff --git a/docs/api/type-aliases/MenuChoice.md b/docs/api/type-aliases/MenuChoice.md index c4cf715d7..95f822ff2 100644 --- a/docs/api/type-aliases/MenuChoice.md +++ b/docs/api/type-aliases/MenuChoice.md @@ -8,6 +8,4 @@ > **MenuChoice** = [`ConversationChoice`](ConversationChoice.md) \| \{ `type`: `"separator"`; `line?`: `string`; \} -Defined in: [types/cli.ts:1419](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1419) - Menu choice type for conversation selector (includes separators). diff --git a/docs/api/type-aliases/Message.md b/docs/api/type-aliases/Message.md index 76b2dee30..843f7b77b 100644 --- a/docs/api/type-aliases/Message.md +++ b/docs/api/type-aliases/Message.md @@ -8,8 +8,6 @@ > **Message** = `object` -Defined in: [types/server.ts:1345](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1345) - Voice-server conversation turn — superset role set. ## Properties @@ -18,12 +16,8 @@ Voice-server conversation turn — superset role set. > **role**: `"system"` \| `"user"` \| `"assistant"` -Defined in: [types/server.ts:1346](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1346) - --- ### content > **content**: `string` - -Defined in: [types/server.ts:1347](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1347) diff --git a/docs/api/type-aliases/MessageBusConfig.md b/docs/api/type-aliases/MessageBusConfig.md index 8545b744b..05e367edb 100644 --- a/docs/api/type-aliases/MessageBusConfig.md +++ b/docs/api/type-aliases/MessageBusConfig.md @@ -8,8 +8,6 @@ > **MessageBusConfig** = `object` -Defined in: [types/agentNetwork.ts:1156](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1156) - Message bus configuration ## Properties @@ -18,8 +16,6 @@ Message bus configuration > `optional` **maxHistorySize?**: `number` -Defined in: [types/agentNetwork.ts:1158](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1158) - Maximum messages to retain in history --- @@ -28,8 +24,6 @@ Maximum messages to retain in history > `optional` **defaultTtl?**: `number` -Defined in: [types/agentNetwork.ts:1161](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1161) - Default message TTL in ms --- @@ -38,8 +32,6 @@ Default message TTL in ms > `optional` **enablePersistence?**: `boolean` -Defined in: [types/agentNetwork.ts:1164](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1164) - Enable message persistence --- @@ -48,8 +40,6 @@ Enable message persistence > `optional` **enableDeadLetterQueue?**: `boolean` -Defined in: [types/agentNetwork.ts:1167](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1167) - Dead letter queue for failed messages --- @@ -58,6 +48,4 @@ Dead letter queue for failed messages > `optional` **requestTimeout?**: `number` -Defined in: [types/agentNetwork.ts:1170](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1170) - Request timeout for request-response pattern diff --git a/docs/api/type-aliases/MessageBusSubscription.md b/docs/api/type-aliases/MessageBusSubscription.md index bf64efc25..281db7b29 100644 --- a/docs/api/type-aliases/MessageBusSubscription.md +++ b/docs/api/type-aliases/MessageBusSubscription.md @@ -8,8 +8,6 @@ > **MessageBusSubscription** = `object` -Defined in: [types/agentNetwork.ts:1661](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1661) - MessageBus subscription record ## Properties @@ -18,44 +16,32 @@ MessageBus subscription record > **id**: `string` -Defined in: [types/agentNetwork.ts:1662](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1662) - --- ### topic > **topic**: `string` -Defined in: [types/agentNetwork.ts:1663](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1663) - --- ### handler > **handler**: [`MessageHandler`](MessageHandler.md) -Defined in: [types/agentNetwork.ts:1664](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1664) - --- ### options > **options**: [`SubscriptionOptions`](SubscriptionOptions.md) -Defined in: [types/agentNetwork.ts:1665](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1665) - --- ### messageCount > **messageCount**: `number` -Defined in: [types/agentNetwork.ts:1666](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1666) - --- ### subscriberId > **subscriberId**: `string` - -Defined in: [types/agentNetwork.ts:1667](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1667) diff --git a/docs/api/type-aliases/MessageContent.md b/docs/api/type-aliases/MessageContent.md index 038ae9150..ef5cedd5a 100644 --- a/docs/api/type-aliases/MessageContent.md +++ b/docs/api/type-aliases/MessageContent.md @@ -8,8 +8,6 @@ > **MessageContent** = `object` -Defined in: [types/multimodal.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L500) - Content format for multimodal messages (used internally). #325: the loose `[key: string]: unknown` index signature has been replaced @@ -26,16 +24,12 @@ unrelated keys through unchecked. > **type**: `string` -Defined in: [types/multimodal.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L501) - --- ### text? > `optional` **text?**: `string` -Defined in: [types/multimodal.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L503) - Text content (`type: "text"`). --- @@ -44,8 +38,6 @@ Text content (`type: "text"`). > `optional` **image?**: `string` -Defined in: [types/multimodal.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L505) - Base64 / data-URI image (`type: "image"`). --- @@ -54,8 +46,6 @@ Base64 / data-URI image (`type: "image"`). > `optional` **mimeType?**: `string` -Defined in: [types/multimodal.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L507) - MIME type for image/file parts. --- @@ -64,8 +54,6 @@ MIME type for image/file parts. > `optional` **data?**: `string` \| `Buffer` -Defined in: [types/multimodal.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L509) - Raw file bytes or base64 (`type: "file"`/document parts). --- @@ -74,8 +62,6 @@ Raw file bytes or base64 (`type: "file"`/document parts). > `optional` **name?**: `string` -Defined in: [types/multimodal.ts:511](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L511) - File name for document/file parts. --- @@ -84,8 +70,6 @@ File name for document/file parts. > `optional` **filename?**: `string` -Defined in: [types/multimodal.ts:513](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L513) - File name (alias used by some file parts). --- @@ -94,8 +78,6 @@ File name (alias used by some file parts). > `optional` **toolCallId?**: `string` -Defined in: [types/multimodal.ts:515](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L515) - Tool-call identifier (`type: "tool-call"`/`"tool-result"`). --- @@ -104,8 +86,6 @@ Tool-call identifier (`type: "tool-call"`/`"tool-result"`). > `optional` **toolName?**: `string` -Defined in: [types/multimodal.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L517) - Tool name (`type: "tool-call"`/`"tool-result"`). --- @@ -114,8 +94,6 @@ Tool name (`type: "tool-call"`/`"tool-result"`). > `optional` **args?**: `Record`\<`string`, `unknown`\> -Defined in: [types/multimodal.ts:519](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L519) - Tool-call arguments (`type: "tool-call"`). --- @@ -124,8 +102,6 @@ Tool-call arguments (`type: "tool-call"`). > `optional` **result?**: `unknown` -Defined in: [types/multimodal.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L521) - Tool-result payload (`type: "tool-result"`). --- @@ -134,8 +110,6 @@ Tool-result payload (`type: "tool-result"`). > `optional` **isError?**: `boolean` -Defined in: [types/multimodal.ts:523](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L523) - Whether a tool-result represents an error (`type: "tool-result"`). --- @@ -144,8 +118,6 @@ Whether a tool-result represents an error (`type: "tool-result"`). > `optional` **providerOptions?**: `Record`\<`string`, `unknown`\> -Defined in: [types/multimodal.ts:529](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L529) - Provider-specific per-block options (e.g. Anthropic cache_control). Read as `item.providerOptions` when converting `MessageContent[]` to `ModelMessage[]` in `MessageBuilder.ts`. diff --git a/docs/api/type-aliases/MessageHandler.md b/docs/api/type-aliases/MessageHandler.md index 72cec073b..0ec1ab0e8 100644 --- a/docs/api/type-aliases/MessageHandler.md +++ b/docs/api/type-aliases/MessageHandler.md @@ -8,8 +8,6 @@ > **MessageHandler** = (`message`) => `void` \| `Promise`\<`void`\> -Defined in: [types/agentNetwork.ts:1131](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1131) - Message handler function type ## Parameters diff --git a/docs/api/type-aliases/MessagePriority.md b/docs/api/type-aliases/MessagePriority.md index 5b593ce6d..a78ae554e 100644 --- a/docs/api/type-aliases/MessagePriority.md +++ b/docs/api/type-aliases/MessagePriority.md @@ -8,6 +8,4 @@ > **MessagePriority** = `"high"` \| `"normal"` \| `"low"` -Defined in: [types/agentNetwork.ts:1085](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1085) - Message priority levels diff --git a/docs/api/type-aliases/MessageType.md b/docs/api/type-aliases/MessageType.md index a3d294708..351a9bb9f 100644 --- a/docs/api/type-aliases/MessageType.md +++ b/docs/api/type-aliases/MessageType.md @@ -8,6 +8,4 @@ > **MessageType** = `"request"` \| `"response"` \| `"broadcast"` \| `"direct"` \| `"event"` \| `"command"` -Defined in: [types/agentNetwork.ts:1074](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1074) - Message types for agent communication diff --git a/docs/api/type-aliases/MetadataExtractor.md b/docs/api/type-aliases/MetadataExtractor.md index 3161f3d31..f61b746c6 100644 --- a/docs/api/type-aliases/MetadataExtractor.md +++ b/docs/api/type-aliases/MetadataExtractor.md @@ -8,8 +8,6 @@ > **MetadataExtractor** = `object` -Defined in: [types/rag.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L104) - Metadata Extractor type - all extractors implement this ## Properties @@ -18,8 +16,6 @@ Metadata Extractor type - all extractors implement this > `readonly` **type**: [`MetadataExtractorType`](MetadataExtractorType.md) -Defined in: [types/rag.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L106) - Extractor type identifier ## Methods @@ -28,8 +24,6 @@ Extractor type identifier > **extract**(`chunks`, `params?`): `Promise`\<[`ExtractionResult`](ExtractionResult.md)[]\> -Defined in: [types/rag.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L114) - Extract metadata from chunks #### Parameters diff --git a/docs/api/type-aliases/MetadataExtractorConfig.md b/docs/api/type-aliases/MetadataExtractorConfig.md index aee52dc29..1f8d82829 100644 --- a/docs/api/type-aliases/MetadataExtractorConfig.md +++ b/docs/api/type-aliases/MetadataExtractorConfig.md @@ -8,8 +8,6 @@ > **MetadataExtractorConfig** = `object` -Defined in: [types/rag.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L120) - Metadata extractor configuration ## Properties @@ -18,8 +16,6 @@ Metadata extractor configuration > **type**: [`MetadataExtractorType`](MetadataExtractorType.md) -Defined in: [types/rag.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L122) - Extractor type --- @@ -28,8 +24,6 @@ Extractor type > `optional` **provider?**: `string` -Defined in: [types/rag.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L124) - Language model provider --- @@ -38,8 +32,6 @@ Language model provider > `optional` **modelName?**: `string` -Defined in: [types/rag.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L126) - Model name for LLM-based extraction --- @@ -48,8 +40,6 @@ Model name for LLM-based extraction > `optional` **promptTemplate?**: `string` -Defined in: [types/rag.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L128) - Custom prompt template --- @@ -58,8 +48,6 @@ Custom prompt template > `optional` **maxTokens?**: `number` -Defined in: [types/rag.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L130) - Maximum tokens for LLM response --- @@ -68,6 +56,4 @@ Maximum tokens for LLM response > `optional` **temperature?**: `number` -Defined in: [types/rag.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L132) - Temperature for LLM generation diff --git a/docs/api/type-aliases/MetadataExtractorMetadata.md b/docs/api/type-aliases/MetadataExtractorMetadata.md index ef59fba83..95cd5699a 100644 --- a/docs/api/type-aliases/MetadataExtractorMetadata.md +++ b/docs/api/type-aliases/MetadataExtractorMetadata.md @@ -8,8 +8,6 @@ > **MetadataExtractorMetadata** = `object` -Defined in: [types/rag.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L138) - Metadata extractor metadata for discovery and documentation ## Properties @@ -18,8 +16,6 @@ Metadata extractor metadata for discovery and documentation > **description**: `string` -Defined in: [types/rag.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L140) - Human-readable description --- @@ -28,8 +24,6 @@ Human-readable description > **defaultConfig**: `Partial`\<[`MetadataExtractorConfig`](MetadataExtractorConfig.md)\> -Defined in: [types/rag.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L142) - Default configuration --- @@ -38,8 +32,6 @@ Default configuration > **supportedOptions**: `string`[] -Defined in: [types/rag.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L144) - Supported configuration options --- @@ -48,8 +40,6 @@ Supported configuration options > **useCases**: `string`[] -Defined in: [types/rag.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L146) - Recommended use cases --- @@ -58,8 +48,6 @@ Recommended use cases > **aliases**: `string`[] -Defined in: [types/rag.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L148) - Alternative names for this extractor --- @@ -68,8 +56,6 @@ Alternative names for this extractor > **requiresModel**: `boolean` -Defined in: [types/rag.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L150) - Whether this extractor requires an AI model --- @@ -78,6 +64,4 @@ Whether this extractor requires an AI model > **extractionTypes**: `string`[] -Defined in: [types/rag.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L152) - Extraction types this extractor can produce diff --git a/docs/api/type-aliases/MetadataExtractorType.md b/docs/api/type-aliases/MetadataExtractorType.md index de8ebeab5..1acddb06b 100644 --- a/docs/api/type-aliases/MetadataExtractorType.md +++ b/docs/api/type-aliases/MetadataExtractorType.md @@ -8,6 +8,4 @@ > **MetadataExtractorType** = `"llm"` \| `"title"` \| `"summary"` \| `"keywords"` \| `"questions"` \| `"custom"` \| `"composite"` -Defined in: [types/rag.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L92) - Supported metadata extractor types diff --git a/docs/api/type-aliases/MetadataFilter.md b/docs/api/type-aliases/MetadataFilter.md index 7463414dc..2f5131401 100644 --- a/docs/api/type-aliases/MetadataFilter.md +++ b/docs/api/type-aliases/MetadataFilter.md @@ -8,8 +8,6 @@ > **MetadataFilter** = `object` -Defined in: [types/rag.ts:1201](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1201) - Metadata filter using MongoDB/Sift query syntax ## Indexable @@ -22,124 +20,92 @@ Metadata filter using MongoDB/Sift query syntax > `optional` **$eq?**: `unknown` -Defined in: [types/rag.ts:1203](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1203) - --- ### $ne? > `optional` **$ne?**: `unknown` -Defined in: [types/rag.ts:1204](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1204) - --- ### $gt? > `optional` **$gt?**: `number` -Defined in: [types/rag.ts:1205](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1205) - --- ### $gte? > `optional` **$gte?**: `number` -Defined in: [types/rag.ts:1206](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1206) - --- ### $lt? > `optional` **$lt?**: `number` -Defined in: [types/rag.ts:1207](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1207) - --- ### $lte? > `optional` **$lte?**: `number` -Defined in: [types/rag.ts:1208](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1208) - --- ### $in? > `optional` **$in?**: `unknown`[] -Defined in: [types/rag.ts:1209](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1209) - --- ### $nin? > `optional` **$nin?**: `unknown`[] -Defined in: [types/rag.ts:1210](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1210) - --- ### $and? > `optional` **$and?**: `MetadataFilter`[] -Defined in: [types/rag.ts:1213](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1213) - --- ### $or? > `optional` **$or?**: `MetadataFilter`[] -Defined in: [types/rag.ts:1214](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1214) - --- ### $not? > `optional` **$not?**: `MetadataFilter` -Defined in: [types/rag.ts:1215](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1215) - --- ### $nor? > `optional` **$nor?**: `MetadataFilter`[] -Defined in: [types/rag.ts:1216](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1216) - --- ### $exists? > `optional` **$exists?**: `boolean` -Defined in: [types/rag.ts:1219](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1219) - --- ### $contains? > `optional` **$contains?**: `string` -Defined in: [types/rag.ts:1220](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1220) - --- ### $regex? > `optional` **$regex?**: `string` -Defined in: [types/rag.ts:1221](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1221) - --- ### $size? > `optional` **$size?**: `number` - -Defined in: [types/rag.ts:1222](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1222) diff --git a/docs/api/type-aliases/MetricConfig.md b/docs/api/type-aliases/MetricConfig.md index f524e4e7e..5f10c5354 100644 --- a/docs/api/type-aliases/MetricConfig.md +++ b/docs/api/type-aliases/MetricConfig.md @@ -8,28 +8,20 @@ > **MetricConfig** = `object` -Defined in: [types/autoresearch.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L19) - ## Properties ### name > **name**: `string` -Defined in: [types/autoresearch.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L20) - --- ### direction > **direction**: [`MetricDirection`](MetricDirection.md) -Defined in: [types/autoresearch.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L21) - --- ### pattern > **pattern**: `string` - -Defined in: [types/autoresearch.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L22) diff --git a/docs/api/type-aliases/MetricDirection.md b/docs/api/type-aliases/MetricDirection.md index dc4ee7038..33d61dcf0 100644 --- a/docs/api/type-aliases/MetricDirection.md +++ b/docs/api/type-aliases/MetricDirection.md @@ -7,5 +7,3 @@ # Type Alias: MetricDirection > **MetricDirection** = `"lower"` \| `"higher"` - -Defined in: [types/autoresearch.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L17) diff --git a/docs/api/type-aliases/MetricsAggregatorConfig.md b/docs/api/type-aliases/MetricsAggregatorConfig.md index 79eca2fe7..a585fe675 100644 --- a/docs/api/type-aliases/MetricsAggregatorConfig.md +++ b/docs/api/type-aliases/MetricsAggregatorConfig.md @@ -8,8 +8,6 @@ > **MetricsAggregatorConfig** = `object` -Defined in: [types/observability.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L570) - Configuration for MetricsAggregator. ## Properties @@ -18,28 +16,20 @@ Configuration for MetricsAggregator. > `optional` **maxSpansRetained?**: `number` -Defined in: [types/observability.ts:571](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L571) - --- ### enableTimeWindows? > `optional` **enableTimeWindows?**: `boolean` -Defined in: [types/observability.ts:572](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L572) - --- ### timeWindowMs? > `optional` **timeWindowMs?**: `number` -Defined in: [types/observability.ts:573](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L573) - --- ### maxTimeWindows? > `optional` **maxTimeWindows?**: `number` - -Defined in: [types/observability.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L574) diff --git a/docs/api/type-aliases/MetricsSummary.md b/docs/api/type-aliases/MetricsSummary.md index b9a2617a3..2e8e35830 100644 --- a/docs/api/type-aliases/MetricsSummary.md +++ b/docs/api/type-aliases/MetricsSummary.md @@ -8,8 +8,6 @@ > **MetricsSummary** = `object` -Defined in: [types/observability.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L369) - Aggregated metrics summary ## Properties @@ -18,8 +16,6 @@ Aggregated metrics summary > **totalSpans**: `number` -Defined in: [types/observability.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L371) - Total number of spans tracked --- @@ -28,8 +24,6 @@ Total number of spans tracked > **successfulSpans**: `number` -Defined in: [types/observability.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L373) - Number of successful spans --- @@ -38,8 +32,6 @@ Number of successful spans > **failedSpans**: `number` -Defined in: [types/observability.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L375) - Number of failed spans --- @@ -48,8 +40,6 @@ Number of failed spans > **successRate**: `number` -Defined in: [types/observability.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L377) - Overall success rate (0-1) --- @@ -58,8 +48,6 @@ Overall success rate (0-1) > **latency**: [`LatencyStats`](LatencyStats.md) -Defined in: [types/observability.ts:379](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L379) - Latency statistics --- @@ -68,8 +56,6 @@ Latency statistics > **tokens**: [`TokenUsageStats`](TokenUsageStats.md) -Defined in: [types/observability.ts:381](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L381) - Token usage statistics --- @@ -78,8 +64,6 @@ Token usage statistics > **costByProvider**: [`ProviderCostStats`](ProviderCostStats.md)[] -Defined in: [types/observability.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L383) - Cost by provider --- @@ -88,8 +72,6 @@ Cost by provider > **costByModel**: [`ModelCostStats`](ModelCostStats.md)[] -Defined in: [types/observability.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L385) - Cost by model --- @@ -98,8 +80,6 @@ Cost by model > **totalCost**: `number` -Defined in: [types/observability.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L387) - Total cost across all providers --- @@ -108,8 +88,6 @@ Total cost across all providers > **spansByType**: `Record`\<`string`, `number`\> -Defined in: [types/observability.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L389) - Span count by type --- @@ -118,8 +96,6 @@ Span count by type > `optional` **firstSpanTime?**: `Date` -Defined in: [types/observability.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L391) - Timestamp of first span --- @@ -128,8 +104,6 @@ Timestamp of first span > `optional` **lastSpanTime?**: `Date` -Defined in: [types/observability.ts:393](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L393) - Timestamp of last span --- @@ -138,6 +112,4 @@ Timestamp of last span > `optional` **trackingDurationMs?**: `number` -Defined in: [types/observability.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L395) - Tracking duration in milliseconds diff --git a/docs/api/type-aliases/MetricsTraceContext.md b/docs/api/type-aliases/MetricsTraceContext.md index 53a6022df..f0a4d7213 100644 --- a/docs/api/type-aliases/MetricsTraceContext.md +++ b/docs/api/type-aliases/MetricsTraceContext.md @@ -8,8 +8,6 @@ > **MetricsTraceContext** = `object` -Defined in: [types/observability.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L491) - Trace + parent span IDs used to correlate metric records with spans. ## Properties @@ -18,12 +16,8 @@ Trace + parent span IDs used to correlate metric records with spans. > **traceId**: `string` -Defined in: [types/observability.ts:492](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L492) - --- ### parentSpanId > **parentSpanId**: `string` - -Defined in: [types/observability.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L493) diff --git a/docs/api/type-aliases/MiddlewareChainConfig.md b/docs/api/type-aliases/MiddlewareChainConfig.md index 5cc36bdf3..bb701f715 100644 --- a/docs/api/type-aliases/MiddlewareChainConfig.md +++ b/docs/api/type-aliases/MiddlewareChainConfig.md @@ -8,8 +8,6 @@ > **MiddlewareChainConfig** = `object` -Defined in: [types/middleware.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L290) - Middleware chain configuration ## Properties @@ -18,28 +16,20 @@ Middleware chain configuration > **middlewares**: [`MiddlewareFactoryConfig`](MiddlewareFactoryConfig.md)[] -Defined in: [types/middleware.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L291) - --- ### errorHandling > **errorHandling**: `"continue"` \| `"stop"` \| `"rollback"` -Defined in: [types/middleware.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L292) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/middleware.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L293) - --- ### retries? > `optional` **retries?**: `number` - -Defined in: [types/middleware.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L294) diff --git a/docs/api/type-aliases/MiddlewareChainStats.md b/docs/api/type-aliases/MiddlewareChainStats.md index 02711c252..c7615ec5d 100644 --- a/docs/api/type-aliases/MiddlewareChainStats.md +++ b/docs/api/type-aliases/MiddlewareChainStats.md @@ -8,8 +8,6 @@ > **MiddlewareChainStats** = `object` -Defined in: [types/middleware.ts:136](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L136) - Middleware chain execution statistics ## Properties @@ -18,8 +16,6 @@ Middleware chain execution statistics > **totalMiddleware**: `number` -Defined in: [types/middleware.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L138) - Total number of middleware in the chain --- @@ -28,8 +24,6 @@ Total number of middleware in the chain > **appliedMiddleware**: `number` -Defined in: [types/middleware.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L140) - Number of middleware that were applied --- @@ -38,8 +32,6 @@ Number of middleware that were applied > **totalExecutionTime**: `number` -Defined in: [types/middleware.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L142) - Total execution time for the chain --- @@ -48,6 +40,4 @@ Total execution time for the chain > **results**: `Record`\<`string`, [`MiddlewareExecutionResult`](MiddlewareExecutionResult.md)\> -Defined in: [types/middleware.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L144) - Individual middleware execution results diff --git a/docs/api/type-aliases/MiddlewareConditions.md b/docs/api/type-aliases/MiddlewareConditions.md index d72083e8c..78fca0f77 100644 --- a/docs/api/type-aliases/MiddlewareConditions.md +++ b/docs/api/type-aliases/MiddlewareConditions.md @@ -8,8 +8,6 @@ > **MiddlewareConditions** = `object` -Defined in: [types/middleware.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L77) - Conditions for applying middleware ## Properties @@ -18,8 +16,6 @@ Conditions for applying middleware > `optional` **providers?**: `string`[] -Defined in: [types/middleware.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L79) - Apply only to specific providers --- @@ -28,8 +24,6 @@ Apply only to specific providers > `optional` **models?**: `string`[] -Defined in: [types/middleware.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L81) - Apply only to specific models --- @@ -38,8 +32,6 @@ Apply only to specific models > `optional` **options?**: `Record`\<`string`, `unknown`\> -Defined in: [types/middleware.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L83) - Apply only when certain options are present --- @@ -48,8 +40,6 @@ Apply only when certain options are present > `optional` **custom?**: (`context`) => `boolean` -Defined in: [types/middleware.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L85) - Custom condition function #### Parameters diff --git a/docs/api/type-aliases/MiddlewareConfig.md b/docs/api/type-aliases/MiddlewareConfig.md index e0d678a04..24a4dde84 100644 --- a/docs/api/type-aliases/MiddlewareConfig.md +++ b/docs/api/type-aliases/MiddlewareConfig.md @@ -8,8 +8,6 @@ > **MiddlewareConfig** = `object` -Defined in: [types/middleware.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L65) - Middleware configuration options ## Properties @@ -18,8 +16,6 @@ Middleware configuration options > `optional` **enabled?**: `boolean` -Defined in: [types/middleware.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L67) - Whether the middleware is enabled --- @@ -28,8 +24,6 @@ Whether the middleware is enabled > `optional` **config?**: `Record`\<`string`, `unknown`\> -Defined in: [types/middleware.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L69) - Middleware-specific configuration --- @@ -38,6 +32,4 @@ Middleware-specific configuration > `optional` **conditions?**: [`MiddlewareConditions`](MiddlewareConditions.md) -Defined in: [types/middleware.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L71) - Conditions under which to apply this middleware diff --git a/docs/api/type-aliases/MiddlewareContext.md b/docs/api/type-aliases/MiddlewareContext.md index edeb2a92d..f93c11c47 100644 --- a/docs/api/type-aliases/MiddlewareContext.md +++ b/docs/api/type-aliases/MiddlewareContext.md @@ -8,8 +8,6 @@ > **MiddlewareContext** = `object` -Defined in: [types/middleware.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L91) - Context passed to middleware for decision making ## Properties @@ -18,8 +16,6 @@ Context passed to middleware for decision making > **provider**: `string` -Defined in: [types/middleware.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L93) - Provider name --- @@ -28,8 +24,6 @@ Provider name > **model**: `string` -Defined in: [types/middleware.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L95) - Model name --- @@ -38,8 +32,6 @@ Model name > **options**: `Record`\<`string`, `unknown`\> -Defined in: [types/middleware.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L97) - Request options --- @@ -48,8 +40,6 @@ Request options > `optional` **session?**: `object` -Defined in: [types/middleware.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L99) - Session information #### sessionId? @@ -66,6 +56,4 @@ Session information > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/middleware.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L104) - Additional metadata diff --git a/docs/api/type-aliases/MiddlewareDefinition.md b/docs/api/type-aliases/MiddlewareDefinition.md index 5711a5eb6..f927e2caf 100644 --- a/docs/api/type-aliases/MiddlewareDefinition.md +++ b/docs/api/type-aliases/MiddlewareDefinition.md @@ -8,8 +8,6 @@ > **MiddlewareDefinition** = `object` -Defined in: [types/server.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L467) - Middleware definition ## Properties @@ -18,8 +16,6 @@ Middleware definition > **name**: `string` -Defined in: [types/server.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L469) - Middleware name --- @@ -28,8 +24,6 @@ Middleware name > `optional` **order?**: `number` -Defined in: [types/server.ts:472](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L472) - Execution order (lower = earlier) --- @@ -38,8 +32,6 @@ Execution order (lower = earlier) > **handler**: [`MiddlewareHandler`](MiddlewareHandler.md) -Defined in: [types/server.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L475) - Middleware handler --- @@ -48,8 +40,6 @@ Middleware handler > `optional` **paths?**: `string`[] -Defined in: [types/server.ts:478](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L478) - Paths to apply middleware to (default: all) --- @@ -58,6 +48,4 @@ Paths to apply middleware to (default: all) > `optional` **excludePaths?**: `string`[] -Defined in: [types/server.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L481) - Paths to exclude from middleware diff --git a/docs/api/type-aliases/MiddlewareExecutionContext.md b/docs/api/type-aliases/MiddlewareExecutionContext.md index efb3e36c7..ee7cc0bec 100644 --- a/docs/api/type-aliases/MiddlewareExecutionContext.md +++ b/docs/api/type-aliases/MiddlewareExecutionContext.md @@ -8,8 +8,6 @@ > **MiddlewareExecutionContext** = `object` -Defined in: [types/middleware.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L265) - Middleware execution context ## Properties @@ -18,52 +16,38 @@ Middleware execution context > **requestId**: `string` -Defined in: [types/middleware.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L266) - --- ### timestamp > **timestamp**: `number` -Defined in: [types/middleware.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L267) - --- ### provider > **provider**: `string` -Defined in: [types/middleware.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L268) - --- ### model > **model**: `string` -Defined in: [types/middleware.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L269) - --- ### userId? > `optional` **userId?**: `string` -Defined in: [types/middleware.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L270) - --- ### sessionId? > `optional` **sessionId?**: `string` -Defined in: [types/middleware.ts:271](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L271) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/middleware.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L272) diff --git a/docs/api/type-aliases/MiddlewareExecutionResult.md b/docs/api/type-aliases/MiddlewareExecutionResult.md index 83cc8774f..105e77899 100644 --- a/docs/api/type-aliases/MiddlewareExecutionResult.md +++ b/docs/api/type-aliases/MiddlewareExecutionResult.md @@ -8,8 +8,6 @@ > **MiddlewareExecutionResult** = `object` -Defined in: [types/middleware.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L122) - Middleware execution result ## Properties @@ -18,8 +16,6 @@ Middleware execution result > **applied**: `boolean` -Defined in: [types/middleware.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L124) - Whether the middleware was applied --- @@ -28,8 +24,6 @@ Whether the middleware was applied > **executionTime**: `number` -Defined in: [types/middleware.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L126) - Execution time in milliseconds --- @@ -38,8 +32,6 @@ Execution time in milliseconds > `optional` **error?**: `Error` -Defined in: [types/middleware.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L128) - Any errors that occurred --- @@ -48,6 +40,4 @@ Any errors that occurred > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/middleware.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L130) - Additional metadata from the middleware diff --git a/docs/api/type-aliases/MiddlewareFactoryConfig.md b/docs/api/type-aliases/MiddlewareFactoryConfig.md index 17fb693f1..e4d8a4df4 100644 --- a/docs/api/type-aliases/MiddlewareFactoryConfig.md +++ b/docs/api/type-aliases/MiddlewareFactoryConfig.md @@ -8,8 +8,6 @@ > **MiddlewareFactoryConfig** = `object` -Defined in: [types/middleware.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L228) - Middleware factory configuration options ## Properties @@ -18,28 +16,20 @@ Middleware factory configuration options > **enabled**: `boolean` -Defined in: [types/middleware.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L229) - --- ### type > **type**: `string` -Defined in: [types/middleware.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L230) - --- ### priority? > `optional` **priority?**: `number` -Defined in: [types/middleware.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L231) - --- ### config? > `optional` **config?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/middleware.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L232) diff --git a/docs/api/type-aliases/MiddlewareFactoryOptions.md b/docs/api/type-aliases/MiddlewareFactoryOptions.md index a05156ab7..be3e55072 100644 --- a/docs/api/type-aliases/MiddlewareFactoryOptions.md +++ b/docs/api/type-aliases/MiddlewareFactoryOptions.md @@ -8,8 +8,6 @@ > **MiddlewareFactoryOptions** = `object` -Defined in: [types/middleware.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L176) - Factory options for middleware ## Properties @@ -18,8 +16,6 @@ Factory options for middleware > `optional` **middleware?**: [`NeuroLinkMiddleware`](NeuroLinkMiddleware.md)[] -Defined in: [types/middleware.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L178) - Custom middleware to register on initialization --- @@ -28,8 +24,6 @@ Custom middleware to register on initialization > `optional` **enabledMiddleware?**: `string`[] -Defined in: [types/middleware.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L180) - Enable specific middleware --- @@ -38,8 +32,6 @@ Enable specific middleware > `optional` **disabledMiddleware?**: `string`[] -Defined in: [types/middleware.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L182) - Disable specific middleware --- @@ -48,8 +40,6 @@ Disable specific middleware > `optional` **middlewareConfig?**: `Record`\<`string`, [`MiddlewareConfig`](MiddlewareConfig.md)\> -Defined in: [types/middleware.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L184) - Middleware configurations --- @@ -58,8 +48,6 @@ Middleware configurations > `optional` **preset?**: `string` -Defined in: [types/middleware.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L186) - Use a preset configuration --- @@ -68,8 +56,6 @@ Use a preset configuration > `optional` **global?**: `object` -Defined in: [types/middleware.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L188) - Global middleware settings #### maxExecutionTime? diff --git a/docs/api/type-aliases/MiddlewareHandler.md b/docs/api/type-aliases/MiddlewareHandler.md index b07447b49..e9f15cfc6 100644 --- a/docs/api/type-aliases/MiddlewareHandler.md +++ b/docs/api/type-aliases/MiddlewareHandler.md @@ -8,8 +8,6 @@ > **MiddlewareHandler** = (`ctx`, `next`) => `Promise`\<`unknown`\> -Defined in: [types/server.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L487) - Middleware handler function ## Parameters diff --git a/docs/api/type-aliases/MiddlewareMetrics.md b/docs/api/type-aliases/MiddlewareMetrics.md index b98a5fd9f..6eef043da 100644 --- a/docs/api/type-aliases/MiddlewareMetrics.md +++ b/docs/api/type-aliases/MiddlewareMetrics.md @@ -8,8 +8,6 @@ > **MiddlewareMetrics** = `object` -Defined in: [types/middleware.ts:278](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L278) - Middleware performance metrics ## Properties @@ -18,44 +16,32 @@ Middleware performance metrics > **name**: `string` -Defined in: [types/middleware.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L279) - --- ### executionTime > **executionTime**: `number` -Defined in: [types/middleware.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L280) - --- ### status > **status**: `"success"` \| `"error"` \| `"skipped"` -Defined in: [types/middleware.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L281) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/middleware.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L282) - --- ### inputSize > **inputSize**: `number` -Defined in: [types/middleware.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L283) - --- ### outputSize > **outputSize**: `number` - -Defined in: [types/middleware.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L284) diff --git a/docs/api/type-aliases/MiddlewarePreset.md b/docs/api/type-aliases/MiddlewarePreset.md index fc2a58d8c..126685fca 100644 --- a/docs/api/type-aliases/MiddlewarePreset.md +++ b/docs/api/type-aliases/MiddlewarePreset.md @@ -8,8 +8,6 @@ > **MiddlewarePreset** = `object` -Defined in: [types/middleware.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L164) - Middleware preset configurations ## Properties @@ -18,8 +16,6 @@ Middleware preset configurations > **name**: `string` -Defined in: [types/middleware.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L166) - Preset name --- @@ -28,8 +24,6 @@ Preset name > **description**: `string` -Defined in: [types/middleware.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L168) - Description of the preset --- @@ -38,6 +32,4 @@ Description of the preset > **config**: `Record`\<`string`, [`MiddlewareConfig`](MiddlewareConfig.md)\> -Defined in: [types/middleware.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L170) - Middleware configurations in the preset diff --git a/docs/api/type-aliases/MiddlewareRegistrationOptions.md b/docs/api/type-aliases/MiddlewareRegistrationOptions.md index 5accc3608..5f6431d1f 100644 --- a/docs/api/type-aliases/MiddlewareRegistrationOptions.md +++ b/docs/api/type-aliases/MiddlewareRegistrationOptions.md @@ -8,8 +8,6 @@ > **MiddlewareRegistrationOptions** = `object` -Defined in: [types/middleware.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L110) - Middleware registration options ## Properties @@ -18,8 +16,6 @@ Middleware registration options > `optional` **replace?**: `boolean` -Defined in: [types/middleware.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L112) - Whether to replace existing middleware with same ID --- @@ -28,8 +24,6 @@ Whether to replace existing middleware with same ID > `optional` **defaultEnabled?**: `boolean` -Defined in: [types/middleware.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L114) - Whether to enable the middleware by default --- @@ -38,6 +32,4 @@ Whether to enable the middleware by default > `optional` **globalConfig?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/middleware.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L116) - Global configuration for the middleware diff --git a/docs/api/type-aliases/MiddlewareRegistryEntry.md b/docs/api/type-aliases/MiddlewareRegistryEntry.md index 47b429145..ea8d1c450 100644 --- a/docs/api/type-aliases/MiddlewareRegistryEntry.md +++ b/docs/api/type-aliases/MiddlewareRegistryEntry.md @@ -8,8 +8,6 @@ > **MiddlewareRegistryEntry** = `object` -Defined in: [types/middleware.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L238) - Middleware registry entry ## Properties @@ -18,36 +16,26 @@ Middleware registry entry > **name**: `string` -Defined in: [types/middleware.ts:239](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L239) - --- ### factory > **factory**: `MiddlewareFactory` -Defined in: [types/middleware.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L240) - --- ### defaultConfig > **defaultConfig**: `Record`\<`string`, `unknown`\> -Defined in: [types/middleware.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L241) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/middleware.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L242) - --- ### version? > `optional` **version?**: `string` - -Defined in: [types/middleware.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L243) diff --git a/docs/api/type-aliases/MiddlewareRequestSchema.md b/docs/api/type-aliases/MiddlewareRequestSchema.md index c359152e2..998111a35 100644 --- a/docs/api/type-aliases/MiddlewareRequestSchema.md +++ b/docs/api/type-aliases/MiddlewareRequestSchema.md @@ -8,8 +8,6 @@ > **MiddlewareRequestSchema** = `object` -Defined in: [types/middleware.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L494) - Simple structural validation schema used by the request-validation middleware. Named MiddlewareRequestSchema to disambiguate from the zod `ValidationSchema` exported from aliases.ts (§Rule 9 domain prefix). @@ -20,20 +18,14 @@ middleware. Named MiddlewareRequestSchema to disambiguate from the zod > `optional` **required?**: `string`[] -Defined in: [types/middleware.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L495) - --- ### properties? > `optional` **properties?**: `Record`\<`string`, [`PropertySchema`](PropertySchema.md)\> -Defined in: [types/middleware.ts:496](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L496) - --- ### additionalProperties? > `optional` **additionalProperties?**: `boolean` - -Defined in: [types/middleware.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L497) diff --git a/docs/api/type-aliases/MiddlewareValidationResult.md b/docs/api/type-aliases/MiddlewareValidationResult.md index 0ae5d3676..e5c6994ac 100644 --- a/docs/api/type-aliases/MiddlewareValidationResult.md +++ b/docs/api/type-aliases/MiddlewareValidationResult.md @@ -8,8 +8,6 @@ > **MiddlewareValidationResult** = `object` -Defined in: [types/middleware.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L256) - Middleware validation result ## Properties @@ -18,20 +16,14 @@ Middleware validation result > **valid**: `boolean` -Defined in: [types/middleware.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L257) - --- ### errors > **errors**: `string`[] -Defined in: [types/middleware.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L258) - --- ### warnings > **warnings**: `string`[] - -Defined in: [types/middleware.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L259) diff --git a/docs/api/type-aliases/MinimalChatMessage.md b/docs/api/type-aliases/MinimalChatMessage.md index 8fbdc3541..e36894ad9 100644 --- a/docs/api/type-aliases/MinimalChatMessage.md +++ b/docs/api/type-aliases/MinimalChatMessage.md @@ -8,8 +8,6 @@ > **MinimalChatMessage** = `object` -Defined in: [types/conversation.ts:775](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L775) - Reduced ChatMessage shape used by callers (typically tests and history reconstructors) that pass synthetic entries into the Gemini history reconstructor without filling every `ChatMessage` field. Mirrors the @@ -21,40 +19,30 @@ fields actually read by `prependConversationMessages`. > **role**: [`ChatMessage`](ChatMessage.md)\[`"role"`\] -Defined in: [types/conversation.ts:776](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L776) - --- ### content > **content**: `string` -Defined in: [types/conversation.ts:777](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L777) - --- ### tool? > `optional` **tool?**: `string` -Defined in: [types/conversation.ts:778](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L778) - --- ### args? > `optional` **args?**: `Record`\<`string`, `unknown`\> -Defined in: [types/conversation.ts:779](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L779) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/conversation.ts:780](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L780) - #### stepIndex? > `optional` **stepIndex?**: `number` diff --git a/docs/api/type-aliases/ModelAliasConfig.md b/docs/api/type-aliases/ModelAliasConfig.md index 2f51aad37..e1ba9da7b 100644 --- a/docs/api/type-aliases/ModelAliasConfig.md +++ b/docs/api/type-aliases/ModelAliasConfig.md @@ -8,8 +8,6 @@ > **ModelAliasConfig** = `object` -Defined in: [types/generate.ts:1861](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1861) - NL-004: Model alias/deprecation configuration. Allows mapping deprecated model names to their replacements. @@ -18,5 +16,3 @@ Allows mapping deprecated model names to their replacements. ### aliases > **aliases**: `Record`\<`string`, \{ `target`: `string`; `action`: `"warn"` \| `"redirect"` \| `"block"`; `reason?`: `string`; \}\> - -Defined in: [types/generate.ts:1862](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1862) diff --git a/docs/api/type-aliases/ModelCapabilities.md b/docs/api/type-aliases/ModelCapabilities.md index 9c5913f3b..f50f7a154 100644 --- a/docs/api/type-aliases/ModelCapabilities.md +++ b/docs/api/type-aliases/ModelCapabilities.md @@ -8,8 +8,6 @@ > **ModelCapabilities** = `object` -Defined in: [types/model.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L116) - Model capabilities interface ## Properties @@ -18,64 +16,48 @@ Model capabilities interface > **vision**: `boolean` -Defined in: [types/model.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L117) - --- ### functionCalling > **functionCalling**: `boolean` -Defined in: [types/model.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L118) - --- ### codeGeneration > **codeGeneration**: `boolean` -Defined in: [types/model.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L119) - --- ### reasoning > **reasoning**: `boolean` -Defined in: [types/model.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L120) - --- ### multimodal > **multimodal**: `boolean` -Defined in: [types/model.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L121) - --- ### streaming > **streaming**: `boolean` -Defined in: [types/model.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L122) - --- ### jsonMode > **jsonMode**: `boolean` -Defined in: [types/model.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L123) - --- ### samplingParams? > `optional` **samplingParams?**: `boolean` -Defined in: [types/model.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L131) - Whether the model accepts classic sampling parameters (`temperature` / `topP`). Reasoning-effort models (Claude Sonnet 5, Opus 4.7+, Fable 5 families) reject them. Optional: unset means diff --git a/docs/api/type-aliases/ModelCapability.md b/docs/api/type-aliases/ModelCapability.md index 12e9262c9..b846b989b 100644 --- a/docs/api/type-aliases/ModelCapability.md +++ b/docs/api/type-aliases/ModelCapability.md @@ -8,6 +8,4 @@ > **ModelCapability** = `"text"` \| `"vision"` \| `"function-calling"` \| `"embedding"` \| `"audio"` \| `"video"` \| `"code"` \| `"reasoning"` \| `"multimodal"` -Defined in: [types/providers.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L416) - Model Capabilities - Maximally Reusable diff --git a/docs/api/type-aliases/ModelChoice.md b/docs/api/type-aliases/ModelChoice.md index 3fa3d9bc1..2971e60a2 100644 --- a/docs/api/type-aliases/ModelChoice.md +++ b/docs/api/type-aliases/ModelChoice.md @@ -8,8 +8,6 @@ > **ModelChoice** = `object` -Defined in: [types/common.ts:425](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L425) - Model choice for CLI prompts (inquirer format) ## Properties @@ -18,20 +16,14 @@ Model choice for CLI prompts (inquirer format) > **name**: `string` -Defined in: [types/common.ts:426](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L426) - --- ### value > **value**: `string` -Defined in: [types/common.ts:427](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L427) - --- ### description? > `optional` **description?**: `string` - -Defined in: [types/common.ts:428](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L428) diff --git a/docs/api/type-aliases/ModelComparison.md b/docs/api/type-aliases/ModelComparison.md index adea4f624..6f71e357d 100644 --- a/docs/api/type-aliases/ModelComparison.md +++ b/docs/api/type-aliases/ModelComparison.md @@ -8,8 +8,6 @@ > **ModelComparison** = `object` -Defined in: [types/model.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L244) - Model comparison result ## Properties @@ -18,16 +16,12 @@ Model comparison result > **models**: [`ModelInfo`](ModelInfo.md)[] -Defined in: [types/model.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L245) - --- ### comparison > **comparison**: `object` -Defined in: [types/model.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L246) - #### capabilities > **capabilities**: `Record`\ diff --git a/docs/api/type-aliases/ModelConfig.md b/docs/api/type-aliases/ModelConfig.md index 40da3751a..990c33100 100644 --- a/docs/api/type-aliases/ModelConfig.md +++ b/docs/api/type-aliases/ModelConfig.md @@ -8,8 +8,6 @@ > **ModelConfig** = `object` -Defined in: [types/model.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L24) - Model configuration for a specific provider ## Properties @@ -18,8 +16,6 @@ Model configuration for a specific provider > **id**: `string` -Defined in: [types/model.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L26) - Model identifier --- @@ -28,8 +24,6 @@ Model identifier > **name**: `string` -Defined in: [types/model.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L28) - Display name --- @@ -38,8 +32,6 @@ Display name > **tier**: [`ModelTier`](ModelTier.md) -Defined in: [types/model.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L30) - Performance tier --- @@ -48,8 +40,6 @@ Performance tier > **cost**: `object` -Defined in: [types/model.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L32) - Cost per 1K tokens #### input @@ -66,8 +56,6 @@ Cost per 1K tokens > **capabilities**: `string`[] -Defined in: [types/model.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L37) - Model capabilities --- @@ -76,6 +64,4 @@ Model capabilities > `optional` **options?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/model.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L39) - Model-specific options diff --git a/docs/api/type-aliases/ModelCostStats.md b/docs/api/type-aliases/ModelCostStats.md index eeeaf3802..c0db2bc94 100644 --- a/docs/api/type-aliases/ModelCostStats.md +++ b/docs/api/type-aliases/ModelCostStats.md @@ -8,8 +8,6 @@ > **ModelCostStats** = `object` -Defined in: [types/observability.ts:353](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L353) - Cost breakdown by model ## Properties @@ -18,68 +16,50 @@ Cost breakdown by model > **model**: `string` -Defined in: [types/observability.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L354) - --- ### provider > **provider**: `string` -Defined in: [types/observability.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L355) - --- ### totalCost > **totalCost**: `number` -Defined in: [types/observability.ts:356](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L356) - --- ### requestCount > **requestCount**: `number` -Defined in: [types/observability.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L357) - --- ### avgCostPerRequest > **avgCostPerRequest**: `number` -Defined in: [types/observability.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L358) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/observability.ts:359](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L359) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/observability.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L360) - --- ### inputCost > **inputCost**: `number` -Defined in: [types/observability.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L361) - --- ### outputCost > **outputCost**: `number` - -Defined in: [types/observability.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L362) diff --git a/docs/api/type-aliases/ModelDeploymentConfig.md b/docs/api/type-aliases/ModelDeploymentConfig.md index df7196412..631bcdb3d 100644 --- a/docs/api/type-aliases/ModelDeploymentConfig.md +++ b/docs/api/type-aliases/ModelDeploymentConfig.md @@ -8,8 +8,6 @@ > **ModelDeploymentConfig** = `object` -Defined in: [types/providers.ts:1845](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1845) - Model deployment configuration ## Properties @@ -18,8 +16,6 @@ Model deployment configuration > **modelName**: `string` -Defined in: [types/providers.ts:1847](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1847) - Model name --- @@ -28,8 +24,6 @@ Model name > **endpointName**: `string` -Defined in: [types/providers.ts:1849](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1849) - Endpoint name --- @@ -38,8 +32,6 @@ Endpoint name > **instanceType**: `string` -Defined in: [types/providers.ts:1851](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1851) - EC2 instance type --- @@ -48,8 +40,6 @@ EC2 instance type > **initialInstanceCount**: `number` -Defined in: [types/providers.ts:1853](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1853) - Initial instance count --- @@ -58,8 +48,6 @@ Initial instance count > **modelDataUrl**: `string` -Defined in: [types/providers.ts:1855](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1855) - Model data S3 location --- @@ -68,8 +56,6 @@ Model data S3 location > **image**: `string` -Defined in: [types/providers.ts:1857](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1857) - Container image URI --- @@ -78,8 +64,6 @@ Container image URI > **executionRoleArn**: `string` -Defined in: [types/providers.ts:1859](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1859) - IAM execution role ARN --- @@ -88,8 +72,6 @@ IAM execution role ARN > `optional` **tags?**: `Record`\<`string`, `string`\> -Defined in: [types/providers.ts:1861](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1861) - Resource tags --- @@ -98,8 +80,6 @@ Resource tags > `optional` **autoScaling?**: `object` -Defined in: [types/providers.ts:1863](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1863) - Auto scaling configuration #### minCapacity diff --git a/docs/api/type-aliases/ModelDetectionResult.md b/docs/api/type-aliases/ModelDetectionResult.md index 012cc97db..31afb1d92 100644 --- a/docs/api/type-aliases/ModelDetectionResult.md +++ b/docs/api/type-aliases/ModelDetectionResult.md @@ -8,8 +8,6 @@ > **ModelDetectionResult** = `object` -Defined in: [types/providers.ts:2377](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2377) - Model type detection result. ## Properties @@ -18,28 +16,20 @@ Model type detection result. > **type**: [`StreamingCapability`](StreamingCapability.md)\[`"modelType"`\] -Defined in: [types/providers.ts:2378](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2378) - --- ### confidence > **confidence**: `number` -Defined in: [types/providers.ts:2379](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2379) - --- ### evidence > **evidence**: `string`[] -Defined in: [types/providers.ts:2380](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2380) - --- ### suggestedConfig? > `optional` **suggestedConfig?**: `Partial`\<[`SageMakerModelConfig`](SageMakerModelConfig.md)\> - -Defined in: [types/providers.ts:2381](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2381) diff --git a/docs/api/type-aliases/ModelFilter.md b/docs/api/type-aliases/ModelFilter.md index c0fd971a8..18a22db37 100644 --- a/docs/api/type-aliases/ModelFilter.md +++ b/docs/api/type-aliases/ModelFilter.md @@ -8,8 +8,6 @@ > **ModelFilter** = `object` -Defined in: [types/providers.ts:463](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L463) - Model Filter Configuration - High Reusability ## Properties @@ -18,52 +16,38 @@ Model Filter Configuration - High Reusability > `optional` **provider?**: `string` -Defined in: [types/providers.ts:464](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L464) - --- ### capability? > `optional` **capability?**: [`ModelCapability`](ModelCapability.md) -Defined in: [types/providers.ts:465](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L465) - --- ### useCase? > `optional` **useCase?**: [`ModelUseCase`](ModelUseCase.md) -Defined in: [types/providers.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L466) - --- ### requireVision? > `optional` **requireVision?**: `boolean` -Defined in: [types/providers.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L467) - --- ### requireFunctionCalling? > `optional` **requireFunctionCalling?**: `boolean` -Defined in: [types/providers.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L468) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/providers.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L469) - --- ### costLimit? > `optional` **costLimit?**: `number` - -Defined in: [types/providers.ts:470](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L470) diff --git a/docs/api/type-aliases/ModelFilterConfig.md b/docs/api/type-aliases/ModelFilterConfig.md index d80fd6c71..a20a28376 100644 --- a/docs/api/type-aliases/ModelFilterConfig.md +++ b/docs/api/type-aliases/ModelFilterConfig.md @@ -8,20 +8,14 @@ > **ModelFilterConfig** = `object` -Defined in: [types/guardrails.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L105) - ## Properties ### enabled? > `optional` **enabled?**: `boolean` -Defined in: [types/guardrails.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L106) - --- ### filterModel? > `optional` **filterModel?**: [`LanguageModel`](LanguageModel.md) - -Defined in: [types/guardrails.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L107) diff --git a/docs/api/type-aliases/ModelGroup.md b/docs/api/type-aliases/ModelGroup.md index 2e46f1db9..967e4c8ca 100644 --- a/docs/api/type-aliases/ModelGroup.md +++ b/docs/api/type-aliases/ModelGroup.md @@ -8,8 +8,6 @@ > **ModelGroup** = `object` -Defined in: [types/workflow.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L41) - Model group for layer-based execution Enables sequential vs parallel control at group level @@ -19,76 +17,56 @@ Enables sequential vs parallel control at group level > **id**: `string` -Defined in: [types/workflow.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L43) - --- ### name? > `optional` **name?**: `string` -Defined in: [types/workflow.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L44) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/workflow.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L45) - --- ### models > **models**: [`WorkflowModelConfig`](WorkflowModelConfig.md)[] -Defined in: [types/workflow.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L48) - --- ### executionStrategy > **executionStrategy**: [`ExecutionStrategy`](ExecutionStrategy.md) -Defined in: [types/workflow.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L51) - --- ### continueOnFailure? > `optional` **continueOnFailure?**: `boolean` -Defined in: [types/workflow.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L52) - --- ### minSuccessful? > `optional` **minSuccessful?**: `number` -Defined in: [types/workflow.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L53) - --- ### parallelism? > `optional` **parallelism?**: `number` -Defined in: [types/workflow.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L56) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/workflow.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L57) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> - -Defined in: [types/workflow.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L60) diff --git a/docs/api/type-aliases/ModelInfo.md b/docs/api/type-aliases/ModelInfo.md index e084c2804..b848d4f38 100644 --- a/docs/api/type-aliases/ModelInfo.md +++ b/docs/api/type-aliases/ModelInfo.md @@ -8,8 +8,6 @@ > **ModelInfo** = `object` -Defined in: [types/model.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L178) - Complete model information ## Properties @@ -18,108 +16,80 @@ Complete model information > **id**: `string` -Defined in: [types/model.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L179) - --- ### name > **name**: `string` -Defined in: [types/model.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L180) - --- ### provider > **provider**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/model.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L181) - --- ### description > **description**: `string` -Defined in: [types/model.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L182) - --- ### capabilities > **capabilities**: [`ModelCapabilities`](ModelCapabilities.md) -Defined in: [types/model.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L183) - --- ### pricing > **pricing**: [`ModelPricingInfo`](ModelPricingInfo.md) -Defined in: [types/model.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L184) - --- ### performance > **performance**: [`ModelPerformance`](ModelPerformance.md) -Defined in: [types/model.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L185) - --- ### limits > **limits**: [`ModelLimits`](ModelLimits.md) -Defined in: [types/model.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L186) - --- ### useCases > **useCases**: [`UseCaseSuitability`](UseCaseSuitability.md) -Defined in: [types/model.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L187) - --- ### aliases > **aliases**: `string`[] -Defined in: [types/model.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L188) - --- ### deprecated > **deprecated**: `boolean` -Defined in: [types/model.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L189) - --- ### isLocal > **isLocal**: `boolean` -Defined in: [types/model.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L190) - --- ### releaseDate? > `optional` **releaseDate?**: `string` -Defined in: [types/model.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L191) - --- ### category > **category**: `"general"` \| `"coding"` \| `"creative"` \| `"vision"` \| `"reasoning"` - -Defined in: [types/model.ts:192](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L192) diff --git a/docs/api/type-aliases/ModelLimits.md b/docs/api/type-aliases/ModelLimits.md index 3981b18eb..b6aa8aa26 100644 --- a/docs/api/type-aliases/ModelLimits.md +++ b/docs/api/type-aliases/ModelLimits.md @@ -8,8 +8,6 @@ > **ModelLimits** = `object` -Defined in: [types/model.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L155) - Model limitations and constraints ## Properties @@ -18,28 +16,20 @@ Model limitations and constraints > **maxContextTokens**: `number` -Defined in: [types/model.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L156) - --- ### maxOutputTokens > **maxOutputTokens**: `number` -Defined in: [types/model.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L157) - --- ### maxRequestsPerMinute? > `optional` **maxRequestsPerMinute?**: `number` -Defined in: [types/model.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L158) - --- ### maxRequestsPerDay? > `optional` **maxRequestsPerDay?**: `number` - -Defined in: [types/model.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L159) diff --git a/docs/api/type-aliases/ModelMapping.md b/docs/api/type-aliases/ModelMapping.md index 25cf7a76f..3149c6bc6 100644 --- a/docs/api/type-aliases/ModelMapping.md +++ b/docs/api/type-aliases/ModelMapping.md @@ -8,8 +8,6 @@ > **ModelMapping** = `object` -Defined in: [types/subscription.ts:1186](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1186) - A single model mapping entry ## Properties @@ -18,20 +16,14 @@ A single model mapping entry > **from**: `string` -Defined in: [types/subscription.ts:1187](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1187) - --- ### to > **to**: `string` -Defined in: [types/subscription.ts:1188](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1188) - --- ### provider > **provider**: `string` - -Defined in: [types/subscription.ts:1189](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1189) diff --git a/docs/api/type-aliases/ModelMessage.md b/docs/api/type-aliases/ModelMessage.md index 3739379db..d19b402d7 100644 --- a/docs/api/type-aliases/ModelMessage.md +++ b/docs/api/type-aliases/ModelMessage.md @@ -7,5 +7,3 @@ # Type Alias: ModelMessage > **ModelMessage** = [`SystemModelMessage`](SystemModelMessage.md) \| [`UserModelMessage`](UserModelMessage.md) \| [`AssistantModelMessage`](AssistantModelMessage.md) \| [`ToolModelMessage`](ToolModelMessage.md) - -Defined in: [types/aiCompat.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L289) diff --git a/docs/api/type-aliases/ModelPerformance.md b/docs/api/type-aliases/ModelPerformance.md index 535806ae0..f66a4e685 100644 --- a/docs/api/type-aliases/ModelPerformance.md +++ b/docs/api/type-aliases/ModelPerformance.md @@ -8,8 +8,6 @@ > **ModelPerformance** = `object` -Defined in: [types/model.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L146) - Model performance characteristics ## Properties @@ -18,20 +16,14 @@ Model performance characteristics > **speed**: `"fast"` \| `"medium"` \| `"slow"` -Defined in: [types/model.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L147) - --- ### quality > **quality**: `"high"` \| `"medium"` \| `"low"` -Defined in: [types/model.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L148) - --- ### accuracy > **accuracy**: `"high"` \| `"medium"` \| `"low"` - -Defined in: [types/model.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L149) diff --git a/docs/api/type-aliases/ModelPoolConfig.md b/docs/api/type-aliases/ModelPoolConfig.md index c844424c1..86753fbf9 100644 --- a/docs/api/type-aliases/ModelPoolConfig.md +++ b/docs/api/type-aliases/ModelPoolConfig.md @@ -8,8 +8,6 @@ > **ModelPoolConfig** = `object` -Defined in: [types/modelPool.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L36) - Constructor-level configuration for a ModelPool instance. ## Properties @@ -18,8 +16,6 @@ Constructor-level configuration for a ModelPool instance. > **members**: [`ModelPoolMember`](ModelPoolMember.md)[] -Defined in: [types/modelPool.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L38) - Ordered list of provider/model/region candidates. --- @@ -28,8 +24,6 @@ Ordered list of provider/model/region candidates. > `optional` **strategy?**: [`ModelPoolStrategy`](ModelPoolStrategy.md) -Defined in: [types/modelPool.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L45) - How to pick among available members. - "priority" — always try the first available member (default). @@ -42,8 +36,6 @@ How to pick among available members. > `optional` **cooldownMs?**: `number` -Defined in: [types/modelPool.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L51) - How long (ms) a failed member stays in cooldown before it is eligible again. Applies to retryable error classes (rate_limit, server, network). Default: 60_000 (1 minute). @@ -54,7 +46,5 @@ Default: 60_000 (1 minute). > `optional` **maxAttempts?**: `number` -Defined in: [types/modelPool.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L56) - Maximum total attempts across all pool members per call. Default: members.length (try every member once). diff --git a/docs/api/type-aliases/ModelPoolMember.md b/docs/api/type-aliases/ModelPoolMember.md index 6ff220141..830cbf3d2 100644 --- a/docs/api/type-aliases/ModelPoolMember.md +++ b/docs/api/type-aliases/ModelPoolMember.md @@ -8,8 +8,6 @@ > **ModelPoolMember** = `object` -Defined in: [types/modelPool.ts:12](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L12) - One candidate provider/model/region tuple in a pool. ## Properties @@ -18,30 +16,22 @@ One candidate provider/model/region tuple in a pool. > **provider**: `string` -Defined in: [types/modelPool.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L13) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/modelPool.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L14) - --- ### region? > `optional` **region?**: `string` -Defined in: [types/modelPool.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L15) - --- ### weight? > `optional` **weight?**: `number` -Defined in: [types/modelPool.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L17) - Relative weight used by the "weighted" strategy. Default: 1. diff --git a/docs/api/type-aliases/ModelPoolStrategy.md b/docs/api/type-aliases/ModelPoolStrategy.md index 9f56cde10..718e85e7d 100644 --- a/docs/api/type-aliases/ModelPoolStrategy.md +++ b/docs/api/type-aliases/ModelPoolStrategy.md @@ -8,6 +8,4 @@ > **ModelPoolStrategy** = `"priority"` \| `"round-robin"` \| `"weighted"` -Defined in: [types/modelPool.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L21) - Member-selection strategy when picking the next candidate. diff --git a/docs/api/type-aliases/ModelPricing.md b/docs/api/type-aliases/ModelPricing.md index 3c7cef414..d90c5293a 100644 --- a/docs/api/type-aliases/ModelPricing.md +++ b/docs/api/type-aliases/ModelPricing.md @@ -8,8 +8,6 @@ > **ModelPricing** = `object` -Defined in: [types/providers.ts:515](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L515) - Model Pricing Information - High Reusability ## Properties @@ -18,8 +16,6 @@ Model Pricing Information - High Reusability > `optional` **inputTokens?**: `object` -Defined in: [types/providers.ts:516](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L516) - #### price > **price**: `number` @@ -38,8 +34,6 @@ Defined in: [types/providers.ts:516](https://github.com/juspay/neurolink/blob/re > `optional` **outputTokens?**: `object` -Defined in: [types/providers.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L521) - #### price > **price**: `number` @@ -58,8 +52,6 @@ Defined in: [types/providers.ts:521](https://github.com/juspay/neurolink/blob/re > `optional` **requestPrice?**: `object` -Defined in: [types/providers.ts:526](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L526) - #### price > **price**: `number` @@ -74,36 +66,26 @@ Defined in: [types/providers.ts:526](https://github.com/juspay/neurolink/blob/re > `optional` **tier?**: `"free"` \| `"basic"` \| `"premium"` \| `"enterprise"` -Defined in: [types/providers.ts:530](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L530) - --- ### average? > `optional` **average?**: `number` -Defined in: [types/providers.ts:532](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L532) - --- ### min? > `optional` **min?**: `number` -Defined in: [types/providers.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L533) - --- ### max? > `optional` **max?**: `number` -Defined in: [types/providers.ts:534](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L534) - --- ### free? > `optional` **free?**: `boolean` - -Defined in: [types/providers.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L535) diff --git a/docs/api/type-aliases/ModelPricingInfo.md b/docs/api/type-aliases/ModelPricingInfo.md index 23d2e9190..46ba5f3da 100644 --- a/docs/api/type-aliases/ModelPricingInfo.md +++ b/docs/api/type-aliases/ModelPricingInfo.md @@ -8,8 +8,6 @@ > **ModelPricingInfo** = `object` -Defined in: [types/model.ts:137](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L137) - Model pricing information ## Properties @@ -18,20 +16,14 @@ Model pricing information > **inputCostPer1K**: `number` -Defined in: [types/model.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L138) - --- ### outputCostPer1K > **outputCostPer1K**: `number` -Defined in: [types/model.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L139) - --- ### currency > **currency**: `string` - -Defined in: [types/model.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L140) diff --git a/docs/api/type-aliases/ModelRecommendation.md b/docs/api/type-aliases/ModelRecommendation.md index 63902c572..89f3182b4 100644 --- a/docs/api/type-aliases/ModelRecommendation.md +++ b/docs/api/type-aliases/ModelRecommendation.md @@ -8,8 +8,6 @@ > **ModelRecommendation** = `object` -Defined in: [types/model.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L234) - Model recommendation result ## Properties @@ -18,28 +16,20 @@ Model recommendation result > **model**: [`ModelInfo`](ModelInfo.md) -Defined in: [types/model.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L235) - --- ### score > **score**: `number` -Defined in: [types/model.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L236) - --- ### reasoning > **reasoning**: `string`[] -Defined in: [types/model.ts:237](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L237) - --- ### alternatives > **alternatives**: [`ModelInfo`](ModelInfo.md)[] - -Defined in: [types/model.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L238) diff --git a/docs/api/type-aliases/ModelRegistry.md b/docs/api/type-aliases/ModelRegistry.md index 47728734c..0cc3fed53 100644 --- a/docs/api/type-aliases/ModelRegistry.md +++ b/docs/api/type-aliases/ModelRegistry.md @@ -8,6 +8,4 @@ > **ModelRegistry** = `z.infer`\<_typeof_ [`ModelRegistrySchema`](../variables/ModelRegistrySchema.md)\> -Defined in: [types/model.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L111) - Dynamic model registry type diff --git a/docs/api/type-aliases/ModelResolutionContext.md b/docs/api/type-aliases/ModelResolutionContext.md index bfb4b6622..a68dcd281 100644 --- a/docs/api/type-aliases/ModelResolutionContext.md +++ b/docs/api/type-aliases/ModelResolutionContext.md @@ -8,8 +8,6 @@ > **ModelResolutionContext** = `object` -Defined in: [types/providers.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L476) - Model Resolution Context - High Reusability ## Properties @@ -18,32 +16,24 @@ Model Resolution Context - High Reusability > `optional` **requireCapabilities?**: [`ModelCapability`](ModelCapability.md)[] -Defined in: [types/providers.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L477) - --- ### preferredProviders? > `optional` **preferredProviders?**: `string`[] -Defined in: [types/providers.ts:478](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L478) - --- ### useCase? > `optional` **useCase?**: [`ModelUseCase`](ModelUseCase.md) -Defined in: [types/providers.ts:479](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L479) - --- ### budgetConstraints? > `optional` **budgetConstraints?**: `object` -Defined in: [types/providers.ts:480](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L480) - #### maxCostPerRequest? > `optional` **maxCostPerRequest?**: `number` @@ -58,8 +48,6 @@ Defined in: [types/providers.ts:480](https://github.com/juspay/neurolink/blob/re > `optional` **performance?**: `object` -Defined in: [types/providers.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L484) - #### maxLatency? > `optional` **maxLatency?**: `number` diff --git a/docs/api/type-aliases/ModelRoute.md b/docs/api/type-aliases/ModelRoute.md index 3411c2ef8..e6d5ce2b4 100644 --- a/docs/api/type-aliases/ModelRoute.md +++ b/docs/api/type-aliases/ModelRoute.md @@ -8,36 +8,26 @@ > **ModelRoute** = `object` -Defined in: [types/model.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L254) - ## Properties ### provider > **provider**: `string` -Defined in: [types/model.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L255) - --- ### model > **model**: `string` -Defined in: [types/model.ts:256](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L256) - --- ### reasoning > **reasoning**: `string` -Defined in: [types/model.ts:257](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L257) - --- ### confidence > **confidence**: `number` - -Defined in: [types/model.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L258) diff --git a/docs/api/type-aliases/ModelRouterInterface.md b/docs/api/type-aliases/ModelRouterInterface.md index 798405e48..2b9c1ade1 100644 --- a/docs/api/type-aliases/ModelRouterInterface.md +++ b/docs/api/type-aliases/ModelRouterInterface.md @@ -8,8 +8,6 @@ > **ModelRouterInterface** = `object` -Defined in: [types/proxy.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L53) - Type describing the ModelRouter contract. Defined here to avoid a circular dependency between types and implementation. @@ -19,8 +17,6 @@ Defined here to avoid a circular dependency between types and implementation. > `optional` **getModelMappings?**: () => [`ModelMapping`](ModelMapping.md)[] -Defined in: [types/proxy.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L59) - #### Returns [`ModelMapping`](ModelMapping.md)[] @@ -31,8 +27,6 @@ Defined in: [types/proxy.ts:59](https://github.com/juspay/neurolink/blob/release > `optional` **getPassthroughModels?**: () => `string`[] -Defined in: [types/proxy.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L60) - #### Returns `string`[] @@ -43,8 +37,6 @@ Defined in: [types/proxy.ts:60](https://github.com/juspay/neurolink/blob/release > **resolve**(`requestedModel`): [`RouteResult`](RouteResult.md) -Defined in: [types/proxy.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L54) - #### Parameters ##### requestedModel @@ -61,8 +53,6 @@ Defined in: [types/proxy.ts:54](https://github.com/juspay/neurolink/blob/release > **isClaudeTarget**(`requestedModel`): `boolean` -Defined in: [types/proxy.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L55) - #### Parameters ##### requestedModel @@ -79,8 +69,6 @@ Defined in: [types/proxy.ts:55](https://github.com/juspay/neurolink/blob/release > **getFallbackChain**(): [`FallbackEntry`](FallbackEntry.md)[] -Defined in: [types/proxy.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L56) - #### Returns [`FallbackEntry`](FallbackEntry.md)[] @@ -91,8 +79,6 @@ Defined in: [types/proxy.ts:56](https://github.com/juspay/neurolink/blob/release > `optional` **isAutoFallbackEnabled**(): `boolean` -Defined in: [types/proxy.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L57) - #### Returns `boolean` @@ -103,8 +89,6 @@ Defined in: [types/proxy.ts:57](https://github.com/juspay/neurolink/blob/release > `optional` **getMaxInflightPerAccount**(): `number` \| `undefined` -Defined in: [types/proxy.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L58) - #### Returns `number` \| `undefined` diff --git a/docs/api/type-aliases/ModelRoutingOptions.md b/docs/api/type-aliases/ModelRoutingOptions.md index f825b5d77..385754f65 100644 --- a/docs/api/type-aliases/ModelRoutingOptions.md +++ b/docs/api/type-aliases/ModelRoutingOptions.md @@ -8,16 +8,12 @@ > **ModelRoutingOptions** = `object` -Defined in: [types/model.ts:261](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L261) - ## Properties ### forceTaskType? > `optional` **forceTaskType?**: [`TaskType`](TaskType.md) -Defined in: [types/model.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L263) - Override the task classification --- @@ -26,8 +22,6 @@ Override the task classification > `optional` **requireFast?**: `boolean` -Defined in: [types/model.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L265) - Require specific performance characteristics --- @@ -36,8 +30,6 @@ Require specific performance characteristics > `optional` **requireCapability?**: `string` -Defined in: [types/model.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L267) - Require specific capability (reasoning, creativity, etc.) --- @@ -46,6 +38,4 @@ Require specific capability (reasoning, creativity, etc.) > `optional` **fallbackStrategy?**: `"fast"` \| `"reasoning"` \| `"auto"` -Defined in: [types/model.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L269) - Fallback strategy if primary choice fails diff --git a/docs/api/type-aliases/ModelSearchFilters.md b/docs/api/type-aliases/ModelSearchFilters.md index dc4ef2e25..612870227 100644 --- a/docs/api/type-aliases/ModelSearchFilters.md +++ b/docs/api/type-aliases/ModelSearchFilters.md @@ -8,8 +8,6 @@ > **ModelSearchFilters** = `object` -Defined in: [types/model.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L198) - Model search filters ## Properties @@ -18,60 +16,44 @@ Model search filters > `optional` **provider?**: [`AIProviderName`](../enumerations/AIProviderName.md) \| [`AIProviderName`](../enumerations/AIProviderName.md)[] -Defined in: [types/model.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L199) - --- ### capability? > `optional` **capability?**: keyof [`ModelCapabilities`](ModelCapabilities.md) \| keyof [`ModelCapabilities`](ModelCapabilities.md)[] -Defined in: [types/model.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L200) - --- ### useCase? > `optional` **useCase?**: keyof [`UseCaseSuitability`](UseCaseSuitability.md) -Defined in: [types/model.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L201) - --- ### maxCost? > `optional` **maxCost?**: `number` -Defined in: [types/model.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L202) - --- ### minContextSize? > `optional` **minContextSize?**: `number` -Defined in: [types/model.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L203) - --- ### maxContextSize? > `optional` **maxContextSize?**: `number` -Defined in: [types/model.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L204) - --- ### performance? > `optional` **performance?**: [`ModelPerformance`](ModelPerformance.md)\[`"speed"`\] \| [`ModelPerformance`](ModelPerformance.md)\[`"quality"`\] -Defined in: [types/model.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L205) - --- ### category? > `optional` **category?**: [`ModelInfo`](ModelInfo.md)\[`"category"`\] \| [`ModelInfo`](ModelInfo.md)\[`"category"`\][] - -Defined in: [types/model.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L206) diff --git a/docs/api/type-aliases/ModelSearchResult.md b/docs/api/type-aliases/ModelSearchResult.md index fecdc90dc..49e214d0f 100644 --- a/docs/api/type-aliases/ModelSearchResult.md +++ b/docs/api/type-aliases/ModelSearchResult.md @@ -8,8 +8,6 @@ > **ModelSearchResult** = `object` -Defined in: [types/model.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L212) - Model search result with ranking ## Properties @@ -18,20 +16,14 @@ Model search result with ranking > **model**: [`ModelInfo`](ModelInfo.md) -Defined in: [types/model.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L213) - --- ### score > **score**: `number` -Defined in: [types/model.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L214) - --- ### matchReasons > **matchReasons**: `string`[] - -Defined in: [types/model.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L215) diff --git a/docs/api/type-aliases/ModelStats.md b/docs/api/type-aliases/ModelStats.md index d7d654c02..73cf54428 100644 --- a/docs/api/type-aliases/ModelStats.md +++ b/docs/api/type-aliases/ModelStats.md @@ -8,8 +8,6 @@ > **ModelStats** = `object` -Defined in: [types/providers.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L493) - Model Statistics Object - High Reusability ## Properties @@ -18,40 +16,30 @@ Model Statistics Object - High Reusability > **name**: `string` -Defined in: [types/providers.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L494) - --- ### provider > **provider**: `string` -Defined in: [types/providers.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L495) - --- ### capabilities > **capabilities**: [`ModelCapability`](ModelCapability.md)[] -Defined in: [types/providers.ts:496](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L496) - --- ### useCases > **useCases**: [`ModelUseCase`](ModelUseCase.md)[] -Defined in: [types/providers.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L497) - --- ### performance > **performance**: `object` -Defined in: [types/providers.ts:498](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L498) - #### avgLatency? > `optional` **avgLatency?**: `number` @@ -70,16 +58,12 @@ Defined in: [types/providers.ts:498](https://github.com/juspay/neurolink/blob/re > `optional` **pricing?**: [`ModelPricing`](ModelPricing.md) -Defined in: [types/providers.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L503) - --- ### metadata > **metadata**: `object` & `object` -Defined in: [types/providers.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L504) - #### Type Declaration ##### version? diff --git a/docs/api/type-aliases/ModelTier.md b/docs/api/type-aliases/ModelTier.md index a40970ca0..08f03b03a 100644 --- a/docs/api/type-aliases/ModelTier.md +++ b/docs/api/type-aliases/ModelTier.md @@ -8,6 +8,4 @@ > **ModelTier** = `"fast"` \| `"balanced"` \| `"quality"` -Defined in: [types/model.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L14) - Model performance tier definition diff --git a/docs/api/type-aliases/ModelTierEntry.md b/docs/api/type-aliases/ModelTierEntry.md index bbfdcdc9f..ce044a48c 100644 --- a/docs/api/type-aliases/ModelTierEntry.md +++ b/docs/api/type-aliases/ModelTierEntry.md @@ -8,8 +8,6 @@ > **ModelTierEntry** = `object` -Defined in: [types/requestRouter.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L59) - Tier-to-(provider,model) mapping used by `createDefaultRequestRouter`. Each tier is optional; an unmatched tier produces an empty decision. @@ -19,20 +17,14 @@ Each tier is optional; an unmatched tier produces an empty decision. > **provider**: `string` -Defined in: [types/requestRouter.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L60) - --- ### model > **model**: `string` -Defined in: [types/requestRouter.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L61) - --- ### region? > `optional` **region?**: `string` - -Defined in: [types/requestRouter.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/requestRouter.ts#L62) diff --git a/docs/api/type-aliases/ModelTokenStats.md b/docs/api/type-aliases/ModelTokenStats.md index e9c5043ba..dbc8e8601 100644 --- a/docs/api/type-aliases/ModelTokenStats.md +++ b/docs/api/type-aliases/ModelTokenStats.md @@ -8,8 +8,6 @@ > **ModelTokenStats** = `object` -Defined in: [types/observability.ts:443](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L443) - Token usage statistics by model ## Properties @@ -18,60 +16,44 @@ Token usage statistics by model > **model**: `string` -Defined in: [types/observability.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L444) - --- ### provider > **provider**: `string` -Defined in: [types/observability.ts:445](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L445) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/observability.ts:446](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L446) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/observability.ts:447](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L447) - --- ### totalTokens > **totalTokens**: `number` -Defined in: [types/observability.ts:448](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L448) - --- ### cost > **cost**: `number` -Defined in: [types/observability.ts:449](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L449) - --- ### requestCount > **requestCount**: `number` -Defined in: [types/observability.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L450) - --- ### avgTokensPerRequest > **avgTokensPerRequest**: `number` - -Defined in: [types/observability.ts:451](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L451) diff --git a/docs/api/type-aliases/ModelUseCase.md b/docs/api/type-aliases/ModelUseCase.md index e3abe8975..8e679fa5e 100644 --- a/docs/api/type-aliases/ModelUseCase.md +++ b/docs/api/type-aliases/ModelUseCase.md @@ -8,6 +8,4 @@ > **ModelUseCase** = `"chat"` \| `"completion"` \| `"analysis"` \| `"coding"` \| `"creative"` \| `"reasoning"` \| `"translation"` \| `"summarization"` \| `"classification"` -Defined in: [types/providers.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L430) - Model Use Cases - High Reusability diff --git a/docs/api/type-aliases/ModelsCommandArgs.md b/docs/api/type-aliases/ModelsCommandArgs.md index dc4c5790d..3671b7d3e 100644 --- a/docs/api/type-aliases/ModelsCommandArgs.md +++ b/docs/api/type-aliases/ModelsCommandArgs.md @@ -8,8 +8,6 @@ > **ModelsCommandArgs** = `Omit`\<[`BaseCommandArgs`](BaseCommandArgs.md), `"format"`\> & `object` -Defined in: [types/cli.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L245) - Models command arguments - Enhanced for model management ## Type Declaration diff --git a/docs/api/type-aliases/ModelsResponse.md b/docs/api/type-aliases/ModelsResponse.md index 647bd7307..ff1266ae9 100644 --- a/docs/api/type-aliases/ModelsResponse.md +++ b/docs/api/type-aliases/ModelsResponse.md @@ -8,8 +8,6 @@ > **ModelsResponse** = `object` -Defined in: [types/providers.ts:1386](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1386) - OpenAI-compatible models endpoint response structure ## Properties @@ -18,8 +16,6 @@ OpenAI-compatible models endpoint response structure > **data**: `object`[] -Defined in: [types/providers.ts:1387](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1387) - #### id > **id**: `string` diff --git a/docs/api/type-aliases/MultiJudgeScores.md b/docs/api/type-aliases/MultiJudgeScores.md index 0a3bb63c7..ded633584 100644 --- a/docs/api/type-aliases/MultiJudgeScores.md +++ b/docs/api/type-aliases/MultiJudgeScores.md @@ -8,8 +8,6 @@ > **MultiJudgeScores** = `object` -Defined in: [types/workflow.ts:366](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L366) - Multi-judge voting results ## Properties @@ -18,132 +16,98 @@ Multi-judge voting results > **judges**: [`JudgeScores`](JudgeScores.md)[] -Defined in: [types/workflow.ts:368](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L368) - --- ### averageScores > **averageScores**: `Record`\<`string`, `number`\> -Defined in: [types/workflow.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L371) - --- ### aggregatedRanking > **aggregatedRanking**: `string`[] -Defined in: [types/workflow.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L372) - --- ### consensusLevel > **consensusLevel**: `number` -Defined in: [types/workflow.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L373) - --- ### bestResponse > **bestResponse**: `string` -Defined in: [types/workflow.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L376) - --- ### confidence > **confidence**: `number` -Defined in: [types/workflow.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L377) - --- ### votingStrategy > **votingStrategy**: `"average"` \| `"median"` \| `"majority"` -Defined in: [types/workflow.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L380) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/workflow.ts:381](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L381) - --- ### judgeProvider? > `optional` **judgeProvider?**: `string` -Defined in: [types/workflow.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L384) - --- ### judgeModel? > `optional` **judgeModel?**: `string` -Defined in: [types/workflow.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L385) - --- ### scores > **scores**: `Record`\<`string`, `number`\> -Defined in: [types/workflow.ts:386](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L386) - --- ### ranking? > `optional` **ranking?**: `string`[] -Defined in: [types/workflow.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L387) - --- ### reasoning? > `optional` **reasoning?**: `string` -Defined in: [types/workflow.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L388) - --- ### confidenceInJudgment? > `optional` **confidenceInJudgment?**: `number` -Defined in: [types/workflow.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L389) - --- ### criteria > **criteria**: `string`[] -Defined in: [types/workflow.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L390) - --- ### judgeTime > **judgeTime**: `number` -Defined in: [types/workflow.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L391) - --- ### timestamp > **timestamp**: `string` - -Defined in: [types/workflow.ts:392](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L392) diff --git a/docs/api/type-aliases/MultiModalChunk.md b/docs/api/type-aliases/MultiModalChunk.md index 49c0a6d31..a0d6ec525 100644 --- a/docs/api/type-aliases/MultiModalChunk.md +++ b/docs/api/type-aliases/MultiModalChunk.md @@ -8,8 +8,6 @@ > **MultiModalChunk** = [`Chunk`](Chunk.md) & `object` -Defined in: [types/rag.ts:1691](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1691) - Extended chunk type for multi-modal RAG. Contains optional image data alongside text for image+text search. diff --git a/docs/api/type-aliases/MultiModalEmbeddingConfig.md b/docs/api/type-aliases/MultiModalEmbeddingConfig.md index 4e4dfe866..ffab87ff1 100644 --- a/docs/api/type-aliases/MultiModalEmbeddingConfig.md +++ b/docs/api/type-aliases/MultiModalEmbeddingConfig.md @@ -8,8 +8,6 @@ > **MultiModalEmbeddingConfig** = `object` -Defined in: [types/rag.ts:1658](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1658) - Multi-modal embedding model configuration ## Properties @@ -18,8 +16,6 @@ Multi-modal embedding model configuration > **provider**: `string` -Defined in: [types/rag.ts:1660](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1660) - Provider name (e.g. "bedrock") --- @@ -28,8 +24,6 @@ Provider name (e.g. "bedrock") > **modelName**: `string` -Defined in: [types/rag.ts:1662](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1662) - Model name (e.g. "amazon.titan-embed-image-v1") --- @@ -38,8 +32,6 @@ Model name (e.g. "amazon.titan-embed-image-v1") > **modality**: [`EmbeddingModality`](EmbeddingModality.md) -Defined in: [types/rag.ts:1664](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1664) - What modalities this model supports --- @@ -48,6 +40,4 @@ What modalities this model supports > `optional` **dimensions?**: `number` -Defined in: [types/rag.ts:1666](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1666) - Embedding dimension (e.g. 1024 for Titan Image) diff --git a/docs/api/type-aliases/MultiModalMatchType.md b/docs/api/type-aliases/MultiModalMatchType.md index 1b329b4a8..0c23549c9 100644 --- a/docs/api/type-aliases/MultiModalMatchType.md +++ b/docs/api/type-aliases/MultiModalMatchType.md @@ -8,6 +8,4 @@ > **MultiModalMatchType** = `"text-to-text"` \| `"text-to-image"` \| `"image-to-image"` \| `"image-to-text"` -Defined in: [types/rag.ts:1730](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1730) - Match type indicating how the result was found diff --git a/docs/api/type-aliases/MultiModalQuery.md b/docs/api/type-aliases/MultiModalQuery.md index 2899d8801..b84f0083b 100644 --- a/docs/api/type-aliases/MultiModalQuery.md +++ b/docs/api/type-aliases/MultiModalQuery.md @@ -8,7 +8,5 @@ > **MultiModalQuery** = [`EmbedInput`](EmbedInput.md) -Defined in: [types/rag.ts:1704](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1704) - Multi-modal query input — can be text, image, or both. Same shape as EmbedInput. diff --git a/docs/api/type-aliases/MultiModalRAGConfig.md b/docs/api/type-aliases/MultiModalRAGConfig.md index 0761a42ec..ac942f21b 100644 --- a/docs/api/type-aliases/MultiModalRAGConfig.md +++ b/docs/api/type-aliases/MultiModalRAGConfig.md @@ -8,8 +8,6 @@ > **MultiModalRAGConfig** = `object` -Defined in: [types/rag.ts:1710](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1710) - Multi-modal RAG pipeline configuration extension. Passed alongside RAGPipelineConfig to enable multi-modal features. @@ -19,8 +17,6 @@ Passed alongside RAGPipelineConfig to enable multi-modal features. > **enabled**: `boolean` -Defined in: [types/rag.ts:1712](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1712) - Whether multi-modal RAG is enabled --- @@ -29,8 +25,6 @@ Whether multi-modal RAG is enabled > **embeddingModel**: [`MultiModalEmbeddingConfig`](MultiModalEmbeddingConfig.md) -Defined in: [types/rag.ts:1714](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1714) - Embedding model for multi-modal content --- @@ -39,8 +33,6 @@ Embedding model for multi-modal content > `optional` **imageTextStrategy?**: `"caption"` \| `"filename"` \| `"none"` -Defined in: [types/rag.ts:1716](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1716) - How to generate text from images for indexing: "caption" uses LLM vision, "filename" uses filename, "none" skips text --- @@ -49,8 +41,6 @@ How to generate text from images for indexing: "caption" uses LLM vision, "filen > `optional` **maxImageSize?**: `number` -Defined in: [types/rag.ts:1718](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1718) - Maximum image file size in bytes (default: 10MB) --- @@ -59,8 +49,6 @@ Maximum image file size in bytes (default: 10MB) > `optional` **supportedFormats?**: `string`[] -Defined in: [types/rag.ts:1720](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1720) - Supported image MIME types --- @@ -69,8 +57,6 @@ Supported image MIME types > `optional` **captionProvider?**: `string` -Defined in: [types/rag.ts:1722](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1722) - Provider for generating image captions (used with imageTextStrategy: "caption") --- @@ -79,6 +65,4 @@ Provider for generating image captions (used with imageTextStrategy: "caption") > `optional` **captionModel?**: `string` -Defined in: [types/rag.ts:1724](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1724) - Model for generating image captions diff --git a/docs/api/type-aliases/MultiModalSearchResult.md b/docs/api/type-aliases/MultiModalSearchResult.md index 664aa07a0..46d83d567 100644 --- a/docs/api/type-aliases/MultiModalSearchResult.md +++ b/docs/api/type-aliases/MultiModalSearchResult.md @@ -8,8 +8,6 @@ > **MultiModalSearchResult** = `object` -Defined in: [types/rag.ts:1739](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1739) - Image search result from multi-modal retrieval ## Properties @@ -18,8 +16,6 @@ Image search result from multi-modal retrieval > **chunk**: [`MultiModalChunk`](MultiModalChunk.md) -Defined in: [types/rag.ts:1741](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1741) - The chunk containing the match --- @@ -28,8 +24,6 @@ The chunk containing the match > **score**: `number` -Defined in: [types/rag.ts:1743](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1743) - Similarity score (0-1) --- @@ -38,6 +32,4 @@ Similarity score (0-1) > **matchType**: [`MultiModalMatchType`](MultiModalMatchType.md) -Defined in: [types/rag.ts:1745](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L1745) - How this match was found diff --git a/docs/api/type-aliases/MultiSelectElicitation.md b/docs/api/type-aliases/MultiSelectElicitation.md index 5d0b6cd49..c77e08ed1 100644 --- a/docs/api/type-aliases/MultiSelectElicitation.md +++ b/docs/api/type-aliases/MultiSelectElicitation.md @@ -8,8 +8,6 @@ > **MultiSelectElicitation** = [`ElicitationRequest`](ElicitationRequest.md) & `object` -Defined in: [types/elicitation.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/elicitation.ts#L138) - Multi-select elicitation ## Type Declaration diff --git a/docs/api/type-aliases/MultiServerManagerConfig.md b/docs/api/type-aliases/MultiServerManagerConfig.md index 00bc4b961..11f1efc87 100644 --- a/docs/api/type-aliases/MultiServerManagerConfig.md +++ b/docs/api/type-aliases/MultiServerManagerConfig.md @@ -8,8 +8,6 @@ > **MultiServerManagerConfig** = `object` -Defined in: [types/mcp.ts:1893](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1893) - Multi-server manager configuration ## Properties @@ -18,8 +16,6 @@ Multi-server manager configuration > `optional` **defaultStrategy?**: [`LoadBalancingStrategy`](LoadBalancingStrategy.md) -Defined in: [types/mcp.ts:1897](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1897) - Default load balancing strategy --- @@ -28,8 +24,6 @@ Default load balancing strategy > `optional` **healthAwareRouting?**: `boolean` -Defined in: [types/mcp.ts:1902](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1902) - Enable health-aware routing by default --- @@ -38,8 +32,6 @@ Enable health-aware routing by default > `optional` **healthCheckInterval?**: `number` -Defined in: [types/mcp.ts:1907](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1907) - Health check interval in milliseconds --- @@ -48,8 +40,6 @@ Health check interval in milliseconds > `optional` **maxFailoverRetries?**: `number` -Defined in: [types/mcp.ts:1912](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1912) - Maximum retries on failover --- @@ -58,8 +48,6 @@ Maximum retries on failover > `optional` **namespaceSeparator?**: `string` -Defined in: [types/mcp.ts:1917](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1917) - Tool namespace separator --- @@ -68,8 +56,6 @@ Tool namespace separator > `optional` **autoNamespace?**: `boolean` -Defined in: [types/mcp.ts:1922](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1922) - Enable automatic tool namespace prefixing --- @@ -78,8 +64,6 @@ Enable automatic tool namespace prefixing > `optional` **conflictResolution?**: `"first-wins"` \| `"last-wins"` \| `"namespace"` \| `"explicit"` -Defined in: [types/mcp.ts:1929](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1929) - Conflict resolution strategy. Reserved for future conflict resolution strategy — currently stored but not consumed by any routing or tool-merge logic. diff --git a/docs/api/type-aliases/MultimodalAudioEntry.md b/docs/api/type-aliases/MultimodalAudioEntry.md index ada70b95f..6855f3d63 100644 --- a/docs/api/type-aliases/MultimodalAudioEntry.md +++ b/docs/api/type-aliases/MultimodalAudioEntry.md @@ -8,8 +8,6 @@ > **MultimodalAudioEntry** = `object` -Defined in: [types/file.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L117) - One audio file destined for native delivery to a provider. Carries the bytes rather than a path because the decision to send audio is @@ -23,8 +21,6 @@ memory. > **buffer**: `Buffer` -Defined in: [types/file.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L119) - Raw audio bytes, as detected. --- @@ -33,8 +29,6 @@ Raw audio bytes, as detected. > **filename**: `string` -Defined in: [types/file.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L121) - Display name; may be a full path, so log only its basename. --- @@ -43,6 +37,4 @@ Display name; may be a full path, so log only its basename. > **mimeType**: `string` -Defined in: [types/file.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L123) - Detected MIME type of `buffer`. diff --git a/docs/api/type-aliases/MultimodalChatMessage.md b/docs/api/type-aliases/MultimodalChatMessage.md index dfd4b299b..44c8c98f8 100644 --- a/docs/api/type-aliases/MultimodalChatMessage.md +++ b/docs/api/type-aliases/MultimodalChatMessage.md @@ -8,8 +8,6 @@ > **MultimodalChatMessage** = `object` -Defined in: [types/multimodal.ts:536](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L536) - Extended chat message for multimodal support (internal use) Used during message processing and transformation @@ -19,8 +17,6 @@ Used during message processing and transformation > **role**: `"user"` \| `"assistant"` \| `"system"` -Defined in: [types/multimodal.ts:538](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L538) - Role of the message sender --- @@ -29,8 +25,6 @@ Role of the message sender > **content**: `string` \| [`MessageContent`](MessageContent.md)[] -Defined in: [types/multimodal.ts:541](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L541) - Content of the message - can be text or multimodal content array --- @@ -39,6 +33,4 @@ Content of the message - can be text or multimodal content array > `optional` **providerOptions?**: `Record`\<`string`, `unknown`\> -Defined in: [types/multimodal.ts:544](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L544) - Provider-specific options (e.g. Anthropic cache_control) diff --git a/docs/api/type-aliases/MultimodalInput.md b/docs/api/type-aliases/MultimodalInput.md index ad8f03230..0984e8c59 100644 --- a/docs/api/type-aliases/MultimodalInput.md +++ b/docs/api/type-aliases/MultimodalInput.md @@ -8,8 +8,6 @@ > **MultimodalInput** = `object` -Defined in: [types/multimodal.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L437) - Multimodal input type for options that may contain images or content arrays This is the primary interface for users to provide multimodal content @@ -19,16 +17,12 @@ This is the primary interface for users to provide multimodal content > **text**: `string` -Defined in: [types/multimodal.ts:438](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L438) - --- ### images? > `optional` **images?**: (`Buffer` \| `string` \| [`ImageWithAltText`](ImageWithAltText.md))[] -Defined in: [types/multimodal.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L456) - Images to include in the request. Can be simple image data (Buffer, string) or objects with alt text for accessibility. @@ -51,40 +45,30 @@ images: [ > `optional` **content?**: [`Content`](Content.md)[] -Defined in: [types/multimodal.ts:457](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L457) - --- ### csvFiles? > `optional` **csvFiles?**: (`Buffer` \| `string`)[] -Defined in: [types/multimodal.ts:458](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L458) - --- ### pdfFiles? > `optional` **pdfFiles?**: (`Buffer` \| `string`)[] -Defined in: [types/multimodal.ts:459](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L459) - --- ### files? > `optional` **files?**: (`Buffer` \| `string`)[] -Defined in: [types/multimodal.ts:460](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L460) - --- ### audioFiles? > `optional` **audioFiles?**: (`Buffer` \| `string`)[] -Defined in: [types/multimodal.ts:463](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L463) - Audio files for file-based audio processing (future) --- @@ -93,8 +77,6 @@ Audio files for file-based audio processing (future) > `optional` **videoFiles?**: (`Buffer` \| `string`)[] -Defined in: [types/multimodal.ts:466](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L466) - Video files for file-based video processing (future) --- @@ -103,8 +85,6 @@ Video files for file-based video processing (future) > `optional` **segments?**: [`DirectorSegment`](DirectorSegment.md)[] -Defined in: [types/multimodal.ts:482](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L482) - Director Mode segments for multi-clip video generation. Each segment contains a prompt and image for generating one video clip. Automatically enables Director Mode when provided. diff --git a/docs/api/type-aliases/MultimodalMessage.md b/docs/api/type-aliases/MultimodalMessage.md index 9f3db3479..3e43cb9c4 100644 --- a/docs/api/type-aliases/MultimodalMessage.md +++ b/docs/api/type-aliases/MultimodalMessage.md @@ -8,8 +8,6 @@ > **MultimodalMessage** = `object` -Defined in: [types/multimodal.ts:550](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L550) - Multimodal message structure for provider adapters ## Properties @@ -18,12 +16,8 @@ Multimodal message structure for provider adapters > **role**: `"user"` \| `"assistant"` \| `"system"` -Defined in: [types/multimodal.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L551) - --- ### content > **content**: [`Content`](Content.md)[] - -Defined in: [types/multimodal.ts:552](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L552) diff --git a/docs/api/type-aliases/MultimodalPdfEntry.md b/docs/api/type-aliases/MultimodalPdfEntry.md index ece102893..8cfa87f40 100644 --- a/docs/api/type-aliases/MultimodalPdfEntry.md +++ b/docs/api/type-aliases/MultimodalPdfEntry.md @@ -8,8 +8,6 @@ > **MultimodalPdfEntry** = `object` -Defined in: [types/file.ts:796](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L796) - A single PDF queued for multimodal message building, normalised from either submission surface — `input.pdfFiles` or `input.content` with `type: "pdf"` — so both can share the aggregate page/size guard (#309). @@ -20,8 +18,6 @@ submission surface — `input.pdfFiles` or `input.content` with `type: "pdf"` > **buffer**: `Buffer` -Defined in: [types/file.ts:798](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L798) - Raw PDF bytes. --- @@ -30,8 +26,6 @@ Raw PDF bytes. > **filename**: `string` -Defined in: [types/file.ts:800](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L800) - Display name; may be a full path, so log only its basename. --- @@ -40,8 +34,6 @@ Display name; may be a full path, so log only its basename. > `optional` **pageCount?**: `number` \| `null` -Defined in: [types/file.ts:806](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L806) - Page count when known. Null/undefined on the `input.content` path whenever the caller omitted `metadata.pages`; the aggregate guard resolves those from `buffer` rather than treating them as zero. @@ -52,8 +44,6 @@ from `buffer` rather than treating them as zero. > `optional` **password?**: `string` -Defined in: [types/file.ts:808](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L808) - Password for an encrypted PDF (#258). --- @@ -62,8 +52,6 @@ Password for an encrypted PDF (#258). > `optional` **maxCanvasPixels?**: `number` -Defined in: [types/file.ts:810](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L810) - Per-page pixel ceiling for the image fallback (#260). --- @@ -72,8 +60,6 @@ Per-page pixel ceiling for the image fallback (#260). > `optional` **scale?**: `number` -Defined in: [types/file.ts:812](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L812) - Render scale for the image fallback (#297). --- @@ -82,6 +68,4 @@ Render scale for the image fallback (#297). > `optional` **maxPages?**: `number` -Defined in: [types/file.ts:814](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L814) - Max pages converted by the image fallback (#297). diff --git a/docs/api/type-aliases/MultimodalVideoEntry.md b/docs/api/type-aliases/MultimodalVideoEntry.md index 20482f650..f6f72614e 100644 --- a/docs/api/type-aliases/MultimodalVideoEntry.md +++ b/docs/api/type-aliases/MultimodalVideoEntry.md @@ -8,8 +8,6 @@ > **MultimodalVideoEntry** = `object` -Defined in: [types/file.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L140) - One video file destined for native delivery to a provider. Mirrors [MultimodalAudioEntry](MultimodalAudioEntry.md): the bytes travel rather than the path, @@ -29,8 +27,6 @@ comfortably under the size ceiling. > **buffer**: `Buffer` -Defined in: [types/file.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L142) - Raw video bytes, as detected. --- @@ -39,8 +35,6 @@ Raw video bytes, as detected. > **filename**: `string` -Defined in: [types/file.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L144) - Display name; may be a full path, so log only its basename. --- @@ -49,8 +43,6 @@ Display name; may be a full path, so log only its basename. > **mimeType**: `string` -Defined in: [types/file.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L146) - Detected MIME type of `buffer`. --- @@ -59,6 +51,4 @@ Detected MIME type of `buffer`. > `optional` **durationSec?**: `number` -Defined in: [types/file.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L148) - Clip length in seconds, when the processor was able to measure it. diff --git a/docs/api/type-aliases/MusicAudioFormat.md b/docs/api/type-aliases/MusicAudioFormat.md index fee097c1e..dd5af4b7d 100644 --- a/docs/api/type-aliases/MusicAudioFormat.md +++ b/docs/api/type-aliases/MusicAudioFormat.md @@ -8,6 +8,4 @@ > **MusicAudioFormat** = `"mp3"` \| `"wav"` \| `"flac"` \| `"ogg"` -Defined in: [types/music.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L16) - Output audio formats supported across music providers. diff --git a/docs/api/type-aliases/MusicGenre.md b/docs/api/type-aliases/MusicGenre.md index d241fb647..006927911 100644 --- a/docs/api/type-aliases/MusicGenre.md +++ b/docs/api/type-aliases/MusicGenre.md @@ -8,8 +8,6 @@ > **MusicGenre** = `string` -Defined in: [types/music.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L24) - Music genre — provider-specific, free-text accepted. Common genres: "ambient", "cinematic", "rock", "pop", "jazz", "classical", diff --git a/docs/api/type-aliases/MusicHandler.md b/docs/api/type-aliases/MusicHandler.md index b149013ca..691585005 100644 --- a/docs/api/type-aliases/MusicHandler.md +++ b/docs/api/type-aliases/MusicHandler.md @@ -8,8 +8,6 @@ > **MusicHandler** = `object` -Defined in: [types/music.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L127) - Handler contract for music-generation providers. Implementations enforce their own timeouts. Recommended: @@ -23,8 +21,6 @@ Implementations enforce their own timeouts. Recommended: > `readonly` `optional` **maxDurationSeconds?**: `number` -Defined in: [types/music.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L141) - Maximum supported track duration in seconds (provider-specific). --- @@ -33,8 +29,6 @@ Maximum supported track duration in seconds (provider-specific). > `readonly` `optional` **supportedFormats?**: readonly [`MusicAudioFormat`](MusicAudioFormat.md)[] -Defined in: [types/music.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L144) - Output formats supported by this handler. --- @@ -43,8 +37,6 @@ Output formats supported by this handler. > `readonly` `optional` **supportedGenres?**: readonly `string`[] -Defined in: [types/music.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L147) - Genres / styles the upstream advertises (informational). ## Methods @@ -53,8 +45,6 @@ Genres / styles the upstream advertises (informational). > **generate**(`options`): `Promise`\<[`MusicResult`](MusicResult.md)\> -Defined in: [types/music.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L133) - Generate a music track from prompt + options. #### Parameters @@ -75,8 +65,6 @@ prompt, duration, format, genre, mood, etc. > **isConfigured**(): `boolean` -Defined in: [types/music.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L138) - Validate the provider is configured (auth, base URL, etc.). #### Returns diff --git a/docs/api/type-aliases/MusicMood.md b/docs/api/type-aliases/MusicMood.md index 3537ce627..4f8c8b42d 100644 --- a/docs/api/type-aliases/MusicMood.md +++ b/docs/api/type-aliases/MusicMood.md @@ -8,8 +8,6 @@ > **MusicMood** = `string` -Defined in: [types/music.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L32) - Music mood — provider-specific, free-text accepted. Common moods: "uplifting", "melancholic", "tense", "calm", "energetic", diff --git a/docs/api/type-aliases/MusicOptions.md b/docs/api/type-aliases/MusicOptions.md index 4bf707308..a2b918fbd 100644 --- a/docs/api/type-aliases/MusicOptions.md +++ b/docs/api/type-aliases/MusicOptions.md @@ -8,8 +8,6 @@ > **MusicOptions** = `object` -Defined in: [types/music.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L52) - Options for music generation requests. ## Indexable @@ -24,8 +22,6 @@ Provider-specific additional options. > **prompt**: `string` -Defined in: [types/music.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L54) - Text prompt describing the music to generate (required). --- @@ -34,8 +30,6 @@ Text prompt describing the music to generate (required). > `optional` **duration?**: `number` -Defined in: [types/music.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L57) - Target duration in seconds. Provider-clamped to its supported range. --- @@ -44,8 +38,6 @@ Target duration in seconds. Provider-clamped to its supported range. > `optional` **format?**: [`MusicAudioFormat`](MusicAudioFormat.md) -Defined in: [types/music.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L60) - Output format (default: "mp3"). --- @@ -54,8 +46,6 @@ Output format (default: "mp3"). > `optional` **genre?**: [`MusicGenre`](MusicGenre.md) -Defined in: [types/music.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L63) - Genre hint (e.g. "ambient", "cinematic"). --- @@ -64,8 +54,6 @@ Genre hint (e.g. "ambient", "cinematic"). > `optional` **mood?**: [`MusicMood`](MusicMood.md) -Defined in: [types/music.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L66) - Mood / emotion hint (e.g. "uplifting", "tense"). --- @@ -74,8 +62,6 @@ Mood / emotion hint (e.g. "uplifting", "tense"). > `optional` **tempo?**: `number` -Defined in: [types/music.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L69) - Tempo in BPM (provider-specific support). --- @@ -84,8 +70,6 @@ Tempo in BPM (provider-specific support). > `optional` **provider?**: [`MusicProviderName`](MusicProviderName.md) -Defined in: [types/music.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L72) - Override the music provider (e.g. "beatoven", "elevenlabs-music", "lyria", "replicate"). --- @@ -94,8 +78,6 @@ Override the music provider (e.g. "beatoven", "elevenlabs-music", "lyria", "repl > `optional` **referenceAudio?**: `Buffer` \| `string` -Defined in: [types/music.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L75) - Reference audio for melody / style guidance (Buffer or path). --- @@ -104,8 +86,6 @@ Reference audio for melody / style guidance (Buffer or path). > `optional` **output?**: `string` -Defined in: [types/music.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L78) - Output file path (optional — buffer is always returned in result). --- @@ -114,6 +94,4 @@ Output file path (optional — buffer is always returned in result). > `optional` **timeout?**: `number` -Defined in: [types/music.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L81) - Per-call timeout in ms (default: 5 minutes). diff --git a/docs/api/type-aliases/MusicProviderName.md b/docs/api/type-aliases/MusicProviderName.md index 824a400e9..8826ac5f3 100644 --- a/docs/api/type-aliases/MusicProviderName.md +++ b/docs/api/type-aliases/MusicProviderName.md @@ -8,8 +8,6 @@ > **MusicProviderName** = `"beatoven"` \| `"elevenlabs-music"` \| `"elevenlabs-sound"` \| `"lyria"` \| `"replicate"` \| `"musicgen"` \| `string` & `object` -Defined in: [types/music.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L40) - Known music provider identifiers shipped with NeuroLink. `(string & {})` keeps the union open for custom provider names diff --git a/docs/api/type-aliases/MusicResult.md b/docs/api/type-aliases/MusicResult.md index 481d79c17..a60e16a5c 100644 --- a/docs/api/type-aliases/MusicResult.md +++ b/docs/api/type-aliases/MusicResult.md @@ -8,8 +8,6 @@ > **MusicResult** = `object` -Defined in: [types/music.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L90) - Result of a music generation request. ## Properties @@ -18,8 +16,6 @@ Result of a music generation request. > **buffer**: `Buffer` -Defined in: [types/music.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L92) - Generated audio buffer. --- @@ -28,8 +24,6 @@ Generated audio buffer. > **format**: [`MusicAudioFormat`](MusicAudioFormat.md) -Defined in: [types/music.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L94) - Output format. --- @@ -38,8 +32,6 @@ Output format. > **size**: `number` -Defined in: [types/music.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L96) - File size in bytes. --- @@ -48,8 +40,6 @@ File size in bytes. > `optional` **duration?**: `number` -Defined in: [types/music.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L98) - Duration in seconds (when reported by the provider). --- @@ -58,8 +48,6 @@ Duration in seconds (when reported by the provider). > `optional` **provider?**: `string` -Defined in: [types/music.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L100) - Provider used for generation. --- @@ -68,8 +56,6 @@ Provider used for generation. > `optional` **metadata?**: `object` -Defined in: [types/music.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/music.ts#L102) - Performance / request metadata. #### Index Signature diff --git a/docs/api/type-aliases/NativeAnthropicToolDeclaration.md b/docs/api/type-aliases/NativeAnthropicToolDeclaration.md index be22be5b6..c9f17bd6c 100644 --- a/docs/api/type-aliases/NativeAnthropicToolDeclaration.md +++ b/docs/api/type-aliases/NativeAnthropicToolDeclaration.md @@ -8,8 +8,6 @@ > **NativeAnthropicToolDeclaration** = `object` -Defined in: [types/nativeTools.ts:10](https://github.com/juspay/neurolink/blob/release/src/lib/types/nativeTools.ts#L10) - A single tool declaration in Anthropic's native `input_schema` wire format. ## Properties @@ -18,32 +16,24 @@ A single tool declaration in Anthropic's native `input_schema` wire format. > **name**: `string` -Defined in: [types/nativeTools.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/types/nativeTools.ts#L11) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/nativeTools.ts:12](https://github.com/juspay/neurolink/blob/release/src/lib/types/nativeTools.ts#L12) - --- ### input_schema > **input_schema**: `Record`\<`string`, `unknown`\> -Defined in: [types/nativeTools.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/types/nativeTools.ts#L13) - --- ### cache_control? > `optional` **cache_control?**: `object` -Defined in: [types/nativeTools.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/nativeTools.ts#L14) - #### type > **type**: `"ephemeral"` diff --git a/docs/api/type-aliases/NativeFunctionCall.md b/docs/api/type-aliases/NativeFunctionCall.md index 9679aff06..83a261d22 100644 --- a/docs/api/type-aliases/NativeFunctionCall.md +++ b/docs/api/type-aliases/NativeFunctionCall.md @@ -8,8 +8,6 @@ > **NativeFunctionCall** = `object` -Defined in: [types/providers.ts:2138](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2138) - A single function call returned by the Gemini model. ## Properties @@ -18,12 +16,8 @@ A single function call returned by the Gemini model. > **name**: `string` -Defined in: [types/providers.ts:2139](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2139) - --- ### args > **args**: `Record`\<`string`, `unknown`\> - -Defined in: [types/providers.ts:2140](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2140) diff --git a/docs/api/type-aliases/NativeFunctionDeclaration.md b/docs/api/type-aliases/NativeFunctionDeclaration.md index d13652092..d7c92226e 100644 --- a/docs/api/type-aliases/NativeFunctionDeclaration.md +++ b/docs/api/type-aliases/NativeFunctionDeclaration.md @@ -8,8 +8,6 @@ > **NativeFunctionDeclaration** = `object` -Defined in: [types/providers.ts:2112](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2112) - A single function declaration for the Gemini native SDK. ## Properties @@ -18,20 +16,14 @@ A single function declaration for the Gemini native SDK. > **name**: `string` -Defined in: [types/providers.ts:2113](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2113) - --- ### description > **description**: `string` -Defined in: [types/providers.ts:2114](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2114) - --- ### parametersJsonSchema? > `optional` **parametersJsonSchema?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/providers.ts:2115](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2115) diff --git a/docs/api/type-aliases/NativeFunctionResponse.md b/docs/api/type-aliases/NativeFunctionResponse.md index 8d509f384..9be1c8d6f 100644 --- a/docs/api/type-aliases/NativeFunctionResponse.md +++ b/docs/api/type-aliases/NativeFunctionResponse.md @@ -8,8 +8,6 @@ > **NativeFunctionResponse** = `object` -Defined in: [types/providers.ts:2144](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2144) - A single function response to feed back into the conversation. ## Properties @@ -18,8 +16,6 @@ A single function response to feed back into the conversation. > **functionResponse**: `object` -Defined in: [types/providers.ts:2145](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2145) - #### name > **name**: `string` diff --git a/docs/api/type-aliases/NativeGenerateGuardConfig.md b/docs/api/type-aliases/NativeGenerateGuardConfig.md index 70021bcbd..b8be04f50 100644 --- a/docs/api/type-aliases/NativeGenerateGuardConfig.md +++ b/docs/api/type-aliases/NativeGenerateGuardConfig.md @@ -8,8 +8,6 @@ > **NativeGenerateGuardConfig** = `object` -Defined in: [types/context.ts:1043](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1043) - Per-turn configuration for reclaiming a native V3 conversation. ## Properties @@ -18,24 +16,18 @@ Per-turn configuration for reclaiming a native V3 conversation. > **provider**: `string` -Defined in: [types/context.ts:1044](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1044) - --- ### availableInputTokens > **availableInputTokens**: `number` -Defined in: [types/context.ts:1045](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1045) - --- ### getFixedOverheadTokens > **getFixedOverheadTokens**: () => `number` -Defined in: [types/context.ts:1046](https://github.com/juspay/neurolink/blob/release/src/lib/types/context.ts#L1046) - #### Returns `number` diff --git a/docs/api/type-aliases/NativeGenerateLoopArgs.md b/docs/api/type-aliases/NativeGenerateLoopArgs.md index 16ba28967..6de77770a 100644 --- a/docs/api/type-aliases/NativeGenerateLoopArgs.md +++ b/docs/api/type-aliases/NativeGenerateLoopArgs.md @@ -8,8 +8,6 @@ > **NativeGenerateLoopArgs** = `object` -Defined in: [types/generate.ts:1887](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1887) - Inputs to the shared native generate loop (`core/nativeGenerateLoop.ts`). One loop serves every provider whose delegating model exposes a v3-shaped `doGenerate`; the provider supplies the wire details. @@ -20,8 +18,6 @@ One loop serves every provider whose delegating model exposes a v3-shaped > `optional` **observeUsage?**: (`usage`) => `void` -Defined in: [types/generate.ts:1889](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1889) - Observed usage for calibrating the next step against the last request. #### Parameters @@ -40,8 +36,6 @@ Observed usage for calibrating the next step against the last request. > `optional` **guardConversation?**: (`conversation`) => `Record`\<`string`, `unknown`\>[] \| `undefined` -Defined in: [types/generate.ts:1896](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1896) - Per-step context reclaim, called before every model call with the conversation as it now stands. Return a replacement to have the loop adopt it, or undefined to leave it untouched. The provider owns this because the @@ -63,8 +57,6 @@ reclaim has to understand its wire shape. > **doGenerate**: (`options`) => `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [types/generate.ts:1899](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1899) - #### Parameters ##### options @@ -81,8 +73,6 @@ Defined in: [types/generate.ts:1899](https://github.com/juspay/neurolink/blob/re > **conversation**: `Record`\<`string`, `unknown`\>[] -Defined in: [types/generate.ts:1903](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1903) - Conversation in the message-builder shape each doGenerate converts itself. --- @@ -91,8 +81,6 @@ Conversation in the message-builder shape each doGenerate converts itself. > `optional` **tools?**: `Record`\<`string`, `unknown`\>[] -Defined in: [types/generate.ts:1905](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1905) - Tool declarations in the v3 shape doGenerate already knows how to convert. --- @@ -101,8 +89,6 @@ Tool declarations in the v3 shape doGenerate already knows how to convert. > **toolsRecord**: `Record`\<`string`, `unknown`\> -Defined in: [types/generate.ts:1907](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1907) - Registered tools, used to execute a call the model asks for. --- @@ -111,64 +97,48 @@ Registered tools, used to execute a call the model asks for. > `optional` **toolChoice?**: `unknown` -Defined in: [types/generate.ts:1908](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1908) - --- ### responseFormat? > `optional` **responseFormat?**: `Record`\<`string`, `unknown`\> -Defined in: [types/generate.ts:1909](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1909) - --- ### providerOptions? > `optional` **providerOptions?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\> -Defined in: [types/generate.ts:1910](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1910) - --- ### maxSteps > **maxSteps**: `number` -Defined in: [types/generate.ts:1911](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1911) - --- ### maxOutputTokens? > `optional` **maxOutputTokens?**: `number` -Defined in: [types/generate.ts:1912](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1912) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/generate.ts:1913](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1913) - --- ### abortSignal? > `optional` **abortSignal?**: `AbortSignal` -Defined in: [types/generate.ts:1914](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1914) - --- ### toolTimeoutMs? > `optional` **toolTimeoutMs?**: `number` \| `null` -Defined in: [types/generate.ts:1916](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1916) - Per-tool-execution cap, forwarded into `guardToolExecutor`. `null` for no bound. --- @@ -177,8 +147,6 @@ Per-tool-execution cap, forwarded into `guardToolExecutor`. `null` for no bound. > **runStep**: (`call`) => `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [types/generate.ts:1918](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1918) - Wraps one step: retry ladder plus provider error classification. #### Parameters diff --git a/docs/api/type-aliases/NativeGenerateLoopResult.md b/docs/api/type-aliases/NativeGenerateLoopResult.md index 3bbc65d24..47da287df 100644 --- a/docs/api/type-aliases/NativeGenerateLoopResult.md +++ b/docs/api/type-aliases/NativeGenerateLoopResult.md @@ -8,24 +8,18 @@ > **NativeGenerateLoopResult** = `object` -Defined in: [types/generate.ts:1923](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1923) - ## Properties ### text > **text**: `string` -Defined in: [types/generate.ts:1924](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1924) - --- ### reasoning? > `optional` **reasoning?**: `string` -Defined in: [types/generate.ts:1932](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1932) - Joined reasoning content parts from EVERY step, when the vendor sent any. Was final-step-only until the native generate loop began accumulating @@ -38,60 +32,44 @@ that happened after its last tool call. > **finishReason**: `string` -Defined in: [types/generate.ts:1933](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1933) - --- ### rawFinishReason? > `optional` **rawFinishReason?**: `string` -Defined in: [types/generate.ts:1934](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1934) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/generate.ts:1935](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1935) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/generate.ts:1936](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1936) - --- ### cacheReadTokens > **cacheReadTokens**: `number` -Defined in: [types/generate.ts:1937](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1937) - --- ### cacheWriteTokens > **cacheWriteTokens**: `number` -Defined in: [types/generate.ts:1938](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1938) - --- ### toolsUsed > **toolsUsed**: `string`[] -Defined in: [types/generate.ts:1939](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1939) - --- ### steps > **steps**: `number` - -Defined in: [types/generate.ts:1940](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1940) diff --git a/docs/api/type-aliases/NativeMediaAttachments.md b/docs/api/type-aliases/NativeMediaAttachments.md index eb0bce444..055d08b60 100644 --- a/docs/api/type-aliases/NativeMediaAttachments.md +++ b/docs/api/type-aliases/NativeMediaAttachments.md @@ -8,8 +8,6 @@ > **NativeMediaAttachments** = `object` -Defined in: [types/file.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L194) - Media collected during file detection that a provider may be able to consume directly, rather than as a text summary. @@ -25,24 +23,18 @@ every call site. > `readonly` `optional` **audio?**: [`MultimodalAudioEntry`](MultimodalAudioEntry.md)[] -Defined in: [types/file.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L195) - --- ### video? > `readonly` `optional` **video?**: [`MultimodalVideoEntry`](MultimodalVideoEntry.md)[] -Defined in: [types/file.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L196) - --- ### outputFormat? > `readonly` `optional` **outputFormat?**: [`VisionImageOutputFormat`](VisionImageOutputFormat.md) -Defined in: [types/file.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L203) - Transcode target for an incompatible image (see `GenerateOptions.imageOptions`). Not itself a native attachment, but bundled here for the same reason audio and video are: it is one more diff --git a/docs/api/type-aliases/NativeThinkingConfig.md b/docs/api/type-aliases/NativeThinkingConfig.md index a654bb6da..1ef3544ef 100644 --- a/docs/api/type-aliases/NativeThinkingConfig.md +++ b/docs/api/type-aliases/NativeThinkingConfig.md @@ -8,8 +8,6 @@ > **NativeThinkingConfig** = `object` -Defined in: [types/config.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L651) - Native SDK thinkingConfig structure for Gemini native SDK. `thinkingLevel` and `thinkingBudget` are mutually exclusive on the wire: @@ -30,20 +28,14 @@ callers building the request pick whichever field the target model accepts. > **includeThoughts**: `boolean` -Defined in: [types/config.ts:652](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L652) - --- ### thinkingLevel? > `optional` **thinkingLevel?**: [`ThinkingLevel`](ThinkingLevel.md) -Defined in: [types/config.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L653) - --- ### thinkingBudget? > `optional` **thinkingBudget?**: `number` - -Defined in: [types/config.ts:654](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L654) diff --git a/docs/api/type-aliases/NativeToolDeclarationsResult.md b/docs/api/type-aliases/NativeToolDeclarationsResult.md index 5e097a977..b438724ad 100644 --- a/docs/api/type-aliases/NativeToolDeclarationsResult.md +++ b/docs/api/type-aliases/NativeToolDeclarationsResult.md @@ -8,8 +8,6 @@ > **NativeToolDeclarationsResult** = `object` -Defined in: [types/providers.ts:2131](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2131) - Return value of buildNativeToolDeclarations. `originalNameMap` lets callers translate a Google-safe (sanitized, @@ -23,20 +21,14 @@ MUST be hidden from tool-call metadata exposed to consumers. > **toolsConfig**: [`NativeToolsConfig`](NativeToolsConfig.md) -Defined in: [types/providers.ts:2132](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2132) - --- ### executeMap > **executeMap**: `Map`\<`string`, [`Tool`](Tool.md)\[`"execute"`\]\> -Defined in: [types/providers.ts:2133](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2133) - --- ### originalNameMap > **originalNameMap**: `Map`\<`string`, `string`\> - -Defined in: [types/providers.ts:2134](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2134) diff --git a/docs/api/type-aliases/NativeToolFormat.md b/docs/api/type-aliases/NativeToolFormat.md index d186942cf..671392f90 100644 --- a/docs/api/type-aliases/NativeToolFormat.md +++ b/docs/api/type-aliases/NativeToolFormat.md @@ -8,8 +8,6 @@ > **NativeToolFormat** = `"input_schema"` \| `"functionDeclarations"` -Defined in: [types/nativeTools.ts:7](https://github.com/juspay/neurolink/blob/release/src/lib/types/nativeTools.ts#L7) - Wire formats accepted by `toNativeToolDeclarations` (src/lib/core/nativeToolFormat.ts). `"input_schema"` is Anthropic's native Messages-API tool shape; `"functionDeclarations"` is the @google/genai SDK shape shared by the diff --git a/docs/api/type-aliases/NativeToolsConfig.md b/docs/api/type-aliases/NativeToolsConfig.md index 628cf07ab..4b80e85b4 100644 --- a/docs/api/type-aliases/NativeToolsConfig.md +++ b/docs/api/type-aliases/NativeToolsConfig.md @@ -8,8 +8,6 @@ > **NativeToolsConfig** = `object`[] -Defined in: [types/providers.ts:2119](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2119) - The tools config array expected by the @google/genai SDK. ## Type Declaration diff --git a/docs/api/type-aliases/NetworkCompleteChunk.md b/docs/api/type-aliases/NetworkCompleteChunk.md index 54e2e6547..9d5fccf6f 100644 --- a/docs/api/type-aliases/NetworkCompleteChunk.md +++ b/docs/api/type-aliases/NetworkCompleteChunk.md @@ -8,8 +8,6 @@ > **NetworkCompleteChunk** = [`NetworkStreamChunkBase`](NetworkStreamChunkBase.md) & `object` -Defined in: [types/agentNetwork.ts:816](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L816) - Network complete event ## Type Declaration diff --git a/docs/api/type-aliases/NetworkDefaults.md b/docs/api/type-aliases/NetworkDefaults.md index aaf6675de..d07d3d280 100644 --- a/docs/api/type-aliases/NetworkDefaults.md +++ b/docs/api/type-aliases/NetworkDefaults.md @@ -8,8 +8,6 @@ > **NetworkDefaults** = `object` -Defined in: [types/agentNetwork.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L342) - Default execution options for the network ## Properties @@ -18,8 +16,6 @@ Default execution options for the network > `optional` **maxSteps?**: `number` -Defined in: [types/agentNetwork.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L344) - Maximum steps per execution --- @@ -28,8 +24,6 @@ Maximum steps per execution > `optional` **timeout?**: `number` -Defined in: [types/agentNetwork.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L347) - Timeout in milliseconds --- @@ -38,6 +32,4 @@ Timeout in milliseconds > `optional` **temperature?**: `number` -Defined in: [types/agentNetwork.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L350) - Default temperature diff --git a/docs/api/type-aliases/NetworkErrorChunk.md b/docs/api/type-aliases/NetworkErrorChunk.md index 3744c58b7..6672ebfa4 100644 --- a/docs/api/type-aliases/NetworkErrorChunk.md +++ b/docs/api/type-aliases/NetworkErrorChunk.md @@ -8,8 +8,6 @@ > **NetworkErrorChunk** = [`NetworkStreamChunkBase`](NetworkStreamChunkBase.md) & `object` -Defined in: [types/agentNetwork.ts:824](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L824) - Network error event ## Type Declaration diff --git a/docs/api/type-aliases/NetworkExecutionInput.md b/docs/api/type-aliases/NetworkExecutionInput.md index 63f1d0459..56054c0f7 100644 --- a/docs/api/type-aliases/NetworkExecutionInput.md +++ b/docs/api/type-aliases/NetworkExecutionInput.md @@ -8,8 +8,6 @@ > **NetworkExecutionInput** = `object` -Defined in: [types/agentNetwork.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L377) - Input for network execution ## Properties @@ -18,8 +16,6 @@ Input for network execution > **message**: `string` \| [`CoreMessage`](CoreMessage.md)[] -Defined in: [types/agentNetwork.ts:379](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L379) - The task or message to process --- @@ -28,8 +24,6 @@ The task or message to process > `optional` **threadId?**: `string` -Defined in: [types/agentNetwork.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L382) - Thread ID for conversation context --- @@ -38,8 +32,6 @@ Thread ID for conversation context > `optional` **resourceId?**: `string` -Defined in: [types/agentNetwork.ts:385](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L385) - User/resource identifier --- @@ -48,6 +40,4 @@ User/resource identifier > `optional` **context?**: `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L388) - Additional context diff --git a/docs/api/type-aliases/NetworkExecutionOptions.md b/docs/api/type-aliases/NetworkExecutionOptions.md index 858d26013..87a325b25 100644 --- a/docs/api/type-aliases/NetworkExecutionOptions.md +++ b/docs/api/type-aliases/NetworkExecutionOptions.md @@ -8,8 +8,6 @@ > **NetworkExecutionOptions** = `object` -Defined in: [types/agentNetwork.ts:402](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L402) - Options for network execution ## Properties @@ -18,8 +16,6 @@ Options for network execution > `optional` **maxSteps?**: `number` -Defined in: [types/agentNetwork.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L404) - Maximum execution steps across the network --- @@ -28,8 +24,6 @@ Maximum execution steps across the network > `optional` **timeout?**: `number` -Defined in: [types/agentNetwork.ts:407](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L407) - Timeout in milliseconds --- @@ -38,8 +32,6 @@ Timeout in milliseconds > `optional` **stream?**: `boolean` -Defined in: [types/agentNetwork.ts:410](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L410) - Enable streaming --- @@ -48,8 +40,6 @@ Enable streaming > `optional` **context?**: `Record`\<`string`, `unknown`\> -Defined in: [types/agentNetwork.ts:413](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L413) - Additional context --- @@ -58,8 +48,6 @@ Additional context > `optional` **tracing?**: `object` -Defined in: [types/agentNetwork.ts:416](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L416) - Tracing configuration #### enabled? @@ -80,8 +68,6 @@ Tracing configuration > `optional` **modelSettings?**: `object` -Defined in: [types/agentNetwork.ts:423](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L423) - Model settings override #### temperature? @@ -102,6 +88,4 @@ Model settings override > `optional` **outputSchema?**: `z.ZodSchema` -Defined in: [types/agentNetwork.ts:430](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L430) - Output schema for structured output diff --git a/docs/api/type-aliases/NetworkExecutionResult.md b/docs/api/type-aliases/NetworkExecutionResult.md index fad91f2f7..c19c5153d 100644 --- a/docs/api/type-aliases/NetworkExecutionResult.md +++ b/docs/api/type-aliases/NetworkExecutionResult.md @@ -8,8 +8,6 @@ > **NetworkExecutionResult** = `object` -Defined in: [types/agentNetwork.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L436) - Result of network execution ## Properties @@ -18,8 +16,6 @@ Result of network execution > **content**: `string` -Defined in: [types/agentNetwork.ts:438](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L438) - Final output content --- @@ -28,8 +24,6 @@ Final output content > `optional` **object?**: `unknown` -Defined in: [types/agentNetwork.ts:441](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L441) - Structured output if schema was provided --- @@ -38,8 +32,6 @@ Structured output if schema was provided > **trace**: [`NetworkExecutionTrace`](NetworkExecutionTrace.md) -Defined in: [types/agentNetwork.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L444) - Execution trace --- @@ -48,8 +40,6 @@ Execution trace > **usage**: [`NetworkTokenUsage`](NetworkTokenUsage.md) -Defined in: [types/agentNetwork.ts:447](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L447) - Token usage across all agents --- @@ -58,8 +48,6 @@ Token usage across all agents > **status**: [`NetworkExecutionStatus`](NetworkExecutionStatus.md) -Defined in: [types/agentNetwork.ts:450](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L450) - Execution status --- @@ -68,8 +56,6 @@ Execution status > **duration**: `number` -Defined in: [types/agentNetwork.ts:453](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L453) - Time taken in milliseconds --- @@ -78,6 +64,4 @@ Time taken in milliseconds > `optional` **error?**: `string` -Defined in: [types/agentNetwork.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L456) - Error message if status is error diff --git a/docs/api/type-aliases/NetworkExecutionStatus.md b/docs/api/type-aliases/NetworkExecutionStatus.md index 610edb3ff..276a40f12 100644 --- a/docs/api/type-aliases/NetworkExecutionStatus.md +++ b/docs/api/type-aliases/NetworkExecutionStatus.md @@ -8,6 +8,4 @@ > **NetworkExecutionStatus** = `"pending"` \| `"running"` \| `"completed"` \| `"error"` \| `"suspended"` -Defined in: [types/agentNetwork.ts:573](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L573) - Execution status enum diff --git a/docs/api/type-aliases/NetworkExecutionStep.md b/docs/api/type-aliases/NetworkExecutionStep.md index a7e93082e..57509c91b 100644 --- a/docs/api/type-aliases/NetworkExecutionStep.md +++ b/docs/api/type-aliases/NetworkExecutionStep.md @@ -8,8 +8,6 @@ > **NetworkExecutionStep** = `object` -Defined in: [types/agentNetwork.ts:482](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L482) - Single execution step in the trace ## Properties @@ -18,8 +16,6 @@ Single execution step in the trace > **index**: `number` -Defined in: [types/agentNetwork.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L484) - Step index --- @@ -28,8 +24,6 @@ Step index > **primitive**: `object` -Defined in: [types/agentNetwork.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L487) - Primitive that was executed #### type @@ -50,8 +44,6 @@ Primitive that was executed > **input**: `unknown` -Defined in: [types/agentNetwork.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L494) - Input to the primitive --- @@ -60,8 +52,6 @@ Input to the primitive > `optional` **output?**: `unknown` -Defined in: [types/agentNetwork.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L497) - Output from the primitive --- @@ -70,8 +60,6 @@ Output from the primitive > `optional` **error?**: `string` -Defined in: [types/agentNetwork.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L500) - Error if step failed --- @@ -80,8 +68,6 @@ Error if step failed > **duration**: `number` -Defined in: [types/agentNetwork.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L503) - Duration in milliseconds --- @@ -90,8 +76,6 @@ Duration in milliseconds > `optional` **usage?**: [`TokenUsage`](TokenUsage.md) -Defined in: [types/agentNetwork.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L506) - Token usage for this step --- @@ -100,6 +84,4 @@ Token usage for this step > **timestamp**: `number` -Defined in: [types/agentNetwork.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L509) - Timestamp diff --git a/docs/api/type-aliases/NetworkExecutionTrace.md b/docs/api/type-aliases/NetworkExecutionTrace.md index 440dd5a2b..d4ac74ddc 100644 --- a/docs/api/type-aliases/NetworkExecutionTrace.md +++ b/docs/api/type-aliases/NetworkExecutionTrace.md @@ -8,8 +8,6 @@ > **NetworkExecutionTrace** = `object` -Defined in: [types/agentNetwork.ts:462](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L462) - Execution trace for debugging and monitoring ## Properties @@ -18,8 +16,6 @@ Execution trace for debugging and monitoring > **traceId**: `string` -Defined in: [types/agentNetwork.ts:464](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L464) - Unique trace ID --- @@ -28,8 +24,6 @@ Unique trace ID > **steps**: [`NetworkExecutionStep`](NetworkExecutionStep.md)[] -Defined in: [types/agentNetwork.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L467) - Steps taken during execution --- @@ -38,8 +32,6 @@ Steps taken during execution > **routingDecisions**: [`AgentRoutingDecision`](AgentRoutingDecision.md)[] -Defined in: [types/agentNetwork.ts:470](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L470) - Routing decisions made --- @@ -48,8 +40,6 @@ Routing decisions made > **startTime**: `number` -Defined in: [types/agentNetwork.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L473) - Start timestamp --- @@ -58,6 +48,4 @@ Start timestamp > `optional` **endTime?**: `number` -Defined in: [types/agentNetwork.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L476) - End timestamp diff --git a/docs/api/type-aliases/NetworkInfo.md b/docs/api/type-aliases/NetworkInfo.md index eeaa26466..a8bfbb416 100644 --- a/docs/api/type-aliases/NetworkInfo.md +++ b/docs/api/type-aliases/NetworkInfo.md @@ -8,8 +8,6 @@ > **NetworkInfo** = `object` -Defined in: [types/agentNetwork.ts:1486](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1486) - Network info ## Properties @@ -18,76 +16,56 @@ Network info > **id**: `string` -Defined in: [types/agentNetwork.ts:1487](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1487) - --- ### name > **name**: `string` -Defined in: [types/agentNetwork.ts:1488](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1488) - --- ### state > **state**: [`NetworkState`](NetworkState.md) -Defined in: [types/agentNetwork.ts:1489](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1489) - --- ### agentCount > **agentCount**: `number` -Defined in: [types/agentNetwork.ts:1490](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1490) - --- ### mode > **mode**: [`OrchestrationMode`](OrchestrationMode.md) -Defined in: [types/agentNetwork.ts:1491](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1491) - --- ### createdAt > **createdAt**: `number` -Defined in: [types/agentNetwork.ts:1492](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1492) - --- ### lastExecutionAt? > `optional` **lastExecutionAt?**: `number` -Defined in: [types/agentNetwork.ts:1493](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1493) - --- ### executionCount > **executionCount**: `number` -Defined in: [types/agentNetwork.ts:1494](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1494) - --- ### parentNetworkId? > `optional` **parentNetworkId?**: `string` -Defined in: [types/agentNetwork.ts:1495](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1495) - --- ### childNetworkIds > **childNetworkIds**: `string`[] - -Defined in: [types/agentNetwork.ts:1496](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1496) diff --git a/docs/api/type-aliases/NetworkMemoryConfig.md b/docs/api/type-aliases/NetworkMemoryConfig.md index c3f8f997b..b5619b956 100644 --- a/docs/api/type-aliases/NetworkMemoryConfig.md +++ b/docs/api/type-aliases/NetworkMemoryConfig.md @@ -8,8 +8,6 @@ > **NetworkMemoryConfig** = `object` -Defined in: [types/agentNetwork.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L325) - Memory configuration for the network ## Properties @@ -18,8 +16,6 @@ Memory configuration for the network > `optional` **shared?**: `boolean` -Defined in: [types/agentNetwork.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L327) - Enable shared memory across agents --- @@ -28,8 +24,6 @@ Enable shared memory across agents > `optional` **provider?**: `"in-memory"` \| `"redis"` -Defined in: [types/agentNetwork.ts:330](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L330) - Memory provider --- @@ -38,8 +32,6 @@ Memory provider > `optional` **ttl?**: `number` -Defined in: [types/agentNetwork.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L333) - Memory TTL in seconds --- @@ -48,6 +40,4 @@ Memory TTL in seconds > `optional` **maxMessages?**: `number` -Defined in: [types/agentNetwork.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L336) - Maximum messages to retain diff --git a/docs/api/type-aliases/NetworkPrimitive.md b/docs/api/type-aliases/NetworkPrimitive.md index 5d4f2ed93..92f54fe18 100644 --- a/docs/api/type-aliases/NetworkPrimitive.md +++ b/docs/api/type-aliases/NetworkPrimitive.md @@ -8,8 +8,6 @@ > **NetworkPrimitive** = `object` -Defined in: [types/agentNetwork.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L180) - Base primitive type for all orchestrable components ## Properties @@ -18,8 +16,6 @@ Base primitive type for all orchestrable components > **id**: `string` -Defined in: [types/agentNetwork.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L182) - Unique identifier --- @@ -28,8 +24,6 @@ Unique identifier > **type**: [`NetworkPrimitiveType`](NetworkPrimitiveType.md) -Defined in: [types/agentNetwork.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L185) - Type of primitive --- @@ -38,8 +32,6 @@ Type of primitive > **name**: `string` -Defined in: [types/agentNetwork.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L188) - Human-readable name --- @@ -48,8 +40,6 @@ Human-readable name > **description**: `string` -Defined in: [types/agentNetwork.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L191) - Description for routing decisions --- @@ -58,8 +48,6 @@ Description for routing decisions > `optional` **inputSchema?**: `z.ZodSchema` -Defined in: [types/agentNetwork.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L194) - Input schema for validation --- @@ -68,6 +56,4 @@ Input schema for validation > `optional` **outputSchema?**: `z.ZodSchema` -Defined in: [types/agentNetwork.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L197) - Output schema for validation diff --git a/docs/api/type-aliases/NetworkPrimitiveType.md b/docs/api/type-aliases/NetworkPrimitiveType.md index a29ced2f9..9cd4372a3 100644 --- a/docs/api/type-aliases/NetworkPrimitiveType.md +++ b/docs/api/type-aliases/NetworkPrimitiveType.md @@ -8,6 +8,4 @@ > **NetworkPrimitiveType** = `"agent"` \| `"workflow"` \| `"tool"` -Defined in: [types/agentNetwork.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L175) - Types of primitives that can be orchestrated in the network diff --git a/docs/api/type-aliases/NetworkStartChunk.md b/docs/api/type-aliases/NetworkStartChunk.md index 95340daf8..cf70794d3 100644 --- a/docs/api/type-aliases/NetworkStartChunk.md +++ b/docs/api/type-aliases/NetworkStartChunk.md @@ -8,8 +8,6 @@ > **NetworkStartChunk** = [`NetworkStreamChunkBase`](NetworkStreamChunkBase.md) & `object` -Defined in: [types/agentNetwork.ts:740](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L740) - Network start event ## Type Declaration diff --git a/docs/api/type-aliases/NetworkState.md b/docs/api/type-aliases/NetworkState.md index a4c2c5337..6a5dec3d3 100644 --- a/docs/api/type-aliases/NetworkState.md +++ b/docs/api/type-aliases/NetworkState.md @@ -8,6 +8,4 @@ > **NetworkState** = `"idle"` \| `"initializing"` \| `"ready"` \| `"executing"` \| `"paused"` \| `"error"` \| `"shutdown"` -Defined in: [types/agentNetwork.ts:1474](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1474) - Network state diff --git a/docs/api/type-aliases/NetworkStreamChunk.md b/docs/api/type-aliases/NetworkStreamChunk.md index 26adc6864..252b1f6d5 100644 --- a/docs/api/type-aliases/NetworkStreamChunk.md +++ b/docs/api/type-aliases/NetworkStreamChunk.md @@ -8,6 +8,4 @@ > **NetworkStreamChunk** = [`NetworkStartChunk`](NetworkStartChunk.md) \| [`RoutingDecisionChunk`](RoutingDecisionChunk.md) \| [`PrimitiveStartChunk`](PrimitiveStartChunk.md) \| [`PrimitiveEndChunk`](PrimitiveEndChunk.md) \| [`AgentTextChunk`](AgentTextChunk.md) \| [`AgentToolCallChunk`](AgentToolCallChunk.md) \| [`AgentToolResultChunk`](AgentToolResultChunk.md) \| [`NetworkCompleteChunk`](NetworkCompleteChunk.md) \| [`NetworkErrorChunk`](NetworkErrorChunk.md) -Defined in: [types/agentNetwork.ts:832](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L832) - Union type for all streaming chunks diff --git a/docs/api/type-aliases/NetworkStreamChunkBase.md b/docs/api/type-aliases/NetworkStreamChunkBase.md index 31992b8de..52c3ece13 100644 --- a/docs/api/type-aliases/NetworkStreamChunkBase.md +++ b/docs/api/type-aliases/NetworkStreamChunkBase.md @@ -8,8 +8,6 @@ > **NetworkStreamChunkBase** = `object` -Defined in: [types/agentNetwork.ts:723](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L723) - Base streaming chunk with common fields ## Properties @@ -18,8 +16,6 @@ Base streaming chunk with common fields > **type**: [`NetworkStreamChunkType`](NetworkStreamChunkType.md) -Defined in: [types/agentNetwork.ts:725](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L725) - Chunk type --- @@ -28,8 +24,6 @@ Chunk type > **timestamp**: `number` -Defined in: [types/agentNetwork.ts:728](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L728) - Timestamp --- @@ -38,8 +32,6 @@ Timestamp > **traceId**: `string` -Defined in: [types/agentNetwork.ts:731](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L731) - Trace ID --- @@ -48,6 +40,4 @@ Trace ID > `optional` **stepIndex?**: `number` -Defined in: [types/agentNetwork.ts:734](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L734) - Current step index diff --git a/docs/api/type-aliases/NetworkStreamChunkType.md b/docs/api/type-aliases/NetworkStreamChunkType.md index d041a0df3..a9077e44c 100644 --- a/docs/api/type-aliases/NetworkStreamChunkType.md +++ b/docs/api/type-aliases/NetworkStreamChunkType.md @@ -8,6 +8,4 @@ > **NetworkStreamChunkType** = `"network-start"` \| `"routing-start"` \| `"routing-decision"` \| `"routing-end"` \| `"primitive-start"` \| `"primitive-progress"` \| `"primitive-end"` \| `"agent-thinking"` \| `"agent-text"` \| `"agent-tool-call"` \| `"agent-tool-result"` \| `"workflow-step"` \| `"network-progress"` \| `"network-complete"` \| `"network-error"` -Defined in: [types/agentNetwork.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L703) - Network streaming chunk types diff --git a/docs/api/type-aliases/NetworkTokenUsage.md b/docs/api/type-aliases/NetworkTokenUsage.md index 0c2b626a8..3946fdef6 100644 --- a/docs/api/type-aliases/NetworkTokenUsage.md +++ b/docs/api/type-aliases/NetworkTokenUsage.md @@ -8,8 +8,6 @@ > **NetworkTokenUsage** = `object` -Defined in: [types/agentNetwork.ts:549](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L549) - Token usage aggregated across the network ## Properties @@ -18,8 +16,6 @@ Token usage aggregated across the network > **promptTokens**: `number` -Defined in: [types/agentNetwork.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L551) - Total prompt tokens --- @@ -28,8 +24,6 @@ Total prompt tokens > **completionTokens**: `number` -Defined in: [types/agentNetwork.ts:554](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L554) - Total completion tokens --- @@ -38,8 +32,6 @@ Total completion tokens > **totalTokens**: `number` -Defined in: [types/agentNetwork.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L557) - Total tokens --- @@ -48,6 +40,4 @@ Total tokens > `optional` **byAgent?**: `Record`\<`string`, \{ `promptTokens`: `number`; `completionTokens`: `number`; `totalTokens`: `number`; \}\> -Defined in: [types/agentNetwork.ts:560](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L560) - Breakdown by agent diff --git a/docs/api/type-aliases/NetworkToolInfo.md b/docs/api/type-aliases/NetworkToolInfo.md index 7406e8fb6..34f163a5c 100644 --- a/docs/api/type-aliases/NetworkToolInfo.md +++ b/docs/api/type-aliases/NetworkToolInfo.md @@ -8,8 +8,6 @@ > **NetworkToolInfo** = `object` -Defined in: [types/agentNetwork.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L244) - Tool info for network integration ## Properties @@ -18,20 +16,14 @@ Tool info for network integration > **name**: `string` -Defined in: [types/agentNetwork.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L245) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/agentNetwork.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L246) - --- ### inputSchema? > `optional` **inputSchema?**: `unknown` - -Defined in: [types/agentNetwork.ts:247](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L247) diff --git a/docs/api/type-aliases/NetworkTransportResult.md b/docs/api/type-aliases/NetworkTransportResult.md index 9b41a7d7b..c510ffffd 100644 --- a/docs/api/type-aliases/NetworkTransportResult.md +++ b/docs/api/type-aliases/NetworkTransportResult.md @@ -8,8 +8,6 @@ > **NetworkTransportResult** = `object` -Defined in: [types/aliases.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L434) - Transport result without process (for network transports) Used for SSE and WebSocket transports that don't spawn processes @@ -18,5 +16,3 @@ Used for SSE and WebSocket transports that don't spawn processes ### transport > **transport**: `unknown` - -Defined in: [types/aliases.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L435) diff --git a/docs/api/type-aliases/NetworkWorkflow.md b/docs/api/type-aliases/NetworkWorkflow.md index 0f4c83115..5cab97ad4 100644 --- a/docs/api/type-aliases/NetworkWorkflow.md +++ b/docs/api/type-aliases/NetworkWorkflow.md @@ -8,8 +8,6 @@ > **NetworkWorkflow** = `object` -Defined in: [types/agentNetwork.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L212) - Workflow definition for network integration ## Methods @@ -18,8 +16,6 @@ Workflow definition for network integration > **execute**(`input`): `Promise`\<\{ `output`: `unknown`; \}\> -Defined in: [types/agentNetwork.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L214) - Execute the workflow with given input #### Parameters @@ -38,8 +34,6 @@ Execute the workflow with given input > `optional` **stream**(`input`): `AsyncIterable`\<`unknown`\> -Defined in: [types/agentNetwork.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L217) - Optional streaming support #### Parameters diff --git a/docs/api/type-aliases/NetworkWorkflowDefinition.md b/docs/api/type-aliases/NetworkWorkflowDefinition.md index 4f0fc4766..43f2ed03c 100644 --- a/docs/api/type-aliases/NetworkWorkflowDefinition.md +++ b/docs/api/type-aliases/NetworkWorkflowDefinition.md @@ -8,8 +8,6 @@ > **NetworkWorkflowDefinition** = `object` -Defined in: [types/agentNetwork.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L223) - Workflow definition config ## Properties @@ -18,44 +16,32 @@ Workflow definition config > **id**: `string` -Defined in: [types/agentNetwork.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L224) - --- ### name > **name**: `string` -Defined in: [types/agentNetwork.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L225) - --- ### description > **description**: `string` -Defined in: [types/agentNetwork.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L226) - --- ### inputSchema? > `optional` **inputSchema?**: `z.ZodSchema` -Defined in: [types/agentNetwork.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L227) - --- ### outputSchema? > `optional` **outputSchema?**: `z.ZodSchema` -Defined in: [types/agentNetwork.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L228) - --- ### workflow > **workflow**: [`NetworkWorkflow`](NetworkWorkflow.md) - -Defined in: [types/agentNetwork.ts:229](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L229) diff --git a/docs/api/type-aliases/NeuroLinkAuthConfig.md b/docs/api/type-aliases/NeuroLinkAuthConfig.md index b675907a9..86fe79409 100644 --- a/docs/api/type-aliases/NeuroLinkAuthConfig.md +++ b/docs/api/type-aliases/NeuroLinkAuthConfig.md @@ -8,6 +8,4 @@ > **NeuroLinkAuthConfig** = [`AuthProvider`](AuthProvider.md) \| \{ `provider`: [`AuthProvider`](AuthProvider.md); \} \| \{ `type`: `"auth0"`; `config`: [`Auth0Config`](Auth0Config.md); \} \| \{ `type`: `"clerk"`; `config`: [`ClerkConfig`](ClerkConfig.md); \} \| \{ `type`: `"firebase"`; `config`: [`FirebaseConfig`](FirebaseConfig.md); \} \| \{ `type`: `"supabase"`; `config`: [`SupabaseConfig`](SupabaseConfig.md); \} \| \{ `type`: `"workos"`; `config`: [`WorkOSConfig`](WorkOSConfig.md); \} \| \{ `type`: `"better-auth"`; `config`: [`BetterAuthConfig`](BetterAuthConfig.md); \} \| \{ `type`: `"jwt"`; `config`: [`JWTConfig`](JWTConfig.md); \} \| \{ `type`: `"oauth2"`; `config`: [`OAuth2Config`](OAuth2Config.md); \} \| \{ `type`: `"cognito"`; `config`: [`CognitoConfig`](CognitoConfig.md); \} \| \{ `type`: `"keycloak"`; `config`: [`KeycloakConfig`](KeycloakConfig.md); \} \| \{ `type`: [`AuthProviderType`](AuthProviderType.md); `config`: [`AuthProviderConfig`](AuthProviderConfig.md); \} -Defined in: [types/config.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L287) - Authentication configuration for NeuroLink SDK diff --git a/docs/api/type-aliases/NeuroLinkAuthOptions.md b/docs/api/type-aliases/NeuroLinkAuthOptions.md index cf7cf3e90..0d930f42e 100644 --- a/docs/api/type-aliases/NeuroLinkAuthOptions.md +++ b/docs/api/type-aliases/NeuroLinkAuthOptions.md @@ -8,8 +8,6 @@ > **NeuroLinkAuthOptions** = `object` -Defined in: [types/subscription.ts:1077](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1077) - Unified authentication options for NeuroLink Supports both direct API key authentication and OAuth-based authentication @@ -21,8 +19,6 @@ for Claude Pro/Max subscriptions. > **method**: `"api-key"` \| `"oauth"` -Defined in: [types/subscription.ts:1083](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1083) - Authentication method to use - "api-key": Use ANTHROPIC_API_KEY environment variable @@ -34,8 +30,6 @@ Authentication method to use > `optional` **oauth?**: `object` -Defined in: [types/subscription.ts:1088](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1088) - OAuth configuration (required when method is "oauth") #### clientId? @@ -62,8 +56,6 @@ Custom scopes to request > `optional` **tokenStorage?**: `object` -Defined in: [types/subscription.ts:1100](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1100) - Token storage configuration (optional, defaults to file-based storage) #### encryptionEnabled? diff --git a/docs/api/type-aliases/NeuroLinkConfig.md b/docs/api/type-aliases/NeuroLinkConfig.md index 818f05bb6..69f7c7b29 100644 --- a/docs/api/type-aliases/NeuroLinkConfig.md +++ b/docs/api/type-aliases/NeuroLinkConfig.md @@ -8,8 +8,6 @@ > **NeuroLinkConfig** = `object` -Defined in: [types/config.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L39) - Main NeuroLink configuration type ## Indexable @@ -22,44 +20,32 @@ Main NeuroLink configuration type > `optional` **providers?**: `Record`\<`string`, [`ProviderRuntimeConfig`](ProviderRuntimeConfig.md)\> -Defined in: [types/config.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L40) - --- ### performance? > `optional` **performance?**: [`PerformanceConfig`](PerformanceConfig.md) -Defined in: [types/config.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L41) - --- ### analytics? > `optional` **analytics?**: [`AnalyticsConfig`](AnalyticsConfig.md) -Defined in: [types/config.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L42) - --- ### tools? > `optional` **tools?**: [`ToolConfig`](ToolConfig.md) -Defined in: [types/config.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L43) - --- ### lastUpdated? > `optional` **lastUpdated?**: `number` -Defined in: [types/config.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L44) - --- ### configVersion? > `optional` **configVersion?**: `string` - -Defined in: [types/config.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L45) diff --git a/docs/api/type-aliases/NeuroLinkEvents.md b/docs/api/type-aliases/NeuroLinkEvents.md index 5ad0990c3..ad035d32a 100644 --- a/docs/api/type-aliases/NeuroLinkEvents.md +++ b/docs/api/type-aliases/NeuroLinkEvents.md @@ -8,8 +8,6 @@ > **NeuroLinkEvents** = `object` -Defined in: [types/common.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L172) - Enhanced NeuroLink event types Flexible type to support both typed and legacy event patterns @@ -23,276 +21,206 @@ Flexible type to support both typed and legacy event patterns > **tool:start**: `unknown` -Defined in: [types/common.ts:174](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L174) - --- ### tool:end > **tool:end**: `unknown` -Defined in: [types/common.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L175) - --- ### stream:start > **stream:start**: `unknown` -Defined in: [types/common.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L178) - --- ### stream:end > **stream:end**: `unknown` -Defined in: [types/common.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L179) - --- ### stream:chunk > **stream:chunk**: `unknown` -Defined in: [types/common.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L180) - --- ### stream:complete > **stream:complete**: `unknown` -Defined in: [types/common.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L181) - --- ### stream:error > **stream:error**: `unknown` -Defined in: [types/common.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L182) - --- ### generation:start > **generation:start**: `unknown` -Defined in: [types/common.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L185) - --- ### generation:end > **generation:end**: `unknown` -Defined in: [types/common.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L186) - --- ### response:start > **response:start**: `unknown` -Defined in: [types/common.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L189) - --- ### response:end > **response:end**: `unknown` -Defined in: [types/common.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L190) - --- ### externalMCP:serverConnected > **externalMCP:serverConnected**: `unknown` -Defined in: [types/common.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L193) - --- ### externalMCP:serverDisconnected > **externalMCP:serverDisconnected**: `unknown` -Defined in: [types/common.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L194) - --- ### externalMCP:serverFailed > **externalMCP:serverFailed**: `unknown` -Defined in: [types/common.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L195) - --- ### externalMCP:toolDiscovered > **externalMCP:toolDiscovered**: `unknown` -Defined in: [types/common.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L196) - --- ### externalMCP:toolRemoved > **externalMCP:toolRemoved**: `unknown` -Defined in: [types/common.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L197) - --- ### externalMCP:serverAdded > **externalMCP:serverAdded**: `unknown` -Defined in: [types/common.ts:198](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L198) - --- ### externalMCP:serverRemoved > **externalMCP:serverRemoved**: `unknown` -Defined in: [types/common.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L199) - --- ### tools-register:start > **tools-register:start**: `unknown` -Defined in: [types/common.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L202) - --- ### tools-register:end > **tools-register:end**: `unknown` -Defined in: [types/common.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L203) - --- ### connected > **connected**: `unknown` -Defined in: [types/common.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L206) - --- ### message > **message**: `unknown` -Defined in: [types/common.ts:207](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L207) - --- ### error > **error**: `unknown` -Defined in: [types/common.ts:208](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L208) - --- ### log > **log**: `unknown` -Defined in: [types/common.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L209) - --- ### log-event > **log-event**: `unknown` -Defined in: [types/common.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L212) - --- ### autoresearch:initialized > **autoresearch:initialized**: [`AutoresearchInitializedEvent`](AutoresearchInitializedEvent.md) -Defined in: [types/common.ts:215](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L215) - --- ### autoresearch:resumed > **autoresearch:resumed**: [`AutoresearchResumedEvent`](AutoresearchResumedEvent.md) -Defined in: [types/common.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L216) - --- ### autoresearch:phase-changed > **autoresearch:phase-changed**: [`AutoresearchPhaseChangedEvent`](AutoresearchPhaseChangedEvent.md) -Defined in: [types/common.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L217) - --- ### autoresearch:experiment-started > **autoresearch:experiment-started**: [`AutoresearchExperimentStartedEvent`](AutoresearchExperimentStartedEvent.md) -Defined in: [types/common.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L218) - --- ### autoresearch:experiment-completed > **autoresearch:experiment-completed**: [`AutoresearchExperimentCompletedEvent`](AutoresearchExperimentCompletedEvent.md) -Defined in: [types/common.ts:219](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L219) - --- ### autoresearch:metric-improved > **autoresearch:metric-improved**: [`AutoresearchMetricImprovedEvent`](AutoresearchMetricImprovedEvent.md) -Defined in: [types/common.ts:220](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L220) - --- ### autoresearch:revert > **autoresearch:revert**: [`AutoresearchRevertEvent`](AutoresearchRevertEvent.md) -Defined in: [types/common.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L221) - --- ### autoresearch:revert-failed > **autoresearch:revert-failed**: [`AutoresearchRevertFailedEvent`](AutoresearchRevertFailedEvent.md) -Defined in: [types/common.ts:222](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L222) - --- ### autoresearch:state-updated > **autoresearch:state-updated**: [`AutoresearchStateUpdatedEvent`](AutoresearchStateUpdatedEvent.md) -Defined in: [types/common.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L223) - --- ### autoresearch:error > **autoresearch:error**: [`AutoresearchErrorEvent`](AutoresearchErrorEvent.md) - -Defined in: [types/common.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L224) diff --git a/docs/api/type-aliases/NeuroLinkExecutable.md b/docs/api/type-aliases/NeuroLinkExecutable.md index 19aea2ba9..ac89f3841 100644 --- a/docs/api/type-aliases/NeuroLinkExecutable.md +++ b/docs/api/type-aliases/NeuroLinkExecutable.md @@ -8,8 +8,6 @@ > **NeuroLinkExecutable** = `object` -Defined in: [types/task.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L295) - Minimal interface for the NeuroLink SDK methods needed by TaskExecutor ## Methods @@ -18,8 +16,6 @@ Minimal interface for the NeuroLink SDK methods needed by TaskExecutor > **generate**(`optionsOrPrompt`): `Promise`\<\{ `content`: `string`; `toolExecutions?`: `object`[]; `usage?`: \{ `input?`: `number`; `output?`: `number`; \}; \}\> -Defined in: [types/task.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L296) - #### Parameters ##### optionsOrPrompt diff --git a/docs/api/type-aliases/NeuroLinkExecutionContext.md b/docs/api/type-aliases/NeuroLinkExecutionContext.md index 3ad8c56b5..755aa44ed 100644 --- a/docs/api/type-aliases/NeuroLinkExecutionContext.md +++ b/docs/api/type-aliases/NeuroLinkExecutionContext.md @@ -8,8 +8,6 @@ > **NeuroLinkExecutionContext** = `object` -Defined in: [types/mcp.ts:360](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L360) - Tool execution context - Rich context passed to every tool execution Extracted from factory.ts for centralized type management Following standard patterns for rich tool context @@ -24,236 +22,176 @@ Following standard patterns for rich tool context > `optional` **sessionId?**: `string` -Defined in: [types/mcp.ts:362](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L362) - --- ### userId? > `optional` **userId?**: `string` -Defined in: [types/mcp.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L363) - --- ### aiProvider? > `optional` **aiProvider?**: `string` -Defined in: [types/mcp.ts:366](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L366) - --- ### modelId? > `optional` **modelId?**: `string` -Defined in: [types/mcp.ts:367](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L367) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/mcp.ts:368](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L368) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/mcp.ts:369](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L369) - --- ### appId? > `optional` **appId?**: `string` -Defined in: [types/mcp.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L372) - --- ### clientId? > `optional` **clientId?**: `string` -Defined in: [types/mcp.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L373) - --- ### clientVersion? > `optional` **clientVersion?**: `string` -Defined in: [types/mcp.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L374) - --- ### organizationId? > `optional` **organizationId?**: `string` -Defined in: [types/mcp.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L375) - --- ### projectId? > `optional` **projectId?**: `string` -Defined in: [types/mcp.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L376) - --- ### environment? > `optional` **environment?**: `string` -Defined in: [types/mcp.ts:379](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L379) - --- ### environmentType? > `optional` **environmentType?**: `"development"` \| `"staging"` \| `"production"` -Defined in: [types/mcp.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L380) - --- ### platform? > `optional` **platform?**: `string` -Defined in: [types/mcp.ts:381](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L381) - --- ### device? > `optional` **device?**: `string` -Defined in: [types/mcp.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L382) - --- ### browser? > `optional` **browser?**: `string` -Defined in: [types/mcp.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L383) - --- ### userAgent? > `optional` **userAgent?**: `string` -Defined in: [types/mcp.ts:384](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L384) - --- ### frameworkType? > `optional` **frameworkType?**: `"react"` \| `"vue"` \| `"svelte"` \| `"next"` \| `"nuxt"` \| `"sveltekit"` -Defined in: [types/mcp.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L387) - --- ### toolChain? > `optional` **toolChain?**: `string`[] -Defined in: [types/mcp.ts:390](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L390) - --- ### parentToolId? > `optional` **parentToolId?**: `string` -Defined in: [types/mcp.ts:391](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L391) - --- ### locale? > `optional` **locale?**: `string` -Defined in: [types/mcp.ts:394](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L394) - --- ### timezone? > `optional` **timezone?**: `string` -Defined in: [types/mcp.ts:395](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L395) - --- ### ipAddress? > `optional` **ipAddress?**: `string` -Defined in: [types/mcp.ts:396](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L396) - --- ### requestId? > `optional` **requestId?**: `string` -Defined in: [types/mcp.ts:399](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L399) - --- ### timestamp? > `optional` **timestamp?**: `number` -Defined in: [types/mcp.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L400) - --- ### permissions? > `optional` **permissions?**: `string`[] -Defined in: [types/mcp.ts:403](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L403) - --- ### features? > `optional` **features?**: `string`[] -Defined in: [types/mcp.ts:404](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L404) - --- ### enableDemoMode? > `optional` **enableDemoMode?**: `boolean` -Defined in: [types/mcp.ts:405](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L405) - --- ### securityLevel? > `optional` **securityLevel?**: `"public"` \| `"private"` \| `"organization"` -Defined in: [types/mcp.ts:406](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L406) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/mcp.ts:409](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L409) diff --git a/docs/api/type-aliases/NeuroLinkInstance.md b/docs/api/type-aliases/NeuroLinkInstance.md index b726754f0..6dac939f1 100644 --- a/docs/api/type-aliases/NeuroLinkInstance.md +++ b/docs/api/type-aliases/NeuroLinkInstance.md @@ -8,8 +8,6 @@ > **NeuroLinkInstance** = `object` -Defined in: [types/providers.ts:2368](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2368) - Minimal NeuroLink-like instance accepted by the image generation service. ## Properties @@ -18,8 +16,6 @@ Minimal NeuroLink-like instance accepted by the image generation service. > **generate**: (`options`) => `Promise`\<`unknown`\> -Defined in: [types/providers.ts:2369](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2369) - #### Parameters ##### options diff --git a/docs/api/type-aliases/NeuroLinkMCPServer.md b/docs/api/type-aliases/NeuroLinkMCPServer.md index 36f058341..0d304c489 100644 --- a/docs/api/type-aliases/NeuroLinkMCPServer.md +++ b/docs/api/type-aliases/NeuroLinkMCPServer.md @@ -8,8 +8,6 @@ > **NeuroLinkMCPServer** = `object` -Defined in: [types/mcp.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L506) - NeuroLink MCP Server Type - Standard compatible Moved from src/lib/mcp/factory.ts @@ -19,88 +17,66 @@ Moved from src/lib/mcp/factory.ts > **id**: `string` -Defined in: [types/mcp.ts:508](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L508) - --- ### title > **title**: `string` -Defined in: [types/mcp.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L509) - --- ### description? > `optional` **description?**: `string` -Defined in: [types/mcp.ts:510](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L510) - --- ### version? > `optional` **version?**: `string` -Defined in: [types/mcp.ts:511](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L511) - --- ### category? > `optional` **category?**: [`MCPServerDomainCategory`](MCPServerDomainCategory.md) -Defined in: [types/mcp.ts:512](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L512) - --- ### visibility? > `optional` **visibility?**: `"public"` \| `"private"` \| `"organization"` -Defined in: [types/mcp.ts:513](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L513) - --- ### tools > **tools**: `Record`\<`string`, [`NeuroLinkMCPTool`](NeuroLinkMCPTool.md)\> -Defined in: [types/mcp.ts:516](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L516) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/mcp.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L522) - --- ### dependencies? > `optional` **dependencies?**: `string`[] -Defined in: [types/mcp.ts:523](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L523) - --- ### capabilities? > `optional` **capabilities?**: `string`[] -Defined in: [types/mcp.ts:524](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L524) - ## Methods ### registerTool() > **registerTool**(`tool`): `NeuroLinkMCPServer` -Defined in: [types/mcp.ts:519](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L519) - #### Parameters ##### tool diff --git a/docs/api/type-aliases/NeuroLinkMCPTool.md b/docs/api/type-aliases/NeuroLinkMCPTool.md index 7a7ee2a11..4c9271431 100644 --- a/docs/api/type-aliases/NeuroLinkMCPTool.md +++ b/docs/api/type-aliases/NeuroLinkMCPTool.md @@ -8,8 +8,6 @@ > **NeuroLinkMCPTool** = `object` -Defined in: [types/mcp.ts:465](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L465) - NeuroLink MCP Tool Type - Standardized tool definition for MCP integration Moved from src/lib/mcp/factory.ts @@ -19,8 +17,6 @@ Moved from src/lib/mcp/factory.ts > **name**: `string` -Defined in: [types/mcp.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L467) - Unique tool identifier for MCP registration and execution --- @@ -29,8 +25,6 @@ Unique tool identifier for MCP registration and execution > **description**: `string` -Defined in: [types/mcp.ts:470](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L470) - Human-readable description of tool functionality --- @@ -39,8 +33,6 @@ Human-readable description of tool functionality > `optional` **category?**: `string` -Defined in: [types/mcp.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L473) - Optional category for tool organization and discovery --- @@ -49,8 +41,6 @@ Optional category for tool organization and discovery > `optional` **inputSchema?**: `unknown` -Defined in: [types/mcp.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L476) - Optional input schema for parameter validation (Zod or JSON Schema) --- @@ -59,8 +49,6 @@ Optional input schema for parameter validation (Zod or JSON Schema) > `optional` **outputSchema?**: `unknown` -Defined in: [types/mcp.ts:479](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L479) - Optional output schema for result validation --- @@ -69,8 +57,6 @@ Optional output schema for result validation > `optional` **isImplemented?**: `boolean` -Defined in: [types/mcp.ts:482](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L482) - Implementation status flag for development tracking --- @@ -79,8 +65,6 @@ Implementation status flag for development tracking > `optional` **permissions?**: `string`[] -Defined in: [types/mcp.ts:485](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L485) - Required permissions for tool execution in secured environments --- @@ -89,8 +73,6 @@ Required permissions for tool execution in secured environments > `optional` **version?**: `string` -Defined in: [types/mcp.ts:488](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L488) - Tool version for compatibility and update management --- @@ -99,8 +81,6 @@ Tool version for compatibility and update management > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/mcp.ts:491](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L491) - Additional metadata for tool information and capabilities --- @@ -109,8 +89,6 @@ Additional metadata for tool information and capabilities > **execute**: (`params`, `context`) => `Promise`\<[`ToolResult`](ToolResult.md)\> -Defined in: [types/mcp.ts:496](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L496) - Tool execution function with standardized signature #### Parameters diff --git a/docs/api/type-aliases/NeuroLinkMiddleware.md b/docs/api/type-aliases/NeuroLinkMiddleware.md index 6521dd6ba..1e633a268 100644 --- a/docs/api/type-aliases/NeuroLinkMiddleware.md +++ b/docs/api/type-aliases/NeuroLinkMiddleware.md @@ -8,8 +8,6 @@ > **NeuroLinkMiddleware** = [`LanguageModelMiddleware`](LanguageModelMiddleware.md) & `object` -Defined in: [types/middleware.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L57) - NeuroLink middleware with metadata Combines standard AI SDK middleware with NeuroLink-specific metadata diff --git a/docs/api/type-aliases/NeuroLinkMiddlewareMetadata.md b/docs/api/type-aliases/NeuroLinkMiddlewareMetadata.md index d655e0bc0..18b4dcfd9 100644 --- a/docs/api/type-aliases/NeuroLinkMiddlewareMetadata.md +++ b/docs/api/type-aliases/NeuroLinkMiddlewareMetadata.md @@ -8,8 +8,6 @@ > **NeuroLinkMiddlewareMetadata** = `object` -Defined in: [types/middleware.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L38) - Metadata type for NeuroLink middleware Provides additional information about middleware without affecting execution @@ -19,8 +17,6 @@ Provides additional information about middleware without affecting execution > **id**: `string` -Defined in: [types/middleware.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L40) - Unique identifier for the middleware --- @@ -29,8 +25,6 @@ Unique identifier for the middleware > **name**: `string` -Defined in: [types/middleware.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L42) - Human-readable name --- @@ -39,8 +33,6 @@ Human-readable name > `optional` **description?**: `string` -Defined in: [types/middleware.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L44) - Description of what the middleware does --- @@ -49,8 +41,6 @@ Description of what the middleware does > `optional` **priority?**: `number` -Defined in: [types/middleware.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L46) - Priority for ordering (higher = earlier in chain) --- @@ -59,8 +49,6 @@ Priority for ordering (higher = earlier in chain) > `optional` **defaultEnabled?**: `boolean` -Defined in: [types/middleware.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L48) - Whether this middleware is enabled by default --- @@ -69,6 +57,4 @@ Whether this middleware is enabled by default > `optional` **configSchema?**: `Record`\<`string`, `unknown`\> -Defined in: [types/middleware.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L50) - Configuration schema for the middleware diff --git a/docs/api/type-aliases/NeuroLinkProviderOptions.md b/docs/api/type-aliases/NeuroLinkProviderOptions.md index 2e68fa482..b1b03eec1 100644 --- a/docs/api/type-aliases/NeuroLinkProviderOptions.md +++ b/docs/api/type-aliases/NeuroLinkProviderOptions.md @@ -8,8 +8,6 @@ > **NeuroLinkProviderOptions** = `object` -Defined in: [types/client.ts:918](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L918) - NeuroLink provider options for AI SDK adapter ## Properties @@ -18,8 +16,6 @@ NeuroLink provider options for AI SDK adapter > **baseUrl**: `string` -Defined in: [types/client.ts:920](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L920) - Base URL for the NeuroLink API --- @@ -28,8 +24,6 @@ Base URL for the NeuroLink API > `optional` **apiKey?**: `string` -Defined in: [types/client.ts:922](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L922) - API key for authentication --- @@ -38,8 +32,6 @@ API key for authentication > `optional` **token?**: `string` -Defined in: [types/client.ts:924](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L924) - Bearer token for authentication --- @@ -48,8 +40,6 @@ Bearer token for authentication > `optional` **defaultModel?**: `string` -Defined in: [types/client.ts:926](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L926) - Default model to use --- @@ -58,8 +48,6 @@ Default model to use > `optional` **defaultProvider?**: `string` -Defined in: [types/client.ts:928](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L928) - Default provider --- @@ -68,6 +56,4 @@ Default provider > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/client.ts:930](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L930) - Custom headers diff --git a/docs/api/type-aliases/NeuroLinkProviderProps.md b/docs/api/type-aliases/NeuroLinkProviderProps.md index 95f1f0de5..a8ef25e35 100644 --- a/docs/api/type-aliases/NeuroLinkProviderProps.md +++ b/docs/api/type-aliases/NeuroLinkProviderProps.md @@ -8,8 +8,6 @@ > **NeuroLinkProviderProps** = `object` -Defined in: [types/client.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L522) - Props for the NeuroLinkProvider React component. `children` is typed as `unknown` so this module stays React-agnostic; @@ -21,8 +19,6 @@ the provider component in reactHooks.tsx narrows it to `ReactNode`. > **config**: [`ClientConfig`](ClientConfig.md) -Defined in: [types/client.ts:524](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L524) - Client configuration --- @@ -31,6 +27,4 @@ Client configuration > **children**: `unknown` -Defined in: [types/client.ts:526](https://github.com/juspay/neurolink/blob/release/src/lib/types/client.ts#L526) - Child components (ReactNode at runtime) diff --git a/docs/api/type-aliases/NeuroLinkTool.md b/docs/api/type-aliases/NeuroLinkTool.md index 079e6044a..719fd053c 100644 --- a/docs/api/type-aliases/NeuroLinkTool.md +++ b/docs/api/type-aliases/NeuroLinkTool.md @@ -8,8 +8,6 @@ > **NeuroLinkTool** = `object` -Defined in: [types/mcp.ts:2148](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2148) - NeuroLink internal tool format ## Properties @@ -18,8 +16,6 @@ NeuroLink internal tool format > **name**: `string` -Defined in: [types/mcp.ts:2152](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2152) - Tool name --- @@ -28,8 +24,6 @@ Tool name > **description**: `string` -Defined in: [types/mcp.ts:2157](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2157) - Tool description --- @@ -38,8 +32,6 @@ Tool description > `optional` **parameters?**: [`JsonObject`](JsonObject.md) -Defined in: [types/mcp.ts:2162](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2162) - Input parameters schema --- @@ -48,8 +40,6 @@ Input parameters schema > **execute**: (`params`, `context?`) => `Promise`\<[`ToolResult`](ToolResult.md) \| `unknown`\> -Defined in: [types/mcp.ts:2167](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2167) - Tool execution function #### Parameters @@ -72,8 +62,6 @@ Tool execution function > `optional` **category?**: `string` -Defined in: [types/mcp.ts:2175](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2175) - Category for organization --- @@ -82,8 +70,6 @@ Category for organization > `optional` **tags?**: `string`[] -Defined in: [types/mcp.ts:2180](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2180) - Tags for filtering --- @@ -92,8 +78,6 @@ Tags for filtering > `optional` **isAsync?**: `boolean` -Defined in: [types/mcp.ts:2185](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2185) - Whether the tool is async --- @@ -102,6 +86,4 @@ Whether the tool is async > `optional` **metadata?**: `Record`\<`string`, [`JsonValue`](JsonValue.md)\> -Defined in: [types/mcp.ts:2190](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2190) - Custom metadata diff --git a/docs/api/type-aliases/NeurolinkConstructorConfig.md b/docs/api/type-aliases/NeurolinkConstructorConfig.md index a629948d9..a8411d528 100644 --- a/docs/api/type-aliases/NeurolinkConstructorConfig.md +++ b/docs/api/type-aliases/NeurolinkConstructorConfig.md @@ -8,8 +8,6 @@ > **NeurolinkConstructorConfig** = `object` -Defined in: [types/config.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L70) - Configuration object for NeuroLink constructor. ## Properties @@ -18,32 +16,24 @@ Configuration object for NeuroLink constructor. > `optional` **conversationMemory?**: `Partial`\<[`ConversationMemoryConfig`](ConversationMemoryConfig.md)\> -Defined in: [types/config.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L71) - --- ### enableOrchestration? > `optional` **enableOrchestration?**: `boolean` -Defined in: [types/config.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L72) - --- ### hitl? > `optional` **hitl?**: [`HITLConfig`](HITLConfig.md) -Defined in: [types/config.ts:73](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L73) - --- ### tools? > `optional` **tools?**: [`ToolConfig`](ToolConfig.md) -Defined in: [types/config.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L79) - Instance-level tool policy: master switch, include/exclude lists (with `*` glob support), and on-demand MCP tool discovery. See [ToolConfig](ToolConfig.md). @@ -54,32 +44,24 @@ See [ToolConfig](ToolConfig.md). > `optional` **toolRegistry?**: [`MCPToolRegistry`](../classes/MCPToolRegistry.md) -Defined in: [types/config.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L80) - --- ### observability? > `optional` **observability?**: [`ObservabilityConfig`](ObservabilityConfig.md) -Defined in: [types/config.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L81) - --- ### modelAliasConfig? > `optional` **modelAliasConfig?**: [`ModelAliasConfig`](ModelAliasConfig.md) -Defined in: [types/config.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L82) - --- ### mcp? > `optional` **mcp?**: [`MCPEnhancementsConfig`](MCPEnhancementsConfig.md) -Defined in: [types/config.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L84) - MCP enhancement modules configuration (cache, router, batcher, annotations, middleware) --- @@ -88,8 +70,6 @@ MCP enhancement modules configuration (cache, router, batcher, annotations, midd > `optional` **artifacts?**: [`ArtifactStorageConfig`](ArtifactStorageConfig.md) -Defined in: [types/config.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L90) - Artifact storage: where externalized MCP tool outputs and banked payloads live. The backend follows `STORAGE_TYPE` exactly like conversation memory unless chosen here. See [ArtifactStorageConfig](ArtifactStorageConfig.md). @@ -100,8 +80,6 @@ unless chosen here. See [ArtifactStorageConfig](ArtifactStorageConfig.md). > `optional` **auth?**: [`NeuroLinkAuthConfig`](NeuroLinkAuthConfig.md) -Defined in: [types/config.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L92) - Authentication provider configuration --- @@ -110,8 +88,6 @@ Authentication provider configuration > `optional` **tasks?**: [`TaskManagerConfig`](TaskManagerConfig.md) -Defined in: [types/config.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L94) - TaskManager configuration (scheduled and self-running tasks) --- @@ -120,8 +96,6 @@ TaskManager configuration (scheduled and self-running tasks) > `optional` **credentials?**: [`NeurolinkCredentials`](NeurolinkCredentials.md) -Defined in: [types/config.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L100) - Per-provider credential overrides. When set here, applies as the default for all generate()/stream() calls from this NeuroLink instance. Per-call credentials override these. @@ -132,8 +106,6 @@ from this NeuroLink instance. Per-call credentials override these. > `optional` **providerFallback?**: [`ProviderFallbackCallback`](ProviderFallbackCallback.md) -Defined in: [types/config.ts:111](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L111) - Curator P2-3: callback invoked when a generate/stream call fails with any error except a genuine caller cancel — i.e. the caller-supplied `abortSignal` fired (network errors, 5xx, timeouts, auth failures, @@ -149,8 +121,6 @@ error unmodified and returns the next `{ provider, model }` to try, or > `optional` **modelChain?**: `string`[] -Defined in: [types/config.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L120) - Curator P2-3: ordered list of model names to try in sequence. Sugar over `providerFallback`, but with a narrower trigger: without an explicit callback the chain only advances on model-access-denied @@ -164,8 +134,6 @@ name changes. > `optional` **toolRouting?**: [`ToolRoutingConfig`](ToolRoutingConfig.md) -Defined in: [types/config.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L127) - Pre-call tool routing: a cheap router LLM picks the tool servers relevant to each stream() turn and the unpicked servers' tools are dropped from the request via `excludeTools`. Fails open (all tools) on @@ -177,8 +145,6 @@ any router failure. See [ToolRoutingConfig](ToolRoutingConfig.md). > `optional` **toolDedup?**: [`ToolDedupConfig`](ToolDedupConfig.md) -Defined in: [types/config.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L140) - Opt-in tool-signature deduplication. When enabled, tools whose canonical signatures are sufficiently similar (Jaccard ≥ threshold) are collapsed to a single representative before being sent to the model, @@ -196,8 +162,6 @@ See [ToolDedupConfig](ToolDedupConfig.md). > `optional` **modelPool?**: [`ModelPoolConfig`](ModelPoolConfig.md) -Defined in: [types/config.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L148) - Multi-provider pool for error-class-aware failover with per-member cooldown. When set, generate() and stream() source their candidate provider sequence from the pool instead of (or in addition to) the @@ -210,8 +174,6 @@ existing behavior unchanged. > `optional` **requestRouter?**: [`RequestRouter`](RequestRouter.md) -Defined in: [types/config.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L156) - Pluggable pre-call router: inspects lightweight request characteristics (token estimate, tools, vision, thinkingLevel) and returns an optional provider/model/region override. Only runs when the caller did NOT @@ -224,8 +186,6 @@ error proceeds unrouted. > `optional` **classifierRouter?**: [`ClassifierRouterConfig`](ClassifierRouterConfig.md) -Defined in: [types/config.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L165) - Pre-call classifier router: classifies each request by difficulty and selects a provider/model from a configured "available base" pool — routing harder tasks to more capable models and easier tasks to cheaper/faster @@ -239,8 +199,6 @@ caller pinned both `provider` and `model`. See [ClassifierRouterConfig](Classifi > `optional` **contextRelevance?**: [`ContextRelevanceOptions`](ContextRelevanceOptions.md) -Defined in: [types/config.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L176) - Relevance-driven context compaction. When a decision provider is configured, compaction gains a stage-zero pass that drops the earlier messages the current request provably does not need, before the @@ -256,8 +214,6 @@ which is the same activation rule every other decision consumer uses. > `optional` **skills?**: [`SkillsConfig`](SkillsConfig.md) -Defined in: [types/config.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L185) - Native skills: versioned, discoverable instruction packs (SOPs, playbooks) with progressive disclosure. When enabled, each generate()/stream() call gets a skills discovery listing plus @@ -271,8 +227,6 @@ Opt-in and fails open on read paths. See [SkillsConfig](SkillsConfig.md). > `optional` **knowledgeGrounding?**: [`KnowledgeGroundingConfig`](KnowledgeGroundingConfig.md) -Defined in: [types/config.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L196) - Knowledge grounding: lexical-first host-supplied knowledge retrieval. When enabled with at least one source, a deterministic in-memory retrieval runs before each generate()/stream() turn — independently of tool routing — and diff --git a/docs/api/type-aliases/NeurolinkCredentials.md b/docs/api/type-aliases/NeurolinkCredentials.md index 35fae4fed..89ece4529 100644 --- a/docs/api/type-aliases/NeurolinkCredentials.md +++ b/docs/api/type-aliases/NeurolinkCredentials.md @@ -8,8 +8,6 @@ > **NeurolinkCredentials** = `object` -Defined in: [types/providers.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L184) - Per-provider credential overrides for generate() / stream() calls. When set on `NeurolinkConstructorConfig.credentials`, applies as the default @@ -25,8 +23,6 @@ Unset providers fall through to environment variables (existing behaviour). > `optional` **openai?**: `object` -Defined in: [types/providers.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L185) - #### apiKey? > `optional` **apiKey?**: `string` @@ -41,8 +37,6 @@ Defined in: [types/providers.ts:185](https://github.com/juspay/neurolink/blob/re > `optional` **anthropic?**: `object` -Defined in: [types/providers.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L186) - #### apiKey? > `optional` **apiKey?**: `string` @@ -57,8 +51,6 @@ Defined in: [types/providers.ts:186](https://github.com/juspay/neurolink/blob/re > `optional` **googleAiStudio?**: `object` -Defined in: [types/providers.ts:187](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L187) - #### apiKey? > `optional` **apiKey?**: `string` @@ -73,8 +65,6 @@ Defined in: [types/providers.ts:187](https://github.com/juspay/neurolink/blob/re > `optional` **vertex?**: `object` -Defined in: [types/providers.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L188) - #### projectId? > `optional` **projectId?**: `string` @@ -111,8 +101,6 @@ Inline service-account fields (alternative to serviceAccountKey) > `optional` **bedrock?**: `object` -Defined in: [types/providers.ts:199](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L199) - #### accessKeyId? > `optional` **accessKeyId?**: `string` @@ -135,8 +123,6 @@ Defined in: [types/providers.ts:199](https://github.com/juspay/neurolink/blob/re > `optional` **sagemaker?**: `object` -Defined in: [types/providers.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L205) - #### accessKeyId? > `optional` **accessKeyId?**: `string` @@ -163,8 +149,6 @@ Defined in: [types/providers.ts:205](https://github.com/juspay/neurolink/blob/re > `optional` **azure?**: `object` -Defined in: [types/providers.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L212) - #### apiKey? > `optional` **apiKey?**: `string` @@ -191,8 +175,6 @@ Defined in: [types/providers.ts:212](https://github.com/juspay/neurolink/blob/re > `optional` **openrouter?**: `object` -Defined in: [types/providers.ts:223](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L223) - #### apiKey? > `optional` **apiKey?**: `string` @@ -207,8 +189,6 @@ Defined in: [types/providers.ts:223](https://github.com/juspay/neurolink/blob/re > `optional` **litellm?**: `object` -Defined in: [types/providers.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L224) - #### apiKey? > `optional` **apiKey?**: `string` @@ -223,8 +203,6 @@ Defined in: [types/providers.ts:224](https://github.com/juspay/neurolink/blob/re > `optional` **openaiCompatible?**: `object` -Defined in: [types/providers.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L225) - #### apiKey? > `optional` **apiKey?**: `string` @@ -239,8 +217,6 @@ Defined in: [types/providers.ts:225](https://github.com/juspay/neurolink/blob/re > `optional` **ollama?**: `object` -Defined in: [types/providers.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L226) - #### baseURL? > `optional` **baseURL?**: `string` @@ -255,8 +231,6 @@ Defined in: [types/providers.ts:226](https://github.com/juspay/neurolink/blob/re > `optional` **nvidiaNim?**: `object` -Defined in: [types/providers.ts:227](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L227) - #### apiKey? > `optional` **apiKey?**: `string` @@ -271,8 +245,6 @@ Defined in: [types/providers.ts:227](https://github.com/juspay/neurolink/blob/re > `optional` **lmStudio?**: `object` -Defined in: [types/providers.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L230) - #### apiKey? > `optional` **apiKey?**: `string` @@ -287,8 +259,6 @@ Defined in: [types/providers.ts:230](https://github.com/juspay/neurolink/blob/re > `optional` **llamacpp?**: `object` -Defined in: [types/providers.ts:231](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L231) - #### apiKey? > `optional` **apiKey?**: `string` @@ -303,8 +273,6 @@ Defined in: [types/providers.ts:231](https://github.com/juspay/neurolink/blob/re > `optional` **apiRoute?**: `object` -Defined in: [types/providers.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L233) - #### apiKey? > `optional` **apiKey?**: `string` @@ -319,8 +287,6 @@ Defined in: [types/providers.ts:233](https://github.com/juspay/neurolink/blob/re > `optional` **baseten?**: `object` -Defined in: [types/providers.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L234) - #### apiKey? > `optional` **apiKey?**: `string` @@ -335,8 +301,6 @@ Defined in: [types/providers.ts:234](https://github.com/juspay/neurolink/blob/re > `optional` **cerebras?**: `object` -Defined in: [types/providers.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L235) - #### apiKey? > `optional` **apiKey?**: `string` @@ -351,8 +315,6 @@ Defined in: [types/providers.ts:235](https://github.com/juspay/neurolink/blob/re > `optional` **cloudflare?**: `object` -Defined in: [types/providers.ts:236](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L236) - #### apiKey? > `optional` **apiKey?**: `string` @@ -371,8 +333,6 @@ Defined in: [types/providers.ts:236](https://github.com/juspay/neurolink/blob/re > `optional` **deepseek?**: `object` -Defined in: [types/providers.ts:237](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L237) - #### apiKey? > `optional` **apiKey?**: `string` @@ -387,8 +347,6 @@ Defined in: [types/providers.ts:237](https://github.com/juspay/neurolink/blob/re > `optional` **fireworks?**: `object` -Defined in: [types/providers.ts:238](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L238) - #### apiKey? > `optional` **apiKey?**: `string` @@ -403,8 +361,6 @@ Defined in: [types/providers.ts:238](https://github.com/juspay/neurolink/blob/re > `optional` **friendli?**: `object` -Defined in: [types/providers.ts:239](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L239) - #### apiKey? > `optional` **apiKey?**: `string` @@ -419,8 +375,6 @@ Defined in: [types/providers.ts:239](https://github.com/juspay/neurolink/blob/re > `optional` **gmicloud?**: `object` -Defined in: [types/providers.ts:240](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L240) - #### apiKey? > `optional` **apiKey?**: `string` @@ -435,8 +389,6 @@ Defined in: [types/providers.ts:240](https://github.com/juspay/neurolink/blob/re > `optional` **groq?**: `object` -Defined in: [types/providers.ts:241](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L241) - #### apiKey? > `optional` **apiKey?**: `string` @@ -451,8 +403,6 @@ Defined in: [types/providers.ts:241](https://github.com/juspay/neurolink/blob/re > `optional` **huggingFace?**: `object` -Defined in: [types/providers.ts:242](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L242) - #### apiKey? > `optional` **apiKey?**: `string` @@ -467,8 +417,6 @@ Defined in: [types/providers.ts:242](https://github.com/juspay/neurolink/blob/re > `optional` **inceptionLabs?**: `object` -Defined in: [types/providers.ts:243](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L243) - #### apiKey? > `optional` **apiKey?**: `string` @@ -483,8 +431,6 @@ Defined in: [types/providers.ts:243](https://github.com/juspay/neurolink/blob/re > `optional` **ioIntelligence?**: `object` -Defined in: [types/providers.ts:244](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L244) - #### apiKey? > `optional` **apiKey?**: `string` @@ -499,8 +445,6 @@ Defined in: [types/providers.ts:244](https://github.com/juspay/neurolink/blob/re > `optional` **mancer?**: `object` -Defined in: [types/providers.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L245) - #### apiKey? > `optional` **apiKey?**: `string` @@ -515,8 +459,6 @@ Defined in: [types/providers.ts:245](https://github.com/juspay/neurolink/blob/re > `optional` **mistral?**: `object` -Defined in: [types/providers.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L246) - #### apiKey? > `optional` **apiKey?**: `string` @@ -531,8 +473,6 @@ Defined in: [types/providers.ts:246](https://github.com/juspay/neurolink/blob/re > `optional` **perplexity?**: `object` -Defined in: [types/providers.ts:247](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L247) - #### apiKey? > `optional` **apiKey?**: `string` @@ -547,8 +487,6 @@ Defined in: [types/providers.ts:247](https://github.com/juspay/neurolink/blob/re > `optional` **sambanova?**: `object` -Defined in: [types/providers.ts:248](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L248) - #### apiKey? > `optional` **apiKey?**: `string` @@ -563,8 +501,6 @@ Defined in: [types/providers.ts:248](https://github.com/juspay/neurolink/blob/re > `optional` **together?**: `object` -Defined in: [types/providers.ts:249](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L249) - #### apiKey? > `optional` **apiKey?**: `string` @@ -579,8 +515,6 @@ Defined in: [types/providers.ts:249](https://github.com/juspay/neurolink/blob/re > `optional` **upstage?**: `object` -Defined in: [types/providers.ts:250](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L250) - #### apiKey? > `optional` **apiKey?**: `string` @@ -595,8 +529,6 @@ Defined in: [types/providers.ts:250](https://github.com/juspay/neurolink/blob/re > `optional` **xai?**: `object` -Defined in: [types/providers.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L251) - #### apiKey? > `optional` **apiKey?**: `string` @@ -611,8 +543,6 @@ Defined in: [types/providers.ts:251](https://github.com/juspay/neurolink/blob/re > `optional` **cohere?**: `object` -Defined in: [types/providers.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L253) - #### apiKey? > `optional` **apiKey?**: `string` @@ -627,8 +557,6 @@ Defined in: [types/providers.ts:253](https://github.com/juspay/neurolink/blob/re > `optional` **replicate?**: `object` -Defined in: [types/providers.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L254) - #### apiToken? > `optional` **apiToken?**: `string` @@ -651,8 +579,6 @@ Defined in: [types/providers.ts:254](https://github.com/juspay/neurolink/blob/re > `optional` **voyage?**: `object` -Defined in: [types/providers.ts:260](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L260) - #### apiKey? > `optional` **apiKey?**: `string` @@ -667,8 +593,6 @@ Defined in: [types/providers.ts:260](https://github.com/juspay/neurolink/blob/re > `optional` **jina?**: `object` -Defined in: [types/providers.ts:261](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L261) - #### apiKey? > `optional` **apiKey?**: `string` @@ -683,8 +607,6 @@ Defined in: [types/providers.ts:261](https://github.com/juspay/neurolink/blob/re > `optional` **stability?**: `object` -Defined in: [types/providers.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L262) - #### apiKey? > `optional` **apiKey?**: `string` @@ -699,8 +621,6 @@ Defined in: [types/providers.ts:262](https://github.com/juspay/neurolink/blob/re > `optional` **ideogram?**: `object` -Defined in: [types/providers.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L263) - #### apiKey? > `optional` **apiKey?**: `string` @@ -715,8 +635,6 @@ Defined in: [types/providers.ts:263](https://github.com/juspay/neurolink/blob/re > `optional` **recraft?**: `object` -Defined in: [types/providers.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L264) - #### apiKey? > `optional` **apiKey?**: `string` @@ -731,8 +649,6 @@ Defined in: [types/providers.ts:264](https://github.com/juspay/neurolink/blob/re > `optional` **typesafe?**: `object` -Defined in: [types/providers.ts:266](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L266) - TypeSafe (Jev) — the `decide` inference type, not text generation. #### apiKey? @@ -778,8 +694,6 @@ The gateway transport's evaluation-model route. Defaults to > `optional` **laya?**: `object` -Defined in: [types/providers.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L296) - Laya (Convai, open weights) — the `decide` inference type. There is no built-in endpoint: `baseURL` (or LAYA_BASE_URL) is required, pointing at a Laya server or a proxy route to one; requests go to `/predict`. diff --git a/docs/api/type-aliases/NeurolinkOptions.md b/docs/api/type-aliases/NeurolinkOptions.md index 3ddc33c8f..9593e6914 100644 --- a/docs/api/type-aliases/NeurolinkOptions.md +++ b/docs/api/type-aliases/NeurolinkOptions.md @@ -8,8 +8,6 @@ > **NeurolinkOptions** = `object` -Defined in: [types/conversation.ts:468](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L468) - NeuroLink initialization options Configuration for creating NeuroLink instances with conversation memory @@ -19,8 +17,6 @@ Configuration for creating NeuroLink instances with conversation memory > `optional` **conversationMemory?**: [`ConversationMemoryConfig`](ConversationMemoryConfig.md) -Defined in: [types/conversation.ts:470](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L470) - Conversation memory configuration --- @@ -29,8 +25,6 @@ Conversation memory configuration > `optional` **sessionId?**: `string` -Defined in: [types/conversation.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L473) - Session identifier for conversation context --- @@ -39,6 +33,4 @@ Session identifier for conversation context > `optional` **observability?**: [`ObservabilityConfig`](ObservabilityConfig.md) -Defined in: [types/conversation.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L476) - Observability configuration diff --git a/docs/api/type-aliases/NextFunction.md b/docs/api/type-aliases/NextFunction.md index 0b92f24f3..4853811c8 100644 --- a/docs/api/type-aliases/NextFunction.md +++ b/docs/api/type-aliases/NextFunction.md @@ -8,8 +8,6 @@ > **NextFunction** = () => `Promise`\<`void`\> -Defined in: [types/auth.ts:1329](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1329) - Next-function for Express-style middleware chaining. ## Returns diff --git a/docs/api/type-aliases/NonEmptyString.md b/docs/api/type-aliases/NonEmptyString.md index 921c58a6d..b007e1ee0 100644 --- a/docs/api/type-aliases/NonEmptyString.md +++ b/docs/api/type-aliases/NonEmptyString.md @@ -8,8 +8,6 @@ > **NonEmptyString** = `string` & `object` -Defined in: [types/aliases.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L296) - Non-empty string type Useful for validated string inputs diff --git a/docs/api/type-aliases/NormalizedKnowledgeEntry.md b/docs/api/type-aliases/NormalizedKnowledgeEntry.md index 48752c115..dbd0d297d 100644 --- a/docs/api/type-aliases/NormalizedKnowledgeEntry.md +++ b/docs/api/type-aliases/NormalizedKnowledgeEntry.md @@ -8,8 +8,6 @@ > **NormalizedKnowledgeEntry** = `object` -Defined in: [types/knowledge.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L114) - The complete, defaults-resolved record NeuroLink indexes and injects. Omitted optionals are materialized (arrays to `[]`, `body` to `""`, `kind` to "text", `status` to "active") so downstream code never re-checks the resolution chain. @@ -21,102 +19,76 @@ Field meanings mirror `KnowledgeEntryInput`. > **id**: `string` -Defined in: [types/knowledge.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L115) - --- ### title > **title**: `string` -Defined in: [types/knowledge.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L116) - --- ### summary > **summary**: `string` -Defined in: [types/knowledge.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L117) - --- ### domain > **domain**: `string` -Defined in: [types/knowledge.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L118) - --- ### integrations > **integrations**: `string`[] -Defined in: [types/knowledge.ts:119](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L119) - --- ### kind > **kind**: [`KnowledgeEntryKind`](KnowledgeEntryKind.md) -Defined in: [types/knowledge.ts:120](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L120) - --- ### status > **status**: [`KnowledgeStatus`](KnowledgeStatus.md) -Defined in: [types/knowledge.ts:121](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L121) - --- ### body > **body**: `string` -Defined in: [types/knowledge.ts:122](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L122) - --- ### aliases > **aliases**: `string`[] -Defined in: [types/knowledge.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L123) - --- ### keywords > **keywords**: `string`[] -Defined in: [types/knowledge.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L124) - --- ### relatedEntryIds > **relatedEntryIds**: `string`[] -Defined in: [types/knowledge.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L125) - --- ### parentEntryId? > `optional` **parentEntryId?**: `string` -Defined in: [types/knowledge.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L126) - --- ### version > **version**: `string` -Defined in: [types/knowledge.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L128) - Content version from the source/manifest; appears in citations as [KB:id@version]. diff --git a/docs/api/type-aliases/NormalizedMcpOutput.md b/docs/api/type-aliases/NormalizedMcpOutput.md index 540d6ada7..5588e78ce 100644 --- a/docs/api/type-aliases/NormalizedMcpOutput.md +++ b/docs/api/type-aliases/NormalizedMcpOutput.md @@ -8,8 +8,6 @@ > **NormalizedMcpOutput** = `object` -Defined in: [types/mcpOutput.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L35) - Value returned by McpOutputNormalizer.normalize(). ## Properties @@ -18,8 +16,6 @@ Value returned by McpOutputNormalizer.normalize(). > **result**: `unknown` -Defined in: [types/mcpOutput.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L37) - The result to substitute for the raw callResult. May be a surrogate. --- @@ -28,8 +24,6 @@ The result to substitute for the raw callResult. May be a surrogate. > **isExternalized**: `boolean` -Defined in: [types/mcpOutput.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L39) - Whether the full payload was written to the artifact store. --- @@ -38,8 +32,6 @@ Whether the full payload was written to the artifact store. > `optional` **artifactId?**: `string` -Defined in: [types/mcpOutput.ts:41](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L41) - Artifact ID when isExternalized === true. --- @@ -48,6 +40,4 @@ Artifact ID when isExternalized === true. > **originalBytes**: `number` -Defined in: [types/mcpOutput.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcpOutput.ts#L43) - Serialized byte size of the original payload. diff --git a/docs/api/type-aliases/Nullable.md b/docs/api/type-aliases/Nullable.md index d0731f20e..3c5e541b6 100644 --- a/docs/api/type-aliases/Nullable.md +++ b/docs/api/type-aliases/Nullable.md @@ -8,8 +8,6 @@ > **Nullable**\<`T`\> = `T` \| `null` -Defined in: [types/aliases.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L280) - Nullable type alias Common pattern for optional values diff --git a/docs/api/type-aliases/NumberArray.md b/docs/api/type-aliases/NumberArray.md index c26623a5e..f8f2ebb9b 100644 --- a/docs/api/type-aliases/NumberArray.md +++ b/docs/api/type-aliases/NumberArray.md @@ -8,7 +8,5 @@ > **NumberArray** = `number`[] -Defined in: [types/aliases.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L172) - Number array type Common for metrics, coordinates, etc. diff --git a/docs/api/type-aliases/NumberRecord.md b/docs/api/type-aliases/NumberRecord.md index 05a752dc1..75a5aeee7 100644 --- a/docs/api/type-aliases/NumberRecord.md +++ b/docs/api/type-aliases/NumberRecord.md @@ -8,7 +8,5 @@ > **NumberRecord** = `Record`\<`string`, `number`\> -Defined in: [types/aliases.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L76) - Number-valued record for metrics and counters Used in performance monitoring and statistics diff --git a/docs/api/type-aliases/NvidiaNimExtraBody.md b/docs/api/type-aliases/NvidiaNimExtraBody.md index 8708b72b5..ab18aa896 100644 --- a/docs/api/type-aliases/NvidiaNimExtraBody.md +++ b/docs/api/type-aliases/NvidiaNimExtraBody.md @@ -8,8 +8,6 @@ > **NvidiaNimExtraBody** = `object` -Defined in: [types/providers.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L370) - NVIDIA NIM extra request body parameters passed via `providerOptions.openai.body`. Lives here (not in providers/nvidiaNim.ts) per CLAUDE.md rule 2. @@ -19,64 +17,48 @@ Lives here (not in providers/nvidiaNim.ts) per CLAUDE.md rule 2. > `optional` **top_k?**: `number` -Defined in: [types/providers.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L371) - --- ### min_p? > `optional` **min_p?**: `number` -Defined in: [types/providers.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L372) - --- ### repetition_penalty? > `optional` **repetition_penalty?**: `number` -Defined in: [types/providers.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L373) - --- ### min_tokens? > `optional` **min_tokens?**: `number` -Defined in: [types/providers.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L374) - --- ### chat_template? > `optional` **chat_template?**: `string` -Defined in: [types/providers.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L375) - --- ### request_id? > `optional` **request_id?**: `string` -Defined in: [types/providers.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L376) - --- ### ignore_eos? > `optional` **ignore_eos?**: `boolean` -Defined in: [types/providers.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L377) - --- ### chat_template_kwargs? > `optional` **chat_template_kwargs?**: `object` -Defined in: [types/providers.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L378) - #### thinking? > `optional` **thinking?**: `boolean` diff --git a/docs/api/type-aliases/OAuth2Config.md b/docs/api/type-aliases/OAuth2Config.md index 86c63e371..e314edb08 100644 --- a/docs/api/type-aliases/OAuth2Config.md +++ b/docs/api/type-aliases/OAuth2Config.md @@ -8,8 +8,6 @@ > **OAuth2Config** = `object` -Defined in: [types/auth.ts:757](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L757) - Generic OAuth2 provider configuration ## Properties @@ -18,8 +16,6 @@ Generic OAuth2 provider configuration > **authorizationUrl**: `string` -Defined in: [types/auth.ts:759](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L759) - Authorization endpoint URL --- @@ -28,8 +24,6 @@ Authorization endpoint URL > **tokenUrl**: `string` -Defined in: [types/auth.ts:761](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L761) - Token endpoint URL --- @@ -38,8 +32,6 @@ Token endpoint URL > `optional` **userInfoUrl?**: `string` -Defined in: [types/auth.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L763) - User info endpoint URL --- @@ -48,8 +40,6 @@ User info endpoint URL > `optional` **jwksUrl?**: `string` -Defined in: [types/auth.ts:765](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L765) - JWKS endpoint URL --- @@ -58,8 +48,6 @@ JWKS endpoint URL > **clientId**: `string` -Defined in: [types/auth.ts:767](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L767) - Client ID --- @@ -68,8 +56,6 @@ Client ID > `optional` **clientSecret?**: `string` -Defined in: [types/auth.ts:769](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L769) - Client secret --- @@ -78,8 +64,6 @@ Client secret > `optional` **scopes?**: `string`[] -Defined in: [types/auth.ts:771](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L771) - OAuth scopes --- @@ -88,8 +72,6 @@ OAuth scopes > `optional` **redirectUrl?**: `string` -Defined in: [types/auth.ts:773](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L773) - Redirect URL --- @@ -98,6 +80,4 @@ Redirect URL > `optional` **usePKCE?**: `boolean` -Defined in: [types/auth.ts:775](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L775) - Enable PKCE diff --git a/docs/api/type-aliases/OAuthClientInformation.md b/docs/api/type-aliases/OAuthClientInformation.md index b0625bd4f..947732eae 100644 --- a/docs/api/type-aliases/OAuthClientInformation.md +++ b/docs/api/type-aliases/OAuthClientInformation.md @@ -8,8 +8,6 @@ > **OAuthClientInformation** = `object` -Defined in: [types/mcp.ts:940](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L940) - OAuth client information returned to MCP SDK ## Properties @@ -18,20 +16,14 @@ OAuth client information returned to MCP SDK > **clientId**: `string` -Defined in: [types/mcp.ts:941](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L941) - --- ### clientSecret? > `optional` **clientSecret?**: `string` -Defined in: [types/mcp.ts:942](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L942) - --- ### redirectUri > **redirectUri**: `string` - -Defined in: [types/mcp.ts:943](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L943) diff --git a/docs/api/type-aliases/OAuthConfig.md b/docs/api/type-aliases/OAuthConfig.md index 0ec5044c6..ff9a43195 100644 --- a/docs/api/type-aliases/OAuthConfig.md +++ b/docs/api/type-aliases/OAuthConfig.md @@ -8,8 +8,6 @@ > **OAuthConfig** = `object` -Defined in: [types/subscription.ts:689](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L689) - OAuth configuration for Claude subscription authentication ## Description @@ -23,8 +21,6 @@ Used to configure the OAuth client for subscription-based access. > **clientId**: `string` -Defined in: [types/subscription.ts:694](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L694) - OAuth client ID for the application #### Description @@ -37,8 +33,6 @@ Obtained from Anthropic developer console > **redirectUri**: `string` -Defined in: [types/subscription.ts:700](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L700) - OAuth redirect URI for the callback #### Description @@ -51,8 +45,6 @@ Must match the registered redirect URI in Anthropic console > **scopes**: `string`[] -Defined in: [types/subscription.ts:706](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L706) - OAuth scopes to request #### Description @@ -65,8 +57,6 @@ Array of scope strings defining requested permissions > `optional` **clientSecret?**: `string` -Defined in: [types/subscription.ts:712](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L712) - OAuth client secret (optional, for confidential clients) #### Description @@ -79,8 +69,6 @@ Only used for server-side OAuth flows > `optional` **authorizationEndpoint?**: `string` -Defined in: [types/subscription.ts:718](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L718) - OAuth authorization endpoint URL #### Description @@ -93,8 +81,6 @@ Anthropic's OAuth authorization URL > `optional` **tokenEndpoint?**: `string` -Defined in: [types/subscription.ts:724](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L724) - OAuth token endpoint URL #### Description @@ -107,8 +93,6 @@ Anthropic's OAuth token exchange URL > `optional` **codeVerifier?**: `string` -Defined in: [types/subscription.ts:730](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L730) - PKCE code verifier (for public clients) #### Description @@ -121,8 +105,6 @@ Used with PKCE flow for enhanced security > `optional` **state?**: `string` -Defined in: [types/subscription.ts:736](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L736) - State parameter for CSRF protection #### Description diff --git a/docs/api/type-aliases/OAuthFlowTokens.md b/docs/api/type-aliases/OAuthFlowTokens.md index 9ca988bca..a56aef189 100644 --- a/docs/api/type-aliases/OAuthFlowTokens.md +++ b/docs/api/type-aliases/OAuthFlowTokens.md @@ -8,8 +8,6 @@ > **OAuthFlowTokens** = `object` -Defined in: [types/subscription.ts:972](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L972) - Parsed OAuth tokens from a fresh OAuth flow. Uses Date for expiresAt (vs number in OAuthTokens for storage). @@ -19,8 +17,6 @@ Uses Date for expiresAt (vs number in OAuthTokens for storage). > **accessToken**: `string` -Defined in: [types/subscription.ts:974](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L974) - The access token for API authentication --- @@ -29,8 +25,6 @@ The access token for API authentication > **tokenType**: `string` -Defined in: [types/subscription.ts:976](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L976) - Token type (typically "Bearer") --- @@ -39,8 +33,6 @@ Token type (typically "Bearer") > **expiresAt**: `Date` -Defined in: [types/subscription.ts:978](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L978) - Expiration timestamp (Date object) --- @@ -49,8 +41,6 @@ Expiration timestamp (Date object) > `optional` **refreshToken?**: `string` -Defined in: [types/subscription.ts:980](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L980) - Refresh token for obtaining new access tokens --- @@ -59,6 +49,4 @@ Refresh token for obtaining new access tokens > **scopes**: `string`[] -Defined in: [types/subscription.ts:982](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L982) - Granted scopes as an array diff --git a/docs/api/type-aliases/OAuthToken.md b/docs/api/type-aliases/OAuthToken.md index c8dee2ef4..9e1d67f4d 100644 --- a/docs/api/type-aliases/OAuthToken.md +++ b/docs/api/type-aliases/OAuthToken.md @@ -8,8 +8,6 @@ > **OAuthToken** = `object` -Defined in: [types/subscription.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L65) - OAuth token structure for Claude subscriptions ## Description @@ -22,8 +20,6 @@ Contains the OAuth token information for authenticated sessions > **accessToken**: `string` -Defined in: [types/subscription.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L69) - The access token for API requests --- @@ -32,8 +28,6 @@ The access token for API requests > `optional` **refreshToken?**: `string` -Defined in: [types/subscription.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L74) - The refresh token for obtaining new access tokens --- @@ -42,8 +36,6 @@ The refresh token for obtaining new access tokens > `optional` **expiresAt?**: `number` -Defined in: [types/subscription.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L79) - Token expiration timestamp (Unix milliseconds, i.e. Date.now() scale) --- @@ -52,8 +44,6 @@ Token expiration timestamp (Unix milliseconds, i.e. Date.now() scale) > `optional` **tokenType?**: `string` -Defined in: [types/subscription.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L84) - Token type (typically "Bearer") --- @@ -62,6 +52,4 @@ Token type (typically "Bearer") > `optional` **scopes?**: `string`[] -Defined in: [types/subscription.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L89) - Scopes granted to this token diff --git a/docs/api/type-aliases/OAuthTokenResponse.md b/docs/api/type-aliases/OAuthTokenResponse.md index d1f6c18da..12c9bfcf2 100644 --- a/docs/api/type-aliases/OAuthTokenResponse.md +++ b/docs/api/type-aliases/OAuthTokenResponse.md @@ -8,8 +8,6 @@ > **OAuthTokenResponse** = `object` -Defined in: [types/subscription.ts:955](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L955) - OAuth 2.0 token response from Anthropic (raw API response shape) ## Properties @@ -18,8 +16,6 @@ OAuth 2.0 token response from Anthropic (raw API response shape) > **access_token**: `string` -Defined in: [types/subscription.ts:957](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L957) - The access token for API authentication --- @@ -28,8 +24,6 @@ The access token for API authentication > **token_type**: `string` -Defined in: [types/subscription.ts:959](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L959) - Token type (typically "Bearer") --- @@ -38,8 +32,6 @@ Token type (typically "Bearer") > **expires_in**: `number` -Defined in: [types/subscription.ts:961](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L961) - Token expiration time in seconds --- @@ -48,8 +40,6 @@ Token expiration time in seconds > `optional` **refresh_token?**: `string` -Defined in: [types/subscription.ts:963](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L963) - Refresh token for obtaining new access tokens --- @@ -58,6 +48,4 @@ Refresh token for obtaining new access tokens > `optional` **scope?**: `string` -Defined in: [types/subscription.ts:965](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L965) - Granted scopes (space-separated) diff --git a/docs/api/type-aliases/OAuthTokens.md b/docs/api/type-aliases/OAuthTokens.md index a3811b92f..b5fd78ccb 100644 --- a/docs/api/type-aliases/OAuthTokens.md +++ b/docs/api/type-aliases/OAuthTokens.md @@ -8,8 +8,6 @@ > **OAuthTokens** = `object` -Defined in: [types/auth.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L36) - OAuth tokens structure (relaxed version for general use). Use StoredOAuthTokens when persisting (stricter — expiresAt and tokenType required). @@ -19,8 +17,6 @@ Use StoredOAuthTokens when persisting (stricter — expiresAt and tokenType requ > **accessToken**: `string` -Defined in: [types/auth.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L38) - The access token for API authentication --- @@ -29,8 +25,6 @@ The access token for API authentication > `optional` **refreshToken?**: `string` -Defined in: [types/auth.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L40) - The refresh token for obtaining new access tokens --- @@ -39,8 +33,6 @@ The refresh token for obtaining new access tokens > `optional` **expiresAt?**: `number` -Defined in: [types/auth.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L42) - Token expiration timestamp (Unix epoch) --- @@ -49,8 +41,6 @@ Token expiration timestamp (Unix epoch) > `optional` **tokenType?**: `string` -Defined in: [types/auth.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L44) - Token type (typically "Bearer") --- @@ -59,6 +49,4 @@ Token type (typically "Bearer") > `optional` **scope?**: `string` -Defined in: [types/auth.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L46) - OAuth scope granted diff --git a/docs/api/type-aliases/ObservabilityCircuitBreakerConfig.md b/docs/api/type-aliases/ObservabilityCircuitBreakerConfig.md index 22c73fbf0..5a318529a 100644 --- a/docs/api/type-aliases/ObservabilityCircuitBreakerConfig.md +++ b/docs/api/type-aliases/ObservabilityCircuitBreakerConfig.md @@ -8,8 +8,6 @@ > **ObservabilityCircuitBreakerConfig** = `object` -Defined in: [types/observability.ts:514](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L514) - Minimal config for the observability exporter circuit breaker. Prefixed to disambiguate from the richer MCP CircuitBreakerConfig in mcp.ts. @@ -19,12 +17,8 @@ Prefixed to disambiguate from the richer MCP CircuitBreakerConfig in mcp.ts. > **failureThreshold**: `number` -Defined in: [types/observability.ts:515](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L515) - --- ### resetTimeout > **resetTimeout**: `number` - -Defined in: [types/observability.ts:516](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L516) diff --git a/docs/api/type-aliases/ObservabilityCircuitBreakerState.md b/docs/api/type-aliases/ObservabilityCircuitBreakerState.md index b0a6489cf..347c8e299 100644 --- a/docs/api/type-aliases/ObservabilityCircuitBreakerState.md +++ b/docs/api/type-aliases/ObservabilityCircuitBreakerState.md @@ -8,8 +8,6 @@ > **ObservabilityCircuitBreakerState** = `object` -Defined in: [types/observability.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L504) - Runtime state for the observability exporter circuit breaker. Prefixed to disambiguate from the richer MCP CircuitBreakerState in mcp.ts. @@ -19,20 +17,14 @@ Prefixed to disambiguate from the richer MCP CircuitBreakerState in mcp.ts. > **failures**: `number` -Defined in: [types/observability.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L505) - --- ### lastFailure > **lastFailure**: `number` -Defined in: [types/observability.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L506) - --- ### state > **state**: `"closed"` \| `"open"` \| `"half-open"` - -Defined in: [types/observability.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L507) diff --git a/docs/api/type-aliases/ObservabilityCommandArgs.md b/docs/api/type-aliases/ObservabilityCommandArgs.md index 0f6957b94..d2f5c4094 100644 --- a/docs/api/type-aliases/ObservabilityCommandArgs.md +++ b/docs/api/type-aliases/ObservabilityCommandArgs.md @@ -8,8 +8,6 @@ > **ObservabilityCommandArgs** = `object` -Defined in: [types/cli.ts:1268](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1268) - Observability command arguments ## Properties @@ -18,12 +16,8 @@ Observability command arguments > `optional` **format?**: `"text"` \| `"json"` \| `"table"` -Defined in: [types/cli.ts:1269](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1269) - --- ### quiet? > `optional` **quiet?**: `boolean` - -Defined in: [types/cli.ts:1270](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1270) diff --git a/docs/api/type-aliases/ObservabilityConfig.md b/docs/api/type-aliases/ObservabilityConfig.md index 3dfefc479..06cfeed93 100644 --- a/docs/api/type-aliases/ObservabilityConfig.md +++ b/docs/api/type-aliases/ObservabilityConfig.md @@ -8,8 +8,6 @@ > **ObservabilityConfig** = `object` -Defined in: [types/observability.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L189) - Complete observability configuration for Neurolink SDK ## Properties @@ -18,8 +16,6 @@ Complete observability configuration for Neurolink SDK > `optional` **langfuse?**: [`LangfuseConfig`](LangfuseConfig.md) -Defined in: [types/observability.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L191) - Langfuse configuration --- @@ -28,6 +24,4 @@ Langfuse configuration > `optional` **openTelemetry?**: [`OpenTelemetryConfig`](OpenTelemetryConfig.md) -Defined in: [types/observability.ts:193](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L193) - OpenTelemetry configuration diff --git a/docs/api/type-aliases/ObservabilityCostsArgs.md b/docs/api/type-aliases/ObservabilityCostsArgs.md index 420701cab..52054c31e 100644 --- a/docs/api/type-aliases/ObservabilityCostsArgs.md +++ b/docs/api/type-aliases/ObservabilityCostsArgs.md @@ -8,8 +8,6 @@ > **ObservabilityCostsArgs** = [`ObservabilityCommandArgs`](ObservabilityCommandArgs.md) & `object` -Defined in: [types/cli.ts:1285](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1285) - Observability costs sub-command args ## Type Declaration diff --git a/docs/api/type-aliases/ObservabilityExportersArgs.md b/docs/api/type-aliases/ObservabilityExportersArgs.md index 27e7b7f7d..b0403e9e8 100644 --- a/docs/api/type-aliases/ObservabilityExportersArgs.md +++ b/docs/api/type-aliases/ObservabilityExportersArgs.md @@ -8,6 +8,4 @@ > **ObservabilityExportersArgs** = [`ObservabilityCommandArgs`](ObservabilityCommandArgs.md) -Defined in: [types/cli.ts:1282](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1282) - Observability exporters sub-command args diff --git a/docs/api/type-aliases/ObservabilityMetricsArgs.md b/docs/api/type-aliases/ObservabilityMetricsArgs.md index e2d0999c2..c3b84d894 100644 --- a/docs/api/type-aliases/ObservabilityMetricsArgs.md +++ b/docs/api/type-aliases/ObservabilityMetricsArgs.md @@ -8,8 +8,6 @@ > **ObservabilityMetricsArgs** = [`ObservabilityCommandArgs`](ObservabilityCommandArgs.md) & `object` -Defined in: [types/cli.ts:1277](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1277) - Observability metrics sub-command args ## Type Declaration diff --git a/docs/api/type-aliases/ObservabilityModelPricing.md b/docs/api/type-aliases/ObservabilityModelPricing.md index 560742fd8..305807ebd 100644 --- a/docs/api/type-aliases/ObservabilityModelPricing.md +++ b/docs/api/type-aliases/ObservabilityModelPricing.md @@ -8,8 +8,6 @@ > **ObservabilityModelPricing** = `object` -Defined in: [types/observability.ts:585](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L585) - Per-million-token pricing used by the observability TokenTracker. Prefixed to disambiguate from the richer providers.ts ModelPricing. @@ -19,20 +17,14 @@ Prefixed to disambiguate from the richer providers.ts ModelPricing. > **inputPricePerMillion**: `number` -Defined in: [types/observability.ts:586](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L586) - --- ### outputPricePerMillion > **outputPricePerMillion**: `number` -Defined in: [types/observability.ts:587](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L587) - --- ### cachedInputPricePerMillion? > `optional` **cachedInputPricePerMillion?**: `number` - -Defined in: [types/observability.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L588) diff --git a/docs/api/type-aliases/ObservabilityStatusArgs.md b/docs/api/type-aliases/ObservabilityStatusArgs.md index bfa06bd5d..7105f8857 100644 --- a/docs/api/type-aliases/ObservabilityStatusArgs.md +++ b/docs/api/type-aliases/ObservabilityStatusArgs.md @@ -8,6 +8,4 @@ > **ObservabilityStatusArgs** = [`ObservabilityCommandArgs`](ObservabilityCommandArgs.md) -Defined in: [types/cli.ts:1274](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1274) - Observability status sub-command args diff --git a/docs/api/type-aliases/OfficeDocumentType.md b/docs/api/type-aliases/OfficeDocumentType.md index fad9c9330..294a68821 100644 --- a/docs/api/type-aliases/OfficeDocumentType.md +++ b/docs/api/type-aliases/OfficeDocumentType.md @@ -8,6 +8,4 @@ > **OfficeDocumentType** = `"docx"` \| `"pptx"` \| `"xlsx"` -Defined in: [types/file.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L25) - Office document types diff --git a/docs/api/type-aliases/OfficeProcessorOptions.md b/docs/api/type-aliases/OfficeProcessorOptions.md index efc63a8f7..7e22ca663 100644 --- a/docs/api/type-aliases/OfficeProcessorOptions.md +++ b/docs/api/type-aliases/OfficeProcessorOptions.md @@ -8,8 +8,6 @@ > **OfficeProcessorOptions** = `object` -Defined in: [types/file.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L649) - Office processor options for Word, PowerPoint, and Excel documents ## Examples @@ -44,8 +42,6 @@ const options: OfficeProcessorOptions = { > `optional` **format?**: [`OfficeDocumentType`](OfficeDocumentType.md) -Defined in: [types/file.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L651) - Office document format type --- @@ -54,8 +50,6 @@ Office document format type > `optional` **extractTextOnly?**: `boolean` -Defined in: [types/file.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L653) - Whether to extract text only (true) or preserve formatting (false). Applies to: docx, pptx, xlsx --- @@ -64,8 +58,6 @@ Whether to extract text only (true) or preserve formatting (false). Applies to: > `optional` **maxSizeMB?**: `number` -Defined in: [types/file.ts:655](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L655) - Maximum file size in megabytes. Applies to: docx, pptx, xlsx --- @@ -74,8 +66,6 @@ Maximum file size in megabytes. Applies to: docx, pptx, xlsx > `optional` **includeMetadata?**: `boolean` -Defined in: [types/file.ts:657](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L657) - Whether to include metadata (author, created date, etc.). Applies to: docx, pptx, xlsx --- @@ -84,8 +74,6 @@ Whether to include metadata (author, created date, etc.). Applies to: docx, pptx > `optional` **processAllSheets?**: `boolean` -Defined in: [types/file.ts:659](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L659) - For spreadsheets (xlsx only): whether to process all sheets or just the first --- @@ -94,6 +82,4 @@ For spreadsheets (xlsx only): whether to process all sheets or just the first > `optional` **includeSlideNotes?**: `boolean` -Defined in: [types/file.ts:661](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L661) - For presentations (pptx only): whether to include slide notes diff --git a/docs/api/type-aliases/OllamaCommandArgs.md b/docs/api/type-aliases/OllamaCommandArgs.md index eaabc6de8..922856342 100644 --- a/docs/api/type-aliases/OllamaCommandArgs.md +++ b/docs/api/type-aliases/OllamaCommandArgs.md @@ -8,8 +8,6 @@ > **OllamaCommandArgs** = [`BaseCommandArgs`](BaseCommandArgs.md) & `object` -Defined in: [types/cli.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L334) - Ollama command arguments ## Type Declaration diff --git a/docs/api/type-aliases/OllamaHttpError.md b/docs/api/type-aliases/OllamaHttpError.md index 9f1e6fb6a..c3bbcc21c 100644 --- a/docs/api/type-aliases/OllamaHttpError.md +++ b/docs/api/type-aliases/OllamaHttpError.md @@ -8,8 +8,6 @@ > **OllamaHttpError** = [`ProviderError`](../classes/ProviderError.md) & `object` -Defined in: [types/errors.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L24) - ## Type Declaration ### statusCode? diff --git a/docs/api/type-aliases/OnChunkCallback.md b/docs/api/type-aliases/OnChunkCallback.md index 2aa0f595c..171e516b1 100644 --- a/docs/api/type-aliases/OnChunkCallback.md +++ b/docs/api/type-aliases/OnChunkCallback.md @@ -8,8 +8,6 @@ > **OnChunkCallback** = (`payload`) => `void` \| `Promise`\<`void`\> -Defined in: [types/middleware.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L350) - Callback invoked for each chunk during streaming. ## Parameters diff --git a/docs/api/type-aliases/OnErrorCallback.md b/docs/api/type-aliases/OnErrorCallback.md index 950f65f58..73eccf9b5 100644 --- a/docs/api/type-aliases/OnErrorCallback.md +++ b/docs/api/type-aliases/OnErrorCallback.md @@ -8,8 +8,6 @@ > **OnErrorCallback** = (`payload`) => `void` \| `Promise`\<`void`\> -Defined in: [types/middleware.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L345) - Callback invoked when generation or streaming encounters an error. ## Parameters diff --git a/docs/api/type-aliases/OnFinishCallback.md b/docs/api/type-aliases/OnFinishCallback.md index ac864d61b..bef0bfa6f 100644 --- a/docs/api/type-aliases/OnFinishCallback.md +++ b/docs/api/type-aliases/OnFinishCallback.md @@ -8,8 +8,6 @@ > **OnFinishCallback** = (`payload`) => `void` \| `Promise`\<`void`\> -Defined in: [types/middleware.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L340) - Callback invoked when generation or streaming finishes successfully. ## Parameters diff --git a/docs/api/type-aliases/OnceSchedule.md b/docs/api/type-aliases/OnceSchedule.md index 7d7aa8cd6..2efaeef5e 100644 --- a/docs/api/type-aliases/OnceSchedule.md +++ b/docs/api/type-aliases/OnceSchedule.md @@ -8,22 +8,16 @@ > **OnceSchedule** = `object` -Defined in: [types/task.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L68) - ## Properties ### type > **type**: `"once"` -Defined in: [types/task.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L69) - --- ### at > **at**: `Date` \| `string` -Defined in: [types/task.ts:71](https://github.com/juspay/neurolink/blob/release/src/lib/types/task.ts#L71) - ISO 8601 timestamp or Date object diff --git a/docs/api/type-aliases/OpenAIAssistantMessage.md b/docs/api/type-aliases/OpenAIAssistantMessage.md index fb3bb50cb..747bd2e7c 100644 --- a/docs/api/type-aliases/OpenAIAssistantMessage.md +++ b/docs/api/type-aliases/OpenAIAssistantMessage.md @@ -8,28 +8,20 @@ > **OpenAIAssistantMessage** = `object` -Defined in: [types/proxy.ts:3969](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3969) - ## Properties ### role > **role**: `"assistant"` -Defined in: [types/proxy.ts:3970](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3970) - --- ### content? > `optional` **content?**: `string` \| `null` -Defined in: [types/proxy.ts:3971](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3971) - --- ### tool_calls? > `optional` **tool_calls?**: [`OpenAIToolCall`](OpenAIToolCall.md)[] - -Defined in: [types/proxy.ts:3972](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3972) diff --git a/docs/api/type-aliases/OpenAIAudioDelta.md b/docs/api/type-aliases/OpenAIAudioDelta.md index 2439921ca..d9b806359 100644 --- a/docs/api/type-aliases/OpenAIAudioDelta.md +++ b/docs/api/type-aliases/OpenAIAudioDelta.md @@ -8,8 +8,6 @@ > **OpenAIAudioDelta** = [`OpenAIRealtimeEvent`](OpenAIRealtimeEvent.md) & `object` -Defined in: [types/stt.ts:705](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L705) - ## Type Declaration ### type diff --git a/docs/api/type-aliases/OpenAICompatBuildBodyArgs.md b/docs/api/type-aliases/OpenAICompatBuildBodyArgs.md index 3289eac56..0150f8d4b 100644 --- a/docs/api/type-aliases/OpenAICompatBuildBodyArgs.md +++ b/docs/api/type-aliases/OpenAICompatBuildBodyArgs.md @@ -8,32 +8,24 @@ > **OpenAICompatBuildBodyArgs** = `object` -Defined in: [types/openaiCompatible.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L325) - ## Properties ### modelId > **modelId**: `string` -Defined in: [types/openaiCompatible.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L326) - --- ### messages > **messages**: [`OpenAICompatChatMessage`](OpenAICompatChatMessage.md)[] -Defined in: [types/openaiCompatible.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L327) - --- ### options > **options**: `object` -Defined in: [types/openaiCompatible.ts:328](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L328) - #### maxTokens? > `optional` **maxTokens?**: `number` \| `null` @@ -78,28 +70,20 @@ explicit channel for non-OpenAI knobs (e.g. NVIDIA NIM's `top_k` / > `optional` **tools?**: [`OpenAICompatChatTool`](OpenAICompatChatTool.md)[] -Defined in: [types/openaiCompatible.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L345) - --- ### toolChoice? > `optional` **toolChoice?**: [`OpenAICompatToolChoiceWire`](OpenAICompatToolChoiceWire.md) -Defined in: [types/openaiCompatible.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L346) - --- ### streaming > **streaming**: `boolean` -Defined in: [types/openaiCompatible.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L347) - --- ### responseFormat? > `optional` **responseFormat?**: [`OpenAICompatResponseFormat`](OpenAICompatResponseFormat.md) - -Defined in: [types/openaiCompatible.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L348) diff --git a/docs/api/type-aliases/OpenAICompatCatalogEntry.md b/docs/api/type-aliases/OpenAICompatCatalogEntry.md index 7247d7ff0..13612dc59 100644 --- a/docs/api/type-aliases/OpenAICompatCatalogEntry.md +++ b/docs/api/type-aliases/OpenAICompatCatalogEntry.md @@ -8,8 +8,6 @@ > **OpenAICompatCatalogEntry** = `object` -Defined in: [types/providers.ts:787](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L787) - One row of the config-driven OpenAI-compatible provider catalog (OPENAI_COMPAT_CATALOG, src/lib/providers/openaiCompatCatalog.ts). Replaces a hand-written OpenAIChatCompletionsProvider subclass for @@ -22,8 +20,6 @@ base URL, model defaults, and error-message classification. > **providerName**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/providers.ts:789](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L789) - Registry key / nl.generate({provider}) value, e.g. "groq". --- @@ -32,8 +28,6 @@ Registry key / nl.generate({provider}) value, e.g. "groq". > **aliases**: `string`[] -Defined in: [types/providers.ts:791](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L791) - Registry aliases, e.g. ["together-ai", "together"]. --- @@ -42,8 +36,6 @@ Registry aliases, e.g. ["together-ai", "together"]. > **apiKeyEnvVar**: `string` -Defined in: [types/providers.ts:801](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L801) - Env var holding the API key, e.g. "GROQ_API_KEY". Declarative: the key is actually read through `configOptions.envVarName`, @@ -58,8 +50,6 @@ fields describing one fact are worth nothing if they can disagree. > `optional` **baseURLEnvVar?**: `string` -Defined in: [types/providers.ts:806](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L806) - Env var that can override the base URL, e.g. "GROQ_BASE_URL". Omit for entries that use computedBaseURL instead (e.g. Cloudflare). @@ -69,8 +59,6 @@ for entries that use computedBaseURL instead (e.g. Cloudflare). > `optional` **defaultBaseURL?**: `string` -Defined in: [types/providers.ts:808](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L808) - Static default base URL. Omit for computedBaseURL entries. --- @@ -79,8 +67,6 @@ Static default base URL. Omit for computedBaseURL entries. > `optional` **computedBaseURL?**: `object` -Defined in: [types/providers.ts:815](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L815) - Present only for providers whose base URL is computed from an extra required credential value instead of a static default (Cloudflare's accountId). Deliberately narrow (accountId-shaped) rather than a @@ -120,8 +106,6 @@ Builds the base URL from the resolved accountId. > **configOptions**: [`ProviderConfigOptions`](ProviderConfigOptions.md) -Defined in: [types/providers.ts:827](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L827) - Setup/help metadata, passed to validateApiKey(). Not consumed by classifyProviderError() — that function's ProviderErrorContext has no docsUrl field; any URL a rule's message needs is inlined in the rule @@ -133,8 +117,6 @@ itself (see Task 4). > **modelEnvVar**: `string` -Defined in: [types/providers.ts:829](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L829) - Env var for the default model, e.g. "GROQ_MODEL". --- @@ -143,8 +125,6 @@ Env var for the default model, e.g. "GROQ_MODEL". > **defaultModel**: `string` -Defined in: [types/providers.ts:831](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L831) - Default model when modelEnvVar is unset. --- @@ -153,8 +133,6 @@ Default model when modelEnvVar is unset. > `optional` **supportsTools?**: `boolean` -Defined in: [types/providers.ts:840](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L840) - Whether the vendor accepts native tool definitions, from the catalog's `capabilities.tools`. `false` makes the provider's `supportsTools()` answer false, so no `tools` array ever reaches a wire that rejects one @@ -168,8 +146,6 @@ same default every hand-written provider uses. > **registryDefaultModel**: `string` -Defined in: [types/providers.ts:846](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L846) - The literal passed as ProviderFactory.registerProvider()'s defaultModel argument (resolved before the provider is constructed). Preserves each provider's exact pre-migration registry behavior. @@ -180,8 +156,6 @@ provider's exact pre-migration registry behavior. > **registryDefaultModelChecksEnvVar**: `boolean` -Defined in: [types/providers.ts:853](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L853) - True for every provider except Mistral: whether the registry-level default also consults modelEnvVar before falling back to registryDefaultModel. False is a pre-existing, intentionally-preserved @@ -193,8 +167,6 @@ quirk unique to Mistral's registration (see plan's Design reference). > **fallbackModelName**: `string` -Defined in: [types/providers.ts:855](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L855) - Fallback model name (getFallbackModelName()). --- @@ -203,8 +175,6 @@ Fallback model name (getFallbackModelName()). > **fallbackModels**: `string`[] -Defined in: [types/providers.ts:857](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L857) - Fallback model list (getFallbackModels()). --- @@ -213,8 +183,6 @@ Fallback model list (getFallbackModels()). > **errorRules**: [`ProviderErrorRule`](ProviderErrorRule.md)[] -Defined in: [types/providers.ts:868](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L868) - Error-classification rules, consumed by classifyProviderError. Typed as a mutable array — not readonly — because plan 07's `classifyProviderError(error, rules: ProviderErrorRule[], provider, modelName?)` @@ -230,8 +198,6 @@ Task 4, so nothing actually mutates it at runtime. > `optional` **timeoutErrorClass?**: (`message`, `provider?`) => [`ProviderError`](../classes/ProviderError.md) -Defined in: [types/providers.ts:882](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L882) - Optional override for the Error subclass a TimeoutError should produce for this entry. classifyProviderError() hard-codes TimeoutError -> NetworkError unconditionally, ahead of any rule table, @@ -264,8 +230,6 @@ the classifier's default (six of the seven catalog entries). > `optional` **messageContentFormat?**: `"string"` -Defined in: [types/providers.ts:885](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L885) - See CatalogQuirks.messageContentFormat — a vendor that accepts `messages[].content` only as a plain string. @@ -275,8 +239,6 @@ See CatalogQuirks.messageContentFormat — a vendor that accepts > `optional` **responseFormatDowngrade?**: `"json-schema-to-json-object"` -Defined in: [types/providers.ts:889](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L889) - See CatalogQuirks.responseFormatDowngrade — a vendor that rejects `response_format: { type: "json_schema" }` but accepts `{ type: "json_object" }`. diff --git a/docs/api/type-aliases/OpenAICompatChatChoice.md b/docs/api/type-aliases/OpenAICompatChatChoice.md index 943726818..7c811132b 100644 --- a/docs/api/type-aliases/OpenAICompatChatChoice.md +++ b/docs/api/type-aliases/OpenAICompatChatChoice.md @@ -8,28 +8,20 @@ > **OpenAICompatChatChoice** = `object` -Defined in: [types/openaiCompatible.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L127) - ## Properties ### index > **index**: `number` -Defined in: [types/openaiCompatible.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L128) - --- ### message > **message**: [`OpenAICompatChatChoiceMessage`](OpenAICompatChatChoiceMessage.md) -Defined in: [types/openaiCompatible.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L129) - --- ### finish_reason > **finish_reason**: `"stop"` \| `"length"` \| `"tool_calls"` \| `"function_call"` \| `"content_filter"` \| `null` - -Defined in: [types/openaiCompatible.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L130) diff --git a/docs/api/type-aliases/OpenAICompatChatChoiceMessage.md b/docs/api/type-aliases/OpenAICompatChatChoiceMessage.md index 5175bcb51..662b98d46 100644 --- a/docs/api/type-aliases/OpenAICompatChatChoiceMessage.md +++ b/docs/api/type-aliases/OpenAICompatChatChoiceMessage.md @@ -8,52 +8,38 @@ > **OpenAICompatChatChoiceMessage** = `object` -Defined in: [types/openaiCompatible.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L114) - ## Properties ### role > **role**: `"assistant"` -Defined in: [types/openaiCompatible.ts:115](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L115) - --- ### content? > `optional` **content?**: `string` \| `null` -Defined in: [types/openaiCompatible.ts:116](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L116) - --- ### tool_calls? > `optional` **tool_calls?**: [`OpenAICompatToolCallWire`](OpenAICompatToolCallWire.md)[] -Defined in: [types/openaiCompatible.ts:117](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L117) - --- ### refusal? > `optional` **refusal?**: `string` \| `null` -Defined in: [types/openaiCompatible.ts:118](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L118) - --- ### reasoning_content? > `optional` **reasoning_content?**: `string` \| `null` -Defined in: [types/openaiCompatible.ts:123](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L123) - --- ### reasoning? > `optional` **reasoning?**: `string` \| `null` - -Defined in: [types/openaiCompatible.ts:124](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L124) diff --git a/docs/api/type-aliases/OpenAICompatChatMessage.md b/docs/api/type-aliases/OpenAICompatChatMessage.md index 4a94b8c19..2c6408698 100644 --- a/docs/api/type-aliases/OpenAICompatChatMessage.md +++ b/docs/api/type-aliases/OpenAICompatChatMessage.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatChatMessage > **OpenAICompatChatMessage** = \{ `role`: `"system"`; `content`: `string` \| [`OpenAICompatMessageContent`](OpenAICompatMessageContent.md)[]; \} \| \{ `role`: `"user"`; `content`: `string` \| [`OpenAICompatMessageContent`](OpenAICompatMessageContent.md)[]; \} \| \{ `role`: `"assistant"`; `content?`: `string` \| [`OpenAICompatMessageContent`](OpenAICompatMessageContent.md)[] \| `null`; `tool_calls?`: [`OpenAICompatToolCallWire`](OpenAICompatToolCallWire.md)[]; \} \| \{ `role`: `"tool"`; `content`: `string`; `tool_call_id`: `string`; \} - -Defined in: [types/openaiCompatible.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L39) diff --git a/docs/api/type-aliases/OpenAICompatChatRequest.md b/docs/api/type-aliases/OpenAICompatChatRequest.md index 16c256b31..4b5199674 100644 --- a/docs/api/type-aliases/OpenAICompatChatRequest.md +++ b/docs/api/type-aliases/OpenAICompatChatRequest.md @@ -8,40 +8,30 @@ > **OpenAICompatChatRequest** = `object` -Defined in: [types/openaiCompatible.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L82) - ## Properties ### model > **model**: `string` -Defined in: [types/openaiCompatible.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L83) - --- ### messages > **messages**: [`OpenAICompatChatMessage`](OpenAICompatChatMessage.md)[] -Defined in: [types/openaiCompatible.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L84) - --- ### stream? > `optional` **stream?**: `boolean` -Defined in: [types/openaiCompatible.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L85) - --- ### stream_options? > `optional` **stream_options?**: `object` -Defined in: [types/openaiCompatible.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L86) - #### include_usage? > `optional` **include_usage?**: `boolean` @@ -52,100 +42,74 @@ Defined in: [types/openaiCompatible.ts:86](https://github.com/juspay/neurolink/b > `optional` **max_tokens?**: `number` -Defined in: [types/openaiCompatible.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L87) - --- ### max_completion_tokens? > `optional` **max_completion_tokens?**: `number` -Defined in: [types/openaiCompatible.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L88) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/openaiCompatible.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L89) - --- ### top_p? > `optional` **top_p?**: `number` -Defined in: [types/openaiCompatible.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L90) - --- ### presence_penalty? > `optional` **presence_penalty?**: `number` -Defined in: [types/openaiCompatible.ts:91](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L91) - --- ### frequency_penalty? > `optional` **frequency_penalty?**: `number` -Defined in: [types/openaiCompatible.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L92) - --- ### seed? > `optional` **seed?**: `number` -Defined in: [types/openaiCompatible.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L93) - --- ### stop? > `optional` **stop?**: `string`[] -Defined in: [types/openaiCompatible.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L94) - --- ### tools? > `optional` **tools?**: [`OpenAICompatChatTool`](OpenAICompatChatTool.md)[] -Defined in: [types/openaiCompatible.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L95) - --- ### tool_choice? > `optional` **tool_choice?**: [`OpenAICompatToolChoiceWire`](OpenAICompatToolChoiceWire.md) -Defined in: [types/openaiCompatible.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L96) - --- ### response_format? > `optional` **response_format?**: [`OpenAICompatResponseFormat`](OpenAICompatResponseFormat.md) -Defined in: [types/openaiCompatible.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L97) - --- ### parallel_tool_calls? > `optional` **parallel_tool_calls?**: `boolean` -Defined in: [types/openaiCompatible.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L98) - --- ### user? > `optional` **user?**: `string` - -Defined in: [types/openaiCompatible.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L99) diff --git a/docs/api/type-aliases/OpenAICompatChatResponse.md b/docs/api/type-aliases/OpenAICompatChatResponse.md index f1434948d..4ec53a51f 100644 --- a/docs/api/type-aliases/OpenAICompatChatResponse.md +++ b/docs/api/type-aliases/OpenAICompatChatResponse.md @@ -8,60 +8,44 @@ > **OpenAICompatChatResponse** = `object` -Defined in: [types/openaiCompatible.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L139) - ## Properties ### id? > `optional` **id?**: `string` -Defined in: [types/openaiCompatible.ts:140](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L140) - --- ### object? > `optional` **object?**: `string` -Defined in: [types/openaiCompatible.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L141) - --- ### created? > `optional` **created?**: `number` -Defined in: [types/openaiCompatible.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L142) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/openaiCompatible.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L143) - --- ### choices > **choices**: [`OpenAICompatChatChoice`](OpenAICompatChatChoice.md)[] -Defined in: [types/openaiCompatible.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L144) - --- ### usage? > `optional` **usage?**: [`OpenAICompatUsage`](OpenAICompatUsage.md) -Defined in: [types/openaiCompatible.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L145) - --- ### system_fingerprint? > `optional` **system_fingerprint?**: `string` - -Defined in: [types/openaiCompatible.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L146) diff --git a/docs/api/type-aliases/OpenAICompatChatRole.md b/docs/api/type-aliases/OpenAICompatChatRole.md index a0060c246..2ed8f4bab 100644 --- a/docs/api/type-aliases/OpenAICompatChatRole.md +++ b/docs/api/type-aliases/OpenAICompatChatRole.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatChatRole > **OpenAICompatChatRole** = `"system"` \| `"user"` \| `"assistant"` \| `"tool"` - -Defined in: [types/openaiCompatible.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L14) diff --git a/docs/api/type-aliases/OpenAICompatChatStreamChunk.md b/docs/api/type-aliases/OpenAICompatChatStreamChunk.md index c8885c581..5d8dd4341 100644 --- a/docs/api/type-aliases/OpenAICompatChatStreamChunk.md +++ b/docs/api/type-aliases/OpenAICompatChatStreamChunk.md @@ -8,52 +8,38 @@ > **OpenAICompatChatStreamChunk** = `object` -Defined in: [types/openaiCompatible.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L179) - ## Properties ### id? > `optional` **id?**: `string` -Defined in: [types/openaiCompatible.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L180) - --- ### object? > `optional` **object?**: `string` -Defined in: [types/openaiCompatible.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L181) - --- ### created? > `optional` **created?**: `number` -Defined in: [types/openaiCompatible.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L182) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/openaiCompatible.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L183) - --- ### choices > **choices**: [`OpenAICompatStreamChunkChoice`](OpenAICompatStreamChunkChoice.md)[] -Defined in: [types/openaiCompatible.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L184) - --- ### usage? > `optional` **usage?**: [`OpenAICompatUsage`](OpenAICompatUsage.md) - -Defined in: [types/openaiCompatible.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L185) diff --git a/docs/api/type-aliases/OpenAICompatChatTool.md b/docs/api/type-aliases/OpenAICompatChatTool.md index 441e62ed5..8cf5e076f 100644 --- a/docs/api/type-aliases/OpenAICompatChatTool.md +++ b/docs/api/type-aliases/OpenAICompatChatTool.md @@ -8,24 +8,18 @@ > **OpenAICompatChatTool** = `object` -Defined in: [types/openaiCompatible.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L53) - ## Properties ### type > **type**: `"function"` -Defined in: [types/openaiCompatible.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L54) - --- ### function > **function**: `object` -Defined in: [types/openaiCompatible.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L55) - #### name > **name**: `string` diff --git a/docs/api/type-aliases/OpenAICompatConfig.md b/docs/api/type-aliases/OpenAICompatConfig.md index cf636c61d..52cf9fbfc 100644 --- a/docs/api/type-aliases/OpenAICompatConfig.md +++ b/docs/api/type-aliases/OpenAICompatConfig.md @@ -8,52 +8,38 @@ > **OpenAICompatConfig** = `object` -Defined in: [types/openaiCompatible.ts:200](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L200) - ## Properties ### provider > **provider**: `string` -Defined in: [types/openaiCompatible.ts:201](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L201) - --- ### modelId > **modelId**: `string` -Defined in: [types/openaiCompatible.ts:202](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L202) - --- ### baseURL > **baseURL**: `string` -Defined in: [types/openaiCompatible.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L203) - --- ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/openaiCompatible.ts:204](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L204) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> \| (() => `Record`\<`string`, `string`\>) -Defined in: [types/openaiCompatible.ts:205](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L205) - --- ### fetch? > `optional` **fetch?**: _typeof_ `globalThis.fetch` - -Defined in: [types/openaiCompatible.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L206) diff --git a/docs/api/type-aliases/OpenAICompatConfigInput.md b/docs/api/type-aliases/OpenAICompatConfigInput.md index a05ffffd0..1db0daf97 100644 --- a/docs/api/type-aliases/OpenAICompatConfigInput.md +++ b/docs/api/type-aliases/OpenAICompatConfigInput.md @@ -8,8 +8,6 @@ > **OpenAICompatConfigInput** = `Pick`\<[`OpenAICompatCatalogEntry`](OpenAICompatCatalogEntry.md), `"providerName"` \| `"apiKeyEnvVar"` \| `"baseURLEnvVar"` \| `"defaultBaseURL"` \| `"computedBaseURL"` \| `"configOptions"`\> -Defined in: [types/providers.ts:895](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L895) - The subset of OpenAICompatCatalogEntry that resolveOpenAICompatConfig() needs — lets call sites pass a minimal object without the full catalog entry (e.g. in tests, or a future non-catalog caller). diff --git a/docs/api/type-aliases/OpenAICompatCredentials.md b/docs/api/type-aliases/OpenAICompatCredentials.md index 58a87d6a2..dd3b066e2 100644 --- a/docs/api/type-aliases/OpenAICompatCredentials.md +++ b/docs/api/type-aliases/OpenAICompatCredentials.md @@ -8,8 +8,6 @@ > **OpenAICompatCredentials** = `object` -Defined in: [types/providers.ts:774](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L774) - Minimal credential shape accepted by resolveOpenAICompatConfig() and ConfiguredOpenAICompatProvider. A structural superset of every real per-provider NeurolinkCredentials[""] slice in this family (groq, @@ -23,20 +21,14 @@ accountId) here is always structurally valid. > `optional` **apiKey?**: `string` -Defined in: [types/providers.ts:775](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L775) - --- ### baseURL? > `optional` **baseURL?**: `string` -Defined in: [types/providers.ts:776](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L776) - --- ### accountId? > `optional` **accountId?**: `string` - -Defined in: [types/providers.ts:777](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L777) diff --git a/docs/api/type-aliases/OpenAICompatErrorBody.md b/docs/api/type-aliases/OpenAICompatErrorBody.md index 7c4a6db6a..589d84dc6 100644 --- a/docs/api/type-aliases/OpenAICompatErrorBody.md +++ b/docs/api/type-aliases/OpenAICompatErrorBody.md @@ -8,16 +8,12 @@ > **OpenAICompatErrorBody** = `object` -Defined in: [types/openaiCompatible.ts:190](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L190) - ## Properties ### error? > `optional` **error?**: `object` -Defined in: [types/openaiCompatible.ts:191](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L191) - #### message? > `optional` **message?**: [`OpenAICompatErrorMessage`](OpenAICompatErrorMessage.md) @@ -39,5 +35,3 @@ Defined in: [types/openaiCompatible.ts:191](https://github.com/juspay/neurolink/ ### detail? > `optional` **detail?**: `string` - -Defined in: [types/openaiCompatible.ts:197](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L197) diff --git a/docs/api/type-aliases/OpenAICompatErrorMessage.md b/docs/api/type-aliases/OpenAICompatErrorMessage.md index f097ce96d..fa804eb43 100644 --- a/docs/api/type-aliases/OpenAICompatErrorMessage.md +++ b/docs/api/type-aliases/OpenAICompatErrorMessage.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatErrorMessage > **OpenAICompatErrorMessage** = `string` \| `ReadonlyArray`\<\{ `msg?`: `string`; \}\> - -Defined in: [types/openaiCompatible.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L188) diff --git a/docs/api/type-aliases/OpenAICompatImageURLContent.md b/docs/api/type-aliases/OpenAICompatImageURLContent.md index 6be0a9eb7..02b912ff2 100644 --- a/docs/api/type-aliases/OpenAICompatImageURLContent.md +++ b/docs/api/type-aliases/OpenAICompatImageURLContent.md @@ -8,24 +8,18 @@ > **OpenAICompatImageURLContent** = `object` -Defined in: [types/openaiCompatible.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L21) - ## Properties ### type > **type**: `"image_url"` -Defined in: [types/openaiCompatible.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L22) - --- ### image_url > **image_url**: `object` -Defined in: [types/openaiCompatible.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L23) - #### url > **url**: `string` diff --git a/docs/api/type-aliases/OpenAICompatMessage.md b/docs/api/type-aliases/OpenAICompatMessage.md index fda5ab828..597d48bc8 100644 --- a/docs/api/type-aliases/OpenAICompatMessage.md +++ b/docs/api/type-aliases/OpenAICompatMessage.md @@ -8,36 +8,26 @@ > **OpenAICompatMessage** = `object` -Defined in: [types/openaiCompatible.ts:251](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L251) - ## Properties ### role > **role**: `"system"` \| `"user"` \| `"assistant"` \| `"tool"` -Defined in: [types/openaiCompatible.ts:252](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L252) - --- ### content > **content**: `unknown` -Defined in: [types/openaiCompatible.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L253) - --- ### toolCallId? > `optional` **toolCallId?**: `string` -Defined in: [types/openaiCompatible.ts:254](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L254) - --- ### toolName? > `optional` **toolName?**: `string` - -Defined in: [types/openaiCompatible.ts:255](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L255) diff --git a/docs/api/type-aliases/OpenAICompatMessageContent.md b/docs/api/type-aliases/OpenAICompatMessageContent.md index 62c88e344..203033ed8 100644 --- a/docs/api/type-aliases/OpenAICompatMessageContent.md +++ b/docs/api/type-aliases/OpenAICompatMessageContent.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatMessageContent > **OpenAICompatMessageContent** = [`OpenAICompatTextContent`](OpenAICompatTextContent.md) \| [`OpenAICompatImageURLContent`](OpenAICompatImageURLContent.md) - -Defined in: [types/openaiCompatible.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L26) diff --git a/docs/api/type-aliases/OpenAICompatResponseFormat.md b/docs/api/type-aliases/OpenAICompatResponseFormat.md index e70b961a6..1411b13c8 100644 --- a/docs/api/type-aliases/OpenAICompatResponseFormat.md +++ b/docs/api/type-aliases/OpenAICompatResponseFormat.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatResponseFormat > **OpenAICompatResponseFormat** = \{ `type`: `"text"`; \} \| \{ `type`: `"json_object"`; \} \| \{ `type`: `"json_schema"`; `json_schema`: \{ `name`: `string`; `schema`: `JSONSchema7`; `description?`: `string`; `strict?`: `boolean`; \}; \} - -Defined in: [types/openaiCompatible.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L69) diff --git a/docs/api/type-aliases/OpenAICompatSSEResult.md b/docs/api/type-aliases/OpenAICompatSSEResult.md index 99a8ada45..a31128e4b 100644 --- a/docs/api/type-aliases/OpenAICompatSSEResult.md +++ b/docs/api/type-aliases/OpenAICompatSSEResult.md @@ -8,24 +8,18 @@ > **OpenAICompatSSEResult** = `object` -Defined in: [types/openaiCompatible.ts:258](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L258) - ## Properties ### text > **text**: `string` -Defined in: [types/openaiCompatible.ts:259](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L259) - --- ### reasoning > **reasoning**: `string` -Defined in: [types/openaiCompatible.ts:261](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L261) - Accumulated reasoner-model output (`reasoning_content` / `reasoning` deltas). --- @@ -34,32 +28,24 @@ Accumulated reasoner-model output (`reasoning_content` / `reasoning` deltas). > **toolCalls**: `Map`\<`number`, \{ `id`: `string`; `name`: `string`; `argsBuffered`: `string`; \}\> -Defined in: [types/openaiCompatible.ts:262](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L262) - --- ### finishReason > **finishReason**: `"stop"` \| `"length"` \| `"tool_calls"` \| `"function_call"` \| `"content_filter"` \| `null` -Defined in: [types/openaiCompatible.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L263) - --- ### usage? > `optional` **usage?**: [`OpenAICompatUsage`](OpenAICompatUsage.md) -Defined in: [types/openaiCompatible.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L270) - --- ### id? > `optional` **id?**: `string` -Defined in: [types/openaiCompatible.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L272) - Response id from the first stream chunk that carried one. --- @@ -68,6 +54,4 @@ Response id from the first stream chunk that carried one. > `optional` **model?**: `string` -Defined in: [types/openaiCompatible.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L274) - Served model from the first stream chunk that carried one. diff --git a/docs/api/type-aliases/OpenAICompatStreamChunk.md b/docs/api/type-aliases/OpenAICompatStreamChunk.md index 564b33e18..b6433fe12 100644 --- a/docs/api/type-aliases/OpenAICompatStreamChunk.md +++ b/docs/api/type-aliases/OpenAICompatStreamChunk.md @@ -8,20 +8,14 @@ > **OpenAICompatStreamChunk** = `object` -Defined in: [types/openaiCompatible.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L282) - ## Properties ### content > **content**: `string` -Defined in: [types/openaiCompatible.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L282) - --- ### reasoning? > `optional` **reasoning?**: `string` - -Defined in: [types/openaiCompatible.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L282) diff --git a/docs/api/type-aliases/OpenAICompatStreamChunkChoice.md b/docs/api/type-aliases/OpenAICompatStreamChunkChoice.md index 87ba60f3c..eae84feb8 100644 --- a/docs/api/type-aliases/OpenAICompatStreamChunkChoice.md +++ b/docs/api/type-aliases/OpenAICompatStreamChunkChoice.md @@ -8,28 +8,20 @@ > **OpenAICompatStreamChunkChoice** = `object` -Defined in: [types/openaiCompatible.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L167) - ## Properties ### index > **index**: `number` -Defined in: [types/openaiCompatible.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L168) - --- ### delta > **delta**: [`OpenAICompatStreamDelta`](OpenAICompatStreamDelta.md) -Defined in: [types/openaiCompatible.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L169) - --- ### finish_reason > **finish_reason**: `"stop"` \| `"length"` \| `"tool_calls"` \| `"function_call"` \| `"content_filter"` \| `null` - -Defined in: [types/openaiCompatible.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L170) diff --git a/docs/api/type-aliases/OpenAICompatStreamDelta.md b/docs/api/type-aliases/OpenAICompatStreamDelta.md index 2dc7aa813..a4b01088d 100644 --- a/docs/api/type-aliases/OpenAICompatStreamDelta.md +++ b/docs/api/type-aliases/OpenAICompatStreamDelta.md @@ -8,32 +8,24 @@ > **OpenAICompatStreamDelta** = `object` -Defined in: [types/openaiCompatible.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L149) - ## Properties ### role? > `optional` **role?**: [`OpenAICompatChatRole`](OpenAICompatChatRole.md) -Defined in: [types/openaiCompatible.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L150) - --- ### content? > `optional` **content?**: `string` \| `null` -Defined in: [types/openaiCompatible.ts:151](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L151) - --- ### tool_calls? > `optional` **tool_calls?**: `object`[] -Defined in: [types/openaiCompatible.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L152) - #### index > **index**: `number` @@ -64,20 +56,14 @@ Defined in: [types/openaiCompatible.ts:152](https://github.com/juspay/neurolink/ > `optional` **refusal?**: `string` \| `null` -Defined in: [types/openaiCompatible.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L161) - --- ### reasoning_content? > `optional` **reasoning_content?**: `string` \| `null` -Defined in: [types/openaiCompatible.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L163) - --- ### reasoning? > `optional` **reasoning?**: `string` \| `null` - -Defined in: [types/openaiCompatible.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L164) diff --git a/docs/api/type-aliases/OpenAICompatStreamLifecycleListeners.md b/docs/api/type-aliases/OpenAICompatStreamLifecycleListeners.md index cb32dc360..2cfbd16a0 100644 --- a/docs/api/type-aliases/OpenAICompatStreamLifecycleListeners.md +++ b/docs/api/type-aliases/OpenAICompatStreamLifecycleListeners.md @@ -8,8 +8,6 @@ > **OpenAICompatStreamLifecycleListeners** = `object` -Defined in: [types/openaiCompatible.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L357) - Per-stream lifecycle listeners returned from an OpenAIChatCompletionsProvider subclass's `onStreamStart` hook. Every property is optional — provide only what the subclass cares about. Used by LiteLLM to wire an OTel span around @@ -21,8 +19,6 @@ the deferred analytics promises. > `optional` **onUsage?**: (`usage`) => `void` -Defined in: [types/openaiCompatible.ts:364](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L364) - Fired once the deferred usage promise resolves with the final aggregated token counts. promptTokens is the UNCACHED remainder; cacheReadTokens carries the cached portion (non-overlapping convention), and @@ -44,8 +40,6 @@ reasoningTokens is a subset of completionTokens. > `optional` **onFinish?**: (`reason`, `capturedError?`) => `void` -Defined in: [types/openaiCompatible.ts:370](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L370) - Fired once the deferred finish promise resolves. `reason` is "stop", "length", "tool-calls", "content-filter", or "error". When the loop errored, the upstream cause is passed as `capturedError`. diff --git a/docs/api/type-aliases/OpenAICompatTextContent.md b/docs/api/type-aliases/OpenAICompatTextContent.md index ba857b670..f56b9e62a 100644 --- a/docs/api/type-aliases/OpenAICompatTextContent.md +++ b/docs/api/type-aliases/OpenAICompatTextContent.md @@ -8,20 +8,14 @@ > **OpenAICompatTextContent** = `object` -Defined in: [types/openaiCompatible.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L16) - ## Properties ### type > **type**: `"text"` -Defined in: [types/openaiCompatible.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L17) - --- ### text > **text**: `string` - -Defined in: [types/openaiCompatible.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L18) diff --git a/docs/api/type-aliases/OpenAICompatToolCallWire.md b/docs/api/type-aliases/OpenAICompatToolCallWire.md index 4b511f8e1..460a56580 100644 --- a/docs/api/type-aliases/OpenAICompatToolCallWire.md +++ b/docs/api/type-aliases/OpenAICompatToolCallWire.md @@ -8,32 +8,24 @@ > **OpenAICompatToolCallWire** = `object` -Defined in: [types/openaiCompatible.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L30) - ## Properties ### id > **id**: `string` -Defined in: [types/openaiCompatible.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L31) - --- ### type > **type**: `"function"` -Defined in: [types/openaiCompatible.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L32) - --- ### function > **function**: `object` -Defined in: [types/openaiCompatible.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L33) - #### name > **name**: `string` diff --git a/docs/api/type-aliases/OpenAICompatToolChoiceWire.md b/docs/api/type-aliases/OpenAICompatToolChoiceWire.md index 3990646d8..f8a453dca 100644 --- a/docs/api/type-aliases/OpenAICompatToolChoiceWire.md +++ b/docs/api/type-aliases/OpenAICompatToolChoiceWire.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatToolChoiceWire > **OpenAICompatToolChoiceWire** = `"auto"` \| `"none"` \| `"required"` \| \{ `type`: `"function"`; `function`: \{ `name`: `string`; \}; \} - -Defined in: [types/openaiCompatible.ts:63](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L63) diff --git a/docs/api/type-aliases/OpenAICompatToolWarning.md b/docs/api/type-aliases/OpenAICompatToolWarning.md index 5d96c8ecc..b9d953535 100644 --- a/docs/api/type-aliases/OpenAICompatToolWarning.md +++ b/docs/api/type-aliases/OpenAICompatToolWarning.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatToolWarning > **OpenAICompatToolWarning** = `NonNullable`\<`Awaited`\<`ReturnType`\<[`LanguageModelV3`](LanguageModelV3.md)\[`"doGenerate"`\]\>\>\[`"warnings"`\]\>\[`number`\] - -Defined in: [types/openaiCompatible.ts:209](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L209) diff --git a/docs/api/type-aliases/OpenAICompatUsage.md b/docs/api/type-aliases/OpenAICompatUsage.md index 961fd2a17..7954a1b89 100644 --- a/docs/api/type-aliases/OpenAICompatUsage.md +++ b/docs/api/type-aliases/OpenAICompatUsage.md @@ -8,40 +8,30 @@ > **OpenAICompatUsage** = `object` -Defined in: [types/openaiCompatible.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L102) - ## Properties ### prompt_tokens? > `optional` **prompt_tokens?**: `number` -Defined in: [types/openaiCompatible.ts:103](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L103) - --- ### completion_tokens? > `optional` **completion_tokens?**: `number` -Defined in: [types/openaiCompatible.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L104) - --- ### total_tokens? > `optional` **total_tokens?**: `number` -Defined in: [types/openaiCompatible.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L105) - --- ### prompt_tokens_details? > `optional` **prompt_tokens_details?**: `object` -Defined in: [types/openaiCompatible.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L106) - #### cached_tokens? > `optional` **cached_tokens?**: `number` @@ -52,8 +42,6 @@ Defined in: [types/openaiCompatible.ts:106](https://github.com/juspay/neurolink/ > `optional` **completion_tokens_details?**: `object` -Defined in: [types/openaiCompatible.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L109) - #### reasoning_tokens? > `optional` **reasoning_tokens?**: `number` diff --git a/docs/api/type-aliases/OpenAICompatUserOrAssistantPart.md b/docs/api/type-aliases/OpenAICompatUserOrAssistantPart.md index cb4a9304e..efaa5ee8c 100644 --- a/docs/api/type-aliases/OpenAICompatUserOrAssistantPart.md +++ b/docs/api/type-aliases/OpenAICompatUserOrAssistantPart.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatUserOrAssistantPart > **OpenAICompatUserOrAssistantPart** = \{ `type`: `"text"`; `text`: `string`; \} \| \{ `type`: `"file"`; `mediaType`: `string`; `data`: `Uint8Array` \| `string` \| `URL`; `filename?`: `string`; \} - -Defined in: [types/openaiCompatible.ts:239](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L239) diff --git a/docs/api/type-aliases/OpenAICompatV3CallToolChoice.md b/docs/api/type-aliases/OpenAICompatV3CallToolChoice.md index 4401e20ce..bd52c714d 100644 --- a/docs/api/type-aliases/OpenAICompatV3CallToolChoice.md +++ b/docs/api/type-aliases/OpenAICompatV3CallToolChoice.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatV3CallToolChoice > **OpenAICompatV3CallToolChoice** = `NonNullable`\<[`LanguageModelV3CallOptions`](LanguageModelV3CallOptions.md)\[`"toolChoice"`\]\> - -Defined in: [types/openaiCompatible.ts:235](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L235) diff --git a/docs/api/type-aliases/OpenAICompatV3CallTools.md b/docs/api/type-aliases/OpenAICompatV3CallTools.md index 7a1893b7b..78301cab7 100644 --- a/docs/api/type-aliases/OpenAICompatV3CallTools.md +++ b/docs/api/type-aliases/OpenAICompatV3CallTools.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatV3CallTools > **OpenAICompatV3CallTools** = `NonNullable`\<[`LanguageModelV3CallOptions`](LanguageModelV3CallOptions.md)\[`"tools"`\]\> - -Defined in: [types/openaiCompatible.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L232) diff --git a/docs/api/type-aliases/OpenAICompatV3Content.md b/docs/api/type-aliases/OpenAICompatV3Content.md index b342cd2f8..137f370fc 100644 --- a/docs/api/type-aliases/OpenAICompatV3Content.md +++ b/docs/api/type-aliases/OpenAICompatV3Content.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatV3Content > **OpenAICompatV3Content** = `Awaited`\<`ReturnType`\<[`LanguageModelV3`](LanguageModelV3.md)\[`"doGenerate"`\]\>\>\[`"content"`\]\[`number`\] - -Defined in: [types/openaiCompatible.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L213) diff --git a/docs/api/type-aliases/OpenAICompatV3FinishReason.md b/docs/api/type-aliases/OpenAICompatV3FinishReason.md index f6e283387..dc42cfd49 100644 --- a/docs/api/type-aliases/OpenAICompatV3FinishReason.md +++ b/docs/api/type-aliases/OpenAICompatV3FinishReason.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatV3FinishReason > **OpenAICompatV3FinishReason** = `Awaited`\<`ReturnType`\<[`LanguageModelV3`](LanguageModelV3.md)\[`"doGenerate"`\]\>\>\[`"finishReason"`\] - -Defined in: [types/openaiCompatible.ts:217](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L217) diff --git a/docs/api/type-aliases/OpenAICompatV3StreamPart.md b/docs/api/type-aliases/OpenAICompatV3StreamPart.md index 950c87ffc..3a3b8fb38 100644 --- a/docs/api/type-aliases/OpenAICompatV3StreamPart.md +++ b/docs/api/type-aliases/OpenAICompatV3StreamPart.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatV3StreamPart > **OpenAICompatV3StreamPart** = `Awaited`\<`ReturnType`\<[`LanguageModelV3`](LanguageModelV3.md)\[`"doStream"`\]\>\>\[`"stream"`\] _extends_ `ReadableStream`\ ? `P` : `never` - -Defined in: [types/openaiCompatible.ts:225](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L225) diff --git a/docs/api/type-aliases/OpenAICompatV3Usage.md b/docs/api/type-aliases/OpenAICompatV3Usage.md index 609338488..9e0ac35cb 100644 --- a/docs/api/type-aliases/OpenAICompatV3Usage.md +++ b/docs/api/type-aliases/OpenAICompatV3Usage.md @@ -7,5 +7,3 @@ # Type Alias: OpenAICompatV3Usage > **OpenAICompatV3Usage** = `Awaited`\<`ReturnType`\<[`LanguageModelV3`](LanguageModelV3.md)\[`"doGenerate"`\]\>\>\[`"usage"`\] - -Defined in: [types/openaiCompatible.ts:221](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L221) diff --git a/docs/api/type-aliases/OpenAICompletionRequest.md b/docs/api/type-aliases/OpenAICompletionRequest.md index 95076c742..ff0857245 100644 --- a/docs/api/type-aliases/OpenAICompletionRequest.md +++ b/docs/api/type-aliases/OpenAICompletionRequest.md @@ -8,8 +8,6 @@ > **OpenAICompletionRequest** = `object` -Defined in: [types/proxy.ts:4010](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4010) - OpenAI Chat Completions request body. ## Properties @@ -18,96 +16,72 @@ OpenAI Chat Completions request body. > **model**: `string` -Defined in: [types/proxy.ts:4011](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4011) - --- ### messages > **messages**: [`OpenAIMessage`](OpenAIMessage.md)[] -Defined in: [types/proxy.ts:4012](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4012) - --- ### tools? > `optional` **tools?**: [`OpenAIToolDef`](OpenAIToolDef.md)[] -Defined in: [types/proxy.ts:4013](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4013) - --- ### tool_choice? > `optional` **tool_choice?**: [`OpenAIToolChoice`](OpenAIToolChoice.md) -Defined in: [types/proxy.ts:4014](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4014) - --- ### stream? > `optional` **stream?**: `boolean` -Defined in: [types/proxy.ts:4015](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4015) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/proxy.ts:4016](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4016) - --- ### top_p? > `optional` **top_p?**: `number` -Defined in: [types/proxy.ts:4017](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4017) - --- ### max_tokens? > `optional` **max_tokens?**: `number` -Defined in: [types/proxy.ts:4018](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4018) - --- ### max_completion_tokens? > `optional` **max_completion_tokens?**: `number` -Defined in: [types/proxy.ts:4019](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4019) - --- ### stop? > `optional` **stop?**: `string` \| `string`[] -Defined in: [types/proxy.ts:4020](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4020) - --- ### n? > `optional` **n?**: `number` -Defined in: [types/proxy.ts:4021](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4021) - --- ### response_format? > `optional` **response_format?**: `object` -Defined in: [types/proxy.ts:4022](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4022) - #### type > **type**: `"text"` \| `"json_object"` \| `"json_schema"` @@ -122,8 +96,6 @@ Defined in: [types/proxy.ts:4022](https://github.com/juspay/neurolink/blob/relea > `optional` **stream_options?**: `object` -Defined in: [types/proxy.ts:4026](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4026) - #### include_usage? > `optional` **include_usage?**: `boolean` diff --git a/docs/api/type-aliases/OpenAICompletionResponse.md b/docs/api/type-aliases/OpenAICompletionResponse.md index 1628c3d7f..ac6a6ba2d 100644 --- a/docs/api/type-aliases/OpenAICompletionResponse.md +++ b/docs/api/type-aliases/OpenAICompletionResponse.md @@ -8,8 +8,6 @@ > **OpenAICompletionResponse** = `object` -Defined in: [types/proxy.ts:4037](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4037) - OpenAI non-streaming response. ## Properties @@ -18,40 +16,30 @@ OpenAI non-streaming response. > **id**: `string` -Defined in: [types/proxy.ts:4038](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4038) - --- ### object > **object**: `"chat.completion"` -Defined in: [types/proxy.ts:4039](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4039) - --- ### created > **created**: `number` -Defined in: [types/proxy.ts:4040](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4040) - --- ### model > **model**: `string` -Defined in: [types/proxy.ts:4041](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4041) - --- ### choices > **choices**: `object`[] -Defined in: [types/proxy.ts:4042](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4042) - #### index > **index**: `number` @@ -81,5 +69,3 @@ Defined in: [types/proxy.ts:4042](https://github.com/juspay/neurolink/blob/relea ### usage > **usage**: [`OpenAIUsage`](OpenAIUsage.md) - -Defined in: [types/proxy.ts:4051](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4051) diff --git a/docs/api/type-aliases/OpenAIContentPart.md b/docs/api/type-aliases/OpenAIContentPart.md index ca0ddbbd5..9c4933437 100644 --- a/docs/api/type-aliases/OpenAIContentPart.md +++ b/docs/api/type-aliases/OpenAIContentPart.md @@ -7,5 +7,3 @@ # Type Alias: OpenAIContentPart > **OpenAIContentPart** = [`OpenAIContentPartText`](OpenAIContentPartText.md) \| [`OpenAIContentPartImage`](OpenAIContentPartImage.md) - -Defined in: [types/proxy.ts:3961](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3961) diff --git a/docs/api/type-aliases/OpenAIContentPartImage.md b/docs/api/type-aliases/OpenAIContentPartImage.md index 3a6d43867..297b85a7d 100644 --- a/docs/api/type-aliases/OpenAIContentPartImage.md +++ b/docs/api/type-aliases/OpenAIContentPartImage.md @@ -8,24 +8,18 @@ > **OpenAIContentPartImage** = `object` -Defined in: [types/proxy.ts:3957](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3957) - ## Properties ### type > **type**: `"image_url"` -Defined in: [types/proxy.ts:3958](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3958) - --- ### image_url > **image_url**: `object` -Defined in: [types/proxy.ts:3959](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3959) - #### url > **url**: `string` diff --git a/docs/api/type-aliases/OpenAIContentPartText.md b/docs/api/type-aliases/OpenAIContentPartText.md index 35b55f6b8..91bdeed7b 100644 --- a/docs/api/type-aliases/OpenAIContentPartText.md +++ b/docs/api/type-aliases/OpenAIContentPartText.md @@ -8,8 +8,6 @@ > **OpenAIContentPartText** = `object` -Defined in: [types/proxy.ts:3956](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3956) - OpenAI content part in a user message. ## Properties @@ -18,12 +16,8 @@ OpenAI content part in a user message. > **type**: `"text"` -Defined in: [types/proxy.ts:3956](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3956) - --- ### text > **text**: `string` - -Defined in: [types/proxy.ts:3956](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3956) diff --git a/docs/api/type-aliases/OpenAIErrorResponse.md b/docs/api/type-aliases/OpenAIErrorResponse.md index 719357711..625ad6e84 100644 --- a/docs/api/type-aliases/OpenAIErrorResponse.md +++ b/docs/api/type-aliases/OpenAIErrorResponse.md @@ -8,8 +8,6 @@ > **OpenAIErrorResponse** = `object` -Defined in: [types/proxy.ts:4078](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4078) - OpenAI error response. ## Properties @@ -18,8 +16,6 @@ OpenAI error response. > **error**: `object` -Defined in: [types/proxy.ts:4079](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4079) - #### message > **message**: `string` diff --git a/docs/api/type-aliases/OpenAIMessage.md b/docs/api/type-aliases/OpenAIMessage.md index 7525a8405..99c28283a 100644 --- a/docs/api/type-aliases/OpenAIMessage.md +++ b/docs/api/type-aliases/OpenAIMessage.md @@ -7,5 +7,3 @@ # Type Alias: OpenAIMessage > **OpenAIMessage** = [`OpenAISystemMessage`](OpenAISystemMessage.md) \| [`OpenAIUserMessage`](OpenAIUserMessage.md) \| [`OpenAIAssistantMessage`](OpenAIAssistantMessage.md) \| [`OpenAIToolMessage`](OpenAIToolMessage.md) - -Defined in: [types/proxy.ts:3979](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3979) diff --git a/docs/api/type-aliases/OpenAIRealtimeEvent.md b/docs/api/type-aliases/OpenAIRealtimeEvent.md index 426be8a65..709a95d9e 100644 --- a/docs/api/type-aliases/OpenAIRealtimeEvent.md +++ b/docs/api/type-aliases/OpenAIRealtimeEvent.md @@ -8,8 +8,6 @@ > **OpenAIRealtimeEvent** = `object` -Defined in: [types/stt.ts:676](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L676) - ## Indexable > \[`key`: `string`\]: `unknown` @@ -20,12 +18,8 @@ Defined in: [types/stt.ts:676](https://github.com/juspay/neurolink/blob/release/ > **type**: `string` -Defined in: [types/stt.ts:677](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L677) - --- ### event_id? > `optional` **event_id?**: `string` - -Defined in: [types/stt.ts:678](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L678) diff --git a/docs/api/type-aliases/OpenAISessionCreated.md b/docs/api/type-aliases/OpenAISessionCreated.md index d036e6779..3076fe895 100644 --- a/docs/api/type-aliases/OpenAISessionCreated.md +++ b/docs/api/type-aliases/OpenAISessionCreated.md @@ -8,8 +8,6 @@ > **OpenAISessionCreated** = [`OpenAIRealtimeEvent`](OpenAIRealtimeEvent.md) & `object` -Defined in: [types/stt.ts:682](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L682) - ## Type Declaration ### type diff --git a/docs/api/type-aliases/OpenAIStreamChunk.md b/docs/api/type-aliases/OpenAIStreamChunk.md index 04173d103..1876a535d 100644 --- a/docs/api/type-aliases/OpenAIStreamChunk.md +++ b/docs/api/type-aliases/OpenAIStreamChunk.md @@ -8,8 +8,6 @@ > **OpenAIStreamChunk** = `object` -Defined in: [types/proxy.ts:4055](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4055) - OpenAI streaming chunk. ## Properties @@ -18,40 +16,30 @@ OpenAI streaming chunk. > **id**: `string` -Defined in: [types/proxy.ts:4056](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4056) - --- ### object > **object**: `"chat.completion.chunk"` -Defined in: [types/proxy.ts:4057](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4057) - --- ### created > **created**: `number` -Defined in: [types/proxy.ts:4058](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4058) - --- ### model > **model**: `string` -Defined in: [types/proxy.ts:4059](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4059) - --- ### choices > **choices**: `object`[] -Defined in: [types/proxy.ts:4060](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4060) - #### index > **index**: `number` @@ -81,5 +69,3 @@ Defined in: [types/proxy.ts:4060](https://github.com/juspay/neurolink/blob/relea ### usage? > `optional` **usage?**: [`OpenAIUsage`](OpenAIUsage.md) - -Defined in: [types/proxy.ts:4074](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4074) diff --git a/docs/api/type-aliases/OpenAISystemMessage.md b/docs/api/type-aliases/OpenAISystemMessage.md index aafa2d62b..455ea6fec 100644 --- a/docs/api/type-aliases/OpenAISystemMessage.md +++ b/docs/api/type-aliases/OpenAISystemMessage.md @@ -8,8 +8,6 @@ > **OpenAISystemMessage** = `object` -Defined in: [types/proxy.ts:3964](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3964) - OpenAI message types. ## Properties @@ -18,12 +16,8 @@ OpenAI message types. > **role**: `"system"` -Defined in: [types/proxy.ts:3964](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3964) - --- ### content > **content**: `string` - -Defined in: [types/proxy.ts:3964](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3964) diff --git a/docs/api/type-aliases/OpenAITTSModel.md b/docs/api/type-aliases/OpenAITTSModel.md index b70c8b639..655ef72b1 100644 --- a/docs/api/type-aliases/OpenAITTSModel.md +++ b/docs/api/type-aliases/OpenAITTSModel.md @@ -7,5 +7,3 @@ # Type Alias: OpenAITTSModel > **OpenAITTSModel** = `"tts-1"` \| `"tts-1-hd"` - -Defined in: [types/voice.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L505) diff --git a/docs/api/type-aliases/OpenAITTSOptions.md b/docs/api/type-aliases/OpenAITTSOptions.md index cee6bef57..4760a2be7 100644 --- a/docs/api/type-aliases/OpenAITTSOptions.md +++ b/docs/api/type-aliases/OpenAITTSOptions.md @@ -8,8 +8,6 @@ > **OpenAITTSOptions** = [`TTSOptions`](TTSOptions.md) & `object` -Defined in: [types/voice.ts:522](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L522) - ## Type Declaration ### model? diff --git a/docs/api/type-aliases/OpenAIToolCall.md b/docs/api/type-aliases/OpenAIToolCall.md index 66674c9d2..d8003b78a 100644 --- a/docs/api/type-aliases/OpenAIToolCall.md +++ b/docs/api/type-aliases/OpenAIToolCall.md @@ -8,8 +8,6 @@ > **OpenAIToolCall** = `object` -Defined in: [types/proxy.ts:3986](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3986) - OpenAI tool call (in assistant messages and responses). ## Properties @@ -18,24 +16,18 @@ OpenAI tool call (in assistant messages and responses). > **id**: `string` -Defined in: [types/proxy.ts:3987](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3987) - --- ### type > **type**: `"function"` -Defined in: [types/proxy.ts:3988](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3988) - --- ### function > **function**: `object` -Defined in: [types/proxy.ts:3989](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3989) - #### name > **name**: `string` diff --git a/docs/api/type-aliases/OpenAIToolChoice.md b/docs/api/type-aliases/OpenAIToolChoice.md index b55af7b00..02f482fe4 100644 --- a/docs/api/type-aliases/OpenAIToolChoice.md +++ b/docs/api/type-aliases/OpenAIToolChoice.md @@ -8,6 +8,4 @@ > **OpenAIToolChoice** = `"auto"` \| `"required"` \| `"none"` \| \{ `type`: `"function"`; `function`: \{ `name`: `string`; \}; \} -Defined in: [types/proxy.ts:4003](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4003) - OpenAI tool_choice options. diff --git a/docs/api/type-aliases/OpenAIToolDef.md b/docs/api/type-aliases/OpenAIToolDef.md index 905cdc6c6..046c612ad 100644 --- a/docs/api/type-aliases/OpenAIToolDef.md +++ b/docs/api/type-aliases/OpenAIToolDef.md @@ -8,8 +8,6 @@ > **OpenAIToolDef** = `object` -Defined in: [types/proxy.ts:3993](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3993) - OpenAI tool definition. ## Properties @@ -18,16 +16,12 @@ OpenAI tool definition. > **type**: `"function"` -Defined in: [types/proxy.ts:3994](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3994) - --- ### function > **function**: `object` -Defined in: [types/proxy.ts:3995](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3995) - #### name > **name**: `string` diff --git a/docs/api/type-aliases/OpenAIToolMessage.md b/docs/api/type-aliases/OpenAIToolMessage.md index 5fd406ddf..bae1b7423 100644 --- a/docs/api/type-aliases/OpenAIToolMessage.md +++ b/docs/api/type-aliases/OpenAIToolMessage.md @@ -8,28 +8,20 @@ > **OpenAIToolMessage** = `object` -Defined in: [types/proxy.ts:3974](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3974) - ## Properties ### role > **role**: `"tool"` -Defined in: [types/proxy.ts:3975](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3975) - --- ### tool_call_id > **tool_call_id**: `string` -Defined in: [types/proxy.ts:3976](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3976) - --- ### content > **content**: `string` - -Defined in: [types/proxy.ts:3977](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3977) diff --git a/docs/api/type-aliases/OpenAITranscriptDelta.md b/docs/api/type-aliases/OpenAITranscriptDelta.md index 9ae17f1c4..2488e0e4c 100644 --- a/docs/api/type-aliases/OpenAITranscriptDelta.md +++ b/docs/api/type-aliases/OpenAITranscriptDelta.md @@ -8,8 +8,6 @@ > **OpenAITranscriptDelta** = [`OpenAIRealtimeEvent`](OpenAIRealtimeEvent.md) & `object` -Defined in: [types/stt.ts:714](https://github.com/juspay/neurolink/blob/release/src/lib/types/stt.ts#L714) - ## Type Declaration ### type diff --git a/docs/api/type-aliases/OpenAIUsage.md b/docs/api/type-aliases/OpenAIUsage.md index de798a5f1..7a2f9b25c 100644 --- a/docs/api/type-aliases/OpenAIUsage.md +++ b/docs/api/type-aliases/OpenAIUsage.md @@ -8,8 +8,6 @@ > **OpenAIUsage** = `object` -Defined in: [types/proxy.ts:4030](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4030) - OpenAI usage counters. ## Properties @@ -18,20 +16,14 @@ OpenAI usage counters. > **prompt_tokens**: `number` -Defined in: [types/proxy.ts:4031](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4031) - --- ### completion_tokens > **completion_tokens**: `number` -Defined in: [types/proxy.ts:4032](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4032) - --- ### total_tokens > **total_tokens**: `number` - -Defined in: [types/proxy.ts:4033](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4033) diff --git a/docs/api/type-aliases/OpenAIUserMessage.md b/docs/api/type-aliases/OpenAIUserMessage.md index 192523fff..2fa6e837a 100644 --- a/docs/api/type-aliases/OpenAIUserMessage.md +++ b/docs/api/type-aliases/OpenAIUserMessage.md @@ -8,20 +8,14 @@ > **OpenAIUserMessage** = `object` -Defined in: [types/proxy.ts:3965](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3965) - ## Properties ### role > **role**: `"user"` -Defined in: [types/proxy.ts:3966](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3966) - --- ### content > **content**: `string` \| [`OpenAIContentPart`](OpenAIContentPart.md)[] - -Defined in: [types/proxy.ts:3967](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3967) diff --git a/docs/api/type-aliases/OpenAIVoice.md b/docs/api/type-aliases/OpenAIVoice.md index e144d9348..4536b16c6 100644 --- a/docs/api/type-aliases/OpenAIVoice.md +++ b/docs/api/type-aliases/OpenAIVoice.md @@ -7,5 +7,3 @@ # Type Alias: OpenAIVoice > **OpenAIVoice** = `"alloy"` \| `"echo"` \| `"fable"` \| `"onyx"` \| `"nova"` \| `"shimmer"` - -Defined in: [types/voice.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/types/voice.ts#L497) diff --git a/docs/api/type-aliases/OpenAPIGeneratorConfig.md b/docs/api/type-aliases/OpenAPIGeneratorConfig.md index 059706bf0..9585a1677 100644 --- a/docs/api/type-aliases/OpenAPIGeneratorConfig.md +++ b/docs/api/type-aliases/OpenAPIGeneratorConfig.md @@ -8,8 +8,6 @@ > **OpenAPIGeneratorConfig** = `object` -Defined in: [types/server.ts:1361](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1361) - Configuration passed to the OpenAPI spec generator. ## Properties @@ -18,8 +16,6 @@ Configuration passed to the OpenAPI spec generator. > `optional` **info?**: `object` -Defined in: [types/server.ts:1362](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1362) - #### title? > `optional` **title?**: `string` @@ -38,8 +34,6 @@ Defined in: [types/server.ts:1362](https://github.com/juspay/neurolink/blob/rele > `optional` **servers?**: `object`[] -Defined in: [types/server.ts:1367](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1367) - #### url > **url**: `string` @@ -54,24 +48,18 @@ Defined in: [types/server.ts:1367](https://github.com/juspay/neurolink/blob/rele > `optional` **includeSecurity?**: `boolean` -Defined in: [types/server.ts:1371](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1371) - --- ### basePath? > `optional` **basePath?**: `string` -Defined in: [types/server.ts:1372](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1372) - --- ### additionalTags? > `optional` **additionalTags?**: `object`[] -Defined in: [types/server.ts:1373](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1373) - #### name > **name**: `string` @@ -86,12 +74,8 @@ Defined in: [types/server.ts:1373](https://github.com/juspay/neurolink/blob/rele > `optional` **customSchemas?**: `Record`\<`string`, [`JsonObject`](JsonObject.md)\> -Defined in: [types/server.ts:1377](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1377) - --- ### routes? > `optional` **routes?**: [`RouteDefinition`](RouteDefinition.md)[] - -Defined in: [types/server.ts:1378](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1378) diff --git a/docs/api/type-aliases/OpenAPISpec.md b/docs/api/type-aliases/OpenAPISpec.md index e76509c2f..f25175458 100644 --- a/docs/api/type-aliases/OpenAPISpec.md +++ b/docs/api/type-aliases/OpenAPISpec.md @@ -8,8 +8,6 @@ > **OpenAPISpec** = `object` -Defined in: [types/server.ts:1382](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1382) - Structured OpenAPI 3.1 specification object. ## Properties @@ -18,48 +16,36 @@ Structured OpenAPI 3.1 specification object. > **openapi**: `"3.1.0"` -Defined in: [types/server.ts:1383](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1383) - --- ### info > **info**: [`JsonObject`](JsonObject.md) -Defined in: [types/server.ts:1384](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1384) - --- ### servers > **servers**: [`JsonObject`](JsonObject.md)[] -Defined in: [types/server.ts:1385](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1385) - --- ### tags > **tags**: [`JsonObject`](JsonObject.md)[] -Defined in: [types/server.ts:1386](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1386) - --- ### paths > **paths**: `Record`\<`string`, [`JsonObject`](JsonObject.md)\> -Defined in: [types/server.ts:1387](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1387) - --- ### components > **components**: `object` -Defined in: [types/server.ts:1388](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1388) - #### schemas > **schemas**: `Record`\<`string`, [`JsonObject`](JsonObject.md)\> @@ -77,5 +63,3 @@ Defined in: [types/server.ts:1388](https://github.com/juspay/neurolink/blob/rele ### security? > `optional` **security?**: [`JsonObject`](JsonObject.md)[] - -Defined in: [types/server.ts:1393](https://github.com/juspay/neurolink/blob/release/src/lib/types/server.ts#L1393) diff --git a/docs/api/type-aliases/OpenRouterModelInfo.md b/docs/api/type-aliases/OpenRouterModelInfo.md index e82825b50..886b810d7 100644 --- a/docs/api/type-aliases/OpenRouterModelInfo.md +++ b/docs/api/type-aliases/OpenRouterModelInfo.md @@ -8,8 +8,6 @@ > **OpenRouterModelInfo** = `object` -Defined in: [types/providers.ts:2072](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2072) - OpenRouter model information from /api/v1/models endpoint ## Properties @@ -18,8 +16,6 @@ OpenRouter model information from /api/v1/models endpoint > **id**: `string` -Defined in: [types/providers.ts:2074](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2074) - Model ID in format 'provider/model-name' --- @@ -28,8 +24,6 @@ Model ID in format 'provider/model-name' > `optional` **supported_parameters?**: `string`[] -Defined in: [types/providers.ts:2076](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2076) - Supported parameters (e.g., 'tools', 'temperature') --- @@ -38,8 +32,6 @@ Supported parameters (e.g., 'tools', 'temperature') > `optional` **name?**: `string` -Defined in: [types/providers.ts:2078](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2078) - Model name --- @@ -48,8 +40,6 @@ Model name > `optional` **description?**: `string` -Defined in: [types/providers.ts:2080](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2080) - Model description --- @@ -58,8 +48,6 @@ Model description > `optional` **pricing?**: `object` -Defined in: [types/providers.ts:2082](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2082) - Pricing information #### prompt? @@ -76,6 +64,4 @@ Pricing information > `optional` **context_length?**: `number` -Defined in: [types/providers.ts:2087](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2087) - Context length diff --git a/docs/api/type-aliases/OpenRouterModelsResponse.md b/docs/api/type-aliases/OpenRouterModelsResponse.md index 5976ef4b1..4d44fc0a8 100644 --- a/docs/api/type-aliases/OpenRouterModelsResponse.md +++ b/docs/api/type-aliases/OpenRouterModelsResponse.md @@ -8,8 +8,6 @@ > **OpenRouterModelsResponse** = `object` -Defined in: [types/providers.ts:2093](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2093) - OpenRouter models API response ## Properties @@ -17,5 +15,3 @@ OpenRouter models API response ### data > **data**: [`OpenRouterModelInfo`](OpenRouterModelInfo.md)[] - -Defined in: [types/providers.ts:2094](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2094) diff --git a/docs/api/type-aliases/OpenRouterProviderCache.md b/docs/api/type-aliases/OpenRouterProviderCache.md index d0398e5cc..d28775b4d 100644 --- a/docs/api/type-aliases/OpenRouterProviderCache.md +++ b/docs/api/type-aliases/OpenRouterProviderCache.md @@ -8,8 +8,6 @@ > **OpenRouterProviderCache** = `object` -Defined in: [types/providers.ts:2100](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2100) - OpenRouter provider static cache properties (for testing/internal use) ## Properties @@ -18,28 +16,20 @@ OpenRouter provider static cache properties (for testing/internal use) > **modelsCache**: `string`[] -Defined in: [types/providers.ts:2101](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2101) - --- ### modelsCacheTime > **modelsCacheTime**: `number` -Defined in: [types/providers.ts:2102](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2102) - --- ### toolCapableModels > **toolCapableModels**: `Set`\<`string`\> -Defined in: [types/providers.ts:2103](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2103) - --- ### capabilitiesCached > **capabilitiesCached**: `boolean` - -Defined in: [types/providers.ts:2104](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2104) diff --git a/docs/api/type-aliases/OpenTelemetryConfig.md b/docs/api/type-aliases/OpenTelemetryConfig.md index 75ac8d1f9..f80b16057 100644 --- a/docs/api/type-aliases/OpenTelemetryConfig.md +++ b/docs/api/type-aliases/OpenTelemetryConfig.md @@ -8,8 +8,6 @@ > **OpenTelemetryConfig** = `object` -Defined in: [types/observability.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L175) - OpenTelemetry configuration ## Properties @@ -18,8 +16,6 @@ OpenTelemetry configuration > **enabled**: `boolean` -Defined in: [types/observability.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L177) - Whether OpenTelemetry is enabled --- @@ -28,8 +24,6 @@ Whether OpenTelemetry is enabled > `optional` **endpoint?**: `string` -Defined in: [types/observability.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L179) - OTLP endpoint URL --- @@ -38,8 +32,6 @@ OTLP endpoint URL > `optional` **serviceName?**: `string` -Defined in: [types/observability.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L181) - Service name for traces --- @@ -48,6 +40,4 @@ Service name for traces > `optional` **serviceVersion?**: `string` -Defined in: [types/observability.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L183) - Service version diff --git a/docs/api/type-aliases/OperationResult.md b/docs/api/type-aliases/OperationResult.md index 92e68ac7e..b78057d36 100644 --- a/docs/api/type-aliases/OperationResult.md +++ b/docs/api/type-aliases/OperationResult.md @@ -8,8 +8,6 @@ > **OperationResult**\<`TData`\> = [`Result`](Result.md)\<`TData`\> & `object` -Defined in: [types/aliases.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L267) - Operation result with metadata Enhanced result type with additional context diff --git a/docs/api/type-aliases/OptimizeParametersParams.md b/docs/api/type-aliases/OptimizeParametersParams.md index a5bb283ad..984a57d09 100644 --- a/docs/api/type-aliases/OptimizeParametersParams.md +++ b/docs/api/type-aliases/OptimizeParametersParams.md @@ -8,8 +8,6 @@ > **OptimizeParametersParams** = `object` -Defined in: [types/mcp.ts:2708](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2708) - Parsed input for the optimize-prompt-parameters MCP tool. ## Properties @@ -18,44 +16,32 @@ Parsed input for the optimize-prompt-parameters MCP tool. > **prompt**: `string` -Defined in: [types/mcp.ts:2709](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2709) - --- ### provider? > `optional` **provider?**: [`AiAnalysisProvider`](AiAnalysisProvider.md) -Defined in: [types/mcp.ts:2710](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2710) - --- ### targetLength? > `optional` **targetLength?**: `number` -Defined in: [types/mcp.ts:2711](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2711) - --- ### style > **style**: `"creative"` \| `"balanced"` \| `"precise"` \| `"factual"` -Defined in: [types/mcp.ts:2712](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2712) - --- ### optimizeFor > **optimizeFor**: `"speed"` \| `"quality"` \| `"cost"` \| `"tokens"` -Defined in: [types/mcp.ts:2713](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2713) - --- ### iterations > **iterations**: `number` - -Defined in: [types/mcp.ts:2714](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2714) diff --git a/docs/api/type-aliases/OptionSchema.md b/docs/api/type-aliases/OptionSchema.md index 975091d45..6dfc7511e 100644 --- a/docs/api/type-aliases/OptionSchema.md +++ b/docs/api/type-aliases/OptionSchema.md @@ -8,8 +8,6 @@ > **OptionSchema** = `object` -Defined in: [types/cli.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L37) - Defines the schema for a session variable or a generation option. ## Properties @@ -18,20 +16,14 @@ Defines the schema for a session variable or a generation option. > **type**: `"string"` \| `"boolean"` \| `"number"` -Defined in: [types/cli.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L38) - --- ### description > **description**: `string` -Defined in: [types/cli.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L39) - --- ### allowedValues? > `optional` **allowedValues?**: `string`[] - -Defined in: [types/cli.ts:40](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L40) diff --git a/docs/api/type-aliases/Optional.md b/docs/api/type-aliases/Optional.md index 91e69bbe7..bf021e901 100644 --- a/docs/api/type-aliases/Optional.md +++ b/docs/api/type-aliases/Optional.md @@ -8,8 +8,6 @@ > **Optional**\<`T`\> = `T` \| `undefined` -Defined in: [types/aliases.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L285) - Optional type alias (more explicit than T | undefined) ## Type Parameters diff --git a/docs/api/type-aliases/OptionalJsonRecord.md b/docs/api/type-aliases/OptionalJsonRecord.md index 4601581a3..0ed7406c8 100644 --- a/docs/api/type-aliases/OptionalJsonRecord.md +++ b/docs/api/type-aliases/OptionalJsonRecord.md @@ -7,5 +7,3 @@ # Type Alias: OptionalJsonRecord > **OptionalJsonRecord** = [`JsonRecord`](JsonRecord.md) \| `undefined` - -Defined in: [types/aliases.ts:101](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L101) diff --git a/docs/api/type-aliases/OptionalRecordArray.md b/docs/api/type-aliases/OptionalRecordArray.md index e56bd658c..f8f3b1be0 100644 --- a/docs/api/type-aliases/OptionalRecordArray.md +++ b/docs/api/type-aliases/OptionalRecordArray.md @@ -7,5 +7,3 @@ # Type Alias: OptionalRecordArray > **OptionalRecordArray** = [`RecordArray`](RecordArray.md) \| `undefined` - -Defined in: [types/aliases.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L178) diff --git a/docs/api/type-aliases/OptionalStandardRecord.md b/docs/api/type-aliases/OptionalStandardRecord.md index da0201529..6b4f80207 100644 --- a/docs/api/type-aliases/OptionalStandardRecord.md +++ b/docs/api/type-aliases/OptionalStandardRecord.md @@ -8,6 +8,4 @@ > **OptionalStandardRecord** = [`StandardRecord`](StandardRecord.md) \| `undefined` -Defined in: [types/aliases.ts:99](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L99) - Optional record types for flexible parameters diff --git a/docs/api/type-aliases/OptionalStringArray.md b/docs/api/type-aliases/OptionalStringArray.md index 76e2b39f5..60b0f054b 100644 --- a/docs/api/type-aliases/OptionalStringArray.md +++ b/docs/api/type-aliases/OptionalStringArray.md @@ -8,6 +8,4 @@ > **OptionalStringArray** = [`StringArray`](StringArray.md) \| `undefined` -Defined in: [types/aliases.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L177) - Optional array types diff --git a/docs/api/type-aliases/OptionalStringRecord.md b/docs/api/type-aliases/OptionalStringRecord.md index c25749889..094a88b07 100644 --- a/docs/api/type-aliases/OptionalStringRecord.md +++ b/docs/api/type-aliases/OptionalStringRecord.md @@ -7,5 +7,3 @@ # Type Alias: OptionalStringRecord > **OptionalStringRecord** = [`StringRecord`](StringRecord.md) \| `undefined` - -Defined in: [types/aliases.ts:100](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L100) diff --git a/docs/api/type-aliases/OptionalValidationSchema.md b/docs/api/type-aliases/OptionalValidationSchema.md index 2833a4c46..0b2867d9c 100644 --- a/docs/api/type-aliases/OptionalValidationSchema.md +++ b/docs/api/type-aliases/OptionalValidationSchema.md @@ -8,7 +8,5 @@ > **OptionalValidationSchema** = [`ValidationSchema`](ValidationSchema.md) \| `undefined` -Defined in: [types/aliases.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L54) - Optional validation schema type Used in optional schema parameters across the codebase diff --git a/docs/api/type-aliases/OptionsWithLifecycleMiddleware.md b/docs/api/type-aliases/OptionsWithLifecycleMiddleware.md index d50a4d2fd..372dc68f5 100644 --- a/docs/api/type-aliases/OptionsWithLifecycleMiddleware.md +++ b/docs/api/type-aliases/OptionsWithLifecycleMiddleware.md @@ -8,8 +8,6 @@ > **OptionsWithLifecycleMiddleware** = `object` -Defined in: [types/middleware.ts:382](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L382) - Structural view of the nested lifecycle config buried inside a request's middleware blob. Extracted so call sites that need to read it (e.g. `BaseProvider.wrapStreamWithLifecycleCallbacks`, @@ -22,8 +20,6 @@ three-level cast. > `optional` **middleware?**: `object` -Defined in: [types/middleware.ts:383](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L383) - #### middlewareConfig? > `optional` **middlewareConfig?**: `object` diff --git a/docs/api/type-aliases/OrchestrationMode.md b/docs/api/type-aliases/OrchestrationMode.md index b2810407b..dd506d026 100644 --- a/docs/api/type-aliases/OrchestrationMode.md +++ b/docs/api/type-aliases/OrchestrationMode.md @@ -8,6 +8,4 @@ > **OrchestrationMode** = `"autonomous"` \| `"supervised"` \| `"collaborative"` \| `"hierarchical"` -Defined in: [types/agentNetwork.ts:1465](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1465) - Orchestration mode diff --git a/docs/api/type-aliases/OrchestrationResult.md b/docs/api/type-aliases/OrchestrationResult.md index a0c7a9861..75c5af162 100644 --- a/docs/api/type-aliases/OrchestrationResult.md +++ b/docs/api/type-aliases/OrchestrationResult.md @@ -8,8 +8,6 @@ > **OrchestrationResult** = `object` -Defined in: [types/aliases.ts:387](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L387) - Tool execution result with enhanced prompt Common pattern in tool orchestration scenarios @@ -19,12 +17,8 @@ Common pattern in tool orchestration scenarios > **toolResults**: `unknown`[] -Defined in: [types/aliases.ts:388](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L388) - --- ### enhancedPrompt > **enhancedPrompt**: `string` - -Defined in: [types/aliases.ts:389](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L389) diff --git a/docs/api/type-aliases/OrchestrationState.md b/docs/api/type-aliases/OrchestrationState.md index 177939868..1a4ded367 100644 --- a/docs/api/type-aliases/OrchestrationState.md +++ b/docs/api/type-aliases/OrchestrationState.md @@ -8,8 +8,6 @@ > **OrchestrationState** = `object` -Defined in: [types/ppt.ts:1400](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1400) - Internal orchestration state ## Properties @@ -18,28 +16,20 @@ Internal orchestration state > **startTime**: `number` -Defined in: [types/ppt.ts:1401](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1401) - --- ### contentPlan > **contentPlan**: [`ContentPlan`](ContentPlan.md) \| `null` -Defined in: [types/ppt.ts:1402](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1402) - --- ### slides > **slides**: [`CompleteSlide`](CompleteSlide.md)[] \| `null` -Defined in: [types/ppt.ts:1403](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1403) - --- ### outputPath > **outputPath**: `string` \| `null` - -Defined in: [types/ppt.ts:1404](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1404) diff --git a/docs/api/type-aliases/OrchestratorConfig.md b/docs/api/type-aliases/OrchestratorConfig.md index 824a93d3f..2c08e60ac 100644 --- a/docs/api/type-aliases/OrchestratorConfig.md +++ b/docs/api/type-aliases/OrchestratorConfig.md @@ -8,8 +8,6 @@ > **OrchestratorConfig** = `object` -Defined in: [types/agentNetwork.ts:1502](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1502) - Orchestrator configuration ## Properties @@ -18,8 +16,6 @@ Orchestrator configuration > `optional` **defaultMode?**: [`OrchestrationMode`](OrchestrationMode.md) -Defined in: [types/agentNetwork.ts:1504](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1504) - Default orchestration mode --- @@ -28,8 +24,6 @@ Default orchestration mode > `optional` **maxConcurrentExecutions?**: `number` -Defined in: [types/agentNetwork.ts:1507](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1507) - Maximum concurrent network executions --- @@ -38,8 +32,6 @@ Maximum concurrent network executions > `optional` **defaultTimeout?**: `number` -Defined in: [types/agentNetwork.ts:1510](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1510) - Default execution timeout --- @@ -48,8 +40,6 @@ Default execution timeout > `optional` **enableHierarchy?**: `boolean` -Defined in: [types/agentNetwork.ts:1513](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1513) - Enable hierarchical networks --- @@ -58,8 +48,6 @@ Enable hierarchical networks > `optional` **maxHierarchyDepth?**: `number` -Defined in: [types/agentNetwork.ts:1516](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1516) - Maximum hierarchy depth --- @@ -68,8 +56,6 @@ Maximum hierarchy depth > `optional` **enableSharedMessageBus?**: `boolean` -Defined in: [types/agentNetwork.ts:1519](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1519) - Enable shared message bus --- @@ -78,8 +64,6 @@ Enable shared message bus > `optional` **resourceLimits?**: `object` -Defined in: [types/agentNetwork.ts:1522](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1522) - Resource limits #### maxNetworks? diff --git a/docs/api/type-aliases/OtelExporterConfig.md b/docs/api/type-aliases/OtelExporterConfig.md index 72c5914b6..7f728277d 100644 --- a/docs/api/type-aliases/OtelExporterConfig.md +++ b/docs/api/type-aliases/OtelExporterConfig.md @@ -8,8 +8,6 @@ > **OtelExporterConfig** = [`ExporterConfig`](ExporterConfig.md) & `object` -Defined in: [types/exporter.ts:189](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L189) - OpenTelemetry exporter configuration ## Type Declaration diff --git a/docs/api/type-aliases/OtelProtocol.md b/docs/api/type-aliases/OtelProtocol.md index ec1b63dff..e302d617c 100644 --- a/docs/api/type-aliases/OtelProtocol.md +++ b/docs/api/type-aliases/OtelProtocol.md @@ -8,6 +8,4 @@ > **OtelProtocol** = `"http"` \| `"grpc"` \| `"zipkin"` -Defined in: [types/exporter.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L184) - OpenTelemetry protocol types diff --git a/docs/api/type-aliases/OtelSpan.md b/docs/api/type-aliases/OtelSpan.md index 321beb18a..056f9fd97 100644 --- a/docs/api/type-aliases/OtelSpan.md +++ b/docs/api/type-aliases/OtelSpan.md @@ -8,8 +8,6 @@ > **OtelSpan** = `object` -Defined in: [types/span.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L267) - OpenTelemetry span format ## Properties @@ -18,64 +16,48 @@ OpenTelemetry span format > **traceId**: `string` -Defined in: [types/span.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L268) - --- ### spanId > **spanId**: `string` -Defined in: [types/span.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L269) - --- ### parentSpanId? > `optional` **parentSpanId?**: `string` -Defined in: [types/span.ts:270](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L270) - --- ### name > **name**: `string` -Defined in: [types/span.ts:271](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L271) - --- ### kind > **kind**: `number` -Defined in: [types/span.ts:272](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L272) - --- ### startTimeUnixNano > **startTimeUnixNano**: `number` -Defined in: [types/span.ts:273](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L273) - --- ### endTimeUnixNano? > `optional` **endTimeUnixNano?**: `number` -Defined in: [types/span.ts:274](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L274) - --- ### attributes > **attributes**: `object`[] -Defined in: [types/span.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L275) - #### key > **key**: `string` @@ -102,8 +84,6 @@ Defined in: [types/span.ts:275](https://github.com/juspay/neurolink/blob/release > **status**: `object` -Defined in: [types/span.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L279) - #### code > **code**: `number` @@ -118,8 +98,6 @@ Defined in: [types/span.ts:279](https://github.com/juspay/neurolink/blob/release > **events**: `object`[] -Defined in: [types/span.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/span.ts#L283) - #### name > **name**: `string` diff --git a/docs/api/type-aliases/OutgoingResponse.md b/docs/api/type-aliases/OutgoingResponse.md index 57a62d757..b83fe3f32 100644 --- a/docs/api/type-aliases/OutgoingResponse.md +++ b/docs/api/type-aliases/OutgoingResponse.md @@ -8,8 +8,6 @@ > **OutgoingResponse** = `object` -Defined in: [types/auth.ts:1307](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1307) - Minimal Express-style response object used by the auth middleware. ## Methods @@ -18,8 +16,6 @@ Minimal Express-style response object used by the auth middleware. > **status**(`code`): `OutgoingResponse` -Defined in: [types/auth.ts:1308](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1308) - #### Parameters ##### code @@ -36,8 +32,6 @@ Defined in: [types/auth.ts:1308](https://github.com/juspay/neurolink/blob/releas > **json**(`body`): `void` -Defined in: [types/auth.ts:1309](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L1309) - #### Parameters ##### body diff --git a/docs/api/type-aliases/OutlineSection.md b/docs/api/type-aliases/OutlineSection.md index de461c8ac..482fb0494 100644 --- a/docs/api/type-aliases/OutlineSection.md +++ b/docs/api/type-aliases/OutlineSection.md @@ -8,8 +8,6 @@ > **OutlineSection** = `object` -Defined in: [types/fileReference.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L42) - A section in a file outline (used for code, PDFs, spreadsheets) ## Properties @@ -18,8 +16,6 @@ A section in a file outline (used for code, PDFs, spreadsheets) > **name**: `string` -Defined in: [types/fileReference.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L44) - Section heading/name (e.g., function name, class name, sheet name) --- @@ -28,8 +24,6 @@ Section heading/name (e.g., function name, class name, sheet name) > **kind**: `string` -Defined in: [types/fileReference.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L46) - Type of section (function, class, import, sheet, page, heading) --- @@ -38,8 +32,6 @@ Type of section (function, class, import, sheet, page, heading) > **startLine**: `number` -Defined in: [types/fileReference.ts:48](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L48) - Starting line number (1-indexed) --- @@ -48,8 +40,6 @@ Starting line number (1-indexed) > **endLine**: `number` -Defined in: [types/fileReference.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L50) - Ending line number (1-indexed) --- @@ -58,8 +48,6 @@ Ending line number (1-indexed) > **depth**: `number` -Defined in: [types/fileReference.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L52) - Nesting depth (0 = top-level) --- @@ -68,6 +56,4 @@ Nesting depth (0 = top-level) > `optional` **children?**: `OutlineSection`[] -Defined in: [types/fileReference.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/fileReference.ts#L54) - Child sections (e.g., methods within a class) diff --git a/docs/api/type-aliases/OutputFormatOption.md b/docs/api/type-aliases/OutputFormatOption.md index 3d111eec4..4a2bd8d43 100644 --- a/docs/api/type-aliases/OutputFormatOption.md +++ b/docs/api/type-aliases/OutputFormatOption.md @@ -7,5 +7,3 @@ # Type Alias: OutputFormatOption > **OutputFormatOption** = `"pptx"` - -Defined in: [types/ppt.ts:42](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L42) diff --git a/docs/api/type-aliases/OutputOptions.md b/docs/api/type-aliases/OutputOptions.md index b7d6f8aa5..5bcd6205b 100644 --- a/docs/api/type-aliases/OutputOptions.md +++ b/docs/api/type-aliases/OutputOptions.md @@ -8,8 +8,6 @@ > **OutputOptions** = `object` -Defined in: [types/cli.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L483) - CLI output formatting options ## Properties @@ -18,28 +16,20 @@ CLI output formatting options > **format**: `"text"` \| `"json"` \| `"table"` \| `"yaml"` -Defined in: [types/cli.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L484) - --- ### pretty? > `optional` **pretty?**: `boolean` -Defined in: [types/cli.ts:485](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L485) - --- ### color? > `optional` **color?**: `boolean` -Defined in: [types/cli.ts:486](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L486) - --- ### compact? > `optional` **compact?**: `boolean` - -Defined in: [types/cli.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L487) diff --git a/docs/api/type-aliases/PCMEncoding.md b/docs/api/type-aliases/PCMEncoding.md index c0441c5f1..a8e60f2a5 100644 --- a/docs/api/type-aliases/PCMEncoding.md +++ b/docs/api/type-aliases/PCMEncoding.md @@ -8,7 +8,5 @@ > **PCMEncoding** = `"PCM16LE"` -Defined in: [types/stream.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L157) - Stream function options type - Primary method for streaming content Future-ready for multi-modal capabilities while maintaining text focus diff --git a/docs/api/type-aliases/PDFAPIType.md b/docs/api/type-aliases/PDFAPIType.md index fec035f4b..b18083de2 100644 --- a/docs/api/type-aliases/PDFAPIType.md +++ b/docs/api/type-aliases/PDFAPIType.md @@ -8,6 +8,4 @@ > **PDFAPIType** = `"document"` \| `"files-api"` \| `"unsupported"` -Defined in: [types/file.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L500) - PDF API types for different providers diff --git a/docs/api/type-aliases/PDFContent.md b/docs/api/type-aliases/PDFContent.md index ac0b363b0..a9f6e05cd 100644 --- a/docs/api/type-aliases/PDFContent.md +++ b/docs/api/type-aliases/PDFContent.md @@ -8,8 +8,6 @@ > **PDFContent** = `object` -Defined in: [types/multimodal.ts:95](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L95) - PDF document content type for multimodal messages ## Properties @@ -18,24 +16,18 @@ PDF document content type for multimodal messages > **type**: `"pdf"` -Defined in: [types/multimodal.ts:96](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L96) - --- ### data > **data**: `Buffer` \| `string` -Defined in: [types/multimodal.ts:97](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L97) - --- ### metadata? > `optional` **metadata?**: `object` -Defined in: [types/multimodal.ts:98](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L98) - #### filename? > `optional` **filename?**: `string` diff --git a/docs/api/type-aliases/PDFImageConversionOptions.md b/docs/api/type-aliases/PDFImageConversionOptions.md index 0b7dec373..d62f5287c 100644 --- a/docs/api/type-aliases/PDFImageConversionOptions.md +++ b/docs/api/type-aliases/PDFImageConversionOptions.md @@ -8,8 +8,6 @@ > **PDFImageConversionOptions** = `object` -Defined in: [types/file.ts:736](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L736) - Options for converting PDF pages to images. ## Properties @@ -18,8 +16,6 @@ Options for converting PDF pages to images. > `optional` **scale?**: `number` -Defined in: [types/file.ts:738](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L738) - Scale factor for image quality (1-4, default: 2) --- @@ -28,8 +24,6 @@ Scale factor for image quality (1-4, default: 2) > `optional` **maxPages?**: `number` -Defined in: [types/file.ts:740](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L740) - Maximum number of pages to convert (default: 20 from PDF_LIMITS.DEFAULT_MAX_PAGES) --- @@ -38,8 +32,6 @@ Maximum number of pages to convert (default: 20 from PDF_LIMITS.DEFAULT_MAX_PAGE > `optional` **format?**: `"png"` -Defined in: [types/file.ts:742](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L742) - Output format (default: png). Only PNG is currently implemented by PDFProcessor. --- @@ -48,8 +40,6 @@ Output format (default: png). Only PNG is currently implemented by PDFProcessor. > `optional` **maxCanvasPixels?**: `number` -Defined in: [types/file.ts:748](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L748) - Per-page pixel ceiling (#260). Any page whose width×height×scale² would exceed this is uniformly downscaled to stay under it, preventing a huge page from allocating gigabytes of canvas. Default: PDF_LIMITS.DEFAULT_MAX_CANVAS_PIXELS. @@ -60,8 +50,6 @@ page from allocating gigabytes of canvas. Default: PDF_LIMITS.DEFAULT_MAX_CANVAS > `optional` **password?**: `string` -Defined in: [types/file.ts:750](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L750) - Password for an encrypted PDF (passed to the underlying renderer) (#258). --- @@ -70,8 +58,6 @@ Password for an encrypted PDF (passed to the underlying renderer) (#258). > `optional` **onProgress?**: (`progress`) => `void` \| `Promise`\<`void`\> -Defined in: [types/file.ts:752](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L752) - Per-page progress callback invoked as each page is rendered (#302). #### Parameters diff --git a/docs/api/type-aliases/PDFImageConversionProgress.md b/docs/api/type-aliases/PDFImageConversionProgress.md index 0dcc98714..9718629d1 100644 --- a/docs/api/type-aliases/PDFImageConversionProgress.md +++ b/docs/api/type-aliases/PDFImageConversionProgress.md @@ -8,8 +8,6 @@ > **PDFImageConversionProgress** = `object` -Defined in: [types/file.ts:756](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L756) - Progress reported per page during streaming conversion (#302). ## Properties @@ -18,8 +16,6 @@ Progress reported per page during streaming conversion (#302). > **pagesConverted**: `number` -Defined in: [types/file.ts:758](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L758) - Number of pages successfully converted so far. --- @@ -28,8 +24,6 @@ Number of pages successfully converted so far. > **totalPages**: `number` -Defined in: [types/file.ts:760](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L760) - Total pages in the document (known up-front from the renderer). --- @@ -38,6 +32,4 @@ Total pages in the document (known up-front from the renderer). > **elapsedMs**: `number` -Defined in: [types/file.ts:762](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L762) - Elapsed time since conversion started, in milliseconds. diff --git a/docs/api/type-aliases/PDFImageConversionResult.md b/docs/api/type-aliases/PDFImageConversionResult.md index 173b9d468..6e32c9c76 100644 --- a/docs/api/type-aliases/PDFImageConversionResult.md +++ b/docs/api/type-aliases/PDFImageConversionResult.md @@ -8,8 +8,6 @@ > **PDFImageConversionResult** = `object` -Defined in: [types/file.ts:818](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L818) - Result of PDF to image conversion. ## Properties @@ -18,8 +16,6 @@ Result of PDF to image conversion. > **images**: `string`[] -Defined in: [types/file.ts:820](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L820) - Array of base64-encoded PNG images (one per successfully converted page) --- @@ -28,8 +24,6 @@ Array of base64-encoded PNG images (one per successfully converted page) > **pageCount**: `number` -Defined in: [types/file.ts:822](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L822) - Number of pages converted --- @@ -38,8 +32,6 @@ Number of pages converted > **conversionTimeMs**: `number` -Defined in: [types/file.ts:824](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L824) - Total conversion time in milliseconds --- @@ -48,8 +40,6 @@ Total conversion time in milliseconds > `optional` **warnings?**: `string`[] -Defined in: [types/file.ts:826](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L826) - Any warnings during conversion --- @@ -58,8 +48,6 @@ Any warnings during conversion > `optional` **errors?**: `object`[] -Defined in: [types/file.ts:828](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L828) - Per-page failures — present only when some pages failed to render (#294). #### page diff --git a/docs/api/type-aliases/PDFImagePage.md b/docs/api/type-aliases/PDFImagePage.md index c14d1626c..5bc0a8faf 100644 --- a/docs/api/type-aliases/PDFImagePage.md +++ b/docs/api/type-aliases/PDFImagePage.md @@ -8,8 +8,6 @@ > **PDFImagePage** = `object` -Defined in: [types/file.ts:766](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L766) - A single streamed page result (#302). `error` is set when that page failed. ## Properties @@ -18,8 +16,6 @@ A single streamed page result (#302). `error` is set when that page failed. > **pageIndex**: `number` -Defined in: [types/file.ts:768](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L768) - 1-based page index. --- @@ -28,8 +24,6 @@ Defined in: [types/file.ts:768](https://github.com/juspay/neurolink/blob/release > **image**: `string` -Defined in: [types/file.ts:770](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L770) - Base64-encoded PNG for the page (empty string when `error` is set). --- @@ -38,8 +32,6 @@ Base64-encoded PNG for the page (empty string when `error` is set). > **imageSizeBytes**: `number` -Defined in: [types/file.ts:772](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L772) - Byte size of the rendered PNG (0 when `error` is set). --- @@ -48,6 +40,4 @@ Byte size of the rendered PNG (0 when `error` is set). > `optional` **error?**: `string` -Defined in: [types/file.ts:774](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L774) - Populated when this page failed to render (#294). diff --git a/docs/api/type-aliases/PDFLoaderOptions.md b/docs/api/type-aliases/PDFLoaderOptions.md index d0a3ddbe1..d38a26efa 100644 --- a/docs/api/type-aliases/PDFLoaderOptions.md +++ b/docs/api/type-aliases/PDFLoaderOptions.md @@ -8,8 +8,6 @@ > **PDFLoaderOptions** = [`LoaderOptions`](LoaderOptions.md) & `object` -Defined in: [types/rag.ts:609](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L609) - PDF loader options ## Type Declaration diff --git a/docs/api/type-aliases/PDFProcessorOptions.md b/docs/api/type-aliases/PDFProcessorOptions.md index 9186dc075..2af56cc9b 100644 --- a/docs/api/type-aliases/PDFProcessorOptions.md +++ b/docs/api/type-aliases/PDFProcessorOptions.md @@ -8,8 +8,6 @@ > **PDFProcessorOptions** = `object` -Defined in: [types/file.ts:524](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L524) - PDF processor options ## Properties @@ -18,40 +16,30 @@ PDF processor options > `optional` **provider?**: `string` -Defined in: [types/file.ts:525](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L525) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/file.ts:526](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L526) - --- ### maxSizeMB? > `optional` **maxSizeMB?**: `number` -Defined in: [types/file.ts:527](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L527) - --- ### bedrockApiMode? > `optional` **bedrockApiMode?**: `"converse"` \| `"invokeModel"` -Defined in: [types/file.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L528) - --- ### enforceLimits? > `optional` **enforceLimits?**: `boolean` -Defined in: [types/file.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L533) - Whether to enforce page limits by throwing an error (default: true) Set to false to bypass limit enforcement (logs warning instead) @@ -61,6 +49,4 @@ Set to false to bypass limit enforcement (logs warning instead) > `optional` **password?**: `string` -Defined in: [types/file.ts:535](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L535) - Password for an encrypted PDF (used on the image-conversion path) (#258). diff --git a/docs/api/type-aliases/PDFProviderConfig.md b/docs/api/type-aliases/PDFProviderConfig.md index a88d5e715..9e1cc1080 100644 --- a/docs/api/type-aliases/PDFProviderConfig.md +++ b/docs/api/type-aliases/PDFProviderConfig.md @@ -8,8 +8,6 @@ > **PDFProviderConfig** = `object` -Defined in: [types/file.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L505) - PDF provider configuration ## Properties @@ -18,32 +16,24 @@ PDF provider configuration > **maxSizeMB**: `number` -Defined in: [types/file.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L506) - --- ### maxPages > **maxPages**: `number` -Defined in: [types/file.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L507) - --- ### supportsNative > **supportsNative**: `boolean` -Defined in: [types/file.ts:508](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L508) - --- ### requiresCitations > **requiresCitations**: `boolean` \| `"auto"` -Defined in: [types/file.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L517) - Whether this provider needs source citations enabled for visual PDF analysis (#349). `"auto"` = enable when the request requires visual grounding (currently Bedrock's Converse document blocks); `false` = the @@ -56,5 +46,3 @@ adapters can act on it instead of the value being dead config. ### apiType > **apiType**: [`PDFAPIType`](PDFAPIType.md) - -Defined in: [types/file.ts:518](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L518) diff --git a/docs/api/type-aliases/PDFRenderDocument.md b/docs/api/type-aliases/PDFRenderDocument.md index f159dcbef..c24b8cf92 100644 --- a/docs/api/type-aliases/PDFRenderDocument.md +++ b/docs/api/type-aliases/PDFRenderDocument.md @@ -8,8 +8,6 @@ > **PDFRenderDocument** = `object` -Defined in: [types/file.ts:782](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L782) - A PDF opened for page rendering. Rendering goes through pdf-parse so the process loads exactly one pdfjs-dist copy — a second copy fails pdfjs's API-vs-Worker version check for whichever library loads second. @@ -20,8 +18,6 @@ API-vs-Worker version check for whichever library loads second. > **length**: `number` -Defined in: [types/file.ts:784](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L784) - Total pages in the document. --- @@ -30,8 +26,6 @@ Total pages in the document. > **getPage**: (`pageNumber`) => `Promise`\<`Buffer`\> -Defined in: [types/file.ts:786](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L786) - Render a 1-based page to a PNG buffer. #### Parameters @@ -50,8 +44,6 @@ Render a 1-based page to a PNG buffer. > **destroy**: () => `Promise`\<`void`\> -Defined in: [types/file.ts:788](https://github.com/juspay/neurolink/blob/release/src/lib/types/file.ts#L788) - Release pdfjs resources held by the document. #### Returns diff --git a/docs/api/type-aliases/PKCEChallenge.md b/docs/api/type-aliases/PKCEChallenge.md index 05036ae83..f14a1d029 100644 --- a/docs/api/type-aliases/PKCEChallenge.md +++ b/docs/api/type-aliases/PKCEChallenge.md @@ -8,8 +8,6 @@ > **PKCEChallenge** = `object` -Defined in: [types/mcp.ts:1000](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1000) - PKCE (Proof Key for Code Exchange) challenge data for OAuth 2.1 authentication Used internally by OAuth client providers to generate and store PKCE parameters @@ -19,8 +17,6 @@ Used internally by OAuth client providers to generate and store PKCE parameters > **codeVerifier**: `string` -Defined in: [types/mcp.ts:1002](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1002) - Random code verifier string (43-128 characters, URL-safe) --- @@ -29,8 +25,6 @@ Random code verifier string (43-128 characters, URL-safe) > **codeChallenge**: `string` -Defined in: [types/mcp.ts:1004](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1004) - SHA-256 hash of code verifier, base64url encoded --- @@ -39,6 +33,4 @@ SHA-256 hash of code verifier, base64url encoded > **codeChallengeMethod**: `"S256"` -Defined in: [types/mcp.ts:1006](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L1006) - Challenge method - always "S256" per OAuth 2.1 specification diff --git a/docs/api/type-aliases/PKCEParams.md b/docs/api/type-aliases/PKCEParams.md index 4a2ccec40..d7f42a9a9 100644 --- a/docs/api/type-aliases/PKCEParams.md +++ b/docs/api/type-aliases/PKCEParams.md @@ -8,8 +8,6 @@ > **PKCEParams** = `object` -Defined in: [types/subscription.ts:1030](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1030) - PKCE (Proof Key for Code Exchange) parameters ## Properties @@ -18,8 +16,6 @@ PKCE (Proof Key for Code Exchange) parameters > **codeVerifier**: `string` -Defined in: [types/subscription.ts:1032](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1032) - Code verifier - random string used to generate challenge --- @@ -28,8 +24,6 @@ Code verifier - random string used to generate challenge > **codeChallenge**: `string` -Defined in: [types/subscription.ts:1034](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1034) - Code challenge - SHA-256 hash of verifier, base64url encoded --- @@ -38,6 +32,4 @@ Code challenge - SHA-256 hash of verifier, base64url encoded > **codeChallengeMethod**: `"S256"` -Defined in: [types/subscription.ts:1036](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1036) - Code challenge method - always "S256" diff --git a/docs/api/type-aliases/PPTGenerationContext.md b/docs/api/type-aliases/PPTGenerationContext.md index bdd0d44c6..e51e35c67 100644 --- a/docs/api/type-aliases/PPTGenerationContext.md +++ b/docs/api/type-aliases/PPTGenerationContext.md @@ -8,8 +8,6 @@ > **PPTGenerationContext** = `object` -Defined in: [types/ppt.ts:780](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L780) - Context extracted from GenerateOptions for PPT generation ## Properties @@ -18,8 +16,6 @@ Context extracted from GenerateOptions for PPT generation > **topic**: `string` -Defined in: [types/ppt.ts:782](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L782) - Original topic/prompt from user --- @@ -28,8 +24,6 @@ Original topic/prompt from user > **pages**: `number` -Defined in: [types/ppt.ts:784](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L784) - Number of slides requested (required) --- @@ -38,8 +32,6 @@ Number of slides requested (required) > **theme**: `string` -Defined in: [types/ppt.ts:786](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L786) - Selected theme name ("AI will decide" means AI chooses) --- @@ -48,8 +40,6 @@ Selected theme name ("AI will decide" means AI chooses) > **audience**: `string` -Defined in: [types/ppt.ts:788](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L788) - Target audience ("AI will decide" means AI chooses) --- @@ -58,8 +48,6 @@ Target audience ("AI will decide" means AI chooses) > **tone**: `string` -Defined in: [types/ppt.ts:790](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L790) - Presentation tone ("AI will decide" means AI chooses) --- @@ -68,8 +56,6 @@ Presentation tone ("AI will decide" means AI chooses) > **generateAIImages**: `boolean` -Defined in: [types/ppt.ts:792](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L792) - Whether to generate AI images (user-provided images via input.images are always used) --- @@ -78,8 +64,6 @@ Whether to generate AI images (user-provided images via input.images are always > **aspectRatio**: [`AspectRatioOption`](AspectRatioOption.md) -Defined in: [types/ppt.ts:794](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L794) - Aspect ratio --- @@ -88,8 +72,6 @@ Aspect ratio > `optional` **outputPath?**: `string` -Defined in: [types/ppt.ts:796](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L796) - Custom output path --- @@ -98,8 +80,6 @@ Custom output path > `optional` **logo?**: `Buffer` \| `string` -Defined in: [types/ppt.ts:798](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L798) - Logo data or path if provided --- @@ -108,8 +88,6 @@ Logo data or path if provided > `optional` **images?**: (`Buffer` \| `string`)[] -Defined in: [types/ppt.ts:800](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L800) - User-provided images for slides (from input.images) --- @@ -118,8 +96,6 @@ User-provided images for slides (from input.images) > `optional` **provider?**: `string` -Defined in: [types/ppt.ts:802](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L802) - Provider name (for logging) --- @@ -128,6 +104,4 @@ Provider name (for logging) > `optional` **model?**: `string` -Defined in: [types/ppt.ts:804](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L804) - Model name (for logging) diff --git a/docs/api/type-aliases/PPTGenerationResult.md b/docs/api/type-aliases/PPTGenerationResult.md index 4090f5aa6..b33e99cf7 100644 --- a/docs/api/type-aliases/PPTGenerationResult.md +++ b/docs/api/type-aliases/PPTGenerationResult.md @@ -8,8 +8,6 @@ > **PPTGenerationResult** = `object` -Defined in: [types/ppt.ts:102](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L102) - Result type for generated presentation content Returned in `GenerateResult.ppt` when presentation generation is successful. @@ -37,8 +35,6 @@ if (result.ppt) { > **filePath**: `string` -Defined in: [types/ppt.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L104) - Path to the generated PPTX file --- @@ -47,8 +43,6 @@ Path to the generated PPTX file > **totalSlides**: `number` -Defined in: [types/ppt.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L106) - Total number of slides in the presentation --- @@ -57,8 +51,6 @@ Total number of slides in the presentation > **format**: [`OutputFormatOption`](OutputFormatOption.md) -Defined in: [types/ppt.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L108) - Output format (always "pptx" currently) --- @@ -67,8 +59,6 @@ Output format (always "pptx" currently) > **provider**: `string` -Defined in: [types/ppt.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L110) - Provider used for PPT generation --- @@ -77,8 +67,6 @@ Provider used for PPT generation > **model**: `string` -Defined in: [types/ppt.ts:112](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L112) - Model used for PPT generation --- @@ -87,8 +75,6 @@ Model used for PPT generation > `optional` **metadata?**: `object` -Defined in: [types/ppt.ts:114](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L114) - Presentation metadata #### theme? diff --git a/docs/api/type-aliases/PPTModelInfo.md b/docs/api/type-aliases/PPTModelInfo.md index 21fedc670..cf85b1fcb 100644 --- a/docs/api/type-aliases/PPTModelInfo.md +++ b/docs/api/type-aliases/PPTModelInfo.md @@ -8,8 +8,6 @@ > **PPTModelInfo** = `object` -Defined in: [types/ppt.ts:1217](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1217) - Model info for prompt tier detection. Both name and provider are required. @@ -19,12 +17,8 @@ Both name and provider are required. > **name**: `string` -Defined in: [types/ppt.ts:1218](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1218) - --- ### provider > **provider**: `string` - -Defined in: [types/ppt.ts:1219](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1219) diff --git a/docs/api/type-aliases/PPTOutputOptions.md b/docs/api/type-aliases/PPTOutputOptions.md index c399e5daf..9f8bb55c8 100644 --- a/docs/api/type-aliases/PPTOutputOptions.md +++ b/docs/api/type-aliases/PPTOutputOptions.md @@ -8,8 +8,6 @@ > **PPTOutputOptions** = `object` -Defined in: [types/ppt.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L60) - PPT output configuration options ## Example @@ -30,8 +28,6 @@ const options: PPTOutputOptions = { > **pages**: `number` -Defined in: [types/ppt.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L62) - Number of slides to generate (required, range: 5-50) --- @@ -40,8 +36,6 @@ Number of slides to generate (required, range: 5-50) > `optional` **format?**: [`OutputFormatOption`](OutputFormatOption.md) -Defined in: [types/ppt.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L64) - Output format - only PPTX supported currently (default: "pptx") --- @@ -50,8 +44,6 @@ Output format - only PPTX supported currently (default: "pptx") > `optional` **theme?**: [`ThemeOption`](ThemeOption.md) -Defined in: [types/ppt.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L66) - Presentation theme/style (default: "AI will decide" - AI chooses based on topic) --- @@ -60,8 +52,6 @@ Presentation theme/style (default: "AI will decide" - AI chooses based on topic) > `optional` **audience?**: [`AudienceOption`](AudienceOption.md) -Defined in: [types/ppt.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L68) - Target audience for content customization (default: "AI will decide" - AI chooses based on topic) --- @@ -70,8 +60,6 @@ Target audience for content customization (default: "AI will decide" - AI choose > `optional` **tone?**: [`ToneOption`](ToneOption.md) -Defined in: [types/ppt.ts:70](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L70) - Presentation tone/style (default: "AI will decide" - AI chooses based on topic) --- @@ -80,8 +68,6 @@ Presentation tone/style (default: "AI will decide" - AI chooses based on topic) > `optional` **generateAIImages?**: `boolean` -Defined in: [types/ppt.ts:72](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L72) - Whether to generate AI images for slides (user-provided images via input.images are always used) --- @@ -90,8 +76,6 @@ Whether to generate AI images for slides (user-provided images via input.images > `optional` **outputPath?**: `string` -Defined in: [types/ppt.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L74) - Custom output file path (default: auto-generated in ./output/) --- @@ -100,8 +84,6 @@ Custom output file path (default: auto-generated in ./output/) > `optional` **aspectRatio?**: [`AspectRatioOption`](AspectRatioOption.md) -Defined in: [types/ppt.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L76) - Aspect ratio for slides (default: "16:9") --- @@ -110,6 +92,4 @@ Aspect ratio for slides (default: "16:9") > `optional` **logoPath?**: `Buffer` \| `string` \| [`ImageWithAltText`](ImageWithAltText.md) -Defined in: [types/ppt.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L78) - Path to logo image to include in slides diff --git a/docs/api/type-aliases/PaginatedResponse.md b/docs/api/type-aliases/PaginatedResponse.md index 06052c809..61c351fa9 100644 --- a/docs/api/type-aliases/PaginatedResponse.md +++ b/docs/api/type-aliases/PaginatedResponse.md @@ -8,8 +8,6 @@ > **PaginatedResponse**\<`TData`\> = [`ApiResponse`](ApiResponse.md)\<`TData`\> & `object` -Defined in: [types/aliases.ts:206](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L206) - Paginated response structure Common in list APIs diff --git a/docs/api/type-aliases/ParallelDetectionConfig.md b/docs/api/type-aliases/ParallelDetectionConfig.md index 606c59508..6114fcae8 100644 --- a/docs/api/type-aliases/ParallelDetectionConfig.md +++ b/docs/api/type-aliases/ParallelDetectionConfig.md @@ -8,8 +8,6 @@ > **ParallelDetectionConfig** = `object` -Defined in: [types/providers.ts:2413](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2413) - Configuration object for parallel detection test execution. ## Properties @@ -18,20 +16,14 @@ Configuration object for parallel detection test execution. > **maxConcurrentTests**: `number` -Defined in: [types/providers.ts:2414](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2414) - --- ### maxRateLimitRetries > **maxRateLimitRetries**: `number` -Defined in: [types/providers.ts:2415](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2415) - --- ### initialRateLimitCount > **initialRateLimitCount**: `number` - -Defined in: [types/providers.ts:2416](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2416) diff --git a/docs/api/type-aliases/ParsedClaudeError.md b/docs/api/type-aliases/ParsedClaudeError.md index f4b840dab..41f5046e0 100644 --- a/docs/api/type-aliases/ParsedClaudeError.md +++ b/docs/api/type-aliases/ParsedClaudeError.md @@ -8,8 +8,6 @@ > **ParsedClaudeError** = `object` -Defined in: [types/proxy.ts:3682](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3682) - Parsed shape of a Claude API error body. ## Properties @@ -18,23 +16,17 @@ Parsed shape of a Claude API error body. > `optional` **errorType?**: `string` -Defined in: [types/proxy.ts:3683](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3683) - --- ### message? > `optional` **message?**: `string` -Defined in: [types/proxy.ts:3684](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3684) - --- ### errorCode? > `optional` **errorCode?**: `string` -Defined in: [types/proxy.ts:3687](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3687) - `error.details.error_code`, e.g. "oauth_not_allowed_for_organization". Absent on payloads that carry no details object. diff --git a/docs/api/type-aliases/ParsedClaudeRequest.md b/docs/api/type-aliases/ParsedClaudeRequest.md index b00b9af4e..1289a815f 100644 --- a/docs/api/type-aliases/ParsedClaudeRequest.md +++ b/docs/api/type-aliases/ParsedClaudeRequest.md @@ -8,8 +8,6 @@ > **ParsedClaudeRequest** = `object` -Defined in: [types/proxy.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L305) - Parsed representation of a Claude request, ready for NeuroLink's generate() / stream() pipeline. @@ -19,64 +17,48 @@ generate() / stream() pipeline. > **model**: `string` -Defined in: [types/proxy.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L306) - --- ### maxTokens > **maxTokens**: `number` -Defined in: [types/proxy.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L307) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/proxy.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L308) - --- ### topP? > `optional` **topP?**: `number` -Defined in: [types/proxy.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L309) - --- ### topK? > `optional` **topK?**: `number` -Defined in: [types/proxy.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L310) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` \| `object`[] -Defined in: [types/proxy.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L311) - --- ### stream > **stream**: `boolean` -Defined in: [types/proxy.ts:312](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L312) - --- ### prompt > **prompt**: `string` -Defined in: [types/proxy.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L315) - Flat prompt string derived from the last user message. --- @@ -85,8 +67,6 @@ Flat prompt string derived from the last user message. > **images**: `string`[] -Defined in: [types/proxy.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L318) - Images extracted from content blocks (base64 data URIs or URLs). --- @@ -95,8 +75,6 @@ Images extracted from content blocks (base64 data URIs or URLs). > **conversationMessages**: `object`[] -Defined in: [types/proxy.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L324) - Full conversation history converted to NeuroLink's ChatMessage shape. Includes all messages, not just the last one. @@ -114,8 +92,6 @@ Includes all messages, not just the last one. > **tools**: `Record`\<`string`, \{ `description?`: `string`; `inputSchema`: `unknown`; `execute?`: (...`args`) => `unknown`; \}\> -Defined in: [types/proxy.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L327) - Tools translated to AI SDK-compatible shape for provider fallback. --- @@ -124,8 +100,6 @@ Tools translated to AI SDK-compatible shape for provider fallback. > `optional` **toolChoice?**: `"auto"` \| `"required"` \| `"none"` -Defined in: [types/proxy.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L342) - Tool choice mapping from Claude format. - "auto" -> let the model decide @@ -138,8 +112,6 @@ Tool choice mapping from Claude format. > `optional` **toolChoiceName?**: `string` -Defined in: [types/proxy.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L345) - When toolChoice came from `{type: "tool", name: "..."}`, the tool name. --- @@ -148,8 +120,6 @@ When toolChoice came from `{type: "tool", name: "..."}`, the tool name. > `optional` **thinkingConfig?**: `object` -Defined in: [types/proxy.ts:348](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L348) - Thinking configuration parsed from the request. #### enabled @@ -170,8 +140,6 @@ Thinking configuration parsed from the request. > `optional` **metadata?**: [`ClaudeMetadata`](ClaudeMetadata.md) -Defined in: [types/proxy.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L355) - Original request metadata (if any). --- @@ -180,6 +148,4 @@ Original request metadata (if any). > `optional` **stopSequences?**: `string`[] -Defined in: [types/proxy.ts:358](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L358) - Stop sequences from the original request. diff --git a/docs/api/type-aliases/ParsedGeminiRequest.md b/docs/api/type-aliases/ParsedGeminiRequest.md index cf00bd5c2..93da623c9 100644 --- a/docs/api/type-aliases/ParsedGeminiRequest.md +++ b/docs/api/type-aliases/ParsedGeminiRequest.md @@ -8,8 +8,6 @@ > **ParsedGeminiRequest** = `object` -Defined in: [types/proxy.ts:4098](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4098) - A Gemini `generateContent` request, reduced to what translation needs. Google's shape differs from both others in three ways that matter here: @@ -24,72 +22,54 @@ at the top level. > **model**: `string` -Defined in: [types/proxy.ts:4099](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4099) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/proxy.ts:4100](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4100) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/proxy.ts:4101](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4101) - --- ### topP? > `optional` **topP?**: `number` -Defined in: [types/proxy.ts:4102](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4102) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/proxy.ts:4103](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4103) - --- ### stream > **stream**: `boolean` -Defined in: [types/proxy.ts:4104](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4104) - --- ### prompt > **prompt**: `string` -Defined in: [types/proxy.ts:4105](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4105) - --- ### images > **images**: `string`[] -Defined in: [types/proxy.ts:4106](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4106) - --- ### conversationMessages > **conversationMessages**: `object`[] -Defined in: [types/proxy.ts:4107](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4107) - #### role > **role**: `string` @@ -104,12 +84,8 @@ Defined in: [types/proxy.ts:4107](https://github.com/juspay/neurolink/blob/relea > **tools**: `Record`\<`string`, \{ `description?`: `string`; `inputSchema`: `unknown`; `execute?`: (...`args`) => `unknown`; \}\> -Defined in: [types/proxy.ts:4108](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4108) - --- ### stopSequences? > `optional` **stopSequences?**: `string`[] - -Defined in: [types/proxy.ts:4116](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4116) diff --git a/docs/api/type-aliases/ParsedJudgeResponse.md b/docs/api/type-aliases/ParsedJudgeResponse.md index bfa462d2e..413a34bec 100644 --- a/docs/api/type-aliases/ParsedJudgeResponse.md +++ b/docs/api/type-aliases/ParsedJudgeResponse.md @@ -8,8 +8,6 @@ > **ParsedJudgeResponse** = `object` -Defined in: [types/workflow.ts:592](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L592) - Parsed judge response (internal) ## Properties @@ -18,44 +16,32 @@ Parsed judge response (internal) > **scores**: `Record`\<`string`, `number`\> -Defined in: [types/workflow.ts:593](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L593) - --- ### ranking? > `optional` **ranking?**: `string`[] -Defined in: [types/workflow.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L594) - --- ### bestResponse? > `optional` **bestResponse?**: `string` -Defined in: [types/workflow.ts:595](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L595) - --- ### reasoning? > `optional` **reasoning?**: `string` -Defined in: [types/workflow.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L596) - --- ### synthesizedResponse? > `optional` **synthesizedResponse?**: `string` -Defined in: [types/workflow.ts:597](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L597) - --- ### confidenceInJudgment? > `optional` **confidenceInJudgment?**: `number` - -Defined in: [types/workflow.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/workflow.ts#L598) diff --git a/docs/api/type-aliases/ParsedOpenAIRequest.md b/docs/api/type-aliases/ParsedOpenAIRequest.md index 5bb807907..ff2d4b664 100644 --- a/docs/api/type-aliases/ParsedOpenAIRequest.md +++ b/docs/api/type-aliases/ParsedOpenAIRequest.md @@ -8,80 +8,60 @@ > **ParsedOpenAIRequest** = `object` -Defined in: [types/proxy.ts:4119](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4119) - ## Properties ### model > **model**: `string` -Defined in: [types/proxy.ts:4120](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4120) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/proxy.ts:4121](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4121) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/proxy.ts:4122](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4122) - --- ### topP? > `optional` **topP?**: `number` -Defined in: [types/proxy.ts:4123](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4123) - --- ### systemPrompt? > `optional` **systemPrompt?**: `string` -Defined in: [types/proxy.ts:4124](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4124) - --- ### stream > **stream**: `boolean` -Defined in: [types/proxy.ts:4125](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4125) - --- ### prompt > **prompt**: `string` -Defined in: [types/proxy.ts:4126](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4126) - --- ### images > **images**: `string`[] -Defined in: [types/proxy.ts:4127](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4127) - --- ### conversationMessages > **conversationMessages**: `object`[] -Defined in: [types/proxy.ts:4128](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4128) - #### role > **role**: `string` @@ -96,40 +76,30 @@ Defined in: [types/proxy.ts:4128](https://github.com/juspay/neurolink/blob/relea > **tools**: `Record`\<`string`, \{ `description?`: `string`; `inputSchema`: `unknown`; `execute?`: (...`args`) => `unknown`; \}\> -Defined in: [types/proxy.ts:4129](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4129) - --- ### toolChoice? > `optional` **toolChoice?**: `"auto"` \| `"required"` \| `"none"` -Defined in: [types/proxy.ts:4137](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4137) - --- ### toolChoiceName? > `optional` **toolChoiceName?**: `string` -Defined in: [types/proxy.ts:4138](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4138) - --- ### stopSequences? > `optional` **stopSequences?**: `string`[] -Defined in: [types/proxy.ts:4139](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4139) - --- ### responseFormat? > `optional` **responseFormat?**: `object` -Defined in: [types/proxy.ts:4140](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4140) - #### type > **type**: `string` diff --git a/docs/api/type-aliases/ParsedProxyConfig.md b/docs/api/type-aliases/ParsedProxyConfig.md index 66b42f151..4aeee29b4 100644 --- a/docs/api/type-aliases/ParsedProxyConfig.md +++ b/docs/api/type-aliases/ParsedProxyConfig.md @@ -8,8 +8,6 @@ > **ParsedProxyConfig** = `object` -Defined in: [types/utilities.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L51) - Parsed proxy configuration ## Properties @@ -18,32 +16,24 @@ Parsed proxy configuration > **protocol**: `string` -Defined in: [types/utilities.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L52) - --- ### hostname > **hostname**: `string` -Defined in: [types/utilities.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L53) - --- ### port > **port**: `number` -Defined in: [types/utilities.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L54) - --- ### auth? > `optional` **auth?**: `object` -Defined in: [types/utilities.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L55) - #### username > **username**: `string` @@ -57,5 +47,3 @@ Defined in: [types/utilities.ts:55](https://github.com/juspay/neurolink/blob/rel ### cleanUrl > **cleanUrl**: `string` - -Defined in: [types/utilities.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L59) diff --git a/docs/api/type-aliases/ParsedSSEBuffer.md b/docs/api/type-aliases/ParsedSSEBuffer.md index f79aca092..d32e3c565 100644 --- a/docs/api/type-aliases/ParsedSSEBuffer.md +++ b/docs/api/type-aliases/ParsedSSEBuffer.md @@ -8,8 +8,6 @@ > **ParsedSSEBuffer** = `object` -Defined in: [types/proxy.ts:1437](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1437) - Complete SSE events plus the trailing partial frame. ## Properties @@ -18,12 +16,8 @@ Complete SSE events plus the trailing partial frame. > **events**: [`ParsedSSEEvent`](ParsedSSEEvent.md)[] -Defined in: [types/proxy.ts:1438](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1438) - --- ### remainder > **remainder**: `string` - -Defined in: [types/proxy.ts:1439](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1439) diff --git a/docs/api/type-aliases/ParsedSSEEvent.md b/docs/api/type-aliases/ParsedSSEEvent.md index a1107d802..cc14237cb 100644 --- a/docs/api/type-aliases/ParsedSSEEvent.md +++ b/docs/api/type-aliases/ParsedSSEEvent.md @@ -8,8 +8,6 @@ > **ParsedSSEEvent** = `object` -Defined in: [types/proxy.ts:1434](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1434) - One complete Server-Sent Event extracted from an incremental buffer. ## Properties @@ -18,12 +16,8 @@ One complete Server-Sent Event extracted from an incremental buffer. > **event**: `string` -Defined in: [types/proxy.ts:1434](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1434) - --- ### data > **data**: `string` - -Defined in: [types/proxy.ts:1434](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1434) diff --git a/docs/api/type-aliases/PathSandboxResult.md b/docs/api/type-aliases/PathSandboxResult.md index cc8f82a79..8798cd6b5 100644 --- a/docs/api/type-aliases/PathSandboxResult.md +++ b/docs/api/type-aliases/PathSandboxResult.md @@ -8,8 +8,6 @@ > **PathSandboxResult** = \{ `path`: `string`; `error?`: `undefined`; \} \| \{ `path?`: `undefined`; `error`: `string`; \} -Defined in: [types/pathSandbox.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/pathSandbox.ts#L18) - Outcome of a containment check. Exactly one branch is present, so a caller that forgets to check `error` cannot accidentally read a path that was refused. diff --git a/docs/api/type-aliases/PendingRequest.md b/docs/api/type-aliases/PendingRequest.md index 8456b151b..2bfbaea88 100644 --- a/docs/api/type-aliases/PendingRequest.md +++ b/docs/api/type-aliases/PendingRequest.md @@ -8,8 +8,6 @@ > **PendingRequest**\<`T`\> = `object` -Defined in: [types/mcp.ts:2585](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2585) - Pending request in the batcher queue. ## Type Parameters @@ -24,40 +22,30 @@ Pending request in the batcher queue. > **id**: `string` -Defined in: [types/mcp.ts:2586](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2586) - --- ### tool > **tool**: `string` -Defined in: [types/mcp.ts:2587](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2587) - --- ### args > **args**: `unknown` -Defined in: [types/mcp.ts:2588](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2588) - --- ### serverId? > `optional` **serverId?**: `string` -Defined in: [types/mcp.ts:2589](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2589) - --- ### resolve > **resolve**: (`value`) => `void` -Defined in: [types/mcp.ts:2590](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2590) - #### Parameters ##### value @@ -74,8 +62,6 @@ Defined in: [types/mcp.ts:2590](https://github.com/juspay/neurolink/blob/release > **reject**: (`error`) => `void` -Defined in: [types/mcp.ts:2591](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2591) - #### Parameters ##### error @@ -91,5 +77,3 @@ Defined in: [types/mcp.ts:2591](https://github.com/juspay/neurolink/blob/release ### addedAt > **addedAt**: `number` - -Defined in: [types/mcp.ts:2592](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2592) diff --git a/docs/api/type-aliases/PendingToolExecution.md b/docs/api/type-aliases/PendingToolExecution.md index ac7eb7c7d..5c8641a8a 100644 --- a/docs/api/type-aliases/PendingToolExecution.md +++ b/docs/api/type-aliases/PendingToolExecution.md @@ -8,8 +8,6 @@ > **PendingToolExecution** = `object` -Defined in: [types/tools.ts:568](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L568) - Pending tool execution type for Redis memory manager Temporary storage for tool execution data to avoid race conditions @@ -19,8 +17,6 @@ Temporary storage for tool execution data to avoid race conditions > **toolCalls**: `object`[] -Defined in: [types/tools.ts:569](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L569) - #### Index Signature \[`key`: `string`\]: `unknown` @@ -55,8 +51,6 @@ Defined in: [types/tools.ts:569](https://github.com/juspay/neurolink/blob/releas > **toolResults**: `object`[] -Defined in: [types/tools.ts:578](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L578) - #### Index Signature \[`key`: `string`\]: `unknown` @@ -94,5 +88,3 @@ Defined in: [types/tools.ts:578](https://github.com/juspay/neurolink/blob/releas ### timestamp > **timestamp**: `number` - -Defined in: [types/tools.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/types/tools.ts#L588) diff --git a/docs/api/type-aliases/PerformanceConfig.md b/docs/api/type-aliases/PerformanceConfig.md index 357d357c3..b204f8ee7 100644 --- a/docs/api/type-aliases/PerformanceConfig.md +++ b/docs/api/type-aliases/PerformanceConfig.md @@ -8,8 +8,6 @@ > **PerformanceConfig** = `object` -Defined in: [types/config.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L333) - Performance and caching configuration ## Properties @@ -18,36 +16,26 @@ Performance and caching configuration > `optional` **cache?**: [`CacheConfig`](CacheConfig.md) -Defined in: [types/config.ts:334](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L334) - --- ### fallback? > `optional` **fallback?**: [`FallbackConfig`](FallbackConfig.md) -Defined in: [types/config.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L335) - --- ### timeoutMs? > `optional` **timeoutMs?**: `number` -Defined in: [types/config.ts:336](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L336) - --- ### maxConcurrency? > `optional` **maxConcurrency?**: `number` -Defined in: [types/config.ts:337](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L337) - --- ### retryConfig? > `optional` **retryConfig?**: [`RetryConfig`](RetryConfig.md) - -Defined in: [types/config.ts:338](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L338) diff --git a/docs/api/type-aliases/PerformanceMetrics.md b/docs/api/type-aliases/PerformanceMetrics.md index 7988786b7..5ae003455 100644 --- a/docs/api/type-aliases/PerformanceMetrics.md +++ b/docs/api/type-aliases/PerformanceMetrics.md @@ -8,56 +8,42 @@ > **PerformanceMetrics** = `object` -Defined in: [types/analytics.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L84) - ## Properties ### startTime > **startTime**: `number` -Defined in: [types/analytics.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L85) - --- ### endTime? > `optional` **endTime?**: `number` -Defined in: [types/analytics.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L86) - --- ### duration? > `optional` **duration?**: `number` -Defined in: [types/analytics.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L87) - --- ### memoryStart > **memoryStart**: `NodeJS.MemoryUsage` -Defined in: [types/analytics.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L88) - --- ### memoryEnd? > `optional` **memoryEnd?**: `NodeJS.MemoryUsage` -Defined in: [types/analytics.ts:89](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L89) - --- ### memoryDelta? > `optional` **memoryDelta?**: `object` -Defined in: [types/analytics.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L90) - #### rss > **rss**: `number` diff --git a/docs/api/type-aliases/PerformancePriority.md b/docs/api/type-aliases/PerformancePriority.md index 7eb4f9658..bc49cd0b2 100644 --- a/docs/api/type-aliases/PerformancePriority.md +++ b/docs/api/type-aliases/PerformancePriority.md @@ -8,6 +8,4 @@ > **PerformancePriority** = `"speed"` \| `"cost"` \| `"reliability"` -Defined in: [types/evaluationProviders.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L9) - Performance optimization priority diff --git a/docs/api/type-aliases/PerformanceProfile.md b/docs/api/type-aliases/PerformanceProfile.md index 6aa780552..792a34adf 100644 --- a/docs/api/type-aliases/PerformanceProfile.md +++ b/docs/api/type-aliases/PerformanceProfile.md @@ -8,6 +8,4 @@ > **PerformanceProfile** = keyof _typeof_ `PERFORMANCE_PROFILES` -Defined in: [types/config.ts:581](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L581) - Performance profile keys from PERFORMANCE_PROFILES. diff --git a/docs/api/type-aliases/PerformanceThresholds.md b/docs/api/type-aliases/PerformanceThresholds.md index 694af2634..bb6adbeb8 100644 --- a/docs/api/type-aliases/PerformanceThresholds.md +++ b/docs/api/type-aliases/PerformanceThresholds.md @@ -8,8 +8,6 @@ > **PerformanceThresholds** = `object` -Defined in: [types/evaluationProviders.ts:65](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L65) - Performance thresholds for evaluation ## Properties @@ -18,28 +16,20 @@ Performance thresholds for evaluation > **EXCELLENT_SUCCESS_RATE**: `number` -Defined in: [types/evaluationProviders.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L66) - --- ### EXCELLENT_RESPONSE_TIME_MS > **EXCELLENT_RESPONSE_TIME_MS**: `number` -Defined in: [types/evaluationProviders.ts:67](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L67) - --- ### GOOD_SUCCESS_RATE > **GOOD_SUCCESS_RATE**: `number` -Defined in: [types/evaluationProviders.ts:68](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L68) - --- ### FAIR_SUCCESS_RATE > **FAIR_SUCCESS_RATE**: `number` - -Defined in: [types/evaluationProviders.ts:69](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L69) diff --git a/docs/api/type-aliases/PermissionDefinition.md b/docs/api/type-aliases/PermissionDefinition.md index 9c94fd778..67e877b7a 100644 --- a/docs/api/type-aliases/PermissionDefinition.md +++ b/docs/api/type-aliases/PermissionDefinition.md @@ -8,8 +8,6 @@ > **PermissionDefinition** = `object` -Defined in: [types/auth.ts:555](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L555) - Permission definition ## Properties @@ -18,8 +16,6 @@ Permission definition > **id**: `string` -Defined in: [types/auth.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L557) - Permission identifier --- @@ -28,8 +24,6 @@ Permission identifier > **name**: `string` -Defined in: [types/auth.ts:559](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L559) - Human-readable name --- @@ -38,8 +32,6 @@ Human-readable name > `optional` **description?**: `string` -Defined in: [types/auth.ts:561](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L561) - Description --- @@ -48,6 +40,4 @@ Description > `optional` **requiredRoles?**: `string`[] -Defined in: [types/auth.ts:563](https://github.com/juspay/neurolink/blob/release/src/lib/types/auth.ts#L563) - Required roles for this permission diff --git a/docs/api/type-aliases/PersistedAccountCooldown.md b/docs/api/type-aliases/PersistedAccountCooldown.md index ecded511f..a2751623c 100644 --- a/docs/api/type-aliases/PersistedAccountCooldown.md +++ b/docs/api/type-aliases/PersistedAccountCooldown.md @@ -8,8 +8,6 @@ > **PersistedAccountCooldown** = `object` -Defined in: [types/proxy.ts:2006](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2006) - Restart-safe cooldown snapshot for one account. ## Properties @@ -18,20 +16,14 @@ Restart-safe cooldown snapshot for one account. > **coolingUntil**: `number` -Defined in: [types/proxy.ts:2007](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2007) - --- ### reason > **reason**: [`AccountCoolingReason`](AccountCoolingReason.md) -Defined in: [types/proxy.ts:2008](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2008) - --- ### updatedAt > **updatedAt**: `number` - -Defined in: [types/proxy.ts:2009](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2009) diff --git a/docs/api/type-aliases/PersistedProxyStatsSnapshot.md b/docs/api/type-aliases/PersistedProxyStatsSnapshot.md index e4183043a..01dcb5fe5 100644 --- a/docs/api/type-aliases/PersistedProxyStatsSnapshot.md +++ b/docs/api/type-aliases/PersistedProxyStatsSnapshot.md @@ -8,8 +8,6 @@ > **PersistedProxyStatsSnapshot** = `object` -Defined in: [types/proxy.ts:1670](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1670) - Versioned on-disk snapshot shared by overlapping proxy workers. ## Properties @@ -18,28 +16,20 @@ Versioned on-disk snapshot shared by overlapping proxy workers. > **schemaVersion**: `1` -Defined in: [types/proxy.ts:1671](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1671) - --- ### revision > **revision**: `number` -Defined in: [types/proxy.ts:1672](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1672) - --- ### updatedAt > **updatedAt**: `number` -Defined in: [types/proxy.ts:1673](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1673) - --- ### stats > **stats**: [`ProxyStats`](ProxyStats.md) - -Defined in: [types/proxy.ts:1674](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1674) diff --git a/docs/api/type-aliases/PersistedProxyTerminalErrorSnapshot.md b/docs/api/type-aliases/PersistedProxyTerminalErrorSnapshot.md index ea32ead6f..dafd38306 100644 --- a/docs/api/type-aliases/PersistedProxyTerminalErrorSnapshot.md +++ b/docs/api/type-aliases/PersistedProxyTerminalErrorSnapshot.md @@ -8,8 +8,6 @@ > **PersistedProxyTerminalErrorSnapshot** = `object` -Defined in: [types/proxy.ts:1678](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1678) - Versioned terminal-error snapshot isolated from rolling-worker counter writes. ## Properties @@ -18,28 +16,20 @@ Versioned terminal-error snapshot isolated from rolling-worker counter writes. > **schemaVersion**: `1` -Defined in: [types/proxy.ts:1679](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1679) - --- ### revision > **revision**: `number` -Defined in: [types/proxy.ts:1680](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1680) - --- ### updatedAt > **updatedAt**: `number` -Defined in: [types/proxy.ts:1681](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1681) - --- ### journal > **journal**: [`ProxyTerminalErrorJournal`](ProxyTerminalErrorJournal.md) - -Defined in: [types/proxy.ts:1682](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1682) diff --git a/docs/api/type-aliases/PgClientLike.md b/docs/api/type-aliases/PgClientLike.md index bad9fe9d1..ff65e05f6 100644 --- a/docs/api/type-aliases/PgClientLike.md +++ b/docs/api/type-aliases/PgClientLike.md @@ -8,8 +8,6 @@ > **PgClientLike** = `object` -Defined in: [types/rag.ts:552](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L552) - Minimal structural interface a caller-supplied Postgres client must satisfy. Both `pg.Pool` (`node-postgres`) and `@electric-sql/pglite` instances already expose a compatible `query(text, values?)` method — @@ -22,8 +20,6 @@ client; `PgVectorStore` only ever calls `query()` on it. > **query**(`text`, `values?`): `Promise`\<[`PgQueryResult`](PgQueryResult.md)\<`unknown`\>\> -Defined in: [types/rag.ts:553](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L553) - #### Parameters ##### text diff --git a/docs/api/type-aliases/PgQueryResult.md b/docs/api/type-aliases/PgQueryResult.md index c16ad2dd8..eb19d53a5 100644 --- a/docs/api/type-aliases/PgQueryResult.md +++ b/docs/api/type-aliases/PgQueryResult.md @@ -8,8 +8,6 @@ > **PgQueryResult**\<`T`\> = `object` -Defined in: [types/rag.ts:541](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L541) - Minimal shape of a query result, satisfied by both `pg` and `pglite`. ## Type Parameters @@ -23,5 +21,3 @@ Minimal shape of a query result, satisfied by both `pg` and `pglite`. ### rows > **rows**: `T`[] - -Defined in: [types/rag.ts:542](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L542) diff --git a/docs/api/type-aliases/PgVectorStoreOptions.md b/docs/api/type-aliases/PgVectorStoreOptions.md index 030372e38..2ba4cbb18 100644 --- a/docs/api/type-aliases/PgVectorStoreOptions.md +++ b/docs/api/type-aliases/PgVectorStoreOptions.md @@ -8,8 +8,6 @@ > **PgVectorStoreOptions** = `object` -Defined in: [types/rag.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L557) - Construction options for `PgVectorStore`. ## Properties @@ -18,8 +16,6 @@ Construction options for `PgVectorStore`. > `optional` **tablePrefix?**: `string` -Defined in: [types/rag.ts:563](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L563) - Prefix prepended to `indexName` to derive the backing table name. Must itself be a valid, unquoted Postgres identifier. diff --git a/docs/api/type-aliases/PgVectorStoreRow.md b/docs/api/type-aliases/PgVectorStoreRow.md index e168e3d88..2dcb7e88d 100644 --- a/docs/api/type-aliases/PgVectorStoreRow.md +++ b/docs/api/type-aliases/PgVectorStoreRow.md @@ -8,8 +8,6 @@ > **PgVectorStoreRow** = `object` -Defined in: [types/rag.ts:567](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L567) - Row shape returned by `PgVectorStore`'s SELECT queries. ## Properties @@ -18,28 +16,20 @@ Row shape returned by `PgVectorStore`'s SELECT queries. > **id**: `string` -Defined in: [types/rag.ts:568](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L568) - --- ### metadata > **metadata**: `unknown` -Defined in: [types/rag.ts:569](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L569) - --- ### score > **score**: `unknown` -Defined in: [types/rag.ts:570](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L570) - --- ### embedding? > `optional` **embedding?**: `unknown` - -Defined in: [types/rag.ts:571](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L571) diff --git a/docs/api/type-aliases/PhaseToolPolicy.md b/docs/api/type-aliases/PhaseToolPolicy.md index c3dbecab3..071ea3342 100644 --- a/docs/api/type-aliases/PhaseToolPolicy.md +++ b/docs/api/type-aliases/PhaseToolPolicy.md @@ -8,20 +8,14 @@ > **PhaseToolPolicy** = `object` -Defined in: [types/autoresearch.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L127) - ## Properties ### activeTools > **activeTools**: `string`[] -Defined in: [types/autoresearch.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L128) - --- ### forcedTool? > `optional` **forcedTool?**: `string` - -Defined in: [types/autoresearch.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/autoresearch.ts#L129) diff --git a/docs/api/type-aliases/PiiDetectionConfig.md b/docs/api/type-aliases/PiiDetectionConfig.md index efcc018c9..62890b0fe 100644 --- a/docs/api/type-aliases/PiiDetectionConfig.md +++ b/docs/api/type-aliases/PiiDetectionConfig.md @@ -8,52 +8,38 @@ > **PiiDetectionConfig** = `object` -Defined in: [types/ioProcessor.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L26) - ## Properties ### enabled? > `optional` **enabled?**: `boolean` -Defined in: [types/ioProcessor.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L27) - --- ### action > **action**: `"redact"` \| `"abort"` \| `"warn"` -Defined in: [types/ioProcessor.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L28) - --- ### detectTypes? > `optional` **detectTypes?**: [`PiiType`](PiiType.md)[] -Defined in: [types/ioProcessor.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L29) - --- ### customPatterns? > `optional` **customPatterns?**: `RegExp`[] -Defined in: [types/ioProcessor.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L30) - --- ### allowList? > `optional` **allowList?**: `string`[] -Defined in: [types/ioProcessor.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L31) - --- ### redactionText? > `optional` **redactionText?**: `string` - -Defined in: [types/ioProcessor.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L32) diff --git a/docs/api/type-aliases/PiiDetectionResult.md b/docs/api/type-aliases/PiiDetectionResult.md index e04b9d2cb..9f74850f4 100644 --- a/docs/api/type-aliases/PiiDetectionResult.md +++ b/docs/api/type-aliases/PiiDetectionResult.md @@ -8,16 +8,12 @@ > **PiiDetectionResult** = `object` -Defined in: [types/ioProcessor.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L43) - ## Properties ### text > **text**: `string` -Defined in: [types/ioProcessor.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L45) - Redacted text when action=redact, otherwise the original text --- @@ -26,22 +22,16 @@ Redacted text when action=redact, otherwise the original text > **detectedPII**: [`DetectedPII`](DetectedPII.md)[] -Defined in: [types/ioProcessor.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L46) - --- ### action > **action**: `"continue"` \| `"abort"` -Defined in: [types/ioProcessor.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L47) - --- ### feedback? > `optional` **feedback?**: `string` -Defined in: [types/ioProcessor.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L49) - Human-readable message about what was found diff --git a/docs/api/type-aliases/PiiType.md b/docs/api/type-aliases/PiiType.md index 71e49fa23..4b13e808c 100644 --- a/docs/api/type-aliases/PiiType.md +++ b/docs/api/type-aliases/PiiType.md @@ -7,5 +7,3 @@ # Type Alias: PiiType > **PiiType** = `"email"` \| `"phone"` \| `"ssn"` \| `"creditCard"` \| `"ipAddress"` \| `"address"` \| `"name"` \| `"dateOfBirth"` \| `"passport"` \| `"driversLicense"` - -Defined in: [types/ioProcessor.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L14) diff --git a/docs/api/type-aliases/PineconeIndexLike.md b/docs/api/type-aliases/PineconeIndexLike.md index a37f81758..d11501f79 100644 --- a/docs/api/type-aliases/PineconeIndexLike.md +++ b/docs/api/type-aliases/PineconeIndexLike.md @@ -8,8 +8,6 @@ > **PineconeIndexLike** = `object` -Defined in: [types/vectorStorePinecone.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L47) - Minimal structural interface modeled on the `@pinecone-database/pinecone` `Index` object. Satisfied by the real SDK's `Index` without modification; callers never need to install the Pinecone SDK as a dependency of this @@ -21,8 +19,6 @@ package — they bring their own already-constructed client instance. > `optional` **namespace**(`ns`): `PineconeIndexLike` -Defined in: [types/vectorStorePinecone.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L49) - Returns a client scoped to the given namespace, if the client supports namespacing. #### Parameters @@ -41,8 +37,6 @@ Returns a client scoped to the given namespace, if the client supports namespaci > **query**(`request`): `Promise`\<[`PineconeQueryResponse`](PineconeQueryResponse.md)\> -Defined in: [types/vectorStorePinecone.ts:50](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L50) - #### Parameters ##### request @@ -59,8 +53,6 @@ Defined in: [types/vectorStorePinecone.ts:50](https://github.com/juspay/neurolin > **upsert**(`records`): `Promise`\<`unknown`\> -Defined in: [types/vectorStorePinecone.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L51) - #### Parameters ##### records @@ -77,8 +69,6 @@ Defined in: [types/vectorStorePinecone.ts:51](https://github.com/juspay/neurolin > **deleteMany**(`ids`): `Promise`\<`unknown`\> -Defined in: [types/vectorStorePinecone.ts:52](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L52) - #### Parameters ##### ids diff --git a/docs/api/type-aliases/PineconeMatch.md b/docs/api/type-aliases/PineconeMatch.md index 4ae64a3e5..fdaf57e2b 100644 --- a/docs/api/type-aliases/PineconeMatch.md +++ b/docs/api/type-aliases/PineconeMatch.md @@ -8,8 +8,6 @@ > **PineconeMatch** = `object` -Defined in: [types/vectorStorePinecone.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L13) - A single scored match as returned by Pinecone's query API. ## Properties @@ -18,28 +16,20 @@ A single scored match as returned by Pinecone's query API. > **id**: `string` -Defined in: [types/vectorStorePinecone.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L14) - --- ### score? > `optional` **score?**: `number` -Defined in: [types/vectorStorePinecone.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L15) - --- ### values? > `optional` **values?**: `number`[] -Defined in: [types/vectorStorePinecone.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L16) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/vectorStorePinecone.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L17) diff --git a/docs/api/type-aliases/PineconeQueryRequest.md b/docs/api/type-aliases/PineconeQueryRequest.md index a1262a9b0..e62ff375c 100644 --- a/docs/api/type-aliases/PineconeQueryRequest.md +++ b/docs/api/type-aliases/PineconeQueryRequest.md @@ -8,8 +8,6 @@ > **PineconeQueryRequest** = `object` -Defined in: [types/vectorStorePinecone.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L26) - Request payload accepted by `PineconeIndexLike.query()`. ## Properties @@ -18,36 +16,26 @@ Request payload accepted by `PineconeIndexLike.query()`. > **vector**: `number`[] -Defined in: [types/vectorStorePinecone.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L27) - --- ### topK > **topK**: `number` -Defined in: [types/vectorStorePinecone.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L28) - --- ### filter? > `optional` **filter?**: `Record`\<`string`, `unknown`\> -Defined in: [types/vectorStorePinecone.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L29) - --- ### includeMetadata? > `optional` **includeMetadata?**: `boolean` -Defined in: [types/vectorStorePinecone.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L30) - --- ### includeValues? > `optional` **includeValues?**: `boolean` - -Defined in: [types/vectorStorePinecone.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L31) diff --git a/docs/api/type-aliases/PineconeQueryResponse.md b/docs/api/type-aliases/PineconeQueryResponse.md index 2405e18c4..1958d9e03 100644 --- a/docs/api/type-aliases/PineconeQueryResponse.md +++ b/docs/api/type-aliases/PineconeQueryResponse.md @@ -8,8 +8,6 @@ > **PineconeQueryResponse** = `object` -Defined in: [types/vectorStorePinecone.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L21) - Shape of the response returned by `PineconeIndexLike.query()`. ## Properties @@ -17,5 +15,3 @@ Shape of the response returned by `PineconeIndexLike.query()`. ### matches? > `optional` **matches?**: [`PineconeMatch`](PineconeMatch.md)[] - -Defined in: [types/vectorStorePinecone.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L22) diff --git a/docs/api/type-aliases/PineconeUpsertRecord.md b/docs/api/type-aliases/PineconeUpsertRecord.md index 52605d1ae..b9d16504f 100644 --- a/docs/api/type-aliases/PineconeUpsertRecord.md +++ b/docs/api/type-aliases/PineconeUpsertRecord.md @@ -8,8 +8,6 @@ > **PineconeUpsertRecord** = `object` -Defined in: [types/vectorStorePinecone.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L35) - A single record accepted by `PineconeIndexLike.upsert()`. ## Properties @@ -18,20 +16,14 @@ A single record accepted by `PineconeIndexLike.upsert()`. > **id**: `string` -Defined in: [types/vectorStorePinecone.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L36) - --- ### values > **values**: `number`[] -Defined in: [types/vectorStorePinecone.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L37) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/vectorStorePinecone.ts:38](https://github.com/juspay/neurolink/blob/release/src/lib/types/vectorStorePinecone.ts#L38) diff --git a/docs/api/type-aliases/PinnedAddress.md b/docs/api/type-aliases/PinnedAddress.md index d1e70cae6..946548fde 100644 --- a/docs/api/type-aliases/PinnedAddress.md +++ b/docs/api/type-aliases/PinnedAddress.md @@ -8,8 +8,6 @@ > **PinnedAddress** = `object` -Defined in: [types/safeFetch.ts:12](https://github.com/juspay/neurolink/blob/release/src/lib/types/safeFetch.ts#L12) - One validated address the pinned connect layer is allowed to dial. Produced by `ssrfGuard.ts:validateAndResolveUrl`, consumed by `safeFetch.ts:buildPinnedAgent`. @@ -20,12 +18,8 @@ Produced by `ssrfGuard.ts:validateAndResolveUrl`, consumed by > **ip**: `string` -Defined in: [types/safeFetch.ts:13](https://github.com/juspay/neurolink/blob/release/src/lib/types/safeFetch.ts#L13) - --- ### family > **family**: `4` \| `6` - -Defined in: [types/safeFetch.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/safeFetch.ts#L14) diff --git a/docs/api/type-aliases/PipelineConfig.md b/docs/api/type-aliases/PipelineConfig.md index 6151eda8a..4a271bbd4 100644 --- a/docs/api/type-aliases/PipelineConfig.md +++ b/docs/api/type-aliases/PipelineConfig.md @@ -8,8 +8,6 @@ > **PipelineConfig** = `object` -Defined in: [types/scorer.ts:339](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L339) - Pipeline configuration for multi-scorer evaluation ## Properties @@ -18,8 +16,6 @@ Pipeline configuration for multi-scorer evaluation > `optional` **name?**: `string` -Defined in: [types/scorer.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L341) - Pipeline name --- @@ -28,8 +24,6 @@ Pipeline name > `optional` **description?**: `string` -Defined in: [types/scorer.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L343) - Pipeline description --- @@ -38,8 +32,6 @@ Pipeline description > **scorers**: `object`[] -Defined in: [types/scorer.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L345) - Scorers to run in the pipeline #### id @@ -56,8 +48,6 @@ Scorers to run in the pipeline > `optional` **aggregation?**: [`AggregationConfig`](AggregationConfig.md) -Defined in: [types/scorer.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L347) - Aggregation configuration --- @@ -66,8 +56,6 @@ Aggregation configuration > `optional` **passThreshold?**: `number` -Defined in: [types/scorer.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L349) - Overall pass threshold --- @@ -76,8 +64,6 @@ Overall pass threshold > `optional` **executionMode?**: `"parallel"` \| `"sequential"` -Defined in: [types/scorer.ts:351](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L351) - Execution mode --- @@ -86,8 +72,6 @@ Execution mode > `optional` **stopOnFailure?**: `boolean` -Defined in: [types/scorer.ts:353](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L353) - Stop on first failure --- @@ -96,8 +80,6 @@ Stop on first failure > `optional` **timeout?**: `number` -Defined in: [types/scorer.ts:355](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L355) - Timeout for entire pipeline (ms) --- @@ -106,6 +88,4 @@ Timeout for entire pipeline (ms) > `optional` **requiredScorers?**: `string`[] -Defined in: [types/scorer.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/types/scorer.ts#L357) - Required scorers that must pass diff --git a/docs/api/type-aliases/PipelineExecutionOptions.md b/docs/api/type-aliases/PipelineExecutionOptions.md index d0484dfe3..baf8b26ab 100644 --- a/docs/api/type-aliases/PipelineExecutionOptions.md +++ b/docs/api/type-aliases/PipelineExecutionOptions.md @@ -8,8 +8,6 @@ > **PipelineExecutionOptions** = `object` -Defined in: [types/evaluation.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L325) - Pipeline execution options ## Properties @@ -18,8 +16,6 @@ Pipeline execution options > `optional` **correlationId?**: `string` -Defined in: [types/evaluation.ts:327](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L327) - Correlation ID for tracing --- @@ -28,8 +24,6 @@ Correlation ID for tracing > `optional` **timeout?**: `number` -Defined in: [types/evaluation.ts:329](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L329) - Custom timeout override --- @@ -38,8 +32,6 @@ Custom timeout override > `optional` **skipScorers?**: `string`[] -Defined in: [types/evaluation.ts:331](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L331) - Skip specific scorers. Mutually exclusive with onlyScorers. --- @@ -48,8 +40,6 @@ Skip specific scorers. Mutually exclusive with onlyScorers. > `optional` **onlyScorers?**: `string`[] -Defined in: [types/evaluation.ts:333](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L333) - Only run specific scorers. Mutually exclusive with skipScorers. --- @@ -58,6 +48,4 @@ Only run specific scorers. Mutually exclusive with skipScorers. > `optional` **metadata?**: [`JsonObject`](JsonObject.md) -Defined in: [types/evaluation.ts:335](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L335) - Additional metadata to attach diff --git a/docs/api/type-aliases/PipelineMetrics.md b/docs/api/type-aliases/PipelineMetrics.md index 5d449ef33..3f70f13de 100644 --- a/docs/api/type-aliases/PipelineMetrics.md +++ b/docs/api/type-aliases/PipelineMetrics.md @@ -8,8 +8,6 @@ > **PipelineMetrics** = `object` -Defined in: [types/evaluation.ts:737](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L737) - Metrics captured per evaluation pipeline. ## Properties @@ -18,100 +16,74 @@ Metrics captured per evaluation pipeline. > **pipelineName**: `string` -Defined in: [types/evaluation.ts:738](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L738) - --- ### totalExecutions > **totalExecutions**: `number` -Defined in: [types/evaluation.ts:739](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L739) - --- ### passedCount > **passedCount**: `number` -Defined in: [types/evaluation.ts:740](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L740) - --- ### failedCount > **failedCount**: `number` -Defined in: [types/evaluation.ts:741](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L741) - --- ### totalScore > **totalScore**: `number` -Defined in: [types/evaluation.ts:742](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L742) - --- ### minScore > **minScore**: `number` -Defined in: [types/evaluation.ts:743](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L743) - --- ### maxScore > **maxScore**: `number` -Defined in: [types/evaluation.ts:744](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L744) - --- ### totalDuration > **totalDuration**: `number` -Defined in: [types/evaluation.ts:745](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L745) - --- ### averageDuration > **averageDuration**: `number` -Defined in: [types/evaluation.ts:746](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L746) - --- ### averageScore > **averageScore**: `number` -Defined in: [types/evaluation.ts:747](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L747) - --- ### passRate > **passRate**: `number` -Defined in: [types/evaluation.ts:748](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L748) - --- ### lastExecutionTime > **lastExecutionTime**: `number` -Defined in: [types/evaluation.ts:749](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L749) - --- ### scorerMetrics > **scorerMetrics**: `Map`\<`string`, [`ScorerMetrics`](ScorerMetrics.md)\> - -Defined in: [types/evaluation.ts:750](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L750) diff --git a/docs/api/type-aliases/PipelineResult.md b/docs/api/type-aliases/PipelineResult.md index a9b73a1d2..53bfef998 100644 --- a/docs/api/type-aliases/PipelineResult.md +++ b/docs/api/type-aliases/PipelineResult.md @@ -8,8 +8,6 @@ > **PipelineResult** = [`AggregatedScores`](AggregatedScores.md) & `object` -Defined in: [types/evaluation.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluation.ts#L342) - Pipeline execution result ## Type Declaration diff --git a/docs/api/type-aliases/PipelineStats.md b/docs/api/type-aliases/PipelineStats.md index c75fc4f54..461c59534 100644 --- a/docs/api/type-aliases/PipelineStats.md +++ b/docs/api/type-aliases/PipelineStats.md @@ -8,8 +8,6 @@ > **PipelineStats** = `object` -Defined in: [types/rag.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L371) - Pipeline statistics ## Properties @@ -18,44 +16,32 @@ Pipeline statistics > **totalDocuments**: `number` -Defined in: [types/rag.ts:372](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L372) - --- ### totalChunks > **totalChunks**: `number` -Defined in: [types/rag.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L373) - --- ### indexName > **indexName**: `string` -Defined in: [types/rag.ts:374](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L374) - --- ### embeddingDimension? > `optional` **embeddingDimension?**: `number` -Defined in: [types/rag.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L375) - --- ### hybridSearchEnabled > **hybridSearchEnabled**: `boolean` -Defined in: [types/rag.ts:376](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L376) - --- ### graphRAGEnabled > **graphRAGEnabled**: `boolean` - -Defined in: [types/rag.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/types/rag.ts#L377) diff --git a/docs/api/type-aliases/PositiveNumber.md b/docs/api/type-aliases/PositiveNumber.md index c773fb98c..0b6083150 100644 --- a/docs/api/type-aliases/PositiveNumber.md +++ b/docs/api/type-aliases/PositiveNumber.md @@ -8,8 +8,6 @@ > **PositiveNumber** = `number` & `object` -Defined in: [types/aliases.ts:302](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L302) - Positive number type Useful for validated numeric inputs diff --git a/docs/api/type-aliases/PostHogExporterConfig.md b/docs/api/type-aliases/PostHogExporterConfig.md index 429c3ff58..731459aef 100644 --- a/docs/api/type-aliases/PostHogExporterConfig.md +++ b/docs/api/type-aliases/PostHogExporterConfig.md @@ -8,8 +8,6 @@ > **PostHogExporterConfig** = [`ExporterConfig`](ExporterConfig.md) & `object` -Defined in: [types/exporter.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/exporter.ts#L158) - PostHog exporter configuration ## Type Declaration diff --git a/docs/api/type-aliases/PptxBackgroundOptions.md b/docs/api/type-aliases/PptxBackgroundOptions.md index 2cf67ac26..d5aabc084 100644 --- a/docs/api/type-aliases/PptxBackgroundOptions.md +++ b/docs/api/type-aliases/PptxBackgroundOptions.md @@ -8,8 +8,6 @@ > **PptxBackgroundOptions** = `object` -Defined in: [types/ppt.ts:1027](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1027) - Background options for a slide ## Properties @@ -18,12 +16,8 @@ Background options for a slide > `optional` **color?**: `string` -Defined in: [types/ppt.ts:1028](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1028) - --- ### data? > `optional` **data?**: `string` - -Defined in: [types/ppt.ts:1029](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1029) diff --git a/docs/api/type-aliases/PptxChartData.md b/docs/api/type-aliases/PptxChartData.md index f4aa03c2c..7d8961f6f 100644 --- a/docs/api/type-aliases/PptxChartData.md +++ b/docs/api/type-aliases/PptxChartData.md @@ -8,8 +8,6 @@ > **PptxChartData** = `object` -Defined in: [types/ppt.ts:1018](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1018) - Chart data structure for addChart method ## Properties @@ -18,20 +16,14 @@ Chart data structure for addChart method > **name**: `string` -Defined in: [types/ppt.ts:1019](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1019) - --- ### labels > **labels**: `string`[] -Defined in: [types/ppt.ts:1020](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1020) - --- ### values > **values**: `number`[] - -Defined in: [types/ppt.ts:1021](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1021) diff --git a/docs/api/type-aliases/PptxChartName.md b/docs/api/type-aliases/PptxChartName.md index d492217c5..ba623c3cd 100644 --- a/docs/api/type-aliases/PptxChartName.md +++ b/docs/api/type-aliases/PptxChartName.md @@ -8,6 +8,4 @@ > **PptxChartName** = `"area"` \| `"bar"` \| `"bar3D"` \| `"bubble"` \| `"doughnut"` \| `"line"` \| `"pie"` \| `"radar"` \| `"scatter"` -Defined in: [types/ppt.ts:1004](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1004) - Chart type names supported by pptxgenjs diff --git a/docs/api/type-aliases/PptxChartOptions.md b/docs/api/type-aliases/PptxChartOptions.md index 4665e7c9f..9a30dd763 100644 --- a/docs/api/type-aliases/PptxChartOptions.md +++ b/docs/api/type-aliases/PptxChartOptions.md @@ -8,8 +8,6 @@ > **PptxChartOptions** = `object` -Defined in: [types/ppt.ts:1100](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1100) - Chart options for addChart method ## Properties @@ -18,148 +16,110 @@ Chart options for addChart method > `optional` **x?**: `number` \| `string` -Defined in: [types/ppt.ts:1101](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1101) - --- ### y? > `optional` **y?**: `number` \| `string` -Defined in: [types/ppt.ts:1102](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1102) - --- ### w? > `optional` **w?**: `number` \| `string` -Defined in: [types/ppt.ts:1103](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1103) - --- ### h? > `optional` **h?**: `number` \| `string` -Defined in: [types/ppt.ts:1104](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1104) - --- ### chartColors? > `optional` **chartColors?**: `string`[] -Defined in: [types/ppt.ts:1105](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1105) - --- ### showLegend? > `optional` **showLegend?**: `boolean` -Defined in: [types/ppt.ts:1106](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1106) - --- ### legendPos? > `optional` **legendPos?**: `"b"` \| `"l"` \| `"r"` \| `"t"` \| `"tr"` -Defined in: [types/ppt.ts:1107](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1107) - --- ### showTitle? > `optional` **showTitle?**: `boolean` -Defined in: [types/ppt.ts:1108](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1108) - --- ### title? > `optional` **title?**: `string` -Defined in: [types/ppt.ts:1109](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1109) - --- ### titleColor? > `optional` **titleColor?**: `string` -Defined in: [types/ppt.ts:1110](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1110) - --- ### titleFontFace? > `optional` **titleFontFace?**: `string` -Defined in: [types/ppt.ts:1111](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1111) - --- ### titleFontSize? > `optional` **titleFontSize?**: `number` -Defined in: [types/ppt.ts:1112](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1112) - --- ### showLabel? > `optional` **showLabel?**: `boolean` -Defined in: [types/ppt.ts:1113](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1113) - --- ### showValue? > `optional` **showValue?**: `boolean` -Defined in: [types/ppt.ts:1114](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1114) - --- ### showPercent? > `optional` **showPercent?**: `boolean` -Defined in: [types/ppt.ts:1115](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1115) - --- ### barGapWidthPct? > `optional` **barGapWidthPct?**: `number` -Defined in: [types/ppt.ts:1116](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1116) - --- ### lineDataSymbol? > `optional` **lineDataSymbol?**: `"circle"` \| `"dash"` \| `"diamond"` \| `"dot"` \| `"none"` \| `"square"` \| `"triangle"` -Defined in: [types/ppt.ts:1117](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1117) - --- ### lineDataSymbolSize? > `optional` **lineDataSymbolSize?**: `number` -Defined in: [types/ppt.ts:1125](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1125) - --- ### lineSmooth? > `optional` **lineSmooth?**: `boolean` - -Defined in: [types/ppt.ts:1126](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1126) diff --git a/docs/api/type-aliases/PptxImageOptions.md b/docs/api/type-aliases/PptxImageOptions.md index 31952500d..6debc87f6 100644 --- a/docs/api/type-aliases/PptxImageOptions.md +++ b/docs/api/type-aliases/PptxImageOptions.md @@ -8,8 +8,6 @@ > **PptxImageOptions** = `object` -Defined in: [types/ppt.ts:1061](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1061) - Image options for addImage method ## Properties @@ -18,56 +16,42 @@ Image options for addImage method > `optional` **data?**: `string` -Defined in: [types/ppt.ts:1062](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1062) - --- ### path? > `optional` **path?**: `string` -Defined in: [types/ppt.ts:1063](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1063) - --- ### x? > `optional` **x?**: `number` \| `string` -Defined in: [types/ppt.ts:1064](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1064) - --- ### y? > `optional` **y?**: `number` \| `string` -Defined in: [types/ppt.ts:1065](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1065) - --- ### w? > `optional` **w?**: `number` \| `string` -Defined in: [types/ppt.ts:1066](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1066) - --- ### h? > `optional` **h?**: `number` \| `string` -Defined in: [types/ppt.ts:1067](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1067) - --- ### sizing? > `optional` **sizing?**: `object` -Defined in: [types/ppt.ts:1068](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1068) - #### type > **type**: `"contain"` \| `"cover"` \| `"crop"` @@ -94,36 +78,26 @@ Defined in: [types/ppt.ts:1068](https://github.com/juspay/neurolink/blob/release > `optional` **altText?**: `string` -Defined in: [types/ppt.ts:1075](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1075) - --- ### rotate? > `optional` **rotate?**: `number` -Defined in: [types/ppt.ts:1076](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1076) - --- ### transparency? > `optional` **transparency?**: `number` -Defined in: [types/ppt.ts:1077](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1077) - --- ### hyperlink? > `optional` **hyperlink?**: [`HyperlinkProps`](HyperlinkProps.md) -Defined in: [types/ppt.ts:1078](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1078) - --- ### shadow? > `optional` **shadow?**: [`ShadowProps`](ShadowProps.md) - -Defined in: [types/ppt.ts:1079](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1079) diff --git a/docs/api/type-aliases/PptxPresentation.md b/docs/api/type-aliases/PptxPresentation.md index d465e4708..55e2343a4 100644 --- a/docs/api/type-aliases/PptxPresentation.md +++ b/docs/api/type-aliases/PptxPresentation.md @@ -8,8 +8,6 @@ > **PptxPresentation** = `object` -Defined in: [types/ppt.ts:1183](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1183) - PptxGenJS Presentation interface Defines the methods we use from a pptxgenjs presentation instance @@ -19,8 +17,6 @@ Defines the methods we use from a pptxgenjs presentation instance > **addSlide**: () => [`PptxSlide`](PptxSlide.md) -Defined in: [types/ppt.ts:1185](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1185) - Add a new slide to the presentation #### Returns @@ -33,8 +29,6 @@ Add a new slide to the presentation > **defineLayout**: (`layout`) => `void` -Defined in: [types/ppt.ts:1187](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1187) - Define a custom layout #### Parameters @@ -63,8 +57,6 @@ Define a custom layout > **layout**: `string` -Defined in: [types/ppt.ts:1193](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1193) - Current layout name --- @@ -73,8 +65,6 @@ Current layout name > `optional` **title?**: `string` -Defined in: [types/ppt.ts:1195](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1195) - Presentation title metadata --- @@ -83,8 +73,6 @@ Presentation title metadata > `optional` **subject?**: `string` -Defined in: [types/ppt.ts:1197](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1197) - Presentation subject metadata --- @@ -93,8 +81,6 @@ Presentation subject metadata > `optional` **author?**: `string` -Defined in: [types/ppt.ts:1199](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1199) - Presentation author metadata --- @@ -103,8 +89,6 @@ Presentation author metadata > `optional` **company?**: `string` -Defined in: [types/ppt.ts:1201](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1201) - Presentation company metadata --- @@ -113,8 +97,6 @@ Presentation company metadata > **writeFile**: (`options`) => `Promise`\<`string`\> -Defined in: [types/ppt.ts:1203](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1203) - Write presentation to file #### Parameters @@ -135,8 +117,6 @@ Write presentation to file > **write**: (`options`) => `Promise`\<`unknown`\> -Defined in: [types/ppt.ts:1205](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1205) - Write presentation to buffer/stream #### Parameters diff --git a/docs/api/type-aliases/PptxRichTextProps.md b/docs/api/type-aliases/PptxRichTextProps.md index 2f5b95298..169342096 100644 --- a/docs/api/type-aliases/PptxRichTextProps.md +++ b/docs/api/type-aliases/PptxRichTextProps.md @@ -8,8 +8,6 @@ > **PptxRichTextProps** = `object` -Defined in: [types/ppt.ts:980](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L980) - Text props that supports both plain string and rich text runs pptxgenjs accepts both formats for the text property @@ -19,12 +17,8 @@ pptxgenjs accepts both formats for the text property > **text**: `string` \| [`PptxTextRun`](PptxTextRun.md)[] -Defined in: [types/ppt.ts:981](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L981) - --- ### options? > `optional` **options?**: [`PptxTextProps`](PptxTextProps.md)\[`"options"`\] - -Defined in: [types/ppt.ts:982](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L982) diff --git a/docs/api/type-aliases/PptxShapeOptions.md b/docs/api/type-aliases/PptxShapeOptions.md index e0f0221a3..cd169605c 100644 --- a/docs/api/type-aliases/PptxShapeOptions.md +++ b/docs/api/type-aliases/PptxShapeOptions.md @@ -8,8 +8,6 @@ > **PptxShapeOptions** = `object` -Defined in: [types/ppt.ts:1085](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1085) - Shape options for addShape method ## Properties @@ -18,40 +16,30 @@ Shape options for addShape method > `optional` **x?**: `number` \| `string` -Defined in: [types/ppt.ts:1086](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1086) - --- ### y? > `optional` **y?**: `number` \| `string` -Defined in: [types/ppt.ts:1087](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1087) - --- ### w? > `optional` **w?**: `number` \| `string` -Defined in: [types/ppt.ts:1088](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1088) - --- ### h? > `optional` **h?**: `number` \| `string` -Defined in: [types/ppt.ts:1089](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1089) - --- ### fill? > `optional` **fill?**: `object` -Defined in: [types/ppt.ts:1090](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1090) - #### color > **color**: `string` @@ -66,8 +54,6 @@ Defined in: [types/ppt.ts:1090](https://github.com/juspay/neurolink/blob/release > `optional` **line?**: `object` -Defined in: [types/ppt.ts:1091](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1091) - #### color? > `optional` **color?**: `string` @@ -86,20 +72,14 @@ Defined in: [types/ppt.ts:1091](https://github.com/juspay/neurolink/blob/release > `optional` **rectRadius?**: `number` -Defined in: [types/ppt.ts:1092](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1092) - --- ### rotate? > `optional` **rotate?**: `number` -Defined in: [types/ppt.ts:1093](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1093) - --- ### shadow? > `optional` **shadow?**: [`ShadowProps`](ShadowProps.md) - -Defined in: [types/ppt.ts:1094](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1094) diff --git a/docs/api/type-aliases/PptxSlide.md b/docs/api/type-aliases/PptxSlide.md index 759706401..d70177c45 100644 --- a/docs/api/type-aliases/PptxSlide.md +++ b/docs/api/type-aliases/PptxSlide.md @@ -8,8 +8,6 @@ > **PptxSlide** = `object` -Defined in: [types/ppt.ts:1155](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1155) - PptxGenJS Slide interface Defines the methods we use from a pptxgenjs slide @@ -19,8 +17,6 @@ Defines the methods we use from a pptxgenjs slide > `optional` **background?**: [`PptxBackgroundOptions`](PptxBackgroundOptions.md) -Defined in: [types/ppt.ts:1157](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1157) - Slide background --- @@ -29,8 +25,6 @@ Slide background > **addText**: (`text`, `options?`) => `PptxSlide` -Defined in: [types/ppt.ts:1159](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1159) - Add text to the slide - supports plain text, text props array, or rich text props array #### Parameters @@ -53,8 +47,6 @@ Add text to the slide - supports plain text, text props array, or rich text prop > **addImage**: (`options`) => `PptxSlide` -Defined in: [types/ppt.ts:1164](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1164) - Add an image to the slide #### Parameters @@ -73,8 +65,6 @@ Add an image to the slide > **addShape**: (`shapeName`, `options?`) => `PptxSlide` -Defined in: [types/ppt.ts:1166](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1166) - Add a shape to the slide #### Parameters @@ -97,8 +87,6 @@ Add a shape to the slide > **addChart**: (`chartType`, `data`, `options?`) => `PptxSlide` -Defined in: [types/ppt.ts:1168](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1168) - Add a chart to the slide #### Parameters @@ -125,8 +113,6 @@ Add a chart to the slide > **addTable**: (`rows`, `options?`) => `PptxSlide` -Defined in: [types/ppt.ts:1174](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1174) - Add a table to the slide #### Parameters @@ -149,8 +135,6 @@ Add a table to the slide > **addNotes**: (`notes`) => `PptxSlide` -Defined in: [types/ppt.ts:1176](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1176) - Add speaker notes to the slide #### Parameters diff --git a/docs/api/type-aliases/PptxTableOptions.md b/docs/api/type-aliases/PptxTableOptions.md index 42fa123e8..cfee9a206 100644 --- a/docs/api/type-aliases/PptxTableOptions.md +++ b/docs/api/type-aliases/PptxTableOptions.md @@ -8,8 +8,6 @@ > **PptxTableOptions** = `object` -Defined in: [types/ppt.ts:1132](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1132) - Table options for addTable method ## Properties @@ -18,80 +16,60 @@ Table options for addTable method > `optional` **x?**: `number` \| `string` -Defined in: [types/ppt.ts:1133](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1133) - --- ### y? > `optional` **y?**: `number` \| `string` -Defined in: [types/ppt.ts:1134](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1134) - --- ### w? > `optional` **w?**: `number` \| `string` -Defined in: [types/ppt.ts:1135](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1135) - --- ### h? > `optional` **h?**: `number` -Defined in: [types/ppt.ts:1136](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1136) - --- ### colW? > `optional` **colW?**: `number` \| `number`[] -Defined in: [types/ppt.ts:1137](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1137) - --- ### rowH? > `optional` **rowH?**: `number` \| `number`[] -Defined in: [types/ppt.ts:1138](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1138) - --- ### fontSize? > `optional` **fontSize?**: `number` -Defined in: [types/ppt.ts:1139](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1139) - --- ### fontFace? > `optional` **fontFace?**: `string` -Defined in: [types/ppt.ts:1140](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1140) - --- ### color? > `optional` **color?**: `string` -Defined in: [types/ppt.ts:1141](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1141) - --- ### fill? > `optional` **fill?**: `object` -Defined in: [types/ppt.ts:1142](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1142) - #### color > **color**: `string` @@ -102,44 +80,32 @@ Defined in: [types/ppt.ts:1142](https://github.com/juspay/neurolink/blob/release > `optional` **border?**: [`TableBorderOptions`](TableBorderOptions.md) \| [`TableBorderOptions`](TableBorderOptions.md)[] -Defined in: [types/ppt.ts:1143](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1143) - --- ### margin? > `optional` **margin?**: `number` \| \[`number`, `number`, `number`, `number`\] -Defined in: [types/ppt.ts:1144](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1144) - --- ### align? > `optional` **align?**: `"left"` \| `"center"` \| `"right"` -Defined in: [types/ppt.ts:1145](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1145) - --- ### valign? > `optional` **valign?**: `"top"` \| `"middle"` \| `"bottom"` -Defined in: [types/ppt.ts:1146](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1146) - --- ### autoPage? > `optional` **autoPage?**: `boolean` -Defined in: [types/ppt.ts:1147](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1147) - --- ### autoPageRepeatHeader? > `optional` **autoPageRepeatHeader?**: `boolean` - -Defined in: [types/ppt.ts:1148](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1148) diff --git a/docs/api/type-aliases/PptxTableRow.md b/docs/api/type-aliases/PptxTableRow.md index 944ddea23..a789fafd0 100644 --- a/docs/api/type-aliases/PptxTableRow.md +++ b/docs/api/type-aliases/PptxTableRow.md @@ -8,8 +8,6 @@ > **PptxTableRow** = `object`[] -Defined in: [types/ppt.ts:988](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L988) - Table row for addTable method ## Type Declaration diff --git a/docs/api/type-aliases/PptxTextOptions.md b/docs/api/type-aliases/PptxTextOptions.md index eb4a1a048..2ef6ef27e 100644 --- a/docs/api/type-aliases/PptxTextOptions.md +++ b/docs/api/type-aliases/PptxTextOptions.md @@ -8,8 +8,6 @@ > **PptxTextOptions** = `object` -Defined in: [types/ppt.ts:1035](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1035) - Text options for addText method ## Properties @@ -18,150 +16,112 @@ Text options for addText method > `optional` **x?**: `number` \| `string` -Defined in: [types/ppt.ts:1036](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1036) - --- ### y? > `optional` **y?**: `number` \| `string` -Defined in: [types/ppt.ts:1037](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1037) - --- ### w? > `optional` **w?**: `number` \| `string` -Defined in: [types/ppt.ts:1038](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1038) - --- ### h? > `optional` **h?**: `number` \| `string` -Defined in: [types/ppt.ts:1039](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1039) - --- ### fontSize? > `optional` **fontSize?**: `number` -Defined in: [types/ppt.ts:1040](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1040) - --- ### fontFace? > `optional` **fontFace?**: `string` -Defined in: [types/ppt.ts:1041](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1041) - --- ### color? > `optional` **color?**: `string` -Defined in: [types/ppt.ts:1042](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1042) - --- ### bold? > `optional` **bold?**: `boolean` -Defined in: [types/ppt.ts:1043](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1043) - --- ### italic? > `optional` **italic?**: `boolean` -Defined in: [types/ppt.ts:1044](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1044) - --- ### align? > `optional` **align?**: `"left"` \| `"center"` \| `"right"` -Defined in: [types/ppt.ts:1045](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1045) - --- ### valign? > `optional` **valign?**: `"top"` \| `"middle"` \| `"bottom"` -Defined in: [types/ppt.ts:1046](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1046) - --- ### rotate? > `optional` **rotate?**: `number` -Defined in: [types/ppt.ts:1047](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1047) - --- ### shadow? > `optional` **shadow?**: [`ShadowProps`](ShadowProps.md) -Defined in: [types/ppt.ts:1048](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1048) - --- ### transparency? > `optional` **transparency?**: `number` -Defined in: [types/ppt.ts:1049](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1049) - --- ### charSpacing? > `optional` **charSpacing?**: `number` -Defined in: [types/ppt.ts:1050](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1050) - --- ### lineSpacing? > `optional` **lineSpacing?**: `number` -Defined in: [types/ppt.ts:1051](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1051) - --- ### margin? > `optional` **margin?**: `number` -Defined in: [types/ppt.ts:1052](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1052) - --- ### autoFit? > `optional` **autoFit?**: `boolean` -Defined in: [types/ppt.ts:1053](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1053) - --- ### fit? > `optional` **fit?**: `"none"` \| `"shrink"` \| `"resize"` -Defined in: [types/ppt.ts:1055](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1055) - Text fit options: 'none' = Do not Autofit, 'shrink' = Shrink text to fit, 'resize' = Resize shape to fit text diff --git a/docs/api/type-aliases/PptxTextProps.md b/docs/api/type-aliases/PptxTextProps.md index 0e2c5e166..4906166e9 100644 --- a/docs/api/type-aliases/PptxTextProps.md +++ b/docs/api/type-aliases/PptxTextProps.md @@ -8,8 +8,6 @@ > **PptxTextProps** = `object` -Defined in: [types/ppt.ts:919](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L919) - Text properties for addText method Represents individual text items with formatting options @@ -19,16 +17,12 @@ Represents individual text items with formatting options > **text**: `string` -Defined in: [types/ppt.ts:920](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L920) - --- ### options? > `optional` **options?**: `object` -Defined in: [types/ppt.ts:921](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L921) - #### bullet? > `optional` **bullet?**: `boolean` \| \{ `type?`: `"bullet"` \| `"number"`; `characterCode?`: `string`; `indent?`: `number`; `numberType?`: `"alphaLcParenBoth"` \| `"alphaLcParenR"` \| `"alphaLcPeriod"` \| `"alphaUcParenBoth"` \| `"alphaUcParenR"` \| `"alphaUcPeriod"` \| `"arabicParenBoth"` \| `"arabicParenR"` \| `"arabicPeriod"` \| `"romanLcParenBoth"` \| `"romanLcParenR"` \| `"romanLcPeriod"` \| `"romanUcParenBoth"` \| `"romanUcParenR"` \| `"romanUcPeriod"`; `numberStartAt?`: `number`; `color?`: `string`; `rtlMode?`: `boolean`; `style?`: `string`; \} diff --git a/docs/api/type-aliases/PptxTextRun.md b/docs/api/type-aliases/PptxTextRun.md index 3d26dcee0..a7e40f858 100644 --- a/docs/api/type-aliases/PptxTextRun.md +++ b/docs/api/type-aliases/PptxTextRun.md @@ -8,8 +8,6 @@ > **PptxTextRun** = `object` -Defined in: [types/ppt.ts:965](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L965) - Rich text run for pptxgenjs Represents a single formatted text segment within a text block @@ -19,16 +17,12 @@ Represents a single formatted text segment within a text block > **text**: `string` -Defined in: [types/ppt.ts:966](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L966) - --- ### options? > `optional` **options?**: `object` -Defined in: [types/ppt.ts:967](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L967) - #### bold? > `optional` **bold?**: `boolean` diff --git a/docs/api/type-aliases/PrecallEvaluationConfig.md b/docs/api/type-aliases/PrecallEvaluationConfig.md index 75d377da8..c5b35e8e6 100644 --- a/docs/api/type-aliases/PrecallEvaluationConfig.md +++ b/docs/api/type-aliases/PrecallEvaluationConfig.md @@ -8,8 +8,6 @@ > **PrecallEvaluationConfig** = `object` -Defined in: [types/guardrails.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L55) - Configuration for precall evaluation using AI models ## Properties @@ -18,64 +16,48 @@ Configuration for precall evaluation using AI models > `optional` **enabled?**: `boolean` -Defined in: [types/guardrails.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L56) - --- ### provider? > `optional` **provider?**: `string` -Defined in: [types/guardrails.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L57) - --- ### evaluationModel? > `optional` **evaluationModel?**: `string` -Defined in: [types/guardrails.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L58) - --- ### evaluationPrompt? > `optional` **evaluationPrompt?**: `string` -Defined in: [types/guardrails.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L59) - --- ### actions? > `optional` **actions?**: [`EvaluationActions`](EvaluationActions.md) -Defined in: [types/guardrails.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L60) - --- ### thresholds? > `optional` **thresholds?**: [`EvaluationThresholds`](EvaluationThresholds.md) -Defined in: [types/guardrails.ts:61](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L61) - --- ### blockUnsafeRequests? > `optional` **blockUnsafeRequests?**: `boolean` -Defined in: [types/guardrails.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L62) - --- ### sanitizationPatterns? > `optional` **sanitizationPatterns?**: `string`[] -Defined in: [types/guardrails.ts:74](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L74) - Regex patterns to use for sanitizing input when action is "sanitize". Each pattern will be applied with the 'gi' flags (global, case-insensitive). Matched content will be replaced with the value specified in `replacementText`. @@ -93,8 +75,6 @@ Example patterns: > `optional` **replacementText?**: `string` -Defined in: [types/guardrails.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L85) - Text to use when replacing sanitized content. #### Default diff --git a/docs/api/type-aliases/PrecallEvaluationResult.md b/docs/api/type-aliases/PrecallEvaluationResult.md index ccb974c91..9967b27c9 100644 --- a/docs/api/type-aliases/PrecallEvaluationResult.md +++ b/docs/api/type-aliases/PrecallEvaluationResult.md @@ -8,8 +8,6 @@ > **PrecallEvaluationResult** = `object` -Defined in: [types/guardrails.ts:6](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L6) - Result from precall evaluation of user input ## Properties @@ -18,40 +16,30 @@ Result from precall evaluation of user input > **overall**: `"safe"` \| `"unsafe"` \| `"suspicious"` \| `"inappropriate"` -Defined in: [types/guardrails.ts:7](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L7) - --- ### safetyScore > **safetyScore**: `number` -Defined in: [types/guardrails.ts:8](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L8) - --- ### appropriatenessScore > **appropriatenessScore**: `number` -Defined in: [types/guardrails.ts:9](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L9) - --- ### confidenceLevel > **confidenceLevel**: `number` -Defined in: [types/guardrails.ts:10](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L10) - --- ### issues? > `optional` **issues?**: `object`[] -Defined in: [types/guardrails.ts:11](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L11) - #### category > **category**: `"explicit_content"` \| `"hate_speech"` \| `"violence"` \| `"personal_info"` \| `"spam"` \| `"other"` @@ -70,12 +58,8 @@ Defined in: [types/guardrails.ts:11](https://github.com/juspay/neurolink/blob/re > **suggestedAction**: `"allow"` \| `"block"` \| `"sanitize"` \| `"warn"` -Defined in: [types/guardrails.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L22) - --- ### reasoning? > `optional` **reasoning?**: `string` - -Defined in: [types/guardrails.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/guardrails.ts#L23) diff --git a/docs/api/type-aliases/PrepareStepFunction.md b/docs/api/type-aliases/PrepareStepFunction.md index 55ad63c99..321d925cb 100644 --- a/docs/api/type-aliases/PrepareStepFunction.md +++ b/docs/api/type-aliases/PrepareStepFunction.md @@ -8,8 +8,6 @@ > **PrepareStepFunction**\<`TOOLS`\> = (`options`) => [`PrepareStepResult`](PrepareStepResult.md)\<`TOOLS`\> \| `undefined` \| `PromiseLike`\<[`PrepareStepResult`](PrepareStepResult.md)\<`TOOLS`\> \| `undefined`\> -Defined in: [types/aiCompat.ts:605](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L605) - ## Type Parameters ### TOOLS diff --git a/docs/api/type-aliases/PrepareStepResult.md b/docs/api/type-aliases/PrepareStepResult.md index 2969e5dd8..b2ea54e2b 100644 --- a/docs/api/type-aliases/PrepareStepResult.md +++ b/docs/api/type-aliases/PrepareStepResult.md @@ -8,8 +8,6 @@ > **PrepareStepResult**\<`TOOLS`\> = `object` -Defined in: [types/aiCompat.ts:593](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L593) - ## Type Parameters ### TOOLS @@ -22,52 +20,38 @@ Defined in: [types/aiCompat.ts:593](https://github.com/juspay/neurolink/blob/rel > `optional` **model?**: [`LanguageModel`](LanguageModel.md) -Defined in: [types/aiCompat.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L596) - --- ### toolChoice? > `optional` **toolChoice?**: [`ToolChoice`](ToolChoice.md)\<`TOOLS`\> -Defined in: [types/aiCompat.ts:597](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L597) - --- ### activeTools? > `optional` **activeTools?**: keyof `TOOLS`[] -Defined in: [types/aiCompat.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L598) - --- ### system? > `optional` **system?**: `string` -Defined in: [types/aiCompat.ts:599](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L599) - --- ### messages? > `optional` **messages?**: [`ModelMessage`](ModelMessage.md)[] -Defined in: [types/aiCompat.ts:600](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L600) - --- ### providerOptions? > `optional` **providerOptions?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\> -Defined in: [types/aiCompat.ts:601](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L601) - --- ### tools? > `optional` **tools?**: `TOOLS` - -Defined in: [types/aiCompat.ts:602](https://github.com/juspay/neurolink/blob/release/src/lib/types/aiCompat.ts#L602) diff --git a/docs/api/type-aliases/PreparedAnthropicAccountAttempt.md b/docs/api/type-aliases/PreparedAnthropicAccountAttempt.md index 121990f48..52a108503 100644 --- a/docs/api/type-aliases/PreparedAnthropicAccountAttempt.md +++ b/docs/api/type-aliases/PreparedAnthropicAccountAttempt.md @@ -8,76 +8,56 @@ > **PreparedAnthropicAccountAttempt** = `object` -Defined in: [types/proxy.ts:1475](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1475) - ## Properties ### continueLoop > **continueLoop**: `boolean` -Defined in: [types/proxy.ts:1476](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1476) - --- ### lastError > **lastError**: `unknown` -Defined in: [types/proxy.ts:1477](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1477) - --- ### authFailureMessage > **authFailureMessage**: `string` \| `null` -Defined in: [types/proxy.ts:1478](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1478) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/proxy.ts:1479](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1479) - --- ### buildUpstreamBody? > `optional` **buildUpstreamBody?**: [`AnthropicUpstreamBodyBuilder`](AnthropicUpstreamBodyBuilder.md) -Defined in: [types/proxy.ts:1480](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1480) - --- ### finalBodyStr? > `optional` **finalBodyStr?**: `string` -Defined in: [types/proxy.ts:1481](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1481) - --- ### preparedContext? > `optional` **preparedContext?**: [`ProxyPreparedContext`](ProxyPreparedContext.md)\<[`ClaudeRequest`](ClaudeRequest.md)\> -Defined in: [types/proxy.ts:1482](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1482) - --- ### fetchStartMs? > `optional` **fetchStartMs?**: `number` -Defined in: [types/proxy.ts:1483](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1483) - --- ### upstreamSpan? > `optional` **upstreamSpan?**: `Span` - -Defined in: [types/proxy.ts:1484](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1484) diff --git a/docs/api/type-aliases/PresentationGenerationOptions.md b/docs/api/type-aliases/PresentationGenerationOptions.md index 1b4799f8d..a21fd49f4 100644 --- a/docs/api/type-aliases/PresentationGenerationOptions.md +++ b/docs/api/type-aliases/PresentationGenerationOptions.md @@ -8,8 +8,6 @@ > **PresentationGenerationOptions** = `object` -Defined in: [types/ppt.ts:1380](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1380) - Options for presentation generation ## Properties @@ -18,8 +16,6 @@ Options for presentation generation > **context**: [`PPTGenerationContext`](PPTGenerationContext.md) -Defined in: [types/ppt.ts:1382](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1382) - PPT generation context (validated) --- @@ -28,8 +24,6 @@ PPT generation context (validated) > **provider**: [`AIProvider`](AIProvider.md) -Defined in: [types/ppt.ts:1384](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1384) - AI provider for content planning --- @@ -38,8 +32,6 @@ AI provider for content planning > **providerName**: `string` -Defined in: [types/ppt.ts:1386](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1386) - Provider name (for result reporting) --- @@ -48,8 +40,6 @@ Provider name (for result reporting) > **modelName**: `string` -Defined in: [types/ppt.ts:1388](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1388) - Model name (for result reporting) --- @@ -58,8 +48,6 @@ Model name (for result reporting) > `optional` **neurolink?**: [`NeuroLink`](../classes/NeuroLink.md) -Defined in: [types/ppt.ts:1390](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1390) - NeuroLink instance for image generation --- @@ -68,8 +56,6 @@ NeuroLink instance for image generation > `optional` **imageProvider?**: `string` -Defined in: [types/ppt.ts:1392](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1392) - Provider name for image generation --- @@ -78,6 +64,4 @@ Provider name for image generation > `optional` **imageModel?**: `string` -Defined in: [types/ppt.ts:1394](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1394) - Model for image generation diff --git a/docs/api/type-aliases/PresentationTheme.md b/docs/api/type-aliases/PresentationTheme.md index fa1a89a8f..1d1c15124 100644 --- a/docs/api/type-aliases/PresentationTheme.md +++ b/docs/api/type-aliases/PresentationTheme.md @@ -8,8 +8,6 @@ > **PresentationTheme** = `object` -Defined in: [types/ppt.ts:765](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L765) - Complete theme definition ## Properties @@ -18,36 +16,26 @@ Complete theme definition > **name**: `string` -Defined in: [types/ppt.ts:766](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L766) - --- ### displayName > **displayName**: `string` -Defined in: [types/ppt.ts:767](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L767) - --- ### description > **description**: `string` -Defined in: [types/ppt.ts:768](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L768) - --- ### colors > **colors**: [`ThemeColors`](ThemeColors.md) -Defined in: [types/ppt.ts:769](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L769) - --- ### fonts > **fonts**: [`ThemeFonts`](ThemeFonts.md) - -Defined in: [types/ppt.ts:770](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L770) diff --git a/docs/api/type-aliases/Primitive.md b/docs/api/type-aliases/Primitive.md index b1c8bcda4..0acc98132 100644 --- a/docs/api/type-aliases/Primitive.md +++ b/docs/api/type-aliases/Primitive.md @@ -8,6 +8,4 @@ > **Primitive** = [`AgentPrimitive`](AgentPrimitive.md) \| [`WorkflowPrimitive`](WorkflowPrimitive.md) \| [`ToolPrimitive`](ToolPrimitive.md) -Defined in: [types/agentNetwork.ts:264](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L264) - Union type for all primitives diff --git a/docs/api/type-aliases/PrimitiveEndChunk.md b/docs/api/type-aliases/PrimitiveEndChunk.md index b128e6b2f..88fd5f39d 100644 --- a/docs/api/type-aliases/PrimitiveEndChunk.md +++ b/docs/api/type-aliases/PrimitiveEndChunk.md @@ -8,8 +8,6 @@ > **PrimitiveEndChunk** = [`NetworkStreamChunkBase`](NetworkStreamChunkBase.md) & `object` -Defined in: [types/agentNetwork.ts:770](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L770) - Primitive end event ## Type Declaration diff --git a/docs/api/type-aliases/PrimitiveExecutionResult.md b/docs/api/type-aliases/PrimitiveExecutionResult.md index 4a0e13d10..d255287c9 100644 --- a/docs/api/type-aliases/PrimitiveExecutionResult.md +++ b/docs/api/type-aliases/PrimitiveExecutionResult.md @@ -8,8 +8,6 @@ > **PrimitiveExecutionResult** = `object` -Defined in: [types/agentNetwork.ts:587](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L587) - Result from executing a primitive ## Properties @@ -18,8 +16,6 @@ Result from executing a primitive > **output**: `unknown` -Defined in: [types/agentNetwork.ts:589](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L589) - Output from the primitive --- @@ -28,8 +24,6 @@ Output from the primitive > `optional` **error?**: `string` -Defined in: [types/agentNetwork.ts:592](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L592) - Error message if execution failed --- @@ -38,8 +32,6 @@ Error message if execution failed > `optional` **usage?**: [`TokenUsage`](TokenUsage.md) -Defined in: [types/agentNetwork.ts:595](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L595) - Token usage --- @@ -48,6 +40,4 @@ Token usage > `optional` **duration?**: `number` -Defined in: [types/agentNetwork.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L598) - Execution duration in ms diff --git a/docs/api/type-aliases/PrimitiveRecord.md b/docs/api/type-aliases/PrimitiveRecord.md index fc402fe50..aa9e5c8fa 100644 --- a/docs/api/type-aliases/PrimitiveRecord.md +++ b/docs/api/type-aliases/PrimitiveRecord.md @@ -8,7 +8,5 @@ > **PrimitiveRecord** = `Record`\<`string`, `string` \| `number` \| `boolean`\> -Defined in: [types/aliases.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L88) - Mixed primitive record for configuration objects Allows string, number, boolean values diff --git a/docs/api/type-aliases/PrimitiveStartChunk.md b/docs/api/type-aliases/PrimitiveStartChunk.md index 86d9c30d0..26f55eb0a 100644 --- a/docs/api/type-aliases/PrimitiveStartChunk.md +++ b/docs/api/type-aliases/PrimitiveStartChunk.md @@ -8,8 +8,6 @@ > **PrimitiveStartChunk** = [`NetworkStreamChunkBase`](NetworkStreamChunkBase.md) & `object` -Defined in: [types/agentNetwork.ts:757](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L757) - Primitive start event ## Type Declaration diff --git a/docs/api/type-aliases/ProcessOptions.md b/docs/api/type-aliases/ProcessOptions.md index 99349de89..dfd150954 100644 --- a/docs/api/type-aliases/ProcessOptions.md +++ b/docs/api/type-aliases/ProcessOptions.md @@ -8,8 +8,6 @@ > **ProcessOptions** = `object` -Defined in: [types/processor.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L182) - Options for file processing operations. Allows customization of download behavior and retry logic. @@ -19,8 +17,6 @@ Allows customization of download behavior and retry logic. > `optional` **authHeaders?**: `Record`\<`string`, `string`\> -Defined in: [types/processor.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L184) - Authentication headers for download requests --- @@ -29,8 +25,6 @@ Authentication headers for download requests > `optional` **timeout?**: `number` -Defined in: [types/processor.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L186) - Override default timeout (in milliseconds) --- @@ -39,6 +33,4 @@ Override default timeout (in milliseconds) > `optional` **retryConfig?**: [`ProcessorRetryConfig`](ProcessorRetryConfig.md) -Defined in: [types/processor.ts:188](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L188) - Retry configuration for transient failures diff --git a/docs/api/type-aliases/ProcessResult.md b/docs/api/type-aliases/ProcessResult.md index 64649b16b..baab82c0e 100644 --- a/docs/api/type-aliases/ProcessResult.md +++ b/docs/api/type-aliases/ProcessResult.md @@ -8,8 +8,6 @@ > **ProcessResult** = `object` -Defined in: [types/common.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L263) - Result of executing a child process (shell command). ## Properties @@ -18,8 +16,6 @@ Result of executing a child process (shell command). > **code**: `number` \| `null` -Defined in: [types/common.ts:265](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L265) - Exit code of the process --- @@ -28,8 +24,6 @@ Exit code of the process > **stdout**: `string` -Defined in: [types/common.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L267) - Standard output --- @@ -38,8 +32,6 @@ Standard output > **stderr**: `string` -Defined in: [types/common.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L269) - Standard error output --- @@ -48,6 +40,4 @@ Standard error output > **success**: `boolean` -Defined in: [types/common.ts:271](https://github.com/juspay/neurolink/blob/release/src/lib/types/common.ts#L271) - Whether the process exited successfully (code === 0) diff --git a/docs/api/type-aliases/ProcessStep.md b/docs/api/type-aliases/ProcessStep.md index f07dfc25f..5077d1b68 100644 --- a/docs/api/type-aliases/ProcessStep.md +++ b/docs/api/type-aliases/ProcessStep.md @@ -8,8 +8,6 @@ > **ProcessStep** = `object` -Defined in: [types/ppt.ts:371](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L371) - Process step for process-flow slides Maps to: addShape (boxes/arrows) + addText @@ -19,8 +17,6 @@ Maps to: addShape (boxes/arrows) + addText > **step**: `number` -Defined in: [types/ppt.ts:373](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L373) - Step number --- @@ -29,8 +25,6 @@ Step number > **title**: `string` -Defined in: [types/ppt.ts:375](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L375) - Step title --- @@ -39,8 +33,6 @@ Step title > `optional` **description?**: `string` -Defined in: [types/ppt.ts:377](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L377) - Step description --- @@ -49,6 +41,4 @@ Step description > `optional` **icon?**: `string` -Defined in: [types/ppt.ts:379](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L379) - Icon code (Unicode) diff --git a/docs/api/type-aliases/ProcessedArchive.md b/docs/api/type-aliases/ProcessedArchive.md index 9c83b97b5..d22e5354a 100644 --- a/docs/api/type-aliases/ProcessedArchive.md +++ b/docs/api/type-aliases/ProcessedArchive.md @@ -8,8 +8,6 @@ > **ProcessedArchive** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:954](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L954) - Processed archive result. Extends ProcessedFileBase with archive-specific metadata, entry listing, and any security warnings encountered during processing. diff --git a/docs/api/type-aliases/ProcessedAudio.md b/docs/api/type-aliases/ProcessedAudio.md index b5a168636..a5333ed9d 100644 --- a/docs/api/type-aliases/ProcessedAudio.md +++ b/docs/api/type-aliases/ProcessedAudio.md @@ -8,8 +8,6 @@ > **ProcessedAudio** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:810](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L810) - Processed audio file result. Extends ProcessedFileBase with audio-specific metadata, tags, and transcript info. diff --git a/docs/api/type-aliases/ProcessedConfig.md b/docs/api/type-aliases/ProcessedConfig.md index f88e153d1..c94e97e3f 100644 --- a/docs/api/type-aliases/ProcessedConfig.md +++ b/docs/api/type-aliases/ProcessedConfig.md @@ -8,8 +8,6 @@ > **ProcessedConfig** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:560](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L560) - Processed configuration file result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedExcel.md b/docs/api/type-aliases/ProcessedExcel.md index 4f8510916..2a3fbb1e2 100644 --- a/docs/api/type-aliases/ProcessedExcel.md +++ b/docs/api/type-aliases/ProcessedExcel.md @@ -8,8 +8,6 @@ > **ProcessedExcel** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:742](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L742) - Processed Excel file result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedFileBase.md b/docs/api/type-aliases/ProcessedFileBase.md index c5e5eb762..2b3cd8b2e 100644 --- a/docs/api/type-aliases/ProcessedFileBase.md +++ b/docs/api/type-aliases/ProcessedFileBase.md @@ -8,8 +8,6 @@ > **ProcessedFileBase** = `object` -Defined in: [types/processor.ts:79](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L79) - Base interface for processed file data. All specific processed types should extend this interface. @@ -19,8 +17,6 @@ All specific processed types should extend this interface. > **buffer**: `Buffer` -Defined in: [types/processor.ts:81](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L81) - File content as a Buffer --- @@ -29,8 +25,6 @@ File content as a Buffer > **mimetype**: `string` -Defined in: [types/processor.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L83) - MIME type of the processed content --- @@ -39,8 +33,6 @@ MIME type of the processed content > **size**: `number` -Defined in: [types/processor.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L85) - Size of the processed content in bytes --- @@ -49,6 +41,4 @@ Size of the processed content in bytes > **filename**: `string` -Defined in: [types/processor.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L87) - Filename (may be normalized or sanitized) diff --git a/docs/api/type-aliases/ProcessedFileInfo.md b/docs/api/type-aliases/ProcessedFileInfo.md index 8a1516690..ede03cf50 100644 --- a/docs/api/type-aliases/ProcessedFileInfo.md +++ b/docs/api/type-aliases/ProcessedFileInfo.md @@ -8,8 +8,6 @@ > **ProcessedFileInfo** = `object` -Defined in: [types/processor.ts:224](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L224) - Information about a successfully processed file. ## Properties @@ -18,8 +16,6 @@ Information about a successfully processed file. > **fileId**: `string` -Defined in: [types/processor.ts:226](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L226) - File identifier --- @@ -28,8 +24,6 @@ File identifier > **filename**: `string` -Defined in: [types/processor.ts:228](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L228) - Filename --- @@ -38,8 +32,6 @@ Filename > **mimetype**: `string` -Defined in: [types/processor.ts:230](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L230) - MIME type --- @@ -48,8 +40,6 @@ MIME type > **size**: `number` -Defined in: [types/processor.ts:232](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L232) - Size in bytes --- @@ -58,6 +48,4 @@ Size in bytes > **processorType**: `string` -Defined in: [types/processor.ts:234](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L234) - Type of processor used diff --git a/docs/api/type-aliases/ProcessedHtml.md b/docs/api/type-aliases/ProcessedHtml.md index 156354026..fcfdca9f7 100644 --- a/docs/api/type-aliases/ProcessedHtml.md +++ b/docs/api/type-aliases/ProcessedHtml.md @@ -8,8 +8,6 @@ > **ProcessedHtml** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:626](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L626) - Processed HTML file result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedImage.md b/docs/api/type-aliases/ProcessedImage.md index 80cd20313..88a7d3cad 100644 --- a/docs/api/type-aliases/ProcessedImage.md +++ b/docs/api/type-aliases/ProcessedImage.md @@ -8,8 +8,6 @@ > **ProcessedImage** = `object` -Defined in: [types/multimodal.ts:584](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L584) - Image processing result ## Properties @@ -18,28 +16,20 @@ Image processing result > **data**: `string` -Defined in: [types/multimodal.ts:585](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L585) - --- ### mediaType > **mediaType**: `string` -Defined in: [types/multimodal.ts:586](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L586) - --- ### size > **size**: `number` -Defined in: [types/multimodal.ts:587](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L587) - --- ### format > **format**: `"data_uri"` \| `"base64"` \| `"inline_data"` \| `"source"` - -Defined in: [types/multimodal.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L588) diff --git a/docs/api/type-aliases/ProcessedJson.md b/docs/api/type-aliases/ProcessedJson.md index cfad6e90b..26a87e3ce 100644 --- a/docs/api/type-aliases/ProcessedJson.md +++ b/docs/api/type-aliases/ProcessedJson.md @@ -8,8 +8,6 @@ > **ProcessedJson** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:588](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L588) - Processed JSON file result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedMarkdown.md b/docs/api/type-aliases/ProcessedMarkdown.md index 3d13e2d75..336116fb4 100644 --- a/docs/api/type-aliases/ProcessedMarkdown.md +++ b/docs/api/type-aliases/ProcessedMarkdown.md @@ -8,8 +8,6 @@ > **ProcessedMarkdown** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:528](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L528) - Processed Markdown result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedOpenDocument.md b/docs/api/type-aliases/ProcessedOpenDocument.md index 64edfda46..649515267 100644 --- a/docs/api/type-aliases/ProcessedOpenDocument.md +++ b/docs/api/type-aliases/ProcessedOpenDocument.md @@ -8,8 +8,6 @@ > **ProcessedOpenDocument** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L574) - Processed OpenDocument result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedProxyBodyCapture.md b/docs/api/type-aliases/ProcessedProxyBodyCapture.md index f051870f1..a1b8803e3 100644 --- a/docs/api/type-aliases/ProcessedProxyBodyCapture.md +++ b/docs/api/type-aliases/ProcessedProxyBodyCapture.md @@ -8,40 +8,30 @@ > **ProcessedProxyBodyCapture** = `object` -Defined in: [types/proxy.ts:887](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L887) - ## Properties ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/proxy.ts:888](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L888) - --- ### stored > **stored**: [`StoredBodyArtifact`](StoredBodyArtifact.md) -Defined in: [types/proxy.ts:889](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L889) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/proxy.ts:890](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L890) - --- ### queueWaitMs? > `optional` **queueWaitMs?**: `number` -Defined in: [types/proxy.ts:892](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L892) - Admission plus worker queue time; retained for existing consumers. --- @@ -50,28 +40,20 @@ Admission plus worker queue time; retained for existing consumers. > `optional` **admissionWaitMs?**: `number` -Defined in: [types/proxy.ts:893](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L893) - --- ### workerQueueWaitMs? > `optional` **workerQueueWaitMs?**: `number` -Defined in: [types/proxy.ts:894](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L894) - --- ### processingMs? > `optional` **processingMs?**: `number` -Defined in: [types/proxy.ts:895](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L895) - --- ### admission? > `optional` **admission?**: [`ProxyBodyCaptureAdmission`](ProxyBodyCaptureAdmission.md) - -Defined in: [types/proxy.ts:896](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L896) diff --git a/docs/api/type-aliases/ProcessedRtf.md b/docs/api/type-aliases/ProcessedRtf.md index b51a71d8e..b3517bd89 100644 --- a/docs/api/type-aliases/ProcessedRtf.md +++ b/docs/api/type-aliases/ProcessedRtf.md @@ -8,8 +8,6 @@ > **ProcessedRtf** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:770](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L770) - Processed RTF document result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedSourceCode.md b/docs/api/type-aliases/ProcessedSourceCode.md index 6f8397082..96aaf77f5 100644 --- a/docs/api/type-aliases/ProcessedSourceCode.md +++ b/docs/api/type-aliases/ProcessedSourceCode.md @@ -8,8 +8,6 @@ > **ProcessedSourceCode** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:544](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L544) - Processed source code result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedSvg.md b/docs/api/type-aliases/ProcessedSvg.md index 3cb2545b5..5ab326c68 100644 --- a/docs/api/type-aliases/ProcessedSvg.md +++ b/docs/api/type-aliases/ProcessedSvg.md @@ -8,8 +8,6 @@ > **ProcessedSvg** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:498](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L498) - Processed SVG result. Extends ProcessedFileBase with SVG-specific fields. diff --git a/docs/api/type-aliases/ProcessedText.md b/docs/api/type-aliases/ProcessedText.md index f83db86a6..2c3fe6d9e 100644 --- a/docs/api/type-aliases/ProcessedText.md +++ b/docs/api/type-aliases/ProcessedText.md @@ -8,8 +8,6 @@ > **ProcessedText** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:610](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L610) - Processed plain text file result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedVideo.md b/docs/api/type-aliases/ProcessedVideo.md index 86964f09d..359419502 100644 --- a/docs/api/type-aliases/ProcessedVideo.md +++ b/docs/api/type-aliases/ProcessedVideo.md @@ -8,8 +8,6 @@ > **ProcessedVideo** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:855](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L855) - Processed video result. Extends ProcessedFileBase with video-specific fields including metadata, extracted keyframes, subtitle text, and a pre-formatted textContent block diff --git a/docs/api/type-aliases/ProcessedWord.md b/docs/api/type-aliases/ProcessedWord.md index 41a70907a..9ffc50401 100644 --- a/docs/api/type-aliases/ProcessedWord.md +++ b/docs/api/type-aliases/ProcessedWord.md @@ -8,8 +8,6 @@ > **ProcessedWord** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:758](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L758) - Processed Word document result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedXml.md b/docs/api/type-aliases/ProcessedXml.md index 05374ed46..39b64bc6e 100644 --- a/docs/api/type-aliases/ProcessedXml.md +++ b/docs/api/type-aliases/ProcessedXml.md @@ -8,8 +8,6 @@ > **ProcessedXml** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:512](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L512) - Processed XML file result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessedYaml.md b/docs/api/type-aliases/ProcessedYaml.md index af0d5bf69..e8e5a3e20 100644 --- a/docs/api/type-aliases/ProcessedYaml.md +++ b/docs/api/type-aliases/ProcessedYaml.md @@ -8,8 +8,6 @@ > **ProcessedYaml** = [`ProcessedFileBase`](ProcessedFileBase.md) & `object` -Defined in: [types/processor.ts:644](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L644) - Processed YAML file result. ## Type Declaration diff --git a/docs/api/type-aliases/ProcessorErrorMessageTemplate.md b/docs/api/type-aliases/ProcessorErrorMessageTemplate.md index 04869422e..42b568215 100644 --- a/docs/api/type-aliases/ProcessorErrorMessageTemplate.md +++ b/docs/api/type-aliases/ProcessorErrorMessageTemplate.md @@ -8,8 +8,6 @@ > **ProcessorErrorMessageTemplate** = `object` -Defined in: [types/processor.ts:1025](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1025) - Error message template with user-friendly messaging and retry information. ## Properties @@ -18,8 +16,6 @@ Error message template with user-friendly messaging and retry information. > **message**: `string` -Defined in: [types/processor.ts:1027](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1027) - Technical error message --- @@ -28,8 +24,6 @@ Technical error message > **userMessage**: `string` -Defined in: [types/processor.ts:1029](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1029) - User-friendly error message --- @@ -38,8 +32,6 @@ User-friendly error message > **suggestedAction**: `string` -Defined in: [types/processor.ts:1031](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1031) - Suggested action to resolve the error --- @@ -48,6 +40,4 @@ Suggested action to resolve the error > **retryable**: `boolean` -Defined in: [types/processor.ts:1033](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L1033) - Whether this error is potentially retryable diff --git a/docs/api/type-aliases/ProcessorFileProcessingResult.md b/docs/api/type-aliases/ProcessorFileProcessingResult.md index 2a47acd0c..8d657ad95 100644 --- a/docs/api/type-aliases/ProcessorFileProcessingResult.md +++ b/docs/api/type-aliases/ProcessorFileProcessingResult.md @@ -8,8 +8,6 @@ > **ProcessorFileProcessingResult**\<`T`\> = `object` -Defined in: [types/processor.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L148) - Result of a file processing operation. Uses discriminated union pattern for type-safe error handling. @@ -36,8 +34,6 @@ if (result.success) { > **success**: `boolean` -Defined in: [types/processor.ts:152](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L152) - Whether the processing was successful --- @@ -46,8 +42,6 @@ Whether the processing was successful > `optional` **data?**: `T` -Defined in: [types/processor.ts:154](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L154) - Processed file data (present when success is true) --- @@ -56,6 +50,4 @@ Processed file data (present when success is true) > `optional` **error?**: [`FileProcessingError`](FileProcessingError.md) -Defined in: [types/processor.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L156) - Error information (present when success is false) diff --git a/docs/api/type-aliases/ProcessorInfo.md b/docs/api/type-aliases/ProcessorInfo.md index 8b7d80898..3be7bd745 100644 --- a/docs/api/type-aliases/ProcessorInfo.md +++ b/docs/api/type-aliases/ProcessorInfo.md @@ -8,8 +8,6 @@ > **ProcessorInfo** = `object` -Defined in: [types/processor.ts:467](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L467) - Information about a registered processor. Used for discovery and documentation. @@ -19,8 +17,6 @@ Used for discovery and documentation. > **name**: `string` -Defined in: [types/processor.ts:469](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L469) - Unique name for the processor --- @@ -29,8 +25,6 @@ Unique name for the processor > **description**: `string` -Defined in: [types/processor.ts:471](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L471) - Human-readable description --- @@ -39,8 +33,6 @@ Human-readable description > **supportedMimeTypes**: `string`[] -Defined in: [types/processor.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L473) - List of supported MIME types --- @@ -49,8 +41,6 @@ List of supported MIME types > **supportedExtensions**: `string`[] -Defined in: [types/processor.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L475) - List of supported file extensions --- @@ -59,6 +49,4 @@ List of supported file extensions > `optional` **priority?**: `number` -Defined in: [types/processor.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L477) - Priority level (lower = higher priority) diff --git a/docs/api/type-aliases/ProcessorMatch.md b/docs/api/type-aliases/ProcessorMatch.md index 74e252ac0..16c426832 100644 --- a/docs/api/type-aliases/ProcessorMatch.md +++ b/docs/api/type-aliases/ProcessorMatch.md @@ -8,8 +8,6 @@ > **ProcessorMatch**\<`_T`\> = `object` -Defined in: [types/processor.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L314) - Result of finding a matching processor for a file. Includes both the processor and metadata about the match quality. @@ -28,8 +26,6 @@ on BaseFileProcessor. The registry module uses the properly typed version. > **name**: `string` -Defined in: [types/processor.ts:316](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L316) - Name of the matched processor --- @@ -38,8 +34,6 @@ Name of the matched processor > **processor**: `unknown` -Defined in: [types/processor.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L319) - The processor instance --- @@ -48,8 +42,6 @@ The processor instance > **priority**: `number` -Defined in: [types/processor.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L322) - Priority level of this processor --- @@ -58,8 +50,6 @@ Priority level of this processor > **confidence**: `number` -Defined in: [types/processor.ts:332](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L332) - Confidence score for the match (0-100). Higher values indicate better match quality: diff --git a/docs/api/type-aliases/ProcessorOperationResult.md b/docs/api/type-aliases/ProcessorOperationResult.md index 399f832e9..b6095d5f6 100644 --- a/docs/api/type-aliases/ProcessorOperationResult.md +++ b/docs/api/type-aliases/ProcessorOperationResult.md @@ -8,8 +8,6 @@ > **ProcessorOperationResult**\<`T`\> = `object` -Defined in: [types/processor.ts:125](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L125) - Generic result type for internal operations. Used for validation and download operations that don't return ProcessedFileBase. @@ -25,8 +23,6 @@ Used for validation and download operations that don't return ProcessedFileBase. > **success**: `boolean` -Defined in: [types/processor.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L127) - Whether the operation was successful --- @@ -35,8 +31,6 @@ Whether the operation was successful > `optional` **data?**: `T` -Defined in: [types/processor.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L129) - Operation result data (present when success is true) --- @@ -45,6 +39,4 @@ Operation result data (present when success is true) > `optional` **error?**: [`FileProcessingError`](FileProcessingError.md) -Defined in: [types/processor.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L131) - Error information (present when success is false) diff --git a/docs/api/type-aliases/ProcessorPipelineConfig.md b/docs/api/type-aliases/ProcessorPipelineConfig.md index 86fd11695..80dd83693 100644 --- a/docs/api/type-aliases/ProcessorPipelineConfig.md +++ b/docs/api/type-aliases/ProcessorPipelineConfig.md @@ -8,8 +8,6 @@ > **ProcessorPipelineConfig** = `object` -Defined in: [types/ioProcessor.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L143) - ## Deprecated Use piiDetection/responseValidation/inputValidation on GenerateOptions instead @@ -20,44 +18,32 @@ Use piiDetection/responseValidation/inputValidation on GenerateOptions instead > `optional` **name?**: `string` -Defined in: [types/ioProcessor.ts:144](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L144) - --- ### ~~stopOnAbort?~~ > `optional` **stopOnAbort?**: `boolean` -Defined in: [types/ioProcessor.ts:145](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L145) - --- ### ~~pipelineTimeoutMs?~~ > `optional` **pipelineTimeoutMs?**: `number` -Defined in: [types/ioProcessor.ts:146](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L146) - --- ### ~~inputProcessors?~~ > `optional` **inputProcessors?**: `unknown`[] -Defined in: [types/ioProcessor.ts:147](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L147) - --- ### ~~outputProcessors?~~ > `optional` **outputProcessors?**: `unknown`[] -Defined in: [types/ioProcessor.ts:148](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L148) - --- ### ~~settings?~~ > `optional` **settings?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/ioProcessor.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/ioProcessor.ts#L149) diff --git a/docs/api/type-aliases/ProcessorPriorityKey.md b/docs/api/type-aliases/ProcessorPriorityKey.md index fe3785dc4..91cccbfb8 100644 --- a/docs/api/type-aliases/ProcessorPriorityKey.md +++ b/docs/api/type-aliases/ProcessorPriorityKey.md @@ -8,6 +8,4 @@ > **ProcessorPriorityKey** = keyof _typeof_ [`PROCESSOR_PRIORITIES`](../variables/PROCESSOR_PRIORITIES.md) -Defined in: [types/processor.ts:451](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L451) - Type for processor priority keys diff --git a/docs/api/type-aliases/ProcessorPriorityValue.md b/docs/api/type-aliases/ProcessorPriorityValue.md index 9dfdfd77b..4a40d74e6 100644 --- a/docs/api/type-aliases/ProcessorPriorityValue.md +++ b/docs/api/type-aliases/ProcessorPriorityValue.md @@ -8,6 +8,4 @@ > **ProcessorPriorityValue** = _typeof_ [`PROCESSOR_PRIORITIES`](../variables/PROCESSOR_PRIORITIES.md)\[[`ProcessorPriorityKey`](ProcessorPriorityKey.md)\] -Defined in: [types/processor.ts:456](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L456) - Type for processor priority values diff --git a/docs/api/type-aliases/ProcessorRegistration.md b/docs/api/type-aliases/ProcessorRegistration.md index 70d86b1c9..cf233bc0a 100644 --- a/docs/api/type-aliases/ProcessorRegistration.md +++ b/docs/api/type-aliases/ProcessorRegistration.md @@ -8,8 +8,6 @@ > **ProcessorRegistration**\<`T`\> = `object` -Defined in: [types/processor.ts:789](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L789) - Registration entry for a file processor. ## Type Parameters @@ -24,32 +22,24 @@ Registration entry for a file processor. > **name**: `string` -Defined in: [types/processor.ts:792](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L792) - --- ### priority > **priority**: `number` -Defined in: [types/processor.ts:793](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L793) - --- ### processor > **processor**: `BaseFileProcessor` -Defined in: [types/processor.ts:794](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L794) - --- ### isSupported > **isSupported**: (`mimetype`, `filename`) => `boolean` -Defined in: [types/processor.ts:795](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L795) - #### Parameters ##### mimetype @@ -70,12 +60,8 @@ Defined in: [types/processor.ts:795](https://github.com/juspay/neurolink/blob/re > `optional` **description?**: `string` -Defined in: [types/processor.ts:796](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L796) - --- ### aliases? > `optional` **aliases?**: `string`[] - -Defined in: [types/processor.ts:797](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L797) diff --git a/docs/api/type-aliases/ProcessorRetryConfig.md b/docs/api/type-aliases/ProcessorRetryConfig.md index 96787814d..5e4c16b32 100644 --- a/docs/api/type-aliases/ProcessorRetryConfig.md +++ b/docs/api/type-aliases/ProcessorRetryConfig.md @@ -8,8 +8,6 @@ > **ProcessorRetryConfig** = `object` -Defined in: [types/processor.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L167) - Configuration for retry behavior on transient failures. Implements exponential backoff with optional custom retry predicate. @@ -19,8 +17,6 @@ Implements exponential backoff with optional custom retry predicate. > **maxRetries**: `number` -Defined in: [types/processor.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L169) - Maximum number of retry attempts --- @@ -29,8 +25,6 @@ Maximum number of retry attempts > **baseDelayMs**: `number` -Defined in: [types/processor.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L171) - Base delay between retries in milliseconds --- @@ -39,8 +33,6 @@ Base delay between retries in milliseconds > **maxDelayMs**: `number` -Defined in: [types/processor.ts:173](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L173) - Maximum delay between retries in milliseconds --- @@ -49,8 +41,6 @@ Maximum delay between retries in milliseconds > `optional` **retryOn?**: (`error`) => `boolean` -Defined in: [types/processor.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/processor.ts#L175) - Optional custom function to determine if an error is retryable #### Parameters diff --git a/docs/api/type-aliases/ProgressCallback.md b/docs/api/type-aliases/ProgressCallback.md index ddf04ee5e..abacb2cbb 100644 --- a/docs/api/type-aliases/ProgressCallback.md +++ b/docs/api/type-aliases/ProgressCallback.md @@ -8,8 +8,6 @@ > **ProgressCallback** = (`progress`) => `void` \| `Promise`\<`void`\> -Defined in: [types/stream.ts:93](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L93) - Progress callback for streaming operations ## Parameters diff --git a/docs/api/type-aliases/PromptGenerator.md b/docs/api/type-aliases/PromptGenerator.md index 61d645a0d..b9f12d301 100644 --- a/docs/api/type-aliases/PromptGenerator.md +++ b/docs/api/type-aliases/PromptGenerator.md @@ -8,8 +8,6 @@ > **PromptGenerator** = (`args`, `context?`) => `Promise`\<[`PromptResult`](PromptResult.md)\> -Defined in: [types/mcp.ts:2101](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2101) - Prompt generator function type ## Parameters diff --git a/docs/api/type-aliases/PromptMessage.md b/docs/api/type-aliases/PromptMessage.md index ad4991ddf..55513cf22 100644 --- a/docs/api/type-aliases/PromptMessage.md +++ b/docs/api/type-aliases/PromptMessage.md @@ -8,8 +8,6 @@ > **PromptMessage** = `object` -Defined in: [types/mcp.ts:2063](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2063) - Prompt message content ## Properties @@ -18,8 +16,6 @@ Prompt message content > **role**: `"user"` \| `"assistant"` -Defined in: [types/mcp.ts:2067](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2067) - Message role --- @@ -28,8 +24,6 @@ Message role > **content**: `object` -Defined in: [types/mcp.ts:2072](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2072) - Message content #### type diff --git a/docs/api/type-aliases/PromptRedactionOptions.md b/docs/api/type-aliases/PromptRedactionOptions.md index c9277ff16..f14f70999 100644 --- a/docs/api/type-aliases/PromptRedactionOptions.md +++ b/docs/api/type-aliases/PromptRedactionOptions.md @@ -8,16 +8,12 @@ > **PromptRedactionOptions** = `object` -Defined in: [types/utilities.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L212) - ## Properties ### maxLength? > `optional` **maxLength?**: `number` -Defined in: [types/utilities.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L214) - Maximum length of redacted prompt --- @@ -26,8 +22,6 @@ Maximum length of redacted prompt > `optional` **showWordCount?**: `boolean` -Defined in: [types/utilities.ts:216](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L216) - Whether to show word count --- @@ -36,6 +30,4 @@ Whether to show word count > `optional` **maskChar?**: `string` -Defined in: [types/utilities.ts:218](https://github.com/juspay/neurolink/blob/release/src/lib/types/utilities.ts#L218) - Mask character to use for redaction diff --git a/docs/api/type-aliases/PromptResult.md b/docs/api/type-aliases/PromptResult.md index e6800b680..db3cce5fb 100644 --- a/docs/api/type-aliases/PromptResult.md +++ b/docs/api/type-aliases/PromptResult.md @@ -8,8 +8,6 @@ > **PromptResult** = `object` -Defined in: [types/mcp.ts:2085](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2085) - Result of getting a prompt ## Properties @@ -18,8 +16,6 @@ Result of getting a prompt > `optional` **description?**: `string` -Defined in: [types/mcp.ts:2089](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2089) - Optional description --- @@ -28,6 +24,4 @@ Optional description > **messages**: [`PromptMessage`](PromptMessage.md)[] -Defined in: [types/mcp.ts:2094](https://github.com/juspay/neurolink/blob/release/src/lib/types/mcp.ts#L2094) - Prompt messages diff --git a/docs/api/type-aliases/PromptTier.md b/docs/api/type-aliases/PromptTier.md index 1ad3479cc..d7fffd4c9 100644 --- a/docs/api/type-aliases/PromptTier.md +++ b/docs/api/type-aliases/PromptTier.md @@ -8,6 +8,4 @@ > **PromptTier** = `"basic"` \| `"advanced"` -Defined in: [types/ppt.ts:1211](https://github.com/juspay/neurolink/blob/release/src/lib/types/ppt.ts#L1211) - Prompt tier levels diff --git a/docs/api/type-aliases/PropertySchema.md b/docs/api/type-aliases/PropertySchema.md index 8bc4bdac4..61d43b267 100644 --- a/docs/api/type-aliases/PropertySchema.md +++ b/docs/api/type-aliases/PropertySchema.md @@ -8,8 +8,6 @@ > **PropertySchema** = `object` -Defined in: [types/middleware.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L501) - Schema for an individual property in ValidationSchema. ## Properties @@ -18,88 +16,66 @@ Schema for an individual property in ValidationSchema. > **type**: `"string"` \| `"number"` \| `"boolean"` \| `"object"` \| `"array"` -Defined in: [types/middleware.ts:502](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L502) - --- ### minimum? > `optional` **minimum?**: `number` -Defined in: [types/middleware.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L503) - --- ### maximum? > `optional` **maximum?**: `number` -Defined in: [types/middleware.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L504) - --- ### minLength? > `optional` **minLength?**: `number` -Defined in: [types/middleware.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L505) - --- ### maxLength? > `optional` **maxLength?**: `number` -Defined in: [types/middleware.ts:506](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L506) - --- ### minItems? > `optional` **minItems?**: `number` -Defined in: [types/middleware.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L507) - --- ### maxItems? > `optional` **maxItems?**: `number` -Defined in: [types/middleware.ts:508](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L508) - --- ### pattern? > `optional` **pattern?**: `string` -Defined in: [types/middleware.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L509) - --- ### enum? > `optional` **enum?**: `unknown`[] -Defined in: [types/middleware.ts:510](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L510) - --- ### default? > `optional` **default?**: `unknown` -Defined in: [types/middleware.ts:511](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L511) - --- ### validate? > `optional` **validate?**: (`value`) => `boolean` \| `string` -Defined in: [types/middleware.ts:512](https://github.com/juspay/neurolink/blob/release/src/lib/types/middleware.ts#L512) - #### Parameters ##### value diff --git a/docs/api/type-aliases/ProtocolState.md b/docs/api/type-aliases/ProtocolState.md index ec0c23430..dc950fe26 100644 --- a/docs/api/type-aliases/ProtocolState.md +++ b/docs/api/type-aliases/ProtocolState.md @@ -8,6 +8,4 @@ > **ProtocolState** = `"initiated"` \| `"pending"` \| `"active"` \| `"completed"` \| `"failed"` \| `"timeout"` -Defined in: [types/agentNetwork.ts:1180](https://github.com/juspay/neurolink/blob/release/src/lib/types/agentNetwork.ts#L1180) - Protocol state diff --git a/docs/api/type-aliases/ProviderAttempt.md b/docs/api/type-aliases/ProviderAttempt.md index dddb0732f..edee718c3 100644 --- a/docs/api/type-aliases/ProviderAttempt.md +++ b/docs/api/type-aliases/ProviderAttempt.md @@ -8,8 +8,6 @@ > **ProviderAttempt** = `object` -Defined in: [types/providers.ts:996](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L996) - Provider attempt result for iteration tracking (converted from interface) ## Properties @@ -18,36 +16,26 @@ Provider attempt result for iteration tracking (converted from interface) > **provider**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/providers.ts:997](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L997) - --- ### model > **model**: [`SupportedModelName`](SupportedModelName.md) -Defined in: [types/providers.ts:998](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L998) - --- ### success > **success**: `boolean` -Defined in: [types/providers.ts:999](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L999) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/providers.ts:1000](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1000) - --- ### stack? > `optional` **stack?**: `string` - -Defined in: [types/providers.ts:1001](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1001) diff --git a/docs/api/type-aliases/ProviderAvailabilityStatus.md b/docs/api/type-aliases/ProviderAvailabilityStatus.md index 04f2c080b..8812e29f7 100644 --- a/docs/api/type-aliases/ProviderAvailabilityStatus.md +++ b/docs/api/type-aliases/ProviderAvailabilityStatus.md @@ -8,8 +8,6 @@ > **ProviderAvailabilityStatus** = `object` -Defined in: [types/evaluationProviders.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L84) - Provider availability status ## Properties @@ -18,28 +16,20 @@ Provider availability status > **provider**: `string` -Defined in: [types/evaluationProviders.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L85) - --- ### available > **available**: `boolean` -Defined in: [types/evaluationProviders.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L86) - --- ### reason? > `optional` **reason?**: `string` -Defined in: [types/evaluationProviders.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L87) - --- ### lastChecked > **lastChecked**: `Date` - -Defined in: [types/evaluationProviders.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L88) diff --git a/docs/api/type-aliases/ProviderCapabilities.md b/docs/api/type-aliases/ProviderCapabilities.md index 03cc6af4c..c7ea923dc 100644 --- a/docs/api/type-aliases/ProviderCapabilities.md +++ b/docs/api/type-aliases/ProviderCapabilities.md @@ -8,8 +8,6 @@ > **ProviderCapabilities** = `object` -Defined in: [types/providers.ts:541](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L541) - Provider capabilities ## Properties @@ -18,56 +16,42 @@ Provider capabilities > **supportsStreaming**: `boolean` -Defined in: [types/providers.ts:542](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L542) - --- ### supportsTools > **supportsTools**: `boolean` -Defined in: [types/providers.ts:543](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L543) - --- ### supportsImages > **supportsImages**: `boolean` -Defined in: [types/providers.ts:544](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L544) - --- ### supportsAudio > **supportsAudio**: `boolean` -Defined in: [types/providers.ts:545](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L545) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/providers.ts:546](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L546) - --- ### supportedModels > **supportedModels**: `string`[] -Defined in: [types/providers.ts:547](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L547) - --- ### subscriptionAware? > `optional` **subscriptionAware?**: `boolean` -Defined in: [types/providers.ts:552](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L552) - Whether the provider supports subscription-based features and tier management When true, the provider can adapt behavior based on subscription tier @@ -77,7 +61,5 @@ When true, the provider can adapt behavior based on subscription tier > `optional` **supportedAuthMethods?**: `string`[] -Defined in: [types/providers.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L557) - List of authentication methods supported by this provider e.g., ["api_key", "oauth", "session_token", "environment"] diff --git a/docs/api/type-aliases/ProviderCapability.md b/docs/api/type-aliases/ProviderCapability.md index c19eecf91..4ef69fd75 100644 --- a/docs/api/type-aliases/ProviderCapability.md +++ b/docs/api/type-aliases/ProviderCapability.md @@ -8,6 +8,4 @@ > **ProviderCapability** = `"text-generation"` \| `"streaming"` \| `"tool-calling"` \| `"image-generation"` \| `"embeddings"` -Defined in: [types/providers.ts:1048](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1048) - Provider capability type diff --git a/docs/api/type-aliases/ProviderCatalogJson.md b/docs/api/type-aliases/ProviderCatalogJson.md index 9beb1db42..1f6fbf2a2 100644 --- a/docs/api/type-aliases/ProviderCatalogJson.md +++ b/docs/api/type-aliases/ProviderCatalogJson.md @@ -8,16 +8,12 @@ > **ProviderCatalogJson** = `object` -Defined in: [types/providerCatalog.ts:139](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L139) - ## Properties ### $schema? > `optional` **$schema?**: `string` -Defined in: [types/providerCatalog.ts:141](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L141) - Editor-only pointer to provider-catalog.schema.json — accepted and ignored. --- @@ -26,24 +22,18 @@ Editor-only pointer to provider-catalog.schema.json — accepted and ignored. > **id**: `string` -Defined in: [types/providerCatalog.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L142) - --- ### displayName > **displayName**: `string` -Defined in: [types/providerCatalog.ts:143](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L143) - --- ### enumTypeName? > `optional` **enumTypeName?**: `string` -Defined in: [types/providerCatalog.ts:150](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L150) - Exported Models enum name override. Default: PascalCase(id) + "Models". REQUIRED where the derived name differs from a pre-existing export ("together-ai" derives "TogetherAiModels"; the legacy export is @@ -55,8 +45,6 @@ export ("together-ai" derives "TogetherAiModels"; the legacy export is > `optional` **credentialsKey?**: `string` -Defined in: [types/providerCatalog.ts:159](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L159) - NeurolinkCredentials key override. Default: toCamelCase(id). REQUIRED where the derived key differs from a pre-existing public credential field ("together-ai" derives "togetherAi"; the shipped public key is @@ -70,32 +58,24 @@ forbids). > **aliases**: `string`[] -Defined in: [types/providerCatalog.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L160) - --- ### tier > **tier**: `2` -Defined in: [types/providerCatalog.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L161) - --- ### wire > **wire**: [`CatalogWire`](CatalogWire.md) -Defined in: [types/providerCatalog.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L162) - --- ### models > **models**: `object` -Defined in: [types/providerCatalog.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L163) - #### default > **default**: `string` @@ -166,32 +146,24 @@ runtime default. > **capabilities**: [`CatalogCapabilities`](CatalogCapabilities.md) -Defined in: [types/providerCatalog.ts:194](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L194) - --- ### errorRules > **errorRules**: [`CatalogErrorRuleJson`](CatalogErrorRuleJson.md)[] -Defined in: [types/providerCatalog.ts:195](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L195) - --- ### quirks? > `optional` **quirks?**: [`CatalogQuirks`](CatalogQuirks.md) -Defined in: [types/providerCatalog.ts:196](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L196) - --- ### timeouts? > `optional` **timeouts?**: [`CatalogTimeouts`](CatalogTimeouts.md) -Defined in: [types/providerCatalog.ts:203](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L203) - Descriptor-only generate/stream turn-budget override — see CatalogTimeouts. Absent = buildCatalogDescriptor() omits ProviderDescriptor.timeouts entirely, matching every catalog provider's @@ -203,8 +175,6 @@ behavior before this field existed. > `optional` **autoSelectPriority?**: `number` -Defined in: [types/providerCatalog.ts:212](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L212) - Descriptor-only ascending auto-select priority override — mirrors ProviderDescriptor.autoSelectPriority field-for-field (lower = tried first in getBestProvider()'s fallback chain). Absent = not part of the @@ -218,12 +188,8 @@ pre-migration hand-typed value). > **setup**: [`CatalogSetup`](CatalogSetup.md) -Defined in: [types/providerCatalog.ts:213](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L213) - --- ### evidence > **evidence**: [`CatalogEvidence`](CatalogEvidence.md) - -Defined in: [types/providerCatalog.ts:214](https://github.com/juspay/neurolink/blob/release/src/lib/types/providerCatalog.ts#L214) diff --git a/docs/api/type-aliases/ProviderConfigOptions.md b/docs/api/type-aliases/ProviderConfigOptions.md index dea3345d4..c4f0e590e 100644 --- a/docs/api/type-aliases/ProviderConfigOptions.md +++ b/docs/api/type-aliases/ProviderConfigOptions.md @@ -8,8 +8,6 @@ > **ProviderConfigOptions** = `object` -Defined in: [types/providers.ts:752](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L752) - Configuration options for provider validation ## Properties @@ -18,52 +16,38 @@ Configuration options for provider validation > **providerName**: `string` -Defined in: [types/providers.ts:753](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L753) - --- ### envVarName > **envVarName**: `string` -Defined in: [types/providers.ts:754](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L754) - --- ### setupUrl > **setupUrl**: `string` -Defined in: [types/providers.ts:755](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L755) - --- ### description > **description**: `string` -Defined in: [types/providers.ts:756](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L756) - --- ### instructions > **instructions**: `string`[] -Defined in: [types/providers.ts:757](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L757) - --- ### fallbackEnvVars? > `optional` **fallbackEnvVars?**: `string`[] -Defined in: [types/providers.ts:758](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L758) - --- ### optional? > `optional` **optional?**: `boolean` - -Defined in: [types/providers.ts:763](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L763) diff --git a/docs/api/type-aliases/ProviderConfiguration.md b/docs/api/type-aliases/ProviderConfiguration.md index 3d40c785b..96e23eb1e 100644 --- a/docs/api/type-aliases/ProviderConfiguration.md +++ b/docs/api/type-aliases/ProviderConfiguration.md @@ -8,8 +8,6 @@ > **ProviderConfiguration** = `object` -Defined in: [types/model.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L45) - Provider configuration for model management ## Properties @@ -18,8 +16,6 @@ Provider configuration for model management > **provider**: `string` -Defined in: [types/model.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L47) - Provider name --- @@ -28,8 +24,6 @@ Provider name > **models**: `Record`\<[`ModelTier`](ModelTier.md), `string`\> -Defined in: [types/model.ts:49](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L49) - Available models by tier --- @@ -38,8 +32,6 @@ Available models by tier > **defaultCost**: `object` -Defined in: [types/model.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L51) - Default cost per token (fallback) #### input @@ -56,8 +48,6 @@ Default cost per token (fallback) > **requiredEnvVars**: `string`[] -Defined in: [types/model.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L56) - Required environment variables --- @@ -66,8 +56,6 @@ Required environment variables > **performance**: `object` -Defined in: [types/model.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L58) - Provider-specific performance metrics #### speed @@ -88,8 +76,6 @@ Provider-specific performance metrics > `optional` **modelConfigs?**: `Record`\<`string`, [`ModelConfig`](ModelConfig.md)\> -Defined in: [types/model.ts:64](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L64) - Provider-specific model configurations --- @@ -98,8 +84,6 @@ Provider-specific model configurations > `optional` **modelBehavior?**: `object` -Defined in: [types/model.ts:66](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L66) - Provider-specific model behavior configurations #### maxTokensIssues? diff --git a/docs/api/type-aliases/ProviderConstructor.md b/docs/api/type-aliases/ProviderConstructor.md index cb12dd5ed..fe6285ad1 100644 --- a/docs/api/type-aliases/ProviderConstructor.md +++ b/docs/api/type-aliases/ProviderConstructor.md @@ -8,7 +8,5 @@ > **ProviderConstructor** = ((`modelName?`, `providerName?`, `sdk?`, `region?`, `credentials?`) => [`AIProvider`](AIProvider.md)) \| ((`modelName?`, `providerName?`, `sdk?`, `region?`, `credentials?`) => `Promise`\<[`AIProvider`](AIProvider.md)\>) -Defined in: [types/providers.ts:2211](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2211) - Provider constructor interface - supports both sync constructors and async factory functions. diff --git a/docs/api/type-aliases/ProviderCostStats.md b/docs/api/type-aliases/ProviderCostStats.md index 09c41a91c..971ca7c65 100644 --- a/docs/api/type-aliases/ProviderCostStats.md +++ b/docs/api/type-aliases/ProviderCostStats.md @@ -8,8 +8,6 @@ > **ProviderCostStats** = `object` -Defined in: [types/observability.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L340) - Cost breakdown by provider ## Properties @@ -18,44 +16,32 @@ Cost breakdown by provider > **provider**: `string` -Defined in: [types/observability.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L341) - --- ### totalCost > **totalCost**: `number` -Defined in: [types/observability.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L342) - --- ### requestCount > **requestCount**: `number` -Defined in: [types/observability.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L343) - --- ### avgCostPerRequest > **avgCostPerRequest**: `number` -Defined in: [types/observability.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L344) - --- ### inputCost > **inputCost**: `number` -Defined in: [types/observability.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L345) - --- ### outputCost > **outputCost**: `number` - -Defined in: [types/observability.ts:346](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L346) diff --git a/docs/api/type-aliases/ProviderCreationError.md b/docs/api/type-aliases/ProviderCreationError.md index 5e3e1c3c3..fa4736b6c 100644 --- a/docs/api/type-aliases/ProviderCreationError.md +++ b/docs/api/type-aliases/ProviderCreationError.md @@ -8,8 +8,6 @@ > **ProviderCreationError** = `object` -Defined in: [types/providers.ts:1007](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1007) - Error types for provider creation ## Properties @@ -18,28 +16,20 @@ Error types for provider creation > **code**: `"INVALID_PROVIDER"` \| `"CONFIGURATION_ERROR"` \| `"INSTANTIATION_ERROR"` -Defined in: [types/providers.ts:1008](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1008) - --- ### message > **message**: `string` -Defined in: [types/providers.ts:1009](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1009) - --- ### provider > **provider**: `string` -Defined in: [types/providers.ts:1010](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1010) - --- ### details? > `optional` **details?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/providers.ts:1011](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1011) diff --git a/docs/api/type-aliases/ProviderDescriptor.md b/docs/api/type-aliases/ProviderDescriptor.md index db9696277..4e0c07666 100644 --- a/docs/api/type-aliases/ProviderDescriptor.md +++ b/docs/api/type-aliases/ProviderDescriptor.md @@ -8,8 +8,6 @@ > **ProviderDescriptor** = `object` -Defined in: [types/providers.ts:2263](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2263) - Single source of truth for one AI provider's static identity: how it's addressed (name/aliases), how it's authenticated (credentialsKey/envVars), what it defaults to (defaultModel), and how the rest of the codebase @@ -26,8 +24,6 @@ instead. See src/lib/factories/providerDescriptors.ts for the data. > **name**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/providers.ts:2265](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2265) - Canonical identity — matches an AIProviderName enum member (never AUTO). --- @@ -36,8 +32,6 @@ Canonical identity — matches an AIProviderName enum member (never AUTO). > **aliases**: readonly `string`[] -Defined in: [types/providers.ts:2267](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2267) - Alternate spellings accepted by the CLI and the alias index (kebab-case, shorthand, legacy names). Does not include `name` itself. --- @@ -46,8 +40,6 @@ Alternate spellings accepted by the CLI and the alias index (kebab-case, shortha > `optional` **inferenceKinds?**: readonly [`InferenceKind`](InferenceKind.md)[] -Defined in: [types/providers.ts:2281](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2281) - Which inference types this provider actually serves. Omitted means `["generate", "stream"]`, which is what every text provider is — so every existing descriptor keeps its meaning untouched. @@ -66,8 +58,6 @@ choices should filter on this rather than special-case a provider name. > **credentialsKey**: keyof [`NeurolinkCredentials`](NeurolinkCredentials.md) -Defined in: [types/providers.ts:2283](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2283) - Key into NeurolinkCredentials for per-call/per-instance credential overrides. --- @@ -76,8 +66,6 @@ Key into NeurolinkCredentials for per-call/per-instance credential overrides. > **envVars**: `object` -Defined in: [types/providers.ts:2285](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2285) - Environment variables this provider reads at runtime. #### apiKey? @@ -138,8 +126,6 @@ True when the provider is usable with zero configuration (local runtime with a d > **defaultModel**: `string` -Defined in: [types/providers.ts:2311](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2311) - Static fallback model. The empty string "" is a documented sentinel meaning "no static default — resolved at runtime via envVars.model or provider-side auto-discovery" (used by Bedrock, OpenAI-Compatible, @@ -152,16 +138,12 @@ LM Studio, llama.cpp, matching how providerRegistry.ts already passes > **toolSupport**: `"native"` \| `"prompt-only"` \| `"none"` \| `"model-dependent"` -Defined in: [types/providers.ts:2312](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2312) - --- ### localRuntime > **localRuntime**: `boolean` -Defined in: [types/providers.ts:2314](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2314) - True only for providers that run entirely on the caller's machine with no cloud account (Ollama, LM Studio, llama.cpp). LiteLLM is a local proxy but commonly points at cloud models, so it is deliberately false. --- @@ -170,8 +152,6 @@ True only for providers that run entirely on the caller's machine with no cloud > **healthCheck**: `"env-only"` \| `"models-probe"` \| `"live-generate"` -Defined in: [types/providers.ts:2316](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2316) - How ProviderHealthChecker should verify this provider is reachable. --- @@ -180,8 +160,6 @@ How ProviderHealthChecker should verify this provider is reachable. > `optional` **defaultHealthSweepPriority?**: `number` -Defined in: [types/providers.ts:2325](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2325) - Membership + order in the default health sweep (`ProviderHealthChecker.checkAllProvidersHealth` with no explicit list). Lower number = checked and reported first; the sweep's array @@ -195,8 +173,6 @@ array that lived in providerHealth.ts. > `optional` **autoSelectPreference?**: `number` -Defined in: [types/providers.ts:2334](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2334) - Preference rank for `getBestHealthyProvider`'s default auto-selection (lower = tried first). Deliberately a SEPARATE ordering from the sweep: auto-select prefers local/cheap runtimes (litellm, ollama) before cloud @@ -210,16 +186,12 @@ that lived inline as getBestHealthyProvider's default parameter. > `optional` **setupUrl?**: `string` -Defined in: [types/providers.ts:2335](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2335) - --- ### timeouts? > `optional` **timeouts?**: `object` -Defined in: [types/providers.ts:2336](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2336) - #### generateMs? > `optional` **generateMs?**: `number` @@ -238,8 +210,6 @@ Defined in: [types/providers.ts:2336](https://github.com/juspay/neurolink/blob/r > `optional` **decisionLimits?**: [`DecisionLimits`](DecisionLimits.md) -Defined in: [types/providers.ts:2341](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2341) - What a `decide` provider can read. Absent means the provider leaves size checks to its own server (TypeSafe). See [DecisionLimits](DecisionLimits.md). @@ -249,8 +219,6 @@ checks to its own server (TypeSafe). See [DecisionLimits](DecisionLimits.md). > `optional` **autoSelectPriority?**: `number` -Defined in: [types/providers.ts:2343](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2343) - Ascending priority (1 = tried first) in the auto-select fallback chain used by getBestProvider(). Undefined = not part of the auto-select chain. --- @@ -259,8 +227,6 @@ Ascending priority (1 = tried first) in the auto-select fallback chain used by g > `optional` **apiKeyFormatPattern?**: `RegExp` -Defined in: [types/providers.ts:2345](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2345) - Format-validation regex sourced from providerConfig.ts's API_KEY_FORMATS, when one exists for this provider. --- @@ -269,8 +235,6 @@ Format-validation regex sourced from providerConfig.ts's API_KEY_FORMATS, when o > `optional` **credentialsResolvedExternally?**: `boolean` -Defined in: [types/providers.ts:2360](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2360) - True when this provider's credentials are resolved by an external chain or its own config validator rather than by plain env-var presence, so its required-env-vars can't be expressed as "every one of these exact diff --git a/docs/api/type-aliases/ProviderDetails.md b/docs/api/type-aliases/ProviderDetails.md index 498db4c9d..334259554 100644 --- a/docs/api/type-aliases/ProviderDetails.md +++ b/docs/api/type-aliases/ProviderDetails.md @@ -8,20 +8,14 @@ > **ProviderDetails** = `object` -Defined in: [types/conversation.ts:764](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L764) - ## Properties ### provider > **provider**: `string` -Defined in: [types/conversation.ts:765](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L765) - --- ### model > **model**: `string` - -Defined in: [types/conversation.ts:766](https://github.com/juspay/neurolink/blob/release/src/lib/types/conversation.ts#L766) diff --git a/docs/api/type-aliases/ProviderErrorClass.md b/docs/api/type-aliases/ProviderErrorClass.md index 224e3636e..1d1e7b380 100644 --- a/docs/api/type-aliases/ProviderErrorClass.md +++ b/docs/api/type-aliases/ProviderErrorClass.md @@ -8,7 +8,5 @@ > **ProviderErrorClass** = `"rate_limit"` \| `"auth"` \| `"context_window"` \| `"server"` \| `"network"` \| `"unknown"` -Defined in: [types/modelPool.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/modelPool.ts#L27) - Coarse error class returned by `classifyProviderError`. Drives the cooldown decision inside ModelPool. diff --git a/docs/api/type-aliases/ProviderErrorContext.md b/docs/api/type-aliases/ProviderErrorContext.md index e3abba4e7..221d1b550 100644 --- a/docs/api/type-aliases/ProviderErrorContext.md +++ b/docs/api/type-aliases/ProviderErrorContext.md @@ -8,8 +8,6 @@ > **ProviderErrorContext** = `object` -Defined in: [types/errors.ts:80](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L80) - Everything a ProviderErrorRule's `match`/`message` functions can inspect about a raw thrown error, pre-extracted once so every rule doesn't re-derive the same duck-typed fields. @@ -20,8 +18,6 @@ re-derive the same duck-typed fields. > **error**: `unknown` -Defined in: [types/errors.ts:82](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L82) - The raw thrown value, for rules that need custom inspection beyond the extracted fields. --- @@ -30,8 +26,6 @@ The raw thrown value, for rules that need custom inspection beyond the extracted > **message**: `string` -Defined in: [types/errors.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L84) - `.message` off the raw error, or "Unknown error" if absent/non-string. --- @@ -40,8 +34,6 @@ Defined in: [types/errors.ts:84](https://github.com/juspay/neurolink/blob/releas > **statusCode**: `number` \| `undefined` -Defined in: [types/errors.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L86) - HTTP status code, duck-typed from `.statusCode` / `.status`. --- @@ -50,8 +42,6 @@ HTTP status code, duck-typed from `.statusCode` / `.status`. > **errorName**: `string` \| `undefined` -Defined in: [types/errors.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L88) - `.name` off the raw error (e.g. AWS SDK exception names like "ThrottlingException"). --- @@ -60,8 +50,6 @@ Defined in: [types/errors.ts:88](https://github.com/juspay/neurolink/blob/releas > **errorCode**: `string` \| `undefined` -Defined in: [types/errors.ts:90](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L90) - `.code` off the raw error (e.g. AWS SDK / Node network error codes). --- @@ -70,8 +58,6 @@ Defined in: [types/errors.ts:90](https://github.com/juspay/neurolink/blob/releas > **provider**: `string` -Defined in: [types/errors.ts:92](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L92) - Provider key passed to classifyProviderError (e.g. "mistral", "vertex"). --- @@ -80,6 +66,4 @@ Provider key passed to classifyProviderError (e.g. "mistral", "vertex"). > **modelName**: `string` \| `undefined` -Defined in: [types/errors.ts:94](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L94) - Model name in effect for this call, when the caller has one available. diff --git a/docs/api/type-aliases/ProviderErrorLike.md b/docs/api/type-aliases/ProviderErrorLike.md index 2fc6bf668..b79779d9b 100644 --- a/docs/api/type-aliases/ProviderErrorLike.md +++ b/docs/api/type-aliases/ProviderErrorLike.md @@ -8,8 +8,6 @@ > **ProviderErrorLike** = `Error` & `object` -Defined in: [types/providers.ts:149](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L149) - Structural type for provider errors from external sources. For throwing errors, use the ProviderError class from errors.ts. diff --git a/docs/api/type-aliases/ProviderErrorRule.md b/docs/api/type-aliases/ProviderErrorRule.md index 01af35425..69a2aeb71 100644 --- a/docs/api/type-aliases/ProviderErrorRule.md +++ b/docs/api/type-aliases/ProviderErrorRule.md @@ -8,8 +8,6 @@ > **ProviderErrorRule** = `object` -Defined in: [types/errors.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L106) - One row of a provider's error-classification table. Rules are tried in array order; the first `match` to return true wins. `errorClass` must be `ProviderError` or one of its subclasses (AuthenticationError, @@ -24,8 +22,6 @@ interpolate a model name, a scraped retry-delay, or an AWS error code. > **match**: (`ctx`) => `boolean` -Defined in: [types/errors.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L107) - #### Parameters ##### ctx @@ -42,8 +38,6 @@ Defined in: [types/errors.ts:107](https://github.com/juspay/neurolink/blob/relea > **errorClass**: (`message`, `provider?`) => [`ProviderError`](../classes/ProviderError.md) -Defined in: [types/errors.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L108) - #### Parameters ##### message @@ -63,5 +57,3 @@ Defined in: [types/errors.ts:108](https://github.com/juspay/neurolink/blob/relea ### message > **message**: `string` \| ((`ctx`) => `string`) - -Defined in: [types/errors.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/errors.ts#L109) diff --git a/docs/api/type-aliases/ProviderFallbackCallback.md b/docs/api/type-aliases/ProviderFallbackCallback.md index f912c3436..c0a4ce7e8 100644 --- a/docs/api/type-aliases/ProviderFallbackCallback.md +++ b/docs/api/type-aliases/ProviderFallbackCallback.md @@ -8,8 +8,6 @@ > **ProviderFallbackCallback** = (`error`) => `Promise`\<\{ `provider?`: `string`; `model?`: `string`; \} \| `null`\> -Defined in: [types/config.ts:62](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L62) - Curator P2-3: callback signature for centralized fallback policy. When an explicit callback is configured (per-call or instance), it is invoked for ANY error thrown by a generate/stream call except genuine caller cancels — diff --git a/docs/api/type-aliases/ProviderHealthCheckOptions.md b/docs/api/type-aliases/ProviderHealthCheckOptions.md index 5c8fe7d2e..e82e03d61 100644 --- a/docs/api/type-aliases/ProviderHealthCheckOptions.md +++ b/docs/api/type-aliases/ProviderHealthCheckOptions.md @@ -8,44 +8,32 @@ > **ProviderHealthCheckOptions** = `object` -Defined in: [types/providers.ts:1989](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1989) - ## Properties ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/providers.ts:1990](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1990) - --- ### includeConnectivityTest? > `optional` **includeConnectivityTest?**: `boolean` -Defined in: [types/providers.ts:1991](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1991) - --- ### includeModelValidation? > `optional` **includeModelValidation?**: `boolean` -Defined in: [types/providers.ts:1992](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1992) - --- ### cacheResults? > `optional` **cacheResults?**: `boolean` -Defined in: [types/providers.ts:1993](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1993) - --- ### maxCacheAge? > `optional` **maxCacheAge?**: `number` - -Defined in: [types/providers.ts:1994](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1994) diff --git a/docs/api/type-aliases/ProviderHealthStatus.md b/docs/api/type-aliases/ProviderHealthStatus.md index 4ef9ec850..28a842eee 100644 --- a/docs/api/type-aliases/ProviderHealthStatus.md +++ b/docs/api/type-aliases/ProviderHealthStatus.md @@ -8,6 +8,4 @@ > **ProviderHealthStatus** = `"healthy"` \| `"degraded"` \| `"unhealthy"` \| `"unknown"` -Defined in: [types/providers.ts:444](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L444) - Provider health status diff --git a/docs/api/type-aliases/ProviderHealthStatusOptions.md b/docs/api/type-aliases/ProviderHealthStatusOptions.md index e5f6d8e1e..99a25505e 100644 --- a/docs/api/type-aliases/ProviderHealthStatusOptions.md +++ b/docs/api/type-aliases/ProviderHealthStatusOptions.md @@ -8,84 +8,62 @@ > **ProviderHealthStatusOptions** = `object` -Defined in: [types/providers.ts:1955](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1955) - ## Properties ### provider > **provider**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/providers.ts:1956](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1956) - --- ### isHealthy > **isHealthy**: `boolean` -Defined in: [types/providers.ts:1957](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1957) - --- ### isConfigured > **isConfigured**: `boolean` -Defined in: [types/providers.ts:1958](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1958) - --- ### hasApiKey > **hasApiKey**: `boolean` -Defined in: [types/providers.ts:1959](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1959) - --- ### lastChecked > **lastChecked**: `Date` -Defined in: [types/providers.ts:1960](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1960) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/providers.ts:1961](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1961) - --- ### warning? > `optional` **warning?**: `string` -Defined in: [types/providers.ts:1962](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1962) - --- ### responseTime? > `optional` **responseTime?**: `number` -Defined in: [types/providers.ts:1963](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1963) - --- ### configurationIssues > **configurationIssues**: `string`[] -Defined in: [types/providers.ts:1964](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1964) - --- ### recommendations > **recommendations**: `string`[] - -Defined in: [types/providers.ts:1965](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1965) diff --git a/docs/api/type-aliases/ProviderImageFormat.md b/docs/api/type-aliases/ProviderImageFormat.md index 9d7d3f11a..f40f95083 100644 --- a/docs/api/type-aliases/ProviderImageFormat.md +++ b/docs/api/type-aliases/ProviderImageFormat.md @@ -8,8 +8,6 @@ > **ProviderImageFormat** = `object` -Defined in: [types/multimodal.ts:573](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L573) - Provider-specific image format requirements ## Properties @@ -18,36 +16,26 @@ Provider-specific image format requirements > **provider**: `string` -Defined in: [types/multimodal.ts:574](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L574) - --- ### format > **format**: `"data_uri"` \| `"base64"` \| `"inline_data"` \| `"source"` -Defined in: [types/multimodal.ts:575](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L575) - --- ### requiresPrefix? > `optional` **requiresPrefix?**: `boolean` -Defined in: [types/multimodal.ts:576](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L576) - --- ### mimeTypeField? > `optional` **mimeTypeField?**: `string` -Defined in: [types/multimodal.ts:577](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L577) - --- ### dataField? > `optional` **dataField?**: `string` - -Defined in: [types/multimodal.ts:578](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L578) diff --git a/docs/api/type-aliases/ProviderInfo.md b/docs/api/type-aliases/ProviderInfo.md index a93597b96..ad754c5c1 100644 --- a/docs/api/type-aliases/ProviderInfo.md +++ b/docs/api/type-aliases/ProviderInfo.md @@ -8,8 +8,6 @@ > **ProviderInfo** = `object` -Defined in: [types/cli.ts:705](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L705) - Provider information for setup display ## Properties @@ -18,112 +16,84 @@ Provider information for setup display > **id**: `string` -Defined in: [types/cli.ts:706](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L706) - --- ### name > **name**: `string` -Defined in: [types/cli.ts:707](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L707) - --- ### emoji > **emoji**: `string` -Defined in: [types/cli.ts:708](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L708) - --- ### description > **description**: `string` -Defined in: [types/cli.ts:709](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L709) - --- ### setupTime > **setupTime**: `string` -Defined in: [types/cli.ts:710](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L710) - --- ### cost > **cost**: `string` -Defined in: [types/cli.ts:711](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L711) - --- ### difficulty? > `optional` **difficulty?**: `"Easy"` \| `"Medium"` \| `"Hard"` -Defined in: [types/cli.ts:712](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L712) - --- ### features? > `optional` **features?**: `string`[] -Defined in: [types/cli.ts:713](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L713) - --- ### bestFor? > `optional` **bestFor?**: `string` -Defined in: [types/cli.ts:714](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L714) - --- ### models? > `optional` **models?**: `string` -Defined in: [types/cli.ts:715](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L715) - --- ### strengths? > `optional` **strengths?**: `string` -Defined in: [types/cli.ts:716](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L716) - --- ### pricing? > `optional` **pricing?**: `string` -Defined in: [types/cli.ts:717](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L717) - --- ### setupCommand? > `optional` **setupCommand?**: `string` -Defined in: [types/cli.ts:718](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L718) - --- ### handler? > `optional` **handler?**: (`argv`) => `Promise`\<`void`\> -Defined in: [types/cli.ts:719](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L719) - #### Parameters ##### argv diff --git a/docs/api/type-aliases/ProviderKeyMap.md b/docs/api/type-aliases/ProviderKeyMap.md index 6794f9ae2..7211a058d 100644 --- a/docs/api/type-aliases/ProviderKeyMap.md +++ b/docs/api/type-aliases/ProviderKeyMap.md @@ -8,6 +8,4 @@ > **ProviderKeyMap** = `Record`\<`string`, `string`[]\> -Defined in: [types/action.ts:268](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L268) - Provider-to-required-keys map used by actionInputs.ts. diff --git a/docs/api/type-aliases/ProviderKeyMapping.md b/docs/api/type-aliases/ProviderKeyMapping.md index 7654dce9f..70611ec12 100644 --- a/docs/api/type-aliases/ProviderKeyMapping.md +++ b/docs/api/type-aliases/ProviderKeyMapping.md @@ -8,6 +8,4 @@ > **ProviderKeyMapping** = `{ [K in AIProviderName]?: (keyof ActionProviderKeys)[] }` -Defined in: [types/action.ts:263](https://github.com/juspay/neurolink/blob/release/src/lib/types/action.ts#L263) - Provider key validation mapping diff --git a/docs/api/type-aliases/ProviderMetadata.md b/docs/api/type-aliases/ProviderMetadata.md index 5839c6fc0..d023cfbef 100644 --- a/docs/api/type-aliases/ProviderMetadata.md +++ b/docs/api/type-aliases/ProviderMetadata.md @@ -8,8 +8,6 @@ > **ProviderMetadata** = `object` -Defined in: [types/providers.ts:1037](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1037) - Provider metadata type ## Properties @@ -18,36 +16,26 @@ Provider metadata type > **name**: `string` -Defined in: [types/providers.ts:1038](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1038) - --- ### version > **version**: `string` -Defined in: [types/providers.ts:1039](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1039) - --- ### capabilities > **capabilities**: [`ProviderCapability`](ProviderCapability.md)[] -Defined in: [types/providers.ts:1040](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1040) - --- ### models > **models**: `string`[] -Defined in: [types/providers.ts:1041](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1041) - --- ### healthStatus > **healthStatus**: [`ProviderHealthStatus`](ProviderHealthStatus.md) - -Defined in: [types/providers.ts:1042](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1042) diff --git a/docs/api/type-aliases/ProviderMetricItem.md b/docs/api/type-aliases/ProviderMetricItem.md index 1967d3b2f..90b1c5297 100644 --- a/docs/api/type-aliases/ProviderMetricItem.md +++ b/docs/api/type-aliases/ProviderMetricItem.md @@ -8,92 +8,68 @@ > **ProviderMetricItem** = `object` -Defined in: [types/analytics.ts:161](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L161) - ## Properties ### name > **name**: `string` -Defined in: [types/analytics.ts:162](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L162) - --- ### averageLatency > **averageLatency**: `number` -Defined in: [types/analytics.ts:163](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L163) - --- ### averageResponseTime > **averageResponseTime**: `number` -Defined in: [types/analytics.ts:164](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L164) - --- ### totalTokens > **totalTokens**: `number` -Defined in: [types/analytics.ts:165](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L165) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/analytics.ts:166](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L166) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/analytics.ts:167](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L167) - --- ### errorRate > **errorRate**: `number` -Defined in: [types/analytics.ts:168](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L168) - --- ### successRate > **successRate**: `number` -Defined in: [types/analytics.ts:169](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L169) - --- ### costPerToken > **costPerToken**: `number` -Defined in: [types/analytics.ts:170](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L170) - --- ### totalCost > **totalCost**: `number` -Defined in: [types/analytics.ts:171](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L171) - --- ### requestCount > **requestCount**: `number` - -Defined in: [types/analytics.ts:172](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L172) diff --git a/docs/api/type-aliases/ProviderMetricsOptions.md b/docs/api/type-aliases/ProviderMetricsOptions.md index ab24cafb6..b36040337 100644 --- a/docs/api/type-aliases/ProviderMetricsOptions.md +++ b/docs/api/type-aliases/ProviderMetricsOptions.md @@ -8,28 +8,20 @@ > **ProviderMetricsOptions** = `object` -Defined in: [types/analytics.ts:155](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L155) - ## Properties ### providers? > `optional` **providers?**: `string`[] -Defined in: [types/analytics.ts:156](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L156) - --- ### timeRange? > `optional` **timeRange?**: [`TimeRangeOption`](TimeRangeOption.md) \| `string` -Defined in: [types/analytics.ts:157](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L157) - --- ### metrics? > `optional` **metrics?**: `string`[] - -Defined in: [types/analytics.ts:158](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L158) diff --git a/docs/api/type-aliases/ProviderMetricsResult.md b/docs/api/type-aliases/ProviderMetricsResult.md index ce23fa4cd..795f7822e 100644 --- a/docs/api/type-aliases/ProviderMetricsResult.md +++ b/docs/api/type-aliases/ProviderMetricsResult.md @@ -8,92 +8,68 @@ > **ProviderMetricsResult** = `object` -Defined in: [types/analytics.ts:175](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L175) - ## Properties ### averageLatency > **averageLatency**: `number` -Defined in: [types/analytics.ts:176](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L176) - --- ### averageResponseTime > **averageResponseTime**: `number` -Defined in: [types/analytics.ts:177](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L177) - --- ### totalTokens > **totalTokens**: `number` -Defined in: [types/analytics.ts:178](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L178) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/analytics.ts:179](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L179) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/analytics.ts:180](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L180) - --- ### errorRate > **errorRate**: `number` -Defined in: [types/analytics.ts:181](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L181) - --- ### successRate > **successRate**: `number` -Defined in: [types/analytics.ts:182](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L182) - --- ### costPerToken > **costPerToken**: `number` -Defined in: [types/analytics.ts:183](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L183) - --- ### totalCost > **totalCost**: `number` -Defined in: [types/analytics.ts:184](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L184) - --- ### requestCount > **requestCount**: `number` -Defined in: [types/analytics.ts:185](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L185) - --- ### providers > **providers**: [`ProviderMetricItem`](ProviderMetricItem.md)[] - -Defined in: [types/analytics.ts:186](https://github.com/juspay/neurolink/blob/release/src/lib/types/analytics.ts#L186) diff --git a/docs/api/type-aliases/ProviderModelConfig.md b/docs/api/type-aliases/ProviderModelConfig.md index 5cb4a6f3c..1434e53af 100644 --- a/docs/api/type-aliases/ProviderModelConfig.md +++ b/docs/api/type-aliases/ProviderModelConfig.md @@ -8,8 +8,6 @@ > **ProviderModelConfig** = `object` -Defined in: [types/evaluationProviders.ts:14](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L14) - Legacy provider model configuration for evaluation ## Properties @@ -18,40 +16,30 @@ Legacy provider model configuration for evaluation > **provider**: `string` -Defined in: [types/evaluationProviders.ts:15](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L15) - --- ### models > **models**: `string`[] -Defined in: [types/evaluationProviders.ts:16](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L16) - --- ### costPerToken? > `optional` **costPerToken?**: `number` \| \{ `input`: `number`; `output`: `number`; \} -Defined in: [types/evaluationProviders.ts:17](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L17) - --- ### requiresApiKey? > `optional` **requiresApiKey?**: `string`[] -Defined in: [types/evaluationProviders.ts:18](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L18) - --- ### performance? > `optional` **performance?**: `object` -Defined in: [types/evaluationProviders.ts:19](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L19) - #### averageLatency? > `optional` **averageLatency?**: `number` diff --git a/docs/api/type-aliases/ProviderModelManifest.md b/docs/api/type-aliases/ProviderModelManifest.md index 47bd583e5..9b0d2709e 100644 --- a/docs/api/type-aliases/ProviderModelManifest.md +++ b/docs/api/type-aliases/ProviderModelManifest.md @@ -8,8 +8,6 @@ > **ProviderModelManifest** = `object` -Defined in: [types/model.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L343) - One provider's complete model manifest: every model NeuroLink knows about for that provider, plus the provider-wide fallback used when a caller passes a model id the manifest has never seen (a symbolic/local provider @@ -21,8 +19,6 @@ model, or a brand-new release the manifest hasn't been updated for yet). > **defaultContextWindow**: `number` -Defined in: [types/model.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L345) - Used for `_default`-key lookups and providers with no named-model list. --- @@ -31,8 +27,6 @@ Used for `_default`-key lookups and providers with no named-model list. > `optional` **familyRules?**: [`ManifestFamilyRule`](ManifestFamilyRule.md)[] -Defined in: [types/model.ts:347](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L347) - Applied, in order, to the resolved entry (see manifestRegistry.ts). --- @@ -41,6 +35,4 @@ Applied, in order, to the resolved entry (see manifestRegistry.ts). > **models**: `Record`\<`string`, [`ProviderModelManifestEntry`](ProviderModelManifestEntry.md)\> -Defined in: [types/model.ts:349](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L349) - Keyed by canonical model id (the same id `ModelInfo.id` / AIProvider calls use). diff --git a/docs/api/type-aliases/ProviderModelManifestEntry.md b/docs/api/type-aliases/ProviderModelManifestEntry.md index 51f0a1d28..56b67e83d 100644 --- a/docs/api/type-aliases/ProviderModelManifestEntry.md +++ b/docs/api/type-aliases/ProviderModelManifestEntry.md @@ -8,8 +8,6 @@ > **ProviderModelManifestEntry** = `object` -Defined in: [types/model.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L285) - A single model's metadata inside a provider's manifest. This is the one canonical shape every model-metadata consumer (context windows, pricing, MODEL_REGISTRY, vision capability, output-token ceilings) is intended to @@ -28,8 +26,6 @@ need to distinguish "free" from "unknown" already have `hasPricing()` > **aliases**: `string`[] -Defined in: [types/model.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L287) - Alternate identifiers that resolve to this canonical model id. --- @@ -38,8 +34,6 @@ Alternate identifiers that resolve to this canonical model id. > `optional` **displayName?**: `string` -Defined in: [types/model.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L289) - Human-readable name. Falls back to a mechanical id-derived name when absent. --- @@ -48,24 +42,18 @@ Human-readable name. Falls back to a mechanical id-derived name when absent. > **contextWindow**: `number` -Defined in: [types/model.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L290) - --- ### maxOutputTokens > **maxOutputTokens**: `number` -Defined in: [types/model.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L291) - --- ### pricingPerMTok? > `optional` **pricingPerMTok?**: `object` -Defined in: [types/model.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L292) - #### input > **input**: `number` @@ -88,48 +76,36 @@ Defined in: [types/model.ts:292](https://github.com/juspay/neurolink/blob/releas > **vision**: `boolean` -Defined in: [types/model.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L298) - --- ### nativeAudio? > `optional` **nativeAudio?**: `boolean` -Defined in: [types/model.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L299) - --- ### functionCalling > **functionCalling**: `boolean` -Defined in: [types/model.ts:300](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L300) - --- ### reasoning? > `optional` **reasoning?**: `boolean` -Defined in: [types/model.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L301) - --- ### jsonMode? > `optional` **jsonMode?**: `boolean` -Defined in: [types/model.ts:302](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L302) - --- ### samplingParams? > `optional` **samplingParams?**: `boolean` -Defined in: [types/model.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L308) - Whether the model accepts classic sampling parameters (temperature/topP). Mirrors ModelCapabilities.samplingParams (src/lib/types/model.ts:131) — unset means supported. @@ -140,8 +116,6 @@ unset means supported. > `optional` **curated?**: `object` -Defined in: [types/model.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/model.ts#L318) - Hand-tuned ModelInfo.performance/useCases/category values, carried forward verbatim for the ids that already had a MODEL_REGISTRY entry before this migration. Absent for every id that never had one — those diff --git a/docs/api/type-aliases/ProviderMultimodalPayload.md b/docs/api/type-aliases/ProviderMultimodalPayload.md index a31731c68..1a735a5ba 100644 --- a/docs/api/type-aliases/ProviderMultimodalPayload.md +++ b/docs/api/type-aliases/ProviderMultimodalPayload.md @@ -8,8 +8,6 @@ > **ProviderMultimodalPayload** = `object` -Defined in: [types/multimodal.ts:594](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L594) - Provider-specific multimodal payload ## Indexable @@ -22,28 +20,20 @@ Provider-specific multimodal payload > **provider**: `string` -Defined in: [types/multimodal.ts:595](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L595) - --- ### model > **model**: `string` -Defined in: [types/multimodal.ts:596](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L596) - --- ### messages? > `optional` **messages?**: [`MultimodalMessage`](MultimodalMessage.md)[] -Defined in: [types/multimodal.ts:597](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L597) - --- ### contents? > `optional` **contents?**: `unknown`[] - -Defined in: [types/multimodal.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/multimodal.ts#L598) diff --git a/docs/api/type-aliases/ProviderName.md b/docs/api/type-aliases/ProviderName.md index a4ec30a84..b9f4840aa 100644 --- a/docs/api/type-aliases/ProviderName.md +++ b/docs/api/type-aliases/ProviderName.md @@ -8,6 +8,4 @@ > **ProviderName** = _typeof_ [`AIProviderName`](../enumerations/AIProviderName.md)\[keyof _typeof_ [`AIProviderName`](../enumerations/AIProviderName.md)\] -Defined in: [types/providers.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L104) - Extract provider names from enum diff --git a/docs/api/type-aliases/ProviderOperationConfig.md b/docs/api/type-aliases/ProviderOperationConfig.md index a8b9f5f40..29675fada 100644 --- a/docs/api/type-aliases/ProviderOperationConfig.md +++ b/docs/api/type-aliases/ProviderOperationConfig.md @@ -8,6 +8,4 @@ > **ProviderOperationConfig** = _typeof_ `PROVIDER_OPERATION_CONFIGS`\[keyof _typeof_ `PROVIDER_OPERATION_CONFIGS`\] -Defined in: [types/config.ts:584](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L584) - Provider-specific operation config. diff --git a/docs/api/type-aliases/ProviderPairResult.md b/docs/api/type-aliases/ProviderPairResult.md index 18431fda1..71d4532dc 100644 --- a/docs/api/type-aliases/ProviderPairResult.md +++ b/docs/api/type-aliases/ProviderPairResult.md @@ -8,8 +8,6 @@ > **ProviderPairResult**\<`T`\> = `object` -Defined in: [types/aliases.ts:378](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L378) - Provider pair result for fallback configurations Used when creating primary/fallback provider setups @@ -25,12 +23,8 @@ Used when creating primary/fallback provider setups > **primary**: `T` -Defined in: [types/aliases.ts:379](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L379) - --- ### fallback > **fallback**: `T` - -Defined in: [types/aliases.ts:380](https://github.com/juspay/neurolink/blob/release/src/lib/types/aliases.ts#L380) diff --git a/docs/api/type-aliases/ProviderPerformanceAnalytics.md b/docs/api/type-aliases/ProviderPerformanceAnalytics.md index d505e624d..89247faa9 100644 --- a/docs/api/type-aliases/ProviderPerformanceAnalytics.md +++ b/docs/api/type-aliases/ProviderPerformanceAnalytics.md @@ -8,8 +8,6 @@ > **ProviderPerformanceAnalytics** = `object` -Defined in: [types/evaluationProviders.ts:53](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L53) - Provider performance analytics result ## Properties @@ -18,44 +16,32 @@ Provider performance analytics result > **avgResponseTime**: `number` -Defined in: [types/evaluationProviders.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L54) - --- ### successRate > **successRate**: `number` -Defined in: [types/evaluationProviders.ts:55](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L55) - --- ### tokenThroughput > **tokenThroughput**: `number` -Defined in: [types/evaluationProviders.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L56) - --- ### costEfficiency > **costEfficiency**: `number` -Defined in: [types/evaluationProviders.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L57) - --- ### recommendation > **recommendation**: `string` -Defined in: [types/evaluationProviders.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L58) - --- ### sampleCount > **sampleCount**: `number` - -Defined in: [types/evaluationProviders.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L59) diff --git a/docs/api/type-aliases/ProviderPerformanceData.md b/docs/api/type-aliases/ProviderPerformanceData.md index 5f78e83b3..c8227c2d8 100644 --- a/docs/api/type-aliases/ProviderPerformanceData.md +++ b/docs/api/type-aliases/ProviderPerformanceData.md @@ -8,8 +8,6 @@ > **ProviderPerformanceData** = `object` -Defined in: [types/evaluationProviders.ts:43](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L43) - Provider performance recording data ## Properties @@ -18,28 +16,20 @@ Provider performance recording data > **responseTime**: `number` -Defined in: [types/evaluationProviders.ts:44](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L44) - --- ### tokensGenerated > **tokensGenerated**: `number` -Defined in: [types/evaluationProviders.ts:45](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L45) - --- ### cost > **cost**: `number` -Defined in: [types/evaluationProviders.ts:46](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L46) - --- ### success > **success**: `boolean` - -Defined in: [types/evaluationProviders.ts:47](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L47) diff --git a/docs/api/type-aliases/ProviderPerformanceMetrics.md b/docs/api/type-aliases/ProviderPerformanceMetrics.md index 7a03696ed..fe9bdac94 100644 --- a/docs/api/type-aliases/ProviderPerformanceMetrics.md +++ b/docs/api/type-aliases/ProviderPerformanceMetrics.md @@ -8,8 +8,6 @@ > **ProviderPerformanceMetrics** = `object` -Defined in: [types/evaluationProviders.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L31) - Real-time provider performance tracking metrics ## Properties @@ -18,44 +16,32 @@ Real-time provider performance tracking metrics > **responseTime**: `number`[] -Defined in: [types/evaluationProviders.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L32) - --- ### successRate > **successRate**: `number` -Defined in: [types/evaluationProviders.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L33) - --- ### tokenThroughput > **tokenThroughput**: `number` -Defined in: [types/evaluationProviders.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L34) - --- ### costEfficiency > **costEfficiency**: `number` -Defined in: [types/evaluationProviders.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L35) - --- ### lastUpdated > **lastUpdated**: `Date` -Defined in: [types/evaluationProviders.ts:36](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L36) - --- ### sampleCount > **sampleCount**: `number` - -Defined in: [types/evaluationProviders.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L37) diff --git a/docs/api/type-aliases/ProviderRegistration.md b/docs/api/type-aliases/ProviderRegistration.md index dfbcbad49..efe11844f 100644 --- a/docs/api/type-aliases/ProviderRegistration.md +++ b/docs/api/type-aliases/ProviderRegistration.md @@ -8,8 +8,6 @@ > **ProviderRegistration** = `object` -Defined in: [types/providers.ts:2230](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2230) - Provider registration entry held by ProviderFactory. ## Properties @@ -18,28 +16,20 @@ Provider registration entry held by ProviderFactory. > **constructor**: [`ProviderConstructor`](ProviderConstructor.md) -Defined in: [types/providers.ts:2231](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2231) - --- ### defaultModel? > `optional` **defaultModel?**: `string` -Defined in: [types/providers.ts:2232](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2232) - --- ### aliases? > `optional` **aliases?**: `string`[] -Defined in: [types/providers.ts:2233](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2233) - --- ### descriptor? > `optional` **descriptor?**: [`ProviderDescriptor`](ProviderDescriptor.md) - -Defined in: [types/providers.ts:2234](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2234) diff --git a/docs/api/type-aliases/ProviderRegistryOptions.md b/docs/api/type-aliases/ProviderRegistryOptions.md index 7bb9b9f65..7fbfed68e 100644 --- a/docs/api/type-aliases/ProviderRegistryOptions.md +++ b/docs/api/type-aliases/ProviderRegistryOptions.md @@ -8,8 +8,6 @@ > **ProviderRegistryOptions** = `object` -Defined in: [types/providers.ts:1026](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1026) - Configuration options for the provider registry ## Properties @@ -18,7 +16,5 @@ Configuration options for the provider registry > `optional` **enableManualMCP?**: `boolean` -Defined in: [types/providers.ts:1031](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1031) - Enable loading of manual MCP configurations from .mcp-config.json Should only be true for CLI mode, false for SDK mode diff --git a/docs/api/type-aliases/ProviderRuntimeConfig.md b/docs/api/type-aliases/ProviderRuntimeConfig.md index 2c1ea691a..a9fb76eea 100644 --- a/docs/api/type-aliases/ProviderRuntimeConfig.md +++ b/docs/api/type-aliases/ProviderRuntimeConfig.md @@ -8,8 +8,6 @@ > **ProviderRuntimeConfig** = `object` -Defined in: [types/config.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L315) - Provider-specific configuration ## Indexable @@ -22,84 +20,62 @@ Provider-specific configuration > `optional` **model?**: `string` -Defined in: [types/config.ts:316](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L316) - --- ### available? > `optional` **available?**: `boolean` -Defined in: [types/config.ts:317](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L317) - --- ### lastCheck? > `optional` **lastCheck?**: `number` -Defined in: [types/config.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L318) - --- ### reason? > `optional` **reason?**: `string` -Defined in: [types/config.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L319) - --- ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/config.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L320) - --- ### endpoint? > `optional` **endpoint?**: `string` -Defined in: [types/config.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L321) - --- ### maxTokens? > `optional` **maxTokens?**: `number` -Defined in: [types/config.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L322) - --- ### temperature? > `optional` **temperature?**: `number` -Defined in: [types/config.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L323) - --- ### timeout? > `optional` **timeout?**: `number` -Defined in: [types/config.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L324) - --- ### costPerToken? > `optional` **costPerToken?**: `number` -Defined in: [types/config.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L325) - --- ### features? > `optional` **features?**: `string`[] - -Defined in: [types/config.ts:326](https://github.com/juspay/neurolink/blob/release/src/lib/types/config.ts#L326) diff --git a/docs/api/type-aliases/ProviderScoringResult.md b/docs/api/type-aliases/ProviderScoringResult.md index 076132bb7..42293977c 100644 --- a/docs/api/type-aliases/ProviderScoringResult.md +++ b/docs/api/type-aliases/ProviderScoringResult.md @@ -8,8 +8,6 @@ > **ProviderScoringResult** = `object` -Defined in: [types/evaluationProviders.ts:75](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L75) - Provider scoring result ## Properties @@ -18,20 +16,14 @@ Provider scoring result > **provider**: [`ProviderModelConfig`](ProviderModelConfig.md) -Defined in: [types/evaluationProviders.ts:76](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L76) - --- ### score > **score**: `number` -Defined in: [types/evaluationProviders.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L77) - --- ### metrics > **metrics**: [`ProviderPerformanceMetrics`](ProviderPerformanceMetrics.md) \| `null` - -Defined in: [types/evaluationProviders.ts:78](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L78) diff --git a/docs/api/type-aliases/ProviderSelectionCriteria.md b/docs/api/type-aliases/ProviderSelectionCriteria.md index 78bb62b21..273babbf2 100644 --- a/docs/api/type-aliases/ProviderSelectionCriteria.md +++ b/docs/api/type-aliases/ProviderSelectionCriteria.md @@ -8,8 +8,6 @@ > **ProviderSelectionCriteria** = `object` -Defined in: [types/evaluationProviders.ts:104](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L104) - Provider selection criteria ## Properties @@ -18,44 +16,32 @@ Provider selection criteria > **priority**: [`PerformancePriority`](PerformancePriority.md) -Defined in: [types/evaluationProviders.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L105) - --- ### maxCost? > `optional` **maxCost?**: `number` -Defined in: [types/evaluationProviders.ts:106](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L106) - --- ### minSuccessRate? > `optional` **minSuccessRate?**: `number` -Defined in: [types/evaluationProviders.ts:107](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L107) - --- ### maxResponseTime? > `optional` **maxResponseTime?**: `number` -Defined in: [types/evaluationProviders.ts:108](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L108) - --- ### excludeProviders? > `optional` **excludeProviders?**: `string`[] -Defined in: [types/evaluationProviders.ts:109](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L109) - --- ### requireCapabilities? > `optional` **requireCapabilities?**: `string`[] - -Defined in: [types/evaluationProviders.ts:110](https://github.com/juspay/neurolink/blob/release/src/lib/types/evaluationProviders.ts#L110) diff --git a/docs/api/type-aliases/ProviderSetupArgv.md b/docs/api/type-aliases/ProviderSetupArgv.md index 3de1fadc3..fa0064487 100644 --- a/docs/api/type-aliases/ProviderSetupArgv.md +++ b/docs/api/type-aliases/ProviderSetupArgv.md @@ -8,8 +8,6 @@ > **ProviderSetupArgv** = `object` -Defined in: [types/cli.ts:1514](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1514) - Shared yargs-argv shape for every provider-specific CLI setup command. ## Properties @@ -18,12 +16,8 @@ Shared yargs-argv shape for every provider-specific CLI setup command. > `optional` **check?**: `boolean` -Defined in: [types/cli.ts:1515](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1515) - --- ### nonInteractive? > `optional` **nonInteractive?**: `boolean` - -Defined in: [types/cli.ts:1516](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1516) diff --git a/docs/api/type-aliases/ProviderSetupConfig.md b/docs/api/type-aliases/ProviderSetupConfig.md index 3b34c64dd..ade64b854 100644 --- a/docs/api/type-aliases/ProviderSetupConfig.md +++ b/docs/api/type-aliases/ProviderSetupConfig.md @@ -8,8 +8,6 @@ > **ProviderSetupConfig** = `object` -Defined in: [types/cli.ts:1524](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1524) - Superset provider-setup config. `endpoint` is Azure-only; other providers leave it undefined. Pre-consolidation there were 4 near-duplicate types (Anthropic/Azure/GoogleAI/OpenAI); they are now one. @@ -20,28 +18,20 @@ leave it undefined. Pre-consolidation there were 4 near-duplicate types > `optional` **apiKey?**: `string` -Defined in: [types/cli.ts:1525](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1525) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/cli.ts:1526](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1526) - --- ### endpoint? > `optional` **endpoint?**: `string` -Defined in: [types/cli.ts:1527](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1527) - --- ### isReconfiguring? > `optional` **isReconfiguring?**: `boolean` - -Defined in: [types/cli.ts:1528](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1528) diff --git a/docs/api/type-aliases/ProviderSetupOptions.md b/docs/api/type-aliases/ProviderSetupOptions.md index ac05510c5..b9fe7c988 100644 --- a/docs/api/type-aliases/ProviderSetupOptions.md +++ b/docs/api/type-aliases/ProviderSetupOptions.md @@ -8,8 +8,6 @@ > **ProviderSetupOptions** = `object` -Defined in: [types/cli.ts:1508](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1508) - Shared options for every provider-specific CLI setup command (anthropic, azure, bedrock, gcp, google-ai, openai). @@ -19,12 +17,8 @@ Shared options for every provider-specific CLI setup command > `optional` **checkOnly?**: `boolean` -Defined in: [types/cli.ts:1509](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1509) - --- ### interactive? > `optional` **interactive?**: `boolean` - -Defined in: [types/cli.ts:1510](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L1510) diff --git a/docs/api/type-aliases/ProviderStatus.md b/docs/api/type-aliases/ProviderStatus.md index 1f210dde0..ea2d344ef 100644 --- a/docs/api/type-aliases/ProviderStatus.md +++ b/docs/api/type-aliases/ProviderStatus.md @@ -8,8 +8,6 @@ > **ProviderStatus** = `object` -Defined in: [types/providers.ts:126](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L126) - Provider status information ## Properties @@ -18,64 +16,48 @@ Provider status information > **provider**: `string` -Defined in: [types/providers.ts:127](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L127) - --- ### status > **status**: `"working"` \| `"failed"` \| `"not-configured"` -Defined in: [types/providers.ts:128](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L128) - --- ### configured > **configured**: `boolean` -Defined in: [types/providers.ts:129](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L129) - --- ### authenticated > **authenticated**: `boolean` -Defined in: [types/providers.ts:130](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L130) - --- ### error? > `optional` **error?**: `string` -Defined in: [types/providers.ts:131](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L131) - --- ### responseTime? > `optional` **responseTime?**: `number` -Defined in: [types/providers.ts:132](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L132) - --- ### model? > `optional` **model?**: `string` -Defined in: [types/providers.ts:133](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L133) - --- ### subscription? > `optional` **subscription?**: [`SubscriptionInfo`](SubscriptionInfo.md) -Defined in: [types/providers.ts:138](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L138) - Subscription information for providers that support subscription tiers (e.g., Anthropic Claude with Pro/Max/Team/Enterprise subscriptions) @@ -85,6 +67,4 @@ Subscription information for providers that support subscription tiers > `optional` **authMethod?**: [`AnthropicAuthMethod`](AnthropicAuthMethod.md) -Defined in: [types/providers.ts:142](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L142) - The authentication method currently in use for this provider diff --git a/docs/api/type-aliases/ProviderStatusArgs.md b/docs/api/type-aliases/ProviderStatusArgs.md index 648baa36b..7480f0cf5 100644 --- a/docs/api/type-aliases/ProviderStatusArgs.md +++ b/docs/api/type-aliases/ProviderStatusArgs.md @@ -8,8 +8,6 @@ > **ProviderStatusArgs** = [`BaseCommandArgs`](BaseCommandArgs.md) & `object` -Defined in: [types/cli.ts:400](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L400) - Provider status command arguments ## Type Declaration diff --git a/docs/api/type-aliases/ProviderStreamChunk.md b/docs/api/type-aliases/ProviderStreamChunk.md index c9a16c9c5..84b0302cf 100644 --- a/docs/api/type-aliases/ProviderStreamChunk.md +++ b/docs/api/type-aliases/ProviderStreamChunk.md @@ -8,6 +8,4 @@ > **ProviderStreamChunk** = \{ `content`: `string`; \} \| \{ `type`: `"audio"`; `audio`: [`AudioChunk`](AudioChunk.md); \} \| \{ `type`: `"tts_audio"`; `audio`: [`TTSChunk`](TTSChunk.md); \} \| \{ `type`: `"image"`; `imageOutput`: \{ `base64`: `string`; \}; \} -Defined in: [types/stream.ts:233](https://github.com/juspay/neurolink/blob/release/src/lib/types/stream.ts#L233) - Provider-level chunks accepted by NeuroLink's core streaming pipeline. diff --git a/docs/api/type-aliases/ProviderTokenStats.md b/docs/api/type-aliases/ProviderTokenStats.md index cd6d24bf4..543928b12 100644 --- a/docs/api/type-aliases/ProviderTokenStats.md +++ b/docs/api/type-aliases/ProviderTokenStats.md @@ -8,8 +8,6 @@ > **ProviderTokenStats** = `object` -Defined in: [types/observability.ts:431](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L431) - Token usage statistics by provider ## Properties @@ -18,44 +16,32 @@ Token usage statistics by provider > **provider**: `string` -Defined in: [types/observability.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L432) - --- ### inputTokens > **inputTokens**: `number` -Defined in: [types/observability.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L433) - --- ### outputTokens > **outputTokens**: `number` -Defined in: [types/observability.ts:434](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L434) - --- ### totalTokens > **totalTokens**: `number` -Defined in: [types/observability.ts:435](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L435) - --- ### cost > **cost**: `number` -Defined in: [types/observability.ts:436](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L436) - --- ### requestCount > **requestCount**: `number` - -Defined in: [types/observability.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/types/observability.ts#L437) diff --git a/docs/api/type-aliases/ProxyAccount.md b/docs/api/type-aliases/ProxyAccount.md index c899030c0..8fa43b088 100644 --- a/docs/api/type-aliases/ProxyAccount.md +++ b/docs/api/type-aliases/ProxyAccount.md @@ -8,8 +8,6 @@ > **ProxyAccount** = `object` -Defined in: [types/subscription.ts:1163](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1163) - A single Claude account in the pool ## Properties @@ -18,84 +16,62 @@ A single Claude account in the pool > **id**: `string` -Defined in: [types/subscription.ts:1164](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1164) - --- ### label? > `optional` **label?**: `string` -Defined in: [types/subscription.ts:1165](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1165) - --- ### type > **type**: `"oauth"` \| `"api_key"` -Defined in: [types/subscription.ts:1166](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1166) - --- ### tokens? > `optional` **tokens?**: [`StoredOAuthTokens`](StoredOAuthTokens.md) -Defined in: [types/subscription.ts:1167](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1167) - --- ### apiKey? > `optional` **apiKey?**: `string` -Defined in: [types/subscription.ts:1168](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1168) - --- ### status > **status**: `"healthy"` \| `"cooling"` \| `"disabled"` -Defined in: [types/subscription.ts:1169](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1169) - --- ### cooldownUntil? > `optional` **cooldownUntil?**: `number` -Defined in: [types/subscription.ts:1170](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1170) - --- ### consecutiveFailures > **consecutiveFailures**: `number` -Defined in: [types/subscription.ts:1171](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1171) - --- ### requestCount > **requestCount**: `number` -Defined in: [types/subscription.ts:1172](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1172) - --- ### lastUsed > **lastUsed**: `number` -Defined in: [types/subscription.ts:1173](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1173) - --- ### subscriptionTier? > `optional` **subscriptionTier?**: [`ClaudeSubscriptionTier`](ClaudeSubscriptionTier.md) - -Defined in: [types/subscription.ts:1174](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1174) diff --git a/docs/api/type-aliases/ProxyAccountConfig.md b/docs/api/type-aliases/ProxyAccountConfig.md index 56d1b7bd1..b587549ab 100644 --- a/docs/api/type-aliases/ProxyAccountConfig.md +++ b/docs/api/type-aliases/ProxyAccountConfig.md @@ -8,8 +8,6 @@ > **ProxyAccountConfig** = `object` -Defined in: [types/proxy.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L501) - Individual account configuration within a proxy config file. ## Properties @@ -18,8 +16,6 @@ Individual account configuration within a proxy config file. > **name**: `string` -Defined in: [types/proxy.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L503) - Human-readable name for the account --- @@ -28,8 +24,6 @@ Human-readable name for the account > **apiKey**: `string` -Defined in: [types/proxy.ts:505](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L505) - API key or token (may contain env var references) --- @@ -38,8 +32,6 @@ API key or token (may contain env var references) > `optional` **baseUrl?**: `string` -Defined in: [types/proxy.ts:507](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L507) - Base URL override for the provider endpoint --- @@ -48,8 +40,6 @@ Base URL override for the provider endpoint > `optional` **orgId?**: `string` -Defined in: [types/proxy.ts:509](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L509) - Organization ID (e.g., OpenAI orgs) --- @@ -58,8 +48,6 @@ Organization ID (e.g., OpenAI orgs) > `optional` **weight?**: `number` -Defined in: [types/proxy.ts:511](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L511) - Weight for weighted round-robin selection (default: 1) --- @@ -68,8 +56,6 @@ Weight for weighted round-robin selection (default: 1) > `optional` **enabled?**: `boolean` -Defined in: [types/proxy.ts:513](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L513) - Whether this account is currently enabled (default: true) --- @@ -78,8 +64,6 @@ Whether this account is currently enabled (default: true) > `optional` **rateLimit?**: `number` -Defined in: [types/proxy.ts:515](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L515) - Maximum requests per minute for this account --- @@ -88,6 +72,4 @@ Maximum requests per minute for this account > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/proxy.ts:517](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L517) - Arbitrary metadata attached to the account diff --git a/docs/api/type-aliases/ProxyAccountDirectoryOverride.md b/docs/api/type-aliases/ProxyAccountDirectoryOverride.md index 7ed880a9c..cdc70fe6b 100644 --- a/docs/api/type-aliases/ProxyAccountDirectoryOverride.md +++ b/docs/api/type-aliases/ProxyAccountDirectoryOverride.md @@ -8,8 +8,6 @@ > **ProxyAccountDirectoryOverride** = `object` -Defined in: [types/proxy.ts:1931](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1931) - Test-only replacement for the token store behind the account-exposing routes. The token store is a module singleton bound to the real home at import, so a suite cannot redirect it; this lets a case state which logins @@ -22,20 +20,14 @@ engine, exactly as the real listers would answer. > **knownKeys**: `Set`\<`string`\> -Defined in: [types/proxy.ts:1932](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1932) - --- ### anthropic > **anthropic**: [`ProxyPassthroughAccount`](ProxyPassthroughAccount.md)[] -Defined in: [types/proxy.ts:1933](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1933) - --- ### codex > **codex**: [`ProxyPassthroughAccount`](ProxyPassthroughAccount.md)[] - -Defined in: [types/proxy.ts:1934](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1934) diff --git a/docs/api/type-aliases/ProxyAccountPrecedenceReason.md b/docs/api/type-aliases/ProxyAccountPrecedenceReason.md index 107f848e0..a1785dd46 100644 --- a/docs/api/type-aliases/ProxyAccountPrecedenceReason.md +++ b/docs/api/type-aliases/ProxyAccountPrecedenceReason.md @@ -8,6 +8,4 @@ > **ProxyAccountPrecedenceReason** = `Extract`\<[`ProxyAccountRoutingReason`](ProxyAccountRoutingReason.md), `"session_affinity"` \| `"preferred_primary"`\> -Defined in: [types/proxy.ts:745](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L745) - The reasons a precedence step (affinity, then prefer-primary) places rank 0. diff --git a/docs/api/type-aliases/ProxyAccountProvider.md b/docs/api/type-aliases/ProxyAccountProvider.md index 4a87e5614..fb6c904b1 100644 --- a/docs/api/type-aliases/ProxyAccountProvider.md +++ b/docs/api/type-aliases/ProxyAccountProvider.md @@ -8,6 +8,4 @@ > **ProxyAccountProvider** = `"anthropic"` \| `"codex"` -Defined in: [types/proxy.ts:1922](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1922) - The pool engine a login belongs to, as named on limits and accounts rows. diff --git a/docs/api/type-aliases/ProxyAccountRankingPolicy.md b/docs/api/type-aliases/ProxyAccountRankingPolicy.md index 6bd94bd50..bcf91c3eb 100644 --- a/docs/api/type-aliases/ProxyAccountRankingPolicy.md +++ b/docs/api/type-aliases/ProxyAccountRankingPolicy.md @@ -7,5 +7,3 @@ # Type Alias: ProxyAccountRankingPolicy > **ProxyAccountRankingPolicy** = `"expiry-first"` \| `"headroom-first"` - -Defined in: [types/proxy.ts:707](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L707) diff --git a/docs/api/type-aliases/ProxyAccountRoutingAffinityEvidence.md b/docs/api/type-aliases/ProxyAccountRoutingAffinityEvidence.md index a36408ffd..a68aa82d6 100644 --- a/docs/api/type-aliases/ProxyAccountRoutingAffinityEvidence.md +++ b/docs/api/type-aliases/ProxyAccountRoutingAffinityEvidence.md @@ -8,36 +8,26 @@ > **ProxyAccountRoutingAffinityEvidence** = `object` -Defined in: [types/proxy.ts:725](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L725) - ## Properties ### sessionBound > **sessionBound**: `boolean` -Defined in: [types/proxy.ts:726](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L726) - --- ### boundAccount > **boundAccount**: `string` \| `null` -Defined in: [types/proxy.ts:727](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L727) - --- ### applied > **applied**: `boolean` -Defined in: [types/proxy.ts:728](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L728) - --- ### skippedReason > **skippedReason**: [`ProxyAccountRoutingAffinitySkipReason`](ProxyAccountRoutingAffinitySkipReason.md) \| `null` - -Defined in: [types/proxy.ts:729](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L729) diff --git a/docs/api/type-aliases/ProxyAccountRoutingAffinitySkipReason.md b/docs/api/type-aliases/ProxyAccountRoutingAffinitySkipReason.md index e976dc6a7..e60752b24 100644 --- a/docs/api/type-aliases/ProxyAccountRoutingAffinitySkipReason.md +++ b/docs/api/type-aliases/ProxyAccountRoutingAffinitySkipReason.md @@ -7,5 +7,3 @@ # Type Alias: ProxyAccountRoutingAffinitySkipReason > **ProxyAccountRoutingAffinitySkipReason** = `"unusable"` \| `"session_saturated"` \| `"expired"` \| `"no_session"` \| `"disabled"` - -Defined in: [types/proxy.ts:709](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L709) diff --git a/docs/api/type-aliases/ProxyAccountRoutingCandidate.md b/docs/api/type-aliases/ProxyAccountRoutingCandidate.md index a6117cdfd..c097dc539 100644 --- a/docs/api/type-aliases/ProxyAccountRoutingCandidate.md +++ b/docs/api/type-aliases/ProxyAccountRoutingCandidate.md @@ -8,296 +8,222 @@ > **ProxyAccountRoutingCandidate** = `object` -Defined in: [types/proxy.ts:598](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L598) - ## Properties ### account > **account**: `string` -Defined in: [types/proxy.ts:599](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L599) - --- ### accountType > **accountType**: [`ProxyAccountType`](ProxyAccountType.md) -Defined in: [types/proxy.ts:600](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L600) - --- ### sourceIndex > **sourceIndex**: `number` -Defined in: [types/proxy.ts:601](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L601) - --- ### rank > **rank**: `number` -Defined in: [types/proxy.ts:602](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L602) - --- ### configuredPrimary > **configuredPrimary**: `boolean` -Defined in: [types/proxy.ts:603](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L603) - --- ### usable > **usable**: `boolean` -Defined in: [types/proxy.ts:604](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L604) - --- ### saturated > **saturated**: `boolean` -Defined in: [types/proxy.ts:605](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L605) - --- ### quotaObserved > **quotaObserved**: `boolean` -Defined in: [types/proxy.ts:606](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L606) - --- ### quotaStale > **quotaStale**: `boolean` -Defined in: [types/proxy.ts:607](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L607) - --- ### quotaFreshness? > `optional` **quotaFreshness?**: [`ProxyQuotaFreshness`](ProxyQuotaFreshness.md) -Defined in: [types/proxy.ts:608](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L608) - --- ### refreshNeeded? > `optional` **refreshNeeded?**: `boolean` -Defined in: [types/proxy.ts:609](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L609) - --- ### refreshReason? > `optional` **refreshReason?**: [`ProxyQuotaRefreshReason`](ProxyQuotaRefreshReason.md) \| `null` -Defined in: [types/proxy.ts:610](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L610) - --- ### refreshInFlight? > `optional` **refreshInFlight?**: `boolean` -Defined in: [types/proxy.ts:611](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L611) - --- ### lastRefreshAttemptAt? > `optional` **lastRefreshAttemptAt?**: `number` \| `null` -Defined in: [types/proxy.ts:612](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L612) - --- ### lastRefreshSuccessAt? > `optional` **lastRefreshSuccessAt?**: `number` \| `null` -Defined in: [types/proxy.ts:613](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L613) - --- ### nextRefreshEligibleAt? > `optional` **nextRefreshEligibleAt?**: `number` \| `null` -Defined in: [types/proxy.ts:614](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L614) - --- ### saturationKind? > `optional` **saturationKind?**: [`ProxyQuotaSaturationKind`](ProxyQuotaSaturationKind.md) -Defined in: [types/proxy.ts:615](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L615) - --- ### softLimitOverrideReason? > `optional` **softLimitOverrideReason?**: `"overage"` \| `"weekly_expiry"` \| `null` -Defined in: [types/proxy.ts:616](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L616) - --- ### quotaLastUpdated > **quotaLastUpdated**: `number` \| `null` -Defined in: [types/proxy.ts:617](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L617) - --- ### quotaAgeMs > **quotaAgeMs**: `number` \| `null` -Defined in: [types/proxy.ts:618](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L618) - --- ### coolingActive > **coolingActive**: `boolean` -Defined in: [types/proxy.ts:619](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L619) - --- ### coolingReason > **coolingReason**: [`AccountCoolingReason`](AccountCoolingReason.md) \| `null` -Defined in: [types/proxy.ts:620](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L620) - --- ### coolingUntil > **coolingUntil**: `number` \| `null` -Defined in: [types/proxy.ts:621](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L621) - --- ### unifiedStatus > **unifiedStatus**: `string` \| `null` -Defined in: [types/proxy.ts:622](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L622) - --- ### fallbackStatus? > `optional` **fallbackStatus?**: `string` \| `null` -Defined in: [types/proxy.ts:623](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L623) - --- ### upgradePaths? > `optional` **upgradePaths?**: `string` \| `null` -Defined in: [types/proxy.ts:624](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L624) - --- ### overageEligible? > `optional` **overageEligible?**: `boolean` -Defined in: [types/proxy.ts:625](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L625) - --- ### overageStatus > **overageStatus**: `string` \| `null` -Defined in: [types/proxy.ts:626](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L626) - --- ### sessionStatus > **sessionStatus**: `string` \| `null` -Defined in: [types/proxy.ts:627](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L627) - --- ### sessionUsed > **sessionUsed**: `number` \| `null` -Defined in: [types/proxy.ts:628](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L628) - --- ### sessionResetAt > **sessionResetAt**: `number` \| `null` -Defined in: [types/proxy.ts:629](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L629) - --- ### sessionResetBucket > **sessionResetBucket**: `number` \| `null` -Defined in: [types/proxy.ts:630](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L630) - --- ### weeklyStatus > **weeklyStatus**: `string` \| `null` -Defined in: [types/proxy.ts:631](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L631) - --- ### weeklyUsed > **weeklyUsed**: `number` \| `null` -Defined in: [types/proxy.ts:632](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L632) - --- ### weeklyResetAt > **weeklyResetAt**: `number` \| `null` -Defined in: [types/proxy.ts:633](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L633) - --- ### scopedModel? > `optional` **scopedModel?**: `string` \| `null` -Defined in: [types/proxy.ts:637](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L637) - Display name of the model-scoped window that matched the requested model (e.g. "Fable"), or null when the account reports no scoped cap for it. Optional so schema-v1 readers of older records stay valid. @@ -308,20 +234,14 @@ Optional so schema-v1 readers of older records stay valid. > `optional` **scopedStatus?**: `string` \| `null` -Defined in: [types/proxy.ts:638](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L638) - --- ### scopedUsed? > `optional` **scopedUsed?**: `number` \| `null` -Defined in: [types/proxy.ts:639](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L639) - --- ### scopedResetAt? > `optional` **scopedResetAt?**: `number` \| `null` - -Defined in: [types/proxy.ts:640](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L640) diff --git a/docs/api/type-aliases/ProxyAccountRoutingDecision.md b/docs/api/type-aliases/ProxyAccountRoutingDecision.md index 719dcf948..d469ae2e4 100644 --- a/docs/api/type-aliases/ProxyAccountRoutingDecision.md +++ b/docs/api/type-aliases/ProxyAccountRoutingDecision.md @@ -8,140 +8,104 @@ > **ProxyAccountRoutingDecision** = `object` -Defined in: [types/proxy.ts:643](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L643) - ## Properties ### schemaVersion > **schemaVersion**: `1` -Defined in: [types/proxy.ts:644](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L644) - --- ### evaluatedAt > **evaluatedAt**: `string` -Defined in: [types/proxy.ts:645](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L645) - --- ### strategy > **strategy**: [`ProxyAccountRoutingStrategy`](ProxyAccountRoutingStrategy.md) -Defined in: [types/proxy.ts:646](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L646) - --- ### mode > **mode**: [`ProxyAccountRoutingMode`](ProxyAccountRoutingMode.md) -Defined in: [types/proxy.ts:647](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L647) - --- ### selectionReason > **selectionReason**: [`ProxyAccountRoutingReason`](ProxyAccountRoutingReason.md) -Defined in: [types/proxy.ts:648](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L648) - --- ### quotaRoutingEnabled > **quotaRoutingEnabled**: `boolean` -Defined in: [types/proxy.ts:649](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L649) - --- ### quotaInputsUsed > **quotaInputsUsed**: `boolean` -Defined in: [types/proxy.ts:650](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L650) - --- ### sessionSoftLimit > **sessionSoftLimit**: `number` -Defined in: [types/proxy.ts:651](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L651) - --- ### sessionResetToleranceMs > **sessionResetToleranceMs**: `number` -Defined in: [types/proxy.ts:652](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L652) - --- ### configuredPrimaryAccount > **configuredPrimaryAccount**: `string` \| `null` -Defined in: [types/proxy.ts:653](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L653) - --- ### configuredPrimaryMatched > **configuredPrimaryMatched**: `boolean` -Defined in: [types/proxy.ts:654](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L654) - --- ### rotationOffset > **rotationOffset**: `number` -Defined in: [types/proxy.ts:655](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L655) - --- ### initialAccount > **initialAccount**: `string` -Defined in: [types/proxy.ts:656](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L656) - --- ### candidates > **candidates**: [`ProxyAccountRoutingCandidate`](ProxyAccountRoutingCandidate.md)[] -Defined in: [types/proxy.ts:657](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L657) - --- ### policy? > `optional` **policy?**: [`ProxyRoutingPolicySnapshot`](ProxyRoutingPolicySnapshot.md) -Defined in: [types/proxy.ts:658](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L658) - --- ### affinity? > `optional` **affinity?**: [`ProxyAccountRoutingAffinityEvidence`](ProxyAccountRoutingAffinityEvidence.md) -Defined in: [types/proxy.ts:659](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L659) - --- ### spill? > `optional` **spill?**: [`ProxyAccountRoutingSpillEvidence`](ProxyAccountRoutingSpillEvidence.md) - -Defined in: [types/proxy.ts:660](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L660) diff --git a/docs/api/type-aliases/ProxyAccountRoutingMode.md b/docs/api/type-aliases/ProxyAccountRoutingMode.md index f690c4120..b93dcd499 100644 --- a/docs/api/type-aliases/ProxyAccountRoutingMode.md +++ b/docs/api/type-aliases/ProxyAccountRoutingMode.md @@ -7,5 +7,3 @@ # Type Alias: ProxyAccountRoutingMode > **ProxyAccountRoutingMode** = _typeof_ `PROXY_ACCOUNT_ROUTING_MODES`\[`number`\] - -Defined in: [types/proxy.ts:551](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L551) diff --git a/docs/api/type-aliases/ProxyAccountRoutingReason.md b/docs/api/type-aliases/ProxyAccountRoutingReason.md index e707de20c..19218091a 100644 --- a/docs/api/type-aliases/ProxyAccountRoutingReason.md +++ b/docs/api/type-aliases/ProxyAccountRoutingReason.md @@ -7,5 +7,3 @@ # Type Alias: ProxyAccountRoutingReason > **ProxyAccountRoutingReason** = _typeof_ `PROXY_ACCOUNT_ROUTING_REASONS`\[`number`\] - -Defined in: [types/proxy.ts:554](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L554) diff --git a/docs/api/type-aliases/ProxyAccountRoutingSpillEvidence.md b/docs/api/type-aliases/ProxyAccountRoutingSpillEvidence.md index aa33d81a9..b560d3c79 100644 --- a/docs/api/type-aliases/ProxyAccountRoutingSpillEvidence.md +++ b/docs/api/type-aliases/ProxyAccountRoutingSpillEvidence.md @@ -8,28 +8,20 @@ > **ProxyAccountRoutingSpillEvidence** = `object` -Defined in: [types/proxy.ts:732](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L732) - ## Properties ### from > **from**: `string` -Defined in: [types/proxy.ts:733](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L733) - --- ### to > **to**: `string` -Defined in: [types/proxy.ts:734](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L734) - --- ### inflight > **inflight**: `number` - -Defined in: [types/proxy.ts:735](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L735) diff --git a/docs/api/type-aliases/ProxyAccountRoutingStrategy.md b/docs/api/type-aliases/ProxyAccountRoutingStrategy.md index ce917c212..63fafa1ac 100644 --- a/docs/api/type-aliases/ProxyAccountRoutingStrategy.md +++ b/docs/api/type-aliases/ProxyAccountRoutingStrategy.md @@ -7,5 +7,3 @@ # Type Alias: ProxyAccountRoutingStrategy > **ProxyAccountRoutingStrategy** = _typeof_ `PROXY_ACCOUNT_ROUTING_STRATEGIES`\[`number`\] - -Defined in: [types/proxy.ts:548](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L548) diff --git a/docs/api/type-aliases/ProxyAccountSortMetrics.md b/docs/api/type-aliases/ProxyAccountSortMetrics.md index c7091f1c5..afd84ef37 100644 --- a/docs/api/type-aliases/ProxyAccountSortMetrics.md +++ b/docs/api/type-aliases/ProxyAccountSortMetrics.md @@ -8,272 +8,204 @@ > **ProxyAccountSortMetrics** = `object` -Defined in: [types/proxy.ts:663](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L663) - ## Properties ### usable > **usable**: `boolean` -Defined in: [types/proxy.ts:664](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L664) - --- ### saturated > **saturated**: `boolean` -Defined in: [types/proxy.ts:665](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L665) - --- ### hasQuota > **hasQuota**: `boolean` -Defined in: [types/proxy.ts:666](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L666) - --- ### quotaEvidenceRank > **quotaEvidenceRank**: `number` -Defined in: [types/proxy.ts:667](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L667) - --- ### quotaStale > **quotaStale**: `boolean` -Defined in: [types/proxy.ts:668](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L668) - --- ### quotaFreshness > **quotaFreshness**: [`ProxyQuotaFreshness`](ProxyQuotaFreshness.md) -Defined in: [types/proxy.ts:669](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L669) - --- ### refreshNeeded > **refreshNeeded**: `boolean` -Defined in: [types/proxy.ts:670](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L670) - --- ### refreshReason > **refreshReason**: [`ProxyQuotaRefreshReason`](ProxyQuotaRefreshReason.md) \| `null` -Defined in: [types/proxy.ts:671](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L671) - --- ### refreshInFlight > **refreshInFlight**: `boolean` -Defined in: [types/proxy.ts:672](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L672) - --- ### lastRefreshAttemptAt > **lastRefreshAttemptAt**: `number` \| `null` -Defined in: [types/proxy.ts:673](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L673) - --- ### lastRefreshSuccessAt > **lastRefreshSuccessAt**: `number` \| `null` -Defined in: [types/proxy.ts:674](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L674) - --- ### nextRefreshEligibleAt > **nextRefreshEligibleAt**: `number` \| `null` -Defined in: [types/proxy.ts:675](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L675) - --- ### saturationKind > **saturationKind**: [`ProxyQuotaSaturationKind`](ProxyQuotaSaturationKind.md) -Defined in: [types/proxy.ts:676](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L676) - --- ### softLimitOverrideReason > **softLimitOverrideReason**: `"overage"` \| `"weekly_expiry"` \| `null` -Defined in: [types/proxy.ts:677](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L677) - --- ### quotaLastUpdated > **quotaLastUpdated**: `number` \| `null` -Defined in: [types/proxy.ts:678](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L678) - --- ### quotaAgeMs > **quotaAgeMs**: `number` \| `null` -Defined in: [types/proxy.ts:679](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L679) - --- ### coolingActive > **coolingActive**: `boolean` -Defined in: [types/proxy.ts:680](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L680) - --- ### coolingReason > **coolingReason**: [`AccountCoolingReason`](AccountCoolingReason.md) \| `null` -Defined in: [types/proxy.ts:681](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L681) - --- ### coolingUntil > **coolingUntil**: `number` -Defined in: [types/proxy.ts:682](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L682) - --- ### unifiedStatus > **unifiedStatus**: `string` \| `null` -Defined in: [types/proxy.ts:683](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L683) - --- ### fallbackStatus? > `optional` **fallbackStatus?**: `string` \| `null` -Defined in: [types/proxy.ts:684](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L684) - --- ### upgradePaths? > `optional` **upgradePaths?**: `string` \| `null` -Defined in: [types/proxy.ts:685](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L685) - --- ### overageEligible? > `optional` **overageEligible?**: `boolean` -Defined in: [types/proxy.ts:686](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L686) - --- ### overageStatus > **overageStatus**: `string` \| `null` -Defined in: [types/proxy.ts:687](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L687) - --- ### sessionStatus > **sessionStatus**: `string` \| `null` -Defined in: [types/proxy.ts:688](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L688) - --- ### sessionUsed > **sessionUsed**: `number` \| `null` -Defined in: [types/proxy.ts:689](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L689) - --- ### sessionResetBucket > **sessionResetBucket**: `number` -Defined in: [types/proxy.ts:690](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L690) - --- ### sessionReset > **sessionReset**: `number` -Defined in: [types/proxy.ts:691](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L691) - --- ### weeklyStatus > **weeklyStatus**: `string` \| `null` -Defined in: [types/proxy.ts:692](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L692) - --- ### weeklyReset > **weeklyReset**: `number` -Defined in: [types/proxy.ts:693](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L693) - --- ### weeklyUsed > **weeklyUsed**: `number` \| `null` -Defined in: [types/proxy.ts:694](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L694) - --- ### weeklyUsedForSort > **weeklyUsedForSort**: `number` -Defined in: [types/proxy.ts:695](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L695) - --- ### scopedModel > **scopedModel**: `string` \| `null` -Defined in: [types/proxy.ts:699](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L699) - Model-scoped weekly window matching the requested model. All null/false when the account reports no scoped cap for it (the common case), which makes every scoped comparator rung a no-op for unscoped traffic. @@ -284,36 +216,26 @@ makes every scoped comparator rung a no-op for unscoped traffic. > **scopedStatus**: `string` \| `null` -Defined in: [types/proxy.ts:700](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L700) - --- ### scopedUsed > **scopedUsed**: `number` \| `null` -Defined in: [types/proxy.ts:701](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L701) - --- ### scopedReset > **scopedReset**: `number` -Defined in: [types/proxy.ts:702](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L702) - --- ### scopedUsedForSort > **scopedUsedForSort**: `number` -Defined in: [types/proxy.ts:703](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L703) - --- ### scopedSaturated > **scopedSaturated**: `boolean` - -Defined in: [types/proxy.ts:704](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L704) diff --git a/docs/api/type-aliases/ProxyAccountSpillMove.md b/docs/api/type-aliases/ProxyAccountSpillMove.md index c5efdf01f..e5d2146dd 100644 --- a/docs/api/type-aliases/ProxyAccountSpillMove.md +++ b/docs/api/type-aliases/ProxyAccountSpillMove.md @@ -8,7 +8,5 @@ > **ProxyAccountSpillMove** = [`ProxyAccountRoutingSpillEvidence`](ProxyAccountRoutingSpillEvidence.md) -Defined in: [types/proxy.ts:754](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L754) - A spill decision in account keys; the route reports it with account labels as ProxyAccountRoutingSpillEvidence. diff --git a/docs/api/type-aliases/ProxyAccountType.md b/docs/api/type-aliases/ProxyAccountType.md index aca705959..0f632accc 100644 --- a/docs/api/type-aliases/ProxyAccountType.md +++ b/docs/api/type-aliases/ProxyAccountType.md @@ -7,5 +7,3 @@ # Type Alias: ProxyAccountType > **ProxyAccountType** = _typeof_ `PROXY_ACCOUNT_TYPES`\[`number`\] - -Defined in: [types/proxy.ts:557](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L557) diff --git a/docs/api/type-aliases/ProxyActivitySnapshot.md b/docs/api/type-aliases/ProxyActivitySnapshot.md index 341f20384..799ef5a93 100644 --- a/docs/api/type-aliases/ProxyActivitySnapshot.md +++ b/docs/api/type-aliases/ProxyActivitySnapshot.md @@ -8,8 +8,6 @@ > **ProxyActivitySnapshot** = `object` -Defined in: [types/proxy.ts:2334](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2334) - In-process proxy request activity used to protect streaming restarts. ## Properties @@ -18,12 +16,8 @@ In-process proxy request activity used to protect streaming restarts. > **activeRequests**: `number` -Defined in: [types/proxy.ts:2335](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2335) - --- ### lastActivityAt > **lastActivityAt**: `Date` \| `null` - -Defined in: [types/proxy.ts:2336](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2336) diff --git a/docs/api/type-aliases/ProxyAffinityPrecedenceSkipReason.md b/docs/api/type-aliases/ProxyAffinityPrecedenceSkipReason.md index b33f4bb3d..b00734493 100644 --- a/docs/api/type-aliases/ProxyAffinityPrecedenceSkipReason.md +++ b/docs/api/type-aliases/ProxyAffinityPrecedenceSkipReason.md @@ -8,6 +8,4 @@ > **ProxyAffinityPrecedenceSkipReason** = `Extract`\<[`ProxyAccountRoutingAffinitySkipReason`](ProxyAccountRoutingAffinitySkipReason.md), `"unusable"` \| `"session_saturated"`\> -Defined in: [types/proxy.ts:739](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L739) - Why the precedence step skipped a bound account it could see. diff --git a/docs/api/type-aliases/ProxyAnalysisAccount.md b/docs/api/type-aliases/ProxyAnalysisAccount.md index 8475a4031..bc8d8e6b8 100644 --- a/docs/api/type-aliases/ProxyAnalysisAccount.md +++ b/docs/api/type-aliases/ProxyAnalysisAccount.md @@ -8,8 +8,6 @@ > **ProxyAnalysisAccount** = `object` -Defined in: [types/proxy.ts:2508](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2508) - Per-account request and rate-limit totals reconstructed from JSONL logs. ## Properties @@ -18,68 +16,50 @@ Per-account request and rate-limit totals reconstructed from JSONL logs. > **account**: `string` -Defined in: [types/proxy.ts:2509](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2509) - --- ### accountType > **accountType**: `string` -Defined in: [types/proxy.ts:2510](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2510) - --- ### attempts > **attempts**: `number` -Defined in: [types/proxy.ts:2511](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2511) - --- ### attemptErrors > **attemptErrors**: `number` -Defined in: [types/proxy.ts:2512](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2512) - --- ### finalRequests > **finalRequests**: `number` -Defined in: [types/proxy.ts:2513](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2513) - --- ### finalErrors > **finalErrors**: `number` -Defined in: [types/proxy.ts:2514](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2514) - --- ### transientRateLimits > **transientRateLimits**: `number` -Defined in: [types/proxy.ts:2515](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2515) - --- ### quotaRateLimits > **quotaRateLimits**: `number` -Defined in: [types/proxy.ts:2516](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2516) - --- ### unclassifiedRateLimits > **unclassifiedRateLimits**: `number` - -Defined in: [types/proxy.ts:2517](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2517) diff --git a/docs/api/type-aliases/ProxyAnalysisAttemptRecord.md b/docs/api/type-aliases/ProxyAnalysisAttemptRecord.md index cc3969ff2..a48398439 100644 --- a/docs/api/type-aliases/ProxyAnalysisAttemptRecord.md +++ b/docs/api/type-aliases/ProxyAnalysisAttemptRecord.md @@ -8,8 +8,6 @@ > **ProxyAnalysisAttemptRecord** = `object` -Defined in: [types/proxy.ts:2708](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2708) - Attempt timing retained while joining offline proxy log records. ## Properties @@ -18,28 +16,20 @@ Attempt timing retained while joining offline proxy log records. > **count**: `number` -Defined in: [types/proxy.ts:2709](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2709) - --- ### hadError > **hadError**: `boolean` -Defined in: [types/proxy.ts:2710](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2710) - --- ### totalDurationMs > **totalDurationMs**: `number` -Defined in: [types/proxy.ts:2711](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2711) - --- ### durationCount > **durationCount**: `number` - -Defined in: [types/proxy.ts:2712](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2712) diff --git a/docs/api/type-aliases/ProxyAnalysisFinalRequestRecord.md b/docs/api/type-aliases/ProxyAnalysisFinalRequestRecord.md index 6138646bd..34ee1dd6f 100644 --- a/docs/api/type-aliases/ProxyAnalysisFinalRequestRecord.md +++ b/docs/api/type-aliases/ProxyAnalysisFinalRequestRecord.md @@ -8,8 +8,6 @@ > **ProxyAnalysisFinalRequestRecord** = `object` -Defined in: [types/proxy.ts:2716](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2716) - Final request fields retained while joining offline proxy log records. ## Properties @@ -18,136 +16,102 @@ Final request fields retained while joining offline proxy log records. > `optional` **accountingScope?**: `"client"` \| `"internal"` -Defined in: [types/proxy.ts:2717](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2717) - --- ### parentRequestId? > `optional` **parentRequestId?**: `string` -Defined in: [types/proxy.ts:2718](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2718) - --- ### usageOwnerRequestId? > `optional` **usageOwnerRequestId?**: `string` -Defined in: [types/proxy.ts:2719](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2719) - --- ### firstUsefulOutputMs > **firstUsefulOutputMs**: `number` \| `null` -Defined in: [types/proxy.ts:2720](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2720) - --- ### timestamp > **timestamp**: `string` -Defined in: [types/proxy.ts:2721](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2721) - --- ### status > **status**: `number` -Defined in: [types/proxy.ts:2722](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2722) - --- ### durationMs > **durationMs**: `number` \| `null` -Defined in: [types/proxy.ts:2723](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2723) - --- ### account > **account**: `string` -Defined in: [types/proxy.ts:2724](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2724) - --- ### accountType > **accountType**: `string` -Defined in: [types/proxy.ts:2725](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2725) - --- ### model > **model**: `string` \| `null` -Defined in: [types/proxy.ts:2726](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2726) - --- ### provider > **provider**: `string` \| `null` -Defined in: [types/proxy.ts:2727](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2727) - --- ### inputIncludesCachedTokens? > `optional` **inputIncludesCachedTokens?**: `boolean` -Defined in: [types/proxy.ts:2728](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2728) - --- ### inputTokens > **inputTokens**: `number` \| `null` -Defined in: [types/proxy.ts:2729](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2729) - --- ### outputTokens > **outputTokens**: `number` \| `null` -Defined in: [types/proxy.ts:2730](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2730) - --- ### cacheReadTokens > **cacheReadTokens**: `number` \| `null` -Defined in: [types/proxy.ts:2731](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2731) - --- ### cacheCreationTokens > **cacheCreationTokens**: `number` \| `null` -Defined in: [types/proxy.ts:2732](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2732) - --- ### cacheReadTokensObserved? > `optional` **cacheReadTokensObserved?**: `boolean` -Defined in: [types/proxy.ts:2738](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2738) - False when the provider reported no cache breakdown. Such a turn is not a cache miss, so it is excluded from the hit-rate denominator rather than counted as a zero. @@ -158,28 +122,20 @@ counted as a zero. > `optional` **cacheCreationTokensObserved?**: `boolean` -Defined in: [types/proxy.ts:2739](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2739) - --- ### errorType > **errorType**: `string` \| `null` -Defined in: [types/proxy.ts:2740](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2740) - --- ### errorCode > **errorCode**: `string` \| `null` -Defined in: [types/proxy.ts:2741](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2741) - --- ### routingDecision > **routingDecision**: [`ProxyAccountRoutingDecision`](ProxyAccountRoutingDecision.md) \| `null` - -Defined in: [types/proxy.ts:2742](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2742) diff --git a/docs/api/type-aliases/ProxyAnalysisOptions.md b/docs/api/type-aliases/ProxyAnalysisOptions.md index 8f5ba145c..959e75c45 100644 --- a/docs/api/type-aliases/ProxyAnalysisOptions.md +++ b/docs/api/type-aliases/ProxyAnalysisOptions.md @@ -8,8 +8,6 @@ > **ProxyAnalysisOptions** = `object` -Defined in: [types/proxy.ts:2700](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2700) - Inputs for the offline proxy JSONL analyzer. ## Properties @@ -18,28 +16,20 @@ Inputs for the offline proxy JSONL analyzer. > `optional` **logsDir?**: `string` -Defined in: [types/proxy.ts:2701](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2701) - --- ### since? > `optional` **since?**: `string` -Defined in: [types/proxy.ts:2702](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2702) - --- ### until? > `optional` **until?**: `string` -Defined in: [types/proxy.ts:2703](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2703) - --- ### nowMs? > `optional` **nowMs?**: `number` - -Defined in: [types/proxy.ts:2704](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2704) diff --git a/docs/api/type-aliases/ProxyAnalysisReport.md b/docs/api/type-aliases/ProxyAnalysisReport.md index 45b066c73..e77f61d1c 100644 --- a/docs/api/type-aliases/ProxyAnalysisReport.md +++ b/docs/api/type-aliases/ProxyAnalysisReport.md @@ -8,16 +8,12 @@ > **ProxyAnalysisReport** = `object` -Defined in: [types/proxy.ts:2527](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2527) - ## Properties ### runtime > **runtime**: `object` -Defined in: [types/proxy.ts:2528](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2528) - #### samples > **samples**: `number` @@ -44,40 +40,30 @@ Defined in: [types/proxy.ts:2528](https://github.com/juspay/neurolink/blob/relea > **generatedAt**: `string` -Defined in: [types/proxy.ts:2535](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2535) - --- ### since > **since**: `string` -Defined in: [types/proxy.ts:2536](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2536) - --- ### until > **until**: `string` -Defined in: [types/proxy.ts:2537](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2537) - --- ### logsDir > **logsDir**: `string` -Defined in: [types/proxy.ts:2538](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2538) - --- ### files > **files**: `object` -Defined in: [types/proxy.ts:2539](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2539) - #### lifecycle > **lifecycle**: `number` @@ -100,8 +86,6 @@ Defined in: [types/proxy.ts:2539](https://github.com/juspay/neurolink/blob/relea > **coverage**: `object` -Defined in: [types/proxy.ts:2545](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2545) - #### lifecycle > **lifecycle**: `boolean` @@ -139,8 +123,6 @@ reconciliation begins at or before the requested analysis window. > **dataQuality**: `object` -Defined in: [types/proxy.ts:2556](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2556) - #### linesRead > **linesRead**: `number` @@ -241,8 +223,6 @@ Missing evidence; may include in-flight or interrupted requests. > **lifecycle**: `object` -Defined in: [types/proxy.ts:2593](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2593) - #### unconfirmedAtWorkerExit > **unconfirmedAtWorkerExit**: `object`[] @@ -305,8 +285,6 @@ Accepted metadata requests that do not require model final records. > **requests**: `object` -Defined in: [types/proxy.ts:2617](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2617) - #### completed > **completed**: `number` @@ -347,8 +325,6 @@ Linked internal adapter finals excluded from client request totals. > **attempts**: `object` -Defined in: [types/proxy.ts:2628](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2628) - #### total > **total**: `number` @@ -375,8 +351,6 @@ Defined in: [types/proxy.ts:2628](https://github.com/juspay/neurolink/blob/relea > **rateLimits**: `object` -Defined in: [types/proxy.ts:2635](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2635) - #### attemptRateLimits > **attemptRateLimits**: `number` @@ -399,8 +373,6 @@ Defined in: [types/proxy.ts:2635](https://github.com/juspay/neurolink/blob/relea > **latencyMs**: `object` -Defined in: [types/proxy.ts:2641](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2641) - #### headers > **headers**: [`ProxyLatencySummary`](ProxyLatencySummary.md) @@ -435,8 +407,6 @@ Defined in: [types/proxy.ts:2641](https://github.com/juspay/neurolink/blob/relea > **cache**: `object` -Defined in: [types/proxy.ts:2650](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2650) - #### requestsWithUsage > **requestsWithUsage**: `number` @@ -519,8 +489,6 @@ Distinct models with no pricing row at all. > **routing**: `object` -Defined in: [types/proxy.ts:2685](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2685) - #### modes > **modes**: `Record`\<`string`, `number`\> @@ -558,5 +526,3 @@ Most recent bounded sample retained for offline inspection. ### accounts > **accounts**: [`ProxyAnalysisAccount`](ProxyAnalysisAccount.md)[] - -Defined in: [types/proxy.ts:2696](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2696) diff --git a/docs/api/type-aliases/ProxyAnalysisRoutingRecord.md b/docs/api/type-aliases/ProxyAnalysisRoutingRecord.md index 5fe34794d..bd9121221 100644 --- a/docs/api/type-aliases/ProxyAnalysisRoutingRecord.md +++ b/docs/api/type-aliases/ProxyAnalysisRoutingRecord.md @@ -8,8 +8,6 @@ > **ProxyAnalysisRoutingRecord** = `object` -Defined in: [types/proxy.ts:2811](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2811) - Validated account-routing evidence joined to a final request log. ## Properties @@ -18,44 +16,32 @@ Validated account-routing evidence joined to a final request log. > **requestId**: `string` -Defined in: [types/proxy.ts:2812](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2812) - --- ### timestamp > **timestamp**: `string` -Defined in: [types/proxy.ts:2813](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2813) - --- ### responseStatus > **responseStatus**: `number` -Defined in: [types/proxy.ts:2814](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2814) - --- ### finalAccount > **finalAccount**: `string` -Defined in: [types/proxy.ts:2815](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2815) - --- ### finalAccountType > **finalAccountType**: `string` -Defined in: [types/proxy.ts:2816](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2816) - --- ### decision > **decision**: [`ProxyAccountRoutingDecision`](ProxyAccountRoutingDecision.md) - -Defined in: [types/proxy.ts:2817](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2817) diff --git a/docs/api/type-aliases/ProxyAnalysisStreamName.md b/docs/api/type-aliases/ProxyAnalysisStreamName.md index a990cea0c..bab5a2882 100644 --- a/docs/api/type-aliases/ProxyAnalysisStreamName.md +++ b/docs/api/type-aliases/ProxyAnalysisStreamName.md @@ -8,6 +8,4 @@ > **ProxyAnalysisStreamName** = `"lifecycle"` \| `"requests"` \| `"attempts"` \| `"debug"` -Defined in: [types/proxy.ts:2521](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2521) - Offline report generated from proxy request, attempt, and lifecycle logs. diff --git a/docs/api/type-aliases/ProxyAnalyzeArgs.md b/docs/api/type-aliases/ProxyAnalyzeArgs.md index 1a063fefa..9e65a8e88 100644 --- a/docs/api/type-aliases/ProxyAnalyzeArgs.md +++ b/docs/api/type-aliases/ProxyAnalyzeArgs.md @@ -8,8 +8,6 @@ > **ProxyAnalyzeArgs** = `object` -Defined in: [types/cli.ts:942](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L942) - Arguments accepted by `neurolink proxy analyze` ## Properties @@ -18,36 +16,26 @@ Arguments accepted by `neurolink proxy analyze` > `optional` **logsDir?**: `string` -Defined in: [types/cli.ts:943](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L943) - --- ### since? > `optional` **since?**: `string` -Defined in: [types/cli.ts:944](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L944) - --- ### until? > `optional` **until?**: `string` -Defined in: [types/cli.ts:945](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L945) - --- ### format? > `optional` **format?**: `"text"` \| `"json"` -Defined in: [types/cli.ts:946](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L946) - --- ### quiet? > `optional` **quiet?**: `boolean` - -Defined in: [types/cli.ts:947](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L947) diff --git a/docs/api/type-aliases/ProxyBodyCaptureAdmission.md b/docs/api/type-aliases/ProxyBodyCaptureAdmission.md index d89f5fa73..5fa116225 100644 --- a/docs/api/type-aliases/ProxyBodyCaptureAdmission.md +++ b/docs/api/type-aliases/ProxyBodyCaptureAdmission.md @@ -8,8 +8,6 @@ > **ProxyBodyCaptureAdmission** = `object` -Defined in: [types/proxy.ts:899](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L899) - Exact bounded-admission state; records no request content. ## Properties @@ -18,24 +16,18 @@ Exact bounded-admission state; records no request content. > **limitingResource**: `"entry"` \| `"captures"` \| `"bytes"` \| `"worker"` -Defined in: [types/proxy.ts:900](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L900) - --- ### estimatedBytes? > `optional` **estimatedBytes?**: `number` -Defined in: [types/proxy.ts:901](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L901) - --- ### maxEntryBytes? > `optional` **maxEntryBytes?**: `number` -Defined in: [types/proxy.ts:903](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L903) - Per-entry clone ceiling, independent of the aggregate queue ceiling. --- @@ -44,28 +36,20 @@ Per-entry clone ceiling, independent of the aggregate queue ceiling. > **pending**: `number` -Defined in: [types/proxy.ts:904](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L904) - --- ### pendingBytes > **pendingBytes**: `number` -Defined in: [types/proxy.ts:905](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L905) - --- ### maxPending > **maxPending**: `number` -Defined in: [types/proxy.ts:906](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L906) - --- ### maxPendingBytes > **maxPendingBytes**: `number` - -Defined in: [types/proxy.ts:907](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L907) diff --git a/docs/api/type-aliases/ProxyBodyCaptureEntry.md b/docs/api/type-aliases/ProxyBodyCaptureEntry.md index 48d1d0821..879190f68 100644 --- a/docs/api/type-aliases/ProxyBodyCaptureEntry.md +++ b/docs/api/type-aliases/ProxyBodyCaptureEntry.md @@ -8,8 +8,6 @@ > **ProxyBodyCaptureEntry** = `object` -Defined in: [types/proxy.ts:2877](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2877) - Single captured body/headers entry written to disk by the proxy logger. ## Properties @@ -18,8 +16,6 @@ Single captured body/headers entry written to disk by the proxy logger. > `optional` **captureId?**: `string` -Defined in: [types/proxy.ts:2879](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2879) - Unique capture identity shared by its index and every exported chunk. --- @@ -28,72 +24,54 @@ Unique capture identity shared by its index and every exported chunk. > **timestamp**: `string` -Defined in: [types/proxy.ts:2880](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2880) - --- ### requestId > **requestId**: `string` -Defined in: [types/proxy.ts:2881](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2881) - --- ### phase > **phase**: `string` -Defined in: [types/proxy.ts:2882](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2882) - --- ### model > **model**: `string` -Defined in: [types/proxy.ts:2883](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2883) - --- ### stream > **stream**: `boolean` -Defined in: [types/proxy.ts:2884](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2884) - --- ### headers? > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/proxy.ts:2885](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2885) - --- ### body? > `optional` **body?**: `unknown` -Defined in: [types/proxy.ts:2886](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2886) - --- ### bodySize? > `optional` **bodySize?**: `number` -Defined in: [types/proxy.ts:2887](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2887) - --- ### sourceTruncated? > `optional` **sourceTruncated?**: `boolean` -Defined in: [types/proxy.ts:2889](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2889) - The bounded stream observer omitted a suffix before redaction/processing. --- @@ -102,72 +80,54 @@ The bounded stream observer omitted a suffix before redaction/processing. > `optional` **contentType?**: `string` -Defined in: [types/proxy.ts:2890](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2890) - --- ### responseStatus? > `optional` **responseStatus?**: `number` -Defined in: [types/proxy.ts:2891](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2891) - --- ### durationMs? > `optional` **durationMs?**: `number` -Defined in: [types/proxy.ts:2892](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2892) - --- ### account? > `optional` **account?**: `string` -Defined in: [types/proxy.ts:2893](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2893) - --- ### accountType? > `optional` **accountType?**: `string` -Defined in: [types/proxy.ts:2894](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2894) - --- ### attempt? > `optional` **attempt?**: `number` -Defined in: [types/proxy.ts:2895](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2895) - --- ### traceId? > `optional` **traceId?**: `string` -Defined in: [types/proxy.ts:2896](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2896) - --- ### spanId? > `optional` **spanId?**: `string` -Defined in: [types/proxy.ts:2897](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2897) - --- ### traceFlags? > `optional` **traceFlags?**: `number` -Defined in: [types/proxy.ts:2899](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2899) - Original OTel sampling flags retained through deferred logging. --- @@ -175,5 +135,3 @@ Original OTel sampling flags retained through deferred logging. ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/proxy.ts:2900](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2900) diff --git a/docs/api/type-aliases/ProxyBodyCaptureInput.md b/docs/api/type-aliases/ProxyBodyCaptureInput.md index 64bff416b..931ca8c29 100644 --- a/docs/api/type-aliases/ProxyBodyCaptureInput.md +++ b/docs/api/type-aliases/ProxyBodyCaptureInput.md @@ -8,24 +8,18 @@ > **ProxyBodyCaptureInput** = `object` -Defined in: [types/proxy.ts:1233](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1233) - ## Properties ### phase > **phase**: `string` -Defined in: [types/proxy.ts:1234](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1234) - --- ### sourceTruncated? > `optional` **sourceTruncated?**: `boolean` -Defined in: [types/proxy.ts:1236](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1236) - The stream observer retained only a bounded prefix. --- @@ -34,76 +28,56 @@ The stream observer retained only a bounded prefix. > `optional` **headers?**: `Record`\<`string`, `string`\> -Defined in: [types/proxy.ts:1237](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1237) - --- ### body? > `optional` **body?**: `unknown` -Defined in: [types/proxy.ts:1238](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1238) - --- ### bodySize? > `optional` **bodySize?**: `number` -Defined in: [types/proxy.ts:1239](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1239) - --- ### contentType? > `optional` **contentType?**: `string` -Defined in: [types/proxy.ts:1240](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1240) - --- ### responseStatus? > `optional` **responseStatus?**: `number` -Defined in: [types/proxy.ts:1241](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1241) - --- ### durationMs? > `optional` **durationMs?**: `number` -Defined in: [types/proxy.ts:1242](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1242) - --- ### account? > `optional` **account?**: `string` -Defined in: [types/proxy.ts:1243](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1243) - --- ### accountType? > `optional` **accountType?**: `string` -Defined in: [types/proxy.ts:1244](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1244) - --- ### attempt? > `optional` **attempt?**: `number` -Defined in: [types/proxy.ts:1245](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1245) - --- ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`\> - -Defined in: [types/proxy.ts:1246](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1246) diff --git a/docs/api/type-aliases/ProxyBodyCaptureLogger.md b/docs/api/type-aliases/ProxyBodyCaptureLogger.md index 8dd04e710..f6bedaf59 100644 --- a/docs/api/type-aliases/ProxyBodyCaptureLogger.md +++ b/docs/api/type-aliases/ProxyBodyCaptureLogger.md @@ -8,8 +8,6 @@ > **ProxyBodyCaptureLogger** = (`capture`) => `void` -Defined in: [types/proxy.ts:1249](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1249) - ## Parameters ### capture diff --git a/docs/api/type-aliases/ProxyBodyCapturePolicyOptions.md b/docs/api/type-aliases/ProxyBodyCapturePolicyOptions.md index fb2157a68..5757105c6 100644 --- a/docs/api/type-aliases/ProxyBodyCapturePolicyOptions.md +++ b/docs/api/type-aliases/ProxyBodyCapturePolicyOptions.md @@ -8,32 +8,24 @@ > **ProxyBodyCapturePolicyOptions** = `object` -Defined in: [types/proxy.ts:973](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L973) - ## Properties ### bytesPerMinute? > `optional` **bytesPerMinute?**: `string` -Defined in: [types/proxy.ts:974](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L974) - --- ### deduplicate? > `optional` **deduplicate?**: `boolean` -Defined in: [types/proxy.ts:975](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L975) - --- ### now? > `optional` **now?**: () => `number` -Defined in: [types/proxy.ts:976](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L976) - #### Returns `number` diff --git a/docs/api/type-aliases/ProxyBodyCapturePolicySnapshot.md b/docs/api/type-aliases/ProxyBodyCapturePolicySnapshot.md index 66129b23d..11e8e28b7 100644 --- a/docs/api/type-aliases/ProxyBodyCapturePolicySnapshot.md +++ b/docs/api/type-aliases/ProxyBodyCapturePolicySnapshot.md @@ -8,100 +8,74 @@ > **ProxyBodyCapturePolicySnapshot** = `object` -Defined in: [types/proxy.ts:978](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L978) - ## Properties ### deduplicationEnabled > **deduplicationEnabled**: `boolean` -Defined in: [types/proxy.ts:979](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L979) - --- ### maxReferences > **maxReferences**: `number` -Defined in: [types/proxy.ts:980](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L980) - --- ### referenceTtlMs > **referenceTtlMs**: `number` -Defined in: [types/proxy.ts:981](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L981) - --- ### references > **references**: `number` -Defined in: [types/proxy.ts:982](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L982) - --- ### byteBudgetPerMinute > **byteBudgetPerMinute**: `number` \| `null` -Defined in: [types/proxy.ts:983](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L983) - --- ### invalidByteBudget > **invalidByteBudget**: `boolean` -Defined in: [types/proxy.ts:984](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L984) - --- ### availableBytes > **availableBytes**: `number` \| `null` -Defined in: [types/proxy.ts:985](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L985) - --- ### submittedBytes > **submittedBytes**: `number` -Defined in: [types/proxy.ts:986](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L986) - --- ### deduplicatedCaptures > **deduplicatedCaptures**: `number` -Defined in: [types/proxy.ts:987](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L987) - --- ### deduplicatedBytes > **deduplicatedBytes**: `number` -Defined in: [types/proxy.ts:988](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L988) - --- ### policyExcludedCaptures > **policyExcludedCaptures**: `number` -Defined in: [types/proxy.ts:989](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L989) - --- ### policyExcludedBytes > **policyExcludedBytes**: `number` - -Defined in: [types/proxy.ts:990](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L990) diff --git a/docs/api/type-aliases/ProxyBodyCapturePublication.md b/docs/api/type-aliases/ProxyBodyCapturePublication.md index 1b14ba2ce..f9c0bb719 100644 --- a/docs/api/type-aliases/ProxyBodyCapturePublication.md +++ b/docs/api/type-aliases/ProxyBodyCapturePublication.md @@ -8,20 +8,14 @@ > **ProxyBodyCapturePublication** = `object` -Defined in: [types/proxy.ts:963](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L963) - ## Properties ### delivery? > `optional` **delivery?**: [`ProxyBodyDeliveryResult`](ProxyBodyDeliveryResult.md) \| \{ `status`: `"reference"`; `reason`: `"identical_redacted_payload"`; \} \| \{ `status`: `"policy_excluded"`; `reason`: `"body_byte_budget_exhausted"` \| `"body_byte_budget_invalid"`; \} -Defined in: [types/proxy.ts:964](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L964) - --- ### reference? > `optional` **reference?**: [`ProxyBodyCaptureReference`](ProxyBodyCaptureReference.md) - -Defined in: [types/proxy.ts:971](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L971) diff --git a/docs/api/type-aliases/ProxyBodyCaptureReference.md b/docs/api/type-aliases/ProxyBodyCaptureReference.md index b1ee0851d..2a2867fdd 100644 --- a/docs/api/type-aliases/ProxyBodyCaptureReference.md +++ b/docs/api/type-aliases/ProxyBodyCaptureReference.md @@ -8,8 +8,6 @@ > **ProxyBodyCaptureReference** = `object` -Defined in: [types/proxy.ts:955](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L955) - One-hop reference to identical redacted bytes from the same request. ## Properties @@ -18,38 +16,28 @@ One-hop reference to identical redacted bytes from the same request. > **captureId**: `string` -Defined in: [types/proxy.ts:956](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L956) - --- ### requestId > **requestId**: `string` -Defined in: [types/proxy.ts:957](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L957) - --- ### bodySha256 > **bodySha256**: `string` -Defined in: [types/proxy.ts:958](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L958) - --- ### redactedBodyBytes > **redactedBodyBytes**: `number` -Defined in: [types/proxy.ts:959](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L959) - --- ### exportedAt > **exportedAt**: `string` -Defined in: [types/proxy.ts:961](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L961) - Source export settlement time, used to bound backend reconstruction. diff --git a/docs/api/type-aliases/ProxyBodyCaptureWorkerSnapshot.md b/docs/api/type-aliases/ProxyBodyCaptureWorkerSnapshot.md index d275591e3..6bf523047 100644 --- a/docs/api/type-aliases/ProxyBodyCaptureWorkerSnapshot.md +++ b/docs/api/type-aliases/ProxyBodyCaptureWorkerSnapshot.md @@ -8,8 +8,6 @@ > **ProxyBodyCaptureWorkerSnapshot** = `object` & `ProxyBodyCaptureWaitingSnapshot` -Defined in: [types/proxy.ts:909](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L909) - ## Type Declaration ### processing? diff --git a/docs/api/type-aliases/ProxyBodyChunkEmitter.md b/docs/api/type-aliases/ProxyBodyChunkEmitter.md index c204feb39..1fc1f8793 100644 --- a/docs/api/type-aliases/ProxyBodyChunkEmitter.md +++ b/docs/api/type-aliases/ProxyBodyChunkEmitter.md @@ -8,8 +8,6 @@ > **ProxyBodyChunkEmitter** = (`chunk`, `index`, `count`) => `void` -Defined in: [types/proxy.ts:1093](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1093) - Chunk emission stays in the request logger, which owns request attributes. ## Parameters diff --git a/docs/api/type-aliases/ProxyBodyDeduplicationEntry.md b/docs/api/type-aliases/ProxyBodyDeduplicationEntry.md index 653633e4f..4e23d4787 100644 --- a/docs/api/type-aliases/ProxyBodyDeduplicationEntry.md +++ b/docs/api/type-aliases/ProxyBodyDeduplicationEntry.md @@ -8,28 +8,20 @@ > **ProxyBodyDeduplicationEntry** = `object` -Defined in: [types/proxy.ts:992](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L992) - ## Properties ### reference > **reference**: [`ProxyBodyCaptureReference`](ProxyBodyCaptureReference.md) -Defined in: [types/proxy.ts:993](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L993) - --- ### expiresAt > **expiresAt**: `number` -Defined in: [types/proxy.ts:994](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L994) - --- ### acknowledged > **acknowledged**: `Promise`\<`boolean`\> - -Defined in: [types/proxy.ts:995](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L995) diff --git a/docs/api/type-aliases/ProxyBodyDeliveryResult.md b/docs/api/type-aliases/ProxyBodyDeliveryResult.md index 2ae30c413..e473ddb07 100644 --- a/docs/api/type-aliases/ProxyBodyDeliveryResult.md +++ b/docs/api/type-aliases/ProxyBodyDeliveryResult.md @@ -8,8 +8,6 @@ > **ProxyBodyDeliveryResult** = `object` -Defined in: [types/proxy.ts:932](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L932) - Collector transport evidence; acknowledgement does not prove backend storage. ## Properties @@ -18,16 +16,12 @@ Collector transport evidence; acknowledgement does not prove backend storage. > **status**: `"transport_acknowledged"` \| `"export_unconfirmed"` \| `"rejected"` \| `"partial"` -Defined in: [types/proxy.ts:933](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L933) - --- ### expectedChunks? > `optional` **expectedChunks?**: `number` -Defined in: [types/proxy.ts:939](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L939) - Absent when publication was rejected before chunking. --- @@ -36,40 +30,30 @@ Absent when publication was rejected before chunking. > **acknowledgedChunks**: `number` -Defined in: [types/proxy.ts:940](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L940) - --- ### unconfirmedChunks > **unconfirmedChunks**: `number` -Defined in: [types/proxy.ts:941](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L941) - --- ### droppedChunks > **droppedChunks**: `number` -Defined in: [types/proxy.ts:942](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L942) - --- ### notSubmittedChunks? > `optional` **notSubmittedChunks?**: `number` -Defined in: [types/proxy.ts:943](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L943) - --- ### publicationMs? > `optional` **publicationMs?**: `number` -Defined in: [types/proxy.ts:945](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L945) - Total publication elapsed time, including capacity and exporter waits. --- @@ -78,16 +62,12 @@ Total publication elapsed time, including capacity and exporter waits. > `optional` **capacityWaitMs?**: `number` -Defined in: [types/proxy.ts:946](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L946) - --- ### maxChunkQueueWaitMs? > `optional` **maxChunkQueueWaitMs?**: `number` -Defined in: [types/proxy.ts:948](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L948) - Maximum per-chunk residence before an OTLP export starts. --- @@ -96,8 +76,6 @@ Maximum per-chunk residence before an OTLP export starts. > `optional` **maxChunkExportMs?**: `number` -Defined in: [types/proxy.ts:950](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L950) - Maximum per-chunk transport duration; never sums overlapping exports. --- @@ -105,5 +83,3 @@ Maximum per-chunk transport duration; never sums overlapping exports. ### reason? > `optional` **reason?**: `string` - -Defined in: [types/proxy.ts:951](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L951) diff --git a/docs/api/type-aliases/ProxyBodyPublicationProgress.md b/docs/api/type-aliases/ProxyBodyPublicationProgress.md index 494da31bd..004e9d6f9 100644 --- a/docs/api/type-aliases/ProxyBodyPublicationProgress.md +++ b/docs/api/type-aliases/ProxyBodyPublicationProgress.md @@ -8,8 +8,6 @@ > **ProxyBodyPublicationProgress** = `object` -Defined in: [types/proxy.ts:999](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L999) - One bounded body publication, tracked across exporter callbacks. ## Properties @@ -18,56 +16,42 @@ One bounded body publication, tracked across exporter callbacks. > **acknowledged**: `number` -Defined in: [types/proxy.ts:1000](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1000) - --- ### unconfirmed > **unconfirmed**: `number` -Defined in: [types/proxy.ts:1001](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1001) - --- ### dropped > **dropped**: `number` -Defined in: [types/proxy.ts:1002](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1002) - --- ### emitted > **emitted**: `number` -Defined in: [types/proxy.ts:1003](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1003) - --- ### maxChunkQueueWaitMs? > `optional` **maxChunkQueueWaitMs?**: `number` -Defined in: [types/proxy.ts:1004](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1004) - --- ### maxChunkExportMs? > `optional` **maxChunkExportMs?**: `number` -Defined in: [types/proxy.ts:1005](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1005) - --- ### notify? > `optional` **notify?**: () => `void` -Defined in: [types/proxy.ts:1006](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L1006) - #### Returns `void` diff --git a/docs/api/type-aliases/ProxyCancellableTransformer.md b/docs/api/type-aliases/ProxyCancellableTransformer.md index d7f938f09..25d1b6a01 100644 --- a/docs/api/type-aliases/ProxyCancellableTransformer.md +++ b/docs/api/type-aliases/ProxyCancellableTransformer.md @@ -8,8 +8,6 @@ > **ProxyCancellableTransformer**\<`I`, `O`\> = `Transformer`\<`I`, `O`\> & `object` -Defined in: [types/proxy.ts:2753](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2753) - A stream transformer that also handles cancellation. The Streams standard gives `Transformer` a `cancel()` callback — invoked when diff --git a/docs/api/type-aliases/ProxyClosableServer.md b/docs/api/type-aliases/ProxyClosableServer.md index dc21ec91d..9d8242841 100644 --- a/docs/api/type-aliases/ProxyClosableServer.md +++ b/docs/api/type-aliases/ProxyClosableServer.md @@ -8,8 +8,6 @@ > **ProxyClosableServer** = `object` -Defined in: [types/proxy.ts:4559](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4559) - The slice of a node HTTP server the proxy runtime actually closes. ## Properties @@ -18,8 +16,6 @@ The slice of a node HTTP server the proxy runtime actually closes. > `optional` **close?**: (`callback?`) => `void` -Defined in: [types/proxy.ts:4560](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4560) - #### Parameters ##### callback? diff --git a/docs/api/type-aliases/ProxyConfig.md b/docs/api/type-aliases/ProxyConfig.md index 380f5e7d7..538ebd3c7 100644 --- a/docs/api/type-aliases/ProxyConfig.md +++ b/docs/api/type-aliases/ProxyConfig.md @@ -8,8 +8,6 @@ > **ProxyConfig** = `object` -Defined in: [types/subscription.ts:1271](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1271) - Full proxy config (loaded from YAML) ## Properties @@ -18,40 +16,30 @@ Full proxy config (loaded from YAML) > `optional` **host?**: `string` -Defined in: [types/subscription.ts:1272](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1272) - --- ### port? > `optional` **port?**: `number` -Defined in: [types/subscription.ts:1273](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1273) - --- ### auth? > `optional` **auth?**: `"none"` \| `"api-key"` -Defined in: [types/subscription.ts:1274](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1274) - --- ### proxyApiKey? > `optional` **proxyApiKey?**: `string` -Defined in: [types/subscription.ts:1275](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1275) - --- ### accounts? > `optional` **accounts?**: `Record`\<`string`, `object`[]\> -Defined in: [types/subscription.ts:1277](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1277) - Provider-keyed account map matching the YAML structure (e.g. accounts.anthropic[0]) --- @@ -60,12 +48,8 @@ Provider-keyed account map matching the YAML structure (e.g. accounts.anthropic[ > `optional` **routing?**: `Partial`\<[`ProxyRoutingConfig`](ProxyRoutingConfig.md)\> -Defined in: [types/subscription.ts:1290](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1290) - --- ### cloaking? > `optional` **cloaking?**: [`CloakingConfig`](CloakingConfig.md) - -Defined in: [types/subscription.ts:1291](https://github.com/juspay/neurolink/blob/release/src/lib/types/subscription.ts#L1291) diff --git a/docs/api/type-aliases/ProxyConfigFile.md b/docs/api/type-aliases/ProxyConfigFile.md index 2f01ccede..a41a0d6e6 100644 --- a/docs/api/type-aliases/ProxyConfigFile.md +++ b/docs/api/type-aliases/ProxyConfigFile.md @@ -8,8 +8,6 @@ > **ProxyConfigFile** = `object` -Defined in: [types/proxy.ts:521](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L521) - Top-level proxy configuration structure. ## Properties @@ -18,8 +16,6 @@ Top-level proxy configuration structure. > `optional` **version?**: `number` -Defined in: [types/proxy.ts:523](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L523) - Configuration schema version --- @@ -28,8 +24,6 @@ Configuration schema version > `optional` **defaultProvider?**: `string` -Defined in: [types/proxy.ts:525](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L525) - Default provider name to apply when not specified per-account --- @@ -38,8 +32,6 @@ Default provider name to apply when not specified per-account > `optional` **defaultBaseUrl?**: `string` -Defined in: [types/proxy.ts:527](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L527) - Default base URL applied to accounts that omit baseUrl --- @@ -48,8 +40,6 @@ Default base URL applied to accounts that omit baseUrl > **accounts**: `Record`\<`string`, [`ProxyAccountConfig`](ProxyAccountConfig.md)[]\> -Defined in: [types/proxy.ts:529](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L529) - Map of provider names to their account lists --- @@ -58,8 +48,6 @@ Map of provider names to their account lists > `optional` **routing?**: `Partial`\<[`ProxyRoutingConfig`](ProxyRoutingConfig.md)\> -Defined in: [types/proxy.ts:531](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L531) - Routing configuration (strategy, model mappings, fallback chain) --- @@ -68,6 +56,4 @@ Routing configuration (strategy, model mappings, fallback chain) > `optional` **cloaking?**: [`CloakingConfig`](CloakingConfig.md) -Defined in: [types/proxy.ts:533](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L533) - Cloaking plugin configuration diff --git a/docs/api/type-aliases/ProxyContextEvidence.md b/docs/api/type-aliases/ProxyContextEvidence.md index bac6f56c6..8e715cec4 100644 --- a/docs/api/type-aliases/ProxyContextEvidence.md +++ b/docs/api/type-aliases/ProxyContextEvidence.md @@ -8,136 +8,102 @@ > **ProxyContextEvidence** = `object` -Defined in: [types/proxyContext.ts:20](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L20) - ## Properties ### provider > **provider**: `string` -Defined in: [types/proxyContext.ts:21](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L21) - --- ### model > **model**: `string` -Defined in: [types/proxyContext.ts:22](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L22) - --- ### inputTokensEstimate > **inputTokensEstimate**: `number` -Defined in: [types/proxyContext.ts:23](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L23) - --- ### toolsTokensEstimate > **toolsTokensEstimate**: `number` -Defined in: [types/proxyContext.ts:24](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L24) - --- ### instructionsTokensEstimate > **instructionsTokensEstimate**: `number` -Defined in: [types/proxyContext.ts:25](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L25) - --- ### schemaTokensEstimate > **schemaTokensEstimate**: `number` -Defined in: [types/proxyContext.ts:26](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L26) - --- ### outputTokensReserve > **outputTokensReserve**: `number` -Defined in: [types/proxyContext.ts:27](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L27) - --- ### reasoningIncludedInOutputReserve > **reasoningIncludedInOutputReserve**: `true` -Defined in: [types/proxyContext.ts:28](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L28) - --- ### contextWindow? > `optional` **contextWindow?**: `number` -Defined in: [types/proxyContext.ts:29](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L29) - --- ### contextLimitSource > **contextLimitSource**: `"configured"` \| `"discovered"` \| `"unknown"` -Defined in: [types/proxyContext.ts:30](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L30) - --- ### tokenCountSource > **tokenCountSource**: `"estimated"` -Defined in: [types/proxyContext.ts:31](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L31) - --- ### multimodalEstimate > **multimodalEstimate**: `boolean` -Defined in: [types/proxyContext.ts:32](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L32) - --- ### originalToolCount > **originalToolCount**: `number` -Defined in: [types/proxyContext.ts:33](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L33) - --- ### retainedToolCount > **retainedToolCount**: `number` -Defined in: [types/proxyContext.ts:34](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L34) - --- ### historyModified > **historyModified**: `boolean` -Defined in: [types/proxyContext.ts:35](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L35) - --- ### historyUnitsRemoved? > `optional` **historyUnitsRemoved?**: `number` -Defined in: [types/proxyContext.ts:37](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L37) - Complete history units dropped by pre-dispatch truncation. --- @@ -146,6 +112,4 @@ Complete history units dropped by pre-dispatch truncation. > `optional` **inputTokensBeforeTruncation?**: `number` -Defined in: [types/proxyContext.ts:39](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L39) - Input estimate before truncation, when truncation ran. diff --git a/docs/api/type-aliases/ProxyContextPolicy.md b/docs/api/type-aliases/ProxyContextPolicy.md index 1ae1f4ff5..c24b6ebf9 100644 --- a/docs/api/type-aliases/ProxyContextPolicy.md +++ b/docs/api/type-aliases/ProxyContextPolicy.md @@ -8,8 +8,6 @@ > **ProxyContextPolicy** = `object` -Defined in: [types/proxyContext.ts:2](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L2) - Explicit proxy context controls; all token quantities remain estimates. ## Properties @@ -18,36 +16,26 @@ Explicit proxy context controls; all token quantities remain estimates. > `optional` **maxInputTokens?**: `number` -Defined in: [types/proxyContext.ts:3](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L3) - --- ### outputReserveTokens? > `optional` **outputReserveTokens?**: `number` -Defined in: [types/proxyContext.ts:4](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L4) - --- ### enforceDiscoveredLimits? > `optional` **enforceDiscoveredLimits?**: `boolean` -Defined in: [types/proxyContext.ts:5](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L5) - --- ### toolAllowlist? > `optional` **toolAllowlist?**: `string`[] -Defined in: [types/proxyContext.ts:6](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L6) - --- ### models? > `optional` **models?**: `Record`\<`string`, \{ `contextWindow`: `number`; `maxOutputTokens?`: `number`; `compactAtTokens?`: `number`; `compactToTokens?`: `number`; \}\> - -Defined in: [types/proxyContext.ts:7](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L7) diff --git a/docs/api/type-aliases/ProxyEnvLoadResult.md b/docs/api/type-aliases/ProxyEnvLoadResult.md index 1494d5e73..ee4b2c799 100644 --- a/docs/api/type-aliases/ProxyEnvLoadResult.md +++ b/docs/api/type-aliases/ProxyEnvLoadResult.md @@ -8,8 +8,6 @@ > **ProxyEnvLoadResult** = `object` -Defined in: [types/proxy.ts:2296](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2296) - Result of loading the proxy env file. ## Properties @@ -18,20 +16,14 @@ Result of loading the proxy env file. > **loaded**: `boolean` -Defined in: [types/proxy.ts:2297](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2297) - --- ### path? > `optional` **path?**: `string` -Defined in: [types/proxy.ts:2298](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2298) - --- ### source > **source**: [`ProxyEnvSource`](ProxyEnvSource.md) - -Defined in: [types/proxy.ts:2299](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2299) diff --git a/docs/api/type-aliases/ProxyEnvOptions.md b/docs/api/type-aliases/ProxyEnvOptions.md index 1e7c2e77b..f30ef4df8 100644 --- a/docs/api/type-aliases/ProxyEnvOptions.md +++ b/docs/api/type-aliases/ProxyEnvOptions.md @@ -8,8 +8,6 @@ > **ProxyEnvOptions** = `object` -Defined in: [types/proxy.ts:2303](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2303) - Options controlling proxy env file resolution. ## Properties @@ -18,20 +16,14 @@ Options controlling proxy env file resolution. > `optional` **explicitEnvFile?**: `string` -Defined in: [types/proxy.ts:2304](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2304) - --- ### env? > `optional` **env?**: `NodeJS.ProcessEnv` -Defined in: [types/proxy.ts:2305](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2305) - --- ### homeDir? > `optional` **homeDir?**: `string` - -Defined in: [types/proxy.ts:2306](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2306) diff --git a/docs/api/type-aliases/ProxyEnvResolution.md b/docs/api/type-aliases/ProxyEnvResolution.md index 7aab659bf..0f10104e0 100644 --- a/docs/api/type-aliases/ProxyEnvResolution.md +++ b/docs/api/type-aliases/ProxyEnvResolution.md @@ -8,8 +8,6 @@ > **ProxyEnvResolution** = `object` -Defined in: [types/proxy.ts:2289](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2289) - Result of resolving which proxy env file to load. ## Properties @@ -18,20 +16,14 @@ Result of resolving which proxy env file to load. > `optional` **path?**: `string` -Defined in: [types/proxy.ts:2290](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2290) - --- ### source > **source**: [`ProxyEnvSource`](ProxyEnvSource.md) -Defined in: [types/proxy.ts:2291](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2291) - --- ### required > **required**: `boolean` - -Defined in: [types/proxy.ts:2292](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2292) diff --git a/docs/api/type-aliases/ProxyEnvSource.md b/docs/api/type-aliases/ProxyEnvSource.md index 945efd244..49e93dbab 100644 --- a/docs/api/type-aliases/ProxyEnvSource.md +++ b/docs/api/type-aliases/ProxyEnvSource.md @@ -8,6 +8,4 @@ > **ProxyEnvSource** = `"cli"` \| `"environment"` \| `"default"` \| `"none"` -Defined in: [types/proxy.ts:2286](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2286) - Where a proxy env file path was sourced from. diff --git a/docs/api/type-aliases/ProxyEnvironmentSnapshot.md b/docs/api/type-aliases/ProxyEnvironmentSnapshot.md index 6821d1e1f..51beffb61 100644 --- a/docs/api/type-aliases/ProxyEnvironmentSnapshot.md +++ b/docs/api/type-aliases/ProxyEnvironmentSnapshot.md @@ -8,8 +8,6 @@ > **ProxyEnvironmentSnapshot** = `object` -Defined in: [types/proxy.ts:2314](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2314) - Snapshot of proxy-related environment variables captured at startup. ## Properties @@ -18,36 +16,26 @@ Snapshot of proxy-related environment variables captured at startup. > `optional` **httpsProxy?**: `string` -Defined in: [types/proxy.ts:2315](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2315) - --- ### httpProxy? > `optional` **httpProxy?**: `string` -Defined in: [types/proxy.ts:2316](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2316) - --- ### allProxy? > `optional` **allProxy?**: `string` -Defined in: [types/proxy.ts:2317](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2317) - --- ### socksProxy? > `optional` **socksProxy?**: `string` -Defined in: [types/proxy.ts:2318](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2318) - --- ### noProxy? > `optional` **noProxy?**: `string` - -Defined in: [types/proxy.ts:2319](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2319) diff --git a/docs/api/type-aliases/ProxyExposeArgs.md b/docs/api/type-aliases/ProxyExposeArgs.md index b5a86bf78..850af3ff9 100644 --- a/docs/api/type-aliases/ProxyExposeArgs.md +++ b/docs/api/type-aliases/ProxyExposeArgs.md @@ -8,36 +8,26 @@ > **ProxyExposeArgs** = `object` -Defined in: [types/cli.ts:2266](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2266) - ## Properties ### port? > `optional` **port?**: `number` -Defined in: [types/cli.ts:2267](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2267) - --- ### host? > `optional` **host?**: `string` -Defined in: [types/cli.ts:2268](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2268) - --- ### named? > `optional` **named?**: `string` -Defined in: [types/cli.ts:2269](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2269) - --- ### force? > `optional` **force?**: `boolean` - -Defined in: [types/cli.ts:2270](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2270) diff --git a/docs/api/type-aliases/ProxyFormat.md b/docs/api/type-aliases/ProxyFormat.md index 6e9d051e3..22918199f 100644 --- a/docs/api/type-aliases/ProxyFormat.md +++ b/docs/api/type-aliases/ProxyFormat.md @@ -8,6 +8,4 @@ > **ProxyFormat** = `"claude"` \| `"openai"` \| `"gemini"` -Defined in: [types/proxy.ts:3934](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3934) - Wire format a proxy request is using. diff --git a/docs/api/type-aliases/ProxyGateProbe.md b/docs/api/type-aliases/ProxyGateProbe.md index 55e3d224f..3bcb99e16 100644 --- a/docs/api/type-aliases/ProxyGateProbe.md +++ b/docs/api/type-aliases/ProxyGateProbe.md @@ -8,8 +8,6 @@ > **ProxyGateProbe** = `object` -Defined in: [types/cli.ts:2274](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2274) - What `proxy expose` learned by asking the running proxy directly. ## Properties @@ -18,20 +16,14 @@ What `proxy expose` learned by asking the running proxy directly. > **gated**: `boolean` -Defined in: [types/cli.ts:2275](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2275) - --- ### reachable > **reachable**: `boolean` -Defined in: [types/cli.ts:2276](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2276) - --- ### detail > **detail**: `string` - -Defined in: [types/cli.ts:2277](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L2277) diff --git a/docs/api/type-aliases/ProxyGeminiContent.md b/docs/api/type-aliases/ProxyGeminiContent.md index 921ce4d5e..68f2ad7d9 100644 --- a/docs/api/type-aliases/ProxyGeminiContent.md +++ b/docs/api/type-aliases/ProxyGeminiContent.md @@ -8,8 +8,6 @@ > **ProxyGeminiContent** = `object` -Defined in: [types/proxy.ts:4087](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4087) - One turn in a Gemini `contents[]` array. ## Properties @@ -18,12 +16,8 @@ One turn in a Gemini `contents[]` array. > `optional` **role?**: `string` -Defined in: [types/proxy.ts:4087](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4087) - --- ### parts? > `optional` **parts?**: [`ProxyGeminiPart`](ProxyGeminiPart.md)[] - -Defined in: [types/proxy.ts:4087](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4087) diff --git a/docs/api/type-aliases/ProxyGeminiPart.md b/docs/api/type-aliases/ProxyGeminiPart.md index 0c190e7b1..7d59ac7d7 100644 --- a/docs/api/type-aliases/ProxyGeminiPart.md +++ b/docs/api/type-aliases/ProxyGeminiPart.md @@ -8,8 +8,6 @@ > **ProxyGeminiPart** = `object` -Defined in: [types/proxy.ts:4084](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4084) - One part of a Gemini `contents[].parts[]` entry. ## Properties @@ -18,16 +16,12 @@ One part of a Gemini `contents[].parts[]` entry. > `optional` **text?**: `string` -Defined in: [types/proxy.ts:4084](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4084) - --- ### inlineData? > `optional` **inlineData?**: `object` -Defined in: [types/proxy.ts:4084](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L4084) - #### data? > `optional` **data?**: `string` diff --git a/docs/api/type-aliases/ProxyGuardArgs.md b/docs/api/type-aliases/ProxyGuardArgs.md index cf34962f7..df6d314c6 100644 --- a/docs/api/type-aliases/ProxyGuardArgs.md +++ b/docs/api/type-aliases/ProxyGuardArgs.md @@ -8,8 +8,6 @@ > **ProxyGuardArgs** = `object` -Defined in: [types/cli.ts:968](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L968) - Arguments accepted by hidden `neurolink proxy guard` command ## Properties @@ -18,62 +16,46 @@ Arguments accepted by hidden `neurolink proxy guard` command > `optional` **host?**: `string` -Defined in: [types/cli.ts:969](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L969) - --- ### port? > `optional` **port?**: `number` -Defined in: [types/cli.ts:970](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L970) - --- ### parentPid? > `optional` **parentPid?**: `number` -Defined in: [types/cli.ts:971](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L971) - --- ### maxWaitMs? > `optional` **maxWaitMs?**: `number` -Defined in: [types/cli.ts:972](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L972) - --- ### failureThreshold? > `optional` **failureThreshold?**: `number` -Defined in: [types/cli.ts:973](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L973) - --- ### pollIntervalMs? > `optional` **pollIntervalMs?**: `number` -Defined in: [types/cli.ts:974](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L974) - --- ### quiet? > `optional` **quiet?**: `boolean` -Defined in: [types/cli.ts:975](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L975) - --- ### updaterOnly? > `optional` **updaterOnly?**: `boolean` -Defined in: [types/cli.ts:977](https://github.com/juspay/neurolink/blob/release/src/lib/types/cli.ts#L977) - Run update checks only; never mutate client settings. diff --git a/docs/api/type-aliases/ProxyHealthProbe.md b/docs/api/type-aliases/ProxyHealthProbe.md index e5afd443c..1f6707fe6 100644 --- a/docs/api/type-aliases/ProxyHealthProbe.md +++ b/docs/api/type-aliases/ProxyHealthProbe.md @@ -8,8 +8,6 @@ > **ProxyHealthProbe** = `object` -Defined in: [types/proxy.ts:3181](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3181) - Result of one local proxy health probe by the updater or fail-open guard. ## Properties @@ -18,36 +16,26 @@ Result of one local proxy health probe by the updater or fail-open guard. > **healthy**: `boolean` -Defined in: [types/proxy.ts:3182](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3182) - --- ### durationMs > **durationMs**: `number` -Defined in: [types/proxy.ts:3183](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3183) - --- ### failure > **failure**: `"http_status"` \| `"network"` \| `"timeout"` \| `null` -Defined in: [types/proxy.ts:3184](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3184) - --- ### statusCode > **statusCode**: `number` \| `null` -Defined in: [types/proxy.ts:3185](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3185) - --- ### errorCode > **errorCode**: `string` \| `null` - -Defined in: [types/proxy.ts:3186](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L3186) diff --git a/docs/api/type-aliases/ProxyHealthResponse.md b/docs/api/type-aliases/ProxyHealthResponse.md index dd8041cc9..cea21f9fa 100644 --- a/docs/api/type-aliases/ProxyHealthResponse.md +++ b/docs/api/type-aliases/ProxyHealthResponse.md @@ -8,8 +8,6 @@ > **ProxyHealthResponse** = `object` -Defined in: [types/proxy.ts:2136](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2136) - Structured response returned by the proxy /health endpoint. ## Properties @@ -18,92 +16,68 @@ Structured response returned by the proxy /health endpoint. > **status**: `"ok"` \| `"starting"` -Defined in: [types/proxy.ts:2137](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2137) - --- ### ready > **ready**: `boolean` -Defined in: [types/proxy.ts:2138](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2138) - --- ### acceptingConnections > **acceptingConnections**: `boolean` -Defined in: [types/proxy.ts:2139](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2139) - --- ### drainingForUpdate > **drainingForUpdate**: `boolean` -Defined in: [types/proxy.ts:2140](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2140) - --- ### strategy > **strategy**: `string` -Defined in: [types/proxy.ts:2141](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2141) - --- ### passthrough > **passthrough**: `boolean` -Defined in: [types/proxy.ts:2142](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2142) - --- ### version > **version**: `string` -Defined in: [types/proxy.ts:2143](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2143) - --- ### startedAt > **startedAt**: `string` -Defined in: [types/proxy.ts:2144](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2144) - --- ### readyAt > **readyAt**: `string` \| `null` -Defined in: [types/proxy.ts:2145](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2145) - --- ### uptime > **uptime**: `number` -Defined in: [types/proxy.ts:2146](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2146) - --- ### healthPath > **healthPath**: `"/health"` -Defined in: [types/proxy.ts:2147](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2147) - --- ### statusPath > **statusPath**: `"/status"` - -Defined in: [types/proxy.ts:2148](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2148) diff --git a/docs/api/type-aliases/ProxyHistoryEstimate.md b/docs/api/type-aliases/ProxyHistoryEstimate.md index 155e45bfc..2d8405e42 100644 --- a/docs/api/type-aliases/ProxyHistoryEstimate.md +++ b/docs/api/type-aliases/ProxyHistoryEstimate.md @@ -8,8 +8,6 @@ > **ProxyHistoryEstimate** = (`value`) => `number` -Defined in: [types/proxyContext.ts:51](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L51) - Estimator injected into history truncation so it matches preflight accounting. ## Parameters diff --git a/docs/api/type-aliases/ProxyHistoryField.md b/docs/api/type-aliases/ProxyHistoryField.md index 9eeb6d358..849d80bb4 100644 --- a/docs/api/type-aliases/ProxyHistoryField.md +++ b/docs/api/type-aliases/ProxyHistoryField.md @@ -8,6 +8,4 @@ > **ProxyHistoryField** = `"messages"` \| `"input"` \| `"conversationMessages"` -Defined in: [types/proxyContext.ts:54](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L54) - The history container a proxy body carries. diff --git a/docs/api/type-aliases/ProxyHistoryTruncationResult.md b/docs/api/type-aliases/ProxyHistoryTruncationResult.md index e3cf9e75a..77d3afdad 100644 --- a/docs/api/type-aliases/ProxyHistoryTruncationResult.md +++ b/docs/api/type-aliases/ProxyHistoryTruncationResult.md @@ -8,8 +8,6 @@ > **ProxyHistoryTruncationResult**\<`T`\> = `object` -Defined in: [types/proxyContext.ts:56](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L56) - ## Type Parameters ### T @@ -22,28 +20,20 @@ Defined in: [types/proxyContext.ts:56](https://github.com/juspay/neurolink/blob/ > **body**: `T` -Defined in: [types/proxyContext.ts:57](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L57) - --- ### historyModified > **historyModified**: `boolean` -Defined in: [types/proxyContext.ts:58](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L58) - --- ### unitsRemoved > **unitsRemoved**: `number` -Defined in: [types/proxyContext.ts:59](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L59) - --- ### itemsRemoved > **itemsRemoved**: `number` - -Defined in: [types/proxyContext.ts:60](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyContext.ts#L60) diff --git a/docs/api/type-aliases/ProxyLatencySummary.md b/docs/api/type-aliases/ProxyLatencySummary.md index a521a944c..5922afa1c 100644 --- a/docs/api/type-aliases/ProxyLatencySummary.md +++ b/docs/api/type-aliases/ProxyLatencySummary.md @@ -8,8 +8,6 @@ > **ProxyLatencySummary** = `object` -Defined in: [types/proxy.ts:2499](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2499) - Percentile summary used by offline proxy log analysis. ## Properties @@ -18,36 +16,26 @@ Percentile summary used by offline proxy log analysis. > **count**: `number` -Defined in: [types/proxy.ts:2500](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2500) - --- ### p50 > **p50**: `number` \| `null` -Defined in: [types/proxy.ts:2501](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2501) - --- ### p95 > **p95**: `number` \| `null` -Defined in: [types/proxy.ts:2502](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2502) - --- ### p99 > **p99**: `number` \| `null` -Defined in: [types/proxy.ts:2503](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2503) - --- ### max > **max**: `number` \| `null` - -Defined in: [types/proxy.ts:2504](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxy.ts#L2504) diff --git a/docs/api/type-aliases/ProxyLedgerEntry.md b/docs/api/type-aliases/ProxyLedgerEntry.md index 024742161..bb97606e1 100644 --- a/docs/api/type-aliases/ProxyLedgerEntry.md +++ b/docs/api/type-aliases/ProxyLedgerEntry.md @@ -8,8 +8,6 @@ > **ProxyLedgerEntry** = `object` -Defined in: [types/proxyClient.ts:245](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L245) - One request as recorded in the proxy request log, reduced to what costing needs. ## Properties @@ -18,16 +16,12 @@ One request as recorded in the proxy request log, reduced to what costing needs. > **account**: `string` -Defined in: [types/proxyClient.ts:246](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L246) - --- ### accountKey > **accountKey**: `string` -Defined in: [types/proxyClient.ts:253](https://github.com/juspay/neurolink/blob/release/src/lib/types/proxyClient.ts#L253) - Provider-qualified identity, "anthropic: