快速入門導覽課程：開始使用 Developer Knowledge API

本指南說明如何開始使用 Developer Knowledge API。您將瞭解如何啟用 Developer Knowledge API、取得 API 金鑰，以及發出第一個 API 呼叫，搜尋及擷取開發人員說明文件。

事前準備

開始使用 Developer Knowledge API 前，請務必完成下列步驟。

啟用 API

  1. 在 Google API 程式庫中開啟 Developer Knowledge API 頁面。
  2. 確認您已選取要使用 API 的正確專案。
  3. 按一下「啟用」。啟用或使用 API 時，不需要特定的 IAM 角色。

建立及保護 API 金鑰

  1. 在 Google Cloud 控制台中，前往已啟用 API 的專案，然後前往「憑證」頁面。
  2. 按一下「建立憑證」，然後從選單中選取「API 金鑰」。
  3. 在「Name」欄位中，輸入金鑰名稱。
  4. 按一下「選取 API 限制」下拉式選單，然後輸入「Developer Knowledge API」。按一下結果，然後按一下「確定」。
    • 注意：如果您剛啟用 Developer Knowledge API，可能要過一段一段時間才會顯示在清單中。請稍候片刻，然後再試一次。
  5. 點選「建立」。

根據資料生成答案來回覆查詢

取得 Developer Knowledge API 金鑰後，即可開始使用 API。以下範例說明如何提出查詢，並根據文件取得答案：

  1. 將 Developer Knowledge API 金鑰儲存至環境變數：

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    將 YOUR_API_KEY 替換為您產生的 API 金鑰。

  2. 使用 curl 呼叫 AnswerQuery 端點：

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

這項指令會根據文件傳回查詢的答案。

搜尋文件區塊

如果想尋找特定文件片段，而非生成的答案，可以直接搜尋文件區塊。

使用 curl 呼叫 SearchDocumentChunks 端點：

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

回覆內容會包含文件中的相符內容區塊，以及父項文件的參照。

擷取文件

searchDocumentChunks 的回覆包含文件區塊清單。每個文件區塊都有 parent 欄位，內含文件的資源名稱，可用於 GetDocument 擷取文件的完整內容。

如要擷取文件，請從 searchDocumentChunks 傳回的其中一個區塊複製 parent 欄位，並儲存至環境變數，然後使用 curl 呼叫 GetDocument 端點：

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

這會傳回指定文件的完整 Markdown 內容。

後續步驟