透過 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 開發人員說明文件。我們的目標是在發布內容後 48 小時內重新建立索引,以便在 2 個工作天內提供新版或更新版文件。已知限制
- Markdown 品質:Markdown 是從來源 HTML 產生,可能會有差異或格式問題。
- 內容範圍:只會納入語料庫參考資料中的公開頁面。不含來自其他來源的內容,例如 GitHub、OSS 網站、網誌或 YouTube。