简介
本文介绍向量桶通过 Python SDK 实现获取向量功能的示例代码和描述。
功能说明
从向量索引中获取一个或多个向量的基本信息。
方法原型
get_vectors(self, Bucket, Index, Keys, ReturnData=None, ReturnMetaData=None, **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, data = client.get_vectors(Bucket='example-bucket-1250000000',Index='idx-dim3',Keys=['vector1', 'vector2'],ReturnData=True,ReturnMetaData=True)print('向量获取成功')print('响应头:', resp)print('响应体:', data)except CosServiceError as e:if e.get_error_code() == "NotFoundException":print("资源不存在")print(f'获取失败: {e}')
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
Bucket | 向量桶名称,<BucketName-APPID>格式,例如 examplebucket-1250000000,支持小写字母、数字和 - ,长度限制为3-63个字符 | String | 是 |
Index | 向量索引名称 | String | 是 |
Keys | 要获取的向量 Key | String 数组 | 是 |
ReturnData | 为 True 则返回向量数据 | Boolean | 否 |
ReturnMetaData | 为 True 则返回向量桶元数据 | Boolean | 否 |
返回结果说明
返回值
resp (dict): 响应头信息
data (dict): 响应数据,包含向量的基本信息,详细结构可参考 GetVectors。