feat: added audio_export_settings

Google APIs · copybara-github · commit 4bd299a6f47c · 2022-04-26T13:06:59.000-07:00
PiperOrigin-RevId: 444644952
diff --git a/google/cloud/dialogflow/cx/v3/security_settings.proto b/google/cloud/dialogflow/cx/v3/security_settings.proto
@@ -213,6 +213,41 @@ message SecuritySettings {
     DIALOGFLOW_HISTORY = 1;
   }
 
+  // Settings for exporting audio.
+  message AudioExportSettings {
+    // File format for exported audio file. Currently only in telephony
+    // recordings.
+    enum AudioFormat {
+      // Unspecified. Do not use.
+      AUDIO_FORMAT_UNSPECIFIED = 0;
+
+      // G.711 mu-law PCM with 8kHz sample rate.
+      MULAW = 1;
+
+      // MP3 file format.
+      MP3 = 2;
+
+      // OGG Vorbis.
+      OGG = 3;
+    }
+
+    // Cloud Storage bucket to export audio record to. You need to grant
+    // `service-<Conversation Project
+    // Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Storage Object
+    // Admin` role in this bucket.
+    string gcs_bucket = 1;
+
+    // Filename pattern for exported audio.
+    string audio_export_pattern = 2;
+
+    // Enable audio redaction if it is true.
+    bool enable_audio_redaction = 3;
+
+    // File format for exported audio file. Currently only in telephony
+    // recordings.
+    AudioFormat audio_format = 4;
+  }
+
   // Settings for exporting conversations to
   // [Insights](https://cloud.google.com/contact-center/insights/docs).
   message InsightsExportSettings {
@@ -302,6 +337,21 @@ message SecuritySettings {
   // List of types of data to remove when retention settings triggers purge.
   repeated PurgeDataType purge_data_types = 8;
 
+  // Controls audio export settings for post-conversation analytics when
+  // ingesting audio to conversations via [Participants.AnalyzeContent][] or
+  // [Participants.StreamingAnalyzeContent][].
+  //
+  // If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy] is set to REMOVE_AFTER_CONVERSATION or
+  // [audio_export_settings.gcs_bucket][] is empty, audio export is disabled.
+  //
+  // If audio export is enabled, audio is recorded and saved to
+  // [audio_export_settings.gcs_bucket][], subject to retention policy of
+  // [audio_export_settings.gcs_bucket][].
+  //
+  // This setting won't effect audio input for implicit sessions via
+  // [Sessions.DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] or [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent].
+  AudioExportSettings audio_export_settings = 12;
+
   // Controls conversation exporting settings to Insights after conversation is
   // completed.
   //
