NotebookLM Enterprise es una herramienta potente para generar resúmenes y obtener información a partir de tus documentos. En esta página, se describen las APIs que te permiten realizar las siguientes tareas de administración de notebooks de forma programática:
- Crea un cuaderno
- Cómo recuperar un notebook
- Enumera los notebooks vistos recientemente
- Cómo borrar notebooks por lotes
- Cómo compartir un notebook
Crea un notebook
Para crear un cuaderno nuevo, usa el método 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",
}'
Reemplaza lo siguiente:
ENDPOINT_LOCATION
: Es la región múltiple para tu solicitud a la API. Asigna uno de los siguientes valores:us-
para la multirregión de EE.UU.eu-
para la multirregión de la UEglobal-
para la ubicación global
PROJECT_NUMBER
: Es el número de tu proyecto de Google Cloud .LOCATION
: La ubicación geográfica de tu almacén de datos, comoglobal
. Para obtener más información, consulta Ubicaciones.NOTEBOOK_TITLE
: Es una cadena codificada en UTF-8 que se usa como título del notebook que deseas crear.
Si la solicitud se realiza correctamente, deberías recibir un JSON similar al siguiente.
{
"title": "NOTEBOOK_TITLE",
"notebookId": "NOTEBOOK_ID",
"emoji": "",
"metadata": {
"userRole": "PROJECT_ROLE_OWNER",
"isShared": false,
"isShareable": true
},
"name": "NOTEBOOK_NAME"
}
Ten en cuenta lo siguiente:
NOTEBOOK_ID
: Es un ID único para identificar el notebook creado. Necesitas el ID del notebook para otras tareas de administración, como compartirlo o recuperarlo.NOTEBOOK_NAME
: Es el nombre completo del recurso del notebook. Este campo tiene el siguiente patrón:projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID
Accede al notebook creado y obtén su ID en un navegador
Para acceder al notebook creado y obtener su ID con un navegador, haz lo siguiente.
Ve a la página principal de NotebookLM Enterprise, disponible en una de las siguientes URLs:
Si usas una identidad de Google, ve a:
https://notebooklm.cloud.google.com/LOCATION/?project=PROJECT_NUMBER
Si usas una identidad de terceros, ve a:
https://notebooklm.cloud.google/LOCATION/?project=PROJECT_NUMBER
Selecciona el notebook creado. La URL del notebook seleccionado tiene el siguiente patrón:
Si usas una identidad de Google, haz lo siguiente:
https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Si usas una identidad de terceros, haz lo siguiente:
https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Ten en cuenta la URL y el ID del notebook, que son útiles para otras tareas de administración de notebooks, como compartirlos.
Recupera un notebook
Para recuperar un notebook específico con su ID, usa el método 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"
Reemplaza lo siguiente:
ENDPOINT_LOCATION
: Es la región múltiple para tu solicitud a la API. Asigna uno de los siguientes valores:us-
para la multirregión de EE.UU.eu-
para la multirregión de la UEglobal-
para la ubicación global
PROJECT_NUMBER
: Es el número de tu proyecto de Google Cloud .LOCATION
: La ubicación geográfica de tu almacén de datos, comoglobal
. Para obtener más información, consulta Ubicaciones.NOTEBOOK_ID
: Es el identificador único del notebook que recibiste cuando lo creaste.
Si la solicitud se realiza correctamente, deberías recibir una respuesta JSON similar a la siguiente para un notebook vacío. Si llamas a este método después de agregar fuentes a tu notebook, recibirás detalles sobre todas las fuentes agregadas al notebook recuperado. Si configuraste los detalles de CMEK, también recibirás información relacionada con CMEK para el 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"
}
Enumera los notebooks vistos recientemente
Para obtener una lista de todos los notebooks de un proyecto que se vieron recientemente, usa el método notebooks.listRecentlyViewed
. De forma predeterminada, la respuesta enumera los últimos 500 notebooks. Puedes optar por paginar las respuestas con el parámetro de búsqueda 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"
Reemplaza lo siguiente:
ENDPOINT_LOCATION
: Es la región múltiple para tu solicitud a la API. Asigna uno de los siguientes valores:us-
para la multirregión de EE.UU.eu-
para la multirregión de la UEglobal-
para la ubicación global
PROJECT_NUMBER
: Es el número de tu proyecto de Google Cloud .LOCATION
: La ubicación geográfica de tu almacén de datos, comoglobal
. Para obtener más información, consulta Ubicaciones.
Si la solicitud se realiza correctamente, deberías recibir una respuesta JSON similar a la siguiente. La respuesta contiene hasta los últimos 500 notebooks a los que accedió un usuario recientemente.
{
"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"
}
]
}
Cómo borrar notebooks en lote
Para borrar notebooks por lotes, usa el método 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"
]
}'
Reemplaza lo siguiente:
ENDPOINT_LOCATION
: Es la región múltiple para tu solicitud a la API. Asigna uno de los siguientes valores:us-
para la multirregión de EE.UU.eu-
para la multirregión de la UEglobal-
para la ubicación global
PROJECT_NUMBER
: Es el número de tu proyecto de Google Cloud .LOCATION
: La ubicación geográfica de tu almacén de datos, comoglobal
. Para obtener más información, consulta Ubicaciones.NOTEBOOK_NAME
: Es el nombre completo del recurso del notebook que se borrará. Este campo tiene el patrónprojects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID
.Si la solicitud se realiza correctamente, deberías recibir un objeto JSON vacío.
Cómo compartir un notebook
Para compartir un notebook nuevo, usa el método notebooks.share
.
El usuario con el que deseas compartir el notebook debe tener el rol de Usuario de Cloud Notebook.
REST
En tu proyecto Google Cloud , asigna el rol de Identity and Access Management (IAM)
Cloud NotebookLM User
a los usuarios con los que deseas compartir el notebook.Llama al siguiente método.
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", }, ] }'
Reemplaza lo siguiente:
ENDPOINT_LOCATION
: Es la región múltiple para tu solicitud a la API. Asigna uno de los siguientes valores:us-
para la multirregión de EE.UU.eu-
para la multirregión de la UEglobal-
para la ubicación global
PROJECT_NUMBER
: Es el número de tu proyecto de Google Cloud .LOCATION
: La ubicación geográfica de tu almacén de datos, comoglobal
. Para obtener más información, consulta Ubicaciones.NOTEBOOK_ID
: Es un ID único para identificar el notebook que deseas compartir. Necesitas el ID del notebook para otras tareas de administración, como compartirlo o recuperarlo.USER_EMAIL
: Es la dirección de correo electrónico del usuario con el que quieres compartir el notebook.USER_ROLE
: Es un rol que deseas asignar al usuario. Puede ser uno de los siguientes:PROJECT_ROLE_OWNER
: El usuario es propietario del proyecto.PROJECT_ROLE_WRITER
: El usuario tiene permisos de escritura en el proyecto.PROJECT_ROLE_READER
: El usuario tiene permisos de lectura en el proyecto.PROJECT_ROLE_NOT_SHARED
:El usuario no tiene acceso al proyecto.
Si la solicitud se realiza correctamente, recibirás un objeto JSON vacío.
Verifica a los usuarios con un navegador
Para verificar si compartiste el notebook con los usuarios correctos y les asignaste los roles adecuados, haz lo siguiente:
Abre el notebook en tu navegador. Un notebook tiene el siguiente patrón de URL:
Si usas una identidad de Google, haz lo siguiente:
https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Si usas una identidad de terceros, haz lo siguiente:
https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Haz clic en Compartir
Verifica los usuarios que aparecen en Personas con acceso y sus roles asignados.
¿Qué sigue?
- Agregar fuentes de datos de diferentes tipos a tus notebooks de forma programática