Package dev.langchain4j.model.openai

Class OpenAiTokenizer

java.lang.Object

dev.langchain4j.model.openai.OpenAiTokenizer

All Implemented Interfaces:

Tokenizer

public class OpenAiTokenizer
extends Object
implements Tokenizer

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
OpenAiTokenizer(String modelName)

Method Summary

Modifier and Type	Method	Description
String	decode(List<Integer> tokens)
List<Integer>	encode(String text)
List<Integer>	encode(String text, int maxTokensToEncode)
int	estimateTokenCountInForcefulToolExecutionRequest(ToolExecutionRequest toolExecutionRequest)
int	estimateTokenCountInForcefulToolSpecification(ToolSpecification toolSpecification)
int	estimateTokenCountInMessage(ChatMessage message)
int	estimateTokenCountInMessages(Iterable<ChatMessage> messages)
int	estimateTokenCountInText(String text)
int	estimateTokenCountInToolExecutionRequests(Iterable<ToolExecutionRequest> toolExecutionRequests)
int	estimateTokenCountInToolSpecifications(Iterable<ToolSpecification> toolSpecifications)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.Tokenizer

estimateTokenCountInTools, estimateTokenCountInTools

Constructor Details

OpenAiTokenizer

public OpenAiTokenizer(String modelName)

Method Details

estimateTokenCountInText

public int estimateTokenCountInText(String text)

Specified by:

estimateTokenCountInText in interface Tokenizer

estimateTokenCountInMessage

public int estimateTokenCountInMessage(ChatMessage message)

Specified by:

estimateTokenCountInMessage in interface Tokenizer

estimateTokenCountInMessages

public int estimateTokenCountInMessages(Iterable<ChatMessage> messages)

Specified by:

estimateTokenCountInMessages in interface Tokenizer

estimateTokenCountInToolSpecifications

public int estimateTokenCountInToolSpecifications(Iterable<ToolSpecification> toolSpecifications)

Specified by:

estimateTokenCountInToolSpecifications in interface Tokenizer

estimateTokenCountInForcefulToolSpecification

public int estimateTokenCountInForcefulToolSpecification(ToolSpecification toolSpecification)

Specified by:

estimateTokenCountInForcefulToolSpecification in interface Tokenizer

encode

public List<Integer> encode(String text)

encode

public List<Integer> encode(String text,
 int maxTokensToEncode)

decode

public String decode(List<Integer> tokens)

estimateTokenCountInToolExecutionRequests

public int estimateTokenCountInToolExecutionRequests(Iterable<ToolExecutionRequest> toolExecutionRequests)

Specified by:

estimateTokenCountInToolExecutionRequests in interface Tokenizer

estimateTokenCountInForcefulToolExecutionRequest

public int estimateTokenCountInForcefulToolExecutionRequest(ToolExecutionRequest toolExecutionRequest)

Specified by:

estimateTokenCountInForcefulToolExecutionRequest in interface Tokenizer