docs: added notes to train agent before sending queries (#138)

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

@@ -58,6 +58,10 @@ service Agents {
   }
 
   // Creates an agent in the specified location.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc CreateAgent(CreateAgentRequest) returns (Agent) {
     option (google.api.http) = {
       post: "/v3beta1/{parent=projects/*/locations/*}/agents"
@@ -67,6 +71,10 @@ service Agents {
   }
 
   // Updates the specified agent.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc UpdateAgent(UpdateAgentRequest) returns (Agent) {
     option (google.api.http) = {
       patch: "/v3beta1/{agent.name=projects/*/locations/*/agents/*}"
@@ -99,6 +107,10 @@ service Agents {
   //
   // Replaces the current agent with a new one. Note that all existing resources
   // in agent (e.g. intents, entity types, flows) will be removed.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc RestoreAgent(RestoreAgentRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v3beta1/{name=projects/*/locations/*/agents/*}:restore"

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/entity_type.proto

@@ -64,6 +64,10 @@ service EntityTypes {
   }
 
   // Updates the specified entity type.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc UpdateEntityType(UpdateEntityTypeRequest) returns (EntityType) {
     option (google.api.http) = {
       patch: "/v3beta1/{entity_type.name=projects/*/locations/*/agents/*/entityTypes/*}"
@@ -73,6 +77,10 @@ service EntityTypes {
   }
 
   // Deletes the specified entity type.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc DeleteEntityType(DeleteEntityTypeRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v3beta1/{name=projects/*/locations/*/agents/*/entityTypes/*}"

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/flow.proto

@@ -43,6 +43,10 @@ service Flows {
       "https://www.googleapis.com/auth/dialogflow";
 
   // Creates a flow in the specified agent.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc CreateFlow(CreateFlowRequest) returns (Flow) {
     option (google.api.http) = {
       post: "/v3beta1/{parent=projects/*/locations/*/agents/*}/flows"
@@ -76,6 +80,10 @@ service Flows {
   }
 
   // Updates the specified flow.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc UpdateFlow(UpdateFlowRequest) returns (Flow) {
     option (google.api.http) = {
       patch: "/v3beta1/{flow.name=projects/*/locations/*/agents/*/flows/*}"
@@ -86,6 +94,10 @@ service Flows {
 
   // Trains the specified flow. Note that only the flow in 'draft' environment
   // is trained.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc TrainFlow(TrainFlowRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v3beta1/{name=projects/*/locations/*/agents/*/flows/*}:train"
@@ -118,6 +130,10 @@ service Flows {
   }
 
   // Imports the specified flow to the specified agent from a binary file.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc ImportFlow(ImportFlowRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v3beta1/{parent=projects/*/locations/*/agents/*}/flows:import"

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/intent.proto

@@ -22,6 +22,7 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 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.Cx.V3Beta1";
@@ -55,6 +56,10 @@ service Intents {
   }
 
   // Creates an intent in the specified agent.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc CreateIntent(CreateIntentRequest) returns (Intent) {
     option (google.api.http) = {
       post: "/v3beta1/{parent=projects/*/locations/*/agents/*}/intents"
@@ -64,6 +69,10 @@ service Intents {
   }
 
   // Updates the specified intent.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc UpdateIntent(UpdateIntentRequest) returns (Intent) {
     option (google.api.http) = {
       patch: "/v3beta1/{intent.name=projects/*/locations/*/agents/*/intents/*}"
@@ -73,6 +82,10 @@ service Intents {
   }
 
   // Deletes the specified intent.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc DeleteIntent(DeleteIntentRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v3beta1/{name=projects/*/locations/*/agents/*/intents/*}"

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/transition_route_group.proto

@@ -56,6 +56,10 @@ service TransitionRouteGroups {
   }
 
   // Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] in the specified flow.
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc CreateTransitionRouteGroup(CreateTransitionRouteGroupRequest) returns (TransitionRouteGroup) {
     option (google.api.http) = {
       post: "/v3beta1/{parent=projects/*/locations/*/agents/*/flows/*}/transitionRouteGroups"
@@ -65,6 +69,10 @@ service TransitionRouteGroups {
   }
 
   // Updates the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc UpdateTransitionRouteGroup(UpdateTransitionRouteGroupRequest) returns (TransitionRouteGroup) {
     option (google.api.http) = {
       patch: "/v3beta1/{transition_route_group.name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}"
@@ -74,6 +82,10 @@ service TransitionRouteGroups {
   }
 
   // Deletes the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
+  //
+  // Note: You should always train a flow prior to sending it queries. See the
+  // [training
+  // documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
   rpc DeleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v3beta1/{name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}"

packages/google-cloud-dialogflow-cx/src/v3beta1/agents_client.ts

@@ -537,6 +537,10 @@ export class AgentsClient {
   /**
    * Creates an agent in the specified location.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
@@ -631,6 +635,10 @@ export class AgentsClient {
   /**
    * Updates the specified agent.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {google.cloud.dialogflow.cx.v3beta1.Agent} request.agent
@@ -1185,6 +1193,10 @@ export class AgentsClient {
    * Replaces the current agent with a new one. Note that all existing resources
    * in agent (e.g. intents, entity types, flows) will be removed.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name

packages/google-cloud-dialogflow-cx/src/v3beta1/entity_types_client.ts

@@ -625,6 +625,10 @@ export class EntityTypesClient {
   /**
    * Updates the specified entity type.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {google.cloud.dialogflow.cx.v3beta1.EntityType} request.entityType
@@ -736,6 +740,10 @@ export class EntityTypesClient {
   /**
    * Deletes the specified entity type.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name

packages/google-cloud-dialogflow-cx/src/v3beta1/flows_client.ts

@@ -457,6 +457,10 @@ export class FlowsClient {
   /**
    * Creates a flow in the specified agent.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
@@ -775,6 +779,10 @@ export class FlowsClient {
   /**
    * Updates the specified flow.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {google.cloud.dialogflow.cx.v3beta1.Flow} request.flow
@@ -1098,6 +1106,10 @@ export class FlowsClient {
    * Trains the specified flow. Note that only the flow in 'draft' environment
    * is trained.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name
@@ -1238,6 +1250,10 @@ export class FlowsClient {
   /**
    * Imports the specified flow to the specified agent from a binary file.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent

packages/google-cloud-dialogflow-cx/src/v3beta1/intents_client.ts

@@ -505,6 +505,10 @@ export class IntentsClient {
   /**
    * Creates an intent in the specified agent.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
@@ -615,6 +619,10 @@ export class IntentsClient {
   /**
    * Updates the specified intent.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {google.cloud.dialogflow.cx.v3beta1.Intent} request.intent
@@ -725,6 +733,10 @@ export class IntentsClient {
   /**
    * Deletes the specified intent.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name

packages/google-cloud-dialogflow-cx/src/v3beta1/transition_route_groups_client.ts

@@ -519,6 +519,10 @@ export class TransitionRouteGroupsClient {
   /**
    * Creates an {@link google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup|TransitionRouteGroup} in the specified flow.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
@@ -636,6 +640,10 @@ export class TransitionRouteGroupsClient {
   /**
    * Updates the specified {@link google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup|TransitionRouteGroup}.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup} request.transitionRouteGroup
@@ -751,6 +759,10 @@ export class TransitionRouteGroupsClient {
   /**
    * Deletes the specified {@link google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup|TransitionRouteGroup}.
    *
+   * Note: You should always train a flow prior to sending it queries. See the
+   * [training
+   * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
+   *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name