You need to enable JavaScript to run this app.
文档中心
对象存储

对象存储

复制全文
下载 pdf
向量
ListVectors
复制全文
下载 pdf
ListVectors
功能描述​
列出指定向量索引中的向量。​
请求消息样式​
Endpoint 需使用 Bucket Endpoint。​
​
POST /ListVectors HTTP/1.1​
Host: {VectorBucketName}-{AccountID}.tosvectors-cn-beijing.volces.com​
Authorization: authorization string​
Date: Wed, 10 Dec 2025 12:49:14 GMT​
​
{​
"vectorBucketName": "test-vector-bucket",​
"indexName": "test-index",​
"returnData": true,​
"returnMetadata": true,​
"maxResults": 100​
}​
​
请求参数和消息头​
无。​
请求元素​
​
名称​
参数类型​
是否必选​
示例值​
说明​
vectorBucketName​
string​
是​
test-vector-bucket​
向量桶的名称。​
indexName​
string​
是​
test-index​
向量索引的名称。​
maxResults​
integer​
否​
100​
页面上返回的最大向量数。默认值为 500。如果处理的数据集大小在达到 maxResults 值之前超过 1MB,操作将停止并返回已检索的向量以及用于后续请求的 nextToken。​
取值范围:1 到 1000。​
nextToken​
string​
否​
a2V5MA==​
来自前一个请求的分页令牌。对于初始请求,此字段的值为空。​
长度约束:最小长度为 1,最大长度为 2048。​
returnData​
boolean​
否​
true​
如果为 true,则每个向量的向量数据将包含在响应中。​
默认值:false。​
returnMetadata​
boolean​
否​
true​
如果为 true,则与每个向量关联的元数据将包含在响应中。​
默认值:false。​
​
响应消息头​
返回公共的响应头,请参见公共参数。​
响应元素​
如果操作成功,服务将返回一个 HTTP 200 响应码以及如下响应元素。​
如果操作失败,返回响应码中定义的错误码。​
​
字段​
类型​
示例值​
说明​
nextToken​
string​
a2V5MA==​
用于后续请求的分页令牌。如果不需要进一步分页,则该字段为空。​
vectors​
ListOutputVector[]​
参见下表​
当前段中的向量。数组中的每个对象都是一个 ListOutputVector 对象。​
​
ListOutputVector 结构体参数说明:​
​
参数名称​
参数类型​
示例值​
说明​
data​
VectorData​
{​
"float32": [​
0.1,​
0.1,​
0.1,​
0.1,​
0.1​
]​
}​
向量数据。确保查询向量的维度与被查询的向量索引的维度相同。​
key​
string​
key0​
向量的唯一标识符。​
metadata​
JSON value​
{​
"key_a": "va",​
"key_b": "vb",​
"key_c": "vc"​
}​
与向量关联的元数据。​
​
VectorData 结构体是 Union 类型,当前只有一个成员有效(float32),参见下表。​
​
名称​
参数类型​
示例值​
说明​
float32​
float32[]​
[0.1, 0.1, 0.1, 0.1, 0.1]​
向量数据。​
该向量维度必须和 CreateIndex 中定义的向量索引维度一致。​
​
请求示例​
​
POST /ListVectors HTTP/1.1​
Host: test-vector-bucket-1111.tosvectors-cn-beijing.volces.com​
Authorization: authorization string​
Date: Wed, 10 Dec 2025 12:49:14 GMT​
​
{​
"vectorBucketName": "test-vector-bucket",​
"indexName":"test-index",​
"returnData": true,​
"returnMetadata": true,​
"maxResults": 3​
}​
​
响应示例​
​
HTTP/1.1 200 OK​
x-tos-id-2: 797014003c90a9b6940****-b15a995-1vV80n-CVB-cb-tos-1az-front-azd-vectors-2​
x-tos-request-id: 797014003c90a9b6940****-b15a995-1vV80n-CVB-cb-tos-1az-front-azd-vectors-2​
Date: Wed, 10 Dec 2025 12:49:14 GMT​
Server: TosServer​
Content-Length: 266​
Content-Type: application/json​
​
{​
"nextToken": "a2V5MQ==",​
"vectors": [​
{​
"data": {​
"float32": [​
0.1,​
0.1,​
0.1,​
0.1,​
0.1​
]​
},​
"key": "key0",​
"metadata": {​
"key_a": "va",​
"key_b": "vb",​
"key_c": "vc"​
}​
},​
{​
"data": {​
"float32": [​
0.2,​
0.2,​
0.2,​
0.2,​
0.2​
]​
},​
"key": "key1",​
"metadata": {​
"key_a": "va",​
"key_b": "vb",​
"key_c": "vc1",​
"key_d": "vd"​
}​
}​
]​
}​
​
​
最近更新时间:2026.09.18 14:23:39
这个页面对您有帮助吗?
有用
有用
无用
无用