google-cloud-dialogflow-v2 0.19.0 → 0.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/v2/agent_services_pb.rb +12 -8
  4. data/lib/google/cloud/dialogflow/v2/agents/client.rb +16 -12
  5. data/lib/google/cloud/dialogflow/v2/agents.rb +1 -1
  6. data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +7 -0
  7. data/lib/google/cloud/dialogflow/v2/answer_record_services_pb.rb +2 -1
  8. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +2 -1
  9. data/lib/google/cloud/dialogflow/v2/answer_records.rb +3 -2
  10. data/lib/google/cloud/dialogflow/v2/contexts.rb +1 -1
  11. data/lib/google/cloud/dialogflow/v2/conversation_dataset_services_pb.rb +10 -5
  12. data/lib/google/cloud/dialogflow/v2/conversation_datasets/client.rb +12 -7
  13. data/lib/google/cloud/dialogflow/v2/conversation_datasets.rb +1 -1
  14. data/lib/google/cloud/dialogflow/v2/conversation_model_pb.rb +1 -0
  15. data/lib/google/cloud/dialogflow/v2/conversation_model_services_pb.rb +10 -5
  16. data/lib/google/cloud/dialogflow/v2/conversation_models/client.rb +10 -5
  17. data/lib/google/cloud/dialogflow/v2/conversation_models.rb +1 -1
  18. data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +18 -0
  19. data/lib/google/cloud/dialogflow/v2/conversation_profile_services_pb.rb +14 -7
  20. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +14 -7
  21. data/lib/google/cloud/dialogflow/v2/conversation_profiles.rb +3 -2
  22. data/lib/google/cloud/dialogflow/v2/conversation_services_pb.rb +14 -6
  23. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +119 -8
  24. data/lib/google/cloud/dialogflow/v2/conversations/paths.rb +45 -0
  25. data/lib/google/cloud/dialogflow/v2/conversations.rb +3 -2
  26. data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +16 -8
  27. data/lib/google/cloud/dialogflow/v2/documents/client.rb +20 -12
  28. data/lib/google/cloud/dialogflow/v2/documents.rb +3 -2
  29. data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb +2 -1
  30. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +2 -1
  31. data/lib/google/cloud/dialogflow/v2/entity_types.rb +1 -1
  32. data/lib/google/cloud/dialogflow/v2/environments/client.rb +4 -4
  33. data/lib/google/cloud/dialogflow/v2/environments.rb +1 -1
  34. data/lib/google/cloud/dialogflow/v2/fulfillments.rb +1 -1
  35. data/lib/google/cloud/dialogflow/v2/intent_services_pb.rb +2 -1
  36. data/lib/google/cloud/dialogflow/v2/intents/client.rb +2 -1
  37. data/lib/google/cloud/dialogflow/v2/intents.rb +1 -1
  38. data/lib/google/cloud/dialogflow/v2/knowledge_base_services_pb.rb +2 -1
  39. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +2 -1
  40. data/lib/google/cloud/dialogflow/v2/knowledge_bases.rb +3 -2
  41. data/lib/google/cloud/dialogflow/v2/participant_pb.rb +1 -0
  42. data/lib/google/cloud/dialogflow/v2/participants/client.rb +3 -2
  43. data/lib/google/cloud/dialogflow/v2/participants.rb +1 -1
  44. data/lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb +2 -1
  45. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +2 -1
  46. data/lib/google/cloud/dialogflow/v2/session_entity_types.rb +3 -2
  47. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +8 -6
  48. data/lib/google/cloud/dialogflow/v2/sessions.rb +1 -1
  49. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  50. data/lib/google/cloud/dialogflow/v2/versions/client.rb +2 -2
  51. data/lib/google/cloud/dialogflow/v2/versions.rb +1 -1
  52. data/lib/google/cloud/dialogflow/v2.rb +2 -2
  53. data/proto_docs/google/api/client.rb +318 -0
  54. data/proto_docs/google/api/launch_stage.rb +71 -0
  55. data/proto_docs/google/cloud/dialogflow/v2/agent.rb +26 -15
  56. data/proto_docs/google/cloud/dialogflow/v2/answer_record.rb +34 -9
  57. data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +28 -18
  58. data/proto_docs/google/cloud/dialogflow/v2/context.rb +14 -7
  59. data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +99 -14
  60. data/proto_docs/google/cloud/dialogflow/v2/conversation_dataset.rb +15 -10
  61. data/proto_docs/google/cloud/dialogflow/v2/conversation_model.rb +41 -14
  62. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +28 -15
  63. data/proto_docs/google/cloud/dialogflow/v2/document.rb +26 -15
  64. data/proto_docs/google/cloud/dialogflow/v2/entity_type.rb +30 -15
  65. data/proto_docs/google/cloud/dialogflow/v2/environment.rb +37 -29
  66. data/proto_docs/google/cloud/dialogflow/v2/fulfillment.rb +12 -7
  67. data/proto_docs/google/cloud/dialogflow/v2/intent.rb +33 -17
  68. data/proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb +12 -6
  69. data/proto_docs/google/cloud/dialogflow/v2/participant.rb +110 -59
  70. data/proto_docs/google/cloud/dialogflow/v2/session.rb +63 -46
  71. data/proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb +15 -8
  72. data/proto_docs/google/cloud/dialogflow/v2/version.rb +20 -14
  73. data/proto_docs/google/cloud/dialogflow/v2/webhook.rb +20 -13
  74. data/proto_docs/google/rpc/status.rb +4 -2
  75. metadata +7 -5
@@ -102,10 +102,12 @@ module Google
102
102
  # the same session do not necessarily need to specify the same language.
103
103
  # @!attribute [rw] enable_word_info
104
104
  # @return [::Boolean]
105
- # If `true`, Dialogflow returns {::Google::Cloud::Dialogflow::V2::SpeechWordInfo SpeechWordInfo} in
106
- # {::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult StreamingRecognitionResult} with information about the recognized speech
107
- # words, e.g. start and end time offsets. If false or unspecified, Speech
108
- # doesn't return any word-level information.
105
+ # If `true`, Dialogflow returns
106
+ # {::Google::Cloud::Dialogflow::V2::SpeechWordInfo SpeechWordInfo} in
107
+ # {::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult StreamingRecognitionResult}
108
+ # with information about the recognized speech words, e.g. start and end time
109
+ # offsets. If false or unspecified, Speech doesn't return any word-level
110
+ # information.
109
111
  # @!attribute [rw] phrase_hints
110
112
  # @return [::Array<::String>]
111
113
  # A list of strings containing words and phrases that the speech
@@ -140,7 +142,8 @@ module Google
140
142
  # for more details.
141
143
  # @!attribute [rw] model_variant
142
144
  # @return [::Google::Cloud::Dialogflow::V2::SpeechModelVariant]
143
- # Which variant of the {::Google::Cloud::Dialogflow::V2::InputAudioConfig#model Speech model} to use.
145
+ # Which variant of the [Speech
146
+ # model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.
144
147
  # @!attribute [rw] single_utterance
145
148
  # @return [::Boolean]
146
149
  # If `false` (default), recognition does not cease until the
@@ -155,7 +158,9 @@ module Google
155
158
  # over StreamingDetectIntentRequest.single_utterance.
156
159
  # @!attribute [rw] disable_no_speech_recognized_event
157
160
  # @return [::Boolean]
158
- # Only used in {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent} and
161
+ # Only used in
162
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
163
+ # and
159
164
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}.
160
165
  # If `false` and recognition doesn't return any result, trigger
161
166
  # `NO_SPEECH_RECOGNIZED` event to Dialogflow agent.
@@ -174,9 +179,10 @@ module Google
174
179
  # @return [::Google::Cloud::Dialogflow::V2::SsmlVoiceGender]
175
180
  # Optional. The preferred gender of the voice. If not set, the service will
176
181
  # choose a voice based on the other parameters such as language_code and
177
- # {::Google::Cloud::Dialogflow::V2::VoiceSelectionParams#name name}. Note that this is only a preference, not requirement. If a
178
- # voice of the appropriate gender is not available, the synthesizer should
179
- # substitute a voice with a different gender rather than failing the request.
182
+ # {::Google::Cloud::Dialogflow::V2::VoiceSelectionParams#name name}. Note that
183
+ # this is only a preference, not requirement. If a voice of the appropriate
184
+ # gender is not available, the synthesizer should substitute a voice with a
185
+ # different gender rather than failing the request.
180
186
  class VoiceSelectionParams
181
187
  include ::Google::Protobuf::MessageExts
182
188
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -247,16 +253,19 @@ module Google
247
253
  extend ::Google::Protobuf::MessageExts::ClassMethods
248
254
  end
249
255
 
250
- # Configures speech transcription for {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile}.
256
+ # Configures speech transcription for
257
+ # {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile}.
251
258
  # @!attribute [rw] speech_model_variant
252
259
  # @return [::Google::Cloud::Dialogflow::V2::SpeechModelVariant]
253
260
  # The speech model used in speech to text.
254
261
  # `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as
255
- # `USE_ENHANCED`. It can be overridden in {::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest AnalyzeContentRequest} and
256
- # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest StreamingAnalyzeContentRequest} request.
257
- # If enhanced model variant is specified and an enhanced
258
- # version of the specified model for the language does not exist, then it
259
- # would emit an error.
262
+ # `USE_ENHANCED`. It can be overridden in
263
+ # {::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest AnalyzeContentRequest}
264
+ # and
265
+ # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest StreamingAnalyzeContentRequest}
266
+ # request. If enhanced model variant is specified and an enhanced version of
267
+ # the specified model for the language does not exist, then it would emit an
268
+ # error.
260
269
  # @!attribute [rw] model
261
270
  # @return [::String]
262
271
  # Which Speech model to select. Select the model best suited to your domain
@@ -320,7 +329,8 @@ module Google
320
329
  AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7
321
330
  end
322
331
 
323
- # Variant of the specified {::Google::Cloud::Dialogflow::V2::InputAudioConfig#model Speech model} to use.
332
+ # Variant of the specified [Speech
333
+ # model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.
324
334
  #
325
335
  # See the [Cloud Speech
326
336
  # documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)
@@ -349,8 +359,8 @@ module Google
349
359
  # Use an enhanced model variant:
350
360
  #
351
361
  # * If an enhanced variant does not exist for the given
352
- # {::Google::Cloud::Dialogflow::V2::InputAudioConfig#model model} and request language, Dialogflow falls
353
- # back to the standard variant.
362
+ # {::Google::Cloud::Dialogflow::V2::InputAudioConfig#model model} and request
363
+ # language, Dialogflow falls back to the standard variant.
354
364
  #
355
365
  # The [Cloud Speech
356
366
  # documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)
@@ -84,7 +84,8 @@ module Google
84
84
  extend ::Google::Protobuf::MessageExts::ClassMethods
85
85
  end
86
86
 
87
- # The request message for {::Google::Cloud::Dialogflow::V2::Contexts::Client#list_contexts Contexts.ListContexts}.
87
+ # The request message for
88
+ # {::Google::Cloud::Dialogflow::V2::Contexts::Client#list_contexts Contexts.ListContexts}.
88
89
  # @!attribute [rw] parent
89
90
  # @return [::String]
90
91
  # Required. The session to list all contexts from.
@@ -105,7 +106,8 @@ module Google
105
106
  extend ::Google::Protobuf::MessageExts::ClassMethods
106
107
  end
107
108
 
108
- # The response message for {::Google::Cloud::Dialogflow::V2::Contexts::Client#list_contexts Contexts.ListContexts}.
109
+ # The response message for
110
+ # {::Google::Cloud::Dialogflow::V2::Contexts::Client#list_contexts Contexts.ListContexts}.
109
111
  # @!attribute [rw] contexts
110
112
  # @return [::Array<::Google::Cloud::Dialogflow::V2::Context>]
111
113
  # The list of contexts. There will be a maximum number of items
@@ -119,7 +121,8 @@ module Google
119
121
  extend ::Google::Protobuf::MessageExts::ClassMethods
120
122
  end
121
123
 
122
- # The request message for {::Google::Cloud::Dialogflow::V2::Contexts::Client#get_context Contexts.GetContext}.
124
+ # The request message for
125
+ # {::Google::Cloud::Dialogflow::V2::Contexts::Client#get_context Contexts.GetContext}.
123
126
  # @!attribute [rw] name
124
127
  # @return [::String]
125
128
  # Required. The name of the context. Format:
@@ -133,7 +136,8 @@ module Google
133
136
  extend ::Google::Protobuf::MessageExts::ClassMethods
134
137
  end
135
138
 
136
- # The request message for {::Google::Cloud::Dialogflow::V2::Contexts::Client#create_context Contexts.CreateContext}.
139
+ # The request message for
140
+ # {::Google::Cloud::Dialogflow::V2::Contexts::Client#create_context Contexts.CreateContext}.
137
141
  # @!attribute [rw] parent
138
142
  # @return [::String]
139
143
  # Required. The session to create a context for.
@@ -150,7 +154,8 @@ module Google
150
154
  extend ::Google::Protobuf::MessageExts::ClassMethods
151
155
  end
152
156
 
153
- # The request message for {::Google::Cloud::Dialogflow::V2::Contexts::Client#update_context Contexts.UpdateContext}.
157
+ # The request message for
158
+ # {::Google::Cloud::Dialogflow::V2::Contexts::Client#update_context Contexts.UpdateContext}.
154
159
  # @!attribute [rw] context
155
160
  # @return [::Google::Cloud::Dialogflow::V2::Context]
156
161
  # Required. The context to update.
@@ -162,7 +167,8 @@ module Google
162
167
  extend ::Google::Protobuf::MessageExts::ClassMethods
163
168
  end
164
169
 
165
- # The request message for {::Google::Cloud::Dialogflow::V2::Contexts::Client#delete_context Contexts.DeleteContext}.
170
+ # The request message for
171
+ # {::Google::Cloud::Dialogflow::V2::Contexts::Client#delete_context Contexts.DeleteContext}.
166
172
  # @!attribute [rw] name
167
173
  # @return [::String]
168
174
  # Required. The name of the context to delete. Format:
@@ -176,7 +182,8 @@ module Google
176
182
  extend ::Google::Protobuf::MessageExts::ClassMethods
177
183
  end
178
184
 
179
- # The request message for {::Google::Cloud::Dialogflow::V2::Contexts::Client#delete_all_contexts Contexts.DeleteAllContexts}.
185
+ # The request message for
186
+ # {::Google::Cloud::Dialogflow::V2::Contexts::Client#delete_all_contexts Contexts.DeleteAllContexts}.
180
187
  # @!attribute [rw] parent
181
188
  # @return [::String]
182
189
  # Required. The name of the session to delete all contexts from. Format:
@@ -41,8 +41,8 @@ module Google
41
41
  # ID>/conversationProfiles/<Conversation Profile ID>`.
42
42
  # @!attribute [r] phone_number
43
43
  # @return [::Google::Cloud::Dialogflow::V2::ConversationPhoneNumber]
44
- # Output only. It will not be empty if the conversation is to be connected over
45
- # telephony.
44
+ # Output only. It will not be empty if the conversation is to be connected
45
+ # over telephony.
46
46
  # @!attribute [r] start_time
47
47
  # @return [::Google::Protobuf::Timestamp]
48
48
  # Output only. The time the conversation was started.
@@ -56,13 +56,16 @@ module Google
56
56
  #
57
57
  # If the conversation is created with the conversation profile that has
58
58
  # Dialogflow config set, defaults to
59
- # {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::VIRTUAL_AGENT_STAGE ConversationStage.VIRTUAL_AGENT_STAGE}; Otherwise, defaults to
59
+ # {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::VIRTUAL_AGENT_STAGE ConversationStage.VIRTUAL_AGENT_STAGE};
60
+ # Otherwise, defaults to
60
61
  # {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::HUMAN_ASSIST_STAGE ConversationStage.HUMAN_ASSIST_STAGE}.
61
62
  #
62
63
  # If the conversation is created with the conversation profile that has
63
64
  # Dialogflow config set but explicitly sets conversation_stage to
64
- # {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::HUMAN_ASSIST_STAGE ConversationStage.HUMAN_ASSIST_STAGE}, it skips
65
- # {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::VIRTUAL_AGENT_STAGE ConversationStage.VIRTUAL_AGENT_STAGE} stage and directly goes to
65
+ # {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::HUMAN_ASSIST_STAGE ConversationStage.HUMAN_ASSIST_STAGE},
66
+ # it skips
67
+ # {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::VIRTUAL_AGENT_STAGE ConversationStage.VIRTUAL_AGENT_STAGE}
68
+ # stage and directly goes to
66
69
  # {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::HUMAN_ASSIST_STAGE ConversationStage.HUMAN_ASSIST_STAGE}.
67
70
  class Conversation
68
71
  include ::Google::Protobuf::MessageExts
@@ -98,7 +101,8 @@ module Google
98
101
  end
99
102
  end
100
103
 
101
- # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#create_conversation Conversations.CreateConversation}.
104
+ # The request message for
105
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#create_conversation Conversations.CreateConversation}.
102
106
  # @!attribute [rw] parent
103
107
  # @return [::String]
104
108
  # Required. Resource identifier of the project creating the conversation.
@@ -108,8 +112,8 @@ module Google
108
112
  # Required. The conversation to create.
109
113
  # @!attribute [rw] conversation_id
110
114
  # @return [::String]
111
- # Optional. Identifier of the conversation. Generally it's auto generated by Google.
112
- # Only set it if you cannot wait for the response to return a
115
+ # Optional. Identifier of the conversation. Generally it's auto generated by
116
+ # Google. Only set it if you cannot wait for the response to return a
113
117
  # auto-generated one to you.
114
118
  #
115
119
  # The conversation ID must be compliant with the regression fomula
@@ -123,7 +127,8 @@ module Google
123
127
  extend ::Google::Protobuf::MessageExts::ClassMethods
124
128
  end
125
129
 
126
- # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_conversations Conversations.ListConversations}.
130
+ # The request message for
131
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_conversations Conversations.ListConversations}.
127
132
  # @!attribute [rw] parent
128
133
  # @return [::String]
129
134
  # Required. The project from which to list all conversation.
@@ -159,7 +164,8 @@ module Google
159
164
  extend ::Google::Protobuf::MessageExts::ClassMethods
160
165
  end
161
166
 
162
- # The response message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_conversations Conversations.ListConversations}.
167
+ # The response message for
168
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_conversations Conversations.ListConversations}.
163
169
  # @!attribute [rw] conversations
164
170
  # @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation>]
165
171
  # The list of conversations. There will be a maximum number of items
@@ -173,7 +179,8 @@ module Google
173
179
  extend ::Google::Protobuf::MessageExts::ClassMethods
174
180
  end
175
181
 
176
- # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#get_conversation Conversations.GetConversation}.
182
+ # The request message for
183
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#get_conversation Conversations.GetConversation}.
177
184
  # @!attribute [rw] name
178
185
  # @return [::String]
179
186
  # Required. The name of the conversation. Format:
@@ -184,7 +191,8 @@ module Google
184
191
  extend ::Google::Protobuf::MessageExts::ClassMethods
185
192
  end
186
193
 
187
- # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#complete_conversation Conversations.CompleteConversation}.
194
+ # The request message for
195
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#complete_conversation Conversations.CompleteConversation}.
188
196
  # @!attribute [rw] name
189
197
  # @return [::String]
190
198
  # Required. Resource identifier of the conversation to close.
@@ -195,7 +203,8 @@ module Google
195
203
  extend ::Google::Protobuf::MessageExts::ClassMethods
196
204
  end
197
205
 
198
- # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}.
206
+ # The request message for
207
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}.
199
208
  # @!attribute [rw] parent
200
209
  # @return [::String]
201
210
  # Required. The name of the conversation to list messages for.
@@ -223,7 +232,8 @@ module Google
223
232
  extend ::Google::Protobuf::MessageExts::ClassMethods
224
233
  end
225
234
 
226
- # The response message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}.
235
+ # The response message for
236
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}.
227
237
  # @!attribute [rw] messages
228
238
  # @return [::Array<::Google::Cloud::Dialogflow::V2::Message>]
229
239
  # The list of messages. There will be a maximum number of items
@@ -247,6 +257,81 @@ module Google
247
257
  include ::Google::Protobuf::MessageExts
248
258
  extend ::Google::Protobuf::MessageExts::ClassMethods
249
259
  end
260
+
261
+ # The request message for
262
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#suggest_conversation_summary Conversations.SuggestConversationSummary}.
263
+ # @!attribute [rw] conversation
264
+ # @return [::String]
265
+ # Required. The conversation to fetch suggestion for.
266
+ # Format: `projects/<Project ID>/locations/<Location
267
+ # ID>/conversations/<Conversation ID>`.
268
+ # @!attribute [rw] latest_message
269
+ # @return [::String]
270
+ # The name of the latest conversation message used as context for
271
+ # compiling suggestion. If empty, the latest message of the conversation will
272
+ # be used.
273
+ #
274
+ # Format: `projects/<Project ID>/locations/<Location
275
+ # ID>/conversations/<Conversation ID>/messages/<Message ID>`.
276
+ # @!attribute [rw] context_size
277
+ # @return [::Integer]
278
+ # Max number of messages prior to and including
279
+ # [latest_message] to use as context when compiling the
280
+ # suggestion. By default 500 and at most 1000.
281
+ class SuggestConversationSummaryRequest
282
+ include ::Google::Protobuf::MessageExts
283
+ extend ::Google::Protobuf::MessageExts::ClassMethods
284
+ end
285
+
286
+ # The response message for
287
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#suggest_conversation_summary Conversations.SuggestConversationSummary}.
288
+ # @!attribute [rw] summary
289
+ # @return [::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryResponse::Summary]
290
+ # Generated summary.
291
+ # @!attribute [rw] latest_message
292
+ # @return [::String]
293
+ # The name of the latest conversation message used as context for
294
+ # compiling suggestion.
295
+ #
296
+ # Format: `projects/<Project ID>/locations/<Location
297
+ # ID>/conversations/<Conversation ID>/messages/<Message ID>`.
298
+ # @!attribute [rw] context_size
299
+ # @return [::Integer]
300
+ # Number of messages prior to and including
301
+ # [last_conversation_message][] used to compile the suggestion. It may be
302
+ # smaller than the [SuggestSummaryRequest.context_size][] field in the
303
+ # request if there weren't that many messages in the conversation.
304
+ class SuggestConversationSummaryResponse
305
+ include ::Google::Protobuf::MessageExts
306
+ extend ::Google::Protobuf::MessageExts::ClassMethods
307
+
308
+ # Generated summary for a conversation.
309
+ # @!attribute [rw] text
310
+ # @return [::String]
311
+ # The summary content that is concatenated into one string.
312
+ # @!attribute [rw] text_sections
313
+ # @return [::Google::Protobuf::Map{::String => ::String}]
314
+ # The summary content that is divided into sections. The key is the
315
+ # section's name and the value is the section's content. There is no
316
+ # specific format for the key or value.
317
+ # @!attribute [rw] answer_record
318
+ # @return [::String]
319
+ # The name of the answer record. Format:
320
+ # "projects/<Project ID>/answerRecords/<Answer Record ID>"
321
+ class Summary
322
+ include ::Google::Protobuf::MessageExts
323
+ extend ::Google::Protobuf::MessageExts::ClassMethods
324
+
325
+ # @!attribute [rw] key
326
+ # @return [::String]
327
+ # @!attribute [rw] value
328
+ # @return [::String]
329
+ class TextSectionsEntry
330
+ include ::Google::Protobuf::MessageExts
331
+ extend ::Google::Protobuf::MessageExts::ClassMethods
332
+ end
333
+ end
334
+ end
250
335
  end
251
336
  end
252
337
  end
@@ -24,9 +24,9 @@ module Google
24
24
  # Represents metadata of a conversation.
25
25
  # @!attribute [rw] language_code
26
26
  # @return [::String]
27
- # Optional. The language code of the conversation data within this dataset. See
28
- # https://cloud.google.com/apis/design/standard_fields for more information.
29
- # Supports all UTF-8 languages.
27
+ # Optional. The language code of the conversation data within this dataset.
28
+ # See https://cloud.google.com/apis/design/standard_fields for more
29
+ # information. Supports all UTF-8 languages.
30
30
  class ConversationInfo
31
31
  include ::Google::Protobuf::MessageExts
32
32
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -70,7 +70,8 @@ module Google
70
70
  # Output only. Metadata set during conversation data import.
71
71
  # @!attribute [r] conversation_count
72
72
  # @return [::Integer]
73
- # Output only. The number of conversations this conversation dataset contains.
73
+ # Output only. The number of conversations this conversation dataset
74
+ # contains.
74
75
  class ConversationDataset
75
76
  include ::Google::Protobuf::MessageExts
76
77
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -106,8 +107,8 @@ module Google
106
107
  # {::Google::Cloud::Dialogflow::V2::ConversationDatasets::Client#list_conversation_datasets ConversationDatasets.ListConversationDatasets}.
107
108
  # @!attribute [rw] parent
108
109
  # @return [::String]
109
- # Required. The project and location name to list all conversation datasets for.
110
- # Format: `projects/<Project ID>/locations/<Location ID>`
110
+ # Required. The project and location name to list all conversation datasets
111
+ # for. Format: `projects/<Project ID>/locations/<Location ID>`
111
112
  # @!attribute [rw] page_size
112
113
  # @return [::Integer]
113
114
  # Optional. Maximum number of conversation datasets to return in a single
@@ -146,7 +147,8 @@ module Google
146
147
  extend ::Google::Protobuf::MessageExts::ClassMethods
147
148
  end
148
149
 
149
- # The request message for {::Google::Cloud::Dialogflow::V2::ConversationDatasets::Client#import_conversation_data ConversationDatasets.ImportConversationData}.
150
+ # The request message for
151
+ # {::Google::Cloud::Dialogflow::V2::ConversationDatasets::Client#import_conversation_data ConversationDatasets.ImportConversationData}.
150
152
  # @!attribute [rw] name
151
153
  # @return [::String]
152
154
  # Required. Dataset resource name. Format:
@@ -160,7 +162,9 @@ module Google
160
162
  extend ::Google::Protobuf::MessageExts::ClassMethods
161
163
  end
162
164
 
163
- # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationDatasets::Client#import_conversation_data ConversationDatasets.ImportConversationData} operation.
165
+ # Metadata for a
166
+ # {::Google::Cloud::Dialogflow::V2::ConversationDatasets::Client#import_conversation_data ConversationDatasets.ImportConversationData}
167
+ # operation.
164
168
  # @!attribute [rw] conversation_dataset
165
169
  # @return [::String]
166
170
  # The resource name of the imported conversation dataset. Format:
@@ -179,8 +183,9 @@ module Google
179
183
  extend ::Google::Protobuf::MessageExts::ClassMethods
180
184
  end
181
185
 
182
- # Response used for {::Google::Cloud::Dialogflow::V2::ConversationDatasets::Client#import_conversation_data ConversationDatasets.ImportConversationData} long
183
- # running operation.
186
+ # Response used for
187
+ # {::Google::Cloud::Dialogflow::V2::ConversationDatasets::Client#import_conversation_data ConversationDatasets.ImportConversationData}
188
+ # long running operation.
184
189
  # @!attribute [rw] conversation_dataset
185
190
  # @return [::String]
186
191
  # The resource name of the imported conversation dataset. Format:
@@ -119,6 +119,23 @@ module Google
119
119
  # @!attribute [r] smart_reply_metrics
120
120
  # @return [::Google::Cloud::Dialogflow::V2::SmartReplyMetrics]
121
121
  # Output only. Only available when model is for smart reply.
122
+ # @!attribute [r] raw_human_eval_template_csv
123
+ # @return [::String]
124
+ # Output only. Human eval template in csv format.
125
+ # It tooks real-world conversations provided through input dataset, generates
126
+ # example suggestions for customer to verify quality of the model.
127
+ # For Smart Reply, the generated csv file contains columns of
128
+ # Context, (Suggestions,Q1,Q2)*3, Actual reply.
129
+ # Context contains at most 10 latest messages in the conversation prior to
130
+ # the current suggestion.
131
+ # Q1: "Would you send it as the next message of agent?"
132
+ # Evaluated based on whether the suggest is appropriate to be sent by
133
+ # agent in current context.
134
+ # Q2: "Does the suggestion move the conversation closer to resolution?"
135
+ # Evaluated based on whether the suggestion provide solutions, or answers
136
+ # customer's question or collect information from customer to resolve the
137
+ # customer's issue.
138
+ # Actual reply column contains the actual agent reply sent in the context.
122
139
  class ConversationModelEvaluation
123
140
  include ::Google::Protobuf::MessageExts
124
141
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -146,10 +163,10 @@ module Google
146
163
  # ID>/documents/<Document ID>`. Only used for smart reply model.
147
164
  # @!attribute [rw] max_result_count
148
165
  # @return [::Integer]
149
- # Required. The model to be evaluated can return multiple results with confidence
150
- # score on each query. These results will be sorted by the descending order
151
- # of the scores and we only keep the first max_result_count results as the
152
- # final results to evaluate.
166
+ # Required. The model to be evaluated can return multiple results with
167
+ # confidence score on each query. These results will be sorted by the
168
+ # descending order of the scores and we only keep the first
169
+ # max_result_count results as the final results to evaluate.
153
170
  class SmartReplyConfig
154
171
  include ::Google::Protobuf::MessageExts
155
172
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -163,10 +180,10 @@ module Google
163
180
  # ID>/documents/<Document ID>`. Only used for smart compose model.
164
181
  # @!attribute [rw] max_result_count
165
182
  # @return [::Integer]
166
- # Required. The model to be evaluated can return multiple results with confidence
167
- # score on each query. These results will be sorted by the descending order
168
- # of the scores and we only keep the first max_result_count results as the
169
- # final results to evaluate.
183
+ # Required. The model to be evaluated can return multiple results with
184
+ # confidence score on each query. These results will be sorted by the
185
+ # descending order of the scores and we only keep the first
186
+ # max_result_count results as the final results to evaluate.
170
187
  class SmartComposeConfig
171
188
  include ::Google::Protobuf::MessageExts
172
189
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -188,7 +205,8 @@ module Google
188
205
  # Metadata for article suggestion models.
189
206
  # @!attribute [rw] training_model_type
190
207
  # @return [::Google::Cloud::Dialogflow::V2::ConversationModel::ModelType]
191
- # Optional. Type of the article suggestion model. If not provided, model_type is used.
208
+ # Optional. Type of the article suggestion model. If not provided, model_type
209
+ # is used.
192
210
  class ArticleSuggestionModelMetadata
193
211
  include ::Google::Protobuf::MessageExts
194
212
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -197,7 +215,8 @@ module Google
197
215
  # Metadata for smart reply models.
198
216
  # @!attribute [rw] training_model_type
199
217
  # @return [::Google::Cloud::Dialogflow::V2::ConversationModel::ModelType]
200
- # Optional. Type of the smart reply model. If not provided, model_type is used.
218
+ # Optional. Type of the smart reply model. If not provided, model_type is
219
+ # used.
201
220
  class SmartReplyModelMetadata
202
221
  include ::Google::Protobuf::MessageExts
203
222
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -386,7 +405,9 @@ module Google
386
405
  extend ::Google::Protobuf::MessageExts::ClassMethods
387
406
  end
388
407
 
389
- # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#create_conversation_model ConversationModels.CreateConversationModel} operation.
408
+ # Metadata for a
409
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#create_conversation_model ConversationModels.CreateConversationModel}
410
+ # operation.
390
411
  # @!attribute [rw] conversation_model
391
412
  # @return [::String]
392
413
  # The resource name of the conversation model. Format:
@@ -429,7 +450,9 @@ module Google
429
450
  end
430
451
  end
431
452
 
432
- # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#deploy_conversation_model ConversationModels.DeployConversationModel} operation.
453
+ # Metadata for a
454
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#deploy_conversation_model ConversationModels.DeployConversationModel}
455
+ # operation.
433
456
  # @!attribute [rw] conversation_model
434
457
  # @return [::String]
435
458
  # The resource name of the conversation model. Format:
@@ -443,7 +466,9 @@ module Google
443
466
  extend ::Google::Protobuf::MessageExts::ClassMethods
444
467
  end
445
468
 
446
- # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#undeploy_conversation_model ConversationModels.UndeployConversationModel} operation.
469
+ # Metadata for a
470
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#undeploy_conversation_model ConversationModels.UndeployConversationModel}
471
+ # operation.
447
472
  # @!attribute [rw] conversation_model
448
473
  # @return [::String]
449
474
  # The resource name of the conversation model. Format:
@@ -457,7 +482,9 @@ module Google
457
482
  extend ::Google::Protobuf::MessageExts::ClassMethods
458
483
  end
459
484
 
460
- # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#delete_conversation_model ConversationModels.DeleteConversationModel} operation.
485
+ # Metadata for a
486
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#delete_conversation_model ConversationModels.DeleteConversationModel}
487
+ # operation.
461
488
  # @!attribute [rw] conversation_model
462
489
  # @return [::String]
463
490
  # The resource name of the conversation model. Format:
@@ -83,7 +83,8 @@ module Google
83
83
  extend ::Google::Protobuf::MessageExts::ClassMethods
84
84
  end
85
85
 
86
- # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#list_conversation_profiles ConversationProfiles.ListConversationProfiles}.
86
+ # The request message for
87
+ # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#list_conversation_profiles ConversationProfiles.ListConversationProfiles}.
87
88
  # @!attribute [rw] parent
88
89
  # @return [::String]
89
90
  # Required. The project to list all conversation profiles from.
@@ -100,7 +101,8 @@ module Google
100
101
  extend ::Google::Protobuf::MessageExts::ClassMethods
101
102
  end
102
103
 
103
- # The response message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#list_conversation_profiles ConversationProfiles.ListConversationProfiles}.
104
+ # The response message for
105
+ # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#list_conversation_profiles ConversationProfiles.ListConversationProfiles}.
104
106
  # @!attribute [rw] conversation_profiles
105
107
  # @return [::Array<::Google::Cloud::Dialogflow::V2::ConversationProfile>]
106
108
  # The list of project conversation profiles. There is a maximum number
@@ -114,7 +116,8 @@ module Google
114
116
  extend ::Google::Protobuf::MessageExts::ClassMethods
115
117
  end
116
118
 
117
- # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#get_conversation_profile ConversationProfiles.GetConversationProfile}.
119
+ # The request message for
120
+ # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#get_conversation_profile ConversationProfiles.GetConversationProfile}.
118
121
  # @!attribute [rw] name
119
122
  # @return [::String]
120
123
  # Required. The resource name of the conversation profile.
@@ -125,7 +128,8 @@ module Google
125
128
  extend ::Google::Protobuf::MessageExts::ClassMethods
126
129
  end
127
130
 
128
- # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#create_conversation_profile ConversationProfiles.CreateConversationProfile}.
131
+ # The request message for
132
+ # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#create_conversation_profile ConversationProfiles.CreateConversationProfile}.
129
133
  # @!attribute [rw] parent
130
134
  # @return [::String]
131
135
  # Required. The project to create a conversation profile for.
@@ -138,7 +142,8 @@ module Google
138
142
  extend ::Google::Protobuf::MessageExts::ClassMethods
139
143
  end
140
144
 
141
- # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#update_conversation_profile ConversationProfiles.UpdateConversationProfile}.
145
+ # The request message for
146
+ # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#update_conversation_profile ConversationProfiles.UpdateConversationProfile}.
142
147
  # @!attribute [rw] conversation_profile
143
148
  # @return [::Google::Cloud::Dialogflow::V2::ConversationProfile]
144
149
  # Required. The conversation profile to update.
@@ -150,7 +155,8 @@ module Google
150
155
  extend ::Google::Protobuf::MessageExts::ClassMethods
151
156
  end
152
157
 
153
- # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#delete_conversation_profile ConversationProfiles.DeleteConversationProfile}.
158
+ # The request message for
159
+ # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#delete_conversation_profile ConversationProfiles.DeleteConversationProfile}.
154
160
  #
155
161
  # This operation fails if the conversation profile is still referenced from
156
162
  # a phone number.
@@ -351,8 +357,8 @@ module Google
351
357
  # Supported feature: DIALOGFLOW_ASSIST.
352
358
  # @!attribute [rw] agent
353
359
  # @return [::String]
354
- # Required. The name of a Dialogflow virtual agent used for end user side intent
355
- # detection and suggestion. Format: `projects/<Project Number/
360
+ # Required. The name of a Dialogflow virtual agent used for end user side
361
+ # intent detection and suggestion. Format: `projects/<Project Number/
356
362
  # ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
357
363
  # the same Dialogflow project.
358
364
  class DialogflowQuerySource
@@ -418,11 +424,17 @@ module Google
418
424
  # and identifies the prevailing subjective opinion, especially to determine
419
425
  # a user's attitude as positive, negative, or neutral:
420
426
  # https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
421
- # For {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent} method, result will be in
427
+ # For
428
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}
429
+ # method, result will be in
422
430
  # {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#message StreamingAnalyzeContentResponse.message.SentimentAnalysisResult}.
423
- # For {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent} method, result will be in
431
+ # For
432
+ # {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
433
+ # method, result will be in
424
434
  # {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#message AnalyzeContentResponse.message.SentimentAnalysisResult}
425
- # For {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages} method, result will be in
435
+ # For
436
+ # {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}
437
+ # method, result will be in
426
438
  # {::Google::Cloud::Dialogflow::V2::ListMessagesResponse#messages ListMessagesResponse.messages.SentimentAnalysisResult}
427
439
  # If Pub/Sub notification is configured, result will be in
428
440
  # {::Google::Cloud::Dialogflow::V2::ConversationEvent#new_message_payload ConversationEvent.new_message_payload.SentimentAnalysisResult}.
@@ -484,8 +496,9 @@ module Google
484
496
  # @return [::String]
485
497
  # Name of the Pub/Sub topic to publish conversation
486
498
  # events like
487
- # {::Google::Cloud::Dialogflow::V2::ConversationEvent::Type::CONVERSATION_STARTED CONVERSATION_STARTED} as
488
- # serialized {::Google::Cloud::Dialogflow::V2::ConversationEvent ConversationEvent} protos.
499
+ # {::Google::Cloud::Dialogflow::V2::ConversationEvent::Type::CONVERSATION_STARTED CONVERSATION_STARTED}
500
+ # as serialized
501
+ # {::Google::Cloud::Dialogflow::V2::ConversationEvent ConversationEvent} protos.
489
502
  #
490
503
  # For telephony integration to receive notification, make sure either this
491
504
  # topic is in the same project as the conversation or you grant
@@ -521,8 +534,8 @@ module Google
521
534
  # @!attribute [rw] enable_stackdriver_logging
522
535
  # @return [::Boolean]
523
536
  # Whether to log conversation events like
524
- # {::Google::Cloud::Dialogflow::V2::ConversationEvent::Type::CONVERSATION_STARTED CONVERSATION_STARTED} to
525
- # Stackdriver in the conversation project as JSON format
537
+ # {::Google::Cloud::Dialogflow::V2::ConversationEvent::Type::CONVERSATION_STARTED CONVERSATION_STARTED}
538
+ # to Stackdriver in the conversation project as JSON format
526
539
  # {::Google::Cloud::Dialogflow::V2::ConversationEvent ConversationEvent} protos.
527
540
  class LoggingConfig
528
541
  include ::Google::Protobuf::MessageExts