クイックスタート: Developer Knowledge API を使ってみる

このガイドでは、Developer Knowledge API の使用を開始する方法について説明します。このチュートリアルでは、Developer Knowledge API を有効にして API キーを取得し、最初の API 呼び出しを行ってデベロッパー ドキュメントを検索して取得する方法について説明します。

始める前に

Developer Knowledge API の使用を開始する前に、次の手順を完了してください。

API を有効にする

  1. Google API ライブラリで Developer Knowledge API ページを開きます。
  2. API を使用するプロジェクトが正しく選択されていることを確認します。
  3. [有効にする] をクリックします。API を有効または使用するために、特定の IAM ロールは必要ありません。

API キーを作成して保護する

  1. API を有効にしたプロジェクトの Google Cloud コンソールで、[認証情報ページ] に移動します。
  2. [認証情報を作成] をクリックし、メニューから [API キー] を選択します。
  3. [名前] フィールドに、鍵の名前を入力します。
  4. [API の制限を選択] プルダウンをクリックし、「Developer Knowledge API」と入力します。結果をクリックし、[OK] をクリックします。
    • 注: Developer Knowledge API を有効にしたばかりの場合、リストに表示されるまでに遅延が生じることがあります。数分待ってから、もう一度お試しください。
  5. [作成] をクリックします。

グラウンディングされた生成でクエリに回答する

Developer Knowledge API キーを取得したら、API の使用を開始できます。次の例は、クエリを送信して、ドキュメントに基づく回答を取得する方法を示しています。

  1. Developer Knowledge API キーを環境変数に保存します。

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    YOUR_API_KEY は、生成した API キーに置き換えます。

  2. curl を使用して 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?"}'

このコマンドは、ドキュメントに基づいてクエリの回答を返します。

ドキュメント チャンクを検索する

生成された回答ではなく、特定のドキュメント スニペットを検索する場合は、ドキュメント チャンクを直接検索できます。

curl を使用して SearchDocumentChunks エンドポイントを呼び出します。

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

レスポンスには、ドキュメントから一致するコンテンツのチャンクと、親ドキュメントへの参照が含まれます。

ドキュメントを取得する

searchDocumentChunks からのレスポンスには、ドキュメント チャンクのリストが含まれます。各ドキュメント チャンクには、ドキュメントのリソース名を含む parent フィールドがあります。このフィールドは GetDocument で使用して、ドキュメントの完全なコンテンツを取得できます。

ドキュメントを取得するには、searchDocumentChunks から返されたチャンクのいずれかから parent フィールドをコピーして環境変数に保存し、curl を使用して GetDocument エンドポイントを呼び出します。

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

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

これにより、指定されたドキュメントの完全な Markdown コンテンツが返されます。

次のステップ