排序服务_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

AI搜索开放平台支持通过API的方式调用文档相关性打分服务，您可以将服务集成到您的业务处理链路中，来提升检索效果。

服务名称

服务ID

服务描述

API调用QPS限制（含主账号与RAM子账号）

BGE重排模型

ops-bge-reranker-larger

提供基于BGE模型的文档打分服务，可根据query与文档内容的相关性，按分数由高到低对doc进行排序，并输出对应的打分结果。

支持中英双语，最大输入token长度512（Query+doc长度）。

说明

如需扩充QPS，请通过工单联系技术支持协助。

OpenSearch文本排序-001

ops-text-reranker-001

OpenSearch自研重排模型，融合多行业数据集训练，提供高水准的重排服务，可根据Query及doc的语义相关性从高到低对doc进行排序。

支持中英双语，最大输入token长度512（Query+doc长度）。

前提条件

获取身份鉴权信息
通过API调用AI搜索开放平台服务时，需要对调用者身份进行鉴权，如何获取鉴权信息请参见获取API-KEY。
获取服务调用地址
支持通过公网和VPC两种方式调用服务，详情请参见获取服务接入地址。

请求说明

公共说明

请求body最大不能超过8MB。

请求方式

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/ranker/{service_id}

参数说明：

host：调用服务的地址，支持通过公网和VPC两种方式调用API服务，可参见获取服务接入地址。
workspace_name：工作空间名称，例如default。
service_id：系统内置服务id，例如ops-bge-reranker-larger。

请求参数

Header参数

API-KEY认证

参数	类型	必填	描述	示例值
Content-Type	String	是	请求类型：application/json	application/json
Authorization	String	是	API-Key	Bearer OS-d1**2a

Body参数

参数

类型

必填

描述

示例值

query

String

是

查询内容。

上海有什么好玩的

docs

List<String>

是

文档内容（列表）。

["上海有许多好玩的地方",

"北京有许多好玩的地方"]

返回参数

参数	类型	描述	示例值
request_id	String	系统对一次API调用赋予的唯一标识。	A5B25952-4406-45BF-99EC-E8020246****
latency	Float/Int	请求耗时，单位ms。	10
usage.doc_count	Int	本次请求输入的文档数量。	2
result.scores	List<score>	按分数由高到低对doc进行排序的结果。	[ { "index":1, "score":0.99 }, { "index":2, "score":0.05 } ]
result.scores[].index	Int	本doc在输入候选doc数组中的位置索引值。	1
result.scores[].score	Float	打分结果，值越大表示相关性越高。	0.99

Curl请求示例

curl -XPOST -H"Content-Type: application/json" 
"http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/ranker/ops-bge-reranker-larger" 
-H "Authorization: Bearer 您的API-KEY" 
-d "{
    \"query\":\"opensearch产品文档\",
    \"docs\":[
        \"什么是opensearch\",
        \"什么是智能问答版\",
        \"智能问答版有啥优势\"
      ]
}"

响应示例

正常响应示例

{
  "request_id":"24B004E0-ADEF-****-879B-F28359BFAD1D",
  "latency":19,
  "usage":{
      "doc_count":3
  },
  "result":{
      "scores":[
        {
          "index":0,"score":0.45026873385713345
        },
        {
          "index":1,"score":1.1412238544346029E-4
        },
        {
          "index":2,"score":8.029784284533197E-5
        }
      ]
    }
  }

异常响应示例

在访问请求出错的情况下，输出的结果中会通过code和message指明出错原因。

{
    "request_id": "45C8C9E5-6BCB-****-80D3-E298F788512B",
    "latency": 0,
    "code": "InvalidParameter",
    "message": "JSON parse error: Unexpected character ..."
}

状态码说明

请参见AI搜索开放平台状态码说明。