全部文档

当前文档

热搜词推荐

云服务器虚拟私有网络边缘节点计算对等连接

暂无内容

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

对象存储(KS3)

查看更多结果

未找到含当前关键字的文档标题

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

对象存储(KS3)

常用工具

工具汇总

KS3 Vectors Embed CLI工具

参数说明

参数说明

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



全局参数

全局参数对所有子命令生效，需写在子命令之前。--base-url、--endpoint、--vectors-endpoint 支持通过环境变量设置，命令行参数优先级高于环境变量。

参数	是否必选	说明
`--base-url`	否	向量化服务地址，环境变量 `KSC_BASE_URL`，默认值 `https://kspmas.ksyun.com/v1/`
`--endpoint`	否	对象存储访问域名，读取 `ks3://` 输入时使用，环境变量 `KS3_ENDPOINT`，默认值 `ks3-cn-beijing.ksyuncs.com`
`--vectors-endpoint`	否	向量桶访问域名，环境变量 `KS3_VECTORS_ENDPOINT`，默认值 `ks3vectors-cn-beijing.ksyuncs.com`
`--debug`	否	启用调试模式，输出详细日志

put 命令参数

参数	是否必选	说明
`--vector-bucket-name`	是	向量桶名称
`--index-name`	是	向量索引名称
`--model-id`	是	用于生成向量的模型 ID
`--text-value`	否	要处理的文本内容
`--text`	否	要处理的文本文件路径或 `ks3://` 对象路径
`--image`	否	要处理的图片文件路径、`ks3://` 对象路径或 URL
`--video`	否	要处理的视频 URL（不支持本地文件）
`--image-resize`	否	对 `ks3://` 图片做服务端等比缩放，取值 10-100（百分比）。仅支持 `ks3://` 图片
`--key`	否	为向量指定一个自定义的唯一键
`--key-prefix`	否	为自动生成的或指定的键添加前缀
`--filename-as-key`	否	使用输入文件的名称作为向量键
`--embedding-inference-params`	否	传递给向量化服务的模型特定参数（JSON 格式）
`--metadata`	否	以 JSON 字符串格式指定的元数据
`--max-workers`	否	批量处理时的最大并发数，默认值 4
`--batch-size`	否	批量写入时单次请求包含的向量数量，取值 1-500，默认值 500
`--output`	否	输出格式，可选 `json`（默认值）或 `table`
`--presign-url`	否	对 `ks3://` 输入生成预签名 URL 供向量化服务访问。`ks3://` 视频必填，`ks3://` 图片可选

query 命令参数

参数	是否必选	说明
`--vector-bucket-name`	是	向量桶名称
`--index-name`	是	向量索引名称
`--model-id`	是	用于生成向量的模型 ID
`--text-value`	否	要查询的文本内容
`--text`	否	包含查询文本的文件路径或 `ks3://` 对象路径
`--image`	否	要查询的图片路径、`ks3://` 对象路径或 URL
`--video`	否	要查询的视频 URL（不支持本地文件）
`--top-k`	否	返回最相似结果的数量，默认值 5
`--filter`	否	以 JSON 字符串格式指定的过滤条件
`--return-distance`	否	在结果中包含相似度距离值，默认值 true，可用 `--no-return-distance` 关闭
`--return-metadata`	否	在结果中包含元数据，默认值 true，可用 `--no-return-metadata` 关闭
`--embedding-inference-params`	否	传递给向量化服务的模型特定参数（JSON 格式）
`--output`	否	输出格式，可选 `json`（默认值）或 `table`

文档导读

上一篇：向量检索

下一篇：KS3签名工具

纯净模式常规模式

纯净模式

点击可全屏预览文档内容

文档反馈