feature #416 [Platform] Introduce CachedPlatform (Guikingone)

OskarStark · OskarStark · commit b24a50894be7 · 2025-11-22T19:16:34.000+01:00
This PR was merged into the main branch. Discussion ---------- [Platform] Introduce `CachedPlatform` | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | Docs? | yes | Issues | Somehow related to #337 | License | MIT Hi 👋🏻 This PR aim to introduce a caching layer for `Ollama` platform (like OpenAI, Anthropic and more already does). Commits ------- c66e733 feat(platform): Ollama prompt cache
diff --git a/docs/bundles/ai-bundle.rst b/docs/bundles/ai-bundle.rst
@@ -136,6 +136,28 @@ Advanced Example with Multiple Agents
                 vectorizer: 'ai.vectorizer.mistral_embeddings'
                 store: 'ai.store.memory.research'
 
+Cached Platform
+---------------
+
+Thanks to Symfony's Cache component, platforms can be decorated and use any cache adapter,
+this platform allows to reduce network calls / resource consumption:
+
+.. code-block:: yaml
+
+    # config/packages/ai.yaml
+    ai:
+        platform:
+            openai:
+                api_key: '%env(OPENAI_API_KEY)%'
+            cache:
+                platform: 'ai.platform.openai'
+                service: 'cache.app'
+
+        agent:
+            openai:
+                platform: 'ai.platform.cache.openai'
+                model: 'gpt-4o-mini'
+
 Store Dependency Injection
 --------------------------
 
diff --git a/docs/components/platform.rst b/docs/components/platform.rst
@@ -406,6 +406,29 @@ which can be useful to speed up the processing::
         echo $result->asText().PHP_EOL;
     }
 
+Cached Platform Calls
+---------------------
+
+Thanks to Symfony's Cache component, platform calls can be cached to reduce calls and resources consumption::
+
+    use Symfony\AI\Platform\Bridge\Ollama\PlatformFactory;
+    use Symfony\AI\Platform\CachedPlatform;
+    use Symfony\AI\Platform\Message\Message;
+    use Symfony\AI\Platform\Message\MessageBag;
+    use Symfony\Component\Cache\Adapter\ArrayAdapter;
+    use Symfony\Component\Cache\Adapter\TagAwareAdapter;
+
+    $platform = PlatformFactory::create($apiKey, eventDispatcher: $dispatcher);
+    $cachedPlatform = new CachedPlatform($platform, new TagAwareAdapter(new ArrayAdapter());
+
+    $firstResult = $cachedPlatform->invoke('gpt-4o-mini', new MessageBag(Message::ofUser('What is the capital of France?')));
+
+    echo $firstResult->getContent().\PHP_EOL;
+
+    $secondResult = $cachedPlatform->invoke('gpt-4o-mini', new MessageBag(Message::ofUser('What is the capital of France?')));
+
+    echo $secondResult->getContent().\PHP_EOL;
+
 Testing Tools
 -------------
 
diff --git a/examples/misc/agent-with-cache.php b/examples/misc/agent-with-cache.php
@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\AI\Agent\Agent;
+use Symfony\AI\Platform\Bridge\Ollama\PlatformFactory;
+use Symfony\AI\Platform\CachedPlatform;
+use Symfony\AI\Platform\Message\Message;
+use Symfony\AI\Platform\Message\MessageBag;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+use Symfony\Component\Cache\Adapter\TagAwareAdapter;
+
+require_once dirname(__DIR__).'/bootstrap.php';
+
+$platform = PlatformFactory::create(env('OLLAMA_HOST_URL'), http_client());
+$cachedPlatform = new CachedPlatform($platform, new TagAwareAdapter(new ArrayAdapter()));
+
+$agent = new Agent($cachedPlatform, 'qwen3:0.6b-q4_K_M');
+$messages = new MessageBag(
+    Message::forSystem('You are a helpful assistant.'),
+    Message::ofUser('Tina has one brother and one sister. How many sisters do Tina\'s siblings have?'),
+);
+$result = $agent->call($messages, [
+    'prompt_cache_key' => 'chat',
+]);
+
+assert($result->getMetadata()->has('cached'));
+
+echo $result->getContent().\PHP_EOL;
+
+// Thanks to the cache adapter and the "prompt_cache_key" key, this call will not trigger any network call
+
+$secondResult = $agent->call($messages, [
+    'prompt_cache_key' => 'chat',
+]);
+
+assert($secondResult->getMetadata()->has('cached'));
+
+echo $secondResult->getContent().\PHP_EOL;
diff --git a/src/ai-bundle/config/options.php b/src/ai-bundle/config/options.php
@@ -65,6 +65,21 @@
                             ->end()
                         ->end()
                     ->end()
+                    ->arrayNode('cache')
+                        ->useAttributeAsKey('name')
+                        ->arrayPrototype()
+                            ->children()
+                                ->stringNode('platform')->isRequired()->end()
+                                ->stringNode('service')
+                                    ->isRequired()
+                                    ->info('The cache service id as defined under the "cache" configuration key')
+                                ->end()
+                                ->stringNode('cache_key')
+                                    ->info('Key used to store platform results, if not set, the current platform name will be used, the "prompt_cache_key" can be set during platform call to override this value')
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
                     ->arrayNode('cartesia')
                         ->children()
                             ->stringNode('api_key')->isRequired()->end()
diff --git a/src/ai-bundle/src/AiBundle.php b/src/ai-bundle/src/AiBundle.php
@@ -67,6 +67,7 @@
 use Symfony\AI\Platform\Bridge\Scaleway\PlatformFactory as ScalewayPlatformFactory;
 use Symfony\AI\Platform\Bridge\VertexAi\PlatformFactory as VertexAiPlatformFactory;
 use Symfony\AI\Platform\Bridge\Voyage\PlatformFactory as VoyagePlatformFactory;
+use Symfony\AI\Platform\CachedPlatform;
 use Symfony\AI\Platform\Capability;
 use Symfony\AI\Platform\Exception\RuntimeException;
 use Symfony\AI\Platform\Message\Content\File;
@@ -374,6 +375,24 @@ private function processPlatformConfig(string $type, array $platform, ContainerB
             return;
         }
 
+        if ('cache' === $type) {
+            foreach ($platform as $name => $cachedPlatformConfig) {
+                $definition = (new Definition(CachedPlatform::class))
+                    ->setLazy(true)
+                    ->setArguments([
+                        new Reference($cachedPlatformConfig['platform']),
+                        new Reference($cachedPlatformConfig['service'], ContainerInterface::NULL_ON_INVALID_REFERENCE),
+                        $cachedPlatformConfig['cache_key'] ?? $name,
+                    ])
+                    ->addTag('proxy', ['interface' => PlatformInterface::class])
+                    ->addTag('ai.platform', ['name' => 'cache'.$name]);
+
+                $container->setDefinition('ai.platform.cache.'.$name, $definition);
+            }
+
+            return;
+        }
+
         if ('cartesia' === $type) {
             $definition = (new Definition(Platform::class))
                 ->setFactory(CartesiaPlatformFactory::class.'::create')
diff --git a/src/ai-bundle/tests/DependencyInjection/AiBundleTest.php b/src/ai-bundle/tests/DependencyInjection/AiBundleTest.php
@@ -2890,6 +2890,77 @@ public function testVectorizerModelBooleanOptionsArePreserved()
         $this->assertSame('text-embedding-3-small?normalize=false&cache=true&nested%5Bbool%5D=false', $vectorizerDefinition->getArgument(1));
     }
 
+    public function testCachedPlatformCanBeUsed()
+    {
+        $container = $this->buildContainer([
+            'ai' => [
+                'platform' => [
+                    'ollama' => [
+                        'host_url' => 'http://127.0.0.1:11434',
+                    ],
+                    'cache' => [
+                        'ollama' => [
+                            'platform' => 'ai.platform.ollama',
+                            'service' => 'cache.app',
+                            'cache_key' => 'ollama',
+                        ],
+                    ],
+                ],
+            ],
+        ]);
+
+        $this->assertTrue($container->hasDefinition('ai.platform.cache.ollama'));
+
+        $definition = $container->getDefinition('ai.platform.cache.ollama');
+        $this->assertTrue($definition->isLazy());
+        $this->assertCount(3, $definition->getArguments());
+
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(0));
+        $platformArgument = $definition->getArgument(0);
+        $this->assertSame('ai.platform.ollama', (string) $platformArgument);
+
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(1));
+        $cacheArgument = $definition->getArgument(1);
+        $this->assertSame('cache.app', (string) $cacheArgument);
+
+        $this->assertSame('ollama', $definition->getArgument(2));
+    }
+
+    public function testCachedPlatformCanBeUsedWithoutCustomCacheKey()
+    {
+        $container = $this->buildContainer([
+            'ai' => [
+                'platform' => [
+                    'ollama' => [
+                        'host_url' => 'http://127.0.0.1:11434',
+                    ],
+                    'cache' => [
+                        'ollama' => [
+                            'platform' => 'ai.platform.ollama',
+                            'service' => 'cache.app',
+                        ],
+                    ],
+                ],
+            ],
+        ]);
+
+        $this->assertTrue($container->hasDefinition('ai.platform.cache.ollama'));
+
+        $definition = $container->getDefinition('ai.platform.cache.ollama');
+        $this->assertTrue($definition->isLazy());
+        $this->assertCount(3, $definition->getArguments());
+
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(0));
+        $platformArgument = $definition->getArgument(0);
+        $this->assertSame('ai.platform.ollama', (string) $platformArgument);
+
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(1));
+        $cacheArgument = $definition->getArgument(1);
+        $this->assertSame('cache.app', (string) $cacheArgument);
+
+        $this->assertSame('ollama', $definition->getArgument(2));
+    }
+
     public function testCacheMessageStoreCanBeConfiguredWithCustomKey()
     {
         $container = $this->buildContainer([
@@ -3559,6 +3630,13 @@ private function getFullConfig(): array
                             'api_version' => '2024-02-15-preview',
                         ],
                     ],
+                    'cache' => [
+                        'azure' => [
+                            'platform' => 'ai.platform.azure.my_azure_instance',
+                            'service' => 'cache.app',
+                            'cache_key' => 'foo',
+                        ],
+                    ],
                     'cartesia' => [
                         'api_key' => 'cartesia_key_full',
                         'version' => '2025-04-16',
diff --git a/src/platform/composer.json b/src/platform/composer.json
@@ -66,6 +66,7 @@
         "phpstan/phpstan-symfony": "^2.0.6",
         "phpunit/phpunit": "^11.5",
         "symfony/ai-agent": "@dev",
+        "symfony/cache": "^7.3|^8.0",
         "symfony/console": "^7.3|^8.0",
         "symfony/dotenv": "^7.3|^8.0",
         "symfony/finder": "^7.3|^8.0",
diff --git a/src/platform/src/CachedPlatform.php b/src/platform/src/CachedPlatform.php
@@ -0,0 +1,69 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\AI\Platform;
+
+use Symfony\AI\Platform\ModelCatalog\ModelCatalogInterface;
+use Symfony\AI\Platform\Result\DeferredResult;
+use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
+use Symfony\Contracts\Cache\CacheInterface;
+use Symfony\Contracts\Cache\ItemInterface;
+
+/**
+ * @author Guillaume Loulier <personal@guillaumeloulier.fr>
+ */
+final class CachedPlatform implements PlatformInterface
+{
+    public function __construct(
+        private readonly PlatformInterface $platform,
+        private readonly (CacheInterface&TagAwareAdapterInterface)|null $cache = null,
+        private readonly ?string $cacheKey = null,
+    ) {
+    }
+
+    public function invoke(string $model, array|string|object $input, array $options = []): DeferredResult
+    {
+        $invokeCall = fn (string $model, array|string|object $input, array $options = []): DeferredResult => $this->platform->invoke($model, $input, $options);
+
+        if ($this->cache instanceof CacheInterface && (\array_key_exists('prompt_cache_key', $options) && '' !== $options['prompt_cache_key'])) {
+            $cacheKey = \sprintf('%s_%s_%s', $this->cacheKey ?? $options['prompt_cache_key'], md5($model), \is_string($input) ? md5($input) : md5(json_encode($input)));
+
+            unset($options['prompt_cache_key']);
+
+            return $this->cache->get($cacheKey, static function (ItemInterface $item) use ($invokeCall, $model, $input, $options, $cacheKey): DeferredResult {
+                $item->tag($model);
+
+                $result = $invokeCall($model, $input, $options);
+
+                $result = new DeferredResult(
+                    $result->getResultConverter(),
+                    $result->getRawResult(),
+                    $options,
+                );
+
+                $result->getMetadata()->set([
+                    'cached' => true,
+                    'cache_key' => $cacheKey,
+                    'cached_at' => (new \DateTimeImmutable())->getTimestamp(),
+                ]);
+
+                return $result;
+            });
+        }
+
+        return $invokeCall($model, $input, $options);
+    }
+
+    public function getModelCatalog(): ModelCatalogInterface
+    {
+        return $this->platform->getModelCatalog();
+    }
+}
diff --git a/src/platform/src/Result/DeferredResult.php b/src/platform/src/Result/DeferredResult.php
@@ -13,6 +13,7 @@
 
 use Symfony\AI\Platform\Exception\ExceptionInterface;
 use Symfony\AI\Platform\Exception\UnexpectedResultTypeException;
+use Symfony\AI\Platform\Metadata\MetadataAwareTrait;
 use Symfony\AI\Platform\ResultConverterInterface;
 use Symfony\AI\Platform\Vector\Vector;
 
@@ -21,6 +22,8 @@
  */
 final class DeferredResult
 {
+    use MetadataAwareTrait;
+
     private bool $isConverted = false;
     private ResultInterface $convertedResult;
 
@@ -50,6 +53,8 @@ public function getResult(): ResultInterface
             $this->isConverted = true;
         }
 
+        $this->convertedResult->getMetadata()->set($this->getMetadata()->all());
+
         return $this->convertedResult;
     }
 
diff --git a/src/platform/tests/CachedPlatformTest.php b/src/platform/tests/CachedPlatformTest.php

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use Symfony\AI\Platform\Exception\ExceptionInterface;`
`15`	`15`	`use Symfony\AI\Platform\Exception\UnexpectedResultTypeException;`
	`16`	`+use Symfony\AI\Platform\Metadata\MetadataAwareTrait;`
`16`	`17`	`use Symfony\AI\Platform\ResultConverterInterface;`
`17`	`18`	`use Symfony\AI\Platform\Vector\Vector;`
`18`	`19`
`@@ -21,6 +22,8 @@`
`21`	`22`	`*/`
`22`	`23`	`final class DeferredResult`
`23`	`24`	`{`
	`25`	`+ use MetadataAwareTrait;`
	`26`	`+`
`24`	`27`	`private bool $isConverted = false;`
`25`	`28`	`private ResultInterface $convertedResult;`
`26`	`29`
`@@ -50,6 +53,8 @@ public function getResult(): ResultInterface`
`50`	`53`	`$this->isConverted = true;`
`51`	`54`	`}`
`52`	`55`
	`56`	`+ $this->convertedResult->getMetadata()->set($this->getMetadata()->all());`
	`57`	`+`
`53`	`58`	`return $this->convertedResult;`
`54`	`59`	`}`
`55`	`60`