使用DescribeCollection查詢向量資料集資訊-雲原生資料倉儲AnalyticDB-阿里雲

查詢向量資料集資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:DescribeCollection

create

*Collection

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	否	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 ID。	gp-bp152460513z****
Namespace	string	否	命名空間。說明您可以通 ListNamespaces 介面查看列表。	mynamespace
NamespacePassword	string	是	命名空間對應的密碼。	testpassword
Collection	string	是	集合名。說明您可以通過 ListCollections 介面查看列表。	document
RegionId	string	是	執行個體所在地區 ID。	cn-hangzhou
WorkspaceId	string	否	多資料庫執行個體組成的 Workspace 的 Id。此參數和 DBInstanceId 參數不能同時為空白，當和 DBInstanceId 同時指定時以此參數為準。	gp-ws-*****

返回參數

名稱	類型	描述	樣本值
	object	向量詳情。
RequestId	string	請求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Dimension	integer	向量維度。	1024
FullTextRetrievalFields	string	用於全文檢索索引的欄位，多個欄位用英文逗號（,）分隔。	title,content
Metadata	object	向量資料的元資訊，為 MAP 格式的 JSON 字串。其中 key 代表欄位名，value 代表資料類型。警告 id、vector、to_tsvector 欄位為保留欄位，禁止使用。
	string	中繼資料。	{"title":"text","content":"text"}
Metrics	string	Distance Metrics。	cosine
Parser	string	用於全文檢索索引的分詞器。	zh_cn
DBInstanceId	string	執行個體 ID。	gp-bp152460513z****
RegionId	string	地區 ID。	cn-hangzhou
Namespace	string	命名空間。	mynamespace
Message	string	介面返回詳細資料。	success
Status	string	API 執行狀態，取值如下： success：執行成功。 fail：執行失敗。	success
SupportSparse	boolean	是否支援稀疏向量。	true
SparseVectorMetrics	string	稀疏向量構建索引時的方法。	ip

樣本

正常返回樣本

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Dimension": 1024,
  "FullTextRetrievalFields": "title,content",
  "Metadata": {
    "key": "{\"title\":\"text\",\"content\":\"text\"}"
  },
  "Metrics": "cosine",
  "Parser": "zh_cn",
  "DBInstanceId": "gp-bp152460513z****",
  "RegionId": "cn-hangzhou",
  "Namespace": "mynamespace",
  "Message": "success",
  "Status": "success",
  "SupportSparse": true,
  "SparseVectorMetrics": "ip"
}

錯誤碼

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

變更歷史

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