ドキュメントから回答を生成する

Developer Knowledge API を使用すると、Google Developers プロダクトについて質問し、自然言語で直接回答を得ることができます。クエリごとに、API は Developer Knowledge コーパス（API リファレンスでは グラウンディングされた生成と呼びます）から抽出したレスポンスを作成し、関連するドキュメント ページへの引用を含めます。

始める前に

使用するツールに合わせて環境を設定します。

gcloud

gcloud CLI をインストールして構成し、Developer Knowledge API を有効にします。

REST

API を有効にして、Developer Knowledge API キーを生成します。 次に、キーを環境変数に保存します。

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

YOUR_API_KEY は実際の Developer Knowledge API キーに置き換えてください。

クエリに回答する

gcloud developer-knowledge answer-query コマンドまたは answerQuery REST メソッド を使用して質問します。

次の例では、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?"}'

レスポンスには、answer.answerText フィールドにテキスト回答が含まれ、 citations と references が answer オブジェクトに含まれます。

{
  "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"
            }
          }
        }
      }
    ]
  }
}

ドキュメント ソースをフィルタする

回答の生成に使用するドキュメント ソースを制限するには、フィルタ 式を渡します。gcloud CLI で --query-filter フラグを使用するか、REST リクエストの本文で filter フィールドを使用します。サポートされているフィルタ フィールド と演算子の詳細については、 検索結果をフィルタするをご覧ください。

次の例では、ドキュメント ソースを 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\""
  }'

AnswerQuery と SearchDocumentChunks のどちらかを選択する

API または Developer Knowledge MCP サーバーを使用する場合は、探しているものに最適な方法を選択します。

  • AnswerQuery （または answer_query MCP ツール）: 一般的な How-to に関する質問、プロダクトの比較、ソースドキュメントへのリンクを含む完全な概要が必要な手順ガイドに最適です。
  • SearchDocumentChunks （または search_documents MCP ツール）: 正確な CLI フラグ、コード構文、パラメータ名、IAM 権限（service.resource.verb など）を検索する場合に最適です。質問全体ではなく、2 ～ 5 個の具体的なキーワードを使用します。

次のステップ