Client
class provides an interface to initialize, create, load and list Encrypted Indexes. Encrypted Indexes, in turn, expose data-related functionality such as upserting, querying, and deleting.
Creating the Client
To create the client, you must define the backing store locations which it will use. At minimum, you must set anindex_location
(where the index will reside) and a config_location
(where the index metadata will reside). For example:
index_location
, such as Redis.
Creating the Client with Item Storage
If you wish to store encrypted items in the index, you will also need to set aitem_location
:
Setting Device Configurations
Cyborg Vector Search can be accelerated in two ways:- CPU Multithreading (via
OpenMP
) -> can scale with the number of CPU cores available - GPU Acceleration (via
CUDA
&cuVS
) -> can increase the speed of certain operations (e.g., ingestion) by an order of magnitude.
cpu_threads
and gpu_accelerate
flags:
gpu_accelerate
can only be set to True
if running on a CUDA-enabled system with the CUDA driver installed.cpu_threads
will use all available cores, and gpu_accelerate
will be set to False
.
API Reference
For more information on theClient
class, refer to the API Reference: