Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dialogflow_v2beta1.projects.agent.html
blob: f81a7dcd2f7a8e157a268830a2dcf90fd94e1f30 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.agent.html">agent</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="dialogflow_v2beta1.projects.agent.entityTypes.html">entityTypes()</a></code>
79</p>
80<p class="firstline">Returns the entityTypes Resource.</p>
81
82<p class="toc_element">
83 <code><a href="dialogflow_v2beta1.projects.agent.environments.html">environments()</a></code>
84</p>
85<p class="firstline">Returns the environments Resource.</p>
86
87<p class="toc_element">
88 <code><a href="dialogflow_v2beta1.projects.agent.intents.html">intents()</a></code>
89</p>
90<p class="firstline">Returns the intents Resource.</p>
91
92<p class="toc_element">
93 <code><a href="dialogflow_v2beta1.projects.agent.knowledgeBases.html">knowledgeBases()</a></code>
94</p>
95<p class="firstline">Returns the knowledgeBases Resource.</p>
96
97<p class="toc_element">
98 <code><a href="dialogflow_v2beta1.projects.agent.sessions.html">sessions()</a></code>
99</p>
100<p class="firstline">Returns the sessions Resource.</p>
101
102<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104<p class="firstline">Exports the specified agent to a ZIP file.</p>
105<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]106 <code><a href="#getFulfillment">getFulfillment(name, x__xgafv=None)</a></code></p>
107<p class="firstline">Retrieves the fulfillment.</p>
108<p class="toc_element">
109 <code><a href="#getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</a></code></p>
110<p class="firstline">Gets agent validation result. Agent validation is performed during</p>
111<p class="toc_element">
112 <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113<p class="firstline">Imports the specified agent from a ZIP file.</p>
114<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115 <code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116<p class="firstline">Restores the specified agent from a ZIP file.</p>
117<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 <code><a href="#search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119<p class="firstline">Returns the list of agents.</p>
120<p class="toc_element">
121 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
122<p class="firstline">Retrieves the next page of results.</p>
123<p class="toc_element">
124 <code><a href="#train">train(parent, body=None, x__xgafv=None)</a></code></p>
125<p class="firstline">Trains the specified agent.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126<p class="toc_element">
127 <code><a href="#updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
128<p class="firstline">Updates the fulfillment.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129<h3>Method Details</h3>
130<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 <code class="details" id="export">export(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 <pre>Exports the specified agent to a ZIP file.
133
134
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135Operation &lt;response: ExportAgentResponse&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136
137Args:
138 parent: string, Required. The project that the agent to export is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]139Format: `projects/&lt;Project ID&gt;`. (required)
140 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 The object takes the form of:
142
143{ # The request message for Agents.ExportAgent.
144 "agentUri": "A String", # Optional. The
145 # [Google Cloud Storage](https://cloud.google.com/storage/docs/)
146 # URI to export the agent to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147 # The format of this URI must be `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 # If left unspecified, the serialized agent is returned inline.
149 }
150
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156Returns:
157 An object of the form:
158
159 { # This resource represents a long-running operation that is the result of a
160 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]161 "response": { # The normal response of the operation in case of success. If the original
162 # method returns no data on success, such as `Delete`, the response is
163 # `google.protobuf.Empty`. If the original method is standard
164 # `Get`/`Create`/`Update`, the response should be the resource. For other
165 # methods, the response should have the type `XxxResponse`, where `Xxx`
166 # is the original method name. For example, if the original method name
167 # is `TakeSnapshot()`, the inferred response type is
168 # `TakeSnapshotResponse`.
169 "a_key": "", # Properties of the object. Contains field @type with type URL.
170 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 "metadata": { # Service-specific metadata associated with the operation. It typically
172 # contains progress information and common metadata such as create time.
173 # Some services might not provide such metadata. Any method that returns a
174 # long-running operation should document the metadata type, if any.
175 "a_key": "", # Properties of the object. Contains field @type with type URL.
176 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 "done": True or False, # If the value is `false`, it means the operation is still in progress.
178 # If `true`, the operation is completed, and either `error` or `response` is
179 # available.
180 "name": "A String", # The server-assigned name, which is only unique within the same service that
181 # originally returns it. If you use the default HTTP mapping, the
182 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
184 # different programming environments, including REST APIs and RPC APIs. It is
185 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
186 # three pieces of data: error code, error message, and error details.
187 #
188 # You can find out more about this error model and how to work with it in the
189 # [API Design Guide](https://cloud.google.com/apis/design/errors).
190 "message": "A String", # A developer-facing error message, which should be in English. Any
191 # user-facing error message should be localized and sent in the
192 # google.rpc.Status.details field, or localized by the client.
193 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
194 "details": [ # A list of messages that carry the error details. There is a common set of
195 # message types for APIs to use.
196 {
197 "a_key": "", # Properties of the object. Contains field @type with type URL.
198 },
199 ],
200 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 }</pre>
202</div>
203
204<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 <code class="details" id="getFulfillment">getFulfillment(name, x__xgafv=None)</code>
206 <pre>Retrieves the fulfillment.
207
208Args:
209 name: string, Required. The name of the fulfillment.
210Format: `projects/&lt;Project ID&gt;/agent/fulfillment`. (required)
211 x__xgafv: string, V1 error format.
212 Allowed values
213 1 - v1 error format
214 2 - v2 error format
215
216Returns:
217 An object of the form:
218
219 { # Represents a fulfillment.
220 "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
221 # Dialogflow supports two mechanisms for authentications:
222 # - Basic authentication with username and password.
223 # - Authentication with additional authentication headers.
224 # More information could be found at:
225 # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
226 "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions
227 # integration. Defaults to false.
228 "username": "A String", # Optional. The user name for HTTP Basic authentication.
229 "password": "A String", # Optional. The password for HTTP Basic authentication.
230 "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
231 "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
232 "a_key": "A String",
233 },
234 },
235 "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
236 "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
237 { # Whether fulfillment is enabled for the specific feature.
238 "type": "A String", # The type of the feature that enabled for fulfillment.
239 },
240 ],
241 "enabled": True or False, # Optional. Whether fulfillment is enabled.
242 "name": "A String", # Required. The unique identifier of the fulfillment.
243 # Format: `projects/&lt;Project ID&gt;/agent/fulfillment`.
244 }</pre>
245</div>
246
247<div class="method">
248 <code class="details" id="getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</code>
249 <pre>Gets agent validation result. Agent validation is performed during
250training time and is updated automatically when training is completed.
251
252Args:
253 parent: string, Required. The project that the agent is associated with.
254Format: `projects/&lt;Project ID&gt;`. (required)
255 languageCode: string, Optional. The language for which you want a validation result. If not
256specified, the agent's default language is used. [Many
257languages](https://cloud.google.com/dialogflow/docs/reference/language)
258are supported. Note: languages must be enabled in the agent before they can
259be used.
260 x__xgafv: string, V1 error format.
261 Allowed values
262 1 - v1 error format
263 2 - v2 error format
264
265Returns:
266 An object of the form:
267
268 { # Represents the output of agent validation.
269 "validationErrors": [ # Contains all validation errors.
270 { # Represents a single validation error.
271 "errorMessage": "A String", # The detailed error messsage.
272 "severity": "A String", # The severity of the error.
273 "entries": [ # The names of the entries that the error is associated with.
274 # Format:
275 #
276 # - "projects/&lt;Project ID&gt;/agent", if the error is associated with the entire
277 # agent.
278 # - "projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;", if the error is
279 # associated with certain intents.
280 # - "projects/&lt;Project
281 # ID&gt;/agent/intents/&lt;Intent Id&gt;/trainingPhrases/&lt;Training Phrase ID&gt;", if the
282 # error is associated with certain intent training phrases.
283 # - "projects/&lt;Project ID&gt;/agent/intents/&lt;Intent Id&gt;/parameters/&lt;Parameter
284 # ID&gt;", if the error is associated with certain intent parameters.
285 # - "projects/&lt;Project ID&gt;/agent/entities/&lt;Entity ID&gt;", if the error is
286 # associated with certain entities.
287 "A String",
288 ],
289 },
290 ],
291 }</pre>
292</div>
293
294<div class="method">
295 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 <pre>Imports the specified agent from a ZIP file.
297
298Uploads new intents and entity types without deleting the existing ones.
299Intents and entity types with the same name are replaced with the new
300versions from ImportAgentRequest.
301
302
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]303Operation &lt;response: google.protobuf.Empty&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304
305Args:
306 parent: string, Required. The project that the agent to import is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]307Format: `projects/&lt;Project ID&gt;`. (required)
308 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]309 The object takes the form of:
310
311{ # The request message for Agents.ImportAgent.
312 "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to import.
313 # Note: The URI must start with "gs://".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]314 "agentContent": "A String", # Zip compressed raw byte content for agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]315 }
316
317 x__xgafv: string, V1 error format.
318 Allowed values
319 1 - v1 error format
320 2 - v2 error format
321
322Returns:
323 An object of the form:
324
325 { # This resource represents a long-running operation that is the result of a
326 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]327 "response": { # The normal response of the operation in case of success. If the original
328 # method returns no data on success, such as `Delete`, the response is
329 # `google.protobuf.Empty`. If the original method is standard
330 # `Get`/`Create`/`Update`, the response should be the resource. For other
331 # methods, the response should have the type `XxxResponse`, where `Xxx`
332 # is the original method name. For example, if the original method name
333 # is `TakeSnapshot()`, the inferred response type is
334 # `TakeSnapshotResponse`.
335 "a_key": "", # Properties of the object. Contains field @type with type URL.
336 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]337 "metadata": { # Service-specific metadata associated with the operation. It typically
338 # contains progress information and common metadata such as create time.
339 # Some services might not provide such metadata. Any method that returns a
340 # long-running operation should document the metadata type, if any.
341 "a_key": "", # Properties of the object. Contains field @type with type URL.
342 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]343 "done": True or False, # If the value is `false`, it means the operation is still in progress.
344 # If `true`, the operation is completed, and either `error` or `response` is
345 # available.
346 "name": "A String", # The server-assigned name, which is only unique within the same service that
347 # originally returns it. If you use the default HTTP mapping, the
348 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
350 # different programming environments, including REST APIs and RPC APIs. It is
351 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
352 # three pieces of data: error code, error message, and error details.
353 #
354 # You can find out more about this error model and how to work with it in the
355 # [API Design Guide](https://cloud.google.com/apis/design/errors).
356 "message": "A String", # A developer-facing error message, which should be in English. Any
357 # user-facing error message should be localized and sent in the
358 # google.rpc.Status.details field, or localized by the client.
359 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
360 "details": [ # A list of messages that carry the error details. There is a common set of
361 # message types for APIs to use.
362 {
363 "a_key": "", # Properties of the object. Contains field @type with type URL.
364 },
365 ],
366 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]367 }</pre>
368</div>
369
370<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]371 <code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]372 <pre>Restores the specified agent from a ZIP file.
373
374Replaces the current agent version with a new one. All the intents and
375entity types in the older version are deleted.
376
377
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]378Operation &lt;response: google.protobuf.Empty&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]379
380Args:
381 parent: string, Required. The project that the agent to restore is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]382Format: `projects/&lt;Project ID&gt;`. (required)
383 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]384 The object takes the form of:
385
386{ # The request message for Agents.RestoreAgent.
387 "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to restore.
388 # Note: The URI must start with "gs://".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]389 "agentContent": "A String", # Zip compressed raw byte content for agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 }
391
392 x__xgafv: string, V1 error format.
393 Allowed values
394 1 - v1 error format
395 2 - v2 error format
396
397Returns:
398 An object of the form:
399
400 { # This resource represents a long-running operation that is the result of a
401 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]402 "response": { # The normal response of the operation in case of success. If the original
403 # method returns no data on success, such as `Delete`, the response is
404 # `google.protobuf.Empty`. If the original method is standard
405 # `Get`/`Create`/`Update`, the response should be the resource. For other
406 # methods, the response should have the type `XxxResponse`, where `Xxx`
407 # is the original method name. For example, if the original method name
408 # is `TakeSnapshot()`, the inferred response type is
409 # `TakeSnapshotResponse`.
410 "a_key": "", # Properties of the object. Contains field @type with type URL.
411 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 "metadata": { # Service-specific metadata associated with the operation. It typically
413 # contains progress information and common metadata such as create time.
414 # Some services might not provide such metadata. Any method that returns a
415 # long-running operation should document the metadata type, if any.
416 "a_key": "", # Properties of the object. Contains field @type with type URL.
417 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 "done": True or False, # If the value is `false`, it means the operation is still in progress.
419 # If `true`, the operation is completed, and either `error` or `response` is
420 # available.
421 "name": "A String", # The server-assigned name, which is only unique within the same service that
422 # originally returns it. If you use the default HTTP mapping, the
423 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
425 # different programming environments, including REST APIs and RPC APIs. It is
426 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
427 # three pieces of data: error code, error message, and error details.
428 #
429 # You can find out more about this error model and how to work with it in the
430 # [API Design Guide](https://cloud.google.com/apis/design/errors).
431 "message": "A String", # A developer-facing error message, which should be in English. Any
432 # user-facing error message should be localized and sent in the
433 # google.rpc.Status.details field, or localized by the client.
434 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
435 "details": [ # A list of messages that carry the error details. There is a common set of
436 # message types for APIs to use.
437 {
438 "a_key": "", # Properties of the object. Contains field @type with type URL.
439 },
440 ],
441 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]442 }</pre>
443</div>
444
445<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]446 <code class="details" id="search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]447 <pre>Returns the list of agents.
448
449Since there is at most one conversational agent per project, this method is
450useful primarily for listing all agents across projects the caller has
451access to. One can achieve that with a wildcard project collection id "-".
452Refer to [List
453Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
454
455Args:
456 parent: string, Required. The project to list agents from.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]457Format: `projects/&lt;Project ID or '-'&gt;`. (required)
458 pageSize: integer, Optional. The maximum number of items to return in a single page. By
459default 100 and at most 1000.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]460 pageToken: string, Optional. The next_page_token value returned from a previous list request.
461 x__xgafv: string, V1 error format.
462 Allowed values
463 1 - v1 error format
464 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]465
466Returns:
467 An object of the form:
468
469 { # The response message for Agents.SearchAgents.
470 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
471 # more results in the list.
472 "agents": [ # The list of agents. There will be a maximum number of items returned based
473 # on the page_size field in the request.
474 { # Represents a conversational agent.
475 "avatarUri": "A String", # Optional. The URI of the agent's avatar.
476 # Avatars are used throughout the Dialogflow console and in the self-hosted
477 # [Web
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]478 # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479 # integration.
480 "displayName": "A String", # Required. The name of this agent.
481 "description": "A String", # Optional. The description of this agent.
482 # The maximum length is 500 characters. If exceeded, the request is rejected.
483 "parent": "A String", # Required. The project of this agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]484 # Format: `projects/&lt;Project ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
486 # [Language
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]487 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]488 # for a list of the currently supported language codes. This field cannot be
489 # set by the `Update` method.
490 "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
491 # V2 API is assumed. Clients are free to query different service endpoints
492 # for different API versions. However, bots connectors and webhook calls will
493 # follow the specified API version.
494 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
495 "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
496 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
497 # `default_language_code`).
498 "A String",
499 ],
500 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
501 "timeZone": "A String", # Required. The time zone of this agent from the
502 # [time zone database](https://www.iana.org/time-zones), e.g.,
503 # America/New_York, Europe/Paris.
504 "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
505 # matched natural language inputs for your agent, you can tune the machine
506 # learning classification threshold. If the returned score value is less than
507 # the threshold value, then a fallback intent will be triggered or, if there
508 # are no fallback intents defined, no intent will be triggered. The score
509 # values range from 0.0 (completely uncertain) to 1.0 (completely certain).
510 # If set to 0.0, the default of 0.3 is used.
511 },
512 ],
513 }</pre>
514</div>
515
516<div class="method">
517 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
518 <pre>Retrieves the next page of results.
519
520Args:
521 previous_request: The request for the previous page. (required)
522 previous_response: The response from the request for the previous page. (required)
523
524Returns:
525 A request object that you can call 'execute()' on to request the next
526 page. Returns None if there are no more items in the collection.
527 </pre>
528</div>
529
530<div class="method">
531 <code class="details" id="train">train(parent, body=None, x__xgafv=None)</code>
532 <pre>Trains the specified agent.
533
534
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]535Operation &lt;response: google.protobuf.Empty&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]536
537Args:
538 parent: string, Required. The project that the agent to train is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]539Format: `projects/&lt;Project ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]540 body: object, The request body.
541 The object takes the form of:
542
543{ # The request message for Agents.TrainAgent.
544 }
545
546 x__xgafv: string, V1 error format.
547 Allowed values
548 1 - v1 error format
549 2 - v2 error format
550
551Returns:
552 An object of the form:
553
554 { # This resource represents a long-running operation that is the result of a
555 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]556 "response": { # The normal response of the operation in case of success. If the original
557 # method returns no data on success, such as `Delete`, the response is
558 # `google.protobuf.Empty`. If the original method is standard
559 # `Get`/`Create`/`Update`, the response should be the resource. For other
560 # methods, the response should have the type `XxxResponse`, where `Xxx`
561 # is the original method name. For example, if the original method name
562 # is `TakeSnapshot()`, the inferred response type is
563 # `TakeSnapshotResponse`.
564 "a_key": "", # Properties of the object. Contains field @type with type URL.
565 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]566 "metadata": { # Service-specific metadata associated with the operation. It typically
567 # contains progress information and common metadata such as create time.
568 # Some services might not provide such metadata. Any method that returns a
569 # long-running operation should document the metadata type, if any.
570 "a_key": "", # Properties of the object. Contains field @type with type URL.
571 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]572 "done": True or False, # If the value is `false`, it means the operation is still in progress.
573 # If `true`, the operation is completed, and either `error` or `response` is
574 # available.
575 "name": "A String", # The server-assigned name, which is only unique within the same service that
576 # originally returns it. If you use the default HTTP mapping, the
577 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]578 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
579 # different programming environments, including REST APIs and RPC APIs. It is
580 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
581 # three pieces of data: error code, error message, and error details.
582 #
583 # You can find out more about this error model and how to work with it in the
584 # [API Design Guide](https://cloud.google.com/apis/design/errors).
585 "message": "A String", # A developer-facing error message, which should be in English. Any
586 # user-facing error message should be localized and sent in the
587 # google.rpc.Status.details field, or localized by the client.
588 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
589 "details": [ # A list of messages that carry the error details. There is a common set of
590 # message types for APIs to use.
591 {
592 "a_key": "", # Properties of the object. Contains field @type with type URL.
593 },
594 ],
595 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]596 }</pre>
597</div>
598
599<div class="method">
600 <code class="details" id="updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</code>
601 <pre>Updates the fulfillment.
602
603Args:
604 name: string, Required. The unique identifier of the fulfillment.
605Format: `projects/&lt;Project ID&gt;/agent/fulfillment`. (required)
606 body: object, The request body.
607 The object takes the form of:
608
609{ # Represents a fulfillment.
610 "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
611 # Dialogflow supports two mechanisms for authentications:
612 # - Basic authentication with username and password.
613 # - Authentication with additional authentication headers.
614 # More information could be found at:
615 # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
616 "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions
617 # integration. Defaults to false.
618 "username": "A String", # Optional. The user name for HTTP Basic authentication.
619 "password": "A String", # Optional. The password for HTTP Basic authentication.
620 "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
621 "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
622 "a_key": "A String",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]623 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]624 },
625 "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
626 "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
627 { # Whether fulfillment is enabled for the specific feature.
628 "type": "A String", # The type of the feature that enabled for fulfillment.
629 },
630 ],
631 "enabled": True or False, # Optional. Whether fulfillment is enabled.
632 "name": "A String", # Required. The unique identifier of the fulfillment.
633 # Format: `projects/&lt;Project ID&gt;/agent/fulfillment`.
634}
635
636 updateMask: string, Required. The mask to control which fields get updated. If the mask is not
637present, all fields will be updated.
638 x__xgafv: string, V1 error format.
639 Allowed values
640 1 - v1 error format
641 2 - v2 error format
642
643Returns:
644 An object of the form:
645
646 { # Represents a fulfillment.
647 "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
648 # Dialogflow supports two mechanisms for authentications:
649 # - Basic authentication with username and password.
650 # - Authentication with additional authentication headers.
651 # More information could be found at:
652 # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
653 "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions
654 # integration. Defaults to false.
655 "username": "A String", # Optional. The user name for HTTP Basic authentication.
656 "password": "A String", # Optional. The password for HTTP Basic authentication.
657 "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
658 "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
659 "a_key": "A String",
660 },
661 },
662 "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
663 "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
664 { # Whether fulfillment is enabled for the specific feature.
665 "type": "A String", # The type of the feature that enabled for fulfillment.
666 },
667 ],
668 "enabled": True or False, # Optional. Whether fulfillment is enabled.
669 "name": "A String", # Required. The unique identifier of the fulfillment.
670 # Format: `projects/&lt;Project ID&gt;/agent/fulfillment`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]671 }</pre>
672</div>
673
674</body></html>