📣
TiDB Cloud Premium 开放公测中。为企业级工作负载提供无限扩展、即时弹性伸缩和高级安全保障。此页面由 AI 自动翻译,英文原文请见此处。

ti fs update-file-system-embedding-configuration



为某个 Filesystem 启用或禁用可选的应用管理向量嵌入。启用时会执行一次真实的提供方验证请求,这可能会产生少量提供方费用。启用后,文本或提取出的描述会发送到所选的嵌入提供方。

语法

ti fs update-file-system-embedding-configuration --enabled <boolean> --file-system-id <string> [--dry-run] [--help] [--provider-api-base <string>] [--provider-model <string>] [--version]

选项

  • --enabled <boolean>:输入 true 并提供完整的提供方配置,或输入 false 且不带提供方选项。[required]
  • --file-system-id <string>:设置不可变的 Filesystem ID。[required]
  • --dry-run:在不联系 Filesystem 后端或嵌入提供方的情况下验证请求。
  • --provider-api-base <string>:设置有效的、兼容 OpenAI 的 HTTPS 提供方基础 URL。
  • --provider-model <string>:设置一个恰好返回 1024 维的嵌入模型。
  • --help:显示帮助信息。
  • --version:显示版本信息。

有关所有命令共享的选项,请参见全局选项

提供方 API 密钥仅接受通过 TI_FS_AI_PROVIDER_API_KEY 传入。它会被发送到 Filesystem 后端以进行验证和加密存储,ti 不会在本地存储该密钥,并且返回时只会以掩码形式显示。向量嵌入要求严格兼容 OpenAI 的 /v1/embeddings 协议。原生提供方接口不受支持。

如果某个 Filesystem 的 sourcedatabase_auto,则它使用数据库管理的向量嵌入,无法通过此命令进行更改。在发生超时或响应丢失后,请不要盲目重试修改。请先运行 describe 命令,以确定修改是否已成功。

示例

  • 启用应用管理的向量嵌入:

    # Read the provider key without echoing it or storing it in shell history. printf 'Provider API key: ' >&2 read -r -s TI_FS_AI_PROVIDER_API_KEY printf '\n' >&2 export TI_FS_AI_PROVIDER_API_KEY # Configure a model that returns exactly 1024 dimensions. ti fs update-file-system-embedding-configuration \ --file-system-id <file-system-id> \ --enabled true \ --provider-api-base https://api.openai.com/v1 \ --provider-model text-embedding-3-small unset TI_FS_AI_PROVIDER_API_KEY
  • 在不验证或保存提供方配置的情况下预览启用操作:

    # Read the provider key without echoing it or storing it in shell history. printf 'Provider API key: ' >&2 read -r -s TI_FS_AI_PROVIDER_API_KEY printf '\n' >&2 export TI_FS_AI_PROVIDER_API_KEY # Validate local inputs and show a redacted request plan. ti fs update-file-system-embedding-configuration \ --file-system-id <file-system-id> \ --enabled true \ --provider-api-base https://api.openai.com/v1 \ --provider-model text-embedding-3-small \ --dry-run unset TI_FS_AI_PROVIDER_API_KEY
  • 禁用应用管理的向量嵌入:

    # Remove custom embedding configuration without changing normal file access. ti fs update-file-system-embedding-configuration \ --file-system-id <file-system-id> \ --enabled false

文档内容是否有帮助?