REST Resource: projects.locations.notebooks.sources

リソース: Source

Source は、コンテンツの単一のソースを表します。

JSON 表現 
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
フィールド
name

string

ID。ソースの完全なリソース名。形式: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
title

string

省略可。ソースのタイトル。
sourceId

object (SourceId)

省略可。出力専用。ソース ID。ソースのリソース名の最後のセグメントです。
metadata

object (SourceMetadata)

出力のみ。ソースに関するメタデータ。
settings

object (SourceSettings)

出力専用。ソースのステータスと失敗理由。

SourceMetadata

ソースのメタデータと追加情報を表します。

JSON 表現 
{

  // 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
}
フィールド
共用体フィールド metadata。ソースのメタデータ。metadata は次のいずれかになります。
googleDocsMetadata

object (GoogleDocsSourceMetadata)

Google ドキュメント ソースのメタデータ。
youtubeMetadata

object (YoutubeMetadata)

YouTube 動画ソースのメタデータ。
agentspaceMetadata

object (AgentspaceMetadata)

agentspace ソースのメタデータ。
wordCount

integer

ソースの単語数。
tokenCount

integer

ソース内のトークン数。
sourceAddedTimestamp

string (Timestamp format)

ソースが追加されたタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"

GoogleDocsSourceMetadata

Google ドキュメントのソースに関するメタデータ。

JSON 表現 
{
  "documentId": string,
  "revisionId": string
}
フィールド
documentId

string

出力専用。Google ドキュメントのドキュメント ID。
revisionId

string

出力専用。ドキュメントのリビジョン ID。

YoutubeMetadata

YouTube 動画ソースに関するメタデータ。

JSON 表現 
{
  "videoId": string,
  "channelName": string
}
フィールド
videoId

string

出力専用。YouTube 動画の ID。
channelName

string

出力専用。YouTube 動画のチャンネル名。

AgentspaceMetadata

agentspace ソースに関するメタデータ。

JSON 表現 
{
  "documentName": string,
  "documentTitle": string
}
フィールド
documentName

string

出力専用。Agentspace の完全なドキュメント名。
documentTitle

string

出力専用。ドキュメントのタイトル。

SourceSettings

sources.batchCreate（以前の AddSource リクエスト）でソース設定の拡張を許可します。

JSON 表現 
{
  "status": enum (SourceStatus),
  "failureReason": {
    object (FailureReason)
  }
}
フィールド
status

enum (SourceStatus)

ソースのステータス。
failureReason

object (FailureReason)

ソースの取り込みが失敗した理由に関する詳細情報を含む失敗理由。

SourceStatus

ソースのステータスとして考えられる値のリスト。

列挙型
SOURCE_STATUS_UNSPECIFIED 不明なステータス。
SOURCE_STATUS_PENDING ソースは追加保留中です。
SOURCE_STATUS_COMPLETE ソースの追加が完了し、成功しました。
SOURCE_STATUS_ERROR ソースの追加が恒久的に失敗しました。
SOURCE_STATUS_PENDING_DELETION ソースは削除保留中です。
SOURCE_STATUS_TENTATIVE ユーザーがソースを追加しようとしていますが、まだアップロードされていないか、ユーザーの上限が確認されていません。ユーザーのソース上限にはカウントされません。

FailureReason

ソースの取り込みが失敗した理由に関する詳細情報を含む失敗理由。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド error。具体的なエラー。error は次のいずれかになります。
unknown

object (Unknown)

不明なエラーが発生したことを示します。
sourceTooLong

object (SourceTooLong)

ソースの単語数がユーザーの上限を超えたことを示します。
ingestionError

object (IngestionError)

ソースの取り込み中にエラーが発生したことを示します。
sourceEmpty

object (SourceEmpty)

ソースが空であることを示します。
uploadError

object (UploadError)

ソースのアップロード中にエラーが発生したことを示します。
paywallError

object (PaywallError)

ソースがペイウォールで保護されており、取り込み不可能であることを示します。
sourceUnreachable

object (SourceUnreachable)

ソースにアクセスできないことを示します。
googleDriveError

object (GoogleDriveError)

Google ドライブ固有のエラー。
youtubeError

object (YoutubeError)

YouTube 固有のエラー。
audioTranscriptionError

object (AudioTranscriptionError)

音声ファイルの文字起こしに固有のエラー。
sourceLimitExceeded

object (SourceLimitExceeded)

ユーザーが上限を超えて更新しようとした場合のエラー。
domainBlocked

object (DomainBlocked)

ユーザーがブロックされたドメインからソースを追加しようとした場合のエラー。

不明

この型にはフィールドがありません。

不明なエラーが発生したことを示します。

SourceTooLong

ソースの単語数がユーザーの上限を超えたことを示します。

JSON 表現 
{
  "wordCount": integer,
  "wordLimit": integer
}
フィールド
wordCount

integer

ソース内の単語数。
wordLimit

integer

アップロード時の現在のユーザーの単語数の上限。

IngestionError

この型にはフィールドがありません。

ソースの取り込み中にエラーが発生したことを示します。

SourceEmpty

この型にはフィールドがありません。

ソースが空であることを示します。

UploadError

この型にはフィールドがありません。

ソースのアップロード中にエラーが発生したことを示します。

PaywallError

この型にはフィールドがありません。

ソースがペイウォールで保護されており、取り込み不可能であることを示します。

SourceUnreachable

ソースにアクセスできないことを示します。これは主に URL 経由で追加されたソースに使用されます。

JSON 表現 
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
フィールド
errorDetails

enum (SourceUnreachableErrorReason)

ソースにアクセスできない理由を説明します。

SourceUnreachableErrorReason

ソースにアクセスできない理由の詳細。ユーザーに適切なメッセージを表示するために使用されます。

列挙型
ERROR_REASON_UNSPECIFIED デフォルト
ERROR_REASON_INVALID_URL ソース URL が無効です。
ERROR_REASON_NOT_ACCESSIBLE ソース URL にアクセスできません。
ERROR_REASON_NOT_REACHABLE ソース URL にアクセスできません。
ERROR_REASON_URL_NOT_FOUND ソース URL から 404 エラーが返されました。
ERROR_REASON_TRANSIENT_ERROR 一時的なネットワーク エラーやホストのタイムアウトなどが原因で、ソース URL にアクセスできません。
ERROR_REASON_FETCH_FAILED 内部エラーのため、ソース URL を取得できませんでした。
ERROR_REASON_NOT_SUPPORTED この URL はまだサポートされていません。たとえば、取得したコンテンツがクローラーの取得最大サイズを超えている、取得したコンテンツがまだサポートされていないタイプである、などです。

GoogleDriveError

Google ドライブ固有のエラー。

JSON 表現 
{

  // Union field error can be only one of the following:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of list of possible types for union field error.
}
フィールド
共用体フィールド error。ドライブ固有のエラー。error は次のいずれかになります。
downloadPrevented

object (DownloadPrevented)

ユーザーはファイルのダウンロードを許可されませんでした。

DownloadPrevented

この型にはフィールドがありません。

ユーザーはファイルのダウンロードを許可されませんでした。

YoutubeError

YouTube 固有のエラー。

JSON 表現 
{

  // Union field error can be only one of the following:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of list of possible types for union field error.
}
フィールド
共用体フィールド error。YouTube 固有のエラー。error は次のいずれかになります。
videoDeleted

object (VideoDeleted)

動画が削除されたためソースが削除されたことを示すエラー。

VideoDeleted

この型にはフィールドがありません。

動画が削除されたためソースが削除されたことを示すエラー。

AudioTranscriptionError

音声ファイルの文字起こしに固有のエラー。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド error。音声ファイルの文字起こしに固有のエラー。error は次のいずれかになります。
languageDetectionFailed

object (LanguageDetectionFailed)

ファイルの言語を検出できませんでした（音声ではない可能性があります）。
noAudioDetected

object (NoAudioDetected)

入力ファイルで音声が検出されませんでした（動画である可能性があります）。

LanguageDetectionFailed

この型にはフィールドがありません。

ファイルの言語を検出できませんでした（音声ではない可能性があります）。

NoAudioDetected

この型にはフィールドがありません。

入力ファイルで音声が検出されませんでした。

SourceLimitExceeded

この型にはフィールドがありません。

ユーザーにこのソースのスペースがないことを示します。

DomainBlocked

この型にはフィールドがありません。

ドメインがブロックされたためソースが削除されたことを示すエラー。

メソッド

batchCreate

 Source のリストを作成します。

batchDelete

 複数のソースを削除する

get

 Source を取得します。