Struct UsageMetadata 

#[non_exhaustive]
pub struct UsageMetadata {
    pub prompt_token_count: i32,
    pub candidates_token_count: i32,
    pub total_token_count: i32,
    pub tool_use_prompt_token_count: i32,
    pub thoughts_token_count: i32,
    pub cached_content_token_count: i32,
    pub prompt_tokens_details: Vec<ModalityTokenCount>,
    pub cache_tokens_details: Vec<ModalityTokenCount>,
    pub candidates_tokens_details: Vec<ModalityTokenCount>,
    pub tool_use_prompt_tokens_details: Vec<ModalityTokenCount>,
    pub traffic_type: TrafficType,
    /* private fields */
}

Available on crate feature prediction-service only.

Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

prompt_token_count: i32

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.

candidates_token_count: i32

The total number of tokens in the generated candidates.

total_token_count: i32

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.

tool_use_prompt_token_count: i32

Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.

thoughts_token_count: i32

Output only. The number of tokens that were part of the model’s generated “thoughts” output, if applicable.

cached_content_token_count: i32

Output only. The number of tokens in the cached content that was used for this request.

prompt_tokens_details: Vec<ModalityTokenCount>

Output only. A detailed breakdown of the token count for each modality in the prompt.

cache_tokens_details: Vec<ModalityTokenCount>

Output only. A detailed breakdown of the token count for each modality in the cached content.

candidates_tokens_details: Vec<ModalityTokenCount>

Output only. A detailed breakdown of the token count for each modality in the generated candidates.

tool_use_prompt_tokens_details: Vec<ModalityTokenCount>

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.

traffic_type: TrafficType

Output only. The traffic type for this request.

Implementations

impl UsageMetadata

pub fn new() -> Self

pub fn set_prompt_token_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of prompt_token_count.

Example

let x = UsageMetadata::new().set_prompt_token_count(42);

pub fn set_candidates_token_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of candidates_token_count.

Example

let x = UsageMetadata::new().set_candidates_token_count(42);

pub fn set_total_token_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of total_token_count.

Example

let x = UsageMetadata::new().set_total_token_count(42);

pub fn set_tool_use_prompt_token_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of tool_use_prompt_token_count.

Example

let x = UsageMetadata::new().set_tool_use_prompt_token_count(42);

pub fn set_thoughts_token_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of thoughts_token_count.

Example

let x = UsageMetadata::new().set_thoughts_token_count(42);

pub fn set_cached_content_token_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of cached_content_token_count.

Example

let x = UsageMetadata::new().set_cached_content_token_count(42);

pub fn set_prompt_tokens_details<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ModalityTokenCount>,

Sets the value of prompt_tokens_details.

Example

use google_cloud_aiplatform_v1::model::ModalityTokenCount;
let x = UsageMetadata::new()
    .set_prompt_tokens_details([
        ModalityTokenCount::default()/* use setters */,
        ModalityTokenCount::default()/* use (different) setters */,
    ]);

pub fn set_cache_tokens_details<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ModalityTokenCount>,

Sets the value of cache_tokens_details.

Example

use google_cloud_aiplatform_v1::model::ModalityTokenCount;
let x = UsageMetadata::new()
    .set_cache_tokens_details([
        ModalityTokenCount::default()/* use setters */,
        ModalityTokenCount::default()/* use (different) setters */,
    ]);

pub fn set_candidates_tokens_details<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ModalityTokenCount>,

Sets the value of candidates_tokens_details.

Example

use google_cloud_aiplatform_v1::model::ModalityTokenCount;
let x = UsageMetadata::new()
    .set_candidates_tokens_details([
        ModalityTokenCount::default()/* use setters */,
        ModalityTokenCount::default()/* use (different) setters */,
    ]);

pub fn set_tool_use_prompt_tokens_details<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ModalityTokenCount>,

Sets the value of tool_use_prompt_tokens_details.

Example

use google_cloud_aiplatform_v1::model::ModalityTokenCount;
let x = UsageMetadata::new()
    .set_tool_use_prompt_tokens_details([
        ModalityTokenCount::default()/* use setters */,
        ModalityTokenCount::default()/* use (different) setters */,
    ]);

pub fn set_traffic_type<T: Into<TrafficType>>(self, v: T) -> Self

Sets the value of traffic_type.

Example

use google_cloud_aiplatform_v1::model::usage_metadata::TrafficType;
let x0 = UsageMetadata::new().set_traffic_type(TrafficType::OnDemand);
let x1 = UsageMetadata::new().set_traffic_type(TrafficType::ProvisionedThroughput);

Trait Implementations

impl Clone for UsageMetadata

fn clone(&self) -> UsageMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UsageMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UsageMetadata

fn default() -> UsageMetadata

Returns the “default value” for a type.

impl Message for UsageMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UsageMetadata

fn eq(&self, other: &UsageMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UsageMetadata