Class: Google::Cloud::ContactCenterInsights::V1::QaAnswer

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/contactcenterinsights/v1/resources.rb

Overview

An answer to a QaQuestion.

Defined Under Namespace

Classes: AnswerSource, AnswerValue

Instance Attribute Summary collapse

Instance Attribute Details

#answer_sources ⇒ ::Array<::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource>

Returns List of all individual answers given to the question.

Returns:



1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1993

class QaAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message for holding the value of a
  # {::Google::Cloud::ContactCenterInsights::V1::QaAnswer QaAnswer}.
  # {::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice QaQuestion.AnswerChoice}
  # defines the possible answer values for a question.
  # @!attribute [rw] str_value
  #   @return [::String]
  #     String value.
  #
  #     Note: The following fields are mutually exclusive: `str_value`, `num_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  #
  #     Note: The following fields are mutually exclusive: `num_value`, `str_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  #
  #     Note: The following fields are mutually exclusive: `bool_value`, `str_value`, `num_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  #
  #     Note: The following fields are mutually exclusive: `na_value`, `str_value`, `num_value`, `bool_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier. Matches the value used in
  #     QaQuestion.AnswerChoice.key.
  # @!attribute [r] score
  #   @return [::Float]
  #     Output only. Numerical score of the answer.
  # @!attribute [r] potential_score
  #   @return [::Float]
  #     Output only. The maximum potential score of the question.
  # @!attribute [r] normalized_score
  #   @return [::Float]
  #     Output only. Normalized score of the questions. Calculated as score /
  #     potential_score.
  class AnswerValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A question may have multiple answers from varying sources, one of which
  # becomes the "main" answer above. AnswerSource represents each individual
  # answer.
  # @!attribute [rw] source_type
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource::SourceType]
  #     What created the answer.
  # @!attribute [rw] answer_value
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
  #     The answer value from this source.
  class AnswerSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # What created the answer.
    module SourceType
      # Source type is unspecified.
      SOURCE_TYPE_UNSPECIFIED = 0

      # Answer was system-generated; created during an Insights analysis.
      SYSTEM_GENERATED = 1

      # Answer was created by a human via manual edit.
      MANUAL_EDIT = 2
    end
  end
end

#answer_value ⇒ ::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue

Returns The main answer value, incorporating any manual edits if they exist.

Returns:



1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1993

class QaAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message for holding the value of a
  # {::Google::Cloud::ContactCenterInsights::V1::QaAnswer QaAnswer}.
  # {::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice QaQuestion.AnswerChoice}
  # defines the possible answer values for a question.
  # @!attribute [rw] str_value
  #   @return [::String]
  #     String value.
  #
  #     Note: The following fields are mutually exclusive: `str_value`, `num_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  #
  #     Note: The following fields are mutually exclusive: `num_value`, `str_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  #
  #     Note: The following fields are mutually exclusive: `bool_value`, `str_value`, `num_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  #
  #     Note: The following fields are mutually exclusive: `na_value`, `str_value`, `num_value`, `bool_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier. Matches the value used in
  #     QaQuestion.AnswerChoice.key.
  # @!attribute [r] score
  #   @return [::Float]
  #     Output only. Numerical score of the answer.
  # @!attribute [r] potential_score
  #   @return [::Float]
  #     Output only. The maximum potential score of the question.
  # @!attribute [r] normalized_score
  #   @return [::Float]
  #     Output only. Normalized score of the questions. Calculated as score /
  #     potential_score.
  class AnswerValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A question may have multiple answers from varying sources, one of which
  # becomes the "main" answer above. AnswerSource represents each individual
  # answer.
  # @!attribute [rw] source_type
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource::SourceType]
  #     What created the answer.
  # @!attribute [rw] answer_value
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
  #     The answer value from this source.
  class AnswerSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # What created the answer.
    module SourceType
      # Source type is unspecified.
      SOURCE_TYPE_UNSPECIFIED = 0

      # Answer was system-generated; created during an Insights analysis.
      SYSTEM_GENERATED = 1

      # Answer was created by a human via manual edit.
      MANUAL_EDIT = 2
    end
  end
end

#conversation ⇒ ::String

Returns The conversation the answer applies to.

Returns:

  • (::String) —

    The conversation the answer applies to.



1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1993

class QaAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message for holding the value of a
  # {::Google::Cloud::ContactCenterInsights::V1::QaAnswer QaAnswer}.
  # {::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice QaQuestion.AnswerChoice}
  # defines the possible answer values for a question.
  # @!attribute [rw] str_value
  #   @return [::String]
  #     String value.
  #
  #     Note: The following fields are mutually exclusive: `str_value`, `num_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  #
  #     Note: The following fields are mutually exclusive: `num_value`, `str_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  #
  #     Note: The following fields are mutually exclusive: `bool_value`, `str_value`, `num_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  #
  #     Note: The following fields are mutually exclusive: `na_value`, `str_value`, `num_value`, `bool_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier. Matches the value used in
  #     QaQuestion.AnswerChoice.key.
  # @!attribute [r] score
  #   @return [::Float]
  #     Output only. Numerical score of the answer.
  # @!attribute [r] potential_score
  #   @return [::Float]
  #     Output only. The maximum potential score of the question.
  # @!attribute [r] normalized_score
  #   @return [::Float]
  #     Output only. Normalized score of the questions. Calculated as score /
  #     potential_score.
  class AnswerValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A question may have multiple answers from varying sources, one of which
  # becomes the "main" answer above. AnswerSource represents each individual
  # answer.
  # @!attribute [rw] source_type
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource::SourceType]
  #     What created the answer.
  # @!attribute [rw] answer_value
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
  #     The answer value from this source.
  class AnswerSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # What created the answer.
    module SourceType
      # Source type is unspecified.
      SOURCE_TYPE_UNSPECIFIED = 0

      # Answer was system-generated; created during an Insights analysis.
      SYSTEM_GENERATED = 1

      # Answer was created by a human via manual edit.
      MANUAL_EDIT = 2
    end
  end
end

#qa_question ⇒ ::String

Returns The QaQuestion answered by this answer.

Returns:

  • (::String) —

    The QaQuestion answered by this answer.



1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1993

class QaAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message for holding the value of a
  # {::Google::Cloud::ContactCenterInsights::V1::QaAnswer QaAnswer}.
  # {::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice QaQuestion.AnswerChoice}
  # defines the possible answer values for a question.
  # @!attribute [rw] str_value
  #   @return [::String]
  #     String value.
  #
  #     Note: The following fields are mutually exclusive: `str_value`, `num_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  #
  #     Note: The following fields are mutually exclusive: `num_value`, `str_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  #
  #     Note: The following fields are mutually exclusive: `bool_value`, `str_value`, `num_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  #
  #     Note: The following fields are mutually exclusive: `na_value`, `str_value`, `num_value`, `bool_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier. Matches the value used in
  #     QaQuestion.AnswerChoice.key.
  # @!attribute [r] score
  #   @return [::Float]
  #     Output only. Numerical score of the answer.
  # @!attribute [r] potential_score
  #   @return [::Float]
  #     Output only. The maximum potential score of the question.
  # @!attribute [r] normalized_score
  #   @return [::Float]
  #     Output only. Normalized score of the questions. Calculated as score /
  #     potential_score.
  class AnswerValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A question may have multiple answers from varying sources, one of which
  # becomes the "main" answer above. AnswerSource represents each individual
  # answer.
  # @!attribute [rw] source_type
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource::SourceType]
  #     What created the answer.
  # @!attribute [rw] answer_value
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
  #     The answer value from this source.
  class AnswerSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # What created the answer.
    module SourceType
      # Source type is unspecified.
      SOURCE_TYPE_UNSPECIFIED = 0

      # Answer was system-generated; created during an Insights analysis.
      SYSTEM_GENERATED = 1

      # Answer was created by a human via manual edit.
      MANUAL_EDIT = 2
    end
  end
end

#question_body ⇒ ::String

Returns Question text. E.g., "Did the agent greet the customer?".

Returns:

  • (::String) —

    Question text. E.g., "Did the agent greet the customer?"



1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1993

class QaAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message for holding the value of a
  # {::Google::Cloud::ContactCenterInsights::V1::QaAnswer QaAnswer}.
  # {::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice QaQuestion.AnswerChoice}
  # defines the possible answer values for a question.
  # @!attribute [rw] str_value
  #   @return [::String]
  #     String value.
  #
  #     Note: The following fields are mutually exclusive: `str_value`, `num_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  #
  #     Note: The following fields are mutually exclusive: `num_value`, `str_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  #
  #     Note: The following fields are mutually exclusive: `bool_value`, `str_value`, `num_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  #
  #     Note: The following fields are mutually exclusive: `na_value`, `str_value`, `num_value`, `bool_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier. Matches the value used in
  #     QaQuestion.AnswerChoice.key.
  # @!attribute [r] score
  #   @return [::Float]
  #     Output only. Numerical score of the answer.
  # @!attribute [r] potential_score
  #   @return [::Float]
  #     Output only. The maximum potential score of the question.
  # @!attribute [r] normalized_score
  #   @return [::Float]
  #     Output only. Normalized score of the questions. Calculated as score /
  #     potential_score.
  class AnswerValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A question may have multiple answers from varying sources, one of which
  # becomes the "main" answer above. AnswerSource represents each individual
  # answer.
  # @!attribute [rw] source_type
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource::SourceType]
  #     What created the answer.
  # @!attribute [rw] answer_value
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
  #     The answer value from this source.
  class AnswerSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # What created the answer.
    module SourceType
      # Source type is unspecified.
      SOURCE_TYPE_UNSPECIFIED = 0

      # Answer was system-generated; created during an Insights analysis.
      SYSTEM_GENERATED = 1

      # Answer was created by a human via manual edit.
      MANUAL_EDIT = 2
    end
  end
end

#tags ⇒ ::Array<::String>

Returns User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.

Returns:

  • (::Array<::String>) —

    User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.



1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1993

class QaAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message for holding the value of a
  # {::Google::Cloud::ContactCenterInsights::V1::QaAnswer QaAnswer}.
  # {::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice QaQuestion.AnswerChoice}
  # defines the possible answer values for a question.
  # @!attribute [rw] str_value
  #   @return [::String]
  #     String value.
  #
  #     Note: The following fields are mutually exclusive: `str_value`, `num_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  #
  #     Note: The following fields are mutually exclusive: `num_value`, `str_value`, `bool_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  #
  #     Note: The following fields are mutually exclusive: `bool_value`, `str_value`, `num_value`, `na_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  #
  #     Note: The following fields are mutually exclusive: `na_value`, `str_value`, `num_value`, `bool_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier. Matches the value used in
  #     QaQuestion.AnswerChoice.key.
  # @!attribute [r] score
  #   @return [::Float]
  #     Output only. Numerical score of the answer.
  # @!attribute [r] potential_score
  #   @return [::Float]
  #     Output only. The maximum potential score of the question.
  # @!attribute [r] normalized_score
  #   @return [::Float]
  #     Output only. Normalized score of the questions. Calculated as score /
  #     potential_score.
  class AnswerValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A question may have multiple answers from varying sources, one of which
  # becomes the "main" answer above. AnswerSource represents each individual
  # answer.
  # @!attribute [rw] source_type
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerSource::SourceType]
  #     What created the answer.
  # @!attribute [rw] answer_value
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QaAnswer::AnswerValue]
  #     The answer value from this source.
  class AnswerSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # What created the answer.
    module SourceType
      # Source type is unspecified.
      SOURCE_TYPE_UNSPECIFIED = 0

      # Answer was system-generated; created during an Insights analysis.
      SYSTEM_GENERATED = 1

      # Answer was created by a human via manual edit.
      MANUAL_EDIT = 2
    end
  end
end