Skip to content

以下描述了用于与云存储同步索引的参数。支持云对象存储、Hugging Face Hub 和自定义提供商。

参数通过 embeddings.loadembeddings.save 方法设置。

provider

provider: string

云提供商。可以是以下之一:

  • 云对象存储。设置为以下提供商之一。

  • Hugging Face Hub。设置为 huggingface-hub

  • 自定义提供商。设置为自定义提供商的完整类路径。

container

container: string

容器/桶/目录/仓库名称。嵌入将存储在容器中,文件名由 path 配置指定。

云对象存储配置

除了上述通用配置外,云对象存储提供商还有以下附加配置参数。请注意,某些云提供商不需要这些参数,可以使用服务账户的隐式认证。

有关这些参数的更多信息,请参阅 libcloud 文档

key

key: string

提供商特定的访问密钥。也可以通过 ACCESS_KEY 环境变量设置。如果添加到文件中,请确保配置文件安全。使用隐式认证时,设置为类似 'using-implicit-auth' 的值。

secret

secret: string

提供商特定的访问密钥。也可以通过 ACCESS_SECRET 环境变量设置。如果添加到文件中,请确保配置文件安全。使用隐式认证时,此选项不需要。

host

host: string

可选的服务器主机名。在使用本地云存储服务器时设置。

port

port: int

可选的服务器端口。在使用本地云存储服务器时设置。

token

token: string

可选的临时会话令牌

region

region: string

可选参数,用于指定存储区域,提供商特定。

Hugging Face Hub 配置

huggingface-hub 提供商支持以下附加配置参数。有关这些参数的更多信息,请参阅 Hugging Face Hub 的文档

revision

revision: string

可选的 Git 修订 ID,可以是分支名称、标签或提交哈希

cache

cache: string

存储缓存文件的文件夹路径

token

token: string|boolean

用于下载的令牌。如果设置为 True,将从 Hugging Face 配置文件夹中读取令牌。