refactor: introduce PlatformInterface (#149)

Author: chr-hertel

src/Bridge/OpenAI/PlatformFactory.php

@@ -4,9 +4,9 @@
 
 namespace PhpLlm\LlmChain\Bridge\OpenAI;
 
-use PhpLlm\LlmChain\Bridge\OpenAI\Embeddings\ModelClient;
-use PhpLlm\LlmChain\Bridge\OpenAI\Embeddings\ResponseConverter;
-use PhpLlm\LlmChain\Bridge\OpenAI\GPT\ModelClient as GPTResponseFactory;
+use PhpLlm\LlmChain\Bridge\OpenAI\Embeddings\ModelClient as EmbeddingsModelClient;
+use PhpLlm\LlmChain\Bridge\OpenAI\Embeddings\ResponseConverter as EmbeddingsResponseConverter;
+use PhpLlm\LlmChain\Bridge\OpenAI\GPT\ModelClient as GPTModelClient;
 use PhpLlm\LlmChain\Bridge\OpenAI\GPT\ResponseConverter as GPTResponseConverter;
 use PhpLlm\LlmChain\Platform;
 use Symfony\Component\HttpClient\EventSourceHttpClient;
@@ -18,8 +18,8 @@ public static function create(#[\SensitiveParameter] string $apiKey): Platform
         $httpClient = new EventSourceHttpClient();
 
         return new Platform(
-            [new GPTResponseFactory($httpClient, $apiKey), new ModelClient($httpClient, $apiKey)],
-            [new GPTResponseConverter(), new ResponseConverter()],
+            [new GPTModelClient($httpClient, $apiKey), new EmbeddingsModelClient($httpClient, $apiKey)],
+            [new GPTResponseConverter(), new EmbeddingsResponseConverter()],
         );
     }
 }

src/Chain.php

@@ -33,7 +33,7 @@
      * @param OutputProcessor[] $outputProcessor
      */
     public function __construct(
-        private Platform $platform,
+        private PlatformInterface $platform,
         private LanguageModel $llm,
         iterable $inputProcessor = [],
         iterable $outputProcessor = [],

src/Chain/ToolBox/Tool/SimilaritySearch.php

@@ -8,7 +8,7 @@
 use PhpLlm\LlmChain\Document\Vector;
 use PhpLlm\LlmChain\Document\VectorDocument;
 use PhpLlm\LlmChain\Model\EmbeddingsModel;
-use PhpLlm\LlmChain\Platform;
+use PhpLlm\LlmChain\PlatformInterface;
 use PhpLlm\LlmChain\Store\VectorStoreInterface;
 
 #[AsTool('similarity_search', description: 'Searches for documents similar to a query or sentence.')]
@@ -20,7 +20,7 @@ final class SimilaritySearch
     public array $usedDocuments = [];
 
     public function __construct(
-        private readonly Platform $platform,
+        private readonly PlatformInterface $platform,
         private readonly EmbeddingsModel $embeddings,
         private readonly VectorStoreInterface $vectorStore,
     ) {

src/Embedder.php

@@ -18,7 +18,7 @@
     private ClockInterface $clock;
 
     public function __construct(
-        private Platform $platform,
+        private PlatformInterface $platform,
         private EmbeddingsModel $embeddings,
         private StoreInterface $store,
         ?ClockInterface $clock = null,

src/Platform.php

@@ -15,7 +15,7 @@
 use Symfony\Contracts\HttpClient\Exception\HttpExceptionInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface as HttpResponse;
 
-final readonly class Platform
+final readonly class Platform implements PlatformInterface
 {
     /**
      * @var ModelClient[]
@@ -37,10 +37,6 @@ public function __construct(iterable $modelClients, iterable $responseConverter)
         $this->responseConverter = $responseConverter instanceof \Traversable ? iterator_to_array($responseConverter) : $responseConverter;
     }
 
-    /**
-     * @param array<mixed>|string|object $input
-     * @param array<string, mixed>       $options
-     */
     public function request(Model $model, array|string|object $input, array $options = []): ResponseInterface
     {
         $options = array_merge($model->getOptions(), $options);

src/PlatformInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain;
+
+use PhpLlm\LlmChain\Model\Model;
+use PhpLlm\LlmChain\Model\Response\ResponseInterface;
+
+interface PlatformInterface
+{
+    /**
+     * @param array<mixed>|string|object $input
+     * @param array<string, mixed>       $options
+     */
+    public function request(Model $model, array|string|object $input, array $options = []): ResponseInterface;
+}