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

Record Class DashScopeApiSpec.DocumentRetrieveRequest

java.lang.Object
java.lang.Record
com.alibaba.cloud.ai.dashscope.spec.DashScopeApiSpec.DocumentRetrieveRequest
Enclosing class:
DashScopeApiSpec
public static record DashScopeApiSpec.DocumentRetrieveRequest(String query, int denseSimilarityTopK, int sparseSimilarityTopK, boolean enableRewrite, List<DashScopeApiSpec.DocumentRetrieveRequest.DocumentRetrieveModelConfig> rewrite, boolean enableReranking, List<DashScopeApiSpec.DocumentRetrieveRequest.DocumentRetrieveModelConfig> rerank, float rerankMinScore, int rerankTopN, List<Map<String,Object>> searchFilters) extends Record

  • Constructor Details

    • DocumentRetrieveRequest

      public DocumentRetrieveRequest(String query, int denseSimilarityTopK, int sparseSimilarityTopK, boolean enableRewrite, List<DashScopeApiSpec.DocumentRetrieveRequest.DocumentRetrieveModelConfig> rewrite, boolean enableReranking, List<DashScopeApiSpec.DocumentRetrieveRequest.DocumentRetrieveModelConfig> rerank, float rerankMinScore, int rerankTopN, List<Map<String,Object>> searchFilters)
      Creates an instance of a DocumentRetrieveRequest record class.
      Parameters:
      query - the value for the query record component
      denseSimilarityTopK - the value for the denseSimilarityTopK record component
      sparseSimilarityTopK - the value for the sparseSimilarityTopK record component
      enableRewrite - the value for the enableRewrite record component
      rewrite - the value for the rewrite record component
      enableReranking - the value for the enableReranking record component
      rerank - the value for the rerank record component
      rerankMinScore - the value for the rerankMinScore record component
      rerankTopN - the value for the rerankTopN record component
      searchFilters - the value for the searchFilters 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.

    • query

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

    • denseSimilarityTopK

      public int denseSimilarityTopK()
      Returns the value of the denseSimilarityTopK record component.
      Returns:
      the value of the denseSimilarityTopK record component

    • sparseSimilarityTopK

      public int sparseSimilarityTopK()
      Returns the value of the sparseSimilarityTopK record component.
      Returns:
      the value of the sparseSimilarityTopK record component

    • enableRewrite

      public boolean enableRewrite()
      Returns the value of the enableRewrite record component.
      Returns:
      the value of the enableRewrite record component

    • rewrite

      public List<DashScopeApiSpec.DocumentRetrieveRequest.DocumentRetrieveModelConfig> rewrite()
      Returns the value of the rewrite record component.
      Returns:
      the value of the rewrite record component

    • enableReranking

      public boolean enableReranking()
      Returns the value of the enableReranking record component.
      Returns:
      the value of the enableReranking record component

    • rerank

      public List<DashScopeApiSpec.DocumentRetrieveRequest.DocumentRetrieveModelConfig> rerank()
      Returns the value of the rerank record component.
      Returns:
      the value of the rerank record component

    • rerankMinScore

      public float rerankMinScore()
      Returns the value of the rerankMinScore record component.
      Returns:
      the value of the rerankMinScore record component

    • rerankTopN

      public int rerankTopN()
      Returns the value of the rerankTopN record component.
      Returns:
      the value of the rerankTopN record component

    • searchFilters

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