UsageMetadata
public final classUsageMetadata
This class is deprecated.
The Vertex AI in Firebase SDK (firebase-vertexai) has been replaced with the FirebaseAI SDK (firebase-ai) to accommodate the evolving set of supported features and services.For migration details, see the migration guide: https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk
Usage metadata about response(s).
Summary
Public fields | |
|---|---|
finalInteger | Number of tokens in the response(s). |
final @NonNullList<@NonNullModalityTokenCount> | The breakdown, by modality, of how many tokens are consumed by the candidates. |
final int | Number of tokens in the request. |
final @NonNullList<@NonNullModalityTokenCount> | The breakdown, by modality, of how many tokens are consumed by the prompt. |
final int | Total number of tokens. |
Public constructors |
|---|
UsageMetadata( |
Public fields
candidatesTokensDetails
public final @NonNullList<@NonNullModalityTokenCount> candidatesTokensDetails
The breakdown, by modality, of how many tokens are consumed by the candidates.
promptTokensDetails
public final @NonNullList<@NonNullModalityTokenCount> promptTokensDetails
The breakdown, by modality, of how many tokens are consumed by the prompt.
Public constructors
UsageMetadata
public UsageMetadata(
int promptTokenCount,
Integer candidatesTokenCount,
int totalTokenCount,
@NonNullList<@NonNullModalityTokenCount> promptTokensDetails,
@NonNullList<@NonNullModalityTokenCount> candidatesTokensDetails
)
| Parameters | |
|---|---|
int promptTokenCount | Number of tokens in the request. |
Integer candidatesTokenCount | Number of tokens in the response(s). |
int totalTokenCount | Total number of tokens. |
@NonNullList<@NonNullModalityTokenCount> promptTokensDetails | The breakdown, by modality, of how many tokens are consumed by the prompt. |
@NonNullList<@NonNullModalityTokenCount> candidatesTokensDetails | The breakdown, by modality, of how many tokens are consumed by the candidates. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-21 UTC.