Merge pull request #94 from token-js/pate/open-router

feat: Support OpenRouter

Author: RPate97

.changeset/eight-goats-jam.md

@@ -0,0 +1,5 @@
+---
+'token.js': patch
+---
+
+Support OpenRouter

.env.example

@@ -19,6 +19,9 @@ GROQ_API_KEY=
 # Mistral
 MISTRAL_API_KEY=
 
+# OpenRouter
+OPENROUTER_API_KEY=
+
 # Perplexity
 PERPLEXITY_API_KEY=
 

README.md

@@ -1,10 +1,10 @@
 # Token.js
 
-Integrate 60+ LLMs with one TypeScript SDK using OpenAI's format. Free and open source. No proxy server required.
+Integrate 200+ LLMs with one TypeScript SDK using OpenAI's format. Free and open source. No proxy server required.
 
 ## Features
 
-* Use OpenAI's format to call 60+ LLMs from 9 providers.
+* Use OpenAI's format to call 200+ LLMs from 10 providers.
 * Supports tools, JSON outputs, image inputs, streaming, and more.
 * Runs completely on the client side. No proxy server needed.
 * Free and open source under MIT.
@@ -20,6 +20,7 @@ Integrate 60+ LLMs with one TypeScript SDK using OpenAI's format. Free and open
 * Mistral
 * OpenAI
 * Perplexity
+* OpenRouter
 
 ## [Documentation](https://docs.tokenjs.ai/)
 

docs/README.md

@@ -1,14 +1,14 @@
 ---
 description: >-
-  Integrate 60+ LLMs with one TypeScript SDK using OpenAI's format.
+  Integrate 200+ LLMs with one TypeScript SDK using OpenAI's format.
   Free and open source. No proxy server required.
 ---
 
 # Token.js
 
 ## Features
 
-* Use OpenAI's format to call 60+ LLMs from 9 providers.
+* Use OpenAI's format to call 200+ LLMs from 10 providers.
 * Supports tools, JSON outputs, image inputs, streaming, and more.
 * Runs completely on the client side. No proxy server needed.
 * Free and open source under MIT.
@@ -24,6 +24,7 @@ description: >-
 * Mistral
 * OpenAI
 * Perplexity
+* OpenRouter
 
 ## Setup
 
@@ -261,6 +262,39 @@ async function main() {
 main()
 ```
 {% endtab %}
+
+{% tab title="OpenRouter" %}
+{% code title=".env" %}
+```bash
+OPENROUTER_API_KEY=<openrouter api key>
+```
+{% endcode %}
+
+```typescript
+import { TokenJS } from 'token.js'
+
+// Create the Token.js client
+const tokenjs = new TokenJS()
+
+async function main() {
+  // Create a model response
+  const completion = await tokenjs.chat.completions.create({
+    // Specify the provider and model
+    provider: 'openrouter',
+    model: 'nvidia/nemotron-4-340b-instruct',
+    // Define your message
+    messages: [
+      {
+        role: 'user',
+        content: 'Hello!',
+      },
+    ],
+  })
+  console.log(completion.choices[0])
+}
+main()
+```
+{% endtab %}
 {% endtabs %}
 
 ### Access Credentials
@@ -284,6 +318,8 @@ GROQ_API_KEY=
 MISTRAL_API_KEY=
 # Perplexity
 PERPLEXITY_API_KEY=
+# OpenRouter
+OPENROUTER_API_KEY=
 # AWS Bedrock
 AWS_REGION_NAME=
 AWS_ACCESS_KEY_ID=

docs/SUMMARY.md

@@ -10,6 +10,7 @@
   * [Groq](providers/groq.md)
   * [Mistral](providers/mistral.md)
   * [OpenAI](providers/openai.md)
+  * [OpenRouter](providers/openrouter.md)
   * [Perplexity](providers/perplexity.md)
 * [Contact Us](contact-us.md)
 * [Contributing](https://github.com/token-js/token.js/blob/main/CONTRIBUTING.md)

docs/providers/README.md

@@ -4,4 +4,4 @@ description: Integrate LLM providers and models using Token.js.
 
 # Providers
 
-<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>AI21</td><td></td><td></td><td><a href="ai21.md">ai21.md</a></td></tr><tr><td>Anthropic</td><td></td><td></td><td><a href="anthropic.md">anthropic.md</a></td></tr><tr><td>Bedrock</td><td></td><td></td><td><a href="bedrock.md">bedrock.md</a></td></tr><tr><td>Cohere</td><td></td><td></td><td><a href="cohere.md">cohere.md</a></td></tr><tr><td>Gemini</td><td></td><td></td><td><a href="gemini.md">gemini.md</a></td></tr><tr><td>Groq</td><td></td><td></td><td><a href="groq.md">groq.md</a></td></tr><tr><td>Mistral</td><td></td><td></td><td><a href="mistral.md">mistral.md</a></td></tr><tr><td>OpenAI</td><td></td><td></td><td><a href="openai.md">openai.md</a></td></tr><tr><td>Perplexity</td><td></td><td></td><td><a href="perplexity.md">perplexity.md</a></td></tr></tbody></table>
+<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>AI21</td><td></td><td></td><td><a href="ai21.md">ai21.md</a></td></tr><tr><td>Anthropic</td><td></td><td></td><td><a href="anthropic.md">anthropic.md</a></td></tr><tr><td>Bedrock</td><td></td><td></td><td><a href="bedrock.md">bedrock.md</a></td></tr><tr><td>Cohere</td><td></td><td></td><td><a href="cohere.md">cohere.md</a></td></tr><tr><td>Gemini</td><td></td><td></td><td><a href="gemini.md">gemini.md</a></td></tr><tr><td>Groq</td><td></td><td></td><td><a href="groq.md">groq.md</a></td></tr><tr><td>Mistral</td><td></td><td></td><td><a href="mistral.md">mistral.md</a></td></tr><tr><td>OpenAI</td><td></td><td></td><td><a href="openai.md">openai.md</a></td></tr><tr><td>Perplexity</td><td></td><td></td><td><a href="perplexity.md">perplexity.md</a></td></tr><tr><td>OpenRouter</td><td></td><td></td><td><a href="openrouter.md">openrouter.md</a></td></tr></tbody></table>

docs/providers/openrouter.md

@@ -0,0 +1,44 @@
+# Perplexity
+
+[Get an OpenRouter API key](https://openrouter.ai/settings/keys)
+
+## Usage
+
+{% code title=".env" %}
+```bash
+OPENROUTER_API_KEY=
+```
+{% endcode %}
+
+```typescript
+import { TokenJS } from 'token.js'
+
+// Create the Token.js client
+const tokenjs = new TokenJS()
+
+async function main() {
+  // Create a model response
+  const completion = await tokenjs.chat.completions.create({
+    // Specify the provider and model
+    provider: 'openrouter',
+    model: 'nvidia/nemotron-4-340b-instruct',
+    // Define your message
+    messages: [
+      {
+        role: 'user',
+        content: 'Hello!',
+      },
+    ],
+  })
+  console.log(completion.choices[0])
+}
+main()
+```
+
+## Compatibility
+OpenRouter supports more than 180 models from a variety of providers which may have varying feature support. We recommend reviewing the OpenRouter and provider documentation for specific compatibility information.
+
+## Additional Resources
+
+* [Supported Models](https://openrouter.ai/models)
+* [OpenRouter Documentation](https://openrouter.ai/docs/quick-start)

scripts/docs/generate.ts

@@ -14,10 +14,22 @@ const generateCompatibility = async () => {
 
     let pushHeader = true
 
+    if (compatibility.generateDocs === false) {
+      continue
+    }
+
+    if (typeof compatibility.models === 'boolean') {
+      throw new Error(
+        'Auto-generating model compatibility tables is not supported for providers that do not have explicitly defined models.'
+      )
+    }
+
     for (const model of compatibility.models) {
       const header: string[] = []
       const features: string[] = [model]
       for (const [feature, models] of Object.entries(compatibility)) {
+        if (feature === 'generateDocs') continue
+
         header.push(TableDisplayNames[feature])
 
         if (feature === 'models') continue
@@ -40,7 +52,9 @@ const generateCompatibility = async () => {
     const mkdTable = markdownTable(table)
     const providerDocs = readFileSync(`docs/providers/${provider}.md`, 'utf-8')
     const docsSplit = providerDocs.split('<!-- compatibility -->')
-    const afterCompatibilitySplit = docsSplit[1].split('<!-- end compatibility -->')
+    const afterCompatibilitySplit = docsSplit[1].split(
+      '<!-- end compatibility -->'
+    )
 
     const newDocs = `${docsSplit[0]}<!-- compatibility -->\n## Supported Models\n\n${mkdTable}\n\n${legend}<!-- end compatibility -->${afterCompatibilitySplit[1]}`
 

src/chat/index.ts

@@ -17,6 +17,7 @@ export type BedrockModel = (typeof models.bedrock.models)[number]
 export type MistralModel = (typeof models.mistral.models)[number]
 export type PerplexityModel = (typeof models.perplexity.models)[number]
 export type GroqModel = (typeof models.groq.models)[number]
+export type OpenRouterModel = string
 
 export type LLMChatModel =
   | OpenAIModel
@@ -28,6 +29,7 @@ export type LLMChatModel =
   | MistralModel
   | PerplexityModel
   | GroqModel
+  | OpenRouterModel
 
 export type LLMProvider = keyof typeof models
 
@@ -41,6 +43,7 @@ type ProviderModelMap = {
   mistral: MistralModel
   perplexity: PerplexityModel
   groq: GroqModel
+  openrouter: OpenRouterModel
 }
 
 type CompletionBase<P extends LLMProvider> = Pick<

src/handlers/base.ts

@@ -8,21 +8,21 @@ import { InputError } from './types.js'
 
 export abstract class BaseHandler<T extends LLMChatModel> {
   opts: ConfigOptions
-  protected models: readonly T[]
-  protected supportsJSON: readonly T[]
-  protected supportsImages: readonly T[]
-  protected supportsToolCalls: readonly T[]
+  protected models: readonly T[] | boolean
+  protected supportsJSON: readonly T[] | boolean
+  protected supportsImages: readonly T[] | boolean
+  protected supportsToolCalls: readonly T[] | boolean
   protected supportsN: readonly T[] | boolean
-  protected supportsStreamingMessages: readonly T[]
+  protected supportsStreamingMessages: readonly T[] | boolean
 
   constructor(
     opts: ConfigOptions,
-    models: readonly T[],
-    supportsJSON: readonly T[],
-    supportsImages: readonly T[],
-    supportsToolCalls: readonly T[],
+    models: readonly T[] | boolean,
+    supportsJSON: readonly T[] | boolean,
+    supportsImages: readonly T[] | boolean,
+    supportsToolCalls: readonly T[] | boolean,
     suportsN: readonly T[] | boolean,
-    supportsStreamingMessages: readonly T[]
+    supportsStreamingMessages: readonly T[] | boolean
   ) {
     this.opts = opts
     this.models = models
@@ -38,6 +38,10 @@ export abstract class BaseHandler<T extends LLMChatModel> {
   ): Promise<CompletionResponse | StreamCompletionResponse>
 
   protected validateInputs(body: CompletionParams): void {
+    // We remove the provider key from the body just in case the provider does validation which errors due to it.
+    // This can only occur on OpenAI compatible providers, but we do it for all providers for consistency.
+    delete (body as any).provider
+
     if (!this.isSupportedModel(body.model)) {
       throw new InputError(`Invalid 'model' field: ${body.model}.`)
     }
@@ -149,8 +153,8 @@ export abstract class BaseHandler<T extends LLMChatModel> {
 
   // We make this public so that we can mock it in tests, which is fine because the `BaseHandler`
   // class isn't exposed to the user.
-  public isSupportedModel(model: LLMChatModel): model is T {
-    return this.models.includes(model as T)
+  public isSupportedModel(model: string): model is T {
+    return this.isSupportedFeature(this.models, model as T)
   }
 
   protected supportsJSONMode(model: T): boolean {