feature #345 [Agent][Platform] Add Metadata to MessageBag (VincentLanglet)

This PR was squashed before being merged into the main branch.

Discussion
----------

[Agent][Platform] Add `Metadata` to `MessageBag`

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Docs?         | yes
| Issues        | Fix #344
| License       | MIT

Commits
-------

30cfcb8 [Agent][Platform] Add `Metadata` to `MessageBag`

Author: chr-hertel

src/agent/tests/StructuredOutput/AgentProcessorTest.php

@@ -23,8 +23,8 @@
 use Symfony\AI\Fixtures\StructuredOutput\Step;
 use Symfony\AI\Platform\Capability;
 use Symfony\AI\Platform\Message\MessageBag;
+use Symfony\AI\Platform\Metadata\Metadata;
 use Symfony\AI\Platform\Model;
-use Symfony\AI\Platform\Result\Metadata\Metadata;
 use Symfony\AI\Platform\Result\ObjectResult;
 use Symfony\AI\Platform\Result\TextResult;
 use Symfony\Component\Serializer\SerializerInterface;

src/platform/src/Message/MessageBag.php

@@ -11,13 +11,17 @@
 
 namespace Symfony\AI\Platform\Message;
 
+use Symfony\AI\Platform\Metadata\MetadataAwareTrait;
+
 /**
  * @final
  *
  * @author Christopher Hertel <mail@christopher-hertel.de>
  */
 class MessageBag implements MessageBagInterface
 {
+    use MetadataAwareTrait;
+
     /**
      * @var list<MessageInterface>
      */

src/platform/src/Message/MessageBagInterface.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\AI\Platform\Message;
 
+use Symfony\AI\Platform\Metadata\Metadata;
+
 /**
  * @author Oskar Stark <oskarstark@googlemail.com>
  */
@@ -36,4 +38,6 @@ public function prepend(MessageInterface $message): self;
     public function containsAudio(): bool;
 
     public function containsImage(): bool;
+
+    public function getMetadata(): Metadata;
 }

src/platform/src/Result/Metadata/Metadata.php renamed to src/platform/src/Metadata/Metadata.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\AI\Platform\Result\Metadata;
+namespace Symfony\AI\Platform\Metadata;
 
 /**
  * @implements \IteratorAggregate<string, mixed>

src/platform/src/Result/Metadata/MetadataAwareTrait.php renamed to src/platform/src/Metadata/MetadataAwareTrait.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\AI\Platform\Result\Metadata;
+namespace Symfony\AI\Platform\Metadata;
 
 /**
  * @author Denis Zunke <denis.zunke@gmail.com>

src/platform/src/Result/BaseResult.php

@@ -11,7 +11,7 @@
 
 namespace Symfony\AI\Platform\Result;
 
-use Symfony\AI\Platform\Result\Metadata\MetadataAwareTrait;
+use Symfony\AI\Platform\Metadata\MetadataAwareTrait;
 
 /**
  * Base result of converted result classes.

src/platform/src/Result/ResultInterface.php

@@ -11,8 +11,8 @@
 
 namespace Symfony\AI\Platform\Result;
 
+use Symfony\AI\Platform\Metadata\Metadata;
 use Symfony\AI\Platform\Result\Exception\RawResultAlreadySetException;
-use Symfony\AI\Platform\Result\Metadata\Metadata;
 
 /**
  * @author Christopher Hertel <mail@christopher-hertel.de>

src/platform/tests/Bridge/Mistral/TokenOutputProcessorTest.php

@@ -18,8 +18,8 @@
 use Symfony\AI\Agent\Output;
 use Symfony\AI\Platform\Bridge\Mistral\TokenOutputProcessor;
 use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Metadata\Metadata;
 use Symfony\AI\Platform\Model;
-use Symfony\AI\Platform\Result\Metadata\Metadata;
 use Symfony\AI\Platform\Result\Metadata\TokenUsage;
 use Symfony\AI\Platform\Result\RawHttpResult;
 use Symfony\AI\Platform\Result\ResultInterface;

src/platform/tests/Bridge/OpenAi/TokenOutputProcessorTest.php

@@ -18,8 +18,8 @@
 use Symfony\AI\Agent\Output;
 use Symfony\AI\Platform\Bridge\OpenAi\TokenOutputProcessor;
 use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Metadata\Metadata;
 use Symfony\AI\Platform\Model;
-use Symfony\AI\Platform\Result\Metadata\Metadata;
 use Symfony\AI\Platform\Result\Metadata\TokenUsage;
 use Symfony\AI\Platform\Result\RawHttpResult;
 use Symfony\AI\Platform\Result\ResultInterface;

src/platform/tests/Message/MessageBagTest.php

@@ -166,4 +166,17 @@ public function testContainsImageReturnsTrueWithImage()
 
         $this->assertTrue($messageBag->containsImage());
     }
+
+    public function testItCanHandleMetadata()
+    {
+        $messageBag = new MessageBag();
+        $metadata = $messageBag->getMetadata();
+
+        $this->assertCount(0, $metadata);
+
+        $metadata->add('key', 'value');
+        $metadata = $messageBag->getMetadata();
+
+        $this->assertCount(1, $metadata);
+    }
 }