Getters

getIndexName(): string

const indexName = index.getIndexName();
console.log('Index name:', indexName);
// Output: "my-vectors"

getIndexType(): string | undefined

const indexType = index.getIndexType();
console.log('Index type:', indexType);
// Output: "ivf"

if (indexType === 'ivfpq') {
    console.log('Using IVFPQ index for memory efficiency');
} else if (indexType === 'ivfflat') {
    console.log('Using IVFFlat index for high accuracy');
}

isTrained(): boolean

const trained = index.isTrained();
console.log('Index trained:', trained);

if (!trained) {
    console.log('Index needs training for optimal performance');
    await index.train();
}

getIndexConfig(): IndexIVFFlatModel | IndexIVFModel | IndexIVFPQModel

const config = index.getIndexConfig();
console.log('Index configuration:', config);

// Access common properties
console.log('Dimension:', config.dimension);
console.log('Metric:', config.metric);
console.log('Number of lists:', config.nLists);

// Type-specific properties
if (config.type === 'ivfpq') {
    const pqConfig = config as IndexIVFPQModel;
    console.log('PQ dimension:', pqConfig.pqDim);
    console.log('PQ bits:', pqConfig.pqBits);
}

// Check index capabilities based on configuration
function analyzeIndexCapabilities(index: EncryptedIndex) {
    const config = index.getIndexConfig();
    const indexName = index.getIndexName();
    const indexType = index.getIndexType();
    const trained = index.isTrained();
    
    console.log(`\nIndex Analysis: ${indexName}`);
    console.log('='.repeat(40));
    console.log(`Type: ${indexType}`);
    console.log(`Dimensions: ${config.dimension}`);
    console.log(`Metric: ${config.metric}`);
    console.log(`Lists: ${config.nLists}`);
    console.log(`Trained: ${trained ? 'Yes' : 'No'}`);
    
    // Performance characteristics
    if (indexType === 'ivfflat') {
        console.log('\nCharacteristics:');
        console.log('- Highest accuracy');
        console.log('- Slower queries');
        console.log('- Higher memory usage');
    } else if (indexType === 'ivfpq') {
        const pqConfig = config as IndexIVFPQModel;
        console.log('\nCharacteristics:');
        console.log('- Memory efficient');
        console.log('- Compressed vectors');
        console.log(`- PQ dimension: ${pqConfig.pqDim}`);
        console.log(`- Quantization bits: ${pqConfig.pqBits}`);
    } else {
        console.log('\nCharacteristics:');
        console.log('- Balanced performance');
        console.log('- Good accuracy/speed tradeoff');
    }
    
    // Recommendations
    console.log('\nRecommendations:');
    if (!trained) {
        console.log('- Train the index for optimal performance');
    }
    if (config.nLists && config.nLists < 100) {
        console.log('- Consider more lists for larger datasets');
    }
}

// Usage
analyzeIndexCapabilities(index);