feat: added support for playbook level speech settings

feat: added support for answer feedback & latency metrics in conversation history feat: added DocumentProcessingMode & BoostSpec for data stores PiperOrigin-RevId: 730930887
googleapis · Feb 25, 2025 · fbbbf50 · fbbbf50
1 parent fe0fa26
commit fbbbf50
Show file tree

Hide file tree

Showing 23 changed files with 101 additions and 49 deletions.
diff --git a/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel b/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel
@@ -431,7 +431,6 @@ load(
 
 csharp_proto_library(
     name = "cx_csharp_proto",
-    extra_opts = [],
     deps = [":cx_proto"],
 )
 

diff --git a/google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto b/google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto
@@ -20,7 +20,6 @@ import "google/api/field_behavior.proto";
 import "google/cloud/dialogflow/cx/v3beta1/gcs.proto";
 import "google/protobuf/duration.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;
@@ -50,7 +49,7 @@ message AdvancedSettings {
     // Timeout before detecting no speech.
     google.protobuf.Duration no_speech_timeout = 2;
 
-    // Use timeout based endpointing, interpreting endpointer sensitivy as
+    // Use timeout based endpointing, interpreting endpointer sensitivity as
     // seconds of timeout value.
     bool use_timeout_based_endpointing = 3;
 

diff --git a/google/cloud/dialogflow/cx/v3beta1/agent.proto b/google/cloud/dialogflow/cx/v3beta1/agent.proto
@@ -30,7 +30,6 @@ import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/struct.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;
@@ -433,6 +432,20 @@ message Agent {
   // Optional. Settings for custom client certificates.
   ClientCertificateSettings client_certificate_settings = 43
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Output only. A read only boolean field reflecting Zone Separation
+  // status of the agent.
+  optional bool satisfies_pzs = 45 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.field_behavior) = OUTPUT_ONLY
+  ];
+
+  // Optional. Output only. A read only boolean field reflecting Zone Isolation
+  // status of the agent.
+  optional bool satisfies_pzi = 46 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.field_behavior) = OUTPUT_ONLY
+  ];
 }
 
 // The request message for

diff --git a/google/cloud/dialogflow/cx/v3beta1/audio_config.proto b/google/cloud/dialogflow/cx/v3beta1/audio_config.proto
@@ -20,7 +20,6 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/duration.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;
@@ -165,7 +164,7 @@ message SpeechWordInfo {
 //
 // The client provides this configuration in terms of the durations of those
 // two phases. The durations are measured in terms of the audio length from the
-// the start of the input audio.
+// start of the input audio.
 //
 // No-speech event is a response with END_OF_UTTERANCE without any transcript
 // following up.

diff --git a/google/cloud/dialogflow/cx/v3beta1/bigquery_export.proto b/google/cloud/dialogflow/cx/v3beta1/bigquery_export.proto
@@ -16,7 +16,6 @@ syntax = "proto3";
 
 package google.cloud.dialogflow.cx.v3beta1;
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/changelog.proto b/google/cloud/dialogflow/cx/v3beta1/changelog.proto
@@ -22,7 +22,6 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/timestamp.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/conversation_history.proto b/google/cloud/dialogflow/cx/v3beta1/conversation_history.proto
@@ -291,6 +291,15 @@ message Conversation {
       float score = 2;
     }
 
+    // Metrics of each processing step.
+    message StepMetrics {
+      // Name of the request processing step.
+      string name = 1;
+
+      // Processing latency of the step.
+      google.protobuf.Duration latency = 2;
+    }
+
     // The request of the interaction.
     DetectIntentRequest request = 1;
 
@@ -315,9 +324,16 @@ message Conversation {
     // The time that the interaction was created.
     google.protobuf.Timestamp create_time = 6;
 
+    // Answer feedback for the final response.
+    AnswerFeedback answer_feedback = 7;
+
     // Missing transition predicted for the interaction. This field is set only
     // if the interaction match type was no-match.
     MissingTransition missing_transition = 8;
+
+    // Metrics associated with different processing steps. Names and number of
+    // steps depend on the request and can change without a notice.
+    repeated StepMetrics step_metrics = 9;
   }
 
   // Identifier. The identifier of the conversation.

diff --git a/google/cloud/dialogflow/cx/v3beta1/data_store_connection.proto b/google/cloud/dialogflow/cx/v3beta1/data_store_connection.proto
@@ -37,6 +37,11 @@ message DataStoreConnection {
   // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
   // `projects/{project}/locations/{location}/dataStores/{data_store}`
   string data_store = 2;
+
+  // The document processing mode for the data store connection. Should only be
+  // set for PUBLIC_WEB and UNSTRUCTURED data stores. If not set it is
+  // considered as DOCUMENTS, as this is the legacy mode.
+  DocumentProcessingMode document_processing_mode = 4;
 }
 
 // Type of a data store.
@@ -235,3 +240,17 @@ message DataStoreConnectionSignals {
   // Optional. Safety check result.
   SafetySignals safety_signals = 9 [(google.api.field_behavior) = OPTIONAL];
 }
+
+// The document processing mode of the data store.
+enum DocumentProcessingMode {
+  // Not specified. This should be set for STRUCTURED type data stores. Due to
+  // legacy reasons this is considered as DOCUMENTS for STRUCTURED and
+  // PUBLIC_WEB data stores.
+  DOCUMENT_PROCESSING_MODE_UNSPECIFIED = 0;
+
+  // Documents are processed as documents.
+  DOCUMENTS = 1;
+
+  // Documents are converted to chunks.
+  CHUNKS = 2;
+}
diff --git a/google/cloud/dialogflow/cx/v3beta1/deployment.proto b/google/cloud/dialogflow/cx/v3beta1/deployment.proto
@@ -22,7 +22,6 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/timestamp.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/environment.proto b/google/cloud/dialogflow/cx/v3beta1/environment.proto
@@ -28,7 +28,6 @@ import "google/protobuf/field_mask.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/example.proto b/google/cloud/dialogflow/cx/v3beta1/example.proto
@@ -304,6 +304,9 @@ message ToolUse {
     (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Tool" }
   ];
 
+  // Output only. The display name of the tool.
+  string display_name = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Optional. Name of the action to be called during the tool use.
   string action = 2 [(google.api.field_behavior) = OPTIONAL];
 
@@ -328,6 +331,9 @@ message PlaybookInvocation {
     }
   ];
 
+  // Output only. The display name of the playbook.
+  string display_name = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Optional. Input of the child playbook invocation.
   PlaybookInput playbook_input = 2 [(google.api.field_behavior) = OPTIONAL];
 
@@ -348,6 +354,9 @@ message FlowInvocation {
     (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Flow" }
   ];
 
+  // Output only. The display name of the flow.
+  string display_name = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Optional. A list of input parameters for the flow.
   google.protobuf.Struct input_action_parameters = 5
       [(google.api.field_behavior) = OPTIONAL];

diff --git a/google/cloud/dialogflow/cx/v3beta1/flow.proto b/google/cloud/dialogflow/cx/v3beta1/flow.proto
@@ -30,7 +30,6 @@ import "google/protobuf/field_mask.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;
@@ -299,7 +298,7 @@ message Flow {
   // way regardless of the current page. Transition routes defined in the page
   // have higher priority than those defined in the flow.
   //
-  // TransitionRoutes are evalauted in the following order:
+  // TransitionRoutes are evaluated in the following order:
   //
   // *   TransitionRoutes with intent specified.
   // *   TransitionRoutes with only condition specified.

diff --git a/google/cloud/dialogflow/cx/v3beta1/fulfillment.proto b/google/cloud/dialogflow/cx/v3beta1/fulfillment.proto
@@ -21,7 +21,6 @@ import "google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto";
 import "google/cloud/dialogflow/cx/v3beta1/response_message.proto";
 import "google/protobuf/struct.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/gcs.proto b/google/cloud/dialogflow/cx/v3beta1/gcs.proto
@@ -18,7 +18,6 @@ package google.cloud.dialogflow.cx.v3beta1;
 
 import "google/api/field_behavior.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/generative_settings.proto b/google/cloud/dialogflow/cx/v3beta1/generative_settings.proto
@@ -19,7 +19,6 @@ package google.cloud.dialogflow.cx.v3beta1;
 import "google/api/resource.proto";
 import "google/cloud/dialogflow/cx/v3beta1/safety_settings.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/generator.proto b/google/cloud/dialogflow/cx/v3beta1/generator.proto
@@ -24,7 +24,6 @@ import "google/cloud/dialogflow/cx/v3beta1/generative_settings.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/intent.proto b/google/cloud/dialogflow/cx/v3beta1/intent.proto
@@ -25,7 +25,6 @@ import "google/longrunning/operations.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;
@@ -165,7 +164,7 @@ message Intent {
     }
 
     // Output only. The unique identifier of the training phrase.
-    string id = 1;
+    string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
 
     // Required. The ordered list of training phrase parts.
     // The parts are concatenated in order to form the training phrase.

diff --git a/google/cloud/dialogflow/cx/v3beta1/page.proto b/google/cloud/dialogflow/cx/v3beta1/page.proto
@@ -157,7 +157,7 @@ message Page {
   // They route the conversation to another page in the same flow, or another
   // flow.
   //
-  // When we are in a certain page, the TransitionRoutes are evalauted in the
+  // When we are in a certain page, the TransitionRoutes are evaluated in the
   // following order:
   //
   // *   TransitionRoutes defined in the page with intent specified.

diff --git a/google/cloud/dialogflow/cx/v3beta1/playbook.proto b/google/cloud/dialogflow/cx/v3beta1/playbook.proto
@@ -20,14 +20,14 @@ import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto";
 import "google/cloud/dialogflow/cx/v3beta1/example.proto";
 import "google/cloud/dialogflow/cx/v3beta1/generative_settings.proto";
 import "google/cloud/dialogflow/cx/v3beta1/parameter_definition.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;
@@ -237,6 +237,11 @@ message Playbook {
 
   // Message of the Instruction of the playbook.
   message Instruction {
+    // General guidelines for the playbook. These are unstructured instructions
+    // that are not directly part of the goal, e.g. "Always be polite". It's
+    // valid for this text to be long and used instead of steps altogether.
+    string guidelines = 1;
+
     // Ordered list of step by step execution instructions to accomplish
     // target goal.
     repeated Step steps = 2;
@@ -251,7 +256,8 @@ message Playbook {
   string display_name = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Required. High level description of the goal the playbook intend to
-  // accomplish.
+  // accomplish. A goal should be concise since it's visible to other playbooks
+  // that may reference this playbook.
   string goal = 3 [(google.api.field_behavior) = REQUIRED];
 
   // Optional. Defined structured input parameters for this playbook.
@@ -304,6 +310,10 @@ message Playbook {
   // Optional. Llm model settings for the playbook.
   LlmModelSettings llm_model_settings = 14
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Playbook level Settings for speech to text detection.
+  AdvancedSettings.SpeechSettings speech_settings = 20
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request message for

diff --git a/google/cloud/dialogflow/cx/v3beta1/response_message.proto b/google/cloud/dialogflow/cx/v3beta1/response_message.proto
@@ -20,7 +20,6 @@ import "google/api/field_behavior.proto";
 import "google/cloud/dialogflow/cx/v3beta1/tool_call.proto";
 import "google/protobuf/struct.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
 option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
 option java_multiple_files = true;