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

Compatibility api clarification #431

Merged
merged 1 commit into from
Mar 1, 2025
Merged

Compatibility api clarification #431

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
26 changes: 25 additions & 1 deletion fern/pages/v2/text-generation/compatibility-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ The Compatibility API allows developers to use Cohere’s models through OpenAI

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.

The supported libraries are:
- TypeScript / JavaScript
- Python
- .NET
- Java (beta)
- Go (beta)

This is a quickstart guide to help you get started with the Compatibility API.

## Installation
Expand Down Expand Up @@ -835,4 +842,21 @@ The following parameters are not supported in the Compatibility API:
### Embeddings

- `dimensions`
- `user`
- `user`

### Cohere-specific parameters

Parameters that are uniquely available on the Cohere API but not on the OpenAI SDK are not supported.

Chat endpoint:

- `connectors`
- `documents`
- `citation_options`
- ...[more here](https://docs.cohere.com/reference/chat)

Embed endpoint:
- `input_type`
- `images`
- `truncate`
- ...[more here](https://docs.cohere.com/reference/embed)