Package ai.chatur.cortex

Record Class SearchResult

java.lang.Object
java.lang.Record
ai.chatur.cortex.SearchResult
Record Components:
subject - the identifier of the matching resource within the Cortex namespace
match - the indexed literal that matched the search text
score - the relevance of the match, higher being more relevant
public record SearchResult(Term subject, String match, double score) extends Record
A full-text search hit in the knowledge graph.

Hits are reported once per resource, ranked by descending score. The score is the relevance the text index assigned to the best-matching literal; it is comparable only within a single result list, not across searches.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchResult(Term subject, String match, double score)
    Creates an instance of a SearchResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    match()
    Returns the value of the match record component.
    double
    score()
    Returns the value of the score record component.
    Term
    subject()
    Returns the value of the subject record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SearchResult

      public SearchResult(Term subject, String match, double score)
      Creates an instance of a SearchResult record class.
      Parameters:
      subject - the value for the subject record component
      match - the value for the match 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. 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.

    • subject

      public Term subject()
      Returns the value of the subject record component.
      Returns:
      the value of the subject record component

    • match

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

    • score

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