Package dev.langchain4j.model.azure

Class AzureOpenAiTokenCountEstimator

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiTokenCountEstimator

All Implemented Interfaces:

TokenCountEstimator

public class AzureOpenAiTokenCountEstimator
extends Object
implements TokenCountEstimator

This class can be used to estimate the cost (in tokens) before calling OpenAI or when using streaming. Magic numbers present in this class were found empirically while testing. There are integration tests in place that are making sure that the calculations here are very close to that of OpenAI.

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiTokenCountEstimator()	Deprecated, for removal: This API element is subject to removal in a future version. Please use other constructors and specify the model name explicitly.
AzureOpenAiTokenCountEstimator(AzureOpenAiChatModelName modelName)	Creates an instance of the AzureOpenAiTokenCountEstimator for a given AzureOpenAiChatModelName.
AzureOpenAiTokenCountEstimator(AzureOpenAiEmbeddingModelName modelName)	Creates an instance of the AzureOpenAiTokenCountEstimator for a given AzureOpenAiEmbeddingModelName.
AzureOpenAiTokenCountEstimator(AzureOpenAiLanguageModelName modelName)	Creates an instance of the AzureOpenAiTokenCountEstimator for a given AzureOpenAiLanguageModelName.
AzureOpenAiTokenCountEstimator(String modelName)	Creates an instance of the AzureOpenAiTokenCountEstimator for a given model name.

Method Summary

Modifier and Type	Method	Description
int	estimateTokenCountInMessage(ChatMessage message)	Estimates the count of tokens in the given message.
int	estimateTokenCountInMessages(Iterable<ChatMessage> messages)	Estimates the count of tokens in the given messages.
int	estimateTokenCountInText(String text)	Estimates the count of tokens in the given text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AzureOpenAiTokenCountEstimator

@Deprecated(forRemoval=true)
public AzureOpenAiTokenCountEstimator()

Deprecated, for removal: This API element is subject to removal in a future version.

Please use other constructors and specify the model name explicitly.

Creates an instance of the AzureOpenAiTokenCountEstimator for the "gpt-3.5-turbo" model.

AzureOpenAiTokenCountEstimator

public AzureOpenAiTokenCountEstimator(AzureOpenAiChatModelName modelName)

Creates an instance of the AzureOpenAiTokenCountEstimator for a given AzureOpenAiChatModelName.

AzureOpenAiTokenCountEstimator

public AzureOpenAiTokenCountEstimator(AzureOpenAiEmbeddingModelName modelName)

Creates an instance of the AzureOpenAiTokenCountEstimator for a given AzureOpenAiEmbeddingModelName.

AzureOpenAiTokenCountEstimator

public AzureOpenAiTokenCountEstimator(AzureOpenAiLanguageModelName modelName)

Creates an instance of the AzureOpenAiTokenCountEstimator for a given AzureOpenAiLanguageModelName.

AzureOpenAiTokenCountEstimator

public AzureOpenAiTokenCountEstimator(String modelName)

Creates an instance of the AzureOpenAiTokenCountEstimator for a given model name.

Method Details

estimateTokenCountInText

public int estimateTokenCountInText(String text)

Description copied from interface: TokenCountEstimator

Estimates the count of tokens in the given text.

Specified by:

estimateTokenCountInText in interface TokenCountEstimator

Parameters:

text - the text.

Returns:

the estimated count of tokens.

estimateTokenCountInMessage

public int estimateTokenCountInMessage(ChatMessage message)

Description copied from interface: TokenCountEstimator

Estimates the count of tokens in the given message.

Specified by:

estimateTokenCountInMessage in interface TokenCountEstimator

Parameters:

message - the message.

Returns:

the estimated count of tokens.

estimateTokenCountInMessages

public int estimateTokenCountInMessages(Iterable<ChatMessage> messages)

Description copied from interface: TokenCountEstimator

Estimates the count of tokens in the given messages.

Specified by:

estimateTokenCountInMessages in interface TokenCountEstimator

Parameters:

messages - the messages.

Returns:

the estimated count of tokens.