Skip to content

Improve example output, mostly for errors #685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 27, 2025
Merged

Improve example output, mostly for errors #685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 41 additions & 12 deletions examples/bootstrap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@

use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Symfony\AI\Agent\Exception\ExceptionInterface as AgentException;
use Symfony\AI\Platform\Exception\ExceptionInterface as PlatformException;
use Symfony\AI\Platform\Metadata\Metadata;
use Symfony\AI\Platform\Metadata\TokenUsage;
use Symfony\AI\Platform\Result\ResultPromise;
use Symfony\AI\Store\Exception\ExceptionInterface as StoreException;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Logger\ConsoleLogger;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Dotenv\Dotenv;
Expand All @@ -26,7 +30,7 @@
function env(string $var): string
{
if (!isset($_SERVER[$var]) || '' === $_SERVER[$var]) {
printf('Please set the "%s" environment variable to run this example.', $var);
output()->writeln(sprintf('<error>Please set the "%s" environment variable to run this example.</error>', $var));
exit(1);
}

Expand All @@ -45,6 +49,11 @@ function http_client(): HttpClientInterface
}

function logger(): LoggerInterface
{
return new ConsoleLogger(output());
}

function output(): ConsoleOutput
{
$verbosity = match ($_SERVER['argv'][1] ?? null) {
'-v', '--verbose' => ConsoleOutput::VERBOSITY_VERBOSE,
Expand All @@ -53,7 +62,7 @@ function logger(): LoggerInterface
default => ConsoleOutput::VERBOSITY_NORMAL,
};

return new ConsoleLogger(new ConsoleOutput($verbosity));
return new ConsoleOutput($verbosity);
}

function print_token_usage(Metadata $metadata): void
Expand All @@ -62,23 +71,29 @@ function print_token_usage(Metadata $metadata): void

assert($tokenUsage instanceof TokenUsage);

echo 'Prompt tokens: '.$tokenUsage->promptTokens.\PHP_EOL;
echo 'Completion tokens: '.$tokenUsage->completionTokens.\PHP_EOL;
echo 'Thinking tokens: '.$tokenUsage->thinkingTokens.\PHP_EOL;
echo 'Tool tokens: '.$tokenUsage->toolTokens.\PHP_EOL;
echo 'Cached tokens: '.$tokenUsage->cachedTokens.\PHP_EOL;
echo 'Remaining tokens minute: '.$tokenUsage->remainingTokensMinute.\PHP_EOL;
echo 'Remaining tokens month: '.$tokenUsage->remainingTokensMonth.\PHP_EOL;
echo 'Remaining tokens: '.$tokenUsage->remainingTokens.\PHP_EOL;
echo 'Utilized tokens: '.$tokenUsage->totalTokens.\PHP_EOL;
$na = '<comment>n/a</comment>';
$table = new Table(output());
$table->setHeaderTitle('Token Usage');
$table->setRows([
['Prompt tokens', $tokenUsage->promptTokens ?? $na],
['Completion tokens', $tokenUsage->completionTokens ?? $na],
['Thinking tokens', $tokenUsage->thinkingTokens ?? $na],
['Tool tokens', $tokenUsage->toolTokens ?? $na],
['Cached tokens', $tokenUsage->cachedTokens ?? $na],
['Remaining tokens minute', $tokenUsage->remainingTokensMinute ?? $na],
['Remaining tokens month', $tokenUsage->remainingTokensMonth ?? $na],
['Remaining tokens', $tokenUsage->remainingTokens ?? $na],
['Utilized tokens', $tokenUsage->totalTokens ?? $na],
]);
$table->render();
}

function print_vectors(ResultPromise $result): void
{
assert([] !== $result->asVectors());
assert(array_key_exists(0, $result->asVectors()));

echo 'Dimensions: '.$result->asVectors()[0]->getDimensions().\PHP_EOL;
output()->writeln(sprintf('Dimensions: %d', $result->asVectors()[0]->getDimensions()));
}

function perplexity_print_search_results(Metadata $metadata): void
Expand Down Expand Up @@ -138,3 +153,17 @@ function print_stream(ResultPromise $result): void
}
echo \PHP_EOL;
}

set_exception_handler(function ($exception) {
if ($exception instanceof AgentException || $exception instanceof PlatformException || $exception instanceof StoreException) {
output()->writeln(sprintf('<error>%s</error>', $exception->getMessage()));

if (output()->isVerbose()) {
output()->writeln($exception->getTraceAsString());
}

exit(1);
}

throw $exception;
});
1 change: 0 additions & 1 deletion examples/runner
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ $app = (new SingleCommandApplication('Symfony AI Example Runner'))
if (!$run['process']->isSuccessful()) {
$io->section('Error in ' . $run['example']->getRelativePathname());
$io->text($run['process']->getOutput());
$io->text($run['process']->getErrorOutput());
}
}

Expand Down