Package com.google.genai.types

Class UsageMetadata

java.lang.Object
com.google.genai.JsonSerializable
com.google.genai.types.UsageMetadata
public abstract class UsageMetadata extends JsonSerializable
Usage metadata about response(s).

  • Constructor Details

    • UsageMetadata

      public UsageMetadata()

  • Method Details

    • promptTokenCount

      public abstract Optional<Integer> promptTokenCount()
      The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.

    • cachedContentTokenCount

      public abstract Optional<Integer> cachedContentTokenCount()
      Output only. The number of tokens in the cached content that was used for this request.

    • responseTokenCount

      public abstract Optional<Integer> responseTokenCount()
      Total number of tokens across all the generated response candidates.

    • toolUsePromptTokenCount

      public abstract Optional<Integer> toolUsePromptTokenCount()
      Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.

    • thoughtsTokenCount

      public abstract Optional<Integer> thoughtsTokenCount()
      Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.

    • totalTokenCount

      public abstract Optional<Integer> totalTokenCount()
      The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.

    • promptTokensDetails

      public abstract Optional<List<ModalityTokenCount>> promptTokensDetails()
      Output only. A detailed breakdown of the token count for each modality in the prompt.

    • cacheTokensDetails

      public abstract Optional<List<ModalityTokenCount>> cacheTokensDetails()
      Output only. A detailed breakdown of the token count for each modality in the cached content.

    • responseTokensDetails

      public abstract Optional<List<ModalityTokenCount>> responseTokensDetails()
      List of modalities that were returned in the response.

    • toolUsePromptTokensDetails

      public abstract Optional<List<ModalityTokenCount>> toolUsePromptTokensDetails()
      Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.

    • trafficType

      public abstract Optional<TrafficType> trafficType()
      Output only. The traffic type for this request. This field is not supported in Gemini API.

    • serviceTier

      public abstract Optional<ServiceTier> serviceTier()
      Output only. Service tier of the request. This field is not supported in Vertex AI.

    • builder

      public static UsageMetadata.Builder builder()
      Instantiates a builder for UsageMetadata.

    • toBuilder

      public abstract UsageMetadata.Builder toBuilder()
      Creates a builder with the same values as this instance.

    • fromJson

      public static UsageMetadata fromJson(String jsonString)
      Deserializes a JSON string to a UsageMetadata object.