Skip to content

Commit 02677b8

Browse files
RPate97RPate97
authored
Merge pull request #57 from token-js/pate/generate-compatibility-chart
docs: Generate model compatibility charts automatically
2 parents 1e80b4b + 0d66151 commit 02677b8

File tree

24 files changed

+352
-193
lines changed

24 files changed

+352
-193
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
docs:
8+
runs-on: ubuntu-22.04
9+
steps:
10+
- uses: actions/checkout@v4
11+
- name: Install pnpm
12+
uses: pnpm/action-setup@v4
13+
with:
14+
version: 9
15+
- name: Use Node.js 20
16+
uses: actions/setup-node@v4
17+
with:
18+
node-version: 20
19+
cache: 'pnpm'
20+
- name: Install dependencies
21+
run: pnpm install
22+
- name: Check Docs
23+
run: pnpm docs:check

‎docs/providers/ai21.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
2929
})
3030
```
3131

32-
### Supported Models
33-
34-
| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
35-
| -------------- | ----------- | ----- | ----------- | --------- | ----- |
36-
| jamba-instruct | | | | | |
32+
### [AI21 Documentation](https://docs.ai21.com/reference/jamba-instruct-api)
3733

34+
<!-- compatibility -->
35+
### Supported Models
3836

37+
| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
38+
| -------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
39+
| jamba-instruct | ✅ | | | | | ✅ |
3940

40-
### [AI21 Documentation](https://docs.ai21.com/reference/jamba-instruct-api)

‎docs/providers/anthropic.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,18 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
2929
})
3030
```
3131

32-
### Supported Models
33-
34-
| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
35-
| -------------------------- | ----------- | ----- | ----------- | --------- | ----- |
36-
| claude-3-5-sonnet-20240620 | | | | | |
37-
| claude-3-opus-20240229 | | | | | |
38-
| claude-3-sonnet-20240229 | | | | | |
39-
| claude-3-haiku-20240307 | | | | | |
40-
| claude-2.1 | | | | | |
41-
| claude-2.0 | | | | | |
42-
| claude-instant-1.2 | | | | | |
32+
### [Anthropic Documentation](https://docs.anthropic.com/en/docs/welcome)
4333

34+
<!-- compatibility -->
35+
### Supported Models
4436

37+
| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
38+
| -------------------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
39+
| claude-3-5-sonnet-20240620 | ✅ | | | ✅ | ✅ | |
40+
| claude-3-opus-20240229 | ✅ | | | ✅ | ✅ | |
41+
| claude-3-sonnet-20240229 | ✅ | | | ✅ | ✅ | |
42+
| claude-3-haiku-20240307 | ✅ | | | ✅ | ✅ | |
43+
| claude-2.1 | ✅ | | | | | |
44+
| claude-2.0 | ✅ | | | | | |
45+
| claude-instant-1.2 | ✅ | | | | | |
4546

46-
### [Anthropic Documentation](https://docs.anthropic.com/en/docs/welcome)

‎docs/providers/bedrock.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -31,30 +31,30 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
3131
})
3232
```
3333

34+
### [Bedrock Documentation](https://docs.aws.amazon.com/bedrock/latest/APIReference/welcome.html)
35+
36+
<!-- compatibility -->
3437
### Supported Models
3538

36-
| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
37-
| --------------------------------------- | ----------- | ----- | ----------- | --------- | ----- |
38-
| amazon.titan-text-lite-v1 | | | | | |
39-
| amazon.titan-text-express-v1 | | | | | |
40-
| anthropic.claude-3-opus-20240229-v1:0 | | | | | |
41-
| anthropic.claude-3-sonnet-20240229-v1:0 | | | | | |
42-
| anthropic.claude-3-haiku-20240307-v1:0 | | | | | |
43-
| anthropic.claude-v2:1 | | | | | |
44-
| anthropic.claude-v2 | | | | | |
45-
| anthropic.claude-instant-v1 | | | | | |
46-
| cohere.command-r-plus-v1:0 | | | | | |
47-
| cohere.command-r-v1:0 | | | | | |
48-
| cohere.command-text-v14 | | | | | |
49-
| cohere.command-light-text-v14 | | | | | |
50-
| meta.llama3-8b-instruct-v1:0 | | | | | |
51-
| meta.llama3-70b-instruct-v1:0 | | | | | |
52-
| meta.llama2-13b-chat-v1 | | | | | |
53-
| meta.llama2-70b-chat-v1 | | | | | |
54-
| mistral.mistral-7b-instruct-v0:2 | | | | | |
55-
| mistral.mixtral-8x7b-instruct-v0:1 | | | | | |
56-
| mistral.mistral-large-2402-v1:0 | | | | | |
57-
58-
59-
60-
### [Bedrock Documentation](https://docs.aws.amazon.com/bedrock/latest/APIReference/welcome.html)
39+
| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
40+
| --------------------------------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
41+
| amazon.titan-text-lite-v1 | ✅ | | | | | |
42+
| amazon.titan-text-express-v1 | ✅ | | | | | |
43+
| anthropic.claude-3-opus-20240229-v1:0 | ✅ | | | ✅ | ✅ | |
44+
| anthropic.claude-3-sonnet-20240229-v1:0 | ✅ | | | ✅ | ✅ | |
45+
| anthropic.claude-3-haiku-20240307-v1:0 | ✅ | | | ✅ | ✅ | |
46+
| anthropic.claude-v2:1 | ✅ | | | | | |
47+
| anthropic.claude-v2 | ✅ | | | | | |
48+
| anthropic.claude-instant-v1 | ✅ | | | | | |
49+
| cohere.command-r-plus-v1:0 | ✅ | | | | ✅ | |
50+
| cohere.command-r-v1:0 | ✅ | | | | ✅ | |
51+
| cohere.command-text-v14 | ✅ | | | | | |
52+
| cohere.command-light-text-v14 | ✅ | | | | | |
53+
| meta.llama3-8b-instruct-v1:0 | ✅ | | | | | |
54+
| meta.llama3-70b-instruct-v1:0 | ✅ | | | | | |
55+
| meta.llama2-13b-chat-v1 | ✅ | | | | | |
56+
| meta.llama2-70b-chat-v1 | ✅ | | | | | |
57+
| mistral.mistral-7b-instruct-v0:2 | ✅ | | | | | |
58+
| mistral.mixtral-8x7b-instruct-v0:1 | ✅ | | | | | |
59+
| mistral.mistral-large-2402-v1:0 | ✅ | | | | ✅ | |
60+

‎docs/providers/cohere.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
2929
})
3030
```
3131

32-
### Supported Models
33-
34-
| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
35-
| --------------------- | ----------- | ----- | ----------- | --------- | ----- |
36-
| command-r-plus | | | | | |
37-
| command-r | | | | | |
38-
| command | | | | | |
39-
| command-nightly | | | | | |
40-
| command-light | | | | | |
41-
| command-light-nightly | | | | | |
32+
### [Cohere Documentation](https://docs.cohere.com)
4233

34+
<!-- compatibility -->
35+
### Supported Models
4336

37+
| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
38+
| --------------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
39+
| command-r-plus | ✅ | | | | ✅ | |
40+
| command-r | ✅ | | | | ✅ | |
41+
| command | ✅ | | | | | |
42+
| command-nightly | ✅ | | | | ✅ | |
43+
| command-light | ✅ | | | | | |
44+
| command-light-nightly | ✅ | | | | | |
4445

45-
### [Cohere Documentation](https://docs.cohere.com)

‎docs/providers/gemini.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,14 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
2929
})
3030
```
3131

32-
### Supported Models
33-
34-
| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
35-
| ---------------- | ----------- | ----- | ----------- | --------- | ----- |
36-
| gemini-1.5-pro | | | | | |
37-
| gemini-1.5-flash | | | | | |
38-
| gemini-1.0-pro | | | | | |
39-
32+
### [Gemini Documentation](https://ai.google.dev/gemini-api/docs)
4033

34+
<!-- compatibility -->
35+
### Supported Models
4136

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

‎docs/providers/groq.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,16 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
2929
})
3030
```
3131

32-
### Supported Models
33-
34-
<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>
32+
### [Groq Documentation](https://console.groq.com/docs/quickstart)
3533

34+
<!-- compatibility -->
35+
### Supported Models
3636

37+
| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
38+
| ------------------ | ---------- | --------- | ----------- | ----------- | ----- | ----- |
39+
| llama3-8b-8192 | ✅ | | | | | |
40+
| llama3-70b-8192 | ✅ | | ✅ | | | |
41+
| mixtral-8x7b-32768 | ✅ | | | | | |
42+
| gemma-7b-it | ✅ | | ✅ | | | |
43+
| gemma2-9b-it | ✅ | | ✅ | | | |
3744

38-
### [Groq Documentation](https://console.groq.com/docs/quickstart)

‎docs/providers/mistral.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,25 @@ const result: ChatCompletionMessageParam[] = await tokenjs.chat.completions.crea
2929
})
3030
```
3131

32-
### Supported Models
33-
34-
| Model | JSON Output | Tools | Image Input | Streaming | N > 1 |
35-
| ----------------------- | ----------- | ----- | ----------- | --------- | ----- |
36-
| open-mistral-7b | | | | | |
37-
| mistral-tiny-2312 | | | | | |
38-
| open-mixtral-8x7b | | | | | |
39-
| mistral-small-2312 | | | | | |
40-
| open-mixtral-8x22b | | | | | |
41-
| open-mixtral-8x22b-2404 | | | | | |
42-
| mistral-small-latest | | | | | |
43-
| mistral-small-2402 | | | | | |
44-
| mistral-medium-latest | | | | | |
45-
| mistral-medium-2312 | | | | | |
46-
| mistral-large-latest | | | | | |
47-
| mistral-large-2402 | | | | | |
48-
| codestral-latest | | | | | |
49-
| codestral-2405 | | | | | |
32+
### [Mistral Documentation](https://docs.mistral.ai)
5033

34+
<!-- compatibility -->
35+
### Supported Models
5136

37+
| Model | Completion | Streaming | JSON Output | Image Input | Tools | N > 1 |
38+
| ----------------------- | ---------- | --------- | ----------- | ----------- | ----- | ----- |
39+
| open-mistral-7b | ✅ | | ✅ | | | |
40+
| mistral-tiny-2312 | ✅ | | ✅ | | | |
41+
| open-mixtral-8x7b | ✅ | | | | | |
42+
| mistral-small-2312 | ✅ | | | | | |
43+
| open-mixtral-8x22b | ✅ | | ✅ | | ✅ | |
44+
| open-mixtral-8x22b-2404 | ✅ | | ✅ | | ✅ | |
45+
| mistral-small-latest | ✅ | | | | ✅ | |
46+
| mistral-small-2402 | ✅ | | | | ✅ | |
47+
| mistral-medium-latest | ✅ | | | | | |
48+
| mistral-medium-2312 | ✅ | | | | | |
49+
| mistral-large-latest | ✅ | | ✅ | | ✅ | |
50+
| mistral-large-2402 | ✅ | | ✅ | | ✅ | |
51+
| codestral-latest | ✅ | | ✅ | | | |
52+
| codestral-2405 | ✅ | | ✅ | | | |
5253

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

0 commit comments

Comments
 (0)