EncryptedIndex
instance based on the provided configuration.
Parameter | Type | Description |
---|---|---|
indexName | string | Name of the index to create. Must be unique within the CyborgDB service. |
indexKey | Uint8Array | 32-byte encryption key for the index, used to secure the index data. |
indexConfig | IndexIVFPQModel | IndexIVFFlatModel | IndexIVFModel | Configuration object specifying the index type (ivf , ivfpq , or ivfflat ) and relevant parameters such as dimension , nLists , pqDim , and pqBits . |
embeddingModel | string | (Optional) Name of the embedding model used to auto-generate embeddings on the server. Defaults to undefined , no auto-generation. |
Promise<EncryptedIndex>
: A Promise that resolves to an instance of the newly created encrypted index.
Error
Network/API Errors