Package com.tnsai.intelligence.rag

Record Class RetrievedDocument

java.lang.Object
java.lang.Record
com.tnsai.intelligence.rag.RetrievedDocument
Record Components:
content - the retrieved text content
source - identifier for the document source (URI, file path, entry ID, etc.)
score - relevance score (higher is more relevant); semantics depend on the strategy
metadata - arbitrary key-value metadata (e.g., chunk index, tier, session ID)
public record RetrievedDocument(String content, String source, double score, Map<String,String> metadata) extends Record
A document retrieved by a RAGStrategy.

Holds the content, source identifier, relevance score, and arbitrary metadata. Instances are immutable and safe to share across threads.

Since:
0.2.4

  • Constructor Details

    • RetrievedDocument

      public RetrievedDocument(String content, String source, double score, Map<String,String> metadata)
      Canonical constructor with validation.

    • RetrievedDocument

      public RetrievedDocument(String content, String source, double score)
      Convenience constructor without metadata.
      Parameters:
      content - the retrieved text content
      source - identifier for the document source
      score - relevance score

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

    • content

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

    • source

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

    • score

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

    • metadata

      public Map<String,String> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component