API Developer Knowledge

L'API Developer Knowledge fournit un accès programmatique à la documentation publique de Google pour les développeurs. Vous pouvez ainsi 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 à la documentation Google pour les développeurs, lisible par machine. Il 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 issues 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 pouvant faire l'objet d'une recherche est listé dans la référence du corpus.

Comment utiliser les connaissances pour les développeurs

Vous pouvez accéder aux connaissances pour les développeurs sur les surfaces suivantes, en fonction de votre workflow :

• API REST et API RPC : appelez directement les points de terminaison HTTP ou gRPC. Pour en savoir plus sur les spécifications des méthodes, consultez la documentation de référence REST et la documentation de référence RPC.
• Bibliothèques clientes : intégrez l'API Developer Knowledge à vos applications à l'aide de bibliothèques clientes officielles pour Python, Node.js et TypeScript, Go, Java, PHP et Ruby.
• Google Cloud CLI (gcloud) : exécutez les commandes gcloud developer-knowledge 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 ou agent de programmation IA à la documentation Google à l'aide des outils MCP (Model Context Protocol) (search_documents, get_documents et answer_query). Consultez la référence MCP.

Conseil : Si vous utilisez un assistant de codage IA, installez la compétence d'agent retrieving-developer-knowledge en exécutant npx skills add google/skills --skill retrieving-developer-knowledge. Cette compétence fournit à votre assistant des instructions intégrées sur l'outil de serveur MCP Developer Knowledge à choisir, sur la façon de gérer les erreurs et sur la façon d'appeler l'API REST avec curl si le serveur MCP n'est pas disponible. Pour en savoir plus, consultez Utiliser la compétence de l'agent Developer Knowledge.

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 d'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 d'en récupérer le contenu complet).
  • 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 de l'agent lorsque :
  • Vous souhaitez connecter un assistant ou un agent de codage 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 filtrer les résultats de recherche à l'aide de métadonnées personnalisées.

Activer l'API

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

Remarque : Si vous n'avez pas de projet Google Cloud, créez-en un en suivant les instructions de Google Cloud ou Firebase.

1. Ouvrez la page de l'API Developer Knowledge dans la bibliothèque des API Google.
2. Vérifiez que vous avez sélectionné le bon projet dans lequel vous prévoyez d'utiliser l'API.
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 envoyées à l'API Developer Knowledge à l'aide de l'une des méthodes suivantes :

• Clé API : authentifiez les requêtes REST directes ou le serveur MCP Developer Knowledge à l'aide du paramètre de requête key ou de l'en-tête X-Goog-Api-Key.
• Identifiants par défaut de l'application (ADC), OAuth 2.0 ou comptes de service : authentifiez les requêtes lorsque vous utilisez les bibliothèques clientes officielles ou les workflows de production. Pour en savoir plus sur la configuration des identifiants, consultez la documentation sur les identifiants par défaut de l'application.
• Identifiants utilisateur (gcloud CLI) : authentifiez les requêtes CLI en vous connectant à votre compte Google Cloud avec gcloud auth login. Pour obtenir des instructions de configuration, consultez le guide de démarrage rapide de gcloud CLI.

Documentation incluse

Consultez la documentation de référence sur le corpus pour savoir quels documents sont recherchés par l'API.

L'API Developer Knowledge vise à fournir un accès à la documentation Google Developers la plus récente. 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 écarts ou des problèmes de mise en forme.
• Champ d'application du contenu : seules les pages publiques de la référence du corpus sont incluses. Les contenus provenant d'autres sources, comme GitHub, les sites OSS, les blogs ou YouTube, ne sont pas inclus.