v0.17 replaces the v0.16 getters (getIndexType, getIndexConfig) with explicit methods for the single DiskIVF index type: getDimension, getMetric, and getNLists. Cached methods avoid repeat round-trips.
getIndexName
async getIndexName(): Promise<string>
Returns
Promise<string>: The unique name identifier of the index.
Example Usage
const indexName = await index.getIndexName();
console.log('Index name:', indexName);
// Output: "my-vectors"
getDimension
async getDimension(): Promise<number>
- Returns the real dimension when
createIndex was called with an explicit dimension, or after the first upsert (auto-detect).
- Returns
0 if the index was created with auto-detect AND no upsert has happened yet.
Cached on first read; subsequent reads do not hit the server.
Returns
Promise<number>
Example Usage
const dimension = await index.getDimension();
console.log('Dimension:', dimension);
// Output: 384
getMetric
async getMetric(): Promise<string>
"euclidean", "squared_euclidean", or "cosine". Cached alongside dimension.
Returns
Promise<string>
Example Usage
const metric = await index.getMetric();
console.log('Metric:', metric);
// Output: "euclidean"
getNLists
async getNLists(): Promise<number>
- Returns
1 for untrained indexes.
- Returns the trained cluster count after
train() completes.
Unlike getDimension / getMetric, this method is not cached — it fetches fresh on every call so callers reading immediately after training see the new value.
Returns
Promise<number>
Example Usage
const nLists = await index.getNLists();
console.log('Lists:', nLists);
// Output: 1024 (after training)
isTrained
async isTrained(): Promise<boolean>
Returns
Promise<boolean>
Example Usage
if (!(await index.isTrained())) {
console.log('Index needs training');
await index.train();
}
isTraining
async isTraining(): Promise<boolean>
true if this index is currently being trained (or queued for training) on the server, false otherwise.
Under the hood this calls the global training-status endpoint and checks whether this index appears in the returned trainingIndexes list — so it always reflects the live server state and is not cached.
Returns
Promise<boolean>
Example Usage
if (await index.isTraining()) {
console.log('Training in progress — try again shortly');
}
Client.getHealth
async getHealth(): Promise<HealthResponse>
Client (CyborgDB) instance.
Example Usage
const health = await client.getHealth();
console.log('Service status:', health.status);
Client.generateKey
generateKey(): Uint8Array // instance method
static generateKey(): Uint8Array // static method
Example Usage
import { CyborgDB } from 'cyborgdb';
// Static form — no client needed
const key = CyborgDB.generateKey();
// Instance form
const sameKindOfKey = client.generateKey();
