Class BedrockTokenUsage

java.lang.Object

dev.langchain4j.model.output.TokenUsage

dev.langchain4j.model.bedrock.BedrockTokenUsage

public class BedrockTokenUsage
extends TokenUsage

Bedrock-specific token usage that includes cache-related metrics.

This class extends TokenUsage to include AWS Bedrock prompt caching metrics: cacheWriteInputTokens() and cacheReadInputTokens().

Since:

1.0.0-beta2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BedrockTokenUsage.Builder

Constructor Summary

Constructors

Constructor	Description
BedrockTokenUsage(BedrockTokenUsage.Builder builder)

Method Summary

Modifier and Type	Method	Description
BedrockTokenUsage	add(TokenUsage that)	Adds the token usage of two responses together.
static BedrockTokenUsage.Builder	builder()
Integer	cacheReadInputTokens()	Returns The total cached token read count, or null if unknown.
Integer	cacheWriteInputTokens()	Returns The total cached token write count, or null if unknown.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class TokenUsage

inputTokenCount, outputTokenCount, sum, sum, totalTokenCount

Methods inherited from class Object

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

Constructor Details

BedrockTokenUsage

public BedrockTokenUsage(BedrockTokenUsage.Builder builder)

Method Details

cacheWriteInputTokens

public Integer cacheWriteInputTokens()

Returns The total cached token write count, or null if unknown.

Returns:

The total cached token write count, or null if unknown.

cacheReadInputTokens

public Integer cacheReadInputTokens()

Returns The total cached token read count, or null if unknown.

Returns:

The total cached token read count, or null if unknown.

add

public BedrockTokenUsage add(TokenUsage that)

Description copied from class: TokenUsage

Adds the token usage of two responses together.

Fields which are null in both responses will be null in the result.

When one of the two is an instance of a TokenUsage subclass, that subclass performs the addition, so that the extra fields it carries are preserved. The result then has the type of that subclass, no matter which of the two sides it was on.

A subclass carrying extra fields should therefore override this method and sum those fields as well. When neither side overrides it, there is nothing that knows how to sum the extra fields and the result is a plain TokenUsage.

Overrides:

add in class TokenUsage

Parameters:

that - The token usage to add to this one.

Returns:

a new TokenUsage instance with the token usage of both responses added together.

equals

public boolean equals(Object o)

Overrides:

equals in class TokenUsage

hashCode

public int hashCode()

Overrides:

hashCode in class TokenUsage

toString

public String toString()

Overrides:

toString in class TokenUsage

builder

public static BedrockTokenUsage.Builder builder()