Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Generate model compatibility charts automatically #57

Merged
merged 1 commit into from
Jul 12, 2024
Merged

docs: Generate model compatibility charts automatically #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: CI

on:
pull_request:

jobs:
docs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 9
- name: Use Node.js 20
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'pnpm'
- name: Install dependencies
run: pnpm install
- name: Check Docs
run: pnpm docs:check
12 changes: 6 additions & 6 deletions docs/providers/ai21.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
})
```

### Supported Models

| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
| -------------- | ----------- | ----- | ----------- | --------- | ----- |
| jamba-instruct | | | | | |
### [AI21 Documentation](https://docs.ai21.com/reference/jamba-instruct-api)

<!-- compatibility -->
### Supported Models

| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
| -------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
| jamba-instruct | ✅ | | | | | ✅ |

### [AI21 Documentation](https://docs.ai21.com/reference/jamba-instruct-api)
24 changes: 12 additions & 12 deletions docs/providers/anthropic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,18 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
})
```

### Supported Models

| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
| -------------------------- | ----------- | ----- | ----------- | --------- | ----- |
| claude-3-5-sonnet-20240620 | | | | | |
| claude-3-opus-20240229 | | | | | |
| claude-3-sonnet-20240229 | | | | | |
| claude-3-haiku-20240307 | | | | | |
| claude-2.1 | | | | | |
| claude-2.0 | | | | | |
| claude-instant-1.2 | | | | | |
### [Anthropic Documentation](https://docs.anthropic.com/en/docs/welcome)

<!-- compatibility -->
### Supported Models

| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
| -------------------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
| claude-3-5-sonnet-20240620 | ✅ | | | ✅ | ✅ | |
| claude-3-opus-20240229 | ✅ | | | ✅ | ✅ | |
| claude-3-sonnet-20240229 | ✅ | | | ✅ | ✅ | |
| claude-3-haiku-20240307 | ✅ | | | ✅ | ✅ | |
| claude-2.1 | ✅ | | | | | |
| claude-2.0 | ✅ | | | | | |
| claude-instant-1.2 | ✅ | | | | | |

### [Anthropic Documentation](https://docs.anthropic.com/en/docs/welcome)
50 changes: 25 additions & 25 deletions docs/providers/bedrock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,30 +31,30 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
})
```

### [Bedrock Documentation](https://docs.aws.amazon.com/bedrock/latest/APIReference/welcome.html)

<!-- compatibility -->
### Supported Models

| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
| --------------------------------------- | ----------- | ----- | ----------- | --------- | ----- |
| amazon.titan-text-lite-v1 | | | | | |
| amazon.titan-text-express-v1 | | | | | |
| anthropic.claude-3-opus-20240229-v1:0 | | | | | |
| anthropic.claude-3-sonnet-20240229-v1:0 | | | | | |
| anthropic.claude-3-haiku-20240307-v1:0 | | | | | |
| anthropic.claude-v2:1 | | | | | |
| anthropic.claude-v2 | | | | | |
| anthropic.claude-instant-v1 | | | | | |
| cohere.command-r-plus-v1:0 | | | | | |
| cohere.command-r-v1:0 | | | | | |
| cohere.command-text-v14 | | | | | |
| cohere.command-light-text-v14 | | | | | |
| meta.llama3-8b-instruct-v1:0 | | | | | |
| meta.llama3-70b-instruct-v1:0 | | | | | |
| meta.llama2-13b-chat-v1 | | | | | |
| meta.llama2-70b-chat-v1 | | | | | |
| mistral.mistral-7b-instruct-v0:2 | | | | | |
| mistral.mixtral-8x7b-instruct-v0:1 | | | | | |
| mistral.mistral-large-2402-v1:0 | | | | | |



### [Bedrock Documentation](https://docs.aws.amazon.com/bedrock/latest/APIReference/welcome.html)
| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
| --------------------------------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
| amazon.titan-text-lite-v1 | ✅ | | | | | |
| amazon.titan-text-express-v1 | ✅ | | | | | |
| anthropic.claude-3-opus-20240229-v1:0 | ✅ | | | ✅ | ✅ | |
| anthropic.claude-3-sonnet-20240229-v1:0 | ✅ | | | ✅ | ✅ | |
| anthropic.claude-3-haiku-20240307-v1:0 | ✅ | | | ✅ | ✅ | |
| anthropic.claude-v2:1 | ✅ | | | | | |
| anthropic.claude-v2 | ✅ | | | | | |
| anthropic.claude-instant-v1 | ✅ | | | | | |
| cohere.command-r-plus-v1:0 | ✅ | | | | ✅ | |
| cohere.command-r-v1:0 | ✅ | | | | ✅ | |
| cohere.command-text-v14 | ✅ | | | | | |
| cohere.command-light-text-v14 | ✅ | | | | | |
| meta.llama3-8b-instruct-v1:0 | ✅ | | | | | |
| meta.llama3-70b-instruct-v1:0 | ✅ | | | | | |
| meta.llama2-13b-chat-v1 | ✅ | | | | | |
| meta.llama2-70b-chat-v1 | ✅ | | | | | |
| mistral.mistral-7b-instruct-v0:2 | ✅ | | | | | |
| mistral.mixtral-8x7b-instruct-v0:1 | ✅ | | | | | |
| mistral.mistral-large-2402-v1:0 | ✅ | | | | ✅ | |

22 changes: 11 additions & 11 deletions docs/providers/cohere.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
})
```

### Supported Models

| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
| --------------------- | ----------- | ----- | ----------- | --------- | ----- |
| command-r-plus | | | | | |
| command-r | | | | | |
| command | | | | | |
| command-nightly | | | | | |
| command-light | | | | | |
| command-light-nightly | | | | | |
### [Cohere Documentation](https://docs.cohere.com)

<!-- compatibility -->
### Supported Models

| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
| --------------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
| command-r-plus | ✅ | | | | ✅ | |
| command-r | ✅ | | | | ✅ | |
| command | ✅ | | | | | |
| command-nightly | ✅ | | | | ✅ | |
| command-light | ✅ | | | | | |
| command-light-nightly | ✅ | | | | | |

### [Cohere Documentation](https://docs.cohere.com)
17 changes: 8 additions & 9 deletions docs/providers/gemini.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,14 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
})
```

### Supported Models

| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
| ---------------- | ----------- | ----- | ----------- | --------- | ----- |
| gemini-1.5-pro | | | | | |
| gemini-1.5-flash | | | | | |
| gemini-1.0-pro | | | | | |

### [Gemini Documentation](https://ai.google.dev/gemini-api/docs)

<!-- compatibility -->
### Supported Models

### [Gemini Documentation](https://ai.google.dev/gemini-api/docs)
| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
| ---------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
| gemini-1.5-pro | ✅ | | ✅ | ✅ | ✅ | ✅ |
| gemini-1.5-flash | ✅ | | ✅ | ✅ | ✅ | ✅ |
| gemini-1.0-pro | ✅ | | | | ✅ | ✅ |

14 changes: 10 additions & 4 deletions docs/providers/groq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,16 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
})
```

### Supported Models

<table><thead><tr><th width="192">Model</th><th>JSON Output</th><th>Tools</th><th>Image Input</th><th>Streaming</th><th>N > 1</th></tr></thead><tbody><tr><td>llama3-8b-8192</td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>llama3-70b-8192</td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>mixtral-8x7b-32768</td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>gemma-7b-it</td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>gemma2-9b-it</td><td></td><td></td><td></td><td></td><td></td></tr></tbody></table>
### [Groq Documentation](https://console.groq.com/docs/quickstart)

<!-- compatibility -->
### Supported Models

| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
| ------------------ | ---------- | --------- | ----------- | ----------- | ----- | ----- |
| llama3-8b-8192 | ✅ | | | | | |
| llama3-70b-8192 | ✅ | | ✅ | | | |
| mixtral-8x7b-32768 | ✅ | | | | | |
| gemma-7b-it | ✅ | | ✅ | | | |
| gemma2-9b-it | ✅ | | ✅ | | | |

### [Groq Documentation](https://console.groq.com/docs/quickstart)
38 changes: 19 additions & 19 deletions docs/providers/mistral.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,25 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
})
```

### Supported Models

| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
| ----------------------- | ----------- | ----- | ----------- | --------- | ----- |
| open-mistral-7b | | | | | |
| mistral-tiny-2312 | | | | | |
| open-mixtral-8x7b | | | | | |
| mistral-small-2312 | | | | | |
| open-mixtral-8x22b | | | | | |
| open-mixtral-8x22b-2404 | | | | | |
| mistral-small-latest | | | | | |
| mistral-small-2402 | | | | | |
| mistral-medium-latest | | | | | |
| mistral-medium-2312 | | | | | |
| mistral-large-latest | | | | | |
| mistral-large-2402 | | | | | |
| codestral-latest | | | | | |
| codestral-2405 | | | | | |
### [Mistral Documentation](https://docs.mistral.ai)

<!-- compatibility -->
### Supported Models

| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
| ----------------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
| open-mistral-7b | ✅ | | ✅ | | | |
| mistral-tiny-2312 | ✅ | | ✅ | | | |
| open-mixtral-8x7b | ✅ | | | | | |
| mistral-small-2312 | ✅ | | | | | |
| open-mixtral-8x22b | ✅ | | ✅ | | ✅ | |
| open-mixtral-8x22b-2404 | ✅ | | ✅ | | ✅ | |
| mistral-small-latest | ✅ | | | | ✅ | |
| mistral-small-2402 | ✅ | | | | ✅ | |
| mistral-medium-latest | ✅ | | | | | |
| mistral-medium-2312 | ✅ | | | | | |
| mistral-large-latest | ✅ | | ✅ | | ✅ | |
| mistral-large-2402 | ✅ | | ✅ | | ✅ | |
| codestral-latest | ✅ | | ✅ | | | |
| codestral-2405 | ✅ | | ✅ | | | |

### [Mistral Documentation](https://docs.mistral.ai)
Loading