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

インデックスを記述 (V2)

この操作は現在のインデックスを記述します。

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

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必要

インデックスが属するコレクションの名前。

indexNamestring必要

記述するインデックスの名前。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/indexes/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "indexName": "vector",
    "collectionName": "quick_setup"
}'
レスポンス200 OK - application/json

現在のインデックスの詳細な説明を含むオブジェクト。

成功レスポンス。

codeinteger

レスポンスコード。

値の例： 0
dataobject

インデックスに関する詳細情報を含むレスポンスペイロード。

indexNamestring

インデックスの名前。

fieldNamestring

対象フィールドの名前。

indexTypestring

このインデックスのタイプ。

metricTypestring

類似度メトリックのタイプ。

mmap.enabledstring

このインデックスで memory mapping が有効かどうか。

indexoffsetcache.enabledstring

インデックスオフセットをメモリにキャッシュするかどうか。

warmupstring

インデックスの作成時または更新時に、インデックスをメモリに読み込むかどうか。

  • sync: セグメントがロード済みと見なされる前にウォームアップします
  • async: ロード後にバックグラウンドでウォームアップします
  • disable: 事前にウォームアップせず、必要に応じてロードします
totalRowsinteger

エンティティ/行の総数。

pendingRowsinteger

インデックス作成待ちのエンティティ/行の数。

indexedRowsinteger

インデックス作成済みのエンティティ/行の総数。

indexStatestring

インデックス作成の進行状況のステータス。

failReasonstring

インデックスの構築に失敗した理由。

minIndexVersionstring

インデックスの最小バージョン。

maxIndexVersionstring

インデックスの最大バージョン。

indexParamsarray

キーと値のペアのリストで示される、インデックスの構築に使用されたインデックスパラメーター。

[]indexParamsobject
keystring

インデックスパラメーターの名前。

valuestring

The value of the index parameter.

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": [
        {
            "indexName": "embedding_idx",
            "fieldName": "embedding",
            "indexType": "AUTOINDEX",
            "metricType": "COSINE",
            "mmap.enabled": "false",
            "indexoffsetcache.enabled": "false",
            "warmup": "sync",
            "totalRows": 10000,
            "pendingRows": 0,
            "indexedRows": 10000,
            "indexState": "Finished",
            "failReason": "",
            "minIndexVersion": 0,
            "maxIndexVersion": 0,
            "indexParams": [
                {
                    "key": "index_type",
                    "value": "AUTOINDEX"
                },
                {
                    "key": "metric_type",
                    "value": "COSINE"
                },
                {
                    "key": "params",
                    "value": "{}"
                }
            ]
        }
    ]
}
Ctrl I