Class OpenAiOfficialTokenUsage.InputTokensDetails

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialTokenUsage.InputTokensDetails

Enclosing class:

OpenAiOfficialTokenUsage

public static class OpenAiOfficialTokenUsage.InputTokensDetails
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiOfficialTokenUsage.InputTokensDetails.Builder

Constructor Summary

Constructors

Constructor	Description
InputTokensDetails(OpenAiOfficialTokenUsage.InputTokensDetails.Builder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiOfficialTokenUsage.InputTokensDetails.Builder	builder()
Integer	cachedTokens()
Integer	cacheWriteTokens()	Returns the number of input tokens written to the prompt cache, as reported by usage.prompt_tokens_details.cache_write_tokens (Chat Completions API) and usage.input_tokens_details.cache_write_tokens (Responses API).
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class Object

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

Constructor Details

InputTokensDetails

public InputTokensDetails(OpenAiOfficialTokenUsage.InputTokensDetails.Builder builder)

Method Details

cachedTokens

public Integer cachedTokens()

cacheWriteTokens

public Integer cacheWriteTokens()

Returns the number of input tokens written to the prompt cache, as reported by usage.prompt_tokens_details.cache_write_tokens (Chat Completions API) and usage.input_tokens_details.cache_write_tokens (Responses API).

Returns null when the model provider did not report it, which is distinct from a reported zero.

Since:

1.21.0

builder

public static OpenAiOfficialTokenUsage.InputTokensDetails.Builder builder()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object