refactor: ResponseInterface as Chain return value (#117)

* refactor: ResponseInterface as Chain return value * tests: Add Response Tests (#120) * Add tests * - * - * - * - * - * - * rebase --------- Co-authored-by: Oskar Stark <[email protected]>
php-llm · Oct 5, 2024 · ae5e028 · ae5e028
1 parent c857660
commit ae5e028
Show file tree

Hide file tree

Showing 34 changed files with 331 additions and 240 deletions.
diff --git a/examples/chat-claude-anthropic.php b/examples/chat-claude-anthropic.php
@@ -26,4 +26,4 @@
 );
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/chat-gpt-azure.php b/examples/chat-gpt-azure.php
@@ -33,4 +33,4 @@
 );
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/chat-gpt-openai.php b/examples/chat-gpt-openai.php
@@ -31,4 +31,4 @@
     'max_tokens' => 500, // specific options just for this call
 ]);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/image-describer.php b/examples/image-describer.php
@@ -32,4 +32,4 @@
 );
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/reasoning-openai.php b/examples/reasoning-openai.php
@@ -36,4 +36,4 @@
 
 $response = (new Chain($llm))->call(new MessageBag(Message::ofUser($prompt)));
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/store-mongodb-similarity-search.php b/examples/store-mongodb-similarity-search.php
@@ -74,4 +74,4 @@
 );
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/store-pinecone-similarity-search.php b/examples/store-pinecone-similarity-search.php
@@ -65,4 +65,4 @@
 );
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/stream-claude-anthropic.php b/examples/stream-claude-anthropic.php
@@ -28,9 +28,7 @@
     'stream' => true, // enable streaming of response text
 ]);
 
-assert($response instanceof Generator);
-
-foreach ($response as $word) {
+foreach ($response->getContent() as $word) {
     echo $word;
 }
 echo PHP_EOL;
diff --git a/examples/stream-gpt-openai.php b/examples/stream-gpt-openai.php
@@ -29,9 +29,7 @@
     'stream' => true, // enable streaming of response text
 ]);
 
-assert($response instanceof Generator);
-
-foreach ($response as $word) {
+foreach ($response->getContent() as $word) {
     echo $word;
 }
 echo PHP_EOL;
diff --git a/examples/structured-output-math.php b/examples/structured-output-math.php
@@ -35,4 +35,4 @@
 );
 $response = $chain->call($messages, ['output_structure' => MathReasoning::class]);
 
-dump($response);
+dump($response->getContent());
diff --git a/examples/toolbox-clock.php b/examples/toolbox-clock.php
@@ -33,4 +33,4 @@
 $messages = new MessageBag(Message::ofUser('What date and time is it?'));
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/toolbox-serpapi.php b/examples/toolbox-serpapi.php
@@ -32,4 +32,4 @@
 $messages = new MessageBag(Message::ofUser('Who is the current chancellor of Germany?'));
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/toolbox-weather.php b/examples/toolbox-weather.php
@@ -33,4 +33,4 @@
 $messages = new MessageBag(Message::ofUser('How is the weather currently in Berlin?'));
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/toolbox-wikipedia.php b/examples/toolbox-wikipedia.php
@@ -33,4 +33,4 @@
 $messages = new MessageBag(Message::ofUser('Who is the current chancellor of Germany?'));
 $response = $chain->call($messages);
 
-echo $response.PHP_EOL;
+echo $response->getContent().PHP_EOL;
diff --git a/examples/toolbox-youtube.php b/examples/toolbox-youtube.php
@@ -35,9 +35,7 @@
     'stream' => true, // enable streaming of response text
 ]);
 
-assert($response instanceof Generator);
-
-foreach ($response as $word) {
+foreach ($response->getContent() as $word) {
     echo $word;
 }
 echo PHP_EOL;
diff --git a/src/Anthropic/Model/Claude.php b/src/Anthropic/Model/Claude.php
@@ -8,10 +8,9 @@
 use PhpLlm\LlmChain\Anthropic\Platform;
 use PhpLlm\LlmChain\LanguageModel;
 use PhpLlm\LlmChain\Message\MessageBag;
-use PhpLlm\LlmChain\Response\Choice;
-use PhpLlm\LlmChain\Response\Response;
 use PhpLlm\LlmChain\Response\ResponseInterface;
 use PhpLlm\LlmChain\Response\StreamResponse;
+use PhpLlm\LlmChain\Response\TextResponse;
 
 final class Claude implements LanguageModel
 {
@@ -45,7 +44,7 @@ public function call(MessageBag $messages, array $options = []): ResponseInterfa
             return new StreamResponse($this->convertStream($response));
         }
 
-        return new Response(new Choice($response['content'][0]['text']));
+        return new TextResponse($response['content'][0]['text']);
     }
 
     public function supportsToolCalling(): bool

diff --git a/src/Chain.php b/src/Chain.php
@@ -10,6 +10,7 @@
 use PhpLlm\LlmChain\Chain\OutputProcessor;
 use PhpLlm\LlmChain\Exception\MissingModelSupport;
 use PhpLlm\LlmChain\Message\MessageBag;
+use PhpLlm\LlmChain\Response\ResponseInterface;
 
 final readonly class Chain
 {
@@ -39,7 +40,7 @@ public function __construct(
     /**
      * @param array<string, mixed> $options
      */
-    public function call(MessageBag $messages, array $options = []): string|object
+    public function call(MessageBag $messages, array $options = []): ResponseInterface
     {
         $input = new Input($this->llm, $messages, $options);
         array_map(fn (InputProcessor $processor) => $processor->processInput($input), $this->inputProcessor);
@@ -59,6 +60,6 @@ public function call(MessageBag $messages, array $options = []): string|object
             }
         }
 
-        return $response->getContent();
+        return $response;
     }
 }
diff --git a/src/OpenAI/Model/Gpt.php b/src/OpenAI/Model/Gpt.php
@@ -10,10 +10,12 @@
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
 use PhpLlm\LlmChain\OpenAI\Platform;
 use PhpLlm\LlmChain\Response\Choice;
-use PhpLlm\LlmChain\Response\Response;
+use PhpLlm\LlmChain\Response\ChoiceResponse;
 use PhpLlm\LlmChain\Response\ResponseInterface;
 use PhpLlm\LlmChain\Response\StreamResponse;
+use PhpLlm\LlmChain\Response\TextResponse;
 use PhpLlm\LlmChain\Response\ToolCall;
+use PhpLlm\LlmChain\Response\ToolCallResponse;
 
 final class Gpt implements LanguageModel
 {
@@ -45,7 +47,22 @@ public function call(MessageBag $messages, array $options = []): ResponseInterfa
             return new StreamResponse($this->convertStream($response));
         }
 
-        return new Response(...array_map([$this, 'convertChoice'], $response['choices']));
+        if (!isset($response['choices'])) {
+            throw new RuntimeException('Response does not contain choices');
+        }
+
+        /** @var Choice[] $choices */
+        $choices = array_map([$this, 'convertChoice'], $response['choices']);
+
+        if (1 !== count($choices)) {
+            return new ChoiceResponse(...$choices);
+        }
+
+        if ($choices[0]->hasToolCall()) {
+            return new ToolCallResponse(...$choices[0]->getToolCalls());
+        }
+
+        return new TextResponse($choices[0]->getContent());
     }
 
     public function supportsToolCalling(): bool
@@ -104,7 +121,7 @@ private function convertChoice(array $choice): Choice
             return new Choice($choice['message']['content']);
         }
 
-        throw new RuntimeException('Unsupported finish reason');
+        throw new RuntimeException(sprintf('Unsupported finish reason "%s".', $choice['finish_reason']));
     }
 
     /**

diff --git a/src/Response/ChoiceResponse.php b/src/Response/ChoiceResponse.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Response;
+
+use PhpLlm\LlmChain\Exception\InvalidArgumentException;
+
+final readonly class ChoiceResponse implements ResponseInterface
+{
+    /**
+     * @var Choice[]
+     */
+    private array $choices;
+
+    public function __construct(Choice ...$choices)
+    {
+        if (0 === count($choices)) {
+            throw new InvalidArgumentException('Response must have at least one choice.');
+        }
+
+        $this->choices = $choices;
+    }
+
+    /**
+     * @return Choice[]
+     */
+    public function getContent(): array
+    {
+        return $this->choices;
+    }
+}
diff --git a/src/Response/Response.php b/src/Response/Response.php
diff --git a/src/Response/ResponseInterface.php b/src/Response/ResponseInterface.php
@@ -7,19 +7,7 @@
 interface ResponseInterface
 {
     /**
-     * @return Choice[]
+     * @return string|iterable<mixed>|object|null
      */
-    public function getChoices(): array;
-
-    /**
-     * @return string|iterable<string>|null
-     */
-    public function getContent(): string|iterable|null;
-
-    /**
-     * @return ToolCall[]
-     */
-    public function getToolCalls(): array;
-
-    public function hasToolCalls(): bool;
+    public function getContent(): string|iterable|object|null;
 }
diff --git a/src/Response/StreamResponse.php b/src/Response/StreamResponse.php
@@ -11,23 +11,8 @@ public function __construct(
     ) {
     }
 
-    public function getChoices(): array
-    {
-        throw new \LogicException('Stream response does not have choices');
-    }
-
     public function getContent(): \Generator
     {
         yield from $this->generator;
     }
-
-    public function getToolCalls(): array
-    {
-        return [];
-    }
-
-    public function hasToolCalls(): bool
-    {
-        return false;
-    }
 }
diff --git a/src/Response/StructuredResponse.php b/src/Response/StructuredResponse.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Response;
+
+final readonly class StructuredResponse implements ResponseInterface
+{
+    /**
+     * @param object|array<string, mixed> $structuredOutput
+     */
+    public function __construct(
+        private object|array $structuredOutput,
+    ) {
+    }
+
+    /**
+     * @return object|array<string, mixed>
+     */
+    public function getContent(): object|array
+    {
+        return $this->structuredOutput;
+    }
+}
diff --git a/src/Response/TextResponse.php b/src/Response/TextResponse.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Response;
+
+final readonly class TextResponse implements ResponseInterface
+{
+    public function __construct(
+        private string $content,
+    ) {
+    }
+
+    public function getContent(): string
+    {
+        return $this->content;
+    }
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,4 @@

		$response = (new Chain($llm))->call(new MessageBag(Message::ofUser($prompt)));

		echo $response.PHP_EOL;
		echo $response->getContent().PHP_EOL;