すべてのプロダクト
Search

このプロダクト

    AnalyticDB:CreateVectorIndex

    ドキュメントセンター

    AnalyticDB:CreateVectorIndex

    最終更新日:Apr 15, 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 です。

    説明

    DescribeDBInstances 操作を呼び出して、特定のリージョンにあるすべての AnalyticDB for PostgreSQL インスタンスの詳細 (インスタンス ID を含む) を表示できます。

    gp-xxxxxxxxx
    Collection

    string

    必須

    コレクション名です。

    説明

    ListCollections 操作を呼び出して、すべてのコレクションを一覧表示できます。

    document
    Dimension

    integer

    任意

    ベクターディメンションです。

    説明

    • このパラメーターは密ベクターに必須です。

    • この値は、UpsertCollectionData 操作を呼び出すときに提供される Rows.Vector データの長さと一致する必要があります。

    1024
    ManagerAccount

    string

    必須

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

    説明

    コンソールの [アカウント管理] ページでアカウントを作成するか、CreateAccount 操作を呼び出してアカウントを作成できます。

    testaccount
    ManagerAccountPassword

    string

    必須

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

    testpassword
    Metrics

    string

    任意

    ベクターインデックスの構築に使用される距離メトリックです。有効な値：

    • l2：ユークリッド距離

    • ip：ドット積 (内積)

    • cosine：コサイン類似度

    説明

    疎ベクターは ip のみをサポートします。

    cosine
    Namespace

    string

    任意

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

    説明

    ListNamespaces 操作を呼び出して、すべての名前空間を一覧表示できます。

    mynamespace
    RegionId

    string

    必須

    インスタンスのリージョン ID です。

    cn-hangzhou
    PqEnable

    integer

    任意

    Product Quantization (PQ) を有効にしてインデックス作成を高速化するかどうかを指定します。500,000 を超えるベクターを持つコレクションに推奨されます。有効な値：

    • 0：無効。

    • 1：有効。(デフォルト)

    1
    HnswM

    integer

    任意

    Hierarchical Navigable Small World (HNSW) アルゴリズムの近傍点の最大数です。システムはベクターディメンションに基づいてこの値を自動的に設定するため、通常は手動でこのパラメーターを設定する必要はありません。

    説明

    有効な値：

    • AnalyticDB for PostgreSQL V6.0 インスタンスの場合：1～1,000。

    • AnalyticDB for PostgreSQL V7.0 インスタンスの場合：2～100。デフォルト値は 16 です。

    説明

    ベクターディメンションに基づいて次の値を推奨します：

    • 384 以下の場合：16

    • 385～768 の場合：32

    • 769～1,024 の場合：64

    • 1,024 を超える場合：128

    64
    HnswEfConstruction

    integer

    任意

    インデックス構築時の HNSW アルゴリズムの候補セットのサイズです。値は 4～1,000 の範囲である必要があります。デフォルト値は 64 です。

    説明

    このパラメーターは AnalyticDB for PostgreSQL V7.0 インスタンスにのみ適用され、その値は 2 * HnswM 以上である必要があります。

    128
    ExternalStorage

    integer

    任意

    mmap を使用して HNSW インデックスを構築するかどうかを指定します。デフォルト値は 0 です。データ削除が不要なシナリオで高性能なデータアップロードを行うには、この値を 1 に設定します。

    有効な値：

    • 0：(デフォルト) セグメント化されたページストレージを使用してインデックスを構築します。このモードは、キャッシュに PostgreSQL の shared_buffer を使用し、削除および更新操作をサポートします。

    • 1：mmap を使用してインデックスを構築します。このモードは、削除および更新操作をサポートしません。

    重要 ExternalStorage パラメーターは AnalyticDB for PostgreSQL V6.0 でのみサポートされます。

    0
    Type

    string

    任意

    ベクタータイプです。有効な値：

    • Dense：(デフォルト) 密ベクター

    • Sparse：疎ベクター

    Dense
    Algorithm

    string

    任意

    ベクターインデックス作成アルゴリズムです。

    有効な値：

    • hnswflat：(デフォルト) 量子化圧縮を使用しない HNSW インデックス。

    • novam：量子化圧縮を使用しないグラフベースのインデックス。このアルゴリズムは、リアルタイムのレコメンデーションなど、高性能なシナリオに適しています。

    • novad：rabitq 量子化を使用するパーティション分割インデックス。このアルゴリズムは、大規模でコスト効率の高い検索シナリオに適しています。

    hnswflat
    Nlist

    integer

    任意

    Novad アルゴリズムのリスト (パーティション) の数です。値は 2～1,073,741,824 の範囲である必要があります。デフォルト値は 256 です。

    256
    RabitqBits

    integer

    任意

    rabitq 圧縮のビット数です。有効な範囲は 1～8 です。デフォルト値は 3 です。

    3

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

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

    string

    応答メッセージです。

    Successful
    Status

    string

    リクエストのステータスです。有効な値：

    • success：リクエストは成功しました。

    • fail：リクエストは失敗しました。

    success

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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