google-apis-dialogflow_v3 0.6.0 → 0.7.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: 8eecd5e50d63d681712176d34efedb26fc11e056695bdc3c5c0bb601b9ff53b6
4
- data.tar.gz: 9fcbadc4e0e6f7a9fa7cb76aafdac67f9475f3023265ff3d1967752691f3b36f
3
+ metadata.gz: 9f17729e096ae7a4bde7b20a35b9413b4723678ae3f4ce32b93c471af02977f5
4
+ data.tar.gz: 9ce6c6d80cdde8791c6b4a1d3a1f3b78d0145c478ca909b478372051f0807b41
5
5
  SHA512:
6
- metadata.gz: df0aac21fb4d1270dfcdacdce4ef0738a7f3662acc5257df3bf3ff133ef296b8d3118c4e8ad6c0f2c3c963f132fa353bbe57bd64258916cb8fdb3c52d143ea4d
7
- data.tar.gz: eb9b3c0e5ff5db4c48cd4bba65993994348bf3322bdf954d1fd0c543c53ad0006306e1f159bcc3d64aba004b93e70d1fe4e3cd944a184f771dd7f7fd27a59902
6
+ metadata.gz: 2f9b7092251ff03e3e076ce51812a1572a51d36843e5370cf2e09b0854b83160b4ec26108b57a34f09f999671ec9d762250ec11a61546382ffad69c7a0d14920
7
+ data.tar.gz: fc646fc7b255582cff65910c9357416a5646010bec63459456de5ce1b9bf2d06f3a90534ffbbda96d69c82742cacecb5459081b6af20c754bf30d27bd01a803f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-dialogflow_v3
2
2
 
3
+ ### v0.7.0 (2021-03-09)
4
+
5
+ * Regenerated from discovery document revision 20210307
6
+ * Regenerated using generator version 0.2.0
7
+
3
8
  ### v0.6.0 (2021-03-04)
4
9
 
5
10
  * Unspecified changes
@@ -920,7 +920,9 @@ module Google
920
920
  # @return [String]
921
921
  attr_accessor :end_time
922
922
 
923
- # 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.
924
926
  # Corresponds to the JSON property `experimentLength`
925
927
  # @return [String]
926
928
  attr_accessor :experiment_length
@@ -3742,6 +3744,11 @@ module Google
3742
3744
  # @return [String]
3743
3745
  attr_accessor :agent_uri
3744
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
+
3745
3752
  def initialize(**args)
3746
3753
  update!(**args)
3747
3754
  end
@@ -3750,6 +3757,7 @@ module Google
3750
3757
  def update!(**args)
3751
3758
  @agent_content = args[:agent_content] if args.key?(:agent_content)
3752
3759
  @agent_uri = args[:agent_uri] if args.key?(:agent_uri)
3760
+ @restore_option = args[:restore_option] if args.key?(:restore_option)
3753
3761
  end
3754
3762
  end
3755
3763
 
@@ -7675,6 +7683,59 @@ module Google
7675
7683
  end
7676
7684
  end
7677
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
+
7678
7739
  # The response message for EntityTypes.BatchUpdateEntityTypes.
7679
7740
  class GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse
7680
7741
  include Google::Apis::Core::Hashable
@@ -7982,6 +8043,94 @@ module Google
7982
8043
  end
7983
8044
  end
7984
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
+
7985
8134
  # An intent categorizes an end-user's intention for one conversation turn. For
7986
8135
  # each agent, you define many intents, where your combined intents can handle a
7987
8136
  # complete conversation. When an end-user writes or says something, referred to
@@ -8009,6 +8158,14 @@ module Google
8009
8158
  # @return [String]
8010
8159
  attr_accessor :display_name
8011
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
+
8012
8169
  # Optional. The collection of event names that trigger the intent. If the
8013
8170
  # collection of input contexts is not empty, all of the contexts must be present
8014
8171
  # in the active user session for an event to trigger this intent. Event names
@@ -8035,6 +8192,14 @@ module Google
8035
8192
  attr_accessor :is_fallback
8036
8193
  alias_method :is_fallback?, :is_fallback
8037
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
+
8038
8203
  # Optional. The collection of rich messages corresponding to the `Response`
8039
8204
  # field in the Dialogflow console.
8040
8205
  # Corresponds to the JSON property `messages`
@@ -8121,10 +8286,12 @@ module Google
8121
8286
  @action = args[:action] if args.key?(:action)
8122
8287
  @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms)
8123
8288
  @display_name = args[:display_name] if args.key?(:display_name)
8289
+ @end_interaction = args[:end_interaction] if args.key?(:end_interaction)
8124
8290
  @events = args[:events] if args.key?(:events)
8125
8291
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
8126
8292
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
8127
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)
8128
8295
  @messages = args[:messages] if args.key?(:messages)
8129
8296
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
8130
8297
  @name = args[:name] if args.key?(:name)
@@ -9213,6 +9380,25 @@ module Google
9213
9380
  end
9214
9381
  end
9215
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
+
9216
9402
  # Represents a message posted into a conversation.
9217
9403
  class GoogleCloudDialogflowV2Message
9218
9404
  include Google::Apis::Core::Hashable
@@ -9589,6 +9775,112 @@ module Google
9589
9775
  end
9590
9776
  end
9591
9777
 
9778
+ # The response message for Participants.SuggestArticles.
9779
+ class GoogleCloudDialogflowV2SuggestArticlesResponse
9780
+ include Google::Apis::Core::Hashable
9781
+
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
9786
+
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
9793
+
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`
9797
+ # @return [String]
9798
+ attr_accessor :latest_message
9799
+
9800
+ def initialize(**args)
9801
+ update!(**args)
9802
+ end
9803
+
9804
+ # Update properties of this object
9805
+ def update!(**args)
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)
9809
+ end
9810
+ end
9811
+
9812
+ # The request message for Participants.SuggestFaqAnswers.
9813
+ class GoogleCloudDialogflowV2SuggestFaqAnswersResponse
9814
+ include Google::Apis::Core::Hashable
9815
+
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
9822
+
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
+
9592
9884
  # The request message for a webhook call.
9593
9885
  class GoogleCloudDialogflowV2WebhookRequest
9594
9886
  include Google::Apis::Core::Hashable
@@ -9715,6 +10007,89 @@ module Google
9715
10007
  end
9716
10008
  end
9717
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
+
9718
10093
  # The response message for EntityTypes.BatchUpdateEntityTypes.
9719
10094
  class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse
9720
10095
  include Google::Apis::Core::Hashable
@@ -9815,19 +10190,63 @@ module Google
9815
10190
  end
9816
10191
  end
9817
10192
 
9818
- # Each intent parameter has a type, called the entity type, which dictates
9819
- # exactly how data from an end-user expression is extracted. Dialogflow provides
9820
- # predefined system entities that can match many common types of data. For
9821
- # example, there are system entities for matching dates, times, colors, email
9822
- # addresses, and so on. You can also create your own custom entities for
9823
- # matching custom data. For example, you could define a vegetable entity that
9824
- # can match the types of vegetables available for purchase with a grocery store
9825
- # agent. For more information, see the [Entity guide](https://cloud.google.com/
9826
- # dialogflow/docs/entities-overview).
9827
- class GoogleCloudDialogflowV2beta1EntityType
10193
+ # Represents a notification sent to Pub/Sub subscribers for conversation
10194
+ # lifecycle events.
10195
+ class GoogleCloudDialogflowV2beta1ConversationEvent
9828
10196
  include Google::Apis::Core::Hashable
9829
10197
 
9830
- # Optional. Indicates whether the entity type can be automatically expanded.
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
+
10237
+ # Each intent parameter has a type, called the entity type, which dictates
10238
+ # exactly how data from an end-user expression is extracted. Dialogflow provides
10239
+ # predefined system entities that can match many common types of data. For
10240
+ # example, there are system entities for matching dates, times, colors, email
10241
+ # addresses, and so on. You can also create your own custom entities for
10242
+ # matching custom data. For example, you could define a vegetable entity that
10243
+ # can match the types of vegetables available for purchase with a grocery store
10244
+ # agent. For more information, see the [Entity guide](https://cloud.google.com/
10245
+ # dialogflow/docs/entities-overview).
10246
+ class GoogleCloudDialogflowV2beta1EntityType
10247
+ include Google::Apis::Core::Hashable
10248
+
10249
+ # Optional. Indicates whether the entity type can be automatically expanded.
9831
10250
  # Corresponds to the JSON property `autoExpansionMode`
9832
10251
  # @return [String]
9833
10252
  attr_accessor :auto_expansion_mode
@@ -9980,6 +10399,117 @@ module Google
9980
10399
  end
9981
10400
  end
9982
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
+
9983
10513
  # An intent categorizes an end-user's intention for one conversation turn. For
9984
10514
  # each agent, you define many intents, where your combined intents can handle a
9985
10515
  # complete conversation. When an end-user writes or says something, referred to
@@ -10042,6 +10572,14 @@ module Google
10042
10572
  attr_accessor :is_fallback
10043
10573
  alias_method :is_fallback?, :is_fallback
10044
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
+
10045
10583
  # Optional. The collection of rich messages corresponding to the `Response`
10046
10584
  # field in the Dialogflow console.
10047
10585
  # Corresponds to the JSON property `messages`
@@ -10146,6 +10684,7 @@ module Google
10146
10684
  @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info)
10147
10685
  @input_context_names = args[:input_context_names] if args.key?(:input_context_names)
10148
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)
10149
10688
  @messages = args[:messages] if args.key?(:messages)
10150
10689
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
10151
10690
  @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled)
@@ -11788,6 +12327,110 @@ module Google
11788
12327
  end
11789
12328
  end
11790
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
+
11791
12434
  # Represents the contents of the original request that was passed to the `[
11792
12435
  # Streaming]DetectIntent` call.
11793
12436
  class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest
@@ -12088,6 +12731,188 @@ module Google
12088
12731
  end
12089
12732
  end
12090
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
+
12091
12916
  # The request message for a webhook call.
12092
12917
  class GoogleCloudDialogflowV2beta1WebhookRequest
12093
12918
  include Google::Apis::Core::Hashable
@@ -12178,6 +13003,14 @@ module Google
12178
13003
  # @return [String]
12179
13004
  attr_accessor :fulfillment_text
12180
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
+
12181
13014
  # Optional. The collection of output contexts that will overwrite currently
12182
13015
  # active contexts for the session and reset their lifespans. When provided,
12183
13016
  # Dialogflow uses this field to populate QueryResult.output_contexts sent to the
@@ -12224,6 +13057,7 @@ module Google
12224
13057
  @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input)
12225
13058
  @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages)
12226
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)
12227
13061
  @output_contexts = args[:output_contexts] if args.key?(:output_contexts)
12228
13062
  @payload = args[:payload] if args.key?(:payload)
12229
13063
  @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types)