UsageMetadata Class

Metadata on the generation request's token usage.

Definition

Namespace: GenerativeAI.Types
Assembly: GenerativeAI (in GenerativeAI.dll) Version: 2.0.2+aa51399cad6d90cc71158d589a6268608b3c1893
C#
public class UsageMetadata
Inheritance
Object    UsageMetadata

Constructors

UsageMetadataInitializes a new instance of the UsageMetadata class

Properties

CachedContentTokenCount Number of tokens in the cached part of the prompt (the cached content).
CacheTokensDetails Output only. List of modalities of the cached content in the request input.
CandidatesTokenCount Total number of tokens across all the generated response candidates.
CandidatesTokensDetails Output only. List of modalities that were returned in the response.
PromptTokenCount Number of tokens in the prompt. When CachedContent is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
PromptTokensDetails Output only. List of modalities that were processed in the request input.
TotalTokenCount Total token count for the generation request (prompt + response candidates).

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also