@mistralai/mistralai 0.0.10 → 0.2.0

package/.eslintrc.yml

@@ -4,6 +4,7 @@ env:
 extends: google
 ignorePatterns:
   - examples/chat-react/
+  - src/client.d.ts
 parserOptions:
   ecmaVersion: latest
   sourceType: module

package/.github/workflows/build_publish.yaml

@@ -3,7 +3,7 @@ name: Build and Publish
 on:
   push:
     branches: ["main"]
-    
+
     # We only deploy on tags and main branch
     tags:
       # Only run on tags that match the following regex
@@ -14,13 +14,12 @@ on:
   pull_request:
 
 jobs:
-  
   lint_and_test:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [18, 20]
+        node-version: [18, 20, 22]
 
     steps:
       # Checkout the repository
@@ -48,6 +47,13 @@ jobs:
         run: |
           npm run test
 
+        # Build TypeScript Examples
+      - name: Build typescript examples
+        run: |
+          cd examples/typescript
+          npm install
+          npx tsc --build --verbose tsconfig.json
+
   publish:
     needs: lint_and_test
     runs-on: ubuntu-latest
@@ -68,8 +74,4 @@ jobs:
       - name: Publish
         run: |
           echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >> .npmrc
-          npm version ${{ github.ref_name }}
-          sed -i 's/VERSION = '\''0.0.1'\''/VERSION = '\''${{ github.ref_name }}'\''/g' src/client.js
-          npm publish 
-
-      
+          npm publish

package/README.md

@@ -1,8 +1,8 @@
-This javascript client is inspired from [cohere-typescript](https://github.com/cohere-ai/cohere-typescript)
+This JavaScript client is inspired from [cohere-typescript](https://github.com/cohere-ai/cohere-typescript)
 
-# Mistral Javascript Client
+# 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
 
@@ -12,6 +12,8 @@ You can install the library in your project using:
 
 ## Usage
 
+You can watch a free course on using the Mistral JavaScript client [here.](https://scrimba.com/links/mistral)
+
 ### Set up
 
 ```typescript

package/examples/chat_with_streaming.js

@@ -4,7 +4,7 @@ const apiKey = process.env.MISTRAL_API_KEY;
 
 const client = new MistralClient(apiKey);
 
-const chatStreamResponse = await client.chatStream({
+const chatStreamResponse = client.chatStream({
   model: 'mistral-tiny',
   messages: [{role: 'user', content: 'What is the best French cheese?'}],
 });

package/examples/function_calling.js

@@ -0,0 +1,122 @@
+import MistralClient from '@mistralai/mistralai';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+
+// Assuming we have the following data
+const data = {
+  transactionId: ['T1001', 'T1002', 'T1003', 'T1004', 'T1005'],
+  customerId: ['C001', 'C002', 'C003', 'C002', 'C001'],
+  paymentAmount: [125.50, 89.99, 120.00, 54.30, 210.20],
+  paymentDate: [
+    '2021-10-05', '2021-10-06', '2021-10-07', '2021-10-05', '2021-10-08',
+  ],
+  paymentStatus: ['Paid', 'Unpaid', 'Paid', 'Paid', 'Pending'],
+};
+
+/**
+ * This function retrieves the payment status of a transaction id.
+ * @param {object} data - The data object.
+ * @param {string} transactionId - The transaction id.
+ * @return {string} - The payment status.
+ */
+function retrievePaymentStatus({data, transactionId}) {
+  const transactionIndex = data.transactionId.indexOf(transactionId);
+  if (transactionIndex != -1) {
+    return JSON.stringify({status: data.payment_status[transactionIndex]});
+  } else {
+    return JSON.stringify({status: 'error - transaction id not found.'});
+  }
+}
+
+/**
+ * This function retrieves the payment date of a transaction id.
+ * @param {object} data - The data object.
+ * @param {string} transactionId - The transaction id.
+ * @return {string} - The payment date.
+ *
+ */
+function retrievePaymentDate({data, transactionId}) {
+  const transactionIndex = data.transactionId.indexOf(transactionId);
+  if (transactionIndex != -1) {
+    return JSON.stringify({status: data.payment_date[transactionIndex]});
+  } else {
+    return JSON.stringify({status: 'error - transaction id not found.'});
+  }
+}
+
+const namesToFunctions = {
+  retrievePaymentStatus: (transactionId) =>
+    retrievePaymentStatus({data, ...transactionId}),
+  retrievePaymentDate: (transactionId) =>
+    retrievePaymentDate({data, ...transactionId}),
+};
+
+const tools = [
+  {
+    type: 'function',
+    function: {
+      name: 'retrievePaymentStatus',
+      description: 'Get payment status of a transaction id',
+      parameters: {
+        type: 'object',
+        required: ['transactionId'],
+        properties: {transactionId:
+          {type: 'string', description: 'The transaction id.'},
+        },
+      },
+    },
+  },
+  {
+    type: 'function',
+    function: {
+      name: 'retrievePaymentDate',
+      description: 'Get payment date of a transaction id',
+      parameters: {
+        type: 'object',
+        required: ['transactionId'],
+        properties: {transactionId:
+          {type: 'string', description: 'The transaction id.'},
+        },
+      },
+    },
+  },
+];
+
+
+const model = 'mistral-large';
+
+const client = new MistralClient(apiKey, 'https://api-2.aurocloud.net');
+
+const messages = [
+  {role: 'user', content: 'What\'s the status of my transaction?'},
+];
+
+let response = await client.chat({
+  model: model, messages: messages, tools: tools,
+});
+
+
+console.log(response.choices[0].message.content);
+
+messages.push(
+  {role: 'assistant', content: response.choices[0].message.content},
+);
+messages.push({role: 'user', content: 'My transaction ID is T1001.'});
+
+response = await client.chat({model: model, messages: messages, tools: tools});
+
+const toolCall = response.choices[0].message.toolCalls[0];
+const functionName = toolCall.function.name;
+const functionParams = JSON.parse(toolCall.function.arguments);
+
+console.log(`calling functionName: ${functionName}`);
+console.log(`functionParams: ${toolCall.function.arguments}`);
+
+const functionResult = namesToFunctions[functionName](functionParams);
+
+messages.push(response.choices[0].message);
+messages.push({role: 'tool', name: functionName, content: functionResult});
+
+response = await client.chat({model: model, messages: messages, tools: tools});
+
+console.log(response.choices[0].message.content);

package/examples/json_format.js

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

package/examples/typescript/chat_with_streaming.ts

@@ -0,0 +1,24 @@
+import MistralClient from '@mistralai/mistralai';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+
+const client = new MistralClient(apiKey);
+
+const responseInterface = '{"best": string, "reasoning": string}';
+const chatStreamResponse = client.chatStream({
+  model: 'open-mistral-7b',
+  responseFormat: {type: 'json_object'},
+  messages: [{
+    role: 'user', content: `
+    What is the best French cheese?
+    Answer in ${responseInterface} format`,
+  }],
+});
+
+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);
+  }
+}