調用Rerank API重排檢索結果-雲原生資料倉儲AnalyticDB-阿里雲

Rerank能夠解決向量檢索和全文檢索索引結果排序不精準的問題，通過語義理解對召回資料重新打分排序，顯著提升結果的相關性與準確性。 AnalyticDB for PostgreSQL版支援調用Rerank模型對檢索結果做重排，但不提供模型。

調試

您可以在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	object
Results	array<object>	Rerank 結果。
	object	結果詳情。
Document	string	重排序的文檔資訊。	ADBPG是阿里雲OLAP資料庫。
Index	integer	此文檔在請求參數 Documents 裡的序號，從 0 開始。	1
RelevanceScore	number	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
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。