google-cloud-dialogflow-cx-v3 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (134) 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 +139 -0
  6. data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +32 -0
  7. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +122 -0
  8. data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +82 -0
  9. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +1051 -0
  10. data/lib/google/cloud/dialogflow/cx/v3/agents/credentials.rb +54 -0
  11. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +666 -0
  12. data/lib/google/cloud/dialogflow/cx/v3/agents/paths.rb +151 -0
  13. data/lib/google/cloud/dialogflow/cx/v3/agents.rb +52 -0
  14. data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +94 -0
  15. data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +92 -0
  16. data/lib/google/cloud/dialogflow/cx/v3/entity_type_services_pb.rb +67 -0
  17. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +766 -0
  18. data/lib/google/cloud/dialogflow/cx/v3/entity_types/credentials.rb +54 -0
  19. data/lib/google/cloud/dialogflow/cx/v3/entity_types/paths.rb +75 -0
  20. data/lib/google/cloud/dialogflow/cx/v3/entity_types.rb +51 -0
  21. data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +117 -0
  22. data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +61 -0
  23. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +950 -0
  24. data/lib/google/cloud/dialogflow/cx/v3/environments/credentials.rb +54 -0
  25. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +666 -0
  26. data/lib/google/cloud/dialogflow/cx/v3/environments/paths.rb +98 -0
  27. data/lib/google/cloud/dialogflow/cx/v3/environments.rb +52 -0
  28. data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +177 -0
  29. data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +61 -0
  30. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +851 -0
  31. data/lib/google/cloud/dialogflow/cx/v3/experiments/credentials.rb +54 -0
  32. data/lib/google/cloud/dialogflow/cx/v3/experiments/paths.rb +102 -0
  33. data/lib/google/cloud/dialogflow/cx/v3/experiments.rb +51 -0
  34. data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +145 -0
  35. data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +88 -0
  36. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +1200 -0
  37. data/lib/google/cloud/dialogflow/cx/v3/flows/credentials.rb +54 -0
  38. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +666 -0
  39. data/lib/google/cloud/dialogflow/cx/v3/flows/paths.rb +184 -0
  40. data/lib/google/cloud/dialogflow/cx/v3/flows.rb +52 -0
  41. data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +55 -0
  42. data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +97 -0
  43. data/lib/google/cloud/dialogflow/cx/v3/intent_services_pb.rb +67 -0
  44. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +750 -0
  45. data/lib/google/cloud/dialogflow/cx/v3/intents/credentials.rb +54 -0
  46. data/lib/google/cloud/dialogflow/cx/v3/intents/paths.rb +96 -0
  47. data/lib/google/cloud/dialogflow/cx/v3/intents.rb +51 -0
  48. data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +113 -0
  49. data/lib/google/cloud/dialogflow/cx/v3/page_services_pb.rb +67 -0
  50. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +805 -0
  51. data/lib/google/cloud/dialogflow/cx/v3/pages/credentials.rb +54 -0
  52. data/lib/google/cloud/dialogflow/cx/v3/pages/paths.rb +165 -0
  53. data/lib/google/cloud/dialogflow/cx/v3/pages.rb +51 -0
  54. data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +77 -0
  55. data/lib/google/cloud/dialogflow/cx/v3/security_settings_pb.rb +89 -0
  56. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +696 -0
  57. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/credentials.rb +54 -0
  58. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/paths.rb +157 -0
  59. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb +51 -0
  60. data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +56 -0
  61. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_pb.rb +68 -0
  62. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +55 -0
  63. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +715 -0
  64. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/credentials.rb +54 -0
  65. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/paths.rb +137 -0
  66. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types.rb +51 -0
  67. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +209 -0
  68. data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +71 -0
  69. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +654 -0
  70. data/lib/google/cloud/dialogflow/cx/v3/sessions/credentials.rb +54 -0
  71. data/lib/google/cloud/dialogflow/cx/v3/sessions/paths.rb +225 -0
  72. data/lib/google/cloud/dialogflow/cx/v3/sessions.rb +53 -0
  73. data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +302 -0
  74. data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +73 -0
  75. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +1324 -0
  76. data/lib/google/cloud/dialogflow/cx/v3/test_cases/credentials.rb +54 -0
  77. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +666 -0
  78. data/lib/google/cloud/dialogflow/cx/v3/test_cases/paths.rb +249 -0
  79. data/lib/google/cloud/dialogflow/cx/v3/test_cases.rb +53 -0
  80. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +67 -0
  81. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +67 -0
  82. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +766 -0
  83. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/credentials.rb +54 -0
  84. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/paths.rb +144 -0
  85. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups.rb +51 -0
  86. data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +59 -0
  87. data/lib/google/cloud/dialogflow/cx/v3/version.rb +30 -0
  88. data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +88 -0
  89. data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +57 -0
  90. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +792 -0
  91. data/lib/google/cloud/dialogflow/cx/v3/versions/credentials.rb +54 -0
  92. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +666 -0
  93. data/lib/google/cloud/dialogflow/cx/v3/versions/paths.rb +79 -0
  94. data/lib/google/cloud/dialogflow/cx/v3/versions.rb +52 -0
  95. data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +172 -0
  96. data/lib/google/cloud/dialogflow/cx/v3/webhook_services_pb.rb +55 -0
  97. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +704 -0
  98. data/lib/google/cloud/dialogflow/cx/v3/webhooks/credentials.rb +54 -0
  99. data/lib/google/cloud/dialogflow/cx/v3/webhooks/paths.rb +96 -0
  100. data/lib/google/cloud/dialogflow/cx/v3/webhooks.rb +51 -0
  101. data/lib/google/cloud/dialogflow/cx/v3.rb +53 -0
  102. data/lib/google-cloud-dialogflow-cx-v3.rb +21 -0
  103. data/proto_docs/README.md +4 -0
  104. data/proto_docs/google/api/field_behavior.rb +71 -0
  105. data/proto_docs/google/api/resource.rb +283 -0
  106. data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb +57 -0
  107. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +301 -0
  108. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +322 -0
  109. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +306 -0
  110. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +279 -0
  111. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +438 -0
  112. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +438 -0
  113. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +126 -0
  114. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +318 -0
  115. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +478 -0
  116. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +220 -0
  117. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +222 -0
  118. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +798 -0
  119. data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +184 -0
  120. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +757 -0
  121. data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +195 -0
  122. data/proto_docs/google/cloud/dialogflow/cx/v3/validation_message.rb +121 -0
  123. data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +182 -0
  124. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +496 -0
  125. data/proto_docs/google/longrunning/operations.rb +164 -0
  126. data/proto_docs/google/protobuf/any.rb +141 -0
  127. data/proto_docs/google/protobuf/duration.rb +98 -0
  128. data/proto_docs/google/protobuf/empty.rb +36 -0
  129. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  130. data/proto_docs/google/protobuf/struct.rb +96 -0
  131. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  132. data/proto_docs/google/rpc/status.rb +46 -0
  133. data/proto_docs/google/type/latlng.rb +38 -0
  134. metadata +326 -0
@@ -0,0 +1,496 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 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 CX
24
+ module V3
25
+ # Webhooks host the developer's business logic. During a session, webhooks
26
+ # allow the developer to use the data extracted by Dialogflow's natural
27
+ # language processing to generate dynamic responses, validate collected data,
28
+ # or trigger actions on the backend.
29
+ # @!attribute [rw] name
30
+ # @return [::String]
31
+ # The unique identifier of the webhook.
32
+ # Required for the {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#update_webhook Webhooks.UpdateWebhook} method.
33
+ # {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#create_webhook Webhooks.CreateWebhook} populates the name automatically.
34
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
35
+ # ID>/webhooks/<Webhook ID>`.
36
+ # @!attribute [rw] display_name
37
+ # @return [::String]
38
+ # Required. The human-readable name of the webhook, unique within the agent.
39
+ # @!attribute [rw] generic_web_service
40
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
41
+ # Configuration for a generic web service.
42
+ # @!attribute [rw] service_directory
43
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig]
44
+ # Configuration for a [Service
45
+ # Directory](https://cloud.google.com/service-directory) service.
46
+ # @!attribute [rw] timeout
47
+ # @return [::Google::Protobuf::Duration]
48
+ # Webhook execution timeout. Execution is considered failed if Dialogflow
49
+ # doesn't receive a response from webhook at the end of the timeout period.
50
+ # Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
51
+ # @!attribute [rw] disabled
52
+ # @return [::Boolean]
53
+ # Indicates whether the webhook is disabled.
54
+ class Webhook
55
+ include ::Google::Protobuf::MessageExts
56
+ extend ::Google::Protobuf::MessageExts::ClassMethods
57
+
58
+ # Represents configuration for a generic web service.
59
+ # @!attribute [rw] uri
60
+ # @return [::String]
61
+ # Required. The webhook URI for receiving POST requests. It must use https protocol.
62
+ # @!attribute [rw] username
63
+ # @return [::String]
64
+ # The user name for HTTP Basic authentication.
65
+ # @!attribute [rw] password
66
+ # @return [::String]
67
+ # The password for HTTP Basic authentication.
68
+ # @!attribute [rw] request_headers
69
+ # @return [::Google::Protobuf::Map{::String => ::String}]
70
+ # The HTTP request headers to send together with webhook
71
+ # requests.
72
+ class GenericWebService
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+
76
+ # @!attribute [rw] key
77
+ # @return [::String]
78
+ # @!attribute [rw] value
79
+ # @return [::String]
80
+ class RequestHeadersEntry
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+ end
85
+
86
+ # Represents configuration for a [Service
87
+ # Directory](https://cloud.google.com/service-directory) service.
88
+ # @!attribute [rw] service
89
+ # @return [::String]
90
+ # Required. The name of [Service
91
+ # Directory](https://cloud.google.com/service-directory) service.
92
+ # Format: `projects/<Project ID>/locations/<Location
93
+ # ID>/namespaces/<Namespace ID>/services/<Service ID>`.
94
+ # `Location ID` of the service directory must be the same as the location
95
+ # of the agent.
96
+ # @!attribute [rw] generic_web_service
97
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
98
+ # Generic Service configuration of this webhook.
99
+ class ServiceDirectoryConfig
100
+ include ::Google::Protobuf::MessageExts
101
+ extend ::Google::Protobuf::MessageExts::ClassMethods
102
+ end
103
+ end
104
+
105
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#list_webhooks Webhooks.ListWebhooks}.
106
+ # @!attribute [rw] parent
107
+ # @return [::String]
108
+ # Required. The agent to list all webhooks for.
109
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
110
+ # @!attribute [rw] page_size
111
+ # @return [::Integer]
112
+ # The maximum number of items to return in a single page. By default 100 and
113
+ # at most 1000.
114
+ # @!attribute [rw] page_token
115
+ # @return [::String]
116
+ # The next_page_token value returned from a previous list request.
117
+ class ListWebhooksRequest
118
+ include ::Google::Protobuf::MessageExts
119
+ extend ::Google::Protobuf::MessageExts::ClassMethods
120
+ end
121
+
122
+ # The response message for {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#list_webhooks Webhooks.ListWebhooks}.
123
+ # @!attribute [rw] webhooks
124
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
125
+ # The list of webhooks. There will be a maximum number of items returned
126
+ # based on the page_size field in the request.
127
+ # @!attribute [rw] next_page_token
128
+ # @return [::String]
129
+ # Token to retrieve the next page of results, or empty if there are no more
130
+ # results in the list.
131
+ class ListWebhooksResponse
132
+ include ::Google::Protobuf::MessageExts
133
+ extend ::Google::Protobuf::MessageExts::ClassMethods
134
+ end
135
+
136
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#get_webhook Webhooks.GetWebhook}.
137
+ # @!attribute [rw] name
138
+ # @return [::String]
139
+ # Required. The name of the webhook.
140
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
141
+ # ID>/webhooks/<Webhook ID>`.
142
+ class GetWebhookRequest
143
+ include ::Google::Protobuf::MessageExts
144
+ extend ::Google::Protobuf::MessageExts::ClassMethods
145
+ end
146
+
147
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#create_webhook Webhooks.CreateWebhook}.
148
+ # @!attribute [rw] parent
149
+ # @return [::String]
150
+ # Required. The agent to create a webhook for.
151
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
152
+ # @!attribute [rw] webhook
153
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook]
154
+ # Required. The webhook to create.
155
+ class CreateWebhookRequest
156
+ include ::Google::Protobuf::MessageExts
157
+ extend ::Google::Protobuf::MessageExts::ClassMethods
158
+ end
159
+
160
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#update_webhook Webhooks.UpdateWebhook}.
161
+ # @!attribute [rw] webhook
162
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook]
163
+ # Required. The webhook to update.
164
+ # @!attribute [rw] update_mask
165
+ # @return [::Google::Protobuf::FieldMask]
166
+ # The mask to control which fields get updated. If the mask is not present,
167
+ # all fields will be updated.
168
+ class UpdateWebhookRequest
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
172
+
173
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#delete_webhook Webhooks.DeleteWebhook}.
174
+ # @!attribute [rw] name
175
+ # @return [::String]
176
+ # Required. The name of the webhook to delete.
177
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
178
+ # ID>/webhooks/<Webhook ID>`.
179
+ # @!attribute [rw] force
180
+ # @return [::Boolean]
181
+ # This field has no effect for webhook not being used.
182
+ # For webhooks that are used by pages/flows/transition route groups:
183
+ #
184
+ # * If `force` is set to false, an error will be returned with message
185
+ # indicating the referenced resources.
186
+ # * If `force` is set to true, Dialogflow will remove the webhook, as well
187
+ # as any references to the webhook (i.e. {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#webhook Webhook}
188
+ # and {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag tag}in fulfillments that point to this webhook
189
+ # will be removed).
190
+ class DeleteWebhookRequest
191
+ include ::Google::Protobuf::MessageExts
192
+ extend ::Google::Protobuf::MessageExts::ClassMethods
193
+ end
194
+
195
+ # The request message for a webhook call. The request is sent as a JSON object
196
+ # and the field names will be presented in camel cases.
197
+ # @!attribute [rw] detect_intent_response_id
198
+ # @return [::String]
199
+ # Always present. The unique identifier of the {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse DetectIntentResponse} that
200
+ # will be returned to the API caller.
201
+ # @!attribute [rw] text
202
+ # @return [::String]
203
+ # If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was provided as input, this field
204
+ # will contain a copy of the text.
205
+ # @!attribute [rw] trigger_intent
206
+ # @return [::String]
207
+ # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as input, this field will
208
+ # contain a copy of the intent identifier.
209
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
210
+ # ID>/intents/<Intent ID>`.
211
+ # @!attribute [rw] transcript
212
+ # @return [::String]
213
+ # If {::Google::Cloud::Dialogflow::CX::V3::AudioInput natural language speech audio} was provided as input,
214
+ # this field will contain the transcript for the audio.
215
+ # @!attribute [rw] trigger_event
216
+ # @return [::String]
217
+ # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as input, this field will contain
218
+ # the name of the event.
219
+ # @!attribute [rw] language_code
220
+ # @return [::String]
221
+ # The language code specified in the [original
222
+ # request][QueryInput.language_code].
223
+ # @!attribute [rw] fulfillment_info
224
+ # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo]
225
+ # Always present. Information about the fulfillment that triggered this
226
+ # webhook call.
227
+ # @!attribute [rw] intent_info
228
+ # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo]
229
+ # Information about the last matched intent.
230
+ # @!attribute [rw] page_info
231
+ # @return [::Google::Cloud::Dialogflow::CX::V3::PageInfo]
232
+ # Information about page status.
233
+ # @!attribute [rw] session_info
234
+ # @return [::Google::Cloud::Dialogflow::CX::V3::SessionInfo]
235
+ # Information about session status.
236
+ # @!attribute [rw] messages
237
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
238
+ # The list of rich message responses to present to the user. Webhook can
239
+ # choose to append or replace this list in
240
+ # {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse#fulfillment_response WebhookResponse.fulfillment_response};
241
+ # @!attribute [rw] payload
242
+ # @return [::Google::Protobuf::Struct]
243
+ # Custom data set in {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#payload QueryParameters.payload}.
244
+ # @!attribute [rw] sentiment_analysis_result
245
+ # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult]
246
+ # The sentiment analysis result of the current user request. The field is
247
+ # filled when sentiment analysis is configured to be enabled for the request.
248
+ class WebhookRequest
249
+ include ::Google::Protobuf::MessageExts
250
+ extend ::Google::Protobuf::MessageExts::ClassMethods
251
+
252
+ # Represents fulfillment information communicated to the webhook.
253
+ # @!attribute [rw] tag
254
+ # @return [::String]
255
+ # Always present. The tag used to identify which fulfillment is being
256
+ # called.
257
+ class FulfillmentInfo
258
+ include ::Google::Protobuf::MessageExts
259
+ extend ::Google::Protobuf::MessageExts::ClassMethods
260
+ end
261
+
262
+ # Represents intent information communicated to the webhook.
263
+ # @!attribute [rw] last_matched_intent
264
+ # @return [::String]
265
+ # Always present. The unique identifier of the last matched
266
+ # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}.
267
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
268
+ # ID>/intents/<Intent ID>`.
269
+ # @!attribute [rw] display_name
270
+ # @return [::String]
271
+ # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}.
272
+ # @!attribute [rw] parameters
273
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}]
274
+ # Parameters identified as a result of intent matching. This is a map of
275
+ # the name of the identified parameter to the value of the parameter
276
+ # identified from the user's utterance. All parameters defined in the
277
+ # matched intent that are identified will be surfaced here.
278
+ # @!attribute [rw] confidence
279
+ # @return [::Float]
280
+ # The confidence of the matched intent. Values range from 0.0 (completely
281
+ # uncertain) to 1.0 (completely certain).
282
+ class IntentInfo
283
+ include ::Google::Protobuf::MessageExts
284
+ extend ::Google::Protobuf::MessageExts::ClassMethods
285
+
286
+ # Represents a value for an intent parameter.
287
+ # @!attribute [rw] original_value
288
+ # @return [::String]
289
+ # Always present. Original text value extracted from user utterance.
290
+ # @!attribute [rw] resolved_value
291
+ # @return [::Google::Protobuf::Value]
292
+ # Always present. Structured value for the parameter extracted from user
293
+ # utterance.
294
+ class IntentParameterValue
295
+ include ::Google::Protobuf::MessageExts
296
+ extend ::Google::Protobuf::MessageExts::ClassMethods
297
+ end
298
+
299
+ # @!attribute [rw] key
300
+ # @return [::String]
301
+ # @!attribute [rw] value
302
+ # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue]
303
+ class ParametersEntry
304
+ include ::Google::Protobuf::MessageExts
305
+ extend ::Google::Protobuf::MessageExts::ClassMethods
306
+ end
307
+ end
308
+
309
+ # Represents the result of sentiment analysis.
310
+ # @!attribute [rw] score
311
+ # @return [::Float]
312
+ # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
313
+ # sentiment).
314
+ # @!attribute [rw] magnitude
315
+ # @return [::Float]
316
+ # A non-negative number in the [0, +inf) range, which represents the
317
+ # absolute magnitude of sentiment, regardless of score (positive or
318
+ # negative).
319
+ class SentimentAnalysisResult
320
+ include ::Google::Protobuf::MessageExts
321
+ extend ::Google::Protobuf::MessageExts::ClassMethods
322
+ end
323
+ end
324
+
325
+ # The response message for a webhook call.
326
+ # @!attribute [rw] fulfillment_response
327
+ # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse]
328
+ # The fulfillment response to send to the user. This field can be omitted by
329
+ # the webhook if it does not intend to send any response to the user.
330
+ # @!attribute [rw] page_info
331
+ # @return [::Google::Cloud::Dialogflow::CX::V3::PageInfo]
332
+ # Information about page status. This field can be omitted by the webhook if
333
+ # it does not intend to modify page status.
334
+ # @!attribute [rw] session_info
335
+ # @return [::Google::Cloud::Dialogflow::CX::V3::SessionInfo]
336
+ # Information about session status. This field can be omitted by the webhook
337
+ # if it does not intend to modify session status.
338
+ # @!attribute [rw] payload
339
+ # @return [::Google::Protobuf::Struct]
340
+ # Value to append directly to {::Google::Cloud::Dialogflow::CX::V3::QueryResult#webhook_payloads QueryResult.webhook_payloads}.
341
+ # @!attribute [rw] target_page
342
+ # @return [::String]
343
+ # The target page to transition to.
344
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
345
+ # ID>/flows/<Flow ID>/pages/<Page ID>`.
346
+ # @!attribute [rw] target_flow
347
+ # @return [::String]
348
+ # The target flow to transition to.
349
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
350
+ # ID>/flows/<Flow ID>`.
351
+ class WebhookResponse
352
+ include ::Google::Protobuf::MessageExts
353
+ extend ::Google::Protobuf::MessageExts::ClassMethods
354
+
355
+ # Represents a fulfillment response to the user.
356
+ # @!attribute [rw] messages
357
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
358
+ # The list of rich message responses to present to the user.
359
+ # @!attribute [rw] merge_behavior
360
+ # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse::MergeBehavior]
361
+ # Merge behavior for `messages`.
362
+ class FulfillmentResponse
363
+ include ::Google::Protobuf::MessageExts
364
+ extend ::Google::Protobuf::MessageExts::ClassMethods
365
+
366
+ # Defines merge behavior for `messages`.
367
+ module MergeBehavior
368
+ # Not specified. `APPEND` will be used.
369
+ MERGE_BEHAVIOR_UNSPECIFIED = 0
370
+
371
+ # `messages` will be appended to the list of messages waiting to be sent
372
+ # to the user.
373
+ APPEND = 1
374
+
375
+ # `messages` will replace the list of messages waiting to be sent to the
376
+ # user.
377
+ REPLACE = 2
378
+ end
379
+ end
380
+ end
381
+
382
+ # Represents page information communicated to and from the webhook.
383
+ # @!attribute [rw] current_page
384
+ # @return [::String]
385
+ # Always present for {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Ignored for {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
386
+ # The unique identifier of the current page.
387
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
388
+ # ID>/flows/<Flow ID>/pages/<Page ID>`.
389
+ # @!attribute [rw] form_info
390
+ # @return [::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo]
391
+ # Optional for both {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
392
+ # Information about the form.
393
+ class PageInfo
394
+ include ::Google::Protobuf::MessageExts
395
+ extend ::Google::Protobuf::MessageExts::ClassMethods
396
+
397
+ # Represents form information.
398
+ # @!attribute [rw] parameter_info
399
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo>]
400
+ # Optional for both {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
401
+ # The parameters contained in the form. Note that the webhook cannot add
402
+ # or remove any form parameter.
403
+ class FormInfo
404
+ include ::Google::Protobuf::MessageExts
405
+ extend ::Google::Protobuf::MessageExts::ClassMethods
406
+
407
+ # Represents parameter information.
408
+ # @!attribute [rw] display_name
409
+ # @return [::String]
410
+ # Always present for {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Required for
411
+ # {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
412
+ # The human-readable name of the parameter, unique within the form. This
413
+ # field cannot be modified by the webhook.
414
+ # @!attribute [rw] required
415
+ # @return [::Boolean]
416
+ # Optional for both {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
417
+ # Indicates whether the parameter is required. Optional parameters will
418
+ # not trigger prompts; however, they are filled if the user specifies
419
+ # them. Required parameters must be filled before form filling concludes.
420
+ # @!attribute [rw] state
421
+ # @return [::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState]
422
+ # Always present for {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Required for
423
+ # {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The state of the parameter. This field can be set
424
+ # to {::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState::INVALID INVALID} by
425
+ # the webhook to invalidate the parameter; other values set by the
426
+ # webhook will be ignored.
427
+ # @!attribute [rw] value
428
+ # @return [::Google::Protobuf::Value]
429
+ # Optional for both {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
430
+ # The value of the parameter. This field can be set by the webhook to
431
+ # change the parameter value.
432
+ # @!attribute [rw] just_collected
433
+ # @return [::Boolean]
434
+ # Optional for {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Ignored for {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
435
+ # Indicates if the parameter value was just collected on the last
436
+ # conversation turn.
437
+ class ParameterInfo
438
+ include ::Google::Protobuf::MessageExts
439
+ extend ::Google::Protobuf::MessageExts::ClassMethods
440
+
441
+ # Represents the state of a parameter.
442
+ module ParameterState
443
+ # Not specified. This value should be never used.
444
+ PARAMETER_STATE_UNSPECIFIED = 0
445
+
446
+ # Indicates that the parameter does not have a value.
447
+ EMPTY = 1
448
+
449
+ # Indicates that the parameter value is invalid. This field can be used
450
+ # by the webhook to invalidate the parameter and ask the server to
451
+ # collect it from the user again.
452
+ INVALID = 2
453
+
454
+ # Indicates that the parameter has a value.
455
+ FILLED = 3
456
+ end
457
+ end
458
+ end
459
+ end
460
+
461
+ # Represents session information communicated to and from the webhook.
462
+ # @!attribute [rw] session
463
+ # @return [::String]
464
+ # Always present for {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Ignored for {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
465
+ # The unique identifier of the {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#session session}. This
466
+ # field can be used by the webhook to identify a session.
467
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
468
+ # ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
469
+ # ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`
470
+ # if environment is specified.
471
+ # @!attribute [rw] parameters
472
+ # @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
473
+ # Optional for {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Optional for {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
474
+ # All parameters collected from forms and intents during the session.
475
+ # Parameters can be created, updated, or removed by the webhook. To remove a
476
+ # parameter from the session, the webhook should explicitly set the parameter
477
+ # value to null in {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The map is keyed by parameters'
478
+ # display names.
479
+ class SessionInfo
480
+ include ::Google::Protobuf::MessageExts
481
+ extend ::Google::Protobuf::MessageExts::ClassMethods
482
+
483
+ # @!attribute [rw] key
484
+ # @return [::String]
485
+ # @!attribute [rw] value
486
+ # @return [::Google::Protobuf::Value]
487
+ class ParametersEntry
488
+ include ::Google::Protobuf::MessageExts
489
+ extend ::Google::Protobuf::MessageExts::ClassMethods
490
+ end
491
+ end
492
+ end
493
+ end
494
+ end
495
+ end
496
+ end