Method: projects.locations.indexEndpoints.searchIndexEndpoint

In einem bereitgestellten Indexendpunkt suchen (nur Bildkorpustyp)

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
indexEndpoint

string

Pflichtangabe. Der Indexendpunkt, in dem gesucht werden soll. Format: `projects/{projectId}/locations/{locationId}/indexEndpoints/{indexEndpointId}`

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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.
}
Felder
criteria[]

object (Criteria)

Kriterien, die auf Suchergebnisse angewendet werden.
exclusionCriteria[]

object (Criteria)

Kriterien, die aus den Suchergebnissen ausgeschlossen werden sollen. fetchMatchedAnnotations wird ignoriert.
pageSize

integer

Angeforderte Seitengröße. Die API gibt möglicherweise weniger Ergebnisse zurück, als angefordert. Wenn der Wert negativ ist, wird der Fehler INVALID_ARGUMENT zurückgegeben. Wenn keine Angabe erfolgt oder „0“ angegeben ist, wählt die API eine Standardgröße von 10 aus. Wenn die angeforderte Seitengröße größer als die maximale Größe ist, wird von der API die maximale Größe von 100 ausgewählt.
pageToken

string

Das Fortsetzungstoken zum Abrufen der nächsten Seite. Wenn das Feld leer ist, wird die erste Seite abgerufen.
Union-Feld query. Die globale Suchanfrage „oneof“. Für query ist nur einer der folgenden Werte zulässig:
imageQuery

object (ImageQuery)

Eine Abfrage, die nur Bilder enthält.
textQuery

string

Eine Abfrage, die nur Text enthält.

Antworttext

Antwortnachricht für indexEndpoints.searchIndexEndpoint.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "searchResultItems": [
    {
      object (SearchResultItem)
    }
  ],
  "nextPageToken": string
}
Felder
searchResultItems[]

object (SearchResultItem)

Zurückgegebene Suchergebnisse.
nextPageToken

string

Das Fortsetzungstoken für die nächste Seite. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource indexEndpoint:

  • visionai.indexEndpoints.search

Weitere Informationen finden Sie in der IAM-Dokumentation.

ImageQuery

Bildabfrage für Suchendpunktanfrage.

JSON-Darstellung 
{

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

Union-Feld image.

Für image ist nur einer der folgenden Werte zulässig:
inputImage

string (bytes format)

Eingabebild in Rohbytes.

Ein base64-codierter String.
asset

string

Ressourcenname des Assets. Nur für den Korpustyp „IMAGE“ unterstützt. Format: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}