Package sk.iway.iwcm.rag.search

Record Class MarkdownSearchService.SearchResult

java.lang.Object
java.lang.Record
sk.iway.iwcm.rag.search.MarkdownSearchService.SearchResult
Record Components:
title - source heading or relative path fallback
url - viewer URL, or null for filesystem sources
sourcePath - full logical path including the configured root
snippet - bounded Markdown excerpt from the best matching chunk, retaining line breaks and indentation
score - best chunk rerank score when available, otherwise its retrieval score
Enclosing class:
MarkdownSearchService
public static record MarkdownSearchService.SearchResult(String title, String url, String sourcePath, String snippet, Double score) extends Record
Represents one documentation source returned to a search client.

  • Constructor Details

    • SearchResult

      public SearchResult(String title, String url, String sourcePath, String snippet, Double score)
      Creates an instance of a SearchResult record class.
      Parameters:
      title - the value for the title record component
      url - the value for the url record component
      sourcePath - the value for the sourcePath record component
      snippet - the value for the snippet record component
      score - the value for the score 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • title

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

    • url

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

    • sourcePath

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

    • snippet

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

    • score

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