AI搜索開放平臺支持通過API的方式調用文檔相關性打分服務，您可以將服務集成到您的業務處理鏈路中，來提升檢索效果。
服務名稱 | 服務ID | 服務描述 | API調用QPS限制（含主賬號與RAM子賬號） |
BGE重排模型 | ops-bge-reranker-larger | 提供基于BGE模型的文檔打分服務，可根據query與文檔內容的相關性，按分數由高到低對doc進行排序，并輸出對應的打分結果。 支持中英雙語，最大輸入token長度512（Query+doc長度）。 | 20 說明 如需擴充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搜索開放平臺狀態碼說明。