調用CreateDocumentCollection API建立文件庫-雲原生資料倉儲AnalyticDB-阿里雲

建立知識庫。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:CreateDocumentCollection

create

*Collection

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 ID。	gp-xxxxxxxxx
ManagerAccount	string	是	具有 rds_superuser 許可權的管理帳號名稱。說明您可以通過控制台->帳號管理來建立帳號，或者通過 CreateAccount 介面建立。	testaccount
ManagerAccountPassword	string	是	管理帳號密碼。	testpassword
Namespace	string	否	命名空間，預設為 public。說明您可以通過 CreateNamespace 介面建立，通過 ListNamespaces 介面查看列表。	mynamespace
Collection	string	是	要建立的文件庫名稱。說明名稱需符合 PostgreSQL 對象名限制。	document
RegionId	string	是	執行個體所在地區 ID。	cn-hangzhou
EmbeddingModel	string	否	向量化演算法。預設值：text-embedding-v3。說明支援的演算法： text-embedding-v3（推薦，預設值）: 1024 維、768 維、512 維 multimodal-embedding-v1（推薦）：1024 維, 多模態向量演算法 text-embedding-v1: 1536 維 text-embedding-v2: 1536 維 text2vec（不推薦）: 1024 維 m3e-base（不推薦）: 768 維 m3e-small（不推薦）: 512 維 clip-vit-b-32（不推薦）：CLIP ViT-B/32 模型, 512 維, 圖片向量化演算法 clip-vit-b-16（不推薦）：CLIP ViT-B/16 模型, 512 維, 圖片向量化演算法 clip-vit-l-14（不推薦）：CLIP ViT-L/14 模型, 768 維, 圖片向量化演算法 clip-vit-l-14-336px（不推薦）：CLIP ViT-L/14@336px 模型, 768 維, 圖片向量化演算法 clip-rn50（不推薦）：CLIP RN50 模型, 1024 維, 圖片向量化演算法 clip-rn101（不推薦）：CLIP RN101 模型, 512 維, 圖片向量化演算法 clip-rn50x4（不推薦）：CLIP RN50x4 模型, 640 維, 圖片向量化演算法 clip-rn50x16（不推薦）：CLIP RN50x16 模型, 768 維, 圖片向量化演算法 clip-rn50x64（不推薦）：CLIP RN50x64 模型, 1024 維, 圖片向量化演算法	text-embedding-v1
Dimension	integer	否	向量維度。預設值是向量化演算法支援的維度。	1024
FullTextRetrievalFields	string	否	用於全文檢索索引的欄位，多個欄位用英文逗號（,）分隔，且欄位必須屬於 Metadata 裡定義的 key。	title,page
Metadata	string	否	向量資料的元資訊，為 MAP 格式的 JSON 字串。其中 key 代表欄位名，value 代表資料類型。說明支援的資料類型資料類型列表詳見：資料類型。其中 money 類型暫不支援。警告 id、vector、doc_name、content、loader_metadata、source、to_tsvector 欄位為保留欄位，禁止使用。	{"title":"text","page":"int"}
Parser	string	否	用於全文檢索索引的分詞器，預設為 zh_cn。	zh_cn
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
MetadataIndices	string	否	標量索引欄位，多個欄位用英文逗號（,）分隔，且欄位必須屬於 Metadata 裡定義的 key。	title
EnableGraph	boolean	否	是否開啟構建知識圖譜。預設值：false。說明使用該參數前，執行個體必須升級到開啟圖引擎的版本。（公測期間請提工單升級版本）	true
LLMModel	string	否	LLM 模型名稱。取值說明： knowledge-extract-standard：預設值。 knowledge-extract-mini 說明僅當開啟構建知識圖譜時，該參數生效。	knowledge-extract-standard
Language	string	否	構建知識圖譜使用的語言。取值說明： Simplified Chinese：簡體中文。預設值。 English：英語。說明僅當開啟構建知識圖譜時，該參數生效。	Simplified Chinese
EntityTypes	array	否	實體類型列表。說明當開啟構建知識圖譜時，該參數必傳。
	string	否	實體類型。	地點
RelationshipTypes	array	否	關係邊類型列表。說明當開啟構建知識圖譜時，該參數必傳。
	string	否	關係邊類型。	發生
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
SparseRetrievalFields	string	否	用於構建稀疏向量的 metadata 欄位，多個欄位用英文逗號（,）分隔，且欄位必須屬於 Metadata 裡定義的 key。	title,abstract

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	返回資訊。	Successful
Status	string	API 執行狀態，取值如下： success：執行成功。 fail：執行失敗。	successs

樣本

正常返回樣本

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "successs"
}

錯誤碼

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

變更歷史

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