Package com.alibaba.cloud.ai.dashscope.spec

Record Class DashScopeApiSpec.RerankRequestParameter

java.lang.Object
java.lang.Record
com.alibaba.cloud.ai.dashscope.spec.DashScopeApiSpec.RerankRequestParameter
Record Components:
topN - return top n documents, it will return all the documents if top n not pass.
returnDocuments - if need to return original documents
Enclosing class:
DashScopeApiSpec
public static record DashScopeApiSpec.RerankRequestParameter(Integer topN, Boolean returnDocuments) extends Record
Represents rerank request parameters.

  • Constructor Details

    • RerankRequestParameter

      public RerankRequestParameter(Integer topN, Boolean returnDocuments)
      Creates an instance of a RerankRequestParameter record class.
      Parameters:
      topN - the value for the topN record component
      returnDocuments - the value for the returnDocuments 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.

    • topN

      public Integer topN()
      Returns the value of the topN record component.
      Returns:
      the value of the topN record component

    • returnDocuments

      public Boolean returnDocuments()
      Returns the value of the returnDocuments record component.
      Returns:
      the value of the returnDocuments record component