Package io.github.stefanbratanov.jvm.openai

Record Class ToolCall.FileSearchToolCall.FileSearch.RankingOptions

java.lang.Object
java.lang.Record
io.github.stefanbratanov.jvm.openai.ToolCall.FileSearchToolCall.FileSearch.RankingOptions
Enclosing class:
ToolCall.FileSearchToolCall.FileSearch
public static record ToolCall.FileSearchToolCall.FileSearch.RankingOptions(String ranker, double scoreThreshold) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    RankingOptions(String ranker, double scoreThreshold)
    Creates an instance of a RankingOptions 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
    ranker()
    Returns the value of the ranker record component.
    double
    scoreThreshold()
    Returns the value of the scoreThreshold 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

    • RankingOptions

      public RankingOptions(String ranker, double scoreThreshold)
      Creates an instance of a RankingOptions record class.
      Parameters:
      ranker - the value for the ranker record component
      scoreThreshold - the value for the scoreThreshold 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.

    • ranker

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

    • scoreThreshold

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