Package com.tnsai.evaluation.rag.embedding

Record Class EmbeddingBenchModel

java.lang.Object
java.lang.Record
com.tnsai.evaluation.rag.embedding.EmbeddingBenchModel
Record Components:
name - table label
nativeDimensions - native vector length before any truncate
reportedDimensions - dimensions actually stored and searched
bytesPerDoc - reportedDimensions * Float.BYTES
queryEmbedder - embeds queries
documentEmbedder - embeds passages
public record EmbeddingBenchModel(String name, int nativeDimensions, int reportedDimensions, int bytesPerDoc, com.tnsai.memory.advanced.EmbeddingFunction queryEmbedder, com.tnsai.memory.advanced.EmbeddingFunction documentEmbedder) extends Record
Named embedder under comparison.
Since:
0.14.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    EmbeddingBenchModel(String name, int nativeDimensions, int reportedDimensions, int bytesPerDoc, com.tnsai.memory.advanced.EmbeddingFunction queryEmbedder, com.tnsai.memory.advanced.EmbeddingFunction documentEmbedder)
    Creates an instance of a EmbeddingBenchModel record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    bytesPerDoc()
    Returns the value of the bytesPerDoc record component.
    com.tnsai.memory.advanced.EmbeddingFunction
    documentEmbedder()
    Returns the value of the documentEmbedder record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    int
    nativeDimensions()
    Returns the value of the nativeDimensions record component.
    static EmbeddingBenchModel
    of(String name, int nativeDimensions, int reportedDimensions, com.tnsai.memory.advanced.EmbeddingFunction queryEmbedder, com.tnsai.memory.advanced.EmbeddingFunction documentEmbedder)
     
    static EmbeddingBenchModel
    of(String name, int nativeDimensions, com.tnsai.memory.advanced.EmbeddingFunction embedder)
     
    static EmbeddingBenchModel
    ollama(String name, int nativeDimensions, OllamaEmbeddingFunction client)
    Wraps an Ollama model so queries use the query prefix and passages use the document prefix.
    com.tnsai.memory.advanced.EmbeddingFunction
    queryEmbedder()
    Returns the value of the queryEmbedder record component.
    int
    reportedDimensions()
    Returns the value of the reportedDimensions record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • EmbeddingBenchModel

      public EmbeddingBenchModel(String name, int nativeDimensions, int reportedDimensions, int bytesPerDoc, com.tnsai.memory.advanced.EmbeddingFunction queryEmbedder, com.tnsai.memory.advanced.EmbeddingFunction documentEmbedder)
      Creates an instance of a EmbeddingBenchModel record class.
      Parameters:
      name - the value for the name record component
      nativeDimensions - the value for the nativeDimensions record component
      reportedDimensions - the value for the reportedDimensions record component
      bytesPerDoc - the value for the bytesPerDoc record component
      queryEmbedder - the value for the queryEmbedder record component
      documentEmbedder - the value for the documentEmbedder record component

  • Method Details

    • of

      public static EmbeddingBenchModel of(String name, int nativeDimensions, com.tnsai.memory.advanced.EmbeddingFunction embedder)

    • of

      public static EmbeddingBenchModel of(String name, int nativeDimensions, int reportedDimensions, com.tnsai.memory.advanced.EmbeddingFunction queryEmbedder, com.tnsai.memory.advanced.EmbeddingFunction documentEmbedder)

    • ollama

      public static EmbeddingBenchModel ollama(String name, int nativeDimensions, OllamaEmbeddingFunction client)
      Wraps an Ollama model so queries use the query prefix and passages use the document prefix.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • nativeDimensions

      public int nativeDimensions()
      Returns the value of the nativeDimensions record component.
      Returns:
      the value of the nativeDimensions record component

    • reportedDimensions

      public int reportedDimensions()
      Returns the value of the reportedDimensions record component.
      Returns:
      the value of the reportedDimensions record component

    • bytesPerDoc

      public int bytesPerDoc()
      Returns the value of the bytesPerDoc record component.
      Returns:
      the value of the bytesPerDoc record component

    • queryEmbedder

      public com.tnsai.memory.advanced.EmbeddingFunction queryEmbedder()
      Returns the value of the queryEmbedder record component.
      Returns:
      the value of the queryEmbedder record component

    • documentEmbedder

      public com.tnsai.memory.advanced.EmbeddingFunction documentEmbedder()
      Returns the value of the documentEmbedder record component.
      Returns:
      the value of the documentEmbedder record component