Package google.cloud.notebooklm.v1alpha

Index

AudioOverviewService

Service for managing audio overviews.

CreateAudioOverview

rpc CreateAudioOverview(CreateAudioOverviewRequest) returns (CreateAudioOverviewResponse)

Generates a new audio overview.

Authorization scopes

Requires one of the following OAuth scopes:

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

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.

Authorization scopes

Requires one of the following OAuth scopes:

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

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.

DiscoverSourcesService

Service for managing asynchronous source-discovery jobs on a notebook.

Each method either kicks off a new background discovery job under a notebook (collection-based custom methods such as DiscoverSourcesFastResearch and DiscoverSourcesDeepResearch) or acts on an existing job identified by source_discovery_job_id.

LabelService

Service for managing labels.

NotebookService

Service for managing notebooks.

SourceService

Service for managing sources.

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.
generation_options

AudioOverviewGenerationOptions

The options used to generate the audio overview.
mime_type

MimeType

The mime type of 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.).

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.

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.

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

SourceId

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

Fields
id

string

The ID of the source.