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 lisible par machine à la documentation pour les développeurs de Google. Elle offre deux fonctions principales :

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

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

Le corpus de contenu exploitable par la recherche est listé dans la référence du corpus.

Remarque pour la version bêta : Cette version bêta 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.

  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 souhaitez utiliser l'API.
  3. Cliquez sur Activer. Aucun rôle IAM spécifique n'est requis pour activer ou utiliser l'API.

Authentification

Une clé API Developer Knowledge est requise pour utiliser l'API Developer Knowledge. Pour en créer un :

  1. Dans la console Google Cloud du projet dans lequel vous avez activé l'API, accédez à la page Identifiants.
  2. Cliquez sur Créer des identifiants, puis sélectionnez Clé API dans le menu. La boîte de dialogue "Clé API créée" affiche la chaîne correspondant à la clé que vous venez de créer.
  3. Cliquez sur Modifier la clé API.
  4. Dans le champ Nom, indiquez un nom pour la clé.
  5. Sous API restrictions (Restrictions liées à l'API), sélectionnez Restrict key (Restreindre la clé).
  6. Dans la liste Sélectionner des API, activez l'API Developer Knowledge, puis cliquez sur OK.
    • Remarque : Si vous venez d'activer l'API Developer Knowledge, il est possible qu'un délai soit nécessaire avant qu'elle n'apparaisse dans la liste Sélectionner des API.
  7. Cliquez sur Enregistrer.

Incluez cette clé API Developer Knowledge dans vos requêtes. Par exemple, les appels REST doivent l'inclure à l'aide du paramètre de requête key. Pour obtenir un exemple, consultez le guide de démarrage rapide.

Documentation incluse

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

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.