建立向量集的索引。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
gpdb:CreateVectorIndex |
create |
*Collection
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
執行個體 ID。 說明
您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情,包括執行個體 ID。 |
gp-xxxxxxxxx |
| Collection |
string |
是 |
集合名。 說明
您可以 ListCollections 介面查看列表。 |
document |
| Dimension |
integer |
否 |
向量維度。 說明
|
1024 |
| ManagerAccount |
string |
是 |
具有 rds_superuser 許可權的管理賬戶名稱。 說明
您可以通過控制台->帳號管理來建立帳號,或者通過 CreateAccount 介面建立。 |
testaccount |
| ManagerAccountPassword |
string |
是 |
管理賬戶密碼。 |
testpassword |
| Metrics |
string |
否 |
向量構建索引時的方法。取值說明:
說明
稀疏向量只支援 ip。 |
cosine |
| Namespace |
string |
否 |
命名空間,預設為 public。 說明
您可以通過 ListNamespaces 介面查看列表。 |
mynamespace |
| RegionId |
string |
是 |
執行個體所在的地區 ID。 |
cn-hangzhou |
| PqEnable |
integer |
否 |
索引是否開啟 PQ(Product quantization)演算法加速,資料量大於 50w 時建議開啟。取值說明:
|
1 |
| HnswM |
integer |
否 |
HNSW 演算法中的最大鄰居數。介面會根據向量維度自動化佈建此值,一般不需要手動設定。 說明
取值範圍:
說明
建議根據向量維度來設定:
|
64 |
| HnswEfConstruction |
integer |
否 |
HNSW 演算法構建索引時的候選集大小。取值範圍:4~1000,預設值 64。 說明
僅 AnalyticDB PostgreSQL 7.0 版執行個體需要傳該值,且取值需要>= 2*HNSW_M。 |
128 |
| ExternalStorage |
integer |
否 |
是否使用 mmap 構建 HNSW 索引,預設為 0。如果資料不需要刪除,且對上傳資料的速度效能有要求時,建議設定為 1。 取值說明:
重要 僅 6.0 版本支援參數 ExternalStorage。7.0 版本暫不支援。 |
0 |
| Type |
string |
否 |
向量類型。取值說明:
|
Dense |
| Algorithm |
string |
否 |
||
| Nlist |
integer |
否 |
||
| RabitqBits |
integer |
否 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
ABB39CC3-4488-4857-905D-2E4A051D0521 |
| Message |
string |
介面返回詳細資料。 |
Successful |
| Status |
string |
API 執行狀態,取值說明:
|
success |
樣本
正常返回樣本
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "Successful",
"Status": "success"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。