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

インデックスの作成 (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 key、または username:password のようにコロンで連結した username と password の組み合わせを指定する必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。

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

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

collectionNamestring必要

対象コレクションの名前です。 存在しないコレクションを設定するとエラーになります。

indexParamsarray必要

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

[]indexParamsobject必要

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

metricTypestring必要

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

fieldNamestring必要

インデックスを作成する対象フィールドの名前です。

indexNamestring必要

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

indexTypestring必要

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

paramsobject

インデックスタイプと関連設定です。詳細については、Vector Indexes を参照してください。

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