Console
    Contact Us Start free

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

    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.

    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.

    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.

    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 notebooks ordered by last view time.

    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.

    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 Source s.

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

    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 UserContent s to be uploaded.

    BatchCreateSourcesResponse

    Response for SourceService.BatchCreateSources method.

    Fields
    sources[]

    Source

    The Source s.

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

    FailureReason

    Failure reason containing details about why a source failed to ingest.

    Fields
    Union field error . The specific error. error can be only one of the following:
    unknown

    Unknown

    Indicates an unknown error occurred.

    source_too_long

    SourceTooLong

    Indicates source word count exceeded the user's limit.

    ingestion_error

    IngestionError

    Indicates an error occurred while ingesting the source.

    source_empty

    SourceEmpty

    Indicates that the source is empty.

    upload_error

    UploadError

    Indicates an error occurred while uploading the source.

    paywall_error

    PaywallError

    Indicates that the source is paywalled and cannot be ingested.

    source_unreachable

    SourceUnreachable

    Indicates that the source is unreachable.

    google_drive_error

    GoogleDriveError

    A google drive specific error.

    youtube_error

    YoutubeError

    A youtube specific error.

    audio_transcription_error

    AudioTranscriptionError

    An audio file transcription specific error.

    source_limit_exceeded

    SourceLimitExceeded

    Error if the user tries to update beyond their limits.

    domain_blocked

    DomainBlocked

    Error if the user tries to add a source from a blocked domain.

    AudioTranscriptionError

    An audio file transcription specific error.

    Fields
    Union field error . The audio file transcription specific error. error can be only one of the following:
    language_detection_failed

    LanguageDetectionFailed

    Could not detect language of the file (it may not be speech).

    no_audio_detected

    NoAudioDetected

    No audio was detected in the input file (it may have been a video).

    LanguageDetectionFailed

    This type has no fields.

    Could not detect language of the file (it may not be speech).

    NoAudioDetected

    This type has no fields.

    No audio was detected in the input file.

    DomainBlocked

    This type has no fields.

    Error to indicate that the source was removed because the domain was blocked.

    GoogleDriveError

    A google drive specific error.

    Fields
    Union field error . The Drive specific error. error can be only one of the following:
    download_prevented

    DownloadPrevented

    The user was prevented from downloading the file.

    DownloadPrevented

    This type has no fields.

    The user was prevented from downloading the file.

    IngestionError

    This type has no fields.

    Indicates an error occurred while ingesting the source.

    PaywallError

    This type has no fields.

    Indicates that the source is paywalled and cannot be ingested.

    SourceEmpty

    This type has no fields.

    Indicates that the source is empty.

    SourceLimitExceeded

    This type has no fields.

    Indicates that the user does not have space for this source.

    SourceTooLong

    Indicates source word count exceeded the user's limit.

    Fields
    word_count

    int32

    The number of words in the source.
    word_limit

    int32

    The word count limit for the current user at the time of the upload.

    SourceUnreachable

    Indicates that the source is unreachable. This is primarily used for sources that are added via URL.

    Fields
    error_details

    SourceUnreachableErrorReason

    Describes why the source is unreachable.

    Unknown

    This type has no fields.

    Indicates an unknown error occurred.

    UploadError

    This type has no fields.

    Indicates an error occurred while uploading the source.

    YoutubeError

    A youtube specific error.

    Fields
    Union field error . The youtube specific error. error can be only one of the following:
    video_deleted

    VideoDeleted

    Error to indicate that the source was removed because the video was deleted.

    VideoDeleted

    This type has no fields.

    Error to indicate that the source was removed because the video was deleted.

    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}

    GoogleDocsSourceMetadata

    Metadata about a google doc source.

    Fields
    document_id

    string

    Output only. The document id of the google doc.
    revision_id

    string

    Output only. Revision id for the doc.

    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 Notebook s 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.
    sources[]

    Source

    Output only. List of sources in the notebook. This is an output only field.
    cmek_config

    CmekConfig

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

    string

    Optional. The title of the notebook.
    notebook_id

    string

    Output only. Notebook id, which is the last segment of the notebook's resource name.
    emoji

    string

    Output only. The emoji of the notebook.
    metadata

    NotebookMetadata

    Output only. 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.

    Enums
    PROJECT_ROLE_UNKNOWN Unknown role.
    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. Output only. Source id, which is the last segment of the source's resource name.
    metadata

    SourceMetadata

    Output only. Metadata about the source.
    settings

    SourceSettings

    Output only. Status of the source, and any failure reasons.

    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:
    google_docs_metadata

    GoogleDocsSourceMetadata

    Metadata for a google doc source.

    youtube_metadata

    YoutubeMetadata

    Metadata for a youtube video source.

    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.

    SourceSettings

    Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request).

    Fields
    status

    SourceStatus

    Status of the source.
    failure_reason

    FailureReason

    Failure reason containing details about why a source failed to ingest.

    SourceStatus

    List of possible statuses for a source.

    Enums
    SOURCE_STATUS_UNSPECIFIED Unspecified status.
    SOURCE_STATUS_PENDING The source is pending addition.
    SOURCE_STATUS_COMPLETE Source addition is complete and successful.
    SOURCE_STATUS_ERROR Source addition has permanently failed.
    SOURCE_STATUS_PENDING_DELETION The source is pending deletion.
    SOURCE_STATUS_TENTATIVE The user is attempting to add a source, but we have not yet uploaded it or checked user limits. Does not count towards the user's source limit.

    SourceUnreachableErrorReason

    Details about why the source is unreachable. Used to display appropriate message to the user.

    Enums
    ERROR_REASON_UNSPECIFIED Default
    ERROR_REASON_INVALID_URL The source URL is invalid.
    ERROR_REASON_NOT_ACCESSIBLE The source URL is not accessible.
    ERROR_REASON_NOT_REACHABLE The source URL is not reachable.
    ERROR_REASON_URL_NOT_FOUND The source URL returned 404.
    ERROR_REASON_TRANSIENT_ERROR The source URL not reachable due to a transient network error or host timeout etc.
    ERROR_REASON_FETCH_FAILED The source URL could not be fetched due to an internal error.
    ERROR_REASON_NOT_SUPPORTED The URL is not yet supported. Examples include: the fetched content exceeds the trawler fetch max size, the fetched content is a type we do not yet support, etc.

    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. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides.
    source_name

    string

    The name to be displayed for the source.

    TextContent

    The text content uploaded as source.

    Fields
    source_name

    string

    The display name of the text source.
    content

    string

    The name to be displayed for the 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 to be displayed for the source.

    YoutubeMetadata

    Metadata about a youtube video source.

    Fields
    video_id

    string

    Output only. The id of the youtube video.
    channel_name

    string

    Output only. The channel name of the youtube video.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: