Package software.amazon.awssdk.services.bedrockruntime.model

Class TokenUsage

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.TokenUsage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TokenUsage.Builder,TokenUsage>

@Generated("software.amazon.awssdk:codegen")
public final class TokenUsage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TokenUsage.Builder,TokenUsage>

The tokens used in a message API inference call.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TokenUsage.Builder

Method Summary

Modifier and Type	Method	Description
static TokenUsage.Builder	builder()
List<CacheDetail>	cacheDetails()	Detailed breakdown of cache writes by TTL.
Integer	cacheReadInputTokens()	The number of input tokens read from the cache for the request.
Integer	cacheWriteInputTokens()	The number of input tokens written to the cache for the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCacheDetails()	For responses, this returns true if the service returned a value for the CacheDetails property.
int	hashCode()
Integer	inputTokens()	The number of tokens sent in the request to the model.
Integer	outputTokens()	The number of tokens that the model generated for the request.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TokenUsage.Builder>	serializableBuilderClass()
TokenUsage.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	totalTokens()	The total of input tokens and tokens generated by the model.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

inputTokens

public final Integer inputTokens()

The number of tokens sent in the request to the model.

Returns:

The number of tokens sent in the request to the model.

outputTokens

public final Integer outputTokens()

The number of tokens that the model generated for the request.

Returns:

The number of tokens that the model generated for the request.

totalTokens

public final Integer totalTokens()

The total of input tokens and tokens generated by the model.

Returns:

The total of input tokens and tokens generated by the model.

cacheReadInputTokens

public final Integer cacheReadInputTokens()

The number of input tokens read from the cache for the request.

Returns:

The number of input tokens read from the cache for the request.

cacheWriteInputTokens

public final Integer cacheWriteInputTokens()

The number of input tokens written to the cache for the request.

Returns:

The number of input tokens written to the cache for the request.

hasCacheDetails

public final boolean hasCacheDetails()

For responses, this returns true if the service returned a value for the CacheDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

cacheDetails

public final List<CacheDetail> cacheDetails()

Detailed breakdown of cache writes by TTL. Empty if no cache creation occurred. Sorted by TTL duration (1h before 5m).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCacheDetails() method.

Returns:

Detailed breakdown of cache writes by TTL. Empty if no cache creation occurred. Sorted by TTL duration (1h before 5m).

toBuilder

public TokenUsage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TokenUsage.Builder,TokenUsage>

builder

public static TokenUsage.Builder builder()

serializableBuilderClass

public static Class<? extends TokenUsage.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo