Object Storage Service:Upload vectors (Python SDK V2)

Prerequisites

Before you begin, ensure that you have:

• An OSS bucket with a vector index created

• The oss:PutVectors permission granted to your Alibaba Cloud account, RAM user, or RAM role — via a RAM policy or a bucket policy

• The alibabacloud-oss-python-sdk-v2 package installed

By default, an Alibaba Cloud account has all permissions. RAM users and RAM roles have no permissions until explicitly granted.

How it works

1. Create an oss_vectors.Client with your region, account ID, and credentials.

2. Build a list of vector records — each with a key, data (float32 array), and optional metadata.

3. Call put_vectors with the bucket name, index name, and vector list.

Permissions

Method definition

put_vectors(request: PutVectorsRequest, **kwargs) → PutVectorsResult

Vector record structure

Each vector record is a dict with the following fields:

Example record:

{
    "key": "rec1",                          # Unique record identifier
    "data": {"float32": [0.1, 0.2, ...]},  # Vector values (float32 array)
    "metadata": {"field": "value"},         # Optional key-value metadata
}

Example

import argparse
import alibabacloud_oss_v2 as oss
import alibabacloud_oss_v2.vectors as oss_vectors

parser = argparse.ArgumentParser(description="vector put vectors sample")
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--index_name', help='The name of the vector index.', required=True)
parser.add_argument('--account_id', help='The account id.', required=True)

def main():
    args = parser.parse_args()

    # Load credentials from environment variables
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Build the client configuration
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    cfg.account_id = args.account_id
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    vector_client = oss_vectors.Client(cfg)

    # Define vector records to upload.
    # Each record requires a unique key, float32 vector data, and optional metadata.
    vectors = [
        {
            "key": "key1",                                                          # Unique record identifier
            "data": {"float32": [0.1] * 128},                                       # 128-dimensional float32 vector
            "metadata": {"metadata1": "value1", "metadata2": "value2"}             # Optional key-value metadata
        },
        {
            "key": "key2",
            "data": {"float32": [0.2] * 128},
            "metadata": {"metadata3": "value3", "metadata4": "value4"}
        }
    ]

    # Upload all records in a single call
    result = vector_client.put_vectors(oss_vectors.models.PutVectorsRequest(
        bucket=args.bucket,
        index_name=args.index_name,
        vectors=vectors,
    ))

    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
    )

if __name__ == "__main__":
    main()

Replace the following placeholders before running:

References

For the complete sample code, see put_vectors.py.