google-apis-dialogflow_v3 0.3.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cbfbbb8a7d6dc181c0f6532dd7c173da9ee47e0f87919485a0b2998a3a216b15
4
- data.tar.gz: a893e6bb25bfd4fc109d43f11252bbb14a342b91f8a06a2202942206c44617ba
3
+ metadata.gz: 2fbeb25558416b5308c1f40d7e778daf79ef5a5eb6cf6f0875719033d7d58703
4
+ data.tar.gz: 97057cea039f803f2c8fac60510c558d6d95ef5b76309d750e83ebebd0502919
5
5
  SHA512:
6
- metadata.gz: 7d470dfb1d829c8c981ae9283e2b53ac9380cbb46e6a791f4d2af0ff08e4850e3672a7066463e57d57b583970909317d5e6fc362f5718c09e7f81eb8fcab1f71
7
- data.tar.gz: b869e01b3cb81cae8192f414fcb98de3418fa15d5c89f455065df526c41ffc2ba3156239eea20cbbe851a4179643e726b58ff71e0afd605e8c3912558cddd2b1
6
+ metadata.gz: f39c15b778a91ce78c37c3838684b86de9bd181df5c0bf97832e3f5b95b0e0a0e1669dde7acdfe5be46ec6f5aa07c360d4aa009babf71f65f421efd2f79f233f
7
+ data.tar.gz: 12acec21c02f2615539ddd3a29a1b68f2e6d75384317f8a634c2db07897b30c308e0888fb28c02873db7e37a0212dc2ee7c9acdcdc9fbb99c5db1bddf0a27cd4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Release history for google-apis-dialogflow_v3
2
2
 
3
+ ### v0.8.0 (2021-03-16)
4
+
5
+ * Regenerated from discovery document revision 20210314
6
+
7
+ ### v0.7.0 (2021-03-09)
8
+
9
+ * Regenerated from discovery document revision 20210307
10
+ * Regenerated using generator version 0.2.0
11
+
12
+ ### v0.6.0 (2021-03-04)
13
+
14
+ * Unspecified changes
15
+
16
+ ### v0.5.0 (2021-02-24)
17
+
18
+ * Regenerated from discovery document revision 20210222
19
+
20
+ ### v0.4.0 (2021-02-17)
21
+
22
+ * Regenerated from discovery document revision 20210213
23
+
3
24
  ### v0.3.0 (2021-02-12)
4
25
 
5
26
  * Regenerated from discovery document revision 20210209
@@ -38,7 +38,7 @@ module Google
38
38
  attr_accessor :avatar_uri
39
39
 
40
40
  # Immutable. The default language of the agent as a language tag. See [Language
41
- # Support](https://cloud.google.com/dialogflow/docs/reference/language) for a
41
+ # Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a
42
42
  # list of the currently supported language codes. This field cannot be set by
43
43
  # the Agents.UpdateAgent method.
44
44
  # Corresponds to the JSON property `defaultLanguageCode`
@@ -276,8 +276,16 @@ module Google
276
276
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3IntentCoverage]
277
277
  attr_accessor :intent_coverage
278
278
 
279
- # Transition coverage represents the percentage of all possible transitions
280
- # present within any of a parent's test cases.
279
+ # Transition route group coverage represents the percentage of all possible
280
+ # transition routes present within any of a parent's test cases. The results are
281
+ # grouped by the transition route group.
282
+ # Corresponds to the JSON property `routeGroupCoverage`
283
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroupCoverage]
284
+ attr_accessor :route_group_coverage
285
+
286
+ # Transition coverage represents the percentage of all possible page transitions
287
+ # (page-level transition routes and event handlers, excluding transition route
288
+ # groups) present within any of a parent's test cases.
281
289
  # Corresponds to the JSON property `transitionCoverage`
282
290
  # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionCoverage]
283
291
  attr_accessor :transition_coverage
@@ -290,6 +298,7 @@ module Google
290
298
  def update!(**args)
291
299
  @agent = args[:agent] if args.key?(:agent)
292
300
  @intent_coverage = args[:intent_coverage] if args.key?(:intent_coverage)
301
+ @route_group_coverage = args[:route_group_coverage] if args.key?(:route_group_coverage)
293
302
  @transition_coverage = args[:transition_coverage] if args.key?(:transition_coverage)
294
303
  end
295
304
  end
@@ -911,7 +920,9 @@ module Google
911
920
  # @return [String]
912
921
  attr_accessor :end_time
913
922
 
914
- # Maximum number of days to run the experiment.
923
+ # Maximum number of days to run the experiment/rollout. If auto-rollout is not
924
+ # enabled, default value and maximum will be 30 days. If auto-rollout is enabled,
925
+ # default value and maximum will be 6 days.
915
926
  # Corresponds to the JSON property `experimentLength`
916
927
  # @return [String]
917
928
  attr_accessor :experiment_length
@@ -2782,7 +2793,7 @@ module Google
2782
2793
  attr_accessor :text
2783
2794
 
2784
2795
  # If natural language speech audio was provided as input, this field will
2785
- # contain the trascript for the audio.
2796
+ # contain the transcript for the audio.
2786
2797
  # Corresponds to the JSON property `transcript`
2787
2798
  # @return [String]
2788
2799
  attr_accessor :transcript
@@ -2794,7 +2805,7 @@ module Google
2794
2805
  attr_accessor :trigger_event
2795
2806
 
2796
2807
  # If an intent was provided as input, this field will contain a copy of the
2797
- # intent identifier.
2808
+ # intent identifier. Format: `projects//locations//agents//intents/`.
2798
2809
  # Corresponds to the JSON property `triggerIntent`
2799
2810
  # @return [String]
2800
2811
  attr_accessor :trigger_intent
@@ -3109,7 +3120,7 @@ module Google
3109
3120
  attr_accessor :intent
3110
3121
 
3111
3122
  # Required. The language of the input. See [Language Support](https://cloud.
3112
- # google.com/dialogflow/docs/reference/language) for a list of the currently
3123
+ # google.com/dialogflow/cx/docs/reference/language) for a list of the currently
3113
3124
  # supported language codes. Note that queries in the same session do not
3114
3125
  # necessarily need to specify the same language.
3115
3126
  # Corresponds to the JSON property `languageCode`
@@ -3147,6 +3158,12 @@ module Google
3147
3158
  attr_accessor :analyze_query_text_sentiment
3148
3159
  alias_method :analyze_query_text_sentiment?, :analyze_query_text_sentiment
3149
3160
 
3161
+ # Whether to disable webhook calls for this request.
3162
+ # Corresponds to the JSON property `disableWebhook`
3163
+ # @return [Boolean]
3164
+ attr_accessor :disable_webhook
3165
+ alias_method :disable_webhook?, :disable_webhook
3166
+
3150
3167
  # An object that represents a latitude/longitude pair. This is expressed as a
3151
3168
  # pair of doubles to represent degrees latitude and degrees longitude. Unless
3152
3169
  # specified otherwise, this must conform to the WGS84 standard. Values must be
@@ -3208,6 +3225,7 @@ module Google
3208
3225
  # Update properties of this object
3209
3226
  def update!(**args)
3210
3227
  @analyze_query_text_sentiment = args[:analyze_query_text_sentiment] if args.key?(:analyze_query_text_sentiment)
3228
+ @disable_webhook = args[:disable_webhook] if args.key?(:disable_webhook)
3211
3229
  @geo_location = args[:geo_location] if args.key?(:geo_location)
3212
3230
  @parameters = args[:parameters] if args.key?(:parameters)
3213
3231
  @payload = args[:payload] if args.key?(:payload)
@@ -3263,7 +3281,7 @@ module Google
3263
3281
  attr_accessor :intent_detection_confidence
3264
3282
 
3265
3283
  # The language that was triggered during intent detection. See [Language Support]
3266
- # (https://cloud.google.com/dialogflow/docs/reference/language) for a list of
3284
+ # (https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of
3267
3285
  # the currently supported language codes.
3268
3286
  # Corresponds to the JSON property `languageCode`
3269
3287
  # @return [String]
@@ -3307,7 +3325,7 @@ module Google
3307
3325
  attr_accessor :text
3308
3326
 
3309
3327
  # If natural language speech audio was provided as input, this field will
3310
- # contain the trascript for the audio.
3328
+ # contain the transcript for the audio.
3311
3329
  # Corresponds to the JSON property `transcript`
3312
3330
  # @return [String]
3313
3331
  attr_accessor :transcript
@@ -3319,7 +3337,7 @@ module Google
3319
3337
  attr_accessor :trigger_event
3320
3338
 
3321
3339
  # If an intent was provided as input, this field will contain a copy of the
3322
- # intent identifier.
3340
+ # intent identifier. Format: `projects//locations//agents//intents/`.
3323
3341
  # Corresponds to the JSON property `triggerIntent`
3324
3342
  # @return [String]
3325
3343
  attr_accessor :trigger_intent
@@ -3726,6 +3744,11 @@ module Google
3726
3744
  # @return [String]
3727
3745
  attr_accessor :agent_uri
3728
3746
 
3747
+ # Agent restore mode. If not specified, `KEEP` is assumed.
3748
+ # Corresponds to the JSON property `restoreOption`
3749
+ # @return [String]
3750
+ attr_accessor :restore_option
3751
+
3729
3752
  def initialize(**args)
3730
3753
  update!(**args)
3731
3754
  end
@@ -3734,6 +3757,7 @@ module Google
3734
3757
  def update!(**args)
3735
3758
  @agent_content = args[:agent_content] if args.key?(:agent_content)
3736
3759
  @agent_uri = args[:agent_uri] if args.key?(:agent_uri)
3760
+ @restore_option = args[:restore_option] if args.key?(:restore_option)
3737
3761
  end
3738
3762
  end
3739
3763
 
@@ -3760,12 +3784,6 @@ module Google
3760
3784
  # @return [String]
3761
3785
  attr_accessor :environment
3762
3786
 
3763
- # Required. Format of test case name to run: `projects//locations/ /agents//
3764
- # testCases/`.
3765
- # Corresponds to the JSON property `name`
3766
- # @return [String]
3767
- attr_accessor :name
3768
-
3769
3787
  def initialize(**args)
3770
3788
  update!(**args)
3771
3789
  end
@@ -3773,7 +3791,6 @@ module Google
3773
3791
  # Update properties of this object
3774
3792
  def update!(**args)
3775
3793
  @environment = args[:environment] if args.key?(:environment)
3776
- @name = args[:name] if args.key?(:name)
3777
3794
  end
3778
3795
  end
3779
3796
 
@@ -4332,8 +4349,9 @@ module Google
4332
4349
  end
4333
4350
  end
4334
4351
 
4335
- # Transition coverage represents the percentage of all possible transitions
4336
- # present within any of a parent's test cases.
4352
+ # Transition coverage represents the percentage of all possible page transitions
4353
+ # (page-level transition routes and event handlers, excluding transition route
4354
+ # groups) present within any of a parent's test cases.
4337
4355
  class GoogleCloudDialogflowCxV3TransitionCoverage
4338
4356
  include Google::Apis::Core::Hashable
4339
4357
 
@@ -4358,7 +4376,7 @@ module Google
4358
4376
  end
4359
4377
  end
4360
4378
 
4361
- # A transition in the agent's graph.
4379
+ # A transition in a page.
4362
4380
  class GoogleCloudDialogflowCxV3TransitionCoverageTransition
4363
4381
  include Google::Apis::Core::Hashable
4364
4382
 
@@ -4572,6 +4590,100 @@ module Google
4572
4590
  end
4573
4591
  end
4574
4592
 
4593
+ # Transition route group coverage represents the percentage of all possible
4594
+ # transition routes present within any of a parent's test cases. The results are
4595
+ # grouped by the transition route group.
4596
+ class GoogleCloudDialogflowCxV3TransitionRouteGroupCoverage
4597
+ include Google::Apis::Core::Hashable
4598
+
4599
+ # The percent of transition routes in all the transition route groups that are
4600
+ # covered.
4601
+ # Corresponds to the JSON property `coverageScore`
4602
+ # @return [Float]
4603
+ attr_accessor :coverage_score
4604
+
4605
+ # Transition route group coverages.
4606
+ # Corresponds to the JSON property `coverages`
4607
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroupCoverageCoverage>]
4608
+ attr_accessor :coverages
4609
+
4610
+ def initialize(**args)
4611
+ update!(**args)
4612
+ end
4613
+
4614
+ # Update properties of this object
4615
+ def update!(**args)
4616
+ @coverage_score = args[:coverage_score] if args.key?(:coverage_score)
4617
+ @coverages = args[:coverages] if args.key?(:coverages)
4618
+ end
4619
+ end
4620
+
4621
+ # Coverage result message for one transition route group.
4622
+ class GoogleCloudDialogflowCxV3TransitionRouteGroupCoverageCoverage
4623
+ include Google::Apis::Core::Hashable
4624
+
4625
+ # The percent of transition routes in the transition route group that are
4626
+ # covered.
4627
+ # Corresponds to the JSON property `coverageScore`
4628
+ # @return [Float]
4629
+ attr_accessor :coverage_score
4630
+
4631
+ # An TransitionRouteGroup represents a group of `TransitionRoutes` to be used by
4632
+ # a Page.
4633
+ # Corresponds to the JSON property `routeGroup`
4634
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup]
4635
+ attr_accessor :route_group
4636
+
4637
+ # The list of transition routes and coverage in the transition route group.
4638
+ # Corresponds to the JSON property `transitions`
4639
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroupCoverageCoverageTransition>]
4640
+ attr_accessor :transitions
4641
+
4642
+ def initialize(**args)
4643
+ update!(**args)
4644
+ end
4645
+
4646
+ # Update properties of this object
4647
+ def update!(**args)
4648
+ @coverage_score = args[:coverage_score] if args.key?(:coverage_score)
4649
+ @route_group = args[:route_group] if args.key?(:route_group)
4650
+ @transitions = args[:transitions] if args.key?(:transitions)
4651
+ end
4652
+ end
4653
+
4654
+ # A transition coverage in a transition route group.
4655
+ class GoogleCloudDialogflowCxV3TransitionRouteGroupCoverageCoverageTransition
4656
+ include Google::Apis::Core::Hashable
4657
+
4658
+ # Whether or not the transition route is covered by at least one of the agent's
4659
+ # test cases.
4660
+ # Corresponds to the JSON property `covered`
4661
+ # @return [Boolean]
4662
+ attr_accessor :covered
4663
+ alias_method :covered?, :covered
4664
+
4665
+ # A transition route specifies a intent that can be matched and/or a data
4666
+ # condition that can be evaluated during a session. When a specified transition
4667
+ # is matched, the following actions are taken in order: * If there is a `
4668
+ # trigger_fulfillment` associated with the transition, it will be called. * If
4669
+ # there is a `target_page` associated with the transition, the session will
4670
+ # transition into the specified page. * If there is a `target_flow` associated
4671
+ # with the transition, the session will transition into the specified flow.
4672
+ # Corresponds to the JSON property `transitionRoute`
4673
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRoute]
4674
+ attr_accessor :transition_route
4675
+
4676
+ def initialize(**args)
4677
+ update!(**args)
4678
+ end
4679
+
4680
+ # Update properties of this object
4681
+ def update!(**args)
4682
+ @covered = args[:covered] if args.key?(:covered)
4683
+ @transition_route = args[:transition_route] if args.key?(:transition_route)
4684
+ end
4685
+ end
4686
+
4575
4687
  # Metadata for UpdateDocument operation.
4576
4688
  class GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata
4577
4689
  include Google::Apis::Core::Hashable
@@ -6524,7 +6636,7 @@ module Google
6524
6636
  attr_accessor :intent
6525
6637
 
6526
6638
  # Required. The language of the input. See [Language Support](https://cloud.
6527
- # google.com/dialogflow/docs/reference/language) for a list of the currently
6639
+ # google.com/dialogflow/cx/docs/reference/language) for a list of the currently
6528
6640
  # supported language codes. Note that queries in the same session do not
6529
6641
  # necessarily need to specify the same language.
6530
6642
  # Corresponds to the JSON property `languageCode`
@@ -7571,6 +7683,59 @@ module Google
7571
7683
  end
7572
7684
  end
7573
7685
 
7686
+ # Represents article answer.
7687
+ class GoogleCloudDialogflowV2ArticleAnswer
7688
+ include Google::Apis::Core::Hashable
7689
+
7690
+ # The name of answer record, in the format of "projects//locations//
7691
+ # answerRecords/"
7692
+ # Corresponds to the JSON property `answerRecord`
7693
+ # @return [String]
7694
+ attr_accessor :answer_record
7695
+
7696
+ # Article match confidence. The system's confidence score that this article is a
7697
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
7698
+ # to 1.0 (completely certain).
7699
+ # Corresponds to the JSON property `confidence`
7700
+ # @return [Float]
7701
+ attr_accessor :confidence
7702
+
7703
+ # A map that contains metadata about the answer and the document from which it
7704
+ # originates.
7705
+ # Corresponds to the JSON property `metadata`
7706
+ # @return [Hash<String,String>]
7707
+ attr_accessor :metadata
7708
+
7709
+ # Article snippets.
7710
+ # Corresponds to the JSON property `snippets`
7711
+ # @return [Array<String>]
7712
+ attr_accessor :snippets
7713
+
7714
+ # The article title.
7715
+ # Corresponds to the JSON property `title`
7716
+ # @return [String]
7717
+ attr_accessor :title
7718
+
7719
+ # The article URI.
7720
+ # Corresponds to the JSON property `uri`
7721
+ # @return [String]
7722
+ attr_accessor :uri
7723
+
7724
+ def initialize(**args)
7725
+ update!(**args)
7726
+ end
7727
+
7728
+ # Update properties of this object
7729
+ def update!(**args)
7730
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
7731
+ @confidence = args[:confidence] if args.key?(:confidence)
7732
+ @metadata = args[:metadata] if args.key?(:metadata)
7733
+ @snippets = args[:snippets] if args.key?(:snippets)
7734
+ @title = args[:title] if args.key?(:title)
7735
+ @uri = args[:uri] if args.key?(:uri)
7736
+ end
7737
+ end
7738
+
7574
7739
  # The response message for EntityTypes.BatchUpdateEntityTypes.
7575
7740
  class GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse
7576
7741
  include Google::Apis::Core::Hashable
@@ -7878,6 +8043,94 @@ module Google
7878
8043
  end
7879
8044
  end
7880
8045
 
8046
+ # Represents answer from "frequently asked questions".
8047
+ class GoogleCloudDialogflowV2FaqAnswer
8048
+ include Google::Apis::Core::Hashable
8049
+
8050
+ # The piece of text from the `source` knowledge base document.
8051
+ # Corresponds to the JSON property `answer`
8052
+ # @return [String]
8053
+ attr_accessor :answer
8054
+
8055
+ # The name of answer record, in the format of "projects//locations//
8056
+ # answerRecords/"
8057
+ # Corresponds to the JSON property `answerRecord`
8058
+ # @return [String]
8059
+ attr_accessor :answer_record
8060
+
8061
+ # The system's confidence score that this Knowledge answer is a good match for
8062
+ # this conversational query, range from 0.0 (completely uncertain) to 1.0 (
8063
+ # completely certain).
8064
+ # Corresponds to the JSON property `confidence`
8065
+ # @return [Float]
8066
+ attr_accessor :confidence
8067
+
8068
+ # A map that contains metadata about the answer and the document from which it
8069
+ # originates.
8070
+ # Corresponds to the JSON property `metadata`
8071
+ # @return [Hash<String,String>]
8072
+ attr_accessor :metadata
8073
+
8074
+ # The corresponding FAQ question.
8075
+ # Corresponds to the JSON property `question`
8076
+ # @return [String]
8077
+ attr_accessor :question
8078
+
8079
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
8080
+ # projects//locations//agent/knowledgeBases//documents/`.
8081
+ # Corresponds to the JSON property `source`
8082
+ # @return [String]
8083
+ attr_accessor :source
8084
+
8085
+ def initialize(**args)
8086
+ update!(**args)
8087
+ end
8088
+
8089
+ # Update properties of this object
8090
+ def update!(**args)
8091
+ @answer = args[:answer] if args.key?(:answer)
8092
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
8093
+ @confidence = args[:confidence] if args.key?(:confidence)
8094
+ @metadata = args[:metadata] if args.key?(:metadata)
8095
+ @question = args[:question] if args.key?(:question)
8096
+ @source = args[:source] if args.key?(:source)
8097
+ end
8098
+ end
8099
+
8100
+ # Represents a notification sent to Cloud Pub/Sub subscribers for human agent
8101
+ # assistant events in a specific conversation.
8102
+ class GoogleCloudDialogflowV2HumanAgentAssistantEvent
8103
+ include Google::Apis::Core::Hashable
8104
+
8105
+ # The conversation this notification refers to. Format: `projects//conversations/
8106
+ # `.
8107
+ # Corresponds to the JSON property `conversation`
8108
+ # @return [String]
8109
+ attr_accessor :conversation
8110
+
8111
+ # The participant that the suggestion is compiled for. Format: `projects//
8112
+ # conversations//participants/`. It will not be set in legacy workflow.
8113
+ # Corresponds to the JSON property `participant`
8114
+ # @return [String]
8115
+ attr_accessor :participant
8116
+
8117
+ # The suggestion results payload that this notification refers to.
8118
+ # Corresponds to the JSON property `suggestionResults`
8119
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SuggestionResult>]
8120
+ attr_accessor :suggestion_results
8121
+
8122
+ def initialize(**args)
8123
+ update!(**args)
8124
+ end
8125
+
8126
+ # Update properties of this object
8127
+ def update!(**args)
8128
+ @conversation = args[:conversation] if args.key?(:conversation)
8129
+ @participant = args[:participant] if args.key?(:participant)
8130
+ @suggestion_results = args[:suggestion_results] if args.key?(:suggestion_results)
8131
+ end
8132
+ end
8133
+
7881
8134
  # An intent categorizes an end-user's intention for one conversation turn. For
7882
8135
  # each agent, you define many intents, where your combined intents can handle a
7883
8136
  # complete conversation. When an end-user writes or says something, referred to
@@ -7905,6 +8158,14 @@ module Google
7905
8158
  # @return [String]
7906
8159
  attr_accessor :display_name
7907
8160
 
8161
+ # Optional. Indicates that this intent ends an interaction. Some integrations (e.
8162
+ # g., Actions on Google or Dialogflow phone gateway) use this information to
8163
+ # close interaction with an end user. Default is false.
8164
+ # Corresponds to the JSON property `endInteraction`
8165
+ # @return [Boolean]
8166
+ attr_accessor :end_interaction
8167
+ alias_method :end_interaction?, :end_interaction
8168
+
7908
8169
  # Optional. The collection of event names that trigger the intent. If the
7909
8170
  # collection of input contexts is not empty, all of the contexts must be present
7910
8171
  # in the active user session for an event to trigger this intent. Event names
@@ -7931,6 +8192,14 @@ module Google
7931
8192
  attr_accessor :is_fallback
7932
8193
  alias_method :is_fallback?, :is_fallback
7933
8194
 
8195
+ # Optional. Indicates that a live agent should be brought in to handle the
8196
+ # interaction with the user. In most cases, when you set this flag to true, you
8197
+ # would also want to set end_interaction to true as well. Default is false.
8198
+ # Corresponds to the JSON property `liveAgentHandoff`
8199
+ # @return [Boolean]
8200
+ attr_accessor :live_agent_handoff
8201
+ alias_method :live_agent_handoff?, :live_agent_handoff
8202
+
7934
8203
  # Optional. The collection of rich messages corresponding to the `Response`
7935
8204
  # field in the Dialogflow console.
7936
8205
  # Corresponds to the JSON property `messages`
@@ -8017,10 +8286,12 @@ module Google
8017
8286
  @action = args[:action] if args.key?(:action)
8018
8287
  @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms)
8019
8288
  @display_name = args[:display_name] if args.key?(:display_name)
8289
+ @end_interaction = args[:end_interaction] if args.key?(:end_interaction)
8020
8290
  @events = args[:events] if args.key?(:events)
8021
8291
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
8022
8292
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
8023
8293
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
8294
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
8024
8295
  @messages = args[:messages] if args.key?(:messages)
8025
8296
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
8026
8297
  @name = args[:name] if args.key?(:name)
@@ -9109,6 +9380,25 @@ module Google
9109
9380
  end
9110
9381
  end
9111
9382
 
9383
+ # Metadata in google::longrunning::Operation for Knowledge operations.
9384
+ class GoogleCloudDialogflowV2KnowledgeOperationMetadata
9385
+ include Google::Apis::Core::Hashable
9386
+
9387
+ # Output only. The current state of this operation.
9388
+ # Corresponds to the JSON property `state`
9389
+ # @return [String]
9390
+ attr_accessor :state
9391
+
9392
+ def initialize(**args)
9393
+ update!(**args)
9394
+ end
9395
+
9396
+ # Update properties of this object
9397
+ def update!(**args)
9398
+ @state = args[:state] if args.key?(:state)
9399
+ end
9400
+ end
9401
+
9112
9402
  # Represents a message posted into a conversation.
9113
9403
  class GoogleCloudDialogflowV2Message
9114
9404
  include Google::Apis::Core::Hashable
@@ -9485,33 +9775,27 @@ module Google
9485
9775
  end
9486
9776
  end
9487
9777
 
9488
- # The request message for a webhook call.
9489
- class GoogleCloudDialogflowV2WebhookRequest
9778
+ # The response message for Participants.SuggestArticles.
9779
+ class GoogleCloudDialogflowV2SuggestArticlesResponse
9490
9780
  include Google::Apis::Core::Hashable
9491
9781
 
9492
- # Represents the contents of the original request that was passed to the `[
9493
- # Streaming]DetectIntent` call.
9494
- # Corresponds to the JSON property `originalDetectIntentRequest`
9495
- # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2OriginalDetectIntentRequest]
9496
- attr_accessor :original_detect_intent_request
9497
-
9498
- # Represents the result of conversational query or event processing.
9499
- # Corresponds to the JSON property `queryResult`
9500
- # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2QueryResult]
9501
- attr_accessor :query_result
9782
+ # Articles ordered by score in descending order.
9783
+ # Corresponds to the JSON property `articleAnswers`
9784
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2ArticleAnswer>]
9785
+ attr_accessor :article_answers
9502
9786
 
9503
- # The unique identifier of the response. Contains the same value as `[Streaming]
9504
- # DetectIntentResponse.response_id`.
9505
- # Corresponds to the JSON property `responseId`
9506
- # @return [String]
9507
- attr_accessor :response_id
9787
+ # Number of messages prior to and including latest_message to compile the
9788
+ # suggestion. It may be smaller than the SuggestArticlesRequest.context_size
9789
+ # field in the request if there aren't that many messages in the conversation.
9790
+ # Corresponds to the JSON property `contextSize`
9791
+ # @return [Fixnum]
9792
+ attr_accessor :context_size
9508
9793
 
9509
- # The unique identifier of detectIntent request session. Can be used to identify
9510
- # end-user inside webhook implementation. Format: `projects//agent/sessions/`,
9511
- # or `projects//agent/environments//users//sessions/`.
9512
- # Corresponds to the JSON property `session`
9794
+ # The name of the latest conversation message used to compile suggestion for.
9795
+ # Format: `projects//locations//conversations//messages/`.
9796
+ # Corresponds to the JSON property `latestMessage`
9513
9797
  # @return [String]
9514
- attr_accessor :session
9798
+ attr_accessor :latest_message
9515
9799
 
9516
9800
  def initialize(**args)
9517
9801
  update!(**args)
@@ -9519,37 +9803,149 @@ module Google
9519
9803
 
9520
9804
  # Update properties of this object
9521
9805
  def update!(**args)
9522
- @original_detect_intent_request = args[:original_detect_intent_request] if args.key?(:original_detect_intent_request)
9523
- @query_result = args[:query_result] if args.key?(:query_result)
9524
- @response_id = args[:response_id] if args.key?(:response_id)
9525
- @session = args[:session] if args.key?(:session)
9806
+ @article_answers = args[:article_answers] if args.key?(:article_answers)
9807
+ @context_size = args[:context_size] if args.key?(:context_size)
9808
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9526
9809
  end
9527
9810
  end
9528
9811
 
9529
- # The response message for a webhook call. This response is validated by the
9530
- # Dialogflow server. If validation fails, an error will be returned in the
9531
- # QueryResult.diagnostic_info field. Setting JSON fields to an empty value with
9532
- # the wrong type is a common error. To avoid this error: - Use `""` for empty
9533
- # strings - Use ```` or `null` for empty objects - Use `[]` or `null` for empty
9534
- # arrays For more information, see the [Protocol Buffers Language Guide](https://
9535
- # developers.google.com/protocol-buffers/docs/proto3#json).
9536
- class GoogleCloudDialogflowV2WebhookResponse
9812
+ # The request message for Participants.SuggestFaqAnswers.
9813
+ class GoogleCloudDialogflowV2SuggestFaqAnswersResponse
9537
9814
  include Google::Apis::Core::Hashable
9538
9815
 
9539
- # Events allow for matching intents by event name instead of the natural
9540
- # language input. For instance, input `` can trigger a personalized welcome
9541
- # response. The parameter `name` may be used by the agent in the response: `"
9542
- # Hello #welcome_event.name! What can I do for you today?"`.
9543
- # Corresponds to the JSON property `followupEventInput`
9544
- # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2EventInput]
9545
- attr_accessor :followup_event_input
9816
+ # Number of messages prior to and including latest_message to compile the
9817
+ # suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size
9818
+ # field in the request if there aren't that many messages in the conversation.
9819
+ # Corresponds to the JSON property `contextSize`
9820
+ # @return [Fixnum]
9821
+ attr_accessor :context_size
9546
9822
 
9547
- # Optional. The rich response messages intended for the end-user. When provided,
9548
- # Dialogflow uses this field to populate QueryResult.fulfillment_messages sent
9549
- # to the integration or API caller.
9550
- # Corresponds to the JSON property `fulfillmentMessages`
9551
- # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessage>]
9552
- attr_accessor :fulfillment_messages
9823
+ # Answers extracted from FAQ documents.
9824
+ # Corresponds to the JSON property `faqAnswers`
9825
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2FaqAnswer>]
9826
+ attr_accessor :faq_answers
9827
+
9828
+ # The name of the latest conversation message used to compile suggestion for.
9829
+ # Format: `projects//locations//conversations//messages/`.
9830
+ # Corresponds to the JSON property `latestMessage`
9831
+ # @return [String]
9832
+ attr_accessor :latest_message
9833
+
9834
+ def initialize(**args)
9835
+ update!(**args)
9836
+ end
9837
+
9838
+ # Update properties of this object
9839
+ def update!(**args)
9840
+ @context_size = args[:context_size] if args.key?(:context_size)
9841
+ @faq_answers = args[:faq_answers] if args.key?(:faq_answers)
9842
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
9843
+ end
9844
+ end
9845
+
9846
+ # One response of different type of suggestion response which is used in the
9847
+ # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
9848
+ # well as HumanAgentAssistantEvent.
9849
+ class GoogleCloudDialogflowV2SuggestionResult
9850
+ include Google::Apis::Core::Hashable
9851
+
9852
+ # The `Status` type defines a logical error model that is suitable for different
9853
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9854
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9855
+ # data: error code, error message, and error details. You can find out more
9856
+ # about this error model and how to work with it in the [API Design Guide](https:
9857
+ # //cloud.google.com/apis/design/errors).
9858
+ # Corresponds to the JSON property `error`
9859
+ # @return [Google::Apis::DialogflowV3::GoogleRpcStatus]
9860
+ attr_accessor :error
9861
+
9862
+ # The response message for Participants.SuggestArticles.
9863
+ # Corresponds to the JSON property `suggestArticlesResponse`
9864
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SuggestArticlesResponse]
9865
+ attr_accessor :suggest_articles_response
9866
+
9867
+ # The request message for Participants.SuggestFaqAnswers.
9868
+ # Corresponds to the JSON property `suggestFaqAnswersResponse`
9869
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
9870
+ attr_accessor :suggest_faq_answers_response
9871
+
9872
+ def initialize(**args)
9873
+ update!(**args)
9874
+ end
9875
+
9876
+ # Update properties of this object
9877
+ def update!(**args)
9878
+ @error = args[:error] if args.key?(:error)
9879
+ @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
9880
+ @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
9881
+ end
9882
+ end
9883
+
9884
+ # The request message for a webhook call.
9885
+ class GoogleCloudDialogflowV2WebhookRequest
9886
+ include Google::Apis::Core::Hashable
9887
+
9888
+ # Represents the contents of the original request that was passed to the `[
9889
+ # Streaming]DetectIntent` call.
9890
+ # Corresponds to the JSON property `originalDetectIntentRequest`
9891
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2OriginalDetectIntentRequest]
9892
+ attr_accessor :original_detect_intent_request
9893
+
9894
+ # Represents the result of conversational query or event processing.
9895
+ # Corresponds to the JSON property `queryResult`
9896
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2QueryResult]
9897
+ attr_accessor :query_result
9898
+
9899
+ # The unique identifier of the response. Contains the same value as `[Streaming]
9900
+ # DetectIntentResponse.response_id`.
9901
+ # Corresponds to the JSON property `responseId`
9902
+ # @return [String]
9903
+ attr_accessor :response_id
9904
+
9905
+ # The unique identifier of detectIntent request session. Can be used to identify
9906
+ # end-user inside webhook implementation. Format: `projects//agent/sessions/`,
9907
+ # or `projects//agent/environments//users//sessions/`.
9908
+ # Corresponds to the JSON property `session`
9909
+ # @return [String]
9910
+ attr_accessor :session
9911
+
9912
+ def initialize(**args)
9913
+ update!(**args)
9914
+ end
9915
+
9916
+ # Update properties of this object
9917
+ def update!(**args)
9918
+ @original_detect_intent_request = args[:original_detect_intent_request] if args.key?(:original_detect_intent_request)
9919
+ @query_result = args[:query_result] if args.key?(:query_result)
9920
+ @response_id = args[:response_id] if args.key?(:response_id)
9921
+ @session = args[:session] if args.key?(:session)
9922
+ end
9923
+ end
9924
+
9925
+ # The response message for a webhook call. This response is validated by the
9926
+ # Dialogflow server. If validation fails, an error will be returned in the
9927
+ # QueryResult.diagnostic_info field. Setting JSON fields to an empty value with
9928
+ # the wrong type is a common error. To avoid this error: - Use `""` for empty
9929
+ # strings - Use ```` or `null` for empty objects - Use `[]` or `null` for empty
9930
+ # arrays For more information, see the [Protocol Buffers Language Guide](https://
9931
+ # developers.google.com/protocol-buffers/docs/proto3#json).
9932
+ class GoogleCloudDialogflowV2WebhookResponse
9933
+ include Google::Apis::Core::Hashable
9934
+
9935
+ # Events allow for matching intents by event name instead of the natural
9936
+ # language input. For instance, input `` can trigger a personalized welcome
9937
+ # response. The parameter `name` may be used by the agent in the response: `"
9938
+ # Hello #welcome_event.name! What can I do for you today?"`.
9939
+ # Corresponds to the JSON property `followupEventInput`
9940
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2EventInput]
9941
+ attr_accessor :followup_event_input
9942
+
9943
+ # Optional. The rich response messages intended for the end-user. When provided,
9944
+ # Dialogflow uses this field to populate QueryResult.fulfillment_messages sent
9945
+ # to the integration or API caller.
9946
+ # Corresponds to the JSON property `fulfillmentMessages`
9947
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessage>]
9948
+ attr_accessor :fulfillment_messages
9553
9949
 
9554
9950
  # Optional. The text response message intended for the end-user. It is
9555
9951
  # recommended to use `fulfillment_messages.text.text[0]` instead. When provided,
@@ -9611,6 +10007,89 @@ module Google
9611
10007
  end
9612
10008
  end
9613
10009
 
10010
+ # Represents a part of a message possibly annotated with an entity. The part can
10011
+ # be an entity or purely a part of the message between two entities or message
10012
+ # start/end.
10013
+ class GoogleCloudDialogflowV2beta1AnnotatedMessagePart
10014
+ include Google::Apis::Core::Hashable
10015
+
10016
+ # Optional. The [Dialogflow system entity type](https://cloud.google.com/
10017
+ # dialogflow/docs/reference/system-entities) of this message part. If this is
10018
+ # empty, Dialogflow could not annotate the phrase part with a system entity.
10019
+ # Corresponds to the JSON property `entityType`
10020
+ # @return [String]
10021
+ attr_accessor :entity_type
10022
+
10023
+ # Optional. The [Dialogflow system entity formatted value ](https://cloud.google.
10024
+ # com/dialogflow/docs/reference/system-entities) of this message part. For
10025
+ # example for a system entity of type `@sys.unit-currency`, this may contain: ` "
10026
+ # amount": 5, "currency": "USD" `
10027
+ # Corresponds to the JSON property `formattedValue`
10028
+ # @return [Object]
10029
+ attr_accessor :formatted_value
10030
+
10031
+ # Required. A part of a message possibly annotated with an entity.
10032
+ # Corresponds to the JSON property `text`
10033
+ # @return [String]
10034
+ attr_accessor :text
10035
+
10036
+ def initialize(**args)
10037
+ update!(**args)
10038
+ end
10039
+
10040
+ # Update properties of this object
10041
+ def update!(**args)
10042
+ @entity_type = args[:entity_type] if args.key?(:entity_type)
10043
+ @formatted_value = args[:formatted_value] if args.key?(:formatted_value)
10044
+ @text = args[:text] if args.key?(:text)
10045
+ end
10046
+ end
10047
+
10048
+ # Represents article answer.
10049
+ class GoogleCloudDialogflowV2beta1ArticleAnswer
10050
+ include Google::Apis::Core::Hashable
10051
+
10052
+ # The name of answer record, in the format of "projects//locations//
10053
+ # answerRecords/"
10054
+ # Corresponds to the JSON property `answerRecord`
10055
+ # @return [String]
10056
+ attr_accessor :answer_record
10057
+
10058
+ # A map that contains metadata about the answer and the document from which it
10059
+ # originates.
10060
+ # Corresponds to the JSON property `metadata`
10061
+ # @return [Hash<String,String>]
10062
+ attr_accessor :metadata
10063
+
10064
+ # Output only. Article snippets.
10065
+ # Corresponds to the JSON property `snippets`
10066
+ # @return [Array<String>]
10067
+ attr_accessor :snippets
10068
+
10069
+ # The article title.
10070
+ # Corresponds to the JSON property `title`
10071
+ # @return [String]
10072
+ attr_accessor :title
10073
+
10074
+ # The article URI.
10075
+ # Corresponds to the JSON property `uri`
10076
+ # @return [String]
10077
+ attr_accessor :uri
10078
+
10079
+ def initialize(**args)
10080
+ update!(**args)
10081
+ end
10082
+
10083
+ # Update properties of this object
10084
+ def update!(**args)
10085
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10086
+ @metadata = args[:metadata] if args.key?(:metadata)
10087
+ @snippets = args[:snippets] if args.key?(:snippets)
10088
+ @title = args[:title] if args.key?(:title)
10089
+ @uri = args[:uri] if args.key?(:uri)
10090
+ end
10091
+ end
10092
+
9614
10093
  # The response message for EntityTypes.BatchUpdateEntityTypes.
9615
10094
  class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse
9616
10095
  include Google::Apis::Core::Hashable
@@ -9711,6 +10190,50 @@ module Google
9711
10190
  end
9712
10191
  end
9713
10192
 
10193
+ # Represents a notification sent to Pub/Sub subscribers for conversation
10194
+ # lifecycle events.
10195
+ class GoogleCloudDialogflowV2beta1ConversationEvent
10196
+ include Google::Apis::Core::Hashable
10197
+
10198
+ # Required. The unique identifier of the conversation this notification refers
10199
+ # to. Format: `projects//conversations/`.
10200
+ # Corresponds to the JSON property `conversation`
10201
+ # @return [String]
10202
+ attr_accessor :conversation
10203
+
10204
+ # The `Status` type defines a logical error model that is suitable for different
10205
+ # programming environments, including REST APIs and RPC APIs. It is used by [
10206
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
10207
+ # data: error code, error message, and error details. You can find out more
10208
+ # about this error model and how to work with it in the [API Design Guide](https:
10209
+ # //cloud.google.com/apis/design/errors).
10210
+ # Corresponds to the JSON property `errorStatus`
10211
+ # @return [Google::Apis::DialogflowV3::GoogleRpcStatus]
10212
+ attr_accessor :error_status
10213
+
10214
+ # Represents a message posted into a conversation.
10215
+ # Corresponds to the JSON property `newMessagePayload`
10216
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1Message]
10217
+ attr_accessor :new_message_payload
10218
+
10219
+ # Required. The type of the event that this notification refers to.
10220
+ # Corresponds to the JSON property `type`
10221
+ # @return [String]
10222
+ attr_accessor :type
10223
+
10224
+ def initialize(**args)
10225
+ update!(**args)
10226
+ end
10227
+
10228
+ # Update properties of this object
10229
+ def update!(**args)
10230
+ @conversation = args[:conversation] if args.key?(:conversation)
10231
+ @error_status = args[:error_status] if args.key?(:error_status)
10232
+ @new_message_payload = args[:new_message_payload] if args.key?(:new_message_payload)
10233
+ @type = args[:type] if args.key?(:type)
10234
+ end
10235
+ end
10236
+
9714
10237
  # Each intent parameter has a type, called the entity type, which dictates
9715
10238
  # exactly how data from an end-user expression is extracted. Dialogflow provides
9716
10239
  # predefined system entities that can match many common types of data. For
@@ -9876,6 +10399,117 @@ module Google
9876
10399
  end
9877
10400
  end
9878
10401
 
10402
+ # Represents answer from "frequently asked questions".
10403
+ class GoogleCloudDialogflowV2beta1FaqAnswer
10404
+ include Google::Apis::Core::Hashable
10405
+
10406
+ # The piece of text from the `source` knowledge base document.
10407
+ # Corresponds to the JSON property `answer`
10408
+ # @return [String]
10409
+ attr_accessor :answer
10410
+
10411
+ # The name of answer record, in the format of "projects//locations//
10412
+ # answerRecords/"
10413
+ # Corresponds to the JSON property `answerRecord`
10414
+ # @return [String]
10415
+ attr_accessor :answer_record
10416
+
10417
+ # The system's confidence score that this Knowledge answer is a good match for
10418
+ # this conversational query, range from 0.0 (completely uncertain) to 1.0 (
10419
+ # completely certain).
10420
+ # Corresponds to the JSON property `confidence`
10421
+ # @return [Float]
10422
+ attr_accessor :confidence
10423
+
10424
+ # A map that contains metadata about the answer and the document from which it
10425
+ # originates.
10426
+ # Corresponds to the JSON property `metadata`
10427
+ # @return [Hash<String,String>]
10428
+ attr_accessor :metadata
10429
+
10430
+ # The corresponding FAQ question.
10431
+ # Corresponds to the JSON property `question`
10432
+ # @return [String]
10433
+ attr_accessor :question
10434
+
10435
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
10436
+ # projects//locations//agent/knowledgeBases//documents/`.
10437
+ # Corresponds to the JSON property `source`
10438
+ # @return [String]
10439
+ attr_accessor :source
10440
+
10441
+ def initialize(**args)
10442
+ update!(**args)
10443
+ end
10444
+
10445
+ # Update properties of this object
10446
+ def update!(**args)
10447
+ @answer = args[:answer] if args.key?(:answer)
10448
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10449
+ @confidence = args[:confidence] if args.key?(:confidence)
10450
+ @metadata = args[:metadata] if args.key?(:metadata)
10451
+ @question = args[:question] if args.key?(:question)
10452
+ @source = args[:source] if args.key?(:source)
10453
+ end
10454
+ end
10455
+
10456
+ # Output only. Represents a notification sent to Pub/Sub subscribers for agent
10457
+ # assistant events in a specific conversation.
10458
+ class GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent
10459
+ include Google::Apis::Core::Hashable
10460
+
10461
+ # The conversation this notification refers to. Format: `projects//conversations/
10462
+ # `.
10463
+ # Corresponds to the JSON property `conversation`
10464
+ # @return [String]
10465
+ attr_accessor :conversation
10466
+
10467
+ # The participant that the suggestion is compiled for. And This field is used to
10468
+ # call Participants.ListSuggestions API. Format: `projects//conversations//
10469
+ # participants/`. It will not be set in legacy workflow.
10470
+ # HumanAgentAssistantConfig.name for more information.
10471
+ # Corresponds to the JSON property `participant`
10472
+ # @return [String]
10473
+ attr_accessor :participant
10474
+
10475
+ # The suggestion results payload that this notification refers to. It will only
10476
+ # be set when HumanAgentAssistantConfig.SuggestionConfig.
10477
+ # group_suggestion_responses sets to true.
10478
+ # Corresponds to the JSON property `suggestionResults`
10479
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SuggestionResult>]
10480
+ attr_accessor :suggestion_results
10481
+
10482
+ def initialize(**args)
10483
+ update!(**args)
10484
+ end
10485
+
10486
+ # Update properties of this object
10487
+ def update!(**args)
10488
+ @conversation = args[:conversation] if args.key?(:conversation)
10489
+ @participant = args[:participant] if args.key?(:participant)
10490
+ @suggestion_results = args[:suggestion_results] if args.key?(:suggestion_results)
10491
+ end
10492
+ end
10493
+
10494
+ # Response message for Documents.ImportDocuments.
10495
+ class GoogleCloudDialogflowV2beta1ImportDocumentsResponse
10496
+ include Google::Apis::Core::Hashable
10497
+
10498
+ # Includes details about skipped documents or any other warnings.
10499
+ # Corresponds to the JSON property `warnings`
10500
+ # @return [Array<Google::Apis::DialogflowV3::GoogleRpcStatus>]
10501
+ attr_accessor :warnings
10502
+
10503
+ def initialize(**args)
10504
+ update!(**args)
10505
+ end
10506
+
10507
+ # Update properties of this object
10508
+ def update!(**args)
10509
+ @warnings = args[:warnings] if args.key?(:warnings)
10510
+ end
10511
+ end
10512
+
9879
10513
  # An intent categorizes an end-user's intention for one conversation turn. For
9880
10514
  # each agent, you define many intents, where your combined intents can handle a
9881
10515
  # complete conversation. When an end-user writes or says something, referred to
@@ -9938,6 +10572,14 @@ module Google
9938
10572
  attr_accessor :is_fallback
9939
10573
  alias_method :is_fallback?, :is_fallback
9940
10574
 
10575
+ # Optional. Indicates that a live agent should be brought in to handle the
10576
+ # interaction with the user. In most cases, when you set this flag to true, you
10577
+ # would also want to set end_interaction to true as well. Default is false.
10578
+ # Corresponds to the JSON property `liveAgentHandoff`
10579
+ # @return [Boolean]
10580
+ attr_accessor :live_agent_handoff
10581
+ alias_method :live_agent_handoff?, :live_agent_handoff
10582
+
9941
10583
  # Optional. The collection of rich messages corresponding to the `Response`
9942
10584
  # field in the Dialogflow console.
9943
10585
  # Corresponds to the JSON property `messages`
@@ -10042,6 +10684,7 @@ module Google
10042
10684
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
10043
10685
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
10044
10686
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
10687
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
10045
10688
  @messages = args[:messages] if args.key?(:messages)
10046
10689
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
10047
10690
  @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled)
@@ -11684,6 +12327,110 @@ module Google
11684
12327
  end
11685
12328
  end
11686
12329
 
12330
+ # Represents a message posted into a conversation.
12331
+ class GoogleCloudDialogflowV2beta1Message
12332
+ include Google::Apis::Core::Hashable
12333
+
12334
+ # Required. The message content.
12335
+ # Corresponds to the JSON property `content`
12336
+ # @return [String]
12337
+ attr_accessor :content
12338
+
12339
+ # Output only. The time when the message was created in Contact Center AI.
12340
+ # Corresponds to the JSON property `createTime`
12341
+ # @return [String]
12342
+ attr_accessor :create_time
12343
+
12344
+ # Optional. The message language. This should be a [BCP-47](https://www.rfc-
12345
+ # editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
12346
+ # Corresponds to the JSON property `languageCode`
12347
+ # @return [String]
12348
+ attr_accessor :language_code
12349
+
12350
+ # Represents the result of annotation for the message.
12351
+ # Corresponds to the JSON property `messageAnnotation`
12352
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1MessageAnnotation]
12353
+ attr_accessor :message_annotation
12354
+
12355
+ # Optional. The unique identifier of the message. Format: `projects//locations//
12356
+ # conversations//messages/`.
12357
+ # Corresponds to the JSON property `name`
12358
+ # @return [String]
12359
+ attr_accessor :name
12360
+
12361
+ # Output only. The participant that sends this message.
12362
+ # Corresponds to the JSON property `participant`
12363
+ # @return [String]
12364
+ attr_accessor :participant
12365
+
12366
+ # Output only. The role of the participant.
12367
+ # Corresponds to the JSON property `participantRole`
12368
+ # @return [String]
12369
+ attr_accessor :participant_role
12370
+
12371
+ # Optional. The time when the message was sent.
12372
+ # Corresponds to the JSON property `sendTime`
12373
+ # @return [String]
12374
+ attr_accessor :send_time
12375
+
12376
+ # The result of sentiment analysis. Sentiment analysis inspects user input and
12377
+ # identifies the prevailing subjective opinion, especially to determine a user's
12378
+ # attitude as positive, negative, or neutral. For Participants.DetectIntent, it
12379
+ # needs to be configured in DetectIntentRequest.query_params. For Participants.
12380
+ # StreamingDetectIntent, it needs to be configured in
12381
+ # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent
12382
+ # and Participants.StreamingAnalyzeContent, it needs to be configured in
12383
+ # ConversationProfile.human_agent_assistant_config
12384
+ # Corresponds to the JSON property `sentimentAnalysis`
12385
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SentimentAnalysisResult]
12386
+ attr_accessor :sentiment_analysis
12387
+
12388
+ def initialize(**args)
12389
+ update!(**args)
12390
+ end
12391
+
12392
+ # Update properties of this object
12393
+ def update!(**args)
12394
+ @content = args[:content] if args.key?(:content)
12395
+ @create_time = args[:create_time] if args.key?(:create_time)
12396
+ @language_code = args[:language_code] if args.key?(:language_code)
12397
+ @message_annotation = args[:message_annotation] if args.key?(:message_annotation)
12398
+ @name = args[:name] if args.key?(:name)
12399
+ @participant = args[:participant] if args.key?(:participant)
12400
+ @participant_role = args[:participant_role] if args.key?(:participant_role)
12401
+ @send_time = args[:send_time] if args.key?(:send_time)
12402
+ @sentiment_analysis = args[:sentiment_analysis] if args.key?(:sentiment_analysis)
12403
+ end
12404
+ end
12405
+
12406
+ # Represents the result of annotation for the message.
12407
+ class GoogleCloudDialogflowV2beta1MessageAnnotation
12408
+ include Google::Apis::Core::Hashable
12409
+
12410
+ # Required. Indicates whether the text message contains entities.
12411
+ # Corresponds to the JSON property `containEntities`
12412
+ # @return [Boolean]
12413
+ attr_accessor :contain_entities
12414
+ alias_method :contain_entities?, :contain_entities
12415
+
12416
+ # Optional. The collection of annotated message parts ordered by their position
12417
+ # in the message. You can recover the annotated message by concatenating [
12418
+ # AnnotatedMessagePart.text].
12419
+ # Corresponds to the JSON property `parts`
12420
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1AnnotatedMessagePart>]
12421
+ attr_accessor :parts
12422
+
12423
+ def initialize(**args)
12424
+ update!(**args)
12425
+ end
12426
+
12427
+ # Update properties of this object
12428
+ def update!(**args)
12429
+ @contain_entities = args[:contain_entities] if args.key?(:contain_entities)
12430
+ @parts = args[:parts] if args.key?(:parts)
12431
+ end
12432
+ end
12433
+
11687
12434
  # Represents the contents of the original request that was passed to the `[
11688
12435
  # Streaming]DetectIntent` call.
11689
12436
  class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest
@@ -11984,6 +12731,188 @@ module Google
11984
12731
  end
11985
12732
  end
11986
12733
 
12734
+ # Represents a smart reply answer.
12735
+ class GoogleCloudDialogflowV2beta1SmartReplyAnswer
12736
+ include Google::Apis::Core::Hashable
12737
+
12738
+ # The name of answer record, in the format of "projects//locations//
12739
+ # answerRecords/"
12740
+ # Corresponds to the JSON property `answerRecord`
12741
+ # @return [String]
12742
+ attr_accessor :answer_record
12743
+
12744
+ # Smart reply confidence. The system's confidence score that this reply is a
12745
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
12746
+ # to 1.0 (completely certain).
12747
+ # Corresponds to the JSON property `confidence`
12748
+ # @return [Float]
12749
+ attr_accessor :confidence
12750
+
12751
+ # The content of the reply.
12752
+ # Corresponds to the JSON property `reply`
12753
+ # @return [String]
12754
+ attr_accessor :reply
12755
+
12756
+ def initialize(**args)
12757
+ update!(**args)
12758
+ end
12759
+
12760
+ # Update properties of this object
12761
+ def update!(**args)
12762
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
12763
+ @confidence = args[:confidence] if args.key?(:confidence)
12764
+ @reply = args[:reply] if args.key?(:reply)
12765
+ end
12766
+ end
12767
+
12768
+ # The response message for Participants.SuggestArticles.
12769
+ class GoogleCloudDialogflowV2beta1SuggestArticlesResponse
12770
+ include Google::Apis::Core::Hashable
12771
+
12772
+ # Output only. Articles ordered by score in descending order.
12773
+ # Corresponds to the JSON property `articleAnswers`
12774
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1ArticleAnswer>]
12775
+ attr_accessor :article_answers
12776
+
12777
+ # Number of messages prior to and including latest_message to compile the
12778
+ # suggestion. It may be smaller than the SuggestArticlesResponse.context_size
12779
+ # field in the request if there aren't that many messages in the conversation.
12780
+ # Corresponds to the JSON property `contextSize`
12781
+ # @return [Fixnum]
12782
+ attr_accessor :context_size
12783
+
12784
+ # The name of the latest conversation message used to compile suggestion for.
12785
+ # Format: `projects//locations//conversations//messages/`.
12786
+ # Corresponds to the JSON property `latestMessage`
12787
+ # @return [String]
12788
+ attr_accessor :latest_message
12789
+
12790
+ def initialize(**args)
12791
+ update!(**args)
12792
+ end
12793
+
12794
+ # Update properties of this object
12795
+ def update!(**args)
12796
+ @article_answers = args[:article_answers] if args.key?(:article_answers)
12797
+ @context_size = args[:context_size] if args.key?(:context_size)
12798
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12799
+ end
12800
+ end
12801
+
12802
+ # The request message for Participants.SuggestFaqAnswers.
12803
+ class GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse
12804
+ include Google::Apis::Core::Hashable
12805
+
12806
+ # Number of messages prior to and including latest_message to compile the
12807
+ # suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size
12808
+ # field in the request if there aren't that many messages in the conversation.
12809
+ # Corresponds to the JSON property `contextSize`
12810
+ # @return [Fixnum]
12811
+ attr_accessor :context_size
12812
+
12813
+ # Output only. Answers extracted from FAQ documents.
12814
+ # Corresponds to the JSON property `faqAnswers`
12815
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1FaqAnswer>]
12816
+ attr_accessor :faq_answers
12817
+
12818
+ # The name of the latest conversation message used to compile suggestion for.
12819
+ # Format: `projects//locations//conversations//messages/`.
12820
+ # Corresponds to the JSON property `latestMessage`
12821
+ # @return [String]
12822
+ attr_accessor :latest_message
12823
+
12824
+ def initialize(**args)
12825
+ update!(**args)
12826
+ end
12827
+
12828
+ # Update properties of this object
12829
+ def update!(**args)
12830
+ @context_size = args[:context_size] if args.key?(:context_size)
12831
+ @faq_answers = args[:faq_answers] if args.key?(:faq_answers)
12832
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12833
+ end
12834
+ end
12835
+
12836
+ # The response message for Participants.SuggestSmartReplies.
12837
+ class GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse
12838
+ include Google::Apis::Core::Hashable
12839
+
12840
+ # Number of messages prior to and including latest_message to compile the
12841
+ # suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size
12842
+ # field in the request if there aren't that many messages in the conversation.
12843
+ # Corresponds to the JSON property `contextSize`
12844
+ # @return [Fixnum]
12845
+ attr_accessor :context_size
12846
+
12847
+ # The name of the latest conversation message used to compile suggestion for.
12848
+ # Format: `projects//locations//conversations//messages/`.
12849
+ # Corresponds to the JSON property `latestMessage`
12850
+ # @return [String]
12851
+ attr_accessor :latest_message
12852
+
12853
+ # Output only. Multiple reply options provided by smart reply service. The order
12854
+ # is based on the rank of the model prediction. The maximum number of the
12855
+ # returned replies is set in SmartReplyConfig.
12856
+ # Corresponds to the JSON property `smartReplyAnswers`
12857
+ # @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SmartReplyAnswer>]
12858
+ attr_accessor :smart_reply_answers
12859
+
12860
+ def initialize(**args)
12861
+ update!(**args)
12862
+ end
12863
+
12864
+ # Update properties of this object
12865
+ def update!(**args)
12866
+ @context_size = args[:context_size] if args.key?(:context_size)
12867
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
12868
+ @smart_reply_answers = args[:smart_reply_answers] if args.key?(:smart_reply_answers)
12869
+ end
12870
+ end
12871
+
12872
+ # One response of different type of suggestion response which is used in the
12873
+ # response of Participants.AnalyzeContent and Participants.AnalyzeContent, as
12874
+ # well as HumanAgentAssistantEvent.
12875
+ class GoogleCloudDialogflowV2beta1SuggestionResult
12876
+ include Google::Apis::Core::Hashable
12877
+
12878
+ # The `Status` type defines a logical error model that is suitable for different
12879
+ # programming environments, including REST APIs and RPC APIs. It is used by [
12880
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
12881
+ # data: error code, error message, and error details. You can find out more
12882
+ # about this error model and how to work with it in the [API Design Guide](https:
12883
+ # //cloud.google.com/apis/design/errors).
12884
+ # Corresponds to the JSON property `error`
12885
+ # @return [Google::Apis::DialogflowV3::GoogleRpcStatus]
12886
+ attr_accessor :error
12887
+
12888
+ # The response message for Participants.SuggestArticles.
12889
+ # Corresponds to the JSON property `suggestArticlesResponse`
12890
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SuggestArticlesResponse]
12891
+ attr_accessor :suggest_articles_response
12892
+
12893
+ # The request message for Participants.SuggestFaqAnswers.
12894
+ # Corresponds to the JSON property `suggestFaqAnswersResponse`
12895
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse]
12896
+ attr_accessor :suggest_faq_answers_response
12897
+
12898
+ # The response message for Participants.SuggestSmartReplies.
12899
+ # Corresponds to the JSON property `suggestSmartRepliesResponse`
12900
+ # @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse]
12901
+ attr_accessor :suggest_smart_replies_response
12902
+
12903
+ def initialize(**args)
12904
+ update!(**args)
12905
+ end
12906
+
12907
+ # Update properties of this object
12908
+ def update!(**args)
12909
+ @error = args[:error] if args.key?(:error)
12910
+ @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
12911
+ @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
12912
+ @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
12913
+ end
12914
+ end
12915
+
11987
12916
  # The request message for a webhook call.
11988
12917
  class GoogleCloudDialogflowV2beta1WebhookRequest
11989
12918
  include Google::Apis::Core::Hashable
@@ -12074,6 +13003,14 @@ module Google
12074
13003
  # @return [String]
12075
13004
  attr_accessor :fulfillment_text
12076
13005
 
13006
+ # Indicates that a live agent should be brought in to handle the interaction
13007
+ # with the user. In most cases, when you set this flag to true, you would also
13008
+ # want to set end_interaction to true as well. Default is false.
13009
+ # Corresponds to the JSON property `liveAgentHandoff`
13010
+ # @return [Boolean]
13011
+ attr_accessor :live_agent_handoff
13012
+ alias_method :live_agent_handoff?, :live_agent_handoff
13013
+
12077
13014
  # Optional. The collection of output contexts that will overwrite currently
12078
13015
  # active contexts for the session and reset their lifespans. When provided,
12079
13016
  # Dialogflow uses this field to populate QueryResult.output_contexts sent to the
@@ -12120,6 +13057,7 @@ module Google
12120
13057
  @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input)
12121
13058
  @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages)
12122
13059
  @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text)
13060
+ @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
12123
13061
  @output_contexts = args[:output_contexts] if args.key?(:output_contexts)
12124
13062
  @payload = args[:payload] if args.key?(:payload)
12125
13063
  @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types)