Skip to content
This repository was archived by the owner on Dec 3, 2023. It is now read-only.

Commit 5692ace

Browse files
yoshi-automationyoshi-automation
authored
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
1 parent 6e43ac4 commit 5692ace

File tree

16 files changed

+667
-309
lines changed

16 files changed

+667
-309
lines changed

‎google-cloud-dialogflow/src/main/java/com/google/cloud/dialogflow/v2/AgentsClient.java

Lines changed: 51 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,9 @@ public final UnaryCallable<GetAgentRequest, Agent> getAgentCallable() {
278278
/**
279279
* Creates/updates the specified agent.
280280
*
281+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
282+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
283+
*
281284
* <p>Sample code:
282285
*
283286
* <pre>{@code
@@ -299,6 +302,9 @@ public final Agent setAgent(Agent agent) {
299302
/**
300303
* Creates/updates the specified agent.
301304
*
305+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
306+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
307+
*
302308
* <p>Sample code:
303309
*
304310
* <pre>{@code
@@ -323,6 +329,9 @@ public final Agent setAgent(SetAgentRequest request) {
323329
/**
324330
* Creates/updates the specified agent.
325331
*
332+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
333+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
334+
*
326335
* <p>Sample code:
327336
*
328337
* <pre>{@code
@@ -658,7 +667,8 @@ public final UnaryCallable<SearchAgentsRequest, SearchAgentsResponse> searchAgen
658667
/**
659668
* Trains the specified agent.
660669
*
661-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
670+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
671+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
662672
*
663673
* <p>Sample code:
664674
*
@@ -683,7 +693,8 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(LocationName parent)
683693
/**
684694
* Trains the specified agent.
685695
*
686-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
696+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
697+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
687698
*
688699
* <p>Sample code:
689700
*
@@ -708,7 +719,8 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(ProjectName parent)
708719
/**
709720
* Trains the specified agent.
710721
*
711-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
722+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
723+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
712724
*
713725
* <p>Sample code:
714726
*
@@ -732,7 +744,8 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(String parent) {
732744
/**
733745
* Trains the specified agent.
734746
*
735-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
747+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
748+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
736749
*
737750
* <p>Sample code:
738751
*
@@ -757,7 +770,8 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(TrainAgentRequest re
757770
/**
758771
* Trains the specified agent.
759772
*
760-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
773+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
774+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
761775
*
762776
* <p>Sample code:
763777
*
@@ -782,7 +796,8 @@ public final OperationCallable<TrainAgentRequest, Empty, Struct> trainAgentOpera
782796
/**
783797
* Trains the specified agent.
784798
*
785-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt;
799+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
800+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
786801
*
787802
* <p>Sample code:
788803
*
@@ -806,9 +821,6 @@ public final UnaryCallable<TrainAgentRequest, Operation> trainAgentCallable() {
806821
/**
807822
* Exports the specified agent to a ZIP file.
808823
*
809-
* <p>Operation &lt;response:
810-
* [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
811-
*
812824
* <p>Sample code:
813825
*
814826
* <pre>{@code
@@ -834,9 +846,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Locat
834846
/**
835847
* Exports the specified agent to a ZIP file.
836848
*
837-
* <p>Operation &lt;response:
838-
* [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
839-
*
840849
* <p>Sample code:
841850
*
842851
* <pre>{@code
@@ -862,9 +871,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Proje
862871
/**
863872
* Exports the specified agent to a ZIP file.
864873
*
865-
* <p>Operation &lt;response:
866-
* [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
867-
*
868874
* <p>Sample code:
869875
*
870876
* <pre>{@code
@@ -887,9 +893,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Strin
887893
/**
888894
* Exports the specified agent to a ZIP file.
889895
*
890-
* <p>Operation &lt;response:
891-
* [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
892-
*
893896
* <p>Sample code:
894897
*
895898
* <pre>{@code
@@ -915,9 +918,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
915918
/**
916919
* Exports the specified agent to a ZIP file.
917920
*
918-
* <p>Operation &lt;response:
919-
* [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
920-
*
921921
* <p>Sample code:
922922
*
923923
* <pre>{@code
@@ -943,9 +943,6 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
943943
/**
944944
* Exports the specified agent to a ZIP file.
945945
*
946-
* <p>Operation &lt;response:
947-
* [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]&gt;
948-
*
949946
* <p>Sample code:
950947
*
951948
* <pre>{@code
@@ -977,9 +974,11 @@ public final UnaryCallable<ExportAgentRequest, Operation> exportAgentCallable()
977974
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
978975
* returns in order to train explicitly.
979976
*
980-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
981-
* which tracks when importing is complete. It only tracks when the draft agent is updated not
982-
* when it is done training.
977+
* <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
978+
* updated not when it is done training.
979+
*
980+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
981+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
983982
*
984983
* <p>Sample code:
985984
*
@@ -1012,9 +1011,11 @@ public final OperationFuture<Empty, Struct> importAgentAsync(ImportAgentRequest
10121011
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
10131012
* returns in order to train explicitly.
10141013
*
1015-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
1016-
* which tracks when importing is complete. It only tracks when the draft agent is updated not
1017-
* when it is done training.
1014+
* <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
1015+
* updated not when it is done training.
1016+
*
1017+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
1018+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
10181019
*
10191020
* <p>Sample code:
10201021
*
@@ -1047,9 +1048,11 @@ public final OperationCallable<ImportAgentRequest, Empty, Struct> importAgentOpe
10471048
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
10481049
* returns in order to train explicitly.
10491050
*
1050-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
1051-
* which tracks when importing is complete. It only tracks when the draft agent is updated not
1052-
* when it is done training.
1051+
* <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
1052+
* updated not when it is done training.
1053+
*
1054+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
1055+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
10531056
*
10541057
* <p>Sample code:
10551058
*
@@ -1080,9 +1083,11 @@ public final UnaryCallable<ImportAgentRequest, Operation> importAgentCallable()
10801083
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
10811084
* returns in order to train explicitly.
10821085
*
1083-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
1084-
* which tracks when restoring is complete. It only tracks when the draft agent is updated not
1085-
* when it is done training.
1086+
* <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
1087+
* updated not when it is done training.
1088+
*
1089+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
1090+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
10861091
*
10871092
* <p>Sample code:
10881093
*
@@ -1114,9 +1119,11 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
11141119
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
11151120
* returns in order to train explicitly.
11161121
*
1117-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
1118-
* which tracks when restoring is complete. It only tracks when the draft agent is updated not
1119-
* when it is done training.
1122+
* <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
1123+
* updated not when it is done training.
1124+
*
1125+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
1126+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
11201127
*
11211128
* <p>Sample code:
11221129
*
@@ -1149,9 +1156,11 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
11491156
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
11501157
* returns in order to train explicitly.
11511158
*
1152-
* <p>Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty]&gt; An operation
1153-
* which tracks when restoring is complete. It only tracks when the draft agent is updated not
1154-
* when it is done training.
1159+
* <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
1160+
* updated not when it is done training.
1161+
*
1162+
* <p>Note: You should always train an agent prior to sending it queries. See the [training
1163+
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
11551164
*
11561165
* <p>Sample code:
11571166
*

0 commit comments

Comments
 (0)