REST Resource: projects.locations.notebooks.sources

Ressource: Quelle

Eine Quelle stellt eine einzelne Inhaltsquelle dar.

JSON-Darstellung 
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
Felder
name

string

ID. Der vollständige Ressourcenname der Quelle. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
title

string

Optional. Titel der Quelle.
sourceId

object (SourceId)

Optional. Nur Ausgabe. Die Quell-ID, die das letzte Segment des Ressourcennamens der Quelle ist.
metadata

object (SourceMetadata)

Nur Ausgabe. Metadaten zur Quelle.
settings

object (SourceSettings)

Nur Ausgabe. Status der Quelle und alle Fehlerursachen.

SourceMetadata

Stellt die Metadaten einer Quelle und einige zusätzliche Informationen dar.

JSON-Darstellung 
{

  // Union field metadata can be only one of the following:
  "googleDocsMetadata": {
    object (GoogleDocsSourceMetadata)
  },
  "youtubeMetadata": {
    object (YoutubeMetadata)
  },
  "agentspaceMetadata": {
    object (AgentspaceMetadata)
  }
  // End of list of possible types for union field metadata.
  "wordCount": integer,
  "tokenCount": integer,
  "sourceAddedTimestamp": string
}
Felder
Union-Feld metadata. Metadaten für die Quelle. Für metadata ist nur einer der folgenden Werte zulässig:
googleDocsMetadata

object (GoogleDocsSourceMetadata)

Metadaten für eine Google-Dokument-Quelle.
youtubeMetadata

object (YoutubeMetadata)

Metadaten für eine YouTube-Videoquelle.
agentspaceMetadata

object (AgentspaceMetadata)

Metadaten für eine Agentspace-Quelle.
wordCount

integer

Die Wortzahl der Quelle.
tokenCount

integer

Die Anzahl der Tokens in der Quelle.
sourceAddedTimestamp

string (Timestamp format)

Der Zeitstempel, zu dem die Quelle hinzugefügt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

GoogleDocsSourceMetadata

Metadaten zu einer Google-Dokument-Quelle.

JSON-Darstellung 
{
  "documentId": string,
  "revisionId": string
}
Felder
documentId

string

Nur Ausgabe. Die Dokument-ID des Google-Dokuments.
revisionId

string

Nur Ausgabe. Versions-ID für das Dokument.

YoutubeMetadata

Metadaten zu einer YouTube-Videoquelle.

JSON-Darstellung 
{
  "videoId": string,
  "channelName": string
}
Felder
videoId

string

Nur Ausgabe. Die ID des YouTube-Videos.
channelName

string

Nur Ausgabe. Der Kanalname des YouTube-Videos.

AgentspaceMetadata

Metadaten zu einer Agentspace-Quelle.

JSON-Darstellung 
{
  "documentName": string,
  "documentTitle": string
}
Felder
documentName

string

Nur Ausgabe. Der vollständige Dokumentname in Agentspace.
documentTitle

string

Nur Ausgabe. Der Titel des Dokuments.

SourceSettings

Ermöglicht die Erweiterung der Quelleneinstellungen in „sources.batchCreate“ (früher „AddSource“-Anfrage).

JSON-Darstellung 
{
  "status": enum (SourceStatus),
  "failureReason": {
    object (FailureReason)
  }
}
Felder
status

enum (SourceStatus)

Status der Quelle.
failureReason

object (FailureReason)

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.

FailureReason

Fehlerursache mit Details dazu, warum die Aufnahme einer Quelle fehlgeschlagen ist.

JSON-Darstellung 
{

  // Union field error can be only one of the following:
  "unknown": {
    object (Unknown)
  },
  "sourceTooLong": {
    object (SourceTooLong)
  },
  "ingestionError": {
    object (IngestionError)
  },
  "sourceEmpty": {
    object (SourceEmpty)
  },
  "uploadError": {
    object (UploadError)
  },
  "paywallError": {
    object (PaywallError)
  },
  "sourceUnreachable": {
    object (SourceUnreachable)
  },
  "googleDriveError": {
    object (GoogleDriveError)
  },
  "youtubeError": {
    object (YoutubeError)
  },
  "audioTranscriptionError": {
    object (AudioTranscriptionError)
  },
  "sourceLimitExceeded": {
    object (SourceLimitExceeded)
  },
  "domainBlocked": {
    object (DomainBlocked)
  }
  // End of list of possible types for union field error.
}
Felder
Union-Feld error. Der spezifische Fehler. Für error ist nur einer der folgenden Werte zulässig:
unknown

object (Unknown)

Gibt an, dass ein unbekannter Fehler aufgetreten ist.
sourceTooLong

object (SourceTooLong)

Gibt an, dass die Anzahl der Quellwörter das Limit des Nutzers überschritten hat.
ingestionError

object (IngestionError)

Gibt an, dass beim Aufnehmen der Quelle ein Fehler aufgetreten ist.
sourceEmpty

object (SourceEmpty)

Gibt an, dass die Quelle leer ist.
uploadError

object (UploadError)

Gibt an, dass beim Hochladen der Quelle ein Fehler aufgetreten ist.
paywallError

object (PaywallError)

Gibt an, dass die Quelle kostenpflichtig ist und nicht aufgenommen werden kann.
sourceUnreachable

object (SourceUnreachable)

Gibt an, dass die Quelle nicht erreichbar ist.
googleDriveError

object (GoogleDriveError)

Ein Google Drive-spezifischer Fehler.
youtubeError

object (YoutubeError)

Ein YouTube-spezifischer Fehler.
audioTranscriptionError

object (AudioTranscriptionError)

Ein Fehler, der speziell bei der Transkription von Audiodateien auftritt.
sourceLimitExceeded

object (SourceLimitExceeded)

Fehler, wenn der Nutzer versucht, über seine Beschränkungen hinaus zu aktualisieren.
domainBlocked

object (DomainBlocked)

Fehler, wenn der Nutzer versucht, eine Quelle aus einer blockierten Domain hinzuzufügen.

Unbekannt

Dieser Typ hat keine Felder.

Gibt an, dass ein unbekannter Fehler aufgetreten ist.

SourceTooLong

Gibt an, dass die Anzahl der Quellwörter das Limit des Nutzers überschritten hat.

JSON-Darstellung 
{
  "wordCount": integer,
  "wordLimit": integer
}
Felder
wordCount

integer

Die Anzahl der Wörter in der Quelle.
wordLimit

integer

Das Wortanzahllimit für den aktuellen Nutzer zum Zeitpunkt des Uploads.

IngestionError

Dieser Typ hat keine Felder.

Gibt an, dass beim Aufnehmen der Quelle ein Fehler aufgetreten ist.

SourceEmpty

Dieser Typ hat keine Felder.

Gibt an, dass die Quelle leer ist.

UploadError

Dieser Typ hat keine Felder.

Gibt an, dass beim Hochladen der Quelle ein Fehler aufgetreten ist.

PaywallError

Dieser Typ hat keine Felder.

Gibt an, dass die Quelle kostenpflichtig ist und nicht aufgenommen werden kann.

SourceUnreachable

Gibt an, dass die Quelle nicht erreichbar ist. Dies wird hauptsächlich für Quellen verwendet, die über eine URL hinzugefügt werden.

JSON-Darstellung 
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
Felder
errorDetails

enum (SourceUnreachableErrorReason)

Beschreibt, warum die Quelle nicht erreichbar ist.

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.

GoogleDriveError

Ein Google Drive-spezifischer Fehler.

JSON-Darstellung 
{

  // Union field error can be only one of the following:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of list of possible types for union field error.
}
Felder
Union-Feld error. Der Drive-spezifische Fehler. Für error ist nur einer der folgenden Werte zulässig:
downloadPrevented

object (DownloadPrevented)

Der Nutzer konnte die Datei nicht herunterladen.

DownloadPrevented

Dieser Typ hat keine Felder.

Der Nutzer konnte die Datei nicht herunterladen.

YoutubeError

Ein YouTube-spezifischer Fehler.

JSON-Darstellung 
{

  // Union field error can be only one of the following:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of list of possible types for union field error.
}
Felder
Union-Feld error. Der YouTube-spezifische Fehler. Für error ist nur einer der folgenden Werte zulässig:
videoDeleted

object (VideoDeleted)

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.

AudioTranscriptionError

Ein Fehler, der speziell bei der Transkription von Audiodateien auftritt.

JSON-Darstellung 
{

  // Union field error can be only one of the following:
  "languageDetectionFailed": {
    object (LanguageDetectionFailed)
  },
  "noAudioDetected": {
    object (NoAudioDetected)
  }
  // End of list of possible types for union field error.
}
Felder
Union-Feld error. Der spezifische Fehler bei der Transkription der Audiodatei. Für error ist nur einer der folgenden Werte zulässig:
languageDetectionFailed

object (LanguageDetectionFailed)

Die Sprache der Datei konnte nicht erkannt werden. Möglicherweise enthält sie keine Sprache.
noAudioDetected

object (NoAudioDetected)

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.

SourceLimitExceeded

Dieser Typ hat keine Felder.

Gibt an, dass der Nutzer nicht genügend Speicherplatz für diese Quelle hat.

DomainBlocked

Dieser Typ hat keine Felder.

Fehler, der angibt, dass die Quelle entfernt wurde, weil die Domain blockiert wurde.

Methoden

batchCreate

 Erstellt eine Liste mit Source.

batchDelete

 Mehrere Quellen löschen

get

 Erstellt einen Source.