Recupera datos vectoriales específicos mediante claves.
Permisos
Las cuentas de Alibaba Cloud tienen todos los permisos de forma predeterminada. Los usuarios de RAM o los roles de RAM no cuentan con ningún permiso de manera predeterminada. Una cuenta de Alibaba Cloud o un administrador debe otorgar los permisos correspondientes mediante una RAM policy o una bucket policy.
|
API |
Acción |
Descripción |
|
GetVectors |
|
Obtiene datos vectoriales. |
Sintaxis de la solicitud
POST /?getVectors HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
Content-type: application/json
{
"indexName": "string",
"keys": [string, string, string],
"returnData": boolean,
"returnMetadata": boolean
}
Encabezados de solicitud
Esta operación utiliza únicamente encabezados de solicitud comunes. Para obtener más información, consulte Common HTTP headers.
Parámetros de solicitud
|
Nombre |
Tipo de dato |
Obligatorio |
Ejemplo |
Descripción |
|
indexName |
String |
Sí |
vectorindex1 |
Nombre del índice. |
|
keys |
Array of strings |
Sí |
["doc-001", "doc-002"] |
Claves principales de los vectores por consultar. Se permiten claves principales duplicadas. Restricciones:
|
|
returnData |
Boolean |
No |
false |
Indica si se devuelven los datos vectoriales. Valores válidos:
|
|
returnMetadata |
Boolean |
No |
false |
Indica si se devuelven los metadatos. Valores válidos:
|
Encabezados de respuesta
Esta operación utiliza únicamente encabezados de respuesta comunes. Para obtener más información, consulte Common HTTP headers.
Elementos de respuesta
|
Nombre |
Tipo de dato |
Ejemplo |
Descripción |
|
vectors |
Array of objects |
- |
Vectores devueltos. Si una clave principal consultada no existe, no se genera ningún error y se omite el resultado correspondiente. |
|
key |
String |
doc-001 |
Clave principal del vector. Si una clave solicitada no coincide con ningún vector existente, no se genera ningún error y la respuesta omite dicha clave. Nodo padre: vectors |
|
data |
Object |
- |
Datos vectoriales. Se devuelven únicamente cuando returnData se establece en true. Nodo padre: vectors |
|
metadata |
Object |
- |
Metadatos. Se devuelven únicamente cuando returnMetadata se establece en true. Nodo padre: vectors |
Ejemplos
Solicitud de ejemplo
POST /?getVectors HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: Thu, 17 Apr 2025 01:33:47 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218
Content-type: application/json
{
"indexName": "vectorindex1",
"keys": ["doc-001", "doc-002"],
"returnData": true,
"returnMetadata": true
}
Respuesta de ejemplo
HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Thu, 17 Apr 2025 01:33:47 GMT
Connection: keep-alive
Server: AliyunOSS
Content-type: application/json
{
"vectors": [
{
"data": {
"float32": [0.1, 0.2, 0.3, 0.4, 0.5]
},
"key": "doc-001",
"metadata": {
"category": ["technology", "ai"],
"title": "Introduction to Vector Search"
}
},
{
"data": {
"float32": [0.2, 0.3, 0.4, 0.5, 0.6]
},
"key": "doc-002",
"metadata": {
"category": ["science"],
"title": "Advanced Vector Operations"
}
}
]
}
SDK
Los siguientes SDK admiten la operación GetVectors:
Interfaz de línea de comandos ossutil
Para consultar el comando de ossutil correspondiente a la operación GetVectors, consulte get-vectors.
Códigos de error
|
Código de error |
Código de estado HTTP |
Descripción |
|
VectorIndexParameterInvalid |
400 |
El parámetro del índice vectorial no es válido. |
|
MalformedJson |
400 |
El JSON del cuerpo de la solicitud tiene un formato incorrecto. |
|
AccessDenied |
403 |
Posibles causas de este error:
|
|
NoSuchVectorIndex |
404 |
El índice vectorial especificado no existe. |
|
QpsLimitExceeded |
503 |
La solicitud se limitó porque se excedió el límite de QPS. |