@mistralai/mistralai 1.0.0 → 1.0.1

package/.devcontainer/README.md

@@ -0,0 +1,35 @@
+
+<div align="center">
+    <a href="https://codespaces.new/mistralai/client-ts.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
+</div>
+<br>
+
+> **Remember to shutdown a GitHub Codespace when it is not in use!**
+
+# Dev Containers Quick Start
+
+The default location for usage snippets is the `samples` directory.
+
+## Running a Usage Sample
+
+A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
+
+```
+ts-node root.ts
+```
+
+## Generating Additional Usage Samples
+
+The speakeasy CLI allows you to generate more usage snippets. Here's how:
+
+- To generate a sample for a specific operation by providing an operation ID, use:
+
+```
+speakeasy generate usage -s registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi -l typescript -i {INPUT_OPERATION_ID} -o ./samples
+```
+
+- To generate samples for an entire namespace (like a tag or group name), use:
+
+```
+speakeasy generate usage -s registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi -l typescript -n {INPUT_TAG_NAME} -o ./samples
+```

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2024 Mistral AI
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,43 +1,543 @@
-# Mistral Javascript Client
+# Mistral Typescript Client
 
-You can use the Mistral Javascript client to interact with the Mistral AI API
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
 
-## Installing
+### NPM
 
-You can install the library in your project using:
+```bash
+npm add @mistralai/mistralai
+```
 
-`npm install mistralai`
+### PNPM
 
-## Usage
+```bash
+pnpm add @mistralai/mistralai
+```
 
-### Chat
+### Bun
 
-The simplest use case is to chat with Mistral AI models:
+```bash
+bun add @mistralai/mistralai
+```
 
-```javascript
-const client = require("mistralai");
+### Yarn
 
-const response = client.chat('le-tiny', [{role: 'user', content: 'What is your favourite French food, and why is it mayonnaise?'}])
+```bash
+yarn add @mistralai/mistralai zod
 
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
 ```
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
 
-You can also use `client.chatStream` for streaming results.
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
 
-### Embeddings
+## API Key Setup
 
-To use our embedding API you can use the following code:
+Before you begin, you will need a Mistral AI API key.
 
-```javascript
-const client = require('mistralai');
+1. Get your own Mistral API Key: <https://docs.mistral.ai/#api-access>
+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
 
-const response = client.embed('le-embed', 'My favourite place to eat mayonnaise is embed');
+# reload the environment (or just quit and open a new terminal)
+$ source ~/.zshenv
 ```
 
-## Run examples
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
 
-Examples can be found in the `examples/` directory you can run them using:
+### Create Chat Completions
 
-```bash
-node [example.js]
+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("./sample-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: "<value>",
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+## Providers' SDKs
+
+We have dedicated SDKs for the following providers:
+
+- [GCP](/packages/mistralai-gcp/README.md)
+- [Azure](/packages/mistralai-azure/README.md)
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+### [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
+
+### [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
+
+
+### [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
+
+### [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
+
+### [embeddings](docs/sdks/embeddings/README.md)
+
+* [create](docs/sdks/embeddings/README.md#create) - Embeddings
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Server-sent event streaming [eventstream] -->
+## 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
+    }
+}
+
+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
+<!-- End Server-sent event streaming [eventstream] -->
+
+<!-- Start File uploads [file-upload] -->
+## 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 `<input type="file">` 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("./sample-file"),
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End File uploads [file-upload] -->
+
+<!-- Start Retries [retries] -->
+## 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();
+
+```
+<!-- End Retries [retries] -->
+
+<!-- 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.
+
+| Error Object               | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4xx-5xx                    | */*                        |
+
+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. 
+
+
+```typescript
+import { Mistral } from "@mistralai/mistralai";
+import { 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();
+    } 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;
+            }
+        }
+    }
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End Error Handling [errors] -->
+
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+### Select Server by Name
+
+You can override the default server globally by passing a server name to the `server` 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 | Variables |
+| ----- | ------ | --------- |
+| `prod` | `https://api.mistral.ai` | None |
+
+```typescript
+import { Mistral } from "@mistralai/mistralai";
+
+const mistral = new Mistral({
+    server: "prod",
+    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` 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();
+
+```
+<!-- End Server Selection [server] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## 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 });
+```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Authentication [security] -->
+## 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 `nullT` 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();
+
+```
+<!-- End Authentication [security] -->
+
+## Providers Support
+
+We also provide provider specific SDK for:
+
+- [GCP](packages/mistralai-gcp/README.md)
+- [Azure](packages/mistralai-azure/README.md)
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# 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. 
+

package/core.d.ts

@@ -0,0 +1,10 @@
+import { ClientSDK } from "./lib/sdks.js";
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export declare class MistralCore extends ClientSDK {
+}
+//# sourceMappingURL=core.d.ts.map

package/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,WAAY,SAAQ,SAAS;CAAG"}

package/core.js

@@ -0,0 +1,17 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MistralCore = void 0;
+const sdks_js_1 = require("./lib/sdks.js");
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+class MistralCore extends sdks_js_1.ClientSDK {
+}
+exports.MistralCore = MistralCore;
+//# sourceMappingURL=core.js.map

package/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,MAAa,WAAY,SAAQ,mBAAS;CAAG;AAA7C,kCAA6C"}