From e38effb6935f274195989bdd436321efd9b9ee33 Mon Sep 17 00:00:00 2001 From: mrmer1 Date: Sat, 1 Mar 2025 00:18:59 +0800 Subject: [PATCH] compatibility api clarification --- .../v2/text-generation/compatibility-api.mdx | 26 ++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/fern/pages/v2/text-generation/compatibility-api.mdx b/fern/pages/v2/text-generation/compatibility-api.mdx index fe044b03c..77aa83de5 100644 --- a/fern/pages/v2/text-generation/compatibility-api.mdx +++ b/fern/pages/v2/text-generation/compatibility-api.mdx @@ -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 @@ -835,4 +842,21 @@ The following parameters are not supported in the Compatibility API: ### Embeddings - `dimensions` -- `user` \ No newline at end of file +- `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)