Skip to content

Commit

Permalink
a
Browse files Browse the repository at this point in the history
  • Loading branch information
sam-goldman committed Jul 13, 2024
1 parent ad900c7 commit 42807b7
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ main()

## Feature Compatibility

This table provides an overview of the features that Token.js supports from each LLM provider. If an LLM provider does not support a certain feature, it is marked with a dash (:heavy_minus_sign:) in the table.
This table provides an overview of the features that Token.js supports from each LLM provider.

| Provider | Chat Completion | Streaming | Tools | JSON Output | Image Input |
| ---------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
Expand All @@ -382,7 +382,11 @@ 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: |

Certain LLMs, particularly older or weaker models, do not support some features in this table. For details about these restrictions, see our [LLM provider documentation](providers/README.md).
#### Key
:white\_check\_mark: Supported by Token.js
:heavy_minus_sign: Not supported by the LLM provider

**Note**: Certain LLMs, particularly older or weaker models, do not support some features in this table. For details about these restrictions, see our [LLM provider documentation](providers/README.md).

## License

Expand All @@ -391,4 +395,7 @@ Token.js is free and open source software licensed under [GPLv3](https://github.

TODO(later): actually run the example code to make sure you get a valid response for each provider. (finished readme)
TODO(later): be consistent with casing for token.js. (finished readme)
TODO(later): grammarly (finished readme)
TODO(later): grammarly (finished readme)
TODO: I think users may find it confusing that we link to the provider's documentation in its current form, particularly because we don't supply our own docs. I'm concerned users will think that they should go to the provider's page to learn about their fields. Is there a reason for us to link to their docs at all? Perhaps to get an API key.
TODO(later): update repo readme.
TODO: make an API reference page.

0 comments on commit 42807b7

Please sign in to comment.