Method: projects.locations.indexEndpoints.searchIndexEndpoint

Pesquise um endpoint de índice implantado (somente tipo de corpus de IMAGEM).

Solicitação HTTP

POST https://visionai.googleapis.com/v1/{indexEndpoint=projects/*/locations/*/indexEndpoints/*}:searchIndexEndpoint

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
indexEndpoint

string

Obrigatório. O endpoint do índice a ser pesquisado. Formato: "projects/{projectId}/locations/{locationId}/indexEndpoints/{indexEndpointId}"

Corpo da solicitação

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

Representação JSON 
{
  "criteria": [
    {
      object (Criteria)
    }
  ],
  "exclusionCriteria": [
    {
      object (Criteria)
    }
  ],
  "pageSize": integer,
  "pageToken": string,

  // Union field query can be only one of the following:
  "imageQuery": {
    object (ImageQuery)
  },
  "textQuery": string
  // End of list of possible types for union field query.
}
Campos
criteria[]

object (Criteria)

Critérios aplicados aos resultados da pesquisa.
exclusionCriteria[]

object (Criteria)

Critérios a serem excluídos dos resultados da pesquisa. fetchMatchedAnnotations será ignorado.
pageSize

integer

Tamanho da página solicitada. A API pode retornar menos resultados do que o solicitado. Se for negativo, o erro INVALID_ARGUMENT será retornado. Se não for especificado ou for 0, a API vai escolher um tamanho padrão, que é 10. Se o tamanho da página solicitado for maior que o máximo, a API vai escolher o tamanho máximo, que é 100.
pageToken

string

O token de continuação para buscar a próxima página. Se estiver vazio, significa que ele está recuperando a primeira página.
Campo de união query. A consulta de pesquisa global oneof. query pode ser apenas de um dos tipos a seguir:
imageQuery

object (ImageQuery)

Uma consulta somente de imagem.
textQuery

string

Uma consulta somente de texto.

Corpo da resposta

Mensagem de resposta para indexEndpoints.searchIndexEndpoint.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "searchResultItems": [
    {
      object (SearchResultItem)
    }
  ],
  "nextPageToken": string
}
Campos
searchResultItems[]

object (SearchResultItem)

Resultados da pesquisa retornados.
nextPageToken

string

O token de continuação da próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

Permissões do IAM

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

  • visionai.indexEndpoints.search

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

ImageQuery

Consulta de imagem para a solicitação de endpoint de pesquisa.

Representação JSON 
{

  // Union field image can be only one of the following:
  "inputImage": string,
  "asset": string
  // End of list of possible types for union field image.
}
Campos

Campo de união image.

image pode ser apenas de um dos tipos a seguir:
inputImage

string (bytes format)

Inserir a imagem em bytes brutos.

Uma string codificada em base64.
asset

string

Nome do recurso. Somente compatível com o tipo de corpus IMAGEM. Formato: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}