feat: added audio_export_settings (#257)

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 444644952 Source-Link: googleapis/googleapis@4bd299a Source-Link: googleapis/googleapis-gen@cd15ee9 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiY2QxNWVlOWI5NWZlYjY1YmQ5ZmQzMTE2MGM3ZDVmM2NiZGIzNWQ0MCJ9 docs: minor wording update PiperOrigin-RevId: 442267541 Source-Link: googleapis/googleapis@740f072 Source-Link: googleapis/googleapis-gen@29eb892 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjllYjg5MmNjYTViMWIwMTM0YjRlYzE4NWRkM2QyZWY1ZDJhZjFhNCJ9 docs: minor wording update PiperOrigin-RevId: 442267451 Source-Link: googleapis/googleapis@4445d18 Source-Link: googleapis/googleapis-gen@4e175b7 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGUxNzViNzllYzQxNThmMmU3ZmFiOWY0ZGVhMGViZjc2M2E1Y2FhNiJ9
googleapis · Apr 27, 2022 · 83b25ab · 83b25ab
1 parent e9db6dc
commit 83b25ab
Show file tree

Hide file tree

Showing 23 changed files with 630 additions and 74 deletions.
diff --git a/...s/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/advanced_settings.proto b/...s/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/advanced_settings.proto
@@ -16,6 +16,8 @@ syntax = "proto3";
 
 package google.cloud.dialogflow.cx.v3;
 
+import "google/api/field_behavior.proto";
+
 option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
 option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3;cx";

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/audio_config.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/audio_config.proto
@@ -17,6 +17,7 @@ syntax = "proto3";
 package google.cloud.dialogflow.cx.v3;
 
 import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
 import "google/protobuf/duration.proto";
 
 option cc_enable_arenas = true;
@@ -27,6 +28,10 @@ option java_outer_classname = "AudioConfigProto";
 option java_package = "com.google.cloud.dialogflow.cx.v3";
 option objc_class_prefix = "DF";
 option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
+option (google.api.resource_definition) = {
+  type: "automl.googleapis.com/Model"
+  pattern: "projects/{project}/locations/{location}/models/{model}"
+};
 
 // Audio encoding of the audio content sent in the conversational query request.
 // Refer to the

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/flow.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/flow.proto
@@ -274,7 +274,7 @@ message Flow {
   //
   // TransitionRoutes are evalauted in the following order:
   //
-  // *   TransitionRoutes with intent specified..
+  // *   TransitionRoutes with intent specified.
   // *   TransitionRoutes with only condition specified.
   //
   // TransitionRoutes with intent specified are inherited by pages in the flow.

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/fulfillment.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/fulfillment.proto
@@ -106,7 +106,11 @@ message Fulfillment {
   // that have slow webhooks.
   bool return_partial_responses = 8;
 
-  // The tag used by the webhook to identify which fulfillment is being called.
+  // The value of this field will be populated in the [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]
+  // `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
+  // called.
+  // The tag is typically used by the webhook service to identify which
+  // fulfillment is being called, but it could be used for other purposes.
   // This field is required if `webhook` is specified.
   string tag = 3;
 

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/page.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/page.proto
@@ -125,7 +125,7 @@ message Page {
   // ID>/flows/<Flow ID>/pages/<Page ID>`.
   string name = 1;
 
-  // Required. The human-readable name of the page, unique within the agent.
+  // Required. The human-readable name of the page, unique within the flow.
   string display_name = 2 [(google.api.field_behavior) = REQUIRED];
 
   // The fulfillment to call when the session is entering the page.

diff --git a/...s/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/security_settings.proto b/...s/google-cloud-dialogflow-cx/protos/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.
   //

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/test_case.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/test_case.proto
@@ -139,7 +139,7 @@ service TestCases {
   }
 
   // Imports the test cases from a Cloud Storage bucket or a local file. It
-  // always creates new test cases and won't overwite any existing ones. The
+  // always creates new test cases and won't overwrite any existing ones. The
   // provided ID in the imported test case is neglected.
   //
   // This method is a [long-running

diff --git a/...gle-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/transition_route_group.proto b/...gle-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/transition_route_group.proto
@@ -111,7 +111,7 @@ message TransitionRouteGroup {
   string name = 1;
 
   // Required. The human-readable name of the transition route group, unique within
-  // the [Agent][google.cloud.dialogflow.cx.v3.Agent]. The display name can be no longer than 30 characters.
+  // the flow. The display name can be no longer than 30 characters.
   string display_name = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Transition routes associated with the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/webhook.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/webhook.proto
@@ -276,8 +276,11 @@ message DeleteWebhookRequest {
 message WebhookRequest {
   // Represents fulfillment information communicated to the webhook.
   message FulfillmentInfo {
-    // Always present. The tag used to identify which fulfillment is being
-    // called.
+    // Always present.
+    // The value of the [Fulfillment.tag][google.cloud.dialogflow.cx.v3.Fulfillment.tag] field will be populated in this
+    // field by Dialogflow when the associated webhook is called.
+    // The tag is typically used by the webhook service to identify which
+    // fulfillment is being called, but it could be used for other purposes.
     string tag = 1;
   }
 

diff --git a/...s/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/audio_config.proto b/...s/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/audio_config.proto
@@ -28,6 +28,10 @@ option java_outer_classname = "AudioConfigProto";
 option java_package = "com.google.cloud.dialogflow.cx.v3beta1";
 option objc_class_prefix = "DF";
 option ruby_package = "Google::Cloud::Dialogflow::CX::V3beta1";
+option (google.api.resource_definition) = {
+  type: "automl.googleapis.com/Model"
+  pattern: "projects/{project}/locations/{location}/models/{model}"
+};
 
 // Audio encoding of the audio content sent in the conversational query request.
 // Refer to the

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/flow.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/flow.proto
@@ -274,7 +274,7 @@ message Flow {
   //
   // TransitionRoutes are evalauted in the following order:
   //
-  // *   TransitionRoutes with intent specified..
+  // *   TransitionRoutes with intent specified.
   // *   TransitionRoutes with only condition specified.
   //
   // TransitionRoutes with intent specified are inherited by pages in the flow.

diff --git a/...es/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/fulfillment.proto b/...es/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/fulfillment.proto
@@ -106,7 +106,11 @@ message Fulfillment {
   // that have slow webhooks.
   bool return_partial_responses = 8;
 
-  // The tag used by the webhook to identify which fulfillment is being called.
+  // The value of this field will be populated in the [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest]
+  // `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
+  // called.
+  // The tag is typically used by the webhook service to identify which
+  // fulfillment is being called, but it could be used for other purposes.
   // This field is required if `webhook` is specified.
   string tag = 3;
 

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/page.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/page.proto
@@ -113,7 +113,7 @@ message Page {
   // ID>/flows/<Flow ID>/pages/<Page ID>`.
   string name = 1;
 
-  // Required. The human-readable name of the page, unique within the agent.
+  // Required. The human-readable name of the page, unique within the flow.
   string display_name = 2 [(google.api.field_behavior) = REQUIRED];
 
   // The fulfillment to call when the session is entering the page.

diff --git a/...ages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/test_case.proto b/...ages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/test_case.proto
@@ -139,7 +139,7 @@ service TestCases {
   }
 
   // Imports the test cases from a Cloud Storage bucket or a local file. It
-  // always creates new test cases and won't overwite any existing ones. The
+  // always creates new test cases and won't overwrite any existing ones. The
   // provided ID in the imported test case is neglected.
   //
   // This method is a [long-running

diff --git a/...loud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/transition_route_group.proto b/...loud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/transition_route_group.proto
@@ -111,7 +111,7 @@ message TransitionRouteGroup {
   string name = 1;
 
   // Required. The human-readable name of the transition route group, unique within
-  // the [Agent][google.cloud.dialogflow.cx.v3beta1.Agent]. The display name can be no longer than 30 characters.
+  // the flow. The display name can be no longer than 30 characters.
   string display_name = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Transition routes associated with the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].

diff --git a/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/webhook.proto b/packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/webhook.proto
@@ -276,8 +276,11 @@ message DeleteWebhookRequest {
 message WebhookRequest {
   // Represents fulfillment information communicated to the webhook.
   message FulfillmentInfo {
-    // Always present. The tag used to identify which fulfillment is being
-    // called.
+    // Always present.
+    // The value of the [Fulfillment.tag][google.cloud.dialogflow.cx.v3beta1.Fulfillment.tag] field will be populated in this
+    // field by Dialogflow when the associated webhook is called.
+    // The tag is typically used by the webhook service to identify which
+    // fulfillment is being called, but it could be used for other purposes.
     string tag = 1;
   }