Method: corpora.documents.query

Führt eine semantische Suche in einem Document durch.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Name der abzufragenden Document. Beispiel: corpora/my-corpus-123/documents/the-doc-abc

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

string

Erforderlich. Abfragestring für die semantische Suche
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.
metadataFilters[]

object (MetadataFilter)

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

Hinweis: Das Filtern auf Document-Ebene wird für diese Anfrage nicht unterstützt, da bereits ein Document-Name angegeben wurde.

Beispielabfrage: (Jahr >= 2020 ODER Jahr < 2010) UND (genre = Drama OR Genre = Action)

MetadataFilter Objektliste: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, action = GREATER_EQUAL}, {int_value = 2010, Vorgang = LESS}}, {key = "chunk.custom_metadata.year" conditions = [{stringValue AL.genre" conditions = [{stringValue" AL Eaction" = "draaction"

Beispielabfrage 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.

Antworttext

Antwort von documents.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 zurückgegebenen relevanten Blöcke.

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.