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 obtenir des réponses à des requêtes basées sur le corpus de documentation.

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

Le corpus de contenu exploitable par la recherche est listé dans 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.

  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.
  3. Dans le champ Nom, indiquez un nom pour la clé.
  4. Cliquez sur le menu déroulant Sélectionner des restrictions d'API, puis saisissez API Developer Knowledge. Cliquez sur le résultat, puis sur OK.
    • Remarque : Si vous venez d'activer l'API Developer Knowledge, il peut y avoir un délai avant qu'elle n'apparaisse dans la liste. Patientez quelques minutes, puis réessayez.
  5. Cliquez sur Créer.

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 référence du corpus pour savoir quels documents sont recherchés par l'API.

Limites connues

  • Qualité du code Markdown : le code 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. Le contenu provenant d'autres sources, comme GitHub, les sites OSS, les blogs ou YouTube, n'est pas inclus.