feat: add support for mistral

.env

@@ -6,6 +6,9 @@ OPENAI_API_KEY=
 # For using Claude on Anthropic
 ANTHROPIC_API_KEY=
 
+# For using Mistral
+MISTRAL_API_KEY=
+
 # For using Voyage
 VOYAGE_API_KEY=
 

README.md

@@ -68,9 +68,11 @@ $embeddings = new Embeddings();
   * [Google's Gemini](https://gemini.google.com/) with [Google](https://ai.google.dev/) and [OpenRouter](https://www.openrouter.com/) as Platform
   * [DeepSeek's R1](https://www.deepseek.com/) with [OpenRouter](https://www.openrouter.com/) as Platform
   * [Amazon's Nova](https://nova.amazon.com) with [AWS](https://aws.amazon.com/bedrock/) as Platform
+  * [Mistral's Mistral](https://www.mistral.ai/) with [Mistral](https://www.mistral.ai/) as Platform
 * Embeddings Models
   * [OpenAI's Text Embeddings](https://platform.openai.com/docs/guides/embeddings/embedding-models) with [OpenAI](https://platform.openai.com/docs/overview) and [Azure](https://learn.microsoft.com/azure/ai-services/openai/concepts/models) as Platform
   * [Voyage's Embeddings](https://docs.voyageai.com/docs/embeddings) with [Voyage](https://www.voyageai.com/) as Platform
+  * [Mistral Embed](https://www.mistral.ai/) with [Mistral](https://www.mistral.ai/) as Platform
 * Other Models
   * [OpenAI's Dall·E](https://platform.openai.com/docs/guides/image-generation) with [OpenAI](https://platform.openai.com/docs/overview) as Platform
   * [OpenAI's Whisper](https://platform.openai.com/docs/guides/speech-to-text) with [OpenAI](https://platform.openai.com/docs/overview) and [Azure](https://learn.microsoft.com/azure/ai-services/openai/concepts/models) as Platform
@@ -137,6 +139,7 @@ $response = $chain->call($messages, [
 1. [Meta's Llama with Replicate](examples/replicate/chat-llama.php)
 1. [Google's Gemini with Google](examples/google/chat.php)
 1. [Google's Gemini with OpenRouter](examples/openrouter/chat-gemini.php)
+1. [Mistral's Mistral with Mistral](examples/mistral/chat-mistral.php)
 
 ### Tools
 
@@ -409,7 +412,7 @@ use PhpLlm\LlmChain\Platform\Message\MessageBag;
 
 // Initialize Platform & Models
 
-$similaritySearch = new SimilaritySearch($embeddings, $store);
+$similaritySearch = new SimilaritySearch($model, $store);
 $toolbox = Toolbox::create($similaritySearch);
 $processor = new Chain($toolbox);
 $chain = new Chain($platform, $model, [$processor], [$processor]);
@@ -547,6 +550,7 @@ needs to be used.
 
 1. [Streaming Claude](examples/anthropic/stream.php)
 1. [Streaming GPT](examples/openai/stream.php)
+1. [Streaming Mistral](examples/mistral/stream.php)
 
 ### Image Processing
 
@@ -623,6 +627,7 @@ dump($vectors[0]->getData()); // Array of float values
 
 1. [OpenAI's Emebddings](examples/openai/embeddings.php)
 1. [Voyage's Embeddings](examples/voyage/embeddings.php)
+1. [Mistral's Embed](examples/mistral/embeddings.php)
 
 ### Parallel Platform Calls
 

examples/mistral/chat.php

@@ -0,0 +1,27 @@
+<?php
+
+use PhpLlm\LlmChain\Chain\Chain;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\Mistral;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\PlatformFactory;
+use PhpLlm\LlmChain\Platform\Message\Message;
+use PhpLlm\LlmChain\Platform\Message\MessageBag;
+use Symfony\Component\Dotenv\Dotenv;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['MISTRAL_API_KEY'])) {
+    echo 'Please set the REPLICATE_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['MISTRAL_API_KEY']);
+$model = new Mistral();
+$chain = new Chain($platform, $model);
+
+$messages = new MessageBag(Message::ofUser('What is the best French cheese?'));
+$response = $chain->call($messages, [
+    'temperature' => 0.7,
+]);
+
+echo $response->getContent().\PHP_EOL;

examples/mistral/embeddings.php

@@ -0,0 +1,28 @@
+<?php
+
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\Embeddings;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\PlatformFactory;
+use PhpLlm\LlmChain\Platform\Response\VectorResponse;
+use Symfony\Component\Dotenv\Dotenv;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['MISTRAL_API_KEY'])) {
+    echo 'Please set the MISTRAL_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['MISTRAL_API_KEY']);
+$model = new Embeddings();
+
+$response = $platform->request($model, <<<TEXT
+    In the middle of the 20th century, food scientists began to understand the importance of vitamins and minerals in
+    human health. They discovered that certain nutrients were essential for growth, development, and overall well-being.
+    This led to the fortification of foods with vitamins and minerals, such as adding vitamin D to milk and iodine to
+    salt. The goal was to prevent deficiencies and promote better health in the population.
+    TEXT);
+
+assert($response instanceof VectorResponse);
+
+echo 'Dimensions: '.$response->getContent()[0]->getDimensions().\PHP_EOL;

examples/mistral/image.php

@@ -0,0 +1,32 @@
+<?php
+
+use PhpLlm\LlmChain\Chain\Chain;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\Mistral;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\PlatformFactory;
+use PhpLlm\LlmChain\Platform\Message\Content\Image;
+use PhpLlm\LlmChain\Platform\Message\Message;
+use PhpLlm\LlmChain\Platform\Message\MessageBag;
+use Symfony\Component\Dotenv\Dotenv;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['OPENAI_API_KEY'])) {
+    echo 'Please set the OPENAI_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['MISTRAL_API_KEY']);
+$model = new Mistral(Mistral::MISTRAL_SMALL);
+$chain = new Chain($platform, $model);
+
+$messages = new MessageBag(
+    Message::forSystem('You are an image analyzer bot that helps identify the content of images.'),
+    Message::ofUser(
+        'Describe the image as a comedian would do it.',
+        Image::fromFile(dirname(__DIR__, 2).'/tests/Fixture/image.jpg'),
+    ),
+);
+$response = $chain->call($messages);
+
+echo $response->getContent().\PHP_EOL;

examples/mistral/stream.php

@@ -0,0 +1,30 @@
+<?php
+
+use PhpLlm\LlmChain\Chain\Chain;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\Mistral;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\PlatformFactory;
+use PhpLlm\LlmChain\Platform\Message\Message;
+use PhpLlm\LlmChain\Platform\Message\MessageBag;
+use Symfony\Component\Dotenv\Dotenv;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['MISTRAL_API_KEY'])) {
+    echo 'Please set the REPLICATE_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['MISTRAL_API_KEY']);
+$model = new Mistral();
+$chain = new Chain($platform, $model);
+
+$messages = new MessageBag(Message::ofUser('What is the eighth prime number?'));
+$response = $chain->call($messages, [
+    'stream' => true,
+]);
+
+foreach ($response->getContent() as $word) {
+    echo $word;
+}
+echo \PHP_EOL;

examples/mistral/structured-output-math.php

@@ -0,0 +1,36 @@
+<?php
+
+use PhpLlm\LlmChain\Chain\Chain;
+use PhpLlm\LlmChain\Chain\StructuredOutput\ChainProcessor;
+use PhpLlm\LlmChain\Chain\StructuredOutput\ResponseFormatFactory;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\Mistral;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\PlatformFactory;
+use PhpLlm\LlmChain\Platform\Message\Message;
+use PhpLlm\LlmChain\Platform\Message\MessageBag;
+use PhpLlm\LlmChain\Tests\Fixture\StructuredOutput\MathReasoning;
+use Symfony\Component\Dotenv\Dotenv;
+use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+use Symfony\Component\Serializer\Serializer;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['MISTRAL_API_KEY'])) {
+    echo 'Please set the MISTRAL_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['MISTRAL_API_KEY']);
+$model = new Mistral(Mistral::MISTRAL_SMALL);
+$serializer = new Serializer([new ObjectNormalizer()], [new JsonEncoder()]);
+
+$processor = new ChainProcessor(new ResponseFormatFactory(), $serializer);
+$chain = new Chain($platform, $model, [$processor], [$processor]);
+$messages = new MessageBag(
+    Message::forSystem('You are a helpful math tutor. Guide the user through the solution step by step.'),
+    Message::ofUser('how can I solve 8x + 7 = -23'),
+);
+$response = $chain->call($messages, ['output_structure' => MathReasoning::class]);
+
+dump($response->getContent());

examples/mistral/toolcall-stream.php

@@ -0,0 +1,38 @@
+<?php
+
+use PhpLlm\LlmChain\Chain\Chain;
+use PhpLlm\LlmChain\Chain\Toolbox\ChainProcessor;
+use PhpLlm\LlmChain\Chain\Toolbox\Tool\YouTubeTranscriber;
+use PhpLlm\LlmChain\Chain\Toolbox\Toolbox;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\Mistral;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\PlatformFactory;
+use PhpLlm\LlmChain\Platform\Message\Message;
+use PhpLlm\LlmChain\Platform\Message\MessageBag;
+use Symfony\Component\Dotenv\Dotenv;
+use Symfony\Component\HttpClient\HttpClient;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['MISTRAL_API_KEY'])) {
+    echo 'Please set the REPLICATE_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['MISTRAL_API_KEY']);
+$model = new Mistral();
+
+$transcriber = new YouTubeTranscriber(HttpClient::create());
+$toolbox = Toolbox::create($transcriber);
+$processor = new ChainProcessor($toolbox);
+$chain = new Chain($platform, $model, [$processor], [$processor]);
+
+$messages = new MessageBag(Message::ofUser('Please summarize this video for me: https://www.youtube.com/watch?v=6uXW-ulpj0s'));
+$response = $chain->call($messages, [
+    'stream' => true,
+]);
+
+foreach ($response->getContent() as $word) {
+    echo $word;
+}
+echo \PHP_EOL;

examples/mistral/toolcall.php

@@ -0,0 +1,31 @@
+<?php
+
+use PhpLlm\LlmChain\Chain\Chain;
+use PhpLlm\LlmChain\Chain\Toolbox\ChainProcessor;
+use PhpLlm\LlmChain\Chain\Toolbox\Tool\Clock;
+use PhpLlm\LlmChain\Chain\Toolbox\Toolbox;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\Mistral;
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\PlatformFactory;
+use PhpLlm\LlmChain\Platform\Message\Message;
+use PhpLlm\LlmChain\Platform\Message\MessageBag;
+use Symfony\Component\Dotenv\Dotenv;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['MISTRAL_API_KEY'])) {
+    echo 'Please set the REPLICATE_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['MISTRAL_API_KEY']);
+$model = new Mistral();
+
+$toolbox = Toolbox::create(new Clock());
+$processor = new ChainProcessor($toolbox);
+$chain = new Chain($platform, $model, [$processor], [$processor]);
+
+$messages = new MessageBag(Message::ofUser('What time is it?'));
+$response = $chain->call($messages);
+
+echo $response->getContent().\PHP_EOL;

src/Platform/Bridge/Mistral/Contract/ToolNormalizer.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace PhpLlm\LlmChain\Platform\Bridge\Mistral\Contract;
+
+use PhpLlm\LlmChain\Platform\Contract\Normalizer\ToolNormalizer as BaseToolNormalizer;
+
+class ToolNormalizer extends BaseToolNormalizer
+{
+    public function normalize(mixed $data, ?string $format = null, array $context = []): array
+    {
+        $array = parent::normalize($data, $format, $context);
+
+        $array['function']['parameters'] ??= ['type' => 'object'];
+
+        return $array;
+    }
+}

src/Platform/Bridge/Mistral/Embeddings.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Platform\Bridge\Mistral;
+
+use PhpLlm\LlmChain\Platform\Capability;
+use PhpLlm\LlmChain\Platform\Model;
+
+final class Embeddings extends Model
+{
+    public const MISTRAL_EMBED = 'mistral-embed';
+
+    /**
+     * @param array<string, mixed> $options
+     */
+    public function __construct(
+        string $name = self::MISTRAL_EMBED,
+        array $options = [],
+    ) {
+        parent::__construct($name, [Capability::INPUT_MULTIPLE], $options);
+    }
+}

src/Platform/Bridge/Mistral/Embeddings/ModelClient.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Platform\Bridge\Mistral\Embeddings;
+
+use PhpLlm\LlmChain\Platform\Bridge\Mistral\Embeddings;
+use PhpLlm\LlmChain\Platform\Model;
+use PhpLlm\LlmChain\Platform\ModelClientInterface;
+use Symfony\Component\HttpClient\EventSourceHttpClient;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+final readonly class ModelClient implements ModelClientInterface
+{
+    private EventSourceHttpClient $httpClient;
+
+    public function __construct(
+        HttpClientInterface $httpClient,
+        #[\SensitiveParameter]
+        private string $apiKey,
+    ) {
+        $this->httpClient = $httpClient instanceof EventSourceHttpClient ? $httpClient : new EventSourceHttpClient($httpClient);
+    }
+
+    public function supports(Model $model): bool
+    {
+        return $model instanceof Embeddings;
+    }
+
+    public function request(Model $model, array|string $payload, array $options = []): ResponseInterface
+    {
+        return $this->httpClient->request('POST', 'https://api.mistral.ai/v1/embeddings', [
+            'auth_bearer' => $this->apiKey,
+            'headers' => [
+                'Content-Type' => 'application/json',
+            ],
+            'json' => array_merge($options, [
+                'model' => $model->getName(),
+                'input' => $payload,
+            ]),
+        ]);
+    }
+}