feature #234 [Platform] Add Ollama embeddings (Guikingone)

This PR was squashed before being merged into the main branch.

Discussion
----------

[Platform] Add Ollama embeddings

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Docs?         | yes
| Issues        | None
| License       | MIT

Hi 👋🏻

This PR aims to add the support for embeddings via `Ollama`, the platform is updated to handle the new embedding client.

Commits
-------

005ef2f [Platform] Add Ollama embeddings

Author: chr-hertel

examples/ollama/embeddings.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\AI\Platform\Bridge\Ollama\Ollama;
+use Symfony\AI\Platform\Bridge\Ollama\PlatformFactory;
+
+require_once dirname(__DIR__).'/bootstrap.php';
+
+$platform = PlatformFactory::create(env('OLLAMA_HOST_URL'), http_client());
+
+$response = $platform->invoke(new Ollama(Ollama::NOMIC_EMBED_TEXT), <<<TEXT
+    Once upon a time, there was a country called Japan. It was a beautiful country with a lot of mountains and rivers.
+    The people of Japan were very kind and hardworking. They loved their country very much and took care of it. The
+    country was very peaceful and prosperous. The people lived happily ever after.
+    TEXT);
+
+echo 'Dimensions: '.$response->asVectors()[0]->getDimensions().\PHP_EOL;

src/platform/src/Bridge/Ollama/Ollama.php

@@ -37,6 +37,9 @@ class Ollama extends Model
     public const QWEN = 'qwen';
     public const QWEN_2 = 'qwen2';
     public const LLAMA_2 = 'llama2';
+    public const NOMIC_EMBED_TEXT = 'nomic-embed-text';
+    public const BGE_M3 = 'bge-m3';
+    public const ALL_MINILM = 'all-minilm';
 
     private const TOOL_PATTERNS = [
         '/./' => [
@@ -52,6 +55,9 @@ class Ollama extends Model
         '/^(deepseek|mistral)/' => [
             Capability::TOOL_CALLING,
         ],
+        '/^(nomic|bge|all-minilm).*/' => [
+            Capability::INPUT_MULTIPLE,
+        ],
     ];
 
     /**

src/platform/src/Bridge/Ollama/OllamaClient.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\AI\Platform\Bridge\Ollama;
+
+use Symfony\AI\Platform\Exception\InvalidArgumentException;
+use Symfony\AI\Platform\Model;
+use Symfony\AI\Platform\ModelClientInterface;
+use Symfony\AI\Platform\Result\RawHttpResult;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * @author Christopher Hertel <[email protected]>
+ */
+final readonly class OllamaClient implements ModelClientInterface
+{
+    public function __construct(
+        private HttpClientInterface $httpClient,
+        private string $hostUrl,
+    ) {
+    }
+
+    public function supports(Model $model): bool
+    {
+        return $model instanceof Ollama;
+    }
+
+    public function request(Model $model, array|string $payload, array $options = []): RawHttpResult
+    {
+        $response = $this->httpClient->request('POST', \sprintf('%s/api/show', $this->hostUrl), [
+            'json' => [
+                'model' => $model->getName(),
+            ],
+        ]);
+
+        $modelInformationsPayload = $response->toArray();
+
+        return match (true) {
+            \in_array('completion', $modelInformationsPayload['capabilities'], true) => $this->doCompletionRequest($payload, $options),
+            \in_array('embedding', $modelInformationsPayload['capabilities'], true) => $this->doEmbeddingsRequest($model, $payload, $options),
+            default => throw new InvalidArgumentException(\sprintf('Unsupported model "%s".', $model::class)),
+        };
+    }
+
+    /**
+     * @param array<string|int, mixed> $payload
+     * @param array<string, mixed>     $options
+     */
+    private function doCompletionRequest(array|string $payload, array $options = []): RawHttpResult
+    {
+        // Revert Ollama's default streaming behavior
+        $options['stream'] ??= false;
+
+        return new RawHttpResult($this->httpClient->request('POST', \sprintf('%s/api/chat', $this->hostUrl), [
+            'headers' => ['Content-Type' => 'application/json'],
+            'json' => array_merge($options, $payload),
+        ]));
+    }
+
+    /**
+     * @param array<string|int, mixed> $payload
+     * @param array<string, mixed>     $options
+     */
+    public function doEmbeddingsRequest(Model $model, array|string $payload, array $options = []): RawHttpResult
+    {
+        return new RawHttpResult($this->httpClient->request('POST', \sprintf('%s/api/embed', $this->hostUrl), [
+            'json' => array_merge($options, [
+                'model' => $model->getName(),
+                'input' => $payload,
+            ]),
+        ]));
+    }
+}

src/platform/src/Bridge/Ollama/OllamaModelClient.php

@@ -18,7 +18,9 @@
 use Symfony\AI\Platform\Result\TextResult;
 use Symfony\AI\Platform\Result\ToolCall;
 use Symfony\AI\Platform\Result\ToolCallResult;
+use Symfony\AI\Platform\Result\VectorResult;
 use Symfony\AI\Platform\ResultConverterInterface;
+use Symfony\AI\Platform\Vector\Vector;
 
 /**
  * @author Christopher Hertel <[email protected]>
@@ -34,6 +36,16 @@ public function convert(RawResultInterface $result, array $options = []): Result
     {
         $data = $result->getData();
 
+        return \array_key_exists('embeddings', $data)
+            ? $this->doConvertEmbeddings($data)
+            : $this->doConvertCompletion($data);
+    }
+
+    /**
+     * @param array<string, mixed> $data
+     */
+    public function doConvertCompletion(array $data): ResultInterface
+    {
         if (!isset($data['message'])) {
             throw new RuntimeException('Response does not contain message.');
         }
@@ -54,4 +66,21 @@ public function convert(RawResultInterface $result, array $options = []): Result
 
         return new TextResult($data['message']['content']);
     }
+
+    /**
+     * @param array<string, mixed> $data
+     */
+    public function doConvertEmbeddings(array $data): ResultInterface
+    {
+        if ([] === $data['embeddings']) {
+            throw new RuntimeException('Response does not contain embeddings.');
+        }
+
+        return new VectorResult(
+            ...array_map(
+                static fn (array $embedding): Vector => new Vector($embedding),
+                $data['embeddings'],
+            ),
+        );
+    }
 }

src/platform/src/Bridge/Ollama/OllamaResultConverter.php

@@ -29,6 +29,10 @@ public static function create(
     ): Platform {
         $httpClient = $httpClient instanceof EventSourceHttpClient ? $httpClient : new EventSourceHttpClient($httpClient);
 
-        return new Platform([new OllamaModelClient($httpClient, $hostUrl)], [new OllamaResultConverter()], $contract ?? OllamaContract::create());
+        return new Platform(
+            [new OllamaClient($httpClient, $hostUrl)],
+            [new OllamaResultConverter()],
+            $contract ?? OllamaContract::create()
+        );
     }
 }

src/platform/src/Bridge/Ollama/PlatformFactory.php

@@ -20,16 +20,22 @@
 use Symfony\AI\Platform\Exception\RuntimeException;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\Result\InMemoryRawResult;
+use Symfony\AI\Platform\Result\RawHttpResult;
 use Symfony\AI\Platform\Result\TextResult;
 use Symfony\AI\Platform\Result\ToolCall;
 use Symfony\AI\Platform\Result\ToolCallResult;
+use Symfony\AI\Platform\Result\VectorResult;
+use Symfony\AI\Platform\Vector\Vector;
+use Symfony\Contracts\HttpClient\ResponseInterface;
 
 #[CoversClass(OllamaResultConverter::class)]
 #[Small]
 #[UsesClass(Ollama::class)]
 #[UsesClass(TextResult::class)]
 #[UsesClass(ToolCall::class)]
 #[UsesClass(ToolCallResult::class)]
+#[UsesClass(Vector::class)]
+#[UsesClass(VectorResult::class)]
 final class OllamaResultConverterTest extends TestCase
 {
     public function testSupportsLlamaModel()
@@ -143,4 +149,29 @@ public function testThrowsExceptionWhenNoContent()
 
         $converter->convert($rawResult);
     }
+
+    public function testItConvertsAResponseToAVectorResult()
+    {
+        $result = $this->createStub(ResponseInterface::class);
+        $result
+            ->method('toArray')
+            ->willReturn([
+                'model' => 'all-minilm',
+                'embeddings' => [
+                    [0.3, 0.4, 0.4],
+                    [0.0, 0.0, 0.2],
+                ],
+                'total_duration' => 14143917,
+                'load_duration' => 1019500,
+                'prompt_eval_count' => 8,
+            ]);
+
+        $vectorResult = (new OllamaResultConverter())->convert(new RawHttpResult($result));
+        $convertedContent = $vectorResult->getContent();
+
+        $this->assertCount(2, $convertedContent);
+
+        $this->assertSame([0.3, 0.4, 0.4], $convertedContent[0]->getData());
+        $this->assertSame([0.0, 0.0, 0.2], $convertedContent[1]->getData());
+    }
 }

src/platform/tests/Bridge/Ollama/OllamaResultConverterTest.php

@@ -44,6 +44,17 @@ public function testModelsWithoutToolCallingCapability(string $modelName)
         );
     }
 
+    #[DataProvider('provideModelsWithMultipleInputCapabilities')]
+    public function testModelsWithMultipleInputCapabilities(string $modelName)
+    {
+        $model = new Ollama($modelName);
+
+        $this->assertTrue(
+            $model->supports(Capability::INPUT_MULTIPLE),
+            \sprintf('Model "%s" should not support multiple input capabilities', $modelName)
+        );
+    }
+
     /**
      * @return iterable<array{string}>
      */
@@ -82,4 +93,14 @@ public static function provideModelsWithoutToolCallingCapability(): iterable
         yield 'llava' => [Ollama::LLAVA];
         yield 'qwen2.5vl' => [Ollama::QWEN_2_5_VL]; // This has 'vl' suffix which doesn't match the pattern
     }
+
+    /**
+     * @return iterable<array{string}>
+     */
+    public static function provideModelsWithMultipleInputCapabilities(): iterable
+    {
+        yield 'nomic-embed-text' => [Ollama::NOMIC_EMBED_TEXT];
+        yield 'bge-m3' => [Ollama::BGE_M3];
+        yield 'all-minilm' => [Ollama::ALL_MINILM];
+    }
 }