Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/mistralai/client-ts

TS Client library for Mistral AI platform
https://github.com/mistralai/client-ts
Last synced: 20 days ago
JSON representation
TS Client library for Mistral AI platform
Host: GitHub
URL: https://github.com/mistralai/client-ts
Owner: mistralai
License: apache-2.0
Created: 2024-08-07T11:54:28.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-11-15T18:38:04.000Z (28 days ago)
Last Synced: 2024-11-15T19:32:40.252Z (28 days ago)
Language: TypeScript
Homepage:
Size: 680 KB
Stars: 29
Watchers: 7
Forks: 10
Open Issues: 13
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project

README

        # Mistral Typescript Client

## 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.

## 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)

## 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

npm add @mistralai/mistralai

```

### PNPM

```bash

pnpm add @mistralai/mistralai

```

### Bun

```bash

bun add @mistralai/mistralai

```

### Yarn

```bash

yarn add @mistralai/mistralai zod

# Note that Yarn does not install peer dependencies automatically. You will need

# to install zod as shown above.

```

## Requirements

For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).

## API Key Setup

Before you begin, you will need a Mistral AI API key.

1. Get your own Mistral API Key: 

2. Set your Mistral API Key as an environment variable. You only need to do this once.

```bash

# set Mistral API Key (using zsh for example)

$ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv

# reload the environment (or just quit and open a new terminal)

$ source ~/.zshenv

```

## SDK Example Usage

### Create Chat Completions

This example shows how to create chat completions.

```typescript

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({

  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",

      },

    ],

  });

  // Handle the result

  console.log(result);

}

run();

```

### Upload a file

This example shows how to upload a file.

```typescript

import { Mistral } from "@mistralai/mistralai";

import { openAsBlob } from "node:fs";

const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});

async function run() {

  const result = await mistral.files.upload({

    file: await openAsBlob("example.file"),

  });

  // Handle the result

  console.log(result);

}

run();

```

### Create Agents Completions

This example shows how to create agents completions.

```typescript

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({

  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: "",

  });

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

```

## Providers' SDKs

We have dedicated SDKs for the following providers:

- [GCP](/packages/mistralai-gcp/README.md)

- [Azure](/packages/mistralai-azure/README.md)

## Available Resources and Operations

Available methods

### [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

### [batch](docs/sdks/batch/README.md)

#### [batch.jobs](docs/sdks/mistraljobs/README.md)

* [list](docs/sdks/mistraljobs/README.md#list) - Get Batch Jobs

* [create](docs/sdks/mistraljobs/README.md#create) - Create Batch Job

* [get](docs/sdks/mistraljobs/README.md#get) - Get Batch Job

* [cancel](docs/sdks/mistraljobs/README.md#cancel) - Cancel Batch 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

### [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)

* [upload](docs/sdks/files/README.md#upload) - Upload File

* [list](docs/sdks/files/README.md#list) - List Files

* [retrieve](docs/sdks/files/README.md#retrieve) - Retrieve File

* [delete](docs/sdks/files/README.md#delete) - Delete File

* [download](docs/sdks/files/README.md#download) - Download 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)

* [list](docs/sdks/jobs/README.md#list) - Get Fine Tuning Jobs

* [create](docs/sdks/jobs/README.md#create) - Create Fine Tuning Job

* [get](docs/sdks/jobs/README.md#get) - Get Fine Tuning Job

* [cancel](docs/sdks/jobs/README.md#cancel) - Cancel Fine Tuning Job

* [start](docs/sdks/jobs/README.md#start) - Start Fine Tuning Job

### [models](docs/sdks/models/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

## Server-sent event streaming

[Server-sent events][mdn-sse] are used to stream content from certain

operations. These operations will expose the stream as an async iterable that

can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will

terminate when the server no longer has any events to send and closes the

underlying connection.

```typescript

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({

  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

    console.log(event);

  }

}

run();

```

[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events

[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

## File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP]

>

> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

>

> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).

> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.

> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `` element.

> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).

```typescript

import { Mistral } from "@mistralai/mistralai";

import { openAsBlob } from "node:fs";

const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});

async function run() {

  const result = await mistral.files.upload({

    file: await openAsBlob("example.file"),

  });

  // Handle the result

  console.log(result);

}

run();

```

## Retries

Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

```typescript

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({

  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,

    },

  });

  // Handle the result

  console.log(result);

}

run();

```

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

```typescript

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({

  retryConfig: {

    strategy: "backoff",

    backoff: {

      initialInterval: 1,

      maxInterval: 50,

      exponent: 1.1,

      maxElapsedTime: 100,

    },

    retryConnectionErrors: false,

  },

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});

async function run() {

  const result = await mistral.models.list();

  // Handle the result

  console.log(result);

}

run();

```

## Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.

If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:

| 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 {

  HTTPValidationError,

  SDKValidationError,

} 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();

    // 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.

## Server Selection

### Select Server by Name

You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

| Name | Server                   |

| ---- | ------------------------ |

| `eu` | `https://api.mistral.ai` |

#### Example

```typescript

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({

  server: "eu",

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});

async function run() {

  const result = await mistral.models.list();

  // Handle the result

  console.log(result);

}

run();

```

### Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:

```typescript

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({

  serverURL: "https://api.mistral.ai",

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});

async function run() {

  const result = await mistral.models.list();

  // Handle the result

  console.log(result);

}

run();

```

## Custom HTTP Client

The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native

[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This

client is a thin wrapper around `fetch` and provides the ability to attach hooks

around the request lifecycle that can be used to modify the request or handle

errors and response.

The `HTTPClient` constructor takes an optional `fetcher` argument that can be

used to integrate a third-party HTTP client or when writing tests to mock out

the HTTP client and feed in fixtures.

The following example shows how to use the `"beforeRequest"` hook to to add a

custom header and a timeout to requests and how to use the `"requestError"` hook

to log errors:

```typescript

import { Mistral } from "@mistralai/mistralai";

import { HTTPClient } from "@mistralai/mistralai/lib/http";

const httpClient = new HTTPClient({

  // fetcher takes a function that has the same signature as native `fetch`.

  fetcher: (request) => {

    return fetch(request);

  }

});

httpClient.addHook("beforeRequest", (request) => {

  const nextRequest = new Request(request, {

    signal: request.signal || AbortSignal.timeout(5000)

  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;

});

httpClient.addHook("requestError", (error, request) => {

  console.group("Request Error");

  console.log("Reason:", `${error}`);

  console.log("Endpoint:", `${request.method} ${request.url}`);

  console.groupEnd();

});

const sdk = new Mistral({ httpClient });

```

## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name     | Type | Scheme      | Environment Variable |

| -------- | ---- | ----------- | -------------------- |

| `apiKey` | http | HTTP Bearer | `MISTRAL_API_KEY`    |

To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:

```typescript

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});

async function run() {

  const result = await mistral.models.list();

  // Handle the result

  console.log(result);

}

run();

```

## Providers Support

We also provide provider specific SDK for:

- [GCP](packages/mistralai-gcp/README.md)

- [Azure](packages/mistralai-azure/README.md)

## Standalone functions

All the methods listed above are available as standalone functions. These

functions are ideal for use in applications running in the browser, serverless

runtimes or other environments where application bundle size is a primary

concern. When using a bundler to build your application, all unused

functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).

Available standalone functions

- [`agentsComplete`](docs/sdks/agents/README.md#complete) - Agents Completion

- [`agentsStream`](docs/sdks/agents/README.md#stream) - Stream Agents completion

- [`batchJobsCancel`](docs/sdks/mistraljobs/README.md#cancel) - Cancel Batch Job

- [`batchJobsCreate`](docs/sdks/mistraljobs/README.md#create) - Create Batch Job

- [`batchJobsGet`](docs/sdks/mistraljobs/README.md#get) - Get Batch Job

- [`batchJobsList`](docs/sdks/mistraljobs/README.md#list) - Get Batch Jobs

- [`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

- [`filesDownload`](docs/sdks/files/README.md#download) - Download 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

## Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches `console`'s interface as an SDK option.

> [!WARNING]

> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

```typescript

import { Mistral } from "@mistralai/mistralai";

const sdk = new Mistral({ debugLogger: console });

```

You can also enable a default debug logger by setting an environment variable `MISTRAL_DEBUG` to true.

# Development

## Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 

We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.