feat: added support for TelephonyConnectionInfo, country_code and ControlPoint

Google APIs · copybara-github · commit cd8473077feb · 2025-03-03T15:05:43.000-08:00
feat: added support for CONVERSATION_SUMMARIZATION
feat: added ConversatioalTrainingAssignments, ConversationalTrainingMembers, ConversationalTrainingModules,ConversationalTrainingTeams API
feat: added support for audio_input and speech_model
feat: changed enablle_partial_automated_agent_reply to optional
docs: clarified wording around filter and document_correctness
docs: clarified wording around use_timeout_based_endpointing
docs: changed reference link around ConversationStage
docs: clarified wording around boost_specs and filter_specs
docs: clarified wording around send_time

PiperOrigin-RevId: 733074841
diff --git a/google/cloud/dialogflow/v2/BUILD.bazel b/google/cloud/dialogflow/v2/BUILD.bazel
@@ -412,7 +412,6 @@ load(
 
 csharp_proto_library(
     name = "dialogflow_csharp_proto",
-    extra_opts = [],
     deps = [":dialogflow_proto"],
 )
 
diff --git a/google/cloud/dialogflow/v2/answer_record.proto b/google/cloud/dialogflow/v2/answer_record.proto
@@ -24,7 +24,6 @@ import "google/cloud/dialogflow/v2/participant.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.V2";
 option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb";
 option java_multiple_files = true;
@@ -134,13 +133,23 @@ message ListAnswerRecordsRequest {
     }
   ];
 
-  // Optional. Filters to restrict results to specific answer records.
+  // Optional. Filters to restrict results to specific answer records. The
+  // expression has the following syntax:
   //
-  // Marked deprecated as it hasn't been, and isn't currently, supported.
+  //     <field> <operator> <value> [AND <field> <operator> <value>] ...
+  //
+  // The following fields and operators are supported:
+  // * conversation_id with equals(=) operator
+  //
+  // Examples:
+  //
+  // * `conversation_id=bar` matches answer records in the
+  //   `projects/foo/locations/global/conversations/bar` conversation
+  //   (assuming the parent is `projects/foo/locations/global`).
   //
   // For more information about filtering, see
   // [API Filtering](https://aip.dev/160).
-  string filter = 2 [deprecated = true, (google.api.field_behavior) = OPTIONAL];
+  string filter = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. The maximum number of records to return in a single page.
   // The server may return fewer records than this. If unspecified, we use 10.
@@ -328,7 +337,7 @@ message AgentAssistantFeedback {
   // * Suggested document says: "Items must be returned/exchanged within 60
   //   days of the purchase date."
   // * Ground truth: "No return or exchange is allowed."
-  // * [document_correctness]: INCORRECT
+  // * [document_correctness][google.cloud.dialogflow.v2.AgentAssistantFeedback.document_correctness]: [INCORRECT][google.cloud.dialogflow.v2.AgentAssistantFeedback.DocumentCorrectness.INCORRECT]
   DocumentCorrectness document_correctness = 2
       [(google.api.field_behavior) = OPTIONAL];
 
diff --git a/google/cloud/dialogflow/v2/audio_config.proto b/google/cloud/dialogflow/v2/audio_config.proto
@@ -320,7 +320,7 @@ message SpeechToTextConfig {
   // information.
   bool enable_word_info = 9;
 
-  // 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 = 11;
 }
diff --git a/google/cloud/dialogflow/v2/conversation.proto b/google/cloud/dialogflow/v2/conversation.proto
@@ -221,7 +221,7 @@ message Conversation {
 
   // Enumeration of the different conversation stages a conversation can be in.
   // Reference:
-  // https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
+  // https://cloud.google.com/agent-assist/docs/basics#conversation_stages
   enum ConversationStage {
     // Unknown. Should never be used after a conversation is successfully
     // created.
@@ -236,6 +236,43 @@ message Conversation {
     HUMAN_ASSIST_STAGE = 2;
   }
 
+  // The information about phone calls connected via phone gateway to the
+  // conversation.
+  message TelephonyConnectionInfo {
+    // The SIP headers from the initial SIP INVITE.
+    message SipHeader {
+      // Optional. The name of the header.
+      string name = 1 [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The value of the header.
+      string value = 2 [(google.api.field_behavior) = OPTIONAL];
+    }
+
+    // The mime content from the initial SIP INVITE.
+    message MimeContent {
+      // Optional. The mime type of the content.
+      string mime_type = 1 [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The content payload.
+      bytes content = 2 [(google.api.field_behavior) = OPTIONAL];
+    }
+
+    // Output only. The number dialed to connect this call in E.164 format.
+    string dialed_number = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Optional. SDP of the call. It's initially the SDP answer to the endpoint,
+    // but maybe later updated for the purpose of making the link active, etc.
+    string sdp = 5 [(google.api.field_behavior) = OPTIONAL];
+
+    // Output only. The SIP headers from the initial SIP INVITE.
+    repeated SipHeader sip_headers = 12
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The mime content from the initial SIP INVITE.
+    repeated MimeContent extra_mime_contents = 13
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
   // Output only. Identifier. The unique identifier of this conversation.
   // Format: `projects/<Project ID>/locations/<Location
   // ID>/conversations/<Conversation ID>`.
@@ -290,6 +327,10 @@ message Conversation {
   // [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].
   ConversationStage conversation_stage = 7
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. The telephony connection information.
+  TelephonyConnectionInfo telephony_connection_info = 10
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // The request message for
@@ -437,6 +478,9 @@ message ListMessagesResponse {
 // Represents a phone number for telephony integration. It allows for connecting
 // a particular conversation over telephony.
 message ConversationPhoneNumber {
+  // Output only. Desired country code for the phone number.
+  int32 country_code = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Output only. The phone number to connect to this conversation.
   string phone_number = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
@@ -723,7 +767,20 @@ message SearchKnowledgeRequest {
             // The control points used to define the curve. The curve defined
             // through these control points can only be monotonically increasing
             // or decreasing(constant values are acceptable).
-            message ControlPoint {}
+            message ControlPoint {
+              // Optional. Can be one of:
+              // 1. The numerical field value.
+              // 2. The duration spec for freshness:
+              // The value must be formatted as an XSD `dayTimeDuration` value
+              // (a restricted subset of an ISO 8601 duration value). The
+              // pattern for this is: `[nD][T[nH][nM][nS]]`.
+              string attribute_value = 1
+                  [(google.api.field_behavior) = OPTIONAL];
+
+              // Optional. The value between -1 to 1 by which to boost the score
+              // if the attribute_value evaluates to the value specified above.
+              float boost_amount = 2 [(google.api.field_behavior) = OPTIONAL];
+            }
 
             // Optional. The name of the field whose value will be used to
             // determine the boost amount.
@@ -787,7 +844,7 @@ message SearchKnowledgeRequest {
         }
 
         // Optional. Condition boost specifications. If a document matches
-        // multiple conditions in the specifictions, boost scores from these
+        // multiple conditions in the specifications, boost scores from these
         // specifications are all applied and combined in a non-linear way.
         // Maximum number of specifications is 20.
         repeated ConditionBoostSpec condition_boost_specs = 1
@@ -824,10 +881,19 @@ message SearchKnowledgeRequest {
     }
 
     // Optional. Boost specifications for data stores.
+    //
+    // Maps from datastore name to their boost configuration. Do not specify
+    // more than one BoostSpecs for each datastore name. If multiple BoostSpecs
+    // are provided for the same datastore name, the behavior is undefined.
     repeated BoostSpecs boost_specs = 1
         [(google.api.field_behavior) = OPTIONAL];
 
     // Optional. Filter specification for data store queries.
+    //
+    // TMaps from datastore name to the filter expression for that datastore. Do
+    // not specify more than one FilterSpecs for each datastore name. If
+    // multiple FilterSpecs are provided for the same datastore name, the
+    // behavior is undefined.
     repeated FilterSpecs filter_specs = 2
         [(google.api.field_behavior) = OPTIONAL];
   }
@@ -966,5 +1032,7 @@ message SearchKnowledgeAnswer {
   // The name of the answer record.
   // Format: `projects/<Project ID>/locations/<location ID>/answer
   // Records/<Answer Record ID>`
-  string answer_record = 5;
+  string answer_record = 5 [(google.api.resource_reference) = {
+    type: "dialogflow.googleapis.com/AnswerRecord"
+  }];
 }
diff --git a/google/cloud/dialogflow/v2/conversation_model.proto b/google/cloud/dialogflow/v2/conversation_model.proto
@@ -342,7 +342,7 @@ message ConversationModelEvaluation {
   }
 
   // Output only. Human eval template in csv format.
-  // It tooks real-world conversations provided through input dataset, generates
+  // It takes real-world conversations provided through input dataset, generates
   // example suggestions for customer to verify quality of the model.
   // For Smart Reply, the generated csv file contains columns of
   // Context, (Suggestions,Q1,Q2)*3, Actual reply.
@@ -399,10 +399,10 @@ message EvaluationConfig {
 
   // Specific configurations for different models in order to do evaluation.
   oneof model_specific_config {
-    // Configuration for smart reply model evalution.
+    // Configuration for smart reply model evaluation.
     SmartReplyConfig smart_reply_config = 2;
 
-    // Configuration for smart compose model evalution.
+    // Configuration for smart compose model evaluation.
     SmartComposeConfig smart_compose_config = 4;
   }
 }
diff --git a/google/cloud/dialogflow/v2/conversation_profile.proto b/google/cloud/dialogflow/v2/conversation_profile.proto
@@ -871,6 +871,9 @@ message SuggestionFeature {
     // Run smart reply model for chat.
     SMART_REPLY = 3;
 
+    // Run conversation summarization model for chat.
+    CONVERSATION_SUMMARIZATION = 8;
+
     // Run knowledge search with text input from agent or text generated query.
     KNOWLEDGE_SEARCH = 14;
 
diff --git a/google/cloud/dialogflow/v2/dialogflow_grpc_service_config.json b/google/cloud/dialogflow/v2/dialogflow_grpc_service_config.json
@@ -11,6 +11,18 @@
         {
           "service": "google.cloud.dialogflow.v2.Contexts"
         },
+        {
+          "service": "google.cloud.dialogflow.v2.ConversationalTrainingAssignments"
+        },
+        {
+          "service": "google.cloud.dialogflow.v2.ConversationalTrainingMembers"
+        },
+        {
+          "service": "google.cloud.dialogflow.v2.ConversationalTrainingModules"
+        },
+        {
+          "service": "google.cloud.dialogflow.v2.ConversationalTrainingTeams"
+        },
         {
           "service": "google.cloud.dialogflow.v2.ConversationDatasets"
         },
diff --git a/google/cloud/dialogflow/v2/document.proto b/google/cloud/dialogflow/v2/document.proto
@@ -27,7 +27,6 @@ import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
 import "google/rpc/status.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.V2";
 option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb";
 option java_multiple_files = true;
diff --git a/google/cloud/dialogflow/v2/encryption_spec.proto b/google/cloud/dialogflow/v2/encryption_spec.proto
@@ -22,7 +22,6 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/longrunning/operations.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.V2";
 option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb";
 option java_multiple_files = true;
diff --git a/google/cloud/dialogflow/v2/generator.proto b/google/cloud/dialogflow/v2/generator.proto
@@ -24,7 +24,6 @@ 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.V2";
 option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb";
 option java_multiple_files = true;
diff --git a/google/cloud/dialogflow/v2/knowledge_base.proto b/google/cloud/dialogflow/v2/knowledge_base.proto
@@ -23,7 +23,6 @@ import "google/api/resource.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.V2";
 option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb";
 option java_multiple_files = true;
diff --git a/google/cloud/dialogflow/v2/participant.proto b/google/cloud/dialogflow/v2/participant.proto
@@ -107,6 +107,7 @@ service Participants {
     };
     option (google.api.method_signature) = "participant,text_input";
     option (google.api.method_signature) = "participant,event_input";
+    option (google.api.method_signature) = "participant,audio_input";
   }
 
   // Adds a text (chat, for example), or audio (phone recording, for example)
@@ -313,7 +314,8 @@ message Message {
   google.protobuf.Timestamp create_time = 6
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Optional. The time when the message was sent.
+  // Optional. The time when the message was sent. For voice messages, this is
+  // the time when an utterance started.
   google.protobuf.Timestamp send_time = 9
       [(google.api.field_behavior) = OPTIONAL];
 
@@ -419,6 +421,9 @@ message AnalyzeContentRequest {
     // The natural language text to be processed.
     TextInput text_input = 6;
 
+    // The natural language speech audio to be processed.
+    AudioInput audio_input = 7;
+
     // An input event to send to Dialogflow.
     EventInput event_input = 8;
 
@@ -640,11 +645,12 @@ message StreamingAnalyzeContentRequest {
   // https://cloud.google.com/agent-assist/docs/extended-streaming
   bool enable_extended_streaming = 11 [(google.api.field_behavior) = OPTIONAL];
 
-  // Enable partial virtual agent responses. If this flag is not enabled,
-  // response stream still contains only one final response even if some
-  // `Fulfillment`s in Dialogflow virtual agent have been configured to return
-  // partial responses.
-  bool enable_partial_automated_agent_reply = 12;
+  // Optional. Enable partial responses from Dialogflow CX agent. If this flag
+  // is not enabled, response stream still contains only one final response even
+  // if some `Fulfillment`s in Dialogflow CX agent have been configured to
+  // return partial responses.
+  bool enable_partial_automated_agent_reply = 12
+      [(google.api.field_behavior) = OPTIONAL];
 
   // If true, `StreamingAnalyzeContentResponse.debugging_info` will get
   // populated.
@@ -723,6 +729,9 @@ message StreamingAnalyzeContentResponse {
   // Debugging info that would get populated when
   // `StreamingAnalyzeContentRequest.enable_debugging_info` is set to true.
   CloudConversationDebuggingInfo debugging_info = 11;
+
+  // The name of the actual Cloud speech model used for speech recognition.
+  string speech_model = 13;
 }
 
 // The request message for
@@ -898,6 +907,18 @@ message SuggestSmartRepliesResponse {
   int32 context_size = 3;
 }
 
+// Represents the natural language speech audio to be processed.
+message AudioInput {
+  // Required. Instructs the speech recognizer how to process the speech audio.
+  InputAudioConfig config = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The natural language speech audio to be processed.
+  // A single request can contain up to 2 minutes of speech audio data.
+  // The transcribed text cannot contain more than 256 bytes for virtual agent
+  // interactions.
+  bytes audio = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
 // Represents the natural language speech audio to be played to the end user.
 message OutputAudio {
   // Instructs the speech synthesizer how to generate the speech
@@ -1189,7 +1210,7 @@ message SuggestKnowledgeAssistRequest {
   int32 context_size = 3 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. The previously suggested query for the given conversation. This
-  // helps identify whether the next suggestion we generate is resonably
+  // helps identify whether the next suggestion we generate is reasonably
   // different from the previous one. This is useful to avoid similar
   // suggestions within the conversation.
   string previous_suggested_query = 4 [(google.api.field_behavior) = OPTIONAL];
diff --git a/google/cloud/dialogflow/v2/session.proto b/google/cloud/dialogflow/v2/session.proto
@@ -30,7 +30,6 @@ import "google/protobuf/struct.proto";
 import "google/rpc/status.proto";
 import "google/type/latlng.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Dialogflow.V2";
 option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb";
 option java_multiple_files = true;

Original file line number	Diff line number	Diff line change
`@@ -412,7 +412,6 @@ load(`
`412`	`412`
`413`	`413`	`csharp_proto_library(`
`414`	`414`	`name = "dialogflow_csharp_proto",`
`415`		`- extra_opts = [],`
`416`	`415`	`deps = [":dialogflow_proto"],`
`417`	`416`	`)`
`418`	`417`
Original file line number	Diff line number	Diff line change
`@@ -320,7 +320,7 @@ message SpeechToTextConfig {`
`320`	`320`	`// information.`
`321`	`321`	`bool enable_word_info = 9;`
`322`	`322`
`323`		`- // Use timeout based endpointing, interpreting endpointer sensitivy as`
	`323`	`+ // Use timeout based endpointing, interpreting endpointer sensitivity as`
`324`	`324`	`// seconds of timeout value.`
`325`	`325`	`bool use_timeout_based_endpointing = 11;`
`326`	`326`	`}`
Original file line number	Diff line number	Diff line change
`@@ -342,7 +342,7 @@ message ConversationModelEvaluation {`
`342`	`342`	`}`
`343`	`343`
`344`	`344`	`// Output only. Human eval template in csv format.`
`345`		`- // It tooks real-world conversations provided through input dataset, generates`
	`345`	`+ // It takes real-world conversations provided through input dataset, generates`
`346`	`346`	`// example suggestions for customer to verify quality of the model.`
`347`	`347`	`// For Smart Reply, the generated csv file contains columns of`
`348`	`348`	`// Context, (Suggestions,Q1,Q2)*3, Actual reply.`
`@@ -399,10 +399,10 @@ message EvaluationConfig {`
`399`	`399`
`400`	`400`	`// Specific configurations for different models in order to do evaluation.`
`401`	`401`	`oneof model_specific_config {`
`402`		`- // Configuration for smart reply model evalution.`
	`402`	`+ // Configuration for smart reply model evaluation.`
`403`	`403`	`SmartReplyConfig smart_reply_config = 2;`
`404`	`404`
`405`		`- // Configuration for smart compose model evalution.`
	`405`	`+ // Configuration for smart compose model evaluation.`
`406`	`406`	`SmartComposeConfig smart_compose_config = 4;`
`407`	`407`	`}`
`408`	`408`	`}`