简介
本文介绍向量桶通过 Python SDK 实现插入向量功能的示例代码和描述。
功能说明
在向量索引中插入一个或多个新的向量。
说明:
插入向量将使用向量的 key 字段作为唯一标识符,如果 key 相同将被覆盖。
方法原型
put_vectors(self, Bucket, Index, Vectors, **kwargs)
使用案例
# -*- coding=utf-8import sysimport osfrom pprint import pprintfrom qcloud_cos import CosServiceErrorfrom qcloud_cos import CosConfigfrom qcloud_cos import CosVectorsClientimport logging# 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息logging.basicConfig(level=logging.INFO, stream=sys.stdout)# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成secret_id = os.getenv("COS_VECTORS_SECRET_ID") # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140secret_key = os.getenv("COS_VECTORS_SECRET_KEY") # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140region = 'ap-guangzhou' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos/bucket# COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048scheme = 'http' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填config = CosConfig(Region=region,SecretId=secret_id,SecretKey=secret_key,Scheme=scheme,Domain="vectors.ap-guangzhou.coslake.com",Token=token,)client = CosVectorsClient(config)try:resp = client.put_vectors(Bucket='examplebucket-1250000000',Index='idx-dim3',Vectors=[{'key': 'vector1','data': {"float32":[0.1, 0.2, 0.3]},'metadata': {'key1': 'value1','key2': 'value2'}},{'key': 'vector2','data': {"float32":[0.4, 0.5, 0.6]},'metadata': {'key1': 'value1','key2': 'value2'}}])print('向量插入成功')print('响应头:', resp)except CosServiceError as e:if e.get_error_code() == "NotFoundException":print("资源不存在")print(f'插入失败: {e}')
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
Bucket | 向量存储桶名称,<BucketName-APPID>格式,例如 examplebucket-1250000000,支持小写字母、数字和 - ,长度限制3-63字符 | String | 是 |
Index | 向量索引名称 | String | 是 |
vectors | 写入向量数据列表,数组长度需为1~500 | InputVector 数组 | 是 |
InputVector 结构的 vectors 内容:
参数名称 | 描述 | 类型 | 是否必选 |
key | 向量的主键,用于标识向量索引内的唯一向量 长度为1~1024字符 需为 UTF-8格式 单次请求中不允许出现相同key的多条向量 | String | 是 |
data | 向量数据 输入向量的维度和数据类型必须与创建向量索引(CreateIndex)时所指定的相匹配 向量数据中不允许出现无效值,例如 NaN 或 Infinity 若目标向量索引以余弦距离度量,则不允许写入零向量(向量所有元素均为0) | VectorData | 是 |
metadata | 向量关联的元数据 元数据总大小不超过40KB 可过滤元数据总大小不超过2KB 元数据键个数不超过10个 支持类型:整数、浮点数、字符串、数组 | Json Value | 否 |
VectorData 结构的 data 内容:
参数名称 | 描述 | 类型 | 是否必选 |
float32 | float32 类型的向量数据 | float32 数组 | 是 |
返回结果说明
返回值
resp (dict): 响应头信息。