OSS Vectors commands provide direct access to the OSS Vectors API. You can use the vectors-api command to invoke them. Unlike standard buckets, a vector bucket manages data by using an index and a vector key instead of an object key. All requests must include the --account-id parameter.
Each vector bucket API request consists of an API name and parameters: bucket name, index name, header, query, and body.
-
API name: Each API maps to a hyphen-separated command name.
For example, PutVectorBucket becomes put-vector-bucket. All available commands are listed in API overview.
-
API parameters
API parameter
Option name
Description
Bucket name
--bucket
string
The name of the bucket.
Index name
--index-name
string
The index name. Required only for vector data and index management operations.
Account ID
--account-id
string
Required in addition to the region. Specify in the configuration file or as a command-line option.
Query parameter
--data-type
string
Each query parameter maps to a kebab-case option derived from its camelCase name. For example, dataType becomes --data-type.
Body parameter
--vectors
string
Body parameters are merged into a single option.
-
The option name is the XML root node converted to kebab-case.
-
The value is a string. Prefix with file:// to specify a file path.
-
JSON format is also supported.
-