Creare e gestire notebook (API)

NotebookLM Enterprise è un potente strumento per generare approfondimenti e riepiloghi dai tuoi documenti. Questa pagina descrive le API che ti consentono di eseguire le seguenti attività di gestione dei notebook a livello programmatico:

Prima di iniziare

Prima di iniziare a lavorare con i notebook:

Crea un notebook

Per creare un nuovo notebook, utilizza il notebooks.create metodo.

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

Sostituisci quanto segue:

  • ENDPOINT_LOCATION: la multi-regione per la richiesta API. Specifica uno dei seguenti valori:
    • us per la multi-regione Stati Uniti
    • eu per la multi-regione EU
    • global per la località globale
    Per saperne di più, consulta Specifica una multi-regione per il datastore.
  • PROJECT_NUMBER: il numero del tuo Google Cloud progetto.
  • LOCATION: la posizione geografica del datastore, ad esempio global. Per saperne di più, consulta Località.
  • NOTEBOOK_TITLE: una stringa con codifica UTF-8 utilizzata come titolo per il notebook che vuoi creare.

Se la richiesta va a buon fine, dovresti ricevere un JSON simile al seguente.

{
"title": "NOTEBOOK_TITLE",
"notebookId": "NOTEBOOK_ID",
"emoji": "",
"metadata": {
  "userRole": "PROJECT_ROLE_OWNER",
  "isShared": false,
  "isShareable": true
},
"name": "NOTEBOOK_NAME"
}

Tieni presente quanto segue:

  • NOTEBOOK_ID: un ID univoco per identificare il notebook creato. L'ID del notebook è necessario per altre attività di gestione dei notebook, come la condivisione o il recupero.
  • NOTEBOOK_NAME: il nome completo della risorsa del notebook. Questo campo ha il seguente pattern: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID

Accedi al notebook creato e recupera il suo ID in un browser

Per accedere al notebook creato e recuperare il suo ID utilizzando un browser:

  1. Vai alla home page di NotebookLM Enterprise, disponibile a uno dei seguenti URL:

    1. Se utilizzi un'identità Google, vai a:

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

    2. Se utilizzi un'identità di terze parti, vai a:

      https://notebooklm.cloud.google/LOCATION/?project=PROJECT_NUMBER

  2. Seleziona il notebook creato. L'URL del notebook selezionato ha il seguente pattern:

    1. Se utilizzi un'identità Google:

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

    2. Se utilizzi un'identità di terze parti:

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

  3. Prendi nota dell'URL e dell'ID del notebook, utili per altre attività di gestione dei notebook, come la condivisione.

Recupera un notebook

Per recuperare un notebook specifico utilizzando il suo ID, utilizza il notebooks.get metodo.

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"

Sostituisci quanto segue:

  • ENDPOINT_LOCATION: la multi-regione per la richiesta API. Specifica uno dei seguenti valori:
    • us per la multi-regione Stati Uniti
    • eu per la multi-regione EU
    • global per la località globale
    Per saperne di più, consulta Specifica una multi-regione per il datastore.
  • PROJECT_NUMBER: il numero del tuo Google Cloud progetto.
  • LOCATION: la posizione geografica del datastore, ad esempio global. Per saperne di più, consulta Località.
  • NOTEBOOK_ID: l'identificatore univoco del notebook che hai ricevuto quando hai creato il notebook.

Se la richiesta va a buon fine, dovresti ricevere una risposta JSON simile alla seguente per un notebook vuoto. Se chiami questo metodo dopo aver aggiunto origini al notebook, ricevi i dettagli di tutte le origini aggiunte al notebook recuperato. Se hai configurato i dettagli di CMEK, ricevi anche le informazioni relative a CMEK per il 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"
}

Elenca i notebook visualizzati di recente

Per ottenere un elenco di tutti i notebook di un progetto visualizzati di recente, utilizza il notebooks.listRecentlyViewed metodo. Per impostazione predefinita, la risposta elenca gli ultimi 500 notebook. Puoi scegliere di impaginare le risposte con il parametro di query 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"

Sostituisci quanto segue:

  • ENDPOINT_LOCATION: la multi-regione per la richiesta API. Specifica uno dei seguenti valori:
    • us per la multi-regione Stati Uniti
    • eu per la multi-regione EU
    • global per la località globale
    Per saperne di più, consulta Specifica una multi-regione per il datastore.
  • PROJECT_NUMBER: il numero del tuo Google Cloud progetto.
  • LOCATION: la posizione geografica del datastore, ad esempio global. Per saperne di più, consulta Località.

Se la richiesta va a buon fine, dovresti ricevere una risposta JSON simile alla seguente. La risposta contiene fino agli ultimi 500 notebook a cui un utente ha avuto accesso di recente.

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

Elimina un notebook

Per eliminare un notebook, utilizza il notebooks.batchDelete metodo.

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

Sostituisci quanto segue:

  • ENDPOINT_LOCATION: la multi-regione per la richiesta API. Specifica uno dei seguenti valori:
    • us per la multi-regione Stati Uniti
    • eu per la multi-regione EU
    • global per la località globale
    Per saperne di più, consulta Specifica una multi-regione per il datastore.
  • PROJECT_NUMBER: il numero del tuo Google Cloud progetto.
  • LOCATION: la posizione geografica del datastore, ad esempio global. Per saperne di più, consulta Località.

  • NOTEBOOK_NAME: il nome completo della risorsa del notebook da eliminare. Questo campo ha il pattern: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID.

    Se la richiesta va a buon fine, ricevi un oggetto JSON vuoto. Se il notebook non esiste, ricevi anche un oggetto JSON vuoto, quindi assicurati di specificare correttamente il nome del notebook.

Condividi un notebook

Per condividere un nuovo notebook, utilizza il notebooks.share metodo.

All'utente con cui vuoi condividere il notebook deve essere concesso il ruolo Utente di Cloud Notebook.

REST

  1. Nel tuo Google Cloud progetto, assegna il ruolo Cloud NotebookLM User Identity and Access Management (IAM) agli utenti con cui vuoi condividere il notebook.

  2. Chiama il seguente metodo.

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

    Sostituisci quanto segue:

    • ENDPOINT_LOCATION: la multi-regione per la richiesta API. Specifica uno dei seguenti valori:
      • us per la multi-regione Stati Uniti
      • eu per la multi-regione EU
      • global per la località globale
      Per saperne di più, consulta Specifica una multi-regione per il datastore.
    • PROJECT_NUMBER: il numero del tuo Google Cloud progetto.
    • LOCATION: la posizione geografica del datastore, ad esempio global. Per saperne di più, consulta Località.
    • NOTEBOOK_ID: un ID univoco per identificare il notebook che vuoi condividere. L'ID del notebook è necessario per altre attività di gestione dei notebook, come la condivisione o il recupero.
    • USER_EMAIL: l'indirizzo email dell'utente con cui vuoi condividere il notebook.

    • USER_ROLE: un ruolo che vuoi assegnare all'utente. Può essere uno dei seguenti:

      • PROJECT_ROLE_OWNER: l'utente è il proprietario del progetto.
      • PROJECT_ROLE_WRITER: l'utente ha le autorizzazioni di scrittura sul progetto.
      • PROJECT_ROLE_READER: l'utente ha le autorizzazioni di lettura sul progetto.
      • PROJECT_ROLE_NOT_SHARED:l'utente non ha accesso al progetto.

    Se la richiesta va a buon fine, ricevi un oggetto JSON vuoto.

Verifica gli utenti utilizzando un browser

Per verificare se hai condiviso il notebook con gli utenti corretti e se hai assegnato loro i ruoli corretti:

  1. Apri il notebook nel browser. Un notebook ha il seguente pattern URL:

    1. Se utilizzi un'identità Google:

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

    2. Se utilizzi un'identità di terze parti:

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

  2. Fai clic su Condividi.

  3. Verifica gli utenti elencati come Persone con accesso e i ruoli assegnati.

Passaggi successivi