google-cloud-contact_center_insights-v1 1.1.0 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +30 -20
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/client.rb +3411 -242
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/operations.rb +12 -15
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb +122 -0
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/rest/client.rb +3181 -229
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/rest/operations.rb +43 -38
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/rest/service_stub.rb +2531 -527
- data/lib/google/cloud/contact_center_insights/v1/version.rb +1 -1
- data/lib/google/cloud/contactcenterinsights/v1/contact_center_insights_pb.rb +70 -1
- data/lib/google/cloud/contactcenterinsights/v1/contact_center_insights_services_pb.rb +65 -3
- data/lib/google/cloud/contactcenterinsights/v1/resources_pb.rb +21 -1
- data/proto_docs/google/api/client.rb +39 -0
- data/proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb +1165 -3
- data/proto_docs/google/cloud/contactcenterinsights/v1/resources.rb +496 -7
- data/proto_docs/google/longrunning/operations.rb +19 -14
- data/proto_docs/google/type/interval.rb +45 -0
- metadata +26 -5
@@ -386,7 +386,7 @@ module Google
|
|
386
386
|
# @return [::Array<::String>]
|
387
387
|
# Optional. Custom keys to extract as conversation labels from metadata
|
388
388
|
# files in `metadata_bucket_uri`. Keys not included in this field will be
|
389
|
-
# ignored. Note that there is a limit of
|
389
|
+
# ignored. Note that there is a limit of 100 labels per conversation.
|
390
390
|
class GcsSource
|
391
391
|
include ::Google::Protobuf::MessageExts
|
392
392
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1151,6 +1151,87 @@ module Google
|
|
1151
1151
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1152
1152
|
end
|
1153
1153
|
|
1154
|
+
# The request to create a analysis rule.
|
1155
|
+
# analysis_rule_id will be generated by the server.
|
1156
|
+
# @!attribute [rw] parent
|
1157
|
+
# @return [::String]
|
1158
|
+
# Required. The parent resource of the analysis rule. Required. The location
|
1159
|
+
# to create a analysis rule for. Format: `projects/<Project
|
1160
|
+
# ID>/locations/<Location ID>` or `projects/<Project
|
1161
|
+
# Number>/locations/<Location ID>`
|
1162
|
+
# @!attribute [rw] analysis_rule
|
1163
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::AnalysisRule]
|
1164
|
+
# Required. The analysis rule resource to create.
|
1165
|
+
class CreateAnalysisRuleRequest
|
1166
|
+
include ::Google::Protobuf::MessageExts
|
1167
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1168
|
+
end
|
1169
|
+
|
1170
|
+
# The request for getting a analysis rule.
|
1171
|
+
# @!attribute [rw] name
|
1172
|
+
# @return [::String]
|
1173
|
+
# Required. The name of the AnalysisRule to get.
|
1174
|
+
class GetAnalysisRuleRequest
|
1175
|
+
include ::Google::Protobuf::MessageExts
|
1176
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1177
|
+
end
|
1178
|
+
|
1179
|
+
# The request to update a analysis rule.
|
1180
|
+
# @!attribute [rw] analysis_rule
|
1181
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::AnalysisRule]
|
1182
|
+
# Required. The new analysis rule.
|
1183
|
+
# @!attribute [rw] update_mask
|
1184
|
+
# @return [::Google::Protobuf::FieldMask]
|
1185
|
+
# Optional. The list of fields to be updated.
|
1186
|
+
# If the update_mask is not provided, the update will be applied to all
|
1187
|
+
# fields.
|
1188
|
+
class UpdateAnalysisRuleRequest
|
1189
|
+
include ::Google::Protobuf::MessageExts
|
1190
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1191
|
+
end
|
1192
|
+
|
1193
|
+
# The request to delete a analysis rule.
|
1194
|
+
# @!attribute [rw] name
|
1195
|
+
# @return [::String]
|
1196
|
+
# Required. The name of the analysis rule to delete.
|
1197
|
+
class DeleteAnalysisRuleRequest
|
1198
|
+
include ::Google::Protobuf::MessageExts
|
1199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1200
|
+
end
|
1201
|
+
|
1202
|
+
# The request to list analysis rules.
|
1203
|
+
# @!attribute [rw] parent
|
1204
|
+
# @return [::String]
|
1205
|
+
# Required. The parent resource of the analysis rules.
|
1206
|
+
# @!attribute [rw] page_size
|
1207
|
+
# @return [::Integer]
|
1208
|
+
# Optional. The maximum number of analysis rule to return in the response. If
|
1209
|
+
# this value is zero, the service will select a default size. A call may
|
1210
|
+
# return fewer objects than requested. A non-empty `next_page_token` in the
|
1211
|
+
# response indicates that more data is available.
|
1212
|
+
# @!attribute [rw] page_token
|
1213
|
+
# @return [::String]
|
1214
|
+
# Optional. The value returned by the last `ListAnalysisRulesResponse`;
|
1215
|
+
# indicates that this is a continuation of a prior `ListAnalysisRules` call
|
1216
|
+
# and the system should return the next page of data.
|
1217
|
+
class ListAnalysisRulesRequest
|
1218
|
+
include ::Google::Protobuf::MessageExts
|
1219
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1220
|
+
end
|
1221
|
+
|
1222
|
+
# The response of listing views.
|
1223
|
+
# @!attribute [rw] analysis_rules
|
1224
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::AnalysisRule>]
|
1225
|
+
# The analysis_rule that match the request.
|
1226
|
+
# @!attribute [rw] next_page_token
|
1227
|
+
# @return [::String]
|
1228
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1229
|
+
# If this field is omitted, there are no subsequent pages.
|
1230
|
+
class ListAnalysisRulesResponse
|
1231
|
+
include ::Google::Protobuf::MessageExts
|
1232
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1233
|
+
end
|
1234
|
+
|
1154
1235
|
# The request to get location-level encryption specification.
|
1155
1236
|
# @!attribute [rw] name
|
1156
1237
|
# @return [::String]
|
@@ -1166,7 +1247,7 @@ module Google
|
|
1166
1247
|
# Required. The encryption spec used for CMEK encryption. It is required that
|
1167
1248
|
# the kms key is in the same region as the endpoint. The same key will be
|
1168
1249
|
# used for all provisioned resources, if encryption is available. If the
|
1169
|
-
# kms_key_name is left empty, no encryption will be enforced.
|
1250
|
+
# `kms_key_name` field is left empty, no encryption will be enforced.
|
1170
1251
|
class InitializeEncryptionSpecRequest
|
1171
1252
|
include ::Google::Protobuf::MessageExts
|
1172
1253
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1190,7 +1271,7 @@ module Google
|
|
1190
1271
|
# Output only. The original request for initialization.
|
1191
1272
|
# @!attribute [rw] partial_errors
|
1192
1273
|
# @return [::Array<::Google::Rpc::Status>]
|
1193
|
-
# Partial errors during
|
1274
|
+
# Partial errors during initializing operation that might cause the operation
|
1194
1275
|
# output to be incomplete.
|
1195
1276
|
class InitializeEncryptionSpecMetadata
|
1196
1277
|
include ::Google::Protobuf::MessageExts
|
@@ -1275,6 +1356,1087 @@ module Google
|
|
1275
1356
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1276
1357
|
end
|
1277
1358
|
|
1359
|
+
# A dimension determines the grouping key for the query. In SQL terms, these
|
1360
|
+
# would be part of both the "SELECT" and "GROUP BY" clauses.
|
1361
|
+
# @!attribute [r] issue_dimension_metadata
|
1362
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::Dimension::IssueDimensionMetadata]
|
1363
|
+
# Output only. Metadata about the issue dimension.
|
1364
|
+
# @!attribute [r] agent_dimension_metadata
|
1365
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::Dimension::AgentDimensionMetadata]
|
1366
|
+
# Output only. Metadata about the agent dimension.
|
1367
|
+
# @!attribute [r] qa_question_dimension_metadata
|
1368
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::Dimension::QaQuestionDimensionMetadata]
|
1369
|
+
# Output only. Metadata about the QA question dimension.
|
1370
|
+
# @!attribute [r] qa_question_answer_dimension_metadata
|
1371
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::Dimension::QaQuestionAnswerDimensionMetadata]
|
1372
|
+
# Output only. Metadata about the QA question-answer dimension.
|
1373
|
+
# @!attribute [rw] dimension_key
|
1374
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::Dimension::DimensionKey]
|
1375
|
+
# The key of the dimension.
|
1376
|
+
class Dimension
|
1377
|
+
include ::Google::Protobuf::MessageExts
|
1378
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1379
|
+
|
1380
|
+
# Metadata about the issue dimension.
|
1381
|
+
# @!attribute [rw] issue_id
|
1382
|
+
# @return [::String]
|
1383
|
+
# The issue ID.
|
1384
|
+
# @!attribute [rw] issue_display_name
|
1385
|
+
# @return [::String]
|
1386
|
+
# The issue display name.
|
1387
|
+
# @!attribute [rw] issue_model_id
|
1388
|
+
# @return [::String]
|
1389
|
+
# The parent issue model ID.
|
1390
|
+
class IssueDimensionMetadata
|
1391
|
+
include ::Google::Protobuf::MessageExts
|
1392
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1393
|
+
end
|
1394
|
+
|
1395
|
+
# Metadata about the agent dimension.
|
1396
|
+
# @!attribute [rw] agent_id
|
1397
|
+
# @return [::String]
|
1398
|
+
# Optional. A user-specified string representing the agent.
|
1399
|
+
# @!attribute [rw] agent_display_name
|
1400
|
+
# @return [::String]
|
1401
|
+
# Optional. The agent's name
|
1402
|
+
# @!attribute [rw] agent_team
|
1403
|
+
# @return [::String]
|
1404
|
+
# Optional. A user-specified string representing the agent's team.
|
1405
|
+
class AgentDimensionMetadata
|
1406
|
+
include ::Google::Protobuf::MessageExts
|
1407
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1408
|
+
end
|
1409
|
+
|
1410
|
+
# Metadata about the QA question dimension.
|
1411
|
+
# @!attribute [rw] qa_scorecard_id
|
1412
|
+
# @return [::String]
|
1413
|
+
# Optional. The QA scorecard ID.
|
1414
|
+
# @!attribute [rw] qa_question_id
|
1415
|
+
# @return [::String]
|
1416
|
+
# Optional. The QA question ID.
|
1417
|
+
# @!attribute [rw] question_body
|
1418
|
+
# @return [::String]
|
1419
|
+
# Optional. The full body of the question.
|
1420
|
+
class QaQuestionDimensionMetadata
|
1421
|
+
include ::Google::Protobuf::MessageExts
|
1422
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1423
|
+
end
|
1424
|
+
|
1425
|
+
# Metadata about the QA question-answer dimension.
|
1426
|
+
# This is useful for showing the answer distribution for questions for a
|
1427
|
+
# given scorecard.
|
1428
|
+
# @!attribute [rw] qa_scorecard_id
|
1429
|
+
# @return [::String]
|
1430
|
+
# Optional. The QA scorecard ID.
|
1431
|
+
# @!attribute [rw] qa_question_id
|
1432
|
+
# @return [::String]
|
1433
|
+
# Optional. The QA question ID.
|
1434
|
+
# @!attribute [rw] question_body
|
1435
|
+
# @return [::String]
|
1436
|
+
# Optional. The full body of the question.
|
1437
|
+
# @!attribute [rw] answer_value
|
1438
|
+
# @return [::String]
|
1439
|
+
# Optional. The full body of the question.
|
1440
|
+
class QaQuestionAnswerDimensionMetadata
|
1441
|
+
include ::Google::Protobuf::MessageExts
|
1442
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1443
|
+
end
|
1444
|
+
|
1445
|
+
# The key of the dimension.
|
1446
|
+
module DimensionKey
|
1447
|
+
# The key of the dimension is unspecified.
|
1448
|
+
DIMENSION_KEY_UNSPECIFIED = 0
|
1449
|
+
|
1450
|
+
# The dimension is keyed by issues.
|
1451
|
+
ISSUE = 1
|
1452
|
+
|
1453
|
+
# The dimension is keyed by agents.
|
1454
|
+
AGENT = 2
|
1455
|
+
|
1456
|
+
# The dimension is keyed by agent teams.
|
1457
|
+
AGENT_TEAM = 3
|
1458
|
+
|
1459
|
+
# The dimension is keyed by QaQuestionIds.
|
1460
|
+
# Note that: We only group by the QuestionId and not the revision-id of the
|
1461
|
+
# scorecard this question is a part of. This allows for showing stats for
|
1462
|
+
# the same question across different scorecard revisions.
|
1463
|
+
QA_QUESTION_ID = 4
|
1464
|
+
|
1465
|
+
# The dimension is keyed by QaQuestionIds-Answer value pairs.
|
1466
|
+
# Note that: We only group by the QuestionId and not the revision-id of the
|
1467
|
+
# scorecard this question is a part of. This allows for showing
|
1468
|
+
# distribution of answers per question across different scorecard
|
1469
|
+
# revisions.
|
1470
|
+
QA_QUESTION_ANSWER_VALUE = 5
|
1471
|
+
|
1472
|
+
# The dimension is keyed by the conversation profile ID.
|
1473
|
+
CONVERSATION_PROFILE_ID = 6
|
1474
|
+
end
|
1475
|
+
end
|
1476
|
+
|
1477
|
+
# The request for querying metrics.
|
1478
|
+
# @!attribute [rw] location
|
1479
|
+
# @return [::String]
|
1480
|
+
# Required. The location of the data.
|
1481
|
+
# "projects/\\{project}/locations/\\{location}"
|
1482
|
+
# @!attribute [rw] filter
|
1483
|
+
# @return [::String]
|
1484
|
+
# Required. Filter to select a subset of conversations to compute the
|
1485
|
+
# metrics. Must specify a window of the conversation create time to compute
|
1486
|
+
# the metrics. The returned metrics will be from the range [DATE(starting
|
1487
|
+
# create time), DATE(ending create time)).
|
1488
|
+
# @!attribute [rw] time_granularity
|
1489
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest::TimeGranularity]
|
1490
|
+
# The time granularity of each data point in the time series.
|
1491
|
+
# Defaults to NONE if this field is unspecified.
|
1492
|
+
# @!attribute [rw] dimensions
|
1493
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>]
|
1494
|
+
# The dimensions that determine the grouping key for the query. Defaults to
|
1495
|
+
# no dimension if this field is unspecified. If a dimension is specified,
|
1496
|
+
# its key must also be specified. Each dimension's key must be unique.
|
1497
|
+
#
|
1498
|
+
# If a time granularity is also specified, metric values in the dimension
|
1499
|
+
# will be bucketed by this granularity.
|
1500
|
+
#
|
1501
|
+
# Up to one dimension is supported for now.
|
1502
|
+
# @!attribute [rw] measure_mask
|
1503
|
+
# @return [::Google::Protobuf::FieldMask]
|
1504
|
+
# Measures to return. Defaults to all measures if this field is unspecified.
|
1505
|
+
# A valid mask should traverse from the `measure` field from the response.
|
1506
|
+
# For example, a path from a measure mask to get the conversation count is
|
1507
|
+
# "conversation_measure.count".
|
1508
|
+
class QueryMetricsRequest
|
1509
|
+
include ::Google::Protobuf::MessageExts
|
1510
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1511
|
+
|
1512
|
+
# A time granularity divides the time line into discrete time periods.
|
1513
|
+
# This is useful for defining buckets over which filtering and aggregation
|
1514
|
+
# should be performed.
|
1515
|
+
module TimeGranularity
|
1516
|
+
# The time granularity is unspecified and will default to NONE.
|
1517
|
+
TIME_GRANULARITY_UNSPECIFIED = 0
|
1518
|
+
|
1519
|
+
# No time granularity. The response won't contain a time series.
|
1520
|
+
# This is the default value if no time granularity is specified.
|
1521
|
+
NONE = 1
|
1522
|
+
|
1523
|
+
# Data points in the time series will aggregate at a daily granularity.
|
1524
|
+
# 1 day means [midnight to midnight).
|
1525
|
+
DAILY = 2
|
1526
|
+
|
1527
|
+
# Data points in the time series will aggregate at a daily granularity.
|
1528
|
+
# 1 HOUR means [01:00 to 02:00).
|
1529
|
+
HOURLY = 3
|
1530
|
+
|
1531
|
+
# Data points in the time series will aggregate at a daily granularity.
|
1532
|
+
# PER_MINUTE means [01:00 to 01:01).
|
1533
|
+
PER_MINUTE = 4
|
1534
|
+
|
1535
|
+
# Data points in the time series will aggregate at a 1 minute granularity.
|
1536
|
+
# PER_5_MINUTES means [01:00 to 01:05).
|
1537
|
+
PER_5_MINUTES = 5
|
1538
|
+
|
1539
|
+
# Data points in the time series will aggregate at a monthly granularity.
|
1540
|
+
# 1 MONTH means [01st of the month to 1st of the next month).
|
1541
|
+
MONTHLY = 6
|
1542
|
+
end
|
1543
|
+
end
|
1544
|
+
|
1545
|
+
# The response for querying metrics.
|
1546
|
+
# @!attribute [rw] location
|
1547
|
+
# @return [::String]
|
1548
|
+
# Required. The location of the data.
|
1549
|
+
# "projects/\\{project}/locations/\\{location}"
|
1550
|
+
# @!attribute [rw] update_time
|
1551
|
+
# @return [::Google::Protobuf::Timestamp]
|
1552
|
+
# The metrics last update time.
|
1553
|
+
# @!attribute [rw] slices
|
1554
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice>]
|
1555
|
+
# A slice contains a total and (if the request specified a time granularity)
|
1556
|
+
# a time series of metric values. Each slice contains a unique combination of
|
1557
|
+
# the cardinality of dimensions from the request.
|
1558
|
+
# @!attribute [rw] macro_average_slice
|
1559
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice]
|
1560
|
+
# The macro average slice contains aggregated averages across the selected
|
1561
|
+
# dimension. i.e. if group_by agent is specified this field will contain the
|
1562
|
+
# average across all agents.
|
1563
|
+
# This field is only populated if the request specifies a Dimension.
|
1564
|
+
class QueryMetricsResponse
|
1565
|
+
include ::Google::Protobuf::MessageExts
|
1566
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1567
|
+
|
1568
|
+
# A slice contains a total and (if the request specified a time granularity)
|
1569
|
+
# a time series of metric values. Each slice contains a unique combination of
|
1570
|
+
# the cardinality of dimensions from the request.
|
1571
|
+
#
|
1572
|
+
# For example, if the request specifies a single ISSUE dimension and it has a
|
1573
|
+
# cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in
|
1574
|
+
# total), the response will have 2 slices:
|
1575
|
+
#
|
1576
|
+
# * Slice 1 -> dimensions=[Issue 1]
|
1577
|
+
# * Slice 2 -> dimensions=[Issue 2]
|
1578
|
+
# @!attribute [rw] dimensions
|
1579
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>]
|
1580
|
+
# A unique combination of dimensions that this slice represents.
|
1581
|
+
# @!attribute [rw] total
|
1582
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint]
|
1583
|
+
# The total metric value. The interval of this data point is
|
1584
|
+
# [starting create time, ending create time) from the request.
|
1585
|
+
# @!attribute [rw] time_series
|
1586
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::TimeSeries]
|
1587
|
+
# A time series of metric values. This is only populated if the request
|
1588
|
+
# specifies a time granularity other than NONE.
|
1589
|
+
class Slice
|
1590
|
+
include ::Google::Protobuf::MessageExts
|
1591
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1592
|
+
|
1593
|
+
# A data point contains the metric values mapped to an interval.
|
1594
|
+
# @!attribute [rw] conversation_measure
|
1595
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure]
|
1596
|
+
# The measure related to conversations.
|
1597
|
+
# @!attribute [rw] interval
|
1598
|
+
# @return [::Google::Type::Interval]
|
1599
|
+
# The interval that this data point represents.
|
1600
|
+
#
|
1601
|
+
# * If this is the total data point, the interval is
|
1602
|
+
# [starting create time, ending create time) from the request.
|
1603
|
+
# * If this a data point from the time series, the interval is
|
1604
|
+
# [time, time + time granularity from the request).
|
1605
|
+
class DataPoint
|
1606
|
+
include ::Google::Protobuf::MessageExts
|
1607
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1608
|
+
|
1609
|
+
# The measure related to conversations.
|
1610
|
+
# @!attribute [rw] conversation_count
|
1611
|
+
# @return [::Integer]
|
1612
|
+
# The conversation count.
|
1613
|
+
# @!attribute [rw] average_silence_percentage
|
1614
|
+
# @return [::Float]
|
1615
|
+
# The average silence percentage.
|
1616
|
+
# @!attribute [rw] average_duration
|
1617
|
+
# @return [::Google::Protobuf::Duration]
|
1618
|
+
# The average duration.
|
1619
|
+
# @!attribute [rw] average_turn_count
|
1620
|
+
# @return [::Float]
|
1621
|
+
# The average turn count.
|
1622
|
+
# @!attribute [rw] average_agent_sentiment_score
|
1623
|
+
# @return [::Float]
|
1624
|
+
# The average agent's sentiment score.
|
1625
|
+
# @!attribute [rw] average_client_sentiment_score
|
1626
|
+
# @return [::Float]
|
1627
|
+
# The average client's sentiment score.
|
1628
|
+
# @!attribute [rw] average_customer_satisfaction_rating
|
1629
|
+
# @return [::Float]
|
1630
|
+
# The average customer satisfaction rating.
|
1631
|
+
# @!attribute [rw] average_qa_normalized_score
|
1632
|
+
# @return [::Float]
|
1633
|
+
# Average QA normalized score.
|
1634
|
+
# Will exclude 0's in average calculation.
|
1635
|
+
# @!attribute [rw] qa_tag_scores
|
1636
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure::QaTagScore>]
|
1637
|
+
# Average QA normalized score for all the tags.
|
1638
|
+
# @!attribute [rw] average_qa_question_normalized_score
|
1639
|
+
# @return [::Float]
|
1640
|
+
# Average QA normalized score averaged for questions averaged across
|
1641
|
+
# all revisions of the parent scorecard.
|
1642
|
+
# Will be only populated if the request specifies a dimension of
|
1643
|
+
# QA_QUESTION_ID.
|
1644
|
+
class ConversationMeasure
|
1645
|
+
include ::Google::Protobuf::MessageExts
|
1646
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1647
|
+
|
1648
|
+
# Average QA normalized score for the tag.
|
1649
|
+
# @!attribute [rw] tag
|
1650
|
+
# @return [::String]
|
1651
|
+
# Tag name.
|
1652
|
+
# @!attribute [rw] average_tag_normalized_score
|
1653
|
+
# @return [::Float]
|
1654
|
+
# Average tag normalized score per tag.
|
1655
|
+
class QaTagScore
|
1656
|
+
include ::Google::Protobuf::MessageExts
|
1657
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1658
|
+
end
|
1659
|
+
end
|
1660
|
+
end
|
1661
|
+
|
1662
|
+
# A time series of metric values.
|
1663
|
+
# @!attribute [rw] data_points
|
1664
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint>]
|
1665
|
+
# The data points that make up the time series .
|
1666
|
+
class TimeSeries
|
1667
|
+
include ::Google::Protobuf::MessageExts
|
1668
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1669
|
+
end
|
1670
|
+
end
|
1671
|
+
end
|
1672
|
+
|
1673
|
+
# The metadata from querying metrics.
|
1674
|
+
class QueryMetricsMetadata
|
1675
|
+
include ::Google::Protobuf::MessageExts
|
1676
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1677
|
+
end
|
1678
|
+
|
1679
|
+
# The request for creating a QaQuestion.
|
1680
|
+
# @!attribute [rw] parent
|
1681
|
+
# @return [::String]
|
1682
|
+
# Required. The parent resource of the QaQuestion.
|
1683
|
+
# @!attribute [rw] qa_question
|
1684
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaQuestion]
|
1685
|
+
# Required. The QaQuestion to create.
|
1686
|
+
# @!attribute [rw] qa_question_id
|
1687
|
+
# @return [::String]
|
1688
|
+
# Optional. A unique ID for the new question. This ID will become the final
|
1689
|
+
# component of the question's resource name. If no ID is specified, a
|
1690
|
+
# server-generated ID will be used.
|
1691
|
+
#
|
1692
|
+
# This value should be 4-64 characters and must match the regular
|
1693
|
+
# expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`.
|
1694
|
+
class CreateQaQuestionRequest
|
1695
|
+
include ::Google::Protobuf::MessageExts
|
1696
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1697
|
+
end
|
1698
|
+
|
1699
|
+
# The request for a QaQuestion.
|
1700
|
+
# @!attribute [rw] name
|
1701
|
+
# @return [::String]
|
1702
|
+
# Required. The name of the QaQuestion to get.
|
1703
|
+
class GetQaQuestionRequest
|
1704
|
+
include ::Google::Protobuf::MessageExts
|
1705
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1706
|
+
end
|
1707
|
+
|
1708
|
+
# Request to list QaQuestions.
|
1709
|
+
# @!attribute [rw] parent
|
1710
|
+
# @return [::String]
|
1711
|
+
# Required. The parent resource of the questions.
|
1712
|
+
# @!attribute [rw] page_size
|
1713
|
+
# @return [::Integer]
|
1714
|
+
# Optional. The maximum number of questions to return in the response. If the
|
1715
|
+
# value is zero, the service will select a default size. A call might return
|
1716
|
+
# fewer objects than requested. A non-empty `next_page_token` in the response
|
1717
|
+
# indicates that more data is available.
|
1718
|
+
# @!attribute [rw] page_token
|
1719
|
+
# @return [::String]
|
1720
|
+
# Optional. The value returned by the last `ListQaQuestionsResponse`. This
|
1721
|
+
# value indicates that this is a continuation of a prior `ListQaQuestions`
|
1722
|
+
# call and that the system should return the next page of data.
|
1723
|
+
class ListQaQuestionsRequest
|
1724
|
+
include ::Google::Protobuf::MessageExts
|
1725
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1726
|
+
end
|
1727
|
+
|
1728
|
+
# The response from a ListQaQuestions request.
|
1729
|
+
# @!attribute [rw] qa_questions
|
1730
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaQuestion>]
|
1731
|
+
# The QaQuestions under the parent.
|
1732
|
+
# @!attribute [rw] next_page_token
|
1733
|
+
# @return [::String]
|
1734
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1735
|
+
# If this field is omitted, there are no subsequent pages.
|
1736
|
+
class ListQaQuestionsResponse
|
1737
|
+
include ::Google::Protobuf::MessageExts
|
1738
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1739
|
+
end
|
1740
|
+
|
1741
|
+
# The request for updating a QaQuestion.
|
1742
|
+
# @!attribute [rw] qa_question
|
1743
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaQuestion]
|
1744
|
+
# Required. The QaQuestion to update.
|
1745
|
+
# @!attribute [rw] update_mask
|
1746
|
+
# @return [::Google::Protobuf::FieldMask]
|
1747
|
+
# Required. The list of fields to be updated. All possible fields can be
|
1748
|
+
# updated by passing `*`, or a subset of the following updateable fields can
|
1749
|
+
# be provided:
|
1750
|
+
#
|
1751
|
+
# * `abbreviation`
|
1752
|
+
# * `answer_choices`
|
1753
|
+
# * `answer_instructions`
|
1754
|
+
# * `order`
|
1755
|
+
# * `question_body`
|
1756
|
+
# * `tags`
|
1757
|
+
class UpdateQaQuestionRequest
|
1758
|
+
include ::Google::Protobuf::MessageExts
|
1759
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1760
|
+
end
|
1761
|
+
|
1762
|
+
# The request for deleting a QaQuestion.
|
1763
|
+
# @!attribute [rw] name
|
1764
|
+
# @return [::String]
|
1765
|
+
# Required. The name of the QaQuestion to delete.
|
1766
|
+
class DeleteQaQuestionRequest
|
1767
|
+
include ::Google::Protobuf::MessageExts
|
1768
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1769
|
+
end
|
1770
|
+
|
1771
|
+
# The request for creating a QaScorecard.
|
1772
|
+
# @!attribute [rw] parent
|
1773
|
+
# @return [::String]
|
1774
|
+
# Required. The parent resource of the QaScorecard.
|
1775
|
+
# @!attribute [rw] qa_scorecard
|
1776
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaScorecard]
|
1777
|
+
# Required. The QaScorecard to create.
|
1778
|
+
# @!attribute [rw] qa_scorecard_id
|
1779
|
+
# @return [::String]
|
1780
|
+
# Optional. A unique ID for the new QaScorecard. This ID will become the
|
1781
|
+
# final component of the QaScorecard's resource name. If no ID is specified,
|
1782
|
+
# a server-generated ID will be used.
|
1783
|
+
#
|
1784
|
+
# This value should be 4-64 characters and must match the regular
|
1785
|
+
# expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`.
|
1786
|
+
class CreateQaScorecardRequest
|
1787
|
+
include ::Google::Protobuf::MessageExts
|
1788
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1789
|
+
end
|
1790
|
+
|
1791
|
+
# The request for a QaScorecard. By default, returns the latest revision.
|
1792
|
+
# @!attribute [rw] name
|
1793
|
+
# @return [::String]
|
1794
|
+
# Required. The name of the QaScorecard to get.
|
1795
|
+
class GetQaScorecardRequest
|
1796
|
+
include ::Google::Protobuf::MessageExts
|
1797
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1798
|
+
end
|
1799
|
+
|
1800
|
+
# The request for updating a QaScorecard.
|
1801
|
+
# @!attribute [rw] qa_scorecard
|
1802
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaScorecard]
|
1803
|
+
# Required. The QaScorecard to update.
|
1804
|
+
# @!attribute [rw] update_mask
|
1805
|
+
# @return [::Google::Protobuf::FieldMask]
|
1806
|
+
# Required. The list of fields to be updated. All possible fields can be
|
1807
|
+
# updated by passing `*`, or a subset of the following updateable fields can
|
1808
|
+
# be provided:
|
1809
|
+
#
|
1810
|
+
# * `description`
|
1811
|
+
# * `display_name`
|
1812
|
+
class UpdateQaScorecardRequest
|
1813
|
+
include ::Google::Protobuf::MessageExts
|
1814
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1815
|
+
end
|
1816
|
+
|
1817
|
+
# The request for deleting a QaScorecard.
|
1818
|
+
# @!attribute [rw] name
|
1819
|
+
# @return [::String]
|
1820
|
+
# Required. The name of the QaScorecard to delete.
|
1821
|
+
# @!attribute [rw] force
|
1822
|
+
# @return [::Boolean]
|
1823
|
+
# Optional. If set to true, all of this QaScorecard's child resources will
|
1824
|
+
# also be deleted. Otherwise, the request will only succeed if it has none.
|
1825
|
+
class DeleteQaScorecardRequest
|
1826
|
+
include ::Google::Protobuf::MessageExts
|
1827
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1828
|
+
end
|
1829
|
+
|
1830
|
+
# The request for creating a QaScorecardRevision.
|
1831
|
+
# @!attribute [rw] parent
|
1832
|
+
# @return [::String]
|
1833
|
+
# Required. The parent resource of the QaScorecardRevision.
|
1834
|
+
# @!attribute [rw] qa_scorecard_revision
|
1835
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision]
|
1836
|
+
# Required. The QaScorecardRevision to create.
|
1837
|
+
# @!attribute [rw] qa_scorecard_revision_id
|
1838
|
+
# @return [::String]
|
1839
|
+
# Optional. A unique ID for the new QaScorecardRevision. This ID will become
|
1840
|
+
# the final component of the QaScorecardRevision's resource name. If no ID is
|
1841
|
+
# specified, a server-generated ID will be used.
|
1842
|
+
#
|
1843
|
+
# This value should be 4-64 characters and must match the regular
|
1844
|
+
# expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`.
|
1845
|
+
class CreateQaScorecardRevisionRequest
|
1846
|
+
include ::Google::Protobuf::MessageExts
|
1847
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1848
|
+
end
|
1849
|
+
|
1850
|
+
# The request for a QaScorecardRevision.
|
1851
|
+
# @!attribute [rw] name
|
1852
|
+
# @return [::String]
|
1853
|
+
# Required. The name of the QaScorecardRevision to get.
|
1854
|
+
class GetQaScorecardRevisionRequest
|
1855
|
+
include ::Google::Protobuf::MessageExts
|
1856
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1857
|
+
end
|
1858
|
+
|
1859
|
+
# Request for TuneQaScorecardRevision endpoint.
|
1860
|
+
# @!attribute [rw] parent
|
1861
|
+
# @return [::String]
|
1862
|
+
# Required. The parent resource for new fine tuning job instance.
|
1863
|
+
# @!attribute [rw] filter
|
1864
|
+
# @return [::String]
|
1865
|
+
# Required. Filter for selecting the feedback labels that needs to be
|
1866
|
+
# used for training.
|
1867
|
+
# This filter can be used to limit the feedback labels used for tuning to a
|
1868
|
+
# feedback labels created or updated for a specific time-window etc.
|
1869
|
+
# @!attribute [rw] validate_only
|
1870
|
+
# @return [::Boolean]
|
1871
|
+
# Optional. Run in validate only mode, no fine tuning will actually run.
|
1872
|
+
# Data quality validations like training data distributions will run.
|
1873
|
+
# Even when set to false, the data quality validations will still run but
|
1874
|
+
# once the validations complete we will proceed with the fine tune, if
|
1875
|
+
# applicable.
|
1876
|
+
class TuneQaScorecardRevisionRequest
|
1877
|
+
include ::Google::Protobuf::MessageExts
|
1878
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1879
|
+
end
|
1880
|
+
|
1881
|
+
# Response for TuneQaScorecardRevision endpoint.
|
1882
|
+
class TuneQaScorecardRevisionResponse
|
1883
|
+
include ::Google::Protobuf::MessageExts
|
1884
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1885
|
+
end
|
1886
|
+
|
1887
|
+
# Metadata for TuneQaScorecardRevision endpoint.
|
1888
|
+
# @!attribute [r] create_time
|
1889
|
+
# @return [::Google::Protobuf::Timestamp]
|
1890
|
+
# Output only. The time the operation was created.
|
1891
|
+
# @!attribute [r] end_time
|
1892
|
+
# @return [::Google::Protobuf::Timestamp]
|
1893
|
+
# Output only. The time the operation finished running.
|
1894
|
+
# @!attribute [r] request
|
1895
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::TuneQaScorecardRevisionRequest]
|
1896
|
+
# Output only. The original request.
|
1897
|
+
# @!attribute [r] qa_question_dataset_validation_results
|
1898
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::TuneQaScorecardRevisionMetadata::QaQuestionDatasetValidationResult>]
|
1899
|
+
# Output only. The results of data validation per question in the request.
|
1900
|
+
# @!attribute [r] qa_question_dataset_tuning_metrics
|
1901
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::TuneQaScorecardRevisionMetadata::QaQuestionDatasetTuningMetrics>]
|
1902
|
+
# Output only. The metrics for each QaQuestion in the TuneScorecardRevision
|
1903
|
+
# request.
|
1904
|
+
# @!attribute [r] tuning_completion_ratio
|
1905
|
+
# @return [::Float]
|
1906
|
+
# Output only. The percentage of the tuning job that has completed. Always
|
1907
|
+
# between 0 and 1 where 0 indicates the job has not started i.e. 0% and 1
|
1908
|
+
# indicates the job has completed i.e. 100%.
|
1909
|
+
class TuneQaScorecardRevisionMetadata
|
1910
|
+
include ::Google::Protobuf::MessageExts
|
1911
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1912
|
+
|
1913
|
+
# Contains validation results for a question in the tuning request.
|
1914
|
+
# @!attribute [r] question
|
1915
|
+
# @return [::String]
|
1916
|
+
# Output only. The resource path of the question whose dataset was
|
1917
|
+
# evaluated for tuning.
|
1918
|
+
# @!attribute [rw] dataset_validation_warnings
|
1919
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
|
1920
|
+
# A list of any applicable data validation warnings about the question's
|
1921
|
+
# feedback labels.
|
1922
|
+
# @!attribute [rw] valid_feedback_labels_count
|
1923
|
+
# @return [::Integer]
|
1924
|
+
# The number of valid feedback labels in the question's dataset.
|
1925
|
+
class QaQuestionDatasetValidationResult
|
1926
|
+
include ::Google::Protobuf::MessageExts
|
1927
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1928
|
+
end
|
1929
|
+
|
1930
|
+
# Contains performance metrics for each QaQuestion in the
|
1931
|
+
# TuneScorecardRevision request.
|
1932
|
+
# @!attribute [r] question
|
1933
|
+
# @return [::String]
|
1934
|
+
# Output only. The resource path of the question whose dataset was
|
1935
|
+
# evaluated for tuning.
|
1936
|
+
# @!attribute [r] metrics
|
1937
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::TuneQaScorecardRevisionMetadata::QaQuestionDatasetTuningMetrics::Metrics]
|
1938
|
+
# Output only. The metrics for the question's dataset.
|
1939
|
+
class QaQuestionDatasetTuningMetrics
|
1940
|
+
include ::Google::Protobuf::MessageExts
|
1941
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1942
|
+
|
1943
|
+
# Performance metrics for the question's dataset calculated over the tuned
|
1944
|
+
# model.
|
1945
|
+
# @!attribute [rw] accuracy
|
1946
|
+
# @return [::Float]
|
1947
|
+
# Accuracy of the question's dataset.
|
1948
|
+
class Metrics
|
1949
|
+
include ::Google::Protobuf::MessageExts
|
1950
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1951
|
+
end
|
1952
|
+
end
|
1953
|
+
end
|
1954
|
+
|
1955
|
+
# The request to deploy a QaScorecardRevision
|
1956
|
+
# @!attribute [rw] name
|
1957
|
+
# @return [::String]
|
1958
|
+
# Required. The name of the QaScorecardRevision to deploy.
|
1959
|
+
class DeployQaScorecardRevisionRequest
|
1960
|
+
include ::Google::Protobuf::MessageExts
|
1961
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1962
|
+
end
|
1963
|
+
|
1964
|
+
# The request to undeploy a QaScorecardRevision
|
1965
|
+
# @!attribute [rw] name
|
1966
|
+
# @return [::String]
|
1967
|
+
# Required. The name of the QaScorecardRevision to undeploy.
|
1968
|
+
class UndeployQaScorecardRevisionRequest
|
1969
|
+
include ::Google::Protobuf::MessageExts
|
1970
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1971
|
+
end
|
1972
|
+
|
1973
|
+
# The request to delete a QaScorecardRevision.
|
1974
|
+
# @!attribute [rw] name
|
1975
|
+
# @return [::String]
|
1976
|
+
# Required. The name of the QaScorecardRevision to delete.
|
1977
|
+
# @!attribute [rw] force
|
1978
|
+
# @return [::Boolean]
|
1979
|
+
# Optional. If set to true, all of this QaScorecardRevision's child resources
|
1980
|
+
# will also be deleted. Otherwise, the request will only succeed if it has
|
1981
|
+
# none.
|
1982
|
+
class DeleteQaScorecardRevisionRequest
|
1983
|
+
include ::Google::Protobuf::MessageExts
|
1984
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1985
|
+
end
|
1986
|
+
|
1987
|
+
# Request to list QaScorecards.
|
1988
|
+
# @!attribute [rw] parent
|
1989
|
+
# @return [::String]
|
1990
|
+
# Required. The parent resource of the scorecards.
|
1991
|
+
# @!attribute [rw] page_size
|
1992
|
+
# @return [::Integer]
|
1993
|
+
# Optional. The maximum number of scorecards to return in the response. If
|
1994
|
+
# the value is zero, the service will select a default size. A call might
|
1995
|
+
# return fewer objects than requested. A non-empty `next_page_token` in the
|
1996
|
+
# response indicates that more data is available.
|
1997
|
+
# @!attribute [rw] page_token
|
1998
|
+
# @return [::String]
|
1999
|
+
# Optional. The value returned by the last `ListQaScorecardsResponse`. This
|
2000
|
+
# value indicates that this is a continuation of a prior `ListQaScorecards`
|
2001
|
+
# call and that the system should return the next page of data.
|
2002
|
+
class ListQaScorecardsRequest
|
2003
|
+
include ::Google::Protobuf::MessageExts
|
2004
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2005
|
+
end
|
2006
|
+
|
2007
|
+
# The response from a ListQaScorecards request.
|
2008
|
+
# @!attribute [rw] qa_scorecards
|
2009
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaScorecard>]
|
2010
|
+
# The QaScorecards under the parent.
|
2011
|
+
# @!attribute [rw] next_page_token
|
2012
|
+
# @return [::String]
|
2013
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
2014
|
+
# If this field is omitted, there are no subsequent pages.
|
2015
|
+
class ListQaScorecardsResponse
|
2016
|
+
include ::Google::Protobuf::MessageExts
|
2017
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2018
|
+
end
|
2019
|
+
|
2020
|
+
# Request to list QaScorecardRevisions
|
2021
|
+
# @!attribute [rw] parent
|
2022
|
+
# @return [::String]
|
2023
|
+
# Required. The parent resource of the scorecard revisions. To list all
|
2024
|
+
# revisions of all scorecards, substitute the QaScorecard ID with a '-'
|
2025
|
+
# character.
|
2026
|
+
# @!attribute [rw] page_size
|
2027
|
+
# @return [::Integer]
|
2028
|
+
# Optional. The maximum number of scorecard revisions to return in the
|
2029
|
+
# response. If the value is zero, the service will select a default size. A
|
2030
|
+
# call might return fewer objects than requested. A non-empty
|
2031
|
+
# `next_page_token` in the response indicates that more data is available.
|
2032
|
+
# @!attribute [rw] page_token
|
2033
|
+
# @return [::String]
|
2034
|
+
# Optional. The value returned by the last
|
2035
|
+
# `ListQaScorecardRevisionsResponse`. This value indicates that this is a
|
2036
|
+
# continuation of a prior `ListQaScorecardRevisions` call and that the system
|
2037
|
+
# should return the next page of data.
|
2038
|
+
# @!attribute [rw] filter
|
2039
|
+
# @return [::String]
|
2040
|
+
# Optional. A filter to reduce results to a specific subset. Useful for
|
2041
|
+
# querying scorecard revisions with specific properties.
|
2042
|
+
class ListQaScorecardRevisionsRequest
|
2043
|
+
include ::Google::Protobuf::MessageExts
|
2044
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2045
|
+
end
|
2046
|
+
|
2047
|
+
# The response from a ListQaScorecardRevisions request.
|
2048
|
+
# @!attribute [rw] qa_scorecard_revisions
|
2049
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision>]
|
2050
|
+
# The QaScorecards under the parent.
|
2051
|
+
# @!attribute [rw] next_page_token
|
2052
|
+
# @return [::String]
|
2053
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
2054
|
+
# If this field is omitted, there are no subsequent pages.
|
2055
|
+
class ListQaScorecardRevisionsResponse
|
2056
|
+
include ::Google::Protobuf::MessageExts
|
2057
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2058
|
+
end
|
2059
|
+
|
2060
|
+
# The request for creating a feedback label.
|
2061
|
+
# @!attribute [rw] parent
|
2062
|
+
# @return [::String]
|
2063
|
+
# Required. The parent resource of the feedback label.
|
2064
|
+
# @!attribute [rw] feedback_label_id
|
2065
|
+
# @return [::String]
|
2066
|
+
# Optional. The ID of the feedback label to create.
|
2067
|
+
# If one is not specified it will be generated by the server.
|
2068
|
+
# @!attribute [rw] feedback_label
|
2069
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel]
|
2070
|
+
# Required. The feedback label to create.
|
2071
|
+
class CreateFeedbackLabelRequest
|
2072
|
+
include ::Google::Protobuf::MessageExts
|
2073
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2074
|
+
end
|
2075
|
+
|
2076
|
+
# The request for listing feedback labels.
|
2077
|
+
# @!attribute [rw] parent
|
2078
|
+
# @return [::String]
|
2079
|
+
# Required. The parent resource of the feedback labels.
|
2080
|
+
# @!attribute [rw] filter
|
2081
|
+
# @return [::String]
|
2082
|
+
# Optional. A filter to reduce results to a specific subset. Supports
|
2083
|
+
# disjunctions (OR) and conjunctions (AND). Automatically sorts by
|
2084
|
+
# conversation ID. To sort by all feedback labels in a project see
|
2085
|
+
# ListAllFeedbackLabels.
|
2086
|
+
#
|
2087
|
+
# Supported fields:
|
2088
|
+
#
|
2089
|
+
# * `issue_model_id`
|
2090
|
+
# * `qa_question_id`
|
2091
|
+
# * `qa_scorecard_id`
|
2092
|
+
# * `min_create_time`
|
2093
|
+
# * `max_create_time`
|
2094
|
+
# * `min_update_time`
|
2095
|
+
# * `max_update_time`
|
2096
|
+
# * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
|
2097
|
+
# @!attribute [rw] page_size
|
2098
|
+
# @return [::Integer]
|
2099
|
+
# Optional. The maximum number of feedback labels to return in the response.
|
2100
|
+
# A valid page size ranges from 0 to 100,000 inclusive. If the page size is
|
2101
|
+
# zero or unspecified, a default page size of 100 will be chosen. Note that a
|
2102
|
+
# call might return fewer results than the requested page size.
|
2103
|
+
# @!attribute [rw] page_token
|
2104
|
+
# @return [::String]
|
2105
|
+
# Optional. The value returned by the last `ListFeedbackLabelsResponse`. This
|
2106
|
+
# value indicates that this is a continuation of a prior `ListFeedbackLabels`
|
2107
|
+
# call and that the system should return the next page of data.
|
2108
|
+
class ListFeedbackLabelsRequest
|
2109
|
+
include ::Google::Protobuf::MessageExts
|
2110
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2111
|
+
end
|
2112
|
+
|
2113
|
+
# The response for listing feedback labels.
|
2114
|
+
# @!attribute [rw] feedback_labels
|
2115
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>]
|
2116
|
+
# The feedback labels that match the request.
|
2117
|
+
# @!attribute [rw] next_page_token
|
2118
|
+
# @return [::String]
|
2119
|
+
# The next page token.
|
2120
|
+
class ListFeedbackLabelsResponse
|
2121
|
+
include ::Google::Protobuf::MessageExts
|
2122
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2123
|
+
end
|
2124
|
+
|
2125
|
+
# The request for getting a feedback label.
|
2126
|
+
# @!attribute [rw] name
|
2127
|
+
# @return [::String]
|
2128
|
+
# Required. The name of the feedback label to get.
|
2129
|
+
class GetFeedbackLabelRequest
|
2130
|
+
include ::Google::Protobuf::MessageExts
|
2131
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2132
|
+
end
|
2133
|
+
|
2134
|
+
# The request for updating a feedback label.
|
2135
|
+
# @!attribute [rw] feedback_label
|
2136
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel]
|
2137
|
+
# Required. The feedback label to update.
|
2138
|
+
# @!attribute [rw] update_mask
|
2139
|
+
# @return [::Google::Protobuf::FieldMask]
|
2140
|
+
# Required. The list of fields to be updated.
|
2141
|
+
class UpdateFeedbackLabelRequest
|
2142
|
+
include ::Google::Protobuf::MessageExts
|
2143
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2144
|
+
end
|
2145
|
+
|
2146
|
+
# The request for deleting a feedback label.
|
2147
|
+
# @!attribute [rw] name
|
2148
|
+
# @return [::String]
|
2149
|
+
# Required. The name of the feedback label to delete.
|
2150
|
+
class DeleteFeedbackLabelRequest
|
2151
|
+
include ::Google::Protobuf::MessageExts
|
2152
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2153
|
+
end
|
2154
|
+
|
2155
|
+
# The request for listing all feedback labels.
|
2156
|
+
# @!attribute [rw] parent
|
2157
|
+
# @return [::String]
|
2158
|
+
# Required. The parent resource of all feedback labels per project.
|
2159
|
+
# @!attribute [rw] page_size
|
2160
|
+
# @return [::Integer]
|
2161
|
+
# Optional. The maximum number of feedback labels to return in the response.
|
2162
|
+
# A valid page size ranges from 0 to 100,000 inclusive. If the page size is
|
2163
|
+
# zero or unspecified, a default page size of 100 will be chosen. Note that a
|
2164
|
+
# call might return fewer results than the requested page size.
|
2165
|
+
# @!attribute [rw] page_token
|
2166
|
+
# @return [::String]
|
2167
|
+
# Optional. The value returned by the last `ListAllFeedbackLabelsResponse`.
|
2168
|
+
# This value indicates that this is a continuation of a prior
|
2169
|
+
# `ListAllFeedbackLabels` call and that the system should return the next
|
2170
|
+
# page of data.
|
2171
|
+
# @!attribute [rw] filter
|
2172
|
+
# @return [::String]
|
2173
|
+
# Optional. A filter to reduce results to a specific subset in the entire
|
2174
|
+
# project. Supports disjunctions (OR) and conjunctions (AND).
|
2175
|
+
#
|
2176
|
+
# Supported fields:
|
2177
|
+
#
|
2178
|
+
# * `issue_model_id`
|
2179
|
+
# * `qa_question_id`
|
2180
|
+
# * `min_create_time`
|
2181
|
+
# * `max_create_time`
|
2182
|
+
# * `min_update_time`
|
2183
|
+
# * `max_update_time`
|
2184
|
+
# * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
|
2185
|
+
class ListAllFeedbackLabelsRequest
|
2186
|
+
include ::Google::Protobuf::MessageExts
|
2187
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2188
|
+
end
|
2189
|
+
|
2190
|
+
# The response for listing all feedback labels.
|
2191
|
+
# @!attribute [rw] feedback_labels
|
2192
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>]
|
2193
|
+
# The feedback labels that match the request.
|
2194
|
+
# @!attribute [rw] next_page_token
|
2195
|
+
# @return [::String]
|
2196
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
2197
|
+
# If this field is omitted, there are no subsequent pages.
|
2198
|
+
class ListAllFeedbackLabelsResponse
|
2199
|
+
include ::Google::Protobuf::MessageExts
|
2200
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2201
|
+
end
|
2202
|
+
|
2203
|
+
# The request for bulk uploading feedback labels.
|
2204
|
+
# @!attribute [rw] gcs_source
|
2205
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkUploadFeedbackLabelsRequest::GcsSource]
|
2206
|
+
# A cloud storage bucket source.
|
2207
|
+
# @!attribute [rw] parent
|
2208
|
+
# @return [::String]
|
2209
|
+
# Required. The parent resource for new feedback labels.
|
2210
|
+
# @!attribute [rw] validate_only
|
2211
|
+
# @return [::Boolean]
|
2212
|
+
# Optional. If set, upload will not happen and the labels will be validated.
|
2213
|
+
# If not set, then default behavior will be to upload the labels after
|
2214
|
+
# validation is complete.
|
2215
|
+
class BulkUploadFeedbackLabelsRequest
|
2216
|
+
include ::Google::Protobuf::MessageExts
|
2217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2218
|
+
|
2219
|
+
# Google Cloud Storage Object details to get the feedback label file from.
|
2220
|
+
# @!attribute [rw] format
|
2221
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkUploadFeedbackLabelsRequest::GcsSource::Format]
|
2222
|
+
# Required. File format which will be ingested.
|
2223
|
+
# @!attribute [rw] object_uri
|
2224
|
+
# @return [::String]
|
2225
|
+
# Required. The Google Cloud Storage URI of the file to import.
|
2226
|
+
# Format: `gs://bucket_name/object_name`
|
2227
|
+
class GcsSource
|
2228
|
+
include ::Google::Protobuf::MessageExts
|
2229
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2230
|
+
|
2231
|
+
# All permissible file formats.
|
2232
|
+
module Format
|
2233
|
+
# Unspecified format.
|
2234
|
+
FORMAT_UNSPECIFIED = 0
|
2235
|
+
|
2236
|
+
# CSV format.
|
2237
|
+
CSV = 1
|
2238
|
+
|
2239
|
+
# JSON format.
|
2240
|
+
JSON = 2
|
2241
|
+
end
|
2242
|
+
end
|
2243
|
+
end
|
2244
|
+
|
2245
|
+
# Response for the Bulk Upload Feedback Labels API.
|
2246
|
+
class BulkUploadFeedbackLabelsResponse
|
2247
|
+
include ::Google::Protobuf::MessageExts
|
2248
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2249
|
+
end
|
2250
|
+
|
2251
|
+
# Metadata for the Bulk Upload Feedback Labels API.
|
2252
|
+
# @!attribute [r] create_time
|
2253
|
+
# @return [::Google::Protobuf::Timestamp]
|
2254
|
+
# Output only. The time the operation was created.
|
2255
|
+
# @!attribute [r] end_time
|
2256
|
+
# @return [::Google::Protobuf::Timestamp]
|
2257
|
+
# Output only. The time the operation finished running.
|
2258
|
+
# @!attribute [r] request
|
2259
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkUploadFeedbackLabelsRequest]
|
2260
|
+
# Output only. The original request for ingest.
|
2261
|
+
# @!attribute [rw] partial_errors
|
2262
|
+
# @return [::Array<::Google::Rpc::Status>]
|
2263
|
+
# Partial errors during ingest operation that might cause the operation
|
2264
|
+
# output to be incomplete.
|
2265
|
+
# @!attribute [r] upload_stats
|
2266
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkUploadFeedbackLabelsMetadata::UploadStats]
|
2267
|
+
# Output only. Statistics for BulkUploadFeedbackLabels operation.
|
2268
|
+
class BulkUploadFeedbackLabelsMetadata
|
2269
|
+
include ::Google::Protobuf::MessageExts
|
2270
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2271
|
+
|
2272
|
+
# Statistics for BulkUploadFeedbackLabels operation.
|
2273
|
+
# @!attribute [rw] processed_object_count
|
2274
|
+
# @return [::Integer]
|
2275
|
+
# The number of objects processed during the upload operation.
|
2276
|
+
# @!attribute [rw] failed_validation_count
|
2277
|
+
# @return [::Integer]
|
2278
|
+
# The number of objects skipped because of failed validation
|
2279
|
+
# @!attribute [rw] successful_upload_count
|
2280
|
+
# @return [::Integer]
|
2281
|
+
# The number of new feedback labels added during this ingest operation.
|
2282
|
+
class UploadStats
|
2283
|
+
include ::Google::Protobuf::MessageExts
|
2284
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2285
|
+
end
|
2286
|
+
end
|
2287
|
+
|
2288
|
+
# Request for the BulkDownloadFeedbackLabel endpoint.
|
2289
|
+
# @!attribute [rw] gcs_destination
|
2290
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination]
|
2291
|
+
# A cloud storage bucket destination.
|
2292
|
+
# @!attribute [rw] parent
|
2293
|
+
# @return [::String]
|
2294
|
+
# Required. The parent resource for new feedback labels.
|
2295
|
+
# @!attribute [rw] filter
|
2296
|
+
# @return [::String]
|
2297
|
+
# Optional. A filter to reduce results to a specific subset. Supports
|
2298
|
+
# disjunctions (OR) and conjunctions (AND).
|
2299
|
+
#
|
2300
|
+
# Supported fields:
|
2301
|
+
#
|
2302
|
+
# * `issue_model_id`
|
2303
|
+
# * `qa_question_id`
|
2304
|
+
# * `qa_scorecard_id`
|
2305
|
+
# * `min_create_time`
|
2306
|
+
# * `max_create_time`
|
2307
|
+
# * `min_update_time`
|
2308
|
+
# * `max_update_time`
|
2309
|
+
# * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
|
2310
|
+
# @!attribute [rw] max_download_count
|
2311
|
+
# @return [::Integer]
|
2312
|
+
# Optional. Limits the maximum number of feedback labels that will be
|
2313
|
+
# downloaded. The first `N` feedback labels will be downloaded.
|
2314
|
+
# @!attribute [rw] feedback_label_type
|
2315
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::FeedbackLabelType]
|
2316
|
+
# Optional. The type of feedback labels that will be downloaded.
|
2317
|
+
# @!attribute [rw] conversation_filter
|
2318
|
+
# @return [::String]
|
2319
|
+
# Optional. Filter parent conversations to download feedback labels for.
|
2320
|
+
# When specified, the feedback labels will be downloaded for the
|
2321
|
+
# conversations that match the filter.
|
2322
|
+
# If `template_qa_scorecard_id` is set, all the conversations that match the
|
2323
|
+
# filter will be paired with the questions under the scorecard for labeling.
|
2324
|
+
# @!attribute [rw] template_qa_scorecard_id
|
2325
|
+
# @return [::Array<::String>]
|
2326
|
+
# Optional. If set, a template for labeling conversations and scorecard
|
2327
|
+
# questions will be created from the conversation_filter and the questions
|
2328
|
+
# under the scorecard(s). The feedback label `filter` will be ignored.
|
2329
|
+
class BulkDownloadFeedbackLabelsRequest
|
2330
|
+
include ::Google::Protobuf::MessageExts
|
2331
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2332
|
+
|
2333
|
+
# Google Cloud Storage Object details to write the feedback labels to.
|
2334
|
+
# @!attribute [rw] format
|
2335
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination::Format]
|
2336
|
+
# Required. File format in which the labels will be exported.
|
2337
|
+
# @!attribute [rw] object_uri
|
2338
|
+
# @return [::String]
|
2339
|
+
# Required. The Google Cloud Storage URI to write the feedback labels to.
|
2340
|
+
# The file name will be used as a prefix for the files written to the
|
2341
|
+
# bucket if the output needs to be split across multiple files, otherwise
|
2342
|
+
# it will be used as is. The file extension will be appended to the file
|
2343
|
+
# name based on the format selected.
|
2344
|
+
# E.g. `gs://bucket_name/object_uri_prefix`
|
2345
|
+
# @!attribute [rw] add_whitespace
|
2346
|
+
# @return [::Boolean]
|
2347
|
+
# Optional. Add whitespace to the JSON file. Makes easier to read, but
|
2348
|
+
# increases file size. Only applicable for JSON format.
|
2349
|
+
# @!attribute [rw] always_print_empty_fields
|
2350
|
+
# @return [::Boolean]
|
2351
|
+
# Optional. Always print fields with no presence.
|
2352
|
+
# This is useful for printing fields that are not set, like implicit 0
|
2353
|
+
# value or empty lists/maps. Only applicable for JSON format.
|
2354
|
+
# @!attribute [rw] records_per_file_count
|
2355
|
+
# @return [::Integer]
|
2356
|
+
# Optional. The number of records per file. Applicable for either format.
|
2357
|
+
class GcsDestination
|
2358
|
+
include ::Google::Protobuf::MessageExts
|
2359
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2360
|
+
|
2361
|
+
# All permissible file formats.
|
2362
|
+
# See `records_per_file_count` to override the default number of records
|
2363
|
+
# per file.
|
2364
|
+
module Format
|
2365
|
+
# Unspecified format.
|
2366
|
+
FORMAT_UNSPECIFIED = 0
|
2367
|
+
|
2368
|
+
# CSV format.
|
2369
|
+
# 1,000 labels are stored per CSV file by default.
|
2370
|
+
CSV = 1
|
2371
|
+
|
2372
|
+
# JSON format.
|
2373
|
+
# 1 label stored per JSON file by default.
|
2374
|
+
JSON = 2
|
2375
|
+
end
|
2376
|
+
end
|
2377
|
+
|
2378
|
+
# Possible feedback label types that will be downloaded.
|
2379
|
+
module FeedbackLabelType
|
2380
|
+
# Unspecified format
|
2381
|
+
FEEDBACK_LABEL_TYPE_UNSPECIFIED = 0
|
2382
|
+
|
2383
|
+
# Downloaded file will contain all Quality AI labels from the latest
|
2384
|
+
# scorecard revision.
|
2385
|
+
QUALITY_AI = 1
|
2386
|
+
|
2387
|
+
# Downloaded file will contain only Topic Modeling labels.
|
2388
|
+
TOPIC_MODELING = 2
|
2389
|
+
end
|
2390
|
+
end
|
2391
|
+
|
2392
|
+
# Response for the BulkDownloadFeedbackLabel endpoint.
|
2393
|
+
class BulkDownloadFeedbackLabelsResponse
|
2394
|
+
include ::Google::Protobuf::MessageExts
|
2395
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2396
|
+
end
|
2397
|
+
|
2398
|
+
# Metadata for the BulkDownloadFeedbackLabel endpoint.
|
2399
|
+
# @!attribute [r] create_time
|
2400
|
+
# @return [::Google::Protobuf::Timestamp]
|
2401
|
+
# Output only. The time the operation was created.
|
2402
|
+
# @!attribute [r] end_time
|
2403
|
+
# @return [::Google::Protobuf::Timestamp]
|
2404
|
+
# Output only. The time the operation finished running.
|
2405
|
+
# @!attribute [r] request
|
2406
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest]
|
2407
|
+
# Output only. The original request for download.
|
2408
|
+
# @!attribute [rw] partial_errors
|
2409
|
+
# @return [::Array<::Google::Rpc::Status>]
|
2410
|
+
# Partial errors during ingest operation that might cause the operation
|
2411
|
+
# output to be incomplete.
|
2412
|
+
# @!attribute [r] download_stats
|
2413
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsMetadata::DownloadStats]
|
2414
|
+
# Output only. Statistics for BulkDownloadFeedbackLabels operation.
|
2415
|
+
class BulkDownloadFeedbackLabelsMetadata
|
2416
|
+
include ::Google::Protobuf::MessageExts
|
2417
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2418
|
+
|
2419
|
+
# Statistics for BulkDownloadFeedbackLabels operation.
|
2420
|
+
# @!attribute [rw] processed_object_count
|
2421
|
+
# @return [::Integer]
|
2422
|
+
# The number of objects processed during the download operation.
|
2423
|
+
# @!attribute [rw] successful_download_count
|
2424
|
+
# @return [::Integer]
|
2425
|
+
# The number of new feedback labels downloaded during this operation.
|
2426
|
+
# Different from "processed" because some labels might not be downloaded
|
2427
|
+
# because an error.
|
2428
|
+
# @!attribute [rw] total_files_written
|
2429
|
+
# @return [::Integer]
|
2430
|
+
# Total number of files written to the provided Cloud Storage bucket.
|
2431
|
+
# @!attribute [r] file_names
|
2432
|
+
# @return [::Array<::String>]
|
2433
|
+
# Output only. Full name of the files written to Cloud storage.
|
2434
|
+
class DownloadStats
|
2435
|
+
include ::Google::Protobuf::MessageExts
|
2436
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2437
|
+
end
|
2438
|
+
end
|
2439
|
+
|
1278
2440
|
# Represents the options for viewing a conversation.
|
1279
2441
|
module ConversationView
|
1280
2442
|
# The conversation view is not specified.
|