@mistralai/mistralai 1.9.18 → 1.10.0

package/docs/sdks/files/README.md

@@ -24,6 +24,7 @@ Please contact us if you need to increase these storage limits.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="files_api_routes_upload_file" method="post" path="/v1/files" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 import { openAsBlob } from "node:fs";
@@ -37,7 +38,6 @@ async function run() {
     file: await openAsBlob("example.file"),
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -63,15 +63,12 @@ async function run() {
   const res = await filesUpload(mistral, {
     file: await openAsBlob("example.file"),
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesUpload failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -102,6 +99,7 @@ Returns a list of files that belong to the user's organization.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="files_api_routes_list_files" method="get" path="/v1/files" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -112,7 +110,6 @@ const mistral = new Mistral({
 async function run() {
   const result = await mistral.files.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -135,15 +132,12 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await filesList(mistral, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -174,6 +168,7 @@ Returns information about a specific file.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="files_api_routes_retrieve_file" method="get" path="/v1/files/{file_id}" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -183,10 +178,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.files.retrieve({
-    fileId: "<id>",
+    fileId: "f2a27685-ca4e-4dc2-9f2b-88c422c3e0f6",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -209,17 +203,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await filesRetrieve(mistral, {
-    fileId: "<id>",
+    fileId: "f2a27685-ca4e-4dc2-9f2b-88c422c3e0f6",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -250,6 +241,7 @@ Delete a file.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="files_api_routes_delete_file" method="delete" path="/v1/files/{file_id}" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -259,10 +251,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.files.delete({
-    fileId: "<id>",
+    fileId: "3b6d45eb-e30b-416f-8019-f47e2e93d930",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -285,17 +276,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await filesDelete(mistral, {
-    fileId: "<id>",
+    fileId: "3b6d45eb-e30b-416f-8019-f47e2e93d930",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -326,6 +314,7 @@ Download a file
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="files_api_routes_download_file" method="get" path="/v1/files/{file_id}/content" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -335,10 +324,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.files.download({
-    fileId: "<id>",
+    fileId: "f8919994-a4a1-46b2-8b5b-06335a4300ce",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -361,17 +349,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await filesDownload(mistral, {
-    fileId: "<id>",
+    fileId: "f8919994-a4a1-46b2-8b5b-06335a4300ce",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesDownload failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -402,6 +387,7 @@ Get Signed Url
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="files_api_routes_get_signed_url" method="get" path="/v1/files/{file_id}/url" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -411,10 +397,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.files.getSignedUrl({
-    fileId: "<id>",
+    fileId: "06a020ab-355c-49a6-b19d-304b7c01699f",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -437,17 +422,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await filesGetSignedUrl(mistral, {
-    fileId: "<id>",
+    fileId: "06a020ab-355c-49a6-b19d-304b7c01699f",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesGetSignedUrl failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/fim/README.md

@@ -16,6 +16,7 @@ FIM completion.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="fim_completion_v1_fim_completions_post" method="post" path="/v1/fim/completions" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -30,7 +31,6 @@ async function run() {
     suffix: "return a+b",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -57,15 +57,12 @@ async function run() {
     prompt: "def",
     suffix: "return a+b",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("fimComplete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -97,6 +94,7 @@ Mistral AI provides the ability to stream responses back to a client in order to
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="stream_fim" method="post" path="/v1/fim/completions#stream" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -140,17 +138,15 @@ async function run() {
     prompt: "def",
     suffix: "return a+b",
   });
-
-  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("fimStream failed:", res.error);
+  }
 }
 
 run();

package/docs/sdks/jobs/README.md

@@ -17,6 +17,7 @@ Get a list of fine-tuning jobs for your organization and user.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_get_fine_tuning_jobs" method="get" path="/v1/fine_tuning/jobs" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -27,7 +28,6 @@ const mistral = new Mistral({
 async function run() {
   const result = await mistral.fineTuning.jobs.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,15 +50,12 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await fineTuningJobsList(mistral, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("fineTuningJobsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -89,6 +86,7 @@ Create a new fine-tuning job, it will be queued for processing.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_create_fine_tuning_job" method="post" path="/v1/fine_tuning/jobs" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -98,13 +96,12 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.fineTuning.jobs.create({
-    model: "Fiesta",
+    model: "Camaro",
     hyperparameters: {
       learningRate: 0.0001,
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -127,20 +124,17 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await fineTuningJobsCreate(mistral, {
-    model: "Fiesta",
+    model: "Camaro",
     hyperparameters: {
       learningRate: 0.0001,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("fineTuningJobsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -171,6 +165,7 @@ Get a fine-tuned job details by its UUID.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_get_fine_tuning_job" method="get" path="/v1/fine_tuning/jobs/{job_id}" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -180,10 +175,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.fineTuning.jobs.get({
-    jobId: "b888f774-3e7c-4135-a18c-6b985523c4bc",
+    jobId: "c167a961-ffca-4bcf-93ac-6169468dd389",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -206,17 +200,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await fineTuningJobsGet(mistral, {
-    jobId: "b888f774-3e7c-4135-a18c-6b985523c4bc",
+    jobId: "c167a961-ffca-4bcf-93ac-6169468dd389",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("fineTuningJobsGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -247,6 +238,7 @@ Request the cancellation of a fine tuning job.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_cancel_fine_tuning_job" method="post" path="/v1/fine_tuning/jobs/{job_id}/cancel" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -256,10 +248,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.fineTuning.jobs.cancel({
-    jobId: "0f713502-9233-41c6-9ebd-c570b7edb496",
+    jobId: "6188a2f6-7513-4e0f-89cc-3f8088523a49",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -282,17 +273,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await fineTuningJobsCancel(mistral, {
-    jobId: "0f713502-9233-41c6-9ebd-c570b7edb496",
+    jobId: "6188a2f6-7513-4e0f-89cc-3f8088523a49",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("fineTuningJobsCancel failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -323,6 +311,7 @@ Request the start of a validated fine tuning job.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_start_fine_tuning_job" method="post" path="/v1/fine_tuning/jobs/{job_id}/start" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -332,10 +321,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.fineTuning.jobs.start({
-    jobId: "0bf0f9e6-c3e5-4d61-aac8-0e36dcac0dfc",
+    jobId: "56553e4d-0679-471e-b9ac-59a77d671103",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -358,17 +346,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await fineTuningJobsStart(mistral, {
-    jobId: "0bf0f9e6-c3e5-4d61-aac8-0e36dcac0dfc",
+    jobId: "56553e4d-0679-471e-b9ac-59a77d671103",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("fineTuningJobsStart failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();