Datenquellen in einem Notebook hinzufügen und verwalten (API)

Nachdem Sie Ihr Notebook erstellt haben, können Sie ihm verschiedene Inhaltstypen als Datenquellen hinzufügen. Sie können dies in Batches oder als einzelne Dateien tun. Zu den Quellen gehören Google Docs, Google-Präsentationen, Rohtext, Webinhalte und YouTube-Videos.

Auf dieser Seite wird beschrieben, wie Sie die folgenden Aufgaben ausführen:

Hinweise

Wenn Sie Google Docs oder Google-Präsentationen als Datenquelle hinzufügen möchten, müssen Sie den Zugriff auf Google Drive mit Google-Nutzeranmeldedaten autorisieren. Führen Sie dazu den folgenden gloud auth login-Befehl aus und folgen Sie der Anleitung in der Befehlszeile.

gcloud auth login --enable-gdrive-access

Datenquellen im Batch hinzufügen

Rufen Sie die Methode notebooks.sources.batchCreate auf, um einem Notebook Quellen hinzuzufügen.

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/NOTEBOOK_ID/sources:batchCreate" \
  -d '{
  "userContents": [
    {
    USER_CONTENT
    }
   ]
  }'

Ersetzen Sie Folgendes:

  • ENDPOINT_LOCATION: Die multiregionale Einstellung für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
    • us- für die multiregionale Option „USA“
    • eu- für die EU-Multiregion
    • global- für den globalen Standort
    Weitere Informationen finden Sie unter Multi-Region für Ihren Datenspeicher angeben.
  • 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.
  • USER_CONTENT: Der Inhalt der Datenquelle.

Sie können nur eine der folgenden Datenquellen als Inhalt hinzufügen:

  • Fügen Sie für Google Drive-Inhalte, die aus Google-Dokumenten oder Google-Präsentationen bestehen, Folgendes hinzu:

     "googleDriveContent": {
   "documentId": "DOCUMENT_ID_GOOGLE",
   "mimeType": "MIME_TYPE",
   "sourceName": "DISPLAY_NAME_GOOGLE"
 }

    Ersetzen Sie Folgendes:

    • DOCUMENT_ID_GOOGLE: die ID der Datei in Google Drive. Diese ID wird in der URL der Datei angezeigt. Um die Dokument-ID einer Datei zu erhalten, öffnen Sie die Datei. Die URL hat das folgende Muster: https://docs.google.com/FILE_TYPE/d/DOCUMENT_ID_GOOGLE/edit?resourcekey=RESOURCE_KEY.
    • MIME_TYPE: Der MIME-Typ des ausgewählten Dokuments. Verwenden Sie application/vnd.google-apps.document für Google Docs oder application/vnd.google-apps.presentation für Google Präsentationen.
    • DISPLAY_NAME_GOOGLE: Der Anzeigename der Datenquelle.

  • Fügen Sie für die Rohtexteingabe Folgendes hinzu:

      "textContent": {
    "sourceName": "DISPLAY_NAME_TEXT",
    "content": "TEXT_CONTENT"
  }

    Ersetzen Sie Folgendes:

    • DISPLAY_NAME_TEXT: Der Anzeigename der Datenquelle.
    • TEXT_CONTENT: Der Roh-Textinhalt, den Sie als Datenquelle hochladen möchten.

  • Für Webinhalte fügen Sie Folgendes hinzu:

     "webContent": {
   "url": "URL_WEBCONTENT",
   "sourceName": "DISPLAY_NAME_WEB"
 }

    Ersetzen Sie Folgendes:

    • URL_WEBCONTENT: die URL der Inhalte, die Sie als Datenquelle hochladen möchten.
    • DISPLAY_NAME_WEB: Der Anzeigename der Datenquelle.

  • Fügen Sie für Videoinhalte Folgendes hinzu:

     "videoContent": {
   "url": "URL_YOUTUBE"
 }

    Ersetzen Sie URL_YOUTUBE durch die URL des YouTube-Videos, das Sie als Datenquelle hochladen möchten.

Wenn die Anfrage erfolgreich ist, sollten Sie eine Instanz des source-Objekts als Antwort erhalten, ähnlich dem folgenden JSON. Beachten Sie die SOURCE_ID und SOURCE_RESOURCE_NAME, die für andere Aufgaben wie das Abrufen oder Löschen der Datenquelle erforderlich sind.

{
  "sources": [
    {
      "sourceId": {
        "id": "SOURCE_ID"
      },
      "title": "DISPLAY_NAME",
      "metadata": {
        "xyz": "abc"
      },
      "settings": {
        "status": "SOURCE_STATUS_COMPLETE"
      },
      "name": "SOURCE_RESOURCE_NAME"
    }
  ]
}

Datei als Quelle hochladen

Sie können nicht nur Datenquellen in Batches hinzufügen, sondern auch einzelne Dateien hochladen, die als Datenquellen in Ihrem Notebook verwendet werden können. Rufen Sie die Methode notebooks.sources.uploadFile auf, um eine einzelne Datei hochzuladen.

REST

curl -X POST --data-binary "@PATH/TO/FILE" \
  -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  -H "X-Goog-Upload-File-Name: FILE_DISPLAY_NAME" \
  -H "X-Goog-Upload-Protocol: raw" \
  -H "Content-Type: CONTENT_TYPE" \
  "https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/upload/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID/sources:uploadFile" \

Ersetzen Sie Folgendes:

  • PATH/TO/FILE: Der Pfad zur Datei, die Sie hochladen möchten.
  • FILE_DISPLAY_NAME: Ein String, der den Anzeigenamen der Datei im Notebook angibt.
  • CONTENT_TYPE: Der Inhaltstyp, den Sie hochladen möchten. Eine Liste der unterstützten Inhaltstypen finden Sie unter Unterstützte Inhaltstypen.
  • ENDPOINT_LOCATION: Die multiregionale Einstellung für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
    • us- für die multiregionale Option „USA“
    • eu- für die EU-Multiregion
    • global- für den globalen Standort
    Weitere Informationen finden Sie unter Multi-Region für Ihren Datenspeicher angeben.
  • 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.

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

{
  "sourceId": {
    "id": "SOURCE_ID"
  }
}

Unterstützte Inhaltstypen

Die Datei, die Sie als Quelle hochladen, muss unterstützt werden.

Die folgenden Dokumentinhaltstypen werden unterstützt:

Dateiendung Inhaltstyp
PDF application/pdf
TXT text/plain
.md text/markdown
DOCX application/vnd.openxmlformats-officedocument.wordprocessingml.document
PPTX application/vnd.openxmlformats-officedocument.presentationml.presentation
XLSX application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Die folgenden Audio-Inhaltstypen werden unterstützt:

Dateiendung Inhaltstyp
3G2 audio/3gpp2
3GP audio/3gpp
.aac audio/aac
.aif audio/aiff
.aifc audio/aiff
AIFF audio/aiff
.amr audio/amr
.au audio/basic
AVI video/x-msvideo
.cda application/x-cdf
M4A audio/m4a
.mid audio/midi
.midi audio/midi
.mp3 audio/mpeg
.mp4 video/mp4
MPEG audio/mpeg
OGG audio/ogg
.opus audio/ogg
.ra audio/vnd.rn-realaudio
.ram audio/vnd.rn-realaudio
.snd audio/basic
WAV audio/wav
.weba audio/webm
.wma audio/x-ms-wma

Die folgenden Bildinhalte werden unterstützt:

Dateiendung Inhaltstyp
.png image/png
JPG image/jpg
.jpeg image/jpeg

Quelle abrufen

Wenn Sie eine bestimmte Quelle abrufen möchten, die einem Notebook hinzugefügt wurde, verwenden Sie die Methode notebooks.sources.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/sources/SOURCE_ID"

Ersetzen Sie Folgendes:

  • ENDPOINT_LOCATION: Die multiregionale Einstellung für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
    • us- für die multiregionale Option „USA“
    • eu- für die EU-Multiregion
    • global- für den globalen Standort
    Weitere Informationen finden Sie unter Multi-Region für Ihren Datenspeicher angeben.
  • 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, die Sie beim Erstellen des Notebooks erhalten haben. Weitere Informationen finden Sie unter Notebook erstellen.
  • SOURCE_ID: Die Kennung der Quelle, die Sie beim Hinzufügen der Quelle zu Ihrem Notebook erhalten haben.

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

{
  "sources": [
    {
      "sourceId": {
        "id": "SOURCE_ID"
      },
      "title": "DISPLAY_NAME",
      "metadata": {
        "wordCount": 148,
        "tokenCount": 160
      },
      "settings": {
        "status": "SOURCE_STATUS_COMPLETE"
      },
     "name": "SOURCE_RESOURCE_NAME"

    }
  ]
}

Datenquellen aus einem Notebook löschen

Wenn Sie Datenquellen in einem Notebook im Bulk löschen möchten, verwenden Sie die Methode notebooks.sources.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/"NOTEBOOK_ID"/sources:batchDelete"
    -d '{
      "names": [
        "SOURCE_RESOURCE_NAME_1",
        "SOURCE_RESOURCE_NAME_2"
      ]
    }'

Ersetzen Sie Folgendes:

  • ENDPOINT_LOCATION: Die multiregionale Einstellung für Ihre API-Anfrage. Weisen Sie einen der folgenden Werte zu:
    • us- für die multiregionale Option „USA“
    • eu- für die EU-Multiregion
    • global- für den globalen Standort
    Weitere Informationen finden Sie unter Multi-Region für Ihren Datenspeicher angeben.
  • 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.
  • SOURCE_RESOURCE_NAME: der vollständige Ressourcenname der zu löschenden Datenquelle. Dieses Feld hat das folgende Muster: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID/source/SOURCE_ID.

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

Nächste Schritte