google-cloud-contact_center_insights-v1 0.3.0 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/client.rb +1203 -87
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/operations.rb +115 -12
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb +19 -0
- data/lib/google/cloud/contact_center_insights/v1/version.rb +1 -1
- data/lib/google/cloud/contactcenterinsights/v1/contact_center_insights_pb.rb +44 -2
- data/lib/google/cloud/contactcenterinsights/v1/contact_center_insights_services_pb.rb +13 -1
- data/lib/google/cloud/contactcenterinsights/v1/resources_pb.rb +20 -3
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb +127 -6
- data/proto_docs/google/cloud/contactcenterinsights/v1/resources.rb +54 -2
- metadata +3 -3
@@ -57,8 +57,13 @@ module Google
|
|
57
57
|
# @return [::Google::Protobuf::Map{::String => ::Integer}]
|
58
58
|
# A map associating each issue resource name with its respective number of
|
59
59
|
# matches in the set of conversations. Key has the format:
|
60
|
-
# `projects/<Project
|
61
|
-
#
|
60
|
+
# `projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>`
|
61
|
+
# Deprecated, use `issue_matches_stats` field instead.
|
62
|
+
# @!attribute [rw] issue_matches_stats
|
63
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats::IssueStats}]
|
64
|
+
# A map associating each issue resource name with its respective number of
|
65
|
+
# matches in the set of conversations. Key has the format:
|
66
|
+
# `projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>`
|
62
67
|
# @!attribute [rw] conversation_count_time_series
|
63
68
|
# @return [::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse::TimeSeries]
|
64
69
|
# A time series representing the count of conversations created over time
|
@@ -119,6 +124,15 @@ module Google
|
|
119
124
|
include ::Google::Protobuf::MessageExts
|
120
125
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
121
126
|
end
|
127
|
+
|
128
|
+
# @!attribute [rw] key
|
129
|
+
# @return [::String]
|
130
|
+
# @!attribute [rw] value
|
131
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats::IssueStats]
|
132
|
+
class IssueMatchesStatsEntry
|
133
|
+
include ::Google::Protobuf::MessageExts
|
134
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
135
|
+
end
|
122
136
|
end
|
123
137
|
|
124
138
|
# Metadata for a create analysis operation.
|
@@ -149,8 +163,8 @@ module Google
|
|
149
163
|
# component of the conversation's resource name. If no ID is specified, a
|
150
164
|
# server-generated ID will be used.
|
151
165
|
#
|
152
|
-
# This value should be 4-
|
153
|
-
# expression
|
166
|
+
# This value should be 4-64 characters and must match the regular
|
167
|
+
# expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
|
154
168
|
class CreateConversationRequest
|
155
169
|
include ::Google::Protobuf::MessageExts
|
156
170
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -318,6 +332,9 @@ module Google
|
|
318
332
|
# A fully qualified KMS key name for BigQuery tables protected by CMEK.
|
319
333
|
# Format:
|
320
334
|
# projects/\\{project}/locations/\\{location}/keyRings/\\{keyring}/cryptoKeys/\\{key}/cryptoKeyVersions/\\{version}
|
335
|
+
# @!attribute [rw] write_disposition
|
336
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest::WriteDisposition]
|
337
|
+
# Options for what to do if the destination table already exists.
|
321
338
|
class ExportInsightsDataRequest
|
322
339
|
include ::Google::Protobuf::MessageExts
|
323
340
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -342,6 +359,19 @@ module Google
|
|
342
359
|
include ::Google::Protobuf::MessageExts
|
343
360
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
344
361
|
end
|
362
|
+
|
363
|
+
# Specifies the action that occurs if the destination table already exists.
|
364
|
+
module WriteDisposition
|
365
|
+
# Write disposition is not specified. Defaults to WRITE_TRUNCATE.
|
366
|
+
WRITE_DISPOSITION_UNSPECIFIED = 0
|
367
|
+
|
368
|
+
# If the table already exists, BigQuery will overwrite the table data and
|
369
|
+
# use the schema from the load.
|
370
|
+
WRITE_TRUNCATE = 1
|
371
|
+
|
372
|
+
# If the table already exists, BigQuery will append data to the table.
|
373
|
+
WRITE_APPEND = 2
|
374
|
+
end
|
345
375
|
end
|
346
376
|
|
347
377
|
# Metadata for an export insights operation.
|
@@ -647,6 +677,18 @@ module Google
|
|
647
677
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
648
678
|
end
|
649
679
|
|
680
|
+
# The request to update a phrase matcher.
|
681
|
+
# @!attribute [rw] phrase_matcher
|
682
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher]
|
683
|
+
# Required. The new values for the phrase matcher.
|
684
|
+
# @!attribute [rw] update_mask
|
685
|
+
# @return [::Google::Protobuf::FieldMask]
|
686
|
+
# The list of fields to be updated.
|
687
|
+
class UpdatePhraseMatcherRequest
|
688
|
+
include ::Google::Protobuf::MessageExts
|
689
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
690
|
+
end
|
691
|
+
|
650
692
|
# The request to get project-level settings.
|
651
693
|
# @!attribute [rw] name
|
652
694
|
# @return [::String]
|
@@ -668,16 +710,95 @@ module Google
|
|
668
710
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
669
711
|
end
|
670
712
|
|
713
|
+
# The request to create a view.
|
714
|
+
# @!attribute [rw] parent
|
715
|
+
# @return [::String]
|
716
|
+
# Required. The parent resource of the view. Required. The location to create
|
717
|
+
# a view for.
|
718
|
+
# Format: `projects/<Project ID>/locations/<Location ID>` or
|
719
|
+
# `projects/<Project Number>/locations/<Location ID>`
|
720
|
+
# @!attribute [rw] view
|
721
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::View]
|
722
|
+
# Required. The view resource to create.
|
723
|
+
class CreateViewRequest
|
724
|
+
include ::Google::Protobuf::MessageExts
|
725
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
726
|
+
end
|
727
|
+
|
728
|
+
# The request to get a view.
|
729
|
+
# @!attribute [rw] name
|
730
|
+
# @return [::String]
|
731
|
+
# Required. The name of the view to get.
|
732
|
+
class GetViewRequest
|
733
|
+
include ::Google::Protobuf::MessageExts
|
734
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
735
|
+
end
|
736
|
+
|
737
|
+
# The request to list views.
|
738
|
+
# @!attribute [rw] parent
|
739
|
+
# @return [::String]
|
740
|
+
# Required. The parent resource of the views.
|
741
|
+
# @!attribute [rw] page_size
|
742
|
+
# @return [::Integer]
|
743
|
+
# The maximum number of views to return in the response. If this
|
744
|
+
# value is zero, the service will select a default size. A call may return
|
745
|
+
# fewer objects than requested. A non-empty `next_page_token` in the response
|
746
|
+
# indicates that more data is available.
|
747
|
+
# @!attribute [rw] page_token
|
748
|
+
# @return [::String]
|
749
|
+
# The value returned by the last `ListViewsResponse`; indicates
|
750
|
+
# that this is a continuation of a prior `ListViews` call and
|
751
|
+
# the system should return the next page of data.
|
752
|
+
class ListViewsRequest
|
753
|
+
include ::Google::Protobuf::MessageExts
|
754
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
755
|
+
end
|
756
|
+
|
757
|
+
# The response of listing views.
|
758
|
+
# @!attribute [rw] views
|
759
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::View>]
|
760
|
+
# The views that match the request.
|
761
|
+
# @!attribute [rw] next_page_token
|
762
|
+
# @return [::String]
|
763
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
764
|
+
# If this field is omitted, there are no subsequent pages.
|
765
|
+
class ListViewsResponse
|
766
|
+
include ::Google::Protobuf::MessageExts
|
767
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
768
|
+
end
|
769
|
+
|
770
|
+
# The request to update a view.
|
771
|
+
# @!attribute [rw] view
|
772
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::View]
|
773
|
+
# Required. The new view.
|
774
|
+
# @!attribute [rw] update_mask
|
775
|
+
# @return [::Google::Protobuf::FieldMask]
|
776
|
+
# The list of fields to be updated.
|
777
|
+
class UpdateViewRequest
|
778
|
+
include ::Google::Protobuf::MessageExts
|
779
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
780
|
+
end
|
781
|
+
|
782
|
+
# The request to delete a view.
|
783
|
+
# @!attribute [rw] name
|
784
|
+
# @return [::String]
|
785
|
+
# Required. The name of the view to delete.
|
786
|
+
class DeleteViewRequest
|
787
|
+
include ::Google::Protobuf::MessageExts
|
788
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
789
|
+
end
|
790
|
+
|
671
791
|
# Represents the options for views of a conversation.
|
672
792
|
module ConversationView
|
673
793
|
# Not specified. Defaults to FULL on GetConversationRequest and BASIC for
|
674
794
|
# ListConversationsRequest.
|
675
795
|
CONVERSATION_VIEW_UNSPECIFIED = 0
|
676
796
|
|
677
|
-
# Transcript field is not populated in the response
|
797
|
+
# Transcript field is not populated in the response for Insights
|
798
|
+
# conversation.
|
678
799
|
BASIC = 1
|
679
800
|
|
680
|
-
# All fields are populated.
|
801
|
+
# All fields are populated for Insights conversation.
|
681
802
|
FULL = 2
|
682
803
|
end
|
683
804
|
end
|
@@ -66,7 +66,7 @@ module Google
|
|
66
66
|
# Output only. The conversation transcript.
|
67
67
|
# @!attribute [rw] medium
|
68
68
|
# @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium]
|
69
|
-
# Immutable. The conversation medium.
|
69
|
+
# Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
|
70
70
|
# @!attribute [r] duration
|
71
71
|
# @return [::Google::Protobuf::Duration]
|
72
72
|
# Output only. The duration of the conversation.
|
@@ -85,6 +85,9 @@ module Google
|
|
85
85
|
# Output only. All the matched Dialogflow intents in the call. The key corresponds to a
|
86
86
|
# Dialogflow intent, format:
|
87
87
|
# projects/\\{project}/agent/\\{agent}/intents/\\{intent}
|
88
|
+
# @!attribute [rw] obfuscated_user_id
|
89
|
+
# @return [::String]
|
90
|
+
# Obfuscated user ID which the customer sent to us.
|
88
91
|
class Conversation
|
89
92
|
include ::Google::Protobuf::MessageExts
|
90
93
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -110,6 +113,9 @@ module Google
|
|
110
113
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
111
114
|
|
112
115
|
# A segment of a full transcript.
|
116
|
+
# @!attribute [rw] message_time
|
117
|
+
# @return [::Google::Protobuf::Timestamp]
|
118
|
+
# The time that the message occurred, if provided.
|
113
119
|
# @!attribute [rw] text
|
114
120
|
# @return [::String]
|
115
121
|
# The text of this segment.
|
@@ -134,6 +140,12 @@ module Google
|
|
134
140
|
# @!attribute [rw] segment_participant
|
135
141
|
# @return [::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant]
|
136
142
|
# The participant of this segment.
|
143
|
+
# @!attribute [rw] dialogflow_segment_metadata
|
144
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript::TranscriptSegment::DialogflowSegmentMetadata]
|
145
|
+
# CCAI metadata relating to the current transcript segment.
|
146
|
+
# @!attribute [rw] sentiment
|
147
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::SentimentData]
|
148
|
+
# The sentiment for this transcript segment.
|
137
149
|
class TranscriptSegment
|
138
150
|
include ::Google::Protobuf::MessageExts
|
139
151
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -158,6 +170,16 @@ module Google
|
|
158
170
|
include ::Google::Protobuf::MessageExts
|
159
171
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
160
172
|
end
|
173
|
+
|
174
|
+
# Metadata from Dialogflow relating to the current transcript segment.
|
175
|
+
# @!attribute [rw] smart_reply_allowlist_covered
|
176
|
+
# @return [::Boolean]
|
177
|
+
# Whether the transcript segment was covered under the configured smart
|
178
|
+
# reply allowlist in Agent Assist.
|
179
|
+
class DialogflowSegmentMetadata
|
180
|
+
include ::Google::Protobuf::MessageExts
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
|
+
end
|
161
183
|
end
|
162
184
|
end
|
163
185
|
|
@@ -181,7 +203,7 @@ module Google
|
|
181
203
|
|
182
204
|
# Possible media for the conversation.
|
183
205
|
module Medium
|
184
|
-
# Default value.
|
206
|
+
# Default value, if unspecified will default to PHONE_CALL.
|
185
207
|
MEDIUM_UNSPECIFIED = 0
|
186
208
|
|
187
209
|
# The format for conversations that took place over the phone.
|
@@ -322,6 +344,7 @@ module Google
|
|
322
344
|
# @!attribute [rw] issue_model
|
323
345
|
# @return [::String]
|
324
346
|
# Issue model that generates the result.
|
347
|
+
# Format: projects/\\{project}/locations/\\{location}/issueModels/\\{issue_model}
|
325
348
|
# @!attribute [rw] issues
|
326
349
|
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::IssueAssignment>]
|
327
350
|
# All the matched issues.
|
@@ -752,6 +775,9 @@ module Google
|
|
752
775
|
# @!attribute [rw] labeled_conversations_count
|
753
776
|
# @return [::Integer]
|
754
777
|
# Number of conversations attached to the issue at this point in time.
|
778
|
+
# @!attribute [rw] display_name
|
779
|
+
# @return [::String]
|
780
|
+
# Display name of the issue.
|
755
781
|
class IssueStats
|
756
782
|
include ::Google::Protobuf::MessageExts
|
757
783
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1196,6 +1222,9 @@ module Google
|
|
1196
1222
|
# Deprecated. Use `dialogflow_participant_name` instead.
|
1197
1223
|
# The name of the Dialogflow participant. Format:
|
1198
1224
|
# projects/\\{project}/locations/\\{location}/conversations/\\{conversation}/participants/\\{participant}
|
1225
|
+
# @!attribute [rw] obfuscated_external_user_id
|
1226
|
+
# @return [::String]
|
1227
|
+
# Obfuscated user ID from Dialogflow.
|
1199
1228
|
# @!attribute [rw] role
|
1200
1229
|
# @return [::Google::Cloud::ContactCenterInsights::V1::ConversationParticipant::Role]
|
1201
1230
|
# The role of the participant.
|
@@ -1221,6 +1250,29 @@ module Google
|
|
1221
1250
|
ANY_AGENT = 4
|
1222
1251
|
end
|
1223
1252
|
end
|
1253
|
+
|
1254
|
+
# The View resource.
|
1255
|
+
# @!attribute [rw] name
|
1256
|
+
# @return [::String]
|
1257
|
+
# Immutable. The resource name of the view.
|
1258
|
+
# Format:
|
1259
|
+
# projects/\\{project}/locations/\\{location}/views/\\{view}
|
1260
|
+
# @!attribute [rw] display_name
|
1261
|
+
# @return [::String]
|
1262
|
+
# The human-readable display name of the view.
|
1263
|
+
# @!attribute [r] create_time
|
1264
|
+
# @return [::Google::Protobuf::Timestamp]
|
1265
|
+
# Output only. The time at which this view was created.
|
1266
|
+
# @!attribute [r] update_time
|
1267
|
+
# @return [::Google::Protobuf::Timestamp]
|
1268
|
+
# Output only. The most recent time at which the view was updated.
|
1269
|
+
# @!attribute [rw] value
|
1270
|
+
# @return [::String]
|
1271
|
+
# String with specific view properties.
|
1272
|
+
class View
|
1273
|
+
include ::Google::Protobuf::MessageExts
|
1274
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1275
|
+
end
|
1224
1276
|
end
|
1225
1277
|
end
|
1226
1278
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-contact_center_insights-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.7.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -213,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
213
213
|
- !ruby/object:Gem::Version
|
214
214
|
version: '0'
|
215
215
|
requirements: []
|
216
|
-
rubygems_version: 3.
|
216
|
+
rubygems_version: 3.3.4
|
217
217
|
signing_key:
|
218
218
|
specification_version: 4
|
219
219
|
summary: API Client library for the Contact Center AI Insights V1 API
|