Method: answerQuery

Beantwortet eine Anfrage mithilfe von fundierter Generierung.

HTTP-Anfrage

POST https://developerknowledge.googleapis.com/v1alpha:answerQuery

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "query": string,
  "filter": string
}
Felder
query

string

Erforderlich. Die zu beantwortende Anfrage.
filter

string

Optional. Wendet einen strengen Filter auf die Suchergebnisse an, die zur Fundierung der Antwort verwendet werden. Der Ausdruck unterstützt eine Teilmenge der unter https://google.aip.dev/160 beschriebenen Syntax.

Unterstützte Felder zum Filtern:

  • content_length_bytes (INTEGER): Die Länge des Felds Document.content in Byte.
  • data_source (STRING): Die Quelle des Dokuments, z.B. docs.cloud.google.com. Eine vollständige Liste der Datenquellen im Korpus finden Sie unter https://developers.google.com/knowledge/reference/corpus-reference.
  • update_time (TIMESTAMP): Der Zeitstempel, der angibt, wann das Dokument zuletzt aktualisiert wurde. Ein sinnvolles Update ist eines, bei dem sich der Markdown-Inhalt oder die Metadaten des Dokuments ändern.
  • uri (STRING): Der Dokument-URI, z.B. https://docs.cloud.google.com/bigquery/docs/tables.

INTEGER-Felder unterstützen die Operatoren =, <, <=, > und >=.

STRING-Felder unterstützen die Operatoren = (gleich) und != (ungleich) für den genauen Abgleich des gesamten Strings. Teilübereinstimmungen, Präfixübereinstimmungen und Regex-Übereinstimmungen werden nicht unterstützt.

TIMESTAMP-Felder unterstützen die Operatoren =, <, <=, > und >=. Zeitstempel müssen im RFC-3339-Format vorliegen, z.B. "2025-01-01T00:00:00Z".

Sie können Ausdrücke mit den logischen Operatoren AND, OR und NOT (oder -) kombinieren. OR hat eine höhere Priorität als AND. Verwenden Sie Klammern für die explizite Gruppierung der Priorität.

Beispiele:

  • Nach Document.content_length_bytes filtern: content_length_bytes < 50000
  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

Der String filter darf nicht länger als 500 Zeichen sein. Bei längeren Werten wird der Fehler INVALID_ARGUMENT ausgegeben.

Antworttext

Antwortnachricht für DeveloperKnowledge.AnswerQuery.

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

JSON-Darstellung 
{
  "answer": {
    object (Answer)
  }
}
Felder
answer

object (Answer)

Die Antwort auf die Anfrage.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

Antwort

Eine Antwort auf eine Anfrage.

JSON-Darstellung 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
Felder
answerText

string

Enthält den Text der Antwort.
citations[]

object (AnswerCitation)

Nur Ausgabe. Enthält Quellenangaben für die Antwort.
references[]

object (AnswerReference)

Nur Ausgabe. Enthält Referenzen für die Antwort.

AnswerCitation

Quelleninformation für ein Segment.

JSON-Darstellung 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Felder
startIndex

integer

Nur Ausgabe. Gibt den Beginn des Segments an, gemessen in Byte (UTF-8-Unicode), einschließlich. Wenn es Multibyte-Zeichen gibt, wie etwa Nicht-ASCII-Zeichen, ist die Indexmessung länger als die Stringlänge.
endIndex

integer

Nur Ausgabe. Gibt das Ende des Segments an, gemessen in Byte (UTF-8-Unicode), exklusiv. Wenn es Multibyte-Zeichen gibt, wie etwa Nicht-ASCII-Zeichen, ist die Indexmessung länger als die Stringlänge.
sources[]

object (CitationSource)

Nur Ausgabe. Enthält Zitationsquellen für das zugeordnete Segment.

CitationSource

Zitationsquelle

JSON-Darstellung 
{
  "referenceIndex": integer
}
Felder
referenceIndex

integer

Nur Ausgabe. Enthält den Index von Answer.AnswerReference im wiederkehrenden Feld references.

AnswerReference

Stellt einen Verweis auf eine Quelle dar.

JSON-Darstellung 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "documentReference": {
    object (DocumentReference)
  }
  // End of mutually exclusive fields.
}
Felder
Enthält den Inhalt der Referenz. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
documentReference

object (DocumentReference)

Nur Ausgabe. Das Referenzdokument.
Ende der sich gegenseitig ausschließenden Felder.

DocumentReference

Stellt einen Verweis auf ein Dokument dar.

JSON-Darstellung 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
Felder
documentChunk

object (DocumentChunk)

Nur Ausgabe. Enthält den Dokument-Chunk. Das Feld documentChunk.id ist nicht festgelegt und ist leer.