Crear y gestionar cuadernos (API)

NotebookLM Enterprise es una herramienta potente para generar información valiosa y resúmenes a partir de tus documentos. En esta página se describen las APIs que te permiten realizar las siguientes tareas de gestión de cuadernos de forma programática:

Crear un cuaderno

Para crear un cuaderno, 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",
  }'

Haz los cambios siguientes:

  • ENDPOINT_LOCATION: la multirregión de 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 UE
    • global- para la ubicación global
    Para obtener más información, consulta el artículo sobre cómo especificar una multirregión para tu almacén de datos.
  • PROJECT_NUMBER: 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: cadena codificada en UTF-8 que se usa como título del cuaderno 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: un ID único para identificar el cuaderno creado. Necesitas el ID del cuaderno para otras tareas de gestión, como compartirlo o recuperarlo.
  • NOTEBOOK_NAME: el nombre completo de los recursos del cuaderno. Este campo tiene el siguiente patrón: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID

Acceder al cuaderno creado y obtener su ID en un navegador

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

  1. Ve a la página principal de NotebookLM Enterprise, disponible en una de las siguientes URLs:

    1. Si utilizas una identidad de Google, ve a:

      https://notebooklm.cloud.google.com/LOCATION/?project=PROJECT_NUMBER
      
    2. Si utilizas una identidad de terceros, ve a:

      https://notebooklm.cloud.google/LOCATION/?project=PROJECT_NUMBER
      
  2. Selecciona el cuaderno que has creado. La URL del cuaderno seleccionado tiene el siguiente patrón:

    1. Si utilizas una identidad de Google:

      https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
      
    2. Si utilizas una identidad de terceros:

      https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
      
  3. Anota la URL y el ID del cuaderno, que te serán útiles para otras tareas de gestión de cuadernos, como compartir.

Recuperar un cuaderno

Para obtener un cuaderno específico mediante 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"

Haz los cambios siguientes:

  • ENDPOINT_LOCATION: la multirregión de 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 UE
    • global- para la ubicación global
    Para obtener más información, consulta el artículo sobre cómo especificar una multirregión para tu almacén de datos.
  • PROJECT_NUMBER: 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: el identificador único del cuaderno que recibiste al crear el cuaderno.

Si la solicitud se realiza correctamente, deberías obtener una respuesta JSON similar a la siguiente en el caso de un cuaderno vacío. Si llamas a este método después de añadir fuentes a tu cuaderno, recibirás información sobre todas las fuentes añadidas al cuaderno recuperado. Si has configurado 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"
}

Mostrar los cuadernos vistos recientemente

Para obtener una lista de todos los cuadernos de un proyecto que se hayan visto recientemente, usa el método notebooks.listRecentlyViewed. De forma predeterminada, la respuesta muestra los últimos 500 cuadernos. Puede 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"

Haz los cambios siguientes:

  • ENDPOINT_LOCATION: la multirregión de 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 UE
    • global- para la ubicación global
    Para obtener más información, consulta el artículo sobre cómo especificar una multirregión para tu almacén de datos.
  • PROJECT_NUMBER: 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 obtener una respuesta JSON similar a la siguiente. La respuesta contiene hasta los últimos 500 cuadernos a los que ha accedido 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"
    }
  ]
}

Eliminar cuadernos por lotes

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

Haz los cambios siguientes:

  • ENDPOINT_LOCATION: la multirregión de 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 UE
    • global- para la ubicación global
    Para obtener más información, consulta el artículo sobre cómo especificar una multirregión para tu almacén de datos.
  • PROJECT_NUMBER: 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: el nombre completo del recurso del cuaderno que se va a eliminar. Este campo tiene el siguiente patrón: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID.

    Si la solicitud se realiza correctamente, deberías recibir un objeto JSON vacío.

Compartir un cuaderno

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

El usuario con el que quieras compartir el cuaderno debe tener asignado el rol Usuario de Cloud Notebook.

REST

  1. En tu Google Cloud proyecto, asigna el rol de Cloud NotebookLM User Gestión de Identidades y Accesos (IAM) a los usuarios con los que quieras compartir el cuaderno.

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

    Haz los cambios siguientes:

    • ENDPOINT_LOCATION: la multirregión de 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 UE
      • global- para la ubicación global
      Para obtener más información, consulta el artículo sobre cómo especificar una multirregión para tu almacén de datos.
    • PROJECT_NUMBER: 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: un ID único para identificar el cuaderno que quieres compartir. Necesitas el ID del cuaderno para otras tareas de gestión, como compartirlo o recuperarlo.
    • USER_EMAIL: la dirección de correo del usuario con el que quieres compartir el cuaderno.
    • USER_ROLE: el rol que quieres asignar al usuario. Puede ser una de las siguientes:

      • PROJECT_ROLE_OWNER: El usuario es el 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.

Verificar usuarios con un navegador

Para comprobar si has compartido el cuaderno con los usuarios correctos y les has asignado los roles adecuados, haz lo siguiente:

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

    1. Si utilizas una identidad de Google:

      https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
      
    2. Si utilizas una identidad de terceros:

      https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
      
  2. Haz clic en Compartir.

  3. Verifica los usuarios que aparecen en Usuarios con acceso y los roles que tienen asignados.

Siguientes pasos