Developer Knowledge API

Die Developer Knowledge API bietet programmatischen Zugriff auf die öffentliche Entwicklerdokumentation von Google. So können Sie diese Wissensdatenbank in Ihre eigenen Anwendungen und Workflows einbinden.

Übersicht

Die Developer Knowledge API ist als kanonische Quelle für den maschinenlesbaren Zugriff auf die Entwicklerdokumentation von Google konzipiert. Sie bietet Funktionen zum Suchen und Abrufen von Dokumenten sowie zum Beantworten von Fragen:

  • SearchDocumentChunks zum Suchen nach relevanten Seiten-URIs und Content-Snippets basierend auf einer Abfrage.
  • GetDocument oder BatchGetDocuments zum Abrufen des vollständigen Inhalts der Suchergebnisse.
  • AnswerQuery zum Abrufen von Antworten auf Fragen, die auf dem Dokumentationscorpus basieren.

Folgen Sie der Kurzanleitung, um schnell loszulegen.

Das Corpus der durchsuchbaren Inhalte ist in der Corpus-Referenz aufgeführt.

Die Developer Knowledge API unterstützt das Suchen und Abrufen von Dokumentationsseiten als unstrukturierte Markdown-Inhalte.

API aktivieren

Bevor Sie die Developer Knowledge API verwenden können, müssen Sie sie für Ihr Google Cloud-Projekt 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.

Authentifizierung

Für die Verwendung der Developer Knowledge API ist ein Developer Knowledge API-Schlüssel erforderlich. So erstellen Sie einen:

  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.

Fügen Sie diesen Developer Knowledge API-Schlüssel in Ihre Anfragen ein. Bei REST-Aufrufen sollte er beispielsweise mit dem Abfrageparameter key angegeben werden. Ein Beispiel finden Sie in der Kurzanleitung.

Enthaltene Dokumentation

In der Corpus-Referenz finden Sie Informationen dazu, in welchen Dokumenten die API sucht.

Bekannte Einschränkungen

  • Markdown-Qualität:Das Markdown wird aus dem Quell-HTML generiert. Es kann zu Abweichungen oder Formatierungsproblemen kommen.
  • Umfang der Inhalte: Es werden nur öffentliche Seiten in der Corpus-Referenz berücksichtigt. Inhalte aus anderen Quellen wie GitHub, OSS-Websites, Blogs oder YouTube sind nicht enthalten.