すべてのプロダクト
Search

このプロダクト

    :CreateDocumentCollection

    ドキュメントセンター

    :CreateDocumentCollection

    最終更新日: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:CreateDocumentCollection

    create

    *Collection

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    説明

    ターゲットリージョン内の AnalyticDB PostgreSQL インスタンスの一覧とそのインスタンス ID を確認するには、DescribeDBInstances API を呼び出します。

    gp-xxxxxxxxx
    ManagerAccount

    string

    必須

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

    説明

    コンソール > アカウント管理からアカウントを作成するか、CreateAccount API を呼び出して作成します。

    testaccount
    ManagerAccountPassword

    string

    必須

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

    testpassword
    Namespace

    string

    任意

    名前空間。デフォルト値：public。

    説明

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

    mynamespace
    Collection

    string

    必須

    作成するドキュメントコレクションの名前。

    説明

    名前は PostgreSQL オブジェクトの命名規則に従う必要があります。

    document
    RegionId

    string

    必須

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

    cn-hangzhou
    EmbeddingModel

    string

    任意

    埋め込みアルゴリズム。デフォルト値：text-embedding-v3。

    説明

    サポートされるアルゴリズム：

    • text-embedding-v3 (推奨、デフォルト値)：1024 ディメンション、768 ディメンション、512 ディメンション

    • multimodal-embedding-v1 (推奨)：1024 ディメンション、マルチモーダル埋め込みアルゴリズム

    • text-embedding-v1：1536 ディメンション

    • text-embedding-v2：1536 ディメンション

    • text2vec (非推奨)：1024 ディメンション

    • m3e-base (非推奨)：768 ディメンション

    • m3e-small (非推奨)：512 ディメンション

    • clip-vit-b-32 (非推奨)：CLIP ViT-B/32 モデル、512 ディメンション、画像埋め込みアルゴリズム

    • clip-vit-b-16 (非推奨)：CLIP ViT-B/16 モデル、512 ディメンション、画像埋め込みアルゴリズム

    • clip-vit-l-14 (非推奨)：CLIP ViT-L/14 モデル、768 ディメンション、画像埋め込みアルゴリズム

    • clip-vit-l-14-336px (非推奨)：CLIP ViT-L/14@336px モデル、768 ディメンション、画像埋め込みアルゴリズム

    • clip-rn50 (非推奨)：CLIP RN50 モデル、1024 ディメンション、画像埋め込みアルゴリズム

    • clip-rn101 (非推奨)：CLIP RN101 モデル、512 ディメンション、画像埋め込みアルゴリズム

    • clip-rn50x4 (非推奨)：CLIP RN50x4 モデル、640 ディメンション、画像埋め込みアルゴリズム

    • clip-rn50x16 (非推奨)：CLIP RN50x16 モデル、768 ディメンション、画像埋め込みアルゴリズム

    • clip-rn50x64 (非推奨)：CLIP RN50x64 モデル、1024 ディメンション、画像埋め込みアルゴリズム

    text-embedding-v1
    Dimension

    integer

    任意

    ベクトルのディメンション。デフォルト値は、埋め込みアルゴリズムでサポートされているディメンションです。

    1024
    FullTextRetrievalFields

    string

    任意

    フルテキストインデックス用のフィールド。複数のフィールドをカンマ (,) で区切ります。フィールドは Metadata で定義されたキーである必要があります。

    title,page
    Metadata

    string

    任意

    ベクトルデータのメタデータ。MAP 形式の JSON 文字列です。キーはフィールド名を表し、値はデータの型を表します。

    説明

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

    • データの型の一覧については、「Data Types」をご参照ください。

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

    警告 id、vector、doc_name、content、loader_metadata、source、to_tsvector は予約語です。これらを使用しないでください。

    {"title":"text","page":"int"}
    Parser

    string

    任意

    フルテキストインデックス用のトークナイザー。デフォルト値：zh_cn。

    zh_cn
    Metrics

    string

    任意

    ベクターインデックス構築の方法。

    値の説明：

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

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

    • cosine (デフォルト)：余弦類似度。

    cosine
    HnswM

    integer

    任意

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

    説明

    有効値：

    • AnalyticDB PostgreSQL 6.0 インスタンスの場合：1～1000。

    • AnalyticDB PostgreSQL 7.0 インスタンスの場合：2～100。デフォルト値：16。

    説明

    ベクトルのディメンションに応じて以下の値を設定してください：

    • 384 以下：16

    • 384 超 768 以下：32

    • 768 超 1024 以下：64

    • 1024 超：128

    64
    HnswEfConstruction

    string

    任意

    HNSW インデックス構築時の候補セットサイズ。値は >= 2*HNSW_M である必要があります。

    説明

    有効値：

    • AnalyticDB PostgreSQL 6.0 インスタンスの場合：40～4000。

    • AnalyticDB PostgreSQL 7.0 インスタンスの場合：4～1000。デフォルト値：64。

    128
    PqEnable

    integer

    任意

    インデックスの Product Quantization (PQ) アルゴリズムによる高速化を有効または無効にします。データ量が 500,000 を超える場合は有効にしてください。値の説明：

    • 0：無効。

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

    1
    ExternalStorage

    integer

    任意

    mmap を使用して HNSW インデックスを構築します。デフォルト値：0。データ削除が不要で、高いデータアップロードパフォーマンスが必要な場合は、このパラメーターを 1 に設定します。

    値の説明：

    • 0：デフォルトでは、セグメントページストレージを使用してインデックスを構築します。このモードでは PostgreSQL の shared_buffer をキャッシュに使用でき、削除や更新などの操作をサポートします。

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

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

    0
    MetadataIndices

    string

    任意

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

    title
    EnableGraph

    boolean

    任意

    知識グラフ構築を有効または無効にします。デフォルト値：false。

    説明

    このパラメーターを使用する前に、グラフエンジンをサポートするバージョンにインスタンスをスペックアップしてください。(パブリックプレビュー中は、チケットを送信してバージョンをスペックアップします。)

    true
    LLMModel

    string

    任意

    LLM モデル名。値の説明：

    • knowledge-extract-standard：デフォルト値。

    • knowledge-extract-mini

    説明

    このパラメーターは、知識グラフ構築が有効になっている場合にのみ有効になります。

    knowledge-extract-standard
    Language

    string

    任意

    知識グラフ構築に使用する言語。値の説明：

    • 簡体字中国語：デフォルト値。

    • 英語。

    説明

    このパラメーターは、知識グラフ構築が有効になっている場合にのみ有効になります。

    Simplified Chinese
    EntityTypes

    array

    任意

    エンティティタイプの一覧。

    説明

    このパラメーターは、知識グラフ構築が有効になっている場合に必須です。

    string

    任意

    エンティティタイプ。

    地点
    RelationshipTypes

    array

    任意

    関係エッジタイプの一覧。

    説明

    このパラメーターは、知識グラフ構築が有効になっている場合に必須です。

    string

    任意

    関係エッジタイプ。

    发生
    SupportSparse

    boolean

    任意

    疎ベクトルサポートを有効または無効にします。デフォルト値：false。

    true
    SparseVectorIndexConfig

    object

    任意

    疎ベクトルインデックスの構成。指定した場合、疎ベクトルインデックスが作成されます。

    HnswM

    integer

    任意

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

    説明

    有効値：

    • AnalyticDB PostgreSQL 6.0 インスタンスの場合：1～1000。

    • AnalyticDB PostgreSQL 7.0 インスタンスの場合：2～100。デフォルト値：16。

    説明

    ベクトルのディメンションに応じて以下の値を設定してください：

    • 384 以下：16

    • 384 超 768 以下：32

    • 768 超 1024 以下：64

    • 1024 超：128

    64
    HnswEfConstruction

    integer

    任意

    HNSW インデックス構築時の候補セットサイズ。有効値：4～1000。デフォルト値：64。

    説明

    この値は AnalyticDB PostgreSQL 7.0 インスタンスでのみ必要であり、値は >= 2*HNSW_M である必要があります。

    128
    SparseRetrievalFields

    string

    任意

    疎ベクトル構築に使用するメタデータフィールド。複数のフィールドをカンマ (,) で区切ります。フィールドは Metadata で定義されたキーである必要があります。

    title,abstract

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    string

    操作によって返されたメッセージ。

    Successful
    Status

    string

    API 実行ステータス。値：

    • success：実行成功。

    • fail：実行失敗。

    successs

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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