feat: allowed custom to specify webhook headers through query paramet…

…ers docs: suggested to always use version for production traffic when calling DetectIntent (#44)

PiperOrigin-RevId: 346434847

Source-Author: Google APIs <noreply@google.com>
Source-Date: Tue Dec 8 16:24:31 2020 -0800
Source-Repo: googleapis/googleapis
Source-Sha: e4d01555afeb93d2f3b467056ea884b092567d1b
Source-Link: googleapis/googleapis@e4d0155

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

@@ -113,6 +113,25 @@ message ResponseMessage {
     bool allow_playback_interruption = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
+  // Specifies an audio clip to be played by the client as part of the response.
+  message PlayAudio {
+    // Required. URI of the audio clip. Dialogflow does not impose any validation on this
+    // value. It is specific to the client that reads it.
+    string audio_uri = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Output only. Whether the playback of this message can be interrupted by the end
+    // user's speech and the client can then starts the next Dialogflow
+    // request.
+    bool allow_playback_interruption = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Indicates that interaction with the Dialogflow agent has ended.
+  // This message is generated by Dialogflow only and not supposed to be
+  // defined by the user.
+  message EndInteraction {
+
+  }
+
   // Represents an audio message that is composed of both segments
   // synthesized from the Dialogflow agent prompts and ones hosted externally
   // at the specified URIs.
@@ -144,25 +163,6 @@ message ResponseMessage {
     repeated Segment segments = 1;
   }
 
-  // Indicates that interaction with the Dialogflow agent has ended.
-  // This message is generated by Dialogflow only and not supposed to be
-  // defined by the user.
-  message EndInteraction {
-
-  }
-
-  // Specifies an audio clip to be played by the client as part of the response.
-  message PlayAudio {
-    // Required. URI of the audio clip. Dialogflow does not impose any validation on this
-    // value. It is specific to the client that reads it.
-    string audio_uri = 1 [(google.api.field_behavior) = REQUIRED];
-
-    // Output only. Whether the playback of this message can be interrupted by the end
-    // user's speech and the client can then starts the next Dialogflow
-    // request.
-    bool allow_playback_interruption = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-  }
-
   // Required. The rich response message.
   oneof message {
     // Returns a text response.

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

@@ -57,6 +57,10 @@ service Sessions {
   // as a result. This method is not idempotent, because it may cause session
   // entity types to be updated, which in turn might affect results of future
   // queries.
+  //
+  // Note: Always use agent versions for production traffic.
+  // See [Versions and
+  // environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
   rpc DetectIntent(DetectIntentRequest) returns (DetectIntentResponse) {
     option (google.api.http) = {
       post: "/v3beta1/{session=projects/*/locations/*/agents/*/sessions/*}:detectIntent"
@@ -71,6 +75,10 @@ service Sessions {
   // Processes a natural language query in audio format in a streaming fashion
   // and returns structured, actionable data as a result. This method is only
   // available via the gRPC API (not REST).
+  //
+  // Note: Always use agent versions for production traffic.
+  // See [Versions and
+  // environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
   rpc StreamingDetectIntent(stream StreamingDetectIntentRequest) returns (stream StreamingDetectIntentResponse) {
   }
 
@@ -116,6 +124,10 @@ message DetectIntentRequest {
   //
   // For more information, see the [sessions
   // guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
+  //
+  // Note: Always use agent versions for production traffic.
+  // See [Versions and
+  // environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
   string session = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -201,6 +213,10 @@ message StreamingDetectIntentRequest {
   //
   // For more information, see the [sessions
   // guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
+  //
+  // Note: Always use agent versions for production traffic.
+  // See [Versions and
+  // environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
   string session = 1 [(google.api.resource_reference) = {
                         type: "dialogflow.googleapis.com/Session"
                       }];
@@ -374,6 +390,16 @@ message QueryParameters {
   // Configures whether sentiment analysis should be performed. If not
   // provided, sentiment analysis is not performed.
   bool analyze_query_text_sentiment = 8;
+
+  // This field can be used to pass HTTP headers for a webhook
+  // call. These headers will be sent to webhook along with the headers that
+  // have been configured through Dialogflow web console. The headers defined
+  // within this field will overwrite the headers configured through Dialogflow
+  // console if there is a conflict. Header names are case-insensitive.
+  // Google's specified headers are not allowed. Including: "Host",
+  // "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
+  // "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
+  map<string, string> webhook_headers = 10;
 }
 
 // Represents the query input. It can contain one of: