Générer des réponses à partir de la documentation

L'API Developer Knowledge vous permet de poser des questions sur les produits Google Developers et de recevoir des réponses directes en langage naturel. Pour chaque requête, l'API compose une réponse tirée du corpus Developer Knowledge (appelée génération ancrée dans la documentation de référence de l'API) et inclut des citations vers les pages de documentation pertinentes.

Avant de commencer

Configurez votre environnement pour l'outil de votre choix :

gcloud

Installez et configurez gcloud CLI, puis activez l'API Developer Knowledge.

REST

Activez l'API et générez une clé API Developer Knowledge. Ensuite, enregistrez votre clé dans une variable d'environnement :

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Remplacez YOUR_API_KEY par votre clé API Developer Knowledge.

Répondre à une requête

Utilisez la gcloud developer-knowledge answer-query commande ou la answerQuery méthode REST pour poser une question.

L'exemple suivant envoie une requête demandant comment créer un ensemble de données BigQuery :

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?"

REST

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

La réponse contient le texte de la réponse dans le answer.answerText champ, ainsi que les citations et les references dans le answer objet :

{
  "answer": {
    "answerText": "To create a BigQuery dataset, you can use the Google Cloud Console, the bq command-line tool, or the BigQuery client libraries.",
    "citations": [
      {
        "startIndex": 0,
        "endIndex": 123,
        "sources": [
          {
            "referenceIndex": 0
          }
        ]
      }
    ],
    "references": [
      {
        "documentReference": {
          "documentChunk": {
            "parent": "documents/docs.cloud.google.com/bigquery/docs/datasets",
            "content": "This page explains how to create BigQuery datasets...",
            "document": {
              "name": "documents/docs.cloud.google.com/bigquery/docs/datasets",
              "title": "Introduction to datasets",
              "uri": "https://docs.cloud.google.com/bigquery/docs/datasets"
            }
          }
        }
      }
    ]
  }
}

Filtrer les sources de documentation

Pour limiter les sources de documentation utilisées pour générer la réponse, transmettez une expression de filtre à l'aide de l'indicateur --query-filter dans gcloud CLI ou du filter champ dans le corps de votre requête REST. Pour en savoir plus sur les champs de filtre compatibles et les opérateurs, consultez Filtrer les résultats de recherche.

L'exemple suivant limite les sources de documentation à docs.cloud.google.com :

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?" \
  --query-filter='data_source = "docs.cloud.google.com"'

REST

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

Choisir entre AnswerQuery et SearchDocumentChunks

Lorsque vous utilisez l'API ou le serveur MCP Developer Knowledge, choisissez la méthode qui correspond le mieux à ce que vous recherchez :

  • AnswerQuery (ou l'outil MCP answer_query) : idéal pour les questions générales de type "comment faire", la comparaison de produits et les guides par étapes où vous souhaitez obtenir un résumé complet avec des liens vers les documents sources.
  • SearchDocumentChunks (ou l'outil MCP search_documents) : idéal pour rechercher des indicateurs CLI exacts, une syntaxe de code, des noms de paramètres ou des autorisations IAM (tels que service.resource.verb). Utilisez deux à cinq mots clés spécifiques au lieu d'une question complète.

Étape suivante