Developer Knowledge API

Developer Knowledge API を使用すると、Google の公開デベロッパー ドキュメントにプログラムでアクセスし、このナレッジベースを独自のアプリケーションやワークフローに統合できます。

概要

Developer Knowledge API は、Google のデベロッパー ドキュメントに機械可読形式でアクセスするための正規のソースとなるように設計されています。ドキュメントの検索と取得、クエリへの回答を行う関数を提供します。

  • SearchDocumentChunks : クエリに基づいて関連するページ URI とコンテンツ スニペットを検索します。
  • GetDocument または BatchGetDocuments : 検索結果の完全なコンテンツを取得します。
  • AnswerQuery : ドキュメント コーパスに基づいてクエリへの回答を取得します。

すぐに始めるには、クイックスタート ガイドに沿って操作してください。

検索可能なコンテンツのコーパスは、コーパス リファレンスに記載されています。

Developer Knowledge API は、ドキュメント ページを構造化されていない Markdown コンテンツとして検索して取得することをサポートしています。

API を有効にする

Developer Knowledge API を使用するには、まず Google Cloud プロジェクトで有効にする必要があります。

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

認証

Developer Knowledge API を使用するには、Developer Knowledge API キーが必要です。作成するには:

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

この Developer Knowledge API キーをリクエストに含めます。たとえば、REST 呼び出しでは、key クエリ パラメータを使用して含める必要があります。例については、 クイックスタート ガイドをご覧ください。

含まれるドキュメント

API で検索されるドキュメントについては、コーパス リファレンスで 情報をご覧ください。

既知の制限事項