Module org.nasdanika.ai
Package org.nasdanika.ai

Record Class Embeddings.Requirement

java.lang.Object
java.lang.Record
org.nasdanika.ai.Embeddings.Requirement
Enclosing interface:
Embeddings
public static record Embeddings.Requirement(String provider, String model, String version, int chunkSize, int overlap) extends Record
Embeddings requirement. String attributes match any value if null. Chunk size is the max input size if more than the max input size or non-positive.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Requirement(String provider, String model, String version, int chunkSize, int overlap)
    Creates an instance of a Requirement record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    chunkSize()
    Returns the value of the chunkSize 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
    model()
    Returns the value of the model record component.
    int
    overlap()
    Returns the value of the overlap record component.
    String
    provider()
    Returns the value of the provider record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    version()
    Returns the value of the version record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Requirement

      public Requirement(String provider, String model, String version, int chunkSize, int overlap)
      Creates an instance of a Requirement record class.
      Parameters:
      provider - the value for the provider record component
      model - the value for the model record component
      version - the value for the version record component
      chunkSize - the value for the chunkSize record component
      overlap - the value for the overlap record component

  • Method Details

    • 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.

    • provider

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

    • model

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

    • version

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

    • chunkSize

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

    • overlap

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