Package google.cloud.notebooklm.v1alpha

インデックス

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)

ノートブックを一括削除します。

認可スコープ

次の 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

エージェント スペース ソースに関するメタデータ。

フィールド
document_name

string

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

string

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

AudioOverview

ノートブックの音声概要。これは、ノートブックの概要を音声形式でまとめたものです。

フィールド
name

string

ID。ノートブックの完全なリソース名。形式: projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
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。ドライブ固有のエラー。error は次のいずれかになります。
download_prevented

DownloadPrevented

ユーザーがファイルをダウンロードできないようにしました。

DownloadPrevented

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

ユーザーがファイルをダウンロードできないようにしました。

IngestionError

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

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

PaywallError

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

ソースがペイウォールで保護されており、取り込むことができないことを示します。

SourceEmpty

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

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

SourceLimitExceeded

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

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

SourceTooLong

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

フィールド
word_count

int32

ソース内の単語数。
word_limit

int32

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

SourceUnreachable

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

フィールド
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

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

プロジェクトを共有できる場合は 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

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

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

エージェント スペース ソースのメタデータ。
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 移行元の 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 はまだサポートされていません。たとえば、取得したコンテンツがクローラーの取得最大サイズを超えている、取得したコンテンツがまだサポートされていないタイプである、などです。

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 には次のいずれか 1 つだけを指定できます。
youtube_url

string

動画コンテンツの YouTube URL。

WebContent

ソースとしてアップロードされたウェブ コンテンツ。

フィールド
url

string

URL が指定されている場合は、バックエンドでウェブページを取得します。
source_name

string

ソースに表示される名前。

YoutubeMetadata

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

フィールド
video_id

string

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

string

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