Kurzanleitung: Erste Schritte mit der Developer Knowledge API

In dieser Anleitung erfahren Sie, wie Sie die Developer Knowledge API verwenden. Sie lernen, wie Sie die Developer Knowledge API aktivieren, einen API-Schlüssel abrufen und Ihre ersten API-Aufrufe ausführen, um nach Entwicklerdokumentation zu suchen und sie abzurufen.

Hinweis

Bevor Sie die Developer Knowledge API verwenden, führen Sie die folgenden Schritte aus.

API aktivieren

  1. Öffnen Sie die Seite Developer Knowledge API in der Google APIs-Bibliothek.
  2. Prüfen Sie, ob das richtige Projekt ausgewählt ist, in dem Sie die API verwenden möchten.
  3. Klicken Sie auf Aktivieren. Zum Aktivieren oder Verwenden der API sind keine bestimmten 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 API-Einschränkungen auswählen Drop-down-Menü, 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 noch einmal.
  5. Klicken Sie auf Erstellen.

Abgesicherte Generierung zum Beantworten einer Anfrage verwenden

Sobald Sie Ihren Developer Knowledge API-Schlüssel haben, können Sie die API verwenden. Im folgenden Beispiel wird gezeigt, wie Sie eine Anfrage 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. Rufen Sie mit curl den Endpunkt AnswerQuery auf:

    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 basierend auf der Dokumentation zurück.

Nach Dokumentblöcken suchen

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

Rufen Sie mit curl den Endpunkt SearchDocumentChunks auf:

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

Die Antwort enthält übereinstimmende 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. Mit GetDocument können Sie den vollständigen Inhalt des Dokuments abrufen.

Kopieren Sie zum Abrufen eines Dokuments das Feld parent aus einem der von searchDocumentChunks zurückgegebenen Blöcke und speichern Sie es in einer Umgebungsvariablen. Rufen Sie dann mit curl den Endpunkt GetDocument 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