minor #743 [Examples] Adopt asX methods of result for better type support (chr-hertel)

chr-hertel · chr-hertel · commit 53c3ebc3f958 · 2025-10-06T23:41:03.000+02:00
This PR was merged into the main branch. Discussion ---------- [Examples] Adopt asX methods of result for better type support | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Docs? | no | Issues | | License | MIT Follows #545 Commits ------- 8410755 Adopt asX methods of result for better type support
diff --git a/examples/aimlapi/chat.php b/examples/aimlapi/chat.php
@@ -25,4 +25,4 @@
     'max_tokens' => 500, // specific options just for this call
 ]);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/aimlapi/image-input-binary.php b/examples/aimlapi/image-input-binary.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('google/gemma-3-27b-it', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/albert/chat.php b/examples/albert/chat.php
@@ -41,4 +41,4 @@
 
 $result = $platform->invoke('llama-3.3-70b-instruct', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/anthropic/chat.php b/examples/anthropic/chat.php
@@ -23,4 +23,4 @@
 );
 $result = $platform->invoke('claude-3-5-sonnet-20241022', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/anthropic/image-input-binary.php b/examples/anthropic/image-input-binary.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('claude-3-5-sonnet-20241022', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/anthropic/image-input-url.php b/examples/anthropic/image-input-url.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('claude-3-5-sonnet-20241022', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/anthropic/pdf-input-binary.php b/examples/anthropic/pdf-input-binary.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('claude-3-5-sonnet-20241022', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/anthropic/pdf-input-url.php b/examples/anthropic/pdf-input-url.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('claude-3-5-sonnet-20241022', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/azure/chat-gpt.php b/examples/azure/chat-gpt.php
@@ -28,4 +28,4 @@
 );
 $result = $platform->invoke('gpt-4o-mini', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/azure/chat-llama.php b/examples/azure/chat-llama.php
@@ -26,4 +26,4 @@
     'frequency_penalty' => 0,
 ]);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/bedrock/chat-claude.php b/examples/bedrock/chat-claude.php
@@ -29,4 +29,4 @@
 );
 $result = $platform->invoke('claude-3-7-sonnet-20250219', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/bedrock/chat-llama.php b/examples/bedrock/chat-llama.php
@@ -29,4 +29,4 @@
 );
 $result = $platform->invoke('llama-3.2-3b-instruct', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/bedrock/chat-nova.php b/examples/bedrock/chat-nova.php
@@ -29,4 +29,4 @@
 );
 $result = $platform->invoke('nova-pro', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/bedrock/image-claude-binary.php b/examples/bedrock/image-claude-binary.php
@@ -33,4 +33,4 @@
 );
 $result = $platform->invoke('claude-3-7-sonnet-20250219', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/bedrock/image-nova.php b/examples/bedrock/image-nova.php
@@ -33,4 +33,4 @@
 );
 $result = $platform->invoke('nova-pro', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/bootstrap.php b/examples/bootstrap.php
@@ -180,7 +180,7 @@ function perplexity_print_citations(Metadata $metadata): void
 
 function print_stream(ResultPromise $result): void
 {
-    foreach ($result->getResult()->getContent() as $word) {
+    foreach ($result->asStream() as $word) {
         echo $word;
     }
     echo \PHP_EOL;
diff --git a/examples/cerebras/chat.php b/examples/cerebras/chat.php
@@ -23,4 +23,4 @@
 );
 $result = $platform->invoke('llama3.1-8b', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/gemini/audio-input.php b/examples/gemini/audio-input.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('gemini-1.5-flash', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/gemini/chat.php b/examples/gemini/chat.php
@@ -23,4 +23,4 @@
 );
 $result = $platform->invoke('gemini-2.0-flash', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/gemini/image-input.php b/examples/gemini/image-input.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('gemini-1.5-flash', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/gemini/pdf-input-binary.php b/examples/gemini/pdf-input-binary.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('gemini-1.5-flash', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/lmstudio/chat.php b/examples/lmstudio/chat.php
@@ -25,4 +25,4 @@
     'max_tokens' => 500, // specific options just for this call
 ]);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/lmstudio/image-input-binary.php b/examples/lmstudio/image-input-binary.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('gemma-3-4b-it-qat', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/mistral/chat-multiple.php b/examples/mistral/chat-multiple.php
@@ -26,6 +26,6 @@
     'n' => 10,
 ]);
 
-foreach ($result->getResult()->getContent() as $key => $choice) {
+foreach ($result->asStream() as $key => $choice) {
     echo sprintf('Choice #%d: %s', ++$key, $choice->getContent()).\PHP_EOL;
 }
diff --git a/examples/mistral/chat.php b/examples/mistral/chat.php
@@ -22,4 +22,4 @@
     'temperature' => 0.7,
 ]);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/mistral/image.php b/examples/mistral/image.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('mistral-small-latest', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/mistral/pdf-input-binary.php b/examples/mistral/pdf-input-binary.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('mistral-small-latest', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/mistral/pdf-input-url.php b/examples/mistral/pdf-input-url.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('mistral-small-latest', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/ollama/chat-llama.php b/examples/ollama/chat-llama.php
@@ -24,7 +24,7 @@
 
 try {
     $result = $platform->invoke(env('OLLAMA_LLM'), $messages);
-    echo $result->getResult()->getContent().\PHP_EOL;
+    echo $result->asText().\PHP_EOL;
 } catch (InvalidArgumentException $e) {
     echo $e->getMessage()."\nMaybe use a different model?\n";
 }
diff --git a/examples/openai/audio-input.php b/examples/openai/audio-input.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('gpt-4o-audio-preview', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/openai/chat-with-string-options.php b/examples/openai/chat-with-string-options.php
@@ -23,4 +23,4 @@
 );
 $result = $platform->invoke('gpt-4o-mini?max_tokens=7', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/openai/chat.php b/examples/openai/chat.php
@@ -25,4 +25,4 @@
     'max_tokens' => 500, // specific options just for this call
 ]);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/openai/image-input-binary.php b/examples/openai/image-input-binary.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('gpt-4o-mini', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/openai/image-input-url.php b/examples/openai/image-input-url.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('gpt-4o-mini', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/openai/pdf-input-binary.php b/examples/openai/pdf-input-binary.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('gpt-4o-mini', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/openrouter/chat-gemini.php b/examples/openrouter/chat-gemini.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke($model, $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/perplexity/chat.php b/examples/perplexity/chat.php
@@ -18,6 +18,6 @@
 $platform = PlatformFactory::create(env('PERPLEXITY_API_KEY'), http_client());
 
 $messages = new MessageBag(Message::ofUser('What is the best French cheese?'));
-$response = $platform->invoke('sonar', $messages);
+$result = $platform->invoke('sonar', $messages);
 
-echo $response->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/perplexity/disable-search.php b/examples/perplexity/disable-search.php
@@ -18,8 +18,8 @@
 $platform = PlatformFactory::create(env('PERPLEXITY_API_KEY'), http_client());
 
 $messages = new MessageBag(Message::ofUser('What is 2 + 2?'));
-$response = $platform->invoke('sonar', $messages, [
+$result = $platform->invoke('sonar', $messages, [
     'disable_search' => true,
 ]);
 
-echo $response->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/perplexity/web-search.php b/examples/perplexity/web-search.php
@@ -18,7 +18,7 @@
 $platform = PlatformFactory::create(env('PERPLEXITY_API_KEY'), http_client());
 
 $messages = new MessageBag(Message::ofUser('What is the best French cheese?'));
-$response = $platform->invoke('sonar', $messages, [
+$result = $platform->invoke('sonar', $messages, [
     'search_domain_filter' => [
         'https://en.wikipedia.org/wiki/Cheese',
     ],
@@ -27,4 +27,4 @@
     'search_recency_filter' => 'week',
 ]);
 
-echo $response->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/replicate/chat-llama.php b/examples/replicate/chat-llama.php
@@ -23,4 +23,4 @@
 );
 $result = $platform->invoke('llama-3.1-405b-instruct', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/scaleway/stream.php b/examples/scaleway/stream.php
@@ -23,7 +23,7 @@
 );
 $result = $platform->invoke('gpt-oss-120b', $messages, ['stream' => true]);
 
-foreach ($result->getResult()->getContent() as $word) {
+foreach ($result->asStream() as $word) {
     echo $word;
 }
 echo \PHP_EOL;
diff --git a/examples/scaleway/vision.php b/examples/scaleway/vision.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('pixtral-12b-2409', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/vertexai/audio-input.php b/examples/vertexai/audio-input.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('gemini-2.5-flash', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/vertexai/chat.php b/examples/vertexai/chat.php
@@ -23,4 +23,4 @@
 );
 $result = $platform->invoke('gemini-2.5-flash', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/vertexai/image-input.php b/examples/vertexai/image-input.php
@@ -27,4 +27,4 @@
 );
 $result = $platform->invoke('gemini-2.5-pro', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/vertexai/pdf-input-binary.php b/examples/vertexai/pdf-input-binary.php
@@ -26,4 +26,4 @@
 );
 $result = $platform->invoke('gemini-2.5-flash', $messages);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;
diff --git a/examples/vertexai/server-tools.php b/examples/vertexai/server-tools.php
@@ -27,4 +27,4 @@
 
 $result = $platform->invoke('gemini-2.5-pro', $messages, ['server_tools' => ['url_context' => true]]);
 
-echo $result->getResult()->getContent().\PHP_EOL;
+echo $result->asText().\PHP_EOL;

Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,4 @@`
`41`	`41`
`42`	`42`	`$result = $platform->invoke('llama-3.3-70b-instruct', $messages);`
`43`	`43`
`44`		`-echo $result->getResult()->getContent().\PHP_EOL;`
	`44`	`+echo $result->asText().\PHP_EOL;`