Reranker重排序API
更新時間 2025-09-08 14:07:19
最近更新時間: 2025-09-08 14:07:19
分享文章
接口描述
| - | 描述 |
|---|---|
| 接口名稱 | 重排序 |
| 請求路徑 | //wishub-x6.daliqc.cn/v1/rerank |
| 功能描述 | 通常用于計算查詢和文檔之間的相關性分數。 |
請求參數
請求頭header參數
| 參數 | 類型 | 必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Content-Type | String | 是 | application/json | json格式 |
| Authorization | String | 是 | Bearer APP_KEY | 請求鑒權的 App Key，由平臺提供。Bearer 開頭 |
請求體body參數
| 名稱 | 類型 | 必選 | 示例值 | 描述 |
|---|---|---|---|---|
| model | String | 是 | 96dcaaaaaaaaaaaa5ff55ea377831a | 模型id，請在模型詳情頁頂部區域查看，樣例：96dcaaaaaaaaaaaa5ff55ea377831a |
| query | String | 是 | 人工智能的發展趨勢 | 待重排序的查詢文本（例如用戶搜索詞） |
| documents | Array | 是 | ["人工智能正在快速發展","機器學習是AI的核心技術","大語言模型改變了AI領域"] | 待排序的文檔列表（每個元素為一個文檔文本，例如搜索結果中的候選文本） |
| truncate_prompt_tokens | Int | 否 | 8192 | 最大token值，取值范圍（1, 8192） |
| top_n | Int | 否 | 2 | 返回top_n個文檔，取值范圍大于0，且小于documents的數量 |
| return_documents | Boolean | 否 | false | 是否返回原文檔 |
請求代碼示例
使用前請替換具體的${APP_KEY}和${MODEL_ID}值
curl --location '//wishub-x6.daliqc.cn/v1/rerank' \
--header 'Authorization: Bearer ${APP_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"model": "${MODEL_ID}",
"query": "人工智能的發展趨勢",
"documents": [
"人工智能正在快速發展。",
"機器學習是AI的核心技術。",
"大語言模型改變了AI領域。",
"自然語言是AI領域的里程碑"
],
"top_n": 2,
"return_documents": true
}'返回值說明
請求成功返回響應參數
| 名稱 | 類型 | 描述 | 示例值 | 下級對象 |
|---|---|---|---|---|
| code | Int | 接口狀態碼，返回狀態，返回 0 表示成功 | 0 | |
| id | String | 請求標識 | endpoint_common_11684 | |
| results | Array | 模型返回的結果 | - | results |
| created | Int | 回答的創建時間，由模型側返回 | 1719904068 | |
| model | String | 模型名稱 | Bge-Rerank-Large |
表results
| 名稱 | 類型 | 描述 | 示例值 | 下級對象 |
|---|---|---|---|---|
| index | Int | 在原文檔中對應索引 | 0 | |
| relevance_score | Float | 分數 | 0.992 | |
| document | Object | 文檔內容，當return_documents為true時，無此字段 | - | document |
表document
| 名稱 | 類型 | 描述 | 示例值 | 下級對象 |
|---|---|---|---|---|
| text | String | 目標文檔 | 人工智能正在快速發展 |
請求失敗返回響應參數
| 字段名 | 二級字段 | 類型 | 描述 | 示例值 |
|---|---|---|---|---|
| error | - | Object | 錯誤信息 | - |
| - | code | String | 錯誤碼，返回錯誤代碼參考下面的錯誤代碼列表 | 500002 |
| - | type | String | 返回對應的錯誤碼 | PARAM_ERROR |
| - | message | String | 返回對應的錯誤信息 | modelId不正確，請重試 |
錯誤碼
如遇模型調用失敗且返回報錯信息，可訪問官網錯誤處理頁面，尋求解決方法。
返回值示例
請求成功返回值示例
{
"code": 0,
"id": "34870e0590084e40800f856bc8e08201",
"model": "b2d640f305f64c52ab5a04cd8565a233",
"results": [
{
"index": 0,
"document": {
"text": "人工智能正在快速發展。"
},
"relevance_score": 0.992597
},
{
"index": 2,
"document": {
"text": "大語言模型改變了AI領域。"
},
"relevance_score": 0.8079157
}
]
}請求失敗返回值示例
{
"error": {
"code": "500001",
"message": "算法服務接口異常，請聯系管理員",
"type": "INVOKE_MODEL_ERROR"
}
}
