Google utiliza tecnología de IA para traducir contenido a tu idioma preferido. Las traducciones realizadas con IA pueden contener errores.

Crea y administra notebooks (API)

Gemini Notebook Enterprise es una herramienta potente para generar estadísticas y resúmenes a partir de tus documentos. En esta página, se describen las APIs que te permiten realizar las siguientes tareas de administración de cuadernos de forma programática:

Crea un cuaderno
Recupera un cuaderno
Enumera los cuadernos vistos recientemente
Borra un cuaderno
Comparte un cuaderno

Antes de comenzar

Antes de comenzar a trabajar con tus cuadernos, haz lo siguiente:

Crea un cuaderno

Para crear un cuaderno nuevo, usa el notebooks.create método.

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 multirregión para tu solicitud a la API. Especifica uno de los siguientes valores:
- us para la multirregión de EE.UU.
- eu para la multirregión de la UE
- global para la ubicación global
Para obtener más información, consulta Cómo especificar una multirregión para tu almacén de datos.
PROJECT_NUMBER: Es el número de tu Google Cloud proyecto.
LOCATION: Es la ubicación geográfica de tu almacén de datos, como global. Para obtener más información, consulta Ubicaciones.
NOTEBOOK_TITLE: Es una cadena codificada en UTF-8 que se usa como título para el cuaderno que deseas crear.

Si la solicitud se realiza correctamente, deberías recibir un objeto 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 cuaderno creado. Necesitas el ID del cuaderno para otras tareas de administración de cuadernos, como compartir o recuperar.
NOTEBOOK_NAME: Es el nombre completo del recurso del cuaderno. Este campo tiene el siguiente patrón: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID

Accede al cuaderno creado y obtén su ID en un navegador

Para acceder al cuaderno creado y obtener su ID con un navegador, haz lo siguiente:

Ve a la página principal de Gemini Notebook Enterprise, que está disponible en una de las siguientes URLs:
1. Si usas una identidad de Google, ve a:
```
https://notebook.cloud.google.com/LOCATION/?project=PROJECT_NUMBER
```
2. Si usas una identidad de terceros, ve a:
```
https://notebook.cloud.google/LOCATION/?project=PROJECT_NUMBER
```

Selecciona el cuaderno creado. La URL del cuaderno seleccionado tiene el siguiente patrón:

Si usas una identidad de Google:

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

Si usas una identidad de terceros:

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

Toma nota de la URL y el ID del cuaderno, que son útiles para otras tareas de administración de cuadernos, como compartir.

Recupera un cuaderno

Para recuperar un cuaderno específico con su ID, usa el notebooks.get método.

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. Especifica uno de los siguientes valores:
- us para la multirregión de EE.UU.
- eu para la multirregión de la UE
- global para la ubicación global
Para obtener más información, consulta Cómo especificar una multirregión para tu almacén de datos.
PROJECT_NUMBER: Es el número de tu Google Cloud proyecto.
LOCATION: Es la ubicación geográfica de tu almacén de datos, como global. Para obtener más información, consulta Ubicaciones.
NOTEBOOK_ID: Es el identificador único del cuaderno que recibiste cuando lo creaste.

Si la solicitud se realiza correctamente, deberías obtener una respuesta JSON similar a la siguiente para un cuaderno vacío. Si llamas a este método después de agregar fuentes a tu cuaderno, recibirás detalles sobre todas las fuentes agregadas al cuaderno recuperado. Si configuraste los detalles de CMEK, también recibirás información relacionada con CMEK para el cuaderno.

{
"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 cuadernos vistos recientemente

Para obtener una lista de todos los cuadernos de un proyecto que se vieron recientemente, usa el notebooks.listRecentlyViewed método. De forma predeterminada, la respuesta muestra los últimos 500 cuadernos. Puedes elegir paginar las respuestas con el parámetro de consulta 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 multirregión para tu solicitud a la API. Especifica uno de los siguientes valores:
- us para la multirregión de EE.UU.
- eu para la multirregión de la UE
- global para la ubicación global
Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
PROJECT_NUMBER: Es el número de tu Google Cloud proyecto.
LOCATION: Es la ubicación geográfica de tu almacén de datos, como global. Para obtener más información, consulta Ubicaciones.

Si la solicitud se realiza correctamente, deberías obtener una respuesta JSON similar a la siguiente. La respuesta contiene hasta los últimos 500 cuadernos 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"
    }
  ]
}

Borra un cuaderno

Para borrar un cuaderno, usa el notebooks.batchDelete método.

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

Reemplaza lo siguiente:

ENDPOINT_LOCATION: Es la multirregión para tu solicitud a la API. Especifica uno de los siguientes valores:
- us para la multirregión de EE.UU.
- eu para la multirregión de la UE
- global para la ubicación global
Para obtener más información, consulta Cómo especificar una multirregión para tu almacén de datos.
PROJECT_NUMBER: Es el número de tu Google Cloud proyecto.
LOCATION: Es la ubicación geográfica de tu almacén de datos, como global. Para obtener más información, consulta Ubicaciones.
NOTEBOOK_NAME: Es el nombre completo del recurso del cuaderno que se borrará. Este campo tiene el siguiente patrón: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID.

Si la solicitud se realiza correctamente, recibirás un objeto JSON vacío. Si el cuaderno no existe, también recibirás un objeto JSON vacío, así que asegúrate de especificar el nombre del cuaderno correctamente.

Para compartir un cuaderno nuevo, usa el notebooks.share método.

El usuario con el que deseas compartir el cuaderno debe tener asignado el rol de usuario de NotebookLM de Cloud.

REST

En tu Google Cloud proyecto, asigna el rol de Cloud NotebookLM User Identity and Access Management (IAM) a los usuarios con los que deseas compartir el cuaderno.
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 multirregión para tu solicitud a la API. Especifica uno de los siguientes valores:
  - us para la multirregión de EE.UU.
  - eu para la multirregión de la UE
  - global para la ubicación global
  Para obtener más información, consulta Cómo especificar una multirregión para tu almacén de datos.
- PROJECT_NUMBER: Es el número de tu Google Cloud proyecto.
- LOCATION: Es la ubicación geográfica de tu almacén de datos, como global. Para obtener más información, consulta Ubicaciones.
- NOTEBOOK_ID: Es un ID único para identificar el cuaderno que deseas compartir. Necesitas el ID del cuaderno para otras tareas de administración de cuadernos, como compartir o recuperar.
- USER_EMAIL: Es la dirección de correo electrónico del usuario con el que deseas compartir el cuaderno.
- 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 cuaderno con los usuarios correctos y les asignaste los roles correctos, haz lo siguiente:

Abre el cuaderno en el navegador. Un cuaderno tiene el siguiente patrón de URL:

Si usas una identidad de Google:

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

Si usas una identidad de terceros:

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

Haz clic en Compartir.
Verifica los usuarios que aparecen como Personas con acceso y sus roles asignados.

¿Qué sigue?

Agrega fuentes de datos de diferentes tipos a tus cuadernos de forma programática.

Crea y administra notebooks (API) Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Antes de comenzar

Crea un cuaderno

REST

Accede al cuaderno creado y obtén su ID en un navegador

Recupera un cuaderno

REST

Enumera los cuadernos vistos recientemente

REST

Borra un cuaderno

REST

Comparte un cuaderno

REST

Verifica a los usuarios con un navegador

¿Qué sigue?

Crea y administra notebooks (API)