Package com.google.genai.types

Class GenerateContentResponseUsageMetadata

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.GenerateContentResponseUsageMetadata

public abstract class GenerateContentResponseUsageMetadata
extends JsonSerializable

Usage metadata about response(s).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenerateContentResponseUsageMetadata.Builder	Builder for GenerateContentResponseUsageMetadata.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

objectMapper

Constructor Summary

Constructors

Constructor	Description
GenerateContentResponseUsageMetadata()

Method Summary

Modifier and Type	Method	Description
static GenerateContentResponseUsageMetadata.Builder	builder()	Instantiates a builder for GenerateContentResponseUsageMetadata.
abstract Optional<Integer>	cachedContentTokenCount()	Output only.
abstract Optional<Integer>	candidatesTokenCount()	Number of tokens in the response(s).
static GenerateContentResponseUsageMetadata	fromJson(String jsonString)	Deserializes a JSON string to a GenerateContentResponseUsageMetadata object.
abstract Optional<Integer>	promptTokenCount()	Number of tokens in the request.
abstract GenerateContentResponseUsageMetadata.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<Integer>	totalTokenCount()	Total token count for prompt and response candidates.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GenerateContentResponseUsageMetadata

public GenerateContentResponseUsageMetadata()

Method Details

cachedContentTokenCount

public abstract Optional<Integer> cachedContentTokenCount()

Output only. Number of tokens in the cached part in the input (the cached content).

candidatesTokenCount

public abstract Optional<Integer> candidatesTokenCount()

Number of tokens in the response(s).

promptTokenCount

public abstract Optional<Integer> promptTokenCount()

Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.

totalTokenCount

public abstract Optional<Integer> totalTokenCount()

Total token count for prompt and response candidates.

builder

public static GenerateContentResponseUsageMetadata.Builder builder()

Instantiates a builder for GenerateContentResponseUsageMetadata.

toBuilder

public abstract GenerateContentResponseUsageMetadata.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static GenerateContentResponseUsageMetadata fromJson(String jsonString)

Deserializes a JSON string to a GenerateContentResponseUsageMetadata object.