Skip to content

feat(firebaseai): deprecate totalBillableCharacters #17499

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.

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
Jul 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ class _TokenCountPageState extends State<TokenCountPage> {
const prompt = 'tell a short story';
final content = Content.text(prompt);
final tokenResponse = await widget.model.countTokens([content]);
final tokenResult = 'Count token: ${tokenResponse.totalTokens}, billable '
'characters: ${tokenResponse.totalBillableCharacters}';
final tokenResult = 'Count token: ${tokenResponse.totalTokens}';
_messages.add(MessageData(text: tokenResult, fromUser: false));

final contentResponse = await widget.model.generateContent([content]);
Expand Down
3 changes: 3 additions & 0 deletions packages/firebase_ai/firebase_ai/lib/src/api.dart
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ final class CountTokensResponse {
/// The number of characters that the `model` could bill at.
///
/// Always non-negative.
@Deprecated(
'Use `totalTokens` instead; Gemini 2.0 series models and newer are always billed by token count.',
)
final int? totalBillableCharacters;

/// List of modalities that were processed in the request input.
Expand Down
8 changes: 1 addition & 7 deletions packages/firebase_ai/firebase_ai/test/api_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,14 @@ void main() {
group('CountTokensResponse', () {
test('constructor initializes fields correctly', () {
final details = [ModalityTokenCount(ContentModality.text, 10)];
final response = CountTokensResponse(100,
totalBillableCharacters: 50, promptTokensDetails: details);
final response = CountTokensResponse(100, promptTokensDetails: details);
expect(response.totalTokens, 100);
expect(response.totalBillableCharacters, 50);
expect(response.promptTokensDetails, same(details));
});

test('constructor with null optional fields', () {
final response = CountTokensResponse(100);
expect(response.totalTokens, 100);
expect(response.totalBillableCharacters, isNull);
expect(response.promptTokensDetails, isNull);
});
});
Expand Down Expand Up @@ -445,7 +442,6 @@ void main() {
test('parses valid full JSON correctly', () {
final json = {
'totalTokens': 120,
'totalBillableCharacters': 240,
'promptTokensDetails': [
{
'modality': 'TEXT',
Expand All @@ -455,7 +451,6 @@ void main() {
};
final response = VertexSerialization().parseCountTokensResponse(json);
expect(response.totalTokens, 120);
expect(response.totalBillableCharacters, 240);
expect(response.promptTokensDetails, isNotNull);
expect(response.promptTokensDetails, hasLength(2));
expect(response.promptTokensDetails![0].modality, ContentModality.text);
Expand All @@ -469,7 +464,6 @@ void main() {
final json = {'totalTokens': 50};
final response = VertexSerialization().parseCountTokensResponse(json);
expect(response.totalTokens, 50);
expect(response.totalBillableCharacters, isNull);
expect(response.promptTokensDetails, isNull);
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ class _TokenCountPageState extends State<TokenCountPage> {
const prompt = 'tell a short story';
final content = Content.text(prompt);
final tokenResponse = await widget.model.countTokens([content]);
final tokenResult = 'Count token: ${tokenResponse.totalTokens}, billable '
'characters: ${tokenResponse.totalBillableCharacters}';
final tokenResult = 'Count token: ${tokenResponse.totalTokens}';
_messages.add(MessageData(text: tokenResult, fromUser: false));

final contentResponse = await widget.model.generateContent([content]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,14 @@ void main() {
group('CountTokensResponse', () {
test('constructor initializes fields correctly', () {
final details = [ModalityTokenCount(ContentModality.text, 10)];
final response = CountTokensResponse(100,
totalBillableCharacters: 50, promptTokensDetails: details);
final response = CountTokensResponse(100, promptTokensDetails: details);
expect(response.totalTokens, 100);
expect(response.totalBillableCharacters, 50);
expect(response.promptTokensDetails, same(details));
});

test('constructor with null optional fields', () {
final response = CountTokensResponse(100);
expect(response.totalTokens, 100);
expect(response.totalBillableCharacters, isNull);
expect(response.promptTokensDetails, isNull);
});
});
Expand Down Expand Up @@ -445,7 +442,6 @@ void main() {
test('parses valid full JSON correctly', () {
final json = {
'totalTokens': 120,
'totalBillableCharacters': 240,
'promptTokensDetails': [
{
'modality': 'TEXT',
Expand All @@ -455,7 +451,6 @@ void main() {
};
final response = VertexSerialization().parseCountTokensResponse(json);
expect(response.totalTokens, 120);
expect(response.totalBillableCharacters, 240);
expect(response.promptTokensDetails, isNotNull);
expect(response.promptTokensDetails, hasLength(2));
expect(response.promptTokensDetails![0].modality, ContentModality.text);
Expand All @@ -469,7 +464,6 @@ void main() {
final json = {'totalTokens': 50};
final response = VertexSerialization().parseCountTokensResponse(json);
expect(response.totalTokens, 50);
expect(response.totalBillableCharacters, isNull);
expect(response.promptTokensDetails, isNull);
});

Expand Down
Loading