Method: projects.locations.collections.dataObjects.search

Pesquisa objetos de dados.

Solicitação HTTP

POST https://vectorsearch.googleapis.com/v1/{parent}/dataObjects:search

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome de recurso da coleção a ser pesquisada. Formato: projects/{project}/locations/{location}/collections/{collection}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "pageSize": integer,
  "pageToken": string,

  // Union field search_type can be only one of the following:
  "vectorSearch": {
    object (VectorSearch)
  },
  "semanticSearch": {
    object (SemanticSearch)
  },
  "textSearch": {
    object (TextSearch)
  }
  // End of list of possible types for union field search_type.
}
Campos
pageSize

integer

Opcional. O tamanho de página de lista padrão. Compatível apenas com KNN. Se não for definido, até search_type.top_k resultados serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
pageToken

string

Opcional. O token de página de lista padrão. Normalmente obtido por SearchDataObjectsResponse.next_page_token da chamada DataObjectSearchService.SearchDataObjects anterior.
Campo de união search_type. A consulta a ser pesquisada. search_type pode ser apenas de um dos tipos a seguir:

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de SearchDataObjectsResponse.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • vectorsearch.dataObjects.search

Para mais informações, consulte a documentação do IAM.