API Developer Knowledge

L'API Developer Knowledge fournit un accès programmatique à la documentation publique pour les développeurs 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 pour les développeurs de Google. 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 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 interrogeable 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 en tant que 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 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

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

  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, saisissez un nom pour la clé.

  4. Cliquez sur le menu déroulant Sélectionner les restrictions liées à l'API, puis saisissez API Developer Knowledge. Cliquez sur le résultat, puis sur OK.

    Remarques :

    • Si vous venez d'activer l'API Developer Knowledge, il est possible qu'elle n'apparaisse pas immédiatement dans la liste. Patientez quelques minutes, puis réessayez.
    • Si vous prévoyez d'utiliser la même clé pour les appels de modèle généraux de votre client d'IA (par exemple, GEMINI_API_KEY), vous devez également sélectionner API Generative Language. Sinon, ces appels seront bloqués.
  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 consulter un exemple, reportez-vous au guide de démarrage rapide.

Documentation incluse

Pour savoir quels documents sont recherchés par l'API, consultez la référence du corpus pour obtenir des informations.

Limites connues

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