google-cloud-contact_center_insights-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +167 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google-cloud-contact_center_insights-v1.rb +21 -0
  7. data/lib/google/cloud/contact_center_insights/v1.rb +38 -0
  8. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights.rb +50 -0
  9. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/client.rb +2506 -0
  10. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/credentials.rb +47 -0
  11. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/operations.rb +664 -0
  12. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb +211 -0
  13. data/lib/google/cloud/contact_center_insights/v1/version.rb +28 -0
  14. data/lib/google/cloud/contactcenterinsights/v1/contact_center_insights_pb.rb +273 -0
  15. data/lib/google/cloud/contactcenterinsights/v1/contact_center_insights_services_pb.rb +102 -0
  16. data/lib/google/cloud/contactcenterinsights/v1/resources_pb.rb +408 -0
  17. data/proto_docs/README.md +4 -0
  18. data/proto_docs/google/api/field_behavior.rb +71 -0
  19. data/proto_docs/google/api/resource.rb +283 -0
  20. data/proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb +685 -0
  21. data/proto_docs/google/cloud/contactcenterinsights/v1/resources.rb +1213 -0
  22. data/proto_docs/google/longrunning/operations.rb +164 -0
  23. data/proto_docs/google/protobuf/any.rb +141 -0
  24. data/proto_docs/google/protobuf/duration.rb +98 -0
  25. data/proto_docs/google/protobuf/empty.rb +36 -0
  26. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  27. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  28. data/proto_docs/google/rpc/status.rb +46 -0
  29. metadata +220 -0
@@ -0,0 +1,1213 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module ContactCenterInsights
23
+ module V1
24
+ # The conversation resource.
25
+ # @!attribute [rw] call_metadata
26
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::CallMetadata]
27
+ # Call-specific metadata.
28
+ # @!attribute [rw] expire_time
29
+ # @return [::Google::Protobuf::Timestamp]
30
+ # The time at which this conversation should expire. After this time, the
31
+ # conversation data and any associated analyses will be deleted.
32
+ # @!attribute [rw] ttl
33
+ # @return [::Google::Protobuf::Duration]
34
+ # Input only. The TTL for this resource. If specified, then this TTL will
35
+ # be used to calculate the expire time.
36
+ # @!attribute [rw] name
37
+ # @return [::String]
38
+ # Immutable. The resource name of the conversation.
39
+ # Format:
40
+ # projects/\\{project}/locations/\\{location}/conversations/\\{conversation}
41
+ # @!attribute [rw] data_source
42
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationDataSource]
43
+ # The source of the audio and transcription for the conversation.
44
+ # @!attribute [r] create_time
45
+ # @return [::Google::Protobuf::Timestamp]
46
+ # Output only. The time at which the conversation was created.
47
+ # @!attribute [r] update_time
48
+ # @return [::Google::Protobuf::Timestamp]
49
+ # Output only. The most recent time at which the conversation was updated.
50
+ # @!attribute [rw] start_time
51
+ # @return [::Google::Protobuf::Timestamp]
52
+ # The time at which the conversation started.
53
+ # @!attribute [rw] language_code
54
+ # @return [::String]
55
+ # A user-specified language code for the conversation.
56
+ # @!attribute [rw] agent_id
57
+ # @return [::String]
58
+ # An opaque, user-specified string representing the human agent who handled
59
+ # the conversation.
60
+ # @!attribute [rw] labels
61
+ # @return [::Google::Protobuf::Map{::String => ::String}]
62
+ # A map for the user to specify any custom fields. A maximum of 20 labels per
63
+ # conversation is allowed, with a maximum of 256 characters per entry.
64
+ # @!attribute [r] transcript
65
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript]
66
+ # Output only. The conversation transcript.
67
+ # @!attribute [rw] medium
68
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium]
69
+ # Immutable. The conversation medium.
70
+ # @!attribute [r] duration
71
+ # @return [::Google::Protobuf::Duration]
72
+ # Output only. The duration of the conversation.
73
+ # @!attribute [r] turn_count
74
+ # @return [::Integer]
75
+ # Output only. The number of turns in the conversation.
76
+ # @!attribute [r] latest_analysis
77
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Analysis]
78
+ # Output only. The conversation's latest analysis, if one exists.
79
+ # @!attribute [r] runtime_annotations
80
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation>]
81
+ # Output only. The annotations that were generated during the customer and agent
82
+ # interaction.
83
+ # @!attribute [r] dialogflow_intents
84
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::DialogflowIntent}]
85
+ # Output only. All the matched Dialogflow intents in the call. The key corresponds to a
86
+ # Dialogflow intent, format:
87
+ # projects/\\{project}/agent/\\{agent}/intents/\\{intent}
88
+ class Conversation
89
+ include ::Google::Protobuf::MessageExts
90
+ extend ::Google::Protobuf::MessageExts::ClassMethods
91
+
92
+ # Call-specific metadata.
93
+ # @!attribute [rw] customer_channel
94
+ # @return [::Integer]
95
+ # The audio channel that contains the customer.
96
+ # @!attribute [rw] agent_channel
97
+ # @return [::Integer]
98
+ # The audio channel that contains the agent.
99
+ class CallMetadata
100
+ include ::Google::Protobuf::MessageExts
101
+ extend ::Google::Protobuf::MessageExts::ClassMethods
102
+ end
103
+
104
+ # A message representing the transcript of a conversation.
105
+ # @!attribute [rw] transcript_segments
106
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript::TranscriptSegment>]
107
+ # A list of sequential transcript segments that comprise the conversation.
108
+ class Transcript
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+
112
+ # A segment of a full transcript.
113
+ # @!attribute [rw] text
114
+ # @return [::String]
115
+ # The text of this segment.
116
+ # @!attribute [rw] confidence
117
+ # @return [::Float]
118
+ # A confidence estimate between 0.0 and 1.0 of the fidelity of this
119
+ # segment. A default value of 0.0 indicates that the value is unset.
120
+ # @!attribute [rw] words
121
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript::TranscriptSegment::WordInfo>]
122
+ # A list of the word-specific information for each word in the segment.
123
+ # @!attribute [rw] language_code
124
+ # @return [::String]
125
+ # The language code of this segment as a
126
+ # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
127
+ # Example: "en-US".
128
+ # @!attribute [rw] channel_tag
129
+ # @return [::Integer]
130
+ # For conversations derived from multi-channel audio, this is the channel
131
+ # number corresponding to the audio from that channel. For
132
+ # audioChannelCount = N, its output values can range from '1' to 'N'. A
133
+ # channel tag of 0 indicates that the audio is mono.
134
+ # @!attribute [rw] segment_participant
135
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant]
136
+ # The participant of this segment.
137
+ class TranscriptSegment
138
+ include ::Google::Protobuf::MessageExts
139
+ extend ::Google::Protobuf::MessageExts::ClassMethods
140
+
141
+ # Word-level info for words in a transcript.
142
+ # @!attribute [rw] start_offset
143
+ # @return [::Google::Protobuf::Duration]
144
+ # Time offset of the start of this word relative to the beginning of
145
+ # the total conversation.
146
+ # @!attribute [rw] end_offset
147
+ # @return [::Google::Protobuf::Duration]
148
+ # Time offset of the end of this word relative to the beginning of the
149
+ # total conversation.
150
+ # @!attribute [rw] word
151
+ # @return [::String]
152
+ # The word itself. Includes punctuation marks that surround the word.
153
+ # @!attribute [rw] confidence
154
+ # @return [::Float]
155
+ # A confidence estimate between 0.0 and 1.0 of the fidelity of this
156
+ # word. A default value of 0.0 indicates that the value is unset.
157
+ class WordInfo
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+ end
162
+ end
163
+
164
+ # @!attribute [rw] key
165
+ # @return [::String]
166
+ # @!attribute [rw] value
167
+ # @return [::String]
168
+ class LabelsEntry
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
172
+
173
+ # @!attribute [rw] key
174
+ # @return [::String]
175
+ # @!attribute [rw] value
176
+ # @return [::Google::Cloud::ContactCenterInsights::V1::DialogflowIntent]
177
+ class DialogflowIntentsEntry
178
+ include ::Google::Protobuf::MessageExts
179
+ extend ::Google::Protobuf::MessageExts::ClassMethods
180
+ end
181
+
182
+ # Possible media for the conversation.
183
+ module Medium
184
+ # Default value.
185
+ MEDIUM_UNSPECIFIED = 0
186
+
187
+ # The format for conversations that took place over the phone.
188
+ PHONE_CALL = 1
189
+
190
+ # The format for conversations that took place over chat.
191
+ CHAT = 2
192
+ end
193
+ end
194
+
195
+ # The analysis resource.
196
+ # @!attribute [rw] name
197
+ # @return [::String]
198
+ # Immutable. The resource name of the analysis.
199
+ # Format:
200
+ # projects/\\{project}/locations/\\{location}/conversations/\\{conversation}/analyses/\\{analysis}
201
+ # @!attribute [r] request_time
202
+ # @return [::Google::Protobuf::Timestamp]
203
+ # Output only. The time at which the analysis was requested.
204
+ # @!attribute [r] create_time
205
+ # @return [::Google::Protobuf::Timestamp]
206
+ # Output only. The time at which the analysis was created, which occurs when the
207
+ # long-running operation completes.
208
+ # @!attribute [r] analysis_result
209
+ # @return [::Google::Cloud::ContactCenterInsights::V1::AnalysisResult]
210
+ # Output only. The result of the analysis, which is populated when the analysis
211
+ # finishes.
212
+ class Analysis
213
+ include ::Google::Protobuf::MessageExts
214
+ extend ::Google::Protobuf::MessageExts::ClassMethods
215
+ end
216
+
217
+ # The conversation source, which is a combination of transcript and audio.
218
+ # @!attribute [rw] gcs_source
219
+ # @return [::Google::Cloud::ContactCenterInsights::V1::GcsSource]
220
+ # A Cloud Storage location specification for the audio and transcript.
221
+ # @!attribute [rw] dialogflow_source
222
+ # @return [::Google::Cloud::ContactCenterInsights::V1::DialogflowSource]
223
+ # The source when the conversation comes from Dialogflow.
224
+ class ConversationDataSource
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # A Cloud Storage source of conversation data.
230
+ # @!attribute [rw] audio_uri
231
+ # @return [::String]
232
+ # Cloud Storage URI that points to a file that contains the conversation
233
+ # audio.
234
+ # @!attribute [rw] transcript_uri
235
+ # @return [::String]
236
+ # Immutable. Cloud Storage URI that points to a file that contains the conversation
237
+ # transcript.
238
+ class GcsSource
239
+ include ::Google::Protobuf::MessageExts
240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
241
+ end
242
+
243
+ # A Dialogflow source of conversation data.
244
+ # @!attribute [r] dialogflow_conversation
245
+ # @return [::String]
246
+ # Output only. The name of the Dialogflow conversation that this conversation
247
+ # resource is derived from. Format:
248
+ # projects/\\{project}/locations/\\{location}/conversations/\\{conversation}
249
+ # @!attribute [rw] audio_uri
250
+ # @return [::String]
251
+ # Cloud Storage URI that points to a file that contains the conversation
252
+ # audio.
253
+ class DialogflowSource
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+ end
257
+
258
+ # The result of an analysis.
259
+ # @!attribute [rw] call_analysis_metadata
260
+ # @return [::Google::Cloud::ContactCenterInsights::V1::AnalysisResult::CallAnalysisMetadata]
261
+ # Call-specific metadata created by the analysis.
262
+ # @!attribute [rw] end_time
263
+ # @return [::Google::Protobuf::Timestamp]
264
+ # The time at which the analysis ended.
265
+ class AnalysisResult
266
+ include ::Google::Protobuf::MessageExts
267
+ extend ::Google::Protobuf::MessageExts::ClassMethods
268
+
269
+ # Call-specific metadata created during analysis.
270
+ # @!attribute [rw] annotations
271
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::CallAnnotation>]
272
+ # A list of call annotations that apply to this call.
273
+ # @!attribute [rw] entities
274
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::Entity}]
275
+ # All the entities in the call.
276
+ # @!attribute [rw] sentiments
277
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::ConversationLevelSentiment>]
278
+ # Overall conversation-level sentiment for each channel of the call.
279
+ # @!attribute [rw] intents
280
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::Intent}]
281
+ # All the matched intents in the call.
282
+ # @!attribute [rw] phrase_matchers
283
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::PhraseMatchData}]
284
+ # All the matched phrase matchers in the call.
285
+ # @!attribute [rw] issue_model_result
286
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelResult]
287
+ # Overall conversation-level issue modeling result.
288
+ class CallAnalysisMetadata
289
+ include ::Google::Protobuf::MessageExts
290
+ extend ::Google::Protobuf::MessageExts::ClassMethods
291
+
292
+ # @!attribute [rw] key
293
+ # @return [::String]
294
+ # @!attribute [rw] value
295
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Entity]
296
+ class EntitiesEntry
297
+ include ::Google::Protobuf::MessageExts
298
+ extend ::Google::Protobuf::MessageExts::ClassMethods
299
+ end
300
+
301
+ # @!attribute [rw] key
302
+ # @return [::String]
303
+ # @!attribute [rw] value
304
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Intent]
305
+ class IntentsEntry
306
+ include ::Google::Protobuf::MessageExts
307
+ extend ::Google::Protobuf::MessageExts::ClassMethods
308
+ end
309
+
310
+ # @!attribute [rw] key
311
+ # @return [::String]
312
+ # @!attribute [rw] value
313
+ # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatchData]
314
+ class PhraseMatchersEntry
315
+ include ::Google::Protobuf::MessageExts
316
+ extend ::Google::Protobuf::MessageExts::ClassMethods
317
+ end
318
+ end
319
+ end
320
+
321
+ # Issue Modeling result on a conversation.
322
+ # @!attribute [rw] issue_model
323
+ # @return [::String]
324
+ # Issue model that generates the result.
325
+ # @!attribute [rw] issues
326
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::IssueAssignment>]
327
+ # All the matched issues.
328
+ class IssueModelResult
329
+ include ::Google::Protobuf::MessageExts
330
+ extend ::Google::Protobuf::MessageExts::ClassMethods
331
+ end
332
+
333
+ # One channel of conversation-level sentiment data.
334
+ # @!attribute [rw] channel_tag
335
+ # @return [::Integer]
336
+ # The channel of the audio that the data applies to.
337
+ # @!attribute [rw] sentiment_data
338
+ # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData]
339
+ # Data specifying sentiment.
340
+ class ConversationLevelSentiment
341
+ include ::Google::Protobuf::MessageExts
342
+ extend ::Google::Protobuf::MessageExts::ClassMethods
343
+ end
344
+
345
+ # Information about the issue.
346
+ # @!attribute [rw] issue
347
+ # @return [::String]
348
+ # Resource name of the assigned issue.
349
+ # @!attribute [rw] score
350
+ # @return [::Float]
351
+ # Score indicating the likelihood of the issue assignment.
352
+ # currently bounded on [0,1].
353
+ class IssueAssignment
354
+ include ::Google::Protobuf::MessageExts
355
+ extend ::Google::Protobuf::MessageExts::ClassMethods
356
+ end
357
+
358
+ # A piece of metadata that applies to a window of a call.
359
+ # @!attribute [rw] interruption_data
360
+ # @return [::Google::Cloud::ContactCenterInsights::V1::InterruptionData]
361
+ # Data specifying an interruption.
362
+ # @!attribute [rw] sentiment_data
363
+ # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData]
364
+ # Data specifying sentiment.
365
+ # @!attribute [rw] silence_data
366
+ # @return [::Google::Cloud::ContactCenterInsights::V1::SilenceData]
367
+ # Data specifying silence.
368
+ # @!attribute [rw] hold_data
369
+ # @return [::Google::Cloud::ContactCenterInsights::V1::HoldData]
370
+ # Data specifying a hold.
371
+ # @!attribute [rw] entity_mention_data
372
+ # @return [::Google::Cloud::ContactCenterInsights::V1::EntityMentionData]
373
+ # Data specifying an entity mention.
374
+ # @!attribute [rw] intent_match_data
375
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IntentMatchData]
376
+ # Data specifying an intent match.
377
+ # @!attribute [rw] phrase_match_data
378
+ # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatchData]
379
+ # Data specifying a phrase match.
380
+ # @!attribute [rw] channel_tag
381
+ # @return [::Integer]
382
+ # The channel of the audio where the annotation occurs. For single-channel
383
+ # audio, this field is not populated.
384
+ # @!attribute [rw] annotation_start_boundary
385
+ # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary]
386
+ # The boundary in the conversation where the annotation starts, inclusive.
387
+ # @!attribute [rw] annotation_end_boundary
388
+ # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary]
389
+ # The boundary in the conversation where the annotation ends, inclusive.
390
+ class CallAnnotation
391
+ include ::Google::Protobuf::MessageExts
392
+ extend ::Google::Protobuf::MessageExts::ClassMethods
393
+ end
394
+
395
+ # A point in a conversation that marks the start or the end of an annotation.
396
+ # @!attribute [rw] word_index
397
+ # @return [::Integer]
398
+ # The word index of this boundary with respect to the first word in the
399
+ # transcript piece. This index starts at zero.
400
+ # @!attribute [rw] transcript_index
401
+ # @return [::Integer]
402
+ # The index in the sequence of transcribed pieces of the conversation where
403
+ # the boundary is located. This index starts at zero.
404
+ class AnnotationBoundary
405
+ include ::Google::Protobuf::MessageExts
406
+ extend ::Google::Protobuf::MessageExts::ClassMethods
407
+ end
408
+
409
+ # The data for an entity annotation.
410
+ # Represents a phrase in the conversation that is a known entity, such
411
+ # as a person, an organization, or location.
412
+ # @!attribute [rw] display_name
413
+ # @return [::String]
414
+ # The representative name for the entity.
415
+ # @!attribute [rw] type
416
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Entity::Type]
417
+ # The entity type.
418
+ # @!attribute [rw] metadata
419
+ # @return [::Google::Protobuf::Map{::String => ::String}]
420
+ # Metadata associated with the entity.
421
+ #
422
+ # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
423
+ # and Knowledge Graph MID (`mid`), if they are available. For the metadata
424
+ # associated with other entity types, see the Type table below.
425
+ # @!attribute [rw] salience
426
+ # @return [::Float]
427
+ # The salience score associated with the entity in the [0, 1.0] range.
428
+ #
429
+ # The salience score for an entity provides information about the
430
+ # importance or centrality of that entity to the entire document text.
431
+ # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
432
+ # salient.
433
+ # @!attribute [rw] sentiment
434
+ # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData]
435
+ # The aggregate sentiment expressed for this entity in the conversation.
436
+ class Entity
437
+ include ::Google::Protobuf::MessageExts
438
+ extend ::Google::Protobuf::MessageExts::ClassMethods
439
+
440
+ # @!attribute [rw] key
441
+ # @return [::String]
442
+ # @!attribute [rw] value
443
+ # @return [::String]
444
+ class MetadataEntry
445
+ include ::Google::Protobuf::MessageExts
446
+ extend ::Google::Protobuf::MessageExts::ClassMethods
447
+ end
448
+
449
+ # The type of the entity. For most entity types, the associated metadata is a
450
+ # Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). The table
451
+ # below lists the associated fields for entities that have different
452
+ # metadata.
453
+ module Type
454
+ # Unspecified.
455
+ TYPE_UNSPECIFIED = 0
456
+
457
+ # Person.
458
+ PERSON = 1
459
+
460
+ # Location.
461
+ LOCATION = 2
462
+
463
+ # Organization.
464
+ ORGANIZATION = 3
465
+
466
+ # Event.
467
+ EVENT = 4
468
+
469
+ # Artwork.
470
+ WORK_OF_ART = 5
471
+
472
+ # Consumer product.
473
+ CONSUMER_GOOD = 6
474
+
475
+ # Other types of entities.
476
+ OTHER = 7
477
+
478
+ # Phone number.
479
+ #
480
+ # The metadata lists the phone number (formatted according to local
481
+ # convention), plus whichever additional elements appear in the text:
482
+ #
483
+ # * `number` - The actual number, broken down into sections according to
484
+ # local convention.
485
+ # * `national_prefix` - Country code, if detected.
486
+ # * `area_code` - Region or area code, if detected.
487
+ # * `extension` - Phone extension (to be dialed after connection), if
488
+ # detected.
489
+ PHONE_NUMBER = 9
490
+
491
+ # Address.
492
+ #
493
+ # The metadata identifies the street number and locality plus whichever
494
+ # additional elements appear in the text:
495
+ #
496
+ # * `street_number` - Street number.
497
+ # * `locality` - City or town.
498
+ # * `street_name` - Street/route name, if detected.
499
+ # * `postal_code` - Postal code, if detected.
500
+ # * `country` - Country, if detected.
501
+ # * `broad_region` - Administrative area, such as the state, if detected.
502
+ # * `narrow_region` - Smaller administrative area, such as county, if
503
+ # detected.
504
+ # * `sublocality` - Used in Asian addresses to demark a district within a
505
+ # city, if detected.
506
+ ADDRESS = 10
507
+
508
+ # Date.
509
+ #
510
+ # The metadata identifies the components of the date:
511
+ #
512
+ # * `year` - Four digit year, if detected.
513
+ # * `month` - Two digit month number, if detected.
514
+ # * `day` - Two digit day number, if detected.
515
+ DATE = 11
516
+
517
+ # Number.
518
+ #
519
+ # The metadata is the number itself.
520
+ NUMBER = 12
521
+
522
+ # Price.
523
+ #
524
+ # The metadata identifies the `value` and `currency`.
525
+ PRICE = 13
526
+ end
527
+ end
528
+
529
+ # The data for an intent.
530
+ # Represents a detected intent in the conversation, for example MAKES_PROMISE.
531
+ # @!attribute [rw] id
532
+ # @return [::String]
533
+ # The unique identifier of the intent.
534
+ # @!attribute [rw] display_name
535
+ # @return [::String]
536
+ # The human-readable name of the intent.
537
+ class Intent
538
+ include ::Google::Protobuf::MessageExts
539
+ extend ::Google::Protobuf::MessageExts::ClassMethods
540
+ end
541
+
542
+ # The data for a matched phrase matcher.
543
+ # Represents information identifying a phrase matcher for a given match.
544
+ # @!attribute [rw] phrase_matcher
545
+ # @return [::String]
546
+ # The unique identifier (the resource name) of the phrase matcher.
547
+ # @!attribute [rw] display_name
548
+ # @return [::String]
549
+ # The human-readable name of the phrase matcher.
550
+ class PhraseMatchData
551
+ include ::Google::Protobuf::MessageExts
552
+ extend ::Google::Protobuf::MessageExts::ClassMethods
553
+ end
554
+
555
+ # The data for a Dialogflow intent.
556
+ # Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
557
+ # @!attribute [rw] display_name
558
+ # @return [::String]
559
+ # The human-readable name of the intent.
560
+ class DialogflowIntent
561
+ include ::Google::Protobuf::MessageExts
562
+ extend ::Google::Protobuf::MessageExts::ClassMethods
563
+ end
564
+
565
+ # The data for an interruption annotation.
566
+ class InterruptionData
567
+ include ::Google::Protobuf::MessageExts
568
+ extend ::Google::Protobuf::MessageExts::ClassMethods
569
+ end
570
+
571
+ # The data for a silence annotation.
572
+ class SilenceData
573
+ include ::Google::Protobuf::MessageExts
574
+ extend ::Google::Protobuf::MessageExts::ClassMethods
575
+ end
576
+
577
+ # The data for a hold annotation.
578
+ class HoldData
579
+ include ::Google::Protobuf::MessageExts
580
+ extend ::Google::Protobuf::MessageExts::ClassMethods
581
+ end
582
+
583
+ # The data for an entity mention annotation.
584
+ # This represents a mention of an `Entity` in the conversation.
585
+ # @!attribute [rw] entity_unique_id
586
+ # @return [::String]
587
+ # The key of this entity in conversation entities.
588
+ # Can be used to retrieve the exact `Entity` this mention is attached to.
589
+ # @!attribute [rw] type
590
+ # @return [::Google::Cloud::ContactCenterInsights::V1::EntityMentionData::MentionType]
591
+ # The type of the entity mention.
592
+ # @!attribute [rw] sentiment
593
+ # @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData]
594
+ # Sentiment expressed for this mention of the entity.
595
+ class EntityMentionData
596
+ include ::Google::Protobuf::MessageExts
597
+ extend ::Google::Protobuf::MessageExts::ClassMethods
598
+
599
+ # The supported types of mentions.
600
+ module MentionType
601
+ # Unspecified.
602
+ MENTION_TYPE_UNSPECIFIED = 0
603
+
604
+ # Proper noun.
605
+ PROPER = 1
606
+
607
+ # Common noun (or noun compound).
608
+ COMMON = 2
609
+ end
610
+ end
611
+
612
+ # The data for an intent match.
613
+ # Represents an intent match for a text segment in the conversation. A text
614
+ # segment can be part of a sentence, a complete sentence, or an utterance
615
+ # with multiple sentences.
616
+ # @!attribute [rw] intent_unique_id
617
+ # @return [::String]
618
+ # The id of the matched intent.
619
+ # Can be used to retrieve the corresponding intent information.
620
+ class IntentMatchData
621
+ include ::Google::Protobuf::MessageExts
622
+ extend ::Google::Protobuf::MessageExts::ClassMethods
623
+ end
624
+
625
+ # The data for a sentiment annotation.
626
+ # @!attribute [rw] magnitude
627
+ # @return [::Float]
628
+ # A non-negative number from 0 to infinity which represents the abolute
629
+ # magnitude of sentiment regardless of score.
630
+ # @!attribute [rw] score
631
+ # @return [::Float]
632
+ # The sentiment score between -1.0 (negative) and 1.0 (positive).
633
+ class SentimentData
634
+ include ::Google::Protobuf::MessageExts
635
+ extend ::Google::Protobuf::MessageExts::ClassMethods
636
+ end
637
+
638
+ # The issue model resource.
639
+ # @!attribute [rw] name
640
+ # @return [::String]
641
+ # Immutable. The resource name of the issue model.
642
+ # Format:
643
+ # projects/\\{project}/locations/\\{location}/issueModels/\\{issue_model}
644
+ # @!attribute [rw] display_name
645
+ # @return [::String]
646
+ # The representative name for the issue model.
647
+ # @!attribute [r] create_time
648
+ # @return [::Google::Protobuf::Timestamp]
649
+ # Output only. The time at which this issue model was created.
650
+ # @!attribute [r] update_time
651
+ # @return [::Google::Protobuf::Timestamp]
652
+ # Output only. The most recent time at which the issue model was updated.
653
+ # @!attribute [r] state
654
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModel::State]
655
+ # Output only. State of the model.
656
+ # @!attribute [rw] input_data_config
657
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModel::InputDataConfig]
658
+ # Configs for the input data that used to create the issue model.
659
+ # @!attribute [r] training_stats
660
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats]
661
+ # Output only. Immutable. The issue model's label statistics on its training data.
662
+ class IssueModel
663
+ include ::Google::Protobuf::MessageExts
664
+ extend ::Google::Protobuf::MessageExts::ClassMethods
665
+
666
+ # Configs for the input data used to create the issue model.
667
+ # @!attribute [rw] medium
668
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium]
669
+ # Required. Medium of conversations used in training data.
670
+ # @!attribute [r] training_conversations_count
671
+ # @return [::Integer]
672
+ # Output only. Number of conversations used in training. Output only.
673
+ class InputDataConfig
674
+ include ::Google::Protobuf::MessageExts
675
+ extend ::Google::Protobuf::MessageExts::ClassMethods
676
+ end
677
+
678
+ # State of the model.
679
+ module State
680
+ # Unspecified.
681
+ STATE_UNSPECIFIED = 0
682
+
683
+ # Model is not deployed but is ready to deploy.
684
+ UNDEPLOYED = 1
685
+
686
+ # Model is being deployed.
687
+ DEPLOYING = 2
688
+
689
+ # Model is deployed and is ready to be used. A model can only be used in
690
+ # analysis if it's in this state.
691
+ DEPLOYED = 3
692
+
693
+ # Model is being undeployed.
694
+ UNDEPLOYING = 4
695
+
696
+ # Model is being deleted.
697
+ DELETING = 5
698
+ end
699
+ end
700
+
701
+ # The issue resource.
702
+ # @!attribute [rw] name
703
+ # @return [::String]
704
+ # Immutable. The resource name of the issue.
705
+ # Format:
706
+ # projects/\\{project}/locations/\\{location}/issueModels/\\{issue_model}/issues/\\{issue}
707
+ # @!attribute [rw] display_name
708
+ # @return [::String]
709
+ # The representative name for the issue.
710
+ # @!attribute [r] create_time
711
+ # @return [::Google::Protobuf::Timestamp]
712
+ # Output only. The time at which this issue was created.
713
+ # @!attribute [r] update_time
714
+ # @return [::Google::Protobuf::Timestamp]
715
+ # Output only. The most recent time that this issue was updated.
716
+ class Issue
717
+ include ::Google::Protobuf::MessageExts
718
+ extend ::Google::Protobuf::MessageExts::ClassMethods
719
+ end
720
+
721
+ # Aggregated statistics about an issue model.
722
+ # @!attribute [rw] analyzed_conversations_count
723
+ # @return [::Integer]
724
+ # Number of conversations the issue model has analyzed at this point in time.
725
+ # @!attribute [rw] unclassified_conversations_count
726
+ # @return [::Integer]
727
+ # Number of analyzed conversations for which no issue was applicable at this
728
+ # point in time.
729
+ # @!attribute [rw] issue_stats
730
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats::IssueStats}]
731
+ # Statistics on each issue. Key is the issue's resource name.
732
+ class IssueModelLabelStats
733
+ include ::Google::Protobuf::MessageExts
734
+ extend ::Google::Protobuf::MessageExts::ClassMethods
735
+
736
+ # Aggregated statistics about an issue.
737
+ # @!attribute [rw] issue
738
+ # @return [::String]
739
+ # Issue resource.
740
+ # Format:
741
+ # projects/\\{project}/locations/\\{location}/issueModels/\\{issue_model}/issues/\\{issue}
742
+ # @!attribute [rw] labeled_conversations_count
743
+ # @return [::Integer]
744
+ # Number of conversations attached to the issue at this point in time.
745
+ class IssueStats
746
+ include ::Google::Protobuf::MessageExts
747
+ extend ::Google::Protobuf::MessageExts::ClassMethods
748
+ end
749
+
750
+ # @!attribute [rw] key
751
+ # @return [::String]
752
+ # @!attribute [rw] value
753
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats::IssueStats]
754
+ class IssueStatsEntry
755
+ include ::Google::Protobuf::MessageExts
756
+ extend ::Google::Protobuf::MessageExts::ClassMethods
757
+ end
758
+ end
759
+
760
+ # The phrase matcher resource.
761
+ # @!attribute [rw] name
762
+ # @return [::String]
763
+ # The resource name of the phrase matcher.
764
+ # Format:
765
+ # projects/\\{project}/locations/\\{location}/phraseMatchers/\\{phrase_matcher}
766
+ # @!attribute [r] revision_id
767
+ # @return [::String]
768
+ # Output only. Immutable. The revision ID of the phrase matcher.
769
+ # A new revision is committed whenever the matcher is changed, except when it
770
+ # is activated or deactivated. A server generated random ID will be used.
771
+ # Example: locations/global/phraseMatchers/my-first-matcher@1234567
772
+ # @!attribute [rw] version_tag
773
+ # @return [::String]
774
+ # The customized version tag to use for the phrase matcher. If not specified,
775
+ # it will default to `revision_id`.
776
+ # @!attribute [r] revision_create_time
777
+ # @return [::Google::Protobuf::Timestamp]
778
+ # Output only. The timestamp of when the revision was created. It is also the create time
779
+ # when a new matcher is added.
780
+ # @!attribute [rw] display_name
781
+ # @return [::String]
782
+ # The human-readable name of the phrase matcher.
783
+ # @!attribute [rw] type
784
+ # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher::PhraseMatcherType]
785
+ # Required. The type of this phrase matcher.
786
+ # @!attribute [rw] active
787
+ # @return [::Boolean]
788
+ # Applies the phrase matcher only when it is active.
789
+ # @!attribute [rw] phrase_match_rule_groups
790
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup>]
791
+ # A list of phase match rule groups that are included in this matcher.
792
+ # @!attribute [r] activation_update_time
793
+ # @return [::Google::Protobuf::Timestamp]
794
+ # Output only. The most recent time at which the activation status was updated.
795
+ # @!attribute [rw] role_match
796
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role]
797
+ # The role whose utterances the phrase matcher should be matched
798
+ # against. If the role is ROLE_UNSPECIFIED it will be matched against any
799
+ # utterances in the transcript.
800
+ class PhraseMatcher
801
+ include ::Google::Protobuf::MessageExts
802
+ extend ::Google::Protobuf::MessageExts::ClassMethods
803
+
804
+ # Specifies how to combine each phrase match rule group to determine whether
805
+ # there is a match.
806
+ module PhraseMatcherType
807
+ # Unspecified.
808
+ PHRASE_MATCHER_TYPE_UNSPECIFIED = 0
809
+
810
+ # Must meet all phrase match rule groups or there is no match.
811
+ ALL_OF = 1
812
+
813
+ # If any of the phrase match rule groups are met, there is a match.
814
+ ANY_OF = 2
815
+ end
816
+ end
817
+
818
+ # A message representing a rule in the phrase matcher.
819
+ # @!attribute [rw] type
820
+ # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleGroup::PhraseMatchRuleGroupType]
821
+ # Required. The type of this phrase match rule group.
822
+ # @!attribute [rw] phrase_match_rules
823
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRule>]
824
+ # A list of phase match rules that are included in this group.
825
+ class PhraseMatchRuleGroup
826
+ include ::Google::Protobuf::MessageExts
827
+ extend ::Google::Protobuf::MessageExts::ClassMethods
828
+
829
+ # Specifies how to combine each phrase match rule for whether there is a
830
+ # match.
831
+ module PhraseMatchRuleGroupType
832
+ # Unspecified.
833
+ PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED = 0
834
+
835
+ # Must meet all phrase match rules or there is no match.
836
+ ALL_OF = 1
837
+
838
+ # If any of the phrase match rules are met, there is a match.
839
+ ANY_OF = 2
840
+ end
841
+ end
842
+
843
+ # The data for a phrase match rule.
844
+ # @!attribute [rw] query
845
+ # @return [::String]
846
+ # Required. The phrase to be matched.
847
+ # @!attribute [rw] negated
848
+ # @return [::Boolean]
849
+ # Specifies whether the phrase must be missing from the transcript segment or
850
+ # present in the transcript segment.
851
+ # @!attribute [rw] config
852
+ # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatchRuleConfig]
853
+ # Provides additional information about the rule that specifies how to apply
854
+ # the rule.
855
+ class PhraseMatchRule
856
+ include ::Google::Protobuf::MessageExts
857
+ extend ::Google::Protobuf::MessageExts::ClassMethods
858
+ end
859
+
860
+ # Configuration information of a phrase match rule.
861
+ # @!attribute [rw] exact_match_config
862
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ExactMatchConfig]
863
+ # The configuration for the exact match rule.
864
+ class PhraseMatchRuleConfig
865
+ include ::Google::Protobuf::MessageExts
866
+ extend ::Google::Protobuf::MessageExts::ClassMethods
867
+ end
868
+
869
+ # Exact match configuration.
870
+ # @!attribute [rw] case_sensitive
871
+ # @return [::Boolean]
872
+ # Whether to consider case sensitivity when performing an exact match.
873
+ class ExactMatchConfig
874
+ include ::Google::Protobuf::MessageExts
875
+ extend ::Google::Protobuf::MessageExts::ClassMethods
876
+ end
877
+
878
+ # The settings resource.
879
+ # @!attribute [rw] name
880
+ # @return [::String]
881
+ # Immutable. The resource name of the settings resource.
882
+ # Format:
883
+ # projects/\\{project}/locations/\\{location}/settings
884
+ # @!attribute [r] create_time
885
+ # @return [::Google::Protobuf::Timestamp]
886
+ # Output only. The time at which the settings was created.
887
+ # @!attribute [r] update_time
888
+ # @return [::Google::Protobuf::Timestamp]
889
+ # Output only. The time at which the settings were last updated.
890
+ # @!attribute [rw] language_code
891
+ # @return [::String]
892
+ # A language code to be applied to each transcript segment unless the segment
893
+ # already specifies a language code. Language code defaults to "en-US" if it
894
+ # is neither specified on the segment nor here.
895
+ # @!attribute [rw] conversation_ttl
896
+ # @return [::Google::Protobuf::Duration]
897
+ # The default TTL for newly-created conversations. If a conversation has a
898
+ # specified expiration, that value will be used instead. Changing this
899
+ # value will not change the expiration of existing conversations.
900
+ # Conversations with no expire time persist until they are deleted.
901
+ # @!attribute [rw] pubsub_notification_settings
902
+ # @return [::Google::Protobuf::Map{::String => ::String}]
903
+ # A map that maps a notification trigger to a Pub/Sub topic. Each time a
904
+ # specified trigger occurs, Insights will notify the corresponding Pub/Sub
905
+ # topic.
906
+ #
907
+ # Keys are notification triggers. Supported keys are:
908
+ #
909
+ # * "all-triggers": Notify each time any of the supported triggers occurs.
910
+ # * "create-analysis": Notify each time an analysis is created.
911
+ # * "create-conversation": Notify each time a conversation is created.
912
+ # * "export-insights-data": Notify each time an export is complete.
913
+ # * "update-conversation": Notify each time a conversation is updated via
914
+ # UpdateConversation.
915
+ #
916
+ # Values are Pub/Sub topics. The format of each Pub/Sub topic is:
917
+ # projects/\\{project}/topics/\\{topic}
918
+ # @!attribute [rw] analysis_config
919
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Settings::AnalysisConfig]
920
+ # Default analysis settings.
921
+ class Settings
922
+ include ::Google::Protobuf::MessageExts
923
+ extend ::Google::Protobuf::MessageExts::ClassMethods
924
+
925
+ # Default configuration when creating Analyses in Insights.
926
+ # @!attribute [rw] runtime_integration_analysis_percentage
927
+ # @return [::Float]
928
+ # Percentage of conversations created using Dialogflow runtime integration
929
+ # to analyze automatically, between [0, 100].
930
+ class AnalysisConfig
931
+ include ::Google::Protobuf::MessageExts
932
+ extend ::Google::Protobuf::MessageExts::ClassMethods
933
+ end
934
+
935
+ # @!attribute [rw] key
936
+ # @return [::String]
937
+ # @!attribute [rw] value
938
+ # @return [::String]
939
+ class PubsubNotificationSettingsEntry
940
+ include ::Google::Protobuf::MessageExts
941
+ extend ::Google::Protobuf::MessageExts::ClassMethods
942
+ end
943
+ end
944
+
945
+ # An annotation that was generated during the customer and agent interaction.
946
+ # @!attribute [rw] article_suggestion
947
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData]
948
+ # Agent Assist Article Suggestion data.
949
+ # @!attribute [rw] faq_answer
950
+ # @return [::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData]
951
+ # Agent Assist FAQ answer data.
952
+ # @!attribute [rw] smart_reply
953
+ # @return [::Google::Cloud::ContactCenterInsights::V1::SmartReplyData]
954
+ # Agent Assist Smart Reply data.
955
+ # @!attribute [rw] smart_compose_suggestion
956
+ # @return [::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData]
957
+ # Agent Assist Smart Compose suggestion data.
958
+ # @!attribute [rw] dialogflow_interaction
959
+ # @return [::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData]
960
+ # Dialogflow interaction data.
961
+ # @!attribute [rw] annotation_id
962
+ # @return [::String]
963
+ # The unique identifier of the annotation.
964
+ # Format:
965
+ # projects/\\{project}/locations/\\{location}/conversationDatasets/\\{dataset}/conversationDataItems/\\{data_item}/conversationAnnotations/\\{annotation}
966
+ # @!attribute [rw] create_time
967
+ # @return [::Google::Protobuf::Timestamp]
968
+ # The time at which this annotation was created.
969
+ # @!attribute [rw] start_boundary
970
+ # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary]
971
+ # The boundary in the conversation where the annotation starts, inclusive.
972
+ # @!attribute [rw] end_boundary
973
+ # @return [::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary]
974
+ # The boundary in the conversation where the annotation ends, inclusive.
975
+ # @!attribute [rw] answer_feedback
976
+ # @return [::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback]
977
+ # The feedback that the customer has about the answer in `data`.
978
+ class RuntimeAnnotation
979
+ include ::Google::Protobuf::MessageExts
980
+ extend ::Google::Protobuf::MessageExts::ClassMethods
981
+ end
982
+
983
+ # The feedback that the customer has about a certain answer in the
984
+ # conversation.
985
+ # @!attribute [rw] correctness_level
986
+ # @return [::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback::CorrectnessLevel]
987
+ # The correctness level of an answer.
988
+ # @!attribute [rw] clicked
989
+ # @return [::Boolean]
990
+ # Indicates whether an answer or item was clicked by the human agent.
991
+ # @!attribute [rw] displayed
992
+ # @return [::Boolean]
993
+ # Indicates whether an answer or item was displayed to the human agent in the
994
+ # agent desktop UI.
995
+ class AnswerFeedback
996
+ include ::Google::Protobuf::MessageExts
997
+ extend ::Google::Protobuf::MessageExts::ClassMethods
998
+
999
+ # The correctness level of an answer.
1000
+ module CorrectnessLevel
1001
+ # Correctness level unspecified.
1002
+ CORRECTNESS_LEVEL_UNSPECIFIED = 0
1003
+
1004
+ # Answer is totally wrong.
1005
+ NOT_CORRECT = 1
1006
+
1007
+ # Answer is partially correct.
1008
+ PARTIALLY_CORRECT = 2
1009
+
1010
+ # Answer is fully correct.
1011
+ FULLY_CORRECT = 3
1012
+ end
1013
+ end
1014
+
1015
+ # Agent Assist Article Suggestion data.
1016
+ # @!attribute [rw] title
1017
+ # @return [::String]
1018
+ # Article title.
1019
+ # @!attribute [rw] uri
1020
+ # @return [::String]
1021
+ # Article URI.
1022
+ # @!attribute [rw] confidence_score
1023
+ # @return [::Float]
1024
+ # The system's confidence score that this article is a good match for this
1025
+ # conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
1026
+ # certain).
1027
+ # @!attribute [rw] metadata
1028
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1029
+ # Map that contains metadata about the Article Suggestion and the document
1030
+ # that it originates from.
1031
+ # @!attribute [rw] query_record
1032
+ # @return [::String]
1033
+ # Name of the query record.
1034
+ # Format:
1035
+ # projects/\\{project}/locations/\\{location}/queryRecords/\\{query_record}
1036
+ # @!attribute [rw] source
1037
+ # @return [::String]
1038
+ # The knowledge document that this answer was extracted from.
1039
+ # Format:
1040
+ # projects/\\{project}/knowledgeBases/\\{knowledge_base}/documents/\\{document}
1041
+ class ArticleSuggestionData
1042
+ include ::Google::Protobuf::MessageExts
1043
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1044
+
1045
+ # @!attribute [rw] key
1046
+ # @return [::String]
1047
+ # @!attribute [rw] value
1048
+ # @return [::String]
1049
+ class MetadataEntry
1050
+ include ::Google::Protobuf::MessageExts
1051
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1052
+ end
1053
+ end
1054
+
1055
+ # Agent Assist frequently-asked-question answer data.
1056
+ # @!attribute [rw] answer
1057
+ # @return [::String]
1058
+ # The piece of text from the `source` knowledge base document.
1059
+ # @!attribute [rw] confidence_score
1060
+ # @return [::Float]
1061
+ # The system's confidence score that this answer is a good match for this
1062
+ # conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
1063
+ # certain).
1064
+ # @!attribute [rw] question
1065
+ # @return [::String]
1066
+ # The corresponding FAQ question.
1067
+ # @!attribute [rw] metadata
1068
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1069
+ # Map that contains metadata about the FAQ answer and the document that
1070
+ # it originates from.
1071
+ # @!attribute [rw] query_record
1072
+ # @return [::String]
1073
+ # Name of the query record.
1074
+ # Format:
1075
+ # projects/\\{project}/locations/\\{location}/queryRecords/\\{query_record}.
1076
+ # @!attribute [rw] source
1077
+ # @return [::String]
1078
+ # The knowledge document that this answer was extracted from.
1079
+ # Format:
1080
+ # projects/\\{project}/knowledgeBases/\\{knowledge_base}/documents/\\{document}.
1081
+ class FaqAnswerData
1082
+ include ::Google::Protobuf::MessageExts
1083
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1084
+
1085
+ # @!attribute [rw] key
1086
+ # @return [::String]
1087
+ # @!attribute [rw] value
1088
+ # @return [::String]
1089
+ class MetadataEntry
1090
+ include ::Google::Protobuf::MessageExts
1091
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1092
+ end
1093
+ end
1094
+
1095
+ # Agent Assist Smart Reply data.
1096
+ # @!attribute [rw] reply
1097
+ # @return [::String]
1098
+ # The content of the reply.
1099
+ # @!attribute [rw] confidence_score
1100
+ # @return [::Float]
1101
+ # The system's confidence score that this reply is a good match for this
1102
+ # conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
1103
+ # certain).
1104
+ # @!attribute [rw] metadata
1105
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1106
+ # Map that contains metadata about the Smart Reply and the document from
1107
+ # which it originates.
1108
+ # @!attribute [rw] query_record
1109
+ # @return [::String]
1110
+ # Name of the query record.
1111
+ # Format:
1112
+ # projects/\\{project}/locations/\\{location}/queryRecords/\\{query_record}
1113
+ class SmartReplyData
1114
+ include ::Google::Protobuf::MessageExts
1115
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1116
+
1117
+ # @!attribute [rw] key
1118
+ # @return [::String]
1119
+ # @!attribute [rw] value
1120
+ # @return [::String]
1121
+ class MetadataEntry
1122
+ include ::Google::Protobuf::MessageExts
1123
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1124
+ end
1125
+ end
1126
+
1127
+ # Agent Assist Smart Compose suggestion data.
1128
+ # @!attribute [rw] suggestion
1129
+ # @return [::String]
1130
+ # The content of the suggestion.
1131
+ # @!attribute [rw] confidence_score
1132
+ # @return [::Float]
1133
+ # The system's confidence score that this suggestion is a good match for this
1134
+ # conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
1135
+ # certain).
1136
+ # @!attribute [rw] metadata
1137
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1138
+ # Map that contains metadata about the Smart Compose suggestion and the
1139
+ # document from which it originates.
1140
+ # @!attribute [rw] query_record
1141
+ # @return [::String]
1142
+ # Name of the query record.
1143
+ # Format:
1144
+ # projects/\\{project}/locations/\\{location}/queryRecords/\\{query_record}
1145
+ class SmartComposeSuggestionData
1146
+ include ::Google::Protobuf::MessageExts
1147
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1148
+
1149
+ # @!attribute [rw] key
1150
+ # @return [::String]
1151
+ # @!attribute [rw] value
1152
+ # @return [::String]
1153
+ class MetadataEntry
1154
+ include ::Google::Protobuf::MessageExts
1155
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1156
+ end
1157
+ end
1158
+
1159
+ # Dialogflow interaction data.
1160
+ # @!attribute [rw] dialogflow_intent_id
1161
+ # @return [::String]
1162
+ # The Dialogflow intent resource path. Format:
1163
+ # projects/\\{project}/agent/\\{agent}/intents/\\{intent}
1164
+ # @!attribute [rw] confidence
1165
+ # @return [::Float]
1166
+ # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0
1167
+ # (completely certain).
1168
+ class DialogflowInteractionData
1169
+ include ::Google::Protobuf::MessageExts
1170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1171
+ end
1172
+
1173
+ # The call participant speaking for a given utterance.
1174
+ # @!attribute [rw] dialogflow_participant_name
1175
+ # @return [::String]
1176
+ # The name of the participant provided by Dialogflow. Format:
1177
+ # projects/\\{project}/locations/\\{location}/conversations/\\{conversation}/participants/\\{participant}
1178
+ # @!attribute [rw] user_id
1179
+ # @return [::String]
1180
+ # A user-specified ID representing the participant.
1181
+ # @!attribute [rw] dialogflow_participant
1182
+ # @return [::String]
1183
+ # The name of the Dialogflow participant. Format:
1184
+ # projects/\\{project}/locations/\\{location}/conversations/\\{conversation}/participants/\\{participant}
1185
+ # @!attribute [rw] role
1186
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role]
1187
+ # The role of the participant.
1188
+ class ConversationParticipant
1189
+ include ::Google::Protobuf::MessageExts
1190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1191
+
1192
+ # The role of the participant.
1193
+ module Role
1194
+ # Participant's role is not set.
1195
+ ROLE_UNSPECIFIED = 0
1196
+
1197
+ # Participant is a human agent.
1198
+ HUMAN_AGENT = 1
1199
+
1200
+ # Participant is an automated agent.
1201
+ AUTOMATED_AGENT = 2
1202
+
1203
+ # Participant is an end user who conversed with the contact center.
1204
+ END_USER = 3
1205
+
1206
+ # Participant is either a human or automated agent.
1207
+ ANY_AGENT = 4
1208
+ end
1209
+ end
1210
+ end
1211
+ end
1212
+ end
1213
+ end