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