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