Discovery Engine API . projects . locations . notebooks . audioOverviews

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

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

delete(name, x__xgafv=None)

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); }
}