List Indexes

Returns the names of all indexes on the CyborgDB service.

async listIndexes(): Promise<string[]>

Returns

Promise<string[]>: index names. Empty when the service has no indexes.

Exceptions

CyborgDBAuthenticationError

The client’s apiKey is missing or invalid (HTTP 401), or is a per-user key: listing indexes requires the root key (HTTP 403).

CyborgDBServiceError

The service returns 5xx.

CyborgDBTransportError

The service can’t be reached.

See Errors for the full hierarchy.

Example Usage

import { Client } from 'cyborgdb';

const client = new Client({ baseUrl: 'http://localhost:8000', apiKey: 'your-api-key' });

const indexes = await client.listIndexes();
console.log(indexes);
// Output: [ 'documents', 'embeddings', 'semantic-search' ]

Introduction

Client

Encrypted Index

Types & Helpers

Returns

Exceptions

Example Usage

​Returns

​Exceptions

​Example Usage

Returns

Exceptions

Example Usage