Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / dialogflow_v2.projects.agent.intents.html
blob: 93f01d858b3fa858b7898c60d7dde97fee273b3b [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> . <a href="dialogflow_v2.projects.agent.intents.html">intents</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#batchDelete">batchDelete(parent, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes intents in the specified agent.</p>
80<p class="toc_element">
81 <code><a href="#batchUpdate">batchUpdate(parent, body, x__xgafv=None)</a></code></p>
82<p class="firstline">Updates/Creates multiple intents in the specified agent.</p>
83<p class="toc_element">
84 <code><a href="#create">create(parent, body, languageCode=None, intentView=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Creates an intent in the specified agent.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Deletes the specified intent and its direct or indirect followup intents.</p>
89<p class="toc_element">
90 <code><a href="#get">get(name, languageCode=None, intentView=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Retrieves the specified intent.</p>
92<p class="toc_element">
93 <code><a href="#list">list(parent, languageCode=None, pageSize=None, intentView=None, pageToken=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Returns the list of all intents in the specified agent.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99 <code><a href="#patch">patch(name, body, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Updates the specified intent.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="batchDelete">batchDelete(parent, body, x__xgafv=None)</code>
104 <pre>Deletes intents in the specified agent.
105
106Operation <response: google.protobuf.Empty>
107
108Args:
109 parent: string, Required. The name of the agent to delete all entities types for. Format:
110`projects/<Project ID>/agent`. (required)
111 body: object, The request body. (required)
112 The object takes the form of:
113
114{ # The request message for Intents.BatchDeleteIntents.
115 "intents": [ # Required. The collection of intents to delete. Only intent `name` must be
116 # filled in.
117 { # Represents an intent.
118 # Intents convert a number of user expressions or patterns into an action. An
119 # action is an extraction of a user command or sentence semantics.
120 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
121 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
122 # Note: If `ml_diabled` setting is set to true, then this intent is not
123 # taken into account during inference in `ML ONLY` match mode. Also,
124 # auto-markup in the UI is turned off.
125 "displayName": "A String", # Required. The name of this intent.
126 "name": "A String", # The unique identifier of this intent.
127 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
128 # methods.
129 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
130 "parameters": [ # Optional. The collection of parameters associated with the intent.
131 { # Represents intent parameters.
132 "displayName": "A String", # Required. The name of the parameter.
133 "name": "A String", # The unique identifier of this parameter.
134 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
135 # result.
136 # Default values can be extracted from contexts by using the following
137 # syntax: `#context_name.parameter_name`.
138 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
139 # describes values of the parameter. If the parameter is
140 # required, this must be provided.
141 "value": "A String", # Optional. The definition of the parameter value. It can be:
142 # - a constant string,
143 # - a parameter value defined as `$parameter_name`,
144 # - an original parameter value defined as `$parameter_name.original`,
145 # - a parameter value from some context defined as
146 # `#context_name.parameter_name`.
147 "prompts": [ # Optional. The collection of prompts that the agent can present to the
148 # user in order to collect value for the parameter.
149 "A String",
150 ],
151 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
152 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
153 # whether the intent cannot be completed without collecting the parameter
154 # value.
155 },
156 ],
157 "trainingPhrases": [ # Optional. The collection of examples that the agent is
158 # trained on.
159 { # Represents an example that the agent is trained on.
160 "parts": [ # Required. The ordered list of training phrase parts.
161 # The parts are concatenated in order to form the training phrase.
162 #
163 # Note: The API does not automatically annotate training phrases like the
164 # Dialogflow Console does.
165 #
166 # Note: Do not forget to include whitespace at part boundaries,
167 # so the training phrase is well formatted when the parts are concatenated.
168 #
169 # If the training phrase does not need to be annotated with parameters,
170 # you just need a single part with only the Part.text field set.
171 #
172 # If you want to annotate the training phrase, you must create multiple
173 # parts, where the fields of each part are populated in one of two ways:
174 #
175 # - `Part.text` is set to a part of the phrase that has no parameters.
176 # - `Part.text` is set to a part of the phrase that you want to annotate,
177 # and the `entity_type`, `alias`, and `user_defined` fields are all
178 # set.
179 { # Represents a part of a training phrase.
180 "alias": "A String", # Optional. The parameter name for the value extracted from the
181 # annotated part of the example.
182 # This field is required for annotated parts of the training phrase.
183 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
184 # This field is required for annotated parts of the training phrase.
185 "text": "A String", # Required. The text for this part.
186 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
187 # This field is set to true when the Dialogflow Console is used to
188 # manually annotate the part. When creating an annotated part with the
189 # API, you must set this to true.
190 },
191 ],
192 "type": "A String", # Required. The type of the training phrase.
193 "name": "A String", # Output only. The unique identifier of this training phrase.
194 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
195 # the intent. Each time a developer adds an existing sample by editing an
196 # intent or training, this counter is increased.
197 },
198 ],
199 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
200 # a direct or indirect parent. We populate this field only in the output.
201 { # Represents a single followup intent in the chain.
202 "followupIntentName": "A String", # The unique identifier of the followup intent.
203 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
204 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
205 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
206 },
207 ],
208 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
209 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
210 # session when this intent is matched.
211 "messages": [ # Optional. The collection of rich messages corresponding to the
212 # `Response` field in the Dialogflow console.
213 { # Corresponds to the `Response` field in the Dialogflow console.
214 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
215 # This message in `QueryResult.fulfillment_messages` and
216 # `WebhookResponse.fulfillment_messages` should contain only one
217 # `SimpleResponse`.
218 "simpleResponses": [ # Required. The list of simple responses.
219 { # The simple response message containing speech or text.
220 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
221 # speech output. Mutually exclusive with ssml.
222 "displayText": "A String", # Optional. The text to display.
223 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
224 # response to the user in the SSML format. Mutually exclusive with
225 # text_to_speech.
226 },
227 ],
228 },
229 "quickReplies": { # The quick replies response message. # The quick replies response.
230 "quickReplies": [ # Optional. The collection of quick replies.
231 "A String",
232 ],
233 "title": "A String", # Optional. The title of the collection of quick replies.
234 },
235 "platform": "A String", # Optional. The platform that this message is intended for.
236 "text": { # The text response message. # The text response.
237 "text": [ # Optional. The collection of the agent's responses.
238 "A String",
239 ],
240 },
241 "image": { # The image response message. # The image response.
242 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
243 # e.g., screen readers.
244 "imageUri": "A String", # Optional. The public URI to an image file.
245 },
246 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
247 "suggestions": [ # Required. The list of suggested replies.
248 { # The suggestion chip message that the user can tap to quickly post a reply
249 # to the conversation.
250 "title": "A String", # Required. The text shown the in the suggestion chip.
251 },
252 ],
253 },
254 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
255 # or website associated with this agent.
256 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
257 # suggestion chip.
258 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
259 },
260 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
261 "buttons": [ # Optional. The collection of card buttons.
262 { # The button object that appears at the bottom of a card.
263 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
264 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
265 },
266 "title": "A String", # Required. The title of the button.
267 },
268 ],
269 "subtitle": "A String", # Optional. The subtitle of the card.
270 "image": { # The image response message. # Optional. The image for the card.
271 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
272 # e.g., screen readers.
273 "imageUri": "A String", # Optional. The public URI to an image file.
274 },
275 "formattedText": "A String", # Required, unless image is present. The body text of the card.
276 "title": "A String", # Optional. The title of the card.
277 },
278 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
279 "items": [ # Required. Carousel items.
280 { # An item in the carousel.
281 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
282 # dialog.
283 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
284 # item in dialog.
285 "A String",
286 ],
287 "key": "A String", # Required. A unique key that will be sent back to the agent if this
288 # response is given.
289 },
290 "image": { # The image response message. # Optional. The image to display.
291 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
292 # e.g., screen readers.
293 "imageUri": "A String", # Optional. The public URI to an image file.
294 },
295 "description": "A String", # Optional. The body text of the card.
296 "title": "A String", # Required. Title of the carousel item.
297 },
298 ],
299 },
300 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
301 "items": [ # Required. List items.
302 { # An item in the list.
303 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
304 # dialog.
305 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
306 # item in dialog.
307 "A String",
308 ],
309 "key": "A String", # Required. A unique key that will be sent back to the agent if this
310 # response is given.
311 },
312 "image": { # The image response message. # Optional. The image to display.
313 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
314 # e.g., screen readers.
315 "imageUri": "A String", # Optional. The public URI to an image file.
316 },
317 "description": "A String", # Optional. The main text describing the item.
318 "title": "A String", # Required. The title of the list item.
319 },
320 ],
321 "title": "A String", # Optional. The overall title of the list.
322 },
323 "payload": { # Returns a response containing a custom, platform-specific payload.
324 # See the Intent.Message.Platform type for a description of the
325 # structure that may be required for your platform.
326 "a_key": "", # Properties of the object.
327 },
328 "card": { # The card response message. # The card response.
329 "buttons": [ # Optional. The collection of card buttons.
330 { # Optional. Contains information about a button.
331 "text": "A String", # Optional. The text to show on the button.
332 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
333 # open.
334 },
335 ],
336 "title": "A String", # Optional. The title of the card.
337 "subtitle": "A String", # Optional. The subtitle of the card.
338 "imageUri": "A String", # Optional. The public URI to an image file for the card.
339 },
340 },
341 ],
342 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
343 # chain of followup intents. You can set this field when creating an intent,
344 # for example with CreateIntent or BatchUpdateIntents, in order to
345 # make this intent a followup intent.
346 #
347 # It identifies the parent followup intent.
348 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
349 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
350 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
351 "A String",
352 ],
353 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
354 # priorities. If this is zero or unspecified, we use the default
355 # priority 500000.
356 #
357 # Negative numbers mean that the intent is disabled.
358 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
359 # followup intents. It identifies the correct followup intents chain for
360 # this intent. We populate this field only in the output.
361 #
362 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
363 "inputContextNames": [ # Optional. The list of context names required for this intent to be
364 # triggered.
365 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
366 "A String",
367 ],
368 "action": "A String", # Optional. The name of the action associated with the intent.
369 # Note: The action name must not contain whitespaces.
370 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
371 # is matched. Context messages in this collection should not set the
372 # parameters field. Setting the `lifespan_count` to 0 will reset the context
373 # when the intent is matched.
374 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
375 { # Represents a context.
376 "parameters": { # Optional. The collection of parameters associated with this context.
377 # Refer to [this
378 # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
379 # for syntax.
380 "a_key": "", # Properties of the object.
381 },
382 "name": "A String", # Required. The unique identifier of the context. Format:
383 # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
384 #
385 # The `Context ID` is always converted to lowercase, may only contain
386 # characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
387 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
388 # context expires. If set to `0` (the default) the context expires
389 # immediately. Contexts expire automatically after 20 minutes if there
390 # are no matching queries.
391 },
392 ],
393 "events": [ # Optional. The collection of event names that trigger the intent.
394 # If the collection of input contexts is not empty, all of the contexts must
395 # be present in the active user session for an event to trigger this intent.
396 "A String",
397 ],
398 },
399 ],
400 }
401
402 x__xgafv: string, V1 error format.
403 Allowed values
404 1 - v1 error format
405 2 - v2 error format
406
407Returns:
408 An object of the form:
409
410 { # This resource represents a long-running operation that is the result of a
411 # network API call.
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 },
418 "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.
419 # different programming environments, including REST APIs and RPC APIs. It is
420 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
421 # three pieces of data: error code, error message, and error details.
422 #
423 # You can find out more about this error model and how to work with it in the
424 # [API Design Guide](https://cloud.google.com/apis/design/errors).
425 "message": "A String", # A developer-facing error message, which should be in English. Any
426 # user-facing error message should be localized and sent in the
427 # google.rpc.Status.details field, or localized by the client.
428 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
429 "details": [ # A list of messages that carry the error details. There is a common set of
430 # message types for APIs to use.
431 {
432 "a_key": "", # Properties of the object. Contains field @type with type URL.
433 },
434 ],
435 },
436 "done": True or False, # If the value is `false`, it means the operation is still in progress.
437 # If `true`, the operation is completed, and either `error` or `response` is
438 # available.
439 "response": { # The normal response of the operation in case of success. If the original
440 # method returns no data on success, such as `Delete`, the response is
441 # `google.protobuf.Empty`. If the original method is standard
442 # `Get`/`Create`/`Update`, the response should be the resource. For other
443 # methods, the response should have the type `XxxResponse`, where `Xxx`
444 # is the original method name. For example, if the original method name
445 # is `TakeSnapshot()`, the inferred response type is
446 # `TakeSnapshotResponse`.
447 "a_key": "", # Properties of the object. Contains field @type with type URL.
448 },
449 "name": "A String", # The server-assigned name, which is only unique within the same service that
450 # originally returns it. If you use the default HTTP mapping, the
451 # `name` should be a resource name ending with `operations/{unique_id}`.
452 }</pre>
453</div>
454
455<div class="method">
456 <code class="details" id="batchUpdate">batchUpdate(parent, body, x__xgafv=None)</code>
457 <pre>Updates/Creates multiple intents in the specified agent.
458
459Operation <response: BatchUpdateIntentsResponse>
460
461Args:
462 parent: string, Required. The name of the agent to update or create intents in.
463Format: `projects/<Project ID>/agent`. (required)
464 body: object, The request body. (required)
465 The object takes the form of:
466
467{ # The request message for Intents.BatchUpdateIntents.
468 "languageCode": "A String", # Optional. The language of training phrases, parameters and rich messages
469 # defined in `intents`. If not specified, the agent's default language is
470 # used. [Many
471 # languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
472 # are supported. Note: languages must be enabled in the agent before they can
473 # be used.
474 "intentBatchUri": "A String", # The URI to a Google Cloud Storage file containing intents to update or
475 # create. The file format can either be a serialized proto (of IntentBatch
476 # type) or JSON object. Note: The URI must start with "gs://".
477 "intentBatchInline": { # This message is a wrapper around a collection of intents. # The collection of intents to update or create.
478 "intents": [ # A collection of intents.
479 { # Represents an intent.
480 # Intents convert a number of user expressions or patterns into an action. An
481 # action is an extraction of a user command or sentence semantics.
482 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
483 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
484 # Note: If `ml_diabled` setting is set to true, then this intent is not
485 # taken into account during inference in `ML ONLY` match mode. Also,
486 # auto-markup in the UI is turned off.
487 "displayName": "A String", # Required. The name of this intent.
488 "name": "A String", # The unique identifier of this intent.
489 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
490 # methods.
491 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
492 "parameters": [ # Optional. The collection of parameters associated with the intent.
493 { # Represents intent parameters.
494 "displayName": "A String", # Required. The name of the parameter.
495 "name": "A String", # The unique identifier of this parameter.
496 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
497 # result.
498 # Default values can be extracted from contexts by using the following
499 # syntax: `#context_name.parameter_name`.
500 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
501 # describes values of the parameter. If the parameter is
502 # required, this must be provided.
503 "value": "A String", # Optional. The definition of the parameter value. It can be:
504 # - a constant string,
505 # - a parameter value defined as `$parameter_name`,
506 # - an original parameter value defined as `$parameter_name.original`,
507 # - a parameter value from some context defined as
508 # `#context_name.parameter_name`.
509 "prompts": [ # Optional. The collection of prompts that the agent can present to the
510 # user in order to collect value for the parameter.
511 "A String",
512 ],
513 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
514 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
515 # whether the intent cannot be completed without collecting the parameter
516 # value.
517 },
518 ],
519 "trainingPhrases": [ # Optional. The collection of examples that the agent is
520 # trained on.
521 { # Represents an example that the agent is trained on.
522 "parts": [ # Required. The ordered list of training phrase parts.
523 # The parts are concatenated in order to form the training phrase.
524 #
525 # Note: The API does not automatically annotate training phrases like the
526 # Dialogflow Console does.
527 #
528 # Note: Do not forget to include whitespace at part boundaries,
529 # so the training phrase is well formatted when the parts are concatenated.
530 #
531 # If the training phrase does not need to be annotated with parameters,
532 # you just need a single part with only the Part.text field set.
533 #
534 # If you want to annotate the training phrase, you must create multiple
535 # parts, where the fields of each part are populated in one of two ways:
536 #
537 # - `Part.text` is set to a part of the phrase that has no parameters.
538 # - `Part.text` is set to a part of the phrase that you want to annotate,
539 # and the `entity_type`, `alias`, and `user_defined` fields are all
540 # set.
541 { # Represents a part of a training phrase.
542 "alias": "A String", # Optional. The parameter name for the value extracted from the
543 # annotated part of the example.
544 # This field is required for annotated parts of the training phrase.
545 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
546 # This field is required for annotated parts of the training phrase.
547 "text": "A String", # Required. The text for this part.
548 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
549 # This field is set to true when the Dialogflow Console is used to
550 # manually annotate the part. When creating an annotated part with the
551 # API, you must set this to true.
552 },
553 ],
554 "type": "A String", # Required. The type of the training phrase.
555 "name": "A String", # Output only. The unique identifier of this training phrase.
556 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
557 # the intent. Each time a developer adds an existing sample by editing an
558 # intent or training, this counter is increased.
559 },
560 ],
561 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
562 # a direct or indirect parent. We populate this field only in the output.
563 { # Represents a single followup intent in the chain.
564 "followupIntentName": "A String", # The unique identifier of the followup intent.
565 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
566 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
567 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
568 },
569 ],
570 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
571 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
572 # session when this intent is matched.
573 "messages": [ # Optional. The collection of rich messages corresponding to the
574 # `Response` field in the Dialogflow console.
575 { # Corresponds to the `Response` field in the Dialogflow console.
576 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
577 # This message in `QueryResult.fulfillment_messages` and
578 # `WebhookResponse.fulfillment_messages` should contain only one
579 # `SimpleResponse`.
580 "simpleResponses": [ # Required. The list of simple responses.
581 { # The simple response message containing speech or text.
582 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
583 # speech output. Mutually exclusive with ssml.
584 "displayText": "A String", # Optional. The text to display.
585 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
586 # response to the user in the SSML format. Mutually exclusive with
587 # text_to_speech.
588 },
589 ],
590 },
591 "quickReplies": { # The quick replies response message. # The quick replies response.
592 "quickReplies": [ # Optional. The collection of quick replies.
593 "A String",
594 ],
595 "title": "A String", # Optional. The title of the collection of quick replies.
596 },
597 "platform": "A String", # Optional. The platform that this message is intended for.
598 "text": { # The text response message. # The text response.
599 "text": [ # Optional. The collection of the agent's responses.
600 "A String",
601 ],
602 },
603 "image": { # The image response message. # The image response.
604 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
605 # e.g., screen readers.
606 "imageUri": "A String", # Optional. The public URI to an image file.
607 },
608 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
609 "suggestions": [ # Required. The list of suggested replies.
610 { # The suggestion chip message that the user can tap to quickly post a reply
611 # to the conversation.
612 "title": "A String", # Required. The text shown the in the suggestion chip.
613 },
614 ],
615 },
616 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
617 # or website associated with this agent.
618 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
619 # suggestion chip.
620 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
621 },
622 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
623 "buttons": [ # Optional. The collection of card buttons.
624 { # The button object that appears at the bottom of a card.
625 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
626 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
627 },
628 "title": "A String", # Required. The title of the button.
629 },
630 ],
631 "subtitle": "A String", # Optional. The subtitle of the card.
632 "image": { # The image response message. # Optional. The image for the card.
633 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
634 # e.g., screen readers.
635 "imageUri": "A String", # Optional. The public URI to an image file.
636 },
637 "formattedText": "A String", # Required, unless image is present. The body text of the card.
638 "title": "A String", # Optional. The title of the card.
639 },
640 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
641 "items": [ # Required. Carousel items.
642 { # An item in the carousel.
643 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
644 # dialog.
645 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
646 # item in dialog.
647 "A String",
648 ],
649 "key": "A String", # Required. A unique key that will be sent back to the agent if this
650 # response is given.
651 },
652 "image": { # The image response message. # Optional. The image to display.
653 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
654 # e.g., screen readers.
655 "imageUri": "A String", # Optional. The public URI to an image file.
656 },
657 "description": "A String", # Optional. The body text of the card.
658 "title": "A String", # Required. Title of the carousel item.
659 },
660 ],
661 },
662 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
663 "items": [ # Required. List items.
664 { # An item in the list.
665 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
666 # dialog.
667 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
668 # item in dialog.
669 "A String",
670 ],
671 "key": "A String", # Required. A unique key that will be sent back to the agent if this
672 # response is given.
673 },
674 "image": { # The image response message. # Optional. The image to display.
675 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
676 # e.g., screen readers.
677 "imageUri": "A String", # Optional. The public URI to an image file.
678 },
679 "description": "A String", # Optional. The main text describing the item.
680 "title": "A String", # Required. The title of the list item.
681 },
682 ],
683 "title": "A String", # Optional. The overall title of the list.
684 },
685 "payload": { # Returns a response containing a custom, platform-specific payload.
686 # See the Intent.Message.Platform type for a description of the
687 # structure that may be required for your platform.
688 "a_key": "", # Properties of the object.
689 },
690 "card": { # The card response message. # The card response.
691 "buttons": [ # Optional. The collection of card buttons.
692 { # Optional. Contains information about a button.
693 "text": "A String", # Optional. The text to show on the button.
694 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
695 # open.
696 },
697 ],
698 "title": "A String", # Optional. The title of the card.
699 "subtitle": "A String", # Optional. The subtitle of the card.
700 "imageUri": "A String", # Optional. The public URI to an image file for the card.
701 },
702 },
703 ],
704 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
705 # chain of followup intents. You can set this field when creating an intent,
706 # for example with CreateIntent or BatchUpdateIntents, in order to
707 # make this intent a followup intent.
708 #
709 # It identifies the parent followup intent.
710 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
711 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
712 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
713 "A String",
714 ],
715 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
716 # priorities. If this is zero or unspecified, we use the default
717 # priority 500000.
718 #
719 # Negative numbers mean that the intent is disabled.
720 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
721 # followup intents. It identifies the correct followup intents chain for
722 # this intent. We populate this field only in the output.
723 #
724 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
725 "inputContextNames": [ # Optional. The list of context names required for this intent to be
726 # triggered.
727 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
728 "A String",
729 ],
730 "action": "A String", # Optional. The name of the action associated with the intent.
731 # Note: The action name must not contain whitespaces.
732 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
733 # is matched. Context messages in this collection should not set the
734 # parameters field. Setting the `lifespan_count` to 0 will reset the context
735 # when the intent is matched.
736 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
737 { # Represents a context.
738 "parameters": { # Optional. The collection of parameters associated with this context.
739 # Refer to [this
740 # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
741 # for syntax.
742 "a_key": "", # Properties of the object.
743 },
744 "name": "A String", # Required. The unique identifier of the context. Format:
745 # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
746 #
747 # The `Context ID` is always converted to lowercase, may only contain
748 # characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
749 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
750 # context expires. If set to `0` (the default) the context expires
751 # immediately. Contexts expire automatically after 20 minutes if there
752 # are no matching queries.
753 },
754 ],
755 "events": [ # Optional. The collection of event names that trigger the intent.
756 # If the collection of input contexts is not empty, all of the contexts must
757 # be present in the active user session for an event to trigger this intent.
758 "A String",
759 ],
760 },
761 ],
762 },
763 "updateMask": "A String", # Optional. The mask to control which fields get updated.
764 "intentView": "A String", # Optional. The resource view to apply to the returned intent.
765 }
766
767 x__xgafv: string, V1 error format.
768 Allowed values
769 1 - v1 error format
770 2 - v2 error format
771
772Returns:
773 An object of the form:
774
775 { # This resource represents a long-running operation that is the result of a
776 # network API call.
777 "metadata": { # Service-specific metadata associated with the operation. It typically
778 # contains progress information and common metadata such as create time.
779 # Some services might not provide such metadata. Any method that returns a
780 # long-running operation should document the metadata type, if any.
781 "a_key": "", # Properties of the object. Contains field @type with type URL.
782 },
783 "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.
784 # different programming environments, including REST APIs and RPC APIs. It is
785 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
786 # three pieces of data: error code, error message, and error details.
787 #
788 # You can find out more about this error model and how to work with it in the
789 # [API Design Guide](https://cloud.google.com/apis/design/errors).
790 "message": "A String", # A developer-facing error message, which should be in English. Any
791 # user-facing error message should be localized and sent in the
792 # google.rpc.Status.details field, or localized by the client.
793 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
794 "details": [ # A list of messages that carry the error details. There is a common set of
795 # message types for APIs to use.
796 {
797 "a_key": "", # Properties of the object. Contains field @type with type URL.
798 },
799 ],
800 },
801 "done": True or False, # If the value is `false`, it means the operation is still in progress.
802 # If `true`, the operation is completed, and either `error` or `response` is
803 # available.
804 "response": { # The normal response of the operation in case of success. If the original
805 # method returns no data on success, such as `Delete`, the response is
806 # `google.protobuf.Empty`. If the original method is standard
807 # `Get`/`Create`/`Update`, the response should be the resource. For other
808 # methods, the response should have the type `XxxResponse`, where `Xxx`
809 # is the original method name. For example, if the original method name
810 # is `TakeSnapshot()`, the inferred response type is
811 # `TakeSnapshotResponse`.
812 "a_key": "", # Properties of the object. Contains field @type with type URL.
813 },
814 "name": "A String", # The server-assigned name, which is only unique within the same service that
815 # originally returns it. If you use the default HTTP mapping, the
816 # `name` should be a resource name ending with `operations/{unique_id}`.
817 }</pre>
818</div>
819
820<div class="method">
821 <code class="details" id="create">create(parent, body, languageCode=None, intentView=None, x__xgafv=None)</code>
822 <pre>Creates an intent in the specified agent.
823
824Args:
825 parent: string, Required. The agent to create a intent for.
826Format: `projects/<Project ID>/agent`. (required)
827 body: object, The request body. (required)
828 The object takes the form of:
829
830{ # Represents an intent.
831 # Intents convert a number of user expressions or patterns into an action. An
832 # action is an extraction of a user command or sentence semantics.
833 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
834 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
835 # Note: If `ml_diabled` setting is set to true, then this intent is not
836 # taken into account during inference in `ML ONLY` match mode. Also,
837 # auto-markup in the UI is turned off.
838 "displayName": "A String", # Required. The name of this intent.
839 "name": "A String", # The unique identifier of this intent.
840 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
841 # methods.
842 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
843 "parameters": [ # Optional. The collection of parameters associated with the intent.
844 { # Represents intent parameters.
845 "displayName": "A String", # Required. The name of the parameter.
846 "name": "A String", # The unique identifier of this parameter.
847 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
848 # result.
849 # Default values can be extracted from contexts by using the following
850 # syntax: `#context_name.parameter_name`.
851 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
852 # describes values of the parameter. If the parameter is
853 # required, this must be provided.
854 "value": "A String", # Optional. The definition of the parameter value. It can be:
855 # - a constant string,
856 # - a parameter value defined as `$parameter_name`,
857 # - an original parameter value defined as `$parameter_name.original`,
858 # - a parameter value from some context defined as
859 # `#context_name.parameter_name`.
860 "prompts": [ # Optional. The collection of prompts that the agent can present to the
861 # user in order to collect value for the parameter.
862 "A String",
863 ],
864 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
865 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
866 # whether the intent cannot be completed without collecting the parameter
867 # value.
868 },
869 ],
870 "trainingPhrases": [ # Optional. The collection of examples that the agent is
871 # trained on.
872 { # Represents an example that the agent is trained on.
873 "parts": [ # Required. The ordered list of training phrase parts.
874 # The parts are concatenated in order to form the training phrase.
875 #
876 # Note: The API does not automatically annotate training phrases like the
877 # Dialogflow Console does.
878 #
879 # Note: Do not forget to include whitespace at part boundaries,
880 # so the training phrase is well formatted when the parts are concatenated.
881 #
882 # If the training phrase does not need to be annotated with parameters,
883 # you just need a single part with only the Part.text field set.
884 #
885 # If you want to annotate the training phrase, you must create multiple
886 # parts, where the fields of each part are populated in one of two ways:
887 #
888 # - `Part.text` is set to a part of the phrase that has no parameters.
889 # - `Part.text` is set to a part of the phrase that you want to annotate,
890 # and the `entity_type`, `alias`, and `user_defined` fields are all
891 # set.
892 { # Represents a part of a training phrase.
893 "alias": "A String", # Optional. The parameter name for the value extracted from the
894 # annotated part of the example.
895 # This field is required for annotated parts of the training phrase.
896 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
897 # This field is required for annotated parts of the training phrase.
898 "text": "A String", # Required. The text for this part.
899 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
900 # This field is set to true when the Dialogflow Console is used to
901 # manually annotate the part. When creating an annotated part with the
902 # API, you must set this to true.
903 },
904 ],
905 "type": "A String", # Required. The type of the training phrase.
906 "name": "A String", # Output only. The unique identifier of this training phrase.
907 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
908 # the intent. Each time a developer adds an existing sample by editing an
909 # intent or training, this counter is increased.
910 },
911 ],
912 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
913 # a direct or indirect parent. We populate this field only in the output.
914 { # Represents a single followup intent in the chain.
915 "followupIntentName": "A String", # The unique identifier of the followup intent.
916 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
917 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
918 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
919 },
920 ],
921 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
922 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
923 # session when this intent is matched.
924 "messages": [ # Optional. The collection of rich messages corresponding to the
925 # `Response` field in the Dialogflow console.
926 { # Corresponds to the `Response` field in the Dialogflow console.
927 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
928 # This message in `QueryResult.fulfillment_messages` and
929 # `WebhookResponse.fulfillment_messages` should contain only one
930 # `SimpleResponse`.
931 "simpleResponses": [ # Required. The list of simple responses.
932 { # The simple response message containing speech or text.
933 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
934 # speech output. Mutually exclusive with ssml.
935 "displayText": "A String", # Optional. The text to display.
936 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
937 # response to the user in the SSML format. Mutually exclusive with
938 # text_to_speech.
939 },
940 ],
941 },
942 "quickReplies": { # The quick replies response message. # The quick replies response.
943 "quickReplies": [ # Optional. The collection of quick replies.
944 "A String",
945 ],
946 "title": "A String", # Optional. The title of the collection of quick replies.
947 },
948 "platform": "A String", # Optional. The platform that this message is intended for.
949 "text": { # The text response message. # The text response.
950 "text": [ # Optional. The collection of the agent's responses.
951 "A String",
952 ],
953 },
954 "image": { # The image response message. # The image response.
955 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
956 # e.g., screen readers.
957 "imageUri": "A String", # Optional. The public URI to an image file.
958 },
959 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
960 "suggestions": [ # Required. The list of suggested replies.
961 { # The suggestion chip message that the user can tap to quickly post a reply
962 # to the conversation.
963 "title": "A String", # Required. The text shown the in the suggestion chip.
964 },
965 ],
966 },
967 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
968 # or website associated with this agent.
969 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
970 # suggestion chip.
971 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
972 },
973 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
974 "buttons": [ # Optional. The collection of card buttons.
975 { # The button object that appears at the bottom of a card.
976 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
977 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
978 },
979 "title": "A String", # Required. The title of the button.
980 },
981 ],
982 "subtitle": "A String", # Optional. The subtitle of the card.
983 "image": { # The image response message. # Optional. The image for the card.
984 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
985 # e.g., screen readers.
986 "imageUri": "A String", # Optional. The public URI to an image file.
987 },
988 "formattedText": "A String", # Required, unless image is present. The body text of the card.
989 "title": "A String", # Optional. The title of the card.
990 },
991 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
992 "items": [ # Required. Carousel items.
993 { # An item in the carousel.
994 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
995 # dialog.
996 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
997 # item in dialog.
998 "A String",
999 ],
1000 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1001 # response is given.
1002 },
1003 "image": { # The image response message. # Optional. The image to display.
1004 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1005 # e.g., screen readers.
1006 "imageUri": "A String", # Optional. The public URI to an image file.
1007 },
1008 "description": "A String", # Optional. The body text of the card.
1009 "title": "A String", # Required. Title of the carousel item.
1010 },
1011 ],
1012 },
1013 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
1014 "items": [ # Required. List items.
1015 { # An item in the list.
1016 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
1017 # dialog.
1018 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1019 # item in dialog.
1020 "A String",
1021 ],
1022 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1023 # response is given.
1024 },
1025 "image": { # The image response message. # Optional. The image to display.
1026 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1027 # e.g., screen readers.
1028 "imageUri": "A String", # Optional. The public URI to an image file.
1029 },
1030 "description": "A String", # Optional. The main text describing the item.
1031 "title": "A String", # Required. The title of the list item.
1032 },
1033 ],
1034 "title": "A String", # Optional. The overall title of the list.
1035 },
1036 "payload": { # Returns a response containing a custom, platform-specific payload.
1037 # See the Intent.Message.Platform type for a description of the
1038 # structure that may be required for your platform.
1039 "a_key": "", # Properties of the object.
1040 },
1041 "card": { # The card response message. # The card response.
1042 "buttons": [ # Optional. The collection of card buttons.
1043 { # Optional. Contains information about a button.
1044 "text": "A String", # Optional. The text to show on the button.
1045 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1046 # open.
1047 },
1048 ],
1049 "title": "A String", # Optional. The title of the card.
1050 "subtitle": "A String", # Optional. The subtitle of the card.
1051 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1052 },
1053 },
1054 ],
1055 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
1056 # chain of followup intents. You can set this field when creating an intent,
1057 # for example with CreateIntent or BatchUpdateIntents, in order to
1058 # make this intent a followup intent.
1059 #
1060 # It identifies the parent followup intent.
1061 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1062 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
1063 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
1064 "A String",
1065 ],
1066 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
1067 # priorities. If this is zero or unspecified, we use the default
1068 # priority 500000.
1069 #
1070 # Negative numbers mean that the intent is disabled.
1071 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
1072 # followup intents. It identifies the correct followup intents chain for
1073 # this intent. We populate this field only in the output.
1074 #
1075 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1076 "inputContextNames": [ # Optional. The list of context names required for this intent to be
1077 # triggered.
1078 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
1079 "A String",
1080 ],
1081 "action": "A String", # Optional. The name of the action associated with the intent.
1082 # Note: The action name must not contain whitespaces.
1083 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
1084 # is matched. Context messages in this collection should not set the
1085 # parameters field. Setting the `lifespan_count` to 0 will reset the context
1086 # when the intent is matched.
1087 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
1088 { # Represents a context.
1089 "parameters": { # Optional. The collection of parameters associated with this context.
1090 # Refer to [this
1091 # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
1092 # for syntax.
1093 "a_key": "", # Properties of the object.
1094 },
1095 "name": "A String", # Required. The unique identifier of the context. Format:
1096 # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
1097 #
1098 # The `Context ID` is always converted to lowercase, may only contain
1099 # characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
1100 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
1101 # context expires. If set to `0` (the default) the context expires
1102 # immediately. Contexts expire automatically after 20 minutes if there
1103 # are no matching queries.
1104 },
1105 ],
1106 "events": [ # Optional. The collection of event names that trigger the intent.
1107 # If the collection of input contexts is not empty, all of the contexts must
1108 # be present in the active user session for an event to trigger this intent.
1109 "A String",
1110 ],
1111}
1112
1113 languageCode: string, Optional. The language of training phrases, parameters and rich messages
1114defined in `intent`. If not specified, the agent's default language is
1115used. [Many
1116languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
1117are supported. Note: languages must be enabled in the agent before they can
1118be used.
1119 intentView: string, Optional. The resource view to apply to the returned intent.
1120 x__xgafv: string, V1 error format.
1121 Allowed values
1122 1 - v1 error format
1123 2 - v2 error format
1124
1125Returns:
1126 An object of the form:
1127
1128 { # Represents an intent.
1129 # Intents convert a number of user expressions or patterns into an action. An
1130 # action is an extraction of a user command or sentence semantics.
1131 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
1132 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
1133 # Note: If `ml_diabled` setting is set to true, then this intent is not
1134 # taken into account during inference in `ML ONLY` match mode. Also,
1135 # auto-markup in the UI is turned off.
1136 "displayName": "A String", # Required. The name of this intent.
1137 "name": "A String", # The unique identifier of this intent.
1138 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
1139 # methods.
1140 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1141 "parameters": [ # Optional. The collection of parameters associated with the intent.
1142 { # Represents intent parameters.
1143 "displayName": "A String", # Required. The name of the parameter.
1144 "name": "A String", # The unique identifier of this parameter.
1145 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
1146 # result.
1147 # Default values can be extracted from contexts by using the following
1148 # syntax: `#context_name.parameter_name`.
1149 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
1150 # describes values of the parameter. If the parameter is
1151 # required, this must be provided.
1152 "value": "A String", # Optional. The definition of the parameter value. It can be:
1153 # - a constant string,
1154 # - a parameter value defined as `$parameter_name`,
1155 # - an original parameter value defined as `$parameter_name.original`,
1156 # - a parameter value from some context defined as
1157 # `#context_name.parameter_name`.
1158 "prompts": [ # Optional. The collection of prompts that the agent can present to the
1159 # user in order to collect value for the parameter.
1160 "A String",
1161 ],
1162 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
1163 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
1164 # whether the intent cannot be completed without collecting the parameter
1165 # value.
1166 },
1167 ],
1168 "trainingPhrases": [ # Optional. The collection of examples that the agent is
1169 # trained on.
1170 { # Represents an example that the agent is trained on.
1171 "parts": [ # Required. The ordered list of training phrase parts.
1172 # The parts are concatenated in order to form the training phrase.
1173 #
1174 # Note: The API does not automatically annotate training phrases like the
1175 # Dialogflow Console does.
1176 #
1177 # Note: Do not forget to include whitespace at part boundaries,
1178 # so the training phrase is well formatted when the parts are concatenated.
1179 #
1180 # If the training phrase does not need to be annotated with parameters,
1181 # you just need a single part with only the Part.text field set.
1182 #
1183 # If you want to annotate the training phrase, you must create multiple
1184 # parts, where the fields of each part are populated in one of two ways:
1185 #
1186 # - `Part.text` is set to a part of the phrase that has no parameters.
1187 # - `Part.text` is set to a part of the phrase that you want to annotate,
1188 # and the `entity_type`, `alias`, and `user_defined` fields are all
1189 # set.
1190 { # Represents a part of a training phrase.
1191 "alias": "A String", # Optional. The parameter name for the value extracted from the
1192 # annotated part of the example.
1193 # This field is required for annotated parts of the training phrase.
1194 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
1195 # This field is required for annotated parts of the training phrase.
1196 "text": "A String", # Required. The text for this part.
1197 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
1198 # This field is set to true when the Dialogflow Console is used to
1199 # manually annotate the part. When creating an annotated part with the
1200 # API, you must set this to true.
1201 },
1202 ],
1203 "type": "A String", # Required. The type of the training phrase.
1204 "name": "A String", # Output only. The unique identifier of this training phrase.
1205 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
1206 # the intent. Each time a developer adds an existing sample by editing an
1207 # intent or training, this counter is increased.
1208 },
1209 ],
1210 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
1211 # a direct or indirect parent. We populate this field only in the output.
1212 { # Represents a single followup intent in the chain.
1213 "followupIntentName": "A String", # The unique identifier of the followup intent.
1214 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1215 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
1216 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1217 },
1218 ],
1219 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
1220 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
1221 # session when this intent is matched.
1222 "messages": [ # Optional. The collection of rich messages corresponding to the
1223 # `Response` field in the Dialogflow console.
1224 { # Corresponds to the `Response` field in the Dialogflow console.
1225 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
1226 # This message in `QueryResult.fulfillment_messages` and
1227 # `WebhookResponse.fulfillment_messages` should contain only one
1228 # `SimpleResponse`.
1229 "simpleResponses": [ # Required. The list of simple responses.
1230 { # The simple response message containing speech or text.
1231 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
1232 # speech output. Mutually exclusive with ssml.
1233 "displayText": "A String", # Optional. The text to display.
1234 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
1235 # response to the user in the SSML format. Mutually exclusive with
1236 # text_to_speech.
1237 },
1238 ],
1239 },
1240 "quickReplies": { # The quick replies response message. # The quick replies response.
1241 "quickReplies": [ # Optional. The collection of quick replies.
1242 "A String",
1243 ],
1244 "title": "A String", # Optional. The title of the collection of quick replies.
1245 },
1246 "platform": "A String", # Optional. The platform that this message is intended for.
1247 "text": { # The text response message. # The text response.
1248 "text": [ # Optional. The collection of the agent's responses.
1249 "A String",
1250 ],
1251 },
1252 "image": { # The image response message. # The image response.
1253 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1254 # e.g., screen readers.
1255 "imageUri": "A String", # Optional. The public URI to an image file.
1256 },
1257 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
1258 "suggestions": [ # Required. The list of suggested replies.
1259 { # The suggestion chip message that the user can tap to quickly post a reply
1260 # to the conversation.
1261 "title": "A String", # Required. The text shown the in the suggestion chip.
1262 },
1263 ],
1264 },
1265 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
1266 # or website associated with this agent.
1267 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
1268 # suggestion chip.
1269 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
1270 },
1271 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
1272 "buttons": [ # Optional. The collection of card buttons.
1273 { # The button object that appears at the bottom of a card.
1274 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1275 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1276 },
1277 "title": "A String", # Required. The title of the button.
1278 },
1279 ],
1280 "subtitle": "A String", # Optional. The subtitle of the card.
1281 "image": { # The image response message. # Optional. The image for the card.
1282 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1283 # e.g., screen readers.
1284 "imageUri": "A String", # Optional. The public URI to an image file.
1285 },
1286 "formattedText": "A String", # Required, unless image is present. The body text of the card.
1287 "title": "A String", # Optional. The title of the card.
1288 },
1289 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
1290 "items": [ # Required. Carousel items.
1291 { # An item in the carousel.
1292 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
1293 # dialog.
1294 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1295 # item in dialog.
1296 "A String",
1297 ],
1298 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1299 # response is given.
1300 },
1301 "image": { # The image response message. # Optional. The image to display.
1302 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1303 # e.g., screen readers.
1304 "imageUri": "A String", # Optional. The public URI to an image file.
1305 },
1306 "description": "A String", # Optional. The body text of the card.
1307 "title": "A String", # Required. Title of the carousel item.
1308 },
1309 ],
1310 },
1311 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
1312 "items": [ # Required. List items.
1313 { # An item in the list.
1314 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
1315 # dialog.
1316 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1317 # item in dialog.
1318 "A String",
1319 ],
1320 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1321 # response is given.
1322 },
1323 "image": { # The image response message. # Optional. The image to display.
1324 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1325 # e.g., screen readers.
1326 "imageUri": "A String", # Optional. The public URI to an image file.
1327 },
1328 "description": "A String", # Optional. The main text describing the item.
1329 "title": "A String", # Required. The title of the list item.
1330 },
1331 ],
1332 "title": "A String", # Optional. The overall title of the list.
1333 },
1334 "payload": { # Returns a response containing a custom, platform-specific payload.
1335 # See the Intent.Message.Platform type for a description of the
1336 # structure that may be required for your platform.
1337 "a_key": "", # Properties of the object.
1338 },
1339 "card": { # The card response message. # The card response.
1340 "buttons": [ # Optional. The collection of card buttons.
1341 { # Optional. Contains information about a button.
1342 "text": "A String", # Optional. The text to show on the button.
1343 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1344 # open.
1345 },
1346 ],
1347 "title": "A String", # Optional. The title of the card.
1348 "subtitle": "A String", # Optional. The subtitle of the card.
1349 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1350 },
1351 },
1352 ],
1353 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
1354 # chain of followup intents. You can set this field when creating an intent,
1355 # for example with CreateIntent or BatchUpdateIntents, in order to
1356 # make this intent a followup intent.
1357 #
1358 # It identifies the parent followup intent.
1359 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1360 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
1361 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
1362 "A String",
1363 ],
1364 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
1365 # priorities. If this is zero or unspecified, we use the default
1366 # priority 500000.
1367 #
1368 # Negative numbers mean that the intent is disabled.
1369 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
1370 # followup intents. It identifies the correct followup intents chain for
1371 # this intent. We populate this field only in the output.
1372 #
1373 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1374 "inputContextNames": [ # Optional. The list of context names required for this intent to be
1375 # triggered.
1376 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
1377 "A String",
1378 ],
1379 "action": "A String", # Optional. The name of the action associated with the intent.
1380 # Note: The action name must not contain whitespaces.
1381 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
1382 # is matched. Context messages in this collection should not set the
1383 # parameters field. Setting the `lifespan_count` to 0 will reset the context
1384 # when the intent is matched.
1385 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
1386 { # Represents a context.
1387 "parameters": { # Optional. The collection of parameters associated with this context.
1388 # Refer to [this
1389 # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
1390 # for syntax.
1391 "a_key": "", # Properties of the object.
1392 },
1393 "name": "A String", # Required. The unique identifier of the context. Format:
1394 # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
1395 #
1396 # The `Context ID` is always converted to lowercase, may only contain
1397 # characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
1398 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
1399 # context expires. If set to `0` (the default) the context expires
1400 # immediately. Contexts expire automatically after 20 minutes if there
1401 # are no matching queries.
1402 },
1403 ],
1404 "events": [ # Optional. The collection of event names that trigger the intent.
1405 # If the collection of input contexts is not empty, all of the contexts must
1406 # be present in the active user session for an event to trigger this intent.
1407 "A String",
1408 ],
1409 }</pre>
1410</div>
1411
1412<div class="method">
1413 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
1414 <pre>Deletes the specified intent and its direct or indirect followup intents.
1415
1416Args:
1417 name: string, Required. The name of the intent to delete. If this intent has direct or
1418indirect followup intents, we also delete them.
1419Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
1420 x__xgafv: string, V1 error format.
1421 Allowed values
1422 1 - v1 error format
1423 2 - v2 error format
1424
1425Returns:
1426 An object of the form:
1427
1428 { # A generic empty message that you can re-use to avoid defining duplicated
1429 # empty messages in your APIs. A typical example is to use it as the request
1430 # or the response type of an API method. For instance:
1431 #
1432 # service Foo {
1433 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1434 # }
1435 #
1436 # The JSON representation for `Empty` is empty JSON object `{}`.
1437 }</pre>
1438</div>
1439
1440<div class="method">
1441 <code class="details" id="get">get(name, languageCode=None, intentView=None, x__xgafv=None)</code>
1442 <pre>Retrieves the specified intent.
1443
1444Args:
1445 name: string, Required. The name of the intent.
1446Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
1447 languageCode: string, Optional. The language to retrieve training phrases, parameters and rich
1448messages for. If not specified, the agent's default language is used.
1449[Many
1450languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
1451are supported. Note: languages must be enabled in the agent before they can
1452be used.
1453 intentView: string, Optional. The resource view to apply to the returned intent.
1454 x__xgafv: string, V1 error format.
1455 Allowed values
1456 1 - v1 error format
1457 2 - v2 error format
1458
1459Returns:
1460 An object of the form:
1461
1462 { # Represents an intent.
1463 # Intents convert a number of user expressions or patterns into an action. An
1464 # action is an extraction of a user command or sentence semantics.
1465 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
1466 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
1467 # Note: If `ml_diabled` setting is set to true, then this intent is not
1468 # taken into account during inference in `ML ONLY` match mode. Also,
1469 # auto-markup in the UI is turned off.
1470 "displayName": "A String", # Required. The name of this intent.
1471 "name": "A String", # The unique identifier of this intent.
1472 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
1473 # methods.
1474 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1475 "parameters": [ # Optional. The collection of parameters associated with the intent.
1476 { # Represents intent parameters.
1477 "displayName": "A String", # Required. The name of the parameter.
1478 "name": "A String", # The unique identifier of this parameter.
1479 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
1480 # result.
1481 # Default values can be extracted from contexts by using the following
1482 # syntax: `#context_name.parameter_name`.
1483 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
1484 # describes values of the parameter. If the parameter is
1485 # required, this must be provided.
1486 "value": "A String", # Optional. The definition of the parameter value. It can be:
1487 # - a constant string,
1488 # - a parameter value defined as `$parameter_name`,
1489 # - an original parameter value defined as `$parameter_name.original`,
1490 # - a parameter value from some context defined as
1491 # `#context_name.parameter_name`.
1492 "prompts": [ # Optional. The collection of prompts that the agent can present to the
1493 # user in order to collect value for the parameter.
1494 "A String",
1495 ],
1496 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
1497 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
1498 # whether the intent cannot be completed without collecting the parameter
1499 # value.
1500 },
1501 ],
1502 "trainingPhrases": [ # Optional. The collection of examples that the agent is
1503 # trained on.
1504 { # Represents an example that the agent is trained on.
1505 "parts": [ # Required. The ordered list of training phrase parts.
1506 # The parts are concatenated in order to form the training phrase.
1507 #
1508 # Note: The API does not automatically annotate training phrases like the
1509 # Dialogflow Console does.
1510 #
1511 # Note: Do not forget to include whitespace at part boundaries,
1512 # so the training phrase is well formatted when the parts are concatenated.
1513 #
1514 # If the training phrase does not need to be annotated with parameters,
1515 # you just need a single part with only the Part.text field set.
1516 #
1517 # If you want to annotate the training phrase, you must create multiple
1518 # parts, where the fields of each part are populated in one of two ways:
1519 #
1520 # - `Part.text` is set to a part of the phrase that has no parameters.
1521 # - `Part.text` is set to a part of the phrase that you want to annotate,
1522 # and the `entity_type`, `alias`, and `user_defined` fields are all
1523 # set.
1524 { # Represents a part of a training phrase.
1525 "alias": "A String", # Optional. The parameter name for the value extracted from the
1526 # annotated part of the example.
1527 # This field is required for annotated parts of the training phrase.
1528 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
1529 # This field is required for annotated parts of the training phrase.
1530 "text": "A String", # Required. The text for this part.
1531 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
1532 # This field is set to true when the Dialogflow Console is used to
1533 # manually annotate the part. When creating an annotated part with the
1534 # API, you must set this to true.
1535 },
1536 ],
1537 "type": "A String", # Required. The type of the training phrase.
1538 "name": "A String", # Output only. The unique identifier of this training phrase.
1539 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
1540 # the intent. Each time a developer adds an existing sample by editing an
1541 # intent or training, this counter is increased.
1542 },
1543 ],
1544 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
1545 # a direct or indirect parent. We populate this field only in the output.
1546 { # Represents a single followup intent in the chain.
1547 "followupIntentName": "A String", # The unique identifier of the followup intent.
1548 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1549 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
1550 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1551 },
1552 ],
1553 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
1554 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
1555 # session when this intent is matched.
1556 "messages": [ # Optional. The collection of rich messages corresponding to the
1557 # `Response` field in the Dialogflow console.
1558 { # Corresponds to the `Response` field in the Dialogflow console.
1559 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
1560 # This message in `QueryResult.fulfillment_messages` and
1561 # `WebhookResponse.fulfillment_messages` should contain only one
1562 # `SimpleResponse`.
1563 "simpleResponses": [ # Required. The list of simple responses.
1564 { # The simple response message containing speech or text.
1565 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
1566 # speech output. Mutually exclusive with ssml.
1567 "displayText": "A String", # Optional. The text to display.
1568 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
1569 # response to the user in the SSML format. Mutually exclusive with
1570 # text_to_speech.
1571 },
1572 ],
1573 },
1574 "quickReplies": { # The quick replies response message. # The quick replies response.
1575 "quickReplies": [ # Optional. The collection of quick replies.
1576 "A String",
1577 ],
1578 "title": "A String", # Optional. The title of the collection of quick replies.
1579 },
1580 "platform": "A String", # Optional. The platform that this message is intended for.
1581 "text": { # The text response message. # The text response.
1582 "text": [ # Optional. The collection of the agent's responses.
1583 "A String",
1584 ],
1585 },
1586 "image": { # The image response message. # The image response.
1587 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1588 # e.g., screen readers.
1589 "imageUri": "A String", # Optional. The public URI to an image file.
1590 },
1591 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
1592 "suggestions": [ # Required. The list of suggested replies.
1593 { # The suggestion chip message that the user can tap to quickly post a reply
1594 # to the conversation.
1595 "title": "A String", # Required. The text shown the in the suggestion chip.
1596 },
1597 ],
1598 },
1599 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
1600 # or website associated with this agent.
1601 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
1602 # suggestion chip.
1603 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
1604 },
1605 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
1606 "buttons": [ # Optional. The collection of card buttons.
1607 { # The button object that appears at the bottom of a card.
1608 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1609 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1610 },
1611 "title": "A String", # Required. The title of the button.
1612 },
1613 ],
1614 "subtitle": "A String", # Optional. The subtitle of the card.
1615 "image": { # The image response message. # Optional. The image for the card.
1616 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1617 # e.g., screen readers.
1618 "imageUri": "A String", # Optional. The public URI to an image file.
1619 },
1620 "formattedText": "A String", # Required, unless image is present. The body text of the card.
1621 "title": "A String", # Optional. The title of the card.
1622 },
1623 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
1624 "items": [ # Required. Carousel items.
1625 { # An item in the carousel.
1626 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
1627 # dialog.
1628 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1629 # item in dialog.
1630 "A String",
1631 ],
1632 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1633 # response is given.
1634 },
1635 "image": { # The image response message. # Optional. The image to display.
1636 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1637 # e.g., screen readers.
1638 "imageUri": "A String", # Optional. The public URI to an image file.
1639 },
1640 "description": "A String", # Optional. The body text of the card.
1641 "title": "A String", # Required. Title of the carousel item.
1642 },
1643 ],
1644 },
1645 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
1646 "items": [ # Required. List items.
1647 { # An item in the list.
1648 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
1649 # dialog.
1650 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1651 # item in dialog.
1652 "A String",
1653 ],
1654 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1655 # response is given.
1656 },
1657 "image": { # The image response message. # Optional. The image to display.
1658 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1659 # e.g., screen readers.
1660 "imageUri": "A String", # Optional. The public URI to an image file.
1661 },
1662 "description": "A String", # Optional. The main text describing the item.
1663 "title": "A String", # Required. The title of the list item.
1664 },
1665 ],
1666 "title": "A String", # Optional. The overall title of the list.
1667 },
1668 "payload": { # Returns a response containing a custom, platform-specific payload.
1669 # See the Intent.Message.Platform type for a description of the
1670 # structure that may be required for your platform.
1671 "a_key": "", # Properties of the object.
1672 },
1673 "card": { # The card response message. # The card response.
1674 "buttons": [ # Optional. The collection of card buttons.
1675 { # Optional. Contains information about a button.
1676 "text": "A String", # Optional. The text to show on the button.
1677 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1678 # open.
1679 },
1680 ],
1681 "title": "A String", # Optional. The title of the card.
1682 "subtitle": "A String", # Optional. The subtitle of the card.
1683 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1684 },
1685 },
1686 ],
1687 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
1688 # chain of followup intents. You can set this field when creating an intent,
1689 # for example with CreateIntent or BatchUpdateIntents, in order to
1690 # make this intent a followup intent.
1691 #
1692 # It identifies the parent followup intent.
1693 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1694 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
1695 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
1696 "A String",
1697 ],
1698 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
1699 # priorities. If this is zero or unspecified, we use the default
1700 # priority 500000.
1701 #
1702 # Negative numbers mean that the intent is disabled.
1703 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
1704 # followup intents. It identifies the correct followup intents chain for
1705 # this intent. We populate this field only in the output.
1706 #
1707 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1708 "inputContextNames": [ # Optional. The list of context names required for this intent to be
1709 # triggered.
1710 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
1711 "A String",
1712 ],
1713 "action": "A String", # Optional. The name of the action associated with the intent.
1714 # Note: The action name must not contain whitespaces.
1715 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
1716 # is matched. Context messages in this collection should not set the
1717 # parameters field. Setting the `lifespan_count` to 0 will reset the context
1718 # when the intent is matched.
1719 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
1720 { # Represents a context.
1721 "parameters": { # Optional. The collection of parameters associated with this context.
1722 # Refer to [this
1723 # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
1724 # for syntax.
1725 "a_key": "", # Properties of the object.
1726 },
1727 "name": "A String", # Required. The unique identifier of the context. Format:
1728 # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
1729 #
1730 # The `Context ID` is always converted to lowercase, may only contain
1731 # characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
1732 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
1733 # context expires. If set to `0` (the default) the context expires
1734 # immediately. Contexts expire automatically after 20 minutes if there
1735 # are no matching queries.
1736 },
1737 ],
1738 "events": [ # Optional. The collection of event names that trigger the intent.
1739 # If the collection of input contexts is not empty, all of the contexts must
1740 # be present in the active user session for an event to trigger this intent.
1741 "A String",
1742 ],
1743 }</pre>
1744</div>
1745
1746<div class="method">
1747 <code class="details" id="list">list(parent, languageCode=None, pageSize=None, intentView=None, pageToken=None, x__xgafv=None)</code>
1748 <pre>Returns the list of all intents in the specified agent.
1749
1750Args:
1751 parent: string, Required. The agent to list all intents from.
1752Format: `projects/<Project ID>/agent`. (required)
1753 languageCode: string, Optional. The language to list training phrases, parameters and rich
1754messages for. If not specified, the agent's default language is used.
1755[Many
1756languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
1757are supported. Note: languages must be enabled in the agent before they can
1758be used.
1759 pageSize: integer, Optional. The maximum number of items to return in a single page. By
1760default 100 and at most 1000.
1761 intentView: string, Optional. The resource view to apply to the returned intent.
1762 pageToken: string, Optional. The next_page_token value returned from a previous list request.
1763 x__xgafv: string, V1 error format.
1764 Allowed values
1765 1 - v1 error format
1766 2 - v2 error format
1767
1768Returns:
1769 An object of the form:
1770
1771 { # The response message for Intents.ListIntents.
1772 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
1773 # more results in the list.
1774 "intents": [ # The list of agent intents. There will be a maximum number of items
1775 # returned based on the page_size field in the request.
1776 { # Represents an intent.
1777 # Intents convert a number of user expressions or patterns into an action. An
1778 # action is an extraction of a user command or sentence semantics.
1779 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
1780 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
1781 # Note: If `ml_diabled` setting is set to true, then this intent is not
1782 # taken into account during inference in `ML ONLY` match mode. Also,
1783 # auto-markup in the UI is turned off.
1784 "displayName": "A String", # Required. The name of this intent.
1785 "name": "A String", # The unique identifier of this intent.
1786 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
1787 # methods.
1788 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1789 "parameters": [ # Optional. The collection of parameters associated with the intent.
1790 { # Represents intent parameters.
1791 "displayName": "A String", # Required. The name of the parameter.
1792 "name": "A String", # The unique identifier of this parameter.
1793 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
1794 # result.
1795 # Default values can be extracted from contexts by using the following
1796 # syntax: `#context_name.parameter_name`.
1797 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
1798 # describes values of the parameter. If the parameter is
1799 # required, this must be provided.
1800 "value": "A String", # Optional. The definition of the parameter value. It can be:
1801 # - a constant string,
1802 # - a parameter value defined as `$parameter_name`,
1803 # - an original parameter value defined as `$parameter_name.original`,
1804 # - a parameter value from some context defined as
1805 # `#context_name.parameter_name`.
1806 "prompts": [ # Optional. The collection of prompts that the agent can present to the
1807 # user in order to collect value for the parameter.
1808 "A String",
1809 ],
1810 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
1811 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
1812 # whether the intent cannot be completed without collecting the parameter
1813 # value.
1814 },
1815 ],
1816 "trainingPhrases": [ # Optional. The collection of examples that the agent is
1817 # trained on.
1818 { # Represents an example that the agent is trained on.
1819 "parts": [ # Required. The ordered list of training phrase parts.
1820 # The parts are concatenated in order to form the training phrase.
1821 #
1822 # Note: The API does not automatically annotate training phrases like the
1823 # Dialogflow Console does.
1824 #
1825 # Note: Do not forget to include whitespace at part boundaries,
1826 # so the training phrase is well formatted when the parts are concatenated.
1827 #
1828 # If the training phrase does not need to be annotated with parameters,
1829 # you just need a single part with only the Part.text field set.
1830 #
1831 # If you want to annotate the training phrase, you must create multiple
1832 # parts, where the fields of each part are populated in one of two ways:
1833 #
1834 # - `Part.text` is set to a part of the phrase that has no parameters.
1835 # - `Part.text` is set to a part of the phrase that you want to annotate,
1836 # and the `entity_type`, `alias`, and `user_defined` fields are all
1837 # set.
1838 { # Represents a part of a training phrase.
1839 "alias": "A String", # Optional. The parameter name for the value extracted from the
1840 # annotated part of the example.
1841 # This field is required for annotated parts of the training phrase.
1842 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
1843 # This field is required for annotated parts of the training phrase.
1844 "text": "A String", # Required. The text for this part.
1845 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
1846 # This field is set to true when the Dialogflow Console is used to
1847 # manually annotate the part. When creating an annotated part with the
1848 # API, you must set this to true.
1849 },
1850 ],
1851 "type": "A String", # Required. The type of the training phrase.
1852 "name": "A String", # Output only. The unique identifier of this training phrase.
1853 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
1854 # the intent. Each time a developer adds an existing sample by editing an
1855 # intent or training, this counter is increased.
1856 },
1857 ],
1858 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
1859 # a direct or indirect parent. We populate this field only in the output.
1860 { # Represents a single followup intent in the chain.
1861 "followupIntentName": "A String", # The unique identifier of the followup intent.
1862 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1863 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
1864 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
1865 },
1866 ],
1867 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
1868 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
1869 # session when this intent is matched.
1870 "messages": [ # Optional. The collection of rich messages corresponding to the
1871 # `Response` field in the Dialogflow console.
1872 { # Corresponds to the `Response` field in the Dialogflow console.
1873 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
1874 # This message in `QueryResult.fulfillment_messages` and
1875 # `WebhookResponse.fulfillment_messages` should contain only one
1876 # `SimpleResponse`.
1877 "simpleResponses": [ # Required. The list of simple responses.
1878 { # The simple response message containing speech or text.
1879 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
1880 # speech output. Mutually exclusive with ssml.
1881 "displayText": "A String", # Optional. The text to display.
1882 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
1883 # response to the user in the SSML format. Mutually exclusive with
1884 # text_to_speech.
1885 },
1886 ],
1887 },
1888 "quickReplies": { # The quick replies response message. # The quick replies response.
1889 "quickReplies": [ # Optional. The collection of quick replies.
1890 "A String",
1891 ],
1892 "title": "A String", # Optional. The title of the collection of quick replies.
1893 },
1894 "platform": "A String", # Optional. The platform that this message is intended for.
1895 "text": { # The text response message. # The text response.
1896 "text": [ # Optional. The collection of the agent's responses.
1897 "A String",
1898 ],
1899 },
1900 "image": { # The image response message. # The image response.
1901 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1902 # e.g., screen readers.
1903 "imageUri": "A String", # Optional. The public URI to an image file.
1904 },
1905 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
1906 "suggestions": [ # Required. The list of suggested replies.
1907 { # The suggestion chip message that the user can tap to quickly post a reply
1908 # to the conversation.
1909 "title": "A String", # Required. The text shown the in the suggestion chip.
1910 },
1911 ],
1912 },
1913 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
1914 # or website associated with this agent.
1915 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
1916 # suggestion chip.
1917 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
1918 },
1919 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
1920 "buttons": [ # Optional. The collection of card buttons.
1921 { # The button object that appears at the bottom of a card.
1922 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1923 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1924 },
1925 "title": "A String", # Required. The title of the button.
1926 },
1927 ],
1928 "subtitle": "A String", # Optional. The subtitle of the card.
1929 "image": { # The image response message. # Optional. The image for the card.
1930 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1931 # e.g., screen readers.
1932 "imageUri": "A String", # Optional. The public URI to an image file.
1933 },
1934 "formattedText": "A String", # Required, unless image is present. The body text of the card.
1935 "title": "A String", # Optional. The title of the card.
1936 },
1937 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
1938 "items": [ # Required. Carousel items.
1939 { # An item in the carousel.
1940 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
1941 # dialog.
1942 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1943 # item in dialog.
1944 "A String",
1945 ],
1946 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1947 # response is given.
1948 },
1949 "image": { # The image response message. # Optional. The image to display.
1950 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1951 # e.g., screen readers.
1952 "imageUri": "A String", # Optional. The public URI to an image file.
1953 },
1954 "description": "A String", # Optional. The body text of the card.
1955 "title": "A String", # Required. Title of the carousel item.
1956 },
1957 ],
1958 },
1959 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
1960 "items": [ # Required. List items.
1961 { # An item in the list.
1962 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
1963 # dialog.
1964 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1965 # item in dialog.
1966 "A String",
1967 ],
1968 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1969 # response is given.
1970 },
1971 "image": { # The image response message. # Optional. The image to display.
1972 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1973 # e.g., screen readers.
1974 "imageUri": "A String", # Optional. The public URI to an image file.
1975 },
1976 "description": "A String", # Optional. The main text describing the item.
1977 "title": "A String", # Required. The title of the list item.
1978 },
1979 ],
1980 "title": "A String", # Optional. The overall title of the list.
1981 },
1982 "payload": { # Returns a response containing a custom, platform-specific payload.
1983 # See the Intent.Message.Platform type for a description of the
1984 # structure that may be required for your platform.
1985 "a_key": "", # Properties of the object.
1986 },
1987 "card": { # The card response message. # The card response.
1988 "buttons": [ # Optional. The collection of card buttons.
1989 { # Optional. Contains information about a button.
1990 "text": "A String", # Optional. The text to show on the button.
1991 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1992 # open.
1993 },
1994 ],
1995 "title": "A String", # Optional. The title of the card.
1996 "subtitle": "A String", # Optional. The subtitle of the card.
1997 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1998 },
1999 },
2000 ],
2001 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
2002 # chain of followup intents. You can set this field when creating an intent,
2003 # for example with CreateIntent or BatchUpdateIntents, in order to
2004 # make this intent a followup intent.
2005 #
2006 # It identifies the parent followup intent.
2007 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2008 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
2009 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
2010 "A String",
2011 ],
2012 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
2013 # priorities. If this is zero or unspecified, we use the default
2014 # priority 500000.
2015 #
2016 # Negative numbers mean that the intent is disabled.
2017 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
2018 # followup intents. It identifies the correct followup intents chain for
2019 # this intent. We populate this field only in the output.
2020 #
2021 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2022 "inputContextNames": [ # Optional. The list of context names required for this intent to be
2023 # triggered.
2024 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
2025 "A String",
2026 ],
2027 "action": "A String", # Optional. The name of the action associated with the intent.
2028 # Note: The action name must not contain whitespaces.
2029 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
2030 # is matched. Context messages in this collection should not set the
2031 # parameters field. Setting the `lifespan_count` to 0 will reset the context
2032 # when the intent is matched.
2033 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
2034 { # Represents a context.
2035 "parameters": { # Optional. The collection of parameters associated with this context.
2036 # Refer to [this
2037 # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
2038 # for syntax.
2039 "a_key": "", # Properties of the object.
2040 },
2041 "name": "A String", # Required. The unique identifier of the context. Format:
2042 # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
2043 #
2044 # The `Context ID` is always converted to lowercase, may only contain
2045 # characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
2046 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
2047 # context expires. If set to `0` (the default) the context expires
2048 # immediately. Contexts expire automatically after 20 minutes if there
2049 # are no matching queries.
2050 },
2051 ],
2052 "events": [ # Optional. The collection of event names that trigger the intent.
2053 # If the collection of input contexts is not empty, all of the contexts must
2054 # be present in the active user session for an event to trigger this intent.
2055 "A String",
2056 ],
2057 },
2058 ],
2059 }</pre>
2060</div>
2061
2062<div class="method">
2063 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2064 <pre>Retrieves the next page of results.
2065
2066Args:
2067 previous_request: The request for the previous page. (required)
2068 previous_response: The response from the request for the previous page. (required)
2069
2070Returns:
2071 A request object that you can call 'execute()' on to request the next
2072 page. Returns None if there are no more items in the collection.
2073 </pre>
2074</div>
2075
2076<div class="method">
2077 <code class="details" id="patch">patch(name, body, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)</code>
2078 <pre>Updates the specified intent.
2079
2080Args:
2081 name: string, The unique identifier of this intent.
2082Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2083methods.
2084Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)
2085 body: object, The request body. (required)
2086 The object takes the form of:
2087
2088{ # Represents an intent.
2089 # Intents convert a number of user expressions or patterns into an action. An
2090 # action is an extraction of a user command or sentence semantics.
2091 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
2092 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
2093 # Note: If `ml_diabled` setting is set to true, then this intent is not
2094 # taken into account during inference in `ML ONLY` match mode. Also,
2095 # auto-markup in the UI is turned off.
2096 "displayName": "A String", # Required. The name of this intent.
2097 "name": "A String", # The unique identifier of this intent.
2098 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2099 # methods.
2100 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2101 "parameters": [ # Optional. The collection of parameters associated with the intent.
2102 { # Represents intent parameters.
2103 "displayName": "A String", # Required. The name of the parameter.
2104 "name": "A String", # The unique identifier of this parameter.
2105 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
2106 # result.
2107 # Default values can be extracted from contexts by using the following
2108 # syntax: `#context_name.parameter_name`.
2109 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
2110 # describes values of the parameter. If the parameter is
2111 # required, this must be provided.
2112 "value": "A String", # Optional. The definition of the parameter value. It can be:
2113 # - a constant string,
2114 # - a parameter value defined as `$parameter_name`,
2115 # - an original parameter value defined as `$parameter_name.original`,
2116 # - a parameter value from some context defined as
2117 # `#context_name.parameter_name`.
2118 "prompts": [ # Optional. The collection of prompts that the agent can present to the
2119 # user in order to collect value for the parameter.
2120 "A String",
2121 ],
2122 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
2123 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
2124 # whether the intent cannot be completed without collecting the parameter
2125 # value.
2126 },
2127 ],
2128 "trainingPhrases": [ # Optional. The collection of examples that the agent is
2129 # trained on.
2130 { # Represents an example that the agent is trained on.
2131 "parts": [ # Required. The ordered list of training phrase parts.
2132 # The parts are concatenated in order to form the training phrase.
2133 #
2134 # Note: The API does not automatically annotate training phrases like the
2135 # Dialogflow Console does.
2136 #
2137 # Note: Do not forget to include whitespace at part boundaries,
2138 # so the training phrase is well formatted when the parts are concatenated.
2139 #
2140 # If the training phrase does not need to be annotated with parameters,
2141 # you just need a single part with only the Part.text field set.
2142 #
2143 # If you want to annotate the training phrase, you must create multiple
2144 # parts, where the fields of each part are populated in one of two ways:
2145 #
2146 # - `Part.text` is set to a part of the phrase that has no parameters.
2147 # - `Part.text` is set to a part of the phrase that you want to annotate,
2148 # and the `entity_type`, `alias`, and `user_defined` fields are all
2149 # set.
2150 { # Represents a part of a training phrase.
2151 "alias": "A String", # Optional. The parameter name for the value extracted from the
2152 # annotated part of the example.
2153 # This field is required for annotated parts of the training phrase.
2154 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
2155 # This field is required for annotated parts of the training phrase.
2156 "text": "A String", # Required. The text for this part.
2157 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
2158 # This field is set to true when the Dialogflow Console is used to
2159 # manually annotate the part. When creating an annotated part with the
2160 # API, you must set this to true.
2161 },
2162 ],
2163 "type": "A String", # Required. The type of the training phrase.
2164 "name": "A String", # Output only. The unique identifier of this training phrase.
2165 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
2166 # the intent. Each time a developer adds an existing sample by editing an
2167 # intent or training, this counter is increased.
2168 },
2169 ],
2170 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
2171 # a direct or indirect parent. We populate this field only in the output.
2172 { # Represents a single followup intent in the chain.
2173 "followupIntentName": "A String", # The unique identifier of the followup intent.
2174 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2175 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
2176 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2177 },
2178 ],
2179 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
2180 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
2181 # session when this intent is matched.
2182 "messages": [ # Optional. The collection of rich messages corresponding to the
2183 # `Response` field in the Dialogflow console.
2184 { # Corresponds to the `Response` field in the Dialogflow console.
2185 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
2186 # This message in `QueryResult.fulfillment_messages` and
2187 # `WebhookResponse.fulfillment_messages` should contain only one
2188 # `SimpleResponse`.
2189 "simpleResponses": [ # Required. The list of simple responses.
2190 { # The simple response message containing speech or text.
2191 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
2192 # speech output. Mutually exclusive with ssml.
2193 "displayText": "A String", # Optional. The text to display.
2194 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
2195 # response to the user in the SSML format. Mutually exclusive with
2196 # text_to_speech.
2197 },
2198 ],
2199 },
2200 "quickReplies": { # The quick replies response message. # The quick replies response.
2201 "quickReplies": [ # Optional. The collection of quick replies.
2202 "A String",
2203 ],
2204 "title": "A String", # Optional. The title of the collection of quick replies.
2205 },
2206 "platform": "A String", # Optional. The platform that this message is intended for.
2207 "text": { # The text response message. # The text response.
2208 "text": [ # Optional. The collection of the agent's responses.
2209 "A String",
2210 ],
2211 },
2212 "image": { # The image response message. # The image response.
2213 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2214 # e.g., screen readers.
2215 "imageUri": "A String", # Optional. The public URI to an image file.
2216 },
2217 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
2218 "suggestions": [ # Required. The list of suggested replies.
2219 { # The suggestion chip message that the user can tap to quickly post a reply
2220 # to the conversation.
2221 "title": "A String", # Required. The text shown the in the suggestion chip.
2222 },
2223 ],
2224 },
2225 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
2226 # or website associated with this agent.
2227 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
2228 # suggestion chip.
2229 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
2230 },
2231 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
2232 "buttons": [ # Optional. The collection of card buttons.
2233 { # The button object that appears at the bottom of a card.
2234 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2235 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2236 },
2237 "title": "A String", # Required. The title of the button.
2238 },
2239 ],
2240 "subtitle": "A String", # Optional. The subtitle of the card.
2241 "image": { # The image response message. # Optional. The image for the card.
2242 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2243 # e.g., screen readers.
2244 "imageUri": "A String", # Optional. The public URI to an image file.
2245 },
2246 "formattedText": "A String", # Required, unless image is present. The body text of the card.
2247 "title": "A String", # Optional. The title of the card.
2248 },
2249 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
2250 "items": [ # Required. Carousel items.
2251 { # An item in the carousel.
2252 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2253 # dialog.
2254 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2255 # item in dialog.
2256 "A String",
2257 ],
2258 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2259 # response is given.
2260 },
2261 "image": { # The image response message. # Optional. The image to display.
2262 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2263 # e.g., screen readers.
2264 "imageUri": "A String", # Optional. The public URI to an image file.
2265 },
2266 "description": "A String", # Optional. The body text of the card.
2267 "title": "A String", # Required. Title of the carousel item.
2268 },
2269 ],
2270 },
2271 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
2272 "items": [ # Required. List items.
2273 { # An item in the list.
2274 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
2275 # dialog.
2276 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2277 # item in dialog.
2278 "A String",
2279 ],
2280 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2281 # response is given.
2282 },
2283 "image": { # The image response message. # Optional. The image to display.
2284 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2285 # e.g., screen readers.
2286 "imageUri": "A String", # Optional. The public URI to an image file.
2287 },
2288 "description": "A String", # Optional. The main text describing the item.
2289 "title": "A String", # Required. The title of the list item.
2290 },
2291 ],
2292 "title": "A String", # Optional. The overall title of the list.
2293 },
2294 "payload": { # Returns a response containing a custom, platform-specific payload.
2295 # See the Intent.Message.Platform type for a description of the
2296 # structure that may be required for your platform.
2297 "a_key": "", # Properties of the object.
2298 },
2299 "card": { # The card response message. # The card response.
2300 "buttons": [ # Optional. The collection of card buttons.
2301 { # Optional. Contains information about a button.
2302 "text": "A String", # Optional. The text to show on the button.
2303 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
2304 # open.
2305 },
2306 ],
2307 "title": "A String", # Optional. The title of the card.
2308 "subtitle": "A String", # Optional. The subtitle of the card.
2309 "imageUri": "A String", # Optional. The public URI to an image file for the card.
2310 },
2311 },
2312 ],
2313 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
2314 # chain of followup intents. You can set this field when creating an intent,
2315 # for example with CreateIntent or BatchUpdateIntents, in order to
2316 # make this intent a followup intent.
2317 #
2318 # It identifies the parent followup intent.
2319 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2320 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
2321 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
2322 "A String",
2323 ],
2324 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
2325 # priorities. If this is zero or unspecified, we use the default
2326 # priority 500000.
2327 #
2328 # Negative numbers mean that the intent is disabled.
2329 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
2330 # followup intents. It identifies the correct followup intents chain for
2331 # this intent. We populate this field only in the output.
2332 #
2333 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2334 "inputContextNames": [ # Optional. The list of context names required for this intent to be
2335 # triggered.
2336 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
2337 "A String",
2338 ],
2339 "action": "A String", # Optional. The name of the action associated with the intent.
2340 # Note: The action name must not contain whitespaces.
2341 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
2342 # is matched. Context messages in this collection should not set the
2343 # parameters field. Setting the `lifespan_count` to 0 will reset the context
2344 # when the intent is matched.
2345 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
2346 { # Represents a context.
2347 "parameters": { # Optional. The collection of parameters associated with this context.
2348 # Refer to [this
2349 # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
2350 # for syntax.
2351 "a_key": "", # Properties of the object.
2352 },
2353 "name": "A String", # Required. The unique identifier of the context. Format:
2354 # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
2355 #
2356 # The `Context ID` is always converted to lowercase, may only contain
2357 # characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
2358 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
2359 # context expires. If set to `0` (the default) the context expires
2360 # immediately. Contexts expire automatically after 20 minutes if there
2361 # are no matching queries.
2362 },
2363 ],
2364 "events": [ # Optional. The collection of event names that trigger the intent.
2365 # If the collection of input contexts is not empty, all of the contexts must
2366 # be present in the active user session for an event to trigger this intent.
2367 "A String",
2368 ],
2369}
2370
2371 languageCode: string, Optional. The language of training phrases, parameters and rich messages
2372defined in `intent`. If not specified, the agent's default language is
2373used. [Many
2374languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
2375are supported. Note: languages must be enabled in the agent before they can
2376be used.
2377 intentView: string, Optional. The resource view to apply to the returned intent.
2378 updateMask: string, Optional. The mask to control which fields get updated.
2379 x__xgafv: string, V1 error format.
2380 Allowed values
2381 1 - v1 error format
2382 2 - v2 error format
2383
2384Returns:
2385 An object of the form:
2386
2387 { # Represents an intent.
2388 # Intents convert a number of user expressions or patterns into an action. An
2389 # action is an extraction of a user command or sentence semantics.
2390 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
2391 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
2392 # Note: If `ml_diabled` setting is set to true, then this intent is not
2393 # taken into account during inference in `ML ONLY` match mode. Also,
2394 # auto-markup in the UI is turned off.
2395 "displayName": "A String", # Required. The name of this intent.
2396 "name": "A String", # The unique identifier of this intent.
2397 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2398 # methods.
2399 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2400 "parameters": [ # Optional. The collection of parameters associated with the intent.
2401 { # Represents intent parameters.
2402 "displayName": "A String", # Required. The name of the parameter.
2403 "name": "A String", # The unique identifier of this parameter.
2404 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
2405 # result.
2406 # Default values can be extracted from contexts by using the following
2407 # syntax: `#context_name.parameter_name`.
2408 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
2409 # describes values of the parameter. If the parameter is
2410 # required, this must be provided.
2411 "value": "A String", # Optional. The definition of the parameter value. It can be:
2412 # - a constant string,
2413 # - a parameter value defined as `$parameter_name`,
2414 # - an original parameter value defined as `$parameter_name.original`,
2415 # - a parameter value from some context defined as
2416 # `#context_name.parameter_name`.
2417 "prompts": [ # Optional. The collection of prompts that the agent can present to the
2418 # user in order to collect value for the parameter.
2419 "A String",
2420 ],
2421 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
2422 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
2423 # whether the intent cannot be completed without collecting the parameter
2424 # value.
2425 },
2426 ],
2427 "trainingPhrases": [ # Optional. The collection of examples that the agent is
2428 # trained on.
2429 { # Represents an example that the agent is trained on.
2430 "parts": [ # Required. The ordered list of training phrase parts.
2431 # The parts are concatenated in order to form the training phrase.
2432 #
2433 # Note: The API does not automatically annotate training phrases like the
2434 # Dialogflow Console does.
2435 #
2436 # Note: Do not forget to include whitespace at part boundaries,
2437 # so the training phrase is well formatted when the parts are concatenated.
2438 #
2439 # If the training phrase does not need to be annotated with parameters,
2440 # you just need a single part with only the Part.text field set.
2441 #
2442 # If you want to annotate the training phrase, you must create multiple
2443 # parts, where the fields of each part are populated in one of two ways:
2444 #
2445 # - `Part.text` is set to a part of the phrase that has no parameters.
2446 # - `Part.text` is set to a part of the phrase that you want to annotate,
2447 # and the `entity_type`, `alias`, and `user_defined` fields are all
2448 # set.
2449 { # Represents a part of a training phrase.
2450 "alias": "A String", # Optional. The parameter name for the value extracted from the
2451 # annotated part of the example.
2452 # This field is required for annotated parts of the training phrase.
2453 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
2454 # This field is required for annotated parts of the training phrase.
2455 "text": "A String", # Required. The text for this part.
2456 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
2457 # This field is set to true when the Dialogflow Console is used to
2458 # manually annotate the part. When creating an annotated part with the
2459 # API, you must set this to true.
2460 },
2461 ],
2462 "type": "A String", # Required. The type of the training phrase.
2463 "name": "A String", # Output only. The unique identifier of this training phrase.
2464 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
2465 # the intent. Each time a developer adds an existing sample by editing an
2466 # intent or training, this counter is increased.
2467 },
2468 ],
2469 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
2470 # a direct or indirect parent. We populate this field only in the output.
2471 { # Represents a single followup intent in the chain.
2472 "followupIntentName": "A String", # The unique identifier of the followup intent.
2473 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2474 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
2475 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2476 },
2477 ],
2478 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
2479 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
2480 # session when this intent is matched.
2481 "messages": [ # Optional. The collection of rich messages corresponding to the
2482 # `Response` field in the Dialogflow console.
2483 { # Corresponds to the `Response` field in the Dialogflow console.
2484 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
2485 # This message in `QueryResult.fulfillment_messages` and
2486 # `WebhookResponse.fulfillment_messages` should contain only one
2487 # `SimpleResponse`.
2488 "simpleResponses": [ # Required. The list of simple responses.
2489 { # The simple response message containing speech or text.
2490 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
2491 # speech output. Mutually exclusive with ssml.
2492 "displayText": "A String", # Optional. The text to display.
2493 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
2494 # response to the user in the SSML format. Mutually exclusive with
2495 # text_to_speech.
2496 },
2497 ],
2498 },
2499 "quickReplies": { # The quick replies response message. # The quick replies response.
2500 "quickReplies": [ # Optional. The collection of quick replies.
2501 "A String",
2502 ],
2503 "title": "A String", # Optional. The title of the collection of quick replies.
2504 },
2505 "platform": "A String", # Optional. The platform that this message is intended for.
2506 "text": { # The text response message. # The text response.
2507 "text": [ # Optional. The collection of the agent's responses.
2508 "A String",
2509 ],
2510 },
2511 "image": { # The image response message. # The image response.
2512 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2513 # e.g., screen readers.
2514 "imageUri": "A String", # Optional. The public URI to an image file.
2515 },
2516 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
2517 "suggestions": [ # Required. The list of suggested replies.
2518 { # The suggestion chip message that the user can tap to quickly post a reply
2519 # to the conversation.
2520 "title": "A String", # Required. The text shown the in the suggestion chip.
2521 },
2522 ],
2523 },
2524 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
2525 # or website associated with this agent.
2526 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
2527 # suggestion chip.
2528 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
2529 },
2530 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
2531 "buttons": [ # Optional. The collection of card buttons.
2532 { # The button object that appears at the bottom of a card.
2533 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2534 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2535 },
2536 "title": "A String", # Required. The title of the button.
2537 },
2538 ],
2539 "subtitle": "A String", # Optional. The subtitle of the card.
2540 "image": { # The image response message. # Optional. The image for the card.
2541 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2542 # e.g., screen readers.
2543 "imageUri": "A String", # Optional. The public URI to an image file.
2544 },
2545 "formattedText": "A String", # Required, unless image is present. The body text of the card.
2546 "title": "A String", # Optional. The title of the card.
2547 },
2548 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
2549 "items": [ # Required. Carousel items.
2550 { # An item in the carousel.
2551 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2552 # dialog.
2553 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2554 # item in dialog.
2555 "A String",
2556 ],
2557 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2558 # response is given.
2559 },
2560 "image": { # The image response message. # Optional. The image to display.
2561 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2562 # e.g., screen readers.
2563 "imageUri": "A String", # Optional. The public URI to an image file.
2564 },
2565 "description": "A String", # Optional. The body text of the card.
2566 "title": "A String", # Required. Title of the carousel item.
2567 },
2568 ],
2569 },
2570 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
2571 "items": [ # Required. List items.
2572 { # An item in the list.
2573 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
2574 # dialog.
2575 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2576 # item in dialog.
2577 "A String",
2578 ],
2579 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2580 # response is given.
2581 },
2582 "image": { # The image response message. # Optional. The image to display.
2583 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2584 # e.g., screen readers.
2585 "imageUri": "A String", # Optional. The public URI to an image file.
2586 },
2587 "description": "A String", # Optional. The main text describing the item.
2588 "title": "A String", # Required. The title of the list item.
2589 },
2590 ],
2591 "title": "A String", # Optional. The overall title of the list.
2592 },
2593 "payload": { # Returns a response containing a custom, platform-specific payload.
2594 # See the Intent.Message.Platform type for a description of the
2595 # structure that may be required for your platform.
2596 "a_key": "", # Properties of the object.
2597 },
2598 "card": { # The card response message. # The card response.
2599 "buttons": [ # Optional. The collection of card buttons.
2600 { # Optional. Contains information about a button.
2601 "text": "A String", # Optional. The text to show on the button.
2602 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
2603 # open.
2604 },
2605 ],
2606 "title": "A String", # Optional. The title of the card.
2607 "subtitle": "A String", # Optional. The subtitle of the card.
2608 "imageUri": "A String", # Optional. The public URI to an image file for the card.
2609 },
2610 },
2611 ],
2612 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
2613 # chain of followup intents. You can set this field when creating an intent,
2614 # for example with CreateIntent or BatchUpdateIntents, in order to
2615 # make this intent a followup intent.
2616 #
2617 # It identifies the parent followup intent.
2618 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2619 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
2620 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
2621 "A String",
2622 ],
2623 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
2624 # priorities. If this is zero or unspecified, we use the default
2625 # priority 500000.
2626 #
2627 # Negative numbers mean that the intent is disabled.
2628 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
2629 # followup intents. It identifies the correct followup intents chain for
2630 # this intent. We populate this field only in the output.
2631 #
2632 # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
2633 "inputContextNames": [ # Optional. The list of context names required for this intent to be
2634 # triggered.
2635 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
2636 "A String",
2637 ],
2638 "action": "A String", # Optional. The name of the action associated with the intent.
2639 # Note: The action name must not contain whitespaces.
2640 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
2641 # is matched. Context messages in this collection should not set the
2642 # parameters field. Setting the `lifespan_count` to 0 will reset the context
2643 # when the intent is matched.
2644 # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
2645 { # Represents a context.
2646 "parameters": { # Optional. The collection of parameters associated with this context.
2647 # Refer to [this
2648 # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
2649 # for syntax.
2650 "a_key": "", # Properties of the object.
2651 },
2652 "name": "A String", # Required. The unique identifier of the context. Format:
2653 # `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
2654 #
2655 # The `Context ID` is always converted to lowercase, may only contain
2656 # characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
2657 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
2658 # context expires. If set to `0` (the default) the context expires
2659 # immediately. Contexts expire automatically after 20 minutes if there
2660 # are no matching queries.
2661 },
2662 ],
2663 "events": [ # Optional. The collection of event names that trigger the intent.
2664 # If the collection of input contexts is not empty, all of the contexts must
2665 # be present in the active user session for an event to trigger this intent.
2666 "A String",
2667 ],
2668 }</pre>
2669</div>
2670
2671</body></html>