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

PiperOrigin-RevId: 380267079 Source-Link: googleapis/googleapis@01bad53 Source-Link: googleapis/googleapis-gen@5810da6
googleapis · Jun 24, 2021 · dbbc03f · dbbc03f
1 parent ae502ce
commit dbbc03f
Show file tree

Hide file tree

Showing 56 changed files with 647 additions and 241 deletions.
diff --git a/...loud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsClient.java b/...loud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsClient.java
@@ -392,6 +392,9 @@ public final UnaryCallable<GetAgentRequest, Agent> getAgentCallable() {
   /**
    * Creates an agent in the specified location.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -420,6 +423,9 @@ public final Agent createAgent(LocationName parent, Agent agent) {
   /**
    * Creates an agent in the specified location.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -445,6 +451,9 @@ public final Agent createAgent(String parent, Agent agent) {
   /**
    * Creates an agent in the specified location.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -469,6 +478,9 @@ public final Agent createAgent(CreateAgentRequest request) {
   /**
    * Creates an agent in the specified location.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -492,6 +504,9 @@ public final UnaryCallable<CreateAgentRequest, Agent> createAgentCallable() {
   /**
    * Updates the specified agent.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -517,6 +532,9 @@ public final Agent updateAgent(Agent agent, FieldMask updateMask) {
   /**
    * Updates the specified agent.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -541,6 +559,9 @@ public final Agent updateAgent(UpdateAgentRequest request) {
   /**
    * Updates the specified agent.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -739,6 +760,9 @@ public final UnaryCallable<ExportAgentRequest, Operation> exportAgentCallable()
    * <p>Replaces the current agent with a new one. Note that all existing resources in agent (e.g.
    * intents, entity types, flows) will be removed.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -765,6 +789,9 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
    * <p>Replaces the current agent with a new one. Note that all existing resources in agent (e.g.
    * intents, entity types, flows) will be removed.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -792,6 +819,9 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
    * <p>Replaces the current agent with a new one. Note that all existing resources in agent (e.g.
    * intents, entity types, flows) will be removed.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code

diff --git a/...dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/EntityTypesClient.java b/...dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/EntityTypesClient.java
@@ -514,6 +514,9 @@ public final UnaryCallable<CreateEntityTypeRequest, EntityType> createEntityType
   /**
    * Updates the specified entity type.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -541,6 +544,9 @@ public final EntityType updateEntityType(EntityType entityType, FieldMask update
   /**
    * Updates the specified entity type.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -566,6 +572,9 @@ public final EntityType updateEntityType(UpdateEntityTypeRequest request) {
   /**
    * Updates the specified entity type.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -591,6 +600,9 @@ public final UnaryCallable<UpdateEntityTypeRequest, EntityType> updateEntityType
   /**
    * Deletes the specified entity type.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -616,6 +628,9 @@ public final void deleteEntityType(EntityTypeName name) {
   /**
    * Deletes the specified entity type.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -640,6 +655,9 @@ public final void deleteEntityType(String name) {
   /**
    * Deletes the specified entity type.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -666,6 +684,9 @@ public final void deleteEntityType(DeleteEntityTypeRequest request) {
   /**
    * Deletes the specified entity type.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code

diff --git a/...cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/FlowsClient.java b/...cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/FlowsClient.java
@@ -168,6 +168,9 @@ public final OperationsClient getOperationsClient() {
   /**
    * Creates a flow in the specified agent.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -196,6 +199,9 @@ public final Flow createFlow(AgentName parent, Flow flow) {
   /**
    * Creates a flow in the specified agent.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -221,6 +227,9 @@ public final Flow createFlow(String parent, Flow flow) {
   /**
    * Creates a flow in the specified agent.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -246,6 +255,9 @@ public final Flow createFlow(CreateFlowRequest request) {
   /**
    * Creates a flow in the specified agent.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -592,6 +604,9 @@ public final UnaryCallable<GetFlowRequest, Flow> getFlowCallable() {
   /**
    * Updates the specified flow.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -617,6 +632,9 @@ public final Flow updateFlow(Flow flow, FieldMask updateMask) {
   /**
    * Updates the specified flow.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -642,6 +660,9 @@ public final Flow updateFlow(UpdateFlowRequest request) {
   /**
    * Updates the specified flow.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -666,6 +687,9 @@ public final UnaryCallable<UpdateFlowRequest, Flow> updateFlowCallable() {
   /**
    * Trains the specified flow. Note that only the flow in 'draft' environment is trained.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -689,6 +713,9 @@ public final OperationFuture<Empty, Struct> trainFlowAsync(FlowName name) {
   /**
    * Trains the specified flow. Note that only the flow in 'draft' environment is trained.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -711,6 +738,9 @@ public final OperationFuture<Empty, Struct> trainFlowAsync(String name) {
   /**
    * Trains the specified flow. Note that only the flow in 'draft' environment is trained.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -734,6 +764,9 @@ public final OperationFuture<Empty, Struct> trainFlowAsync(TrainFlowRequest requ
   /**
    * Trains the specified flow. Note that only the flow in 'draft' environment is trained.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -757,6 +790,9 @@ public final OperationCallable<TrainFlowRequest, Empty, Struct> trainFlowOperati
   /**
    * Trains the specified flow. Note that only the flow in 'draft' environment is trained.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -939,6 +975,9 @@ public final FlowValidationResult getFlowValidationResult(
   /**
    * Imports the specified flow to the specified agent from a binary file.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -963,6 +1002,9 @@ public final OperationFuture<ImportFlowResponse, Struct> importFlowAsync(
   /**
    * Imports the specified flow to the specified agent from a binary file.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -987,6 +1029,9 @@ public final OperationFuture<ImportFlowResponse, Struct> importFlowAsync(
   /**
    * Imports the specified flow to the specified agent from a binary file.
    *
+   * <p>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).
+   *
    * <p>Sample code:
    *
    * <pre>{@code