com.tencentcloudapi.es.v20250101.models

Class RunRerankRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.es.v20250101.models.RunRerankRequest

public class RunRerankRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
RunRerankRequest()
RunRerankRequest(RunRerankRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String[]	getDocuments() Get 待排序的候选doc列表。
String	getModelName() Get 模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。
String	getQuery() Get 查询文本。
Boolean	getReturnDocuments() Get 返回的排序结果列表里面是否返回每一条document原文，默认值False。
Long	getTopN() Get 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。
void	setDocuments(String[] Documents) Set 待排序的候选doc列表。
void	setModelName(String ModelName) Set 模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。
void	setQuery(String Query) Set 查询文本。
void	setReturnDocuments(Boolean ReturnDocuments) Set 返回的排序结果列表里面是否返回每一条document原文，默认值False。
void	setTopN(Long TopN) Set 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RunRerankRequest

public RunRerankRequest()

RunRerankRequest

public RunRerankRequest(RunRerankRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getModelName

public String getModelName()

Get 模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

Returns:

ModelName 模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

setModelName

public void setModelName(String ModelName)

Set 模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

Parameters:

ModelName - 模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

getQuery

public String getQuery()

Get 查询文本。

Returns:

Query 查询文本。

setQuery

public void setQuery(String Query)

Set 查询文本。

Parameters:

Query - 查询文本。

getDocuments

public String[] getDocuments()

Get 待排序的候选doc列表。

Returns:

Documents 待排序的候选doc列表。

setDocuments

public void setDocuments(String[] Documents)

Set 待排序的候选doc列表。

Parameters:

Documents - 待排序的候选doc列表。

getTopN

public Long getTopN()

Get 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

Returns:

TopN 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

setTopN

public void setTopN(Long TopN)

Set 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

Parameters:

TopN - 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

getReturnDocuments

public Boolean getReturnDocuments()

Get 返回的排序结果列表里面是否返回每一条document原文，默认值False。

Returns:

ReturnDocuments 返回的排序结果列表里面是否返回每一条document原文，默认值False。

setReturnDocuments

public void setReturnDocuments(Boolean ReturnDocuments)

Set 返回的排序结果列表里面是否返回每一条document原文，默认值False。

Parameters:

ReturnDocuments - 返回的排序结果列表里面是否返回每一条document原文，默认值False。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.