Getters

@property
index_name: str

index_name = index.index_name
print(f'Index name: {index_name}')
# Output: "my-vectors"

@property
index_type: str

index_type = index.index_type
print(f'Index type: {index_type}')
# Output: "ivfflat", "ivfpq", or "ivfsq"

if index_type == 'ivfsq':
    print('Using IVFSQ index for high accuracy and memory efficiency')
elif index_type == 'ivfpq':
    print('Using IVFPQ index for memory efficiency')
elif index_type == 'ivfflat':
    print('Using IVFFlat index for high accuracy')
else:
    print('Unknown index type')

def is_trained(self) -> bool

trained = index.is_trained()
print(f'Index trained: {trained}')

if not trained:
    print('Index needs training for optimal performance')
    index.train()

def is_training(self) -> bool

import time

index.train()  # Start training

while index.is_training():
    print('Index is still training...')
    time.sleep(5)  # Wait before checking again
print('Index training complete')

@property
index_config: Dict[str, Any]

config = index.index_config
print(f'Index configuration: {config}')

# Access common properties
print(f"Dimension: {config.get('dimension')}")
print(f"Metric: {config.get('metric')}")
print(f"Number of lists: {config.get('n_lists')}")

# Type-specific properties
if config.get('type') == 'ivfpq':
    print(f"PQ dimension: {config.get('pq_dim')}")
    print(f"PQ bits: {config.get('pq_bits')}")