https://github.com/helgesverre/mistral
PHP Client for the Mistral.ai API
https://github.com/helgesverre/mistral
Last synced: 24 days ago
JSON representation
PHP Client for the Mistral.ai API
- Host: GitHub
- URL: https://github.com/helgesverre/mistral
- Owner: HelgeSverre
- License: mit
- Created: 2023-12-14T09:50:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-20T14:54:08.000Z (over 1 year ago)
- Last Synced: 2025-04-01T13:12:58.623Z (6 months ago)
- Language: PHP
- Homepage:
- Size: 123 KB
- Stars: 40
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Client for Mistral.AI
[](https://packagist.org/packages/helgesverre/mistral)
[](https://packagist.org/packages/helgesverre/mistral)
The Mistral.ai Laravel Client enables laravel applications to interact with the Mistral.ai API, providing
straightforward access to features like chat completions and text embeddings.
Get your API key at [console.mistral.ai](https://console.mistral.ai/).
## Installation
You can install the package via composer:
```bash
composer require helgesverre/mistral
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="mistral-config"
```
This is the contents of the published config file:
```php
return [
'api_key' => env('MISTRAL_API_KEY'),
'base_url' => env('MISTRAL_BASE_URL', 'https://api.mistral.ai'),
'timeout' => env('MISTRAL_TIMEOUT', 30),
];
```
## Usage
### Client Instantiation
Create an instance of the Mistral client to start interacting with the API. This instance will be your primary interface
for sending requests to Mistral.AI.
```php
use HelgeSverre\Mistral\Enums\Model;
use HelgeSverre\Mistral\Mistral;
// Instantiate the client
$mistral = new Mistral(apiKey: config('mistral.api_key'));
// Or use the Facade (Laravel)
Mistral::chat();
Mistral::simpleChat();
Mistral::embedding();
Mistral::models();
```
## Resources
### `Models` Resource
#### List available models
```php
// Models
$response = $mistral->models()->list();
/** @var \HelgeSverre\Mistral\Dto\Embedding\EmbeddingResponse $dto */
$dto = $response->dto();
```
### `Embeddings` Resource
#### Create embedding
```php
$response = $mistral->embedding()->create([
"A string here",
"Another one here",
]);
/** @var EmbeddingResponse $dto */
$dto = $response->dto();
```
### `Chat` Resource
#### Create Chat Completion
```php
$response = $mistral->chat()->create(
messages: [
[
"role" => "user",
"content" => "Write hello world in BASH",
]
],
model: Model::medium->value,
temperature: 0.4,
maxTokens: 100,
safeMode: false
);
/** @var ChatCompletionResponse $dto */
$dto = $response->dto();
```
#### Create Chat Completion with Function Calling
```php
$response = $this->mistral->chat()->create(
messages: [
[
'role' => Role::user->value,
'content' => 'What is the weather in Bergen, Norway?',
],
],
model: Model::large->value,
maxTokens: 1000,
tools: [
[
'type' => 'function',
'function' => [
'name' => 'searchWeather',
'description' => 'Get the weather for a location',
'parameters' => [
'type' => 'object',
'required' => [
'location',
],
'properties' => [
'location' => [
'type' => 'string',
'description' => 'The location to get the weather for.',
],
],
],
],
],
[
'type' => 'function',
'function' => [
'name' => 'sendWeatherNotification',
'description' => 'Send notification about weather to a user',
'parameters' => [
'type' => 'object',
'required' => [
'userId',
'message',
],
'properties' => [
'userId' => [
'type' => 'string',
'description' => 'the id of the user',
],
'message' => [
'type' => 'string',
'description' => 'the message to send the user',
],
],
],
],
],
],
toolChoice: 'any',
);
// Tool calls are returned in the response
$response->json('choices.0.message.tool_calls');
$response->json('choices.0.message.tool_calls.0.id');
$response->json('choices.0.message.tool_calls.0.type');
$response->json('choices.0.message.tool_calls.0.function');
$response->json('choices.0.message.tool_calls.0.function.name');
$response->json('choices.0.message.tool_calls.0.function.arguments');
// Or using the dto
/** @var ChatCompletionResponse $dto */
$dto = $response->dto();
$dto->choices; // array of ChatCompletionChoice
foreach ($dto->choices as $choice) {
$choice->message; // ChatCompletionMessage
foreach ($choice->message->toolCalls as $toolCall) {
$toolCall->id; // null
$toolCall->type; // function
$toolCall->function; // FunctionCall
$toolCall->function->name; // 'searchWeather'
$toolCall->function->arguments; // '{"location":"Bergen, Norway"}'
$toolCall->function->args(); // ['location' => 'Bergen, Norway']
}
}
```
#### Create Streamed Chat Completions
```php
// Returns a generator, which you can iterate over to get the streamed chunks
$stream = $this->mistral->chat()->createStreamed(
messages: [
[
'role' => 'user',
'content' => 'Make a markdown list of 10 common fruits'
],
],
model: Model::small->value,
);
foreach ($stream as $chunk) {
/** @var StreamedChatCompletionResponse $chunk */
echo $chunk->id; // 'cmpl-0339459d35cb441b9f111b94216cff97'
echo $chunk->model; // 'mistral-small'
echo $chunk->object; // 'chat.completion.chunk'
echo $chunk->created; // DateTime
foreach ($chunk->choices as $choice) {
$choice->index; // 0
$choice->delta->role; // 'assistant'
$choice->delta->content; // 'Fruit list...'
$choice->finishReason; // 'length'
}
}
```
### `SimpleChat` Resource
For convenience, the client also provides a simple chat completion method, which returns a simpler, condensed and
flattened DTO, which is useful for quick prototyping.
#### Create simple chat completions
```php
$response = $mistral->simpleChat()->create(
messages: [
[
"role" => "user",
"content" => "Hello world!",
],
],
model: Model::medium->value,
temperature: 0.4,
maxTokens: 1500,
safeMode: false
);
/** @var ChatCompletionResponse $response */
```
### `SimpleChat` Resource
For convenience, the client also provides a simple chat completion method, which returns a simpler, condensed, and
flattened DTO, useful for quick prototyping.
#### Create Streamed Simple Chat Completions
```php
// Returns a generator, which you can iterate over to get the streamed chunks
$response = $this->mistral->simpleChat()->stream(
messages: [
[
'role' => "user",
'content' => 'Say the word "banana"',
],
],
maxTokens: 100,
);
foreach ($response as $chunk) {
/** @var SimpleStreamChunk $chunk */
$chunk->id; // 'cmpl-716e95d336db4e51a04cbcf2b84d1a76'
$chunk->model; // 'mistral-medium'
$chunk->object; // 'chat.completion.chunk'
$chunk->created; // '2024-01-03 12:00:00'
$chunk->role; // 'assistant'
$chunk->content; // 'the text \n'
$chunk->finishReason; // 'length'
}
```
## List of DTOs
For convenience, here is a list of all the DTOs available in this package.
- Chat
- [Chat/ChatCompletionChoice.php](./src/Dto/Chat/ChatCompletionChoice.php)
- [Chat/ChatCompletionMessage.php](./src/Dto/Chat/ChatCompletionMessage.php)
- [Chat/ChatCompletionRequest.php](./src/Dto/Chat/ChatCompletionRequest.php)
- [Chat/ChatCompletionResponse.php](./src/Dto/Chat/ChatCompletionResponse.php)
- [Chat/StreamedChatCompletionChoice.php](./src/Dto/Chat/StreamedChatCompletionChoice.php)
- [Chat/StreamedChatCompletionDelta.php](./src/Dto/Chat/StreamedChatCompletionDelta.php)
- [Chat/StreamedChatCompletionResponse.php](./src/Dto/Chat/StreamedChatCompletionResponse.php)
- [Chat/FunctionCall.php](./src/Dto/Chat/FunctionCall.php)
- [Chat/ToolCalls.php](./src/Dto/Chat/ToolCalls.php)
- Embedding
- [Embedding/Embedding.php](./src/Dto/Embedding/Embedding.php)
- [Embedding/EmbeddingRequest.php](./src/Dto/Embedding/EmbeddingRequest.php)
- [Embedding/EmbeddingResponse.php](./src/Dto/Embedding/EmbeddingResponse.php)
- Models
- [Models/Model.php](./src/Dto/Models/Model.php)
- [Models/ModelList.php](./src/Dto/Models/ModelList.php)
- [Models/ModelPermission.php](./src/Dto/Models/ModelPermission.php)
- SimpleChat
- [SimpleChat/SimpleChatResponse.php](./src/Dto/SimpleChat/SimpleChatResponse.php)
- [SimpleChat/SimpleStreamChunk.php](./src/Dto/SimpleChat/SimpleStreamChunk.php)
- Misc
- [Usage.php](./src/Dto/Usage.php)
## List of available Mistral models
The following models are available in the Mistral API. You can use the `Model` enum in this package to refer to them, or
use the string value directly.
| Enum Case | String Value | Documentation Link |
|---------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `Model::large->value` | `'mistral-large-latest'` | [Mistral Large Docs](https://docs.mistral.ai/guides/model-selection/#mistral-large-complex-tasks-that-require-large-reasoning-capabilities-or-are-highly-specialized) |
| `Model::medium->value` | `'mistral-medium-latest'` | [Mistral Medium Docs](https://docs.mistral.ai/guides/model-selection/#mistral-medium-intermediate-tasks-that-require-language-transformation) |
| `Model::small->value` | `'mistral-small-latest'` | [Mistral Small Docs](https://docs.mistral.ai/guides/model-selection/#mistral-small-simple-tasks-that-one-can-do-in-bulk) |
| `Model::mixtral->value` | `'open-mixtral-8x7b'` | [Mistral Mixtral-8x7b Docs](https://docs.mistral.ai/models/#mistral-7b) |
| `Model::mistral7b->value` | `'open-mistral-7b'` | [Mistral Mistral-7b Docs](https://docs.mistral.ai/models/#mixtral-8x7b) |
| `Model::embed->value` | `'mistral-embed'` | [Mistral Embed Docs](https://docs.mistral.ai/platform/endpoints/#embedding-models) |
## Testing
```bash
cp .env.example .env
composer test
composer analyse src
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Disclaimer
Mistral and the Mistral logo are trademarks of Mistral.ai. This package is not affiliated with, endorsed by, or
sponsored by Mistral.ai. All trademarks and registered trademarks are the property of their respective owners.
See [Mistral.AI](https://mistral.ai/terms-of-use/) for more information.