Skip to main content

is_trained

Returns True if the index has been trained, enabling efficient approximate nearest neighbor search. An untrained index will default to exhaustive search.

Returns

bool: True if the index has been trained; otherwise, False.

Example Usage


index_name

Retrieves the name of the current index.

Returns

str: Name of the currently loaded or created index.

Example Usage


index_type

Returns the type of the current index (e.g., ivf, ivfpq, ivfflat).

Returns

Example Usage


index_config

Retrieves the configuration details of the current index.

Returns

IndexConfig: Dictionary of index configuration parameters.

Example Usage