Developer Knowledge API を使用すると、Google の公開デベロッパー ドキュメントにプログラムでアクセスできます。これにより、このナレッジベースを独自のアプリケーションやワークフローに統合できます。
概要
Developer Knowledge API は、Google のデベロッパー向けドキュメントへの機械可読アクセス用の正規ソースとなるように設計されています。主な機能は次の 2 つです。
SearchDocumentChunksを使用して、クエリに基づいて関連するページの URI とコンテンツ スニペットを見つけます。GetDocumentまたはBatchGetDocumentsを使用して、検索結果の全コンテンツを取得します。
すぐに始めるには、クイックスタート ガイドに沿って操作してください。
検索可能なコンテンツのコーパスは、コーパス リファレンスに記載されています。
プレビューに関する注: このプレビュー リリースでは、非構造化マークダウン コンテンツとしてドキュメント ページの検索と取得がサポートされています。
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 キーを作成しました] ダイアログに、新しく作成されたキーの文字列が表示されます。
- [API キーを編集] をクリックします。
- [名前] フィールドに、鍵の名前を入力します。
- [API の制限] で [キーを制限] を選択します。
-
[API を選択] リストで、[Developer Knowledge API] を有効にして、[OK] をクリックします。
- 注: Developer Knowledge API を有効にしたばかりの場合、[API を選択] リストに表示されるまでに遅延が生じることがあります。
- [保存] をクリックします。
この Developer Knowledge API キーをリクエストに含めます。たとえば、REST 呼び出しでは、key クエリ パラメータを使用して含める必要があります。例については、クイックスタート ガイドをご覧ください。
含まれるドキュメント
API で検索されるドキュメントについては、コーパス リファレンスをご覧ください。
既知の制限事項
- Markdown の品質: Markdown はソース HTML から生成されます。不一致や形式の問題が発生する可能性があります。
- コンテンツの範囲: コーパス リファレンスの公開ページのみが含まれます。GitHub、OSS サイト、ブログ、YouTube などの他のソースのコンテンツは含まれません。