Membuat dan mengelola notebook (API)

NotebookLM Enterprise adalah alat canggih untuk menghasilkan insight dan ringkasan dari dokumen Anda. Halaman ini menjelaskan API yang memungkinkan Anda melakukan tugas pengelolaan notebook berikut secara terprogram:

Sebelum memulai

Sebelum mulai menggunakan notebook, lakukan hal berikut:

Membuat notebook

Untuk membuat notebook baru, gunakan metode.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",
  }'

Ganti kode berikut:

  • ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:
    • us untuk multi-region AS
    • eu untuk multi-region UE
    • global untuk lokasi Global
    Untuk mengetahui informasi selengkapnya, lihat Menentukan multi-region untuk penyimpanan data Anda.
  • PROJECT_NUMBER: nomor Google Cloud project Anda.
  • LOCATION: lokasi geografis penyimpanan data Anda, seperti global. Untuk mengetahui informasi selengkapnya, lihat Lokasi.
  • NOTEBOOK_TITLE: string berenkode UTF-8 yang digunakan sebagai judul untuk notebook yang ingin Anda buat.

Jika permintaan berhasil, Anda akan menerima JSON yang mirip dengan yang berikut ini.

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

Perhatikan hal berikut:

  • NOTEBOOK_ID: ID unik untuk mengidentifikasi notebook yang dibuat. Anda memerlukan ID notebook untuk tugas pengelolaan notebook lainnya, seperti berbagi atau mengambil.
  • NOTEBOOK_NAME: nama resource lengkap notebook. Kolom ini memiliki pola berikut: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID

Mengakses notebook yang dibuat dan mendapatkan ID-nya di browser

Untuk mengakses notebook yang dibuat dan mendapatkan ID-nya menggunakan browser, lakukan hal berikut.

  1. Buka halaman beranda NotebookLM Enterprise yang tersedia di salah satu URL berikut:

    1. Jika Anda menggunakan identitas Google, buka:

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

    2. Jika Anda menggunakan identitas pihak ketiga, buka:

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

  2. Pilih notebook yang dibuat. URL notebook yang dipilih memiliki pola berikut:

    1. Jika Anda menggunakan identitas Google:

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

    2. Jika Anda menggunakan identitas pihak ketiga:

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

  3. Perhatikan URL dan ID notebook, yang berguna untuk tugas pengelolaan notebook lainnya, seperti berbagi.

Mengambil notebook

Untuk mengambil notebook tertentu menggunakan ID notebook-nya, gunakan notebooks.get metode.

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"

Ganti kode berikut:

  • ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:
    • us untuk multi-region AS
    • eu untuk multi-region UE
    • global untuk lokasi Global
    Untuk mengetahui informasi selengkapnya, lihat Menentukan multi-region untuk penyimpanan data Anda.
  • PROJECT_NUMBER: nomor Google Cloud project Anda.
  • LOCATION: lokasi geografis penyimpanan data Anda, seperti global. Untuk mengetahui informasi selengkapnya, lihat Lokasi.
  • NOTEBOOK_ID: ID unik notebook yang Anda terima saat membuat notebook.

Jika permintaan berhasil, Anda akan mendapatkan respons JSON yang mirip dengan yang berikut ini untuk notebook kosong. Jika Anda memanggil metode ini setelah Anda menambahkan sumber ke notebook, Anda akan menerima detail tentang semua sumber yang ditambahkan ke notebook yang diambil. Jika telah mengonfigurasi detail CMEK, Anda juga akan menerima informasi terkait CMEK untuk notebook.

{
"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"
}

Mencantumkan notebook yang baru-baru ini dilihat

Untuk mendapatkan daftar semua notebook dalam project yang baru-baru ini dilihat, gunakan notebooks.listRecentlyViewed metode. Secara default, respons mencantumkan 500 notebook terakhir. Anda dapat memilih untuk melakukan penomoran halaman pada respons dengan parameter kueri 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"

Ganti kode berikut:

  • ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:
    • us untuk multi-region AS
    • eu untuk multi-region UE
    • global untuk lokasi Global
    Untuk mengetahui informasi selengkapnya, lihat Menentukan multi-region untuk penyimpanan data Anda.
  • PROJECT_NUMBER: nomor Google Cloud project Anda.
  • LOCATION: lokasi geografis penyimpanan data Anda, seperti global. Untuk mengetahui informasi selengkapnya, lihat Lokasi.

Jika permintaan berhasil, Anda akan mendapatkan respons JSON yang mirip dengan yang berikut ini. Respons berisi hingga 500 notebook terakhir yang baru-baru ini diakses pengguna.

{
  "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"
    }
  ]
}

Menghapus notebook

Untuk menghapus notebook, gunakan metode.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"
    ]
  }'

Ganti kode berikut:

  • ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:
    • us untuk multi-region AS
    • eu untuk multi-region UE
    • global untuk lokasi Global
    Untuk mengetahui informasi selengkapnya, lihat Menentukan multi-region untuk penyimpanan data Anda.
  • PROJECT_NUMBER: nomor Google Cloud project Anda.
  • LOCATION: lokasi geografis penyimpanan data Anda, seperti global. Untuk mengetahui informasi selengkapnya, lihat Lokasi.

  • NOTEBOOK_NAME: nama resource lengkap notebook yang akan dihapus. Kolom ini memiliki pola: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID.

    Jika permintaan berhasil, Anda akan menerima objek JSON kosong. Jika notebook tidak ada, Anda juga akan menerima objek JSON kosong, jadi pastikan untuk menentukan nama notebook dengan benar.

Membagikan notebook

Untuk membagikan notebook baru, gunakan metode notebooks.share.

Pengguna yang ingin Anda ajak berbagi notebook harus diberi peran Pengguna Notebook Cloud.

REST

  1. Di project Anda, tetapkan peran Identity and Access Management (IAM) kepada pengguna yang ingin Anda ajak berbagi notebook. Google Cloud Cloud NotebookLM User

  2. Panggil metode berikut.

    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",
     },
    ]
  }'

    Ganti kode berikut:

    • ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:
      • us untuk multi-region AS
      • eu untuk multi-region UE
      • global untuk lokasi Global
      Untuk mengetahui informasi selengkapnya, lihat Menentukan multi-region untuk penyimpanan data Anda.
    • PROJECT_NUMBER: nomor Google Cloud project Anda.
    • LOCATION: lokasi geografis penyimpanan data Anda, seperti global. Untuk mengetahui informasi selengkapnya, lihat Lokasi.
    • NOTEBOOK_ID: ID unik untuk mengidentifikasi notebook yang ingin Anda bagikan. Anda memerlukan ID notebook untuk tugas pengelolaan notebook lainnya, seperti berbagi atau mengambil.
    • USER_EMAIL: alamat email pengguna yang ingin Anda ajak berbagi notebook.

    • USER_ROLE: peran yang ingin Anda tetapkan kepada pengguna. Peran ini dapat berupa salah satu hal berikut:

      • PROJECT_ROLE_OWNER: Pengguna memiliki project.
      • PROJECT_ROLE_WRITER: Pengguna memiliki izin tulis di project.
      • PROJECT_ROLE_READER: Pengguna memiliki izin baca di project.
      • PROJECT_ROLE_NOT_SHARED:Pengguna tidak memiliki akses ke project.

    Jika permintaan berhasil, Anda akan menerima objek JSON kosong.

Memverifikasi pengguna menggunakan browser

Untuk memverifikasi apakah Anda telah membagikan notebook kepada pengguna yang tepat dan menetapkan peran yang benar kepada mereka, lakukan hal berikut:

  1. Buka notebook di browser Anda. Notebook memiliki pola URL berikut:

    1. Jika Anda menggunakan identitas Google:

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

    2. Jika Anda menggunakan identitas pihak ketiga:

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

  2. Klik Bagikan.

  3. Verifikasi pengguna yang tercantum sebagai Orang yang memiliki akses dan peran yang ditetapkan kepada mereka.

Langkah berikutnya