Skip to content

maint: fix docs #123

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.

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

Merged
merged 1 commit into from
Dec 4, 2024
Merged
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -189,6 +189,7 @@ This table provides an overview of the features that Token.js supports from each
| Groq | :white\_check\_mark: | :white\_check\_mark: | :heavy_minus_sign: | :white\_check\_mark: | :heavy_minus_sign: |
| Perplexity | :white\_check\_mark: | :white\_check\_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: |
| OpenRouter | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
| OpenAI Compatible | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |

### Legend
| Symbol | Description |
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -25,6 +25,7 @@ description: >-
* OpenAI
* Perplexity
* OpenRouter
* Any other model provider with an OpenAI compatible API

## Setup

@@ -324,6 +325,8 @@ OPENROUTER_API_KEY=
AWS_REGION_NAME=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
# OpenAI Compatible
OPENAI_COMPATIBLE_API_KEY=
```

### Streaming
@@ -418,6 +421,8 @@ This table provides an overview of the features that Token.js supports from each
| Gemini | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
| Groq | :white\_check\_mark: | :white\_check\_mark: | :heavy\_minus\_sign: | :white\_check\_mark: | :heavy\_minus\_sign: |
| Perplexity | :white\_check\_mark: | :white\_check\_mark: | :heavy\_minus\_sign: | :heavy\_minus\_sign: | :heavy\_minus\_sign: |
| OpenRouter | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
| OpenAI Compatible | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |

### Legend

1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -12,5 +12,6 @@
* [OpenAI](providers/openai.md)
* [OpenRouter](providers/openrouter.md)
* [Perplexity](providers/perplexity.md)
* [OpenAI Compatible](providers/openai-compatible.md)
* [Contact Us](contact-us.md)
* [Contributing](https://github.com/token-js/token.js/blob/main/CONTRIBUTING.md)
2 changes: 1 addition & 1 deletion docs/providers/README.md
Original file line number Diff line number Diff line change
@@ -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><tr><td>OpenRouter</td><td></td><td></td><td><a href="openrouter.md">openrouter.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><tr><td>OpenAI Compatible</td><td></td><td></td><td><a href="openai-compatible.md">openai-compatible.md</a></td></tr></tbody></table>