Method: projects.locations.collections.dataObjects.batchSearch

Batch durchsucht Datenobjekte.

HTTP-Anfrage

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

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname der Sammlung, 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 der Suchanfragen, die parallel ausgeführt werden sollen.
combine

object (CombineResultsOptions)

Optional. Optionen zum Kombinieren der Ergebnisse der Batchsuchvorgänge.

Antworttext

Eine Antwort auf einen Batchsuchvorgang.

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

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

object (SearchDataObjectsResponse)

Nur Ausgabe. Eine Liste mit Suchantworten, eine für jede Anfrage im Batch. Wenn ein Ranker verwendet wird, wird eine einzelne sortierte Liste mit 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 Batchsuchvorgä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.

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

object (ReciprocalRankFusion)

Reciprocal Rank Fusion-Ranking.
Union-Feld reranker. Der Reranker, der für das endgültige Ranking der vom Ranker kombinierten Ergebnisse verwendet werden soll. Für reranker ist nur einer der folgenden Werte zulässig:
vertexRanker

object (VertexRanker)

Optional. Vertex AI-Ranking.

ReciprocalRankFusion

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

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

number

Erforderlich. Die Gewichte, die während der Zusammenführung auf die einzelnen Suchergebnisgruppen angewendet werden sollen.

VertexRanker

Definiert einen Ranker mit dem Vertex AI-Rankingdienst. Weitere Informationen finden Sie unter https://cloud.google.com/generative-ai-app-builder/docs/ranking.

JSON-Darstellung 
{
  "model": string,
  "topN": integer,

  // Union field record_spec can be only one of the following:
  "textRecordSpec": {
    object (TextRecordSpec)
  }
  // End of list of possible types for union field record_spec.
}
Felder
model

string

Erforderlich. Das zum Ranking von Dokumenten verwendete Modell. Die Liste der verfügbaren Modelle finden Sie unter https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Derzeit wird nur semantic-ranker-fast@latest unterstützt.
topN

integer

Erforderlich. Die Anzahl der Dokumente, die für das Ranking verarbeitet werden sollen.
Union-Feld record_spec. Die Datensatzspezifikation für das Ranking. Es muss mindestens eine Datensatzspezifikation festgelegt sein. Für record_spec ist nur einer der folgenden Werte zulässig:
textRecordSpec

object (TextRecordSpec)

Die Datensatzspezifikation für die Textsuche.

TextRecordSpec

Die Datensatzspezifikation für die Textsuche.

JSON-Darstellung 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string
}
Felder
query

string

Erforderlich. Die Abfrage, anhand derer die Datensätze gerankt und bewertet werden.
titleTemplate

string

Optional. Die Vorlage, die zum Generieren des Titels des Datensatzes verwendet wird.
contentTemplate

string

Optional. Die Vorlage, die zum Generieren des Inhalts des Datensatzes verwendet wurde.