google-cloud-dialogflow-cx-v3 1.3.0 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +13 -0
  4. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +7 -0
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +13 -0
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +7 -0
  7. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +7 -0
  8. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +7 -0
  9. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +7 -0
  10. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +7 -0
  11. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +15 -0
  12. data/lib/google/cloud/dialogflow/cx/v3/entity_types/operations.rb +7 -0
  13. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +15 -0
  14. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/operations.rb +7 -0
  15. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +7 -0
  16. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +7 -0
  17. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +7 -0
  18. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +7 -0
  19. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +7 -0
  20. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +7 -0
  21. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +11 -0
  22. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +7 -0
  23. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +11 -0
  24. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +7 -0
  25. data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +7 -0
  26. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +7 -0
  27. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +15 -0
  28. data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +7 -0
  29. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +15 -0
  30. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +7 -0
  31. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +7 -0
  32. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +7 -0
  33. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +7 -0
  34. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +7 -0
  35. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +7 -0
  36. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +7 -0
  37. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +7 -0
  38. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +7 -0
  39. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +11 -0
  40. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +7 -0
  41. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +11 -0
  42. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +7 -0
  43. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +7 -0
  44. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +7 -0
  45. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  46. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +7 -0
  47. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +7 -0
  48. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +7 -0
  49. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +7 -0
  50. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +7 -0
  51. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +7 -0
  52. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +12 -0
  53. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +12 -0
  54. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +4 -0
  55. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +8 -0
  56. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +4 -0
  57. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +12 -0
  58. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +12 -0
  59. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +28 -0
  60. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +4 -0
  61. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +32 -0
  62. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +22 -0
  63. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +18 -0
  64. data/proto_docs/google/longrunning/operations.rb +4 -0
  65. data/proto_docs/google/protobuf/struct.rb +12 -0
  66. metadata +6 -9
@@ -42,19 +42,29 @@ module Google
42
42
  # @!attribute [rw] text
43
43
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text]
44
44
  # Returns a text response.
45
+ #
46
+ # Note: The following fields are mutually exclusive: `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
45
47
  # @!attribute [rw] payload
46
48
  # @return [::Google::Protobuf::Struct]
47
49
  # Returns a response containing a custom, platform-specific payload.
50
+ #
51
+ # Note: The following fields are mutually exclusive: `payload`, `text`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
48
52
  # @!attribute [rw] conversation_success
49
53
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess]
50
54
  # Indicates that the conversation succeeded.
55
+ #
56
+ # Note: The following fields are mutually exclusive: `conversation_success`, `text`, `payload`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
51
57
  # @!attribute [rw] output_audio_text
52
58
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText]
53
59
  # A text or ssml response that is preferentially used for TTS output audio
54
60
  # synthesis, as described in the comment on the ResponseMessage message.
61
+ #
62
+ # Note: The following fields are mutually exclusive: `output_audio_text`, `text`, `payload`, `conversation_success`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
55
63
  # @!attribute [rw] live_agent_handoff
56
64
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff]
57
65
  # Hands off conversation to a human agent.
66
+ #
67
+ # Note: The following fields are mutually exclusive: `live_agent_handoff`, `text`, `payload`, `conversation_success`, `output_audio_text`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
58
68
  # @!attribute [r] end_interaction
59
69
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::EndInteraction]
60
70
  # Output only. A signal that indicates the interaction with the Dialogflow
@@ -63,6 +73,8 @@ module Google
63
73
  # by the user.
64
74
  #
65
75
  # It's guaranteed that there is at most one such message in each response.
76
+ #
77
+ # Note: The following fields are mutually exclusive: `end_interaction`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `play_audio`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
66
78
  # @!attribute [rw] play_audio
67
79
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio]
68
80
  # Signal that the client should play an audio clip hosted at a
@@ -70,6 +82,8 @@ module Google
70
82
  # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#mixed_audio mixed_audio}.
71
83
  # However, Dialogflow itself does not try to read or process the URI in any
72
84
  # way.
85
+ #
86
+ # Note: The following fields are mutually exclusive: `play_audio`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `mixed_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
73
87
  # @!attribute [r] mixed_audio
74
88
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::MixedAudio]
75
89
  # Output only. An audio response message composed of both the synthesized
@@ -77,14 +91,20 @@ module Google
77
91
  # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#play_audio play_audio}.
78
92
  # This message is generated by Dialogflow only and not supposed to be
79
93
  # defined by the user.
94
+ #
95
+ # Note: The following fields are mutually exclusive: `mixed_audio`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `telephony_transfer_call`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
80
96
  # @!attribute [rw] telephony_transfer_call
81
97
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::TelephonyTransferCall]
82
98
  # A signal that the client should transfer the phone call connected to
83
99
  # this agent to a third-party endpoint.
100
+ #
101
+ # Note: The following fields are mutually exclusive: `telephony_transfer_call`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `knowledge_info_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
84
102
  # @!attribute [rw] knowledge_info_card
85
103
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::KnowledgeInfoCard]
86
104
  # Represents info card for knowledge answers, to be better rendered in
87
105
  # Dialogflow Messenger.
106
+ #
107
+ # Note: The following fields are mutually exclusive: `knowledge_info_card`, `text`, `payload`, `conversation_success`, `output_audio_text`, `live_agent_handoff`, `end_interaction`, `play_audio`, `mixed_audio`, `telephony_transfer_call`. If a field in that set is populated, all other fields in the set will automatically be cleared.
88
108
  # @!attribute [rw] response_type
89
109
  # @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ResponseType]
90
110
  # Response type.
@@ -165,10 +185,14 @@ module Google
165
185
  # @!attribute [rw] text
166
186
  # @return [::String]
167
187
  # The raw text to be synthesized.
188
+ #
189
+ # Note: The following fields are mutually exclusive: `text`, `ssml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
168
190
  # @!attribute [rw] ssml
169
191
  # @return [::String]
170
192
  # The SSML text to be synthesized. For more information, see
171
193
  # [SSML](/speech/text-to-speech/docs/ssml).
194
+ #
195
+ # Note: The following fields are mutually exclusive: `ssml`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
172
196
  # @!attribute [r] allow_playback_interruption
173
197
  # @return [::Boolean]
174
198
  # Output only. Whether the playback of this message can be interrupted by
@@ -221,10 +245,14 @@ module Google
221
245
  # @return [::String]
222
246
  # Raw audio synthesized from the Dialogflow agent's response using
223
247
  # the output config specified in the request.
248
+ #
249
+ # Note: The following fields are mutually exclusive: `audio`, `uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
224
250
  # @!attribute [rw] uri
225
251
  # @return [::String]
226
252
  # Client-specific URI that points to an audio clip accessible to the
227
253
  # client. Dialogflow does not impose any validation on it.
254
+ #
255
+ # Note: The following fields are mutually exclusive: `uri`, `audio`. If a field in that set is populated, all other fields in the set will automatically be cleared.
228
256
  # @!attribute [r] allow_playback_interruption
229
257
  # @return [::Boolean]
230
258
  # Output only. Whether the playback of this segment can be interrupted by
@@ -177,10 +177,14 @@ module Google
177
177
  # When data retention configuration is changed, it only applies to the data
178
178
  # created after the change; the TTL of existing data created before the
179
179
  # change stays intact.
180
+ #
181
+ # Note: The following fields are mutually exclusive: `retention_window_days`, `retention_strategy`. If a field in that set is populated, all other fields in the set will automatically be cleared.
180
182
  # @!attribute [rw] retention_strategy
181
183
  # @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy]
182
184
  # Specifies the retention behavior defined by
183
185
  # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy SecuritySettings.RetentionStrategy}.
186
+ #
187
+ # Note: The following fields are mutually exclusive: `retention_strategy`, `retention_window_days`. If a field in that set is populated, all other fields in the set will automatically be cleared.
184
188
  # @!attribute [rw] purge_data_types
185
189
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>]
186
190
  # List of types of data to remove when retention settings triggers purge.
@@ -350,9 +350,13 @@ module Google
350
350
  # @!attribute [rw] recognition_result
351
351
  # @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult]
352
352
  # The result of speech recognition.
353
+ #
354
+ # Note: The following fields are mutually exclusive: `recognition_result`, `detect_intent_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
353
355
  # @!attribute [rw] detect_intent_response
354
356
  # @return [::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse]
355
357
  # The response from detect intent.
358
+ #
359
+ # Note: The following fields are mutually exclusive: `detect_intent_response`, `recognition_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
356
360
  # @!attribute [rw] debugging_info
357
361
  # @return [::Google::Cloud::Dialogflow::CX::V3::CloudConversationDebuggingInfo]
358
362
  # Debugging info that would get populated when
@@ -819,18 +823,28 @@ module Google
819
823
  # @!attribute [rw] text
820
824
  # @return [::Google::Cloud::Dialogflow::CX::V3::TextInput]
821
825
  # The natural language text to be processed.
826
+ #
827
+ # Note: The following fields are mutually exclusive: `text`, `intent`, `audio`, `event`, `dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
822
828
  # @!attribute [rw] intent
823
829
  # @return [::Google::Cloud::Dialogflow::CX::V3::IntentInput]
824
830
  # The intent to be triggered.
831
+ #
832
+ # Note: The following fields are mutually exclusive: `intent`, `text`, `audio`, `event`, `dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
825
833
  # @!attribute [rw] audio
826
834
  # @return [::Google::Cloud::Dialogflow::CX::V3::AudioInput]
827
835
  # The natural language speech audio to be processed.
836
+ #
837
+ # Note: The following fields are mutually exclusive: `audio`, `text`, `intent`, `event`, `dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
828
838
  # @!attribute [rw] event
829
839
  # @return [::Google::Cloud::Dialogflow::CX::V3::EventInput]
830
840
  # The event to be triggered.
841
+ #
842
+ # Note: The following fields are mutually exclusive: `event`, `text`, `intent`, `audio`, `dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
831
843
  # @!attribute [rw] dtmf
832
844
  # @return [::Google::Cloud::Dialogflow::CX::V3::DtmfInput]
833
845
  # The DTMF event to be handled.
846
+ #
847
+ # Note: The following fields are mutually exclusive: `dtmf`, `text`, `intent`, `audio`, `event`. If a field in that set is populated, all other fields in the set will automatically be cleared.
834
848
  # @!attribute [rw] language_code
835
849
  # @return [::String]
836
850
  # Required. The language of the input. See [Language
@@ -847,25 +861,35 @@ module Google
847
861
  # @return [::String]
848
862
  # If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was
849
863
  # provided as input, this field will contain a copy of the text.
864
+ #
865
+ # Note: The following fields are mutually exclusive: `text`, `trigger_intent`, `transcript`, `trigger_event`, `dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
850
866
  # @!attribute [rw] trigger_intent
851
867
  # @return [::String]
852
868
  # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
853
869
  # input, this field will contain a copy of the intent identifier. Format:
854
870
  # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
871
+ #
872
+ # Note: The following fields are mutually exclusive: `trigger_intent`, `text`, `transcript`, `trigger_event`, `dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
855
873
  # @!attribute [rw] transcript
856
874
  # @return [::String]
857
875
  # If [natural language speech
858
876
  # audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
859
877
  # this field will contain the transcript for the audio.
878
+ #
879
+ # Note: The following fields are mutually exclusive: `transcript`, `text`, `trigger_intent`, `trigger_event`, `dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
860
880
  # @!attribute [rw] trigger_event
861
881
  # @return [::String]
862
882
  # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as
863
883
  # input, this field will contain the name of the event.
884
+ #
885
+ # Note: The following fields are mutually exclusive: `trigger_event`, `text`, `trigger_intent`, `transcript`, `dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
864
886
  # @!attribute [rw] dtmf
865
887
  # @return [::Google::Cloud::Dialogflow::CX::V3::DtmfInput]
866
888
  # If a {::Google::Cloud::Dialogflow::CX::V3::DtmfInput DTMF} was provided as
867
889
  # input, this field will contain a copy of the
868
890
  # {::Google::Cloud::Dialogflow::CX::V3::DtmfInput DtmfInput}.
891
+ #
892
+ # Note: The following fields are mutually exclusive: `dtmf`, `text`, `trigger_intent`, `transcript`, `trigger_event`. If a field in that set is populated, all other fields in the set will automatically be cleared.
869
893
  # @!attribute [rw] language_code
870
894
  # @return [::String]
871
895
  # The language that was triggered during intent detection.
@@ -1174,20 +1198,28 @@ module Google
1174
1198
  # @return [::String]
1175
1199
  # If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was
1176
1200
  # provided as input, this field will contain a copy of the text.
1201
+ #
1202
+ # Note: The following fields are mutually exclusive: `text`, `trigger_intent`, `transcript`, `trigger_event`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1177
1203
  # @!attribute [rw] trigger_intent
1178
1204
  # @return [::String]
1179
1205
  # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
1180
1206
  # input, this field will contain a copy of the intent identifier. Format:
1181
1207
  # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
1208
+ #
1209
+ # Note: The following fields are mutually exclusive: `trigger_intent`, `text`, `transcript`, `trigger_event`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1182
1210
  # @!attribute [rw] transcript
1183
1211
  # @return [::String]
1184
1212
  # If [natural language speech
1185
1213
  # audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
1186
1214
  # this field will contain the transcript for the audio.
1215
+ #
1216
+ # Note: The following fields are mutually exclusive: `transcript`, `text`, `trigger_intent`, `trigger_event`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1187
1217
  # @!attribute [rw] trigger_event
1188
1218
  # @return [::String]
1189
1219
  # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as
1190
1220
  # input, this field will contain a copy of the event name.
1221
+ #
1222
+ # Note: The following fields are mutually exclusive: `trigger_event`, `text`, `trigger_intent`, `transcript`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1191
1223
  # @!attribute [rw] matches
1192
1224
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Match>]
1193
1225
  # Match results, if more than one, ordered descendingly by the confidence
@@ -234,10 +234,14 @@ module Google
234
234
  # @return [::Google::Cloud::Dialogflow::CX::V3::Page]
235
235
  # Indicates a transition to a {::Google::Cloud::Dialogflow::CX::V3::Page Page}.
236
236
  # Only some fields such as name and displayname will be set.
237
+ #
238
+ # Note: The following fields are mutually exclusive: `page`, `flow`. If a field in that set is populated, all other fields in the set will automatically be cleared.
237
239
  # @!attribute [rw] flow
238
240
  # @return [::Google::Cloud::Dialogflow::CX::V3::Flow]
239
241
  # Indicates a transition to a {::Google::Cloud::Dialogflow::CX::V3::Flow Flow}.
240
242
  # Only some fields such as name and displayname will be set.
243
+ #
244
+ # Note: The following fields are mutually exclusive: `flow`, `page`. If a field in that set is populated, all other fields in the set will automatically be cleared.
241
245
  class TransitionNode
242
246
  include ::Google::Protobuf::MessageExts
243
247
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -260,9 +264,13 @@ module Google
260
264
  # @!attribute [rw] transition_route
261
265
  # @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRoute]
262
266
  # Intent route or condition route.
267
+ #
268
+ # Note: The following fields are mutually exclusive: `transition_route`, `event_handler`. If a field in that set is populated, all other fields in the set will automatically be cleared.
263
269
  # @!attribute [rw] event_handler
264
270
  # @return [::Google::Cloud::Dialogflow::CX::V3::EventHandler]
265
271
  # Event handler.
272
+ #
273
+ # Note: The following fields are mutually exclusive: `event_handler`, `transition_route`. If a field in that set is populated, all other fields in the set will automatically be cleared.
266
274
  class Transition
267
275
  include ::Google::Protobuf::MessageExts
268
276
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -377,12 +385,18 @@ module Google
377
385
  # @!attribute [rw] intent_coverage
378
386
  # @return [::Google::Cloud::Dialogflow::CX::V3::IntentCoverage]
379
387
  # Intent coverage.
388
+ #
389
+ # Note: The following fields are mutually exclusive: `intent_coverage`, `transition_coverage`, `route_group_coverage`. If a field in that set is populated, all other fields in the set will automatically be cleared.
380
390
  # @!attribute [rw] transition_coverage
381
391
  # @return [::Google::Cloud::Dialogflow::CX::V3::TransitionCoverage]
382
392
  # Transition (excluding transition route groups) coverage.
393
+ #
394
+ # Note: The following fields are mutually exclusive: `transition_coverage`, `intent_coverage`, `route_group_coverage`. If a field in that set is populated, all other fields in the set will automatically be cleared.
383
395
  # @!attribute [rw] route_group_coverage
384
396
  # @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroupCoverage]
385
397
  # Transition route group coverage.
398
+ #
399
+ # Note: The following fields are mutually exclusive: `route_group_coverage`, `intent_coverage`, `transition_coverage`. If a field in that set is populated, all other fields in the set will automatically be cleared.
386
400
  class CalculateCoverageResponse
387
401
  include ::Google::Protobuf::MessageExts
388
402
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -605,9 +619,13 @@ module Google
605
619
  # have read permissions for the object. For more information, see
606
620
  # [Dialogflow access
607
621
  # control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
622
+ #
623
+ # Note: The following fields are mutually exclusive: `gcs_uri`, `content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
608
624
  # @!attribute [rw] content
609
625
  # @return [::String]
610
626
  # Uncompressed raw byte content for test cases.
627
+ #
628
+ # Note: The following fields are mutually exclusive: `content`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
611
629
  class ImportTestCasesRequest
612
630
  include ::Google::Protobuf::MessageExts
613
631
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -706,9 +724,13 @@ module Google
706
724
  # The URI to a file containing the exported test cases. This field is
707
725
  # populated only if `gcs_uri` is specified in
708
726
  # {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest ExportTestCasesRequest}.
727
+ #
728
+ # Note: The following fields are mutually exclusive: `gcs_uri`, `content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
709
729
  # @!attribute [rw] content
710
730
  # @return [::String]
711
731
  # Uncompressed raw byte content for test cases.
732
+ #
733
+ # Note: The following fields are mutually exclusive: `content`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
712
734
  class ExportTestCasesResponse
713
735
  include ::Google::Protobuf::MessageExts
714
736
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -41,10 +41,14 @@ module Google
41
41
  # @!attribute [rw] generic_web_service
42
42
  # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
43
43
  # Configuration for a generic web service.
44
+ #
45
+ # Note: The following fields are mutually exclusive: `generic_web_service`, `service_directory`. If a field in that set is populated, all other fields in the set will automatically be cleared.
44
46
  # @!attribute [rw] service_directory
45
47
  # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig]
46
48
  # Configuration for a [Service
47
49
  # Directory](https://cloud.google.com/service-directory) service.
50
+ #
51
+ # Note: The following fields are mutually exclusive: `service_directory`, `generic_web_service`. If a field in that set is populated, all other fields in the set will automatically be cleared.
48
52
  # @!attribute [rw] timeout
49
53
  # @return [::Google::Protobuf::Duration]
50
54
  # Webhook execution timeout. Execution is considered failed if Dialogflow
@@ -352,24 +356,34 @@ module Google
352
356
  # @return [::String]
353
357
  # If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was
354
358
  # provided as input, this field will contain a copy of the text.
359
+ #
360
+ # Note: The following fields are mutually exclusive: `text`, `trigger_intent`, `transcript`, `trigger_event`, `dtmf_digits`. If a field in that set is populated, all other fields in the set will automatically be cleared.
355
361
  # @!attribute [rw] trigger_intent
356
362
  # @return [::String]
357
363
  # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
358
364
  # input, this field will contain a copy of the intent identifier. Format:
359
365
  # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
366
+ #
367
+ # Note: The following fields are mutually exclusive: `trigger_intent`, `text`, `transcript`, `trigger_event`, `dtmf_digits`. If a field in that set is populated, all other fields in the set will automatically be cleared.
360
368
  # @!attribute [rw] transcript
361
369
  # @return [::String]
362
370
  # If [natural language speech
363
371
  # audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
364
372
  # this field will contain the transcript for the audio.
373
+ #
374
+ # Note: The following fields are mutually exclusive: `transcript`, `text`, `trigger_intent`, `trigger_event`, `dtmf_digits`. If a field in that set is populated, all other fields in the set will automatically be cleared.
365
375
  # @!attribute [rw] trigger_event
366
376
  # @return [::String]
367
377
  # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as
368
378
  # input, this field will contain the name of the event.
379
+ #
380
+ # Note: The following fields are mutually exclusive: `trigger_event`, `text`, `trigger_intent`, `transcript`, `dtmf_digits`. If a field in that set is populated, all other fields in the set will automatically be cleared.
369
381
  # @!attribute [rw] dtmf_digits
370
382
  # @return [::String]
371
383
  # If {::Google::Cloud::Dialogflow::CX::V3::DtmfInput DTMF} was provided as input,
372
384
  # this field will contain the DTMF digits.
385
+ #
386
+ # Note: The following fields are mutually exclusive: `dtmf_digits`, `text`, `trigger_intent`, `transcript`, `trigger_event`. If a field in that set is populated, all other fields in the set will automatically be cleared.
373
387
  # @!attribute [rw] language_code
374
388
  # @return [::String]
375
389
  # The language code specified in the [original
@@ -508,11 +522,15 @@ module Google
508
522
  # The target page to transition to.
509
523
  # Format:
510
524
  # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
525
+ #
526
+ # Note: The following fields are mutually exclusive: `target_page`, `target_flow`. If a field in that set is populated, all other fields in the set will automatically be cleared.
511
527
  # @!attribute [rw] target_flow
512
528
  # @return [::String]
513
529
  # The target flow to transition to.
514
530
  # Format:
515
531
  # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
532
+ #
533
+ # Note: The following fields are mutually exclusive: `target_flow`, `target_page`. If a field in that set is populated, all other fields in the set will automatically be cleared.
516
534
  class WebhookResponse
517
535
  include ::Google::Protobuf::MessageExts
518
536
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -40,6 +40,8 @@ module Google
40
40
  # @!attribute [rw] error
41
41
  # @return [::Google::Rpc::Status]
42
42
  # The error result of the operation in case of failure or cancellation.
43
+ #
44
+ # Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
43
45
  # @!attribute [rw] response
44
46
  # @return [::Google::Protobuf::Any]
45
47
  # The normal, successful response of the operation. If the original
@@ -50,6 +52,8 @@ module Google
50
52
  # is the original method name. For example, if the original method name
51
53
  # is `TakeSnapshot()`, the inferred response type is
52
54
  # `TakeSnapshotResponse`.
55
+ #
56
+ # Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
53
57
  class Operation
54
58
  include ::Google::Protobuf::MessageExts
55
59
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -53,21 +53,33 @@ module Google
53
53
  # @!attribute [rw] null_value
54
54
  # @return [::Google::Protobuf::NullValue]
55
55
  # Represents a null value.
56
+ #
57
+ # Note: The following fields are mutually exclusive: `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
56
58
  # @!attribute [rw] number_value
57
59
  # @return [::Float]
58
60
  # Represents a double value.
61
+ #
62
+ # Note: The following fields are mutually exclusive: `number_value`, `null_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
59
63
  # @!attribute [rw] string_value
60
64
  # @return [::String]
61
65
  # Represents a string value.
66
+ #
67
+ # Note: The following fields are mutually exclusive: `string_value`, `null_value`, `number_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
62
68
  # @!attribute [rw] bool_value
63
69
  # @return [::Boolean]
64
70
  # Represents a boolean value.
71
+ #
72
+ # Note: The following fields are mutually exclusive: `bool_value`, `null_value`, `number_value`, `string_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
65
73
  # @!attribute [rw] struct_value
66
74
  # @return [::Google::Protobuf::Struct]
67
75
  # Represents a structured value.
76
+ #
77
+ # Note: The following fields are mutually exclusive: `struct_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
68
78
  # @!attribute [rw] list_value
69
79
  # @return [::Google::Protobuf::ListValue]
70
80
  # Represents a repeated `Value`.
81
+ #
82
+ # Note: The following fields are mutually exclusive: `list_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
71
83
  class Value
72
84
  include ::Google::Protobuf::MessageExts
73
85
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dialogflow-cx-v3
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.0
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-12-10 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.24.0
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.24.0
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -311,7 +310,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
311
310
  licenses:
312
311
  - Apache-2.0
313
312
  metadata: {}
314
- post_install_message:
315
313
  rdoc_options: []
316
314
  require_paths:
317
315
  - lib
@@ -319,15 +317,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
319
317
  requirements:
320
318
  - - ">="
321
319
  - !ruby/object:Gem::Version
322
- version: '2.7'
320
+ version: '3.0'
323
321
  required_rubygems_version: !ruby/object:Gem::Requirement
324
322
  requirements:
325
323
  - - ">="
326
324
  - !ruby/object:Gem::Version
327
325
  version: '0'
328
326
  requirements: []
329
- rubygems_version: 3.5.23
330
- signing_key:
327
+ rubygems_version: 3.6.2
331
328
  specification_version: 4
332
329
  summary: Builds conversational interfaces (for example, chatbots, and voice-powered
333
330
  apps and devices).