メインコンテンツまでスキップ

インデックスの作成（V2）

ターゲットフィールドに名前付きインデックスを作成します。対象フィールドには、ベクトルフィールドまたはスカラーフィールドを指定できます。

POST/v2/vectordb/indexes/create
接続エンドポイント

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

📘ノート
  • サービングクラスターを使用している場合は、クラスターエンドポイントを使用してください。

    • Free & Serverless

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated

      https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

  • ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
  • エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
shell
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つAPIキー、または コロンで結合したユーザー名とパスワードのペア（例: username:password）である必要があります。プロジェクトエンドポイントを使用する場合は、十分な権限を持つ有効なAPIキーのみが適用されます。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
dbNamestring

コレクションが属するデータベースの名前。 存在しないデータベースを指定するとエラーが発生します。

collectionNamestring必要

ターゲットコレクションの名前。 存在しないコレクションを指定するとエラーが発生します。

indexParamsarray必要

インデックス構築プロセスに適用されるパラメーター。

[]indexParamsobject必要

特定のフィールドに対するインデックスパラメーター。

metricTypestring必要

インデックスの構築に使用する類似度メトリックのタイプ。詳細は、類似度メトリックの説明を参照してください。

fieldNamestring必要

インデックスを作成するターゲットフィールドの名前。

indexNamestring必要

作成するインデックスの名前。デフォルトはターゲットフィールド名です。

indexTypestring必要

作成するインデックスのタイプ。

paramsobject

インデックスのタイプと関連設定。詳細は、ベクトルインデックスを参照してください。

Minteger

ノードの最大次数。index_type が HNSW に設定されている場合にのみ適用されます。

efConstructioninteger

検索範囲。index_type が HNSW に設定されている場合にのみ適用されます。

nlistinteger

クラスターユニットの数。index_type が IVF 関連のインデックスタイプに設定されている場合にのみ適用されます。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/indexes/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "my_collection",
    "indexParams": [
        {
            "metricType": "L2",
            "fieldName": "my_vector",
            "indexName": "my_vector",
            "indexType": "AUTOINDEX"
        },
        {
            "fieldName": "my_varchar",
            "indexName": "my_varchar",
            "indexType": "INVERTED"
        },
        {
            "fieldName": "my_int",
            "indexName": "my_int",
            "indexType": "STL_SORT"
        }
    ]
}'
レスポンス200 OK - application/json

なし

成功レスポンス

codeinteger

レスポンスコード。

dataobject

レスポンスペイロード（空のオブジェクト）。

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {}
}
Ctrl I