chore(ci): run examples in the ci #132

Author: aac228

.github/workflows/run_example_scripts.yaml

@@ -0,0 +1,32 @@
+name: Running the examples
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: npm install && npm install --prefix examples && npm install tsx
+
+      - name: Build the project
+        run: npm run build
+
+      - name: Run the example script
+        run: ./scripts/run_examples.sh
+        env:
+          MISTRAL_API_KEY: ${{ secrets.MISTRAL_API_KEY }}

examples/package-lock.json

@@ -13,5 +13,6 @@ const stream = await mistral.audio.transcriptions.stream({
 });
 
 for await (const event of stream) {
-    process.stdout.write(event);
+    process.stdout.write(JSON.stringify(event));
+    process.stdout.write("\n");
 }

examples/src/async_audio_transcription_stream.ts

@@ -16,12 +16,12 @@ const chatResponse = await client.chat.complete({
         { type: "text", text: "What's in this image?" },
         {
           type: "image_url",
-          imageUrl: "https://tripfixers.com/wp-content/uploads/2019/11/eiffel-tower-with-snow.jpeg",
+          imageUrl:
+            "https://mistral.ai/_next/image?url=https%3A%2F%2Fcms.mistral.ai%2Fassets%2Fce1514ab-62f9-4825-a20b-298f2497c536&w=3840&q=75",
         },
-      ]
-    }
+      ],
+    },
   ],
 });
 
-
-console.log('JSON:', chatResponse.choices[0].message.content)
+console.log("JSON:", chatResponse.choices[0].message.content);

examples/src/async_chat_with_image_no_streaming.ts

@@ -1,25 +1,25 @@
 import * as fs from "fs";
 import { Mistral } from "@mistralai/mistralai";
+import path from 'path';
+import { fileURLToPath } from "url";
 
 const apiKey = process.env["MISTRAL_API_KEY"];
 if (!apiKey) {
   throw new Error("missing MISTRAL_API_KEY environment variable");
 }
 
+// Get the absolute directory path
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
 const client = new Mistral({ apiKey: apiKey });
 
 // Create a new file
-const blob = new Blob([fs.readFileSync("./src/file.jsonl")], {
+const filePath = path.join(__dirname, "file.jsonl");
+const blob = new Blob([fs.readFileSync(filePath)], {
   type: "application/json",
 });
 const createdFile = await client.files.upload({ file: blob, });
-// const createdFile = await client.files.upload(
-//   {
-//     file: {
-//       fileName: "./src/file.jsonl",
-//       content: fs.readFileSync("./src/file.jsonl")
-//     },
-//   });
 
 console.log(createdFile);
 

examples/src/async_files.ts

@@ -90,7 +90,7 @@ const tools = [
   },
 ];
 
-const model = "mistral-large-latest";
+const model = "mistral-small-latest";
 
 const client = new Mistral({ apiKey: apiKey });
 

examples/src/async_function_calling_streaming.ts

@@ -1,5 +1,7 @@
 import * as fs from "fs";
 import { Mistral } from "@mistralai/mistralai";
+import path from 'path';
+import { fileURLToPath } from "url";
 
 const apiKey = process.env["MISTRAL_API_KEY"];
 if (!apiKey) {
@@ -8,8 +10,13 @@ if (!apiKey) {
 
 const mistral = new Mistral();
 
+// Get the absolute directory path
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const filePath = path.join(__dirname, "file.jsonl");
+
 // Create a new file
-const blob = new Blob([fs.readFileSync("src/file.jsonl")], {
+const blob = new Blob([fs.readFileSync(filePath)], {
   type: "application/json",
 });
 const createdFile = await mistral.files.upload({ file: blob });

examples/src/async_jobs.ts

@@ -8,7 +8,7 @@ if (!apiKey) {
 const mistral = new Mistral({ apiKey: apiKey });
 
 const chatResponse = await mistral.chat.complete({
-  model: "mistral-large-latest",
+  model: "mistral-small-latest",
   messages: [{ role: "user", content: "What is the best French cheese?" }],
   responseFormat: { type: "json_object" },
 });

examples/src/async_json_format.ts

@@ -1,13 +1,20 @@
 import { Mistral } from '@mistralai/mistralai';
 import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from "url";
 
 const apiKey = process.env.MISTRAL_API_KEY;
 
 const client = new Mistral({ apiKey: apiKey });
 
 
-const file_path = "/path/to/uploaded_file.pdf"
-const uploaded_file = fs.readFileSync(file_path);
+// Get the absolute directory path
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const filePath = path.join(__dirname, "ocr.pdf")
+
+// Upload the file and run ocr
+const uploaded_file = fs.readFileSync(filePath);
 const uploaded_pdf = await client.files.upload({
     file: {
         fileName: "uploaded_file.pdf",

examples/src/async_ocr_process_from_file.ts

@@ -0,0 +1,31 @@
+import {Mistral} from "@mistralai/mistralai";
+import {SDKError} from "../../models/errors/index.js";
+
+const apiKey = process.env["MISTRAL_API_KEY"];
+if (!apiKey) {
+    throw new Error("missing MISTRAL_API_KEY environment variable");
+}
+
+const client = new Mistral({apiKey: apiKey});
+
+try{
+    const chatResponse = await client.chat.complete({
+        model: "pixtral-12b",
+        messages: [
+            {
+                role: "user",
+                content: "hello"
+            },
+            {
+                role: "assistant",
+                content: "hey"
+            }
+        ],
+    });
+} catch (e){
+    if (e instanceof SDKError) {
+        process.stdout.write(e.message)
+    } else {
+        throw e
+    }
+}