Kurzanleitung: Erste Schritte mit der Developer Knowledge API

In diesem Leitfaden erfahren Sie, wie Sie die Developer Knowledge API verwenden. Sie erfahren, wie Sie die Developer Knowledge API aktivieren, einen API-Schlüssel abrufen und Ihre ersten API-Aufrufe zum Suchen und Abrufen von Entwicklerdokumentation ausführen.

Hinweis

Bevor Sie die Developer Knowledge API verwenden, müssen Sie die folgenden Schritte ausführen.

API aktivieren

  1. Öffnen Sie in der Google APIs-Bibliothek die Seite zur Developer Knowledge API.
  2. Prüfen Sie, ob Sie das richtige Projekt ausgewählt haben, in dem Sie die API verwenden möchten.
  3. Klicken Sie auf Aktivieren. Zum Aktivieren oder Verwenden der API sind keine speziellen IAM-Rollen erforderlich.

API-Schlüssel erstellen und schützen

  1. Rufen Sie in der Google Cloud Console für das Projekt, in dem Sie die API aktiviert haben, die Seite „Anmeldedaten“ auf.
  2. Klicken Sie auf Anmeldedaten erstellen und wählen Sie im Menü API-Schlüssel aus.
  3. Geben Sie im Feld Name einen Namen für den Schlüssel ein.
  4. Klicken Sie auf das Drop-down-Menü API-Einschränkungen auswählen und geben Sie Developer Knowledge API ein. Klicken Sie auf das Ergebnis und dann auf OK.
    • Hinweis: Wenn Sie die Developer Knowledge API gerade erst aktiviert haben, kann es einige Zeit dauern, bis sie in der Liste angezeigt wird. Warten Sie einige Minuten und versuchen Sie es dann noch einmal.
  5. Klicken Sie auf Erstellen.

Eine Anfrage mit fundierter Generierung beantworten

Sobald Sie Ihren Developer Knowledge API-Schlüssel haben, können Sie die API verwenden. Im folgenden Beispiel wird gezeigt, wie Sie eine Frage stellen und eine Antwort erhalten, die auf der Dokumentation basiert:

  1. Speichern Sie Ihren Developer Knowledge API-Schlüssel in einer Umgebungsvariablen:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Ersetzen Sie YOUR_API_KEY durch den generierten API-Schlüssel.

  2. Verwenden Sie curl, um den Endpunkt AnswerQuery aufzurufen:

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

Dieser Befehl gibt eine Antwort auf Ihre Anfrage auf Grundlage der Dokumentation zurück.

Nach Dokumentblöcken suchen

Wenn Sie bestimmte Dokumentationsausschnitte anstelle einer generierten Antwort finden möchten, können Sie direkt nach Dokumentblöcken suchen.

Verwenden Sie curl, um den Endpunkt SearchDocumentChunks aufzurufen:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Die Antwort enthält passende Inhaltsblöcke aus der Dokumentation und Verweise auf die übergeordneten Dokumente.

Dokument abrufen

Die Antwort von searchDocumentChunks enthält eine Liste von Dokumentblöcken. Jeder Dokumentblock hat ein Feld parent mit dem Ressourcennamen des Dokuments, den Sie mit GetDocument verwenden können, um den vollständigen Inhalt des Dokuments abzurufen.

Um ein Dokument abzurufen, kopieren Sie das Feld parent aus einem der von searchDocumentChunks zurückgegebenen Chunks und speichern Sie es in einer Umgebungsvariablen. Rufen Sie dann den GetDocument-Endpunkt mit curl auf:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Dadurch wird der vollständige Markdown-Inhalt des angegebenen Dokuments zurückgegeben.

Nächste Schritte