本頁面由 Cloud Translation API 翻譯而成。

Package google.cloud.notebooklm.v1alpha

索引

AudioOverviewService (介面)
NotebookService (介面)
SourceService (介面)
AccountAndRole (訊息)
AgentspaceMetadata (訊息)
AudioOverview (訊息)
AudioOverview.MimeType (enum)
AudioOverviewGenerationOptions (訊息)
AudioOverviewStatus (enum)
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 (enum)
ShareNotebookRequest (訊息)
ShareNotebookResponse (訊息)
Source (訊息)
SourceId (訊息)
SourceMetadata (訊息)
SourceSettings (訊息)
SourceStatus (enum)
SourceUnreachableErrorReason (enum)
UserContent (訊息)
UserContent.AgentspaceContent (訊息)
UserContent.GoogleDriveContent (訊息)
UserContent.TextContent (訊息)
UserContent.VideoContent (訊息)
UserContent.WebContent (訊息)
YoutubeMetadata (訊息)

AudioOverviewService

用於管理語音摘要的服務。

CreateAudioOverview

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 說明文件。

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

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 說明文件。

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

BatchDeleteNotebooks
`rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty)` 批次刪除筆記本。授權範圍需要下列其中一種 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` `https://www.googleapis.com/auth/discoveryengine.readwrite` 詳情請參閱Authentication Overview。

rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty)

批次刪除筆記本。

授權範圍

需要下列其中一種 OAuth 範圍：

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/discoveryengine.readwrite

詳情請參閱Authentication Overview。

CreateNotebook

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 說明文件。

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

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 說明文件。

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

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 說明文件。

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

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 說明文件。

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

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 說明文件。

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

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 說明文件。

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

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 說明文件。

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` 這是必要旗標，筆記本中的角色。

email

string

這是必要旗標，與帳戶相關聯的電子郵件地址。

role

ProjectRole

這是必要旗標，筆記本中的角色。

AgentspaceMetadata

Agentspace 來源的中繼資料。

欄位

document_name

string

僅供輸出。Agentspace 中的完整文件名稱。

document_title

string

僅供輸出。文件的標題。

AudioOverview

筆記本的語音摘要。這是筆記本的語音摘要。

欄位
`name`	`string` ID。筆記本的完整資源名稱。格式：`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` 要求語音摘要時使用的語言。

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`。

parent

string

這是必要旗標，表示將建立來源的父項資源。格式：projects/{project}/locations/{location}/notebooks/{notebook}

user_contents[]

UserContent

這是必要旗標，要上傳的 UserContent。

BatchCreateSourcesResponse

SourceService.BatchCreateSources 方法的回應。

欄位

欄位
`sources[]`	`Source` `Source`。

sources[]

Source

Source。

BatchDeleteNotebooksRequest

要求 NotebookService.BatchDeleteNotebooks 方法。

欄位

欄位
`parent`	`string` 這是必要旗標，父項分支資源名稱，例如 `projects/{project}/locations/{location}`。
`names[]`	`string` 這是必要旗標，`Notebook` 的完整資源名稱，例如 `projects/{project}/locations/{location}/notebooks/{notebook_id}`。

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}

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 金鑰資源名稱。

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` 生成語音摘要的選項。

parent

string

這是必要旗標，表示將建立這個筆記本的父項資源。格式：projects/{project}/locations/{location}/notebooks/{notebook}

generation_options

AudioOverviewGenerationOptions

生成語音摘要的選項。

CreateAudioOverviewResponse

AudioOverviewService.CreateAudioOverview 方法的回應。

欄位

欄位
`audio_overview`	`AudioOverview` 生成的語音摘要。

audio_overview

AudioOverview

生成的語音摘要。

CreateNotebookRequest

要求 NotebookService.CreateNotebook 方法。

欄位

欄位
`parent`	`string` 這是必要旗標，父項資源名稱，例如 `projects/{project}/locations/{location}`。
`notebook`	`Notebook` 這是必要旗標，要建立的筆記本。

parent

string

這是必要旗標，父項資源名稱，例如 projects/{project}/locations/{location}。

notebook

Notebook

這是必要旗標，要建立的筆記本。

DeleteAudioOverviewRequest

要求 AudioOverviewService.DeleteAudioOverview 方法。

欄位

欄位
`name`	`string` 這是必要旗標，`AudioOverview` 的完整資源名稱，例如 `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`。

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` 系統在輸入檔案中偵測不到音訊 (可能是影片)。

聯集欄位 error。音訊檔案轉錄的特定錯誤。error 只能是下列其中一項：

language_detection_failed

LanguageDetectionFailed

無法偵測檔案語言 (檔案可能不是語音)。

no_audio_detected

NoAudioDetected

系統在輸入檔案中偵測不到音訊 (可能是影片)。

LanguageDetectionFailed

這個類型沒有任何欄位。

無法偵測檔案語言 (檔案可能不是語音)。

NoAudioDetected

這個類型沒有任何欄位。

輸入檔案中未偵測到音訊。

DomainBlocked

這個類型沒有任何欄位。

錯誤，表示來源已遭移除，因為網域遭到封鎖。

GoogleDriveError

Google 雲端硬碟專屬錯誤。

欄位

欄位
聯集欄位 `error`。雲端硬碟專屬錯誤。`error` 只能是下列其中一項：
`download_prevented`	`DownloadPrevented` 使用者無法下載檔案。

聯集欄位 error。雲端硬碟專屬錯誤。error 只能是下列其中一項：

download_prevented

DownloadPrevented

使用者無法下載檔案。

DownloadPrevented

這個類型沒有任何欄位。

使用者無法下載檔案。

IngestionError

這個類型沒有任何欄位。

表示擷取來源時發生錯誤。

PaywallError

這個類型沒有任何欄位。

表示來源設有付費牆，無法擷取。

SourceEmpty

這個類型沒有任何欄位。

表示來源為空白。

SourceLimitExceeded

這個類型沒有任何欄位。

表示使用者沒有這個來源的空間。

SourceTooLong

表示來源字數超出使用者限制。

欄位

欄位
`word_count`	`int32` 來源中的字數。
`word_limit`	`int32` 上傳時，目前使用者可用的字數上限。

word_count

int32

來源中的字數。

word_limit

int32

上傳時，目前使用者可用的字數上限。

SourceUnreachable

表示無法連上來源。這項功能主要用於透過網址新增的來源。

欄位

欄位
`error_details`	`SourceUnreachableErrorReason` 說明來源無法連線的原因。

error_details

SourceUnreachableErrorReason

說明來源無法連線的原因。

不明

這個類型沒有任何欄位。

表示發生不明錯誤。

UploadError

這個類型沒有任何欄位。

表示上傳來源時發生錯誤。

YoutubeError

YouTube 專屬錯誤。

欄位

欄位
聯集欄位 `error`。YouTube 專屬錯誤。`error` 只能是下列其中一項：
`video_deleted`	`VideoDeleted` 錯誤，表示來源已移除，因為影片已刪除。

聯集欄位 error。YouTube 專屬錯誤。error 只能是下列其中一項：

video_deleted

VideoDeleted

錯誤，表示來源已移除，因為影片已刪除。

VideoDeleted

這個類型沒有任何欄位。

錯誤，表示來源已移除，因為影片已刪除。

GetNotebookRequest

要求 NotebookService.GetNotebook 方法。

欄位

欄位
`name`	`string` 這是必要旗標，`Notebook` 的完整資源名稱，例如 `projects/{project}/locations/{location}/notebooks/{notebook_id}`。

name

string

這是必要旗標，Notebook 的完整資源名稱，例如 projects/{project}/locations/{location}/notebooks/{notebook_id}。

GetSourceRequest

要求 SourceService.GetSource 方法。

欄位

欄位
`name`	`string` 這是必要旗標，來源的資源名稱。格式：projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

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` (選用步驟) 頁面權杖，提供此項目即可擷取後續網頁。

parent

string

這是必要旗標，父項分支資源名稱，例如 projects/{project}/locations/{location}。

page_size

int32

(選用步驟) 要傳回的 Notebook 數量上限。如未指定，預設值為「500」。允許的最大值為「500」。如果這個欄位為負數，系統會使用預設值。

page_token

string

(選用步驟) 頁面權杖，提供此項目即可擷取後續網頁。

ListRecentlyViewedNotebooksResponse

NotebookService.ListRecentlyViewedNotebooks 方法的回應。

欄位

欄位
`notebooks[]`	`Notebook` 最近查看的筆記本清單。
`next_page_token`	`string` 頁面權杖，提供此項目即可擷取後續網頁。

notebooks[]

Notebook

最近查看的筆記本清單。

next_page_token

string

頁面權杖，提供此項目即可擷取後續網頁。

筆記本

筆記本是使用者儲存內容 (做為來源) 並與內容互動的資源。

欄位
`name`	`string` ID。筆記本的 ID。格式：`projects/{project}/locations/{location}/notebooks/{notebook_id}`。這個欄位必須是 UTF-8 編碼的字串。
`sources[]`	`Source` 僅供輸出。筆記本中的來源清單。這是僅供輸出的欄位。
`cmek_config`	`CmekConfig` 僅供輸出。Notebook 的 CMEK 相關資訊。
`title`	`string` (選用步驟) 筆記本名稱。
`notebook_id`	`string` 僅供輸出。筆記本 ID，也就是筆記本資源名稱的最後一個區段。
`emoji`	`string` 僅供輸出。筆記本的表情符號。
`metadata`	`NotebookMetadata` 僅供輸出。筆記本的中繼資料。

NotebookMetadata

筆記本的中繼資料。

欄位
`is_shared`	`bool` 如果這個專案目前與其他使用者共用，則為 True，否則為 False。
`is_shareable`	`bool` 如果專案可共用，則為「是」。
`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` 這是必要旗標，是否透過電子郵件通知共用使用者。

name

string

這是必要旗標，Notebook 的完整資源名稱，例如 projects/{project}/locations/{location}/notebooks/{notebook_id}。

account_and_roles[]

AccountAndRole

這是必要旗標，要共用筆記本的帳戶和角色清單。

notify_via_email

bool

這是必要旗標，是否透過電子郵件通知共用使用者。

ShareNotebookResponse

這個類型沒有任何欄位。

NotebookService.ShareNotebook 方法的回應。

來源

來源是指單一內容來源。

欄位
`name`	`string` ID。來源的完整資源名稱。格式：`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` 失敗原因，內含來源無法擷取的詳細原因。

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}`

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` 來源的顯示名稱。

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` 來源的顯示名稱。

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 影片的頻道名稱。