fix: update package.json for examples #133

aac228 · web-flow · commit 02dfca72a79d · 2025-09-02T15:39:20.000+02:00
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -35,6 +35,7 @@ typescript:
   envVarPrefix: MISTRAL
   flattenGlobalSecurity: true
   flatteningOrder: body-first
+  generateExamples: true
   imports:
     option: openapi
     paths:
diff --git a/examples/README.md b/examples/README.md
@@ -9,11 +9,13 @@ Below is a guide how to run the examples if you have cloned this repo.
 ## How to run the examples locally
 
 ### Install the npm dependencies or the repository and the `examples` directory
+
 ```properties
 npm install && npm install --prefix examples
 ```
 
 ### Set your environment variables
+
 ```properties
 cp examples/.env.template examples/.env
 # Edit your .env file
@@ -22,18 +24,21 @@ cp examples/.env.template examples/.env
 ### [Dev only] Link the local `mistralai` package
 
 If you want to use the local `mistralai` package, you can link it to the examples directory. From the repository's root:
+
 ```properties
 npm run build
 npm link
 (cd examples/src && npm link @mistralai/mistralai)
 ```
 
 ### Run the examples
+
 ```properties
 npm run test --prefix examples
 ```
 
 If you just want to run one example file, you can do so with:
+
 ```properties
 npm run test --prefix examples -- --files src/stag_async_moderation.ts
-```
+```
diff --git a/examples/package-lock.json b/examples/package-lock.json
diff --git a/examples/package.json b/examples/package.json
@@ -10,7 +10,8 @@
     "gcp": "npm run script -- ./src/gcp/async_chat_no_streaming.ts",
     "azure": "npm run script -- ./src/azure/async_chat_no_streaming.ts",
     "format": "prettier --write .",
-    "test": "tsx ./test.ts"
+    "test": "tsx ./test.ts",
+    "build:examples": "echo 'skipping build examples'"
   },
   "keywords": [],
   "author": "",
@@ -22,9 +23,10 @@
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "glob": "^11.0.0",
     "@types/node": "^20.11.4",
+    "glob": "^11.0.0",
     "prettier": "3.3.3",
-    "tsx": "^4.7.0"
+    "tsx": "^4.7.0",
+    "typescript": "^5.9.2"
   }
-}
+}
diff --git a/examples/src/async_audio_transcription_stream.ts b/examples/src/async_audio_transcription_stream.ts
@@ -2,17 +2,17 @@ import { Mistral } from "@mistralai/mistralai";
 
 const apiKey = process.env["MISTRAL_API_KEY"];
 if (!apiKey) {
-    throw new Error("missing MISTRAL_API_KEY environment variable");
+  throw new Error("missing MISTRAL_API_KEY environment variable");
 }
 
 const mistral = new Mistral({ apiKey: apiKey });
 
 const stream = await mistral.audio.transcriptions.stream({
-    model: "voxtral-mini-latest",
-    fileUrl: "https://docs.mistral.ai/audio/bcn_weather.mp3",
+  model: "voxtral-mini-latest",
+  fileUrl: "https://docs.mistral.ai/audio/bcn_weather.mp3",
 });
 
 for await (const event of stream) {
-    process.stdout.write(JSON.stringify(event));
-    process.stdout.write("\n");
+  process.stdout.write(JSON.stringify(event));
+  process.stdout.write("\n");
 }
diff --git a/examples/src/async_chat_prediction.ts b/examples/src/async_chat_prediction.ts
@@ -22,12 +22,12 @@ const chatResponse = await client.chat.complete({
   model: "codestral-latest",
   messages: [
     { role: "user", content: refactorPrompt },
-    { role: "user", content: code }
+    { role: "user", content: code },
   ],
   prediction: {
     type: "content",
-    content: code
-  }
+    content: code,
+  },
 });
 
-console.log(chatResponse.choices[0].message.content);
+console.log(chatResponse.choices[0]?.message.content);
diff --git a/examples/src/async_files.ts b/examples/src/async_files.ts
@@ -1,6 +1,6 @@
 import * as fs from "fs";
 import { Mistral } from "@mistralai/mistralai";
-import path from 'path';
+import path from "path";
 import { fileURLToPath } from "url";
 
 const apiKey = process.env["MISTRAL_API_KEY"];
@@ -19,7 +19,7 @@ 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: blob });
 
 console.log(createdFile);
 
diff --git a/examples/src/async_function_calling_streaming.ts b/examples/src/async_function_calling_streaming.ts
@@ -131,7 +131,6 @@ stream = await client.chat.stream({
 let full_tool_call: ToolCall[] = [];
 
 for await (const event of stream) {
-
   const toolCalls = event.data?.choices[0]?.delta.toolCalls;
   if (!toolCalls) {
     continue;
@@ -177,4 +176,4 @@ for await (const event of stream) {
 
   process.stdout.write(content);
 }
-console.log("\ndone")
+console.log("\ndone");
diff --git a/examples/src/async_jobs.ts b/examples/src/async_jobs.ts
@@ -1,6 +1,6 @@
 import * as fs from "fs";
 import { Mistral } from "@mistralai/mistralai";
-import path from 'path';
+import path from "path";
 import { fileURLToPath } from "url";
 
 const apiKey = process.env["MISTRAL_API_KEY"];
@@ -39,7 +39,9 @@ const jobs = await mistral.fineTuning.jobs.list();
 console.log(jobs);
 
 // Retrieve a job
-const retrievedJob = await mistral.fineTuning.jobs.get({ jobId: createdJob.id });
+const retrievedJob = await mistral.fineTuning.jobs.get({
+  jobId: createdJob.id,
+});
 console.log(retrievedJob);
 
 // Cancel a job
diff --git a/examples/src/async_ocr_process_from_file.ts b/examples/src/async_ocr_process_from_file.ts
@@ -1,34 +1,33 @@
-import { Mistral } from '@mistralai/mistralai';
-import fs from 'fs';
-import path from 'path';
+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 });
 
-
 // Get the absolute directory path
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
-const filePath = path.join(__dirname, "ocr.pdf")
+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",
-        content: uploaded_file,
-    },
-    purpose: "ocr"
+  file: {
+    fileName: "uploaded_file.pdf",
+    content: uploaded_file,
+  },
+  purpose: "ocr",
 });
 
 const ocrResponse = await client.ocr.process({
-    model: "mistral-ocr-latest",
-    document: {
-        type: "file",
-        fileId: uploaded_pdf.id
-    },
-    includeImageBase64: true
+  model: "mistral-ocr-latest",
+  document: {
+    type: "file",
+    fileId: uploaded_pdf.id,
+  },
+  includeImageBase64: true,
 });
-console.log("OCR ", ocrResponse);
+console.log("OCR ", ocrResponse);
diff --git a/examples/src/async_ocr_process_from_url.ts b/examples/src/async_ocr_process_from_url.ts
@@ -1,15 +1,15 @@
-import { Mistral } from '@mistralai/mistralai';
+import { Mistral } from "@mistralai/mistralai";
 
 const apiKey = process.env.MISTRAL_API_KEY;
 const client = new Mistral({ apiKey: apiKey });
 
 const ocrResponse = await client.ocr.process({
-    model: "mistral-ocr-latest",
-    document: {
-        type: "document_url",
-        documentUrl: "https://arxiv.org/pdf/2201.04234.pdf"
-    },
-    includeImageBase64: true
+  model: "mistral-ocr-latest",
+  document: {
+    type: "document_url",
+    documentUrl: "https://arxiv.org/pdf/2201.04234.pdf",
+  },
+  includeImageBase64: true,
 });
 
-console.log("OCR:", ocrResponse);
+console.log("OCR:", ocrResponse);
diff --git a/examples/src/async_structured_outputs.ts b/examples/src/async_structured_outputs.ts
@@ -7,14 +7,14 @@ if (!apiKey) {
 }
 
 const Explanation = z.object({
-    explanation: z.string(),
-    output: z.string(),
-  });
+  explanation: z.string(),
+  output: z.string(),
+});
 
 const MathDemonstration = z.object({
-    steps: z.array(Explanation),
-    final_answer: z.string(),
-  });
+  steps: z.array(Explanation),
+  final_answer: z.string(),
+});
 
 const client = new Mistral({ apiKey: apiKey });
 
@@ -25,13 +25,17 @@ const client = new Mistral({ apiKey: apiKey });
 const stream = await client.chat.parseStream({
   model: "mistral-tiny-latest",
   messages: [
-    { role: "system", content: "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning." },
-    { role: "user", content: "How can I solve 8x + 7 = -23" }
+    {
+      role: "system",
+      content:
+        "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning.",
+    },
+    { role: "user", content: "How can I solve 8x + 7 = -23" },
   ],
   responseFormat: MathDemonstration,
 });
 
-let accumulatedStream = '';
+let accumulatedStream = "";
 for await (const event of stream) {
   const content = event.data?.choices[0]?.delta.content;
   if (!content) {
@@ -42,19 +46,25 @@ for await (const event of stream) {
 }
 
 // Parse the accumulated stream back to the initial zod object.
-let parsedAccumulatedStream = MathDemonstration.safeParse(JSON.parse(accumulatedStream)).data;
-console.log('\n', parsedAccumulatedStream);
+let parsedAccumulatedStream = MathDemonstration.safeParse(
+  JSON.parse(accumulatedStream),
+).data;
+console.log("\n", parsedAccumulatedStream);
 
 // Structured Output using the parse method
 // This method will return the response parsed back to the initial Zod object.
 
 const chatResponse = await client.chat.parse({
   model: "mistral-tiny-latest",
   messages: [
-    { role: "system", content: "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning." },
-    { role: "user", content: "How can I solve 8x + 7 = -23" }
+    {
+      role: "system",
+      content:
+        "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning.",
+    },
+    { role: "user", content: "How can I solve 8x + 7 = -23" },
   ],
   responseFormat: MathDemonstration,
 });
 
-console.log('\n', chatResponse.choices[0].message.parsed);
+console.log("\n", chatResponse.choices[0].message.parsed);
diff --git a/examples/src/error_handling.ts b/examples/src/error_handling.ts
@@ -1,31 +1,31 @@
-import {Mistral} from "@mistralai/mistralai";
-import {SDKError} from "../../models/errors/index.js";
+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");
+  throw new Error("missing MISTRAL_API_KEY environment variable");
 }
 
-const client = new Mistral({apiKey: apiKey});
+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
-    }
+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;
+  }
 }
diff --git a/examples/test.ts b/examples/test.ts
