すべてのプロダクト
Search

このプロダクト

    AnalyticDB:CreateVectorIndex

    ドキュメントセンター

    AnalyticDB:CreateVectorIndex

    最終更新日:Mar 21, 2026

    ベクターインデックスの作成

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    gpdb:CreateVectorIndex

    create

    *Collection

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    説明

    対象リージョン内のすべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）の詳細を表示するには、DescribeDBInstances API を呼び出します。

    gp-xxxxxxxxx
    Collection

    string

    必須

    コレクション名。

    説明

    コレクションの一覧を表示するには、ListCollections API を使用します。

    document
    Dimension

    integer

    任意

    ベクトルのディメンション。

    説明

    この値は、UpsertCollectionData API を使用してアップロードしたベクトルデータ（行：ベクトル）の長さと一致している必要があります。

    1024
    ManagerAccount

    string

    必須

    rds_superuser 権限を持つ管理アカウントの名前。

    説明

    アカウントは、コンソール → アカウント管理から作成するか、CreateAccount API を使用して作成できます。

    testaccount
    ManagerAccountPassword

    string

    必須

    管理アカウントのパスワード。

    testpassword
    Metrics

    string

    任意

    ベクターインデックス構築に使用する手法。値の説明：

    • l2：ユークリッド距離。

    • ip：内積（ドット積）距離。

    • cosine：コサイン類似度。

    cosine
    Namespace

    string

    任意

    名前空間。デフォルト値は public です。

    説明

    名前空間の一覧を表示するには、ListNamespaces API を使用します。

    mynamespace
    RegionId

    string

    必須

    インスタンスが配置されているリージョン ID。

    cn-hangzhou
    PqEnable

    integer

    任意

    インデックスに対して PQ（Product Quantization）アルゴリズムによる高速化を有効にするかどうか。データ量が 50 万件を超える場合、有効化することを推奨します。値の説明：

    • 0：無効。

    • 1：有効（デフォルト）。

    1
    HnswM

    integer

    任意

    HNSW アルゴリズムにおける最大近傍数（1～1000）。API はベクトルのディメンションに基づいて自動的にこの値を設定し、通常は手動で設定する必要はありません。

    説明

    ベクトルのディメンションに応じて、以下のように設定することを推奨します：

    • 384 以下：16

    • 384 より大きく 768 以下：32

    • 768 より大きく 1024 以下：64

    • 1024 より大きい：128

    64
    HnswEfConstruction

    integer

    任意

    HNSW アルゴリズムによるインデックス構築時に使用される候補セットのサイズ。有効範囲：4～1000。デフォルト値：64。

    説明

    このパラメーターは、AnalyticDB for PostgreSQL バージョン 7.0 のインスタンスでのみ必須であり、その値は >= 2 * HNSW_M である必要があります。

    128
    ExternalStorage

    integer

    任意

    HNSW インデックス構築時に mmap を使用するかどうか。デフォルト値は 0 です。データの削除が必要なく、データアップロード時のパフォーマンス要件がある場合は、1 に設定することを推奨します。

    説明

    • 0 に設定すると、セグメントページ方式でインデックスが構築され、PostgreSQL の shared_buffer をキャッシュに利用でき、削除および更新操作をサポートします。

    • 1 に設定すると、mmap を使用してインデックスが構築され、削除および更新操作はサポートされません。

    0
    Type

    string

    任意

    ベクトルの種別。有効な値：

    • Dense（デフォルト）：密ベクトル。

    • Sparse：疎ベクトル。

    Dense

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Message

    string

    API から返された詳細情報。

    Successful
    Status

    string

    API 実行ステータス。値の説明：

    • success：実行成功。

    • fail：実行失敗。

    success

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。