helgesverre / mistral
Laravel Client for the Mistral.ai API
Installs: 2 764
Dependents: 0
Suggesters: 0
Security: 0
Stars: 34
Watchers: 2
Forks: 1
Open Issues: 1
Requires
- php: ^8.2
- saloonphp/laravel-plugin: ^v3.5
- spatie/laravel-data: ^3|^4
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- larastan/larastan: ^2.0.1
- laravel/pint: ^1.0
- nunomaduro/collision: ^7|^8
- orchestra/testbench: ^8.0|^9.0
- pestphp/pest: ^2.20
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
README
Laravel Client for Mistral.AI
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.
Installation
You can install the package via composer:
composer require helgesverre/mistral
You can publish the config file with:
php artisan vendor:publish --tag="mistral-config"
This is the contents of the published config file:
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.
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
// Models $response = $mistral->models()->list(); /** @var \HelgeSverre\Mistral\Dto\Embedding\EmbeddingResponse $dto */ $dto = $response->dto();
Embeddings
Resource
Create embedding
$response = $mistral->embedding()->create([ "A string here", "Another one here", ]); /** @var EmbeddingResponse $dto */ $dto = $response->dto();
Chat
Resource
Create Chat Completion
$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
$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
// 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
$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
// 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
- Embedding
- Models
- SimpleChat
- Misc
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.
Testing
cp .env.example .env
composer test
composer analyse src
License
The MIT License (MIT). Please see License File 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 for more information.