@mistralai/mistralai 1.9.18 → 1.10.0

package/FUNCTIONS.md

@@ -21,7 +21,6 @@ specific category of applications.
 ```typescript
 import { MistralCore } from "@mistralai/mistralai/core.js";
 import { filesUpload } from "@mistralai/mistralai/funcs/filesUpload.js";
-import { SDKValidationError } from "@mistralai/mistralai/models/errors/sdkvalidationerror.js";
 import { openAsBlob } from "node:fs";
 
 // Use `MistralCore` for best tree-shaking performance.
@@ -34,28 +33,12 @@ async function run() {
   const res = await filesUpload(mistral, {
     file: await openAsBlob("example.file"),
   });
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + 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();

package/README.md

@@ -111,7 +111,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -136,7 +135,6 @@ async function run() {
     file: await openAsBlob("example.file"),
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -167,7 +165,6 @@ async function run() {
     agentId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -195,7 +192,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -367,7 +363,16 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.beta.conversations.startStream({
-    inputs: "<value>",
+    inputs: [
+      {
+        object: "entry",
+        type: "agent.handoff",
+        previousAgentId: "<id>",
+        previousAgentName: "<value>",
+        nextAgentId: "<id>",
+        nextAgentName: "<value>",
+      },
+    ],
   });
 
   for await (const event of result) {
@@ -408,13 +413,12 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.beta.libraries.documents.upload({
-    libraryId: "6886a454-7910-4a2b-b98a-ab61ec65fc41",
+    libraryId: "a02150d9-5ee0-4877-b62c-28b1fcdf3b76",
     requestBody: {
       file: await openAsBlob("example.file"),
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -450,7 +454,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -479,7 +482,6 @@ const mistral = new Mistral({
 async function run() {
   const result = await mistral.models.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -491,51 +493,42 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `list` method may throw the following errors:
+[`MistralError`](./src/models/errors/mistralerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-| Error Type                 | Status Code | Content Type     |
-| -------------------------- | ----------- | ---------------- |
-| errors.HTTPValidationError | 422         | application/json |
-| errors.SDKError            | 4XX, 5XX    | \*/\*            |
-
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
+### Example
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
-import {
-  HTTPValidationError,
-  SDKValidationError,
-} from "@mistralai/mistralai/models/errors";
+import * as errors from "@mistralai/mistralai/models/errors";
 
 const mistral = new Mistral({
   apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-  let result;
   try {
-    result = await mistral.models.list();
+    const result = await mistral.models.list();
 
-    // Handle the result
     console.log(result);
-  } catch (err) {
-    switch (true) {
-      // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError): {
-        // Pretty-print will provide a human-readable multi-line error message
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
-        return;
-      }
-      case (err instanceof HTTPValidationError): {
-        // Handle err.data$: HTTPValidationErrorData
-        console.error(err);
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.MistralError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.HTTPValidationError) {
+        console.log(error.data$.detail); // ValidationError[]
       }
     }
   }
@@ -545,17 +538,29 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+### Error Classes
+**Primary error:**
+* [`MistralError`](./src/models/errors/mistralerror.ts): The base class for HTTP error responses.
 
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+<details><summary>Less common errors (7)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`MistralError`](./src/models/errors/mistralerror.ts)**:
+* [`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 47 of 68 methods.*
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
 
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -582,7 +587,6 @@ const mistral = new Mistral({
 async function run() {
   const result = await mistral.models.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -604,7 +608,6 @@ const mistral = new Mistral({
 async function run() {
   const result = await mistral.models.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -684,7 +687,6 @@ const mistral = new Mistral({
 async function run() {
   const result = await mistral.models.list();
 
-  // Handle the result
   console.log(result);
 }
 

package/docs/sdks/accesses/README.md

@@ -17,6 +17,7 @@ Given a library, list all of the Entity that have access and to what level.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="libraries_share_list_v1" method="get" path="/v1/libraries/{library_id}/share" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -26,10 +27,9 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.beta.libraries.accesses.list({
-    libraryId: "c8a232aa-0b11-4b8a-b005-71e9e705d0e6",
+    libraryId: "d2169833-d8e2-416e-a372-76518d3d99c2",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -52,17 +52,14 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await betaLibrariesAccessesList(mistral, {
-    libraryId: "c8a232aa-0b11-4b8a-b005-71e9e705d0e6",
+    libraryId: "d2169833-d8e2-416e-a372-76518d3d99c2",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("betaLibrariesAccessesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -94,6 +91,7 @@ Given a library id, you can create or update the access level of an entity. You
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="libraries_share_create_v1" method="put" path="/v1/libraries/{library_id}/share" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -103,16 +101,15 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.beta.libraries.accesses.updateOrCreate({
-    libraryId: "e24dc3a8-24c6-4b2e-8108-3f00cec89687",
+    libraryId: "36de3a24-5b1c-4c8f-9d84-d5642205a976",
     sharingIn: {
-      orgId: "9543b76d-ef36-4022-8fc2-3cdec423babe",
-      level: "Editor",
-      shareWithUuid: "5c2bae94-726a-4824-98ee-0429525e4adf",
-      shareWithType: "Org",
+      orgId: "aadd9ae1-f285-4437-884a-091c77efa6fd",
+      level: "Viewer",
+      shareWithUuid: "0ae92ecb-21ed-47c5-9f7e-0b2cbe325a20",
+      shareWithType: "User",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -135,23 +132,20 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await betaLibrariesAccessesUpdateOrCreate(mistral, {
-    libraryId: "e24dc3a8-24c6-4b2e-8108-3f00cec89687",
+    libraryId: "36de3a24-5b1c-4c8f-9d84-d5642205a976",
     sharingIn: {
-      orgId: "9543b76d-ef36-4022-8fc2-3cdec423babe",
-      level: "Editor",
-      shareWithUuid: "5c2bae94-726a-4824-98ee-0429525e4adf",
-      shareWithType: "Org",
+      orgId: "aadd9ae1-f285-4437-884a-091c77efa6fd",
+      level: "Viewer",
+      shareWithUuid: "0ae92ecb-21ed-47c5-9f7e-0b2cbe325a20",
+      shareWithType: "User",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("betaLibrariesAccessesUpdateOrCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -183,6 +177,7 @@ Given a library id, you can delete the access level of an entity. An owner canno
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="libraries_share_delete_v1" method="delete" path="/v1/libraries/{library_id}/share" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -192,15 +187,14 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.beta.libraries.accesses.delete({
-    libraryId: "460ea4f9-1d0d-46c0-ba7e-bf643773e381",
+    libraryId: "709e3cad-9fb2-4f4e-bf88-143cf1808107",
     sharingDelete: {
-      orgId: "8b6fe91a-a0b1-4b3e-ab7b-e83a32f2399e",
-      shareWithUuid: "7aa10743-a04f-44af-84fe-b54259caa1ba",
-      shareWithType: "Workspace",
+      orgId: "0814a235-c2d0-4814-875a-4b85f93d3dc7",
+      shareWithUuid: "b843cc47-ce8f-4354-8cfc-5fcd7fb2865b",
+      shareWithType: "User",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -223,22 +217,19 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await betaLibrariesAccessesDelete(mistral, {
-    libraryId: "460ea4f9-1d0d-46c0-ba7e-bf643773e381",
+    libraryId: "709e3cad-9fb2-4f4e-bf88-143cf1808107",
     sharingDelete: {
-      orgId: "8b6fe91a-a0b1-4b3e-ab7b-e83a32f2399e",
-      shareWithUuid: "7aa10743-a04f-44af-84fe-b54259caa1ba",
-      shareWithType: "Workspace",
+      orgId: "0814a235-c2d0-4814-875a-4b85f93d3dc7",
+      shareWithUuid: "b843cc47-ce8f-4354-8cfc-5fcd7fb2865b",
+      shareWithType: "User",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("betaLibrariesAccessesDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/agents/README.md

@@ -16,6 +16,7 @@ Agents Completion
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="agents_completion_v1_agents_completions_post" method="post" path="/v1/agents/completions" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -34,7 +35,6 @@ async function run() {
     agentId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -65,15 +65,12 @@ async function run() {
     ],
     agentId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("agentsComplete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -105,6 +102,7 @@ Mistral AI provides the ability to stream responses back to a client in order to
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="stream_agents" method="post" path="/v1/agents/completions#stream" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -156,17 +154,15 @@ async function run() {
     ],
     agentId: "<id>",
   });
-
-  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("agentsStream failed:", res.error);
+  }
 }
 
 run();

package/docs/sdks/chat/README.md

@@ -16,6 +16,7 @@ Chat Completion
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="chat_completion_v1_chat_completions_post" method="post" path="/v1/chat/completions" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -34,7 +35,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -65,15 +65,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("chatComplete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -105,6 +102,7 @@ Mistral AI provides the ability to stream responses back to a client in order to
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="stream_chat" method="post" path="/v1/chat/completions#stream" -->
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
@@ -156,17 +154,15 @@ async function run() {
       },
     ],
   });
-
-  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("chatStream failed:", res.error);
+  }
 }
 
 run();