Cloud
This section describes parameters used to sync compressed indexes with cloud storage. These parameters are only enabled if an embeddings index is stored as compressed. They are set via the embeddings.load and embeddings.save methods.
provider
provider: string
The cloud storage provider, see full list of providers here.
container
container: string
Container/bucket/directory name.
key
key: string
Provider-specific access key. Can also be set via ACCESS_KEY environment variable. Ensure the configuration file is secured if added to the file.
secret
secret: string
Provider-specific access secret. Can also be set via ACCESS_SECRET environment variable. Ensure the configuration file is secured if added to the file.
host
host: string
Optional server host name. Set when using a local cloud storage server.
port
port: int
Optional server port. Set when using a local cloud storage server.
token
token: string
Optional temporary session token
region
region: string
Optional parameter to specify the storage region, provider-specific.