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
@@ -59,16 +59,16 @@ module Google
|
|
59
59
|
# the conversation.
|
60
60
|
# @!attribute [rw] labels
|
61
61
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
62
|
-
# A map for the user to specify any custom fields. A maximum of
|
63
|
-
# conversation is allowed, with a maximum of 256 characters per entry.
|
62
|
+
# A map for the user to specify any custom fields. A maximum of 100 labels
|
63
|
+
# per conversation is allowed, with a maximum of 256 characters per entry.
|
64
64
|
# @!attribute [rw] quality_metadata
|
65
65
|
# @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::QualityMetadata]
|
66
66
|
# Conversation metadata related to quality management.
|
67
67
|
# @!attribute [rw] metadata_json
|
68
68
|
# @return [::String]
|
69
|
-
# Input only. JSON
|
69
|
+
# Input only. JSON metadata encoded as a string.
|
70
70
|
# This field is primarily used by Insights integrations with various telphony
|
71
|
-
# systems and must be in one of
|
71
|
+
# systems and must be in one of Insight's supported formats.
|
72
72
|
# @!attribute [r] transcript
|
73
73
|
# @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript]
|
74
74
|
# Output only. The conversation transcript.
|
@@ -363,6 +363,9 @@ module Google
|
|
363
363
|
# @!attribute [rw] issue_model_result
|
364
364
|
# @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelResult]
|
365
365
|
# Overall conversation-level issue modeling result.
|
366
|
+
# @!attribute [rw] qa_scorecard_results
|
367
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaScorecardResult>]
|
368
|
+
# Results of scoring QaScorecards.
|
366
369
|
class CallAnalysisMetadata
|
367
370
|
include ::Google::Protobuf::MessageExts
|
368
371
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -409,6 +412,32 @@ module Google
|
|
409
412
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
410
413
|
end
|
411
414
|
|
415
|
+
# Represents a conversation, resource, and label provided by the user.
|
416
|
+
# @!attribute [rw] label
|
417
|
+
# @return [::String]
|
418
|
+
# String label.
|
419
|
+
# @!attribute [rw] qa_answer_label
|
420
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
|
421
|
+
# QaAnswer label.
|
422
|
+
# @!attribute [rw] name
|
423
|
+
# @return [::String]
|
424
|
+
# Immutable. Resource name of the FeedbackLabel.
|
425
|
+
# Format:
|
426
|
+
# projects/\\{project}/locations/\\{location}/conversations/\\{conversation}/feedbackLabels/\\{feedback_label}
|
427
|
+
# @!attribute [rw] labeled_resource
|
428
|
+
# @return [::String]
|
429
|
+
# Resource name of the resource to be labeled.
|
430
|
+
# @!attribute [r] create_time
|
431
|
+
# @return [::Google::Protobuf::Timestamp]
|
432
|
+
# Output only. Create time of the label.
|
433
|
+
# @!attribute [r] update_time
|
434
|
+
# @return [::Google::Protobuf::Timestamp]
|
435
|
+
# Output only. Update time of the label.
|
436
|
+
class FeedbackLabel
|
437
|
+
include ::Google::Protobuf::MessageExts
|
438
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
439
|
+
end
|
440
|
+
|
412
441
|
# One channel of conversation-level sentiment data.
|
413
442
|
# @!attribute [rw] channel_tag
|
414
443
|
# @return [::Integer]
|
@@ -1121,8 +1150,52 @@ module Google
|
|
1121
1150
|
end
|
1122
1151
|
end
|
1123
1152
|
|
1153
|
+
# The CCAI Insights project wide analysis rule. This rule will be applied to
|
1154
|
+
# all conversations that match the filter defined in the rule. For a
|
1155
|
+
# conversation matches the filter, the annotators specified in the rule will be
|
1156
|
+
# run. If a conversation matches multiple rules, a union of all the annotators
|
1157
|
+
# will be run. One project can have multiple analysis rules.
|
1158
|
+
# @!attribute [rw] name
|
1159
|
+
# @return [::String]
|
1160
|
+
# Identifier. The resource name of the analysis rule.
|
1161
|
+
# Format:
|
1162
|
+
# projects/\\{project}/locations/\\{location}/analysisRules/\\{analysis_rule}
|
1163
|
+
# @!attribute [r] create_time
|
1164
|
+
# @return [::Google::Protobuf::Timestamp]
|
1165
|
+
# Output only. The time at which this analysis rule was created.
|
1166
|
+
# @!attribute [r] update_time
|
1167
|
+
# @return [::Google::Protobuf::Timestamp]
|
1168
|
+
# Output only. The most recent time at which this analysis rule was updated.
|
1169
|
+
# @!attribute [rw] display_name
|
1170
|
+
# @return [::String]
|
1171
|
+
# Display Name of the analysis rule.
|
1172
|
+
# @!attribute [rw] conversation_filter
|
1173
|
+
# @return [::String]
|
1174
|
+
# Filter for the conversations that should apply this analysis
|
1175
|
+
# rule. An empty filter means this analysis rule applies to all
|
1176
|
+
# conversations.
|
1177
|
+
# @!attribute [rw] annotator_selector
|
1178
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
|
1179
|
+
# Selector of annotators to run and the phrase matchers to use for
|
1180
|
+
# conversations that matches the conversation_filter. If not specified, NO
|
1181
|
+
# annotators will be run.
|
1182
|
+
# @!attribute [rw] analysis_percentage
|
1183
|
+
# @return [::Float]
|
1184
|
+
# Percentage of conversations that we should apply this analysis setting
|
1185
|
+
# automatically, between [0, 1]. For example, 0.1 means 10%. Conversations
|
1186
|
+
# are sampled in a determenestic way. The original runtime_percentage &
|
1187
|
+
# upload percentage will be replaced by defining filters on the conversation.
|
1188
|
+
# @!attribute [rw] active
|
1189
|
+
# @return [::Boolean]
|
1190
|
+
# If true, apply this rule to conversations. Otherwise, this rule is
|
1191
|
+
# inactive and saved as a draft.
|
1192
|
+
class AnalysisRule
|
1193
|
+
include ::Google::Protobuf::MessageExts
|
1194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1195
|
+
end
|
1196
|
+
|
1124
1197
|
# A customer-managed encryption key specification that can be applied to all
|
1125
|
-
# created resources (e.g. Conversation).
|
1198
|
+
# created resources (e.g. `Conversation`).
|
1126
1199
|
# @!attribute [rw] name
|
1127
1200
|
# @return [::String]
|
1128
1201
|
# Immutable. The resource name of the encryption key specification resource.
|
@@ -1132,8 +1205,8 @@ module Google
|
|
1132
1205
|
# @return [::String]
|
1133
1206
|
# Required. The name of customer-managed encryption key that is used to
|
1134
1207
|
# secure a resource and its sub-resources. If empty, the resource is secured
|
1135
|
-
# by
|
1136
|
-
#
|
1208
|
+
# by our default encryption key. Only the key in the same location as this
|
1209
|
+
# resource is allowed to be used for encryption. Format:
|
1137
1210
|
# `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
|
1138
1211
|
class EncryptionSpec
|
1139
1212
|
include ::Google::Protobuf::MessageExts
|
@@ -1599,6 +1672,12 @@ module Google
|
|
1599
1672
|
# @!attribute [rw] summarization_config
|
1600
1673
|
# @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::SummarizationConfig]
|
1601
1674
|
# Configuration for the summarization annotator.
|
1675
|
+
# @!attribute [rw] run_qa_annotator
|
1676
|
+
# @return [::Boolean]
|
1677
|
+
# Whether to run the QA annotator.
|
1678
|
+
# @!attribute [rw] qa_config
|
1679
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig]
|
1680
|
+
# Configuration for the QA annotator.
|
1602
1681
|
class AnnotatorSelector
|
1603
1682
|
include ::Google::Protobuf::MessageExts
|
1604
1683
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1628,6 +1707,416 @@ module Google
|
|
1628
1707
|
BASELINE_MODEL_V2_0 = 2
|
1629
1708
|
end
|
1630
1709
|
end
|
1710
|
+
|
1711
|
+
# Configuration for the QA feature.
|
1712
|
+
# @!attribute [rw] scorecard_list
|
1713
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector::QaConfig::ScorecardList]
|
1714
|
+
# A manual list of scorecards to score.
|
1715
|
+
class QaConfig
|
1716
|
+
include ::Google::Protobuf::MessageExts
|
1717
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1718
|
+
|
1719
|
+
# Container for a list of scorecards.
|
1720
|
+
# @!attribute [rw] qa_scorecard_revisions
|
1721
|
+
# @return [::Array<::String>]
|
1722
|
+
# List of QaScorecardRevisions.
|
1723
|
+
class ScorecardList
|
1724
|
+
include ::Google::Protobuf::MessageExts
|
1725
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1726
|
+
end
|
1727
|
+
end
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# A single question to be scored by the Insights QA feature.
|
1731
|
+
# @!attribute [rw] name
|
1732
|
+
# @return [::String]
|
1733
|
+
# Identifier. The resource name of the question.
|
1734
|
+
# Format:
|
1735
|
+
# projects/\\{project}/locations/\\{location}/qaScorecards/\\{qa_scorecard}/revisions/\\{revision}/qaQuestions/\\{qa_question}
|
1736
|
+
# @!attribute [rw] abbreviation
|
1737
|
+
# @return [::String]
|
1738
|
+
# Short, descriptive string, used in the UI where it's not practical
|
1739
|
+
# to display the full question body. E.g., "Greeting".
|
1740
|
+
# @!attribute [r] create_time
|
1741
|
+
# @return [::Google::Protobuf::Timestamp]
|
1742
|
+
# Output only. The time at which this question was created.
|
1743
|
+
# @!attribute [r] update_time
|
1744
|
+
# @return [::Google::Protobuf::Timestamp]
|
1745
|
+
# Output only. The most recent time at which the question was updated.
|
1746
|
+
# @!attribute [rw] question_body
|
1747
|
+
# @return [::String]
|
1748
|
+
# Question text. E.g., "Did the agent greet the customer?"
|
1749
|
+
# @!attribute [rw] answer_instructions
|
1750
|
+
# @return [::String]
|
1751
|
+
# Instructions describing how to determine the answer.
|
1752
|
+
# @!attribute [rw] answer_choices
|
1753
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice>]
|
1754
|
+
# A list of valid answers to the question, which the LLM must choose from.
|
1755
|
+
# @!attribute [rw] tags
|
1756
|
+
# @return [::Array<::String>]
|
1757
|
+
# User-defined list of arbitrary tags for the question. Used for
|
1758
|
+
# grouping/organization and for weighting the score of each question.
|
1759
|
+
# @!attribute [rw] order
|
1760
|
+
# @return [::Integer]
|
1761
|
+
# Defines the order of the question within its parent scorecard revision.
|
1762
|
+
# @!attribute [rw] metrics
|
1763
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaQuestion::Metrics]
|
1764
|
+
# Metrics of the underlying tuned LLM over a holdout/test set while fine
|
1765
|
+
# tuning the underlying LLM for the given question. This field will only be
|
1766
|
+
# populated if and only if the question is part of a scorecard revision that
|
1767
|
+
# has been tuned.
|
1768
|
+
# @!attribute [rw] tuning_metadata
|
1769
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaQuestion::TuningMetadata]
|
1770
|
+
# Metadata about the tuning operation for the question.This field will only
|
1771
|
+
# be populated if and only if the question is part of a scorecard revision
|
1772
|
+
# that has been tuned.
|
1773
|
+
class QaQuestion
|
1774
|
+
include ::Google::Protobuf::MessageExts
|
1775
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1776
|
+
|
1777
|
+
# Message representing a possible answer to the question.
|
1778
|
+
# @!attribute [rw] str_value
|
1779
|
+
# @return [::String]
|
1780
|
+
# String value.
|
1781
|
+
# @!attribute [rw] num_value
|
1782
|
+
# @return [::Float]
|
1783
|
+
# Numerical value.
|
1784
|
+
# @!attribute [rw] bool_value
|
1785
|
+
# @return [::Boolean]
|
1786
|
+
# Boolean value.
|
1787
|
+
# @!attribute [rw] na_value
|
1788
|
+
# @return [::Boolean]
|
1789
|
+
# A value of "Not Applicable (N/A)". If provided, this field may only
|
1790
|
+
# be set to `true`. If a question receives this answer, it will be
|
1791
|
+
# excluded from any score calculations.
|
1792
|
+
# @!attribute [rw] key
|
1793
|
+
# @return [::String]
|
1794
|
+
# A short string used as an identifier.
|
1795
|
+
# @!attribute [rw] score
|
1796
|
+
# @return [::Float]
|
1797
|
+
# Numerical score of the answer, used for generating the overall score of
|
1798
|
+
# a QaScorecardResult. If the answer uses na_value, this field is unused.
|
1799
|
+
class AnswerChoice
|
1800
|
+
include ::Google::Protobuf::MessageExts
|
1801
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1802
|
+
end
|
1803
|
+
|
1804
|
+
# A wrapper representing metrics calculated against a test-set on a LLM that
|
1805
|
+
# was fine tuned for this question.
|
1806
|
+
# @!attribute [r] accuracy
|
1807
|
+
# @return [::Float]
|
1808
|
+
# Output only. Accuracy of the model. Measures the percentage of correct
|
1809
|
+
# answers the model gave on the test set.
|
1810
|
+
class Metrics
|
1811
|
+
include ::Google::Protobuf::MessageExts
|
1812
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1813
|
+
end
|
1814
|
+
|
1815
|
+
# Metadata about the tuning operation for the question. Will only be set if a
|
1816
|
+
# scorecard containing this question has been tuned.
|
1817
|
+
# @!attribute [rw] total_valid_label_count
|
1818
|
+
# @return [::Integer]
|
1819
|
+
# Total number of valid labels provided for the question at the time of
|
1820
|
+
# tuining.
|
1821
|
+
# @!attribute [rw] dataset_validation_warnings
|
1822
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
|
1823
|
+
# A list of any applicable data validation warnings about the question's
|
1824
|
+
# feedback labels.
|
1825
|
+
# @!attribute [rw] tuning_error
|
1826
|
+
# @return [::String]
|
1827
|
+
# Error status of the tuning operation for the question. Will only be set
|
1828
|
+
# if the tuning operation failed.
|
1829
|
+
class TuningMetadata
|
1830
|
+
include ::Google::Protobuf::MessageExts
|
1831
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1832
|
+
end
|
1833
|
+
end
|
1834
|
+
|
1835
|
+
# A QaScorecard represents a collection of questions to be scored during
|
1836
|
+
# analysis.
|
1837
|
+
# @!attribute [rw] name
|
1838
|
+
# @return [::String]
|
1839
|
+
# Identifier. The scorecard name.
|
1840
|
+
# Format:
|
1841
|
+
# projects/\\{project}/locations/\\{location}/qaScorecards/\\{qa_scorecard}
|
1842
|
+
# @!attribute [rw] display_name
|
1843
|
+
# @return [::String]
|
1844
|
+
# The user-specified display name of the scorecard.
|
1845
|
+
# @!attribute [rw] description
|
1846
|
+
# @return [::String]
|
1847
|
+
# A text description explaining the intent of the scorecard.
|
1848
|
+
# @!attribute [r] create_time
|
1849
|
+
# @return [::Google::Protobuf::Timestamp]
|
1850
|
+
# Output only. The time at which this scorecard was created.
|
1851
|
+
# @!attribute [r] update_time
|
1852
|
+
# @return [::Google::Protobuf::Timestamp]
|
1853
|
+
# Output only. The most recent time at which the scorecard was updated.
|
1854
|
+
class QaScorecard
|
1855
|
+
include ::Google::Protobuf::MessageExts
|
1856
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1857
|
+
end
|
1858
|
+
|
1859
|
+
# A revision of a QaScorecard.
|
1860
|
+
#
|
1861
|
+
# Modifying published scorecard fields would invalidate existing scorecard
|
1862
|
+
# results — the questions may have changed, or the score weighting will make
|
1863
|
+
# existing scores impossible to understand. So changes must create a new
|
1864
|
+
# revision, rather than modifying the existing resource.
|
1865
|
+
# @!attribute [rw] name
|
1866
|
+
# @return [::String]
|
1867
|
+
# Identifier. The name of the scorecard revision.
|
1868
|
+
# Format:
|
1869
|
+
# projects/\\{project}/locations/\\{location}/qaScorecards/\\{qa_scorecard}/revisions/\\{revision}
|
1870
|
+
# @!attribute [rw] snapshot
|
1871
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaScorecard]
|
1872
|
+
# The snapshot of the scorecard at the time of this revision's creation.
|
1873
|
+
# @!attribute [r] create_time
|
1874
|
+
# @return [::Google::Protobuf::Timestamp]
|
1875
|
+
# Output only. The timestamp that the revision was created.
|
1876
|
+
# @!attribute [r] alternate_ids
|
1877
|
+
# @return [::Array<::String>]
|
1878
|
+
# Output only. Alternative IDs for this revision of the scorecard, e.g.,
|
1879
|
+
# `latest`.
|
1880
|
+
# @!attribute [r] state
|
1881
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision::State]
|
1882
|
+
# Output only. State of the scorecard revision, indicating whether it's ready
|
1883
|
+
# to be used in analysis.
|
1884
|
+
class QaScorecardRevision
|
1885
|
+
include ::Google::Protobuf::MessageExts
|
1886
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1887
|
+
|
1888
|
+
# Enum representing the set of states a scorecard revision may be in.
|
1889
|
+
module State
|
1890
|
+
# Unspecified.
|
1891
|
+
STATE_UNSPECIFIED = 0
|
1892
|
+
|
1893
|
+
# The scorecard revision can be edited.
|
1894
|
+
EDITABLE = 12
|
1895
|
+
|
1896
|
+
# Scorecard model training is in progress.
|
1897
|
+
TRAINING = 2
|
1898
|
+
|
1899
|
+
# Scorecard revision model training failed.
|
1900
|
+
TRAINING_FAILED = 9
|
1901
|
+
|
1902
|
+
# The revision can be used in analysis.
|
1903
|
+
READY = 11
|
1904
|
+
|
1905
|
+
# Scorecard is being deleted.
|
1906
|
+
DELETING = 7
|
1907
|
+
|
1908
|
+
# Scorecard model training was explicitly cancelled by the user.
|
1909
|
+
TRAINING_CANCELLED = 14
|
1910
|
+
end
|
1911
|
+
end
|
1912
|
+
|
1913
|
+
# An answer to a QaQuestion.
|
1914
|
+
# @!attribute [rw] qa_question
|
1915
|
+
# @return [::String]
|
1916
|
+
# The QaQuestion answered by this answer.
|
1917
|
+
# @!attribute [rw] conversation
|
1918
|
+
# @return [::String]
|
1919
|
+
# The conversation the answer applies to.
|
1920
|
+
# @!attribute [rw] question_body
|
1921
|
+
# @return [::String]
|
1922
|
+
# Question text. E.g., "Did the agent greet the customer?"
|
1923
|
+
# @!attribute [rw] answer_value
|
1924
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
|
1925
|
+
# The main answer value, incorporating any manual edits if they exist.
|
1926
|
+
# @!attribute [rw] tags
|
1927
|
+
# @return [::Array<::String>]
|
1928
|
+
# User-defined list of arbitrary tags. Matches the value from
|
1929
|
+
# QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and
|
1930
|
+
# for weighting the score of each answer.
|
1931
|
+
# @!attribute [rw] answer_sources
|
1932
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource>]
|
1933
|
+
# List of all individual answers given to the question.
|
1934
|
+
class QaAnswer
|
1935
|
+
include ::Google::Protobuf::MessageExts
|
1936
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1937
|
+
|
1938
|
+
# Message for holding the value of a
|
1939
|
+
# {::Google::Cloud::ContactCenterInsights::V1::QaAnswer QaAnswer}.
|
1940
|
+
# {::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice QaQuestion.AnswerChoice}
|
1941
|
+
# defines the possible answer values for a question.
|
1942
|
+
# @!attribute [rw] str_value
|
1943
|
+
# @return [::String]
|
1944
|
+
# String value.
|
1945
|
+
# @!attribute [rw] num_value
|
1946
|
+
# @return [::Float]
|
1947
|
+
# Numerical value.
|
1948
|
+
# @!attribute [rw] bool_value
|
1949
|
+
# @return [::Boolean]
|
1950
|
+
# Boolean value.
|
1951
|
+
# @!attribute [rw] na_value
|
1952
|
+
# @return [::Boolean]
|
1953
|
+
# A value of "Not Applicable (N/A)". Should only ever be `true`.
|
1954
|
+
# @!attribute [rw] key
|
1955
|
+
# @return [::String]
|
1956
|
+
# A short string used as an identifier. Matches the value used in
|
1957
|
+
# QaQuestion.AnswerChoice.key.
|
1958
|
+
# @!attribute [r] score
|
1959
|
+
# @return [::Float]
|
1960
|
+
# Output only. Numerical score of the answer.
|
1961
|
+
# @!attribute [r] potential_score
|
1962
|
+
# @return [::Float]
|
1963
|
+
# Output only. The maximum potential score of the question.
|
1964
|
+
# @!attribute [r] normalized_score
|
1965
|
+
# @return [::Float]
|
1966
|
+
# Output only. Normalized score of the questions. Calculated as score /
|
1967
|
+
# potential_score.
|
1968
|
+
class AnswerValue
|
1969
|
+
include ::Google::Protobuf::MessageExts
|
1970
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1971
|
+
end
|
1972
|
+
|
1973
|
+
# A question may have multiple answers from varying sources, one of which
|
1974
|
+
# becomes the "main" answer above. AnswerSource represents each individual
|
1975
|
+
# answer.
|
1976
|
+
# @!attribute [rw] source_type
|
1977
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource::SourceType]
|
1978
|
+
# What created the answer.
|
1979
|
+
# @!attribute [rw] answer_value
|
1980
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
|
1981
|
+
# The answer value from this source.
|
1982
|
+
class AnswerSource
|
1983
|
+
include ::Google::Protobuf::MessageExts
|
1984
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1985
|
+
|
1986
|
+
# What created the answer.
|
1987
|
+
module SourceType
|
1988
|
+
# Source type is unspecified.
|
1989
|
+
SOURCE_TYPE_UNSPECIFIED = 0
|
1990
|
+
|
1991
|
+
# Answer was system-generated; created during an Insights analysis.
|
1992
|
+
SYSTEM_GENERATED = 1
|
1993
|
+
|
1994
|
+
# Answer was created by a human via manual edit.
|
1995
|
+
MANUAL_EDIT = 2
|
1996
|
+
end
|
1997
|
+
end
|
1998
|
+
end
|
1999
|
+
|
2000
|
+
# The results of scoring a single conversation against a QaScorecard. Contains
|
2001
|
+
# a collection of QaAnswers and aggregate score.
|
2002
|
+
# @!attribute [rw] name
|
2003
|
+
# @return [::String]
|
2004
|
+
# Identifier. The name of the scorecard result.
|
2005
|
+
# Format:
|
2006
|
+
# projects/\\{project}/locations/\\{location}/qaScorecardResults/\\{qa_scorecard_result}
|
2007
|
+
# @!attribute [rw] qa_scorecard_revision
|
2008
|
+
# @return [::String]
|
2009
|
+
# The QaScorecardRevision scored by this result.
|
2010
|
+
# @!attribute [rw] conversation
|
2011
|
+
# @return [::String]
|
2012
|
+
# The conversation scored by this result.
|
2013
|
+
# @!attribute [r] create_time
|
2014
|
+
# @return [::Google::Protobuf::Timestamp]
|
2015
|
+
# Output only. The timestamp that the revision was created.
|
2016
|
+
# @!attribute [rw] agent_id
|
2017
|
+
# @return [::String]
|
2018
|
+
# ID of the agent that handled the conversation.
|
2019
|
+
# @!attribute [rw] qa_answers
|
2020
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaAnswer>]
|
2021
|
+
# Set of QaAnswers represented in the result.
|
2022
|
+
# @!attribute [rw] score
|
2023
|
+
# @return [::Float]
|
2024
|
+
# The overall numerical score of the result, incorporating any manual edits
|
2025
|
+
# if they exist.
|
2026
|
+
# @!attribute [rw] potential_score
|
2027
|
+
# @return [::Float]
|
2028
|
+
# The maximum potential overall score of the scorecard. Any questions
|
2029
|
+
# answered using `na_value` are excluded from this calculation.
|
2030
|
+
# @!attribute [rw] normalized_score
|
2031
|
+
# @return [::Float]
|
2032
|
+
# The normalized score, which is the score divided by the potential score.
|
2033
|
+
# Any manual edits are included if they exist.
|
2034
|
+
# @!attribute [rw] qa_tag_results
|
2035
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaScorecardResult::QaTagResult>]
|
2036
|
+
# Collection of tags and their scores.
|
2037
|
+
# @!attribute [rw] score_sources
|
2038
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaScorecardResult::ScoreSource>]
|
2039
|
+
# List of all individual score sets.
|
2040
|
+
class QaScorecardResult
|
2041
|
+
include ::Google::Protobuf::MessageExts
|
2042
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2043
|
+
|
2044
|
+
# Tags and their corresponding results.
|
2045
|
+
# @!attribute [rw] tag
|
2046
|
+
# @return [::String]
|
2047
|
+
# The tag the score applies to.
|
2048
|
+
# @!attribute [rw] score
|
2049
|
+
# @return [::Float]
|
2050
|
+
# The score the tag applies to.
|
2051
|
+
# @!attribute [rw] potential_score
|
2052
|
+
# @return [::Float]
|
2053
|
+
# The potential score the tag applies to.
|
2054
|
+
# @!attribute [rw] normalized_score
|
2055
|
+
# @return [::Float]
|
2056
|
+
# The normalized score the tag applies to.
|
2057
|
+
class QaTagResult
|
2058
|
+
include ::Google::Protobuf::MessageExts
|
2059
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2060
|
+
end
|
2061
|
+
|
2062
|
+
# A scorecard result may have multiple sets of scores from varying sources,
|
2063
|
+
# one of which becomes the "main" answer above. A ScoreSource represents
|
2064
|
+
# each individual set of scores.
|
2065
|
+
# @!attribute [rw] source_type
|
2066
|
+
# @return [::Google::Cloud::ContactCenterInsights::V1::QaScorecardResult::ScoreSource::SourceType]
|
2067
|
+
# What created the score.
|
2068
|
+
# @!attribute [rw] score
|
2069
|
+
# @return [::Float]
|
2070
|
+
# The overall numerical score of the result.
|
2071
|
+
# @!attribute [rw] potential_score
|
2072
|
+
# @return [::Float]
|
2073
|
+
# The maximum potential overall score of the scorecard. Any questions
|
2074
|
+
# answered using `na_value` are excluded from this calculation.
|
2075
|
+
# @!attribute [rw] normalized_score
|
2076
|
+
# @return [::Float]
|
2077
|
+
# The normalized score, which is the score divided by the potential score.
|
2078
|
+
# @!attribute [rw] qa_tag_results
|
2079
|
+
# @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QaScorecardResult::QaTagResult>]
|
2080
|
+
# Collection of tags and their scores.
|
2081
|
+
class ScoreSource
|
2082
|
+
include ::Google::Protobuf::MessageExts
|
2083
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2084
|
+
|
2085
|
+
# What created the score.
|
2086
|
+
module SourceType
|
2087
|
+
# Source type is unspecified.
|
2088
|
+
SOURCE_TYPE_UNSPECIFIED = 0
|
2089
|
+
|
2090
|
+
# Score is derived only from system-generated answers.
|
2091
|
+
SYSTEM_GENERATED_ONLY = 1
|
2092
|
+
|
2093
|
+
# Score is derived from both system-generated answers, and includes
|
2094
|
+
# any manual edits if they exist.
|
2095
|
+
INCLUDES_MANUAL_EDITS = 2
|
2096
|
+
end
|
2097
|
+
end
|
2098
|
+
end
|
2099
|
+
|
2100
|
+
# Enum for the different types of issues a tuning dataset can have.
|
2101
|
+
# These warnings are currentlyraised when trying to validate a dataset for
|
2102
|
+
# tuning a scorecard.
|
2103
|
+
module DatasetValidationWarning
|
2104
|
+
# Unspecified data validation warning.
|
2105
|
+
DATASET_VALIDATION_WARNING_UNSPECIFIED = 0
|
2106
|
+
|
2107
|
+
# A non-trivial percentage of the feedback labels are invalid.
|
2108
|
+
TOO_MANY_INVALID_FEEDBACK_LABELS = 1
|
2109
|
+
|
2110
|
+
# The quantity of valid feedback labels provided is less than the
|
2111
|
+
# recommended minimum.
|
2112
|
+
INSUFFICIENT_FEEDBACK_LABELS = 2
|
2113
|
+
|
2114
|
+
# One or more of the answers have less than the recommended minimum of
|
2115
|
+
# feedback labels.
|
2116
|
+
INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER = 3
|
2117
|
+
|
2118
|
+
# All the labels in the dataset come from a single answer choice.
|
2119
|
+
ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER = 4
|
1631
2120
|
end
|
1632
2121
|
end
|
1633
2122
|
end
|
@@ -42,7 +42,7 @@ module Google
|
|
42
42
|
# The error result of the operation in case of failure or cancellation.
|
43
43
|
# @!attribute [rw] response
|
44
44
|
# @return [::Google::Protobuf::Any]
|
45
|
-
# The normal response of the operation
|
45
|
+
# The normal, successful response of the operation. If the original
|
46
46
|
# method returns no data on success, such as `Delete`, the response is
|
47
47
|
# `google.protobuf.Empty`. If the original method is standard
|
48
48
|
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
@@ -55,7 +55,8 @@ module Google
|
|
55
55
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
56
|
end
|
57
57
|
|
58
|
-
# The request message for
|
58
|
+
# The request message for
|
59
|
+
# Operations.GetOperation.
|
59
60
|
# @!attribute [rw] name
|
60
61
|
# @return [::String]
|
61
62
|
# The name of the operation resource.
|
@@ -64,7 +65,8 @@ module Google
|
|
64
65
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
66
|
end
|
66
67
|
|
67
|
-
# The request message for
|
68
|
+
# The request message for
|
69
|
+
# Operations.ListOperations.
|
68
70
|
# @!attribute [rw] name
|
69
71
|
# @return [::String]
|
70
72
|
# The name of the operation's parent resource.
|
@@ -82,7 +84,8 @@ module Google
|
|
82
84
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
85
|
end
|
84
86
|
|
85
|
-
# The response message for
|
87
|
+
# The response message for
|
88
|
+
# Operations.ListOperations.
|
86
89
|
# @!attribute [rw] operations
|
87
90
|
# @return [::Array<::Google::Longrunning::Operation>]
|
88
91
|
# A list of operations that matches the specified filter in the request.
|
@@ -94,7 +97,8 @@ module Google
|
|
94
97
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
95
98
|
end
|
96
99
|
|
97
|
-
# The request message for
|
100
|
+
# The request message for
|
101
|
+
# Operations.CancelOperation.
|
98
102
|
# @!attribute [rw] name
|
99
103
|
# @return [::String]
|
100
104
|
# The name of the operation resource to be cancelled.
|
@@ -103,7 +107,8 @@ module Google
|
|
103
107
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
108
|
end
|
105
109
|
|
106
|
-
# The request message for
|
110
|
+
# The request message for
|
111
|
+
# Operations.DeleteOperation.
|
107
112
|
# @!attribute [rw] name
|
108
113
|
# @return [::String]
|
109
114
|
# The name of the operation resource to be deleted.
|
@@ -112,7 +117,8 @@ module Google
|
|
112
117
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
118
|
end
|
114
119
|
|
115
|
-
# The request message for
|
120
|
+
# The request message for
|
121
|
+
# Operations.WaitOperation.
|
116
122
|
# @!attribute [rw] name
|
117
123
|
# @return [::String]
|
118
124
|
# The name of the operation resource to wait on.
|
@@ -130,13 +136,12 @@ module Google
|
|
130
136
|
#
|
131
137
|
# Example:
|
132
138
|
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
# }
|
139
|
-
# }
|
139
|
+
# rpc Export(ExportRequest) returns (google.longrunning.Operation) {
|
140
|
+
# option (google.longrunning.operation_info) = {
|
141
|
+
# response_type: "ExportResponse"
|
142
|
+
# metadata_type: "ExportMetadata"
|
143
|
+
# };
|
144
|
+
# }
|
140
145
|
# @!attribute [rw] response_type
|
141
146
|
# @return [::String]
|
142
147
|
# Required. The message name of the primary return type for this
|