Cohere SDK Cloud Platform Compatibility

To maximize convenience in building on and switching between Cohere-supported environments, we have developed SDKs that seamlessly support whichever backend you choose. This allows you to start developing your project with one backend while maintaining the flexibility to switch, should the need arise.

Note that the code snippets presented in this document should be more than enough to get you started, but if you end up switching from one environment to another there will be some small changes you need to make to how you import and initialize the SDK.

Supported environments

The table below summarizes the environments in which Cohere models can be deployed. You’ll notice it contains many links; the links in the “sdk” column take you to Github pages with more information on Cohere’s language-specific SDKs, while all the others take you to relevant sections in this document.

Note

The Cohere v2 API is not yet supported for cloud deployments (Bedrock, SageMaker, Azure, and OCI) and will be coming soon. The code examples shown for these cloud deployments use the v1 API.

sdk	Cohere platform	Bedrock	Sagemaker	Azure	OCI	Private Deployment
Typescript	✅ docs	✅ docs	✅ docs	✅ docs	🟠 soon	✅ docs
Python	✅ docs	✅ docs	✅ docs	✅ docs	🟠 soon	✅ docs
Go	✅ docs	🟠 soon	🟠 soon	✅ docs	🟠 soon	✅ docs
Java	✅ docs	🟠 soon	🟠 soon	✅ docs	🟠 soon	✅ docs

Feature support

The most complete set of features is found on the cohere platform, while each of the cloud platforms support subsets of these features. Please consult the platform-specific documentation for more information about the parameters that they support.

Feature	Cohere Platform	Bedrock	Sagemaker	Azure	OCI	Private Deployment
chat_stream	✅	✅	✅	✅	✅	✅
chat	✅	✅	✅	✅	✅	✅
generate_stream	✅	✅	✅	✅	✅	✅
generate	✅	✅	✅	✅	✅	✅
embed	✅	✅	✅	✅	✅	✅
rerank	✅	✅	✅	✅	⬜️	✅
classify	✅	⬜️	⬜️	⬜️	⬜️	✅
summarize	✅	⬜️	⬜️	⬜️	⬜️	✅
tokenize	✅	✅ (offline)	✅ (offline)	✅ (offline)	✅ (offline)	✅ (offline)
detokenize	✅	✅ (offline)	✅ (offline)	✅ (offline)	✅ (offline)	✅ (offline)
check_api_key	✅	✅	✅	✅	✅	✅

Snippets

Cohere Platform

1 const { CohereClient } = require('cohere-ai');
2 
3 const cohere = new CohereClient({
4   token: 'Your API key',
5 });
6 
7 (async () => {
8   const response = await cohere.chat({
9     chatHistory: [
10       { role: 'USER', message: 'Who discovered gravity?' },
11       {
12         role: 'CHATBOT',
13         message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
14       },
15     ],
16     message: 'What year was he born?',
17     // perform web search before answering the question. You can also use your own custom connector.
18     connectors: [{ id: 'web-search' }],
19   });
20 
21   console.log(response);
22 })();

Private Deployment

1 const { CohereClient } = require('cohere-ai');
2 
3 const cohere = new CohereClientV2({
4   token: '',
5   base_url='<YOUR_DEPLOYMENT_URL>'
6 });
7 
8 (async () => {
9   const response = await cohere.chat({
10     chatHistory: [
11       { role: 'USER', message: 'Who discovered gravity?' },
12       {
13         role: 'CHATBOT',
14         message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
15       },
16     ],
17     message: 'What year was he born?',
18     // perform web search before answering the question. You can also use your own custom connector.
19     connectors: [{ id: 'web-search' }],
20   });
21 
22   console.log(response);
23 })();

Bedrock

Rerank API Compatibility

Rerank v3.5 on Bedrock is only supported with Rerank API v2, via BedrockClientV2()

1 const { BedrockClient } = require('cohere-ai');
2 
3 const cohere = new BedrockClient({
4   awsRegion: "us-east-1",
5   awsAccessKey: "...",
6   awsSecretKey: "...",
7   awsSessionToken: "...",
8 });
9 
10 (async () => {
11   const response = await cohere.chat({
12     model: "cohere.command-r-plus-v1:0",
13     chatHistory: [
14       { role: 'USER', message: 'Who discovered gravity?' },
15       {
16         role: 'CHATBOT',
17         message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
18       },
19     ],
20     message: 'What year was he born?',
21   });
22 
23   console.log(response);
24 })();

Sagemaker

1 const { SagemakerClient } = require('cohere-ai');
2 
3 const cohere = new SagemakerClient({
4   awsRegion: "us-east-1",
5   awsAccessKey: "...",
6   awsSecretKey: "...",
7   awsSessionToken: "...",
8 });
9 
10 (async () => {
11   const response = await cohere.chat({
12     model: "my-endpoint-name",
13     chatHistory: [
14       { role: 'USER', message: 'Who discovered gravity?' },
15       {
16         role: 'CHATBOT',
17         message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
18       },
19     ],
20     message: 'What year was he born?',
21   });
22 
23   console.log(response);
24 })();

Azure

1 const { CohereClient } = require('cohere-ai');
2 
3 const cohere = new CohereClient({
4   token: "<azure token>",
5   environment: "https://Cohere-command-r-plus-phulf-serverless.eastus2.inference.ai.azure.com/v1",
6 });
7 
8 (async () => {
9   const response = await cohere.chat({
10     chatHistory: [
11       { role: 'USER', message: 'Who discovered gravity?' },
12       {
13         role: 'CHATBOT',
14         message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
15       },
16     ],
17     message: 'What year was he born?',
18   });
19 
20   console.log(response);
21 })();

1	const { CohereClient } = require('cohere-ai');
2
3	const cohere = new CohereClient({
4	token: 'Your API key',
5	});
6
7	(async () => {
8	const response = await cohere.chat({
9	chatHistory: [
10	{ role: 'USER', message: 'Who discovered gravity?' },
11	{
12	role: 'CHATBOT',
13	message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
14	},
15	],
16	message: 'What year was he born?',
17	// perform web search before answering the question. You can also use your own custom connector.
18	connectors: [{ id: 'web-search' }],
19	});
20
21	console.log(response);
22	})();

1	const { CohereClient } = require('cohere-ai');
2
3	const cohere = new CohereClientV2({
4	token: '',
5	base_url='<YOUR_DEPLOYMENT_URL>'
6	});
7
8	(async () => {
9	const response = await cohere.chat({
10	chatHistory: [
11	{ role: 'USER', message: 'Who discovered gravity?' },
12	{
13	role: 'CHATBOT',
14	message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
15	},
16	],
17	message: 'What year was he born?',
18	// perform web search before answering the question. You can also use your own custom connector.
19	connectors: [{ id: 'web-search' }],
20	});
21
22	console.log(response);
23	})();

1	const { BedrockClient } = require('cohere-ai');
2
3	const cohere = new BedrockClient({
4	awsRegion: "us-east-1",
5	awsAccessKey: "...",
6	awsSecretKey: "...",
7	awsSessionToken: "...",
8	});
9
10	(async () => {
11	const response = await cohere.chat({
12	model: "cohere.command-r-plus-v1:0",
13	chatHistory: [
14	{ role: 'USER', message: 'Who discovered gravity?' },
15	{
16	role: 'CHATBOT',
17	message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
18	},
19	],
20	message: 'What year was he born?',
21	});
22
23	console.log(response);
24	})();

1	const { SagemakerClient } = require('cohere-ai');
2
3	const cohere = new SagemakerClient({
4	awsRegion: "us-east-1",
5	awsAccessKey: "...",
6	awsSecretKey: "...",
7	awsSessionToken: "...",
8	});
9
10	(async () => {
11	const response = await cohere.chat({
12	model: "my-endpoint-name",
13	chatHistory: [
14	{ role: 'USER', message: 'Who discovered gravity?' },
15	{
16	role: 'CHATBOT',
17	message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
18	},
19	],
20	message: 'What year was he born?',
21	});
22
23	console.log(response);
24	})();

1	const { CohereClient } = require('cohere-ai');
2
3	const cohere = new CohereClient({
4	token: "<azure token>",
5	environment: "https://Cohere-command-r-plus-phulf-serverless.eastus2.inference.ai.azure.com/v1",
6	});
7
8	(async () => {
9	const response = await cohere.chat({
10	chatHistory: [
11	{ role: 'USER', message: 'Who discovered gravity?' },
12	{
13	role: 'CHATBOT',
14	message: 'The man who is widely credited with discovering gravity is Sir Isaac Newton',
15	},
16	],
17	message: 'What year was he born?',
18	});
19
20	console.log(response);
21	})();