Merge branch 'main' of github.com:mistralai/client-js

README.md

@@ -1,43 +1,16 @@
 # Mistral Javascript Client
 
-You can use the Mistral Javascript client to interact with the Mistral AI API
+You can use the Mistral Javascript client to interact with the Mistral AI API.
 
 ## Installing
 
 You can install the library in your project using:
 
 `npm install mistralai`
 
-## Usage
-
-### Chat
-
-The simplest use case is to chat with Mistral AI models:
-
-```javascript
-const client = require("mistralai");
-
-const response = client.chat('le-tiny', [{role: 'user', content: 'What is your favourite French food, and why is it mayonnaise?'}])
-
-```
-
-You can also use `client.chatStream` for streaming results.
-
-### Embeddings
-
-To use our embedding API you can use the following code:
-
-```javascript
-const client = require('mistralai');
-
-const response = client.embed('le-embed', 'My favourite place to eat mayonnaise is embed');
-```
-
 ## Run examples
 
-Examples can be found in the `examples/` directory you can run them using:
-
+You can run the examples in the `examples/` directory using
 ```bash
-node [example.js]
-
+node examples/chat_no_streaming.js
 ```

examples/chat_no_streaming.js

@@ -0,0 +1,12 @@
+import MistralClient from '@mistralai/mistralai';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+
+const client = new MistralClient(apiKey);
+
+const chatResponse = await client.chat(
+    'mistral-tiny',
+    [{role: 'user', content: 'What is the best French cheese?'}],
+);
+
+console.log('Chat:', chatResponse);

examples/chat_with_streaming.js

@@ -0,0 +1,14 @@
+import MistralClient from '@mistralai/mistralai';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+
+const client = new MistralClient(apiKey);
+
+const chatStreamResponse = await client.chatStream(
+    'mistral-tiny',
+    [{role: 'user', content: 'What is the best French cheese?'}],
+);
+
+for await (const chunk of chatStreamResponse) {
+    console.log('Chat Stream:', '' + chunk);
+}

examples/embeddings.js

@@ -0,0 +1,14 @@
+import MistralClient from '@mistralai/mistralai';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+
+const client = new MistralClient(apiKey);
+
+const input = [];
+for (let i = 0; i < 10; i++) {
+    input.push('What is the best French cheese?');
+}
+
+const embeddingsBatchResponse = await client.embeddings('mistral-embed', input);
+
+console.log('Embeddings Batch:', embeddingsBatchResponse.data);

examples/list_models.js

@@ -0,0 +1,11 @@
+import MistralClient from '@mistralai/mistralai';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+
+const client = new MistralClient(apiKey);
+
+const listModelsResponse = await client.listModels();
+
+listModelsResponse.data.forEach((model) => {
+    console.log('Model:', model);
+});