Skip to content

Commit 01bad53

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: added notes to train agent before sending queries
PiperOrigin-RevId: 380267079
1 parent 9d8dbc0 commit 01bad53

5 files changed

Lines changed: 61 additions & 0 deletions

File tree

‎google/cloud/dialogflow/cx/v3beta1/agent.proto‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ service Agents {
5858
}
5959

6060
// Creates an agent in the specified location.
61+
//
62+
// Note: You should always train a flow prior to sending it queries. See the
63+
// [training
64+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
6165
rpc CreateAgent(CreateAgentRequest) returns (Agent) {
6266
option (google.api.http) = {
6367
post: "/v3beta1/{parent=projects/*/locations/*}/agents"
@@ -67,6 +71,10 @@ service Agents {
6771
}
6872

6973
// Updates the specified agent.
74+
//
75+
// Note: You should always train a flow prior to sending it queries. See the
76+
// [training
77+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
7078
rpc UpdateAgent(UpdateAgentRequest) returns (Agent) {
7179
option (google.api.http) = {
7280
patch: "/v3beta1/{agent.name=projects/*/locations/*/agents/*}"
@@ -99,6 +107,10 @@ service Agents {
99107
//
100108
// Replaces the current agent with a new one. Note that all existing resources
101109
// in agent (e.g. intents, entity types, flows) will be removed.
110+
//
111+
// Note: You should always train a flow prior to sending it queries. See the
112+
// [training
113+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
102114
rpc RestoreAgent(RestoreAgentRequest) returns (google.longrunning.Operation) {
103115
option (google.api.http) = {
104116
post: "/v3beta1/{name=projects/*/locations/*/agents/*}:restore"

‎google/cloud/dialogflow/cx/v3beta1/entity_type.proto‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ service EntityTypes {
6464
}
6565

6666
// Updates the specified entity type.
67+
//
68+
// Note: You should always train a flow prior to sending it queries. See the
69+
// [training
70+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
6771
rpc UpdateEntityType(UpdateEntityTypeRequest) returns (EntityType) {
6872
option (google.api.http) = {
6973
patch: "/v3beta1/{entity_type.name=projects/*/locations/*/agents/*/entityTypes/*}"
@@ -73,6 +77,10 @@ service EntityTypes {
7377
}
7478

7579
// Deletes the specified entity type.
80+
//
81+
// Note: You should always train a flow prior to sending it queries. See the
82+
// [training
83+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
7684
rpc DeleteEntityType(DeleteEntityTypeRequest) returns (google.protobuf.Empty) {
7785
option (google.api.http) = {
7886
delete: "/v3beta1/{name=projects/*/locations/*/agents/*/entityTypes/*}"

‎google/cloud/dialogflow/cx/v3beta1/flow.proto‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ service Flows {
4343
"https://www.googleapis.com/auth/dialogflow";
4444

4545
// Creates a flow in the specified agent.
46+
//
47+
// Note: You should always train a flow prior to sending it queries. See the
48+
// [training
49+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
4650
rpc CreateFlow(CreateFlowRequest) returns (Flow) {
4751
option (google.api.http) = {
4852
post: "/v3beta1/{parent=projects/*/locations/*/agents/*}/flows"
@@ -76,6 +80,10 @@ service Flows {
7680
}
7781

7882
// Updates the specified flow.
83+
//
84+
// Note: You should always train a flow prior to sending it queries. See the
85+
// [training
86+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
7987
rpc UpdateFlow(UpdateFlowRequest) returns (Flow) {
8088
option (google.api.http) = {
8189
patch: "/v3beta1/{flow.name=projects/*/locations/*/agents/*/flows/*}"
@@ -86,6 +94,10 @@ service Flows {
8694

8795
// Trains the specified flow. Note that only the flow in 'draft' environment
8896
// is trained.
97+
//
98+
// Note: You should always train a flow prior to sending it queries. See the
99+
// [training
100+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
89101
rpc TrainFlow(TrainFlowRequest) returns (google.longrunning.Operation) {
90102
option (google.api.http) = {
91103
post: "/v3beta1/{name=projects/*/locations/*/agents/*/flows/*}:train"
@@ -118,6 +130,10 @@ service Flows {
118130
}
119131

120132
// Imports the specified flow to the specified agent from a binary file.
133+
//
134+
// Note: You should always train a flow prior to sending it queries. See the
135+
// [training
136+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
121137
rpc ImportFlow(ImportFlowRequest) returns (google.longrunning.Operation) {
122138
option (google.api.http) = {
123139
post: "/v3beta1/{parent=projects/*/locations/*/agents/*}/flows:import"

‎google/cloud/dialogflow/cx/v3beta1/intent.proto‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import "google/api/field_behavior.proto";
2222
import "google/api/resource.proto";
2323
import "google/protobuf/empty.proto";
2424
import "google/protobuf/field_mask.proto";
25+
import "google/protobuf/timestamp.proto";
2526

2627
option cc_enable_arenas = true;
2728
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
@@ -55,6 +56,10 @@ service Intents {
5556
}
5657

5758
// Creates an intent in the specified agent.
59+
//
60+
// Note: You should always train a flow prior to sending it queries. See the
61+
// [training
62+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
5863
rpc CreateIntent(CreateIntentRequest) returns (Intent) {
5964
option (google.api.http) = {
6065
post: "/v3beta1/{parent=projects/*/locations/*/agents/*}/intents"
@@ -64,6 +69,10 @@ service Intents {
6469
}
6570

6671
// Updates the specified intent.
72+
//
73+
// Note: You should always train a flow prior to sending it queries. See the
74+
// [training
75+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
6776
rpc UpdateIntent(UpdateIntentRequest) returns (Intent) {
6877
option (google.api.http) = {
6978
patch: "/v3beta1/{intent.name=projects/*/locations/*/agents/*/intents/*}"
@@ -73,6 +82,10 @@ service Intents {
7382
}
7483

7584
// Deletes the specified intent.
85+
//
86+
// Note: You should always train a flow prior to sending it queries. See the
87+
// [training
88+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
7689
rpc DeleteIntent(DeleteIntentRequest) returns (google.protobuf.Empty) {
7790
option (google.api.http) = {
7891
delete: "/v3beta1/{name=projects/*/locations/*/agents/*/intents/*}"

‎google/cloud/dialogflow/cx/v3beta1/transition_route_group.proto‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ service TransitionRouteGroups {
5656
}
5757

5858
// Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup] in the specified flow.
59+
//
60+
// Note: You should always train a flow prior to sending it queries. See the
61+
// [training
62+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
5963
rpc CreateTransitionRouteGroup(CreateTransitionRouteGroupRequest) returns (TransitionRouteGroup) {
6064
option (google.api.http) = {
6165
post: "/v3beta1/{parent=projects/*/locations/*/agents/*/flows/*}/transitionRouteGroups"
@@ -65,6 +69,10 @@ service TransitionRouteGroups {
6569
}
6670

6771
// Updates the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
72+
//
73+
// Note: You should always train a flow prior to sending it queries. See the
74+
// [training
75+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
6876
rpc UpdateTransitionRouteGroup(UpdateTransitionRouteGroupRequest) returns (TransitionRouteGroup) {
6977
option (google.api.http) = {
7078
patch: "/v3beta1/{transition_route_group.name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}"
@@ -74,6 +82,10 @@ service TransitionRouteGroups {
7482
}
7583

7684
// Deletes the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup].
85+
//
86+
// Note: You should always train a flow prior to sending it queries. See the
87+
// [training
88+
// documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
7789
rpc DeleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest) returns (google.protobuf.Empty) {
7890
option (google.api.http) = {
7991
delete: "/v3beta1/{name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}"

0 commit comments

Comments
 (0)