google-cloud-dialogflow-cx-v3 0.10.2 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (70) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +1 -0
  4. data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +2 -1
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +8 -6
  6. data/lib/google/cloud/dialogflow/cx/v3/agents.rb +1 -1
  7. data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +1 -1
  8. data/lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb +4 -2
  9. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +11 -7
  10. data/lib/google/cloud/dialogflow/cx/v3/deployments.rb +1 -1
  11. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +5 -3
  12. data/lib/google/cloud/dialogflow/cx/v3/entity_types.rb +1 -1
  13. data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +26 -13
  14. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +40 -23
  15. data/lib/google/cloud/dialogflow/cx/v3/environments.rb +3 -2
  16. data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +15 -9
  17. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +28 -18
  18. data/lib/google/cloud/dialogflow/cx/v3/experiments.rb +1 -1
  19. data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +4 -2
  20. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +8 -6
  21. data/lib/google/cloud/dialogflow/cx/v3/flows.rb +1 -1
  22. data/lib/google/cloud/dialogflow/cx/v3/intents.rb +1 -1
  23. data/lib/google/cloud/dialogflow/cx/v3/pages.rb +1 -1
  24. data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +1 -0
  25. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +14 -9
  26. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb +1 -1
  27. data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +7 -4
  28. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +2 -1
  29. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +2 -1
  30. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types.rb +3 -2
  31. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +1 -0
  32. data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +10 -5
  33. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +10 -5
  34. data/lib/google/cloud/dialogflow/cx/v3/sessions.rb +4 -3
  35. data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +16 -8
  36. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +27 -18
  37. data/lib/google/cloud/dialogflow/cx/v3/test_cases.rb +1 -1
  38. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +11 -5
  39. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +21 -11
  40. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups.rb +3 -2
  41. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  42. data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +6 -3
  43. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +22 -18
  44. data/lib/google/cloud/dialogflow/cx/v3/versions.rb +1 -1
  45. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +4 -3
  46. data/lib/google/cloud/dialogflow/cx/v3/webhooks.rb +1 -1
  47. data/lib/google/cloud/dialogflow/cx/v3.rb +2 -2
  48. data/proto_docs/google/api/client.rb +318 -0
  49. data/proto_docs/google/api/launch_stage.rb +71 -0
  50. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +58 -31
  51. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +16 -12
  52. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +6 -3
  53. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +13 -8
  54. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +24 -12
  55. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +65 -41
  56. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +31 -19
  57. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +38 -22
  58. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +10 -5
  59. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +27 -15
  60. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +62 -37
  61. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +32 -21
  62. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +35 -25
  63. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +109 -68
  64. data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +22 -15
  65. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +82 -55
  66. data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +32 -20
  67. data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +36 -26
  68. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +106 -66
  69. data/proto_docs/google/rpc/status.rb +4 -2
  70. metadata +9 -7
@@ -68,9 +68,9 @@ module Google
68
68
  # The audio data bytes encoded as specified in the request.
69
69
  # Note: The output audio is generated based on the values of default platform
70
70
  # text responses found in the
71
- # {::Google::Cloud::Dialogflow::CX::V3::QueryResult#response_messages `query_result.response_messages`} field. If
72
- # multiple default text responses exist, they will be concatenated when
73
- # generating audio. If no default platform text responses exist, the
71
+ # {::Google::Cloud::Dialogflow::CX::V3::QueryResult#response_messages `query_result.response_messages`}
72
+ # field. If multiple default text responses exist, they will be concatenated
73
+ # when generating audio. If no default platform text responses exist, the
74
74
  # generated audio content will be empty.
75
75
  #
76
76
  # In some scenarios, multiple output audio fields may be present in the
@@ -107,24 +107,29 @@ module Google
107
107
  end
108
108
 
109
109
  # The top-level message sent by the client to the
110
- # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent Sessions.StreamingDetectIntent} method.
110
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent Sessions.StreamingDetectIntent}
111
+ # method.
111
112
  #
112
113
  # Multiple request messages should be sent in order:
113
114
  #
114
115
  # 1. The first message must contain
115
116
  # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#session session},
116
- # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input} plus optionally
117
- # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_params query_params}. If the client
118
- # wants to receive an audio response, it should also contain
117
+ # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input}
118
+ # plus optionally
119
+ # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_params query_params}.
120
+ # If the client wants to receive an audio response, it should also contain
119
121
  # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#output_audio_config output_audio_config}.
120
122
  #
121
- # 2. If {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input} was set to
122
- # {::Google::Cloud::Dialogflow::CX::V3::AudioInput#config query_input.audio.config}, all subsequent messages
123
- # must contain {::Google::Cloud::Dialogflow::CX::V3::AudioInput#audio query_input.audio.audio} to continue with
124
- # Speech recognition.
125
- # If you decide to rather detect an intent from text
126
- # input after you already started Speech recognition, please send a message
127
- # with {::Google::Cloud::Dialogflow::CX::V3::QueryInput#text query_input.text}.
123
+ # 2. If
124
+ # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input}
125
+ # was set to
126
+ # {::Google::Cloud::Dialogflow::CX::V3::AudioInput#config query_input.audio.config},
127
+ # all subsequent messages must contain
128
+ # {::Google::Cloud::Dialogflow::CX::V3::AudioInput#audio query_input.audio.audio}
129
+ # to continue with Speech recognition. If you decide to rather detect an
130
+ # intent from text input after you already started Speech recognition,
131
+ # please send a message with
132
+ # {::Google::Cloud::Dialogflow::CX::V3::QueryInput#text query_input.text}.
128
133
  #
129
134
  # However, note that:
130
135
  #
@@ -174,7 +179,8 @@ module Google
174
179
  end
175
180
 
176
181
  # The top-level message returned from the
177
- # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent StreamingDetectIntent} method.
182
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent StreamingDetectIntent}
183
+ # method.
178
184
  #
179
185
  # Multiple response messages (N) can be returned in order.
180
186
  #
@@ -185,17 +191,21 @@ module Google
185
191
  # set, and the `StreamingDetectIntentRequest.enable_partial_response`
186
192
  # field was false, the `recognition_result` field is populated for each
187
193
  # of the (N-1) responses.
188
- # See the {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult StreamingRecognitionResult} message for details
189
- # about the result message sequence.
194
+ # See the
195
+ # {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult StreamingRecognitionResult}
196
+ # message for details about the result message sequence.
190
197
  #
191
198
  # * If the `StreamingDetectIntentRequest.enable_partial_response` field was
192
199
  # true, the `detect_intent_response` field is populated for each
193
200
  # of the (N-1) responses, where 1 <= N <= 4.
194
- # These responses set the {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type} field
195
- # to `PARTIAL`.
201
+ # These responses set the
202
+ # {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type}
203
+ # field to `PARTIAL`.
196
204
  #
197
205
  # For the final Nth response message, the `detect_intent_response` is fully
198
- # populated, and {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type} is set to `FINAL`.
206
+ # populated, and
207
+ # {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type}
208
+ # is set to `FINAL`.
199
209
  # @!attribute [rw] recognition_result
200
210
  # @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult]
201
211
  # The result of speech recognition.
@@ -278,7 +288,8 @@ module Google
278
288
  # @!attribute [rw] speech_word_info
279
289
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SpeechWordInfo>]
280
290
  # Word-specific information for the words recognized by Speech in
281
- # {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult#transcript transcript}. Populated if and only if `message_type` = `TRANSCRIPT` and
291
+ # {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult#transcript transcript}.
292
+ # Populated if and only if `message_type` = `TRANSCRIPT` and
282
293
  # [InputAudioConfig.enable_word_info] is set.
283
294
  # @!attribute [rw] speech_end_offset
284
295
  # @return [::Google::Protobuf::Duration]
@@ -306,8 +317,8 @@ module Google
306
317
  # additional results). The client should stop sending additional audio
307
318
  # data, half-close the gRPC connection, and wait for any additional results
308
319
  # until the server closes the gRPC connection. This message is only sent if
309
- # {::Google::Cloud::Dialogflow::CX::V3::InputAudioConfig#single_utterance `single_utterance`} was set to
310
- # `true`, and is not used otherwise.
320
+ # {::Google::Cloud::Dialogflow::CX::V3::InputAudioConfig#single_utterance `single_utterance`}
321
+ # was set to `true`, and is not used otherwise.
311
322
  END_OF_SINGLE_UTTERANCE = 2
312
323
  end
313
324
  end
@@ -366,8 +377,8 @@ module Google
366
377
  # use parameter value.
367
378
  # @!attribute [rw] current_page
368
379
  # @return [::String]
369
- # The unique identifier of the {::Google::Cloud::Dialogflow::CX::V3::Page page} to override the [current
370
- # page][QueryResult.current_page] in the session.
380
+ # The unique identifier of the {::Google::Cloud::Dialogflow::CX::V3::Page page} to
381
+ # override the [current page][QueryResult.current_page] in the session.
371
382
  # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
372
383
  # ID>/flows/<Flow ID>/pages/<Page ID>`.
373
384
  #
@@ -375,9 +386,10 @@ module Google
375
386
  # ignored by Dialogflow, including the [previous
376
387
  # page][QueryResult.current_page] and the [previous session
377
388
  # parameters][QueryResult.parameters].
378
- # In most cases, {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#current_page current_page} and
379
- # {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#parameters parameters} should be configured together to
380
- # direct a session to a specific state.
389
+ # In most cases,
390
+ # {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#current_page current_page}
391
+ # and {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#parameters parameters}
392
+ # should be configured together to direct a session to a specific state.
381
393
  # @!attribute [rw] disable_webhook
382
394
  # @return [::Boolean]
383
395
  # Whether to disable webhook calls for this request.
@@ -405,6 +417,21 @@ module Google
405
417
  # flow X will go through version 1 regardless of the version configuration in
406
418
  # the environment. Each flow can have at most one version specified in this
407
419
  # list.
420
+ # @!attribute [rw] channel
421
+ # @return [::String]
422
+ # The channel which this query is for.
423
+ #
424
+ # If specified, only the
425
+ # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage ResponseMessage} associated
426
+ # with the channel will be returned. If no
427
+ # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage ResponseMessage} is
428
+ # associated with the channel, it falls back to the
429
+ # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage ResponseMessage} with
430
+ # unspecified channel.
431
+ #
432
+ # If unspecified, the
433
+ # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage ResponseMessage} with
434
+ # unspecified channel will be returned.
408
435
  class QueryParameters
409
436
  include ::Google::Protobuf::MessageExts
410
437
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -457,22 +484,23 @@ module Google
457
484
  # Represents the result of a conversational query.
458
485
  # @!attribute [rw] text
459
486
  # @return [::String]
460
- # If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was provided as input, this field
461
- # will contain a copy of the text.
487
+ # If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was
488
+ # provided as input, this field will contain a copy of the text.
462
489
  # @!attribute [rw] trigger_intent
463
490
  # @return [::String]
464
- # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as input, this field will
465
- # contain a copy of the intent identifier.
466
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
491
+ # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
492
+ # input, this field will contain a copy of the intent identifier. Format:
493
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
467
494
  # ID>/intents/<Intent ID>`.
468
495
  # @!attribute [rw] transcript
469
496
  # @return [::String]
470
- # If {::Google::Cloud::Dialogflow::CX::V3::AudioInput natural language speech audio} was provided as input,
497
+ # If [natural language speech
498
+ # audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
471
499
  # this field will contain the transcript for the audio.
472
500
  # @!attribute [rw] trigger_event
473
501
  # @return [::String]
474
- # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as input, this field will contain
475
- # the name of the event.
502
+ # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as
503
+ # input, this field will contain the name of the event.
476
504
  # @!attribute [rw] dtmf
477
505
  # @return [::Google::Cloud::Dialogflow::CX::V3::DtmfInput]
478
506
  # If a [DTMF][DTMFInput] was provided as input, this field will contain
@@ -485,7 +513,8 @@ module Google
485
513
  # for a list of the currently supported language codes.
486
514
  # @!attribute [rw] parameters
487
515
  # @return [::Google::Protobuf::Struct]
488
- # The collected {::Google::Cloud::Dialogflow::CX::V3::SessionInfo#parameters session parameters}.
516
+ # The collected [session
517
+ # parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
489
518
  #
490
519
  # Depending on your protocol or client library language, this is a
491
520
  # map, associative array, symbol table, dictionary, or JSON object
@@ -509,19 +538,23 @@ module Google
509
538
  # The list of webhook call status in the order of call sequence.
510
539
  # @!attribute [rw] webhook_payloads
511
540
  # @return [::Array<::Google::Protobuf::Struct>]
512
- # The list of webhook payload in {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse#payload WebhookResponse.payload}, in
513
- # the order of call sequence. If some webhook call fails or doesn't return
541
+ # The list of webhook payload in
542
+ # {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse#payload WebhookResponse.payload},
543
+ # in the order of call sequence. If some webhook call fails or doesn't return
514
544
  # any payload, an empty `Struct` would be used instead.
515
545
  # @!attribute [rw] current_page
516
546
  # @return [::Google::Cloud::Dialogflow::CX::V3::Page]
517
- # The current {::Google::Cloud::Dialogflow::CX::V3::Page Page}. Some, not all fields are filled in this message,
518
- # including but not limited to `name` and `display_name`.
547
+ # The current {::Google::Cloud::Dialogflow::CX::V3::Page Page}. Some, not all
548
+ # fields are filled in this message, including but not limited to `name` and
549
+ # `display_name`.
519
550
  # @!attribute [rw] intent
520
551
  # @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
521
- # The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that matched the conversational query. Some, not all fields
522
- # are filled in this message, including but not limited to: `name` and
523
- # `display_name`.
524
- # This field is deprecated, please use {::Google::Cloud::Dialogflow::CX::V3::QueryResult#match QueryResult.match} instead.
552
+ # The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that matched the
553
+ # conversational query. Some, not all fields are filled in this message,
554
+ # including but not limited to: `name` and `display_name`. This field is
555
+ # deprecated, please use
556
+ # {::Google::Cloud::Dialogflow::CX::V3::QueryResult#match QueryResult.match}
557
+ # instead.
525
558
  # @!attribute [rw] intent_detection_confidence
526
559
  # @return [::Float]
527
560
  # The intent detection confidence. Values range from 0.0 (completely
@@ -530,7 +563,9 @@ module Google
530
563
  # help match the best intent within the classification threshold.
531
564
  # This value may change for the same end-user expression at any time due to a
532
565
  # model retraining or change in implementation.
533
- # This field is deprecated, please use {::Google::Cloud::Dialogflow::CX::V3::QueryResult#match QueryResult.match} instead.
566
+ # This field is deprecated, please use
567
+ # {::Google::Cloud::Dialogflow::CX::V3::QueryResult#match QueryResult.match}
568
+ # instead.
534
569
  # @!attribute [rw] match
535
570
  # @return [::Google::Cloud::Dialogflow::CX::V3::Match]
536
571
  # Intent match result, could be an intent or an event.
@@ -557,7 +592,8 @@ module Google
557
592
  # @return [::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult]
558
593
  # The sentiment analyss result, which depends on
559
594
  # [`analyze_query_text_sentiment`]
560
- # [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.
595
+ # [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment],
596
+ # specified in the request.
561
597
  class QueryResult
562
598
  include ::Google::Protobuf::MessageExts
563
599
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -566,8 +602,8 @@ module Google
566
602
  # Represents the natural language text to be processed.
567
603
  # @!attribute [rw] text
568
604
  # @return [::String]
569
- # Required. The UTF-8 encoded natural language text to be processed. Text length must
570
- # not exceed 256 characters.
605
+ # Required. The UTF-8 encoded natural language text to be processed. Text
606
+ # length must not exceed 256 characters.
571
607
  class TextInput
572
608
  include ::Google::Protobuf::MessageExts
573
609
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -593,8 +629,9 @@ module Google
593
629
  # @return [::String]
594
630
  # The natural language speech audio to be processed.
595
631
  # A single request can contain up to 1 minute of speech audio data.
596
- # The {::Google::Cloud::Dialogflow::CX::V3::QueryResult#transcript transcribed text} cannot contain more than 256
597
- # bytes.
632
+ # The [transcribed
633
+ # text][google.cloud.dialogflow.cx.v3.QueryResult.transcript] cannot contain
634
+ # more than 256 bytes.
598
635
  #
599
636
  # For non-streaming audio detect intent, both `config` and `audio` must be
600
637
  # provided.
@@ -629,13 +666,15 @@ module Google
629
666
  # Represents one match result of [MatchIntent][].
630
667
  # @!attribute [rw] intent
631
668
  # @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
632
- # The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that matched the query. Some, not all fields are filled in
633
- # this message, including but not limited to: `name` and `display_name`. Only
634
- # filled for {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `INTENT`} match type.
669
+ # The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that matched the query.
670
+ # Some, not all fields are filled in this message, including but not limited
671
+ # to: `name` and `display_name`. Only filled for
672
+ # {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `INTENT`} match type.
635
673
  # @!attribute [rw] event
636
674
  # @return [::String]
637
675
  # The event that matched the query. Filled for
638
- # {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `EVENT`}, {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `NO_MATCH`} and
676
+ # {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `EVENT`},
677
+ # {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `NO_MATCH`} and
639
678
  # {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `NO_INPUT`} match types.
640
679
  # @!attribute [rw] parameters
641
680
  # @return [::Google::Protobuf::Struct]
@@ -727,30 +766,32 @@ module Google
727
766
  # Response of [MatchIntent][].
728
767
  # @!attribute [rw] text
729
768
  # @return [::String]
730
- # If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was provided as input, this field
731
- # will contain a copy of the text.
769
+ # If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was
770
+ # provided as input, this field will contain a copy of the text.
732
771
  # @!attribute [rw] trigger_intent
733
772
  # @return [::String]
734
- # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as input, this field will
735
- # contain a copy of the intent identifier.
736
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
773
+ # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
774
+ # input, this field will contain a copy of the intent identifier. Format:
775
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
737
776
  # ID>/intents/<Intent ID>`.
738
777
  # @!attribute [rw] transcript
739
778
  # @return [::String]
740
- # If {::Google::Cloud::Dialogflow::CX::V3::AudioInput natural language speech audio} was provided as input,
779
+ # If [natural language speech
780
+ # audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
741
781
  # this field will contain the transcript for the audio.
742
782
  # @!attribute [rw] trigger_event
743
783
  # @return [::String]
744
- # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as input, this field will
745
- # contain a copy of the event name.
784
+ # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as
785
+ # input, this field will contain a copy of the event name.
746
786
  # @!attribute [rw] matches
747
787
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Match>]
748
788
  # Match results, if more than one, ordered descendingly by the confidence
749
789
  # we have that the particular intent matches the query.
750
790
  # @!attribute [rw] current_page
751
791
  # @return [::Google::Cloud::Dialogflow::CX::V3::Page]
752
- # The current {::Google::Cloud::Dialogflow::CX::V3::Page Page}. Some, not all fields are filled in this message,
753
- # including but not limited to `name` and `display_name`.
792
+ # The current {::Google::Cloud::Dialogflow::CX::V3::Page Page}. Some, not all
793
+ # fields are filled in this message, including but not limited to `name` and
794
+ # `display_name`.
754
795
  class MatchIntentResponse
755
796
  include ::Google::Protobuf::MessageExts
756
797
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -785,9 +826,9 @@ module Google
785
826
  # The audio data bytes encoded as specified in the request.
786
827
  # Note: The output audio is generated based on the values of default platform
787
828
  # text responses found in the
788
- # {::Google::Cloud::Dialogflow::CX::V3::QueryResult#response_messages `query_result.response_messages`} field. If
789
- # multiple default text responses exist, they will be concatenated when
790
- # generating audio. If no default platform text responses exist, the
829
+ # {::Google::Cloud::Dialogflow::CX::V3::QueryResult#response_messages `query_result.response_messages`}
830
+ # field. If multiple default text responses exist, they will be concatenated
831
+ # when generating audio. If no default platform text responses exist, the
791
832
  # generated audio content will be empty.
792
833
  #
793
834
  # In some scenarios, multiple output audio fields may be present in the
@@ -27,9 +27,9 @@ module Google
27
27
  # preferences, playlists, and so on.
28
28
  #
29
29
  # You can redefine a session entity type at the session level to extend or
30
- # replace a {::Google::Cloud::Dialogflow::CX::V3::EntityType custom entity type} at the user session level (we
31
- # refer to the entity types defined at the agent level as "custom entity
32
- # types").
30
+ # replace a {::Google::Cloud::Dialogflow::CX::V3::EntityType custom entity type} at
31
+ # the user session level (we refer to the entity types defined at the agent
32
+ # level as "custom entity types").
33
33
  #
34
34
  # Note: session entity types apply to all queries, regardless of the language.
35
35
  #
@@ -46,12 +46,12 @@ module Google
46
46
  # environment.
47
47
  # @!attribute [rw] entity_override_mode
48
48
  # @return [::Google::Cloud::Dialogflow::CX::V3::SessionEntityType::EntityOverrideMode]
49
- # Required. Indicates whether the additional data should override or supplement the
50
- # custom entity type definition.
49
+ # Required. Indicates whether the additional data should override or
50
+ # supplement the custom entity type definition.
51
51
  # @!attribute [rw] entities
52
52
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::Entity>]
53
- # Required. The collection of entities to override or supplement the custom entity
54
- # type.
53
+ # Required. The collection of entities to override or supplement the custom
54
+ # entity type.
55
55
  class SessionEntityType
56
56
  include ::Google::Protobuf::MessageExts
57
57
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -72,13 +72,15 @@ module Google
72
72
  # `GetSessionEntityType`, `CreateSessionEntityType` and
73
73
  # `UpdateSessionEntityType` only return the additional entities added in
74
74
  # this session entity type. If you want to get the supplemented list,
75
- # please call {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType} on the custom entity type
76
- # and merge.
75
+ # please call
76
+ # {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType}
77
+ # on the custom entity type and merge.
77
78
  ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
78
79
  end
79
80
  end
80
81
 
81
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
82
+ # The request message for
83
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
82
84
  # @!attribute [rw] parent
83
85
  # @return [::String]
84
86
  # Required. The session to list all session entity types from.
@@ -99,7 +101,8 @@ module Google
99
101
  extend ::Google::Protobuf::MessageExts::ClassMethods
100
102
  end
101
103
 
102
- # The response message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
104
+ # The response message for
105
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
103
106
  # @!attribute [rw] session_entity_types
104
107
  # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SessionEntityType>]
105
108
  # The list of session entity types. There will be a maximum number of items
@@ -113,7 +116,8 @@ module Google
113
116
  extend ::Google::Protobuf::MessageExts::ClassMethods
114
117
  end
115
118
 
116
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#get_session_entity_type SessionEntityTypes.GetSessionEntityType}.
119
+ # The request message for
120
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#get_session_entity_type SessionEntityTypes.GetSessionEntityType}.
117
121
  # @!attribute [rw] name
118
122
  # @return [::String]
119
123
  # Required. The name of the session entity type.
@@ -128,7 +132,8 @@ module Google
128
132
  extend ::Google::Protobuf::MessageExts::ClassMethods
129
133
  end
130
134
 
131
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#create_session_entity_type SessionEntityTypes.CreateSessionEntityType}.
135
+ # The request message for
136
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#create_session_entity_type SessionEntityTypes.CreateSessionEntityType}.
132
137
  # @!attribute [rw] parent
133
138
  # @return [::String]
134
139
  # Required. The session to create a session entity type for.
@@ -145,7 +150,8 @@ module Google
145
150
  extend ::Google::Protobuf::MessageExts::ClassMethods
146
151
  end
147
152
 
148
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#update_session_entity_type SessionEntityTypes.UpdateSessionEntityType}.
153
+ # The request message for
154
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#update_session_entity_type SessionEntityTypes.UpdateSessionEntityType}.
149
155
  # @!attribute [rw] session_entity_type
150
156
  # @return [::Google::Cloud::Dialogflow::CX::V3::SessionEntityType]
151
157
  # Required. The session entity type to update.
@@ -163,7 +169,8 @@ module Google
163
169
  extend ::Google::Protobuf::MessageExts::ClassMethods
164
170
  end
165
171
 
166
- # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#delete_session_entity_type SessionEntityTypes.DeleteSessionEntityType}.
172
+ # The request message for
173
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#delete_session_entity_type SessionEntityTypes.DeleteSessionEntityType}.
167
174
  # @!attribute [rw] name
168
175
  # @return [::String]
169
176
  # Required. The name of the session entity type to delete.