@openrouter/ai-sdk-provider 1.0.0 → 1.1.1

package/dist/index.d.mts

@@ -39,6 +39,80 @@ type OpenRouterChatSettings = {
   monitor and detect abuse. Learn more.
   */
     user?: string;
+    /**
+     * Web search plugin configuration for enabling web search capabilities
+     */
+    plugins?: Array<{
+        id: 'web';
+        /**
+         * Maximum number of search results to include (default: 5)
+         */
+        max_results?: number;
+        /**
+         * Custom search prompt to guide the search query
+         */
+        search_prompt?: string;
+    }>;
+    /**
+     * Built-in web search options for models that support native web search
+     */
+    web_search_options?: {
+        /**
+         * Maximum number of search results to include
+         */
+        max_results?: number;
+        /**
+         * Custom search prompt to guide the search query
+         */
+        search_prompt?: string;
+    };
+    /**
+     * Provider routing preferences to control request routing behavior
+     */
+    provider?: {
+        /**
+         * List of provider slugs to try in order (e.g. ["anthropic", "openai"])
+         */
+        order?: string[];
+        /**
+         * Whether to allow backup providers when primary is unavailable (default: true)
+         */
+        allow_fallbacks?: boolean;
+        /**
+         * Only use providers that support all parameters in your request (default: false)
+         */
+        require_parameters?: boolean;
+        /**
+         * Control whether to use providers that may store data
+         */
+        data_collection?: 'allow' | 'deny';
+        /**
+         * List of provider slugs to allow for this request
+         */
+        only?: string[];
+        /**
+         * List of provider slugs to skip for this request
+         */
+        ignore?: string[];
+        /**
+         * List of quantization levels to filter by (e.g. ["int4", "int8"])
+         */
+        quantizations?: Array<'int4' | 'int8' | 'fp4' | 'fp6' | 'fp8' | 'fp16' | 'bf16' | 'fp32' | 'unknown'>;
+        /**
+         * Sort providers by price, throughput, or latency
+         */
+        sort?: 'price' | 'throughput' | 'latency';
+        /**
+         * Maximum pricing you want to pay for this request
+         */
+        max_price?: {
+            prompt?: number | string;
+            completion?: number | string;
+            image?: number | string;
+            audio?: number | string;
+            request?: number | string;
+        };
+    };
 } & OpenRouterSharedSettings;
 
 type OpenRouterProviderOptions = {
@@ -162,6 +236,7 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
         warnings: Array<LanguageModelV2CallWarning>;
         providerMetadata?: {
             openrouter: {
+                provider: string;
                 usage: OpenRouterUsageAccounting;
             };
         };

package/dist/index.d.ts

@@ -39,6 +39,80 @@ type OpenRouterChatSettings = {
   monitor and detect abuse. Learn more.
   */
     user?: string;
+    /**
+     * Web search plugin configuration for enabling web search capabilities
+     */
+    plugins?: Array<{
+        id: 'web';
+        /**
+         * Maximum number of search results to include (default: 5)
+         */
+        max_results?: number;
+        /**
+         * Custom search prompt to guide the search query
+         */
+        search_prompt?: string;
+    }>;
+    /**
+     * Built-in web search options for models that support native web search
+     */
+    web_search_options?: {
+        /**
+         * Maximum number of search results to include
+         */
+        max_results?: number;
+        /**
+         * Custom search prompt to guide the search query
+         */
+        search_prompt?: string;
+    };
+    /**
+     * Provider routing preferences to control request routing behavior
+     */
+    provider?: {
+        /**
+         * List of provider slugs to try in order (e.g. ["anthropic", "openai"])
+         */
+        order?: string[];
+        /**
+         * Whether to allow backup providers when primary is unavailable (default: true)
+         */
+        allow_fallbacks?: boolean;
+        /**
+         * Only use providers that support all parameters in your request (default: false)
+         */
+        require_parameters?: boolean;
+        /**
+         * Control whether to use providers that may store data
+         */
+        data_collection?: 'allow' | 'deny';
+        /**
+         * List of provider slugs to allow for this request
+         */
+        only?: string[];
+        /**
+         * List of provider slugs to skip for this request
+         */
+        ignore?: string[];
+        /**
+         * List of quantization levels to filter by (e.g. ["int4", "int8"])
+         */
+        quantizations?: Array<'int4' | 'int8' | 'fp4' | 'fp6' | 'fp8' | 'fp16' | 'bf16' | 'fp32' | 'unknown'>;
+        /**
+         * Sort providers by price, throughput, or latency
+         */
+        sort?: 'price' | 'throughput' | 'latency';
+        /**
+         * Maximum pricing you want to pay for this request
+         */
+        max_price?: {
+            prompt?: number | string;
+            completion?: number | string;
+            image?: number | string;
+            audio?: number | string;
+            request?: number | string;
+        };
+    };
 } & OpenRouterSharedSettings;
 
 type OpenRouterProviderOptions = {
@@ -162,6 +236,7 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
         warnings: Array<LanguageModelV2CallWarning>;
         providerMetadata?: {
             openrouter: {
+                provider: string;
                 usage: OpenRouterUsageAccounting;
             };
         };

package/dist/index.js

@@ -1223,6 +1223,7 @@ var import_v44 = require("zod/v4");
 var OpenRouterChatCompletionBaseResponseSchema = import_v44.z.object({
   id: import_v44.z.string().optional(),
   model: import_v44.z.string().optional(),
+  provider: import_v44.z.string().optional(),
   usage: import_v44.z.object({
     prompt_tokens: import_v44.z.number(),
     prompt_tokens_details: import_v44.z.object({
@@ -1256,7 +1257,19 @@ var OpenRouterNonStreamChatCompletionResponseSchema = OpenRouterChatCompletionBa
               arguments: import_v44.z.string()
             })
           })
-        ).optional()
+        ).optional(),
+        annotations: import_v44.z.array(
+          import_v44.z.object({
+            type: import_v44.z.enum(["url_citation"]),
+            url_citation: import_v44.z.object({
+              end_index: import_v44.z.number(),
+              start_index: import_v44.z.number(),
+              title: import_v44.z.string(),
+              url: import_v44.z.string(),
+              content: import_v44.z.string().optional()
+            })
+          })
+        ).nullish()
       }),
       index: import_v44.z.number().nullish(),
       logprobs: import_v44.z.object({
@@ -1296,6 +1309,18 @@ var OpenRouterStreamChatCompletionChunkSchema = import_v44.z.union([
                 arguments: import_v44.z.string().nullish()
               })
             })
+          ).nullish(),
+          annotations: import_v44.z.array(
+            import_v44.z.object({
+              type: import_v44.z.enum(["url_citation"]),
+              url_citation: import_v44.z.object({
+                end_index: import_v44.z.number(),
+                start_index: import_v44.z.number(),
+                title: import_v44.z.string(),
+                url: import_v44.z.string(),
+                content: import_v44.z.string().optional()
+              })
+            })
           ).nullish()
         }).nullish(),
         logprobs: import_v44.z.object({
@@ -1378,7 +1403,12 @@ var OpenRouterChatLanguageModel = class {
       // OpenRouter specific settings:
       include_reasoning: this.settings.includeReasoning,
       reasoning: this.settings.reasoning,
-      usage: this.settings.usage
+      usage: this.settings.usage,
+      // Web search settings:
+      plugins: this.settings.plugins,
+      web_search_options: this.settings.web_search_options,
+      // Provider routing settings:
+      provider: this.settings.provider
     }, this.config.extraBody), this.settings.extraBody);
     if ((responseFormat == null ? void 0 : responseFormat.type) === "json" && responseFormat.schema != null) {
       return __spreadProps(__spreadValues({}, baseArgs), {
@@ -1399,7 +1429,7 @@ var OpenRouterChatLanguageModel = class {
         type: "function",
         function: {
           name: tool.name,
-          description: tool.type,
+          description: tool.description,
           parameters: tool.inputSchema
         }
       }));
@@ -1411,7 +1441,7 @@ var OpenRouterChatLanguageModel = class {
     return baseArgs;
   }
   async doGenerate(options) {
-    var _a15, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w;
+    var _a15, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
     const providerOptions = options.providerOptions || {};
     const openrouterOptions = providerOptions.openrouter || {};
     const args = __spreadValues(__spreadValues({}, this.getArgs(options)), openrouterOptions);
@@ -1505,6 +1535,24 @@ var OpenRouterChatLanguageModel = class {
         });
       }
     }
+    if (choice.message.annotations) {
+      for (const annotation of choice.message.annotations) {
+        if (annotation.type === "url_citation") {
+          content.push({
+            type: "source",
+            sourceType: "url",
+            id: annotation.url_citation.url,
+            url: annotation.url_citation.url,
+            title: annotation.url_citation.title,
+            providerMetadata: {
+              openrouter: {
+                content: annotation.url_citation.content || ""
+              }
+            }
+          });
+        }
+      }
+    }
     return {
       content,
       finishReason: mapOpenRouterFinishReason(choice.finish_reason),
@@ -1512,19 +1560,20 @@ var OpenRouterChatLanguageModel = class {
       warnings: [],
       providerMetadata: {
         openrouter: {
+          provider: (_k = response.provider) != null ? _k : "",
           usage: {
-            promptTokens: (_k = usageInfo.inputTokens) != null ? _k : 0,
-            completionTokens: (_l = usageInfo.outputTokens) != null ? _l : 0,
-            totalTokens: (_m = usageInfo.totalTokens) != null ? _m : 0,
-            cost: (_n = response.usage) == null ? void 0 : _n.cost,
+            promptTokens: (_l = usageInfo.inputTokens) != null ? _l : 0,
+            completionTokens: (_m = usageInfo.outputTokens) != null ? _m : 0,
+            totalTokens: (_n = usageInfo.totalTokens) != null ? _n : 0,
+            cost: (_o = response.usage) == null ? void 0 : _o.cost,
             promptTokensDetails: {
-              cachedTokens: (_q = (_p = (_o = response.usage) == null ? void 0 : _o.prompt_tokens_details) == null ? void 0 : _p.cached_tokens) != null ? _q : 0
+              cachedTokens: (_r = (_q = (_p = response.usage) == null ? void 0 : _p.prompt_tokens_details) == null ? void 0 : _q.cached_tokens) != null ? _r : 0
             },
             completionTokensDetails: {
-              reasoningTokens: (_t = (_s = (_r = response.usage) == null ? void 0 : _r.completion_tokens_details) == null ? void 0 : _s.reasoning_tokens) != null ? _t : 0
+              reasoningTokens: (_u = (_t = (_s = response.usage) == null ? void 0 : _s.completion_tokens_details) == null ? void 0 : _t.reasoning_tokens) != null ? _u : 0
             },
             costDetails: {
-              upstreamInferenceCost: (_w = (_v = (_u = response.usage) == null ? void 0 : _u.cost_details) == null ? void 0 : _v.upstream_inference_cost) != null ? _w : 0
+              upstreamInferenceCost: (_x = (_w = (_v = response.usage) == null ? void 0 : _v.cost_details) == null ? void 0 : _w.upstream_inference_cost) != null ? _x : 0
             }
           }
         }
@@ -1577,6 +1626,7 @@ var OpenRouterChatLanguageModel = class {
     let textId;
     let reasoningId;
     let openrouterResponseId;
+    let provider;
     return {
       stream: response.pipeThrough(
         new TransformStream({
@@ -1593,6 +1643,9 @@ var OpenRouterChatLanguageModel = class {
               controller.enqueue({ type: "error", error: value.error });
               return;
             }
+            if (value.provider) {
+              provider = value.provider;
+            }
             if (value.id) {
               openrouterResponseId = value.id;
               controller.enqueue({
@@ -1704,6 +1757,24 @@ var OpenRouterChatLanguageModel = class {
                 id: textId || generateId()
               });
             }
+            if (delta.annotations) {
+              for (const annotation of delta.annotations) {
+                if (annotation.type === "url_citation") {
+                  controller.enqueue({
+                    type: "source",
+                    sourceType: "url",
+                    id: annotation.url_citation.url,
+                    url: annotation.url_citation.url,
+                    title: annotation.url_citation.title,
+                    providerMetadata: {
+                      openrouter: {
+                        content: annotation.url_citation.content || ""
+                      }
+                    }
+                  });
+                }
+              }
+            }
             if (delta.tool_calls != null) {
               for (const toolCallDelta of delta.tool_calls) {
                 const index = (_c = toolCallDelta.index) != null ? _c : toolCalls.length - 1;
@@ -1826,14 +1897,18 @@ var OpenRouterChatLanguageModel = class {
                 id: textId || generateId()
               });
             }
+            const openrouterMetadata = {
+              usage: openrouterUsage
+            };
+            if (provider !== void 0) {
+              openrouterMetadata.provider = provider;
+            }
             controller.enqueue({
               type: "finish",
               finishReason,
               usage,
               providerMetadata: {
-                openrouter: {
-                  usage: openrouterUsage
-                }
+                openrouter: openrouterMetadata
               }
             });
           }