Method: corpora.query

Führt eine semantische Suche in einem Corpus durch.

HTTP-Anfrage

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Name der abzufragenden Corpus. Beispiel: corpora/my-corpus-123

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "query": string,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "resultsCount": integer
}
Felder
query

string

Erforderlich. Abfragestring für die semantische Suche

metadataFilters[]

object (MetadataFilter)

Optional. Nach Chunk- und Document-Metadaten filtern. Jedes MetadataFilter-Objekt muss einem eindeutigen Schlüssel entsprechen. Mehrere MetadataFilter-Objekte werden durch logische UND-Verknüpfungen verbunden.

Beispielabfrage auf Dokumentebene: (Jahr >= 2020 ODER Jahr < 2010) UND (Genre = Drama ODER Genre = Action)

MetadataFilter Objektliste: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operational = GREATER_EQUAL}, {int_value = 2010, operational = LESS}]}, {key = "document.custom_metadata.year" conditions = "document.custom_metadata.year" conditions = [{int_value TER_metadata.year" conditions = [{int_value2 TER = int_value2 TER = INT_value2 TER = Operation LES = 2020" = 2020 = 2020 = 2020 = 2020

Beispielabfrage auf Chunk-Ebene für einen numerischen Wertebereich: (Jahr > 2015 UND Jahr <= 2020)

MetadataFilter Objektliste: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, action = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, Vorgang = LESS_EQUAL}]}]

Hinweis: UND-Verknüpfungen für denselben Schlüssel werden nur für numerische Werte unterstützt. Stringwerte unterstützen nur „OR“-Werte für denselben Schlüssel.

resultsCount

integer

Optional. Die maximale Anzahl von Chunk-Werten, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger Chunks zurück.

Wenn keine Vorgabe erfolgt, werden maximal 10 Chunks zurückgegeben. Es können maximal 100 Ergebnisse angegeben werden.

Antworttext

Antwort von corpora.query, die eine Liste relevanter Blöcke enthält.

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

JSON-Darstellung
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
Felder
relevantChunks[]

object (RelevantChunk)

Die relevanten Teile.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Weitere Informationen finden Sie in der Authentifizierungsübersicht.