UsageMetadata

class UsageMetadata

Usage metadata about response(s).

Summary

Public constructors
`UsageMetadata( promptTokenCount: Int, candidatesTokenCount: Int?, totalTokenCount: Int, promptTokensDetails: List<ModalityTokenCount>, candidatesTokensDetails: List<ModalityTokenCount> )`

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

candidatesTokenCount

val candidatesTokenCount: Int?

Number of tokens in the response(s).

candidatesTokensDetails

val candidatesTokensDetails: List<ModalityTokenCount>

The breakdown, by modality, of how many tokens are consumed by the candidates.

promptTokenCount

val promptTokenCount: Int

Number of tokens in the request.

promptTokensDetails

val promptTokensDetails: List<ModalityTokenCount>

The breakdown, by modality, of how many tokens are consumed by the prompt.

totalTokenCount

val totalTokenCount: Int

Total number of tokens.