Parameters
Parameter | Type | Description |
---|---|---|
indexName | string | Name of the existing index to load |
indexKey | Uint8Array | The exact 32-byte encryption key used when creating the index |
The encryption key must exactly match the key used during index creation.
Returns
Promise<EncryptedIndex>
: A Promise that resolves to an EncryptedIndex
instance ready for vector operations (query, upsert, delete, etc.)
Exceptions
Error
Error
- Throws if the index doesn’t exist on the server
- Throws if the encryption key is incorrect or invalid
- Throws if the server returns an HTTP error status.
- Throws if authentication fails (invalid API key).
Service Errors
Service Errors
- Throws if the CyborgDB service is unavailable or unreachable.
- Throws if there are internal server errors on the CyborgDB service.