xref: /aosp_15_r20/external/googleapis/google/cloud/dialogflow/v2beta1/agent.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1*d5c09012SAndroid Build Coastguard Worker// Copyright 2023 Google LLC
2*d5c09012SAndroid Build Coastguard Worker//
3*d5c09012SAndroid Build Coastguard Worker// Licensed under the Apache License, Version 2.0 (the "License");
4*d5c09012SAndroid Build Coastguard Worker// you may not use this file except in compliance with the License.
5*d5c09012SAndroid Build Coastguard Worker// You may obtain a copy of the License at
6*d5c09012SAndroid Build Coastguard Worker//
7*d5c09012SAndroid Build Coastguard Worker//     http://www.apache.org/licenses/LICENSE-2.0
8*d5c09012SAndroid Build Coastguard Worker//
9*d5c09012SAndroid Build Coastguard Worker// Unless required by applicable law or agreed to in writing, software
10*d5c09012SAndroid Build Coastguard Worker// distributed under the License is distributed on an "AS IS" BASIS,
11*d5c09012SAndroid Build Coastguard Worker// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*d5c09012SAndroid Build Coastguard Worker// See the License for the specific language governing permissions and
13*d5c09012SAndroid Build Coastguard Worker// limitations under the License.
14*d5c09012SAndroid Build Coastguard Worker
15*d5c09012SAndroid Build Coastguard Workersyntax = "proto3";
16*d5c09012SAndroid Build Coastguard Worker
17*d5c09012SAndroid Build Coastguard Workerpackage google.cloud.dialogflow.v2beta1;
18*d5c09012SAndroid Build Coastguard Worker
19*d5c09012SAndroid Build Coastguard Workerimport "google/api/annotations.proto";
20*d5c09012SAndroid Build Coastguard Workerimport "google/api/client.proto";
21*d5c09012SAndroid Build Coastguard Workerimport "google/api/field_behavior.proto";
22*d5c09012SAndroid Build Coastguard Workerimport "google/api/resource.proto";
23*d5c09012SAndroid Build Coastguard Workerimport "google/cloud/dialogflow/v2beta1/validation_result.proto";
24*d5c09012SAndroid Build Coastguard Workerimport "google/longrunning/operations.proto";
25*d5c09012SAndroid Build Coastguard Workerimport "google/protobuf/empty.proto";
26*d5c09012SAndroid Build Coastguard Workerimport "google/protobuf/field_mask.proto";
27*d5c09012SAndroid Build Coastguard Workerimport "google/protobuf/struct.proto";
28*d5c09012SAndroid Build Coastguard Worker
29*d5c09012SAndroid Build Coastguard Workeroption cc_enable_arenas = true;
30*d5c09012SAndroid Build Coastguard Workeroption csharp_namespace = "Google.Cloud.Dialogflow.V2Beta1";
31*d5c09012SAndroid Build Coastguard Workeroption go_package = "cloud.google.com/go/dialogflow/apiv2beta1/dialogflowpb;dialogflowpb";
32*d5c09012SAndroid Build Coastguard Workeroption java_multiple_files = true;
33*d5c09012SAndroid Build Coastguard Workeroption java_outer_classname = "AgentProto";
34*d5c09012SAndroid Build Coastguard Workeroption java_package = "com.google.cloud.dialogflow.v2beta1";
35*d5c09012SAndroid Build Coastguard Workeroption objc_class_prefix = "DF";
36*d5c09012SAndroid Build Coastguard Worker
37*d5c09012SAndroid Build Coastguard Worker// Service for managing [Agents][google.cloud.dialogflow.v2beta1.Agent].
38*d5c09012SAndroid Build Coastguard Workerservice Agents {
39*d5c09012SAndroid Build Coastguard Worker  option (google.api.default_host) = "dialogflow.googleapis.com";
40*d5c09012SAndroid Build Coastguard Worker  option (google.api.oauth_scopes) =
41*d5c09012SAndroid Build Coastguard Worker      "https://www.googleapis.com/auth/cloud-platform,"
42*d5c09012SAndroid Build Coastguard Worker      "https://www.googleapis.com/auth/dialogflow";
43*d5c09012SAndroid Build Coastguard Worker
44*d5c09012SAndroid Build Coastguard Worker  // Retrieves the specified agent.
45*d5c09012SAndroid Build Coastguard Worker  rpc GetAgent(GetAgentRequest) returns (Agent) {
46*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
47*d5c09012SAndroid Build Coastguard Worker      get: "/v2beta1/{parent=projects/*}/agent"
48*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
49*d5c09012SAndroid Build Coastguard Worker        get: "/v2beta1/{parent=projects/*/locations/*}/agent"
50*d5c09012SAndroid Build Coastguard Worker      }
51*d5c09012SAndroid Build Coastguard Worker    };
52*d5c09012SAndroid Build Coastguard Worker    option (google.api.method_signature) = "parent";
53*d5c09012SAndroid Build Coastguard Worker  }
54*d5c09012SAndroid Build Coastguard Worker
55*d5c09012SAndroid Build Coastguard Worker  // Creates/updates the specified agent.
56*d5c09012SAndroid Build Coastguard Worker  //
57*d5c09012SAndroid Build Coastguard Worker  // Note: You should always train an agent prior to sending it queries. See the
58*d5c09012SAndroid Build Coastguard Worker  // [training
59*d5c09012SAndroid Build Coastguard Worker  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
60*d5c09012SAndroid Build Coastguard Worker  rpc SetAgent(SetAgentRequest) returns (Agent) {
61*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
62*d5c09012SAndroid Build Coastguard Worker      post: "/v2beta1/{agent.parent=projects/*}/agent"
63*d5c09012SAndroid Build Coastguard Worker      body: "agent"
64*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
65*d5c09012SAndroid Build Coastguard Worker        post: "/v2beta1/{agent.parent=projects/*/locations/*}/agent"
66*d5c09012SAndroid Build Coastguard Worker        body: "agent"
67*d5c09012SAndroid Build Coastguard Worker      }
68*d5c09012SAndroid Build Coastguard Worker    };
69*d5c09012SAndroid Build Coastguard Worker    option (google.api.method_signature) = "agent";
70*d5c09012SAndroid Build Coastguard Worker  }
71*d5c09012SAndroid Build Coastguard Worker
72*d5c09012SAndroid Build Coastguard Worker  // Deletes the specified agent.
73*d5c09012SAndroid Build Coastguard Worker  rpc DeleteAgent(DeleteAgentRequest) returns (google.protobuf.Empty) {
74*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
75*d5c09012SAndroid Build Coastguard Worker      delete: "/v2beta1/{parent=projects/*}/agent"
76*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
77*d5c09012SAndroid Build Coastguard Worker        delete: "/v2beta1/{parent=projects/*/locations/*}/agent"
78*d5c09012SAndroid Build Coastguard Worker      }
79*d5c09012SAndroid Build Coastguard Worker    };
80*d5c09012SAndroid Build Coastguard Worker    option (google.api.method_signature) = "parent";
81*d5c09012SAndroid Build Coastguard Worker  }
82*d5c09012SAndroid Build Coastguard Worker
83*d5c09012SAndroid Build Coastguard Worker  // Returns the list of agents.
84*d5c09012SAndroid Build Coastguard Worker  // Since there is at most one conversational agent per project, this method is
85*d5c09012SAndroid Build Coastguard Worker  // useful primarily for listing all agents across projects the caller has
86*d5c09012SAndroid Build Coastguard Worker  // access to. One can achieve that with a wildcard project collection id "-".
87*d5c09012SAndroid Build Coastguard Worker  // Refer to [List
88*d5c09012SAndroid Build Coastguard Worker  // Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
89*d5c09012SAndroid Build Coastguard Worker  rpc SearchAgents(SearchAgentsRequest) returns (SearchAgentsResponse) {
90*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
91*d5c09012SAndroid Build Coastguard Worker      get: "/v2beta1/{parent=projects/*}/agent:search"
92*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
93*d5c09012SAndroid Build Coastguard Worker        get: "/v2beta1/{parent=projects/*/locations/*}/agent:search"
94*d5c09012SAndroid Build Coastguard Worker      }
95*d5c09012SAndroid Build Coastguard Worker    };
96*d5c09012SAndroid Build Coastguard Worker    option (google.api.method_signature) = "parent";
97*d5c09012SAndroid Build Coastguard Worker  }
98*d5c09012SAndroid Build Coastguard Worker
99*d5c09012SAndroid Build Coastguard Worker  // Trains the specified agent.
100*d5c09012SAndroid Build Coastguard Worker  //
101*d5c09012SAndroid Build Coastguard Worker  // This method is a [long-running
102*d5c09012SAndroid Build Coastguard Worker  // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
103*d5c09012SAndroid Build Coastguard Worker  // The returned `Operation` type has the following method-specific fields:
104*d5c09012SAndroid Build Coastguard Worker  //
105*d5c09012SAndroid Build Coastguard Worker  // - `metadata`: An empty [Struct
106*d5c09012SAndroid Build Coastguard Worker  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
107*d5c09012SAndroid Build Coastguard Worker  // - `response`: An [Empty
108*d5c09012SAndroid Build Coastguard Worker  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
109*d5c09012SAndroid Build Coastguard Worker  //
110*d5c09012SAndroid Build Coastguard Worker  // Note: You should always train an agent prior to sending it queries. See the
111*d5c09012SAndroid Build Coastguard Worker  // [training
112*d5c09012SAndroid Build Coastguard Worker  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
113*d5c09012SAndroid Build Coastguard Worker  rpc TrainAgent(TrainAgentRequest) returns (google.longrunning.Operation) {
114*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
115*d5c09012SAndroid Build Coastguard Worker      post: "/v2beta1/{parent=projects/*}/agent:train"
116*d5c09012SAndroid Build Coastguard Worker      body: "*"
117*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
118*d5c09012SAndroid Build Coastguard Worker        post: "/v2beta1/{parent=projects/*/locations/*}/agent:train"
119*d5c09012SAndroid Build Coastguard Worker        body: "*"
120*d5c09012SAndroid Build Coastguard Worker      }
121*d5c09012SAndroid Build Coastguard Worker    };
122*d5c09012SAndroid Build Coastguard Worker    option (google.api.method_signature) = "parent";
123*d5c09012SAndroid Build Coastguard Worker    option (google.longrunning.operation_info) = {
124*d5c09012SAndroid Build Coastguard Worker      response_type: "google.protobuf.Empty"
125*d5c09012SAndroid Build Coastguard Worker      metadata_type: "google.protobuf.Struct"
126*d5c09012SAndroid Build Coastguard Worker    };
127*d5c09012SAndroid Build Coastguard Worker  }
128*d5c09012SAndroid Build Coastguard Worker
129*d5c09012SAndroid Build Coastguard Worker  // Exports the specified agent to a ZIP file.
130*d5c09012SAndroid Build Coastguard Worker  //
131*d5c09012SAndroid Build Coastguard Worker  // This method is a [long-running
132*d5c09012SAndroid Build Coastguard Worker  // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
133*d5c09012SAndroid Build Coastguard Worker  // The returned `Operation` type has the following method-specific fields:
134*d5c09012SAndroid Build Coastguard Worker  //
135*d5c09012SAndroid Build Coastguard Worker  // - `metadata`: An empty [Struct
136*d5c09012SAndroid Build Coastguard Worker  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
137*d5c09012SAndroid Build Coastguard Worker  // - `response`:
138*d5c09012SAndroid Build Coastguard Worker  // [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]
139*d5c09012SAndroid Build Coastguard Worker  rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
140*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
141*d5c09012SAndroid Build Coastguard Worker      post: "/v2beta1/{parent=projects/*}/agent:export"
142*d5c09012SAndroid Build Coastguard Worker      body: "*"
143*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
144*d5c09012SAndroid Build Coastguard Worker        post: "/v2beta1/{parent=projects/*/locations/*}/agent:export"
145*d5c09012SAndroid Build Coastguard Worker        body: "*"
146*d5c09012SAndroid Build Coastguard Worker      }
147*d5c09012SAndroid Build Coastguard Worker    };
148*d5c09012SAndroid Build Coastguard Worker    option (google.api.method_signature) = "parent";
149*d5c09012SAndroid Build Coastguard Worker    option (google.longrunning.operation_info) = {
150*d5c09012SAndroid Build Coastguard Worker      response_type: "google.cloud.dialogflow.v2beta1.ExportAgentResponse"
151*d5c09012SAndroid Build Coastguard Worker      metadata_type: "google.protobuf.Struct"
152*d5c09012SAndroid Build Coastguard Worker    };
153*d5c09012SAndroid Build Coastguard Worker  }
154*d5c09012SAndroid Build Coastguard Worker
155*d5c09012SAndroid Build Coastguard Worker  // Imports the specified agent from a ZIP file.
156*d5c09012SAndroid Build Coastguard Worker  //
157*d5c09012SAndroid Build Coastguard Worker  // Uploads new intents and entity types without deleting the existing ones.
158*d5c09012SAndroid Build Coastguard Worker  // Intents and entity types with the same name are replaced with the new
159*d5c09012SAndroid Build Coastguard Worker  // versions from
160*d5c09012SAndroid Build Coastguard Worker  // [ImportAgentRequest][google.cloud.dialogflow.v2beta1.ImportAgentRequest].
161*d5c09012SAndroid Build Coastguard Worker  // After the import, the imported draft agent will be trained automatically
162*d5c09012SAndroid Build Coastguard Worker  // (unless disabled in agent settings). However, once the import is done,
163*d5c09012SAndroid Build Coastguard Worker  // training may not be completed yet. Please call
164*d5c09012SAndroid Build Coastguard Worker  // [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait
165*d5c09012SAndroid Build Coastguard Worker  // for the operation it returns in order to train explicitly.
166*d5c09012SAndroid Build Coastguard Worker  //
167*d5c09012SAndroid Build Coastguard Worker  // This method is a [long-running
168*d5c09012SAndroid Build Coastguard Worker  // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
169*d5c09012SAndroid Build Coastguard Worker  // The returned `Operation` type has the following method-specific fields:
170*d5c09012SAndroid Build Coastguard Worker  //
171*d5c09012SAndroid Build Coastguard Worker  // - `metadata`: An empty [Struct
172*d5c09012SAndroid Build Coastguard Worker  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
173*d5c09012SAndroid Build Coastguard Worker  // - `response`: An [Empty
174*d5c09012SAndroid Build Coastguard Worker  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
175*d5c09012SAndroid Build Coastguard Worker  //
176*d5c09012SAndroid Build Coastguard Worker  // The operation only tracks when importing is complete, not when it is done
177*d5c09012SAndroid Build Coastguard Worker  // training.
178*d5c09012SAndroid Build Coastguard Worker  //
179*d5c09012SAndroid Build Coastguard Worker  // Note: You should always train an agent prior to sending it queries. See the
180*d5c09012SAndroid Build Coastguard Worker  // [training
181*d5c09012SAndroid Build Coastguard Worker  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
182*d5c09012SAndroid Build Coastguard Worker  rpc ImportAgent(ImportAgentRequest) returns (google.longrunning.Operation) {
183*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
184*d5c09012SAndroid Build Coastguard Worker      post: "/v2beta1/{parent=projects/*}/agent:import"
185*d5c09012SAndroid Build Coastguard Worker      body: "*"
186*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
187*d5c09012SAndroid Build Coastguard Worker        post: "/v2beta1/{parent=projects/*/locations/*}/agent:import"
188*d5c09012SAndroid Build Coastguard Worker        body: "*"
189*d5c09012SAndroid Build Coastguard Worker      }
190*d5c09012SAndroid Build Coastguard Worker    };
191*d5c09012SAndroid Build Coastguard Worker    option (google.longrunning.operation_info) = {
192*d5c09012SAndroid Build Coastguard Worker      response_type: "google.protobuf.Empty"
193*d5c09012SAndroid Build Coastguard Worker      metadata_type: "google.protobuf.Struct"
194*d5c09012SAndroid Build Coastguard Worker    };
195*d5c09012SAndroid Build Coastguard Worker  }
196*d5c09012SAndroid Build Coastguard Worker
197*d5c09012SAndroid Build Coastguard Worker  // Restores the specified agent from a ZIP file.
198*d5c09012SAndroid Build Coastguard Worker  //
199*d5c09012SAndroid Build Coastguard Worker  // Replaces the current agent version with a new one. All the intents and
200*d5c09012SAndroid Build Coastguard Worker  // entity types in the older version are deleted. After the restore, the
201*d5c09012SAndroid Build Coastguard Worker  // restored draft agent will be trained automatically (unless disabled in
202*d5c09012SAndroid Build Coastguard Worker  // agent settings). However, once the restore is done, training may not be
203*d5c09012SAndroid Build Coastguard Worker  // completed yet. Please call
204*d5c09012SAndroid Build Coastguard Worker  // [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait
205*d5c09012SAndroid Build Coastguard Worker  // for the operation it returns in order to train explicitly.
206*d5c09012SAndroid Build Coastguard Worker  //
207*d5c09012SAndroid Build Coastguard Worker  // This method is a [long-running
208*d5c09012SAndroid Build Coastguard Worker  // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
209*d5c09012SAndroid Build Coastguard Worker  // The returned `Operation` type has the following method-specific fields:
210*d5c09012SAndroid Build Coastguard Worker  //
211*d5c09012SAndroid Build Coastguard Worker  // - `metadata`: An empty [Struct
212*d5c09012SAndroid Build Coastguard Worker  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
213*d5c09012SAndroid Build Coastguard Worker  // - `response`: An [Empty
214*d5c09012SAndroid Build Coastguard Worker  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
215*d5c09012SAndroid Build Coastguard Worker  //
216*d5c09012SAndroid Build Coastguard Worker  // The operation only tracks when restoring is complete, not when it is done
217*d5c09012SAndroid Build Coastguard Worker  // training.
218*d5c09012SAndroid Build Coastguard Worker  //
219*d5c09012SAndroid Build Coastguard Worker  // Note: You should always train an agent prior to sending it queries. See the
220*d5c09012SAndroid Build Coastguard Worker  // [training
221*d5c09012SAndroid Build Coastguard Worker  // documentation](https://cloud.google.com/dialogflow/es/docs/training).
222*d5c09012SAndroid Build Coastguard Worker  rpc RestoreAgent(RestoreAgentRequest) returns (google.longrunning.Operation) {
223*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
224*d5c09012SAndroid Build Coastguard Worker      post: "/v2beta1/{parent=projects/*}/agent:restore"
225*d5c09012SAndroid Build Coastguard Worker      body: "*"
226*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
227*d5c09012SAndroid Build Coastguard Worker        post: "/v2beta1/{parent=projects/*/locations/*}/agent:restore"
228*d5c09012SAndroid Build Coastguard Worker        body: "*"
229*d5c09012SAndroid Build Coastguard Worker      }
230*d5c09012SAndroid Build Coastguard Worker    };
231*d5c09012SAndroid Build Coastguard Worker    option (google.longrunning.operation_info) = {
232*d5c09012SAndroid Build Coastguard Worker      response_type: "google.protobuf.Empty"
233*d5c09012SAndroid Build Coastguard Worker      metadata_type: "google.protobuf.Struct"
234*d5c09012SAndroid Build Coastguard Worker    };
235*d5c09012SAndroid Build Coastguard Worker  }
236*d5c09012SAndroid Build Coastguard Worker
237*d5c09012SAndroid Build Coastguard Worker  // Gets agent validation result. Agent validation is performed during
238*d5c09012SAndroid Build Coastguard Worker  // training time and is updated automatically when training is completed.
239*d5c09012SAndroid Build Coastguard Worker  rpc GetValidationResult(GetValidationResultRequest)
240*d5c09012SAndroid Build Coastguard Worker      returns (ValidationResult) {
241*d5c09012SAndroid Build Coastguard Worker    option (google.api.http) = {
242*d5c09012SAndroid Build Coastguard Worker      get: "/v2beta1/{parent=projects/*}/agent/validationResult"
243*d5c09012SAndroid Build Coastguard Worker      additional_bindings {
244*d5c09012SAndroid Build Coastguard Worker        get: "/v2beta1/{parent=projects/*/locations/*}/agent/validationResult"
245*d5c09012SAndroid Build Coastguard Worker      }
246*d5c09012SAndroid Build Coastguard Worker    };
247*d5c09012SAndroid Build Coastguard Worker  }
248*d5c09012SAndroid Build Coastguard Worker}
249*d5c09012SAndroid Build Coastguard Worker
250*d5c09012SAndroid Build Coastguard Worker// A Dialogflow agent is a virtual agent that handles conversations with your
251*d5c09012SAndroid Build Coastguard Worker// end-users. It is a natural language understanding module that understands the
252*d5c09012SAndroid Build Coastguard Worker// nuances of human language. Dialogflow translates end-user text or audio
253*d5c09012SAndroid Build Coastguard Worker// during a conversation to structured data that your apps and services can
254*d5c09012SAndroid Build Coastguard Worker// understand. You design and build a Dialogflow agent to handle the types of
255*d5c09012SAndroid Build Coastguard Worker// conversations required for your system.
256*d5c09012SAndroid Build Coastguard Worker//
257*d5c09012SAndroid Build Coastguard Worker// For more information about agents, see the
258*d5c09012SAndroid Build Coastguard Worker// [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
259*d5c09012SAndroid Build Coastguard Worker//
260*d5c09012SAndroid Build Coastguard Workermessage Agent {
261*d5c09012SAndroid Build Coastguard Worker  option (google.api.resource) = {
262*d5c09012SAndroid Build Coastguard Worker    type: "dialogflow.googleapis.com/Agent"
263*d5c09012SAndroid Build Coastguard Worker    pattern: "projects/{project}/agent"
264*d5c09012SAndroid Build Coastguard Worker    pattern: "projects/{project}/locations/{location}/agent"
265*d5c09012SAndroid Build Coastguard Worker  };
266*d5c09012SAndroid Build Coastguard Worker
267*d5c09012SAndroid Build Coastguard Worker  // Match mode determines how intents are detected from user queries.
268*d5c09012SAndroid Build Coastguard Worker  enum MatchMode {
269*d5c09012SAndroid Build Coastguard Worker    // Not specified.
270*d5c09012SAndroid Build Coastguard Worker    MATCH_MODE_UNSPECIFIED = 0;
271*d5c09012SAndroid Build Coastguard Worker
272*d5c09012SAndroid Build Coastguard Worker    // Best for agents with a small number of examples in intents and/or wide
273*d5c09012SAndroid Build Coastguard Worker    // use of templates syntax and composite entities.
274*d5c09012SAndroid Build Coastguard Worker    MATCH_MODE_HYBRID = 1;
275*d5c09012SAndroid Build Coastguard Worker
276*d5c09012SAndroid Build Coastguard Worker    // Can be used for agents with a large number of examples in intents,
277*d5c09012SAndroid Build Coastguard Worker    // especially the ones using @sys.any or very large custom entities.
278*d5c09012SAndroid Build Coastguard Worker    MATCH_MODE_ML_ONLY = 2;
279*d5c09012SAndroid Build Coastguard Worker  }
280*d5c09012SAndroid Build Coastguard Worker
281*d5c09012SAndroid Build Coastguard Worker  // API version for the agent.
282*d5c09012SAndroid Build Coastguard Worker  enum ApiVersion {
283*d5c09012SAndroid Build Coastguard Worker    // Not specified.
284*d5c09012SAndroid Build Coastguard Worker    API_VERSION_UNSPECIFIED = 0;
285*d5c09012SAndroid Build Coastguard Worker
286*d5c09012SAndroid Build Coastguard Worker    // Legacy V1 API.
287*d5c09012SAndroid Build Coastguard Worker    API_VERSION_V1 = 1;
288*d5c09012SAndroid Build Coastguard Worker
289*d5c09012SAndroid Build Coastguard Worker    // V2 API.
290*d5c09012SAndroid Build Coastguard Worker    API_VERSION_V2 = 2;
291*d5c09012SAndroid Build Coastguard Worker
292*d5c09012SAndroid Build Coastguard Worker    // V2beta1 API.
293*d5c09012SAndroid Build Coastguard Worker    API_VERSION_V2_BETA_1 = 3;
294*d5c09012SAndroid Build Coastguard Worker  }
295*d5c09012SAndroid Build Coastguard Worker
296*d5c09012SAndroid Build Coastguard Worker  // Represents the agent tier.
297*d5c09012SAndroid Build Coastguard Worker  enum Tier {
298*d5c09012SAndroid Build Coastguard Worker    // Not specified. This value should never be used.
299*d5c09012SAndroid Build Coastguard Worker    TIER_UNSPECIFIED = 0;
300*d5c09012SAndroid Build Coastguard Worker
301*d5c09012SAndroid Build Coastguard Worker    // Trial Edition, previously known as Standard Edition.
302*d5c09012SAndroid Build Coastguard Worker    TIER_STANDARD = 1;
303*d5c09012SAndroid Build Coastguard Worker
304*d5c09012SAndroid Build Coastguard Worker    // Essentials Edition, previously known as Enterprise Essential Edition.
305*d5c09012SAndroid Build Coastguard Worker    TIER_ENTERPRISE = 2;
306*d5c09012SAndroid Build Coastguard Worker
307*d5c09012SAndroid Build Coastguard Worker    // Essentials Edition (same as TIER_ENTERPRISE), previously known as
308*d5c09012SAndroid Build Coastguard Worker    // Enterprise Plus Edition.
309*d5c09012SAndroid Build Coastguard Worker    TIER_ENTERPRISE_PLUS = 3 [deprecated = true];
310*d5c09012SAndroid Build Coastguard Worker  }
311*d5c09012SAndroid Build Coastguard Worker
312*d5c09012SAndroid Build Coastguard Worker  // Required. The project of this agent.
313*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
314*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`
315*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
316*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
317*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
318*d5c09012SAndroid Build Coastguard Worker      type: "cloudresourcemanager.googleapis.com/Project"
319*d5c09012SAndroid Build Coastguard Worker    }
320*d5c09012SAndroid Build Coastguard Worker  ];
321*d5c09012SAndroid Build Coastguard Worker
322*d5c09012SAndroid Build Coastguard Worker  // Required. The name of this agent.
323*d5c09012SAndroid Build Coastguard Worker  string display_name = 2;
324*d5c09012SAndroid Build Coastguard Worker
325*d5c09012SAndroid Build Coastguard Worker  // Required. The default language of the agent as a language tag. See
326*d5c09012SAndroid Build Coastguard Worker  // [Language
327*d5c09012SAndroid Build Coastguard Worker  // Support](https://cloud.google.com/dialogflow/docs/reference/language)
328*d5c09012SAndroid Build Coastguard Worker  // for a list of the currently supported language codes. This field cannot be
329*d5c09012SAndroid Build Coastguard Worker  // set by the `Update` method.
330*d5c09012SAndroid Build Coastguard Worker  string default_language_code = 3;
331*d5c09012SAndroid Build Coastguard Worker
332*d5c09012SAndroid Build Coastguard Worker  // Optional. The list of all languages supported by this agent (except for the
333*d5c09012SAndroid Build Coastguard Worker  // `default_language_code`).
334*d5c09012SAndroid Build Coastguard Worker  repeated string supported_language_codes = 4;
335*d5c09012SAndroid Build Coastguard Worker
336*d5c09012SAndroid Build Coastguard Worker  // Required. The time zone of this agent from the
337*d5c09012SAndroid Build Coastguard Worker  // [time zone database](https://www.iana.org/time-zones), e.g.,
338*d5c09012SAndroid Build Coastguard Worker  // America/New_York, Europe/Paris.
339*d5c09012SAndroid Build Coastguard Worker  string time_zone = 5;
340*d5c09012SAndroid Build Coastguard Worker
341*d5c09012SAndroid Build Coastguard Worker  // Optional. The description of this agent.
342*d5c09012SAndroid Build Coastguard Worker  // The maximum length is 500 characters. If exceeded, the request is rejected.
343*d5c09012SAndroid Build Coastguard Worker  string description = 6;
344*d5c09012SAndroid Build Coastguard Worker
345*d5c09012SAndroid Build Coastguard Worker  // Optional. The URI of the agent's avatar.
346*d5c09012SAndroid Build Coastguard Worker  // Avatars are used throughout the Dialogflow console and in the self-hosted
347*d5c09012SAndroid Build Coastguard Worker  // [Web
348*d5c09012SAndroid Build Coastguard Worker  // Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
349*d5c09012SAndroid Build Coastguard Worker  // integration.
350*d5c09012SAndroid Build Coastguard Worker  string avatar_uri = 7;
351*d5c09012SAndroid Build Coastguard Worker
352*d5c09012SAndroid Build Coastguard Worker  // Optional. Determines whether this agent should log conversation queries.
353*d5c09012SAndroid Build Coastguard Worker  bool enable_logging = 8;
354*d5c09012SAndroid Build Coastguard Worker
355*d5c09012SAndroid Build Coastguard Worker  // Optional. Determines how intents are detected from user queries.
356*d5c09012SAndroid Build Coastguard Worker  MatchMode match_mode = 9 [deprecated = true];
357*d5c09012SAndroid Build Coastguard Worker
358*d5c09012SAndroid Build Coastguard Worker  // Optional. To filter out false positive results and still get variety in
359*d5c09012SAndroid Build Coastguard Worker  // matched natural language inputs for your agent, you can tune the machine
360*d5c09012SAndroid Build Coastguard Worker  // learning classification threshold. If the returned score value is less than
361*d5c09012SAndroid Build Coastguard Worker  // the threshold value, then a fallback intent will be triggered or, if there
362*d5c09012SAndroid Build Coastguard Worker  // are no fallback intents defined, no intent will be triggered. The score
363*d5c09012SAndroid Build Coastguard Worker  // values range from 0.0 (completely uncertain) to 1.0 (completely certain).
364*d5c09012SAndroid Build Coastguard Worker  // If set to 0.0, the default of 0.3 is used.
365*d5c09012SAndroid Build Coastguard Worker  float classification_threshold = 10;
366*d5c09012SAndroid Build Coastguard Worker
367*d5c09012SAndroid Build Coastguard Worker  // Optional. API version displayed in Dialogflow console. If not specified,
368*d5c09012SAndroid Build Coastguard Worker  // V2 API is assumed. Clients are free to query different service endpoints
369*d5c09012SAndroid Build Coastguard Worker  // for different API versions. However, bots connectors and webhook calls will
370*d5c09012SAndroid Build Coastguard Worker  // follow the specified API version.
371*d5c09012SAndroid Build Coastguard Worker  ApiVersion api_version = 14;
372*d5c09012SAndroid Build Coastguard Worker
373*d5c09012SAndroid Build Coastguard Worker  // Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
374*d5c09012SAndroid Build Coastguard Worker  Tier tier = 15;
375*d5c09012SAndroid Build Coastguard Worker}
376*d5c09012SAndroid Build Coastguard Worker
377*d5c09012SAndroid Build Coastguard Worker// The request message for
378*d5c09012SAndroid Build Coastguard Worker// [Agents.GetAgent][google.cloud.dialogflow.v2beta1.Agents.GetAgent].
379*d5c09012SAndroid Build Coastguard Workermessage GetAgentRequest {
380*d5c09012SAndroid Build Coastguard Worker  // Required. The project that the agent to fetch is associated with.
381*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
382*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`.
383*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
384*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
385*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
386*d5c09012SAndroid Build Coastguard Worker      child_type: "dialogflow.googleapis.com/Agent"
387*d5c09012SAndroid Build Coastguard Worker    }
388*d5c09012SAndroid Build Coastguard Worker  ];
389*d5c09012SAndroid Build Coastguard Worker}
390*d5c09012SAndroid Build Coastguard Worker
391*d5c09012SAndroid Build Coastguard Worker// The request message for
392*d5c09012SAndroid Build Coastguard Worker// [Agents.SetAgent][google.cloud.dialogflow.v2beta1.Agents.SetAgent].
393*d5c09012SAndroid Build Coastguard Workermessage SetAgentRequest {
394*d5c09012SAndroid Build Coastguard Worker  // Required. The agent to update.
395*d5c09012SAndroid Build Coastguard Worker  Agent agent = 1 [(google.api.field_behavior) = REQUIRED];
396*d5c09012SAndroid Build Coastguard Worker
397*d5c09012SAndroid Build Coastguard Worker  // Optional. The mask to control which fields get updated.
398*d5c09012SAndroid Build Coastguard Worker  google.protobuf.FieldMask update_mask = 2;
399*d5c09012SAndroid Build Coastguard Worker}
400*d5c09012SAndroid Build Coastguard Worker
401*d5c09012SAndroid Build Coastguard Worker// The request message for
402*d5c09012SAndroid Build Coastguard Worker// [Agents.DeleteAgent][google.cloud.dialogflow.v2beta1.Agents.DeleteAgent].
403*d5c09012SAndroid Build Coastguard Workermessage DeleteAgentRequest {
404*d5c09012SAndroid Build Coastguard Worker  // Required. The project that the agent to delete is associated with.
405*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
406*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`.
407*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
408*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
409*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
410*d5c09012SAndroid Build Coastguard Worker      child_type: "dialogflow.googleapis.com/Agent"
411*d5c09012SAndroid Build Coastguard Worker    }
412*d5c09012SAndroid Build Coastguard Worker  ];
413*d5c09012SAndroid Build Coastguard Worker}
414*d5c09012SAndroid Build Coastguard Worker
415*d5c09012SAndroid Build Coastguard Worker// Contains basic configuration for a sub-agent.
416*d5c09012SAndroid Build Coastguard Workermessage SubAgent {
417*d5c09012SAndroid Build Coastguard Worker  // Required. The project of this agent.
418*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
419*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`.
420*d5c09012SAndroid Build Coastguard Worker  string project = 1;
421*d5c09012SAndroid Build Coastguard Worker
422*d5c09012SAndroid Build Coastguard Worker  // Optional. The unique identifier (`environment name` in dialogflow console)
423*d5c09012SAndroid Build Coastguard Worker  // of this sub-agent environment. Assumes draft environment if `environment`
424*d5c09012SAndroid Build Coastguard Worker  // is not set.
425*d5c09012SAndroid Build Coastguard Worker  string environment = 2;
426*d5c09012SAndroid Build Coastguard Worker}
427*d5c09012SAndroid Build Coastguard Worker
428*d5c09012SAndroid Build Coastguard Worker// The request message for
429*d5c09012SAndroid Build Coastguard Worker// [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].
430*d5c09012SAndroid Build Coastguard Workermessage SearchAgentsRequest {
431*d5c09012SAndroid Build Coastguard Worker  // Required. The project to list agents from.
432*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID or '-'>` or
433*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID or '-'>/locations/<Location ID>`.
434*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
435*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
436*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
437*d5c09012SAndroid Build Coastguard Worker      child_type: "dialogflow.googleapis.com/Agent"
438*d5c09012SAndroid Build Coastguard Worker    }
439*d5c09012SAndroid Build Coastguard Worker  ];
440*d5c09012SAndroid Build Coastguard Worker
441*d5c09012SAndroid Build Coastguard Worker  // Optional. The maximum number of items to return in a single page. By
442*d5c09012SAndroid Build Coastguard Worker  // default 100 and at most 1000.
443*d5c09012SAndroid Build Coastguard Worker  int32 page_size = 2;
444*d5c09012SAndroid Build Coastguard Worker
445*d5c09012SAndroid Build Coastguard Worker  // Optional. The next_page_token value returned from a previous list request.
446*d5c09012SAndroid Build Coastguard Worker  string page_token = 3;
447*d5c09012SAndroid Build Coastguard Worker}
448*d5c09012SAndroid Build Coastguard Worker
449*d5c09012SAndroid Build Coastguard Worker// The response message for
450*d5c09012SAndroid Build Coastguard Worker// [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].
451*d5c09012SAndroid Build Coastguard Workermessage SearchAgentsResponse {
452*d5c09012SAndroid Build Coastguard Worker  // The list of agents. There will be a maximum number of items returned based
453*d5c09012SAndroid Build Coastguard Worker  // on the page_size field in the request.
454*d5c09012SAndroid Build Coastguard Worker  repeated Agent agents = 1;
455*d5c09012SAndroid Build Coastguard Worker
456*d5c09012SAndroid Build Coastguard Worker  // Token to retrieve the next page of results, or empty if there are no
457*d5c09012SAndroid Build Coastguard Worker  // more results in the list.
458*d5c09012SAndroid Build Coastguard Worker  string next_page_token = 2;
459*d5c09012SAndroid Build Coastguard Worker}
460*d5c09012SAndroid Build Coastguard Worker
461*d5c09012SAndroid Build Coastguard Worker// The request message for
462*d5c09012SAndroid Build Coastguard Worker// [Agents.TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent].
463*d5c09012SAndroid Build Coastguard Workermessage TrainAgentRequest {
464*d5c09012SAndroid Build Coastguard Worker  // Required. The project that the agent to train is associated with.
465*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
466*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`.
467*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
468*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
469*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
470*d5c09012SAndroid Build Coastguard Worker      child_type: "dialogflow.googleapis.com/Agent"
471*d5c09012SAndroid Build Coastguard Worker    }
472*d5c09012SAndroid Build Coastguard Worker  ];
473*d5c09012SAndroid Build Coastguard Worker}
474*d5c09012SAndroid Build Coastguard Worker
475*d5c09012SAndroid Build Coastguard Worker// The request message for
476*d5c09012SAndroid Build Coastguard Worker// [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent].
477*d5c09012SAndroid Build Coastguard Workermessage ExportAgentRequest {
478*d5c09012SAndroid Build Coastguard Worker  // Required. The project that the agent to export is associated with.
479*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
480*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`.
481*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
482*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
483*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
484*d5c09012SAndroid Build Coastguard Worker      child_type: "dialogflow.googleapis.com/Agent"
485*d5c09012SAndroid Build Coastguard Worker    }
486*d5c09012SAndroid Build Coastguard Worker  ];
487*d5c09012SAndroid Build Coastguard Worker
488*d5c09012SAndroid Build Coastguard Worker  // Optional. The
489*d5c09012SAndroid Build Coastguard Worker  // [Google Cloud Storage](https://cloud.google.com/storage/docs/)
490*d5c09012SAndroid Build Coastguard Worker  // URI to export the agent to.
491*d5c09012SAndroid Build Coastguard Worker  // The format of this URI must be `gs://<bucket-name>/<object-name>`.
492*d5c09012SAndroid Build Coastguard Worker  // If left unspecified, the serialized agent is returned inline.
493*d5c09012SAndroid Build Coastguard Worker  //
494*d5c09012SAndroid Build Coastguard Worker  // Dialogflow performs a write operation for the Cloud Storage object
495*d5c09012SAndroid Build Coastguard Worker  // on the caller's behalf, so your request authentication must
496*d5c09012SAndroid Build Coastguard Worker  // have write permissions for the object. For more information, see
497*d5c09012SAndroid Build Coastguard Worker  // [Dialogflow access
498*d5c09012SAndroid Build Coastguard Worker  // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
499*d5c09012SAndroid Build Coastguard Worker  string agent_uri = 2;
500*d5c09012SAndroid Build Coastguard Worker}
501*d5c09012SAndroid Build Coastguard Worker
502*d5c09012SAndroid Build Coastguard Worker// The response message for
503*d5c09012SAndroid Build Coastguard Worker// [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent].
504*d5c09012SAndroid Build Coastguard Workermessage ExportAgentResponse {
505*d5c09012SAndroid Build Coastguard Worker  // The exported agent.
506*d5c09012SAndroid Build Coastguard Worker  oneof agent {
507*d5c09012SAndroid Build Coastguard Worker    // The URI to a file containing the exported agent. This field is populated
508*d5c09012SAndroid Build Coastguard Worker    // only if `agent_uri` is specified in `ExportAgentRequest`.
509*d5c09012SAndroid Build Coastguard Worker    string agent_uri = 1;
510*d5c09012SAndroid Build Coastguard Worker
511*d5c09012SAndroid Build Coastguard Worker    // Zip compressed raw byte content for agent.
512*d5c09012SAndroid Build Coastguard Worker    bytes agent_content = 2;
513*d5c09012SAndroid Build Coastguard Worker  }
514*d5c09012SAndroid Build Coastguard Worker}
515*d5c09012SAndroid Build Coastguard Worker
516*d5c09012SAndroid Build Coastguard Worker// The request message for
517*d5c09012SAndroid Build Coastguard Worker// [Agents.ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent].
518*d5c09012SAndroid Build Coastguard Workermessage ImportAgentRequest {
519*d5c09012SAndroid Build Coastguard Worker  // Required. The project that the agent to import is associated with.
520*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
521*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`.
522*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
523*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
524*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
525*d5c09012SAndroid Build Coastguard Worker      child_type: "dialogflow.googleapis.com/Agent"
526*d5c09012SAndroid Build Coastguard Worker    }
527*d5c09012SAndroid Build Coastguard Worker  ];
528*d5c09012SAndroid Build Coastguard Worker
529*d5c09012SAndroid Build Coastguard Worker  // Required. The agent to import.
530*d5c09012SAndroid Build Coastguard Worker  oneof agent {
531*d5c09012SAndroid Build Coastguard Worker    // The URI to a Google Cloud Storage file containing the agent to import.
532*d5c09012SAndroid Build Coastguard Worker    // Note: The URI must start with "gs://".
533*d5c09012SAndroid Build Coastguard Worker    //
534*d5c09012SAndroid Build Coastguard Worker    // Dialogflow performs a read operation for the Cloud Storage object
535*d5c09012SAndroid Build Coastguard Worker    // on the caller's behalf, so your request authentication must
536*d5c09012SAndroid Build Coastguard Worker    // have read permissions for the object. For more information, see
537*d5c09012SAndroid Build Coastguard Worker    // [Dialogflow access
538*d5c09012SAndroid Build Coastguard Worker    // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
539*d5c09012SAndroid Build Coastguard Worker    string agent_uri = 2;
540*d5c09012SAndroid Build Coastguard Worker
541*d5c09012SAndroid Build Coastguard Worker    // Zip compressed raw byte content for agent.
542*d5c09012SAndroid Build Coastguard Worker    bytes agent_content = 3;
543*d5c09012SAndroid Build Coastguard Worker  }
544*d5c09012SAndroid Build Coastguard Worker}
545*d5c09012SAndroid Build Coastguard Worker
546*d5c09012SAndroid Build Coastguard Worker// The request message for
547*d5c09012SAndroid Build Coastguard Worker// [Agents.RestoreAgent][google.cloud.dialogflow.v2beta1.Agents.RestoreAgent].
548*d5c09012SAndroid Build Coastguard Workermessage RestoreAgentRequest {
549*d5c09012SAndroid Build Coastguard Worker  // Required. The project that the agent to restore is associated with.
550*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
551*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`.
552*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
553*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
554*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
555*d5c09012SAndroid Build Coastguard Worker      child_type: "dialogflow.googleapis.com/Agent"
556*d5c09012SAndroid Build Coastguard Worker    }
557*d5c09012SAndroid Build Coastguard Worker  ];
558*d5c09012SAndroid Build Coastguard Worker
559*d5c09012SAndroid Build Coastguard Worker  // Required. The agent to restore.
560*d5c09012SAndroid Build Coastguard Worker  oneof agent {
561*d5c09012SAndroid Build Coastguard Worker    // The URI to a Google Cloud Storage file containing the agent to restore.
562*d5c09012SAndroid Build Coastguard Worker    // Note: The URI must start with "gs://".
563*d5c09012SAndroid Build Coastguard Worker    //
564*d5c09012SAndroid Build Coastguard Worker    // Dialogflow performs a read operation for the Cloud Storage object
565*d5c09012SAndroid Build Coastguard Worker    // on the caller's behalf, so your request authentication must
566*d5c09012SAndroid Build Coastguard Worker    // have read permissions for the object. For more information, see
567*d5c09012SAndroid Build Coastguard Worker    // [Dialogflow access
568*d5c09012SAndroid Build Coastguard Worker    // control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
569*d5c09012SAndroid Build Coastguard Worker    string agent_uri = 2;
570*d5c09012SAndroid Build Coastguard Worker
571*d5c09012SAndroid Build Coastguard Worker    // Zip compressed raw byte content for agent.
572*d5c09012SAndroid Build Coastguard Worker    bytes agent_content = 3;
573*d5c09012SAndroid Build Coastguard Worker  }
574*d5c09012SAndroid Build Coastguard Worker}
575*d5c09012SAndroid Build Coastguard Worker
576*d5c09012SAndroid Build Coastguard Worker// The request message for
577*d5c09012SAndroid Build Coastguard Worker// [Agents.GetValidationResult][google.cloud.dialogflow.v2beta1.Agents.GetValidationResult].
578*d5c09012SAndroid Build Coastguard Workermessage GetValidationResultRequest {
579*d5c09012SAndroid Build Coastguard Worker  // Required. The project that the agent is associated with.
580*d5c09012SAndroid Build Coastguard Worker  // Format: `projects/<Project ID>` or
581*d5c09012SAndroid Build Coastguard Worker  //         `projects/<Project ID>/locations/<Location ID>`.
582*d5c09012SAndroid Build Coastguard Worker  string parent = 1 [
583*d5c09012SAndroid Build Coastguard Worker    (google.api.field_behavior) = REQUIRED,
584*d5c09012SAndroid Build Coastguard Worker    (google.api.resource_reference) = {
585*d5c09012SAndroid Build Coastguard Worker      child_type: "dialogflow.googleapis.com/Agent"
586*d5c09012SAndroid Build Coastguard Worker    }
587*d5c09012SAndroid Build Coastguard Worker  ];
588*d5c09012SAndroid Build Coastguard Worker
589*d5c09012SAndroid Build Coastguard Worker  // Optional. The language for which you want a validation result. If not
590*d5c09012SAndroid Build Coastguard Worker  // specified, the agent's default language is used. [Many
591*d5c09012SAndroid Build Coastguard Worker  // languages](https://cloud.google.com/dialogflow/docs/reference/language)
592*d5c09012SAndroid Build Coastguard Worker  // are supported. Note: languages must be enabled in the agent before they can
593*d5c09012SAndroid Build Coastguard Worker  // be used.
594*d5c09012SAndroid Build Coastguard Worker  string language_code = 3 [(google.api.field_behavior) = OPTIONAL];
595*d5c09012SAndroid Build Coastguard Worker}
596