@aeye/openrouter 0.4.1 → 0.5.0

package/dist/openrouter.d.ts

@@ -14,15 +14,16 @@
  *   `defaultParams.providers.requireParameters` explicitly (`false` disables, `true`
  *   forces regardless of strictness). See {@link OpenRouterConfig.defaultParams}.
  */
-import type { Message, ModelInfo, Provider } from '@aeye/ai';
-import { type Chunk, type DescriptorFamily, type Request, type Response } from '@aeye/core';
-import { OpenAIConfig, OpenAIProvider } from '@aeye/openai';
+import type { BatchJob, Message, ModelInfo, Provider } from '@aeye/ai';
+import { type Chunk, type DescriptorFamily, type Request, type Response, type SchemaRejectedError } from '@aeye/core';
+import { type BatchSubmission, OpenAIConfig, OpenAIProvider, type OperationRun } from '@aeye/openai';
 import OpenAI from 'openai';
-import { OpenRouterChatChunk, OpenRouterChatRequest, OpenRouterChatResponse, OpenRouterModel, OpenRouterRequestMessage } from './types';
+import type { OpenRouterChatChunk, OpenRouterChatRequest, OpenRouterChatResponse, OpenRouterContentPart, OpenRouterMetrics, OpenRouterModel, OpenRouterPlugin, OpenRouterProviderPreferences, OpenRouterRequestMessage } from './types';
 /**
- * OpenRouter provider configuration
+ * OpenRouter provider configuration. Requests always go through chat
+ * completions, where OpenRouter serves routing, plugins, and server tools.
  */
-export interface OpenRouterConfig extends OpenAIConfig {
+export interface OpenRouterConfig extends Omit<OpenAIConfig, 'api'> {
     defaultParams?: {
         siteUrl?: string;
         appName?: string;
@@ -42,34 +43,46 @@ export interface OpenRouterConfig extends OpenAIConfig {
              * Non-strict requests are unaffected unless this is explicitly set.
              */
             requireParameters?: boolean;
-            dataCollection?: 'deny' | 'allow';
+            dataCollection?: OpenRouterProviderPreferences['data_collection'];
             zdr?: boolean;
+            enforceDistillableText?: boolean;
             only?: string[];
             ignore?: string[];
-            quantizations?: ('int4' | 'int8' | 'fp4' | 'fp6' | 'fp8' | 'fp16' | 'bf16' | 'fp32' | 'unknown')[];
-            sort?: 'price' | 'throughput' | 'latency';
-            maxPrice?: {
-                prompt?: number;
-                completion?: number;
-                image?: number;
-            };
+            quantizations?: OpenRouterProviderPreferences['quantizations'];
+            sort?: OpenRouterProviderPreferences['sort'];
+            preferredMinThroughput?: number;
+            preferredMaxLatency?: number;
+            maxPrice?: OpenRouterProviderPreferences['max_price'];
         };
+        fallbackModels?: string[];
+        plugins?: OpenRouterPlugin[];
+        /**
+         * @deprecated OpenRouter replaced transforms with plugins; `middle-out`
+         * is sent as the `context-compression` plugin.
+         */
         transforms?: string[];
     };
 }
 /**
  * Convert OpenRouter model to ModelInfo with full details
  */
-export declare function convertOpenRouterModel(model: OpenRouterModel, zdrModelIds: Set<string>, metrics?: {
-    latency?: number;
-    throughput?: number;
-    uptime?: number;
-} | null): ModelInfo;
+export declare function convertOpenRouterModel(model: OpenRouterModel, zdrModelIds: Set<string>, metrics?: OpenRouterMetrics | null): ModelInfo;
 /**
  * OpenRouter provider implementation extending base OpenAI-compatible provider
  */
 export declare class OpenRouterProvider extends OpenAIProvider<OpenRouterConfig> implements Provider<OpenRouterConfig> {
     readonly name = "openrouter";
+    protected readonly defaults: {
+        chat?: import("@aeye/core").ModelInput;
+        imageGenerate?: import("@aeye/core").ModelInput;
+        imageEdit?: import("@aeye/core").ModelInput;
+        imageAnalyze?: import("@aeye/core").ModelInput;
+        transcription?: import("@aeye/core").ModelInput;
+        speech?: import("@aeye/core").ModelInput;
+        embedding?: import("@aeye/core").ModelInput;
+        decision?: import("@aeye/core").ModelInput;
+        rerank?: import("@aeye/core").ModelInput;
+    };
     /**
      * OpenRouter is a router, not a model host: it speaks an OpenAI-shaped API
      * but forwards each request to the upstream provider that actually serves
@@ -88,56 +101,102 @@ export declare class OpenRouterProvider extends OpenAIProvider<OpenRouterConfig>
      * why structured output looked family-aware while tools were not.
      */
     protected supportedStrictFamilies: ReadonlySet<DescriptorFamily>;
+    private readonly reasoningOf;
     protected createClient(config: OpenRouterConfig): OpenAI;
     protected convertModel(model: OpenAI.Model): ModelInfo;
     /**
-     * Augment chat request with OpenRouter-specific parameters
+     * OpenRouter serves hosted tools and reasoning options through chat
+     * completions, so the Responses API is never needed.
      */
-    protected augmentChatRequest(params: OpenRouterChatRequest, request: Request, config: OpenRouterConfig): void;
+    protected usesResponses(): boolean;
     /**
-     *
-     * @param expected
-     * @param response
+     * OpenRouter doesn't honor `allowed_tools` (models still call the others,
+     * and some upstreams reject it), so only the allowed tools are sent.
+     */
+    protected buildChatParams(request: Request, run: OperationRun<OpenRouterConfig>, streaming: boolean): Promise<OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming>;
+    /**
+     * OpenRouter reports an upstream's rejection as "Provider returned error",
+     * with the upstream's own message in `metadata.raw`.
+     */
+    protected rejectedSchema(request: Request, error: Error): SchemaRejectedError | undefined;
+    /**
+     * OpenRouter strips `strict` from tools bound for Anthropic unless the
+     * request carries Anthropic's structured-outputs beta flag, so a strict tool
+     * would silently go unenforced (openrouter.ai/docs/guides/routing/provider-selection,
+     * read 2026-11-04). Other upstreams ignore the header.
+     */
+    protected chatHeaders(params: OpenAI.Chat.ChatCompletionCreateParams): Record<string, string> | undefined;
+    /**
+     * Augment chat request with OpenRouter-specific parameters
      */
+    protected augmentChatRequest(params: OpenRouterChatRequest, request: Request, config: OpenRouterConfig): void;
     protected augmentChatResponse(expected: OpenRouterChatResponse, response: Response, config: OpenRouterConfig): void;
     protected augmentChatChunk(expected: OpenRouterChatChunk, chunk: Chunk, config: OpenRouterConfig): void;
-    protected augmentChatMessage(chatMessage: OpenRouterRequestMessage, message: Message, config: OpenRouterConfig): void;
+    /**
+     * OpenRouter marks cache breakpoints Anthropic-style and translates them
+     * for each upstream provider.
+     */
+    protected augmentChatContent(chatContent: OpenRouterContentPart): void;
+    protected augmentChatMessage(chatMessage: OpenAI.Chat.ChatCompletionMessageParam, message: Message): void;
+    /**
+     * Assistant messages carry their reasoning back on the same message, which
+     * OpenRouter relays with the turn's text and tool calls, once even when a
+     * message was split into parts.
+     */
     protected convertMessages(request: Request, config: OpenRouterConfig): Promise<OpenRouterRequestMessage[]>;
     /**
-     * OpenRouter does not support image generation
+     * Produce images through chat: image models on OpenRouter answer with
+     * images when asked for the image modality. Runs through the chat hooks.
      */
-    generateImage: undefined;
+    private chatImages;
+    generateImage: Provider['generateImage'];
+    editImage: Provider['editImage'];
     /**
-     * OpenRouter does not support image generation streaming
+     * Image streaming is not offered; image requests fall back to the
+     * non-streaming methods.
      */
     generateImageStream: undefined;
+    editImageStream: undefined;
     /**
-     * OpenRouter does not support image editing
+     * Transcription streaming is not offered; transcription falls back to
+     * the non-streaming method.
      */
-    editImage: undefined;
+    transcribeStream: undefined;
     /**
-     * OpenRouter does not support image editing
+     * Order documents by relevance to a query.
+     *
+     * @param request Rerank request parameters
+     * @param ctx Context object
+     * @param config Optional configuration override
+     * @returns Documents by relevance, most relevant first
      */
-    editImageStream: undefined;
+    rerank: Provider['rerank'];
     /**
-     * OpenRouter does not support audio transcription
+     * Typed answers about an input, from System One models such as Jev and
+     * Kev or other decision models. A conversation goes in as chat messages.
+     * Decisions are an alpha endpoint, outside the versioned API.
+     *
+     * @param request Decision request parameters
+     * @param ctx Context object
+     * @param config Optional configuration override
+     * @returns Answers by question name
      */
-    transcribe: undefined;
+    decide: Provider['decide'];
     /**
-     * OpenRouter does not support audio transcription streaming
+     * Start a batch: OpenRouter takes the requests inline.
      */
-    transcribeStream: undefined;
+    protected createBatch(batch: BatchSubmission, run: OperationRun<OpenRouterConfig>): Promise<BatchJob>;
     /**
-     * OpenRouter does not support speech synthesis
+     * Read a batch: OpenRouter returns the results inline once it completes.
      */
-    speech: undefined;
+    protected retrieveBatch(job: BatchJob, run: OperationRun<OpenRouterConfig>): Promise<BatchJob>;
     /**
-     * OpenRouter does not support embeddings
+     * A batch as @aeye reports it.
      */
-    embed: undefined;
+    private toBatchJob;
     /**
      * Override listModels to use OpenRouter's model API with ZDR support
      */
-    listModels(config: OpenRouterConfig): Promise<ModelInfo[]>;
+    listModels(config?: OpenRouterConfig): Promise<ModelInfo[]>;
 }
 //# sourceMappingURL=openrouter.d.ts.map

package/dist/openrouter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openrouter.d.ts","sourceRoot":"","sources":["../src/openrouter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAmB,SAAS,EAAkC,QAAQ,EAAE,MAAM,UAAU,CAAC;AAE9G,OAAO,EAAuB,KAAK,KAAK,EAAE,KAAK,gBAAgB,EAAE,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjH,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,sBAAsB,EAAqB,eAAe,EAA8B,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAEvL;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,aAAa,CAAC,EAAE;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE;YACV,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;YACjB,cAAc,CAAC,EAAE,OAAO,CAAC;YACzB;;;;;;;;;;;eAWG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAC5B,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;YAClC,GAAG,CAAC,EAAE,OAAO,CAAC;YACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;YAClB,aAAa,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;YACnG,IAAI,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,SAAS,CAAC;YAC1C,QAAQ,CAAC,EAAE;gBACT,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,UAAU,CAAC,EAAE,MAAM,CAAC;gBACpB,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB,CAAC;SACH,CAAC;QACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;CACH;AA+FD;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,eAAe,EACtB,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,EACxB,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,GAC1E,SAAS,CAwDX;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,cAAc,CAAC,gBAAgB,CAAE,YAAW,QAAQ,CAAC,gBAAgB,CAAC;IAC5G,QAAQ,CAAC,IAAI,gBAAgB;IAE7B;;;;;;;;;;;;;;;;OAgBG;IACH,UAAmB,uBAAuB,EAAE,WAAW,CAAC,gBAAgB,CAAC,CACV;IAE/D,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM;IAaxD,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,SAAS;IAetD;;OAEG;cACgB,kBAAkB,CACnC,MAAM,EAAE,qBAAqB,EAC7B,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,gBAAgB;IAsD1B;;;;OAIG;cACgB,mBAAmB,CACpC,QAAQ,EAAE,sBAAsB,EAChC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,gBAAgB;cAqCP,gBAAgB,CACjC,QAAQ,EAAE,mBAAmB,EAC7B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,gBAAgB;IA6B1B,SAAS,CAAC,kBAAkB,CACxB,WAAW,EAAE,wBAAwB,EACrC,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,gBAAgB;cAUZ,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC;IA2BhH;;OAEG;IACM,aAAa,YAAa;IAEnC;;OAEG;IACM,mBAAmB,YAAa;IAEzC;;OAEG;IACM,SAAS,YAAa;IAE/B;;OAEG;IACM,eAAe,YAAa;IAErC;;OAEG;IACM,UAAU,YAAa;IAEhC;;OAEG;IACM,gBAAgB,YAAa;IAEtC;;OAEG;IACM,MAAM,YAAa;IAE5B;;OAEG;IACM,KAAK,YAAa;IAE3B;;OAEG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAajE"}
+{"version":3,"file":"openrouter.d.ts","sourceRoot":"","sources":["../src/openrouter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAgB,QAAQ,EAA2H,OAAO,EAAmB,SAAS,EAAkC,QAAQ,EAAE,MAAM,UAAU,CAAC;AAE/P,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,gBAAgB,EAA2G,KAAK,OAAO,EAAiB,KAAK,QAAQ,EAAE,KAAK,mBAAmB,EAAiD,MAAM,YAAY,CAAC;AAC7R,OAAO,EAAE,KAAK,eAAe,EAAsB,YAAY,EAAE,cAAc,EAAE,KAAK,YAAY,EAAuF,MAAM,cAAc,CAAC;AAC9M,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,KAAK,EAAmB,mBAAmB,EAAgD,qBAAqB,EAAE,sBAAsB,EAAE,qBAAqB,EAAmB,iBAAiB,EAAE,eAAe,EAAoB,gBAAgB,EAAE,6BAA6B,EAAE,wBAAwB,EAA2D,MAAM,SAAS,CAAC;AAEnY;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC;IACjE,aAAa,CAAC,EAAE;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE;YACV,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;YACjB,cAAc,CAAC,EAAE,OAAO,CAAC;YACzB;;;;;;;;;;;eAWG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAC5B,cAAc,CAAC,EAAE,6BAA6B,CAAC,iBAAiB,CAAC,CAAC;YAClE,GAAG,CAAC,EAAE,OAAO,CAAC;YAEd,sBAAsB,CAAC,EAAE,OAAO,CAAC;YACjC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;YAClB,aAAa,CAAC,EAAE,6BAA6B,CAAC,eAAe,CAAC,CAAC;YAC/D,IAAI,CAAC,EAAE,6BAA6B,CAAC,MAAM,CAAC,CAAC;YAE7C,sBAAsB,CAAC,EAAE,MAAM,CAAC;YAChC,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B,QAAQ,CAAC,EAAE,6BAA6B,CAAC,WAAW,CAAC,CAAC;SACvD,CAAC;QAEF,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;QAE1B,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;QAC7B;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;CACH;AAgHD;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,eAAe,EACtB,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,EACxB,OAAO,CAAC,EAAE,iBAAiB,GAAG,IAAI,GACjC,SAAS,CAyDX;AA0ED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,cAAc,CAAC,gBAAgB,CAAE,YAAW,QAAQ,CAAC,gBAAgB,CAAC;IAC5G,QAAQ,CAAC,IAAI,gBAAgB;IAE7B,mBAA4B,QAAQ;;;;;;;;;;MAAkB;IAEtD;;;;;;;;;;;;;;;;OAgBG;IACH,UAAmB,uBAAuB,EAAE,WAAW,CAAC,gBAAgB,CAAC,CACH;IAItE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAoE;IAEhG,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM;IAaxD,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,SAAS;IAetD;;;OAGG;cACgB,aAAa,IAAI,OAAO;IAI3C;;;OAGG;cACgB,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,OAAO;IAI5G;;;OAGG;cACgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,mBAAmB,GAAG,SAAS;IAOlG;;;;;OAKG;cACgB,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS;IAKlH;;OAEG;cACgB,kBAAkB,CACnC,MAAM,EAAE,qBAAqB,EAC7B,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,gBAAgB;cA8EP,mBAAmB,CACpC,QAAQ,EAAE,sBAAsB,EAChC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,gBAAgB;cAYP,gBAAgB,CACjC,QAAQ,EAAE,mBAAmB,EAC7B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,gBAAgB;IAY1B;;;OAGG;cACgB,kBAAkB,CACnC,WAAW,EAAE,qBAAqB;cAQjB,kBAAkB,CACnC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,0BAA0B,EACnD,OAAO,EAAE,OAAO;IAOlB;;;;OAIG;cACsB,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAazH;;;OAGG;YACW,UAAU;IAoBf,aAAa,EAAE,QAAQ,CAAC,eAAe,CAAC,CACY;IAEpD,SAAS,EAAE,QAAQ,CAAC,WAAW,CAAC,CAC0D;IAEnG;;;OAGG;IACM,mBAAmB,YAAa;IAChC,eAAe,YAAa;IAErC;;;OAGG;IACM,gBAAgB,YAAa;IAEtC;;;;;;;OAOG;IACH,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CASzB;IAED;;;;;;;;;OASG;IACM,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAelC;IAED;;OAEG;cACsB,WAAW,CAAC,KAAK,EAAE,eAAe,EAAE,GAAG,EAAE,YAAY,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMpH;;OAEG;cACsB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,YAAY,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAM7G;;OAEG;IACH,OAAO,CAAC,UAAU;IAQlB;;OAEG;IACY,UAAU,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAa3E"}