Method: projects.locations.indexEndpoints.searchIndexEndpoint

Busca un extremo de índice implementado (solo para el tipo de corpus de IMÁGENES).

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
indexEndpoint

string

Obligatorio. El extremo del índice que se buscará. Formato: "projects/{projectId}/locations/{locationId}/indexEndpoints/{indexEndpointId}"

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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)

Criterios aplicados a los resultados de la búsqueda.
exclusionCriteria[]

object (Criteria)

Criterios para excluir de los resultados de la búsqueda. Ten en cuenta que se ignorará fetchMatchedAnnotations.
pageSize

integer

Indica el tamaño de la página solicitada. Es posible que la API devuelva menos resultados de los solicitados. Si es negativo, se mostrará el error INVALID_ARGUMENT. Si no se especifica o es 0, la API elegirá un tamaño predeterminado, que es 10. Si el tamaño de página solicitado es mayor que el máximo, la API elegirá el tamaño máximo, que es 100.
pageToken

string

Es el token de Continuation para recuperar la siguiente página. Si está vacío, significa que está recuperando la primera página.
Campo de unión query. La búsqueda global de oneof. query puede ser solo uno de los siguientes:
imageQuery

object (ImageQuery)

Una búsqueda de solo imagen.
textQuery

string

Es una consulta de solo texto.

Cuerpo de la respuesta

Mensaje de respuesta para indexEndpoints.searchIndexEndpoint.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "searchResultItems": [
    {
      object (SearchResultItem)
    }
  ],
  "nextPageToken": string
}
Campos
searchResultItems[]

object (SearchResultItem)

Resultados de la búsqueda que se muestran.
nextPageToken

string

Es el token de habilitación de la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Alcances de autorización

Se requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso indexEndpoint:

  • visionai.indexEndpoints.search

Para obtener más información, consulta la documentación de IAM.

ImageQuery

Búsqueda de imágenes para la solicitud del extremo de búsqueda.

Representación 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ón image.

image puede ser una de las siguientes opciones:
inputImage

string (bytes format)

Ingresa la imagen en bytes sin procesar.

String codificada en base64.
asset

string

Es el nombre del recurso del activo. Solo se admite en el tipo de corpus IMAGE. Formato: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}