@juspay/neurolink 9.67.2 → 9.67.3

package/dist/providers/openaiChatCompletionsBase.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Abstract base class for providers that talk to an OpenAI chat-completions
+ * shaped HTTP endpoint. Owns the entire request/stream/tool-loop pipeline
+ * so concrete providers only declare configuration + provider-specific
+ * quirks (env var names, default model, error mapping).
+ *
+ * Currently extended by:
+ *   - OpenAICompatibleProvider (generic /v1/chat/completions backend)
+ *   - LiteLLMProvider          (LiteLLM proxy server)
+ *   - DeepSeekProvider         (api.deepseek.com)
+ *
+ * Subclasses provide:
+ *   - getProviderName() / getDefaultModel() / formatProviderError() (abstract)
+ *   - optional overrides: getFallbackModelName, getFallbackModels,
+ *     adjustBuildBodyOptions, onStreamStart, getAvailableModels
+ *
+ * Nothing here imports from "ai" or "@ai-sdk/*". The base class is a
+ * direct HTTP client + multi-step tool-execution loop driven by SSE.
+ */
+import type { AIProviderName } from "../constants/enums.js";
+import { BaseProvider } from "../core/baseProvider.js";
+import type { LanguageModel, OpenAICompatBuildBodyArgs, OpenAICompatStreamLifecycleListeners, Schema, StreamOptions, StreamResult, ZodUnknownSchema } from "../types/index.js";
+/**
+ * Abstract HTTP+SSE provider for OpenAI chat-completions-shaped endpoints.
+ */
+export declare abstract class OpenAIChatCompletionsProvider extends BaseProvider {
+    protected config: {
+        baseURL: string;
+        apiKey: string;
+    };
+    protected resolvedModel?: string;
+    constructor(providerName: AIProviderName, modelName: string | undefined, sdk: unknown, config: {
+        baseURL: string;
+        apiKey: string;
+    });
+    protected abstract getProviderName(): AIProviderName;
+    protected abstract getDefaultModel(): string;
+    protected abstract formatProviderError(error: unknown): Error;
+    /**
+     * Model name to return when `getDefaultModel()` is empty AND
+     * auto-discovery via `/models` finds nothing. Default "gpt-3.5-turbo".
+     */
+    protected getFallbackModelName(): string;
+    /**
+     * Hardcoded model names returned from `getAvailableModels()` when the
+     * remote `/models` endpoint can't be reached. Default empty.
+     */
+    protected getFallbackModels(): string[];
+    /**
+     * Hook to mutate the `buildBody` options before the wire body is
+     * constructed. Default identity. Override for model-specific quirks
+     * (e.g. LiteLLM's Gemini 2.5 maxTokens skip).
+     */
+    protected adjustBuildBodyOptions(_modelId: string, opts: OpenAICompatBuildBodyArgs["options"]): OpenAICompatBuildBodyArgs["options"];
+    /**
+     * Hook called once at the start of every `executeStream` invocation.
+     * Return lifecycle listeners (onUsage / onFinish) to receive deferred
+     * analytics events as the stream progresses. Default returns undefined
+     * (no extra wiring). LiteLLM uses this for the OTel span wrap with cost.
+     */
+    protected onStreamStart(_modelId: string): OpenAICompatStreamLifecycleListeners | undefined;
+    /**
+     * Returns true if `resolveModelName` should fall back to fetching
+     * `getAvailableModels()` and picking the first one when no explicit
+     * model is configured. Default true. Subclasses with a non-empty
+     * `getDefaultModel()` will never hit this branch anyway.
+     */
+    protected shouldAutoDiscoverModel(): boolean;
+    supportsTools(): boolean;
+    /**
+     * Returns a minimal V3-shaped model used by BaseProvider's `generate()`
+     * non-streaming path. Driven by the parent's `generateText`. The
+     * streaming path bypasses this entirely.
+     */
+    protected getAISDKModel(): Promise<LanguageModel>;
+    protected resolveModelName(): Promise<string>;
+    private buildDelegatingModel;
+    /**
+     * Streaming path — drives the chat-completions endpoint directly. No
+     * streamText, no AI SDK orchestrator. Tool calls, multi-step loops,
+     * telemetry, abort handling all inline.
+     */
+    protected executeStream(options: StreamOptions, _analysisSchema?: ZodUnknownSchema | Schema<unknown>): Promise<StreamResult>;
+    private runStreamLoop;
+    private streamOneStep;
+    private executeToolBatch;
+    /**
+     * Default implementation hits `${baseURL}/models`. Subclasses with a
+     * different endpoint path, caching, or fallback strategy should override.
+     */
+    getAvailableModels(): Promise<string[]>;
+    getFirstAvailableModel(): Promise<string>;
+}