Method: projects.locations.notebooks.audioOverviews.create

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

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/notebooks/*}/audioOverviews

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "generationOptions": {
    object (AudioOverviewGenerationOptions)
  }
}
Fields
generationOptions

object (AudioOverviewGenerationOptions)

Options for the audio overview generation.

Response body

Response for AudioOverviewService.CreateAudioOverview method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "audioOverview": {
    object (AudioOverview)
  }
}
Fields
audioOverview

object (AudioOverview)

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

AudioOverviewGenerationOptions

Options used during audio overview generation.

JSON representation 
{
  "sourceIds": [
    {
      object (SourceId)
    }
  ],
  "episodeFocus": string,
  "languageCode": string
}
Fields
sourceIds[]

object (SourceId)

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

string

What the hosts of the show should focus on.
languageCode

string

The language that the audio overview was requested in.