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

describe_index()

この操作は、特定のインデックスの詳細を取得します。

Notes

このメソッドは、Dedicated serving クラスターとオンデマンドコンピュートにのみ適用されます。

  • serving クラスターのコレクションでこの操作を行うには、クラスターエンドポイントを使用して MilvusClient を作成してください。

    • Free & Serverless

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

    • Dedicated

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

  • オンデマンドコンピュート用のコレクションでこの操作を行うには、プロジェクトエンドポイントを使用して MilvusClient を作成し、その後、検索のためにオンデマンドクラスターにアタッチするセッションを作成してください。

    https://{project-id}.{region}.api.zillizcloud.com

リクエスト構文​

python
describe_index(
    collection_name: str,
    index_name: str,
    timeout: Optional[float] = None
) -> Dict

パラメータ:

  • collection_name (str) -

    [REQUIRED]

    既存のコレクションの名前です。

    これを存在しないコレクションに設定すると、MilvusException が発生します。

  • index_name (str) -

    [REQUIRED]

    詳細を取得するインデックスの名前です。

    これを存在しないコレクションに設定すると、MilvusException が発生します。

  • timeout (float | None)

    この操作のタイムアウト時間です。これを None に設定すると、何らかのレスポンスが到着するかエラーが発生した時点でこの操作がタイムアウトすることを示します。

戻り値の型:

Dict

戻り値:

指定したインデックスの詳細を含む辞書です。

python
{
    'index_type': 'AUTOINDEX',
    'metric_type': 'IP',
    'M': 32,
    'efConstruction': 360,
    'total_rows': 0,
    'indexed_rows': 0,
    'pending_index_rows': 0,
    'state': 'Finished',
    'field_name': 'my_vector',
    'index_name': 'my_vector'
}

パラメータ:

  • index_type (str) -

    インデックスの構築に使用されるアルゴリズムです。

    Zilliz Cloud では、この値は常に AUTOINDEX です。詳細については、AUTOINDEX Explained を参照してください。

  • metric_type (str) -

    ベクトル間の類似度を測定するために使用されるアルゴリズムです。指定可能な値は IP、L2、COSINE です。

    これは、指定されたフィールドがベクトルフィールドである場合にのみ使用できます。

  • total_rows (int) -

    このインデックスの対象フィールドの行数です。

  • indexed_rows (int) -

    このインデックスの対象フィールドでインデックス化された行数です。

  • pending_index_rows (int) -

    指定されたフィールドでインデックス化される予定の行数です。

  • state (str) -

    インデックス構築プロセスの状態です。

  • field_name (str) -

    インデックスが作成されたフィールドの名前です。

  • index_name (str) -

    作成されたインデックスの名前です。

例外:

  • MilvusException

    この操作中に何らかのエラーが発生した場合、この例外が発生します。

例​

python
from pymilvus import MilvusClient, DataType

client = MilvusClient(
    uri="https://inxx-xxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530",
    token="user:password"
)

# 1. Create schema
schema = MilvusClient.create_schema(
    auto_id=False,
    enable_dynamic_field=False,
)

# 2. Add fields to schema
schema.add_field(field_name="my_id", datatype=DataType.INT64, is_primary=True)
schema.add_field(field_name="my_vector", datatype=DataType.FLOAT_VECTOR, dim=5)

# 3. Create index parameters
index_params = client.prepare_index_params()

# 4. Add indexes
# - For a scalar field
index_params.add_index(
    field_name="my_id",
    index_type="STL_SORT"
)

# - For a vector field
index_params.add_index(
    field_name="my_vector", 
    index_type="AUTOINDEX",
    metric_type="L2",
    params={"nlist": 1024}
)

# 5. Create a collection
client.create_collection(
    collection_name="customized_setup",
    schema=schema
)

# 6. Create indexes
client.create_index(
    collection_name="customized_setup",
    index_params=index_params
)

# 6. List indexes
client.list_indexes(collection_name="customized_setup")

# ['my_id', 'my_vector']

# 7. Describe the indexes
client.describe_index(
    collection_name="customized_setup",
    index_name="my_vector"
)

# {
#     'index_type': 'AUTOINDEX',
#     'metric_type': 'L2',
#     'field_name': 'my_vector',
#     'index_name': 'my_vector'
# }

client.describe_index(
    collection_name="customized_setup",
    index_name="my_id"    
)

# {
#     'index_type': 'STL_SORT',
#     'field_name': 'my_id', 
#     'index_name': 'my_id'
# }
Ctrl I