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:



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1934

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.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  # @!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:



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1934

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.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  # @!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.



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1934

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.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  # @!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.



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1934

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.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  # @!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?"



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1934

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.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  # @!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.



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1934

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.
  # @!attribute [rw] num_value
  #   @return [::Float]
  #     Numerical value.
  # @!attribute [rw] bool_value
  #   @return [::Boolean]
  #     Boolean value.
  # @!attribute [rw] na_value
  #   @return [::Boolean]
  #     A value of "Not Applicable (N/A)". Should only ever be `true`.
  # @!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