調用QueryCollectionData實現向量、全文及混合檢索召回-雲原生資料倉儲AnalyticDB-阿里雲 - AnalyticDB

召迴向量資料。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:QueryCollectionData

create

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	否	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 ID。	gp-xxxxxxxxx
Collection	string	是	集合名。說明您可以通過 ListCollections 介面查看列表。	document
Namespace	string	否	命名空間。說明您可以通過 ListNamespaces 查看列表。	mynamespace
NamespacePassword	string	是	命名空間對應的密碼。	testpassword
Content	string	否	用於全文檢索索引的內容。即此值為空白時，僅使用向量檢索；不為空白時，使用向量和全文雙路檢索。說明和 Vector 參數不能同時為空白。	hello_world
Filter	string	否	要查詢的資料的過濾條件，格式為 SQL 的 WHERE 格式。是一個返回布爾值（真或假）的運算式，條件可以是簡單的比較子，如等於(=)、不等於(<>或!=)、大於(>), 小於(<)、大於等於(>=)、小於等於(<=)，也可以是邏輯運算子（AND, OR, NOT）組合的更複雜的運算式，以及使用 IN、BETWEEN、LIKE 等關鍵字的條件。說明詳細文法可參考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/	pipeline_id='1yhpmo0rbn' AND (spu='10025667796135' AND dept_id='226')
TopK	integer	是	設定返回 top 結果數量。	10
Vector	array	否	向量資料，長度和 CreateCollection 介面的維度一致。說明當 SparseVector 為空白時，只返回稠密向量檢索結果。當 Vector 和 SparseVector 均為空白時，只返回全文檢索索引結果。
	number	否	向量資料。	1.234
SparseVector	object	否	稀疏向量資料列表。
Indices	array	否	下標數組。說明列表大小不能超過 4000。
	integer	否	下標值。	1
Values	array	否	稀疏向量數組。
	number	否	稀疏向量資料。	1.2345
RegionId	string	是	執行個體所在地區 ID。	cn-hangzhou
Metrics	string	否	檢索時的相似性演算法。取值說明： l2：歐氏距離。 ip：點積（內積）距離。 cosine：餘弦相似性。說明此值為空白時，則使用構建索引時指定的演算法。	cosine
IncludeValues	boolean	否	是否返回稠密向量資料。取值說明： true：返回稠密向量資料。 false：不返回稠密向量資料。	true
HybridSearch	string	否	雙路召回演算法，預設為空白(即直接將向量和全文的分數比較並排序)。可選值： RRF：倒數排序融合(Reciprocal rank fusion)，有一個參數 k 控制融合效果，詳見 HybridSearchArgs 配置； Weight：比重排序，採用一個參數 alpha 控制向量和全文的分數比重，然後再排序，參數詳見 HybridSearchArgs 配置； Cascaded：先全文檢索索引再在其基礎上進行向量檢索；	RRF
HybridSearchArgs	object	否	雙路召回的演算法參數。目前支援 RRF 和 Weight 兩種： RRF：指定計算分數的演算法的`1/(k+rank_i)`中的 k 常數，範圍大於 1 的正整數，格式為： `{ "RRF": { "k": 60 } }` Weight: 計算公式`alpha * vector_score + (1-alpha) * text_score`，參數 alpha 表示向量和全文的檢索分數比重，範圍為 0～1，其中 0 表示只全文，1 表示只向量： `{ "Weight": { "alpha": 0.5 } }`
	object	否	召回演算法。
	any	否	召回演算法配置。	{ "RRF": { "k": 60 } }
OrderBy	string	否	預設為空白，表示排序的依據欄位。不支援雙路召回情境。欄位必須屬於 metadata 或表裡的預設欄位比如 id，格式支援：單個欄位，如 chunk_id；多個欄位，用逗號串連，如 block_id, chunk_id；支援反序，如: block_id DESC, chunk_id DESC；	chunk_id
Offset	integer	否	預設為空白，表示分頁查詢時的檢索起點。不支援雙路召回情境。範圍必須>=0。當此值不為空白時，會返回 Total 表示總的命中數。此參數配合 TopK 使用，比如要分頁 20 檢索 chunk_id 0~44 的 chunks，則要請求 3 次： Offset=0,TopK=20 返回 chunk_id 0~19 Offset=20,TopK=20 返回 chunk_id 20~39 Offset=30,TopK=20 返回 chunk_id 40~44	0
IncludeMetadataFields	string	否	預設為空白，表示要返回的 metadata 欄位，多個欄位用逗號分隔。	title,content
WorkspaceId	string	否	多資料庫執行個體組成的 Workspace 的 Id。此參數和 DBInstanceId 參數不能同時為空白，當和 DBInstanceId 同時指定時以此參數為準。	gp-ws-*****
RelationalTableFilter	object	否	使用另外一張關係表實現向量資料過濾（類似 Join 的功能）。說明關係表的資料可以通過設定 IncludeMetadataFields 參數返回。比如 rds_table_name.id 表示返回關係表的 id 欄位。
CollectionMetadataField	string	否	向量集的 Metadata 欄位，用來和向量表的欄位關聯。	doc_id
TableField	string	否	關係表的欄位，用來和向量集的 Metadata 的欄位做關聯。	id
TableName	string	否	關係表的名稱。	my_rds_table
Condition	string	否	關係表的過濾條件。	tags @> ARRAY['art']
IncludeSparseValues	boolean	否	是否返回稀疏向量資料。取值說明： true：返回稀疏向量資料。 false：不返稀疏迴向量資料。	false

返回參數

名稱

類型

描述

樣本值

object

召回結果。

Matches

object

match

array<object>

資料列表。

array<object>

單條記錄。

string

向量資料的唯一 ID。

doca-1234

Metadata

object

中繼資料。

string

中繼資料內容。

{"title":"test title", "content": "test content"}

Values

object

value

array

向量資料列表。

number

向量資料。

1.234

Score

number

此條資料的相似性分數，其分數演算法和建立索引時指定的演算法(l2/ip/cosine)相關。

0.12345

SparseValues

object

稀疏向量返回體

Indices

object

Indice

array

稀疏向量索引數組

integer

稀疏向量索引值

Values

object

Value

array

稀疏向量值數組

number

稀疏向量值

0.222

MetadataV2

object

中繼資料。值與 Metadata 一致，元素類型區別於 Metadata，用於在 SDK 端透出任意類型。

any

該欄位可容納多種資料類型，由 SDK 按以下規則進行還原序列化。

說明

還原序列化規則

ADBPG 資料類型	Java SDK 還原序列化類型	Python SDK 還原序列化類型
整數(integer, bigint)	Long	int
浮點數(real, double precision)	Double	float
布爾值(boolean)	Boolean	bool
字串(text, character varying)	String	str
數組(如 int[], text[])	ArrayList<T>(T 類型按本表規則映射)	list
json	String	String

{'array_field': [15.5, 25.5, 35.5], 'float_field': 128.45, 'long_field': 123456789017, 'bool_field': False, 'json_field': '{"key1":"value1","num":999.0}', 'char_array_field': '[c, h, a, r, s, 5]', 'int_field': 128, 'source': 0, 'double_field': 12350.6789, 'string_field': 'test_string_5'}

RequestId

string

請求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521

Status

string

狀態，取值說明：

success：成功。
fail：失敗。

success

Message

string

請求失敗時的詳細資料。

0.1234

Total

integer

當請求 Offset 不為 0 時才返回，傳回值為該檢索條件的命中總數。

100

樣本

正常返回樣本

JSON格式

{
  "Matches": {
    "match": [
      {
        "Id": "doca-1234",
        "Metadata": {
          "key": "{\"title\":\"test title\", \"content\":  \"test content\"}"
        },
        "Values": {
          "value": [
            1.234
          ]
        },
        "Score": 0.12345,
        "SparseValues": {
          "Indices": {
            "Indice": [
              20
            ]
          },
          "Values": {
            "Value": [
              0.222
            ]
          }
        },
        "MetadataV2": {
          "key": "{'array_field': [15.5, 25.5, 35.5], 'float_field': 128.45, 'long_field': 123456789017, 'bool_field': False, 'json_field': '{\"key1\":\"value1\",\"num\":999.0}', 'char_array_field': '[c, h, a, r, s, 5]', 'int_field': 128, 'source': 0, 'double_field': 12350.6789, 'string_field': 'test_string_5'}"
        }
      }
    ]
  },
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success",
  "Message": "0.1234",
  "Total": 100
}

錯誤碼

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

變更歷史

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