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.

Pour commencer rapidement, suivez le guide de démarrage rapide.

Le corpus de contenu pouvant être recherché est listé dans la référence du corpus.

L'API Developer Knowledge permet de rechercher et de récupérer des pages de documentation sous forme de contenu Markdown non structuré.

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 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 à l'aide du paramètre de requête key ou de l'en-tête X-Goog-Api-Key. Pour obtenir un exemple, consultez le guide de démarrage rapide REST.
• 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.

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.