Blame - docs/dyn/dialogflow_v2beta1.projects.agent.intents.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

79

<p class="firstline">Deletes intents in the specified agent. Operation </p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">Updates/Creates multiple intents in the specified agent. Operation </p>

83

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

87

<code><a href="#create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Creates an intent in the specified agent.</p>

89

90

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

91

<p class="firstline">Deletes the specified intent and its direct or indirect followup intents.</p>

92

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

93

<code><a href="#get">get(name, languageCode=None, intentView=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Retrieves the specified intent.</p>

95

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

96

<code><a href="#list">list(parent, pageToken=None, languageCode=None, pageSize=None, intentView=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Returns the list of all intents in the specified agent.</p>

98

99

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

100

<p class="firstline">Retrieves the next page of results.</p>

101

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

102

<code><a href="#patch">patch(name, body=None, intentView=None, languageCode=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<p class="firstline">Updates the specified intent.</p>

104

<h3>Method Details</h3>

105

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

106

<code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

107

<pre>Deletes intents in the specified agent. Operation

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

108

109

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

110

parent: string, Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

111

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

The object takes the form of:

113

114

{ # The request message for Intents.BatchDeleteIntents.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

115

"intents": [ # Required. The collection of intents to delete. Only intent `name` must be filled in.

116

{ # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

117

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

118

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

119

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

120

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

121

"events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

122

"A String",

123

],

124

"displayName": "A String", # Required. The name of this intent.

125

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

126

"parameters": [ # Optional. The collection of parameters associated with the intent.

127

{ # Represents intent parameters.

128

"name": "A String", # The unique identifier of this parameter.

129

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.

130

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

131

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.

132

"value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.

133

"displayName": "A String", # Required. The name of the parameter.

134

"prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

135

"A String",

136

],

137

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

138

},

139

],

140

"trainingPhrases": [ # Optional. The collection of examples that the agent is trained on.

141

{ # Represents an example that the agent is trained on.

142

"type": "A String", # Required. The type of the training phrase.

143

"name": "A String", # Output only. The unique identifier of this training phrase.

144

"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.

145

{ # Represents a part of a training phrase.

146

"text": "A String", # Required. The text for this part.

147

"alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

148

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

149

"entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.

150

},

151

],

152

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

153

},

154

],

155

"inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`

156

"A String",

157

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

158

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

159

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

160

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.

161

{ # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

162

"parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

163

"a_key": "", # Properties of the object.

164

},

165

"name": "A String", # Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

166

"lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

167

},

168

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

169

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.

170

"action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

171

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.

172

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

173

"messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

174

{ # Corresponds to the `Response` field in the Dialogflow console.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

175

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google.

176

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items.

177

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

178

{ # Browsing carousel tile

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

179

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

180

"url": "A String", # Required. URL

181

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

182

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

183

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

184

"image": { # The image response message. # Optional. Hero image for the carousel item.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

185

"imageUri": "A String", # Optional. The public URI to an image file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

186

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

187

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

188

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

189

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

190

},

191

],

192

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

193

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

194

"phoneNumber": "A String", # Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

195

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

196

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

197

"suggestions": [ # Required. The list of suggested replies.

198

{ # The suggestion chip message that the user can tap to quickly post a reply to the conversation.

199

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

},

201

],

202

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

203

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

204

"items": [ # Required. List items.

205

{ # An item in the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

206

"image": { # The image response message. # Optional. The image to display.

207

"imageUri": "A String", # Optional. The public URI to an image file.

208

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

209

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

210

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

211

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

212

"A String",

213

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

214

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

215

},

216

"title": "A String", # Required. The title of the list item.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

217

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

218

},

219

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

220

"subtitle": "A String", # Optional. Subtitle of the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

221

"title": "A String", # Optional. The overall title of the list.

222

},

223

"image": { # The image response message. # Displays an image.

224

"imageUri": "A String", # Optional. The public URI to an image file.

225

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

226

},

227

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # Displays a link out suggestion chip for Actions on Google.

228

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

229

"uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip.

230

},

231

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

232

"buttons": [ # Optional. The collection of card buttons.

233

{ # The button object that appears at the bottom of a card.

234

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

235

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

236

},

237

"title": "A String", # Required. The title of the button.

238

},

239

],

240

"formattedText": "A String", # Required, unless image is present. The body text of the card.

241

"image": { # The image response message. # Optional. The image for the card.

242

"imageUri": "A String", # Optional. The public URI to an image file.

243

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

244

},

245

"title": "A String", # Optional. The title of the card.

246

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

247

},

248

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

249

"items": [ # Required. Carousel items.

250

{ # An item in the carousel.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

251

"image": { # The image response message. # Optional. The image to display.

252

"imageUri": "A String", # Optional. The public URI to an image file.

253

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

254

},

255

"title": "A String", # Required. Title of the carousel item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

256

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

257

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

258

"A String",

259

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

260

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

261

},

262

"description": "A String", # Optional. The body text of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

263

},

264

],

265

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

266

"text": { # The text response message. # Returns a text response.

267

"text": [ # Optional. The collection of the agent's responses.

268

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

269

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

270

},

271

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

272

"title": "A String", # Required. Title of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

273

"image": { # The image response message. # Optional. Image which should be displayed on the card.

274

"imageUri": "A String", # Optional. The public URI to an image file.

275

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

276

},

277

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

278

"rows": [ # Optional. Rows in this table of data.

279

{ # Row of TableCard.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

280

"cells": [ # Optional. List of cells that make up this row.

281

{ # Cell of TableCardRow.

282

"text": "A String", # Required. Text in this cell.

283

},

284

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

285

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

286

},

287

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

288

"columnProperties": [ # Optional. Display properties for the columns in this table.

289

{ # Column properties for TableCard.

290

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

291

"header": "A String", # Required. Column heading.

292

},

293

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

294

"buttons": [ # Optional. List of buttons for the card.

295

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

296

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

297

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

298

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

299

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

},

301

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

302

},

303

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. # Rich Business Messaging (RBM) carousel rich card response.

304

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

305

{ # Rich Business Messaging (RBM) Card content

306

"suggestions": [ # Optional. List of suggestions to include in the card.

307

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

308

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

309

"text": "A String", # Suggested reply text.

310

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

311

},

312

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

313

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

314

"uri": "A String", # Required. The uri to open on the user device

315

},

316

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

317

},

318

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

319

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

320

},

321

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

322

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

327

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

328

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

329

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

330

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

331

},

332

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

333

},

334

],

335

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

336

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

337

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

338

"subtitle": "A String", # Optional. The subtitle of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

339

"imageUri": "A String", # Optional. The public URI to an image file for the card.

340

"title": "A String", # Optional. The title of the card.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

341

"buttons": [ # Optional. The collection of card buttons.

342

{ # Optional. Contains information about a button.

343

"text": "A String", # Optional. The text to show on the button.

344

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

345

},

346

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

347

},

348

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

349

"mediaObjects": [ # Required. List of media objects.

350

{ # Response media object for media content card.

351

"description": "A String", # Optional. Description of media card.

352

"contentUrl": "A String", # Required. Url where the media is stored.

353

"name": "A String", # Required. Name of media card.

354

"largeImage": { # The image response message. # Optional. Image to display above media content.

355

"imageUri": "A String", # Optional. The public URI to an image file.

356

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

357

},

358

"icon": { # The image response message. # Optional. Icon to display above media content.

359

"imageUri": "A String", # Optional. The public URI to an image file.

360

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

365

},

366

"platform": "A String", # Optional. The platform that this message is intended for.

367

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. # Standalone Rich Business Messaging (RBM) rich card response.

368

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

369

"suggestions": [ # Optional. List of suggestions to include in the card.

370

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

371

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

372

"text": "A String", # Suggested reply text.

373

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

374

},

375

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

376

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

377

"uri": "A String", # Required. The uri to open on the user device

378

},

379

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

380

},

381

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

382

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

383

},

384

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

385

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

390

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

391

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

392

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

393

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

394

},

395

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

396

},

397

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

398

"cardOrientation": "A String", # Required. Orientation of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

399

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

400

"payload": { # A custom platform-specific response.

401

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

402

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

403

"simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # Returns a voice or text-only response for Actions on Google.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

404

"simpleResponses": [ # Required. The list of simple responses.

405

{ # The simple response message containing speech or text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

406

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

407

"displayText": "A String", # Optional. The text to display.

408

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

409

},

410

],

411

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

412

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

413

"text": "A String", # Required. Text sent and displayed to the user.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

414

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

415

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

416

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

417

"text": "A String", # Suggested reply text.

418

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

419

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

420

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

421

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

422

"uri": "A String", # Required. The uri to open on the user device

423

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

424

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

425

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

426

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

427

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

428

},

429

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

430

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

431

},

432

},

433

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

434

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

435

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

436

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.

437

},

438

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. # Synthesizes speech in Telephony Gateway.

439

"text": "A String", # The raw text to be synthesized.

440

"ssml": "A String", # The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

441

},

442

"quickReplies": { # The quick replies response message. # Displays quick replies.

443

"quickReplies": [ # Optional. The collection of quick replies.

444

"A String",

445

],

446

"title": "A String", # Optional. The title of the collection of quick replies.

447

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

448

},

449

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

450

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

451

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

452

"name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`

453

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

454

{ # Represents a single followup intent in the chain.

455

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.

456

"followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`.

457

},

458

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

470

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

471

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

472

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

473

"a_key": "", # Properties of the object. Contains field @type with type URL.

474

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

475

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

476

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

477

{

478

"a_key": "", # Properties of the object. Contains field @type with type URL.

479

},

480

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

481

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

482

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

483

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

484

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

485

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

486

"a_key": "", # Properties of the object. Contains field @type with type URL.

487

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

488

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

493

<code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

494

<pre>Updates/Creates multiple intents in the specified agent. Operation

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

495

496

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

497

parent: string, Required. The name of the agent to update or create intents in. Supported formats: - `projects//agent` - `projects//locations//agent` (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

498

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

499

The object takes the form of:

500

501

{ # The request message for Intents.BatchUpdateIntents.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

502

"intentBatchInline": { # This message is a wrapper around a collection of intents. # The collection of intents to update or create.

503

"intents": [ # A collection of intents.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

504

{ # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

505

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

506

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

507

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

508

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

509

"events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

510

"A String",

511

],

512

"displayName": "A String", # Required. The name of this intent.

513

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

514

"parameters": [ # Optional. The collection of parameters associated with the intent.

515

{ # Represents intent parameters.

516

"name": "A String", # The unique identifier of this parameter.

517

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.

518

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

519

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.

520

"value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.

521

"displayName": "A String", # Required. The name of the parameter.

522

"prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

523

"A String",

524

],

525

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

526

},

527

],

528

"trainingPhrases": [ # Optional. The collection of examples that the agent is trained on.

529

{ # Represents an example that the agent is trained on.

530

"type": "A String", # Required. The type of the training phrase.

531

"name": "A String", # Output only. The unique identifier of this training phrase.

532

"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.

533

{ # Represents a part of a training phrase.

534

"text": "A String", # Required. The text for this part.

535

"alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

536

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

537

"entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.

538

},

539

],

540

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

541

},

542

],

543

"inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`

544

"A String",

545

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

546

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

547

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

548

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.

549

{ # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

550

"parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

551

"a_key": "", # Properties of the object.

552

},

553

"name": "A String", # Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

554

"lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

555

},

556

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

557

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.

558

"action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

559

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.

560

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

561

"messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

562

{ # Corresponds to the `Response` field in the Dialogflow console.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

563

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google.

564

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items.

565

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

566

{ # Browsing carousel tile

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

567

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

568

"url": "A String", # Required. URL

569

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

570

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

571

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

572

"image": { # The image response message. # Optional. Hero image for the carousel item.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

573

"imageUri": "A String", # Optional. The public URI to an image file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

574

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

575

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

576

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

577

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

578

},

579

],

580

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

581

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

582

"phoneNumber": "A String", # Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

583

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

584

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

585

"suggestions": [ # Required. The list of suggested replies.

586

{ # The suggestion chip message that the user can tap to quickly post a reply to the conversation.

587

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

588

},

589

],

590

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

591

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

592

"items": [ # Required. List items.

593

{ # An item in the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

594

"image": { # The image response message. # Optional. The image to display.

595

"imageUri": "A String", # Optional. The public URI to an image file.

596

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

597

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

598

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

599

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

600

"A String",

601

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

602

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

603

},

604

"title": "A String", # Required. The title of the list item.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

605

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

606

},

607

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

608

"subtitle": "A String", # Optional. Subtitle of the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

609

"title": "A String", # Optional. The overall title of the list.

610

},

611

"image": { # The image response message. # Displays an image.

612

"imageUri": "A String", # Optional. The public URI to an image file.

613

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

614

},

615

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # Displays a link out suggestion chip for Actions on Google.

616

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

617

"uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip.

618

},

619

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

620

"buttons": [ # Optional. The collection of card buttons.

621

{ # The button object that appears at the bottom of a card.

622

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

623

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

624

},

625

"title": "A String", # Required. The title of the button.

626

},

627

],

628

"formattedText": "A String", # Required, unless image is present. The body text of the card.

629

"image": { # The image response message. # Optional. The image for the card.

630

"imageUri": "A String", # Optional. The public URI to an image file.

631

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

632

},

633

"title": "A String", # Optional. The title of the card.

634

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

635

},

636

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

637

"items": [ # Required. Carousel items.

638

{ # An item in the carousel.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

639

"image": { # The image response message. # Optional. The image to display.

640

"imageUri": "A String", # Optional. The public URI to an image file.

641

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

642

},

643

"title": "A String", # Required. Title of the carousel item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

644

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

645

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

646

"A String",

647

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

648

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

649

},

650

"description": "A String", # Optional. The body text of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

651

},

652

],

653

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

654

"text": { # The text response message. # Returns a text response.

655

"text": [ # Optional. The collection of the agent's responses.

656

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

657

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

658

},

659

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

660

"title": "A String", # Required. Title of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

661

"image": { # The image response message. # Optional. Image which should be displayed on the card.

662

"imageUri": "A String", # Optional. The public URI to an image file.

663

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

664

},

665

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

666

"rows": [ # Optional. Rows in this table of data.

667

{ # Row of TableCard.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

668

"cells": [ # Optional. List of cells that make up this row.

669

{ # Cell of TableCardRow.

670

"text": "A String", # Required. Text in this cell.

671

},

672

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

673

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

674

},

675

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

676

"columnProperties": [ # Optional. Display properties for the columns in this table.

677

{ # Column properties for TableCard.

678

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

679

"header": "A String", # Required. Column heading.

680

},

681

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

682

"buttons": [ # Optional. List of buttons for the card.

683

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

684

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

685

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

686

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

687

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

688

},

689

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

690

},

691

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. # Rich Business Messaging (RBM) carousel rich card response.

692

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

693

{ # Rich Business Messaging (RBM) Card content

694

"suggestions": [ # Optional. List of suggestions to include in the card.

695

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

696

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

697

"text": "A String", # Suggested reply text.

698

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

699

},

700

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

701

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

702

"uri": "A String", # Required. The uri to open on the user device

703

},

704

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

705

},

706

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

707

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

708

},

709

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

710

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

715

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

716

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

717

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

718

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

719

},

720

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

721

},

722

],

723

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

724

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

725

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

726

"subtitle": "A String", # Optional. The subtitle of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

727

"imageUri": "A String", # Optional. The public URI to an image file for the card.

728

"title": "A String", # Optional. The title of the card.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

729

"buttons": [ # Optional. The collection of card buttons.

730

{ # Optional. Contains information about a button.

731

"text": "A String", # Optional. The text to show on the button.

732

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

733

},

734

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

735

},

736

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

737

"mediaObjects": [ # Required. List of media objects.

738

{ # Response media object for media content card.

739

"description": "A String", # Optional. Description of media card.

740

"contentUrl": "A String", # Required. Url where the media is stored.

741

"name": "A String", # Required. Name of media card.

742

"largeImage": { # The image response message. # Optional. Image to display above media content.

743

"imageUri": "A String", # Optional. The public URI to an image file.

744

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

745

},

746

"icon": { # The image response message. # Optional. Icon to display above media content.

747

"imageUri": "A String", # Optional. The public URI to an image file.

748

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

753

},

754

"platform": "A String", # Optional. The platform that this message is intended for.

755

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. # Standalone Rich Business Messaging (RBM) rich card response.

756

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

757

"suggestions": [ # Optional. List of suggestions to include in the card.

758

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

759

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

760

"text": "A String", # Suggested reply text.

761

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

762

},

763

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

764

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

765

"uri": "A String", # Required. The uri to open on the user device

766

},

767

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

768

},

769

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

770

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

771

},

772

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

773

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

778

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

779

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

780

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

781

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

782

},

783

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

784

},

785

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

786

"cardOrientation": "A String", # Required. Orientation of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

787

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

788

"payload": { # A custom platform-specific response.

789

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

790

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

791

"simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # Returns a voice or text-only response for Actions on Google.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

792

"simpleResponses": [ # Required. The list of simple responses.

793

{ # The simple response message containing speech or text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

794

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

795

"displayText": "A String", # Optional. The text to display.

796

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

797

},

798

],

799

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

800

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

801

"text": "A String", # Required. Text sent and displayed to the user.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

802

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

803

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

804

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

805

"text": "A String", # Suggested reply text.

806

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

807

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

808

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

809

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

810

"uri": "A String", # Required. The uri to open on the user device

811

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

812

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

813

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

814

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

815

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

816

},

817

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

818

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

819

},

820

},

821

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

822

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

823

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

824

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.

825

},

826

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. # Synthesizes speech in Telephony Gateway.

827

"text": "A String", # The raw text to be synthesized.

828

"ssml": "A String", # The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

829

},

830

"quickReplies": { # The quick replies response message. # Displays quick replies.

831

"quickReplies": [ # Optional. The collection of quick replies.

832

"A String",

833

],

834

"title": "A String", # Optional. The title of the collection of quick replies.

835

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

836

},

837

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

838

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

839

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

840

"name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`

841

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

842

{ # Represents a single followup intent in the chain.

843

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.

844

"followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`.

845

},

846

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

847

},

848

],

849

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

850

"updateMask": "A String", # Optional. The mask to control which fields get updated.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

851

"intentBatchUri": "A String", # The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".

852

"intentView": "A String", # Optional. The resource view to apply to the returned intent.

853

"languageCode": "A String", # Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

854

}

855

856

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

863

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

864

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

865

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

866

"a_key": "", # Properties of the object. Contains field @type with type URL.

867

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

868

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

869

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

870

{

871

"a_key": "", # Properties of the object. Contains field @type with type URL.

872

},

873

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

874

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

875

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

876

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

877

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

878

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

879

"a_key": "", # Properties of the object. Contains field @type with type URL.

880

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

881

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

886

<code class="details" id="close">close()</code>

887

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

891

<code class="details" id="create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

892

<pre>Creates an intent in the specified agent.

893

894

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

895

parent: string, Required. The agent to create a intent for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

896

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

897

The object takes the form of:

898

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

899

{ # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

900

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

901

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

902

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

903

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

904

"events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

905

"A String",

906

],

907

"displayName": "A String", # Required. The name of this intent.

908

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

909

"parameters": [ # Optional. The collection of parameters associated with the intent.

910

{ # Represents intent parameters.

911

"name": "A String", # The unique identifier of this parameter.

912

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.

913

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

914

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.

915

"value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.

916

"displayName": "A String", # Required. The name of the parameter.

917

"prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

918

"A String",

919

],

920

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

921

},

922

],

923

"trainingPhrases": [ # Optional. The collection of examples that the agent is trained on.

924

{ # Represents an example that the agent is trained on.

925

"type": "A String", # Required. The type of the training phrase.

926

"name": "A String", # Output only. The unique identifier of this training phrase.

927

"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.

928

{ # Represents a part of a training phrase.

929

"text": "A String", # Required. The text for this part.

930

"alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

931

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

932

"entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.

933

},

934

],

935

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

936

},

937

],

938

"inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`

939

"A String",

940

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

941

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

942

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

943

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.

944

{ # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

945

"parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

946

"a_key": "", # Properties of the object.

947

},

948

"name": "A String", # Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

949

"lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

950

},

951

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

952

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.

953

"action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

954

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.

955

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

956

"messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

957

{ # Corresponds to the `Response` field in the Dialogflow console.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

958

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google.

959

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items.

960

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

961

{ # Browsing carousel tile

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

962

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

963

"url": "A String", # Required. URL

964

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

965

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

966

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

967

"image": { # The image response message. # Optional. Hero image for the carousel item.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

968

"imageUri": "A String", # Optional. The public URI to an image file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

969

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

970

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

971

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

972

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

973

},

974

],

975

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

976

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

977

"phoneNumber": "A String", # Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

978

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

979

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

980

"suggestions": [ # Required. The list of suggested replies.

981

{ # The suggestion chip message that the user can tap to quickly post a reply to the conversation.

982

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

983

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

984

],

985

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

986

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

987

"items": [ # Required. List items.

988

{ # An item in the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

989

"image": { # The image response message. # Optional. The image to display.

990

"imageUri": "A String", # Optional. The public URI to an image file.

991

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

992

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

993

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

994

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

995

"A String",

996

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

997

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

998

},

999

"title": "A String", # Required. The title of the list item.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1000

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1001

},

1002

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1003

"subtitle": "A String", # Optional. Subtitle of the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1004

"title": "A String", # Optional. The overall title of the list.

1005

},

1006

"image": { # The image response message. # Displays an image.

1007

"imageUri": "A String", # Optional. The public URI to an image file.

1008

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1009

},

1010

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # Displays a link out suggestion chip for Actions on Google.

1011

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1012

"uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip.

1013

},

1014

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

1015

"buttons": [ # Optional. The collection of card buttons.

1016

{ # The button object that appears at the bottom of a card.

1017

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1018

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1019

},

1020

"title": "A String", # Required. The title of the button.

1021

},

1022

],

1023

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1024

"image": { # The image response message. # Optional. The image for the card.

1025

"imageUri": "A String", # Optional. The public URI to an image file.

1026

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1027

},

1028

"title": "A String", # Optional. The title of the card.

1029

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1030

},

1031

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

1032

"items": [ # Required. Carousel items.

1033

{ # An item in the carousel.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1034

"image": { # The image response message. # Optional. The image to display.

1035

"imageUri": "A String", # Optional. The public URI to an image file.

1036

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1037

},

1038

"title": "A String", # Required. Title of the carousel item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1039

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1040

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

1041

"A String",

1042

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1043

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1044

},

1045

"description": "A String", # Optional. The body text of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1046

},

1047

],

1048

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1049

"text": { # The text response message. # Returns a text response.

1050

"text": [ # Optional. The collection of the agent's responses.

1051

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1052

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1053

},

1054

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1055

"title": "A String", # Required. Title of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1056

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1057

"imageUri": "A String", # Optional. The public URI to an image file.

1058

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1059

},

1060

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1061

"rows": [ # Optional. Rows in this table of data.

1062

{ # Row of TableCard.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1063

"cells": [ # Optional. List of cells that make up this row.

1064

{ # Cell of TableCardRow.

1065

"text": "A String", # Required. Text in this cell.

1066

},

1067

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1068

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

1069

},

1070

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1071

"columnProperties": [ # Optional. Display properties for the columns in this table.

1072

{ # Column properties for TableCard.

1073

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

1074

"header": "A String", # Required. Column heading.

1075

},

1076

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1077

"buttons": [ # Optional. List of buttons for the card.

1078

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1079

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1080

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1081

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1082

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1083

},

1084

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1085

},

1086

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. # Rich Business Messaging (RBM) carousel rich card response.

1087

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

1088

{ # Rich Business Messaging (RBM) Card content

1089

"suggestions": [ # Optional. List of suggestions to include in the card.

1090

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

1091

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1092

"text": "A String", # Suggested reply text.

1093

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1094

},

1095

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

1096

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1097

"uri": "A String", # Required. The uri to open on the user device

1098

},

1099

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1100

},

1101

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1102

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1103

},

1104

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1105

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

1110

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

1111

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

1112

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

1113

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

1114

},

1115

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

1116

},

1117

],

1118

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1119

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1120

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1121

"subtitle": "A String", # Optional. The subtitle of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1122

"imageUri": "A String", # Optional. The public URI to an image file for the card.

1123

"title": "A String", # Optional. The title of the card.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1124

"buttons": [ # Optional. The collection of card buttons.

1125

{ # Optional. Contains information about a button.

1126

"text": "A String", # Optional. The text to show on the button.

1127

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1128

},

1129

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1130

},

1131

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1132

"mediaObjects": [ # Required. List of media objects.

1133

{ # Response media object for media content card.

1134

"description": "A String", # Optional. Description of media card.

1135

"contentUrl": "A String", # Required. Url where the media is stored.

1136

"name": "A String", # Required. Name of media card.

1137

"largeImage": { # The image response message. # Optional. Image to display above media content.

1138

"imageUri": "A String", # Optional. The public URI to an image file.

1139

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1140

},

1141

"icon": { # The image response message. # Optional. Icon to display above media content.

1142

"imageUri": "A String", # Optional. The public URI to an image file.

1143

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1148

},

1149

"platform": "A String", # Optional. The platform that this message is intended for.

1150

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. # Standalone Rich Business Messaging (RBM) rich card response.

1151

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

1152

"suggestions": [ # Optional. List of suggestions to include in the card.

1153

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

1154

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1155

"text": "A String", # Suggested reply text.

1156

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1157

},

1158

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

1159

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1160

"uri": "A String", # Required. The uri to open on the user device

1161

},

1162

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1163

},

1164

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1165

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1166

},

1167

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1168

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

1173

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

1174

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

1175

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

1176

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

1177

},

1178

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

1179

},

1180

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

1181

"cardOrientation": "A String", # Required. Orientation of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1182

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1183

"payload": { # A custom platform-specific response.

1184

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1185

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1186

"simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # Returns a voice or text-only response for Actions on Google.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1187

"simpleResponses": [ # Required. The list of simple responses.

1188

{ # The simple response message containing speech or text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1189

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1190

"displayText": "A String", # Optional. The text to display.

1191

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1192

},

1193

],

1194

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1195

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1196

"text": "A String", # Required. Text sent and displayed to the user.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1197

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

1198

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1199

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1200

"text": "A String", # Suggested reply text.

1201

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1202

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1203

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1204

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1205

"uri": "A String", # Required. The uri to open on the user device

1206

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1207

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1208

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1209

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1210

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1211

},

1212

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1213

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1214

},

1215

},

1216

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1217

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1218

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

1219

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.

1220

},

1221

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. # Synthesizes speech in Telephony Gateway.

1222

"text": "A String", # The raw text to be synthesized.

1223

"ssml": "A String", # The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1224

},

1225

"quickReplies": { # The quick replies response message. # Displays quick replies.

1226

"quickReplies": [ # Optional. The collection of quick replies.

1227

"A String",

1228

],

1229

"title": "A String", # Optional. The title of the collection of quick replies.

1230

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1231

},

1232

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1233

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1234

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1235

"name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`

1236

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

1237

{ # Represents a single followup intent in the chain.

1238

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.

1239

"followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`.

1240

},

1241

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1242

}

1243

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1244

languageCode: string, Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1245

intentView: string, Optional. The resource view to apply to the returned intent.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1246

Allowed values

1247

INTENT_VIEW_UNSPECIFIED - Training phrases field is not populated in the response.

1248

INTENT_VIEW_FULL - All fields are populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1249

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1256

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1257

{ # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1258

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1259

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1260

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1261

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

1262

"events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

1263

"A String",

1264

],

1265

"displayName": "A String", # Required. The name of this intent.

1266

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

1267

"parameters": [ # Optional. The collection of parameters associated with the intent.

1268

{ # Represents intent parameters.

1269

"name": "A String", # The unique identifier of this parameter.

1270

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.

1271

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1272

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.

1273

"value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.

1274

"displayName": "A String", # Required. The name of the parameter.

1275

"prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

1276

"A String",

1277

],

1278

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

1279

},

1280

],

1281

"trainingPhrases": [ # Optional. The collection of examples that the agent is trained on.

1282

{ # Represents an example that the agent is trained on.

1283

"type": "A String", # Required. The type of the training phrase.

1284

"name": "A String", # Output only. The unique identifier of this training phrase.

1285

"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.

1286

{ # Represents a part of a training phrase.

1287

"text": "A String", # Required. The text for this part.

1288

"alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

1289

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

1290

"entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.

1291

},

1292

],

1293

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1294

},

1295

],

1296

"inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`

1297

"A String",

1298

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1299

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1300

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1301

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.

1302

{ # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

1303

"parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

1304

"a_key": "", # Properties of the object.

1305

},

1306

"name": "A String", # Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

1307

"lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

1308

},

1309

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1310

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.

1311

"action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1312

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.

1313

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1314

"messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1315

{ # Corresponds to the `Response` field in the Dialogflow console.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1316

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google.

1317

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items.

1318

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

1319

{ # Browsing carousel tile

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1320

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1321

"url": "A String", # Required. URL

1322

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

1323

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1324

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1325

"image": { # The image response message. # Optional. Hero image for the carousel item.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1326

"imageUri": "A String", # Optional. The public URI to an image file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1327

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1328

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1329

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1330

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1331

},

1332

],

1333

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1334

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

1335

"phoneNumber": "A String", # Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1336

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1337

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

1338

"suggestions": [ # Required. The list of suggested replies.

1339

{ # The suggestion chip message that the user can tap to quickly post a reply to the conversation.

1340

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1341

},

1342

],

1343

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1344

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1345

"items": [ # Required. List items.

1346

{ # An item in the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1347

"image": { # The image response message. # Optional. The image to display.

1348

"imageUri": "A String", # Optional. The public URI to an image file.

1349

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1350

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1351

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1352

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

1353

"A String",

1354

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1355

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1356

},

1357

"title": "A String", # Required. The title of the list item.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1358

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1359

},

1360

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1361

"subtitle": "A String", # Optional. Subtitle of the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1362

"title": "A String", # Optional. The overall title of the list.

1363

},

1364

"image": { # The image response message. # Displays an image.

1365

"imageUri": "A String", # Optional. The public URI to an image file.

1366

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1367

},

1368

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # Displays a link out suggestion chip for Actions on Google.

1369

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1370

"uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip.

1371

},

1372

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

1373

"buttons": [ # Optional. The collection of card buttons.

1374

{ # The button object that appears at the bottom of a card.

1375

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1376

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1377

},

1378

"title": "A String", # Required. The title of the button.

1379

},

1380

],

1381

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1382

"image": { # The image response message. # Optional. The image for the card.

1383

"imageUri": "A String", # Optional. The public URI to an image file.

1384

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1385

},

1386

"title": "A String", # Optional. The title of the card.

1387

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1388

},

1389

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

1390

"items": [ # Required. Carousel items.

1391

{ # An item in the carousel.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1392

"image": { # The image response message. # Optional. The image to display.

1393

"imageUri": "A String", # Optional. The public URI to an image file.

1394

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1395

},

1396

"title": "A String", # Required. Title of the carousel item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1397

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1398

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

1399

"A String",

1400

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1401

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1402

},

1403

"description": "A String", # Optional. The body text of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1404

},

1405

],

1406

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1407

"text": { # The text response message. # Returns a text response.

1408

"text": [ # Optional. The collection of the agent's responses.

1409

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1410

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1411

},

1412

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1413

"title": "A String", # Required. Title of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1414

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1415

"imageUri": "A String", # Optional. The public URI to an image file.

1416

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1417

},

1418

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1419

"rows": [ # Optional. Rows in this table of data.

1420

{ # Row of TableCard.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1421

"cells": [ # Optional. List of cells that make up this row.

1422

{ # Cell of TableCardRow.

1423

"text": "A String", # Required. Text in this cell.

1424

},

1425

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1426

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

1427

},

1428

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1429

"columnProperties": [ # Optional. Display properties for the columns in this table.

1430

{ # Column properties for TableCard.

1431

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

1432

"header": "A String", # Required. Column heading.

1433

},

1434

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1435

"buttons": [ # Optional. List of buttons for the card.

1436

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1437

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1438

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1439

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1440

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1441

},

1442

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1443

},

1444

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. # Rich Business Messaging (RBM) carousel rich card response.

1445

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

1446

{ # Rich Business Messaging (RBM) Card content

1447

"suggestions": [ # Optional. List of suggestions to include in the card.

1448

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

1449

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1450

"text": "A String", # Suggested reply text.

1451

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1452

},

1453

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

1454

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1455

"uri": "A String", # Required. The uri to open on the user device

1456

},

1457

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1458

},

1459

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1460

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1461

},

1462

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1463

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

1468

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

1469

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

1470

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

1471

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

1472

},

1473

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

1474

},

1475

],

1476

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1477

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1478

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1479

"subtitle": "A String", # Optional. The subtitle of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1480

"imageUri": "A String", # Optional. The public URI to an image file for the card.

1481

"title": "A String", # Optional. The title of the card.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1482

"buttons": [ # Optional. The collection of card buttons.

1483

{ # Optional. Contains information about a button.

1484

"text": "A String", # Optional. The text to show on the button.

1485

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1486

},

1487

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1488

},

1489

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1490

"mediaObjects": [ # Required. List of media objects.

1491

{ # Response media object for media content card.

1492

"description": "A String", # Optional. Description of media card.

1493

"contentUrl": "A String", # Required. Url where the media is stored.

1494

"name": "A String", # Required. Name of media card.

1495

"largeImage": { # The image response message. # Optional. Image to display above media content.

1496

"imageUri": "A String", # Optional. The public URI to an image file.

1497

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1498

},

1499

"icon": { # The image response message. # Optional. Icon to display above media content.

1500

"imageUri": "A String", # Optional. The public URI to an image file.

1501

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1506

},

1507

"platform": "A String", # Optional. The platform that this message is intended for.

1508

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. # Standalone Rich Business Messaging (RBM) rich card response.

1509

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

1510

"suggestions": [ # Optional. List of suggestions to include in the card.

1511

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

1512

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1513

"text": "A String", # Suggested reply text.

1514

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1515

},

1516

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

1517

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1518

"uri": "A String", # Required. The uri to open on the user device

1519

},

1520

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1521

},

1522

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1523

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1524

},

1525

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1526

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

1531

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

1532

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

1533

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

1534

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

1535

},

1536

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

1537

},

1538

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

1539

"cardOrientation": "A String", # Required. Orientation of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1540

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1541

"payload": { # A custom platform-specific response.

1542

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1543

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1544

"simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # Returns a voice or text-only response for Actions on Google.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1545

"simpleResponses": [ # Required. The list of simple responses.

1546

{ # The simple response message containing speech or text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1547

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1548

"displayText": "A String", # Optional. The text to display.

1549

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1550

},

1551

],

1552

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1553

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1554

"text": "A String", # Required. Text sent and displayed to the user.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1555

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

1556

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1557

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1558

"text": "A String", # Suggested reply text.

1559

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1560

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1561

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1562

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1563

"uri": "A String", # Required. The uri to open on the user device

1564

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1565

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1566

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1567

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1568

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1569

},

1570

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1571

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1572

},

1573

},

1574

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1575

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1576

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

1577

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.

1578

},

1579

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. # Synthesizes speech in Telephony Gateway.

1580

"text": "A String", # The raw text to be synthesized.

1581

"ssml": "A String", # The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1582

},

1583

"quickReplies": { # The quick replies response message. # Displays quick replies.

1584

"quickReplies": [ # Optional. The collection of quick replies.

1585

"A String",

1586

],

1587

"title": "A String", # Optional. The title of the collection of quick replies.

1588

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1589

},

1590

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1591

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1592

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1593

"name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`

1594

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

1595

{ # Represents a single followup intent in the chain.

1596

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.

1597

"followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`.

1598

},

1599

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

1605

<pre>Deletes the specified intent and its direct or indirect followup intents.

1606

1607

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1608

name: string, Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/` (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1609

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1616

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1617

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1622

<code class="details" id="get">get(name, languageCode=None, intentView=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1623

<pre>Retrieves the specified intent.

1624

1625

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1626

name: string, Required. The name of the intent. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/` (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1627

languageCode: string, Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1628

intentView: string, Optional. The resource view to apply to the returned intent.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1629

Allowed values

1630

INTENT_VIEW_UNSPECIFIED - Training phrases field is not populated in the response.

1631

INTENT_VIEW_FULL - All fields are populated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1632

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1639

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1640

{ # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1641

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1642

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1643

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1644

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

1645

"events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

1646

"A String",

1647

],

1648

"displayName": "A String", # Required. The name of this intent.

1649

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

1650

"parameters": [ # Optional. The collection of parameters associated with the intent.

1651

{ # Represents intent parameters.

1652

"name": "A String", # The unique identifier of this parameter.

1653

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.

1654

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1655

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.

1656

"value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.

1657

"displayName": "A String", # Required. The name of the parameter.

1658

"prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

1659

"A String",

1660

],

1661

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

1662

},

1663

],

1664

"trainingPhrases": [ # Optional. The collection of examples that the agent is trained on.

1665

{ # Represents an example that the agent is trained on.

1666

"type": "A String", # Required. The type of the training phrase.

1667

"name": "A String", # Output only. The unique identifier of this training phrase.

1668

"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.

1669

{ # Represents a part of a training phrase.

1670

"text": "A String", # Required. The text for this part.

1671

"alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

1672

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

1673

"entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.

1674

},

1675

],

1676

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1677

},

1678

],

1679

"inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`

1680

"A String",

1681

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1682

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1683

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1684

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.

1685

{ # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

1686

"parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

1687

"a_key": "", # Properties of the object.

1688

},

1689

"name": "A String", # Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

1690

"lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

1691

},

1692

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1693

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.

1694

"action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1695

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.

1696

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1697

"messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1698

{ # Corresponds to the `Response` field in the Dialogflow console.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1699

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google.

1700

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items.

1701

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

1702

{ # Browsing carousel tile

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1703

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1704

"url": "A String", # Required. URL

1705

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

1706

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1707

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1708

"image": { # The image response message. # Optional. Hero image for the carousel item.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1709

"imageUri": "A String", # Optional. The public URI to an image file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1710

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1711

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1712

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1713

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1714

},

1715

],

1716

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1717

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

1718

"phoneNumber": "A String", # Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1719

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1720

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

1721

"suggestions": [ # Required. The list of suggested replies.

1722

{ # The suggestion chip message that the user can tap to quickly post a reply to the conversation.

1723

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1724

},

1725

],

1726

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1727

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1728

"items": [ # Required. List items.

1729

{ # An item in the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1730

"image": { # The image response message. # Optional. The image to display.

1731

"imageUri": "A String", # Optional. The public URI to an image file.

1732

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1733

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1734

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1735

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

1736

"A String",

1737

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1738

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1739

},

1740

"title": "A String", # Required. The title of the list item.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1741

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1742

},

1743

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1744

"subtitle": "A String", # Optional. Subtitle of the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1745

"title": "A String", # Optional. The overall title of the list.

1746

},

1747

"image": { # The image response message. # Displays an image.

1748

"imageUri": "A String", # Optional. The public URI to an image file.

1749

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1750

},

1751

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # Displays a link out suggestion chip for Actions on Google.

1752

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1753

"uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip.

1754

},

1755

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

1756

"buttons": [ # Optional. The collection of card buttons.

1757

{ # The button object that appears at the bottom of a card.

1758

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1759

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1760

},

1761

"title": "A String", # Required. The title of the button.

1762

},

1763

],

1764

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1765

"image": { # The image response message. # Optional. The image for the card.

1766

"imageUri": "A String", # Optional. The public URI to an image file.

1767

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1768

},

1769

"title": "A String", # Optional. The title of the card.

1770

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1771

},

1772

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

1773

"items": [ # Required. Carousel items.

1774

{ # An item in the carousel.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1775

"image": { # The image response message. # Optional. The image to display.

1776

"imageUri": "A String", # Optional. The public URI to an image file.

1777

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1778

},

1779

"title": "A String", # Required. Title of the carousel item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1780

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1781

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

1782

"A String",

1783

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1784

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1785

},

1786

"description": "A String", # Optional. The body text of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1787

},

1788

],

1789

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1790

"text": { # The text response message. # Returns a text response.

1791

"text": [ # Optional. The collection of the agent's responses.

1792

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1793

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1794

},

1795

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1796

"title": "A String", # Required. Title of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1797

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1798

"imageUri": "A String", # Optional. The public URI to an image file.

1799

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1800

},

1801

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1802

"rows": [ # Optional. Rows in this table of data.

1803

{ # Row of TableCard.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1804

"cells": [ # Optional. List of cells that make up this row.

1805

{ # Cell of TableCardRow.

1806

"text": "A String", # Required. Text in this cell.

1807

},

1808

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1809

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

1810

},

1811

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1812

"columnProperties": [ # Optional. Display properties for the columns in this table.

1813

{ # Column properties for TableCard.

1814

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

1815

"header": "A String", # Required. Column heading.

1816

},

1817

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1818

"buttons": [ # Optional. List of buttons for the card.

1819

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1820

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1821

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1822

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1823

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1824

},

1825

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1826

},

1827

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. # Rich Business Messaging (RBM) carousel rich card response.

1828

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

1829

{ # Rich Business Messaging (RBM) Card content

1830

"suggestions": [ # Optional. List of suggestions to include in the card.

1831

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

1832

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1833

"text": "A String", # Suggested reply text.

1834

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1835

},

1836

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

1837

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1838

"uri": "A String", # Required. The uri to open on the user device

1839

},

1840

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1841

},

1842

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1843

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1844

},

1845

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1846

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

1851

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

1852

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

1853

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

1854

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

1855

},

1856

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

1857

},

1858

],

1859

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1860

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1861

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1862

"subtitle": "A String", # Optional. The subtitle of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1863

"imageUri": "A String", # Optional. The public URI to an image file for the card.

1864

"title": "A String", # Optional. The title of the card.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1865

"buttons": [ # Optional. The collection of card buttons.

1866

{ # Optional. Contains information about a button.

1867

"text": "A String", # Optional. The text to show on the button.

1868

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1869

},

1870

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1871

},

1872

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1873

"mediaObjects": [ # Required. List of media objects.

1874

{ # Response media object for media content card.

1875

"description": "A String", # Optional. Description of media card.

1876

"contentUrl": "A String", # Required. Url where the media is stored.

1877

"name": "A String", # Required. Name of media card.

1878

"largeImage": { # The image response message. # Optional. Image to display above media content.

1879

"imageUri": "A String", # Optional. The public URI to an image file.

1880

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

1881

},

1882

"icon": { # The image response message. # Optional. Icon to display above media content.

1883

"imageUri": "A String", # Optional. The public URI to an image file.

1884

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1889

},

1890

"platform": "A String", # Optional. The platform that this message is intended for.

1891

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. # Standalone Rich Business Messaging (RBM) rich card response.

1892

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

1893

"suggestions": [ # Optional. List of suggestions to include in the card.

1894

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

1895

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1896

"text": "A String", # Suggested reply text.

1897

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1898

},

1899

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

1900

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1901

"uri": "A String", # Required. The uri to open on the user device

1902

},

1903

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1904

},

1905

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1906

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1907

},

1908

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1909

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

1914

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

1915

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

1916

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

1917

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

1918

},

1919

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

1920

},

1921

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

1922

"cardOrientation": "A String", # Required. Orientation of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1923

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1924

"payload": { # A custom platform-specific response.

1925

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1926

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1927

"simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # Returns a voice or text-only response for Actions on Google.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1928

"simpleResponses": [ # Required. The list of simple responses.

1929

{ # The simple response message containing speech or text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1930

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1931

"displayText": "A String", # Optional. The text to display.

1932

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1933

},

1934

],

1935

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1936

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1937

"text": "A String", # Required. Text sent and displayed to the user.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1938

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

1939

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1940

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

1941

"text": "A String", # Suggested reply text.

1942

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

1943

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1944

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1945

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

1946

"uri": "A String", # Required. The uri to open on the user device

1947

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1948

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

1949

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1950

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

1951

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

1952

},

1953

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

1954

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1955

},

1956

},

1957

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1958

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1959

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

1960

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.

1961

},

1962

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. # Synthesizes speech in Telephony Gateway.

1963

"text": "A String", # The raw text to be synthesized.

1964

"ssml": "A String", # The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1965

},

1966

"quickReplies": { # The quick replies response message. # Displays quick replies.

1967

"quickReplies": [ # Optional. The collection of quick replies.

1968

"A String",

1969

],

1970

"title": "A String", # Optional. The title of the collection of quick replies.

1971

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1972

},

1973

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1974

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1975

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1976

"name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`

1977

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

1978

{ # Represents a single followup intent in the chain.

1979

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.

1980

"followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`.

1981

},

1982

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1987

<code class="details" id="list">list(parent, pageToken=None, languageCode=None, pageSize=None, intentView=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1988

<pre>Returns the list of all intents in the specified agent.

1989

1990

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1991

parent: string, Required. The agent to list all intents from. Format: `projects//agent`. (required)

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1992

pageToken: string, Optional. The next_page_token value returned from a previous list request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1993

languageCode: string, Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1994

pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1995

intentView: string, Optional. The resource view to apply to the returned intent.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1996

Allowed values

1997

INTENT_VIEW_UNSPECIFIED - Training phrases field is not populated in the response.

1998

INTENT_VIEW_FULL - All fields are populated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1999

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2006

2007

{ # The response message for Intents.ListIntents.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2008

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2009

"intents": [ # The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request.

2010

{ # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2011

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2012

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2013

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2014

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

2015

"events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

2016

"A String",

2017

],

2018

"displayName": "A String", # Required. The name of this intent.

2019

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

2020

"parameters": [ # Optional. The collection of parameters associated with the intent.

2021

{ # Represents intent parameters.

2022

"name": "A String", # The unique identifier of this parameter.

2023

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.

2024

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2025

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.

2026

"value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.

2027

"displayName": "A String", # Required. The name of the parameter.

2028

"prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

2029

"A String",

2030

],

2031

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

2032

},

2033

],

2034

"trainingPhrases": [ # Optional. The collection of examples that the agent is trained on.

2035

{ # Represents an example that the agent is trained on.

2036

"type": "A String", # Required. The type of the training phrase.

2037

"name": "A String", # Output only. The unique identifier of this training phrase.

2038

"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.

2039

{ # Represents a part of a training phrase.

2040

"text": "A String", # Required. The text for this part.

2041

"alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

2042

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

2043

"entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.

2044

},

2045

],

2046

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2047

},

2048

],

2049

"inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`

2050

"A String",

2051

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2052

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2053

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2054

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.

2055

{ # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

2056

"parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

2057

"a_key": "", # Properties of the object.

2058

},

2059

"name": "A String", # Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

2060

"lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

2061

},

2062

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2063

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.

2064

"action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2065

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.

2066

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2067

"messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2068

{ # Corresponds to the `Response` field in the Dialogflow console.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2069

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google.

2070

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items.

2071

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

2072

{ # Browsing carousel tile

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2073

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2074

"url": "A String", # Required. URL

2075

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

2076

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2077

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2078

"image": { # The image response message. # Optional. Hero image for the carousel item.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2079

"imageUri": "A String", # Optional. The public URI to an image file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2080

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2081

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2082

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2083

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2084

},

2085

],

2086

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2087

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2088

"phoneNumber": "A String", # Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2089

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2090

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2091

"suggestions": [ # Required. The list of suggested replies.

2092

{ # The suggestion chip message that the user can tap to quickly post a reply to the conversation.

2093

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2094

},

2095

],

2096

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2097

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2098

"items": [ # Required. List items.

2099

{ # An item in the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2100

"image": { # The image response message. # Optional. The image to display.

2101

"imageUri": "A String", # Optional. The public URI to an image file.

2102

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2103

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2104

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2105

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

2106

"A String",

2107

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2108

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2109

},

2110

"title": "A String", # Required. The title of the list item.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2111

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2112

},

2113

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2114

"subtitle": "A String", # Optional. Subtitle of the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2115

"title": "A String", # Optional. The overall title of the list.

2116

},

2117

"image": { # The image response message. # Displays an image.

2118

"imageUri": "A String", # Optional. The public URI to an image file.

2119

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2120

},

2121

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # Displays a link out suggestion chip for Actions on Google.

2122

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2123

"uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip.

2124

},

2125

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

2126

"buttons": [ # Optional. The collection of card buttons.

2127

{ # The button object that appears at the bottom of a card.

2128

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2129

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2130

},

2131

"title": "A String", # Required. The title of the button.

2132

},

2133

],

2134

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2135

"image": { # The image response message. # Optional. The image for the card.

2136

"imageUri": "A String", # Optional. The public URI to an image file.

2137

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2138

},

2139

"title": "A String", # Optional. The title of the card.

2140

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2141

},

2142

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2143

"items": [ # Required. Carousel items.

2144

{ # An item in the carousel.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2145

"image": { # The image response message. # Optional. The image to display.

2146

"imageUri": "A String", # Optional. The public URI to an image file.

2147

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2148

},

2149

"title": "A String", # Required. Title of the carousel item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2150

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2151

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

2152

"A String",

2153

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2154

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2155

},

2156

"description": "A String", # Optional. The body text of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2157

},

2158

],

2159

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2160

"text": { # The text response message. # Returns a text response.

2161

"text": [ # Optional. The collection of the agent's responses.

2162

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2163

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2164

},

2165

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2166

"title": "A String", # Required. Title of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2167

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2168

"imageUri": "A String", # Optional. The public URI to an image file.

2169

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2170

},

2171

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2172

"rows": [ # Optional. Rows in this table of data.

2173

{ # Row of TableCard.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2174

"cells": [ # Optional. List of cells that make up this row.

2175

{ # Cell of TableCardRow.

2176

"text": "A String", # Required. Text in this cell.

2177

},

2178

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2179

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2180

},

2181

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2182

"columnProperties": [ # Optional. Display properties for the columns in this table.

2183

{ # Column properties for TableCard.

2184

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2185

"header": "A String", # Required. Column heading.

2186

},

2187

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2188

"buttons": [ # Optional. List of buttons for the card.

2189

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2190

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2191

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2192

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2193

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2194

},

2195

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2196

},

2197

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. # Rich Business Messaging (RBM) carousel rich card response.

2198

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

2199

{ # Rich Business Messaging (RBM) Card content

2200

"suggestions": [ # Optional. List of suggestions to include in the card.

2201

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

2202

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

2203

"text": "A String", # Suggested reply text.

2204

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

2205

},

2206

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

2207

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

2208

"uri": "A String", # Required. The uri to open on the user device

2209

},

2210

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

2211

},

2212

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

2213

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

2214

},

2215

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

2216

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

2221

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

2222

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

2223

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

2224

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

2225

},

2226

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

2227

},

2228

],

2229

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2230

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2231

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2232

"subtitle": "A String", # Optional. The subtitle of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2233

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2234

"title": "A String", # Optional. The title of the card.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2235

"buttons": [ # Optional. The collection of card buttons.

2236

{ # Optional. Contains information about a button.

2237

"text": "A String", # Optional. The text to show on the button.

2238

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2239

},

2240

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2241

},

2242

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2243

"mediaObjects": [ # Required. List of media objects.

2244

{ # Response media object for media content card.

2245

"description": "A String", # Optional. Description of media card.

2246

"contentUrl": "A String", # Required. Url where the media is stored.

2247

"name": "A String", # Required. Name of media card.

2248

"largeImage": { # The image response message. # Optional. Image to display above media content.

2249

"imageUri": "A String", # Optional. The public URI to an image file.

2250

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2251

},

2252

"icon": { # The image response message. # Optional. Icon to display above media content.

2253

"imageUri": "A String", # Optional. The public URI to an image file.

2254

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2259

},

2260

"platform": "A String", # Optional. The platform that this message is intended for.

2261

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. # Standalone Rich Business Messaging (RBM) rich card response.

2262

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

2263

"suggestions": [ # Optional. List of suggestions to include in the card.

2264

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

2265

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

2266

"text": "A String", # Suggested reply text.

2267

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

2268

},

2269

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

2270

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

2271

"uri": "A String", # Required. The uri to open on the user device

2272

},

2273

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

2274

},

2275

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

2276

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

2277

},

2278

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

2279

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

2284

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

2285

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

2286

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

2287

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

2288

},

2289

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

2290

},

2291

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

2292

"cardOrientation": "A String", # Required. Orientation of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2293

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2294

"payload": { # A custom platform-specific response.

2295

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2296

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2297

"simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # Returns a voice or text-only response for Actions on Google.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2298

"simpleResponses": [ # Required. The list of simple responses.

2299

{ # The simple response message containing speech or text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2300

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2301

"displayText": "A String", # Optional. The text to display.

2302

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2303

},

2304

],

2305

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2306

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2307

"text": "A String", # Required. Text sent and displayed to the user.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2308

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2309

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2310

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

2311

"text": "A String", # Suggested reply text.

2312

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

2313

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2314

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2315

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

2316

"uri": "A String", # Required. The uri to open on the user device

2317

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2318

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

2319

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2320

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

2321

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

2322

},

2323

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

2324

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2325

},

2326

},

2327

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2328

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2329

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2330

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.

2331

},

2332

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. # Synthesizes speech in Telephony Gateway.

2333

"text": "A String", # The raw text to be synthesized.

2334

"ssml": "A String", # The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2335

},

2336

"quickReplies": { # The quick replies response message. # Displays quick replies.

2337

"quickReplies": [ # Optional. The collection of quick replies.

2338

"A String",

2339

],

2340

"title": "A String", # Optional. The title of the collection of quick replies.

2341

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2342

},

2343

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2344

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2345

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2346

"name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`

2347

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

2348

{ # Represents a single followup intent in the chain.

2349

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.

2350

"followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`.

2351

},

2352

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2360

<pre>Retrieves the next page of results.

2361

2362

Args:

2363

previous_request: The request for the previous page. (required)

2364

previous_response: The response from the request for the previous page. (required)

2365

2366

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2367

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2368

page. Returns None if there are no more items in the collection.

</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2373

<code class="details" id="patch">patch(name, body=None, intentView=None, languageCode=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2374

<pre>Updates the specified intent.

2375

2376

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2377

name: string, Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/` (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2378

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2379

The object takes the form of:

2380

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2381

{ # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2382

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2383

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2384

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2385

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

2386

"events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

2387

"A String",

2388

],

2389

"displayName": "A String", # Required. The name of this intent.

2390

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

2391

"parameters": [ # Optional. The collection of parameters associated with the intent.

2392

{ # Represents intent parameters.

2393

"name": "A String", # The unique identifier of this parameter.

2394

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.

2395

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2396

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.

2397

"value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.

2398

"displayName": "A String", # Required. The name of the parameter.

2399

"prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

2400

"A String",

2401

],

2402

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

2403

},

2404

],

2405

"trainingPhrases": [ # Optional. The collection of examples that the agent is trained on.

2406

{ # Represents an example that the agent is trained on.

2407

"type": "A String", # Required. The type of the training phrase.

2408

"name": "A String", # Output only. The unique identifier of this training phrase.

2409

"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.

2410

{ # Represents a part of a training phrase.

2411

"text": "A String", # Required. The text for this part.

2412

"alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

2413

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

2414

"entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.

2415

},

2416

],

2417

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2418

},

2419

],

2420

"inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`

2421

"A String",

2422

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2423

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2424

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2425

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.

2426

{ # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

2427

"parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

2428

"a_key": "", # Properties of the object.

2429

},

2430

"name": "A String", # Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

2431

"lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

2432

},

2433

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2434

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.

2435

"action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2436

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.

2437

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2438

"messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2439

{ # Corresponds to the `Response` field in the Dialogflow console.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2440

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google.

2441

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items.

2442

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

2443

{ # Browsing carousel tile

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2444

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2445

"url": "A String", # Required. URL

2446

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

2447

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2448

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2449

"image": { # The image response message. # Optional. Hero image for the carousel item.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2450

"imageUri": "A String", # Optional. The public URI to an image file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2451

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2452

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2453

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2454

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2455

},

2456

],

2457

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2458

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2459

"phoneNumber": "A String", # Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2460

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2461

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2462

"suggestions": [ # Required. The list of suggested replies.

2463

{ # The suggestion chip message that the user can tap to quickly post a reply to the conversation.

2464

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2465

},

2466

],

2467

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2468

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2469

"items": [ # Required. List items.

2470

{ # An item in the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2471

"image": { # The image response message. # Optional. The image to display.

2472

"imageUri": "A String", # Optional. The public URI to an image file.

2473

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2474

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2475

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2476

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

2477

"A String",

2478

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2479

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2480

},

2481

"title": "A String", # Required. The title of the list item.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2482

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2483

},

2484

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2485

"subtitle": "A String", # Optional. Subtitle of the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2486

"title": "A String", # Optional. The overall title of the list.

2487

},

2488

"image": { # The image response message. # Displays an image.

2489

"imageUri": "A String", # Optional. The public URI to an image file.

2490

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2491

},

2492

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # Displays a link out suggestion chip for Actions on Google.

2493

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2494

"uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip.

2495

},

2496

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

2497

"buttons": [ # Optional. The collection of card buttons.

2498

{ # The button object that appears at the bottom of a card.

2499

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2500

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2501

},

2502

"title": "A String", # Required. The title of the button.

2503

},

2504

],

2505

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2506

"image": { # The image response message. # Optional. The image for the card.

2507

"imageUri": "A String", # Optional. The public URI to an image file.

2508

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2509

},

2510

"title": "A String", # Optional. The title of the card.

2511

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2512

},

2513

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2514

"items": [ # Required. Carousel items.

2515

{ # An item in the carousel.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2516

"image": { # The image response message. # Optional. The image to display.

2517

"imageUri": "A String", # Optional. The public URI to an image file.

2518

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2519

},

2520

"title": "A String", # Required. Title of the carousel item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2521

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2522

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

2523

"A String",

2524

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2525

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2526

},

2527

"description": "A String", # Optional. The body text of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2528

},

2529

],

2530

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2531

"text": { # The text response message. # Returns a text response.

2532

"text": [ # Optional. The collection of the agent's responses.

2533

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2534

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2535

},

2536

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2537

"title": "A String", # Required. Title of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2538

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2539

"imageUri": "A String", # Optional. The public URI to an image file.

2540

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2541

},

2542

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2543

"rows": [ # Optional. Rows in this table of data.

2544

{ # Row of TableCard.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2545

"cells": [ # Optional. List of cells that make up this row.

2546

{ # Cell of TableCardRow.

2547

"text": "A String", # Required. Text in this cell.

2548

},

2549

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2550

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2551

},

2552

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2553

"columnProperties": [ # Optional. Display properties for the columns in this table.

2554

{ # Column properties for TableCard.

2555

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2556

"header": "A String", # Required. Column heading.

2557

},

2558

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2559

"buttons": [ # Optional. List of buttons for the card.

2560

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2561

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2562

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2563

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2564

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2565

},

2566

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2567

},

2568

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. # Rich Business Messaging (RBM) carousel rich card response.

2569

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

2570

{ # Rich Business Messaging (RBM) Card content

2571

"suggestions": [ # Optional. List of suggestions to include in the card.

2572

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

2573

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

2574

"text": "A String", # Suggested reply text.

2575

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

2576

},

2577

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

2578

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

2579

"uri": "A String", # Required. The uri to open on the user device

2580

},

2581

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

2582

},

2583

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

2584

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

2585

},

2586

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

2587

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

2592

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

2593

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

2594

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

2595

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

2596

},

2597

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

2598

},

2599

],

2600

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2601

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2602

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2603

"subtitle": "A String", # Optional. The subtitle of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2604

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2605

"title": "A String", # Optional. The title of the card.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2606

"buttons": [ # Optional. The collection of card buttons.

2607

{ # Optional. Contains information about a button.

2608

"text": "A String", # Optional. The text to show on the button.

2609

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2610

},

2611

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2612

},

2613

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2614

"mediaObjects": [ # Required. List of media objects.

2615

{ # Response media object for media content card.

2616

"description": "A String", # Optional. Description of media card.

2617

"contentUrl": "A String", # Required. Url where the media is stored.

2618

"name": "A String", # Required. Name of media card.

2619

"largeImage": { # The image response message. # Optional. Image to display above media content.

2620

"imageUri": "A String", # Optional. The public URI to an image file.

2621

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2622

},

2623

"icon": { # The image response message. # Optional. Icon to display above media content.

2624

"imageUri": "A String", # Optional. The public URI to an image file.

2625

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2630

},

2631

"platform": "A String", # Optional. The platform that this message is intended for.

2632

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. # Standalone Rich Business Messaging (RBM) rich card response.

2633

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

2634

"suggestions": [ # Optional. List of suggestions to include in the card.

2635

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

2636

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

2637

"text": "A String", # Suggested reply text.

2638

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

2639

},

2640

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

2641

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

2642

"uri": "A String", # Required. The uri to open on the user device

2643

},

2644

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

2645

},

2646

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

2647

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

2648

},

2649

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

2650

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

2655

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

2656

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

2657

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

2658

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

2659

},

2660

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

2661

},

2662

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

2663

"cardOrientation": "A String", # Required. Orientation of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2664

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2665

"payload": { # A custom platform-specific response.

2666

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2667

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2668

"simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # Returns a voice or text-only response for Actions on Google.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2669

"simpleResponses": [ # Required. The list of simple responses.

2670

{ # The simple response message containing speech or text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2671

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2672

"displayText": "A String", # Optional. The text to display.

2673

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2674

},

2675

],

2676

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2677

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2678

"text": "A String", # Required. Text sent and displayed to the user.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2679

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2680

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2681

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

2682

"text": "A String", # Suggested reply text.

2683

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

2684

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2685

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2686

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

2687

"uri": "A String", # Required. The uri to open on the user device

2688

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2689

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

2690

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2691

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

2692

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

2693

},

2694

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

2695

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2696

},

2697

},

2698

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2699

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2700

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2701

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.

2702

},

2703

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. # Synthesizes speech in Telephony Gateway.

2704

"text": "A String", # The raw text to be synthesized.

2705

"ssml": "A String", # The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2706

},

2707

"quickReplies": { # The quick replies response message. # Displays quick replies.

2708

"quickReplies": [ # Optional. The collection of quick replies.

2709

"A String",

2710

],

2711

"title": "A String", # Optional. The title of the collection of quick replies.

2712

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2713

},

2714

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2715

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2716

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2717

"name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`

2718

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

2719

{ # Represents a single followup intent in the chain.

2720

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.

2721

"followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`.

2722

},

2723

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2724

}

2725

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2726

intentView: string, Optional. The resource view to apply to the returned intent.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2727

Allowed values

2728

INTENT_VIEW_UNSPECIFIED - Training phrases field is not populated in the response.

2729

INTENT_VIEW_FULL - All fields are populated.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2730

languageCode: string, Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2731

updateMask: string, Optional. The mask to control which fields get updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2732

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2739

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2740

{ # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2741

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2742

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2743

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2744

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

2745

"events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

2746

"A String",

2747

],

2748

"displayName": "A String", # Required. The name of this intent.

2749

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

2750

"parameters": [ # Optional. The collection of parameters associated with the intent.

2751

{ # Represents intent parameters.

2752

"name": "A String", # The unique identifier of this parameter.

2753

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.

2754

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2755

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.

2756

"value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.

2757

"displayName": "A String", # Required. The name of the parameter.

2758

"prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

2759

"A String",

2760

],

2761

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

2762

},

2763

],

2764

"trainingPhrases": [ # Optional. The collection of examples that the agent is trained on.

2765

{ # Represents an example that the agent is trained on.

2766

"type": "A String", # Required. The type of the training phrase.

2767

"name": "A String", # Output only. The unique identifier of this training phrase.

2768

"parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.

2769

{ # Represents a part of a training phrase.

2770

"text": "A String", # Required. The text for this part.

2771

"alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

2772

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

2773

"entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.

2774

},

2775

],

2776

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2777

},

2778

],

2779

"inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`

2780

"A String",

2781

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2782

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2783

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2784

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.

2785

{ # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

2786

"parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

2787

"a_key": "", # Properties of the object.

2788

},

2789

"name": "A String", # Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

2790

"lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

2791

},

2792

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2793

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.

2794

"action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2795

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.

2796

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2797

"messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2798

{ # Corresponds to the `Response` field in the Dialogflow console.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2799

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google.

2800

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items.

2801

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

2802

{ # Browsing carousel tile

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2803

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2804

"url": "A String", # Required. URL

2805

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

2806

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2807

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2808

"image": { # The image response message. # Optional. Hero image for the carousel item.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2809

"imageUri": "A String", # Optional. The public URI to an image file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2810

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2811

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2812

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2813

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2814

},

2815

],

2816

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2817

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2818

"phoneNumber": "A String", # Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2819

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2820

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2821

"suggestions": [ # Required. The list of suggested replies.

2822

{ # The suggestion chip message that the user can tap to quickly post a reply to the conversation.

2823

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2824

},

2825

],

2826

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2827

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2828

"items": [ # Required. List items.

2829

{ # An item in the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2830

"image": { # The image response message. # Optional. The image to display.

2831

"imageUri": "A String", # Optional. The public URI to an image file.

2832

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2833

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2834

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2835

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

2836

"A String",

2837

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2838

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2839

},

2840

"title": "A String", # Required. The title of the list item.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2841

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2842

},

2843

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2844

"subtitle": "A String", # Optional. Subtitle of the list.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2845

"title": "A String", # Optional. The overall title of the list.

2846

},

2847

"image": { # The image response message. # Displays an image.

2848

"imageUri": "A String", # Optional. The public URI to an image file.

2849

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2850

},

2851

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # Displays a link out suggestion chip for Actions on Google.

2852

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2853

"uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip.

2854

},

2855

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

2856

"buttons": [ # Optional. The collection of card buttons.

2857

{ # The button object that appears at the bottom of a card.

2858

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2859

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2860

},

2861

"title": "A String", # Required. The title of the button.

2862

},

2863

],

2864

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2865

"image": { # The image response message. # Optional. The image for the card.

2866

"imageUri": "A String", # Optional. The public URI to an image file.

2867

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2868

},

2869

"title": "A String", # Optional. The title of the card.

2870

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2871

},

2872

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2873

"items": [ # Required. Carousel items.

2874

{ # An item in the carousel.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2875

"image": { # The image response message. # Optional. The image to display.

2876

"imageUri": "A String", # Optional. The public URI to an image file.

2877

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2878

},

2879

"title": "A String", # Required. Title of the carousel item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2880

"info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2881

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog.

2882

"A String",

2883

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2884

"key": "A String", # Required. A unique key that will be sent back to the agent if this response is given.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2885

},

2886

"description": "A String", # Optional. The body text of the card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2887

},

2888

],

2889

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2890

"text": { # The text response message. # Returns a text response.

2891

"text": [ # Optional. The collection of the agent's responses.

2892

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2893

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2894

},

2895

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2896

"title": "A String", # Required. Title of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2897

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2898

"imageUri": "A String", # Optional. The public URI to an image file.

2899

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2900

},

2901

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2902

"rows": [ # Optional. Rows in this table of data.

2903

{ # Row of TableCard.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2904

"cells": [ # Optional. List of cells that make up this row.

2905

{ # Cell of TableCardRow.

2906

"text": "A String", # Required. Text in this cell.

2907

},

2908

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2909

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2910

},

2911

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2912

"columnProperties": [ # Optional. Display properties for the columns in this table.

2913

{ # Column properties for TableCard.

2914

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2915

"header": "A String", # Required. Column heading.

2916

},

2917

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2918

"buttons": [ # Optional. List of buttons for the card.

2919

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2920

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2921

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2922

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2923

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2924

},

2925

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2926

},

2927

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. # Rich Business Messaging (RBM) carousel rich card response.

2928

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

2929

{ # Rich Business Messaging (RBM) Card content

2930

"suggestions": [ # Optional. List of suggestions to include in the card.

2931

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

2932

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

2933

"text": "A String", # Suggested reply text.

2934

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

2935

},

2936

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

2937

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

2938

"uri": "A String", # Required. The uri to open on the user device

2939

},

2940

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

2941

},

2942

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

2943

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

2944

},

2945

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

2946

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

2951

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

2952

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

2953

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

2954

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

2955

},

2956

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

2957

},

2958

],

2959

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2960

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2961

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2962

"subtitle": "A String", # Optional. The subtitle of the card.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2963

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2964

"title": "A String", # Optional. The title of the card.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2965

"buttons": [ # Optional. The collection of card buttons.

2966

{ # Optional. Contains information about a button.

2967

"text": "A String", # Optional. The text to show on the button.

2968

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2969

},

2970

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2971

},

2972

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2973

"mediaObjects": [ # Required. List of media objects.

2974

{ # Response media object for media content card.

2975

"description": "A String", # Optional. Description of media card.

2976

"contentUrl": "A String", # Required. Url where the media is stored.

2977

"name": "A String", # Required. Name of media card.

2978

"largeImage": { # The image response message. # Optional. Image to display above media content.

2979

"imageUri": "A String", # Optional. The public URI to an image file.

2980

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

2981

},

2982

"icon": { # The image response message. # Optional. Icon to display above media content.

2983

"imageUri": "A String", # Optional. The public URI to an image file.

2984

"accessibilityText": "A String", # A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2989

},

2990

"platform": "A String", # Optional. The platform that this message is intended for.

2991

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. # Standalone Rich Business Messaging (RBM) rich card response.

2992

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

2993

"suggestions": [ # Optional. List of suggestions to include in the card.

2994

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

2995

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

2996

"text": "A String", # Suggested reply text.

2997

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

2998

},

2999

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

3000

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

3001

"uri": "A String", # Required. The uri to open on the user device

3002

},

3003

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

3004

},

3005

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

3006

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

3007

},

3008

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

3009

"text": "A String", # Text to display alongside the action.

},

},

],

"description": "A String", # Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.

3014

"media": { # Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm # Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

3015

"height": "A String", # Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

3016

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

3017

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

3018

},

3019

"title": "A String", # Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.

3020

},

3021

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

3022

"cardOrientation": "A String", # Required. Orientation of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3023

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3024

"payload": { # A custom platform-specific response.

3025

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3026

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3027

"simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # Returns a voice or text-only response for Actions on Google.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3028

"simpleResponses": [ # Required. The list of simple responses.

3029

{ # The simple response message containing speech or text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3030

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3031

"displayText": "A String", # Optional. The text to display.

3032

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3033

},

3034

],

3035

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3036

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3037

"text": "A String", # Required. Text sent and displayed to the user.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3038

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

3039

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3040

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. # Predefined replies for user to select instead of typing

3041

"text": "A String", # Suggested reply text.

3042

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

3043

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3044

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. # Predefined client side actions that user can choose

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3045

"openUrl": { # Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. # Suggested client side action: Open a URI on device

3046

"uri": "A String", # Required. The uri to open on the user device

3047

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3048

"shareLocation": { # Opens the device's location chooser so the user can pick a location to send back to the agent. # Suggested client side action: Share user location

3049

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3050

"dial": { # Opens the user's default dialer app with the specified phone number but does not dial automatically. # Suggested client side action: Dial a phone number

3051

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.

3052

},

3053

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

3054

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3055

},

3056

},

3057

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3058

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3059

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

3060

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.

3061

},

3062

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. # Synthesizes speech in Telephony Gateway.

3063

"text": "A String", # The raw text to be synthesized.

3064

"ssml": "A String", # The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3065

},

3066

"quickReplies": { # The quick replies response message. # Displays quick replies.

3067

"quickReplies": [ # Optional. The collection of quick replies.

3068

"A String",

3069

],

3070

"title": "A String", # Optional. The title of the collection of quick replies.

3071

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3072

},

3073

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3074

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3075

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3076

"name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`

3077

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

3078

{ # Represents a single followup intent in the chain.

3079

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.

3080

"followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`.

3081

},

3082

],

Bu Sun Kim