google-cloud-dialogflow-v2 0.20.0 → 0.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dialogflow/v2/agent_services_pb.rb +12 -8
  3. data/lib/google/cloud/dialogflow/v2/agents/client.rb +16 -12
  4. data/lib/google/cloud/dialogflow/v2/agents.rb +1 -1
  5. data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +7 -0
  6. data/lib/google/cloud/dialogflow/v2/answer_record_services_pb.rb +2 -1
  7. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +2 -1
  8. data/lib/google/cloud/dialogflow/v2/answer_records.rb +3 -2
  9. data/lib/google/cloud/dialogflow/v2/contexts.rb +1 -1
  10. data/lib/google/cloud/dialogflow/v2/conversation_dataset_services_pb.rb +10 -5
  11. data/lib/google/cloud/dialogflow/v2/conversation_datasets/client.rb +12 -7
  12. data/lib/google/cloud/dialogflow/v2/conversation_datasets.rb +1 -1
  13. data/lib/google/cloud/dialogflow/v2/conversation_model_pb.rb +1 -0
  14. data/lib/google/cloud/dialogflow/v2/conversation_model_services_pb.rb +10 -5
  15. data/lib/google/cloud/dialogflow/v2/conversation_models/client.rb +10 -5
  16. data/lib/google/cloud/dialogflow/v2/conversation_models.rb +1 -1
  17. data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +18 -0
  18. data/lib/google/cloud/dialogflow/v2/conversation_profile_services_pb.rb +14 -7
  19. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +14 -7
  20. data/lib/google/cloud/dialogflow/v2/conversation_profiles.rb +3 -2
  21. data/lib/google/cloud/dialogflow/v2/conversation_services_pb.rb +14 -6
  22. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +119 -8
  23. data/lib/google/cloud/dialogflow/v2/conversations/paths.rb +45 -0
  24. data/lib/google/cloud/dialogflow/v2/conversations.rb +3 -2
  25. data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +16 -8
  26. data/lib/google/cloud/dialogflow/v2/documents/client.rb +20 -12
  27. data/lib/google/cloud/dialogflow/v2/documents.rb +3 -2
  28. data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb +2 -1
  29. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +2 -1
  30. data/lib/google/cloud/dialogflow/v2/entity_types.rb +1 -1
  31. data/lib/google/cloud/dialogflow/v2/environments/client.rb +4 -4
  32. data/lib/google/cloud/dialogflow/v2/environments.rb +1 -1
  33. data/lib/google/cloud/dialogflow/v2/fulfillments.rb +1 -1
  34. data/lib/google/cloud/dialogflow/v2/intent_services_pb.rb +2 -1
  35. data/lib/google/cloud/dialogflow/v2/intents/client.rb +2 -1
  36. data/lib/google/cloud/dialogflow/v2/intents.rb +1 -1
  37. data/lib/google/cloud/dialogflow/v2/knowledge_base_services_pb.rb +2 -1
  38. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +2 -1
  39. data/lib/google/cloud/dialogflow/v2/knowledge_bases.rb +3 -2
  40. data/lib/google/cloud/dialogflow/v2/participants/client.rb +3 -2
  41. data/lib/google/cloud/dialogflow/v2/participants.rb +1 -1
  42. data/lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb +2 -1
  43. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +2 -1
  44. data/lib/google/cloud/dialogflow/v2/session_entity_types.rb +3 -2
  45. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +8 -6
  46. data/lib/google/cloud/dialogflow/v2/sessions.rb +1 -1
  47. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  48. data/lib/google/cloud/dialogflow/v2/versions/client.rb +2 -2
  49. data/lib/google/cloud/dialogflow/v2/versions.rb +1 -1
  50. data/lib/google/cloud/dialogflow/v2.rb +2 -2
  51. data/proto_docs/google/cloud/dialogflow/v2/agent.rb +26 -15
  52. data/proto_docs/google/cloud/dialogflow/v2/answer_record.rb +34 -9
  53. data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +28 -18
  54. data/proto_docs/google/cloud/dialogflow/v2/context.rb +14 -7
  55. data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +99 -14
  56. data/proto_docs/google/cloud/dialogflow/v2/conversation_dataset.rb +15 -10
  57. data/proto_docs/google/cloud/dialogflow/v2/conversation_model.rb +41 -14
  58. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +28 -15
  59. data/proto_docs/google/cloud/dialogflow/v2/document.rb +26 -15
  60. data/proto_docs/google/cloud/dialogflow/v2/entity_type.rb +30 -15
  61. data/proto_docs/google/cloud/dialogflow/v2/environment.rb +37 -29
  62. data/proto_docs/google/cloud/dialogflow/v2/fulfillment.rb +12 -7
  63. data/proto_docs/google/cloud/dialogflow/v2/intent.rb +33 -17
  64. data/proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb +12 -6
  65. data/proto_docs/google/cloud/dialogflow/v2/participant.rb +105 -59
  66. data/proto_docs/google/cloud/dialogflow/v2/session.rb +60 -45
  67. data/proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb +15 -8
  68. data/proto_docs/google/cloud/dialogflow/v2/version.rb +20 -14
  69. data/proto_docs/google/cloud/dialogflow/v2/webhook.rb +20 -13
  70. data/proto_docs/google/rpc/status.rb +4 -2
  71. metadata +5 -5
@@ -239,12 +239,14 @@ module Google
239
239
  # audio. If this field is not set and agent-level speech synthesizer is not
240
240
  # configured, no output audio is generated.
241
241
  # @param output_audio_config_mask [::Google::Protobuf::FieldMask, ::Hash]
242
- # Mask for {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config} indicating which settings in this
243
- # request-level config should override speech synthesizer settings defined at
244
- # agent-level.
245
- #
246
- # If unspecified or empty, {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config} replaces the agent-level
247
- # config in its entirety.
242
+ # Mask for
243
+ # {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config}
244
+ # indicating which settings in this request-level config should override
245
+ # speech synthesizer settings defined at agent-level.
246
+ #
247
+ # If unspecified or empty,
248
+ # {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config}
249
+ # replaces the agent-level config in its entirety.
248
250
  # @param input_audio [::String]
249
251
  # The natural language speech audio to be processed. This field
250
252
  # should be populated iff `query_input` is set to an input audio config.
@@ -36,7 +36,7 @@ module Google
36
36
  # For more information, see the [API interactions
37
37
  # guide](https://cloud.google.com/dialogflow/docs/api-overview).
38
38
  #
39
- # To load this service and instantiate a client:
39
+ # @example Load this service and instantiate a gRPC client
40
40
  #
41
41
  # require "google/cloud/dialogflow/v2/sessions"
42
42
  # client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dialogflow
23
23
  module V2
24
- VERSION = "0.20.0"
24
+ VERSION = "0.21.0"
25
25
  end
26
26
  end
27
27
  end
@@ -188,8 +188,8 @@ module Google
188
188
  # - `projects/<Project ID>/agent`
189
189
  # - `projects/<Project ID>/locations/<Location ID>/agent`
190
190
  # @param page_size [::Integer]
191
- # Optional. The maximum number of items to return in a single page. By default 100 and
192
- # at most 1000.
191
+ # Optional. The maximum number of items to return in a single page. By
192
+ # default 100 and at most 1000.
193
193
  # @param page_token [::String]
194
194
  # Optional. The next_page_token value returned from a previous list request.
195
195
  #
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # Service for managing {::Google::Cloud::Dialogflow::V2::Version Versions}.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/dialogflow/v2/versions"
39
39
  # client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new
@@ -39,9 +39,9 @@ module Google
39
39
  module Cloud
40
40
  module Dialogflow
41
41
  ##
42
- # To load this package, including all its services, and instantiate a client:
42
+ # API client module.
43
43
  #
44
- # @example
44
+ # @example Load this package, including all its services, and instantiate a gRPC client
45
45
  #
46
46
  # require "google/cloud/dialogflow/v2"
47
47
  # client = ::Google::Cloud::Dialogflow::V2::Agents::Client.new
@@ -138,7 +138,8 @@ module Google
138
138
  end
139
139
  end
140
140
 
141
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#get_agent Agents.GetAgent}.
141
+ # The request message for
142
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#get_agent Agents.GetAgent}.
142
143
  # @!attribute [rw] parent
143
144
  # @return [::String]
144
145
  # Required. The project that the agent to fetch is associated with.
@@ -148,7 +149,8 @@ module Google
148
149
  extend ::Google::Protobuf::MessageExts::ClassMethods
149
150
  end
150
151
 
151
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#set_agent Agents.SetAgent}.
152
+ # The request message for
153
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#set_agent Agents.SetAgent}.
152
154
  # @!attribute [rw] agent
153
155
  # @return [::Google::Cloud::Dialogflow::V2::Agent]
154
156
  # Required. The agent to update.
@@ -160,7 +162,8 @@ module Google
160
162
  extend ::Google::Protobuf::MessageExts::ClassMethods
161
163
  end
162
164
 
163
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#delete_agent Agents.DeleteAgent}.
165
+ # The request message for
166
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#delete_agent Agents.DeleteAgent}.
164
167
  # @!attribute [rw] parent
165
168
  # @return [::String]
166
169
  # Required. The project that the agent to delete is associated with.
@@ -170,7 +173,8 @@ module Google
170
173
  extend ::Google::Protobuf::MessageExts::ClassMethods
171
174
  end
172
175
 
173
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#search_agents Agents.SearchAgents}.
176
+ # The request message for
177
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#search_agents Agents.SearchAgents}.
174
178
  # @!attribute [rw] parent
175
179
  # @return [::String]
176
180
  # Required. The project to list agents from.
@@ -187,7 +191,8 @@ module Google
187
191
  extend ::Google::Protobuf::MessageExts::ClassMethods
188
192
  end
189
193
 
190
- # The response message for {::Google::Cloud::Dialogflow::V2::Agents::Client#search_agents Agents.SearchAgents}.
194
+ # The response message for
195
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#search_agents Agents.SearchAgents}.
191
196
  # @!attribute [rw] agents
192
197
  # @return [::Array<::Google::Cloud::Dialogflow::V2::Agent>]
193
198
  # The list of agents. There will be a maximum number of items returned based
@@ -201,7 +206,8 @@ module Google
201
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
202
207
  end
203
208
 
204
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#train_agent Agents.TrainAgent}.
209
+ # The request message for
210
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#train_agent Agents.TrainAgent}.
205
211
  # @!attribute [rw] parent
206
212
  # @return [::String]
207
213
  # Required. The project that the agent to train is associated with.
@@ -211,17 +217,18 @@ module Google
211
217
  extend ::Google::Protobuf::MessageExts::ClassMethods
212
218
  end
213
219
 
214
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#export_agent Agents.ExportAgent}.
220
+ # The request message for
221
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#export_agent Agents.ExportAgent}.
215
222
  # @!attribute [rw] parent
216
223
  # @return [::String]
217
224
  # Required. The project that the agent to export is associated with.
218
225
  # Format: `projects/<Project ID>`.
219
226
  # @!attribute [rw] agent_uri
220
227
  # @return [::String]
221
- # Required. The [Google Cloud Storage](https://cloud.google.com/storage/docs/)
222
- # URI to export the agent to.
223
- # The format of this URI must be `gs://<bucket-name>/<object-name>`.
224
- # If left unspecified, the serialized agent is returned inline.
228
+ # Required. The [Google Cloud
229
+ # Storage](https://cloud.google.com/storage/docs/) URI to export the agent
230
+ # to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If
231
+ # left unspecified, the serialized agent is returned inline.
225
232
  #
226
233
  # Dialogflow performs a write operation for the Cloud Storage object
227
234
  # on the caller's behalf, so your request authentication must
@@ -233,7 +240,8 @@ module Google
233
240
  extend ::Google::Protobuf::MessageExts::ClassMethods
234
241
  end
235
242
 
236
- # The response message for {::Google::Cloud::Dialogflow::V2::Agents::Client#export_agent Agents.ExportAgent}.
243
+ # The response message for
244
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#export_agent Agents.ExportAgent}.
237
245
  # @!attribute [rw] agent_uri
238
246
  # @return [::String]
239
247
  # The URI to a file containing the exported agent. This field is populated
@@ -246,7 +254,8 @@ module Google
246
254
  extend ::Google::Protobuf::MessageExts::ClassMethods
247
255
  end
248
256
 
249
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#import_agent Agents.ImportAgent}.
257
+ # The request message for
258
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#import_agent Agents.ImportAgent}.
250
259
  # @!attribute [rw] parent
251
260
  # @return [::String]
252
261
  # Required. The project that the agent to import is associated with.
@@ -269,7 +278,8 @@ module Google
269
278
  extend ::Google::Protobuf::MessageExts::ClassMethods
270
279
  end
271
280
 
272
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#restore_agent Agents.RestoreAgent}.
281
+ # The request message for
282
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#restore_agent Agents.RestoreAgent}.
273
283
  # @!attribute [rw] parent
274
284
  # @return [::String]
275
285
  # Required. The project that the agent to restore is associated with.
@@ -292,7 +302,8 @@ module Google
292
302
  extend ::Google::Protobuf::MessageExts::ClassMethods
293
303
  end
294
304
 
295
- # The request message for {::Google::Cloud::Dialogflow::V2::Agents::Client#get_validation_result Agents.GetValidationResult}.
305
+ # The request message for
306
+ # {::Google::Cloud::Dialogflow::V2::Agents::Client#get_validation_result Agents.GetValidationResult}.
296
307
  # @!attribute [rw] parent
297
308
  # @return [::String]
298
309
  # Required. The project that the agent is associated with.
@@ -42,9 +42,11 @@ module Google
42
42
  # A typical workflow for customers provide feedback to an answer is:
43
43
  #
44
44
  # 1. For human agent assistant, customers get suggestion via ListSuggestions
45
- # API. Together with the answers, {::Google::Cloud::Dialogflow::V2::AnswerRecord#name AnswerRecord.name} are returned to the
46
- # customers.
47
- # 2. The customer uses the {::Google::Cloud::Dialogflow::V2::AnswerRecord#name AnswerRecord.name} to call the
45
+ # API. Together with the answers,
46
+ # {::Google::Cloud::Dialogflow::V2::AnswerRecord#name AnswerRecord.name} are
47
+ # returned to the customers.
48
+ # 2. The customer uses the
49
+ # {::Google::Cloud::Dialogflow::V2::AnswerRecord#name AnswerRecord.name} to call the
48
50
  # [UpdateAnswerRecord][] method to send feedback about a specific answer
49
51
  # that they believe is wrong.
50
52
  # @!attribute [rw] name
@@ -55,8 +57,8 @@ module Google
55
57
  # @!attribute [rw] answer_feedback
56
58
  # @return [::Google::Cloud::Dialogflow::V2::AnswerFeedback]
57
59
  # Required. The AnswerFeedback for this record. You can set this with
58
- # {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#update_answer_record AnswerRecords.UpdateAnswerRecord} in order to give us feedback about
59
- # this answer.
60
+ # {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#update_answer_record AnswerRecords.UpdateAnswerRecord}
61
+ # in order to give us feedback about this answer.
60
62
  # @!attribute [r] agent_assistant_record
61
63
  # @return [::Google::Cloud::Dialogflow::V2::AgentAssistantRecord]
62
64
  # Output only. The record for human agent assistant.
@@ -65,7 +67,8 @@ module Google
65
67
  extend ::Google::Protobuf::MessageExts::ClassMethods
66
68
  end
67
69
 
68
- # Request message for {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#list_answer_records AnswerRecords.ListAnswerRecords}.
70
+ # Request message for
71
+ # {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#list_answer_records AnswerRecords.ListAnswerRecords}.
69
72
  # @!attribute [rw] parent
70
73
  # @return [::String]
71
74
  # Required. The project to list all answer records for in reverse
@@ -95,7 +98,8 @@ module Google
95
98
  extend ::Google::Protobuf::MessageExts::ClassMethods
96
99
  end
97
100
 
98
- # Response message for {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#list_answer_records AnswerRecords.ListAnswerRecords}.
101
+ # Response message for
102
+ # {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#list_answer_records AnswerRecords.ListAnswerRecords}.
99
103
  # @!attribute [rw] answer_records
100
104
  # @return [::Array<::Google::Cloud::Dialogflow::V2::AnswerRecord>]
101
105
  # The list of answer records.
@@ -112,7 +116,8 @@ module Google
112
116
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
117
  end
114
118
 
115
- # Request message for {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#update_answer_record AnswerRecords.UpdateAnswerRecord}.
119
+ # Request message for
120
+ # {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#update_answer_record AnswerRecords.UpdateAnswerRecord}.
116
121
  # @!attribute [rw] answer_record
117
122
  # @return [::Google::Cloud::Dialogflow::V2::AnswerRecord]
118
123
  # Required. Answer record to update.
@@ -192,12 +197,32 @@ module Google
192
197
  # @return [::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentEfficiency]
193
198
  # Optional. Whether or not the suggested document is efficient. For example,
194
199
  # if the document is poorly written, hard to understand, hard to use or
195
- # too long to find useful information, {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback#document_efficiency document_efficiency} is
200
+ # too long to find useful information,
201
+ # {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback#document_efficiency document_efficiency}
202
+ # is
196
203
  # {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentEfficiency::INEFFICIENT DocumentEfficiency.INEFFICIENT}.
204
+ # @!attribute [rw] summarization_feedback
205
+ # @return [::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::SummarizationFeedback]
206
+ # Optional. Feedback for conversation summarization.
197
207
  class AgentAssistantFeedback
198
208
  include ::Google::Protobuf::MessageExts
199
209
  extend ::Google::Protobuf::MessageExts::ClassMethods
200
210
 
211
+ # Feedback for conversation summarization.
212
+ # @!attribute [rw] start_time
213
+ # @return [::Google::Protobuf::Timestamp]
214
+ # Timestamp when composing of the summary starts.
215
+ # @!attribute [rw] submit_time
216
+ # @return [::Google::Protobuf::Timestamp]
217
+ # Timestamp when the summary was submitted.
218
+ # @!attribute [rw] summary_text
219
+ # @return [::String]
220
+ # Text of actual submitted summary.
221
+ class SummarizationFeedback
222
+ include ::Google::Protobuf::MessageExts
223
+ extend ::Google::Protobuf::MessageExts::ClassMethods
224
+ end
225
+
201
226
  # Relevance of an answer.
202
227
  module AnswerRelevance
203
228
  # Answer relevance unspecified.
@@ -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