Gemini Notebook Enterprise adalah alat yang andal untuk membuat insight dan ringkasan dari dokumen Anda. Halaman ini menjelaskan API yang memungkinkan Anda melakukan tugas pengelolaan notebook berikut secara terprogram:
- Membuat notebook
- Mengambil notebook
- Mencantumkan notebook yang baru-baru ini dilihat
- Menghapus notebook
- Membagikan notebook
Sebelum memulai
Sebelum mulai menggunakan notebook, lakukan hal berikut:
- Siapkan Gemini Notebook Enterprise.
- Dapatkan lisensi untuk Gemini Notebook Enterprise dan tetapkan lisensi ke akun pengguna Anda.
- Berikan peran Cloud NotebookLM User
(
roles/discoveryengine.notebookLmUser) ke akun pengguna Anda. Di terminal lokal atau Cloud Shell, login ke Google Cloud CLI dengan kredensial pengguna Anda dengan menjalankan perintah
gcloud auth login:gcloud auth loginLogin dengan kredensial pengguna akan memastikan bahwa
gcloud auth print-access-tokenmembuat token akses untuk akun pengguna Anda. Metodeprojects.locations.notebooksREST API di halaman ini memerlukan akun pengguna yang diautentikasi dengan lisensi Gemini Notebook Enterprise yang aktif.
Menggunakan endpoint multi-regional AS
Jika langganan Gemini Notebook Enterprise Anda berada di multi-region AS, Anda dapat mengirim permintaan di halaman ini ke endpoint multi-regional AS, discoveryengine.us.rep.googleapis.com. Endpoint multi-regional
memproses permintaan Anda dan menghentikan TLS dalam multi-region, sehingga data
permintaan Anda tetap berada di AS saat dalam pengiriman. Penggunaan endpoint ini tidak mengubah tempat notebook Anda disimpan. Untuk informasi selengkapnya, lihat
Ringkasan endpoint API regional dan multi-regional dalam panduan keamanan Google Cloud.
Untuk menggunakan endpoint multi-regional AS, buat perubahan berikut pada setiap URL permintaan di halaman ini:
Ganti host
ENDPOINT_LOCATION-discoveryengine.googleapis.comdengandiscoveryengine.us.rep.googleapis.com.Tetapkan
LOCATIONkeus.
Bagian lain dari setiap permintaan tetap sama. Untuk mempelajari cara memilih multi-region langganan, lihat Mendapatkan langganan. Untuk mengetahui daftar endpoint layanan regional dan multi-region, lihat Endpoint layanan regional dan multi-region dalam panduan Virtual Private Cloud.
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:usuntuk multi-region ASeuuntuk multi-region Uni Eropaglobaluntuk lokasi Global
PROJECT_NUMBER: jumlah project Google Cloud Anda.LOCATION: lokasi geografis penyimpanan data Anda, sepertiglobal. 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 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.
Buka halaman beranda Gemini Notebook Enterprise yang tersedia di salah satu URL berikut:
Jika Anda menggunakan Google Identity, buka:
https://notebook.cloud.google.com/LOCATION/?project=PROJECT_NUMBERJika Anda menggunakan identitas pihak ketiga, buka:
https://notebook.cloud.google/LOCATION/?project=PROJECT_NUMBER
Pilih notebook yang dibuat. URL notebook yang dipilih memiliki pola berikut:
Jika Anda menggunakan identitas Google:
https://notebook.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBERJika Anda menggunakan identitas pihak ketiga:
https://notebook.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Catat URL dan ID notebook, yang berguna untuk tugas pengelolaan notebook lainnya, seperti berbagi.
Mengambil notebook
Untuk mengambil notebook tertentu menggunakan ID notebook-nya, gunakan metode
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"
Ganti kode berikut:
ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:usuntuk multi-region ASeuuntuk multi-region Uni Eropaglobaluntuk lokasi Global
PROJECT_NUMBER: jumlah project Google Cloud Anda.LOCATION: lokasi geografis penyimpanan data Anda, sepertiglobal. 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 berikut ini untuk notebook kosong. Jika Anda memanggil metode ini setelah menambahkan sumber ke notebook, Anda akan menerima detail tentang semua sumber yang ditambahkan ke notebook yang diambil. Jika Anda 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 metode
notebooks.listRecentlyViewed. Secara default, respons mencantumkan 500 notebook terakhir. Anda dapat memilih
untuk memberi nomor 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:usuntuk multi-region ASeuuntuk multi-region Uni Eropaglobaluntuk lokasi Global
PROJECT_NUMBER: jumlah project Google Cloud Anda.LOCATION: lokasi geografis penyimpanan data Anda, sepertiglobal. Untuk mengetahui informasi selengkapnya, lihat Lokasi.
Jika permintaan berhasil, Anda akan mendapatkan respons JSON yang mirip dengan berikut ini. Respons berisi hingga 500 notebook terakhir yang diakses pengguna baru-baru ini.
{
"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:usuntuk multi-region ASeuuntuk multi-region Uni Eropaglobaluntuk lokasi Global
PROJECT_NUMBER: jumlah project Google Cloud Anda.LOCATION: lokasi geografis penyimpanan data Anda, sepertiglobal. 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 Cloud NotebookLM User.
REST
Dalam project Google Cloud , tetapkan peran
Cloud NotebookLM UserIdentity and Access Management (IAM) kepada pengguna yang ingin Anda ajak berbagi notebook.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:usuntuk multi-region ASeuuntuk multi-region Uni Eropaglobaluntuk lokasi Global
PROJECT_NUMBER: jumlah project Google Cloud Anda.LOCATION: lokasi geografis penyimpanan data Anda, sepertiglobal. 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. Nilai ini dapat berupa salah satu dari berikut:PROJECT_ROLE_WRITER: Pengguna memiliki izin tulis pada project.PROJECT_ROLE_READER: Pengguna memiliki izin baca pada 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 benar dan menetapkan peran yang benar kepada mereka, lakukan hal berikut:
Buka notebook di browser Anda. Notebook memiliki pola URL berikut:
Jika Anda menggunakan identitas Google:
https://notebook.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBERJika Anda menggunakan identitas pihak ketiga:
https://notebook.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Klik Bagikan.
Verifikasi pengguna yang tercantum sebagai Orang yang memiliki akses dan peran yang ditetapkan kepada mereka.
Langkah berikutnya
- Tambahkan sumber data dari berbagai jenis ke notebook Anda secara terprogram.