feat: Enhancement: Add MessageBagInterface (#166)

OskarStark · web-flow · commit f064e67a10ae · 2024-12-28T23:43:20.000+01:00
diff --git a/src/Bridge/Anthropic/ModelHandler.php b/src/Bridge/Anthropic/ModelHandler.php
@@ -5,7 +5,7 @@
 namespace PhpLlm\LlmChain\Bridge\Anthropic;
 
 use PhpLlm\LlmChain\Exception\RuntimeException;
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 use PhpLlm\LlmChain\Model\Model;
 use PhpLlm\LlmChain\Model\Response\ResponseInterface as LlmResponse;
 use PhpLlm\LlmChain\Model\Response\StreamResponse;
@@ -33,12 +33,12 @@ public function __construct(
 
     public function supports(Model $model, array|string|object $input): bool
     {
-        return $model instanceof Claude && $input instanceof MessageBag;
+        return $model instanceof Claude && $input instanceof MessageBagInterface;
     }
 
     public function request(Model $model, object|array|string $input, array $options = []): ResponseInterface
     {
-        Assert::isInstanceOf($input, MessageBag::class);
+        Assert::isInstanceOf($input, MessageBagInterface::class);
 
         $system = $input->getSystemMessage();
         $body = array_merge($options, [
diff --git a/src/Bridge/Meta/LlamaPromptConverter.php b/src/Bridge/Meta/LlamaPromptConverter.php
@@ -8,13 +8,13 @@
 use PhpLlm\LlmChain\Model\Message\AssistantMessage;
 use PhpLlm\LlmChain\Model\Message\Content\Image;
 use PhpLlm\LlmChain\Model\Message\Content\Text;
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 use PhpLlm\LlmChain\Model\Message\SystemMessage;
 use PhpLlm\LlmChain\Model\Message\UserMessage;
 
 final class LlamaPromptConverter
 {
-    public function convertToPrompt(MessageBag $messageBag): string
+    public function convertToPrompt(MessageBagInterface $messageBag): string
     {
         $messages = [];
 
diff --git a/src/Bridge/Ollama/LlamaModelHandler.php b/src/Bridge/Ollama/LlamaModelHandler.php
@@ -6,7 +6,7 @@
 
 use PhpLlm\LlmChain\Bridge\Meta\Llama;
 use PhpLlm\LlmChain\Exception\RuntimeException;
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 use PhpLlm\LlmChain\Model\Model;
 use PhpLlm\LlmChain\Model\Response\ResponseInterface as LlmResponse;
 use PhpLlm\LlmChain\Model\Response\TextResponse;
@@ -25,7 +25,7 @@ public function __construct(
 
     public function supports(Model $model, object|array|string $input): bool
     {
-        return $model instanceof Llama && $input instanceof MessageBag;
+        return $model instanceof Llama && $input instanceof MessageBagInterface;
     }
 
     public function request(Model $model, object|array|string $input, array $options = []): ResponseInterface
diff --git a/src/Bridge/Replicate/LlamaModelClient.php b/src/Bridge/Replicate/LlamaModelClient.php
@@ -6,7 +6,7 @@
 
 use PhpLlm\LlmChain\Bridge\Meta\Llama;
 use PhpLlm\LlmChain\Bridge\Meta\LlamaPromptConverter;
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 use PhpLlm\LlmChain\Model\Message\SystemMessage;
 use PhpLlm\LlmChain\Model\Model;
 use PhpLlm\LlmChain\Platform\ModelClient;
@@ -23,13 +23,13 @@ public function __construct(
 
     public function supports(Model $model, object|array|string $input): bool
     {
-        return $model instanceof Llama && $input instanceof MessageBag;
+        return $model instanceof Llama && $input instanceof MessageBagInterface;
     }
 
     public function request(Model $model, object|array|string $input, array $options = []): ResponseInterface
     {
         Assert::isInstanceOf($model, Llama::class);
-        Assert::isInstanceOf($input, MessageBag::class);
+        Assert::isInstanceOf($input, MessageBagInterface::class);
 
         return $this->client->request(sprintf('meta/meta-%s', $model->getVersion()), 'predictions', [
             'system' => $this->promptConverter->convertMessage($input->getSystemMessage() ?? new SystemMessage('')),
diff --git a/src/Bridge/Replicate/LlamaResponseConverter.php b/src/Bridge/Replicate/LlamaResponseConverter.php
@@ -6,7 +6,7 @@
 
 use PhpLlm\LlmChain\Bridge\Meta\Llama;
 use PhpLlm\LlmChain\Exception\RuntimeException;
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 use PhpLlm\LlmChain\Model\Model;
 use PhpLlm\LlmChain\Model\Response\ResponseInterface as LlmResponse;
 use PhpLlm\LlmChain\Model\Response\TextResponse;
@@ -17,7 +17,7 @@
 {
     public function supports(Model $model, object|array|string $input): bool
     {
-        return $model instanceof Llama && $input instanceof MessageBag;
+        return $model instanceof Llama && $input instanceof MessageBagInterface;
     }
 
     public function convert(HttpResponse $response, array $options = []): LlmResponse
diff --git a/src/Chain.php b/src/Chain.php
@@ -12,7 +12,7 @@
 use PhpLlm\LlmChain\Exception\InvalidArgumentException;
 use PhpLlm\LlmChain\Exception\MissingModelSupport;
 use PhpLlm\LlmChain\Model\LanguageModel;
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 use PhpLlm\LlmChain\Model\Response\AsyncResponse;
 use PhpLlm\LlmChain\Model\Response\ResponseInterface;
 
@@ -45,7 +45,7 @@ public function __construct(
     /**
      * @param array<string, mixed> $options
      */
-    public function call(MessageBag $messages, array $options = []): ResponseInterface
+    public function call(MessageBagInterface $messages, array $options = []): ResponseInterface
     {
         $llm = $this->llm;
 
diff --git a/src/Chain/Input.php b/src/Chain/Input.php
@@ -5,7 +5,7 @@
 namespace PhpLlm\LlmChain\Chain;
 
 use PhpLlm\LlmChain\Model\LanguageModel;
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 
 final class Input
 {
@@ -14,7 +14,7 @@ final class Input
      */
     public function __construct(
         public readonly LanguageModel $llm,
-        public readonly MessageBag $messages,
+        public readonly MessageBagInterface $messages,
         private array $options,
     ) {
     }
diff --git a/src/Chain/Output.php b/src/Chain/Output.php
@@ -5,7 +5,7 @@
 namespace PhpLlm\LlmChain\Chain;
 
 use PhpLlm\LlmChain\Model\LanguageModel;
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 use PhpLlm\LlmChain\Model\Response\ResponseInterface;
 
 final class Output
@@ -16,7 +16,7 @@ final class Output
     public function __construct(
         public readonly LanguageModel $llm,
         public ResponseInterface $response,
-        public readonly MessageBag $messages,
+        public readonly MessageBagInterface $messages,
         public readonly array $options,
     ) {
     }
diff --git a/src/ChainInterface.php b/src/ChainInterface.php
@@ -4,13 +4,13 @@
 
 namespace PhpLlm\LlmChain;
 
-use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;
 use PhpLlm\LlmChain\Model\Response\ResponseInterface;
 
 interface ChainInterface
 {
     /**
      * @param array<string, mixed> $options
      */
-    public function call(MessageBag $messages, array $options = []): ResponseInterface;
+    public function call(MessageBagInterface $messages, array $options = []): ResponseInterface;
 }
diff --git a/src/Model/Message/MessageBag.php b/src/Model/Message/MessageBag.php
@@ -4,10 +4,10 @@
 
 namespace PhpLlm\LlmChain\Model\Message;
 
-final class MessageBag implements \Countable, \JsonSerializable
+final class MessageBag implements MessageBagInterface
 {
     /**
-     * @var MessageInterface[]
+     * @var list<MessageInterface>
      */
     private array $messages;
 
@@ -22,7 +22,7 @@ public function add(MessageInterface $message): void
     }
 
     /**
-     * @return MessageInterface[]
+     * @return list<MessageInterface>
      */
     public function getMessages(): array
     {
@@ -48,7 +48,7 @@ public function with(MessageInterface $message): self
         return $messages;
     }
 
-    public function merge(MessageBag $messageBag): self
+    public function merge(MessageBagInterface $messageBag): self
     {
         $messages = clone $this;
         $messages->messages = array_merge($messages->messages, $messageBag->getMessages());
diff --git a/src/Model/Message/MessageBagInterface.php b/src/Model/Message/MessageBagInterface.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Model\Message;
+
+interface MessageBagInterface extends \JsonSerializable, \Countable
+{
+    public function add(MessageInterface $message): void;
+
+    /**
+     * @return list<MessageInterface>
+     */
+    public function getMessages(): array;
+
+    public function getSystemMessage(): ?SystemMessage;
+
+    public function with(MessageInterface $message): self;
+
+    public function merge(MessageBagInterface $messageBag): self;
+
+    public function withoutSystemMessage(): self;
+
+    public function prepend(MessageInterface $message): self;
+
+    public function containsImage(): bool;
+}

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace PhpLlm\LlmChain\Bridge\Anthropic;`
`6`	`6`
`7`	`7`	`use PhpLlm\LlmChain\Exception\RuntimeException;`
`8`		`-use PhpLlm\LlmChain\Model\Message\MessageBag;`
	`8`	`+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;`
`9`	`9`	`use PhpLlm\LlmChain\Model\Model;`
`10`	`10`	`use PhpLlm\LlmChain\Model\Response\ResponseInterface as LlmResponse;`
`11`	`11`	`use PhpLlm\LlmChain\Model\Response\StreamResponse;`
`@@ -33,12 +33,12 @@ public function __construct(`
`33`	`33`
`34`	`34`	`public function supports(Model $model, array\|string\|object $input): bool`
`35`	`35`	`{`
`36`		`- return $model instanceof Claude && $input instanceof MessageBag;`
	`36`	`+ return $model instanceof Claude && $input instanceof MessageBagInterface;`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`public function request(Model $model, object\|array\|string $input, array $options = []): ResponseInterface`
`40`	`40`	`{`
`41`		`- Assert::isInstanceOf($input, MessageBag::class);`
	`41`	`+ Assert::isInstanceOf($input, MessageBagInterface::class);`
`42`	`42`
`43`	`43`	`$system = $input->getSystemMessage();`
`44`	`44`	`$body = array_merge($options, [`
Original file line number	Diff line number	Diff line change
`@@ -8,13 +8,13 @@`
`8`	`8`	`use PhpLlm\LlmChain\Model\Message\AssistantMessage;`
`9`	`9`	`use PhpLlm\LlmChain\Model\Message\Content\Image;`
`10`	`10`	`use PhpLlm\LlmChain\Model\Message\Content\Text;`
`11`		`-use PhpLlm\LlmChain\Model\Message\MessageBag;`
	`11`	`+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;`
`12`	`12`	`use PhpLlm\LlmChain\Model\Message\SystemMessage;`
`13`	`13`	`use PhpLlm\LlmChain\Model\Message\UserMessage;`
`14`	`14`
`15`	`15`	`final class LlamaPromptConverter`
`16`	`16`	`{`
`17`		`- public function convertToPrompt(MessageBag $messageBag): string`
	`17`	`+ public function convertToPrompt(MessageBagInterface $messageBag): string`
`18`	`18`	`{`
`19`	`19`	`$messages = [];`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`use PhpLlm\LlmChain\Bridge\Meta\Llama;`
`8`	`8`	`use PhpLlm\LlmChain\Exception\RuntimeException;`
`9`		`-use PhpLlm\LlmChain\Model\Message\MessageBag;`
	`9`	`+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;`
`10`	`10`	`use PhpLlm\LlmChain\Model\Model;`
`11`	`11`	`use PhpLlm\LlmChain\Model\Response\ResponseInterface as LlmResponse;`
`12`	`12`	`use PhpLlm\LlmChain\Model\Response\TextResponse;`
`@@ -25,7 +25,7 @@ public function __construct(`
`25`	`25`
`26`	`26`	`public function supports(Model $model, object\|array\|string $input): bool`
`27`	`27`	`{`
`28`		`- return $model instanceof Llama && $input instanceof MessageBag;`
	`28`	`+ return $model instanceof Llama && $input instanceof MessageBagInterface;`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`public function request(Model $model, object\|array\|string $input, array $options = []): ResponseInterface`
Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`
`5`	`5`	`namespace PhpLlm\LlmChain;`
`6`	`6`
`7`		`-use PhpLlm\LlmChain\Model\Message\MessageBag;`
	`7`	`+use PhpLlm\LlmChain\Model\Message\MessageBagInterface;`
`8`	`8`	`use PhpLlm\LlmChain\Model\Response\ResponseInterface;`
`9`	`9`
`10`	`10`	`interface ChainInterface`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`	`13`	`* @param array<string, mixed> $options`
`14`	`14`	`*/`
`15`		`- public function call(MessageBag $messages, array $options = []): ResponseInterface;`
	`15`	`+ public function call(MessageBagInterface $messages, array $options = []): ResponseInterface;`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,10 @@`
`4`	`4`
`5`	`5`	`namespace PhpLlm\LlmChain\Model\Message;`
`6`	`6`
`7`		`-final class MessageBag implements \Countable, \JsonSerializable`
	`7`	`+final class MessageBag implements MessageBagInterface`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`		`- * @var MessageInterface[]`
	`10`	`+ * @var list<MessageInterface>`
`11`	`11`	`*/`
`12`	`12`	`private array $messages;`
`13`	`13`
`@@ -22,7 +22,7 @@ public function add(MessageInterface $message): void`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`/**`
`25`		`- * @return MessageInterface[]`
	`25`	`+ * @return list<MessageInterface>`
`26`	`26`	`*/`
`27`	`27`	`public function getMessages(): array`
`28`	`28`	`{`
`@@ -48,7 +48,7 @@ public function with(MessageInterface $message): self`
`48`	`48`	`return $messages;`
`49`	`49`	`}`
`50`	`50`
`51`		`- public function merge(MessageBag $messageBag): self`
	`51`	`+ public function merge(MessageBagInterface $messageBag): self`
`52`	`52`	`{`
`53`	`53`	`$messages = clone $this;`
`54`	`54`	`$messages->messages = array_merge($messages->messages, $messageBag->getMessages());`