透過 Developer Knowledge API,您可以透過程式輔助方式存取 Google 的公開開發人員說明文件,將這個知識庫整合至自己的應用程式和工作流程。
總覽
Developer Knowledge API 的設計宗旨,是成為 Google 開發人員說明文件的正規來源,提供機器可讀取的存取權。這項服務提供兩項主要功能:
SearchDocumentChunks根據查詢內容尋找相關網頁 URI 和內容摘要。GetDocument或BatchGetDocuments即可擷取搜尋結果的完整內容。
如要快速上手,請按照快速入門指南操作。
可搜尋內容的語料庫列於「語料庫參考資料」。
預先發布版注意事項:這個預先發布版本支援以非結構化 Markdown 內容搜尋及擷取說明文件頁面。
啟用 API
如要使用 Developer Knowledge API,請先為 Google Cloud 雲端專案啟用這項功能。
- 在 Google API 程式庫中開啟 Developer Knowledge API 頁面。
- 確認您已選取要使用 API 的正確專案。
- 按一下「啟用」。啟用或使用 API 時,不需要特定的 IAM 角色。
驗證
您必須擁有 Developer Knowledge API 金鑰,才能使用 Developer Knowledge API。如要建立一個,請按照下列步驟操作:
- 在 Google Cloud 控制台中,前往已啟用 API 的專案,然後前往「憑證」頁面。
- 按一下「建立憑證」,然後從選單中選取「API 金鑰」。「建立的 API 金鑰」對話方塊會顯示新建立的金鑰字串。
- 點選「編輯 API 金鑰」。
- 在「Name」欄位中,輸入金鑰名稱。
- 在「API restrictions」下方,選取「Restrict key」。
-
從「選取 API」清單中啟用「Developer Knowledge API」,然後按一下「確定」。
- 注意:如果您剛啟用 Developer Knowledge API,可能要過一段時間才會顯示在「選取 API」清單中。
- 按一下 [儲存]。
在要求中加入這個 Developer Knowledge API 金鑰。舉例來說,REST 呼叫應使用 key 查詢參數納入這項資訊。如需範例,請參閱快速入門指南。
隨附文件
如要瞭解 API 會搜尋哪些文件,請參閱語料庫參考資料。
已知限制
- Markdown 品質:Markdown 是從來源 HTML 產生,可能會有部分差異或格式問題。
- 內容範圍:只會納入語料庫參考資料中的公開頁面。不包括來自其他來源的內容,例如 GitHub、OSS 網站、網誌或 YouTube。