@openrouter/ai-sdk-provider 0.0.3 → 0.0.5

package/README.md

@@ -7,27 +7,27 @@ contains 160+ language model support for the OpenRouter chat and completion APIs
 
 ```bash
 # For pnpm
-pnpm add openrouter-ai-provider
+pnpm add @openrouter/ai-sdk-provider
 
 # For npm
-npm install openrouter-ai-provider
+npm install @openrouter/ai-sdk-provider
 
 # For yarn
-yarn add openrouter-ai-provider
+yarn add @openrouter/ai-sdk-provider
 ```
 
 ## Provider Instance
 
-You can import the default provider instance `openrouter` from `openrouter-ai-provider`:
+You can import the default provider instance `openrouter` from `@openrouter/ai-sdk-provider`:
 
 ```ts
-import { openrouter } from "openrouter-ai-provider";
+import { openrouter } from "@openrouter/ai-sdk-provider";
 ```
 
 ## Example
 
 ```ts
-import { openrouter } from "openrouter-ai-provider";
+import { openrouter } from "@openrouter/ai-sdk-provider";
 import { generateText } from "ai";
 
 const { text } = await generateText({
@@ -38,7 +38,7 @@ const { text } = await generateText({
 
 ## Supported models
 
-This list is not a definitive list of models supported by OpenRouter, as it constantly changes as we add new models to our system.  
+This list is not a definitive list of models supported by OpenRouter, as it constantly changes as we add new models (and deprecate old ones) to our system.  
 You can find the latest list of models supported by OpenRouter [here](https://openrouter.ai/models).
 
 | Model                                         | ID                                          | Input Price ($/1M tokens) | Output Price ($/1M tokens) | Context Window | Moderation |
@@ -191,3 +191,71 @@ You can find the latest list of models supported by OpenRouter [here](https://op
 | Mistral: Mistral 7B Instruct (free)           | mistralai/mistral-7b-instruct:free          | $0 (100% off)             | $0 (100% off)              | 32,768         | None       |
 | Pygmalion: Mythalion 13B                      | pygmalionai/mythalion-13b                   | $1.125 (25% off)          | $1.125 (25% off)           | 8,192          | None       |
 | OpenAI: GPT-3.5 Turbo 16k                     | openai/gpt-3.5-turbo-16k                    | $3                        | $4                         | 16,385         | Moderated  |
+
+## Models with Tool Calling Capabilities Compatible with AI SDK
+
+_Last Update: 2024-08-19_
+
+This list is not a definitive list of tool-calling models supported by OpenRouter, as it constantly changes as we add new models (and deprecate old ones) to our system.
+You can find the latest list of tool-supported models supported by OpenRouter [here](https://openrouter.ai/models?order=newest&supported_parameters=tools). (Note: This list may contain models that are not compatible with the AI SDK.)
+
+- openai/gpt-3.5-turbo
+- openai/gpt-3.5-turbo-0125
+- openai/gpt-3.5-turbo-1106
+- openai/gpt-3.5-turbo-0613
+- openai/gpt-3.5-turbo-16k
+- openai/gpt-4o
+- openai/gpt-4o-2024-05-13
+- openai/gpt-4o-2024-08-06
+- openai/gpt-4o-mini
+- openai/gpt-4o-mini-2024-07-18
+- openai/gpt-4-turbo
+- openai/gpt-4-turbo-preview
+- openai/gpt-4-1106-preview
+- openai/gpt-4
+- openai/gpt-4-32k
+- openai/gpt-4-vision-preview
+- google/gemini-pro
+- google/gemini-pro-vision
+- google/gemini-pro-1.5
+- google/gemini-flash-1.5
+- mistralai/mistral-small
+- mistralai/mistral-large
+- 01-ai/yi-large-fc
+- anthropic/claude-3-opus
+- anthropic/claude-3-opus:beta
+- anthropic/claude-3-sonnet
+- anthropic/claude-3-sonnet:beta
+- anthropic/claude-3.5-sonnet
+- anthropic/claude-3.5-sonnet:beta
+- anthropic/claude-3-haiku
+- anthropic/claude-3-haiku:beta
+- meta-llama/llama-3-8b-instruct
+- mistralai/mixtral-8x22b-instruct
+
+## Passing Extra Body to OpenRouter
+
+When you want to pass extra body to OpenRouter or to the upstream provider, you can do so by setting the `extraBody` property on the language model.
+
+```typescript
+import { createOpenRouter } from "@ai-sdk/openrouter";
+
+const provider = createOpenRouter({
+  apiKey: "your-api-key",
+  // Extra body to pass to OpenRouter
+  extraBody: {
+    custom_field: "custom_value",
+    providers: {
+      anthropic: {
+        custom_field: "custom_value",
+      },
+    },
+  },
+});
+const model = provider.chat("anthropic/claude-3.5-sonnet");
+const response = await model.doStream({
+  inputFormat: "prompt",
+  mode: { type: "regular" },
+  prompt: [{ role: "user", content: "Hello" }],
+});
+```

package/dist/index.d.mts

@@ -49,6 +49,7 @@ type OpenRouterChatConfig = {
         path: string;
     }) => string;
     fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
 };
 declare class OpenRouterChatLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
@@ -63,7 +64,7 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV1 {
     doStream(options: Parameters<LanguageModelV1["doStream"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doStream"]>>>;
 }
 
-type OpenRouterCompletionModelId = "openai/gpt-3.5-turbo-instruct" | (string & {});
+type OpenRouterCompletionModelId = string & {};
 interface OpenRouterCompletionSettings {
     /**
   Echo back the prompt in addition to the completion.
@@ -116,6 +117,7 @@ type OpenRouterCompletionConfig = {
         path: string;
     }) => string;
     fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
 };
 declare class OpenRouterCompletionLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
@@ -158,14 +160,6 @@ interface OpenRouterProviderSettings {
        */
     apiKey?: string;
     /**
-  OpenRouter Organization.
-       */
-    organization?: string;
-    /**
-  OpenRouter project.
-       */
-    project?: string;
-    /**
   Custom headers to include in the requests.
        */
     headers?: Record<string, string>;
@@ -180,6 +174,10 @@ interface OpenRouterProviderSettings {
   or to provide a custom fetch implementation for e.g. testing.
       */
     fetch?: typeof fetch;
+    /**
+  A JSON object to send as the request body to access OpenRouter features & upstream provider features.
+    */
+    extraBody?: Record<string, unknown>;
 }
 /**
 Create an OpenRouter provider instance.
@@ -201,18 +199,10 @@ declare class OpenRouter {
     readonly baseURL: string;
     /**
   API key that is being send using the `Authorization` header.
-  It defaults to the `OPENAI_API_KEY` environment variable.
+  It defaults to the `OPENROUTER_API_KEY` environment variable.
    */
     readonly apiKey?: string;
     /**
-  OpenRouter Organization.
-     */
-    readonly organization?: string;
-    /**
-  OpenRouter project.
-     */
-    readonly project?: string;
-    /**
   Custom headers to include in the requests.
      */
     readonly headers?: Record<string, string>;

package/dist/index.d.ts

@@ -49,6 +49,7 @@ type OpenRouterChatConfig = {
         path: string;
     }) => string;
     fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
 };
 declare class OpenRouterChatLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
@@ -63,7 +64,7 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV1 {
     doStream(options: Parameters<LanguageModelV1["doStream"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doStream"]>>>;
 }
 
-type OpenRouterCompletionModelId = "openai/gpt-3.5-turbo-instruct" | (string & {});
+type OpenRouterCompletionModelId = string & {};
 interface OpenRouterCompletionSettings {
     /**
   Echo back the prompt in addition to the completion.
@@ -116,6 +117,7 @@ type OpenRouterCompletionConfig = {
         path: string;
     }) => string;
     fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
 };
 declare class OpenRouterCompletionLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
@@ -158,14 +160,6 @@ interface OpenRouterProviderSettings {
        */
     apiKey?: string;
     /**
-  OpenRouter Organization.
-       */
-    organization?: string;
-    /**
-  OpenRouter project.
-       */
-    project?: string;
-    /**
   Custom headers to include in the requests.
        */
     headers?: Record<string, string>;
@@ -180,6 +174,10 @@ interface OpenRouterProviderSettings {
   or to provide a custom fetch implementation for e.g. testing.
       */
     fetch?: typeof fetch;
+    /**
+  A JSON object to send as the request body to access OpenRouter features & upstream provider features.
+    */
+    extraBody?: Record<string, unknown>;
 }
 /**
 Create an OpenRouter provider instance.
@@ -201,18 +199,10 @@ declare class OpenRouter {
     readonly baseURL: string;
     /**
   API key that is being send using the `Authorization` header.
-  It defaults to the `OPENAI_API_KEY` environment variable.
+  It defaults to the `OPENROUTER_API_KEY` environment variable.
    */
     readonly apiKey?: string;
     /**
-  OpenRouter Organization.
-     */
-    readonly organization?: string;
-    /**
-  OpenRouter project.
-     */
-    readonly project?: string;
-    /**
   Custom headers to include in the requests.
      */
     readonly headers?: Record<string, string>;

package/dist/index.js

@@ -221,7 +221,7 @@ var OpenRouterChatLanguageModel = class {
     seed
   }) {
     const type = mode.type;
-    const baseArgs = {
+    const baseArgs = __spreadValues({
       // model id:
       model: this.modelId,
       // model specific settings:
@@ -239,7 +239,7 @@ var OpenRouterChatLanguageModel = class {
       seed,
       // messages:
       messages: convertToOpenRouterChatMessages(prompt)
-    };
+    }, this.config.extraBody);
     switch (type) {
       case "regular": {
         return __spreadValues(__spreadValues({}, baseArgs), prepareToolsAndToolChoice(mode));
@@ -741,7 +741,7 @@ var OpenRouterCompletionLanguageModel = class {
     var _a;
     const type = mode.type;
     const { prompt: completionPrompt, stopSequences } = convertToOpenRouterCompletionPrompt({ prompt, inputFormat });
-    const baseArgs = {
+    const baseArgs = __spreadValues({
       // model id:
       model: this.modelId,
       // model specific settings:
@@ -761,7 +761,7 @@ var OpenRouterCompletionLanguageModel = class {
       prompt: completionPrompt,
       // stop sequences:
       stop: stopSequences
-    };
+    }, this.config.extraBody);
     switch (type) {
       case "regular": {
         if ((_a = mode.tools) == null ? void 0 : _a.length) {
@@ -961,22 +961,17 @@ var OpenRouter = class {
     var _a, _b;
     this.baseURL = (_b = (0, import_provider_utils5.withoutTrailingSlash)((_a = options.baseURL) != null ? _a : options.baseUrl)) != null ? _b : "https://openrouter.ai/api/v1";
     this.apiKey = options.apiKey;
-    this.organization = options.organization;
-    this.project = options.project;
     this.headers = options.headers;
   }
   get baseConfig() {
     return {
-      organization: this.organization,
       baseURL: this.baseURL,
       headers: () => __spreadValues({
         Authorization: `Bearer ${(0, import_provider_utils5.loadApiKey)({
           apiKey: this.apiKey,
-          environmentVariableName: "OPENAI_API_KEY",
+          environmentVariableName: "OPENROUTER_API_KEY",
           description: "OpenRouter"
-        })}`,
-        "OpenRouter-Organization": this.organization,
-        "OpenRouter-Project": this.project
+        })}`
       }, this.headers)
     };
   }
@@ -1007,25 +1002,25 @@ function createOpenRouter(options = {}) {
   const getHeaders = () => __spreadValues({
     Authorization: `Bearer ${(0, import_provider_utils6.loadApiKey)({
       apiKey: options.apiKey,
-      environmentVariableName: "OPENAI_API_KEY",
+      environmentVariableName: "OPENROUTER_API_KEY",
       description: "OpenRouter"
-    })}`,
-    "OpenRouter-Organization": options.organization,
-    "OpenRouter-Project": options.project
+    })}`
   }, options.headers);
   const createChatModel = (modelId, settings = {}) => new OpenRouterChatLanguageModel(modelId, settings, {
     provider: "openrouter.chat",
     url: ({ path }) => `${baseURL}${path}`,
     headers: getHeaders,
     compatibility,
-    fetch: options.fetch
+    fetch: options.fetch,
+    extraBody: options.extraBody
   });
   const createCompletionModel = (modelId, settings = {}) => new OpenRouterCompletionLanguageModel(modelId, settings, {
     provider: "openrouter.completion",
     url: ({ path }) => `${baseURL}${path}`,
     headers: getHeaders,
     compatibility,
-    fetch: options.fetch
+    fetch: options.fetch,
+    extraBody: options.extraBody
   });
   const createLanguageModel = (modelId, settings) => {
     if (new.target) {