Antworten aus der Dokumentation generieren

Mit der Developer Knowledge API können Sie Fragen zu Google-Entwicklerprodukten stellen und erhalten direkte Antworten in natürlicher Sprache. Für jede Anfrage erstellt die API eine Antwort aus dem Developer Knowledge-Corpus (in der API-Referenz als grounded generation bezeichnet) und fügt Zitate zu den relevanten Dokumentationsseiten ein.

Hinweis

Richten Sie Ihre Umgebung für das gewünschte Tool ein:

gcloud

Installieren und konfigurieren Sie die gcloud CLI und aktivieren Sie die Developer Knowledge API.

REST

Aktivieren Sie die API und generieren Sie einen Developer Knowledge API-Schlüssel. Speichern Sie den Schlüssel dann in einer Umgebungsvariablen:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Ersetzen Sie YOUR_API_KEY durch Ihren Developer Knowledge API-Schlüssel.

Anfrage beantworten

Verwenden Sie den gcloud developer-knowledge answer-query Befehl oder die answerQuery REST-Methode um eine Frage zu stellen.

Im folgenden Beispiel wird eine Anfrage gesendet, in der gefragt wird, wie ein BigQuery-Dataset erstellt wird:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?"

REST

curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Die Antwort enthält die Textantwort im answer.answerText Feld, sowie citations und references im answer Objekt:

{
  "answer": {
    "answerText": "To create a BigQuery dataset, you can use the Google Cloud Console, the bq command-line tool, or the BigQuery client libraries.",
    "citations": [
      {
        "startIndex": 0,
        "endIndex": 123,
        "sources": [
          {
            "referenceIndex": 0
          }
        ]
      }
    ],
    "references": [
      {
        "documentReference": {
          "documentChunk": {
            "parent": "documents/docs.cloud.google.com/bigquery/docs/datasets",
            "content": "This page explains how to create BigQuery datasets...",
            "document": {
              "name": "documents/docs.cloud.google.com/bigquery/docs/datasets",
              "title": "Introduction to datasets",
              "uri": "https://docs.cloud.google.com/bigquery/docs/datasets"
            }
          }
        }
      }
    ]
  }
}

Dokumentationsquellen filtern

Wenn Sie die Dokumentationsquellen einschränken möchten, die zum Generieren der Antwort verwendet werden, übergeben Sie einen Filter ausdruck mit dem --query-filter Flag in der gcloud CLI oder dem filter Feld im Anfragetext Ihrer REST-Anfrage. Weitere Informationen zu unterstützten Filterfeldern und -operatoren finden Sie unter Suchergebnisse filtern.

Im folgenden Beispiel werden die Dokumentationsquellen auf docs.cloud.google.com beschränkt:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?" \
  --query-filter='data_source = "docs.cloud.google.com"'

REST

curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "How do I create a BigQuery dataset?",
    "filter": "data_source = \"docs.cloud.google.com\""
  }'

Zwischen AnswerQuery und SearchDocumentChunks wählen

Wenn Sie die API oder den Developer Knowledge MCP-Server verwenden, wählen Sie die Methode aus, die am besten zu Ihren Anforderungen passt:

  • AnswerQuery (oder das MCP-Tool answer_query): Am besten geeignet für allgemeine Fragen zu Anleitungen, Produktvergleiche und detaillierte Anleitungen, bei denen Sie eine vollständige Zusammenfassung mit Links zu den Quelldokumenten wünschen.
  • SearchDocumentChunks (oder das MCP-Tool search_documents): Am besten geeignet, um nach genauen CLI-Flags, Codesyntax, Parameternamen oder IAM-Berechtigungen (z. B. service.resource.verb) zu suchen. Verwenden Sie zwei bis fünf bestimmte Keywords anstelle einer vollständigen Frage.

Nächste Schritte