REST Resource: projects.locations.notebooks.sources

资源：Source

来源表示单个内容来源。

JSON 表示法 
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
字段
name

string

标识符。来源的完整资源名称。格式：projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
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 规范化（即转换为 UTC 零时区格式并在末尾附加 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

表示来源无法访问。这主要用于通过网址添加的来源。

JSON 表示法 
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
字段
errorDetails

enum (SourceUnreachableErrorReason)

说明来源无法访问的原因。

SourceUnreachableErrorReason

有关来源无法访问的详细信息。用于向用户显示适当的消息。

枚举
ERROR_REASON_UNSPECIFIED 默认
ERROR_REASON_INVALID_URL 源网址无效。
ERROR_REASON_NOT_ACCESSIBLE 无法访问源网址。
ERROR_REASON_NOT_REACHABLE 无法访问来源网址。
ERROR_REASON_URL_NOT_FOUND 来源网址返回了 404 错误。
ERROR_REASON_TRANSIENT_ERROR 由于暂时性网络错误或主机超时等原因，无法访问源网址。
ERROR_REASON_FETCH_FAILED 由于内部错误，无法提取源网址。
ERROR_REASON_NOT_SUPPORTED 尚不支持该网址。例如：提取的内容超出了抓取工具提取的最大大小，提取的内容是我们尚不支持的类型，等等。

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。特定于 Google 云端硬盘的错误。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。