Package com.axelor.ai.knowledge

Record Class KnowledgeRetriever.RetrievedChunk

java.lang.Object
java.lang.Record
com.axelor.ai.knowledge.KnowledgeRetriever.RetrievedChunk
Enclosing class:
KnowledgeRetriever
public static record KnowledgeRetriever.RetrievedChunk(String text, double score, String sourceType, String fileName, String modelName, String recordId) extends Record
A retrieved text chunk with metadata.

  • Constructor Details

    • RetrievedChunk

      public RetrievedChunk(String text, double score, String sourceType, String fileName, String modelName, String recordId)
      Creates an instance of a RetrievedChunk record class.
      Parameters:
      text - the value for the text record component
      score - the value for the score record component
      sourceType - the value for the sourceType record component
      fileName - the value for the fileName record component
      modelName - the value for the modelName record component
      recordId - the value for the recordId record component

  • Method Details

    • formatSource

      public String formatSource()

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

    • text

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

    • score

      public double score()
      Returns the value of the score record component.
      Returns:
      the value of the score record component

    • sourceType

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

    • fileName

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

    • modelName

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

    • recordId

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