すべてのプロダクト
Search

このプロダクト

    AnalyticDB:CreateCollection

    ドキュメントセンター

    AnalyticDB:CreateCollection

    最終更新日:Feb 09, 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:CreateCollection

    create

    *Collection

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    任意

    データベースインスタンスの ID。

    説明

    ターゲットリージョンにあるすべての AnalyticDB for PostgreSQL インスタンスを一覧表示するには、「DescribeDBInstances」操作を呼び出します。

    gp-bp152460513z****
    ManagerAccount

    string

    必須

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

    説明

    アカウントを作成するには、「CreateAccount」操作を呼び出します。

    testaccount
    ManagerAccountPassword

    string

    必須

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

    testpassword
    Namespace

    string

    任意

    名前空間。

    説明

    名前空間を作成するには、「CreateNamespace」操作を呼び出します。名前空間を一覧表示するには、「ListNamespaces」操作を呼び出します。

    mynamespace
    Collection

    string

    必須

    作成するコレクションの名前。

    説明

    名前は PostgreSQL オブジェクト命名規則に準拠している必要があります。

    document
    Dimension

    integer

    任意

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

    説明

    このパラメーターを指定すると、システムがインデックスを構築します。後続の「UpsertCollectionData」呼び出しにおける Rows.Vector フィールドの長さは、この値と一致する必要があります。このパラメーターを省略した場合、後で「CreateVectorIndex」を呼び出してインデックスを構築します。

    1024
    FullTextRetrievalFields

    string

    任意

    全文検索に使用されるフィールド。複数のフィールドはコンマ (,) で区切ります。各フィールドは Metadata パラメーターで定義されたキーである必要があります。

    title,content
    Metadata

    string

    必須

    ベクターデータのメタデータ。MAP 形式の JSON 文字列としてフォーマットされます。キーはフィールド名を表し、値はデータの型を表します。

    説明

    サポートされているデータの型

    • 完全なリストについては、「データの型」をご参照ください。

    • money 型はサポートされていません。

    警告 id、vector、to_tsvector、および source フィールドは予約済みです。これらを使用しないでください。

    {"title":"text","content":"text","response":"int"}
    Parser

    string

    任意

    全文検索に使用されるトークナイザー。デフォルト値: zh_cn。

    zh_cn
    RegionId

    string

    必須

    インスタンスが存在するリージョンの ID。

    cn-hangzhou
    Metrics

    string

    任意

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

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

    • ip: 内積距離。

    • cosine: コサイン類似度。

    cosine
    HnswM

    integer

    任意

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

    説明

    有効な値:

    • AnalyticDB for PostgreSQL 6.0: 1 から 1000。

    • AnalyticDB for PostgreSQL 7.0: 2 から 100。デフォルト値: 16。

    説明

    ベクターディメンションに基づく推奨値:

    • ≤ 384: 16

    • 384 < ディメンション ≤ 768: 32

    • 768 < ディメンション ≤ 1024: 64

    • > 1024: 128

    64
    HnswEfConstruction

    string

    任意

    HNSW インデックスの構築時に使用される候補セットサイズ。この値は 2 × HNSW_M 以上である必要があります。

    説明

    有効な値:

    • AnalyticDB for PostgreSQL 6.0: 40 から 4000。

    • AnalyticDB for PostgreSQL 7.0: 4 から 1000。デフォルト値: 64。

    128
    PqEnable

    integer

    任意

    プロダクト量子化 (PQ) を有効にしてインデックス作成を高速化するかどうかを指定します。データ量が 500,000 ベクターを超える場合は、PQ を有効にしてください。有効な値:

    • 0: 無効。

    • 1: 有効。デフォルト値。

    1
    ExternalStorage

    integer

    任意

    メモリマップドファイル (mmap) を使用して HNSW インデックスを構築するかどうかを指定します。デフォルト値: 0。データを削除する必要がなく、高いアップロード速度が必要な場合は、これを 1 に設定します。

    有効な値:

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

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

    重要 ExternalStorage パラメーターはバージョン 6.0 でのみサポートされています。バージョン 7.0 ではサポートされていません。

    0
    WorkspaceId

    string

    任意

    複数のデータベースインスタンスを含むワークスペースの ID。このパラメーターと DBInstanceId の両方を空にすることはできません。両方を指定した場合、WorkspaceId が優先されます。

    gp-ws-*****
    MetadataIndices

    string

    任意

    スカラーインデックスフィールド。複数のフィールドはコンマ (,) で区切ります。各フィールドは Metadata パラメーターで定義されたキーである必要があります。

    title
    SupportSparse

    boolean

    任意

    疎ベクトルがサポートされているかどうかを指定します。デフォルト値: false。

    true
    SparseVectorIndexConfig

    object

    任意

    疎ベクターインデックス構成。このパラメーターを指定すると、疎ベクターインデックスが作成されます。

    HnswM

    integer

    任意

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

    説明

    有効な値:

    • AnalyticDB for PostgreSQL 6.0: 1 から 1000。

    • AnalyticDB for PostgreSQL 7.0: 2 から 100。デフォルト値: 16。

    説明

    ベクターディメンションに基づく推奨値:

    • ≤ 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
    説明

    ベクターコレクションの作成に成功した後、それを表示するには「DescribeCollection」を呼び出します。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

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

    string

    詳細な応答メッセージ。

    create successfully
    Status

    string

    作成ステータス。有効な値:

    • success: 操作は成功しました。

    • fail: 操作は失敗しました。

    success

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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