Google Cloud Dialogflow Cx V3 Client - Class AudioExportSettings (0.4.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class AudioExportSettings.

Settings for exporting audio.

Generated from protobuf message google.cloud.dialogflow.cx.v3.SecuritySettings.AudioExportSettings

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3 \ SecuritySettings

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ gcs_bucket string

Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy.

↳ audio_export_pattern string

Filename pattern for exported audio.

↳ enable_audio_redaction bool

Enable audio redaction if it is true. Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted.

↳ audio_format int

File format for exported audio file. Currently only in telephony recordings.

↳ store_tts_audio bool

Whether to store TTS audio. By default, TTS audio from the virtual agent is not exported.

getGcsBucket

Cloud Storage bucket to export audio record to.

Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy.

Returns
Type Description
string

setGcsBucket

Cloud Storage bucket to export audio record to.

Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy.

Parameter
Name Description
var string
Returns
Type Description
$this

getAudioExportPattern

Filename pattern for exported audio.

Returns
Type Description
string

setAudioExportPattern

Filename pattern for exported audio.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnableAudioRedaction

Enable audio redaction if it is true.

Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted.

Returns
Type Description
bool

setEnableAudioRedaction

Enable audio redaction if it is true.

Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAudioFormat

File format for exported audio file. Currently only in telephony recordings.

Returns
Type Description
int

setAudioFormat

File format for exported audio file. Currently only in telephony recordings.

Parameter
Name Description
var int
Returns
Type Description
$this

getStoreTtsAudio

Whether to store TTS audio. By default, TTS audio from the virtual agent is not exported.

Returns
Type Description
bool

setStoreTtsAudio

Whether to store TTS audio. By default, TTS audio from the virtual agent is not exported.

Parameter
Name Description
var bool
Returns
Type Description
$this