@mistralai/mistralai 1.0.4 → 1.2.0

package/README.md

@@ -1,8 +1,34 @@
 # Mistral Typescript Client
 
+<!-- Start Summary [summary] -->
+## Summary
+
+Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it.
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+
+* [SDK Installation](#sdk-installation)
+* [Requirements](#requirements)
+* [SDK Example Usage](#sdk-example-usage)
+* [Available Resources and Operations](#available-resources-and-operations)
+* [Standalone functions](#standalone-functions)
+* [Server-sent event streaming](#server-sent-event-streaming)
+* [File uploads](#file-uploads)
+* [Retries](#retries)
+* [Error Handling](#error-handling)
+* [Server Selection](#server-selection)
+* [Custom HTTP Client](#custom-http-client)
+* [Authentication](#authentication)
+* [Debugging](#debugging)
+<!-- End Table of Contents [toc] -->
+
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
 ### NPM
 
 ```bash
@@ -63,22 +89,23 @@ This example shows how to create chat completions.
 import { Mistral } from "@mistralai/mistralai";
 
 const mistral = new Mistral({
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.chat.complete({
-        model: "mistral-small-latest",
-        messages: [
-            {
-                content: "Who is the best French painter? Answer in one short sentence.",
-                role: "user",
-            },
-        ],
-    });
+  const result = await mistral.chat.complete({
+    model: "mistral-small-latest",
+    messages: [
+      {
+        content:
+          "Who is the best French painter? Answer in one short sentence.",
+        role: "user",
+      },
+    ],
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -94,16 +121,16 @@ import { Mistral } from "@mistralai/mistralai";
 import { openAsBlob } from "node:fs";
 
 const mistral = new Mistral({
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.files.upload({
-        file: await openAsBlob("./sample-file"),
-    });
+  const result = await mistral.files.upload({
+    file: await openAsBlob("example.file"),
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -118,22 +145,51 @@ This example shows how to create agents completions.
 import { Mistral } from "@mistralai/mistralai";
 
 const mistral = new Mistral({
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.agents.complete({
-        messages: [
-            {
-                content: "Who is the best French painter? Answer in one short sentence.",
-                role: "user",
-            },
-        ],
-        agentId: "<value>",
-    });
+  const result = await mistral.agents.complete({
+    messages: [
+      {
+        content:
+          "Who is the best French painter? Answer in one short sentence.",
+        role: "user",
+      },
+    ],
+    agentId: "<value>",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+
+### Create Embedding Request
+
+This example shows how to create embedding request.
+
+```typescript
+import { Mistral } from "@mistralai/mistralai";
+
+const mistral = new Mistral({
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await mistral.embeddings.create({
+    inputs: [
+      "Embed this sentence.",
+      "As well as this one.",
+    ],
+    model: "Wrangler",
+  });
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -151,14 +207,27 @@ We have dedicated SDKs for the following providers:
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
-### [models](docs/sdks/models/README.md)
+<details open>
+<summary>Available methods</summary>
 
-* [list](docs/sdks/models/README.md#list) - List Models
-* [retrieve](docs/sdks/models/README.md#retrieve) - Retrieve Model
-* [delete](docs/sdks/models/README.md#delete) - Delete Model
-* [update](docs/sdks/models/README.md#update) - Update Fine Tuned Model
-* [archive](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model
-* [unarchive](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model
+### [agents](docs/sdks/agents/README.md)
+
+* [complete](docs/sdks/agents/README.md#complete) - Agents Completion
+* [stream](docs/sdks/agents/README.md#stream) - Stream Agents completion
+
+### [chat](docs/sdks/chat/README.md)
+
+* [complete](docs/sdks/chat/README.md#complete) - Chat Completion
+* [stream](docs/sdks/chat/README.md#stream) - Stream chat completion
+
+### [classifiers](docs/sdks/classifiers/README.md)
+
+* [moderate](docs/sdks/classifiers/README.md#moderate) - Moderations
+* [moderateChat](docs/sdks/classifiers/README.md#moderatechat) - Moderations Chat
+
+### [embeddings](docs/sdks/embeddings/README.md)
+
+* [create](docs/sdks/embeddings/README.md#create) - Embeddings
 
 ### [files](docs/sdks/files/README.md)
 
@@ -167,8 +236,15 @@ We have dedicated SDKs for the following providers:
 * [retrieve](docs/sdks/files/README.md#retrieve) - Retrieve File
 * [delete](docs/sdks/files/README.md#delete) - Delete File
 
+### [fim](docs/sdks/fim/README.md)
+
+* [complete](docs/sdks/fim/README.md#complete) - Fim Completion
+* [stream](docs/sdks/fim/README.md#stream) - Stream fim completion
+
+### [fineTuning](docs/sdks/finetuning/README.md)
+
 
-### [fineTuning.jobs](docs/sdks/jobs/README.md)
+#### [fineTuning.jobs](docs/sdks/jobs/README.md)
 
 * [list](docs/sdks/jobs/README.md#list) - Get Fine Tuning Jobs
 * [create](docs/sdks/jobs/README.md#create) - Create Fine Tuning Job
@@ -176,24 +252,17 @@ We have dedicated SDKs for the following providers:
 * [cancel](docs/sdks/jobs/README.md#cancel) - Cancel Fine Tuning Job
 * [start](docs/sdks/jobs/README.md#start) - Start Fine Tuning Job
 
-### [chat](docs/sdks/chat/README.md)
-
-* [complete](docs/sdks/chat/README.md#complete) - Chat Completion
-* [stream](docs/sdks/chat/README.md#stream) - Stream chat completion
-
-### [fim](docs/sdks/fim/README.md)
-
-* [complete](docs/sdks/fim/README.md#complete) - Fim Completion
-* [stream](docs/sdks/fim/README.md#stream) - Stream fim completion
 
-### [agents](docs/sdks/agents/README.md)
-
-* [complete](docs/sdks/agents/README.md#complete) - Agents Completion
-* [stream](docs/sdks/agents/README.md#stream) - Stream Agents completion
+### [models](docs/sdks/models/README.md)
 
-### [embeddings](docs/sdks/embeddings/README.md)
+* [list](docs/sdks/models/README.md#list) - List Models
+* [retrieve](docs/sdks/models/README.md#retrieve) - Retrieve Model
+* [delete](docs/sdks/models/README.md#delete) - Delete Model
+* [update](docs/sdks/models/README.md#update) - Update Fine Tuned Model
+* [archive](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model
+* [unarchive](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model
 
-* [create](docs/sdks/embeddings/README.md#create) - Embeddings
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Server-sent event streaming [eventstream] -->
@@ -209,23 +278,25 @@ underlying connection.
 import { Mistral } from "@mistralai/mistralai";
 
 const mistral = new Mistral({
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.chat.stream({
-        model: "mistral-small-latest",
-        messages: [
-            {
-                content: "Who is the best French painter? Answer in one short sentence.",
-                role: "user",
-            },
-        ],
-    });
-
-    for await (const event of result) {
-        // Handle the event
-    }
+  const result = await mistral.chat.stream({
+    model: "mistral-small-latest",
+    messages: [
+      {
+        content:
+          "Who is the best French painter? Answer in one short sentence.",
+        role: "user",
+      },
+    ],
+  });
+
+  for await (const event of result) {
+    // Handle the event
+    console.log(event);
+  }
 }
 
 run();
@@ -255,16 +326,16 @@ import { Mistral } from "@mistralai/mistralai";
 import { openAsBlob } from "node:fs";
 
 const mistral = new Mistral({
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.files.upload({
-        file: await openAsBlob("./sample-file"),
-    });
+  const result = await mistral.files.upload({
+    file: await openAsBlob("example.file"),
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -282,25 +353,25 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Mistral } from "@mistralai/mistralai";
 
 const mistral = new Mistral({
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.models.list({
-        retries: {
-            strategy: "backoff",
-            backoff: {
-                initialInterval: 1,
-                maxInterval: 50,
-                exponent: 1.1,
-                maxElapsedTime: 100,
-            },
-            retryConnectionErrors: false,
-        },
-    });
+  const result = await mistral.models.list({
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -312,24 +383,24 @@ If you'd like to override the default retry strategy for all operations that sup
 import { Mistral } from "@mistralai/mistralai";
 
 const mistral = new Mistral({
-    retryConfig: {
-        strategy: "backoff",
-        backoff: {
-            initialInterval: 1,
-            maxInterval: 50,
-            exponent: 1.1,
-            maxElapsedTime: 100,
-        },
-        retryConnectionErrors: false,
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
     },
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+    retryConnectionErrors: false,
+  },
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.models.list();
+  const result = await mistral.models.list();
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -340,54 +411,69 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
+All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
 
-| Error Object               | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4xx-5xx                    | */*                        |
+If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
 
-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 string since validation errors can list many issues and the plain error string may be difficult read when debugging. 
+| 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                     |
 
+In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `list` method may throw the following errors:
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
-import { SDKValidationError } from "@mistralai/mistralai/models/errors";
+import {
+  HTTPValidationError,
+  SDKValidationError,
+} from "@mistralai/mistralai/models/errors";
 
 const mistral = new Mistral({
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    let result;
-    try {
-        result = await mistral.models.list();
-    } catch (err) {
-        switch (true) {
-            case err instanceof SDKValidationError: {
-                // Validation errors can be pretty-printed
-                console.error(err.pretty());
-                // Raw value may also be inspected
-                console.error(err.rawValue);
-                return;
-            }
-            case err instanceof errors.HTTPValidationError: {
-                console.error(err); // handle exception
-                return;
-            }
-            default: {
-                throw err;
-            }
-        }
-    }
+  let result;
+  try {
+    result = await mistral.models.list();
 
     // Handle the result
     console.log(result);
+  } catch (err) {
+    switch (true) {
+      case (err instanceof SDKValidationError): {
+        // Validation errors can be pretty-printed
+        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: {
+        throw err;
+      }
+    }
+  }
 }
 
 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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -399,21 +485,21 @@ You can override the default server globally by passing a server name to the `se
 
 | Name | Server | Variables |
 | ----- | ------ | --------- |
-| `prod` | `https://api.mistral.ai` | None |
+| `eu` | `https://api.mistral.ai` | None |
 
 ```typescript
 import { Mistral } from "@mistralai/mistralai";
 
 const mistral = new Mistral({
-    server: "prod",
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  server: "eu",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.models.list();
+  const result = await mistral.models.list();
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -429,15 +515,15 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { Mistral } from "@mistralai/mistralai";
 
 const mistral = new Mistral({
-    serverURL: "https://api.mistral.ai",
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  serverURL: "https://api.mistral.ai",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.models.list();
+  const result = await mistral.models.list();
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -510,14 +596,14 @@ To authenticate with the API the `apiKey` parameter must be set when initializin
 import { Mistral } from "@mistralai/mistralai";
 
 const mistral = new Mistral({
-    apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
 });
 
 async function run() {
-    const result = await mistral.models.list();
+  const result = await mistral.models.list();
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -547,29 +633,30 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [agentsComplete](docs/sdks/agents/README.md#complete)
-- [agentsStream](docs/sdks/agents/README.md#stream)
-- [chatComplete](docs/sdks/chat/README.md#complete)
-- [chatStream](docs/sdks/chat/README.md#stream)
-- [embeddingsCreate](docs/sdks/embeddings/README.md#create)
-- [filesDelete](docs/sdks/files/README.md#delete)
-- [filesList](docs/sdks/files/README.md#list)
-- [filesRetrieve](docs/sdks/files/README.md#retrieve)
-- [filesUpload](docs/sdks/files/README.md#upload)
-- [fimComplete](docs/sdks/fim/README.md#complete)
-- [fimStream](docs/sdks/fim/README.md#stream)
-- [fineTuningJobsCancel](docs/sdks/jobs/README.md#cancel)
-- [fineTuningJobsCreate](docs/sdks/jobs/README.md#create)
-- [fineTuningJobsGet](docs/sdks/jobs/README.md#get)
-- [fineTuningJobsList](docs/sdks/jobs/README.md#list)
-- [fineTuningJobsStart](docs/sdks/jobs/README.md#start)
-- [modelsArchive](docs/sdks/models/README.md#archive)
-- [modelsDelete](docs/sdks/models/README.md#delete)
-- [modelsList](docs/sdks/models/README.md#list)
-- [modelsRetrieve](docs/sdks/models/README.md#retrieve)
-- [modelsUnarchive](docs/sdks/models/README.md#unarchive)
-- [modelsUpdate](docs/sdks/models/README.md#update)
-
+- [`agentsComplete`](docs/sdks/agents/README.md#complete) - Agents Completion
+- [`agentsStream`](docs/sdks/agents/README.md#stream) - Stream Agents completion
+- [`chatComplete`](docs/sdks/chat/README.md#complete) - Chat Completion
+- [`chatStream`](docs/sdks/chat/README.md#stream) - Stream chat completion
+- [`classifiersModerate`](docs/sdks/classifiers/README.md#moderate) - Moderations
+- [`classifiersModerateChat`](docs/sdks/classifiers/README.md#moderatechat) - Moderations Chat
+- [`embeddingsCreate`](docs/sdks/embeddings/README.md#create) - Embeddings
+- [`filesDelete`](docs/sdks/files/README.md#delete) - Delete File
+- [`filesList`](docs/sdks/files/README.md#list) - List Files
+- [`filesRetrieve`](docs/sdks/files/README.md#retrieve) - Retrieve File
+- [`filesUpload`](docs/sdks/files/README.md#upload) - Upload File
+- [`fimComplete`](docs/sdks/fim/README.md#complete) - Fim Completion
+- [`fimStream`](docs/sdks/fim/README.md#stream) - Stream fim completion
+- [`fineTuningJobsCancel`](docs/sdks/jobs/README.md#cancel) - Cancel Fine Tuning Job
+- [`fineTuningJobsCreate`](docs/sdks/jobs/README.md#create) - Create Fine Tuning Job
+- [`fineTuningJobsGet`](docs/sdks/jobs/README.md#get) - Get Fine Tuning Job
+- [`fineTuningJobsList`](docs/sdks/jobs/README.md#list) - Get Fine Tuning Jobs
+- [`fineTuningJobsStart`](docs/sdks/jobs/README.md#start) - Start Fine Tuning Job
+- [`modelsArchive`](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model
+- [`modelsDelete`](docs/sdks/models/README.md#delete) - Delete Model
+- [`modelsList`](docs/sdks/models/README.md#list) - List Models
+- [`modelsRetrieve`](docs/sdks/models/README.md#retrieve) - Retrieve Model
+- [`modelsUnarchive`](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model
+- [`modelsUpdate`](docs/sdks/models/README.md#update) - Update Fine Tuned Model
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->

package/docs/sdks/agents/README.md

@@ -35,7 +35,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -73,7 +73,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -94,11 +94,10 @@ run();
 
 ### Errors
 
-| Error Object               | Status Code                | Content Type               |
+| Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4xx-5xx                    | */*                        |
-
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
 ## stream
 
@@ -126,6 +125,7 @@ async function run() {
 
   for await (const event of result) {
     // Handle the event
+    console.log(event);
   }
 }
 
@@ -165,6 +165,7 @@ async function run() {
 
   for await (const event of result) {
     // Handle the event
+    console.log(event);
   }
 }
 
@@ -186,7 +187,7 @@ run();
 
 ### Errors
 
-| Error Object               | Status Code                | Content Type               |
+| Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4xx-5xx                    | */*                        |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |