Developer Knowledge API は、Google の公開デベロッパー ドキュメントへのプログラムによるアクセスを提供します。これにより、このナレッジベースを独自のアプリケーションやワークフローに統合できます。
概要
Developer Knowledge API は、Google のデベロッパー向けドキュメントへの機械可読アクセス用の正規ソースとなるように設計されています。ドキュメントの検索と取得、クエリへの回答を行う関数を提供します。
SearchDocumentChunksクエリに基づいて関連するページの URI とコンテンツ スニペットを見つけます。GetDocumentまたはBatchGetDocumentsを使用して、検索結果のコンテンツ全体を取得します。AnswerQuery: ドキュメント コーパスに基づくクエリの回答を取得します。
すぐに始めるには、クイックスタート ガイドに沿って操作してください。
検索可能なコンテンツのコーパスは、コーパス リファレンスに記載されています。
Developer Knowledge API は、ドキュメント ページを非構造化マークダウン コンテンツとして検索して取得することをサポートしています。
API を有効にする
Developer Knowledge API を使用するには、まず Google Cloud プロジェクトで API を有効にする必要があります。
- Google API ライブラリで Developer Knowledge API ページを開きます。
- API を使用するプロジェクトが正しく選択されていることを確認します。
- [有効にする] をクリックします。API を有効または使用するために、特定の IAM ロールは必要ありません。
認証
Developer Knowledge API を使用するには、Developer Knowledge API キーが必要です。作成するには:
- API を有効にしたプロジェクトの Google Cloud コンソールで、[認証情報] ページに移動します。
- [認証情報を作成] をクリックし、メニューから [API キー] を選択します。
- [名前] フィールドに、鍵の名前を入力します。
-
[API の制限を選択] プルダウンをクリックし、「Developer Knowledge API」と入力します。結果をクリックし、[OK] をクリックします。
注:
- Developer Knowledge API を有効にしたばかりの場合は、リストに表示されるまでに遅延が生じることがあります。数分待ってから、もう一度お試しください。
-
AI クライアントの一般モデル呼び出し（
GEMINI_API_KEYなど）に同じキーを使用する場合は、[Generative Language API] も選択する必要があります。それ以外の場合、これらの通話はブロックされます。
- [作成] をクリックします。
この Developer Knowledge API キーをリクエストに含めます。たとえば、REST 呼び出しでは、key クエリ パラメータを使用して含める必要があります。例については、クイックスタート ガイドをご覧ください。
含まれるドキュメント
API で検索されるドキュメントについては、コーパス リファレンスをご覧ください。
既知の制限事項
- マークダウンの品質: マークダウンはソース HTML から生成されます。不一致や書式設定の問題が発生する可能性があります。
- コンテンツの範囲: コーパス リファレンスの公開ページのみが含まれます。GitHub、OSS サイト、ブログ、YouTube などの他のソースのコンテンツは含まれません。