@mistralai/mistralai 0.1.3 → 0.3.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

@@ -19,7 +19,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18, 20]
+        node-version: [18, 20, 22]
 
     steps:
       # Checkout the repository
@@ -47,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
@@ -67,68 +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
-
-  create_pr_on_public:
-    if: startsWith(github.ref, 'refs/tags')
-    runs-on: ubuntu-latest
-    needs: lint_and_test
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.PUBLIC_CLIENT_WRITE_TOKEN }}
-
-      - name: Pull public updates
-        env: # We cannot use the github bot token to push to the public repo, we have to use one with more permissions
-          GITHUB_TOKEN: ${{ secrets.PUBLIC_CLIENT_WRITE_TOKEN }}
-        run: |
-
-          set -x
-          git config --global user.name "GitHub Actions"
-          git config --global user.email "mayo@mistral.ai"
-
-          git remote add public https://github.com/mistralai/client-js.git
-          git remote update
-
-          # Create a diff of the changes, ignoring the ci workflow
-          git merge public/main --no-commit --no-ff --no-edit --allow-unrelated-histories --strategy-option ours
-
-          # If there are changes, commit them
-          if ! git diff --quiet; then
-            git commit -m "Update from public repo"
-            git push origin ${{github.ref}}
-          else
-            echo "No changes to apply"
-          fi
-
-      - name: Push to public repo
-        env:
-          GITHUB_TOKEN: ${{ secrets.PUBLIC_CLIENT_WRITE_TOKEN }}
-        run: |
-          git checkout public/main
-          git checkout -b update/${{github.ref_name}}
-
-          # write version number to version file
-          echo ${{github.ref_name}} > version.txt
-
-          git add .
-          git commit -m "Bump version file"
-
-          # create a diff of this ref and the public repo
-          git diff update/${{github.ref_name}} ${{github.ref_name}} --binary -- . ':!.github' > changes.diff
-
-          # apply the diff to the current branch
-          git apply changes.diff
-
-          # commit the changes
-          git add .
-          git commit -m "Update version to ${{github.ref_name}}"
-
-          # push the changes
-          git push public update/${{github.ref_name}}
-
-          # Create a PR from this branch to the public repo
-          gh pr create --title "Update client to ${{github.ref_name}}" --body "This PR was automatically created by a GitHub Action" --base main --head update/${{github.ref_name}} --repo mistralai/client-js

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

@@ -6,9 +6,13 @@ const apiKey = process.env.MISTRAL_API_KEY;
 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],
+  paymentAmount: [125.5, 89.99, 120.0, 54.3, 210.2],
   paymentDate: [
-    '2021-10-05', '2021-10-06', '2021-10-07', '2021-10-05', '2021-10-08',
+    '2021-10-05',
+    '2021-10-06',
+    '2021-10-07',
+    '2021-10-05',
+    '2021-10-08',
   ],
   paymentStatus: ['Paid', 'Unpaid', 'Paid', 'Paid', 'Pending'],
 };
@@ -22,7 +26,7 @@ const data = {
 function retrievePaymentStatus({data, transactionId}) {
   const transactionIndex = data.transactionId.indexOf(transactionId);
   if (transactionIndex != -1) {
-    return JSON.stringify({status: data.payment_status[transactionIndex]});
+    return JSON.stringify({status: data.paymentStatus[transactionIndex]});
   } else {
     return JSON.stringify({status: 'error - transaction id not found.'});
   }
@@ -60,8 +64,8 @@ const tools = [
       parameters: {
         type: 'object',
         required: ['transactionId'],
-        properties: {transactionId:
-          {type: 'string', description: 'The transaction id.'},
+        properties: {
+          transactionId: {type: 'string', description: 'The transaction id.'},
         },
       },
     },
@@ -74,38 +78,43 @@ const tools = [
       parameters: {
         type: 'object',
         required: ['transactionId'],
-        properties: {transactionId:
-          {type: 'string', description: 'The transaction id.'},
+        properties: {
+          transactionId: {type: 'string', description: 'The transaction id.'},
         },
       },
     },
   },
 ];
 
+const model = 'mistral-small-latest';
 
-const model = 'mistral-large';
-
-const client = new MistralClient(apiKey, 'https://api-2.aurocloud.net');
+const client = new MistralClient(apiKey);
 
 const messages = [
   {role: 'user', content: 'What\'s the status of my transaction?'},
 ];
 
 let response = await client.chat({
-  model: model, messages: messages, tools: tools,
+  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: '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});
+response = await client.chat({
+  model: model,
+  messages: messages,
+  tools: tools,
+});
 
-const toolCall = response.choices[0].message.toolCalls[0];
+const toolCall = response.choices[0].message.tool_calls[0];
 const functionName = toolCall.function.name;
 const functionParams = JSON.parse(toolCall.function.arguments);
 
@@ -115,8 +124,17 @@ 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});
+messages.push({
+  role: 'tool',
+  name: functionName,
+  content: functionResult,
+  tool_call_id: toolCall.id,
+});
 
-response = await client.chat({model: model, messages: messages, tools: tools});
+response = await client.chat({
+  model: model,
+  messages: messages,
+  tools: tools,
+});
 
 console.log(response.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);
+  }
+}