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 page 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 ou agent d'assistance au codage 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.

Conseil : Si vous utilisez un assistant de codage IA, installez la retrieving-developer-knowledge compétence d'agent 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 gestion des erreurs et sur l'appel de l'API REST avec curl si le serveur MCP n'est pas disponible. Pour en savoir plus, consultez Utiliser la compétence d'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 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 ou agent d'assistance au 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 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.

**Conseil** : 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 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 :

• 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

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 ouvrables.

Limites connues

• Qualité Markdown : le format 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.