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 Anfragen:

• SearchDocumentChunks zum Suchen nach relevanten Seiten-URIs und Content-Snippets basierend auf einer Anfrage.
• GetDocument oder BatchGetDocuments zum Abrufen des vollständigen Inhalts der Suchergebnisse.
• AnswerQuery zum Generieren von Antworten auf Anfragen aus dem Dokumentationscorpus.

Die Developer Knowledge API unterstützt das Suchen und Abrufen von Dokumentationsseiten als unstrukturierter Markdown-Inhalt. Das Corpus der durchsuchbaren Inhalte ist in der Corpus-Referenz aufgeführt.

Möglichkeiten zur Verwendung von Developer Knowledge

Je nach Workflow können Sie über die folgenden Oberflächen auf Developer Knowledge zugreifen:

• REST API und RPC API: Rufen Sie die HTTP- oder gRPC-Endpunkte direkt auf. Die Methodenspezifikationen finden Sie in der REST-Referenz und RPC-Referenz.
• Clientbibliotheken: Binden Sie die Developer Knowledge API mithilfe der offiziellen Clientbibliotheken für C#, Go, Java, Node.js und TypeScript, PHP, Python und Ruby in Ihre Anwendungen ein.
• Google Cloud CLI (gcloud): Führen Sie gcloud developer-knowledge Befehle über das Terminal aus, um nach Dokument-Chunks zu suchen, Markdown-Inhalte abzurufen und Antworten zu generieren.
• MCP-Server für Entwicklerwissen: Verbinden Sie Ihren KI-Codierungsassistenten oder -Agenten mit der Dokumentation von Google mithilfe von MCP-Tools (Model Context Protocol) (search_documents, get_documents, und answer_query). Weitere Informationen finden Sie in der MCP-Referenz.

Tipp: Wenn Sie einen KI-Codierungsassistenten verwenden, installieren Sie die retrieving-developer-knowledge Agent-Fähigkeit, indem Sie npx skills add google/skills --skill retrieving-developer-knowledge ausführen. Diese Fähigkeit enthält integrierte Anweisungen für Ihren Assistenten, welches MCP-Servertool für Entwicklerwissen ausgewählt werden soll, wie Fehler behandelt werden und wie die REST API mit curl aufgerufen wird, wenn der MCP-Server nicht verfügbar ist. Weitere Informationen finden Sie unter Agent-Fähigkeit für Entwicklerwissen verwenden.

Zwischen der API und dem MCP-Server wählen

Die Developer Knowledge API und der MCP-Server für Entwicklerwissen sind für unterschiedliche Integrationsanforderungen konzipiert:

• Verwenden Sie die Developer Knowledge API, Clientbibliotheken oder die gcloud CLI in folgenden Fällen:
  • Ihr Projekt verwendet keinen KI-Agenten.
  • Sie möchten benutzerdefinierte Tools oder Toolsets für Ihren Agenten definieren.
  • Sie möchten Ergebnisse verarbeiten oder kombinieren, bevor Sie sie an ein Modell übergeben (z. B. die Byte-Länge des Dokuments prüfen, bevor Sie den vollständigen Inhalt abrufen).
  • Sie müssen Suchergebnisse filtern (z. B. nach data_source oder update_time) oder Feldmasken anwenden .
• Verwenden Sie den MCP-Server für Entwicklerwissen und die Agent-Fähigkeit in folgenden Fällen:
  • Sie möchten einen KI-Assistenten oder -Agenten für die Unterstützung beim Programmieren verbinden, ohne benutzerdefinierte Tooldefinitionen und -beschreibungen zu schreiben.
  • Sie möchten automatische Updates, wenn der MCP-Server für Entwicklerwissen neue Funktionen hinzufügt.
  • Sie benötigen keine benutzerdefinierte Metadatenfilterung für Suchergebnisse.

API aktivieren

Wenn Sie die Developer Knowledge API verwenden möchten, müssen Sie sie zuerst für Ihr Google Cloud-Projekt aktivieren.

Tipp: Wenn Sie kein Google Cloud-Projekt haben, erstellen Sie eines gemäß der Anleitung für Google Cloud oder Firebase.

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

Sie können Anfragen an die Developer Knowledge API mit einer der folgenden Methoden authentifizieren:

• API-Schlüssel: Authentifizieren Sie direkte REST-Anfragen oder den MCP-Server für Entwicklerwissen mit dem Abfrageparameter key oder dem X-Goog-Api-Key Header.
• Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC), OAuth 2.0 oder Dienstkonten: Authentifizieren Sie Anfragen bei Verwendung der offiziellen Clientbibliotheken oder Produktions workflows. Weitere Informationen zum Einrichten von Anmeldedaten finden Sie in der Dokumentation zu Standardanmeldedaten für Anwendungen.
• Nutzeranmeldedaten (gcloud CLI): Authentifizieren Sie CLI-Anfragen, indem Sie sich mit Ihrem Google Cloud-Konto anmelden mit gcloud auth login. Eine Anleitung zur Einrichtung finden Sie in der Kurzanleitung zur gcloud CLI.

Enthaltene Dokumentation

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

Die Developer Knowledge API soll Zugriff auf die neueste Entwicklerdokumentation von Google bieten. Wir versuchen, Inhalte innerhalb von 48 Stunden nach der Veröffentlichung neu zu indexieren, damit neue oder aktualisierte Dokumentation innerhalb von zwei Arbeitstagen verfügbar ist.

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.