Mistral Typescript Client

This repository is the typescript version of mistralai/client-js

You can use the Mistral JavaScript/Typescript client to interact with the Mistral AI API.

Installing

You can install the library in your project using:

npm install @mistralai/mistralai

Usage

You can watch a free course on using the Mistral JavaScript client here.

$3

``typescript
import MistralClient from '@mistralai/mistralai';

const apiKey = process.env.MISTRAL_API_KEY || 'your_api_key';

const client = new MistralClient(apiKey);
`

$3

`typescript
const listModelsResponse = await client.listModels();
const listModels = listModelsResponse.data;
listModels.forEach((model) => {
console.log('Model:', model);
});
`

$3

`typescript
const chatStreamResponse = await client.chatStream({
model: 'mistral-tiny',
messages: [{role: 'user', content: 'What is the best French cheese?'}],
});

console.log('Chat Stream:');
for await (const chunk of chatStreamResponse) {
if (chunk.choices[0].delta.content !== undefined) {
const streamText = chunk.choices[0].delta.content;
process.stdout.write(streamText);
}
}
`

$3

`typescript
const chatResponse = await client.chat({
model: 'mistral-tiny',
messages: [{role: 'user', content: 'What is the best French cheese?'}],
});

console.log('Chat:', chatResponse.choices[0].message.content);
`

$3

`typescript
const input = [];
for (let i = 0; i < 1; i++) {
input.push('What is the best French cheese?');
}

const embeddingsBatchResponse = await client.embeddings({
model: 'mistral-embed',
input: input,
});

console.log('Embeddings Batch:', embeddingsBatchResponse.data);
`

$3

`typescript
// Create a new file
const file = fs.readFileSync('file.jsonl');
const createdFile = await client.files.create({ file });

// List files
const files = await client.files.list();

// Retrieve a file
const retrievedFile = await client.files.retrieve({ fileId: createdFile.id });

// Delete a file
const deletedFile = await client.files.delete({ fileId: createdFile.id });
`

$3

`typescript
// Create a new job
const createdJob = await client.jobs.create({
model: 'open-mistral-7B',
trainingFiles: [trainingFile.id],
validationFiles: [validationFile.id],
hyperparameters: {
trainingSteps: 10,
learningRate: 0.0001,
},
});

// List jobs
const jobs = await client.jobs.list();

// Retrieve a job
const retrievedJob = await client.jobs.retrieve({ jobId: createdJob.id });

// Cancel a job
const canceledJob = await client.jobs.cancel({ jobId: createdJob.id });
`

Run examples

You can run the examples in the examples directory by installing them locally:

`bash
cd examples
npm install .
`

$3

Running the examples requires a Mistral AI API key.

Get your own Mistral API Key:

$3

`bash
MISTRAL_API_KEY='your_api_key' node chat_with_streaming.js
`

$3

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_api_key]' >> ~/.zshenv

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

$ source ~/.zshenv
`

You can then run the examples without appending the API key:

`bash
node chat_with_streaming.js
`
After the env variable setup the client will find the MISTRAL_API_KEY by itself

`typescript
import MistralClient from '@mistralai/mistralai';

const client = new MistralClient();
``

ChangeLog

- 20240705---sync the progress from the last PR
- 20240506---init the project from offical js version