API Developer Knowledge

L'API Developer Knowledge fournit un accès programmatique à la documentation pour les développeurs publique de Google, ce qui vous permet d'intégrer cette base de connaissances à vos propres applications et workflows.

Présentation

L'API Developer Knowledge est conçue pour être la source canonique d'accès lisible par machine à la documentation de Google pour les développeurs. Elle propose des fonctions permettant de rechercher et de récupérer des documents, et de répondre à des requêtes :

  • SearchDocumentChunks pour trouver des URI de pages et des extraits de contenu pertinents en fonction d'une requête.
  • GetDocument ou BatchGetDocuments pour récupérer l'intégralité du contenu du ou des résultats de recherche.
  • AnswerQuery pour générer des réponses aux requêtes extraites du corpus de documentation.

L'API Developer Knowledge permet de rechercher et de récupérer des pages de documentation sous forme de contenu Markdown non structuré. Le corpus de contenu interrogeable est listé dans la documentation de référence du corpus.

Utiliser Developer Knowledge

Vous pouvez accéder à Developer Knowledge via les surfaces suivantes, en fonction de votre workflow :

  • API REST et API RPC : appelez directement les points de terminaison HTTP ou gRPC. Pour connaître les spécifications des méthodes, consultez la documentation de référence REST et RPC.
  • Bibliothèques clientes : intégrez l'API Developer Knowledge à vos applications à l'aide des bibliothèques clientes officielles pour C#, Go, Java, Node.js et TypeScript, PHP, Python et Ruby.
  • Google Cloud CLI (gcloud): exécutez gcloud developer-knowledge commandes depuis votre terminal pour rechercher des blocs de documents, récupérer du contenu Markdown et générer des réponses.
  • Serveur MCP Developer Knowledge : connectez votre assistant de codage ou agent IA à la documentation de Google à l'aide des outils MCP (Model Context Protocol) (search_documents, get_documents, et answer_query). Consultez la documentation de référence MCP.

Choisir entre l'API et le serveur MCP

L'API Developer Knowledge et le serveur MCP Developer Knowledge sont conçus pour répondre à différents besoins d'intégration :

  • Utilisez l'API Developer Knowledge, les bibliothèques clientes ou gcloud CLI lorsque :
    • Votre projet n'utilise pas d'agent IA.
    • Vous souhaitez définir des outils ou des ensembles d'outils personnalisés pour votre agent.
    • Vous souhaitez traiter ou combiner des résultats avant de les transmettre à un modèle (par exemple, vérifier la longueur en octets d'un document avant de récupérer l'intégralité de son contenu).
    • Vous devez filtrer les résultats de recherche (par exemple, par data_source ou update_time) ou appliquer des masques de champ.
  • Utilisez le serveur MCP Developer Knowledge et la compétence d'agent lorsque :
    • Vous souhaitez connecter un assistant de codage ou un agent IA sans écrire de définitions ni de descriptions d'outils personnalisées.
    • Vous souhaitez bénéficier de mises à jour automatiques à mesure que le serveur MCP Developer Knowledge ajoute de nouvelles fonctionnalités.
    • Vous n'avez pas besoin de filtrage de métadonnées personnalisé sur les résultats de recherche.

Activer l'API

Pour utiliser l'API Developer Knowledge, vous devez d'abord l'activer pour votre projet Google Cloud.

  1. Ouvrez la page de l'API Developer Knowledge dans la bibliothèque Google APIs.
  2. Vérifiez que le projet dans lequel vous souhaitez utiliser l'API est sélectionné.
  3. Cliquez sur Activer. Aucun rôle IAM spécifique n'est requis pour activer ou utiliser l' API.

Authentification

Vous pouvez authentifier les requêtes adressées à l'API Developer Knowledge à l'aide de l'une des méthodes suivantes :

Champs d'application OAuth

Lors de l'authentification avec OAuth 2.0 ou des comptes de service, l'API Developer Knowledge et le serveur MCP Developer Knowledge acceptent les champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform: champ d'application par défaut utilisé par les identifiants par défaut de l'application (ADC), gcloud CLI et les bibliothèques clientes officielles de Google Cloud.
  • https://www.googleapis.com/auth/devprofiles.full_control: champ d'application utilisé pour les flux de consentement OAuth 2.0 des utilisateurs et les intégrations de serveurs MCP.
  • https://www.googleapis.com/auth/developerprofiles.readonly: champ d'application en lecture seule compatible avec les comptes de service et les identifiants qui ne nécessitent pas d'écran de consentement OAuth de l'utilisateur final.

Autorisation des jetons de support

Pour authentifier les requêtes REST directes avec un compte de service ou un jeton d'accès OAuth 2.0, transmettez le jeton dans l'en-tête Authorization: Bearer et spécifiez votre projet de facturation dans X-Goog-User-Project :

export ACCESS_TOKEN=$(gcloud auth print-access-token)
curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Remplacez PROJECT_ID par l'ID de votre projet Google Cloud.

Pour les applications Python, Node.js, Go et Java, les bibliothèques clientes officielles gèrent automatiquement les identifiants par défaut de l'application (ADC) et les actualisations de jetons. Pour obtenir des exemples, consultez Utiliser des bibliothèques clientes avec l' API Developer Knowledge.

Documentation incluse

Pour savoir quels documents sont recherchés par l'API, consultez la documentation de référence du corpus.

L'API Developer Knowledge vise à fournir un accès à la dernière documentation de Google pour les développeurs. Notre objectif est de réindexer le contenu dans les 48 heures suivant sa publication afin que la documentation nouvelle ou mise à jour soit disponible dans les deux jours ouvrés.

Limites connues

  • Qualité Markdown : le Markdown est généré à partir du code HTML source. Il peut y avoir des différences ou des problèmes de mise en forme.
  • Champ d'application du contenu : seules les pages publiques de la documentation de référence du corpus sont incluses. Le contenu provenant d'autres sources, telles que GitHub, les sites OSS, les blogs ou YouTube, n'est pas inclus.