Guide de démarrage rapide : Premiers pas avec l'API Developer Knowledge

Ce guide vous explique comment commencer à utiliser l'API Developer Knowledge. Vous allez apprendre à activer l'API Developer Knowledge, à obtenir une clé API et à effectuer vos premiers appels d'API pour rechercher et récupérer de la documentation pour les développeurs.

Avant de commencer

Avant de commencer à utiliser l'API Developer Knowledge, assurez-vous d'avoir effectué les étapes suivantes.

Activer l'API

  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.

Créer et sécuriser la clé API

  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.

Répondre à une requête avec la génération ancrée

Une fois que vous avez votre clé API Developer Knowledge, vous pouvez commencer à utiliser l'API. L'exemple suivant montre comment poser une question et obtenir une réponse basée sur la documentation :

  1. Enregistrez votre clé API Developer Knowledge dans une variable d'environnement :

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Remplacez YOUR_API_KEY par la clé API que vous avez générée.

  2. Utilisez curl pour appeler le point de terminaison AnswerQuery :

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Cette commande renvoie une réponse à votre requête basée sur la documentation.

Rechercher des blocs de document

Si vous souhaitez trouver des extraits de documentation spécifiques plutôt qu'une réponse générée, vous pouvez rechercher directement des blocs de documents.

Utilisez curl pour appeler le point de terminaison SearchDocumentChunks :

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

La réponse inclut des blocs de contenu correspondants issus de la documentation et des références aux documents parents.

Récupérer un document

La réponse de searchDocumentChunks contient une liste de blocs de documents. Chaque bloc de document comporte un champ parent contenant le nom de ressource du document, que vous pouvez utiliser avec GetDocument pour récupérer l'intégralité du contenu du document.

Pour récupérer un document, copiez le champ parent de l'un des blocs renvoyés par searchDocumentChunks et enregistrez-le dans une variable d'environnement, puis utilisez curl pour appeler le point de terminaison GetDocument :

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Cette méthode renvoie le contenu Markdown complet du document spécifié.

Étape suivante