Notebooks erstellen und verwalten (API)

NotebookLM Enterprise ist ein leistungsstarkes Tool, mit dem Sie Erkenntnisse aus Ihren Dokumenten gewinnen und zusammenfassen können. Auf dieser Seite werden die APIs beschrieben, mit denen Sie folgende Notebook-Managementaufgaben ausführen können:

• Notebook erstellen
• Notebook aufrufen
• Kürzlich angesehene Notebooks auflisten
• Notebooks im Batch löschen
• Notebook freigeben

Notebook erstellen

Verwenden Sie zum Erstellen eines neuen Notebooks die Methode 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",
  }'

Ersetzen Sie Folgendes:

• ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
  • us- für die multiregionale Option „USA“
  • eu- für die multiregionale Option „EU“
  • global- für den globalen Standort
  Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
• PROJECT_NUMBER: Die Nummer Ihres Projekts von Google Cloud .
• LOCATION: Der geografische Standort Ihres Datenspeichers, z. B. global. Weitere Informationen finden Sie unter Standorte.
• NOTEBOOK_TITLE: Ein UTF-8-codierter String, der als Titel für das zu erstellende Notebook verwendet wird.

Wenn die Anfrage erfolgreich ist, sollten Sie eine JSON-Antwort ähnlich der folgenden erhalten.

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

Hinweis:

• NOTEBOOK_ID: Die eindeutige ID zur Identifizierung des erstellten Notebooks. Sie benötigen die Notebook-ID für andere Notebook-Verwaltungsaufgaben, z. B. zum Freigeben oder Abrufen.
• NOTEBOOK_NAME: Der vollständige Ressourcenname des Notebooks. Dieses Feld hat das folgende Muster: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID

Auf das erstellte Notebook zugreifen und die ID in einem Browser abrufen

So greifen Sie über einen Browser auf das erstellte Notebook zu und rufen seine ID ab:

1. Rufen Sie die NotebookLM Enterprise-Startseite unter einer der folgenden URLs auf:

   1. Wenn Sie eine Google-Identität verwenden, rufen Sie folgende Seite auf:

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

   2. Wenn Sie eine Drittanbieteridentität verwenden, rufen Sie Folgendes auf:

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

2. Wählen Sie das erstellte Notebook aus. Die URL des ausgewählten Notebooks hat das folgende Muster:

   1. Wenn Sie eine Google-Identität verwenden:

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

   2. Wenn Sie eine Drittanbieteridentität verwenden:

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

3. Notieren Sie die URL und die Notebook-ID. Sie sind für andere Notebook-Verwaltungsaufgaben wie das Teilen nützlich.

Notebook aufrufen

Verwenden Sie die Methode notebooks.get, um ein bestimmtes Notebook anhand seiner Notebook-ID aufzurufen.

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"

Ersetzen Sie Folgendes:

• ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
  • us- für die multiregionale Option „USA“
  • eu- für die multiregionale Option „EU“
  • global- für den globalen Standort
  Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
• PROJECT_NUMBER: Die Nummer Ihres Google Cloud -Projekts.
• LOCATION: Der geografische Standort Ihres Datenspeichers, z. B. global. Weitere Informationen finden Sie unter Standorte.
• NOTEBOOK_ID: Die eindeutige Kennung des Notebooks, die Sie beim Erstellen des Notebooks erhalten haben.

Wenn die Anfrage erfolgreich ist, sollten Sie eine JSON-Antwort ähnlich der folgenden für ein leeres Notebook erhalten. Wenn Sie diese Methode aufrufen, nachdem Sie Ihrem Notebook Quellen hinzugefügt haben, erhalten Sie Details zu allen Quellen, die dem abgerufenen Notebook hinzugefügt wurden. Wenn Sie vom Kunden verwaltete Verschlüsselungsschlüssel (CMEK) konfiguriert haben, erhalten Sie auch CMEK-bezogene Informationen für das 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"
}

Kürzlich angesehene Notebooks auflisten

Mit der Methode notebooks.listRecentlyViewed können Sie eine Liste aller Notebooks in einem Projekt abrufen, die zuletzt aufgerufen wurden. Standardmäßig werden in der Antwort die letzten 500 Notebooks aufgeführt. Sie können die Antworten mit dem Abfrageparameter pageSize paginieren.

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"

Ersetzen Sie Folgendes:

• ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
  • us- für die multiregionale Option „USA“
  • eu- für die multiregionale Option „EU“
  • global- für den globalen Standort
  Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
• PROJECT_NUMBER: Die Nummer Ihres Projekts von Google Cloud .
• LOCATION: Der geografische Standort Ihres Datenspeichers, z. B. global. Weitere Informationen finden Sie unter Standorte.

Wenn die Anfrage erfolgreich ist, sollte eine JSON-Antwort ähnlich der folgenden zurückgegeben werden. Die Antwort enthält bis zu 500 Notebooks, auf die ein Nutzer zuletzt zugegriffen hat.

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

Notebooks im Batch löschen

Wenn Sie Notebooks im Batch löschen möchten, verwenden Sie die Methode 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"
    ]
  }'

Ersetzen Sie Folgendes:

• ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
  • us- für die multiregionale Option „USA“
  • eu- für die multiregionale Option „EU“
  • global- für den globalen Standort
  Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
• PROJECT_NUMBER: Die Nummer Ihres Projekts von Google Cloud .
• LOCATION: Der geografische Standort Ihres Datenspeichers, z. B. global. Weitere Informationen finden Sie unter Standorte.

• NOTEBOOK_NAME: Der vollständige Ressourcenname des Notebooks, das gelöscht werden soll. Dieses Feld hat das Muster: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID.

  Wenn die Anfrage erfolgreich ist, sollten Sie ein leeres JSON-Objekt erhalten.

Notebook freigeben

Wenn Sie ein neues Notebook freigeben möchten, verwenden Sie die Methode notebooks.share.

Dem Nutzer, für den Sie das Notebook freigeben möchten, muss die Rolle Cloud Notebook-Nutzer zugewiesen werden.

REST

1. Weisen Sie in Ihrem Google Cloud -Projekt die IAM-Rolle (Identity and Access Management) Cloud NotebookLM User den Nutzern zu, für die Sie das Notebook freigeben möchten.

2. Rufen Sie die folgende Methode auf.

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

   Ersetzen Sie Folgendes:

   • ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
     • us- für die multiregionale Option „USA“
     • eu- für die multiregionale Option „EU“
     • global- für den globalen Standort
     Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
   • PROJECT_NUMBER: Die Nummer Ihres Projekts von Google Cloud .
   • LOCATION: Der geografische Standort Ihres Datenspeichers, z. B. global. Weitere Informationen finden Sie unter Standorte.
   • NOTEBOOK_ID: Eindeutige ID zur Identifizierung des Notebooks, das Sie freigeben möchten. Sie benötigen die Notebook-ID für andere Notebook-Verwaltungsaufgaben, z. B. zum Freigeben oder Abrufen.
   • USER_EMAIL: Die E-Mail-Adresse des Nutzers, für den Sie das Notebook freigeben möchten.

   • USER_ROLE: Eine Rolle, die Sie dem Nutzer zuweisen möchten. Diese Rollen stehen zur Verfügung:

     • PROJECT_ROLE_OWNER: Der Nutzer ist der Inhaber des Projekts.
     • PROJECT_ROLE_WRITER: Der Nutzer hat eine Schreibberechtigung für das Projekt.
     • PROJECT_ROLE_READER: Der Nutzer hat eine Leseberechtigung für das Projekt.
     • PROJECT_ROLE_NOT_SHARED: Der Nutzer hat keinen Zugriff auf das Projekt.

   Wenn die Anfrage erfolgreich ist, erhalten Sie ein leeres JSON-Objekt.

Nutzer über einen Browser prüfen

So prüfen Sie, ob Sie das Notebook für die richtigen Nutzer freigegeben und ihnen die richtigen Rollen zugewiesen haben:

1. Öffnen Sie das Notebook in Ihrem Browser. Ein Notebook hat das folgende URL-Muster:

   1. Wenn Sie eine Google-Identität verwenden:

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

   2. Wenn Sie eine Drittanbieteridentität verwenden:

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

2. Klicken Sie auf Freigeben.

3. Prüfen Sie die Nutzer, die unter Personen mit Zugriff aufgeführt sind, und die ihnen zugewiesenen Rollen.

Nächste Schritte

• Datenquellen unterschiedlicher Typen programmatisch zu Notebooks hinzufügen