refactor(platform): introduce ElevenLabsApiCatalog

Guikingone · Guikingone · commit 718ee9d2674b · 2025-12-10T13:38:46.000+01:00
diff --git a/src/ai-bundle/config/options.php b/src/ai-bundle/config/options.php
@@ -98,6 +98,9 @@
                                 ->defaultValue('http_client')
                                 ->info('Service ID of the HTTP client to use')
                             ->end()
+                            ->booleanNode('api_catalog')
+                                ->info('If set, the ElevenLabs API will be used to build the catalog and retrieve models information, using this option leads to additional HTTP calls')
+                            ->end()
                         ->end()
                     ->end()
                     ->arrayNode('gemini')
diff --git a/src/ai-bundle/config/services.php b/src/ai-bundle/config/services.php
@@ -62,6 +62,7 @@
 use Symfony\AI\Platform\Contract;
 use Symfony\AI\Platform\Contract\JsonSchema\DescriptionParser;
 use Symfony\AI\Platform\Contract\JsonSchema\Factory as SchemaFactory;
+use Symfony\AI\Platform\ModelCatalog\ModelCatalogInterface;
 use Symfony\AI\Platform\Serializer\StructuredOutputSerializer;
 use Symfony\AI\Platform\StructuredOutput\PlatformSubscriber;
 use Symfony\AI\Platform\StructuredOutput\ResponseFormatFactory;
@@ -98,6 +99,8 @@
         ->set('ai.platform.model_catalog.deepseek', DeepSeekModelCatalog::class)
         ->set('ai.platform.model_catalog.dockermodelrunner', DockerModelRunnerModelCatalog::class)
         ->set('ai.platform.model_catalog.elevenlabs', ElevenLabsModelCatalog::class)
+            ->lazy(true)
+            ->tag('proxy', ['interface' => ModelCatalogInterface::class])
         ->set('ai.platform.model_catalog.gemini', GeminiModelCatalog::class)
         ->set('ai.platform.model_catalog.huggingface', HuggingFaceModelCatalog::class)
         ->set('ai.platform.model_catalog.lmstudio', LmStudioModelCatalog::class)
diff --git a/src/ai-bundle/src/AiBundle.php b/src/ai-bundle/src/AiBundle.php
@@ -57,6 +57,7 @@
 use Symfony\AI\Platform\Bridge\Cerebras\PlatformFactory as CerebrasPlatformFactory;
 use Symfony\AI\Platform\Bridge\DeepSeek\PlatformFactory as DeepSeekPlatformFactory;
 use Symfony\AI\Platform\Bridge\DockerModelRunner\PlatformFactory as DockerModelRunnerPlatformFactory;
+use Symfony\AI\Platform\Bridge\ElevenLabs\ElevenLabsApiCatalog;
 use Symfony\AI\Platform\Bridge\ElevenLabs\PlatformFactory as ElevenLabsPlatformFactory;
 use Symfony\AI\Platform\Bridge\Gemini\PlatformFactory as GeminiPlatformFactory;
 use Symfony\AI\Platform\Bridge\Generic\PlatformFactory as GenericPlatformFactory;
@@ -75,6 +76,7 @@
 use Symfony\AI\Platform\Capability;
 use Symfony\AI\Platform\Exception\RuntimeException;
 use Symfony\AI\Platform\Message\Content\File;
+use Symfony\AI\Platform\ModelCatalog\ModelCatalogInterface;
 use Symfony\AI\Platform\ModelClientInterface;
 use Symfony\AI\Platform\Platform;
 use Symfony\AI\Platform\PlatformInterface;
@@ -431,6 +433,19 @@ private function processPlatformConfig(string $type, array $platform, ContainerB
         }
 
         if ('elevenlabs' === $type) {
+            if (\array_key_exists('api_catalog', $platform) && $platform['api_catalog']) {
+                $catalogDefinition = (new Definition(ElevenLabsApiCatalog::class))
+                    ->setLazy(true)
+                    ->setArguments([
+                        new Reference($platform['http_client']),
+                        $platform['api_key'],
+                        $platform['host'],
+                    ])
+                    ->addTag('proxy', ['interface' => ModelCatalogInterface::class]);
+
+                $container->setDefinition('ai.platform.model_catalog.'.$type, $catalogDefinition);
+            }
+
             $definition = (new Definition(Platform::class))
                 ->setFactory(ElevenLabsPlatformFactory::class.'::create')
                 ->setLazy(true)
@@ -648,7 +663,9 @@ private function processPlatformConfig(string $type, array $platform, ContainerB
                     ->setArguments([
                         $platform['host_url'],
                         new Reference($platform['http_client']),
-                    ]);
+                    ])
+                    ->addTag('proxy', ['interface' => ModelCatalogInterface::class])
+                ;
 
                 $container->setDefinition('ai.platform.model_catalog.ollama', $catalogDefinition);
             }
diff --git a/src/ai-bundle/tests/DependencyInjection/AiBundleTest.php b/src/ai-bundle/tests/DependencyInjection/AiBundleTest.php
@@ -27,10 +27,13 @@
 use Symfony\AI\Chat\ChatInterface;
 use Symfony\AI\Chat\ManagedStoreInterface as ManagedMessageStoreInterface;
 use Symfony\AI\Chat\MessageStoreInterface;
-use Symfony\AI\Platform\Bridge\ElevenLabs\PlatformFactory;
+use Symfony\AI\Platform\Bridge\ElevenLabs\ElevenLabsApiCatalog;
+use Symfony\AI\Platform\Bridge\ElevenLabs\ModelCatalog as ElevenLabsModelCatalog;
+use Symfony\AI\Platform\Bridge\ElevenLabs\PlatformFactory as ElevenLabsPlatformFactory;
 use Symfony\AI\Platform\Bridge\Ollama\OllamaApiCatalog;
 use Symfony\AI\Platform\Capability;
 use Symfony\AI\Platform\Model;
+use Symfony\AI\Platform\ModelCatalog\ModelCatalogInterface;
 use Symfony\AI\Platform\PlatformInterface;
 use Symfony\AI\Store\Bridge\AzureSearch\SearchStore as AzureStore;
 use Symfony\AI\Store\Bridge\Cache\Store as CacheStore;
@@ -3785,7 +3788,7 @@ public function testElevenLabsPlatformCanBeRegistered()
         $definition = $container->getDefinition('ai.platform.elevenlabs');
 
         $this->assertTrue($definition->isLazy());
-        $this->assertSame([PlatformFactory::class, 'create'], $definition->getFactory());
+        $this->assertSame([ElevenLabsPlatformFactory::class, 'create'], $definition->getFactory());
 
         $this->assertCount(6, $definition->getArguments());
         $this->assertSame('foo', $definition->getArgument(0));
@@ -3805,6 +3808,14 @@ public function testElevenLabsPlatformCanBeRegistered()
 
         $this->assertTrue($container->hasAlias('Symfony\AI\Platform\PlatformInterface $elevenlabs'));
         $this->assertTrue($container->hasAlias('Symfony\AI\Platform\PlatformInterface'));
+
+        $modelCatalogDefinition = $container->getDefinition('ai.platform.model_catalog.elevenlabs');
+
+        $this->assertSame(ElevenLabsModelCatalog::class, $modelCatalogDefinition->getClass());
+        $this->assertTrue($modelCatalogDefinition->isLazy());
+
+        $this->assertTrue($modelCatalogDefinition->hasTag('proxy'));
+        $this->assertSame([['interface' => ModelCatalogInterface::class]], $modelCatalogDefinition->getTag('proxy'));
     }
 
     public function testElevenLabsPlatformWithCustomEndpointCanBeRegistered()
@@ -3825,7 +3836,7 @@ public function testElevenLabsPlatformWithCustomEndpointCanBeRegistered()
         $definition = $container->getDefinition('ai.platform.elevenlabs');
 
         $this->assertTrue($definition->isLazy());
-        $this->assertSame([PlatformFactory::class, 'create'], $definition->getFactory());
+        $this->assertSame([ElevenLabsPlatformFactory::class, 'create'], $definition->getFactory());
 
         $this->assertCount(6, $definition->getArguments());
         $this->assertSame('foo', $definition->getArgument(0));
@@ -3845,6 +3856,14 @@ public function testElevenLabsPlatformWithCustomEndpointCanBeRegistered()
 
         $this->assertTrue($container->hasAlias('Symfony\AI\Platform\PlatformInterface $elevenlabs'));
         $this->assertTrue($container->hasAlias('Symfony\AI\Platform\PlatformInterface'));
+
+        $modelCatalogDefinition = $container->getDefinition('ai.platform.model_catalog.elevenlabs');
+
+        $this->assertSame(ElevenLabsModelCatalog::class, $modelCatalogDefinition->getClass());
+        $this->assertTrue($modelCatalogDefinition->isLazy());
+
+        $this->assertTrue($modelCatalogDefinition->hasTag('proxy'));
+        $this->assertSame([['interface' => ModelCatalogInterface::class]], $modelCatalogDefinition->getTag('proxy'));
     }
 
     public function testElevenLabsPlatformWithCustomHttpClientCanBeRegistered()
@@ -3865,7 +3884,7 @@ public function testElevenLabsPlatformWithCustomHttpClientCanBeRegistered()
         $definition = $container->getDefinition('ai.platform.elevenlabs');
 
         $this->assertTrue($definition->isLazy());
-        $this->assertSame([PlatformFactory::class, 'create'], $definition->getFactory());
+        $this->assertSame([ElevenLabsPlatformFactory::class, 'create'], $definition->getFactory());
 
         $this->assertCount(6, $definition->getArguments());
         $this->assertSame('foo', $definition->getArgument(0));
@@ -3885,6 +3904,68 @@ public function testElevenLabsPlatformWithCustomHttpClientCanBeRegistered()
 
         $this->assertTrue($container->hasAlias('Symfony\AI\Platform\PlatformInterface $elevenlabs'));
         $this->assertTrue($container->hasAlias('Symfony\AI\Platform\PlatformInterface'));
+
+        $modelCatalogDefinition = $container->getDefinition('ai.platform.model_catalog.elevenlabs');
+
+        $this->assertSame(ElevenLabsModelCatalog::class, $modelCatalogDefinition->getClass());
+        $this->assertTrue($modelCatalogDefinition->isLazy());
+
+        $this->assertTrue($modelCatalogDefinition->hasTag('proxy'));
+        $this->assertSame([['interface' => ModelCatalogInterface::class]], $modelCatalogDefinition->getTag('proxy'));
+    }
+
+    public function testElevenLabsPlatformWithApiCatalogCanBeRegistered()
+    {
+        $container = $this->buildContainer([
+            'ai' => [
+                'platform' => [
+                    'elevenlabs' => [
+                        'api_key' => 'foo',
+                        'api_catalog' => true,
+                    ],
+                ],
+            ],
+        ]);
+
+        $this->assertTrue($container->hasDefinition('ai.platform.elevenlabs'));
+        $this->assertTrue($container->hasDefinition('ai.platform.model_catalog.elevenlabs'));
+
+        $definition = $container->getDefinition('ai.platform.elevenlabs');
+
+        $this->assertTrue($definition->isLazy());
+        $this->assertSame([ElevenLabsPlatformFactory::class, 'create'], $definition->getFactory());
+
+        $this->assertCount(6, $definition->getArguments());
+        $this->assertSame('foo', $definition->getArgument(0));
+        $this->assertSame('https://api.elevenlabs.io/v1', $definition->getArgument(1));
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(2));
+        $this->assertSame('http_client', (string) $definition->getArgument(2));
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(3));
+        $this->assertSame('ai.platform.model_catalog.elevenlabs', (string) $definition->getArgument(3));
+        $this->assertNull($definition->getArgument(4));
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(5));
+        $this->assertSame('event_dispatcher', (string) $definition->getArgument(5));
+
+        $this->assertTrue($definition->hasTag('proxy'));
+        $this->assertSame([['interface' => PlatformInterface::class]], $definition->getTag('proxy'));
+        $this->assertTrue($definition->hasTag('ai.platform'));
+        $this->assertSame([['name' => 'elevenlabs']], $definition->getTag('ai.platform'));
+
+        $this->assertTrue($container->hasAlias('Symfony\AI\Platform\PlatformInterface $elevenlabs'));
+        $this->assertTrue($container->hasAlias('Symfony\AI\Platform\PlatformInterface'));
+
+        $modelCatalogDefinition = $container->getDefinition('ai.platform.model_catalog.elevenlabs');
+
+        $this->assertSame(ElevenLabsApiCatalog::class, $modelCatalogDefinition->getClass());
+        $this->assertTrue($modelCatalogDefinition->isLazy());
+        $this->assertCount(3, $modelCatalogDefinition->getArguments());
+        $this->assertInstanceOf(Reference::class, $modelCatalogDefinition->getArgument(0));
+        $this->assertSame('http_client', (string) $modelCatalogDefinition->getArgument(0));
+        $this->assertSame('foo', $modelCatalogDefinition->getArgument(1));
+        $this->assertSame('https://api.elevenlabs.io/v1', $modelCatalogDefinition->getArgument(2));
+
+        $this->assertTrue($modelCatalogDefinition->hasTag('proxy'));
+        $this->assertSame([['interface' => ModelCatalogInterface::class]], $modelCatalogDefinition->getTag('proxy'));
     }
 
     #[TestDox('Token usage processor tags use the correct agent ID')]
diff --git a/src/platform/src/Bridge/ElevenLabs/ElevenLabsApiCatalog.php b/src/platform/src/Bridge/ElevenLabs/ElevenLabsApiCatalog.php
@@ -0,0 +1,76 @@
+<?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\Bridge\ElevenLabs;
+
+use Symfony\AI\Platform\Capability;
+use Symfony\AI\Platform\Exception\InvalidArgumentException;
+use Symfony\AI\Platform\ModelCatalog\ModelCatalogInterface;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * @author Guillaume Loulier <personal@guillaumeloulier.fr>
+ */
+final class ElevenLabsApiCatalog implements ModelCatalogInterface
+{
+    public function __construct(
+        private readonly HttpClientInterface $httpClient,
+        #[\SensitiveParameter] private readonly string $apiKey,
+        private readonly string $hostUrl = 'https://api.elevenlabs.io/v1',
+    ) {
+    }
+
+    public function getModel(string $modelName): ElevenLabs
+    {
+        $models = $this->getModels();
+
+        if (!\array_key_exists($modelName, $models)) {
+            throw new InvalidArgumentException(\sprintf('The model "%s" cannot be retrieve from the API.', $modelName));
+        }
+
+        return new ElevenLabs($modelName, $models[$modelName]['capabilities']);
+    }
+
+    public function getModels(): array
+    {
+        $response = $this->httpClient->request('GET', \sprintf('%s/models', $this->hostUrl), [
+            'headers' => [
+                'x-api-key' => $this->apiKey,
+            ],
+        ]);
+
+        $models = $response->toArray();
+
+        $capabilities = fn (array $model): array => match (true) {
+            $model['can_do_text_to_speech'] => [
+                Capability::TEXT_TO_SPEECH,
+                Capability::INPUT_TEXT,
+                Capability::OUTPUT_AUDIO,
+            ],
+            $model['can_do_voice_conversation'] => [
+                Capability::SPEECH_TO_TEXT,
+                Capability::INPUT_AUDIO,
+                Capability::OUTPUT_TEXT,
+            ],
+            default => throw new InvalidArgumentException(\sprintf('The model "%s" is not supported, please check the ElevenLabs API.', $model['name'])),
+        };
+
+        return array_merge(...array_map(
+            static fn (array $model): array => [
+                $model['name'] => [
+                    'class' => ElevenLabs::class,
+                    'capabilities' => $capabilities($model),
+                ],
+            ],
+            $models,
+        ));
+    }
+}
diff --git a/src/platform/src/Bridge/ElevenLabs/ElevenLabsClient.php b/src/platform/src/Bridge/ElevenLabs/ElevenLabsClient.php
@@ -46,13 +46,14 @@ public function request(Model $model, array|string $payload, array $options = []
             return $this->doSpeechToTextRequest($model, $payload);
         }
 
-        $capabilities = $this->retrieveCapabilities($model);
-
-        if (!$capabilities['can_do_text_to_speech']) {
-            throw new InvalidArgumentException(\sprintf('The model "%s" does not support text-to-speech.', $model->getName()));
+        if ($model->supports(Capability::TEXT_TO_SPEECH)) {
+            return $this->doTextToSpeechRequest($model, $payload, [
+                ...$options,
+                ...$model->getOptions(),
+            ]);
         }
 
-        return $this->doTextToSpeechRequest($model, $payload, array_merge($options, $model->getOptions()));
+        throw new InvalidArgumentException(\sprintf('The model "%s" does not support text-to-speech or speech-to-text, please check the model information.', $model->getName()));
     }
 
     /**
@@ -102,26 +103,4 @@ private function doTextToSpeechRequest(Model $model, array|string $payload, arra
             ],
         ]));
     }
-
-    /**
-     * @return array<string, mixed>
-     */
-    private function retrieveCapabilities(Model $model): array
-    {
-        $capabilityResponse = $this->httpClient->request('GET', \sprintf('%s/models', $this->hostUrl), [
-            'headers' => [
-                'xi-api-key' => $this->apiKey,
-            ],
-        ]);
-
-        $models = $capabilityResponse->toArray();
-
-        $currentModelConfiguration = array_filter($models, static fn (array $information): bool => $information['model_id'] === $model->getName());
-
-        if ([] === $currentModelConfiguration) {
-            throw new InvalidArgumentException('The model information could not be retrieved from the ElevenLabs API. Your model might not be supported. Try to use another one.');
-        }
-
-        return reset($currentModelConfiguration);
-    }
 }
diff --git a/src/platform/tests/Bridge/ElevenLabs/ElevenLabsApiCatalogTest.php b/src/platform/tests/Bridge/ElevenLabs/ElevenLabsApiCatalogTest.php
diff --git a/src/platform/tests/Bridge/ElevenLabs/ElevenLabsClientTest.php b/src/platform/tests/Bridge/ElevenLabs/ElevenLabsClientTest.php
