GetVectors - Object Storage Service: Central de Documentação do Alibaba Cloud

Permissões

Contas da Alibaba Cloud têm todas as permissões por padrão. Usuários e funções do RAM não possuem permissões por padrão. Uma conta da Alibaba Cloud ou um administrador deve conceder permissões por meio de uma política do RAM ou de uma política de bucket.

API	Ação	Descrição
GetVectors	`oss:GetVectors`	Obtém dados vetoriais.

Sintaxe da solicitação

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
}

Cabeçalhos da solicitação

Esta operação usa apenas cabeçalhos de solicitação comuns. Para obter mais informações, consulte Cabeçalhos HTTP comuns.

Parâmetros da solicitação

Nome	Tipo de dados	Obrigatório	Exemplo	Descrição
indexName	String	Sim	vectorindex1	Nome do índice.
keys	Array de strings	Sim	["doc-001", "doc-002"]	Chaves primárias dos vetores a consultar. Chaves duplicadas são permitidas. Restrições: Quantidade de chaves: 1 a 100. Comprimento da chave: 1 a 1024.
returnData	Booleano	Não	false	Indica se os dados vetoriais devem ser retornados. Valores válidos: true false (padrão)
returnMetadata	Booleano	Não	false	Indica se os metadados devem ser retornados. Valores válidos: true false (padrão)

Cabeçalhos da resposta

Esta operação usa apenas cabeçalhos de resposta comuns. Para obter mais informações, consulte Cabeçalhos HTTP comuns.

Elementos da resposta

Nome	Tipo de dados	Exemplo	Descrição
vectors	Array de objetos	-	Vetores retornados. Se uma chave primária consultada não existir, o sistema não reportará erro e omitirá o resultado dessa chave.
key	String	doc-001	Chave primária do vetor. Se uma chave solicitada não corresponder a um vetor existente, o sistema não reportará erro e a resposta omitirá essa chave. Nó pai: vectors
data	Objeto	-	Dados do vetor. Retornado apenas quando returnData é definido como true. Nó pai: vectors
metadata	Objeto	-	Metadados. Retornado apenas quando returnMetadata é definido como true. Nó pai: vectors

Exemplos

Exemplo de solicitação

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
}

Exemplo de resposta

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

Os SDKs a seguir oferecem suporte à operação GetVectors:

Interface de linha de comando ossutil

Para o comando ossutil correspondente à operação GetVectors, consulte get-vectors.

Códigos de erro

Código de erro	Código de status HTTP	Descrição
VectorIndexParameterInvalid	400	Parâmetro do índice vetorial inválido.
MalformedJson	400	JSON malformado no corpo da solicitação.
AccessDenied	403	Possíveis causas: A solicitação não inclui informações de autenticação do usuário. Permissões insuficientes para realizar a operação.
NoSuchVectorIndex	404	O índice vetorial especificado não existe.
QpsLimitExceeded	503	Solicitação limitada devido à exceededência do limite de QPS.