建立及管理筆記本 (API)

NotebookLM Enterprise 是一項強大工具，可從文件中生成洞察資訊和摘要。本頁面說明可讓您透過程式執行下列筆記本管理工作的 API：

建立筆記本

如要建立新筆記本，請使用 notebooks.create 方法。

REST

curl -X POST \
  -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks" \
  -d '{
  "title": "NOTEBOOK_TITLE",
  }'

更改下列內容：

  • ENDPOINT_LOCATION：API 要求的適用多區域。指派下列其中一個值：
    • us- 美國多區域
    • 歐盟多區域：eu-
    • global-，即可查看全球位置
    詳情請參閱「為資料儲存庫指定多區域」。
  • PROJECT_NUMBER：您的 Google Cloud 專案編號。
  • LOCATION： 資料存放區的地理位置，例如 global。 詳情請參閱「位置」。
  • NOTEBOOK_TITLE：以 UTF-8 編碼的字串，做為要建立的記事本標題。

如果要求成功，您應該會收到類似以下的 JSON。

{
"title": "NOTEBOOK_TITLE",
"notebookId": "NOTEBOOK_ID",
"emoji": "",
"metadata": {
  "userRole": "PROJECT_ROLE_OWNER",
  "isShared": false,
  "isShareable": true
},
"name": "NOTEBOOK_NAME"
}

注意事項：

  • NOTEBOOK_ID：用於識別所建立筆記本的專屬 ID。您需要筆記本 ID 才能執行其他筆記本管理工作，例如共用或擷取筆記本。
  • NOTEBOOK_NAME：筆記本的完整資源名稱。這個欄位的模式如下： projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID

在瀏覽器中存取已建立的筆記本並取得其 ID

如要使用瀏覽器存取已建立的筆記本並取得其 ID，請按照下列步驟操作。

  1. 前往 NotebookLM Enterprise 首頁，網址如下：

    1. 如果您使用 Google 身分，請前往：

      https://notebooklm.cloud.google.com/LOCATION/?project=PROJECT_NUMBER

    2. 如果使用第三方身分，請前往：

      https://notebooklm.cloud.google/LOCATION/?project=PROJECT_NUMBER

  2. 選取建立的筆記本。所選筆記本的網址格式如下：

    1. 如果您使用 Google 身分：

      https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER

    2. 如果使用第三方身分：

      https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER

  3. 記下網址和記事本 ID，這兩項資訊可用於其他記事本管理工作，例如共用記事本。

擷取筆記本

如要使用筆記本 ID 擷取特定筆記本，請使用 notebooks.get 方法。

REST

curl -X GET \
  -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID"

更改下列內容：

  • ENDPOINT_LOCATION：API 要求的適用多區域。指派下列其中一個值：
    • us- 美國多區域
    • 歐盟多區域：eu-
    • global-，即可查看全球位置
    詳情請參閱「為資料儲存庫指定多區域」。
  • PROJECT_NUMBER：您的 Google Cloud 專案編號。
  • LOCATION： 資料存放區的地理位置，例如 global。 詳情請參閱「位置」。
  • NOTEBOOK_ID：建立筆記本時收到的筆記本專屬 ID。

如果要求成功，您應該會收到類似以下內容的 JSON 回應 (適用於空白記事本)。如果您在將來源新增至記事本後呼叫這個方法，系統會提供所有新增至擷取記事本的來源詳細資料。如果您已設定 CMEK 詳細資料，也會收到筆記本的 CMEK 相關資訊。

{
"title": "NOTEBOOK_TITLE",
"notebookId": "NOTEBOOK_ID",
"emoji": "",
"metadata": {
  "userRole": "PROJECT_ROLE_OWNER",
  "isShared": false,
  "isShareable": true,
  "lastViewed": "LAST_VIEWED_TIME",
  "createTime": "LAST_CREATED_TIME"
},
"name": "NOTEBOOK_NAME"
}

列出最近查看的筆記本

如要取得專案中最近查看的所有筆記本清單，請使用 notebooks.listRecentlyViewed 方法。根據預設，回應會列出最近 500 本筆記本。您可以選擇使用 pageSize 查詢參數，將回覆分頁。

REST

curl -X GET \
  -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks:listRecentlyViewed"

更改下列內容：

  • ENDPOINT_LOCATION：API 要求的適用多區域。指派下列其中一個值：
    • us- 美國多區域
    • 歐盟多區域：eu-
    • global-，即可查看全球位置
    詳情請參閱「為資料儲存庫指定多區域」。
  • PROJECT_NUMBER：您的 Google Cloud 專案編號。
  • LOCATION： 資料存放區的地理位置，例如 global。 詳情請參閱「位置」。

如果要求成功，您應該會收到類似以下的 JSON 回應。回應最多會包含使用者最近存取的 500 本筆記本。

{
  "notebooks": [
    {
      "title": "NOTEBOOK_TITLE_1",
      "notebookId": "NOTEBOOK_ID_1",
      "emoji": "",
      "metadata": {
        "userRole": "PROJECT_ROLE_OWNER",
        "isShared": false,
        "isShareable": true,
        "lastViewed": "LAST_VIEWED_TIME",
        "createTime": "LAST_CREATED_TIME"
      },
      "name": "NOTEBOOK_NAME_1"
    },
    {
      "title": "NOTEBOOK_TITLE_2",
      "notebookId": "NOTEBOOK_ID_2",
      "emoji": "",
      "metadata": {
        "userRole": "PROJECT_ROLE_OWNER",
        "isShared": false,
        "isShareable": true,
        "lastViewed": "LAST_VIEWED_TIME",
        "createTime": "LAST_CREATED_TIME"
      },
      "name": "NOTEBOOK_NAME_2"
    }
  ]
}

批次刪除筆記本

如要批次刪除筆記本，請使用 notebooks.batchDelete 方法。

REST

curl -X POST \
  -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks:batchDelete"
  -d '{
    "names": [
      "NOTEBOOK_NAME_1",
      "NOTEBOOK_NAME_2"
    ]
  }'

更改下列內容：

  • ENDPOINT_LOCATION：API 要求的適用多區域。指派下列其中一個值：
    • us- 美國多區域
    • 歐盟多區域：eu-
    • global-，即可查看全球位置
    詳情請參閱「為資料儲存庫指定多區域」。
  • PROJECT_NUMBER：您的 Google Cloud 專案編號。
  • LOCATION： 資料存放區的地理位置，例如 global。 詳情請參閱「位置」。

  • NOTEBOOK_NAME：要刪除的筆記本完整資源名稱。這個欄位的格式為： projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID。

    如果要求成功，您應該會收到空白的 JSON 物件。

共用筆記本

如要共用新筆記本，請使用 notebooks.share 方法。

您必須授予要與其共用筆記本的使用者「Cloud Notebook 使用者」角色。

REST

  1. 在 Google Cloud 專案中，將 Cloud NotebookLM UserIdentity and Access Management (IAM) 角色指派給要與其共用筆記本的使用者。

  2. 呼叫下列方法。

    curl -X POST \
  -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://ENDPOINT_LOCATION--discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID:share" \
  -d '{
    "accountAndRoles": [
     {
        "email":"USER_EMAIL_1",
        "role":"USER_ROLE_1",
     },
     {
        "email":"USER_EMAIL_2",
        "role":"USER_ROLE_2",
     },
    ]
  }'

    更改下列內容：

    • ENDPOINT_LOCATION：API 要求的適用多區域。指派下列其中一個值：
      • us- 美國多區域
      • 歐盟多區域：eu-
      • global-，即可查看全球位置
      詳情請參閱「為資料儲存庫指定多區域」。
    • PROJECT_NUMBER：您的 Google Cloud 專案編號。
    • LOCATION： 資料存放區的地理位置，例如 global。 詳情請參閱「位置」。
    • NOTEBOOK_ID：用於識別要共用筆記本的專屬 ID。您需要筆記本 ID 才能執行其他筆記本管理工作，例如共用或擷取筆記本。
    • USER_EMAIL：要與之共用記事本的使用者電子郵件地址。

    • USER_ROLE：您要指派給使用者的角色。可以是下列其中一項：

      • PROJECT_ROLE_OWNER：使用者擁有專案。
      • PROJECT_ROLE_WRITER：使用者擁有專案的寫入權限。
      • PROJECT_ROLE_READER：使用者擁有專案的讀取權限。
      • PROJECT_ROLE_NOT_SHARED：使用者無法存取專案。

    如果要求成功，您會收到空白的 JSON 物件。

使用瀏覽器驗證使用者

如要確認筆記本是否已與正確的使用者共用，並指派正確的角色，請按照下列步驟操作：

  1. 在瀏覽器中開啟筆記本。筆記本的網址模式如下：

    1. 如果您使用 Google 身分：

      https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER

    2. 如果使用第三方身分：

      https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER

  2. 按一下「共用」。

  3. 確認「有權存取的使用者」清單中的使用者及其獲派的角色。

後續步驟