Skip to content

Latest commit

 

History

History
447 lines (345 loc) · 12.5 KB

README.md

File metadata and controls

447 lines (345 loc) · 12.5 KB

Mistral on Azure Typescript Client

SDK Installation

NPM

npm add @mistralai/mistralai-azure

PNPM

pnpm add @mistralai/mistralai-azure

Bun

bun add @mistralai/mistralai-azure

Yarn

yarn add @mistralai/mistralai-azure 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.

SDK Example Usage

Create Chat Completions

This example shows how to create chat completions.

import { MistralAzure } from "@mistralai/mistralai-azure";

const mistralAzure = new MistralAzure({
    apiKey: process.env.["AZURE_API_KEY"],
    endpoint: process.env.["AZURE_ENDPOINT"],
});

async function run() {
    const result = await mistralAzure.chat.complete({
        model: "azureai",
        messages: [
            {
                content: "Who is the best French painter? Answer in one short sentence.",
                role: "user",
            },
        ],
    });

    // Handle the result
    console.log(result);
}

run();

Available Resources and Operations

chat

Server-sent event streaming

Server-sent events 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 loop. The loop will terminate when the server no longer has any events to send and closes the underlying connection.

import { MistralAzure } from "@mistralai/mistralai-azure";

const mistralAzure = new MistralAzure({
    apiKey: process.env.["AZURE_API_KEY"],
    endpoint: process.env.["AZURE_ENDPOINT"],
});

async function run() {
    const result = await mistralAzure.chat.stream({
        model: "azureai",
        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();

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:

import { MistralAzure } from "@mistralai/mistralai-azure";

const mistralAzure = new MistralAzure({
    apiKey: process.env.["AZURE_API_KEY"],
    endpoint: process.env.["AZURE_ENDPOINT"],
});

async function run() {
    const result = await mistralAzure.chat.stream(
        {
            model: "azureai",
            messages: [
                {
                    content: "Who is the best French painter? Answer in one short sentence.",
                    role: "user",
                },
            ],
        },
        {
            retries: {
                strategy: "backoff",
                backoff: {
                    initialInterval: 1,
                    maxInterval: 50,
                    exponent: 1.1,
                    maxElapsedTime: 100,
                },
                retryConnectionErrors: false,
            },
        }
    );

    for await (const event of result) {
        // Handle the event
    }
}

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:

import { MistralAzure } from "@mistralai/mistralai-azure";

const mistralAzure = new MistralAzure({
    retryConfig: {
        strategy: "backoff",
        backoff: {
            initialInterval: 1,
            maxInterval: 50,
            exponent: 1.1,
            maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
    },
    apiKey: process.env.["AZURE_API_KEY"],
    endpoint: process.env.["AZURE_ENDPOINT"],
});

async function run() {
    const result = await mistralAzure.chat.stream({
        model: "azureai",
        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();

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.

import { MistralAzure } from "@mistralai/mistralai-azure";
import { SDKValidationError } from "@mistralai/mistralai-azure/models/errors";

const mistralAzure = new MistralAzure({
    apiKey: process.env.["AZURE_API_KEY"],
    endpoint: process.env.["AZURE_ENDPOINT"],
});

async function run() {
    let result;
    try {
        result = await mistralAzure.chat.complete({
            model: "azureai",
            messages: [
                {
                    content: "Who is the best French painter? Answer in one short sentence.",
                    role: "user",
                },
            ],
        });
    } 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();

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 
import { MistralAzure } from "@mistralai/mistralai-azure";

const mistralAzure = new MistralAzure({
    server: "prod",
    apiKey: process.env.["AZURE_API_KEY"],
    endpoint: process.env.["AZURE_ENDPOINT"],
});

async function run() {
    const result = await mistralAzure.chat.stream({
        model: "azureai",
        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();

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:

import { MistralAzure } from "@mistralai/mistralai-azure";

const mistralAzure = new MistralAzure({
    serverURL: "https://api.mistral.ai",
    apiKey: process.env.["AZURE_API_KEY"],
    endpoint: process.env.["AZURE_ENDPOINT"],
});

async function run() {
    const result = await mistralAzure.chat.stream({
        model: "azureai",
        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();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native 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:

import { MistralAzure } from "@mistralai/mistralai-azure";
import { HTTPClient } from "@mistralai/mistralai-azure/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 MistralAzure({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
apiKey http HTTP Bearer

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

import { MistralAzure } from "@mistralai/mistralai-azure";

const mistralAzure = new MistralAzure({
    apiKey: process.env.["AZURE_API_KEY"],
    endpoint: process.env.["AZURE_ENDPOINT"],
});

async function run() {
    const result = await mistralAzure.chat.stream({
        model: "azureai",
        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();

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.