Interface TokenCountEstimator

  • All Implemented Interfaces:

    
    public interface TokenCountEstimator
    
                        

    Represents an interface for estimating the count of tokens in various texts, text segments, etc. This can be useful when it's necessary to know in advance the cost of processing a specified text by the LLM.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract int estimateTokenCount(String text) Estimates the count of tokens in the given text.
      int estimateTokenCount(TextSegment textSegment) Estimates the count of tokens in the given text segment.
      int estimateTokenCount(List<TextSegment> textSegments) Estimates the count of tokens in the given text segments.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • estimateTokenCount

         abstract int estimateTokenCount(String text)

        Estimates the count of tokens in the given text.

        Parameters:
        text - the text.
        Returns:

        the estimated count of tokens.

      • estimateTokenCount

         int estimateTokenCount(TextSegment textSegment)

        Estimates the count of tokens in the given text segment.

        The metadata will not be included in the estimate.

        Parameters:
        textSegment - the text segment.
        Returns:

        the estimated count of tokens.

      • estimateTokenCount

         int estimateTokenCount(List<TextSegment> textSegments)

        Estimates the count of tokens in the given text segments.

        The metadata will not be included in the estimate.

        Parameters:
        textSegments - the text segments.
        Returns:

        the estimated count of tokens.