fix!: An existing field start_flow is moved in to oneof in message …

…`.google.cloud.dialogflow.cx.v3beta1.Agent`

fix!: An existing field `start_playbook` is moved in to oneof in message `.google.cloud.dialogflow.cx.v3beta1.Agent`
fix!: An existing field `parameters` is removed from message `.google.cloud.dialogflow.cx.v3beta1.PlaybookInput`
fix!: An existing field `parameters` is removed from message `.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput`
fix!: An existing field `input_parameters` is removed from message `.google.cloud.dialogflow.cx.v3beta1.ToolUse`
fix!: An existing field `output_parameters` is removed from message `.google.cloud.dialogflow.cx.v3beta1.ToolUse`
fix!: An existing message `ActionParameter` is removed
fix!: An existing field `input_parameters` is removed from message `.google.cloud.dialogflow.cx.v3beta1.FlowInvocation`
fix!: An existing field `output_parameters` is removed from message `.google.cloud.dialogflow.cx.v3beta1.FlowInvocation`
fix!: An existing field `steps` is removed from message `.google.cloud.dialogflow.cx.v3beta1.Playbook`
fix!: An existing field `actions` is removed from message `.google.cloud.dialogflow.cx.v3beta1.Tool`
fix!: An existing field `schemas` is removed from message `.google.cloud.dialogflow.cx.v3beta1.Tool`
feat: A new field `interdigit_timeout_duration` is added to message `.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings`
feat: A new field `endpointing_timeout_duration` is added to message `.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings`
feat: A new field `action_parameters` is added to message `.google.cloud.dialogflow.cx.v3beta1.PlaybookInput`
feat: A new field `action_parameters` is added to message `.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput`
feat: A new field `input_action_parameters` is added to message `.google.cloud.dialogflow.cx.v3beta1.ToolUse`
feat: A new field `output_action_parameters` is added to message `.google.cloud.dialogflow.cx.v3beta1.ToolUse`
feat: A new field `input_action_parameters` is added to message `.google.cloud.dialogflow.cx.v3beta1.FlowInvocation`
feat: A new field `output_action_parameters` is added to message `.google.cloud.dialogflow.cx.v3beta1.FlowInvocation`
feat: A new message `Instruction` is added
feat: A new field `instruction` is added to message `.google.cloud.dialogflow.cx.v3beta1.Playbook`
feat: A new field `tool_call` is added to message `.google.cloud.dialogflow.cx.v3beta1.ResponseMessage`
feat: A new field `store_tts_audio` is added to message `.google.cloud.dialogflow.cx.v3beta1.SecuritySettings`
feat: A new value `PLAYBOOK` is added to enum `MatchType`
feat: A new message `ToolCall` is added
docs: A comment for field `start_flow` in message `.google.cloud.dialogflow.cx.v3beta1.Agent` is changed
docs: A comment for field `start_playbook` in message `.google.cloud.dialogflow.cx.v3beta1.Agent` is changed

PiperOrigin-RevId: 640982171

google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto

@@ -77,6 +77,12 @@ message AdvancedSettings {
 
     // The digit that terminates a DTMF digit sequence.
     string finish_digit = 3;
+
+    // Interdigit timeout setting for matching dtmf input to regex.
+    google.protobuf.Duration interdigit_timeout_duration = 6;
+
+    // Endpoint timeout setting for matching dtmf input to regex.
+    google.protobuf.Duration endpointing_timeout_duration = 7;
   }
 
   // Define behaviors on logging.

google/cloud/dialogflow/cx/v3beta1/agent.proto

@@ -314,30 +314,29 @@ message Agent {
   // Speech recognition related settings.
   SpeechToTextSettings speech_to_text_settings = 13;
 
-  // Immutable. Name of the start flow in this agent. A start flow will be
-  // automatically created when the agent is created, and can only be deleted by
-  // deleting the agent. Format: `projects/<Project ID>/locations/<Location
-  // ID>/agents/<Agent ID>/flows/<Flow ID>`.
-  string start_flow = 16 [
-    (google.api.field_behavior) = IMMUTABLE,
-    (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Flow" }
-  ];
-
-  // Optional. Name of the start playbook in this agent. A start playbook will
-  // be automatically created when the agent is created, and can only be deleted
-  // by deleting the agent.
-  // Format: `projects/<Project ID>/locations/<Location
-  // ID>/agents/<Agent ID>/playbooks/<Playbook ID>`. Currently only the
-  // default playbook with id
-  // "00000000-0000-0000-0000-000000000000" is allowed.
-  //
-  // Only one of `start_flow` or `start_playbook` should be set, but not both.
-  string start_playbook = 39 [
-    (google.api.field_behavior) = OPTIONAL,
-    (google.api.resource_reference) = {
+  // The resource to start the conversations with for the agent.
+  oneof session_entry_resource {
+    // Name of the start flow in this agent. A start flow will be automatically
+    // created when the agent is created, and can only be deleted by deleting
+    // the agent.
+    // Format: `projects/<Project ID>/locations/<Location
+    // ID>/agents/<Agent ID>/flows/<Flow ID>`. Currently only the default start
+    // flow with id "00000000-0000-0000-0000-000000000000" is allowed.
+    string start_flow = 16 [(google.api.resource_reference) = {
+      type: "dialogflow.googleapis.com/Flow"
+    }];
+
+    // Name of the start playbook in this agent. A start playbook will be
+    // automatically created when the agent is created, and can only be deleted
+    // by deleting the agent.
+    // Format: `projects/<Project ID>/locations/<Location
+    // ID>/agents/<Agent ID>/playbooks/<Playbook ID>`. Currently only the
+    // default playbook with id
+    // "00000000-0000-0000-0000-000000000000" is allowed.
+    string start_playbook = 39 [(google.api.resource_reference) = {
       type: "dialogflow.googleapis.com/Playbook"
-    }
-  ];
+    }];
+  }
 
   // Name of the
   // [SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings]

google/cloud/dialogflow/cx/v3beta1/dialogflow_grpc_service_config.json

@@ -41,6 +41,15 @@
         {
           "service": "google.cloud.dialogflow.cx.v3beta1.Pages"
         },
+        {
+          "service": "google.cloud.dialogflow.cx.v3beta1.Playbooks"
+        },
+        {
+          "service": "google.cloud.dialogflow.cx.v3beta1.Examples"
+        },
+        {
+          "service": "google.cloud.dialogflow.cx.v3beta1.Tools"
+        },
         {
           "service": "google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService"
         },

google/cloud/dialogflow/cx/v3beta1/example.proto

@@ -243,8 +243,8 @@ message PlaybookInput {
   string preceding_conversation_summary = 1
       [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. A list of input parameters for the invocation.
-  repeated ActionParameter parameters = 2
+  // Optional. A list of input parameters for the action.
+  google.protobuf.Struct action_parameters = 3
       [(google.api.field_behavior) = OPTIONAL];
 }
 
@@ -253,8 +253,8 @@ message PlaybookOutput {
   // Optional. Summary string of the execution result of the child playbook.
   string execution_summary = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. A list of output parameters for the invocation.
-  repeated ActionParameter parameters = 3
+  // Optional. A Struct object of output parameters for the action.
+  google.protobuf.Struct action_parameters = 4
       [(google.api.field_behavior) = OPTIONAL];
 }
 
@@ -307,20 +307,13 @@ message ToolUse {
   // Optional. Name of the action to be called during the tool use.
   string action = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A list of input parameters for the action.
-  repeated ActionParameter input_parameters = 3;
-
-  // A list of output parameters generated by the action.
-  repeated ActionParameter output_parameters = 4;
-}
-
-// Parameter associated with action.
-message ActionParameter {
-  // Required. Name of the parameter.
-  string name = 1 [(google.api.field_behavior) = REQUIRED];
+  // Optional. A list of input parameters for the action.
+  google.protobuf.Struct input_action_parameters = 5
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // Required. Value of the parameter.
-  google.protobuf.Value value = 2 [(google.api.field_behavior) = REQUIRED];
+  // Optional. A list of output parameters generated by the action.
+  google.protobuf.Struct output_action_parameters = 6
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Stores metadata of the invocation of a child playbook.
@@ -357,11 +350,13 @@ message FlowInvocation {
     (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Flow" }
   ];
 
-  // A list of input parameters for the flow invocation.
-  repeated ActionParameter input_parameters = 2;
+  // Optional. A list of input parameters for the flow.
+  google.protobuf.Struct input_action_parameters = 5
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // A list of output parameters generated by the flow invocation.
-  repeated ActionParameter output_parameters = 3;
+  // Optional. A list of output parameters generated by the flow invocation.
+  google.protobuf.Struct output_action_parameters = 6
+      [(google.api.field_behavior) = OPTIONAL];
 
   // Required. Flow invocation's output state.
   OutputState flow_state = 4 [(google.api.field_behavior) = REQUIRED];

google/cloud/dialogflow/cx/v3beta1/playbook.proto

@@ -235,6 +235,13 @@ message Playbook {
     repeated Step steps = 2;
   }
 
+  // Message of the Instruction of the playbook.
+  message Instruction {
+    // Ordered list of step by step execution instructions to accomplish
+    // target goal.
+    repeated Step steps = 2;
+  }
+
   // The unique identifier of the playbook.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   // ID>/playbooks/<Playbook ID>`.
@@ -255,9 +262,8 @@ message Playbook {
   repeated google.cloud.dialogflow.cx.v3beta1.ParameterDefinition
       output_parameter_definitions = 6 [(google.api.field_behavior) = OPTIONAL];
 
-  // Ordered list of step by step execution instructions to accomplish
-  // target goal.
-  repeated Step steps = 4;
+  // Instruction to accomplish target goal.
+  Instruction instruction = 17;
 
   // Output only. Estimated number of tokes current playbook takes when sent to
   // the LLM.

google/cloud/dialogflow/cx/v3beta1/response_message.proto

@@ -17,6 +17,7 @@ syntax = "proto3";
 package google.cloud.dialogflow.cx.v3beta1;
 
 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;
@@ -235,6 +236,10 @@ message ResponseMessage {
     // Represents info card for knowledge answers, to be better rendered in
     // Dialogflow Messenger.
     KnowledgeInfoCard knowledge_info_card = 20;
+
+    // Returns the definition of a tool call that should be executed by the
+    // client.
+    google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;
   }
 
   // The channel which the response is associated with. Clients can specify the

google/cloud/dialogflow/cx/v3beta1/security_settings.proto

@@ -276,6 +276,10 @@ message SecuritySettings {
     // File format for exported audio file. Currently only in telephony
     // recordings.
     AudioFormat audio_format = 4;
+
+    // Whether to store TTS audio. By default, TTS audio from the virtual agent
+    // is not exported.
+    bool store_tts_audio = 6;
   }
 
   // Settings for exporting conversations to

google/cloud/dialogflow/cx/v3beta1/session.proto

@@ -1141,6 +1141,10 @@ message Match {
 
     // The query directly triggered an event.
     EVENT = 6;
+
+    // The query was handled by a
+    // [`Playbook`][google.cloud.dialogflow.cx.v3beta1.Playbook].
+    PLAYBOOK = 9;
   }
 
   // The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the

google/cloud/dialogflow/cx/v3beta1/tool.proto

@@ -455,12 +455,6 @@ message Tool {
   // Required. High level description of the Tool and its usage.
   string description = 3 [(google.api.field_behavior) = REQUIRED];
 
-  // The list of derived action names for the tool.
-  repeated string actions = 6 [deprecated = true];
-
-  // The list of derived type schemas for the tool.
-  repeated string schemas = 7 [deprecated = true];
-
   // Specification of the Tool.
   oneof specification {
     // OpenAPI specification of the Tool.

google/cloud/dialogflow/cx/v3beta1/tool_call.proto

@@ -31,6 +31,22 @@ option java_package = "com.google.cloud.dialogflow.cx.v3beta1";
 option objc_class_prefix = "DF";
 option ruby_package = "Google::Cloud::Dialogflow::CX::V3beta1";
 
+// Represents a call of a specific tool's action with the specified inputs.
+message ToolCall {
+  // The [tool][Tool] associated with this call.
+  // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+  // ID>/tools/<Tool ID>`.
+  string tool = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Tool" }
+  ];
+  // The name of the tool's action associated with this call.
+  string action = 2 [(google.api.field_behavior) = REQUIRED];
+  // The action's input parameters.
+  google.protobuf.Struct input_parameters = 3
+      [(google.api.field_behavior) = OPTIONAL];
+}
+
 // The result of calling a tool's action that has been executed by the client.
 message ToolCallResult {
   // The [tool][Tool] associated with this call.