简介
本文介绍通过 Python SDK 实现列举向量功能的示例代码和描述。
功能说明
列出向量索引中的向量基本信息。
方法原型
list_vectors(self, Bucket, Index, MaxResults=None, NextToken=None,ReturnData=None, ReturnMetaData=None, SegmentCount=None, SegmentIndex=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.list_vectors(Bucket='examplebucket-1250000000',Index='idx-dim3',MaxResults=10)print('向量列举成功')print('响应头:', resp)print('响应体:', data)except CosServiceError as e:if e.get_error_code() == "NotFoundException":print("资源不存在")print(f'列举失败: {e}')
分页列举向量
# -*- 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.list_vectors(Bucket='examplebucket-1250000000',Index='idx-dim3',MaxResults=10)print('向量列举成功')print('响应头:', resp)print('响应体:', data)if 'nextToken' in data and data['nextToken']:resp, data = client.list_vectors(Bucket='examplebucket-1250000000',Index='idx-dim3',MaxResults=10,NextToken=data['nextToken'])print('向量分页列举成功')print('响应头:', resp)print('响应体:', data)except CosServiceError as e:if e.get_error_code() == "NotFoundException":print("资源不存在")print(f'列举失败: {e}')
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
Index | 向量索引名称 | String | 是 |
Bucket | 向量存储桶名称,<BucketName-APPID>格式,例如 examplebucket-1250000000,支持小写字母、数字和 - ,长度限制3-63字符 | String | 是 |
MaxResults | 返回的最大向量数量(默认值:500),参数取值范围为1~1000 | Int | 否 |
NextToken | 分页查询凭证,来源于上一次 ListVectors 请求响应,首次调用该接口时为空 | String | 否 |
ReturnData | 是否返回向量数据(默认值:false) | Boolean | 否 |
ReturnMetadata | 是否返回向量元数据(默认值:false) | Boolean | 否 |
SegmentCount | 并行列举时,以此表示划分向量的段数。若设置为1,则为串行列举 取值范围为1~16 需与 segmentIndex 同时指定 | Int | 否 |
SegmentIndex | 并行列举时,以此表示当前请求列举的向量段的索引 取值需小于 segmentCount 需与 segmentCount 同时指定 | Int | 否 |
返回结果说明
返回值
resp (dict): 响应头信息
data (dict): 响应数据,包含向量列表,每一项包含向量的基本信息,详细结构可参见 ListVectors。