Index
AudioOverviewService
(Schnittstelle)NotebookService
(Schnittstelle)SourceService
(Schnittstelle)AccountAndRole
(Meldung)AgentspaceMetadata
(Meldung)AudioOverview
(Meldung)AudioOverview.MimeType
(Aufzählung)AudioOverviewGenerationOptions
(Meldung)AudioOverviewStatus
(Aufzählung)BatchCreateSourcesRequest
(Meldung)BatchCreateSourcesResponse
(Meldung)BatchDeleteNotebooksRequest
(Meldung)BatchDeleteSourcesRequest
(Meldung)CmekConfig
(Meldung)CreateAudioOverviewRequest
(Meldung)CreateAudioOverviewResponse
(Meldung)CreateNotebookRequest
(Meldung)DeleteAudioOverviewRequest
(Meldung)FailureReason
(Meldung)FailureReason.AudioTranscriptionError
(Meldung)FailureReason.AudioTranscriptionError.LanguageDetectionFailed
(Meldung)FailureReason.AudioTranscriptionError.NoAudioDetected
(Meldung)FailureReason.DomainBlocked
(Meldung)FailureReason.GoogleDriveError
(Meldung)FailureReason.GoogleDriveError.DownloadPrevented
(Meldung)FailureReason.IngestionError
(Meldung)FailureReason.PaywallError
(Meldung)FailureReason.SourceEmpty
(Meldung)FailureReason.SourceLimitExceeded
(Meldung)FailureReason.SourceTooLong
(Meldung)FailureReason.SourceUnreachable
(Meldung)FailureReason.Unknown
(Meldung)FailureReason.UploadError
(Meldung)FailureReason.YoutubeError
(Meldung)FailureReason.YoutubeError.VideoDeleted
(Meldung)GetNotebookRequest
(Meldung)GetSourceRequest
(Meldung)GoogleDocsSourceMetadata
(Meldung)ListRecentlyViewedNotebooksRequest
(Meldung)ListRecentlyViewedNotebooksResponse
(Meldung)Notebook
(Meldung)NotebookMetadata
(Meldung)ProjectRole
(Aufzählung)ShareNotebookRequest
(Meldung)ShareNotebookResponse
(Meldung)Source
(Meldung)SourceId
(Meldung)SourceMetadata
(Meldung)SourceSettings
(Meldung)SourceStatus
(enum)SourceUnreachableErrorReason
(enum)UserContent
(Meldung)UserContent.AgentspaceContent
(Meldung)UserContent.GoogleDriveContent
(Meldung)UserContent.TextContent
(Meldung)UserContent.VideoContent
(Meldung)UserContent.WebContent
(Meldung)YoutubeMetadata
(Meldung)
AudioOverviewService
Dienst zur Verwaltung von Audio-Zusammenfassungen.
CreateAudioOverview |
---|
Erstellt eine neue Audio-Zusammenfassung.
|
DeleteAudioOverview |
---|
Löscht eine Audio-Zusammenfassung.
|
NotebookService
Dienst zur Verwaltung von Notebooks.
BatchDeleteNotebooks |
---|
Löscht Notebooks im Batch.
|
CreateNotebook |
---|
Erstellt ein Notebook.
|
GetNotebook |
---|
Ruft ein Notebook ab.
|
ListRecentlyViewedNotebooks |
---|
Listet die Notebooks nach dem Zeitpunkt des letzten Aufrufs auf.
|
SourceService
Dienst zur Verwaltung von Quellen.
BatchCreateSources |
---|
Erstellt eine Liste mit
|
BatchDeleteSources |
---|
Mehrere Quellen löschen
|
GetSource |
---|
Erstellt einen
|
AccountAndRole
Konto- und Rolleninformationen.
Felder | |
---|---|
email |
Erforderlich. Die mit dem Konto verknüpfte E‑Mail-Adresse. |
role |
Erforderlich. Die Rolle im Notebook. |
AgentspaceMetadata
Metadaten zu einer Agentspace-Quelle.
Felder | |
---|---|
document_name |
Nur Ausgabe. Der vollständige Dokumentname in Agentspace. |
document_title |
Nur Ausgabe. Der Titel des Dokuments. |
AudioOverview
Eine Audio-Zusammenfassung eines Notebooks. Dies ist eine Zusammenfassung des Notebooks im Audioformat.
Felder | |
---|---|
name |
ID. Der vollständige Ressourcenname des Notebooks. Format: Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein. |
audio_overview_id |
Nur Ausgabe. Eindeutige ID der Audioübersicht. |
status |
Der Status der Audio-Zusammenfassung. |
generation_options |
Die Optionen, die zum Generieren der Audio-Zusammenfassung verwendet wurden. |
mime_type |
Der MIME-Typ der Audio-Zusammenfassung. |
language_code |
Der Sprachcode der generierten Audio-Zusammenfassung. Verwenden Sie den BCP 47-Sprachcode (z. B. „en“, „es“, „hi“). |
MimeType
Unterstützte MIME-Typen für Audio-Zusammenfassungen.
Enums | |
---|---|
MIME_TYPE_UNKNOWN |
Der MIME-Typ wurde nicht festgelegt. |
MIME_TYPE_WAV |
Der MIME-Typ ist „audio/wav“. |
MIME_TYPE_MP4 |
Der MIME-Typ ist „audio/mp4“. |
AudioOverviewGenerationOptions
Optionen, die beim Erstellen der Audio-Zusammenfassung verwendet werden.
Felder | |
---|---|
source_ids[] |
Optional. Die Quellen, auf denen die Audio-Zusammenfassung basiert. |
episode_focus |
Worauf sich die Moderatoren der Show konzentrieren sollen. |
language_code |
Die Sprache, in der die Audio-Zusammenfassung angefordert wurde. |
AudioOverviewStatus
Der Status einer Audio-Zusammenfassung.
Enums | |
---|---|
AUDIO_OVERVIEW_STATUS_UNSPECIFIED |
Der Status wurde nicht festgelegt. |
AUDIO_OVERVIEW_STATUS_NOT_STARTED |
Die Audio-Zusammenfassung wurde noch nicht erstellt. |
AUDIO_OVERVIEW_STATUS_IN_PROGRESS |
Die Audio-Zusammenfassung wird gerade erstellt. |
AUDIO_OVERVIEW_STATUS_COMPLETE |
Die Audio-Zusammenfassung wurde erstellt und ist verfügbar. |
AUDIO_OVERVIEW_STATUS_FAILED |
Die Audio-Zusammenfassung konnte nicht generiert werden. |
BatchCreateSourcesRequest
Anfrage für die Methode SourceService.BatchCreateSources
.
Felder | |
---|---|
parent |
Erforderlich. Die übergeordnete Ressource, in der die Quellen erstellt werden. Format: projects/{project}/locations/{location}/notebooks/{notebook} |
user_contents[] |
Erforderlich. Die |
BatchCreateSourcesResponse
Antwort für die Methode SourceService.BatchCreateSources
.
Felder | |
---|---|
sources[] |
Die |
BatchDeleteNotebooksRequest
Anfrage für die Methode NotebookService.BatchDeleteNotebooks
.
Felder | |
---|---|
parent |
Erforderlich. Der Ressourcenname des übergeordneten Zweigs, z. B. |
names[] |
Erforderlich. Vollständige Ressourcennamen von |
BatchDeleteSourcesRequest
Anfrage für die Methode [SourceService.BatchDeleteSourcesRequest][].
Felder | |
---|---|
parent |
Erforderlich. Die übergeordnete Ressource, in der die Quellen gelöscht werden. Format: projects/{project}/locations/{location}/notebooks/{notebook} |
names[] |
Erforderlich. Namen der zu löschenden Quellen. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source} |
CmekConfig
Konfiguration der vom Kunden verwalteten Verschlüsselung für Notebooks.
Felder | |
---|---|
kms_key |
Erforderlich. Der Ressourcenname des KMS-Schlüssels, der zum Verschlüsseln von Ressourcen |
CreateAudioOverviewRequest
Anfrage für die Methode AudioOverviewService.CreateAudioOverview
.
Felder | |
---|---|
parent |
Erforderlich. Die übergeordnete Ressource, in der dieses Notebook erstellt wird. Format: projects/{project}/locations/{location}/notebooks/{notebook} |
generation_options |
Optionen für die Erstellung der Audio-Zusammenfassung. |
CreateAudioOverviewResponse
Antwort für die Methode AudioOverviewService.CreateAudioOverview
.
Felder | |
---|---|
audio_overview |
Die generierte Audio-Zusammenfassung. |
CreateNotebookRequest
Anfrage für die Methode NotebookService.CreateNotebook
.
Felder | |
---|---|
parent |
Erforderlich. Der Name der übergeordneten Ressource, z. B. |
notebook |
Erforderlich. Das zu erstellende Notebook. |
DeleteAudioOverviewRequest
Anfrage für die Methode AudioOverviewService.DeleteAudioOverview
.
Felder | |
---|---|
name |
Erforderlich. Der vollständige Ressourcenname der |
FailureReason
Fehlerursache mit Details dazu, warum die Aufnahme einer Quelle fehlgeschlagen ist.
Felder | |
---|---|
Union-Feld error . Der spezifische Fehler. Für error ist nur einer der folgenden Werte zulässig: |
|
unknown |
Gibt an, dass ein unbekannter Fehler aufgetreten ist. |
source_too_long |
Gibt an, dass die Anzahl der Quellwörter das Limit des Nutzers überschritten hat. |
ingestion_error |
Gibt an, dass beim Aufnehmen der Quelle ein Fehler aufgetreten ist. |
source_empty |
Gibt an, dass die Quelle leer ist. |
upload_error |
Gibt an, dass beim Hochladen der Quelle ein Fehler aufgetreten ist. |
paywall_error |
Gibt an, dass die Quelle kostenpflichtig ist und nicht aufgenommen werden kann. |
source_unreachable |
Gibt an, dass die Quelle nicht erreichbar ist. |
google_drive_error |
Ein Google Drive-spezifischer Fehler. |
youtube_error |
Ein YouTube-spezifischer Fehler. |
audio_transcription_error |
Ein Fehler, der speziell bei der Transkription von Audiodateien auftritt. |
source_limit_exceeded |
Fehler, wenn der Nutzer versucht, über seine Beschränkungen hinaus zu aktualisieren. |
domain_blocked |
Fehler, wenn der Nutzer versucht, eine Quelle aus einer blockierten Domain hinzuzufügen. |
AudioTranscriptionError
Ein Fehler, der speziell bei der Transkription von Audiodateien auftritt.
Felder | |
---|---|
Union-Feld error . Der spezifische Fehler bei der Transkription der Audiodatei. Für error ist nur einer der folgenden Werte zulässig: |
|
language_detection_failed |
Die Sprache der Datei konnte nicht erkannt werden. Möglicherweise enthält sie keine Sprache. |
no_audio_detected |
In der Eingabedatei wurde kein Audio erkannt (möglicherweise war es ein Video). |
LanguageDetectionFailed
Dieser Typ hat keine Felder.
Die Sprache der Datei konnte nicht erkannt werden. Möglicherweise enthält sie keine Sprache.
NoAudioDetected
Dieser Typ hat keine Felder.
In der Eingabedatei wurde kein Audio erkannt.
DomainBlocked
Dieser Typ hat keine Felder.
Fehler, der angibt, dass die Quelle entfernt wurde, weil die Domain blockiert wurde.
GoogleDriveError
Ein Google Drive-spezifischer Fehler.
Felder | |
---|---|
Union-Feld error . Der Drive-spezifische Fehler. Für error ist nur einer der folgenden Werte zulässig: |
|
download_prevented |
Der Nutzer konnte die Datei nicht herunterladen. |
DownloadPrevented
Dieser Typ hat keine Felder.
Der Nutzer konnte die Datei nicht herunterladen.
IngestionError
Dieser Typ hat keine Felder.
Gibt an, dass beim Aufnehmen der Quelle ein Fehler aufgetreten ist.
PaywallError
Dieser Typ hat keine Felder.
Gibt an, dass die Quelle kostenpflichtig ist und nicht aufgenommen werden kann.
SourceEmpty
Dieser Typ hat keine Felder.
Gibt an, dass die Quelle leer ist.
SourceLimitExceeded
Dieser Typ hat keine Felder.
Gibt an, dass der Nutzer nicht genügend Speicherplatz für diese Quelle hat.
SourceTooLong
Gibt an, dass die Anzahl der Quellwörter das Limit des Nutzers überschritten hat.
Felder | |
---|---|
word_count |
Die Anzahl der Wörter in der Quelle. |
word_limit |
Das Wortanzahllimit für den aktuellen Nutzer zum Zeitpunkt des Uploads. |
SourceUnreachable
Gibt an, dass die Quelle nicht erreichbar ist. Dies wird hauptsächlich für Quellen verwendet, die über eine URL hinzugefügt werden.
Felder | |
---|---|
error_details |
Beschreibt, warum die Quelle nicht erreichbar ist. |
Unbekannt
Dieser Typ hat keine Felder.
Gibt an, dass ein unbekannter Fehler aufgetreten ist.
UploadError
Dieser Typ hat keine Felder.
Gibt an, dass beim Hochladen der Quelle ein Fehler aufgetreten ist.
YoutubeError
Ein YouTube-spezifischer Fehler.
Felder | |
---|---|
Union-Feld error . Der YouTube-spezifische Fehler. Für error ist nur einer der folgenden Werte zulässig: |
|
video_deleted |
Fehler, der angibt, dass die Quelle entfernt wurde, weil das Video gelöscht wurde. |
VideoDeleted
Dieser Typ hat keine Felder.
Fehler, der angibt, dass die Quelle entfernt wurde, weil das Video gelöscht wurde.
GetNotebookRequest
Anfrage für die Methode NotebookService.GetNotebook
.
Felder | |
---|---|
name |
Erforderlich. Vollständiger Ressourcenname von |
GetSourceRequest
Anfrage für die Methode SourceService.GetSource
.
Felder | |
---|---|
name |
Erforderlich. Der Ressourcenname für die Quelle. Format: „projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}“ |
GoogleDocsSourceMetadata
Metadaten zu einer Google-Dokument-Quelle.
Felder | |
---|---|
document_id |
Nur Ausgabe. Die Dokument-ID des Google-Dokuments. |
revision_id |
Nur Ausgabe. Versions-ID für das Dokument. |
ListRecentlyViewedNotebooksRequest
Anfrage für die Methode NotebookService.ListRecentlyViewedNotebooks
.
Felder | |
---|---|
parent |
Erforderlich. Der Ressourcenname des übergeordneten Zweigs, z. B. |
page_size |
Optional. Maximale Anzahl der zurückzugebenden |
page_token |
Optional. Das Seitentoken. Geben Sie dieses an, um die nachfolgende Seite abzurufen. |
ListRecentlyViewedNotebooksResponse
Antwort für die Methode NotebookService.ListRecentlyViewedNotebooks
.
Felder | |
---|---|
notebooks[] |
Die Liste der zuletzt aufgerufenen Notebooks. |
next_page_token |
Das Seitentoken. Geben Sie dieses an, um die nachfolgende Seite abzurufen. |
Notebook
Ein Notebook ist eine Ressource, in der Nutzer ihre Inhalte (als Quellen) speichern und mit den Inhalten interagieren können.
Felder | |
---|---|
name |
ID. Die ID des Notebooks. Format: Dieses Feld muss ein UTF-8-codierter String sein. |
sources[] |
Nur Ausgabe. Liste der Quellen im Notebook. Dieses Feld dient nur der Ausgabe. |
cmek_config |
Nur Ausgabe. CMEK-bezogene Informationen für das Notebook. |
title |
Optional. Der Titel des Notebooks. |
notebook_id |
Nur Ausgabe. Die Notebook-ID, die das letzte Segment des Ressourcennamens des Notebooks ist. |
emoji |
Nur Ausgabe. Das Emoji des Notebooks. |
metadata |
Nur Ausgabe. Die Metadaten des Notebooks. |
NotebookMetadata
Metadaten für ein Notebook.
Felder | |
---|---|
is_shared |
„True“, wenn dieses Projekt derzeit für andere Nutzer freigegeben ist, andernfalls „False“. |
is_shareable |
„True“, wenn das Projekt freigegeben werden kann. |
last_viewed |
Ein Zeitstempel, der angibt, wann der aktuelle Nutzer in der Sitzung das Projekt zuletzt aufgerufen hat. |
create_time |
Der Zeitpunkt, zu dem dieses Projekt erstellt wurde. |
ProjectRole
Die Rolle des Projekts.
Enums | |
---|---|
PROJECT_ROLE_UNKNOWN |
Unbekannte Rolle. |
PROJECT_ROLE_OWNER |
Der Nutzer ist Inhaber des Projekts. |
PROJECT_ROLE_WRITER |
Der Nutzer hat Schreibberechtigungen für das Projekt. |
PROJECT_ROLE_READER |
Der Nutzer hat Leseberechtigungen für das Projekt. |
PROJECT_ROLE_NOT_SHARED |
Der Nutzer hat keinen Zugriff auf das Projekt. |
Quelle
Eine Quelle stellt eine einzelne Inhaltsquelle dar.
Felder | |
---|---|
name |
ID. Der vollständige Ressourcenname der Quelle. Format: Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein. |
title |
Optional. Titel der Quelle. |
source_id |
Optional. Nur Ausgabe. Die Quell-ID, die das letzte Segment des Ressourcennamens der Quelle ist. |
metadata |
Nur Ausgabe. Metadaten zur Quelle. |
settings |
Nur Ausgabe. Status der Quelle und alle Fehlerursachen. |
SourceId
„SourceId“ ist das letzte Segment des Ressourcennamens der Quelle.
Felder | |
---|---|
id |
Die ID der Quelle. |
SourceMetadata
Stellt die Metadaten einer Quelle und einige zusätzliche Informationen dar.
Felder | |
---|---|
Union-Feld metadata . Metadaten für die Quelle. Für metadata ist nur einer der folgenden Werte zulässig: |
|
google_docs_metadata |
Metadaten für eine Google-Dokument-Quelle. |
youtube_metadata |
Metadaten für eine YouTube-Videoquelle. |
agentspace_metadata |
Metadaten für eine Agentspace-Quelle. |
word_count |
Die Wortzahl der Quelle. |
token_count |
Die Anzahl der Tokens in der Quelle. |
source_added_timestamp |
Der Zeitstempel, zu dem die Quelle hinzugefügt wurde. |
SourceSettings
Ermöglicht die Erweiterung der Quelleneinstellungen in der BatchCreateSources-Anfrage (früher AddSource-Anfrage).
Felder | |
---|---|
status |
Status der Quelle. |
failure_reason |
Fehlerursache mit Details dazu, warum die Aufnahme einer Quelle fehlgeschlagen ist. |
SourceStatus
Liste der möglichen Status für eine Quelle.
Enums | |
---|---|
SOURCE_STATUS_UNSPECIFIED |
Nicht angegebener Status. |
SOURCE_STATUS_PENDING |
Die Quelle wird gerade hinzugefügt. |
SOURCE_STATUS_COMPLETE |
Das Hinzufügen der Quelle ist abgeschlossen und war erfolgreich. |
SOURCE_STATUS_ERROR |
Das Hinzufügen der Quelle ist dauerhaft fehlgeschlagen. |
SOURCE_STATUS_PENDING_DELETION |
Die Quelle wird gerade gelöscht. |
SOURCE_STATUS_TENTATIVE |
Der Nutzer versucht, eine Quelle hinzuzufügen, aber wir haben sie noch nicht hochgeladen oder die Nutzerlimits geprüft. Wird nicht auf das Quellenlimit des Nutzers angerechnet. |
SourceUnreachableErrorReason
Details dazu, warum die Quelle nicht erreichbar ist. Wird verwendet, um dem Nutzer die entsprechende Meldung anzuzeigen.
Enums | |
---|---|
ERROR_REASON_UNSPECIFIED |
Standard |
ERROR_REASON_INVALID_URL |
Die Quell-URL ist ungültig. |
ERROR_REASON_NOT_ACCESSIBLE |
Auf die Quell-URL kann nicht zugegriffen werden. |
ERROR_REASON_NOT_REACHABLE |
Die Quell-URL ist nicht erreichbar. |
ERROR_REASON_URL_NOT_FOUND |
Die Quell-URL hat den Fehlercode 404 zurückgegeben. |
ERROR_REASON_TRANSIENT_ERROR |
Die Quell-URL ist aufgrund eines vorübergehenden Netzwerkfehlers oder einer Zeitüberschreitung des Hosts usw. nicht erreichbar. |
ERROR_REASON_FETCH_FAILED |
Die Quell-URL konnte aufgrund eines internen Fehlers nicht abgerufen werden. |
ERROR_REASON_NOT_SUPPORTED |
Die URL wird noch nicht unterstützt. Beispiele: Die abgerufenen Inhalte überschreiten die maximale Größe für den Abruf durch den Trawler, die abgerufenen Inhalte haben einen Typ, der noch nicht unterstützt wird usw. |
UserContent
Die Meldungen vom Typ „Inhalt“ beziehen sich auf Daten, die der Nutzer hochladen möchte.
Felder | |
---|---|
Union-Feld content . Die Nutzerinhalte. Für content ist nur einer der folgenden Werte zulässig: |
|
google_drive_content |
Die Inhalte aus Google Drive. |
text_content |
Der als Quelle hochgeladene Textinhalt. |
web_content |
Die als Quelle hochgeladenen Webinhalte. |
video_content |
Die als Quelle hochgeladenen Videoinhalte. |
agentspace_content |
Als Quelle hochgeladene Agentspace-Inhalte. |
AgentspaceContent
Als Quelle hochgeladene Agentspace-Inhalte.
Felder | |
---|---|
document_name |
Optional. Der vollständige Ressourcenname des Agentspace-Dokuments. Format: |
engine_name |
Optional. Engine zum Überprüfen der Berechtigung für das Dokument. Format: |
ideaforge_idea_name |
Optional. Ressourcenname der Idea Forge-Instanz. Format: |
GoogleDriveContent
Die Inhalte aus Google Drive.
Felder | |
---|---|
document_id |
Die Dokument-ID des ausgewählten Dokuments. |
mime_type |
Der MIME-Typ des ausgewählten Dokuments. Damit kann der Typ des im Laufwerk-Picker ausgewählten Inhalts unterschieden werden. Verwenden Sie „application/vnd.google-apps.document“ für Google Docs oder „application/vnd.google-apps.presentation“ für Google Präsentationen. |
source_name |
Der Name, der für die Quelle angezeigt werden soll. |
TextContent
Der als Quelle hochgeladene Textinhalt.
Felder | |
---|---|
source_name |
Der Anzeigename der Textquelle. |
content |
Der Name, der für die Quelle angezeigt werden soll. |
VideoContent
Als Quelle hochgeladene Videoinhalte
Felder | |
---|---|
Union-Feld format . Gibt das Format der Videoinhalte an. format kann nur einer der folgenden Werte sein: |
|
youtube_url |
Die YouTube-URL des Videoinhalts. |
WebContent
Die als Quelle hochgeladenen Webinhalte.
Felder | |
---|---|
url |
Wenn eine URL angegeben wird, wird die Webseite im Backend abgerufen. |
source_name |
Der Name, der für die Quelle angezeigt werden soll. |
YoutubeMetadata
Metadaten zu einer YouTube-Videoquelle.
Felder | |
---|---|
video_id |
Nur Ausgabe. Die ID des YouTube-Videos. |
channel_name |
Nur Ausgabe. Der Kanalname des YouTube-Videos. |