Skip to content

[Platform][VertexAi] Yield TokenUsage from Gemini stream chunks #2008

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

Open
Amoifr wants to merge 1 commit into
base: main
Choose a base branch
from
+53 −2
Open

[Platform][VertexAi] Yield TokenUsage from Gemini stream chunks #2008

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
4 changes: 4 additions & 0 deletions src/platform/src/Bridge/VertexAi/Gemini/ResultConverter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ public function getTokenUsageExtractor(): TokenUsageExtractor
private function convertStream(RawResultInterface $result): \Generator
{
foreach ($result->getDataStream() as $data) {
if (isset($data['usageMetadata'])) {
yield $this->getTokenUsageExtractor()->fromUsageMetadata($data['usageMetadata']);
}

$choices = array_values(array_filter(array_map($this->convertChoice(...), $data['candidates'] ?? [])));

if (!$choices) {
Expand Down
4 changes: 2 additions & 2 deletions src/platform/src/Bridge/VertexAi/Gemini/TokenUsageExtractor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function extract(RawResultInterface $rawResult, array $options = []): ?To
return null;
}

return $this->extractUsageMetadata($content['usageMetadata']);
return $this->fromUsageMetadata($content['usageMetadata']);
}

/**
Expand All @@ -46,7 +46,7 @@ public function extract(RawResultInterface $rawResult, array $options = []): ?To
* totalTokenCount?: int
* } $usage
*/
private function extractUsageMetadata(array $usage): TokenUsage
public function fromUsageMetadata(array $usage): TokenUsage
{
return new TokenUsage(
promptTokens: $usage['promptTokenCount'] ?? null,
Expand Down
47 changes: 47 additions & 0 deletions src/platform/src/Bridge/VertexAi/Tests/Gemini/ResultConverterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
use Symfony\AI\Platform\Result\TextResult;
use Symfony\AI\Platform\Result\ToolCall;
use Symfony\AI\Platform\Result\ToolCallResult;
use Symfony\AI\Platform\TokenUsage\TokenUsageInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;

final class ResultConverterTest extends TestCase
Expand Down Expand Up @@ -329,4 +330,50 @@ public static function streamDeltaProvider(): iterable
],
], ChoiceDelta::class];
}

public function testStreamingYieldsTokenUsageWhenUsageMetadataIsPresent()
{
$response = $this->createStub(ResponseInterface::class);
$response->method('getStatusCode')->willReturn(200);

$rawResult = $this->createStub(RawResultInterface::class);
$rawResult->method('getObject')->willReturn($response);
$rawResult->method('getDataStream')->willReturn((static function (): \Generator {
yield [
'candidates' => [[
'content' => ['parts' => [['text' => 'Hello']]],
]],
];
yield [
'candidates' => [[
'content' => ['parts' => [['text' => ' world']]],
]],
'usageMetadata' => [
'promptTokenCount' => 15,
'candidatesTokenCount' => 25,
'thoughtsTokenCount' => 3,
'totalTokenCount' => 43,
],
];
})());

$result = (new ResultConverter())->convert($rawResult, ['stream' => true]);

$this->assertInstanceOf(StreamResult::class, $result);

$items = iterator_to_array($result->getContent(), false);

$this->assertCount(3, $items);
$this->assertInstanceOf(TextDelta::class, $items[0]);
$this->assertSame('Hello', $items[0]->getText());

$this->assertInstanceOf(TokenUsageInterface::class, $items[1]);
$this->assertSame(15, $items[1]->getPromptTokens());
$this->assertSame(25, $items[1]->getCompletionTokens());
$this->assertSame(3, $items[1]->getThinkingTokens());
$this->assertSame(43, $items[1]->getTotalTokens());

$this->assertInstanceOf(TextDelta::class, $items[2]);
$this->assertSame(' world', $items[2]->getText());
}
}