使用CreateCollection建立向量資料集-雲原生資料倉儲AnalyticDB-阿里雲

建立向量資料集。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:CreateCollection

create

*Collection

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	否	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的執行個體 ID。	gp-bp152460513z****
ManagerAccount	string	是	具有 rds_superuser 許可權的管理帳號名稱。說明您可以調用 CreateAccount 介面建立帳號。	testaccount
ManagerAccountPassword	string	是	管理帳號密碼。	testpassword
Namespace	string	否	命名空間。說明您可以通過 CreateNamespace 介面建立，通過 ListNamespaces 介面查看列表。	mynamespace
Collection	string	是	要建立的集合名。說明名稱需符合 PostgreSQL 對象名限制。	document
Dimension	integer	否	向量維度。說明如果指定此值，會構建索引，且後續上傳向量資料介面 UpsertCollectionData 的 Rows.Vector 長度需和此值一致。如果不指定此值，可以後續調用 CreateVectorIndex 構建索引。	1024
FullTextRetrievalFields	string	否	用於全文檢索索引的欄位，多個欄位用英文逗號（,）分隔，且欄位必須屬於 Metadata 裡定義的 key。	title,content
Metadata	string	是	向量資料的元資訊，為 MAP 格式的 JSON 字串。其中 key 代表欄位名，value 代表資料類型。說明支援的資料類型資料類型列表詳見：資料類型。其中 money 類型暫不支援。警告 id、vector、to_tsvector、source 欄位為保留欄位，禁止使用。	{"title":"text","content":"text","response":"int"}
Parser	string	否	用於全文檢索索引的分詞器，預設為 zh_cn。	zh_cn
RegionId	string	是	執行個體所在地區 ID。	cn-hangzhou
Metrics	string	否	向量構建索引時的方法。取值說明： l2：歐氏距離。 ip：點積（內積）距離。 cosine：餘弦相似性。	cosine
HnswM	integer	否	HNSW 演算法中的最大鄰居數。介面會根據向量維度自動化佈建此值，一般不需要手動設定。說明取值範圍： AnalyticDB PostgreSQL 6.0 版執行個體：1～1000。 AnalyticDB PostgreSQL 7.0 版執行個體：2～100，預設值 16。說明建議根據向量維度來設定：小於等於 384：16 大於 384 小於等於 768：32 大於 768 小於等於 1024：64 大於 1024：128	64
HnswEfConstruction	string	否	HNSW 演算法構建索引時的候選集大小。取值需要>= 2*HNSW_M。說明取值範圍： AnalyticDB PostgreSQL 6.0 版執行個體：40～4000。 AnalyticDB PostgreSQL 7.0 版執行個體：4～1000，預設值 64。	128
PqEnable	integer	否	索引是否開啟 PQ(Product quantization)演算法加速，資料量大於 50w 時建議開啟。取值說明： 0：關閉。 1：開啟（預設）。	1
ExternalStorage	integer	否	是否使用 mmap 構建 HNSW 索引，預設為 0。如果資料不需要刪除，且對上傳資料的速度效能有要求時，建議設定為 1。取值說明： 0：預設採用段頁式儲存構建索引，這種模式可以使用 PostgreSQL 中的 shared_buffer 做緩衝，支援刪除和更新等操作。 1：該索引會採用 mmap 構建索引，該模式不支援刪除更新等操作。重要僅 6.0 版本支援參數 ExternalStorage。7.0 版本暫不支援。	0
WorkspaceId	string	否	多資料庫執行個體組成的 Workspace 的 Id。此參數和 DBInstanceId 參數不能同時為空白，當和 DBInstanceId 同時指定時以此參數為準。	gp-ws-*****
MetadataIndices	string	否	標量索引欄位，多個欄位用英文逗號（,）分隔，且欄位必須屬於 Metadata 裡定義的 key。	title
SupportSparse	boolean	否	是否支援稀疏向量。預設值：false。	true
SparseVectorIndexConfig	object	否	稀疏向量索引配置。如果傳入，則建立稀疏向量索引。
HnswM	integer	否	HNSW 演算法中的最大鄰居數。介面會根據向量維度自動化佈建此值，一般不需要手動設定。說明取值範圍： AnalyticDB PostgreSQL 6.0 版執行個體：1～1000。 AnalyticDB PostgreSQL 7.0 版執行個體：2～100，預設值 16。說明建議根據向量維度來設定：小於等於 384：16 大於 384 小於等於 768：32 大於 768 小於等於 1024：64 大於 1024：128	64
HnswEfConstruction	integer	否	HNSW 演算法構建索引時的候選集大小。取值範圍：4～1000，預設值 64。說明僅 AnalyticDB PostgreSQL 7.0 版執行個體需要傳該值，且取值需要>= 2*HNSW_M。	128

說明

建立向量Data Integration功後，您可參考 DescribeCollection 查看已建立的向量資料集。

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	介面返回詳細資料。	create successfully
Status	string	建立狀態，取值說明： success：成功。 fail：失敗。	success

樣本

正常返回樣本

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "create successfully",
  "Status": "success"
}

錯誤碼

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

變更歷史

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