Method: projects.locations.collections.dataObjects.batchSearch

Batch-Suche nach Datenobjekten.

HTTP-Anfrage

POST https://vectorsearch.googleapis.com/v1beta/{parent}/dataObjects:batchSearch

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname der Collection, in der gesucht werden soll. Format: projects/{project}/locations/{location}/collections/{collection}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
Felder
searches[]

object (Search)

Erforderlich. Eine Liste von Suchanfragen, die parallel ausgeführt werden sollen.
combine

object (CombineResultsOptions)

Optional. Optionen zum Kombinieren der Ergebnisse der Batch-Suchvorgänge.

Antworttext

Eine Antwort von einem Batch-Suchvorgang.

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

JSON-Darstellung 
{
  "results": [
    {
      object (SearchDataObjectsResponse)
    }
  ]
}
Felder
results[]

object (SearchDataObjectsResponse)

Nur Ausgabe. Eine Liste von Suchantworten, eine für jede Anfrage im Batch. Wenn ein Ranker verwendet wird, wird eine einzelne sortierte Liste von Ergebnissen zurückgegeben.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

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

  • vectorsearch.dataObjects.search

Weitere Informationen finden Sie in der IAM-Dokumentation.

CombineResultsOptions

Optionen zum Kombinieren der Ergebnisse der Batch-Suchvorgänge.

JSON-Darstellung 
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
Felder
ranker

object (Ranker)

Erforderlich. Der Ranker, der zum Kombinieren der Ergebnisse verwendet werden soll.
outputFields

object (OutputFields)

Optional. Maske, die angibt, welche Felder zurückgegeben werden sollen.
topK

integer

Optional. Die Anzahl der zurückzugebenden Ergebnisse. Wenn nicht festgelegt, wird ein Standardwert verwendet.

Ranker

Definiert einen Ranker, um Ergebnisse aus mehreren Suchvorgängen zu kombinieren.

JSON-Darstellung 
{

  // Union field ranker can be only one of the following:
  "rrf": {
    object (ReciprocalRankFusion)
  }
  // End of list of possible types for union field ranker.
}
Felder
Union-Feld ranker. Die Ranking-Methode, die verwendet werden soll. Für ranker ist nur einer der folgenden Werte zulässig:
rrf

object (ReciprocalRankFusion)

Ranking mit Reciprocal Rank Fusion.

ReciprocalRankFusion

Definiert den Algorithmus Reciprocal Rank Fusion (RRF) für das Ranking der Ergebnisse.

JSON-Darstellung 
{
  "weights": [
    number
  ]
}
Felder
weights[]

number

Erforderlich. Die Gewichtungen, die während der Fusion auf die einzelnen Suchergebnismengen angewendet werden sollen.