Rework Platform API to invoke and result

Author: chr-hertel

demo/src/Audio/Chat.php

@@ -17,7 +17,7 @@
 use Symfony\AI\Platform\Message\Message;
 use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\PlatformInterface;
-use Symfony\AI\Platform\Response\TextResponse;
+use Symfony\AI\Platform\Result\TextResult;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\HttpFoundation\RequestStack;
 
@@ -39,9 +39,9 @@ public function say(string $base64audio): void
         $path = tempnam(sys_get_temp_dir(), 'audio-').'.wav';
         file_put_contents($path, base64_decode($base64audio));
 
-        $response = $this->platform->request(new Whisper(), Audio::fromFile($path));
+        $result = $this->platform->invoke(new Whisper(), Audio::fromFile($path));
 
-        $this->submitMessage($response->asText());
+        $this->submitMessage($result->asText());
     }
 
     public function loadMessages(): MessageBag
@@ -54,11 +54,11 @@ public function submitMessage(string $message): void
         $messages = $this->loadMessages();
 
         $messages->add(Message::ofUser($message));
-        $response = $this->agent->call($messages);
+        $result = $this->agent->call($messages);
 
-        \assert($response instanceof TextResponse);
+        \assert($result instanceof TextResult);
 
-        $messages->add(Message::ofAssistant($response->getContent()));
+        $messages->add(Message::ofAssistant($result->getContent()));
 
         $this->saveMessages($messages);
     }

demo/src/Blog/Chat.php

@@ -14,7 +14,7 @@
 use Symfony\AI\Agent\AgentInterface;
 use Symfony\AI\Platform\Message\Message;
 use Symfony\AI\Platform\Message\MessageBag;
-use Symfony\AI\Platform\Response\TextResponse;
+use Symfony\AI\Platform\Result\TextResult;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\HttpFoundation\RequestStack;
 
@@ -49,11 +49,11 @@ public function submitMessage(string $message): void
         $messages = $this->loadMessages();
 
         $messages->add(Message::ofUser($message));
-        $response = $this->agent->call($messages);
+        $result = $this->agent->call($messages);
 
-        \assert($response instanceof TextResponse);
+        \assert($result instanceof TextResult);
 
-        $messages->add(Message::ofAssistant($response->getContent()));
+        $messages->add(Message::ofAssistant($result->getContent()));
 
         $this->saveMessages($messages);
     }

demo/src/Blog/Command/QueryCommand.php

@@ -48,7 +48,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io->comment(\sprintf('Converting "%s" to vector & searching in Chroma DB ...', $search));
         $io->comment('Results are limited to 4 most similar documents.');
 
-        $platformResponse = $this->platform->request(new Embeddings(), $search);
+        $platformResponse = $this->platform->invoke(new Embeddings(), $search);
         $queryResponse = $collection->query(
             queryEmbeddings: [$platformResponse->asVectors()[0]->getData()],
             nResults: 4,

demo/src/Blog/FeedLoader.php

@@ -27,10 +27,10 @@ public function __construct(
      */
     public function load(): array
     {
-        $response = $this->httpClient->request('GET', 'https://feeds.feedburner.com/symfony/blog');
+        $result = $this->httpClient->request('GET', 'https://feeds.feedburner.com/symfony/blog');
 
         $posts = [];
-        $crawler = new Crawler($response->getContent());
+        $crawler = new Crawler($result->getContent());
         $crawler->filter('item')->each(function (Crawler $node) use (&$posts) {
             $title = $node->filter('title')->text();
             $posts[] = new Post(

demo/src/Video/TwigComponent.php

@@ -47,10 +47,10 @@ public function submit(#[LiveArg] string $instruction, #[LiveArg] string $image)
             Message::ofUser($instruction, Image::fromDataUrl($image))
         );
 
-        $response = $this->platform->request(new GPT(GPT::GPT_4O_MINI), $messageBag, [
+        $result = $this->platform->invoke(new GPT(GPT::GPT_4O_MINI), $messageBag, [
             'max_tokens' => 100,
         ]);
 
-        $this->caption = $response->asText();
+        $this->caption = $result->asText();
     }
 }

demo/src/Wikipedia/Chat.php

@@ -14,7 +14,7 @@
 use Symfony\AI\Agent\AgentInterface;
 use Symfony\AI\Platform\Message\Message;
 use Symfony\AI\Platform\Message\MessageBag;
-use Symfony\AI\Platform\Response\TextResponse;
+use Symfony\AI\Platform\Result\TextResult;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\HttpFoundation\RequestStack;
 
@@ -39,11 +39,11 @@ public function submitMessage(string $message): void
         $messages = $this->loadMessages();
 
         $messages->add(Message::ofUser($message));
-        $response = $this->agent->call($messages);
+        $result = $this->agent->call($messages);
 
-        \assert($response instanceof TextResponse);
+        \assert($result instanceof TextResult);
 
-        $messages->add(Message::ofAssistant($response->getContent()));
+        $messages->add(Message::ofAssistant($result->getContent()));
 
         $this->saveMessages($messages);
     }

demo/src/YouTube/Chat.php

@@ -14,7 +14,7 @@
 use Symfony\AI\Agent\AgentInterface;
 use Symfony\AI\Platform\Message\Message;
 use Symfony\AI\Platform\Message\MessageBag;
-use Symfony\AI\Platform\Response\TextResponse;
+use Symfony\AI\Platform\Result\TextResult;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\HttpFoundation\RequestStack;
 
@@ -61,11 +61,11 @@ public function submitMessage(string $message): void
         $messages = $this->loadMessages();
 
         $messages->add(Message::ofUser($message));
-        $response = $this->agent->call($messages);
+        $result = $this->agent->call($messages);
 
-        \assert($response instanceof TextResponse);
+        \assert($result instanceof TextResult);
 
-        $messages->add(Message::ofAssistant($response->getContent()));
+        $messages->add(Message::ofAssistant($result->getContent()));
 
         $this->saveMessages($messages);
     }

examples/albert/chat.php

@@ -44,6 +44,6 @@
     Message::ofUser('What are the main objectives of France\'s AI strategy?'),
 );
 
-$response = $agent->call($messages);
+$result = $agent->call($messages);
 
-echo $response->getContent().\PHP_EOL;
+echo $result->getContent().\PHP_EOL;

examples/anthropic/chat.php

@@ -25,6 +25,6 @@
     Message::forSystem('You are a pirate and you write funny.'),
     Message::ofUser('What is the Symfony framework?'),
 );
-$response = $agent->call($messages);
+$result = $agent->call($messages);
 
-echo $response->getContent().\PHP_EOL;
+echo $result->getContent().\PHP_EOL;

examples/anthropic/image-input-binary.php

@@ -29,6 +29,6 @@
         'Describe this image.',
     ),
 );
-$response = $agent->call($messages);
+$result = $agent->call($messages);
 
-echo $response->getContent().\PHP_EOL;
+echo $result->getContent().\PHP_EOL;