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 notebooks de forma programática:

Crea un notebook
Recupera un notebook
Cómo enumerar los cuadernos vistos recientemente
Cómo borrar un cuaderno
Cómo compartir un cuaderno

Antes de comenzar

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

Usa el extremo multirregional de EE.UU.

Si tu suscripción a Gemini Notebook Enterprise se encuentra en la multirregión de EE.UU., puedes enviar las solicitudes de esta página al extremo multirregional de EE.UU., discoveryengine.us.rep.googleapis.com. Un extremo multirregional procesa tus solicitudes y finaliza TLS dentro de la multirregión, por lo que los datos de tu solicitud permanecen en EE.UU. mientras están en tránsito. El uso de este extremo no cambia la ubicación en la que se almacenan tus notebooks. Para obtener más información, consulta Descripción general de los extremos de API regionales y multirregionales en la guía de seguridad de Google Cloud.

Para usar el extremo multirregional de EE.UU., realiza los siguientes cambios en cada URL de solicitud de esta página:

Reemplaza el host ENDPOINT_LOCATION-discoveryengine.googleapis.com por discoveryengine.us.rep.googleapis.com.
Establece LOCATION en us.

El resto de cada solicitud permanece igual. Para obtener información sobre cómo elegir la multirregión de tu suscripción, consulta Obtén una suscripción. Para obtener la lista de extremos de servicio regionales y multirregionales, consulta Extremos de servicio regionales y multirregionales en la guía de la nube privada virtual.

Crear un notebook

Para crear un notebook 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 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 proyecto de Google Cloud .
LOCATION: 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 notebook que quieres 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 cuaderno para otras tareas de administración, como compartir o recuperar.
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 Gemini Notebook Enterprise que está disponible en una de las siguientes URLs:
1. Si usas una identidad de Google, ve a la siguiente página:
```
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 notebook creado. La URL del notebook seleccionado tiene el siguiente patrón:
1. Si usas una identidad de Google, haz lo siguiente:
```
https://notebook.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
```
2. Si usas una identidad de terceros, haz lo siguiente:
```
https://notebook.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
```
Toma nota de la URL y el ID del notebook, que son útiles para otras tareas de administración de notebooks, como el uso compartido.

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 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 proyecto de Google Cloud .
LOCATION: 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 notebook que recibiste cuando lo creaste.

Si la solicitud se realiza correctamente, deberías obtener 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 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 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 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 multirregión para tu almacén de datos.
PROJECT_NUMBER: Es el número de tu proyecto de Google Cloud .
LOCATION: 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 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 un cuaderno

Para borrar un notebook, 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"
    ]
  }'

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 proyecto de Google Cloud .
LOCATION: 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 notebook 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 notebook no existe, también recibirás un objeto JSON vacío, así que asegúrate de especificar el nombre del notebook de forma correcta.

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

Al usuario con el que quieres compartir el cuaderno se le debe otorgar el rol de Usuario de NotebookLM de Cloud.

REST

En tu proyecto de Google Cloud , asigna el rol de Identity and Access Management (IAM) deCloud NotebookLM User a los usuarios con los que quieras 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 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 proyecto de Google Cloud .
- LOCATION: 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 notebook que quieres compartir. Necesitas el ID del cuaderno para otras tareas de administración, como compartir o recuperar.
- USER_EMAIL: Es la dirección de correo electrónico del usuario con el que deseas 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 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 cuaderno en tu navegador. Un notebook tiene el siguiente patrón de URL:
1. Si usas una identidad de Google, haz lo siguiente:
```
https://notebook.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
```
2. Si usas una identidad de terceros, haz lo siguiente:
```
https://notebook.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 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

Usa el extremo multirregional de EE.UU.

Crear un notebook

REST

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

Recupera un notebook

REST

Enumera los notebooks vistos recientemente

REST

Cómo borrar un cuaderno

REST

Comparte un cuaderno

REST

Verifica los usuarios con un navegador

¿Qué sigue?

Crea y administra notebooks (API)