@mistralai/mistralai 0.0.5 → 0.0.6

package/README.md

@@ -1,43 +1,24 @@
 # 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`
+`npm install @mistralai/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:
+## Run examples
 
-```javascript
-const client = require('mistralai');
+You can run the examples in the examples directory by installing them locally:
 
-const response = client.embed('le-embed', 'My favourite place to eat mayonnaise is embed');
+```bash
+cd examples
+npm install .
 ```
 
-## Run examples
-
-Examples can be found in the `examples/` directory you can run them using:
+You can then run the examples using node:
 
 ```bash
-node [example.js]
-
+MISTARL_API_KEY=XXXX node chat_with_streaming.js
 ```

package/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({
+  model: 'mistral-tiny',
+  messages: [{role: 'user', content: 'What is the best French cheese?'}],
+});
+
+console.log('Chat:', chatResponse.choices[0].message.content);

package/examples/chat_with_streaming.js

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

package/examples/embeddings.js

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

package/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);
+});

package/examples/package-lock.json

@@ -0,0 +1,33 @@
+{
+    "name": "mistralai client examples",
+    "version": "1.0.0",
+    "lockfileVersion": 3,
+    "requires": true,
+    "packages": {
+        "": {
+            "name": "mistralai client examples",
+            "version": "1.0.0",
+            "dependencies": {
+                "@mistralai/mistralai": "file:../"
+            }
+        },
+        "..": {
+            "name": "@mistralai/mistralai",
+            "version": "0.0.1",
+            "license": "ISC",
+            "dependencies": {
+                "axios": "^1.6.2",
+                "axios-retry": "^4.0.0"
+            },
+            "devDependencies": {
+                "eslint": "^8.55.0",
+                "eslint-config-google": "^0.14.0",
+                "prettier": "2.8.8"
+            }
+        },
+        "node_modules/@mistralai/mistralai": {
+            "resolved": "..",
+            "link": true
+        }
+    }
+}

package/examples/package.json

@@ -0,0 +1,10 @@
+{
+    "name": "mistralai client examples",
+    "version": "1.0.0",
+    "description": "",
+    "type": "module",
+    "dependencies": {
+      "@mistralai/mistralai": "file:../"
+    },
+    "keywords": []
+  }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mistralai/mistralai",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "",
   "author": "bam4d@mistral.ai",
   "license": "ISC",

package/src/client.js

@@ -2,7 +2,7 @@ import axios from 'axios';
 import axiosRetry from 'axios-retry';
 
 const RETRY_STATUS_CODES = [429, 500, 502, 503, 504];
-const ENDPOINT = 'http://api.mistral.ai';
+const ENDPOINT = 'https://api.mistral.ai';
 
 /**
  * MistralClient
@@ -10,11 +10,12 @@ const ENDPOINT = 'http://api.mistral.ai';
  */
 class MistralClient {
   /**
-   *
-   * @param {*} apiKey
-   * @param {*} endpoint
+   * A simple and lightweight client for the Mistral API
+   * @param {*} apiKey can be set as an environment variable MISTRAL_API_KEY,
+   * or provided in this parameter
+   * @param {*} endpoint defaults to https://api.mistral.ai
    */
-  constructor(apiKey, endpoint = ENDPOINT) {
+  constructor(apiKey=process.env.MISTRAL_API_KEY, endpoint = ENDPOINT) {
     this.endpoint = endpoint;
     this.apiKey = apiKey;
 
@@ -82,11 +83,11 @@ class MistralClient {
       model: model,
       messages: messages,
       temperature: temperature ?? undefined,
-      maxTokens: maxTokens ?? undefined,
-      topP: topP ?? undefined,
-      randomSeed: randomSeed ?? undefined,
+      max_tokens: maxTokens ?? undefined,
+      top_p: topP ?? undefined,
+      random_seed: randomSeed ?? undefined,
       stream: stream ?? undefined,
-      safeMode: safeMode ?? undefined,
+      safe_prompt: safeMode ?? undefined,
     };
   };
 
@@ -97,24 +98,25 @@ class MistralClient {
   };
 
   /**
-   * Chat
-   * @param {*} model
-   * @param {*} messages
-   * @param {*} temperature
-   * @param {*} maxTokens
-   * @param {*} topP
-   * @param {*} randomSeed
-   * @param {*} safeMode
+   * A chat endpoint without streaming
+   * @param {*} model the name of the model to chat with, e.g. mistral-tiny
+   * @param {*} messages an array of messages to chat with, e.g.
+   * [{role: 'user', content: 'What is the best French cheese?'}]
+   * @param {*} temperature the temperature to use for sampling, e.g. 0.5
+   * @param {*} maxTokens the maximum number of tokens to generate, e.g. 100
+   * @param {*} topP the cumulative probability of tokens to generate, e.g. 0.9
+   * @param {*} randomSeed the random seed to use for sampling, e.g. 42
+   * @param {*} safeMode whether to use safe mode, e.g. true
    * @return {Promise<Object>}
    */
-  chat = async function(
+  chat = async function({
     model,
     messages,
     temperature,
     maxTokens,
     topP,
     randomSeed,
-    safeMode) {
+    safeMode}) {
     const request = this._makeChatCompletionRequest(
       model,
       messages,
@@ -132,24 +134,25 @@ class MistralClient {
   };
 
   /**
-   * Chat with streaming
-   * @param {*} model
-   * @param {*} messages
-   * @param {*} temperature
-   * @param {*} maxTokens
-   * @param {*} topP
-   * @param {*} randomSeed
-   * @param {*} safeMode
+   * A chat endpoint that streams responses.
+   * @param {*} model the name of the model to chat with, e.g. mistral-tiny
+   * @param {*} messages an array of messages to chat with, e.g.
+   * [{role: 'user', content: 'What is the best French cheese?'}]
+   * @param {*} temperature the temperature to use for sampling, e.g. 0.5
+   * @param {*} maxTokens the maximum number of tokens to generate, e.g. 100
+   * @param {*} topP the cumulative probability of tokens to generate, e.g. 0.9
+   * @param {*} randomSeed the random seed to use for sampling, e.g. 42
+   * @param {*} safeMode whether to use safe mode, e.g. true
    * @return {Promise<Object>}
    */
-  chatStream = async function* (
+  chatStream = async function* ({
     model,
     messages,
     temperature,
     maxTokens,
     topP,
     randomSeed,
-    safeMode) {
+    safeMode}) {
     const request = this._makeChatCompletionRequest(
       model,
       messages,
@@ -166,22 +169,30 @@ class MistralClient {
 
     for await (const chunk of response) {
       const chunkString = this.textDecoder.decode(chunk);
-      if (chunkString.startsWith('data:')) {
-        const chunkData = chunkString.substring(6).trim();
-        if (chunkData !== '[DONE]') {
-          yield JSON.parse(chunkData);
+      // split the chunks by new line
+      const chunkLines = chunkString.split('\n');
+      // Iterate through the lines
+      for (const chunkLine of chunkLines) {
+        // If the line starts with data: then it is a chunk
+        if (chunkLine.startsWith('data:')) {
+          const chunkData = chunkLine.substring(6).trim();
+          if (chunkData !== '[DONE]') {
+            yield JSON.parse(chunkData);
+          }
         }
       }
     }
   };
 
   /**
-   * Embeddings
-   * @param {*} model
-   * @param {*} input
+   * An embedddings endpoint that returns embeddings for a single,
+   * or batch of inputs
+   * @param {*} model The embedding model to use, e.g. mistral-embed
+   * @param {*} input The input to embed,
+   * e.g. ['What is the best French cheese?']
    * @return {Promise<Object>}
    */
-  embeddings = async function(model, input) {
+  embeddings = async function({model, input}) {
     const request = {
       model: model,
       input: input,

package/examples/examples.js

@@ -1,51 +0,0 @@
-import MistralClient from '../client.js';
-
-const apiKey = process.env.MISTRAL_API_KEY;
-
-const client = new MistralClient(apiKey);
-
-// LIST MODELS
-const listModelsResponse = await client.listModels();
-
-listModelsResponse.data.forEach((model) => {
-  console.log('Model:', model);
-});
-
-// CHAT
-const chatResponse = await client.chat(
-  'le-tiny-v2312',
-  [{role: 'user', content: 'hello world'}],
-);
-
-console.log('Chat:', chatResponse);
-
-// CHAT STREAM
-const chatStreamResponse = await client.chatStream(
-  'le-tiny-v2312', [{role: 'user', content: 'hello world'}],
-);
-
-for await (const chunk of chatStreamResponse) {
-  console.log('Chat Stream:', '' + chunk);
-}
-
-// chatStreamResponse.data.on('data', (data) => {
-//   console.log('Chat Stream:', '' + data);
-// });
-
-// EMBEDDINGS
-const embeddingsResponse = await client.embeddings('le-embed', 'hello world');
-
-console.log('Embeddings:', embeddingsResponse.data);
-
-
-// EMBEDDINGS BATCH
-
-// Create 100 strings to embed
-const input = [];
-for (let i = 0; i < 10; i++) {
-  input.push('hello world');
-}
-
-const embeddingsBatchResponse = await client.embeddings('le-embed', input);
-
-console.log('Embeddings Batch:', embeddingsBatchResponse.data);