docs: added notes to train agent prior to sending queries (#601)

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/4608b25f-ef7f-4e94-8853-b270d97453b2/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.) PiperOrigin-RevId: 380595849 Source-Link: googleapis/googleapis@5fe3c63 fix: added resource reference to agent_version
googleapis · Jul 5, 2021 · 5692ace · 5692ace
1 parent 6e43ac4
commit 5692ace
Show file tree

Hide file tree

Showing 16 changed files with 667 additions and 309 deletions.
diff --git a/google-cloud-dialogflow/src/main/java/com/google/cloud/dialogflow/v2/AgentsClient.java b/google-cloud-dialogflow/src/main/java/com/google/cloud/dialogflow/v2/AgentsClient.java
@@ -278,6 +278,9 @@ public final UnaryCallable<GetAgentRequest, Agent> getAgentCallable() {
   /**
    * Creates/updates the specified agent.
    *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -299,6 +302,9 @@ public final Agent setAgent(Agent agent) {
   /**
    * Creates/updates the specified agent.
    *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -323,6 +329,9 @@ public final Agent setAgent(SetAgentRequest request) {
   /**
    * Creates/updates the specified agent.
    *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -658,7 +667,8 @@ public final UnaryCallable<SearchAgentsRequest, SearchAgentsResponse> searchAgen
   /**
    * Trains the specified agent.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -683,7 +693,8 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(LocationName parent)
   /**
    * Trains the specified agent.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -708,7 +719,8 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(ProjectName parent)
   /**
    * Trains the specified agent.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -732,7 +744,8 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(String parent) {
   /**
    * Trains the specified agent.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -757,7 +770,8 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(TrainAgentRequest re
   /**
    * Trains the specified agent.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -782,7 +796,8 @@ public final OperationCallable<TrainAgentRequest, Empty, Struct> trainAgentOpera
   /**
    * Trains the specified agent.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -806,9 +821,6 @@ public final UnaryCallable<TrainAgentRequest, Operation> trainAgentCallable() {
   /**
    * Exports the specified agent to a ZIP file.
    *
-   * <p>Operation &lt;response:
-   * [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
-   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -834,9 +846,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Locat
   /**
    * Exports the specified agent to a ZIP file.
    *
-   * <p>Operation &lt;response:
-   * [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
-   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -862,9 +871,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Proje
   /**
    * Exports the specified agent to a ZIP file.
    *
-   * <p>Operation &lt;response:
-   * [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
-   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -887,9 +893,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Strin
   /**
    * Exports the specified agent to a ZIP file.
    *
-   * <p>Operation &lt;response:
-   * [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
-   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -915,9 +918,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
   /**
    * Exports the specified agent to a ZIP file.
    *
-   * <p>Operation &lt;response:
-   * [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
-   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -943,9 +943,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
   /**
    * Exports the specified agent to a ZIP file.
    *
-   * <p>Operation &lt;response:
-   * [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
-   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -977,9 +974,11 @@ public final UnaryCallable<ExportAgentRequest, Operation> exportAgentCallable()
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
-   * which tracks when importing is complete. It only tracks when the draft agent is updated not
-   * when it is done training.
+   * <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
+   * updated not when it is done training.
+   *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -1012,9 +1011,11 @@ public final OperationFuture<Empty, Struct> importAgentAsync(ImportAgentRequest
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
-   * which tracks when importing is complete. It only tracks when the draft agent is updated not
-   * when it is done training.
+   * <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
+   * updated not when it is done training.
+   *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -1047,9 +1048,11 @@ public final OperationCallable<ImportAgentRequest, Empty, Struct> importAgentOpe
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
-   * which tracks when importing is complete. It only tracks when the draft agent is updated not
-   * when it is done training.
+   * <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
+   * updated not when it is done training.
+   *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -1080,9 +1083,11 @@ public final UnaryCallable<ImportAgentRequest, Operation> importAgentCallable()
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
-   * which tracks when restoring is complete. It only tracks when the draft agent is updated not
-   * when it is done training.
+   * <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
+   * updated not when it is done training.
+   *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -1114,9 +1119,11 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
-   * which tracks when restoring is complete. It only tracks when the draft agent is updated not
-   * when it is done training.
+   * <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
+   * updated not when it is done training.
+   *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *
@@ -1149,9 +1156,11 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
-   * which tracks when restoring is complete. It only tracks when the draft agent is updated not
-   * when it is done training.
+   * <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
+   * updated not when it is done training.
+   *
+   * <p>Note: You should always train an agent prior to sending it queries. See the [training
+   * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
    * <p>Sample code:
    *