Developer Knowledge API は、Google の公開デベロッパー ドキュメントへのプログラムによるアクセスを提供します。これにより、このナレッジベースを独自のアプリケーションやワークフローに統合できます。
概要
Developer Knowledge API は、Google のデベロッパー向けドキュメントへの機械可読アクセス用の正規ソースとなるように設計されています。ドキュメントの検索と取得、クエリへの回答を行う関数が用意されています。
SearchDocumentChunksクエリに基づいて関連するページ URI とコンテンツ スニペットを見つけます。GetDocumentまたはBatchGetDocumentsを使用して、検索結果のコンテンツ全体を取得します。AnswerQueryを使用して、ドキュメント コーパスから抽出されたクエリに対する回答を生成します。
すぐに始めるには、クイックスタート ガイドに沿って操作してください。
検索可能なコンテンツのコーパスは、コーパス リファレンスに記載されています。
Developer Knowledge API は、非構造化 Markdown コンテンツとしてドキュメント ページを検索して取得することをサポートしています。
API を有効にする
Developer Knowledge API を使用するには、まず Google Cloud プロジェクトで API を有効にする必要があります。
- Google API ライブラリで Developer Knowledge API ページを開きます。
- API を使用するプロジェクトが正しく選択されていることを確認します。
- [有効にする] をクリックします。API を有効または使用するために、特定の IAM ロールは必要ありません。
認証
Developer Knowledge API へのリクエストは、次のいずれかの方法で認証できます。
- API キー:
keyクエリ パラメータまたはX-Goog-Api-Keyヘッダーを使用して、直接 REST リクエストを認証します。例については、REST クイックスタートをご覧ください。 - アプリケーションのデフォルト認証情報（ADC）、OAuth 2.0、またはサービス アカウント: 公式のクライアント ライブラリまたは本番環境のワークフローを使用する場合にリクエストを認証します。認証情報の設定の詳細については、アプリケーションのデフォルト認証情報のドキュメントをご覧ください。
含まれるドキュメント
API で検索されるドキュメントについては、コーパス リファレンスをご覧ください。
Developer Knowledge API は、最新の Google デベロッパー ドキュメントへのアクセスを提供することを目的としています。Google の目標は、公開後 48 時間以内にコンテンツのインデックスを再作成し、新しいドキュメントや更新されたドキュメントを 2 営業日以内に利用できるようにすることです。既知の制限事項
- マークダウンの品質: マークダウンはソース HTML から生成されます。不一致や形式の問題が発生する可能性があります。
- コンテンツの範囲: コーパス リファレンスの公開ページのみが含まれます。GitHub、OSS サイト、ブログ、YouTube などの他のソースのコンテンツは含まれません。