feat: ResponseMessage proto contains channel information

packages/google-cloud-dialogflow-cx/.jsdoc.js

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ module.exports = {
     includePattern: '\\.js$'
   },
   templates: {
-    copyright: 'Copyright 2022 Google LLC',
+    copyright: 'Copyright 2023 Google LLC',
     includeDate: false,
     sourceFiles: false,
     systemName: '@google-cloud/dialogflow-cx',

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/advanced_settings.proto

@@ -20,7 +20,7 @@ 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";
+option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
 option java_multiple_files = true;
 option java_outer_classname = "AdvancedSettingsProto";
 option java_package = "com.google.cloud.dialogflow.cx.v3";

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/agent.proto

@@ -28,7 +28,7 @@ import "google/protobuf/field_mask.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";
+option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
 option java_multiple_files = true;
 option java_outer_classname = "AgentProto";
 option java_package = "com.google.cloud.dialogflow.cx.v3";
@@ -100,7 +100,8 @@ service Agents {
   //
   // - `metadata`: An empty [Struct
   //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
-  // - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
+  // - `response`:
+  // [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
   rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v3/{name=projects/*/locations/*/agents/*}:export"
@@ -152,7 +153,8 @@ service Agents {
 
   // Gets the latest agent validation result. Agent validation is performed
   // when ValidateAgent is called.
-  rpc GetAgentValidationResult(GetAgentValidationResultRequest) returns (AgentValidationResult) {
+  rpc GetAgentValidationResult(GetAgentValidationResultRequest)
+      returns (AgentValidationResult) {
     option (google.api.http) = {
       get: "/v3/{name=projects/*/locations/*/agents/*/validationResult}"
     };
@@ -171,17 +173,24 @@ message SpeechToTextSettings {
 // in your app, product, or service to determine user intent and respond to the
 // user in a natural way.
 //
-// After you create an agent, you can add [Intents][google.cloud.dialogflow.cx.v3.Intent],
-// [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment],
-// [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
+// After you create an agent, you can add
+// [Intents][google.cloud.dialogflow.cx.v3.Intent], [Entity
+// Types][google.cloud.dialogflow.cx.v3.EntityType],
+// [Flows][google.cloud.dialogflow.cx.v3.Flow],
+// [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment],
+// [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the
+// conversation flows..
 message Agent {
   option (google.api.resource) = {
     type: "dialogflow.googleapis.com/Agent"
     pattern: "projects/{project}/locations/{location}/agents/{agent}"
   };
 
   // The unique identifier of the agent.
-  // Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
+  // Required for the
+  // [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
+  // method.
+  // [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
   // populates the name automatically.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
   string name = 1;
@@ -193,7 +202,9 @@ message Agent {
   // See [Language
   // Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
   // for a list of the currently supported language codes.
-  // This field cannot be set by the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method.
+  // This field cannot be set by the
+  // [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
+  // method.
   string default_language_code = 3 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.field_behavior) = IMMUTABLE
@@ -221,27 +232,26 @@ 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>`.
+  // 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"
-    }
+    (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Flow" }
   ];
 
-  // Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent.
-  // Format: `projects/<Project ID>/locations/<Location
+  // Name of the
+  // [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]
+  // reference for the agent. Format: `projects/<Project ID>/locations/<Location
   // ID>/securitySettings/<Security Settings ID>`.
   string security_settings = 17 [(google.api.resource_reference) = {
-                                   type: "dialogflow.googleapis.com/SecuritySettings"
-                                 }];
+    type: "dialogflow.googleapis.com/SecuritySettings"
+  }];
 
   // Indicates if stackdriver logging is enabled for the agent.
-  // Please use [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings]
+  // Please use
+  // [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings]
   // instead.
   bool enable_stackdriver_logging = 18 [deprecated = true];
 
@@ -258,7 +268,8 @@ message Agent {
   AdvancedSettings advanced_settings = 22;
 }
 
-// The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
+// The request message for
+// [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
 message ListAgentsRequest {
   // Required. The location to list all agents for.
   // Format: `projects/<Project ID>/locations/<Location ID>`.
@@ -277,7 +288,8 @@ message ListAgentsRequest {
   string page_token = 3;
 }
 
-// The response message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
+// The response message for
+// [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
 message ListAgentsResponse {
   // The list of agents. There will be a maximum number of items returned based
   // on the page_size field in the request.
@@ -288,7 +300,8 @@ message ListAgentsResponse {
   string next_page_token = 2;
 }
 
-// The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].
+// The request message for
+// [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].
 message GetAgentRequest {
   // Required. The name of the agent.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
@@ -300,7 +313,8 @@ message GetAgentRequest {
   ];
 }
 
-// The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].
+// The request message for
+// [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].
 message CreateAgentRequest {
   // Required. The location to create a agent for.
   // Format: `projects/<Project ID>/locations/<Location ID>`.
@@ -315,7 +329,8 @@ message CreateAgentRequest {
   Agent agent = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
-// The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].
+// The request message for
+// [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].
 message UpdateAgentRequest {
   // Required. The agent to update.
   Agent agent = 1 [(google.api.field_behavior) = REQUIRED];
@@ -325,7 +340,8 @@ message UpdateAgentRequest {
   google.protobuf.FieldMask update_mask = 2;
 }
 
-// The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].
+// The request message for
+// [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].
 message DeleteAgentRequest {
   // Required. The name of the agent to delete.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
@@ -337,7 +353,8 @@ message DeleteAgentRequest {
   ];
 }
 
-// The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].
+// The request message for
+// [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].
 message ExportAgentRequest {
   // Data format of the exported agent.
   enum DataFormat {
@@ -357,10 +374,10 @@ message ExportAgentRequest {
     }
   ];
 
-  // Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to
-  // export the agent to. The format of this URI must be
-  // `gs://<bucket-name>/<object-name>`.
-  // If left unspecified, the serialized agent is returned inline.
+  // Optional. The [Google Cloud
+  // Storage](https://cloud.google.com/storage/docs/) URI to export the agent
+  // to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If
+  // left unspecified, the serialized agent is returned inline.
   //
   // Dialogflow performs a write operation for the Cloud Storage object
   // on the caller's behalf, so your request authentication must
@@ -369,7 +386,8 @@ message ExportAgentRequest {
   // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
   string agent_uri = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. The data format of the exported agent. If not specified, `BLOB` is assumed.
+  // Optional. The data format of the exported agent. If not specified, `BLOB`
+  // is assumed.
   DataFormat data_format = 3 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Environment name. If not set, draft environment is assumed.
@@ -383,20 +401,23 @@ message ExportAgentRequest {
   ];
 }
 
-// The response message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].
+// The response message for
+// [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].
 message ExportAgentResponse {
   // The exported agent.
   oneof agent {
     // The URI to a file containing the exported agent. This field is populated
-    // only if `agent_uri` is specified in [ExportAgentRequest][google.cloud.dialogflow.cx.v3.ExportAgentRequest].
+    // only if `agent_uri` is specified in
+    // [ExportAgentRequest][google.cloud.dialogflow.cx.v3.ExportAgentRequest].
     string agent_uri = 1;
 
     // Uncompressed raw byte content for agent.
     bytes agent_content = 2;
   }
 }
 
-// The request message for [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3.Agents.RestoreAgent].
+// The request message for
+// [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3.Agents.RestoreAgent].
 message RestoreAgentRequest {
   // Restore option.
   enum RestoreOption {
@@ -443,7 +464,8 @@ message RestoreAgentRequest {
   RestoreOption restore_option = 5;
 }
 
-// The request message for [Agents.ValidateAgent][google.cloud.dialogflow.cx.v3.Agents.ValidateAgent].
+// The request message for
+// [Agents.ValidateAgent][google.cloud.dialogflow.cx.v3.Agents.ValidateAgent].
 message ValidateAgentRequest {
   // Required. The agent to validate.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
@@ -458,7 +480,8 @@ message ValidateAgentRequest {
   string language_code = 2;
 }
 
-// The request message for [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].
+// The request message for
+// [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].
 message GetAgentValidationResultRequest {
   // Required. The agent name.
   // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
@@ -474,7 +497,8 @@ message GetAgentValidationResultRequest {
   string language_code = 2;
 }
 
-// The response message for [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].
+// The response message for
+// [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].
 message AgentValidationResult {
   option (google.api.resource) = {
     type: "dialogflow.googleapis.com/AgentValidationResult"

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/audio_config.proto

@@ -22,7 +22,7 @@ import "google/protobuf/duration.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";
+option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
 option java_multiple_files = true;
 option java_outer_classname = "AudioConfigProto";
 option java_package = "com.google.cloud.dialogflow.cx.v3";
@@ -82,7 +82,8 @@ enum AudioEncoding {
   AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7;
 }
 
-// Variant of the specified [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
+// Variant of the specified [Speech
+// model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
 //
 // See the [Cloud Speech
 // documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)
@@ -111,8 +112,8 @@ enum SpeechModelVariant {
   // Use an enhanced model variant:
   //
   // * If an enhanced variant does not exist for the given
-  //   [model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] and request language, Dialogflow falls
-  //   back to the standard variant.
+  //   [model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] and request
+  //   language, Dialogflow falls back to the standard variant.
   //
   //   The [Cloud Speech
   //   documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)
@@ -162,10 +163,12 @@ message InputAudioConfig {
   // more details.
   int32 sample_rate_hertz = 2;
 
-  // Optional. If `true`, Dialogflow returns [SpeechWordInfo][google.cloud.dialogflow.cx.v3.SpeechWordInfo] in
-  // [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult] with information about the recognized speech
-  // words, e.g. start and end time offsets. If false or unspecified, Speech
-  // doesn't return any word-level information.
+  // Optional. If `true`, Dialogflow returns
+  // [SpeechWordInfo][google.cloud.dialogflow.cx.v3.SpeechWordInfo] in
+  // [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult]
+  // with information about the recognized speech words, e.g. start and end time
+  // offsets. If false or unspecified, Speech doesn't return any word-level
+  // information.
   bool enable_word_info = 13;
 
   // Optional. A list of strings containing words and phrases that the speech
@@ -189,7 +192,8 @@ message InputAudioConfig {
   // for more details.
   string model = 7;
 
-  // Optional. Which variant of the [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
+  // Optional. Which variant of the [Speech
+  // model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
   SpeechModelVariant model_variant = 10;
 
   // Optional. If `false` (default), recognition does not cease until the
@@ -232,10 +236,10 @@ message VoiceSelectionParams {
 
   // Optional. The preferred gender of the voice. If not set, the service will
   // choose a voice based on the other parameters such as language_code and
-  // [name][google.cloud.dialogflow.cx.v3.VoiceSelectionParams.name]. Note that this is only a preference, not requirement. If a
-  // voice of the appropriate gender is not available, the synthesizer
-  // substitutes a voice with a different gender rather than failing the
-  // request.
+  // [name][google.cloud.dialogflow.cx.v3.VoiceSelectionParams.name]. Note that
+  // this is only a preference, not requirement. If a voice of the appropriate
+  // gender is not available, the synthesizer substitutes a voice with a
+  // different gender rather than failing the request.
   SsmlVoiceGender ssml_gender = 2;
 }
 
@@ -299,7 +303,8 @@ enum OutputAudioEncoding {
 // Instructs the speech synthesizer how to generate the output audio content.
 message OutputAudioConfig {
   // Required. Audio encoding of the synthesized audio content.
-  OutputAudioEncoding audio_encoding = 1 [(google.api.field_behavior) = REQUIRED];
+  OutputAudioEncoding audio_encoding = 1
+      [(google.api.field_behavior) = REQUIRED];
 
   // Optional. The synthesis sample rate (in hertz) for this audio. If not
   // provided, then the synthesizer will use the default sample rate based on