fix: fix validation result docs

feat: add language code to streaming recognition result feat: add time zone and security settings to conversation profile docs: update agent docs docs: update entity type docs docs: update intent docs PiperOrigin-RevId: 388737553
googleapis · Aug 4, 2021 · 09e5b17 · 09e5b17
1 parent 8dfb215
commit 09e5b17
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 21 deletions.
diff --git a/google/cloud/dialogflow/v2beta1/agent.proto b/google/cloud/dialogflow/v2beta1/agent.proto
@@ -53,6 +53,10 @@ service Agents {
   }
 
   // Creates/updates the specified agent.
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc SetAgent(SetAgentRequest) returns (Agent) {
     option (google.api.http) = {
       post: "/v2beta1/{agent.parent=projects/*}/agent"
@@ -94,8 +98,9 @@ service Agents {
 
   // Trains the specified agent.
   //
-  //
-  // Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc TrainAgent(TrainAgentRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*}/agent:train"
@@ -113,9 +118,6 @@ service Agents {
   }
 
   // Exports the specified agent to a ZIP file.
-  //
-  //
-  // Operation <response: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]>
   rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*}/agent:export"
@@ -142,10 +144,9 @@ service Agents {
   // call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it returns in order to train
   // explicitly.
   //
-  //
-  // Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
-  // An operation which tracks when importing is complete. It only tracks
-  // when the draft agent is updated not when it is done training.
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc ImportAgent(ImportAgentRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*}/agent:import"
@@ -170,10 +171,9 @@ service Agents {
   // completed yet. Please call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it
   // returns in order to train explicitly.
   //
-  //
-  // Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
-  // An operation which tracks when restoring is complete. It only tracks
-  // when the draft agent is updated not when it is done training.
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc RestoreAgent(RestoreAgentRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*}/agent:restore"

diff --git a/google/cloud/dialogflow/v2beta1/conversation_profile.proto b/google/cloud/dialogflow/v2beta1/conversation_profile.proto
@@ -169,7 +169,21 @@ message ConversationProfile {
   // Language code for the conversation profile. If not specified, the language
   // is en-US. Language at ConversationProfile should be set for all non en-us
   // languages.
+  // This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
+  // language tag. Example: "en-US".
   string language_code = 10;
+
+  // The time zone of this conversational profile from the
+  // [time zone database](https://www.iana.org/time-zones), e.g.,
+  // America/New_York, Europe/Paris. Defaults to America/New_York.
+  string time_zone = 14;
+
+  // Name of the CX SecuritySettings reference for the agent.
+  // Format: `projects/<Project ID>/locations/<Location
+  // ID>/securitySettings/<Security Settings ID>`.
+  string security_settings = 13 [(google.api.resource_reference) = {
+                                   type: "dialogflow.googleapis.com/CXSecuritySettings"
+                                 }];
 }
 
 // Defines the Automated Agent to connect to a conversation.

diff --git a/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json b/google/cloud/dialogflow/v2beta1/dialogflow_grpc_service_config.json
@@ -145,6 +145,10 @@
         {
           "service": "google.cloud.dialogflow.v2beta1.AgentModeling",
           "method": "CreateConversationGraph"
+        },
+        {
+          "service": "google.cloud.dialogflow.v2beta1.SessionHistory",
+          "method": "SearchSessionConversations"
         }
       ],
       "timeout": "180s",

diff --git a/google/cloud/dialogflow/v2beta1/entity_type.proto b/google/cloud/dialogflow/v2beta1/entity_type.proto
@@ -64,6 +64,10 @@ service EntityTypes {
   }
 
   // Creates an entity type in the specified agent.
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc CreateEntityType(CreateEntityTypeRequest) returns (EntityType) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent}/entityTypes"
@@ -78,6 +82,10 @@ service EntityTypes {
   }
 
   // Updates the specified entity type.
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc UpdateEntityType(UpdateEntityTypeRequest) returns (EntityType) {
     option (google.api.http) = {
       patch: "/v2beta1/{entity_type.name=projects/*/agent/entityTypes/*}"
@@ -93,6 +101,10 @@ service EntityTypes {
   }
 
   // Deletes the specified entity type.
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc DeleteEntityType(DeleteEntityTypeRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v2beta1/{name=projects/*/agent/entityTypes/*}"
@@ -104,7 +116,10 @@ service EntityTypes {
   }
 
   // Updates/Creates multiple entity types in the specified agent.
-  // Operation <response: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse]>
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc BatchUpdateEntityTypes(BatchUpdateEntityTypesRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent}/entityTypes:batchUpdate"
@@ -121,7 +136,10 @@ service EntityTypes {
   }
 
   // Deletes entity types in the specified agent.
-  // Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc BatchDeleteEntityTypes(BatchDeleteEntityTypesRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent}/entityTypes:batchDelete"
@@ -140,7 +158,9 @@ service EntityTypes {
 
   // Creates multiple new entities in the specified entity type.
   //
-  // Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc BatchCreateEntities(BatchCreateEntitiesRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchCreate"
@@ -162,7 +182,9 @@ service EntityTypes {
   // method does not affect entities in the entity type that aren't explicitly
   // specified in the request.
   //
-  // Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc BatchUpdateEntities(BatchUpdateEntitiesRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchUpdate"
@@ -182,7 +204,9 @@ service EntityTypes {
 
   // Deletes entities in the specified entity type.
   //
-  // Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc BatchDeleteEntities(BatchDeleteEntitiesRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchDelete"

diff --git a/google/cloud/dialogflow/v2beta1/environment.proto b/google/cloud/dialogflow/v2beta1/environment.proto
@@ -178,7 +178,12 @@ message Environment {
   // - `projects/<Project ID>/agent/versions/<Version ID>`
   // - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version
   //   ID>`
-  string agent_version = 3 [(google.api.field_behavior) = OPTIONAL];
+  string agent_version = 3 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "dialogflow.googleapis.com/Version"
+    }
+  ];
 
   // Output only. The state of this environment. This field is read-only, i.e., it cannot be
   // set by create and update methods.

diff --git a/google/cloud/dialogflow/v2beta1/intent.proto b/google/cloud/dialogflow/v2beta1/intent.proto
@@ -74,6 +74,10 @@ service Intents {
   }
 
   // Creates an intent in the specified agent.
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc CreateIntent(CreateIntentRequest) returns (Intent) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent}/intents"
@@ -88,6 +92,10 @@ service Intents {
   }
 
   // Updates the specified intent.
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc UpdateIntent(UpdateIntentRequest) returns (Intent) {
     option (google.api.http) = {
       patch: "/v2beta1/{intent.name=projects/*/agent/intents/*}"
@@ -104,6 +112,10 @@ service Intents {
   }
 
   // Deletes the specified intent and its direct or indirect followup intents.
+  //
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc DeleteIntent(DeleteIntentRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v2beta1/{name=projects/*/agent/intents/*}"
@@ -116,7 +128,9 @@ service Intents {
 
   // Updates/Creates multiple intents in the specified agent.
   //
-  // Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc BatchUpdateIntents(BatchUpdateIntentsRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent}/intents:batchUpdate"
@@ -136,7 +150,9 @@ service Intents {
 
   // Deletes intents in the specified agent.
   //
-  // Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
+  // Note: You should always train an agent prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
   rpc BatchDeleteIntents(BatchDeleteIntentsRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2beta1/{parent=projects/*/agent}/intents:batchDelete"

diff --git a/google/cloud/dialogflow/v2beta1/session.proto b/google/cloud/dialogflow/v2beta1/session.proto
@@ -725,6 +725,9 @@ message StreamingRecognitionResult {
   // beginning of the audio. Only populated for `message_type` = `TRANSCRIPT`.
   google.protobuf.Duration speech_end_offset = 8;
 
+  // Detected language code for the transcript.
+  string language_code = 10;
+
   // DTMF digits. Populated if and only if `message_type` = `DTMF_DIGITS`.
   TelephonyDtmfEvents dtmf_digits = 5;
 }