docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.notebooks.html">notebooks</a> . <a href="discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html">audioOverviews</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates a new audio overview.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an audio overview.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Generates a new audio overview.

Args:
  parent: string, Required. The parent resource where this notebook will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for AudioOverviewService.CreateAudioOverview method.
  &quot;generationOptions&quot;: { # Options used during audio overview generation. # Options for the audio overview generation.
    &quot;episodeFocus&quot;: &quot;A String&quot;, # What the hosts of the show should focus on.
    &quot;languageCode&quot;: &quot;A String&quot;, # The language that the audio overview was requested in.
    &quot;sourceIds&quot;: [ # Optional. The sources in which the audio overview is grounded.
      { # SourceId is the last segment of the source&#x27;s resource name.
        &quot;id&quot;: &quot;A String&quot;, # The id of the source.
      },
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for AudioOverviewService.CreateAudioOverview method.
  &quot;audioOverview&quot;: { # An audio overview of a notebook. This is a summary of the notebook in audio format. # The generated audio overview.
    &quot;audioOverviewId&quot;: &quot;A String&quot;, # Output only. Unique ID of the audio overview.
    &quot;generationOptions&quot;: { # Options used during audio overview generation. # The options used to generate the audio overview.
      &quot;episodeFocus&quot;: &quot;A String&quot;, # What the hosts of the show should focus on.
      &quot;languageCode&quot;: &quot;A String&quot;, # The language that the audio overview was requested in.
      &quot;sourceIds&quot;: [ # Optional. The sources in which the audio overview is grounded.
        { # SourceId is the last segment of the source&#x27;s resource name.
          &quot;id&quot;: &quot;A String&quot;, # The id of the source.
        },
      ],
    },
    &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the generated audio overview. Use the BCP 47 language code (e.g. &quot;en&quot;, &quot;es&quot;, &quot;hi&quot;, etc.).
    &quot;mimeType&quot;: &quot;A String&quot;, # The mime type of the audio overview.
    &quot;name&quot;: &quot;A String&quot;, # 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.
    &quot;status&quot;: &quot;A String&quot;, # The status of the audio overview.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes an audio overview.

Args:
  name: string, Required. The full resource name of the AudioOverview, such as `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

</body></html>