全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

安装与配置

最近更新时间:2026-11-03 20:47:21

环境准备

使用本工具前,请确保:

重要:向量索引的维度必须与所用向量模型输出维度一致,否则写入会失败。

安装

方式一:pip 安装(推荐)

pip install ks3-vectors-embed-cli

方式二:源码安装

git clone https://github.com/ks3sdklib/ks3-vectors-embed-cli.git
cd ks3-vectors-embed-cli
pip install -e .

验证安装

ks3-vectors-embed --version
# 输出:ks3-vectors-embed, version 0.1.0

配置凭证

将凭证配置为环境变量,CLI 执行时自动读取,无需在命令中重复传入。

# KS3 访问密钥(对象读写与向量桶共用,必选)
export KS3_ACCESS_KEY_ID="AK"
export KS3_ACCESS_KEY_SECRET="SK"

# 对象存储与向量桶访问域名(可选,默认值如下)
export KS3_ENDPOINT="ks3-cn-beijing.ksyuncs.com"
export KS3_VECTORS_ENDPOINT="ks3vectors-cn-beijing.ksyuncs.com"

# 向量化服务(API Key 必选,服务地址可选,默认值如下)
export KSC_API_KEY="APIKey"
export KSC_BASE_URL="https://kspmas.ksyun.com/v1/"

环境变量说明:

变量名

说明

是否必选

KS3_ACCESS_KEY_ID

KS3 访问密钥 ID,对象读写与向量桶共用

必选

KS3_ACCESS_KEY_SECRET

KS3 访问密钥 Secret,对象读写与向量桶共用

必选

KS3_SECURITY_TOKEN

临时安全令牌,仅使用 STS 临时凭证时需要

可选

KS3_ENDPOINT

对象存储地址,默认值 ks3-cn-beijing.ksyuncs.com

可选

KS3_VECTORS_ENDPOINT

向量桶服务地址,默认值 ks3vectors-cn-beijing.ksyuncs.com

可选

KSC_API_KEY

向量化服务 API Key

必选

KSC_BASE_URL

向量化服务地址,默认值 https://kspmas.ksyun.com/v1/

可选

工具卸载

可通过以下命令卸载本工具:

pip uninstall ks3-vectors-embed-cli

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈