google-cloud-dialogflow-v2 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +24 -0
  6. data/lib/google-cloud-dialogflow-v2.rb +1 -0
  7. data/lib/google/cloud/common_resources_pb.rb +15 -0
  8. data/lib/google/cloud/dialogflow/v2.rb +24 -0
  9. data/lib/google/cloud/dialogflow/v2/agent_pb.rb +122 -0
  10. data/lib/google/cloud/dialogflow/v2/agent_services_pb.rb +110 -0
  11. data/lib/google/cloud/dialogflow/v2/agents.rb +21 -0
  12. data/lib/google/cloud/dialogflow/v2/agents/client.rb +1047 -0
  13. data/lib/google/cloud/dialogflow/v2/agents/credentials.rb +53 -0
  14. data/lib/google/cloud/dialogflow/v2/agents/operations.rb +559 -0
  15. data/lib/google/cloud/dialogflow/v2/agents/paths.rb +59 -0
  16. data/lib/google/cloud/dialogflow/v2/audio_config_pb.rb +97 -0
  17. data/lib/google/cloud/dialogflow/v2/context_pb.rb +64 -0
  18. data/lib/google/cloud/dialogflow/v2/context_services_pb.rb +74 -0
  19. data/lib/google/cloud/dialogflow/v2/contexts.rb +20 -0
  20. data/lib/google/cloud/dialogflow/v2/contexts/client.rb +756 -0
  21. data/lib/google/cloud/dialogflow/v2/contexts/credentials.rb +53 -0
  22. data/lib/google/cloud/dialogflow/v2/contexts/paths.rb +50 -0
  23. data/lib/google/cloud/dialogflow/v2/entity_type_pb.rb +126 -0
  24. data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb +104 -0
  25. data/lib/google/cloud/dialogflow/v2/entity_types.rb +21 -0
  26. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +1150 -0
  27. data/lib/google/cloud/dialogflow/v2/entity_types/credentials.rb +53 -0
  28. data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +559 -0
  29. data/lib/google/cloud/dialogflow/v2/entity_types/paths.rb +62 -0
  30. data/lib/google/cloud/dialogflow/v2/intent_pb.rb +368 -0
  31. data/lib/google/cloud/dialogflow/v2/intent_services_pb.rb +92 -0
  32. data/lib/google/cloud/dialogflow/v2/intents.rb +21 -0
  33. data/lib/google/cloud/dialogflow/v2/intents/client.rb +893 -0
  34. data/lib/google/cloud/dialogflow/v2/intents/credentials.rb +53 -0
  35. data/lib/google/cloud/dialogflow/v2/intents/operations.rb +559 -0
  36. data/lib/google/cloud/dialogflow/v2/intents/paths.rb +81 -0
  37. data/lib/google/cloud/dialogflow/v2/session_entity_type_pb.rb +66 -0
  38. data/lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb +92 -0
  39. data/lib/google/cloud/dialogflow/v2/session_entity_types.rb +20 -0
  40. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +727 -0
  41. data/lib/google/cloud/dialogflow/v2/session_entity_types/credentials.rb +53 -0
  42. data/lib/google/cloud/dialogflow/v2/session_entity_types/paths.rb +69 -0
  43. data/lib/google/cloud/dialogflow/v2/session_pb.rb +142 -0
  44. data/lib/google/cloud/dialogflow/v2/session_services_pb.rb +55 -0
  45. data/lib/google/cloud/dialogflow/v2/sessions.rb +20 -0
  46. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +472 -0
  47. data/lib/google/cloud/dialogflow/v2/sessions/credentials.rb +53 -0
  48. data/lib/google/cloud/dialogflow/v2/sessions/paths.rb +110 -0
  49. data/lib/google/cloud/dialogflow/v2/validation_result_pb.rb +37 -0
  50. data/lib/google/cloud/dialogflow/v2/version.rb +28 -0
  51. data/lib/google/cloud/dialogflow/v2/webhook_pb.rb +47 -0
  52. data/proto_docs/README.md +4 -0
  53. data/proto_docs/google/api/field_behavior.rb +59 -0
  54. data/proto_docs/google/api/resource.rb +247 -0
  55. data/proto_docs/google/cloud/dialogflow/v2/agent.rb +287 -0
  56. data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +363 -0
  57. data/proto_docs/google/cloud/dialogflow/v2/context.rb +144 -0
  58. data/proto_docs/google/cloud/dialogflow/v2/entity_type.rb +354 -0
  59. data/proto_docs/google/cloud/dialogflow/v2/intent.rb +1070 -0
  60. data/proto_docs/google/cloud/dialogflow/v2/session.rb +541 -0
  61. data/proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb +155 -0
  62. data/proto_docs/google/cloud/dialogflow/v2/validation_result.rb +81 -0
  63. data/proto_docs/google/cloud/dialogflow/v2/webhook.rb +153 -0
  64. data/proto_docs/google/longrunning/operations.rb +150 -0
  65. data/proto_docs/google/protobuf/any.rb +137 -0
  66. data/proto_docs/google/protobuf/duration.rb +98 -0
  67. data/proto_docs/google/protobuf/empty.rb +36 -0
  68. data/proto_docs/google/protobuf/field_mask.rb +237 -0
  69. data/proto_docs/google/protobuf/struct.rb +96 -0
  70. data/proto_docs/google/rpc/status.rb +46 -0
  71. data/proto_docs/google/type/latlng.rb +38 -0
  72. metadata +225 -0
@@ -0,0 +1,1070 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Dialogflow
23
+ module V2
24
+ # Represents an intent.
25
+ # Intents convert a number of user expressions or patterns into an action. An
26
+ # action is an extraction of a user command or sentence semantics.
27
+ # @!attribute [rw] name
28
+ # @return [String]
29
+ # The unique identifier of this intent.
30
+ # Required for {Google::Cloud::Dialogflow::V2::Intents::Client#update_intent Intents.UpdateIntent} and {Google::Cloud::Dialogflow::V2::Intents::Client#batch_update_intents Intents.BatchUpdateIntents}
31
+ # methods.
32
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
33
+ # @!attribute [rw] display_name
34
+ # @return [String]
35
+ # Required. The name of this intent.
36
+ # @!attribute [rw] webhook_state
37
+ # @return [Google::Cloud::Dialogflow::V2::Intent::WebhookState]
38
+ # Optional. Indicates whether webhooks are enabled for the intent.
39
+ # @!attribute [rw] priority
40
+ # @return [Integer]
41
+ # Optional. The priority of this intent. Higher numbers represent higher
42
+ # priorities.
43
+ #
44
+ # - If the supplied value is unspecified or 0, the service
45
+ # translates the value to 500,000, which corresponds to the
46
+ # `Normal` priority in the console.
47
+ # - If the supplied value is negative, the intent is ignored
48
+ # in runtime detect intent requests.
49
+ # @!attribute [rw] is_fallback
50
+ # @return [Boolean]
51
+ # Optional. Indicates whether this is a fallback intent.
52
+ # @!attribute [rw] ml_disabled
53
+ # @return [Boolean]
54
+ # Optional. Indicates whether Machine Learning is disabled for the intent.
55
+ # Note: If `ml_disabled` setting is set to true, then this intent is not
56
+ # taken into account during inference in `ML ONLY` match mode. Also,
57
+ # auto-markup in the UI is turned off.
58
+ # @!attribute [rw] input_context_names
59
+ # @return [Array<String>]
60
+ # Optional. The list of context names required for this intent to be
61
+ # triggered.
62
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
63
+ # @!attribute [rw] events
64
+ # @return [Array<String>]
65
+ # Optional. The collection of event names that trigger the intent.
66
+ # If the collection of input contexts is not empty, all of the contexts must
67
+ # be present in the active user session for an event to trigger this intent.
68
+ # @!attribute [rw] training_phrases
69
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase>]
70
+ # Optional. The collection of examples that the agent is
71
+ # trained on.
72
+ # @!attribute [rw] action
73
+ # @return [String]
74
+ # Optional. The name of the action associated with the intent.
75
+ # Note: The action name must not contain whitespaces.
76
+ # @!attribute [rw] output_contexts
77
+ # @return [Array<Google::Cloud::Dialogflow::V2::Context>]
78
+ # Optional. The collection of contexts that are activated when the intent
79
+ # is matched. Context messages in this collection should not set the
80
+ # parameters field. Setting the `lifespan_count` to 0 will reset the context
81
+ # when the intent is matched.
82
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
83
+ # @!attribute [rw] reset_contexts
84
+ # @return [Boolean]
85
+ # Optional. Indicates whether to delete all contexts in the current
86
+ # session when this intent is matched.
87
+ # @!attribute [rw] parameters
88
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Parameter>]
89
+ # Optional. The collection of parameters associated with the intent.
90
+ # @!attribute [rw] messages
91
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message>]
92
+ # Optional. The collection of rich messages corresponding to the
93
+ # `Response` field in the Dialogflow console.
94
+ # @!attribute [rw] default_response_platforms
95
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::Platform>]
96
+ # Optional. The list of platforms for which the first responses will be
97
+ # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
98
+ # @!attribute [rw] root_followup_intent_name
99
+ # @return [String]
100
+ # Read-only. The unique identifier of the root intent in the chain of
101
+ # followup intents. It identifies the correct followup intents chain for
102
+ # this intent. We populate this field only in the output.
103
+ #
104
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
105
+ # @!attribute [rw] parent_followup_intent_name
106
+ # @return [String]
107
+ # Read-only after creation. The unique identifier of the parent intent in the
108
+ # chain of followup intents. You can set this field when creating an intent,
109
+ # for example with {Google::Cloud::Dialogflow::V2::Intents::Client#create_intent CreateIntent} or
110
+ # {Google::Cloud::Dialogflow::V2::Intents::Client#batch_update_intents BatchUpdateIntents}, in order to make this
111
+ # intent a followup intent.
112
+ #
113
+ # It identifies the parent followup intent.
114
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
115
+ # @!attribute [rw] followup_intent_info
116
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::FollowupIntentInfo>]
117
+ # Read-only. Information about all followup intents that have this intent as
118
+ # a direct or indirect parent. We populate this field only in the output.
119
+ class Intent
120
+ include Google::Protobuf::MessageExts
121
+ extend Google::Protobuf::MessageExts::ClassMethods
122
+
123
+ # Represents an example that the agent is trained on.
124
+ # @!attribute [rw] name
125
+ # @return [String]
126
+ # Output only. The unique identifier of this training phrase.
127
+ # @!attribute [rw] type
128
+ # @return [Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Type]
129
+ # Required. The type of the training phrase.
130
+ # @!attribute [rw] parts
131
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Part>]
132
+ # Required. The ordered list of training phrase parts.
133
+ # The parts are concatenated in order to form the training phrase.
134
+ #
135
+ # Note: The API does not automatically annotate training phrases like the
136
+ # Dialogflow Console does.
137
+ #
138
+ # Note: Do not forget to include whitespace at part boundaries,
139
+ # so the training phrase is well formatted when the parts are concatenated.
140
+ #
141
+ # If the training phrase does not need to be annotated with parameters,
142
+ # you just need a single part with only the {Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Part#text Part.text} field set.
143
+ #
144
+ # If you want to annotate the training phrase, you must create multiple
145
+ # parts, where the fields of each part are populated in one of two ways:
146
+ #
147
+ # - `Part.text` is set to a part of the phrase that has no parameters.
148
+ # - `Part.text` is set to a part of the phrase that you want to annotate,
149
+ # and the `entity_type`, `alias`, and `user_defined` fields are all
150
+ # set.
151
+ # @!attribute [rw] times_added_count
152
+ # @return [Integer]
153
+ # Optional. Indicates how many times this example was added to
154
+ # the intent. Each time a developer adds an existing sample by editing an
155
+ # intent or training, this counter is increased.
156
+ class TrainingPhrase
157
+ include Google::Protobuf::MessageExts
158
+ extend Google::Protobuf::MessageExts::ClassMethods
159
+
160
+ # Represents a part of a training phrase.
161
+ # @!attribute [rw] text
162
+ # @return [String]
163
+ # Required. The text for this part.
164
+ # @!attribute [rw] entity_type
165
+ # @return [String]
166
+ # Optional. The entity type name prefixed with `@`.
167
+ # This field is required for annotated parts of the training phrase.
168
+ # @!attribute [rw] alias
169
+ # @return [String]
170
+ # Optional. The parameter name for the value extracted from the
171
+ # annotated part of the example.
172
+ # This field is required for annotated parts of the training phrase.
173
+ # @!attribute [rw] user_defined
174
+ # @return [Boolean]
175
+ # Optional. Indicates whether the text was manually annotated.
176
+ # This field is set to true when the Dialogflow Console is used to
177
+ # manually annotate the part. When creating an annotated part with the
178
+ # API, you must set this to true.
179
+ class Part
180
+ include Google::Protobuf::MessageExts
181
+ extend Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Represents different types of training phrases.
185
+ module Type
186
+ # Not specified. This value should never be used.
187
+ TYPE_UNSPECIFIED = 0
188
+
189
+ # Examples do not contain @-prefixed entity type names, but example parts
190
+ # can be annotated with entity types.
191
+ EXAMPLE = 1
192
+
193
+ # Templates are not annotated with entity types, but they can contain
194
+ # @-prefixed entity type names as substrings.
195
+ # Template mode has been deprecated. Example mode is the only supported
196
+ # way to create new training phrases. If you have existing training
197
+ # phrases that you've created in template mode, those will continue to
198
+ # work.
199
+ TEMPLATE = 2
200
+ end
201
+ end
202
+
203
+ # Represents intent parameters.
204
+ # @!attribute [rw] name
205
+ # @return [String]
206
+ # The unique identifier of this parameter.
207
+ # @!attribute [rw] display_name
208
+ # @return [String]
209
+ # Required. The name of the parameter.
210
+ # @!attribute [rw] value
211
+ # @return [String]
212
+ # Optional. The definition of the parameter value. It can be:
213
+ # - a constant string,
214
+ # - a parameter value defined as `$parameter_name`,
215
+ # - an original parameter value defined as `$parameter_name.original`,
216
+ # - a parameter value from some context defined as
217
+ # `#context_name.parameter_name`.
218
+ # @!attribute [rw] default_value
219
+ # @return [String]
220
+ # Optional. The default value to use when the `value` yields an empty
221
+ # result.
222
+ # Default values can be extracted from contexts by using the following
223
+ # syntax: `#context_name.parameter_name`.
224
+ # @!attribute [rw] entity_type_display_name
225
+ # @return [String]
226
+ # Optional. The name of the entity type, prefixed with `@`, that
227
+ # describes values of the parameter. If the parameter is
228
+ # required, this must be provided.
229
+ # @!attribute [rw] mandatory
230
+ # @return [Boolean]
231
+ # Optional. Indicates whether the parameter is required. That is,
232
+ # whether the intent cannot be completed without collecting the parameter
233
+ # value.
234
+ # @!attribute [rw] prompts
235
+ # @return [Array<String>]
236
+ # Optional. The collection of prompts that the agent can present to the
237
+ # user in order to collect a value for the parameter.
238
+ # @!attribute [rw] is_list
239
+ # @return [Boolean]
240
+ # Optional. Indicates whether the parameter represents a list of values.
241
+ class Parameter
242
+ include Google::Protobuf::MessageExts
243
+ extend Google::Protobuf::MessageExts::ClassMethods
244
+ end
245
+
246
+ # Corresponds to the `Response` field in the Dialogflow console.
247
+ # @!attribute [rw] text
248
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Text]
249
+ # The text response.
250
+ # @!attribute [rw] image
251
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
252
+ # The image response.
253
+ # @!attribute [rw] quick_replies
254
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::QuickReplies]
255
+ # The quick replies response.
256
+ # @!attribute [rw] card
257
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Card]
258
+ # The card response.
259
+ # @!attribute [rw] payload
260
+ # @return [Google::Protobuf::Struct]
261
+ # Returns a response containing a custom, platform-specific payload.
262
+ # See the Intent.Message.Platform type for a description of the
263
+ # structure that may be required for your platform.
264
+ # @!attribute [rw] simple_responses
265
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::SimpleResponses]
266
+ # The voice and text-only responses for Actions on Google.
267
+ # @!attribute [rw] basic_card
268
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::BasicCard]
269
+ # The basic card response for Actions on Google.
270
+ # @!attribute [rw] suggestions
271
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Suggestions]
272
+ # The suggestion chips for Actions on Google.
273
+ # @!attribute [rw] link_out_suggestion
274
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::LinkOutSuggestion]
275
+ # The link out suggestion chip for Actions on Google.
276
+ # @!attribute [rw] list_select
277
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::ListSelect]
278
+ # The list card response for Actions on Google.
279
+ # @!attribute [rw] carousel_select
280
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::CarouselSelect]
281
+ # The carousel card response for Actions on Google.
282
+ # @!attribute [rw] browse_carousel_card
283
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard]
284
+ # Browse carousel card for Actions on Google.
285
+ # @!attribute [rw] table_card
286
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::TableCard]
287
+ # Table card for Actions on Google.
288
+ # @!attribute [rw] media_content
289
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::MediaContent]
290
+ # The media content card for Actions on Google.
291
+ # @!attribute [rw] platform
292
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Platform]
293
+ # Optional. The platform that this message is intended for.
294
+ class Message
295
+ include Google::Protobuf::MessageExts
296
+ extend Google::Protobuf::MessageExts::ClassMethods
297
+
298
+ # The text response message.
299
+ # @!attribute [rw] text
300
+ # @return [Array<String>]
301
+ # Optional. The collection of the agent's responses.
302
+ class Text
303
+ include Google::Protobuf::MessageExts
304
+ extend Google::Protobuf::MessageExts::ClassMethods
305
+ end
306
+
307
+ # The image response message.
308
+ # @!attribute [rw] image_uri
309
+ # @return [String]
310
+ # Optional. The public URI to an image file.
311
+ # @!attribute [rw] accessibility_text
312
+ # @return [String]
313
+ # Optional. A text description of the image to be used for accessibility,
314
+ # e.g., screen readers.
315
+ class Image
316
+ include Google::Protobuf::MessageExts
317
+ extend Google::Protobuf::MessageExts::ClassMethods
318
+ end
319
+
320
+ # The quick replies response message.
321
+ # @!attribute [rw] title
322
+ # @return [String]
323
+ # Optional. The title of the collection of quick replies.
324
+ # @!attribute [rw] quick_replies
325
+ # @return [Array<String>]
326
+ # Optional. The collection of quick replies.
327
+ class QuickReplies
328
+ include Google::Protobuf::MessageExts
329
+ extend Google::Protobuf::MessageExts::ClassMethods
330
+ end
331
+
332
+ # The card response message.
333
+ # @!attribute [rw] title
334
+ # @return [String]
335
+ # Optional. The title of the card.
336
+ # @!attribute [rw] subtitle
337
+ # @return [String]
338
+ # Optional. The subtitle of the card.
339
+ # @!attribute [rw] image_uri
340
+ # @return [String]
341
+ # Optional. The public URI to an image file for the card.
342
+ # @!attribute [rw] buttons
343
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::Card::Button>]
344
+ # Optional. The collection of card buttons.
345
+ class Card
346
+ include Google::Protobuf::MessageExts
347
+ extend Google::Protobuf::MessageExts::ClassMethods
348
+
349
+ # Contains information about a button.
350
+ # @!attribute [rw] text
351
+ # @return [String]
352
+ # Optional. The text to show on the button.
353
+ # @!attribute [rw] postback
354
+ # @return [String]
355
+ # Optional. The text to send back to the Dialogflow API or a URI to
356
+ # open.
357
+ class Button
358
+ include Google::Protobuf::MessageExts
359
+ extend Google::Protobuf::MessageExts::ClassMethods
360
+ end
361
+ end
362
+
363
+ # The simple response message containing speech or text.
364
+ # @!attribute [rw] text_to_speech
365
+ # @return [String]
366
+ # One of text_to_speech or ssml must be provided. The plain text of the
367
+ # speech output. Mutually exclusive with ssml.
368
+ # @!attribute [rw] ssml
369
+ # @return [String]
370
+ # One of text_to_speech or ssml must be provided. Structured spoken
371
+ # response to the user in the SSML format. Mutually exclusive with
372
+ # text_to_speech.
373
+ # @!attribute [rw] display_text
374
+ # @return [String]
375
+ # Optional. The text to display.
376
+ class SimpleResponse
377
+ include Google::Protobuf::MessageExts
378
+ extend Google::Protobuf::MessageExts::ClassMethods
379
+ end
380
+
381
+ # The collection of simple response candidates.
382
+ # This message in `QueryResult.fulfillment_messages` and
383
+ # `WebhookResponse.fulfillment_messages` should contain only one
384
+ # `SimpleResponse`.
385
+ # @!attribute [rw] simple_responses
386
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::SimpleResponse>]
387
+ # Required. The list of simple responses.
388
+ class SimpleResponses
389
+ include Google::Protobuf::MessageExts
390
+ extend Google::Protobuf::MessageExts::ClassMethods
391
+ end
392
+
393
+ # The basic card message. Useful for displaying information.
394
+ # @!attribute [rw] title
395
+ # @return [String]
396
+ # Optional. The title of the card.
397
+ # @!attribute [rw] subtitle
398
+ # @return [String]
399
+ # Optional. The subtitle of the card.
400
+ # @!attribute [rw] formatted_text
401
+ # @return [String]
402
+ # Required, unless image is present. The body text of the card.
403
+ # @!attribute [rw] image
404
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
405
+ # Optional. The image for the card.
406
+ # @!attribute [rw] buttons
407
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::BasicCard::Button>]
408
+ # Optional. The collection of card buttons.
409
+ class BasicCard
410
+ include Google::Protobuf::MessageExts
411
+ extend Google::Protobuf::MessageExts::ClassMethods
412
+
413
+ # The button object that appears at the bottom of a card.
414
+ # @!attribute [rw] title
415
+ # @return [String]
416
+ # Required. The title of the button.
417
+ # @!attribute [rw] open_uri_action
418
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::BasicCard::Button::OpenUriAction]
419
+ # Required. Action to take when a user taps on the button.
420
+ class Button
421
+ include Google::Protobuf::MessageExts
422
+ extend Google::Protobuf::MessageExts::ClassMethods
423
+
424
+ # Opens the given URI.
425
+ # @!attribute [rw] uri
426
+ # @return [String]
427
+ # Required. The HTTP or HTTPS scheme URI.
428
+ class OpenUriAction
429
+ include Google::Protobuf::MessageExts
430
+ extend Google::Protobuf::MessageExts::ClassMethods
431
+ end
432
+ end
433
+ end
434
+
435
+ # The suggestion chip message that the user can tap to quickly post a reply
436
+ # to the conversation.
437
+ # @!attribute [rw] title
438
+ # @return [String]
439
+ # Required. The text shown the in the suggestion chip.
440
+ class Suggestion
441
+ include Google::Protobuf::MessageExts
442
+ extend Google::Protobuf::MessageExts::ClassMethods
443
+ end
444
+
445
+ # The collection of suggestions.
446
+ # @!attribute [rw] suggestions
447
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::Suggestion>]
448
+ # Required. The list of suggested replies.
449
+ class Suggestions
450
+ include Google::Protobuf::MessageExts
451
+ extend Google::Protobuf::MessageExts::ClassMethods
452
+ end
453
+
454
+ # The suggestion chip message that allows the user to jump out to the app
455
+ # or website associated with this agent.
456
+ # @!attribute [rw] destination_name
457
+ # @return [String]
458
+ # Required. The name of the app or site this chip is linking to.
459
+ # @!attribute [rw] uri
460
+ # @return [String]
461
+ # Required. The URI of the app or site to open when the user taps the
462
+ # suggestion chip.
463
+ class LinkOutSuggestion
464
+ include Google::Protobuf::MessageExts
465
+ extend Google::Protobuf::MessageExts::ClassMethods
466
+ end
467
+
468
+ # The card for presenting a list of options to select from.
469
+ # @!attribute [rw] title
470
+ # @return [String]
471
+ # Optional. The overall title of the list.
472
+ # @!attribute [rw] items
473
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::ListSelect::Item>]
474
+ # Required. List items.
475
+ # @!attribute [rw] subtitle
476
+ # @return [String]
477
+ # Optional. Subtitle of the list.
478
+ class ListSelect
479
+ include Google::Protobuf::MessageExts
480
+ extend Google::Protobuf::MessageExts::ClassMethods
481
+
482
+ # An item in the list.
483
+ # @!attribute [rw] info
484
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::SelectItemInfo]
485
+ # Required. Additional information about this option.
486
+ # @!attribute [rw] title
487
+ # @return [String]
488
+ # Required. The title of the list item.
489
+ # @!attribute [rw] description
490
+ # @return [String]
491
+ # Optional. The main text describing the item.
492
+ # @!attribute [rw] image
493
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
494
+ # Optional. The image to display.
495
+ class Item
496
+ include Google::Protobuf::MessageExts
497
+ extend Google::Protobuf::MessageExts::ClassMethods
498
+ end
499
+ end
500
+
501
+ # The card for presenting a carousel of options to select from.
502
+ # @!attribute [rw] items
503
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::CarouselSelect::Item>]
504
+ # Required. Carousel items.
505
+ class CarouselSelect
506
+ include Google::Protobuf::MessageExts
507
+ extend Google::Protobuf::MessageExts::ClassMethods
508
+
509
+ # An item in the carousel.
510
+ # @!attribute [rw] info
511
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::SelectItemInfo]
512
+ # Required. Additional info about the option item.
513
+ # @!attribute [rw] title
514
+ # @return [String]
515
+ # Required. Title of the carousel item.
516
+ # @!attribute [rw] description
517
+ # @return [String]
518
+ # Optional. The body text of the card.
519
+ # @!attribute [rw] image
520
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
521
+ # Optional. The image to display.
522
+ class Item
523
+ include Google::Protobuf::MessageExts
524
+ extend Google::Protobuf::MessageExts::ClassMethods
525
+ end
526
+ end
527
+
528
+ # Additional info about the select item for when it is triggered in a
529
+ # dialog.
530
+ # @!attribute [rw] key
531
+ # @return [String]
532
+ # Required. A unique key that will be sent back to the agent if this
533
+ # response is given.
534
+ # @!attribute [rw] synonyms
535
+ # @return [Array<String>]
536
+ # Optional. A list of synonyms that can also be used to trigger this
537
+ # item in dialog.
538
+ class SelectItemInfo
539
+ include Google::Protobuf::MessageExts
540
+ extend Google::Protobuf::MessageExts::ClassMethods
541
+ end
542
+
543
+ # The media content card for Actions on Google.
544
+ # @!attribute [rw] media_type
545
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::MediaContent::ResponseMediaType]
546
+ # Optional. What type of media is the content (ie "audio").
547
+ # @!attribute [rw] media_objects
548
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::MediaContent::ResponseMediaObject>]
549
+ # Required. List of media objects.
550
+ class MediaContent
551
+ include Google::Protobuf::MessageExts
552
+ extend Google::Protobuf::MessageExts::ClassMethods
553
+
554
+ # Response media object for media content card.
555
+ # @!attribute [rw] name
556
+ # @return [String]
557
+ # Required. Name of media card.
558
+ # @!attribute [rw] description
559
+ # @return [String]
560
+ # Optional. Description of media card.
561
+ # @!attribute [rw] large_image
562
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
563
+ # Optional. Image to display above media content.
564
+ # @!attribute [rw] icon
565
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
566
+ # Optional. Icon to display above media content.
567
+ # @!attribute [rw] content_url
568
+ # @return [String]
569
+ # Required. Url where the media is stored.
570
+ class ResponseMediaObject
571
+ include Google::Protobuf::MessageExts
572
+ extend Google::Protobuf::MessageExts::ClassMethods
573
+ end
574
+
575
+ # Format of response media type.
576
+ module ResponseMediaType
577
+ # Unspecified.
578
+ RESPONSE_MEDIA_TYPE_UNSPECIFIED = 0
579
+
580
+ # Response media type is audio.
581
+ AUDIO = 1
582
+ end
583
+ end
584
+
585
+ # Browse Carousel Card for Actions on Google.
586
+ # https://developers.google.com/actions/assistant/responses#browsing_carousel
587
+ # @!attribute [rw] items
588
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::BrowseCarouselCardItem>]
589
+ # Required. List of items in the Browse Carousel Card. Minimum of two
590
+ # items, maximum of ten.
591
+ # @!attribute [rw] image_display_options
592
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::ImageDisplayOptions]
593
+ # Optional. Settings for displaying the image. Applies to every image in
594
+ # {Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard#items items}.
595
+ class BrowseCarouselCard
596
+ include Google::Protobuf::MessageExts
597
+ extend Google::Protobuf::MessageExts::ClassMethods
598
+
599
+ # Browsing carousel tile
600
+ # @!attribute [rw] open_uri_action
601
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::BrowseCarouselCardItem::OpenUrlAction]
602
+ # Required. Action to present to the user.
603
+ # @!attribute [rw] title
604
+ # @return [String]
605
+ # Required. Title of the carousel item. Maximum of two lines of text.
606
+ # @!attribute [rw] description
607
+ # @return [String]
608
+ # Optional. Description of the carousel item. Maximum of four lines of
609
+ # text.
610
+ # @!attribute [rw] image
611
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
612
+ # Optional. Hero image for the carousel item.
613
+ # @!attribute [rw] footer
614
+ # @return [String]
615
+ # Optional. Text that appears at the bottom of the Browse Carousel
616
+ # Card. Maximum of one line of text.
617
+ class BrowseCarouselCardItem
618
+ include Google::Protobuf::MessageExts
619
+ extend Google::Protobuf::MessageExts::ClassMethods
620
+
621
+ # Actions on Google action to open a given url.
622
+ # @!attribute [rw] url
623
+ # @return [String]
624
+ # Required. URL
625
+ # @!attribute [rw] url_type_hint
626
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::BrowseCarouselCardItem::OpenUrlAction::UrlTypeHint]
627
+ # Optional. Specifies the type of viewer that is used when opening
628
+ # the URL. Defaults to opening via web browser.
629
+ class OpenUrlAction
630
+ include Google::Protobuf::MessageExts
631
+ extend Google::Protobuf::MessageExts::ClassMethods
632
+
633
+ # Type of the URI.
634
+ module UrlTypeHint
635
+ # Unspecified
636
+ URL_TYPE_HINT_UNSPECIFIED = 0
637
+
638
+ # Url would be an amp action
639
+ AMP_ACTION = 1
640
+
641
+ # URL that points directly to AMP content, or to a canonical URL
642
+ # which refers to AMP content via <link rel="amphtml">.
643
+ AMP_CONTENT = 2
644
+ end
645
+ end
646
+ end
647
+
648
+ # Image display options for Actions on Google. This should be used for
649
+ # when the image's aspect ratio does not match the image container's
650
+ # aspect ratio.
651
+ module ImageDisplayOptions
652
+ # Fill the gaps between the image and the image container with gray
653
+ # bars.
654
+ IMAGE_DISPLAY_OPTIONS_UNSPECIFIED = 0
655
+
656
+ # Fill the gaps between the image and the image container with gray
657
+ # bars.
658
+ GRAY = 1
659
+
660
+ # Fill the gaps between the image and the image container with white
661
+ # bars.
662
+ WHITE = 2
663
+
664
+ # Image is scaled such that the image width and height match or exceed
665
+ # the container dimensions. This may crop the top and bottom of the
666
+ # image if the scaled image height is greater than the container
667
+ # height, or crop the left and right of the image if the scaled image
668
+ # width is greater than the container width. This is similar to "Zoom
669
+ # Mode" on a widescreen TV when playing a 4:3 video.
670
+ CROPPED = 3
671
+
672
+ # Pad the gaps between image and image frame with a blurred copy of the
673
+ # same image.
674
+ BLURRED_BACKGROUND = 4
675
+ end
676
+ end
677
+
678
+ # Table card for Actions on Google.
679
+ # @!attribute [rw] title
680
+ # @return [String]
681
+ # Required. Title of the card.
682
+ # @!attribute [rw] subtitle
683
+ # @return [String]
684
+ # Optional. Subtitle to the title.
685
+ # @!attribute [rw] image
686
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
687
+ # Optional. Image which should be displayed on the card.
688
+ # @!attribute [rw] column_properties
689
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::ColumnProperties>]
690
+ # Optional. Display properties for the columns in this table.
691
+ # @!attribute [rw] rows
692
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::TableCardRow>]
693
+ # Optional. Rows in this table of data.
694
+ # @!attribute [rw] buttons
695
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::BasicCard::Button>]
696
+ # Optional. List of buttons for the card.
697
+ class TableCard
698
+ include Google::Protobuf::MessageExts
699
+ extend Google::Protobuf::MessageExts::ClassMethods
700
+ end
701
+
702
+ # Column properties for {Google::Cloud::Dialogflow::V2::Intent::Message::TableCard TableCard}.
703
+ # @!attribute [rw] header
704
+ # @return [String]
705
+ # Required. Column heading.
706
+ # @!attribute [rw] horizontal_alignment
707
+ # @return [Google::Cloud::Dialogflow::V2::Intent::Message::ColumnProperties::HorizontalAlignment]
708
+ # Optional. Defines text alignment for all cells in this column.
709
+ class ColumnProperties
710
+ include Google::Protobuf::MessageExts
711
+ extend Google::Protobuf::MessageExts::ClassMethods
712
+
713
+ # Text alignments within a cell.
714
+ module HorizontalAlignment
715
+ # Text is aligned to the leading edge of the column.
716
+ HORIZONTAL_ALIGNMENT_UNSPECIFIED = 0
717
+
718
+ # Text is aligned to the leading edge of the column.
719
+ LEADING = 1
720
+
721
+ # Text is centered in the column.
722
+ CENTER = 2
723
+
724
+ # Text is aligned to the trailing edge of the column.
725
+ TRAILING = 3
726
+ end
727
+ end
728
+
729
+ # Row of {Google::Cloud::Dialogflow::V2::Intent::Message::TableCard TableCard}.
730
+ # @!attribute [rw] cells
731
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::TableCardCell>]
732
+ # Optional. List of cells that make up this row.
733
+ # @!attribute [rw] divider_after
734
+ # @return [Boolean]
735
+ # Optional. Whether to add a visual divider after this row.
736
+ class TableCardRow
737
+ include Google::Protobuf::MessageExts
738
+ extend Google::Protobuf::MessageExts::ClassMethods
739
+ end
740
+
741
+ # Cell of {Google::Cloud::Dialogflow::V2::Intent::Message::TableCardRow TableCardRow}.
742
+ # @!attribute [rw] text
743
+ # @return [String]
744
+ # Required. Text in this cell.
745
+ class TableCardCell
746
+ include Google::Protobuf::MessageExts
747
+ extend Google::Protobuf::MessageExts::ClassMethods
748
+ end
749
+
750
+ # Represents different platforms that a rich message can be intended for.
751
+ module Platform
752
+ # Not specified.
753
+ PLATFORM_UNSPECIFIED = 0
754
+
755
+ # Facebook.
756
+ FACEBOOK = 1
757
+
758
+ # Slack.
759
+ SLACK = 2
760
+
761
+ # Telegram.
762
+ TELEGRAM = 3
763
+
764
+ # Kik.
765
+ KIK = 4
766
+
767
+ # Skype.
768
+ SKYPE = 5
769
+
770
+ # Line.
771
+ LINE = 6
772
+
773
+ # Viber.
774
+ VIBER = 7
775
+
776
+ # Actions on Google.
777
+ # When using Actions on Google, you can choose one of the specific
778
+ # Intent.Message types that mention support for Actions on Google,
779
+ # or you can use the advanced Intent.Message.payload field.
780
+ # The payload field provides access to AoG features not available in the
781
+ # specific message types.
782
+ # If using the Intent.Message.payload field, it should have a structure
783
+ # similar to the JSON message shown here. For more information, see
784
+ # [Actions on Google Webhook
785
+ # Format](https://developers.google.com/actions/dialogflow/webhook)
786
+ # <pre>{
787
+ # "expectUserResponse": true,
788
+ # "isSsml": false,
789
+ # "noInputPrompts": [],
790
+ # "richResponse": {
791
+ # "items": [
792
+ # {
793
+ # "simpleResponse": {
794
+ # "displayText": "hi",
795
+ # "textToSpeech": "hello"
796
+ # }
797
+ # }
798
+ # ],
799
+ # "suggestions": [
800
+ # {
801
+ # "title": "Say this"
802
+ # },
803
+ # {
804
+ # "title": "or this"
805
+ # }
806
+ # ]
807
+ # },
808
+ # "systemIntent": {
809
+ # "data": {
810
+ # "@type": "type.googleapis.com/google.actions.v2.OptionValueSpec",
811
+ # "listSelect": {
812
+ # "items": [
813
+ # {
814
+ # "optionInfo": {
815
+ # "key": "key1",
816
+ # "synonyms": [
817
+ # "key one"
818
+ # ]
819
+ # },
820
+ # "title": "must not be empty, but unique"
821
+ # },
822
+ # {
823
+ # "optionInfo": {
824
+ # "key": "key2",
825
+ # "synonyms": [
826
+ # "key two"
827
+ # ]
828
+ # },
829
+ # "title": "must not be empty, but unique"
830
+ # }
831
+ # ]
832
+ # }
833
+ # },
834
+ # "intent": "actions.intent.OPTION"
835
+ # }
836
+ # }</pre>
837
+ ACTIONS_ON_GOOGLE = 8
838
+
839
+ # Google Hangouts.
840
+ GOOGLE_HANGOUTS = 11
841
+ end
842
+ end
843
+
844
+ # Represents a single followup intent in the chain.
845
+ # @!attribute [rw] followup_intent_name
846
+ # @return [String]
847
+ # The unique identifier of the followup intent.
848
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
849
+ # @!attribute [rw] parent_followup_intent_name
850
+ # @return [String]
851
+ # The unique identifier of the followup intent's parent.
852
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
853
+ class FollowupIntentInfo
854
+ include Google::Protobuf::MessageExts
855
+ extend Google::Protobuf::MessageExts::ClassMethods
856
+ end
857
+
858
+ # Represents the different states that webhooks can be in.
859
+ module WebhookState
860
+ # Webhook is disabled in the agent and in the intent.
861
+ WEBHOOK_STATE_UNSPECIFIED = 0
862
+
863
+ # Webhook is enabled in the agent and in the intent.
864
+ WEBHOOK_STATE_ENABLED = 1
865
+
866
+ # Webhook is enabled in the agent and in the intent. Also, each slot
867
+ # filling prompt is forwarded to the webhook.
868
+ WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING = 2
869
+ end
870
+ end
871
+
872
+ # The request message for {Google::Cloud::Dialogflow::V2::Intents::Client#list_intents Intents.ListIntents}.
873
+ # @!attribute [rw] parent
874
+ # @return [String]
875
+ # Required. The agent to list all intents from.
876
+ # Format: `projects/<Project ID>/agent`.
877
+ # @!attribute [rw] language_code
878
+ # @return [String]
879
+ # Optional. The language to list training phrases, parameters and rich
880
+ # messages for. If not specified, the agent's default language is used.
881
+ # [Many
882
+ # languages](https://cloud.google.com/dialogflow/docs/reference/language)
883
+ # are supported. Note: languages must be enabled in the agent before they can
884
+ # be used.
885
+ # @!attribute [rw] intent_view
886
+ # @return [Google::Cloud::Dialogflow::V2::IntentView]
887
+ # Optional. The resource view to apply to the returned intent.
888
+ # @!attribute [rw] page_size
889
+ # @return [Integer]
890
+ # Optional. The maximum number of items to return in a single page. By
891
+ # default 100 and at most 1000.
892
+ # @!attribute [rw] page_token
893
+ # @return [String]
894
+ # Optional. The next_page_token value returned from a previous list request.
895
+ class ListIntentsRequest
896
+ include Google::Protobuf::MessageExts
897
+ extend Google::Protobuf::MessageExts::ClassMethods
898
+ end
899
+
900
+ # The response message for {Google::Cloud::Dialogflow::V2::Intents::Client#list_intents Intents.ListIntents}.
901
+ # @!attribute [rw] intents
902
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent>]
903
+ # The list of agent intents. There will be a maximum number of items
904
+ # returned based on the page_size field in the request.
905
+ # @!attribute [rw] next_page_token
906
+ # @return [String]
907
+ # Token to retrieve the next page of results, or empty if there are no
908
+ # more results in the list.
909
+ class ListIntentsResponse
910
+ include Google::Protobuf::MessageExts
911
+ extend Google::Protobuf::MessageExts::ClassMethods
912
+ end
913
+
914
+ # The request message for {Google::Cloud::Dialogflow::V2::Intents::Client#get_intent Intents.GetIntent}.
915
+ # @!attribute [rw] name
916
+ # @return [String]
917
+ # Required. The name of the intent.
918
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
919
+ # @!attribute [rw] language_code
920
+ # @return [String]
921
+ # Optional. The language to retrieve training phrases, parameters and rich
922
+ # messages for. If not specified, the agent's default language is used.
923
+ # [Many
924
+ # languages](https://cloud.google.com/dialogflow/docs/reference/language)
925
+ # are supported. Note: languages must be enabled in the agent before they can
926
+ # be used.
927
+ # @!attribute [rw] intent_view
928
+ # @return [Google::Cloud::Dialogflow::V2::IntentView]
929
+ # Optional. The resource view to apply to the returned intent.
930
+ class GetIntentRequest
931
+ include Google::Protobuf::MessageExts
932
+ extend Google::Protobuf::MessageExts::ClassMethods
933
+ end
934
+
935
+ # The request message for {Google::Cloud::Dialogflow::V2::Intents::Client#create_intent Intents.CreateIntent}.
936
+ # @!attribute [rw] parent
937
+ # @return [String]
938
+ # Required. The agent to create a intent for.
939
+ # Format: `projects/<Project ID>/agent`.
940
+ # @!attribute [rw] intent
941
+ # @return [Google::Cloud::Dialogflow::V2::Intent]
942
+ # Required. The intent to create.
943
+ # @!attribute [rw] language_code
944
+ # @return [String]
945
+ # Optional. The language of training phrases, parameters and rich messages
946
+ # defined in `intent`. If not specified, the agent's default language is
947
+ # used. [Many
948
+ # languages](https://cloud.google.com/dialogflow/docs/reference/language)
949
+ # are supported. Note: languages must be enabled in the agent before they can
950
+ # be used.
951
+ # @!attribute [rw] intent_view
952
+ # @return [Google::Cloud::Dialogflow::V2::IntentView]
953
+ # Optional. The resource view to apply to the returned intent.
954
+ class CreateIntentRequest
955
+ include Google::Protobuf::MessageExts
956
+ extend Google::Protobuf::MessageExts::ClassMethods
957
+ end
958
+
959
+ # The request message for {Google::Cloud::Dialogflow::V2::Intents::Client#update_intent Intents.UpdateIntent}.
960
+ # @!attribute [rw] intent
961
+ # @return [Google::Cloud::Dialogflow::V2::Intent]
962
+ # Required. The intent to update.
963
+ # @!attribute [rw] language_code
964
+ # @return [String]
965
+ # Optional. The language of training phrases, parameters and rich messages
966
+ # defined in `intent`. If not specified, the agent's default language is
967
+ # used. [Many
968
+ # languages](https://cloud.google.com/dialogflow/docs/reference/language)
969
+ # are supported. Note: languages must be enabled in the agent before they can
970
+ # be used.
971
+ # @!attribute [rw] update_mask
972
+ # @return [Google::Protobuf::FieldMask]
973
+ # Optional. The mask to control which fields get updated.
974
+ # @!attribute [rw] intent_view
975
+ # @return [Google::Cloud::Dialogflow::V2::IntentView]
976
+ # Optional. The resource view to apply to the returned intent.
977
+ class UpdateIntentRequest
978
+ include Google::Protobuf::MessageExts
979
+ extend Google::Protobuf::MessageExts::ClassMethods
980
+ end
981
+
982
+ # The request message for {Google::Cloud::Dialogflow::V2::Intents::Client#delete_intent Intents.DeleteIntent}.
983
+ # @!attribute [rw] name
984
+ # @return [String]
985
+ # Required. The name of the intent to delete. If this intent has direct or
986
+ # indirect followup intents, we also delete them.
987
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
988
+ class DeleteIntentRequest
989
+ include Google::Protobuf::MessageExts
990
+ extend Google::Protobuf::MessageExts::ClassMethods
991
+ end
992
+
993
+ # The request message for {Google::Cloud::Dialogflow::V2::Intents::Client#batch_update_intents Intents.BatchUpdateIntents}.
994
+ # @!attribute [rw] parent
995
+ # @return [String]
996
+ # Required. The name of the agent to update or create intents in.
997
+ # Format: `projects/<Project ID>/agent`.
998
+ # @!attribute [rw] intent_batch_uri
999
+ # @return [String]
1000
+ # The URI to a Google Cloud Storage file containing intents to update or
1001
+ # create. The file format can either be a serialized proto (of IntentBatch
1002
+ # type) or JSON object. Note: The URI must start with "gs://".
1003
+ # @!attribute [rw] intent_batch_inline
1004
+ # @return [Google::Cloud::Dialogflow::V2::IntentBatch]
1005
+ # The collection of intents to update or create.
1006
+ # @!attribute [rw] language_code
1007
+ # @return [String]
1008
+ # Optional. The language of training phrases, parameters and rich messages
1009
+ # defined in `intents`. If not specified, the agent's default language is
1010
+ # used. [Many
1011
+ # languages](https://cloud.google.com/dialogflow/docs/reference/language)
1012
+ # are supported. Note: languages must be enabled in the agent before they can
1013
+ # be used.
1014
+ # @!attribute [rw] update_mask
1015
+ # @return [Google::Protobuf::FieldMask]
1016
+ # Optional. The mask to control which fields get updated.
1017
+ # @!attribute [rw] intent_view
1018
+ # @return [Google::Cloud::Dialogflow::V2::IntentView]
1019
+ # Optional. The resource view to apply to the returned intent.
1020
+ class BatchUpdateIntentsRequest
1021
+ include Google::Protobuf::MessageExts
1022
+ extend Google::Protobuf::MessageExts::ClassMethods
1023
+ end
1024
+
1025
+ # The response message for {Google::Cloud::Dialogflow::V2::Intents::Client#batch_update_intents Intents.BatchUpdateIntents}.
1026
+ # @!attribute [rw] intents
1027
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent>]
1028
+ # The collection of updated or created intents.
1029
+ class BatchUpdateIntentsResponse
1030
+ include Google::Protobuf::MessageExts
1031
+ extend Google::Protobuf::MessageExts::ClassMethods
1032
+ end
1033
+
1034
+ # The request message for {Google::Cloud::Dialogflow::V2::Intents::Client#batch_delete_intents Intents.BatchDeleteIntents}.
1035
+ # @!attribute [rw] parent
1036
+ # @return [String]
1037
+ # Required. The name of the agent to delete all entities types for. Format:
1038
+ # `projects/<Project ID>/agent`.
1039
+ # @!attribute [rw] intents
1040
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent>]
1041
+ # Required. The collection of intents to delete. Only intent `name` must be
1042
+ # filled in.
1043
+ class BatchDeleteIntentsRequest
1044
+ include Google::Protobuf::MessageExts
1045
+ extend Google::Protobuf::MessageExts::ClassMethods
1046
+ end
1047
+
1048
+ # This message is a wrapper around a collection of intents.
1049
+ # @!attribute [rw] intents
1050
+ # @return [Array<Google::Cloud::Dialogflow::V2::Intent>]
1051
+ # A collection of intents.
1052
+ class IntentBatch
1053
+ include Google::Protobuf::MessageExts
1054
+ extend Google::Protobuf::MessageExts::ClassMethods
1055
+ end
1056
+
1057
+ # Represents the options for views of an intent.
1058
+ # An intent can be a sizable object. Therefore, we provide a resource view that
1059
+ # does not return training phrases in the response by default.
1060
+ module IntentView
1061
+ # Training phrases field is not populated in the response.
1062
+ INTENT_VIEW_UNSPECIFIED = 0
1063
+
1064
+ # All fields are populated.
1065
+ INTENT_VIEW_FULL = 1
1066
+ end
1067
+ end
1068
+ end
1069
+ end
1070
+ end