Package google.cloud.notebooklm.v1alpha

索引

• AudioOverviewService（接口）
• NotebookService（接口）
• SourceService（接口）
• AccountAndRole（消息）
• AgentspaceMetadata（消息）
• AudioOverview（消息）
• AudioOverview.MimeType（枚举）
• AudioOverviewGenerationOptions（消息）
• AudioOverviewStatus（枚举）
• BatchCreateSourcesRequest（消息）
• BatchCreateSourcesResponse（消息）
• BatchDeleteNotebooksRequest（消息）
• BatchDeleteSourcesRequest（消息）
• CmekConfig（消息）
• CreateAudioOverviewRequest（消息）
• CreateAudioOverviewResponse（消息）
• CreateNotebookRequest（消息）
• DeleteAudioOverviewRequest（消息）
• FailureReason（消息）
• FailureReason.AudioTranscriptionError（消息）
• FailureReason.AudioTranscriptionError.LanguageDetectionFailed（消息）
• FailureReason.AudioTranscriptionError.NoAudioDetected（消息）
• FailureReason.DomainBlocked（消息）
• FailureReason.GoogleDriveError（消息）
• FailureReason.GoogleDriveError.DownloadPrevented（消息）
• FailureReason.IngestionError（消息）
• FailureReason.PaywallError（消息）
• FailureReason.SourceEmpty（消息）
• FailureReason.SourceLimitExceeded（消息）
• FailureReason.SourceTooLong（消息）
• FailureReason.SourceUnreachable（消息）
• FailureReason.Unknown（消息）
• FailureReason.UploadError（消息）
• FailureReason.YoutubeError（消息）
• FailureReason.YoutubeError.VideoDeleted（消息）
• GetNotebookRequest（消息）
• GetSourceRequest（消息）
• GoogleDocsSourceMetadata（消息）
• ListRecentlyViewedNotebooksRequest（消息）
• ListRecentlyViewedNotebooksResponse（消息）
• Notebook（消息）
• NotebookMetadata（消息）
• ProjectRole（枚举）
• ShareNotebookRequest（消息）
• ShareNotebookResponse（消息）
• Source（消息）
• SourceId（消息）
• SourceMetadata（消息）
• SourceSettings（消息）
• SourceStatus（枚举）
• SourceUnreachableErrorReason（枚举）
• UserContent（消息）
• UserContent.AgentspaceContent（消息）
• UserContent.GoogleDriveContent（消息）
• UserContent.TextContent（消息）
• UserContent.VideoContent（消息）
• UserContent.WebContent（消息）
• YoutubeMetadata（消息）

AudioOverviewService

用于管理音频概览的服务。

CreateAudioOverview
rpc CreateAudioOverview(CreateAudioOverviewRequest) returns (CreateAudioOverviewResponse) 生成新的音频概览。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.audioOverviews.create 如需了解详情，请参阅 IAM 文档。

DeleteAudioOverview
rpc DeleteAudioOverview(DeleteAudioOverviewRequest) returns (Empty) 删除音频概览。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.audioOverviews.delete 如需了解详情，请参阅 IAM 文档。

NotebookService

用于管理笔记本的服务。

BatchDeleteNotebooks
rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty) 批量删除 Notebooks。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。

CreateNotebook
rpc CreateNotebook(CreateNotebookRequest) returns (Notebook) 创建笔记本。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.notebooks.create 如需了解详情，请参阅 IAM 文档。

GetNotebook
rpc GetNotebook(GetNotebookRequest) returns (Notebook) 获取笔记本。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.notebooks.get 如需了解详情，请参阅 IAM 文档。

ListRecentlyViewedNotebooks
rpc ListRecentlyViewedNotebooks(ListRecentlyViewedNotebooksRequest) returns (ListRecentlyViewedNotebooksResponse) 列出按上次查看时间排序的笔记本。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.notebooks.list 如需了解详情，请参阅 IAM 文档。

ShareNotebook
rpc ShareNotebook(ShareNotebookRequest) returns (ShareNotebookResponse) 将笔记本分享给其他账号。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.notebooks.getIamPolicy discoveryengine.notebooks.setIamPolicy 如需了解详情，请参阅 IAM 文档。

SourceService

用于管理来源的服务。

BatchCreateSources
rpc BatchCreateSources(BatchCreateSourcesRequest) returns (BatchCreateSourcesResponse) 创建 Source 的列表。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.sources.create 如需了解详情，请参阅 IAM 文档。

BatchDeleteSources
rpc BatchDeleteSources(BatchDeleteSourcesRequest) returns (Empty) 删除多个来源 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.sources.delete 如需了解详情，请参阅 IAM 文档。

GetSource
rpc GetSource(GetSourceRequest) returns (Source) 获取 Source。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sources.get 如需了解详情，请参阅 IAM 文档。

AccountAndRole

账号和角色信息。

字段
email	string 必需。与账号关联的电子邮件地址。
role	ProjectRole 必需。笔记本中的角色。

AgentspaceMetadata

有关 agentspace 源的元数据。

字段
document_name	string 仅限输出。Agentspace 中的完整文档名称。
document_title	string 仅限输出。文档的标题。

AudioOverview

笔记本的音频概览。这是笔记本内容的音频格式摘要。

字段
name	string 标识符。笔记本的完整资源名称。格式：projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
audio_overview_id	string 仅限输出。音频概览的唯一 ID。
status	AudioOverviewStatus 音频概览的状态。
generation_options	AudioOverviewGenerationOptions 用于生成音频概览的选项。
mime_type	MimeType 音频概览的 MIME 类型。
language_code	string 生成的音频概览的语言代码。使用 BCP 47 语言代码（例如“en”“es”“hi”等）。

MimeType

音频概览支持的 MIME 类型。

枚举
MIME_TYPE_UNKNOWN	尚未设置 MIME 类型。
MIME_TYPE_WAV	MIME 类型为 audio/wav。
MIME_TYPE_MP4	MIME 类型为 audio/mp4。

AudioOverviewGenerationOptions

生成音频概览期间使用的选项。

字段
source_ids[]	SourceId 可选。音频概览所依据的来源。
episode_focus	string 节目主持人应侧重于哪些方面。
language_code	string 请求音频概览时使用的语言。

AudioOverviewStatus

音频概览的状态。

枚举
AUDIO_OVERVIEW_STATUS_UNSPECIFIED	状态尚未设置。
AUDIO_OVERVIEW_STATUS_NOT_STARTED	音频概览尚未开始生成。
AUDIO_OVERVIEW_STATUS_IN_PROGRESS	系统正在生成音频概览。
AUDIO_OVERVIEW_STATUS_COMPLETE	音频概览已生成并可供使用。
AUDIO_OVERVIEW_STATUS_FAILED	未能生成音频概览。

BatchCreateSourcesRequest

对 SourceService.BatchCreateSources 方法的请求。

字段
parent	string 必需。将创建来源的父资源。格式：projects/{project}/locations/{location}/notebooks/{notebook}
user_contents[]	UserContent 必需。要上传的 UserContent。

BatchCreateSourcesResponse

对 SourceService.BatchCreateSources 方法的响应。

字段
sources[]	Source Source。

BatchDeleteNotebooksRequest

对 NotebookService.BatchDeleteNotebooks 方法的请求。

字段
parent	string 必需。父分支资源名称，例如 projects/{project}/locations/{location}。
names[]	string 必需。Notebook 的完整资源名称，例如 projects/{project}/locations/{location}/notebooks/{notebook_id}。

BatchDeleteSourcesRequest

针对 [SourceService.BatchDeleteSourcesRequest][] 方法的请求。

字段
parent	string 必需。要删除的来源所在的父资源。格式：projects/{project}/locations/{location}/notebooks/{notebook}
names[]	string 必需。要删除的来源的名称。格式：projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

CmekConfig

Notebooks 的客户管理的加密配置。

字段
kms_key	string 必需。将用于加密资源 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} 的 KMS 密钥资源名称。

CreateAudioOverviewRequest

对 AudioOverviewService.CreateAudioOverview 方法的请求。

字段
parent	string 必需。将创建相应笔记本的父级资源。格式：projects/{project}/locations/{location}/notebooks/{notebook}
generation_options	AudioOverviewGenerationOptions 用于生成音频概览的选项。

CreateAudioOverviewResponse

对 AudioOverviewService.CreateAudioOverview 方法的响应。

字段
audio_overview	AudioOverview 生成的音频概览。

CreateNotebookRequest

对 NotebookService.CreateNotebook 方法的请求。

字段
parent	string 必需。父级资源名称，例如 projects/{project}/locations/{location}。
notebook	Notebook 必需。要创建的笔记本。

DeleteAudioOverviewRequest

对 AudioOverviewService.DeleteAudioOverview 方法的请求。

字段
name	string 必需。AudioOverview 的完整资源名称，例如 projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}。

FailureReason

包含有关来源无法注入的详细信息的失败原因。

字段
联合字段 error。具体错误。error 只能是下列其中一项：
unknown	Unknown 表示发生了未知错误。
source_too_long	SourceTooLong 表示源字数超过了用户的限制。
ingestion_error	IngestionError 表示在提取来源时发生了错误。
source_empty	SourceEmpty 表示来源为空。
upload_error	UploadError 表示上传来源时出错。
paywall_error	PaywallError 表示来源受付费墙保护，无法提取。
source_unreachable	SourceUnreachable 表示来源无法访问。
google_drive_error	GoogleDriveError 特定于 Google 云端硬盘的错误。
youtube_error	YoutubeError YouTube 特有的错误。
audio_transcription_error	AudioTranscriptionError 音频文件转写方面的特定错误。
source_limit_exceeded	SourceLimitExceeded 如果用户尝试更新超出其限制的资源，则会出错。
domain_blocked	DomainBlocked 如果用户尝试添加来自被屏蔽网域的来源，则会出错。

AudioTranscriptionError

音频文件转写方面的特定错误。

字段
联合字段 error。音频文件转写特有的错误。error 只能是下列其中一项：
language_detection_failed	LanguageDetectionFailed 无法检测到文件的语言（可能不是语音）。
no_audio_detected	NoAudioDetected 在输入文件中未检测到任何音频（可能是一个视频）。

LanguageDetectionFailed

此类型没有字段。

无法检测到文件的语言（可能不是语音）。

NoAudioDetected

此类型没有字段。

在输入文件中未检测到任何音频。

DomainBlocked

此类型没有字段。

表示来源因网域被屏蔽而被移除的错误。

GoogleDriveError

特定于 Google 云端硬盘的错误。

字段
联合字段 error。特定于 Google 云端硬盘的错误。error 只能是下列其中一项：
download_prevented	DownloadPrevented 系统阻止用户下载该文件。

DownloadPrevented

此类型没有字段。

系统阻止用户下载该文件。

IngestionError

此类型没有字段。

表示在提取来源时发生了错误。

PaywallError

此类型没有字段。

表示来源受付费墙保护，无法提取。

SourceEmpty

此类型没有字段。

表示来源为空。

SourceLimitExceeded

此类型没有字段。

表示用户没有此来源的存储空间。

SourceTooLong

表示源字数超过了用户的限制。

字段
word_count	int32 来源中的字数。
word_limit	int32 上传时当前用户的字数限制。

SourceUnreachable

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

字段
error_details	SourceUnreachableErrorReason 说明来源无法访问的原因。

未知

此类型没有字段。

表示发生了未知错误。

UploadError

此类型没有字段。

表示上传来源时出错。

YoutubeError

YouTube 特有的错误。

字段
联合字段 error。YouTube 特有的错误。error 只能是下列其中一项：
video_deleted	VideoDeleted 表示来源已被移除，因为视频已被删除的错误。

VideoDeleted

此类型没有字段。

表示来源已被移除，因为视频已被删除的错误。

GetNotebookRequest

对 NotebookService.GetNotebook 方法的请求。

字段
name	string 必需。Notebook 的完整资源名称，例如 projects/{project}/locations/{location}/notebooks/{notebook_id}。

GetSourceRequest

对 SourceService.GetSource 方法的请求。

字段
name	string 必需。来源的资源名称。格式：projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

GoogleDocsSourceMetadata

有关 Google 文档来源的元数据。

字段
document_id	string 仅限输出。相应 Google 文档的文档 ID。
revision_id	string 仅限输出。相应文档的修订版本 ID。

ListRecentlyViewedNotebooksRequest

对 NotebookService.ListRecentlyViewedNotebooks 方法的请求。

字段
parent	string 必需。父分支资源名称，例如 projects/{project}/locations/{location}。
page_size	int32 可选。要返回的 Notebook 数量上限。如果未指定，则默认为“500”。允许的最大值为“500”。如果此字段为负值，则使用默认值。
page_token	string 可选。页面令牌，提供此令牌可检索后续页面。

ListRecentlyViewedNotebooksResponse

对 NotebookService.ListRecentlyViewedNotebooks 方法的响应。

字段
notebooks[]	Notebook 最近查看过的笔记本的列表。
next_page_token	string 页面令牌，提供此令牌可检索后续页面。

笔记本

笔记本是一种资源，用户可以在其中存储内容（作为来源）并与内容互动。

字段
name	string 标识符。笔记本的标识符。格式：projects/{project}/locations/{location}/notebooks/{notebook_id}。 此字段必须是采用 UTF-8 编码的字符串。
sources[]	Source 仅限输出。笔记本中的来源列表。此字段仅限输出。
cmek_config	CmekConfig 仅限输出。笔记本的 CMEK 相关信息。
title	string 可选。笔记本的标题。
notebook_id	string 仅限输出。笔记本 ID，即笔记本资源名称的最后一段。
emoji	string 仅限输出。笔记本的表情符号。
metadata	NotebookMetadata 仅限输出。笔记本的元数据。

NotebookMetadata

笔记本的元数据。

字段
is_shared	bool 如果相应项目目前已与他人共享，则为 true；否则为 false。
is_shareable	bool 如果项目可共享，则为 true。
last_viewed	Timestamp 一个时间戳，用于指示当前会话中的用户上次查看项目的时间。
create_time	Timestamp 相应项目的创建时间。

ProjectRole

项目的角色。

枚举
PROJECT_ROLE_UNKNOWN	未知角色。
PROJECT_ROLE_OWNER	用户拥有相应项目。
PROJECT_ROLE_WRITER	用户对项目拥有写入者权限。
PROJECT_ROLE_READER	用户对项目拥有读取者权限。
PROJECT_ROLE_NOT_SHARED	用户无权访问相应项目。

ShareNotebookRequest

对 NotebookService.ShareNotebook 方法的请求。

字段
name	string 必需。Notebook 的完整资源名称，例如 projects/{project}/locations/{location}/notebooks/{notebook_id}。
account_and_roles[]	AccountAndRole 必需。要与之分享笔记本的账号和角色的列表。
notify_via_email	bool 必需。是否通过电子邮件通知共享用户。

ShareNotebookResponse

此类型没有字段。

对 NotebookService.ShareNotebook 方法的响应。

来源

来源表示单个内容来源。

字段
name	string 标识符。来源的完整资源名称。格式：projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
title	string 可选。来源的标题。
source_id	SourceId 可选。仅限输出。来源 ID，即来源资源名称的最后一段。
metadata	SourceMetadata 仅限输出。有关来源的元数据。
settings	SourceSettings 仅限输出。来源的状态以及任何失败原因。

SourceId

SourceId 是来源资源名称的最后一段。

字段
id	string 来源的 ID。

SourceMetadata

表示来源的元数据和一些其他信息。

字段
联合字段 metadata。来源的元数据。metadata 只能是下列其中一项：
google_docs_metadata	GoogleDocsSourceMetadata Google 文档来源的元数据。
youtube_metadata	YoutubeMetadata YouTube 视频来源的元数据。
agentspace_metadata	AgentspaceMetadata Agentspace 来源的元数据。
word_count	int32 来源的字数。
token_count	int32 来源中的词元数量。
source_added_timestamp	Timestamp 添加来源时的时间戳。

SourceSettings

允许在 BatchCreateSources（以前的 AddSource 请求）中扩展来源设置。

字段
status	SourceStatus 来源的状态。
failure_reason	FailureReason 包含有关来源无法注入的详细信息的失败原因。

SourceStatus

来源的可能状态列表。

枚举
SOURCE_STATUS_UNSPECIFIED	未指定状态。
SOURCE_STATUS_PENDING	来源待添加。
SOURCE_STATUS_COMPLETE	来源添加已完成并成功。
SOURCE_STATUS_ERROR	来源添加已永久失败。
SOURCE_STATUS_PENDING_DELETION	相应来源正在等待删除。
SOURCE_STATUS_TENTATIVE	用户正在尝试添加来源，但我们尚未上传该来源或检查用户限额。不会计入用户的来源数量上限。

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	尚不支持该网址。例如：提取的内容超出了抓取工具提取的最大大小，提取的内容是我们尚不支持的类型，等等。

UserContent

“内容”消息是指用户想要上传的数据。

字段
联合字段 content。用户内容。content 只能是下列其中一项：
google_drive_content	GoogleDriveContent Google 云端硬盘中的内容。
text_content	TextContent 作为来源上传的文本内容。
web_content	WebContent 上传为来源的网络内容。
video_content	VideoContent 上传的视频内容作为来源。
agentspace_content	AgentspaceContent 以来源形式上传的 Agentspace 内容。

AgentspaceContent

以来源形式上传的 Agentspace 内容。

字段
document_name	string 可选。Agentspace 文档的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}。
engine_name	string 可选。引擎来验证文档的权限。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}。
ideaforge_idea_name	string 可选。创意工作坊实例的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}

GoogleDriveContent

Google 云端硬盘中的内容。

字段
document_id	string 所选文档的文档 ID。
mime_type	string 所选文档的 MIME 类型。 可用于区分在云端硬盘选择器中选择的内容类型。对于 Google 文档，请使用 application/vnd.google-apps.document；对于 Google 幻灯片，请使用 application/vnd.google-apps.presentation。
source_name	string 要为来源显示的名称。

TextContent

作为来源上传的文本内容。

字段
source_name	string 文本源的显示名称。
content	string 要为来源显示的名称。

VideoContent

以源文件形式上传的视频内容。

字段
联合字段 format。指定视频内容的格式，format 只能是下列其中一项：
youtube_url	string 视频内容的 YouTube 网址。

WebContent

上传为来源的网络内容。

字段
url	string 如果提供了网址，则会在后端提取网页。
source_name	string 要为来源显示的名称。

YoutubeMetadata

有关 YouTube 视频来源的元数据。

字段
video_id	string 仅限输出。YouTube 视频的 ID。
channel_name	string 仅限输出。YouTube 视频的频道名称。