refactor: rename Runtime to Platform (#34)

OskarStark · web-flow · commit ce897978fcfa · 2024-09-25T18:31:52.000+02:00
diff --git a/README.md b/README.md
@@ -21,19 +21,19 @@ composer require php-llm/llm-chain
 
 When using Symfony Framework, check out the integration bundle [php-llm/llm-chain-bundle](https://github.com/php-llm/llm-chain-bundle).
 
-Supported Models & Runtimes
----------------------------
+Supported Models & Platforms
+----------------------------
 
-Currently supported models and runtimes:
+Currently supported models and platforms:
 
-| Vendor         | Model                  | Runtime                          |
-|----------------|------------------------|----------------------------------|
-| **OpenAI**     | - GPT<br/>- Embeddings | - OpenAI<br/>- Azure             |
-| **Anthropic**  | - Claude | - Anthropic  |
+| Vendor         | Model                  | Platform             |
+|----------------|------------------------|----------------------|
+| **OpenAI**     | - GPT<br/>- Embeddings | - OpenAI<br/>- Azure |
+| **Anthropic**  | - Claude | - Anthropic          |
 
-Planned Models & Runtimes (not implemented yet):
+Planned Models & Platforms (not implemented yet):
 
-| Vendor         | Model                  | Runtime                          |
+| Vendor         | Model                  | Platform                         |
 |----------------|------------------------|----------------------------------|
 | **Anthropic**  | - Voyage | - GPC<br/>- AWS                  |
 | **Google**     | - Gemini<br/>- Gemma | - GPC                            |
diff --git a/examples/chat-claude-anthropic.php b/examples/chat-claude-anthropic.php
@@ -1,16 +1,16 @@
 <?php
 
 use PhpLlm\LlmChain\Anthropic\Model\Claude;
-use PhpLlm\LlmChain\Anthropic\Runtime\Anthropic;
+use PhpLlm\LlmChain\Anthropic\Platform\Anthropic;
 use PhpLlm\LlmChain\Chain;
 use PhpLlm\LlmChain\Message\Message;
 use PhpLlm\LlmChain\Message\MessageBag;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
-$runtime = new Anthropic(HttpClient::create(), getenv('ANTHROPIC_API_KEY'));
-$llm = new Claude($runtime);
+$platform = new Anthropic(HttpClient::create(), getenv('ANTHROPIC_API_KEY'));
+$llm = new Claude($platform);
 
 $chain = new Chain($llm);
 $messages = new MessageBag(
diff --git a/examples/chat-gpt-azure.php b/examples/chat-gpt-azure.php
@@ -5,18 +5,18 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime\Azure;
+use PhpLlm\LlmChain\OpenAI\Platform\Azure;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
-$runtime = new Azure(HttpClient::create(),
+$platform = new Azure(HttpClient::create(),
     getenv('AZURE_OPENAI_BASEURL'),
     getenv('AZURE_OPENAI_DEPLOYMENT'),
     getenv('AZURE_OPENAI_VERSION'),
     getenv('AZURE_OPENAI_KEY')
 );
-$llm = new Gpt($runtime, Version::gpt4oMini());
+$llm = new Gpt($platform, Version::gpt4oMini());
 
 $chain = new Chain($llm);
 $messages = new MessageBag(
diff --git a/examples/chat-gpt-openai.php b/examples/chat-gpt-openai.php
@@ -5,13 +5,13 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
-$runtime = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
-$llm = new Gpt($runtime, Version::gpt4oMini());
+$platform = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
+$llm = new Gpt($platform, Version::gpt4oMini());
 
 $chain = new Chain($llm);
 $messages = new MessageBag(
diff --git a/examples/structured-output-math.php b/examples/structured-output-math.php
@@ -5,7 +5,7 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
 use PhpLlm\LlmChain\StructuredOutput\ResponseFormatFactory;
 use PhpLlm\LlmChain\StructuredOutput\SchemaFactory;
 use PhpLlm\LlmChain\Tests\StructuredOutput\Data\MathReasoning;
@@ -16,8 +16,8 @@
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
-$runtime = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
-$llm = new Gpt($runtime, Version::gpt4oMini());
+$platform = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
+$llm = new Gpt($platform, Version::gpt4oMini());
 $responseFormatFactory = new ResponseFormatFactory(SchemaFactory::create());
 $serializer = new Serializer([new ObjectNormalizer()], [new JsonEncoder()]);
 
diff --git a/examples/toolbox-clock.php b/examples/toolbox-clock.php
@@ -5,7 +5,7 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
 use PhpLlm\LlmChain\ToolBox\Tool\Clock;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
@@ -14,8 +14,8 @@
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
-$runtime = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
-$llm = new Gpt($runtime, Version::gpt4oMini());
+$platform = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
+$llm = new Gpt($platform, Version::gpt4oMini());
 
 $clock = new Clock(new SymfonyClock());
 $toolBox = new ToolBox(new ToolAnalyzer(), [$clock]);
diff --git a/examples/toolbox-serpapi.php b/examples/toolbox-serpapi.php
@@ -5,7 +5,7 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
 use PhpLlm\LlmChain\ToolBox\Tool\SerpApi;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
@@ -14,8 +14,8 @@
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
 $httpClient = HttpClient::create();
-$runtime = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
-$llm = new Gpt($runtime, Version::gpt4oMini());
+$platform = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
+$llm = new Gpt($platform, Version::gpt4oMini());
 
 $serpApi = new SerpApi($httpClient, getenv('SERP_API_KEY'));
 $toolBox = new ToolBox(new ToolAnalyzer(), [$serpApi]);
diff --git a/examples/toolbox-weather.php b/examples/toolbox-weather.php
@@ -5,7 +5,7 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
 use PhpLlm\LlmChain\ToolBox\Tool\OpenMeteo;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
@@ -14,8 +14,8 @@
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
 $httpClient = HttpClient::create();
-$runtime = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
-$llm = new Gpt($runtime, Version::gpt4oMini());
+$platform = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
+$llm = new Gpt($platform, Version::gpt4oMini());
 
 $wikipedia = new OpenMeteo($httpClient);
 $toolBox = new ToolBox(new ToolAnalyzer(), [$wikipedia]);
diff --git a/examples/toolbox-wikipedia.php b/examples/toolbox-wikipedia.php
@@ -5,7 +5,7 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
 use PhpLlm\LlmChain\ToolBox\Tool\Wikipedia;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
@@ -14,8 +14,8 @@
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
 $httpClient = HttpClient::create();
-$runtime = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
-$llm = new Gpt($runtime, Version::gpt4oMini());
+$platform = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
+$llm = new Gpt($platform, Version::gpt4oMini());
 
 $wikipedia = new Wikipedia($httpClient);
 $toolBox = new ToolBox(new ToolAnalyzer(), [$wikipedia]);
diff --git a/examples/toolbox-youtube.php b/examples/toolbox-youtube.php
@@ -5,7 +5,7 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI;
+use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
 use PhpLlm\LlmChain\ToolBox\Tool\YouTubeTranscriber;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
@@ -14,8 +14,8 @@
 require_once dirname(__DIR__).'/vendor/autoload.php';
 
 $httpClient = HttpClient::create();
-$runtime = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
-$llm = new Gpt($runtime, Version::gpt4oMini());
+$platform = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
+$llm = new Gpt($platform, Version::gpt4oMini());
 
 $transcriber = new YouTubeTranscriber($httpClient);
 $toolBox = new ToolBox(new ToolAnalyzer(), [$transcriber]);
diff --git a/src/Anthropic/ClaudePlatform.php b/src/Anthropic/ClaudePlatform.php
@@ -4,7 +4,7 @@
 
 namespace PhpLlm\LlmChain\Anthropic;
 
-interface ClaudeRuntime
+interface ClaudePlatform
 {
     /**
      * @param array<string, mixed> $body
diff --git a/src/Anthropic/Model/Claude.php b/src/Anthropic/Model/Claude.php
@@ -4,7 +4,7 @@
 
 namespace PhpLlm\LlmChain\Anthropic\Model;
 
-use PhpLlm\LlmChain\Anthropic\ClaudeRuntime;
+use PhpLlm\LlmChain\Anthropic\ClaudePlatform;
 use PhpLlm\LlmChain\Anthropic\Model\Claude\Version;
 use PhpLlm\LlmChain\LanguageModel;
 use PhpLlm\LlmChain\Message\MessageBag;
@@ -14,7 +14,7 @@
 final class Claude implements LanguageModel
 {
     public function __construct(
-        private readonly ClaudeRuntime $runtime,
+        private readonly ClaudePlatform $platform,
         private ?Version $version = null,
         private readonly float $temperature = 1.0,
         private readonly int $maxTokens = 1000,
@@ -33,7 +33,7 @@ public function call(MessageBag $messages, array $options = []): Response
             'messages' => $messages->withoutSystemMessage(),
         ];
 
-        $response = $this->runtime->request(array_merge($body, $options));
+        $response = $this->platform->request(array_merge($body, $options));
 
         return new Response(new Choice($response['content'][0]['text']));
     }
diff --git a/src/Anthropic/Platform/Anthropic.php b/src/Anthropic/Platform/Anthropic.php
@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace PhpLlm\LlmChain\Anthropic\Runtime;
+namespace PhpLlm\LlmChain\Anthropic\Platform;
 
-use PhpLlm\LlmChain\Anthropic\ClaudeRuntime;
+use PhpLlm\LlmChain\Anthropic\ClaudePlatform;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
-final readonly class Anthropic implements ClaudeRuntime
+final readonly class Anthropic implements ClaudePlatform
 {
     public function __construct(
         private HttpClientInterface $httpClient,
diff --git a/src/OpenAI/Model/Embeddings.php b/src/OpenAI/Model/Embeddings.php
@@ -7,20 +7,20 @@
 use PhpLlm\LlmChain\Document\Vector;
 use PhpLlm\LlmChain\EmbeddingModel;
 use PhpLlm\LlmChain\OpenAI\Model\Embeddings\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime;
+use PhpLlm\LlmChain\OpenAI\Platform;
 
 final class Embeddings implements EmbeddingModel
 {
     public function __construct(
-        private readonly Runtime $runtime,
+        private readonly Platform $platform,
         private ?Version $version = null,
     ) {
         $this->version ??= Version::textEmbedding3Small();
     }
 
     public function create(string $text): Vector
     {
-        $response = $this->runtime->request('embeddings', $this->createBody($text));
+        $response = $this->platform->request('embeddings', $this->createBody($text));
 
         return $this->extractVector($response);
     }
@@ -30,7 +30,7 @@ public function multiCreate(array $texts): array
         $bodies = array_map([$this, 'createBody'], $texts);
 
         $vectors = [];
-        foreach ($this->runtime->multiRequest('embeddings', $bodies) as $response) {
+        foreach ($this->platform->multiRequest('embeddings', $bodies) as $response) {
             $vectors[] = $this->extractVector($response);
         }
 
diff --git a/src/OpenAI/Model/Gpt.php b/src/OpenAI/Model/Gpt.php
@@ -7,15 +7,15 @@
 use PhpLlm\LlmChain\LanguageModel;
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
-use PhpLlm\LlmChain\OpenAI\Runtime;
+use PhpLlm\LlmChain\OpenAI\Platform;
 use PhpLlm\LlmChain\Response\Choice;
 use PhpLlm\LlmChain\Response\Response;
 use PhpLlm\LlmChain\Response\ToolCall;
 
 final class Gpt implements LanguageModel
 {
     public function __construct(
-        private readonly Runtime $runtime,
+        private readonly Platform $platform,
         private ?Version $version = null,
         private readonly float $temperature = 1.0,
     ) {
@@ -30,7 +30,7 @@ public function call(MessageBag $messages, array $options = []): Response
             'messages' => $messages,
         ];
 
-        $response = $this->runtime->request('chat/completions', array_merge($body, $options));
+        $response = $this->platform->request('chat/completions', array_merge($body, $options));
 
         return new Response(...array_map([$this, 'convertChoice'], $response['choices']));
     }
diff --git a/src/OpenAI/Platform.php b/src/OpenAI/Platform.php
@@ -4,7 +4,7 @@
 
 namespace PhpLlm\LlmChain\OpenAI;
 
-interface Runtime
+interface Platform
 {
     /**
      * @param array<string, mixed> $body
diff --git a/src/OpenAI/Platform/AbstractPlatform.php b/src/OpenAI/Platform/AbstractPlatform.php
@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace PhpLlm\LlmChain\OpenAI\Runtime;
+namespace PhpLlm\LlmChain\OpenAI\Platform;
 
-use PhpLlm\LlmChain\OpenAI\Runtime;
+use PhpLlm\LlmChain\OpenAI\Platform;
 use Symfony\Component\HttpClient\Exception\ClientException;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
-abstract class AbstractRuntime implements Runtime
+abstract class AbstractPlatform implements Platform
 {
     public function request(string $endpoint, array $body): array
     {
diff --git a/src/OpenAI/Platform/Azure.php b/src/OpenAI/Platform/Azure.php
@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace PhpLlm\LlmChain\OpenAI\Runtime;
+namespace PhpLlm\LlmChain\OpenAI\Platform;
 
-use PhpLlm\LlmChain\OpenAI\Runtime;
+use PhpLlm\LlmChain\OpenAI\Platform;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
-final class Azure extends AbstractRuntime implements Runtime
+final class Azure extends AbstractPlatform implements Platform
 {
     public function __construct(
         private readonly HttpClientInterface $httpClient,
diff --git a/src/OpenAI/Platform/OpenAI.php b/src/OpenAI/Platform/OpenAI.php
@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace PhpLlm\LlmChain\OpenAI\Runtime;
+namespace PhpLlm\LlmChain\OpenAI\Platform;
 
-use PhpLlm\LlmChain\OpenAI\Runtime;
+use PhpLlm\LlmChain\OpenAI\Platform;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
-final class OpenAI extends AbstractRuntime implements Runtime
+final class OpenAI extends AbstractPlatform implements Platform
 {
     public function __construct(
         private readonly HttpClientInterface $httpClient,

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace PhpLlm\LlmChain\Anthropic;`
`6`	`6`
`7`		`-interface ClaudeRuntime`
	`7`	`+interface ClaudePlatform`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`	`10`	`* @param array<string, mixed> $body`
Original file line number	Diff line number	Diff line change
`@@ -7,20 +7,20 @@`
`7`	`7`	`use PhpLlm\LlmChain\Document\Vector;`
`8`	`8`	`use PhpLlm\LlmChain\EmbeddingModel;`
`9`	`9`	`use PhpLlm\LlmChain\OpenAI\Model\Embeddings\Version;`
`10`		`-use PhpLlm\LlmChain\OpenAI\Runtime;`
	`10`	`+use PhpLlm\LlmChain\OpenAI\Platform;`
`11`	`11`
`12`	`12`	`final class Embeddings implements EmbeddingModel`
`13`	`13`	`{`
`14`	`14`	`public function __construct(`
`15`		`- private readonly Runtime $runtime,`
	`15`	`+ private readonly Platform $platform,`
`16`	`16`	`private ?Version $version = null,`
`17`	`17`	`) {`
`18`	`18`	`$this->version ??= Version::textEmbedding3Small();`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`public function create(string $text): Vector`
`22`	`22`	`{`
`23`		`- $response = $this->runtime->request('embeddings', $this->createBody($text));`
	`23`	`+ $response = $this->platform->request('embeddings', $this->createBody($text));`
`24`	`24`
`25`	`25`	`return $this->extractVector($response);`
`26`	`26`	`}`
`@@ -30,7 +30,7 @@ public function multiCreate(array $texts): array`
`30`	`30`	`$bodies = array_map([$this, 'createBody'], $texts);`
`31`	`31`
`32`	`32`	`$vectors = [];`
`33`		`- foreach ($this->runtime->multiRequest('embeddings', $bodies) as $response) {`
	`33`	`+ foreach ($this->platform->multiRequest('embeddings', $bodies) as $response) {`
`34`	`34`	`$vectors[] = $this->extractVector($response);`
`35`	`35`	`}`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace PhpLlm\LlmChain\OpenAI;`
`6`	`6`
`7`		`-interface Runtime`
	`7`	`+interface Platform`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`	`10`	`* @param array<string, mixed> $body`
Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,13 @@`
`2`	`2`
`3`	`3`	`declare(strict_types=1);`
`4`	`4`
`5`		`-namespace PhpLlm\LlmChain\OpenAI\Runtime;`
	`5`	`+namespace PhpLlm\LlmChain\OpenAI\Platform;`
`6`	`6`
`7`		`-use PhpLlm\LlmChain\OpenAI\Runtime;`
	`7`	`+use PhpLlm\LlmChain\OpenAI\Platform;`
`8`	`8`	`use Symfony\Component\HttpClient\Exception\ClientException;`
`9`	`9`	`use Symfony\Contracts\HttpClient\ResponseInterface;`
`10`	`10`
`11`		`-abstract class AbstractRuntime implements Runtime`
	`11`	`+abstract class AbstractPlatform implements Platform`
`12`	`12`	`{`
`13`	`13`	`public function request(string $endpoint, array $body): array`
`14`	`14`	`{`