Package google.cloud.notebooklm.v1alpha

Index

AudioOverviewService

Service for managing audio overviews.

CreateAudioOverview

rpc CreateAudioOverview(CreateAudioOverviewRequest) returns (CreateAudioOverviewResponse)

Generates a new audio overview. Needs a side channel with the user's EUC.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.audioOverviews.create

For more information, see the IAM documentation.
DeleteAudioOverview

rpc DeleteAudioOverview(DeleteAudioOverviewRequest) returns (Empty)

Deletes an audio overview. Needs a side channel with the user's EUC.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.audioOverviews.delete

For more information, see the IAM documentation.

NotebookService

Service for managing notebooks.

BatchDeleteNotebooks

rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty)

Batch deletes Notebooks. Needs a side channel with the user's EUC.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateNotebook

rpc CreateNotebook(CreateNotebookRequest) returns (Notebook)

Creates a notebook. Needs a side channel with the user's EUC.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.notebooks.create

For more information, see the IAM documentation.
GetNotebook

rpc GetNotebook(GetNotebookRequest) returns (Notebook)

Gets a notebook. Needs a side channel with the user's EUC.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.notebooks.get

For more information, see the IAM documentation.
ListRecentlyViewedNotebooks

rpc ListRecentlyViewedNotebooks(ListRecentlyViewedNotebooksRequest) returns (ListRecentlyViewedNotebooksResponse)

Lists the recently viewed notebooks. Needs a side channel with the user's EUC.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.notebooks.list

For more information, see the IAM documentation.
ShareNotebook

rpc ShareNotebook(ShareNotebookRequest) returns (ShareNotebookResponse)

Shares a notebook to other accounts. Needs a side channel with the user's EUC.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permissions on the name resource:

  • discoveryengine.notebooks.getIamPolicy
  • discoveryengine.notebooks.setIamPolicy

For more information, see the IAM documentation.

SourceService

Service for managing sources.

BatchCreateSources

rpc BatchCreateSources(BatchCreateSourcesRequest) returns (BatchCreateSourcesResponse)

Creates a list of Sources.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.sources.create

For more information, see the IAM documentation.
BatchDeleteSources

rpc BatchDeleteSources(BatchDeleteSourcesRequest) returns (Empty)

Deletes multiple sources

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.sources.delete

For more information, see the IAM documentation.
GetSource

rpc GetSource(GetSourceRequest) returns (Source)

Gets a Source.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.sources.get

For more information, see the IAM documentation.

AccountAndRole

Account and role information.

Fields
email

string

Required. The email address associated with the account.
role

ProjectRole

Required. The role in the notebook.

AgentspaceMetadata

Metadata about an agentspace source.

Fields
document_name

string

Output only. The full document name in Agentspace.
document_title

string

Output only. The title of the document.

AudioOverview

An audio overview of a notebook. This is a summary of the notebook in audio format.

Fields
name

string

Identifier. The full resource name of the notebook. Format: projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.
audio_overview_id

string

Output only. Unique ID of the audio overview.
status

AudioOverviewStatus

The status of the audio overview.
audio

bytes

The audio overview in wav format. This is only present if the status is AUDIO_OVERVIEW_STATUS_COMPLETE.
mime_type

MimeType

The mime type of the audio overview.
playback_url

string

The url used to play the audio overview.
language_code

string

The language code of the generated audio overview. Use the BCP 47 language code (e.g. "en", "es", "hi", etc.). Examples: google3/i18n/identifiers/tools/language_code_constants.txt

MimeType

Supported mime types for audio overviews.

Enums
MIME_TYPE_UNKNOWN The mime type has not been set.
MIME_TYPE_WAV The mime type is audio/wav.
MIME_TYPE_MP4 The mime type is audio/mp4.

AudioOverviewGenerationOptions

Options used during audio overview generation.

Fields
source_ids[]

SourceId

Optional. The sources in which the audio overview is grounded.
episode_focus

string

What the hosts of the show should focus on.
language_code

string

The language that the audio overview was requested in.

AudioOverviewStatus

The status of an audio overview.

Enums
AUDIO_OVERVIEW_STATUS_UNSPECIFIED The status has not been set.
AUDIO_OVERVIEW_STATUS_NOT_STARTED The audio overview has not started being generated.
AUDIO_OVERVIEW_STATUS_IN_PROGRESS The audio overview is in the process of being generated.
AUDIO_OVERVIEW_STATUS_COMPLETE The audio overview has been generated and is available.
AUDIO_OVERVIEW_STATUS_FAILED The audio overview failed to be generated.

BatchCreateSourcesRequest

Request for SourceService.BatchCreateSources method.

Fields
parent

string

Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}
user_contents[]

UserContent

Required. The UserContents to be uploaded.

BatchCreateSourcesResponse

Response for SourceService.BatchCreateSources method.

Fields
sources[]

Source

The Sources.

BatchDeleteNotebooksRequest

Request for NotebookService.BatchDeleteNotebooks method.

Fields
parent

string

Required. The parent branch resource name, such as projects/{project}/locations/{location}.
names[]

string

Required. Full resource names of Notebook, such as projects/{project}/locations/{location}/notebooks/{notebook_id}.

BatchDeleteSourcesRequest

Request for [SourceService.BatchDeleteSourcesRequest][] method.

Fields
parent

string

Required. The parent resource where the sources will be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}
names[]

string

Required. Names of sources to be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

CmekConfig

Customer-managed encryption configuration for Notebooks.

Fields
kms_key

string

Required. KMS key resource name which will be used to encrypt resources projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

CreateAudioOverviewRequest

Request for AudioOverviewService.CreateAudioOverview method.

Fields
parent

string

Required. The parent resource where this notebook will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}
generation_options

AudioOverviewGenerationOptions

Options for the audio overview generation.

CreateAudioOverviewResponse

Response for AudioOverviewService.CreateAudioOverview method.

Fields
audio_overview

AudioOverview

The generated audio overview.

CreateNotebookRequest

Request for NotebookService.CreateNotebook method.

Fields
parent

string

Required. The parent resource name, such as projects/{project}/locations/{location}.
notebook

Notebook

Required. The notebook to create.

DeleteAudioOverviewRequest

Request for AudioOverviewService.DeleteAudioOverview method.

Fields
name

string

Required. The full resource name of the AudioOverview, such as projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}.

GetNotebookRequest

Request for NotebookService.GetNotebook method.

Fields
name

string

Required. Full resource name of Notebook, such as projects/{project}/locations/{location}/notebooks/{notebook_id}.

GetSourceRequest

Request for SourceService.GetSource method.

Fields
name

string

Required. The resource name for source Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

ListRecentlyViewedNotebooksRequest

Request for NotebookService.ListRecentlyViewedNotebooks method.

Fields
parent

string

Required. The parent branch resource name, such as projects/{project}/locations/{location}.
page_size

int32

Optional. Maximum number of Notebooks to return. If unspecified, defaults to "200". The maximum allowed value is "500". If this field is negative, will use the default value.
page_token

string

Optional. The page token, provide this to retrieve the subsequent page.

ListRecentlyViewedNotebooksResponse

Response for NotebookService.ListRecentlyViewedNotebooks method.

Fields
notebooks[]

Notebook

The list of recently viewed notebooks.
next_page_token

string

The page token, provide this to retrieve the subsequent page.

Notebook

Notebook is a resource where users can store their content (as sources) and interacts with the content.

Fields
name

string

Identifier. The identifier of the notebook. Format: projects/{project}/locations/{location}/notebooks/{notebook_id}.

This field must be a UTF-8 encoded string.
cmek_config

CmekConfig

Output only. CMEK-related information for the Notebook.
title

string

Optional. The title of the notebook.
notebook_id

string

Optional. Notebook id, which is the last segment of the notebook's resource name. This is to make it similar with notebooklm API.
emoji

string

Output only. The emoji of the notebook.
metadata

NotebookMetadata

The metadata of the notebook.

NotebookMetadata

Metadata for a notebook.

Fields
is_shared

bool

True if this project is currently shared with other people, false otherwise.
is_shareable

bool

True if the project is shareable.
last_viewed

Timestamp

A timestamp indicating the time that the current in session user has last viewed the project.
create_time

Timestamp

The time at which this project was created.

ProjectRole

The role of the project.

IMPORTANT: This enum should never be used for authorization - it could be used to render certain elements in the UI or to communicate intent through a service interface.

Enums
PROJECT_ROLE_UNKNOWN Unknown role - do not use.
PROJECT_ROLE_OWNER The user owns the project.
PROJECT_ROLE_WRITER The user has writer permissions on the project.
PROJECT_ROLE_READER The user has reader permissions on the project.
PROJECT_ROLE_NOT_SHARED The user has no access to the project.

ShareNotebookRequest

Request for NotebookService.ShareNotebook method.

Fields
name

string

Required. Full resource name of Notebook, such as projects/{project}/locations/{location}/notebooks/{notebook_id}.
account_and_roles[]

AccountAndRole

Required. The list of accounts and roles to share the notebook with.
notify_via_email

bool

Required. Whether to notify the shared users via email.

ShareNotebookResponse

This type has no fields.

Response for NotebookService.ShareNotebook method.

Source

Source represents a single source of content.

Fields
name

string

Identifier. The full resource name of the source. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.
title

string

Optional. Title of the source.
source_id

SourceId

Optional. Source id, which is the last segment of the source's resource name. This is to make it similar with notebooklm API.
metadata

SourceMetadata

Metadata about the source.

SourceId

SourceId is the last segment of the source's resource name.

Fields
id

string

The id of the source.

SourceMetadata

Represents the metadata of a source and some additional information.

Fields
Union field metadata. Metadata for the source. metadata can be only one of the following:
agentspace_metadata

AgentspaceMetadata

Metadata for an agentspace source.
word_count

int32

The word count of the source.
token_count

int32

The number of tokens in the source.
source_added_timestamp

Timestamp

The timestamp the source was added.

UserContent

The "Content" messages refer to data the user wants to upload.

Fields
Union field content. The user content. content can be only one of the following:
google_drive_content

GoogleDriveContent

The content from Google Drive.
text_content

TextContent

The text content uploaded as source.
web_content

WebContent

The web content uploaded as source.
video_content

VideoContent

The video content uploaded as source.
agentspace_content

AgentspaceContent

Agentspace content uploaded as source.

AgentspaceContent

Agentspace content uploaded as source.

Fields
document_name

string

Optional. The full document name in Agentspace.
engine_name

string

Optional. Engine to verify the permission of the document.
ideaforge_idea_name

string

Optional. The full idea name for IdeaForge.

GoogleDriveContent

The content from Google Drive.

Fields
document_id

string

The document id of the selected document.
mime_type

string

The mime type of the selected document.

This can be used to differentiate type of content selected in the drive picker.
source_name

string

Should track this from Drive Picker.

TextContent

The text content uploaded as source.

Fields
source_name

string

The name of the text source.
content

string

The content of the text source.

VideoContent

Video content uploaded as source.

Fields
Union field format. Specifies the format of the video content format can be only one of the following:
youtube_url

string

The youtube url of the video content.

WebContent

The web content uploaded as source.

Fields
url

string

If URL is supplied, will fetch the webpage in the backend.
source_name

string

The name of the web source.