Skip to content

Commit 3777b51

Browse files
authored
compatibility api clarification (#431)
1 parent 73ced57 commit 3777b51

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

fern/pages/v2/text-generation/compatibility-api.mdx

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ The Compatibility API allows developers to use Cohere’s models through OpenAI
1414

1515
It makes it easy to switch existing OpenAI-based applications to use Cohere’s models while still maintaining the use of OpenAI SDK — no big refactors needed.
1616

17+
The supported libraries are:
18+
- TypeScript / JavaScript
19+
- Python
20+
- .NET
21+
- Java (beta)
22+
- Go (beta)
23+
1724
This is a quickstart guide to help you get started with the Compatibility API.
1825

1926
## Installation
@@ -835,4 +842,21 @@ The following parameters are not supported in the Compatibility API:
835842
### Embeddings
836843

837844
- `dimensions`
838-
- `user`
845+
- `user`
846+
847+
### Cohere-specific parameters
848+
849+
Parameters that are uniquely available on the Cohere API but not on the OpenAI SDK are not supported.
850+
851+
Chat endpoint:
852+
853+
- `connectors`
854+
- `documents`
855+
- `citation_options`
856+
- ...[more here](https://docs.cohere.com/reference/chat)
857+
858+
Embed endpoint:
859+
- `input_type`
860+
- `images`
861+
- `truncate`
862+
- ...[more here](https://docs.cohere.com/reference/embed)

0 commit comments

Comments
 (0)