Getters

async getIndexName(): Promise<string>

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

async getDimension(): Promise<number>

const dimension = await index.getDimension();
console.log('Dimension:', dimension);
// Output: 384

async getMetric(): Promise<string>

const metric = await index.getMetric();
console.log('Metric:', metric);
// Output: "euclidean"

async getNLists(): Promise<number>

const nLists = await index.getNLists();
console.log('Lists:', nLists);
// Output: 1024  (after training)

async isTrained(): Promise<boolean>

if (!(await index.isTrained())) {
    console.log('Index needs training');
    await index.train();
}

async isTraining(): Promise<boolean>

if (await index.isTraining()) {
    console.log('Training in progress — try again shortly');
}

async getHealth(): Promise<HealthResponse>

const health = await client.getHealth();
console.log('Service status:', health.status);

generateKey(): Uint8Array        // instance method
static generateKey(): Uint8Array // static method

import { CyborgDB } from 'cyborgdb';

// Static form — no client needed
const key = CyborgDB.generateKey();

// Instance form
const sameKindOfKey = client.generateKey();