Method: answerQuery

Beantwortet eine Abfrage mithilfe der fundierten 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 Abfrage, die beantwortet werden soll.
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 für die Filterung:

  • contentLengthBytes (Ganzzahl): Die Länge des Felds Document.content in Byte.
  • dataSource (String): Die Quelle des Dokuments, z.B. docs.cloud.google.com. Die vollständige Liste der Datenquellen im Korpus finden Sie unter https://developers.google.com/knowledge/reference/corpus-reference.
  • updateTime (Zeitstempel): Der Zeitstempel, der angibt, wann das Dokument zuletzt sinnvoll aktualisiert wurde. Eine sinnvolle Aktualisierung ist eine Aktualisierung, bei der der Markdown-Inhalt oder die Metadaten des Dokuments geändert werden.
  • uri (String): Der URI des Dokuments, z.B. https://docs.cloud.google.com/bigquery/docs/tables.

Ganzzahlfelder unterstützen die Operatoren =, <, <=, >, und >=.

Stringfelder unterstützen die Operatoren = (gleich) und != (ungleich) für eine genaue Übereinstimmung mit dem gesamten String. Teilweise Übereinstimmungen, Präfixübereinstimmungen und reguläre Ausdrücke werden nicht unterstützt.

Zeitstempelfelder 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, um die Priorität explizit festzulegen.

Beispiele:

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

Der String filter darf maximal 500 Zeichen lang sein. Bei längeren Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.

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

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

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 Zitate für die Antwort.
references[]

object (AnswerReference)

Nur Ausgabe. Enthält Verweise 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), ausschließlich. 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 Zitatquellen 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 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
Felder
Union-Feld content. Enthält den Inhalt des Verweises. Für content ist nur einer der folgenden Werte zulässig:
documentReference

object (DocumentReference)

Nur Ausgabe. Das Referenzdokument.

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