創(chuàng)建向量數(shù)據(jù)集。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| gpdb:CreateCollection | create |
|
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 否 | 實(shí)例 ID。 說(shuō)明
您可以調(diào)用 DescribeDBInstances 接口查看目標(biāo)地域下所有的 AnalyticDB PostgreSQL 實(shí)例的實(shí)例 ID。
| gp-bp152460513z**** |
| ManagerAccount | string | 是 | 具有 rds_superuser 權(quán)限的管理賬號(hào)名稱。 說(shuō)明
您可以調(diào)用 CreateAccount 接口創(chuàng)建賬號(hào)。
| testaccount |
| ManagerAccountPassword | string | 是 | 管理賬號(hào)密碼。 | testpassword |
| Namespace | string | 否 | 命名空間。 說(shuō)明
您可以通過(guò) CreateNamespace 接口創(chuàng)建，通過(guò) ListNamespaces 接口查看列表。
| mynamespace |
| Collection | string | 是 | 要?jiǎng)?chuàng)建的集合名。 說(shuō)明
名稱需符合 PostgreSQL 對(duì)象名限制。
| document |
| Dimension | long | 否 | 向量維度。 說(shuō)明
如果指定此值，會(huì)構(gòu)建索引，且后續(xù)上傳向量數(shù)據(jù)接口 UpsertCollectionData 的 Rows.Vector 長(zhǎng)度需和此值一致。如果不指定此值，可以后續(xù)調(diào)用 CreateVectorIndex 構(gòu)建索引。
| 1024 |
| FullTextRetrievalFields | string | 否 | 用于全文檢索的字段，多個(gè)字段用英文逗號(hào)（,）分隔，且字段必須屬于 Metadata 里定義的 key。 | title,content |
| Metadata | string | 是 | 向量數(shù)據(jù)的元信息，為 MAP 格式的 JSON 字符串。其中 key 代表字段名，value 代表數(shù)據(jù)類型。 說(shuō)明
支持的數(shù)據(jù)類型
警告 id、vector、to_tsvector、source 字段為保留字段，禁止使用。 | {"title":"text","content":"text","response":"int"} |
| Parser | string | 否 | 用于全文檢索的分詞器，默認(rèn)為 zh_cn。 | zh_cn |
| RegionId | string | 是 | 實(shí)例所在地域 ID。 | cn-hangzhou |
| Metrics | string | 否 | 向量構(gòu)建索引時(shí)的方法。取值說(shuō)明：
| cosine |
| HnswM | integer | 否 | HNSW 算法中的最大鄰居數(shù)，范圍為 1～1000。接口會(huì)根據(jù)向量維度自動(dòng)設(shè)置此值，一般不需要手動(dòng)設(shè)置。 說(shuō)明
建議根據(jù)向量維度來(lái)設(shè)置：
| 64 |
| PqEnable | integer | 否 | 索引是否開(kāi)啟 PQ(Product quantization)算法加速，數(shù)據(jù)量大于 50w 時(shí)建議開(kāi)啟。取值說(shuō)明：
| 1 |
| ExternalStorage | integer | 否 | 是否使用 mmap 構(gòu)建 HNSW 索引，默認(rèn)為 0。如果數(shù)據(jù)不需要?jiǎng)h除，且對(duì)上傳數(shù)據(jù)的速度性能有要求時(shí)，建議設(shè)置為 1。 說(shuō)明
| 0 |
| WorkspaceId | string | 否 | 多數(shù)據(jù)庫(kù)實(shí)例組成的 Workspace 的 Id。此參數(shù)和 DBInstanceId 參數(shù)不能同時(shí)為空，當(dāng)和 DBInstanceId 同時(shí)指定時(shí)以此參數(shù)為準(zhǔn)。 | gp-ws-***** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "create successfully",
"Status": "success"
}錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-08-04 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-01-09 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-11-07 | API 內(nèi)部配置變更，不影響調(diào)用 | 查看變更詳情 |
| 2023-08-08 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |