Rerank - 精排 - 云原生数据仓库AnalyticDB

通过模型对文档进行打分和重排序

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
gpdb:Rerank	list	*DBInstance `acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-xxxxxxxxx
RegionId	string	是	实例所在 Region ID。	cn-hangzhou
Query	string	是	Rerank 对应的查询语句。	ADBPG是什么
Documents	array	是	要重新排序的文档列表。
	string	是	单条文档内容。	ADBPG是阿里云OLAP数据库。
Model	string	否	Rerank 模型，目前支持 bge-reranker-v2-m3:（默认值），性能较好，单条推理支持 8192tokens，超出会被切分，效果可能下降。 bge-reranker-v2-minicpm-layerwise：效果相比 v2-m3 更优，单条推理支持 2048tokens，超出会被切分，效果可能下降。	bge-reranker-v2-m3
TopK	integer	否	要返回的最相关文档的数量。	3
ReturnDocuments	boolean	否	为 false 时，不返回 Documents 文本，仅仅返回文档排序的索引及 rerank 得分。	false
MaxChunksPerDoc	integer	否	超出模型窗口时，允许将文本切分的最大块数： bge-reranker-v2-m3：默认值是 10。 bge-reranker-v2-minicpm-layerwise：默认值是 5：说明切分举例如果使用 bge-reranker-v2-minicpm-layerwise 模型，则最大单推理窗口为 2048tokens，此时如果 query 是 48tokens，单个 document 参数内容为 9000tokens，则会被分为：1-2000 为第一个，2001-4000 为第二个，以此类推，并且切分个数超过 MaxChunksPerDoc 后，后面的语句会被丢弃。	10

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	接口返回详细信息。	success
Status	string	API 执行状态，取值说明： success：执行成功。 fail：执行失败。	success
Tokens	integer	消耗的 tokens 数。	100
Results	array<object>	Rerank 结果。
Results	object	结果详情。
Document	string	重排序的文档信息。	ADBPG是阿里云OLAP数据库。
Index	integer	此文档在请求参数 Documents 里的序号，从 0 开始。	1
RelevanceScore	float	Rerank 相似度分数。	2.31412

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Tokens": 100,
  "Results": {
    "Results": [
      {
        "Document": "ADBPG是阿里云OLAP数据库。",
        "Index": 1,
        "RelevanceScore": 2.31412
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。