Vector Search API

A API Vector Search oferece um banco de dados vetorial totalmente gerenciado, altamente eficiente e escalonável, projetado para impulsionar aplicativos de pesquisa, recomendação e IA generativa de última geração. Ela permite armazenar, indexar e consultar seus dados e os embeddings de vetor correspondentes em uma interface simples e intuitiva. Com a pesquisa vetorial, é possível definir esquemas personalizados para seus dados, inserir objetos com metadados associados, gerar automaticamente embeddings dos dados e realizar pesquisas rápidas de vizinhos mais próximos aproximados (ANN, na sigla em inglês) para encontrar itens semanticamente semelhantes em grande escala.

Serviço: vectorsearch.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso o aplicativo precise usar bibliotecas próprias para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço apresenta os documentos de descoberta abaixo:

Endpoint de serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • https://vectorsearch.googleapis.com

Recurso REST: v1.projects.locations

Métodos
get GET /v1/{name}
Extrai informações sobre um local.
list GET /v1/{name}/locations
Lista informações sobre os locais compatíveis com este serviço.

Recurso REST: v1.projects.locations.collections

Métodos
create POST /v1/{parent}/collections
Cria uma nova coleção em determinado projeto e local.
delete DELETE /v1/{name}
Exclui uma única coleção.
exportDataObjects POST /v1/{name}:exportDataObjects
Inicia uma operação de longa duração para exportar DataObjects de uma coleção.
get GET /v1/{name}
Recebe detalhes de uma única coleção.
importDataObjects POST /v1/{name}:importDataObjects
Inicia uma operação de longa duração para importar DataObjects em uma coleção.
list GET /v1/{parent}/collections
Lista as coleções em um determinado projeto e local.
patch PATCH /v1/{collection.name}
Atualiza os parâmetros de uma única coleção.

Recurso REST: v1.projects.locations.collections.dataObjects

Métodos
aggregate POST /v1/{parent}/dataObjects:aggregate
Agrega objetos de dados.
batchCreate POST /v1/{parent}/dataObjects:batchCreate
Cria um lote de dataObjects.
batchDelete POST /v1/{parent}/dataObjects:batchDelete
Exclui dataObjects em lote.
batchSearch POST /v1/{parent}/dataObjects:batchSearch
Pesquisa em lote objetos de dados.
batchUpdate POST /v1/{parent}/dataObjects:batchUpdate
Atualiza dataObjects em lote.
create POST /v1/{parent}/dataObjects
Cria um dataObject.
delete DELETE /v1/{name}
Exclui um dataObject.
get GET /v1/{name}
Recebe um objeto de dados.
patch PATCH /v1/{dataObject.name}
Atualiza um dataObject.
query POST /v1/{parent}/dataObjects:query
Consulta objetos de dados.
search POST /v1/{parent}/dataObjects:search
Pesquisa objetos de dados.

Recurso REST: v1.projects.locations.collections.indexes

Métodos
create POST /v1/{parent}/indexes
Cria um novo índice em determinado projeto e local.
delete DELETE /v1/{name}
Exclui um único índice.
get GET /v1/{name}
Recebe detalhes de um único índice.
list GET /v1/{parent}/indexes
Lista os índices em um determinado projeto e local.

Recurso da REST: v1.projects.locations.operations

Métodos
cancel POST /v1/{name}:cancel
Inicia o cancelamento assíncrono em uma operação de longa duração.
delete DELETE /v1/{name}
Exclui uma operação de longa duração.
get GET /v1/{name}
Recebe o estado mais recente de uma operação de longa duração.
list GET /v1/{name}/operations
Lista as operações correspondentes ao filtro especificado na solicitação.

Recurso REST: v1beta1.projects.locations

Métodos
get GET /v1beta/{name}
Extrai informações sobre um local.
list GET /v1beta/{name}/locations
Lista informações sobre os locais compatíveis com este serviço.

Recurso REST: v1beta.projects.locations.collections

Métodos
create POST /v1beta/{parent}/collections
Cria uma nova coleção em determinado projeto e local.
delete DELETE /v1beta/{name}
Exclui uma única coleção.
exportDataObjects POST /v1beta/{name}:exportDataObjects
Inicia uma operação de longa duração para exportar DataObjects de uma coleção.
get GET /v1beta/{name}
Recebe detalhes de uma única coleção.
importDataObjects POST /v1beta/{name}:importDataObjects
Inicia uma operação de longa duração para importar DataObjects em uma coleção.
list GET /v1beta/{parent}/collections
Lista as coleções em um determinado projeto e local.
patch PATCH /v1beta/{collection.name}
Atualiza os parâmetros de uma única coleção.

Recurso REST: v1beta.projects.locations.collections.dataObjects

Métodos
aggregate POST /v1beta/{parent}/dataObjects:aggregate
Agrega objetos de dados.
batchCreate POST /v1beta/{parent}/dataObjects:batchCreate
Cria um lote de dataObjects.
batchDelete POST /v1beta/{parent}/dataObjects:batchDelete
Exclui dataObjects em lote.
batchSearch POST /v1beta/{parent}/dataObjects:batchSearch
Pesquisa em lote objetos de dados.
batchUpdate POST /v1beta/{parent}/dataObjects:batchUpdate
Atualiza dataObjects em lote.
create POST /v1beta/{parent}/dataObjects
Cria um dataObject.
delete DELETE /v1beta/{name}
Exclui um dataObject.
get GET /v1beta/{name}
Recebe um objeto de dados.
patch PATCH /v1beta/{dataObject.name}
Atualiza um dataObject.
query POST /v1beta/{parent}/dataObjects:query
Consulta objetos de dados.
search POST /v1beta/{parent}/dataObjects:search
Pesquisa objetos de dados.

Recurso REST: v1beta.projects.locations.collections.indexes

Métodos
create POST /v1beta/{parent}/indexes
Cria um novo índice em determinado projeto e local.
delete DELETE /v1beta/{name}
Exclui um único índice.
get GET /v1beta/{name}
Recebe detalhes de um único índice.
list GET /v1beta/{parent}/indexes
Lista os índices em um determinado projeto e local.

Recurso REST: v1beta.projects.locations.operations

Métodos
cancel POST /v1beta/{name}:cancel
Inicia o cancelamento assíncrono em uma operação de longa duração.
delete DELETE /v1beta/{name}
Exclui uma operação de longa duração.
get GET /v1beta/{name}
Recebe o estado mais recente de uma operação de longa duração.
list GET /v1beta/{name}/operations
Lista as operações correspondentes ao filtro especificado na solicitação.