google-apis-dialogflow_v2 0.27.0 → 0.28.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: 4b77b3d25f23a34dbc01d155d712c39ff3e3b4423fac72e4f6044baa46861c2e
4
- data.tar.gz: bac3249d659e4266a76adb8ff76a7604a3600168aca374e4672d0231ea7eba3e
3
+ metadata.gz: 1e8c57c39fbca8c94b1eab2e22aed5962b5f96a8b1c6508387221f79b3f84f87
4
+ data.tar.gz: e4d35a42bc3332cac29e7874699c9982bbb3f14490eb3b9b9f247d6a99839562
5
5
  SHA512:
6
- metadata.gz: 47c9c2acb2758b743b8e649925cc7ba85b55cafa021f2efd3e8b216974705a53139ea1cd09e618ca6cf0b1310d284d5545c43c9f1b978f9d6a4606326874572a
7
- data.tar.gz: a86484501de83e50f20bda11032fa1d7a4e339caa91148ef07db975e7bdc4abe21762f7124f7d6c1c7b458509ebcb91bfe4ff118295366c21a9396c6541ea1f6
6
+ metadata.gz: 87e59fe7313d16135f38104b6d2d4f7bebcf5c3a57fb4c3c222ea06c2c3e86ce69254ae19c624b041c9ee780d948da95692ef7786db603fba673b35822c6b042
7
+ data.tar.gz: 9b111cd27b0d80b1d284d95961fb982575a18688eb2ca06be70a861ce2faa809fd342f647c9ea23c6c9e8bd0a5a131e63237526063ccfa88c2d6d4b18a93f677
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-dialogflow_v2
2
2
 
3
+ ### v0.28.0 (2022-01-07)
4
+
5
+ * Regenerated from discovery document revision 20211231
6
+ * Unspecified changes
7
+
3
8
  ### v0.27.0 (2021-12-10)
4
9
 
5
10
  * Regenerated from discovery document revision 20211207
data/OVERVIEW.md CHANGED
@@ -51,7 +51,7 @@ require "google/apis/dialogflow_v2"
51
51
  client = Google::Apis::DialogflowV2::DialogflowService.new
52
52
 
53
53
  # Authenticate calls
54
- client.authentication = # ... use the googleauth gem to create credentials
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
55
  ```
56
56
 
57
57
  See the class reference docs for information on the methods you can call from a client.
@@ -1526,6 +1526,12 @@ module Google
1526
1526
  # @return [String]
1527
1527
  attr_accessor :current_page
1528
1528
 
1529
+ # Always present for WebhookRequest. Ignored for WebhookResponse. The display
1530
+ # name of the current page.
1531
+ # Corresponds to the JSON property `displayName`
1532
+ # @return [String]
1533
+ attr_accessor :display_name
1534
+
1529
1535
  # Represents form information.
1530
1536
  # Corresponds to the JSON property `formInfo`
1531
1537
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3PageInfoFormInfo]
@@ -1538,6 +1544,7 @@ module Google
1538
1544
  # Update properties of this object
1539
1545
  def update!(**args)
1540
1546
  @current_page = args[:current_page] if args.key?(:current_page)
1547
+ @display_name = args[:display_name] if args.key?(:display_name)
1541
1548
  @form_info = args[:form_info] if args.key?(:form_info)
1542
1549
  end
1543
1550
  end
@@ -4261,6 +4268,12 @@ module Google
4261
4268
  # @return [String]
4262
4269
  attr_accessor :current_page
4263
4270
 
4271
+ # Always present for WebhookRequest. Ignored for WebhookResponse. The display
4272
+ # name of the current page.
4273
+ # Corresponds to the JSON property `displayName`
4274
+ # @return [String]
4275
+ attr_accessor :display_name
4276
+
4264
4277
  # Represents form information.
4265
4278
  # Corresponds to the JSON property `formInfo`
4266
4279
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo]
@@ -4273,6 +4286,7 @@ module Google
4273
4286
  # Update properties of this object
4274
4287
  def update!(**args)
4275
4288
  @current_page = args[:current_page] if args.key?(:current_page)
4289
+ @display_name = args[:display_name] if args.key?(:display_name)
4276
4290
  @form_info = args[:form_info] if args.key?(:form_info)
4277
4291
  end
4278
4292
  end
@@ -7233,6 +7247,40 @@ module Google
7233
7247
  end
7234
7248
  end
7235
7249
 
7250
+ # Request message for Documents.ExportDocument.
7251
+ class GoogleCloudDialogflowV2ExportDocumentRequest
7252
+ include Google::Apis::Core::Hashable
7253
+
7254
+ # When enabled, export the full content of the document including empirical
7255
+ # probability.
7256
+ # Corresponds to the JSON property `exportFullContent`
7257
+ # @return [Boolean]
7258
+ attr_accessor :export_full_content
7259
+ alias_method :export_full_content?, :export_full_content
7260
+
7261
+ # Google Cloud Storage location for the output.
7262
+ # Corresponds to the JSON property `gcsDestination`
7263
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GcsDestination]
7264
+ attr_accessor :gcs_destination
7265
+
7266
+ # When enabled, export the smart messaging allowlist document for partial update.
7267
+ # Corresponds to the JSON property `smartMessagingPartialUpdate`
7268
+ # @return [Boolean]
7269
+ attr_accessor :smart_messaging_partial_update
7270
+ alias_method :smart_messaging_partial_update?, :smart_messaging_partial_update
7271
+
7272
+ def initialize(**args)
7273
+ update!(**args)
7274
+ end
7275
+
7276
+ # Update properties of this object
7277
+ def update!(**args)
7278
+ @export_full_content = args[:export_full_content] if args.key?(:export_full_content)
7279
+ @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
7280
+ @smart_messaging_partial_update = args[:smart_messaging_partial_update] if args.key?(:smart_messaging_partial_update)
7281
+ end
7282
+ end
7283
+
7236
7284
  # Represents answer from "frequently asked questions".
7237
7285
  class GoogleCloudDialogflowV2FaqAnswer
7238
7286
  include Google::Apis::Core::Hashable
@@ -7416,6 +7464,27 @@ module Google
7416
7464
  end
7417
7465
  end
7418
7466
 
7467
+ # Google Cloud Storage location for the output.
7468
+ class GoogleCloudDialogflowV2GcsDestination
7469
+ include Google::Apis::Core::Hashable
7470
+
7471
+ # The Google Cloud Storage URIs for the output. A URI is of the form: gs://
7472
+ # bucket/object-prefix-or-name Whether a prefix or name is used depends on the
7473
+ # use case. The requesting user must have "write-permission" to the bucket.
7474
+ # Corresponds to the JSON property `uri`
7475
+ # @return [String]
7476
+ attr_accessor :uri
7477
+
7478
+ def initialize(**args)
7479
+ update!(**args)
7480
+ end
7481
+
7482
+ # Update properties of this object
7483
+ def update!(**args)
7484
+ @uri = args[:uri] if args.key?(:uri)
7485
+ end
7486
+ end
7487
+
7419
7488
  # Defines the Human Agent Assist to connect to a conversation.
7420
7489
  class GoogleCloudDialogflowV2HumanAgentAssistantConfig
7421
7490
  include Google::Apis::Core::Hashable
@@ -7473,6 +7542,26 @@ module Google
7473
7542
  end
7474
7543
  end
7475
7544
 
7545
+ # Config to process conversation.
7546
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig
7547
+ include Google::Apis::Core::Hashable
7548
+
7549
+ # Number of recent non-small-talk sentences to use as context for article and
7550
+ # FAQ suggestion
7551
+ # Corresponds to the JSON property `recentSentencesCount`
7552
+ # @return [Fixnum]
7553
+ attr_accessor :recent_sentences_count
7554
+
7555
+ def initialize(**args)
7556
+ update!(**args)
7557
+ end
7558
+
7559
+ # Update properties of this object
7560
+ def update!(**args)
7561
+ @recent_sentences_count = args[:recent_sentences_count] if args.key?(:recent_sentences_count)
7562
+ end
7563
+ end
7564
+
7476
7565
  # Configuration for analyses to run on each conversation message.
7477
7566
  class GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig
7478
7567
  include Google::Apis::Core::Hashable
@@ -7559,6 +7648,11 @@ module Google
7559
7648
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig]
7560
7649
  attr_accessor :conversation_model_config
7561
7650
 
7651
+ # Config to process conversation.
7652
+ # Corresponds to the JSON property `conversationProcessConfig`
7653
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig]
7654
+ attr_accessor :conversation_process_config
7655
+
7562
7656
  # Automatically iterates all participants and tries to compile suggestions.
7563
7657
  # Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST.
7564
7658
  # Corresponds to the JSON property `enableEventBasedSuggestion`
@@ -7590,6 +7684,7 @@ module Google
7590
7684
  # Update properties of this object
7591
7685
  def update!(**args)
7592
7686
  @conversation_model_config = args[:conversation_model_config] if args.key?(:conversation_model_config)
7687
+ @conversation_process_config = args[:conversation_process_config] if args.key?(:conversation_process_config)
7593
7688
  @enable_event_based_suggestion = args[:enable_event_based_suggestion] if args.key?(:enable_event_based_suggestion)
7594
7689
  @query_config = args[:query_config] if args.key?(:query_config)
7595
7690
  @suggestion_feature = args[:suggestion_feature] if args.key?(:suggestion_feature)
@@ -9749,7 +9844,7 @@ module Google
9749
9844
  # @return [String]
9750
9845
  attr_accessor :content
9751
9846
 
9752
- # Output only. The time when the message was created.
9847
+ # Output only. The time when the message was created in Contact Center AI.
9753
9848
  # Corresponds to the JSON property `createTime`
9754
9849
  # @return [String]
9755
9850
  attr_accessor :create_time
@@ -9765,7 +9860,7 @@ module Google
9765
9860
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2MessageAnnotation]
9766
9861
  attr_accessor :message_annotation
9767
9862
 
9768
- # The unique identifier of the message. Format: `projects//locations//
9863
+ # Optional. The unique identifier of the message. Format: `projects//locations//
9769
9864
  # conversations//messages/`.
9770
9865
  # Corresponds to the JSON property `name`
9771
9866
  # @return [String]
@@ -9781,6 +9876,23 @@ module Google
9781
9876
  # @return [String]
9782
9877
  attr_accessor :participant_role
9783
9878
 
9879
+ # Optional. The time when the message was sent.
9880
+ # Corresponds to the JSON property `sendTime`
9881
+ # @return [String]
9882
+ attr_accessor :send_time
9883
+
9884
+ # The result of sentiment analysis. Sentiment analysis inspects user input and
9885
+ # identifies the prevailing subjective opinion, especially to determine a user's
9886
+ # attitude as positive, negative, or neutral. For Participants.DetectIntent, it
9887
+ # needs to be configured in DetectIntentRequest.query_params. For Participants.
9888
+ # StreamingDetectIntent, it needs to be configured in
9889
+ # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent
9890
+ # and Participants.StreamingAnalyzeContent, it needs to be configured in
9891
+ # ConversationProfile.human_agent_assistant_config
9892
+ # Corresponds to the JSON property `sentimentAnalysis`
9893
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisResult]
9894
+ attr_accessor :sentiment_analysis
9895
+
9784
9896
  def initialize(**args)
9785
9897
  update!(**args)
9786
9898
  end
@@ -9794,6 +9906,8 @@ module Google
9794
9906
  @name = args[:name] if args.key?(:name)
9795
9907
  @participant = args[:participant] if args.key?(:participant)
9796
9908
  @participant_role = args[:participant_role] if args.key?(:participant_role)
9909
+ @send_time = args[:send_time] if args.key?(:send_time)
9910
+ @sentiment_analysis = args[:sentiment_analysis] if args.key?(:sentiment_analysis)
9797
9911
  end
9798
9912
  end
9799
9913
 
@@ -10298,6 +10412,20 @@ module Google
10298
10412
  # @return [String]
10299
10413
  attr_accessor :content_uri
10300
10414
 
10415
+ # Optional. Whether to import custom metadata from Google Cloud Storage. Only
10416
+ # valid when the document source is Google Cloud Storage URI.
10417
+ # Corresponds to the JSON property `importGcsCustomMetadata`
10418
+ # @return [Boolean]
10419
+ attr_accessor :import_gcs_custom_metadata
10420
+ alias_method :import_gcs_custom_metadata?, :import_gcs_custom_metadata
10421
+
10422
+ # Optional. When enabled, the reload request is to apply partial update to the
10423
+ # smart messaging allowlist.
10424
+ # Corresponds to the JSON property `smartMessagingPartialUpdate`
10425
+ # @return [Boolean]
10426
+ attr_accessor :smart_messaging_partial_update
10427
+ alias_method :smart_messaging_partial_update?, :smart_messaging_partial_update
10428
+
10301
10429
  def initialize(**args)
10302
10430
  update!(**args)
10303
10431
  end
@@ -10305,6 +10433,8 @@ module Google
10305
10433
  # Update properties of this object
10306
10434
  def update!(**args)
10307
10435
  @content_uri = args[:content_uri] if args.key?(:content_uri)
10436
+ @import_gcs_custom_metadata = args[:import_gcs_custom_metadata] if args.key?(:import_gcs_custom_metadata)
10437
+ @smart_messaging_partial_update = args[:smart_messaging_partial_update] if args.key?(:smart_messaging_partial_update)
10308
10438
  end
10309
10439
  end
10310
10440
 
@@ -10480,6 +10610,40 @@ module Google
10480
10610
  end
10481
10611
  end
10482
10612
 
10613
+ # Represents a smart reply answer.
10614
+ class GoogleCloudDialogflowV2SmartReplyAnswer
10615
+ include Google::Apis::Core::Hashable
10616
+
10617
+ # The name of answer record, in the format of "projects//locations//
10618
+ # answerRecords/"
10619
+ # Corresponds to the JSON property `answerRecord`
10620
+ # @return [String]
10621
+ attr_accessor :answer_record
10622
+
10623
+ # Smart reply confidence. The system's confidence score that this reply is a
10624
+ # good match for this conversation, as a value from 0.0 (completely uncertain)
10625
+ # to 1.0 (completely certain).
10626
+ # Corresponds to the JSON property `confidence`
10627
+ # @return [Float]
10628
+ attr_accessor :confidence
10629
+
10630
+ # The content of the reply.
10631
+ # Corresponds to the JSON property `reply`
10632
+ # @return [String]
10633
+ attr_accessor :reply
10634
+
10635
+ def initialize(**args)
10636
+ update!(**args)
10637
+ end
10638
+
10639
+ # Update properties of this object
10640
+ def update!(**args)
10641
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
10642
+ @confidence = args[:confidence] if args.key?(:confidence)
10643
+ @reply = args[:reply] if args.key?(:reply)
10644
+ end
10645
+ end
10646
+
10483
10647
  # Hints for the speech recognizer to help with recognition in a specific
10484
10648
  # conversation state.
10485
10649
  class GoogleCloudDialogflowV2SpeechContext
@@ -10548,15 +10712,15 @@ module Google
10548
10712
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AssistQueryParameters]
10549
10713
  attr_accessor :assist_query_params
10550
10714
 
10551
- # Max number of messages prior to and including latest_message to use as context
10552
- # when compiling the suggestion. By default 20 and at most 50.
10715
+ # Optional. Max number of messages prior to and including latest_message to use
10716
+ # as context when compiling the suggestion. By default 20 and at most 50.
10553
10717
  # Corresponds to the JSON property `contextSize`
10554
10718
  # @return [Fixnum]
10555
10719
  attr_accessor :context_size
10556
10720
 
10557
- # The name of the latest conversation message to compile suggestion for. If
10558
- # empty, it will be the latest message of the conversation. Format: `projects//
10559
- # locations//conversations//messages/`.
10721
+ # Optional. The name of the latest conversation message to compile suggestion
10722
+ # for. If empty, it will be the latest message of the conversation. Format: `
10723
+ # projects//locations//conversations//messages/`.
10560
10724
  # Corresponds to the JSON property `latestMessage`
10561
10725
  # @return [String]
10562
10726
  attr_accessor :latest_message
@@ -10616,15 +10780,15 @@ module Google
10616
10780
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AssistQueryParameters]
10617
10781
  attr_accessor :assist_query_params
10618
10782
 
10619
- # Max number of messages prior to and including [latest_message] to use as
10620
- # context when compiling the suggestion. By default 20 and at most 50.
10783
+ # Optional. Max number of messages prior to and including [latest_message] to
10784
+ # use as context when compiling the suggestion. By default 20 and at most 50.
10621
10785
  # Corresponds to the JSON property `contextSize`
10622
10786
  # @return [Fixnum]
10623
10787
  attr_accessor :context_size
10624
10788
 
10625
- # The name of the latest conversation message to compile suggestion for. If
10626
- # empty, it will be the latest message of the conversation. Format: `projects//
10627
- # locations//conversations//messages/`.
10789
+ # Optional. The name of the latest conversation message to compile suggestion
10790
+ # for. If empty, it will be the latest message of the conversation. Format: `
10791
+ # projects//locations//conversations//messages/`.
10628
10792
  # Corresponds to the JSON property `latestMessage`
10629
10793
  # @return [String]
10630
10794
  attr_accessor :latest_message
@@ -10675,6 +10839,76 @@ module Google
10675
10839
  end
10676
10840
  end
10677
10841
 
10842
+ # The request message for Participants.SuggestSmartReplies.
10843
+ class GoogleCloudDialogflowV2SuggestSmartRepliesRequest
10844
+ include Google::Apis::Core::Hashable
10845
+
10846
+ # Max number of messages prior to and including [latest_message] to use as
10847
+ # context when compiling the suggestion. By default 20 and at most 50.
10848
+ # Corresponds to the JSON property `contextSize`
10849
+ # @return [Fixnum]
10850
+ attr_accessor :context_size
10851
+
10852
+ # Represents the natural language text to be processed.
10853
+ # Corresponds to the JSON property `currentTextInput`
10854
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput]
10855
+ attr_accessor :current_text_input
10856
+
10857
+ # The name of the latest conversation message to compile suggestion for. If
10858
+ # empty, it will be the latest message of the conversation. Format: `projects//
10859
+ # locations//conversations//messages/`.
10860
+ # Corresponds to the JSON property `latestMessage`
10861
+ # @return [String]
10862
+ attr_accessor :latest_message
10863
+
10864
+ def initialize(**args)
10865
+ update!(**args)
10866
+ end
10867
+
10868
+ # Update properties of this object
10869
+ def update!(**args)
10870
+ @context_size = args[:context_size] if args.key?(:context_size)
10871
+ @current_text_input = args[:current_text_input] if args.key?(:current_text_input)
10872
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
10873
+ end
10874
+ end
10875
+
10876
+ # The response message for Participants.SuggestSmartReplies.
10877
+ class GoogleCloudDialogflowV2SuggestSmartRepliesResponse
10878
+ include Google::Apis::Core::Hashable
10879
+
10880
+ # Number of messages prior to and including latest_message to compile the
10881
+ # suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size
10882
+ # field in the request if there aren't that many messages in the conversation.
10883
+ # Corresponds to the JSON property `contextSize`
10884
+ # @return [Fixnum]
10885
+ attr_accessor :context_size
10886
+
10887
+ # The name of the latest conversation message used to compile suggestion for.
10888
+ # Format: `projects//locations//conversations//messages/`.
10889
+ # Corresponds to the JSON property `latestMessage`
10890
+ # @return [String]
10891
+ attr_accessor :latest_message
10892
+
10893
+ # Output only. Multiple reply options provided by smart reply service. The order
10894
+ # is based on the rank of the model prediction. The maximum number of the
10895
+ # returned replies is set in SmartReplyConfig.
10896
+ # Corresponds to the JSON property `smartReplyAnswers`
10897
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SmartReplyAnswer>]
10898
+ attr_accessor :smart_reply_answers
10899
+
10900
+ def initialize(**args)
10901
+ update!(**args)
10902
+ end
10903
+
10904
+ # Update properties of this object
10905
+ def update!(**args)
10906
+ @context_size = args[:context_size] if args.key?(:context_size)
10907
+ @latest_message = args[:latest_message] if args.key?(:latest_message)
10908
+ @smart_reply_answers = args[:smart_reply_answers] if args.key?(:smart_reply_answers)
10909
+ end
10910
+ end
10911
+
10678
10912
  # The type of Human Agent Assistant API suggestion to perform, and the maximum
10679
10913
  # number of results to return for that type. Multiple `Feature` objects can be
10680
10914
  # specified in the `features` list.
@@ -10722,6 +10956,11 @@ module Google
10722
10956
  # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse]
10723
10957
  attr_accessor :suggest_faq_answers_response
10724
10958
 
10959
+ # The response message for Participants.SuggestSmartReplies.
10960
+ # Corresponds to the JSON property `suggestSmartRepliesResponse`
10961
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse]
10962
+ attr_accessor :suggest_smart_replies_response
10963
+
10725
10964
  def initialize(**args)
10726
10965
  update!(**args)
10727
10966
  end
@@ -10731,6 +10970,7 @@ module Google
10731
10970
  @error = args[:error] if args.key?(:error)
10732
10971
  @suggest_articles_response = args[:suggest_articles_response] if args.key?(:suggest_articles_response)
10733
10972
  @suggest_faq_answers_response = args[:suggest_faq_answers_response] if args.key?(:suggest_faq_answers_response)
10973
+ @suggest_smart_replies_response = args[:suggest_smart_replies_response] if args.key?(:suggest_smart_replies_response)
10734
10974
  end
10735
10975
  end
10736
10976
 
@@ -13450,6 +13690,11 @@ module Google
13450
13690
  class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata
13451
13691
  include Google::Apis::Core::Hashable
13452
13692
 
13693
+ # The name of the knowledge base interacted with during the operation.
13694
+ # Corresponds to the JSON property `knowledgeBase`
13695
+ # @return [String]
13696
+ attr_accessor :knowledge_base
13697
+
13453
13698
  # Required. Output only. The current state of this operation.
13454
13699
  # Corresponds to the JSON property `state`
13455
13700
  # @return [String]
@@ -13461,6 +13706,7 @@ module Google
13461
13706
 
13462
13707
  # Update properties of this object
13463
13708
  def update!(**args)
13709
+ @knowledge_base = args[:knowledge_base] if args.key?(:knowledge_base)
13464
13710
  @state = args[:state] if args.key?(:state)
13465
13711
  end
13466
13712
  end
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DialogflowV2
18
18
  # Version of the google-apis-dialogflow_v2 gem
19
- GEM_VERSION = "0.27.0"
19
+ GEM_VERSION = "0.28.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211207"
25
+ REVISION = "20211231"
26
26
  end
27
27
  end
28
28
  end
@@ -1216,6 +1216,12 @@ module Google
1216
1216
  include Google::Apis::Core::JsonObjectSupport
1217
1217
  end
1218
1218
 
1219
+ class GoogleCloudDialogflowV2ExportDocumentRequest
1220
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1221
+
1222
+ include Google::Apis::Core::JsonObjectSupport
1223
+ end
1224
+
1219
1225
  class GoogleCloudDialogflowV2FaqAnswer
1220
1226
  class Representation < Google::Apis::Core::JsonRepresentation; end
1221
1227
 
@@ -1240,6 +1246,12 @@ module Google
1240
1246
  include Google::Apis::Core::JsonObjectSupport
1241
1247
  end
1242
1248
 
1249
+ class GoogleCloudDialogflowV2GcsDestination
1250
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1251
+
1252
+ include Google::Apis::Core::JsonObjectSupport
1253
+ end
1254
+
1243
1255
  class GoogleCloudDialogflowV2HumanAgentAssistantConfig
1244
1256
  class Representation < Google::Apis::Core::JsonRepresentation; end
1245
1257
 
@@ -1252,6 +1264,12 @@ module Google
1252
1264
  include Google::Apis::Core::JsonObjectSupport
1253
1265
  end
1254
1266
 
1267
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig
1268
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1269
+
1270
+ include Google::Apis::Core::JsonObjectSupport
1271
+ end
1272
+
1255
1273
  class GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig
1256
1274
  class Representation < Google::Apis::Core::JsonRepresentation; end
1257
1275
 
@@ -1744,6 +1762,12 @@ module Google
1744
1762
  include Google::Apis::Core::JsonObjectSupport
1745
1763
  end
1746
1764
 
1765
+ class GoogleCloudDialogflowV2SmartReplyAnswer
1766
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1767
+
1768
+ include Google::Apis::Core::JsonObjectSupport
1769
+ end
1770
+
1747
1771
  class GoogleCloudDialogflowV2SpeechContext
1748
1772
  class Representation < Google::Apis::Core::JsonRepresentation; end
1749
1773
 
@@ -1780,6 +1804,18 @@ module Google
1780
1804
  include Google::Apis::Core::JsonObjectSupport
1781
1805
  end
1782
1806
 
1807
+ class GoogleCloudDialogflowV2SuggestSmartRepliesRequest
1808
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1809
+
1810
+ include Google::Apis::Core::JsonObjectSupport
1811
+ end
1812
+
1813
+ class GoogleCloudDialogflowV2SuggestSmartRepliesResponse
1814
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1815
+
1816
+ include Google::Apis::Core::JsonObjectSupport
1817
+ end
1818
+
1783
1819
  class GoogleCloudDialogflowV2SuggestionFeature
1784
1820
  class Representation < Google::Apis::Core::JsonRepresentation; end
1785
1821
 
@@ -2811,6 +2847,7 @@ module Google
2811
2847
  # @private
2812
2848
  class Representation < Google::Apis::Core::JsonRepresentation
2813
2849
  property :current_page, as: 'currentPage'
2850
+ property :display_name, as: 'displayName'
2814
2851
  property :form_info, as: 'formInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3PageInfoFormInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3PageInfoFormInfo::Representation
2815
2852
 
2816
2853
  end
@@ -3579,6 +3616,7 @@ module Google
3579
3616
  # @private
3580
3617
  class Representation < Google::Apis::Core::JsonRepresentation
3581
3618
  property :current_page, as: 'currentPage'
3619
+ property :display_name, as: 'displayName'
3582
3620
  property :form_info, as: 'formInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo::Representation
3583
3621
 
3584
3622
  end
@@ -4379,6 +4417,16 @@ module Google
4379
4417
  end
4380
4418
  end
4381
4419
 
4420
+ class GoogleCloudDialogflowV2ExportDocumentRequest
4421
+ # @private
4422
+ class Representation < Google::Apis::Core::JsonRepresentation
4423
+ property :export_full_content, as: 'exportFullContent'
4424
+ property :gcs_destination, as: 'gcsDestination', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GcsDestination, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GcsDestination::Representation
4425
+
4426
+ property :smart_messaging_partial_update, as: 'smartMessagingPartialUpdate'
4427
+ end
4428
+ end
4429
+
4382
4430
  class GoogleCloudDialogflowV2FaqAnswer
4383
4431
  # @private
4384
4432
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4422,6 +4470,13 @@ module Google
4422
4470
  end
4423
4471
  end
4424
4472
 
4473
+ class GoogleCloudDialogflowV2GcsDestination
4474
+ # @private
4475
+ class Representation < Google::Apis::Core::JsonRepresentation
4476
+ property :uri, as: 'uri'
4477
+ end
4478
+ end
4479
+
4425
4480
  class GoogleCloudDialogflowV2HumanAgentAssistantConfig
4426
4481
  # @private
4427
4482
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4443,6 +4498,13 @@ module Google
4443
4498
  end
4444
4499
  end
4445
4500
 
4501
+ class GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig
4502
+ # @private
4503
+ class Representation < Google::Apis::Core::JsonRepresentation
4504
+ property :recent_sentences_count, as: 'recentSentencesCount'
4505
+ end
4506
+ end
4507
+
4446
4508
  class GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig
4447
4509
  # @private
4448
4510
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4465,6 +4527,8 @@ module Google
4465
4527
  class Representation < Google::Apis::Core::JsonRepresentation
4466
4528
  property :conversation_model_config, as: 'conversationModelConfig', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig::Representation
4467
4529
 
4530
+ property :conversation_process_config, as: 'conversationProcessConfig', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig::Representation
4531
+
4468
4532
  property :enable_event_based_suggestion, as: 'enableEventBasedSuggestion'
4469
4533
  property :query_config, as: 'queryConfig', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig::Representation
4470
4534
 
@@ -5111,6 +5175,9 @@ module Google
5111
5175
  property :name, as: 'name'
5112
5176
  property :participant, as: 'participant'
5113
5177
  property :participant_role, as: 'participantRole'
5178
+ property :send_time, as: 'sendTime'
5179
+ property :sentiment_analysis, as: 'sentimentAnalysis', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisResult, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisResult::Representation
5180
+
5114
5181
  end
5115
5182
  end
5116
5183
 
@@ -5229,6 +5296,8 @@ module Google
5229
5296
  # @private
5230
5297
  class Representation < Google::Apis::Core::JsonRepresentation
5231
5298
  property :content_uri, as: 'contentUri'
5299
+ property :import_gcs_custom_metadata, as: 'importGcsCustomMetadata'
5300
+ property :smart_messaging_partial_update, as: 'smartMessagingPartialUpdate'
5232
5301
  end
5233
5302
  end
5234
5303
 
@@ -5282,6 +5351,15 @@ module Google
5282
5351
  end
5283
5352
  end
5284
5353
 
5354
+ class GoogleCloudDialogflowV2SmartReplyAnswer
5355
+ # @private
5356
+ class Representation < Google::Apis::Core::JsonRepresentation
5357
+ property :answer_record, as: 'answerRecord'
5358
+ property :confidence, as: 'confidence'
5359
+ property :reply, as: 'reply'
5360
+ end
5361
+ end
5362
+
5285
5363
  class GoogleCloudDialogflowV2SpeechContext
5286
5364
  # @private
5287
5365
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5337,6 +5415,26 @@ module Google
5337
5415
  end
5338
5416
  end
5339
5417
 
5418
+ class GoogleCloudDialogflowV2SuggestSmartRepliesRequest
5419
+ # @private
5420
+ class Representation < Google::Apis::Core::JsonRepresentation
5421
+ property :context_size, as: 'contextSize'
5422
+ property :current_text_input, as: 'currentTextInput', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput::Representation
5423
+
5424
+ property :latest_message, as: 'latestMessage'
5425
+ end
5426
+ end
5427
+
5428
+ class GoogleCloudDialogflowV2SuggestSmartRepliesResponse
5429
+ # @private
5430
+ class Representation < Google::Apis::Core::JsonRepresentation
5431
+ property :context_size, as: 'contextSize'
5432
+ property :latest_message, as: 'latestMessage'
5433
+ collection :smart_reply_answers, as: 'smartReplyAnswers', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SmartReplyAnswer, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SmartReplyAnswer::Representation
5434
+
5435
+ end
5436
+ end
5437
+
5340
5438
  class GoogleCloudDialogflowV2SuggestionFeature
5341
5439
  # @private
5342
5440
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5353,6 +5451,8 @@ module Google
5353
5451
 
5354
5452
  property :suggest_faq_answers_response, as: 'suggestFaqAnswersResponse', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse::Representation
5355
5453
 
5454
+ property :suggest_smart_replies_response, as: 'suggestSmartRepliesResponse', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse::Representation
5455
+
5356
5456
  end
5357
5457
  end
5358
5458
 
@@ -6102,6 +6202,7 @@ module Google
6102
6202
  class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata
6103
6203
  # @private
6104
6204
  class Representation < Google::Apis::Core::JsonRepresentation
6205
+ property :knowledge_base, as: 'knowledgeBase'
6105
6206
  property :state, as: 'state'
6106
6207
  end
6107
6208
  end
@@ -2033,6 +2033,19 @@ module Google
2033
2033
  # @param [String] parent
2034
2034
  # Required. The project to list of knowledge bases for. Format: `projects//
2035
2035
  # locations/`.
2036
+ # @param [String] filter
2037
+ # The filter expression used to filter knowledge bases returned by the list
2038
+ # method. The expression has the following syntax: [AND ] ... The following
2039
+ # fields and operators are supported: * display_name with has(:) operator *
2040
+ # language_code with equals(=) operator Examples: * 'language_code=en-us'
2041
+ # matches knowledge bases with en-us language code. * 'display_name:articles'
2042
+ # matches knowledge bases whose display name contains "articles". * '
2043
+ # display_name:"Best Articles"' matches knowledge bases whose display name
2044
+ # contains "Best Articles". * 'language_code=en-gb AND display_name=articles'
2045
+ # matches all knowledge bases whose display name contains "articles" and whose
2046
+ # language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op
2047
+ # and will result in no filtering. For more information about filtering, see [
2048
+ # API Filtering](https://aip.dev/160).
2036
2049
  # @param [Fixnum] page_size
2037
2050
  # The maximum number of items to return in a single page. By default 10 and at
2038
2051
  # most 100.
@@ -2055,11 +2068,12 @@ module Google
2055
2068
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2056
2069
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2057
2070
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2058
- def list_project_agent_knowledge_bases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2071
+ def list_project_agent_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2059
2072
  command = make_simple_command(:get, 'v2/{+parent}/knowledgeBases', options)
2060
2073
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse::Representation
2061
2074
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse
2062
2075
  command.params['parent'] = parent unless parent.nil?
2076
+ command.query['filter'] = filter unless filter.nil?
2063
2077
  command.query['pageSize'] = page_size unless page_size.nil?
2064
2078
  command.query['pageToken'] = page_token unless page_token.nil?
2065
2079
  command.query['fields'] = fields unless fields.nil?
@@ -2213,6 +2227,16 @@ module Google
2213
2227
  # @param [String] parent
2214
2228
  # Required. The knowledge base to list all documents for. Format: `projects//
2215
2229
  # locations//knowledgeBases/`.
2230
+ # @param [String] filter
2231
+ # The filter expression used to filter documents returned by the list method.
2232
+ # The expression has the following syntax: [AND ] ... The following fields and
2233
+ # operators are supported: * knowledge_types with has(:) operator * display_name
2234
+ # with has(:) operator * state with equals(=) operator Examples: * "
2235
+ # knowledge_types:FAQ" matches documents with FAQ knowledge type. * "
2236
+ # display_name:customer" matches documents whose display name contains "customer"
2237
+ # . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ
2238
+ # AND state=ACTIVE" matches all active FAQ documents. For more information about
2239
+ # filtering, see [API Filtering](https://aip.dev/160).
2216
2240
  # @param [Fixnum] page_size
2217
2241
  # The maximum number of items to return in a single page. By default 10 and at
2218
2242
  # most 100.
@@ -2235,11 +2259,12 @@ module Google
2235
2259
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2236
2260
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2237
2261
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2238
- def list_project_agent_knowledge_basis_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2262
+ def list_project_agent_knowledge_basis_documents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2239
2263
  command = make_simple_command(:get, 'v2/{+parent}/documents', options)
2240
2264
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse::Representation
2241
2265
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse
2242
2266
  command.params['parent'] = parent unless parent.nil?
2267
+ command.query['filter'] = filter unless filter.nil?
2243
2268
  command.query['pageSize'] = page_size unless page_size.nil?
2244
2269
  command.query['pageToken'] = page_token unless page_token.nil?
2245
2270
  command.query['fields'] = fields unless fields.nil?
@@ -3693,6 +3718,40 @@ module Google
3693
3718
  execute_or_queue_command(command, &block)
3694
3719
  end
3695
3720
 
3721
+ # Gets smart replies for a participant based on specific historical messages.
3722
+ # @param [String] parent
3723
+ # Required. The name of the participant to fetch suggestion for. Format: `
3724
+ # projects//locations//conversations//participants/`.
3725
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest] google_cloud_dialogflow_v2_suggest_smart_replies_request_object
3726
+ # @param [String] fields
3727
+ # Selector specifying which fields to include in a partial response.
3728
+ # @param [String] quota_user
3729
+ # Available to use for quota purposes for server-side applications. Can be any
3730
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3731
+ # @param [Google::Apis::RequestOptions] options
3732
+ # Request-specific options
3733
+ #
3734
+ # @yield [result, err] Result & error if block supplied
3735
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse] parsed result object
3736
+ # @yieldparam err [StandardError] error object if request failed
3737
+ #
3738
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse]
3739
+ #
3740
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3741
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3742
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3743
+ def suggest_project_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3744
+ command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestSmartReplies', options)
3745
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest::Representation
3746
+ command.request_object = google_cloud_dialogflow_v2_suggest_smart_replies_request_object
3747
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse::Representation
3748
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse
3749
+ command.params['parent'] = parent unless parent.nil?
3750
+ command.query['fields'] = fields unless fields.nil?
3751
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3752
+ execute_or_queue_command(command, &block)
3753
+ end
3754
+
3696
3755
  # Creates a knowledge base.
3697
3756
  # @param [String] parent
3698
3757
  # Required. The project to create a knowledge base for. Format: `projects//
@@ -3797,6 +3856,19 @@ module Google
3797
3856
  # @param [String] parent
3798
3857
  # Required. The project to list of knowledge bases for. Format: `projects//
3799
3858
  # locations/`.
3859
+ # @param [String] filter
3860
+ # The filter expression used to filter knowledge bases returned by the list
3861
+ # method. The expression has the following syntax: [AND ] ... The following
3862
+ # fields and operators are supported: * display_name with has(:) operator *
3863
+ # language_code with equals(=) operator Examples: * 'language_code=en-us'
3864
+ # matches knowledge bases with en-us language code. * 'display_name:articles'
3865
+ # matches knowledge bases whose display name contains "articles". * '
3866
+ # display_name:"Best Articles"' matches knowledge bases whose display name
3867
+ # contains "Best Articles". * 'language_code=en-gb AND display_name=articles'
3868
+ # matches all knowledge bases whose display name contains "articles" and whose
3869
+ # language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op
3870
+ # and will result in no filtering. For more information about filtering, see [
3871
+ # API Filtering](https://aip.dev/160).
3800
3872
  # @param [Fixnum] page_size
3801
3873
  # The maximum number of items to return in a single page. By default 10 and at
3802
3874
  # most 100.
@@ -3819,11 +3891,12 @@ module Google
3819
3891
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3820
3892
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3821
3893
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3822
- def list_project_knowledge_bases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3894
+ def list_project_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3823
3895
  command = make_simple_command(:get, 'v2/{+parent}/knowledgeBases', options)
3824
3896
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse::Representation
3825
3897
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse
3826
3898
  command.params['parent'] = parent unless parent.nil?
3899
+ command.query['filter'] = filter unless filter.nil?
3827
3900
  command.query['pageSize'] = page_size unless page_size.nil?
3828
3901
  command.query['pageToken'] = page_token unless page_token.nil?
3829
3902
  command.query['fields'] = fields unless fields.nil?
@@ -3942,6 +4015,44 @@ module Google
3942
4015
  execute_or_queue_command(command, &block)
3943
4016
  end
3944
4017
 
4018
+ # Exports a smart messaging candidate document into the specified destination.
4019
+ # This method is a [long-running operation](https://cloud.google.com/dialogflow/
4020
+ # cx/docs/how/long-running-operation). The returned `Operation` type has the
4021
+ # following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `
4022
+ # response`: Document
4023
+ # @param [String] name
4024
+ # Required. The name of the document to export. Format: `projects//locations//
4025
+ # knowledgeBases//documents/`.
4026
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest] google_cloud_dialogflow_v2_export_document_request_object
4027
+ # @param [String] fields
4028
+ # Selector specifying which fields to include in a partial response.
4029
+ # @param [String] quota_user
4030
+ # Available to use for quota purposes for server-side applications. Can be any
4031
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4032
+ # @param [Google::Apis::RequestOptions] options
4033
+ # Request-specific options
4034
+ #
4035
+ # @yield [result, err] Result & error if block supplied
4036
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
4037
+ # @yieldparam err [StandardError] error object if request failed
4038
+ #
4039
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
4040
+ #
4041
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4042
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4043
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4044
+ def export_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_export_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4045
+ command = make_simple_command(:post, 'v2/{+name}:export', options)
4046
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest::Representation
4047
+ command.request_object = google_cloud_dialogflow_v2_export_document_request_object
4048
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
4049
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
4050
+ command.params['name'] = name unless name.nil?
4051
+ command.query['fields'] = fields unless fields.nil?
4052
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4053
+ execute_or_queue_command(command, &block)
4054
+ end
4055
+
3945
4056
  # Retrieves the specified document.
3946
4057
  # @param [String] name
3947
4058
  # Required. The name of the document to retrieve. Format `projects//locations//
@@ -3977,6 +4088,16 @@ module Google
3977
4088
  # @param [String] parent
3978
4089
  # Required. The knowledge base to list all documents for. Format: `projects//
3979
4090
  # locations//knowledgeBases/`.
4091
+ # @param [String] filter
4092
+ # The filter expression used to filter documents returned by the list method.
4093
+ # The expression has the following syntax: [AND ] ... The following fields and
4094
+ # operators are supported: * knowledge_types with has(:) operator * display_name
4095
+ # with has(:) operator * state with equals(=) operator Examples: * "
4096
+ # knowledge_types:FAQ" matches documents with FAQ knowledge type. * "
4097
+ # display_name:customer" matches documents whose display name contains "customer"
4098
+ # . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ
4099
+ # AND state=ACTIVE" matches all active FAQ documents. For more information about
4100
+ # filtering, see [API Filtering](https://aip.dev/160).
3980
4101
  # @param [Fixnum] page_size
3981
4102
  # The maximum number of items to return in a single page. By default 10 and at
3982
4103
  # most 100.
@@ -3999,11 +4120,12 @@ module Google
3999
4120
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4000
4121
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4001
4122
  # @raise [Google::Apis::AuthorizationError] Authorization is required
4002
- def list_project_knowledge_basis_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4123
+ def list_project_knowledge_basis_documents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4003
4124
  command = make_simple_command(:get, 'v2/{+parent}/documents', options)
4004
4125
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse::Representation
4005
4126
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse
4006
4127
  command.params['parent'] = parent unless parent.nil?
4128
+ command.query['filter'] = filter unless filter.nil?
4007
4129
  command.query['pageSize'] = page_size unless page_size.nil?
4008
4130
  command.query['pageToken'] = page_token unless page_token.nil?
4009
4131
  command.query['fields'] = fields unless fields.nil?
@@ -7409,6 +7531,40 @@ module Google
7409
7531
  execute_or_queue_command(command, &block)
7410
7532
  end
7411
7533
 
7534
+ # Gets smart replies for a participant based on specific historical messages.
7535
+ # @param [String] parent
7536
+ # Required. The name of the participant to fetch suggestion for. Format: `
7537
+ # projects//locations//conversations//participants/`.
7538
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest] google_cloud_dialogflow_v2_suggest_smart_replies_request_object
7539
+ # @param [String] fields
7540
+ # Selector specifying which fields to include in a partial response.
7541
+ # @param [String] quota_user
7542
+ # Available to use for quota purposes for server-side applications. Can be any
7543
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7544
+ # @param [Google::Apis::RequestOptions] options
7545
+ # Request-specific options
7546
+ #
7547
+ # @yield [result, err] Result & error if block supplied
7548
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse] parsed result object
7549
+ # @yieldparam err [StandardError] error object if request failed
7550
+ #
7551
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse]
7552
+ #
7553
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7554
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7555
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7556
+ def suggest_project_location_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7557
+ command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestSmartReplies', options)
7558
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest::Representation
7559
+ command.request_object = google_cloud_dialogflow_v2_suggest_smart_replies_request_object
7560
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse::Representation
7561
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse
7562
+ command.params['parent'] = parent unless parent.nil?
7563
+ command.query['fields'] = fields unless fields.nil?
7564
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7565
+ execute_or_queue_command(command, &block)
7566
+ end
7567
+
7412
7568
  # Creates a knowledge base.
7413
7569
  # @param [String] parent
7414
7570
  # Required. The project to create a knowledge base for. Format: `projects//
@@ -7513,6 +7669,19 @@ module Google
7513
7669
  # @param [String] parent
7514
7670
  # Required. The project to list of knowledge bases for. Format: `projects//
7515
7671
  # locations/`.
7672
+ # @param [String] filter
7673
+ # The filter expression used to filter knowledge bases returned by the list
7674
+ # method. The expression has the following syntax: [AND ] ... The following
7675
+ # fields and operators are supported: * display_name with has(:) operator *
7676
+ # language_code with equals(=) operator Examples: * 'language_code=en-us'
7677
+ # matches knowledge bases with en-us language code. * 'display_name:articles'
7678
+ # matches knowledge bases whose display name contains "articles". * '
7679
+ # display_name:"Best Articles"' matches knowledge bases whose display name
7680
+ # contains "Best Articles". * 'language_code=en-gb AND display_name=articles'
7681
+ # matches all knowledge bases whose display name contains "articles" and whose
7682
+ # language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op
7683
+ # and will result in no filtering. For more information about filtering, see [
7684
+ # API Filtering](https://aip.dev/160).
7516
7685
  # @param [Fixnum] page_size
7517
7686
  # The maximum number of items to return in a single page. By default 10 and at
7518
7687
  # most 100.
@@ -7535,11 +7704,12 @@ module Google
7535
7704
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7536
7705
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7537
7706
  # @raise [Google::Apis::AuthorizationError] Authorization is required
7538
- def list_project_location_knowledge_bases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7707
+ def list_project_location_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7539
7708
  command = make_simple_command(:get, 'v2/{+parent}/knowledgeBases', options)
7540
7709
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse::Representation
7541
7710
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse
7542
7711
  command.params['parent'] = parent unless parent.nil?
7712
+ command.query['filter'] = filter unless filter.nil?
7543
7713
  command.query['pageSize'] = page_size unless page_size.nil?
7544
7714
  command.query['pageToken'] = page_token unless page_token.nil?
7545
7715
  command.query['fields'] = fields unless fields.nil?
@@ -7658,6 +7828,44 @@ module Google
7658
7828
  execute_or_queue_command(command, &block)
7659
7829
  end
7660
7830
 
7831
+ # Exports a smart messaging candidate document into the specified destination.
7832
+ # This method is a [long-running operation](https://cloud.google.com/dialogflow/
7833
+ # cx/docs/how/long-running-operation). The returned `Operation` type has the
7834
+ # following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `
7835
+ # response`: Document
7836
+ # @param [String] name
7837
+ # Required. The name of the document to export. Format: `projects//locations//
7838
+ # knowledgeBases//documents/`.
7839
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest] google_cloud_dialogflow_v2_export_document_request_object
7840
+ # @param [String] fields
7841
+ # Selector specifying which fields to include in a partial response.
7842
+ # @param [String] quota_user
7843
+ # Available to use for quota purposes for server-side applications. Can be any
7844
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7845
+ # @param [Google::Apis::RequestOptions] options
7846
+ # Request-specific options
7847
+ #
7848
+ # @yield [result, err] Result & error if block supplied
7849
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
7850
+ # @yieldparam err [StandardError] error object if request failed
7851
+ #
7852
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
7853
+ #
7854
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7855
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7856
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7857
+ def export_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_export_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7858
+ command = make_simple_command(:post, 'v2/{+name}:export', options)
7859
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest::Representation
7860
+ command.request_object = google_cloud_dialogflow_v2_export_document_request_object
7861
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
7862
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
7863
+ command.params['name'] = name unless name.nil?
7864
+ command.query['fields'] = fields unless fields.nil?
7865
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7866
+ execute_or_queue_command(command, &block)
7867
+ end
7868
+
7661
7869
  # Retrieves the specified document.
7662
7870
  # @param [String] name
7663
7871
  # Required. The name of the document to retrieve. Format `projects//locations//
@@ -7693,6 +7901,16 @@ module Google
7693
7901
  # @param [String] parent
7694
7902
  # Required. The knowledge base to list all documents for. Format: `projects//
7695
7903
  # locations//knowledgeBases/`.
7904
+ # @param [String] filter
7905
+ # The filter expression used to filter documents returned by the list method.
7906
+ # The expression has the following syntax: [AND ] ... The following fields and
7907
+ # operators are supported: * knowledge_types with has(:) operator * display_name
7908
+ # with has(:) operator * state with equals(=) operator Examples: * "
7909
+ # knowledge_types:FAQ" matches documents with FAQ knowledge type. * "
7910
+ # display_name:customer" matches documents whose display name contains "customer"
7911
+ # . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ
7912
+ # AND state=ACTIVE" matches all active FAQ documents. For more information about
7913
+ # filtering, see [API Filtering](https://aip.dev/160).
7696
7914
  # @param [Fixnum] page_size
7697
7915
  # The maximum number of items to return in a single page. By default 10 and at
7698
7916
  # most 100.
@@ -7715,11 +7933,12 @@ module Google
7715
7933
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7716
7934
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7717
7935
  # @raise [Google::Apis::AuthorizationError] Authorization is required
7718
- def list_project_location_knowledge_basis_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7936
+ def list_project_location_knowledge_basis_documents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7719
7937
  command = make_simple_command(:get, 'v2/{+parent}/documents', options)
7720
7938
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse::Representation
7721
7939
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse
7722
7940
  command.params['parent'] = parent unless parent.nil?
7941
+ command.query['filter'] = filter unless filter.nil?
7723
7942
  command.query['pageSize'] = page_size unless page_size.nil?
7724
7943
  command.query['pageToken'] = page_token unless page_token.nil?
7725
7944
  command.query['fields'] = fields unless fields.nil?
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dialogflow_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.27.0
4
+ version: 0.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-12-13 00:00:00.000000000 Z
11
+ date: 2022-01-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v2/v0.27.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v2/v0.28.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v2
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.4
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Dialogflow API V2