UsageMetadata
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 constructors |
|---|
UsageMetadata( |
Public properties | |
|---|---|
Int? | Number of tokens in the response(s). |
List<ModalityTokenCount> | The breakdown, by modality, of how many tokens are consumed by the candidates. |
Int | Number of tokens in the request. |
List<ModalityTokenCount> | The breakdown, by modality, of how many tokens are consumed by the prompt. |
Int | Total number of tokens. |
Public constructors
UsageMetadata
UsageMetadata(
promptTokenCount: Int,
candidatesTokenCount: Int?,
totalTokenCount: Int,
promptTokensDetails: List<ModalityTokenCount>,
candidatesTokensDetails: List<ModalityTokenCount>
)
| Parameters | |
|---|---|
promptTokenCount: Int | Number of tokens in the request. |
candidatesTokenCount: Int? | Number of tokens in the response(s). |
totalTokenCount: Int | Total number of tokens. |
promptTokensDetails: List<ModalityTokenCount> | The breakdown, by modality, of how many tokens are consumed by the prompt. |
candidatesTokensDetails: List<ModalityTokenCount> | The breakdown, by modality, of how many tokens are consumed by the candidates. |
Public properties
candidatesTokensDetails
val candidatesTokensDetails: List<ModalityTokenCount>
The breakdown, by modality, of how many tokens are consumed by the candidates.
promptTokensDetails
val promptTokensDetails: List<ModalityTokenCount>
The breakdown, by modality, of how many tokens are consumed by the prompt.
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.