Skip to content

fix(vertexai): handle omit tokenCount nicely #17336

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
May 6, 2025
Merged

fix(vertexai): handle omit tokenCount nicely #17336

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
9 changes: 7 additions & 2 deletions packages/firebase_vertexai/firebase_vertexai/lib/src/api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1023,8 +1023,13 @@ ModalityTokenCount _parseModalityTokenCount(Object? jsonObject) {
if (jsonObject is! Map) {
throw unhandledFormat('ModalityTokenCount', jsonObject);
}
return ModalityTokenCount(ContentModality._parseValue(jsonObject['modality']),
jsonObject['tokenCount'] as int);
var modality = ContentModality._parseValue(jsonObject['modality']);

if (jsonObject.containsKey('tokenCount')) {
return ModalityTokenCount(modality, jsonObject['tokenCount'] as int);
} else {
return ModalityTokenCount(modality, 0);
}
}

SafetyRating _parseSafetyRating(Object? jsonObject) {
Expand Down
47 changes: 45 additions & 2 deletions packages/firebase_vertexai/firebase_vertexai/test/api_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,9 @@ void main() {
'totalTokens': 120,
'totalBillableCharacters': 240,
'promptTokensDetails': [
{'modality': 'TEXT', 'tokenCount': 100},
{
'modality': 'TEXT',
},
{'modality': 'IMAGE', 'tokenCount': 20}
]
};
Expand All @@ -447,7 +449,7 @@ void main() {
expect(response.promptTokensDetails, isNotNull);
expect(response.promptTokensDetails, hasLength(2));
expect(response.promptTokensDetails![0].modality, ContentModality.text);
expect(response.promptTokensDetails![0].tokenCount, 100);
expect(response.promptTokensDetails![0].tokenCount, 0);
expect(
response.promptTokensDetails![1].modality, ContentModality.image);
expect(response.promptTokensDetails![1].tokenCount, 20);
Expand Down Expand Up @@ -597,6 +599,47 @@ void main() {
expect(response.candidates.first.finishMessage, isNull);
});

test('parses usageMetadata for no tokenCount', () {
final json = {
'candidates': [basicCandidateJson],
'usageMetadata': {
'promptTokenCount': 10,
'candidatesTokenCount': 20,
'totalTokenCount': 30,
'promptTokensDetails': [
{'modality': 'TEXT', 'tokenCount': 10}
],
'candidatesTokensDetails': [
{
'modality': 'TEXT',
}
],
}
};
final response = parseGenerateContentResponse(json);
expect(response.candidates, hasLength(1));
expect(response.candidates.first.text, 'Hello world');
expect(response.candidates.first.finishReason, FinishReason.stop);
expect(response.candidates.first.safetyRatings, isNotNull);
expect(response.candidates.first.safetyRatings, hasLength(1));

expect(response.usageMetadata, isNotNull);
expect(response.usageMetadata!.promptTokenCount, 10);
expect(response.usageMetadata!.candidatesTokenCount, 20);
expect(response.usageMetadata!.totalTokenCount, 30);
expect(response.usageMetadata!.promptTokensDetails, hasLength(1));
expect(response.usageMetadata!.promptTokensDetails!.first.modality,
ContentModality.text);
expect(
response.usageMetadata!.promptTokensDetails!.first.tokenCount, 10);
expect(response.usageMetadata!.candidatesTokensDetails, hasLength(1));
expect(response.usageMetadata!.candidatesTokensDetails!.first.modality,
ContentModality.text);
expect(
response.usageMetadata!.candidatesTokensDetails!.first.tokenCount,
0);
});

test('parses citationMetadata with "citationSources"', () {
final json = {
'candidates': [
Expand Down
Loading