对象存储 参数选项

一、参数概述

2. 全局 CLI 参数：例如 cos-vectors-embed –region ap-guangzhou put …。

3. 环境变量配置：例如 COS_REGION=ap-guangzhou。

4. 自动生成的默认值：COS_DOMAIN 未设置时自动生成为 vectors.{region}.coslake.com。

二、全局参数

用户可通过–help 选项来查看工具的全局参数和用法。

cos-vectors-embed –help

help 信息如下所示：

Usage: cos-vectors-embed [OPTIONS] COMMAND [ARGS]… COS Vectors Embed CLI – Vectorize content and store in COS Vector Buckets.Options: –region TEXT COS region (e.g. ap-guangzhou). Falls back to COS_REGION env var. –domain TEXT COS Vectors service domain (e.g. vectors.ap- guangzhou.coslake.com). Falls back to COS_DOMAIN env var. –debug Enable debug output with detailed logging. –version Show the version and exit. –help Show this message and exit.Commands: put Vectorize content and write to a COS vector index. query Query a COS vector index by similarity search.

三、put 子命令参数

用户可通过 –help 选项来查看 put 子命令参数和用法

cos-vectors-embed put –help

help 信息如下所示：

Usage: cos-vectors-embed put [OPTIONS] Vectorize content and write to a COS vector index.Options: –vector-bucket-name TEXT COS vector bucket name. [required] –index-name TEXT Vector index name. [required] –model-id TEXT Embedding model identifier. [required] –text-value TEXT Direct text string to embed. –text TEXT Text file path, glob pattern, COS URI (cos://bucket/key), or COS prefix (cos://bucket/prefix/*). –video TEXT Local video file path (reserved for future use). –key TEXT Custom vector key. Only for single-item puts. –key-prefix TEXT Prefix for generated vector keys. –filename-as-key Use source filename as vector key. –metadata TEXT Custom metadata as JSON string, e.g. '{"category": "finance"}'. –provider TEXT Embedding provider type. Default: openai- compatible. –embedding-api-base TEXT Embedding API base URL. Falls back to EMBEDDING_API_BASE env var. –embedding-api-key TEXT Embedding API key. Falls back to EMBEDDING_API_KEY env var. –embedding-inference-params TEXT Extra inference parameters as JSON string. –max-workers INTEGER Number of parallel worker threads for batch processing. Default: 4. –batch-size INTEGER Number of items per storage batch. Default: 100. –output [json|table] Output format. Default: json. –region TEXT Override global –region for this command. –domain TEXT Override global –domain for this command. –help Show this message and exit.

注意：当前的 put 子命令数据输入方式有两种，–text-value用于直接文本输入，而–text需要从文这篇件读取，输入方式必须使用其中一种。

四、query 子命令参数

用户可通过 –help 选项来查看 query 子命令参数和用法

cos-vectors-embed query –help

help 信息如下所示：

Usage: cos-vectors-embed query [OPTIONS] Query a COS vector index by similarity search.Options: –vector-bucket-name TEXT COS vector bucket name. [required] –index-name TEXT Vector index name. [required] –model-id TEXT Embedding model identifier. [required] –text-value TEXT Direct text string to query with. –text TEXT Text file path or COS URI (cos://bucket/key) containing the query. –top-k INTEGER Number of results to return. Default: 5. –filter TEXT Metadata filter as JSON string, e.g. '{"category": {"$eq": "finance"}}'. –return-distance / –no-return-distance Whether to return distance scores. Default: true. –return-metadata / –no-return-metadata Whether to return metadata. Default: true. –provider TEXT Embedding provider type. Default: openai- compatible. –embedding-api-base TEXT Embedding API base URL. Falls back to EMBEDDING_API_BASE env var. –embedding-api-key TEXT Embedding API key. Falls back to EMBEDDING_API_KEY env var. –output [json|table] Output format. Default: json. –region TEXT Override global –region for this command. –domain TEXT Override global –domain for this command. –help Show this message and exit.

注意：当前的 query 子命令数据输入方式有两种，–text-value用于直接文本输入，而–text需要从文这篇件读取，输入方式必须使用一种。