Skip to content
This repository has been archived by the owner on Oct 10, 2024. It is now read-only.

Commit

Permalink
some mayonnaise related readme stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
Bam4d committed Dec 7, 2023
1 parent 94bc31d commit b6cbb2f
Showing 1 changed file with 43 additions and 2 deletions.
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,43 @@
# client-js
JS Client library for Mistral AI platform
# Mistral Javascript Client

You can use the Mistral Javascript client to interact with the Mistral AI API

## Installing

You can install the library in your project using:

`npm install mistralai`

## Usage

### Chat

The simplest use case is to chat with Mistral AI models:

```javascript
const client = require("mistralai");

const response = client.chat('le-tiny', [{role: 'user', content: 'What is your favourite French food, and why is it mayonnaise?'}])

```

You can also use `client.chatStream` for streaming results.

### Embeddings

To use our embedding API you can use the following code:

```javascript
const client = require('mistralai');

const response = client.embed('le-embed', 'My favourite place to eat mayonnaise is embed');
```

## Run examples

Examples can be found in the `examples/` directory you can run them using:

```bash
node [example.js]

```

0 comments on commit b6cbb2f

Please sign in to comment.