@mistralai/mistralai 1.9.18 → 1.10.0

package/docs/sdks/models/README.md

@@ -20,6 +20,7 @@ List all models available to the user.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list_models_v1_models_get" method="get" path="/v1/models" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -30,7 +31,6 @@ const mistral = new Mistral({
 async function run() {
   const result = await mistral.models.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -53,15 +53,12 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await modelsList(mistral);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("modelsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -92,6 +89,7 @@ Retrieve information about a model.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="retrieve_model_v1_models__model_id__get" method="get" path="/v1/models/{model_id}" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -104,7 +102,6 @@ async function run() {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -129,15 +126,12 @@ async function run() {
   const res = await modelsRetrieve(mistral, {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("modelsRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -169,6 +163,7 @@ Delete a fine-tuned model.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="delete_model_v1_models__model_id__delete" method="delete" path="/v1/models/{model_id}" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -181,7 +176,6 @@ async function run() {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -206,15 +200,12 @@ async function run() {
   const res = await modelsDelete(mistral, {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("modelsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -246,6 +237,7 @@ Update a model name or description.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_update_fine_tuned_model" method="patch" path="/v1/fine_tuning/models/{model_id}" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -259,7 +251,6 @@ async function run() {
     updateFTModelIn: {},
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -285,15 +276,12 @@ async function run() {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
     updateFTModelIn: {},
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("modelsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -324,6 +312,7 @@ Archive a fine-tuned model.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_archive_fine_tuned_model" method="post" path="/v1/fine_tuning/models/{model_id}/archive" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -336,7 +325,6 @@ async function run() {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -361,15 +349,12 @@ async function run() {
   const res = await modelsArchive(mistral, {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("modelsArchive failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -400,6 +385,7 @@ Un-archive a fine-tuned model.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_unarchive_fine_tuned_model" method="delete" path="/v1/fine_tuning/models/{model_id}/archive" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -412,7 +398,6 @@ async function run() {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -437,15 +422,12 @@ async function run() {
   const res = await modelsUnarchive(mistral, {
     modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("modelsUnarchive failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/ocr/README.md

@@ -15,6 +15,7 @@ OCR
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ocr_v1_ocr_post" method="post" path="/v1/ocr" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -24,14 +25,13 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.ocr.process({
-    model: "Focus",
+    model: "CX-9",
     document: {
-      documentUrl: "https://dutiful-horst.org",
+      documentUrl: "https://upset-labourer.net/",
       type: "document_url",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -54,21 +54,18 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await ocrProcess(mistral, {
-    model: "Focus",
+    model: "CX-9",
     document: {
-      documentUrl: "https://dutiful-horst.org",
+      documentUrl: "https://upset-labourer.net/",
       type: "document_url",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ocrProcess failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/transcriptions/README.md

@@ -16,6 +16,7 @@ Create Transcription
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="audio_api_v1_transcriptions_post" method="post" path="/v1/audio/transcriptions" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -25,10 +26,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.audio.transcriptions.complete({
-    model: "Ranchero",
+    model: "Model X",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -51,17 +51,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await audioTranscriptionsComplete(mistral, {
-    model: "Ranchero",
+    model: "Model X",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("audioTranscriptionsComplete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -92,6 +89,7 @@ Create streaming transcription (SSE)
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="audio_api_v1_transcriptions_post_stream" method="post" path="/v1/audio/transcriptions#stream" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -101,7 +99,7 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.audio.transcriptions.stream({
-    model: "Ranchero",
+    model: "Camry",
   });
 
   for await (const event of result) {
@@ -129,19 +127,17 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await audioTranscriptionsStream(mistral, {
-    model: "Ranchero",
+    model: "Camry",
   });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  for await (const event of result) {
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const event of result) {
     // Handle the event
     console.log(event);
   }
+  } else {
+    console.log("audioTranscriptionsStream failed:", res.error);
+  }
 }
 
 run();

package/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,6 +24,7 @@ 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
@@ -29,11 +32,13 @@ npm link
 ```
 
 ### 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
-```
+```

package/examples/package-lock.json

@@ -18,22 +18,22 @@
         "@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"
       }
     },
     "..": {
       "name": "@mistralai/mistralai",
-      "version": "1.5.1",
+      "version": "1.9.19",
       "dependencies": {
         "zod-to-json-schema": "^3.24.1"
       },
       "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "^7.7.1",
-        "@typescript-eslint/parser": "^7.7.1",
-        "eslint": "^8.57.0",
-        "eslint-import-resolver-typescript": "^3.6.1",
-        "eslint-plugin-import": "^2.29.1",
+        "@eslint/js": "^9.19.0",
+        "eslint": "^9.19.0",
+        "globals": "^15.14.0",
         "typescript": "^5.4.5",
+        "typescript-eslint": "^8.22.0",
         "zod": "^3.23.4"
       },
       "peerDependencies": {
@@ -42,14 +42,13 @@
     },
     "../packages/mistralai-azure": {
       "name": "@mistralai/mistralai-azure",
-      "version": "1.4.0",
+      "version": "1.6.0",
       "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "^7.7.1",
-        "@typescript-eslint/parser": "^7.7.1",
-        "eslint": "^8.57.0",
-        "eslint-import-resolver-typescript": "^3.6.1",
-        "eslint-plugin-import": "^2.29.1",
+        "@eslint/js": "^9.19.0",
+        "eslint": "^9.19.0",
+        "globals": "^15.14.0",
         "typescript": "^5.4.5",
+        "typescript-eslint": "^8.22.0",
         "zod": "^3.23.4"
       },
       "peerDependencies": {
@@ -58,17 +57,16 @@
     },
     "../packages/mistralai-gcp": {
       "name": "@mistralai/mistralai-gcp",
-      "version": "1.4.0",
+      "version": "1.5.0",
       "dependencies": {
         "google-auth-library": "^9.11.0"
       },
       "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "^7.7.1",
-        "@typescript-eslint/parser": "^7.7.1",
-        "eslint": "^8.57.0",
-        "eslint-import-resolver-typescript": "^3.6.1",
-        "eslint-plugin-import": "^2.29.1",
+        "@eslint/js": "^9.19.0",
+        "eslint": "^9.19.0",
+        "globals": "^15.14.0",
         "typescript": "^5.4.5",
+        "typescript-eslint": "^8.22.0",
         "zod": "^3.23.4"
       },
       "peerDependencies": {
@@ -1138,6 +1136,20 @@
         "fsevents": "~2.3.3"
       }
     },
+    "node_modules/typescript": {
+      "version": "5.9.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.2.tgz",
+      "integrity": "sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A==",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    },
     "node_modules/undici-types": {
       "version": "6.19.8",
       "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz",

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

package/examples/src/async_audio_transcription_stream.ts

@@ -2,16 +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(event);
+  process.stdout.write(JSON.stringify(event));
+  process.stdout.write("\n");
 }

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

package/examples/src/async_chat_with_image_no_streaming.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);

package/examples/src/async_files.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")
-//     },
-//   });
+const createdFile = await client.files.upload({ file: blob });
 
 console.log(createdFile);
 

package/examples/src/async_function_calling_streaming.ts

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

package/examples/src/async_jobs.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 });
@@ -32,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

package/examples/src/async_json_format.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" },
 });