refactor!: improve types in platform api

examples/azure/audio-transcript.php

@@ -34,4 +34,4 @@
 
 $response = $platform->request($model, $file);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/azure/embeddings.php

@@ -11,7 +11,6 @@
 
 use Symfony\AI\Platform\Bridge\Azure\OpenAI\PlatformFactory;
 use Symfony\AI\Platform\Bridge\OpenAI\Embeddings;
-use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
@@ -37,6 +36,4 @@
     country was very peaceful and prosperous. The people lived happily ever after.
     TEXT);
 
-assert($response instanceof VectorResponse);
-
-echo 'Dimensions: '.$response->getContent()[0]->getDimensions().\PHP_EOL;
+echo 'Dimensions: '.$response->asVectors()[0]->getDimensions().\PHP_EOL;

examples/huggingface/audio-classification.php

@@ -31,4 +31,4 @@
     'task' => Task::AUDIO_CLASSIFICATION,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/automatic-speech-recognition.php

@@ -31,4 +31,4 @@
     'task' => Task::AUTOMATIC_SPEECH_RECOGNITION,
 ]);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/huggingface/chat-completion.php

@@ -32,4 +32,4 @@
     'task' => Task::CHAT_COMPLETION,
 ]);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/huggingface/feature-extraction.php

@@ -12,7 +12,6 @@
 use Symfony\AI\Platform\Bridge\HuggingFace\PlatformFactory;
 use Symfony\AI\Platform\Bridge\HuggingFace\Task;
 use Symfony\AI\Platform\Model;
-use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
@@ -30,6 +29,4 @@
     'task' => Task::FEATURE_EXTRACTION,
 ]);
 
-assert($response instanceof VectorResponse);
-
-echo 'Dimensions: '.$response->getContent()[0]->getDimensions().\PHP_EOL;
+echo 'Dimensions: '.$response->asVectors()[0]->getDimensions().\PHP_EOL;

examples/huggingface/fill-mask.php

@@ -29,4 +29,4 @@
     'task' => Task::FILL_MASK,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/image-classification.php

@@ -31,4 +31,4 @@
     'task' => Task::IMAGE_CLASSIFICATION,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/image-segmentation.php

@@ -31,4 +31,4 @@
     'task' => Task::IMAGE_SEGMENTATION,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/image-to-text.php

@@ -31,4 +31,4 @@
     'task' => Task::IMAGE_TO_TEXT,
 ]);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/huggingface/object-detection.php

@@ -31,4 +31,4 @@
     'task' => Task::OBJECT_DETECTION,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/question-answering.php

@@ -34,4 +34,4 @@
     'task' => Task::QUESTION_ANSWERING,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/sentence-similarity.php

@@ -38,4 +38,4 @@
     'task' => Task::SENTENCE_SIMILARITY,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/summarization.php

@@ -39,4 +39,4 @@
     'task' => Task::SUMMARIZATION,
 ]);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/huggingface/table-question-answering.php

@@ -37,4 +37,4 @@
     'task' => Task::TABLE_QUESTION_ANSWERING,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/text-classification.php

@@ -29,4 +29,4 @@
     'task' => Task::TEXT_CLASSIFICATION,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/text-generation.php

@@ -29,4 +29,4 @@
     'task' => Task::TEXT_GENERATION,
 ]);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/huggingface/text-to-image.php

@@ -12,7 +12,6 @@
 use Symfony\AI\Platform\Bridge\HuggingFace\PlatformFactory;
 use Symfony\AI\Platform\Bridge\HuggingFace\Task;
 use Symfony\AI\Platform\Model;
-use Symfony\AI\Platform\Response\BinaryResponse;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
@@ -30,6 +29,4 @@
     'task' => Task::TEXT_TO_IMAGE,
 ]);
 
-assert($response instanceof BinaryResponse);
-
-echo $response->toBase64().\PHP_EOL;
+echo $response->asBase64().\PHP_EOL;

examples/huggingface/token-classification.php

@@ -29,4 +29,4 @@
     'task' => Task::TOKEN_CLASSIFICATION,
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/huggingface/translation.php

@@ -31,4 +31,4 @@
     'tgt_lang' => 'en',
 ]);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/huggingface/zero-shot-classification.php

@@ -31,4 +31,4 @@
     'candidate_labels' => ['refund', 'legal', 'faq'],
 ]);
 
-dump($response->getContent());
+dump($response->asObject());

examples/misc/parallel-chat-gpt.php

@@ -41,5 +41,5 @@
 
 echo 'Waiting for the responses ...'.\PHP_EOL;
 foreach ($responses as $response) {
-    echo 'Next Letter: '.$response->getContent().\PHP_EOL;
+    echo 'Next Letter: '.$response->asText().\PHP_EOL;
 }

examples/misc/parallel-embeddings.php

@@ -11,7 +11,6 @@
 
 use Symfony\AI\Platform\Bridge\OpenAI\Embeddings;
 use Symfony\AI\Platform\Bridge\OpenAI\PlatformFactory;
-use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
@@ -36,6 +35,5 @@
 
 echo 'Waiting for the responses ...'.\PHP_EOL;
 foreach ($responses as $response) {
-    assert($response instanceof VectorResponse);
-    echo 'Dimensions: '.$response->getContent()[0]->getDimensions().\PHP_EOL;
+    echo 'Dimensions: '.$response->asVectors()[0]->getDimensions().\PHP_EOL;
 }

examples/mistral/embeddings.php

@@ -11,7 +11,6 @@
 
 use Symfony\AI\Platform\Bridge\Mistral\Embeddings;
 use Symfony\AI\Platform\Bridge\Mistral\PlatformFactory;
-use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
@@ -32,6 +31,4 @@
     salt. The goal was to prevent deficiencies and promote better health in the population.
     TEXT);
 
-assert($response instanceof VectorResponse);
-
-echo 'Dimensions: '.$response->getContent()[0]->getDimensions().\PHP_EOL;
+echo 'Dimensions: '.$response->asVectors()[0]->getDimensions().\PHP_EOL;

examples/openai/audio-transcript.php

@@ -28,4 +28,4 @@
 
 $response = $platform->request($model, $file);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/openai/embeddings.php

@@ -11,7 +11,6 @@
 
 use Symfony\AI\Platform\Bridge\OpenAI\Embeddings;
 use Symfony\AI\Platform\Bridge\OpenAI\PlatformFactory;
-use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
@@ -31,6 +30,4 @@
     country was very peaceful and prosperous. The people lived happily ever after.
     TEXT);
 
-assert($response instanceof VectorResponse);
-
-echo 'Dimensions: '.$response->getContent()[0]->getDimensions().\PHP_EOL;
+echo 'Dimensions: '.$response->asVectors()[0]->getDimensions().\PHP_EOL;

examples/openai/image-output-dall-e-2.php

@@ -32,6 +32,6 @@
     ],
 );
 
-foreach ($response->getContent() as $index => $image) {
+foreach ($response->getResponse()->getContent() as $index => $image) {
     echo 'Image '.$index.': '.$image->url.\PHP_EOL;
 }

examples/openai/image-output-dall-e-3.php

@@ -30,7 +30,7 @@
     options: [
         'response_format' => 'url', // Generate response as URL
     ],
-);
+)->getResponse();
 
 assert($response instanceof ImageResponse);
 

examples/transformers/text-generation.php

@@ -32,4 +32,4 @@
     'task' => Task::Text2TextGeneration,
 ]);
 
-echo $response->getContent().\PHP_EOL;
+echo $response->asText().\PHP_EOL;

examples/voyage/embeddings.php

@@ -11,7 +11,6 @@
 
 use Symfony\AI\Platform\Bridge\Voyage\PlatformFactory;
 use Symfony\AI\Platform\Bridge\Voyage\Voyage;
-use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
@@ -31,6 +30,4 @@
     country was very peaceful and prosperous. The people lived happily ever after.
     TEXT);
 
-assert($response instanceof VectorResponse);
-
-echo 'Dimensions: '.$response->getContent()[0]->getDimensions().\PHP_EOL;
+echo 'Dimensions: '.$response->asVectors()[0]->getDimensions().\PHP_EOL;

src/agent/src/Agent.php

@@ -20,7 +20,6 @@
 use Symfony\AI\Platform\Message\MessageBagInterface;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\PlatformInterface;
-use Symfony\AI\Platform\Response\AsyncResponse;
 use Symfony\AI\Platform\Response\ResponseInterface;
 use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
 use Symfony\Contracts\HttpClient\Exception\HttpExceptionInterface;
@@ -76,11 +75,7 @@ public function call(MessageBagInterface $messages, array $options = []): Respon
         }
 
         try {
-            $response = $this->platform->request($model, $messages, $options);
-
-            if ($response instanceof AsyncResponse) {
-                $response = $response->unwrap();
-            }
+            $response = $this->platform->request($model, $messages, $options)->getResponse();
         } catch (ClientExceptionInterface $e) {
             $message = $e->getMessage();
             $content = $e->getResponse()->toArray(false);

src/agent/src/Toolbox/Tool/SimilaritySearch.php

@@ -14,7 +14,6 @@
 use Symfony\AI\Agent\Toolbox\Attribute\AsTool;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\PlatformInterface;
-use Symfony\AI\Platform\Vector\Vector;
 use Symfony\AI\Store\Document\VectorDocument;
 use Symfony\AI\Store\VectorStoreInterface;
 
@@ -41,8 +40,7 @@ public function __construct(
      */
     public function __invoke(string $searchTerm): string
     {
-        /** @var Vector[] $vectors */
-        $vectors = $this->platform->request($this->model, $searchTerm)->getContent();
+        $vectors = $this->platform->request($this->model, $searchTerm)->asVectors();
         $this->usedDocuments = $this->vectorStore->query($vectors[0]);
 
         if (0 === \count($this->usedDocuments)) {

src/ai-bundle/src/Profiler/TraceablePlatform.php

@@ -14,7 +14,7 @@
 use Symfony\AI\Platform\Message\Content\File;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\PlatformInterface;
-use Symfony\AI\Platform\Response\ResponseInterface;
+use Symfony\AI\Platform\Response\ResponsePromise;
 
 /**
  * @author Christopher Hertel <[email protected]>
@@ -23,7 +23,7 @@
  *     model: Model,
  *     input: array<mixed>|string|object,
  *     options: array<string, mixed>,
- *     response: ResponseInterface,
+ *     response: ResponsePromise,
  * }
  */
 final class TraceablePlatform implements PlatformInterface
@@ -38,7 +38,7 @@ public function __construct(
     ) {
     }
 
-    public function request(Model $model, array|string|object $input, array $options = []): ResponseInterface
+    public function request(Model $model, array|string|object $input, array $options = []): ResponsePromise
     {
         $response = $this->platform->request($model, $input, $options);
 
@@ -50,7 +50,7 @@ public function request(Model $model, array|string|object $input, array $options
             'model' => $model,
             'input' => \is_object($input) ? clone $input : $input,
             'options' => $options,
-            'response' => $response->getContent(),
+            'response' => $response,
         ];
 
         return $response;

src/platform/doc/index.rst

@@ -246,7 +246,7 @@ The standalone usage results in an ``Vector`` instance::
 
     $embeddings = new Embeddings($platform, Embeddings::TEXT_3_SMALL);
 
-    $vectors = $platform->request($embeddings, $textInput)->getContent();
+    $vectors = $platform->request($embeddings, $textInput)->asVectors();
 
     dump($vectors[0]->getData()); // returns something like: [0.123, -0.456, 0.789, ...]
 
@@ -276,7 +276,7 @@ which can be useful to speed up the processing::
     }
 
     foreach ($responses as $response) {
-        echo $response->getContent().PHP_EOL;
+        echo $response->asText().PHP_EOL;
     }
 
 .. note::

src/platform/src/Bridge/Bedrock/Anthropic/ClaudeHandler.php

@@ -18,7 +18,6 @@
 use Symfony\AI\Platform\Bridge\Bedrock\BedrockModelClient;
 use Symfony\AI\Platform\Exception\RuntimeException;
 use Symfony\AI\Platform\Model;
-use Symfony\AI\Platform\Response\ResponseInterface as LlmResponse;
 use Symfony\AI\Platform\Response\TextResponse;
 use Symfony\AI\Platform\Response\ToolCall;
 use Symfony\AI\Platform\Response\ToolCallResponse;
@@ -39,7 +38,7 @@ public function supports(Model $model): bool
         return $model instanceof Claude;
     }
 
-    public function request(Model $model, array|string $payload, array $options = []): LlmResponse
+    public function request(Model $model, array|string $payload, array $options = []): InvokeModelResponse
     {
         unset($payload['model']);
 
@@ -57,12 +56,10 @@ public function request(Model $model, array|string $payload, array $options = []
             'body' => json_encode(array_merge($options, $payload), \JSON_THROW_ON_ERROR),
         ];
 
-        $invokeModelResponse = $this->bedrockRuntimeClient->invokeModel(new InvokeModelRequest($request));
-
-        return $this->convert($invokeModelResponse);
+        return $this->bedrockRuntimeClient->invokeModel(new InvokeModelRequest($request));
     }
 
-    public function convert(InvokeModelResponse $bedrockResponse): LlmResponse
+    public function convert(InvokeModelResponse $bedrockResponse): ToolCallResponse|TextResponse
     {
         $data = json_decode($bedrockResponse->getBody(), true, 512, \JSON_THROW_ON_ERROR);