Method: projects.locations.indexEndpoints.searchIndexEndpoint

Cerca un endpoint indice di cui è stato eseguito il deployment (solo tipo di corpus IMMAGINE).

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
indexEndpoint

string

Obbligatorio. L'endpoint dell'indice da cercare. Formato: "projects/{projectId}/locations/{locationId}/indexEndpoints/{indexEndpointId}"

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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.
}
Campi
criteria[]

object (Criteria)

Criteri applicati ai risultati di ricerca.
exclusionCriteria[]

object (Criteria)

Criteri da escludere dai risultati di ricerca. Tieni presente che fetchMatchedAnnotations verrà ignorato.
pageSize

integer

Dimensioni della pagina richiesta. L'API potrebbe restituire meno risultati rispetto a quelli richiesti. Se è negativo, viene restituito l'errore INVALID_ARGUMENT. Se non specificato o 0, l'API sceglierà una dimensione predefinita, pari a 10. Se le dimensioni della pagina richieste sono superiori a quelle massime, l'API sceglierà le dimensioni massime, ovvero 100.
pageToken

string

Il token di continuazione per recuperare la pagina successiva. Se è vuoto, significa che sta recuperando la prima pagina.
Campo unione query. La query di ricerca globale oneof. query può essere solo uno dei seguenti:
imageQuery

object (ImageQuery)

Una query solo per immagini.
textQuery

string

Una query di solo testo.

Corpo della risposta

Messaggio di risposta per indexEndpoints.searchIndexEndpoint.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "searchResultItems": [
    {
      object (SearchResultItem)
    }
  ],
  "nextPageToken": string
}
Campi
searchResultItems[]

object (SearchResultItem)

Risultati di ricerca restituiti.
nextPageToken

string

Il token di continuazione della pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa indexEndpoint:

  • visionai.indexEndpoints.search

Per ulteriori informazioni, consulta la documentazione di IAM.

ImageQuery

Query sull'immagine per la richiesta dell'endpoint di ricerca.

Rappresentazione 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.
}
Campi

Campo unione image.

image può essere solo uno dei seguenti:
inputImage

string (bytes format)

Immagine di input in byte non elaborati.

Una stringa con codifica Base64.
asset

string

Nome della risorsa dell'asset. Supportato solo nel tipo di corpus IMAGE. Formato: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}