refactor: rename Runtime to Platform (#20)

* Rename `Runtime` to `Platform`

* -

* fix: missing readme update

---------

Co-authored-by: Christopher Hertel <mail@christopher-hertel.de>

Author: OskarStark

README.md

@@ -13,7 +13,7 @@ composer require php-llm/llm-chain-bundle
 ```yaml
 # config/packages/llm_chain.yaml
 llm_chain:
-    runtimes:
+    platforms:
         azure_gpt:
             type: 'azure'
             base_url: '%env(AZURE_OPENAI_BASEURL)%'
@@ -31,14 +31,14 @@ llm_chain:
             api_key: '%env(OPENAI_API_KEY)%'
     llms:
         azure_gpt:
-            runtime: 'azure_gpt'
+            platform: 'azure_gpt'
         original_gpt:
-            runtime: 'openai'
+            platform: 'openai'
     embeddings:
         azure_embeddings:
-            runtime: 'azure_embeddings'
+            platform: 'azure_embeddings'
         original_embeddings:
-            runtime: 'openai'
+            platform: 'openai'
     stores:
         chroma_db:
             engine: 'chroma-db'

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
         "php": ">=8.2",
-        "php-llm/llm-chain": "^0.1",
+        "php-llm/llm-chain": "^0.2",
         "symfony/config": "^6.4 || ^7.0",
         "symfony/dependency-injection": "^6.4 || ^7.0",
         "symfony/framework-bundle": "^6.4 || ^7.0"

src/DependencyInjection/Configuration.php

@@ -16,7 +16,7 @@ public function getConfigTreeBuilder(): TreeBuilder
 
         $rootNode
             ->children()
-                ->arrayNode('runtimes')
+                ->arrayNode('platforms')
                     ->normalizeKeys(false)
                     ->useAttributeAsKey('name')
                     ->arrayPrototype()
@@ -34,7 +34,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->useAttributeAsKey('name')
                     ->arrayPrototype()
                         ->children()
-                            ->scalarNode('runtime')->end()
+                            ->scalarNode('platform')->end()
                         ->end()
                     ->end()
                 ->end()
@@ -43,7 +43,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->useAttributeAsKey('name')
                     ->arrayPrototype()
                         ->children()
-                            ->scalarNode('runtime')->end()
+                            ->scalarNode('platform')->end()
                         ->end()
                     ->end()
                 ->end()

src/DependencyInjection/LlmChainExtension.php

@@ -8,9 +8,9 @@
 use PhpLlm\LlmChain\LanguageModel;
 use PhpLlm\LlmChain\OpenAI\Model\Embeddings;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
-use PhpLlm\LlmChain\OpenAI\Runtime;
-use PhpLlm\LlmChain\OpenAI\Runtime\Azure as AzureRuntime;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI as OpenAIRuntime;
+use PhpLlm\LlmChain\OpenAI\Platform;
+use PhpLlm\LlmChain\OpenAI\Platform\Azure as AzurePlatform;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI as OpenAIPlatform;
 use PhpLlm\LlmChain\Store\Azure\SearchStore as AzureSearchStore;
 use PhpLlm\LlmChain\Store\ChromaDb\Store as ChromaDbStore;
 use PhpLlm\LlmChain\Store\StoreInterface;
@@ -37,11 +37,11 @@ public function load(array $configs, ContainerBuilder $container): void
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
 
-        foreach ($config['runtimes'] as $runtimeName => $runtime) {
-            $this->processRuntimeConfig($runtimeName, $runtime, $container);
+        foreach ($config['platforms'] as $platformName => $platform) {
+            $this->processPlatformConfig($platformName, $platform, $container);
         }
-        if (1 === count($config['runtimes']) && isset($runtimeName)) {
-            $container->setAlias(Runtime::class, 'llm_chain.runtime.'.$runtimeName);
+        if (1 === count($config['platforms']) && isset($platformName)) {
+            $container->setAlias(Platform::class, 'llm_chain.platform.'.$platformName);
         }
 
         foreach ($config['llms'] as $llmName => $llm) {
@@ -81,29 +81,29 @@ public function load(array $configs, ContainerBuilder $container): void
     }
 
     /**
-     * @param array<string, mixed> $runtime
+     * @param array<string, mixed> $platform
      */
-    private function processRuntimeConfig(string $name, array $runtime, ContainerBuilder $container): void
+    private function processPlatformConfig(string $name, array $platform, ContainerBuilder $container): void
     {
-        if ('openai' === $runtime['type']) {
-            $definition = new ChildDefinition(OpenAIRuntime::class);
+        if ('openai' === $platform['type']) {
+            $definition = new ChildDefinition(OpenAIPlatform::class);
             $definition
-                ->replaceArgument('$apiKey', $runtime['api_key']);
+                ->replaceArgument('$apiKey', $platform['api_key']);
 
-            $container->setDefinition('llm_chain.runtime.'.$name, $definition);
+            $container->setDefinition('llm_chain.platform.'.$name, $definition);
 
             return;
         }
 
-        if ('azure' === $runtime['type']) {
-            $definition = new ChildDefinition(AzureRuntime::class);
+        if ('azure' === $platform['type']) {
+            $definition = new ChildDefinition(AzurePlatform::class);
             $definition
-                ->replaceArgument('$baseUrl', $runtime['base_url'])
-                ->replaceArgument('$deployment', $runtime['deployment'])
-                ->replaceArgument('$key', $runtime['api_key'])
-                ->replaceArgument('$apiVersion', $runtime['version']);
+                ->replaceArgument('$baseUrl', $platform['base_url'])
+                ->replaceArgument('$deployment', $platform['deployment'])
+                ->replaceArgument('$key', $platform['api_key'])
+                ->replaceArgument('$apiVersion', $platform['version']);
 
-            $container->setDefinition('llm_chain.runtime.'.$name, $definition);
+            $container->setDefinition('llm_chain.platform.'.$name, $definition);
         }
     }
 
@@ -112,10 +112,10 @@ private function processRuntimeConfig(string $name, array $runtime, ContainerBui
      */
     private function processLlmConfig(string $name, array $llm, ContainerBuilder $container): void
     {
-        $runtime = isset($llm['runtime']) ? 'llm_chain.runtime.'.$llm['runtime'] : Runtime::class;
+        $platform = isset($llm['platform']) ? 'llm_chain.platform.'.$llm['platform'] : Platform::class;
 
         $definition = new ChildDefinition(Gpt::class);
-        $definition->replaceArgument('$runtime', new Reference($runtime));
+        $definition->replaceArgument('$platform', new Reference($platform));
 
         $container->setDefinition('llm_chain.llm.'.$name, $definition);
 
@@ -134,10 +134,10 @@ private function processLlmConfig(string $name, array $llm, ContainerBuilder $co
      */
     private function processEmbeddingsConfig(string $name, array $embeddings, ContainerBuilder $container): void
     {
-        $runtime = isset($embeddings['runtime']) ? 'llm_chain.runtime.'.$embeddings['runtime'] : Runtime::class;
+        $platform = isset($embeddings['platform']) ? 'llm_chain.platform.'.$embeddings['platform'] : Platform::class;
 
         $definition = new ChildDefinition(Embeddings::class);
-        $definition->replaceArgument('$runtime', new Reference($runtime));
+        $definition->replaceArgument('$platform', new Reference($platform));
 
         $container->setDefinition('llm_chain.embeddings.'.$name, $definition);
     }

src/Resources/config/services.php

@@ -8,9 +8,9 @@
 use PhpLlm\LlmChain\DocumentEmbedder;
 use PhpLlm\LlmChain\OpenAI\Model\Embeddings;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
-use PhpLlm\LlmChain\OpenAI\Runtime;
-use PhpLlm\LlmChain\OpenAI\Runtime\Azure as AzureRuntime;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI as OpenAIRuntime;
+use PhpLlm\LlmChain\OpenAI\Platform;
+use PhpLlm\LlmChain\OpenAI\Platform\Azure as AzurePlatform;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI as OpenAIPlatform;
 use PhpLlm\LlmChain\Store\Azure\SearchStore as AzureSearchStore;
 use PhpLlm\LlmChain\Store\ChromaDb\Store as ChromaDbStore;
 use PhpLlm\LlmChain\ToolBox\ParameterAnalyzer;
@@ -30,16 +30,16 @@
         ->set(Chain::class)
         ->set(DocumentEmbedder::class)
 
-        // runtimes
-        ->set(AzureRuntime::class)
+        // platforms
+        ->set(AzurePlatform::class)
             ->abstract()
             ->args([
                 '$baseUrl' => abstract_arg('Base URL for Azure API'),
                 '$deployment' => abstract_arg('Deployment for Azure API'),
                 '$apiVersion' => abstract_arg('API version for Azure API'),
                 '$key' => abstract_arg('API key for Azure API'),
             ])
-        ->set(OpenAIRuntime::class)
+        ->set(OpenAIPlatform::class)
             ->abstract()
             ->args([
                 '$apiKey' => abstract_arg('API key for OpenAI API'),
@@ -49,12 +49,12 @@
         ->set(Gpt::class)
             ->abstract()
             ->args([
-                '$runtime' => service(Runtime::class),
+                '$platform' => service(Platform::class),
             ])
         ->set(Embeddings::class)
             ->abstract()
             ->args([
-                '$runtime' => service(Runtime::class),
+                '$platform' => service(Platform::class),
             ])
 
         // stores