Class: Google::Cloud::ContactCenterInsights::V1::QaQuestion

Inherits:

Object

Object
Google::Cloud::ContactCenterInsights::V1::QaQuestion

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/contactcenterinsights/v1/resources.rb

Overview

A single question to be scored by the Insights QA feature.

Defined Under Namespace

Classes: AnswerChoice, Metrics, TuningMetadata

Instance Attribute Summary collapse

#abbreviation ⇒ ::String
Short, descriptive string, used in the UI where it's not practical to display the full question body.
#answer_choices ⇒ ::Array<::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice>
A list of valid answers to the question, which the LLM must choose from.
#answer_instructions ⇒ ::String
Instructions describing how to determine the answer.
#create_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#metrics ⇒ ::Google::Cloud::ContactCenterInsights::V1::QaQuestion::Metrics
Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question.
#name ⇒ ::String
Identifier.
#order ⇒ ::Integer
Defines the order of the question within its parent scorecard revision.
#question_body ⇒ ::String
Question text.
#tags ⇒ ::Array<::String>
User-defined list of arbitrary tags for the question.
#tuning_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::QaQuestion::TuningMetadata
Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
#update_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.

Instance Attribute Details

#abbreviation ⇒ `::String`

Returns Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".

Returns:

(::String) —
Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#answer_choices ⇒ `::Array<::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice>`

Returns A list of valid answers to the question, which the LLM must choose from.

Returns:

(::Array<::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice>) —
A list of valid answers to the question, which the LLM must choose from.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#answer_instructions ⇒ `::String`

Returns Instructions describing how to determine the answer.

Returns:

(::String) —
Instructions describing how to determine the answer.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. The time at which this question was created.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The time at which this question was created.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metrics ⇒ `::Google::Cloud::ContactCenterInsights::V1::QaQuestion::Metrics`

Returns Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.

Returns:

(::Google::Cloud::ContactCenterInsights::V1::QaQuestion::Metrics) —
Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ `::String`

Returns Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}.

Returns:

(::String) —
Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order ⇒ `::Integer`

Returns Defines the order of the question within its parent scorecard revision.

Returns:

(::Integer) —
Defines the order of the question within its parent scorecard revision.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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?"

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tags ⇒ `::Array<::String>`

Returns User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.

Returns:

(::Array<::String>) —
User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tuning_metadata ⇒ `::Google::Cloud::ContactCenterInsights::V1::QaQuestion::TuningMetadata`

Returns Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.

Returns:

(::Google::Cloud::ContactCenterInsights::V1::QaQuestion::TuningMetadata) —
Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. The most recent time at which the question was updated.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The most recent time at which the question was updated.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1773

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

  # Message representing a possible answer to the 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)". If provided, this field may only
  #     be set to `true`. If a question receives this answer, it will be
  #     excluded from any score calculations.
  # @!attribute [rw] key
  #   @return [::String]
  #     A short string used as an identifier.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Numerical score of the answer, used for generating the overall score of
  #     a QaScorecardResult. If the answer uses na_value, this field is unused.
  class AnswerChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A wrapper representing metrics calculated against a test-set on a LLM that
  # was fine tuned for this question.
  # @!attribute [r] accuracy
  #   @return [::Float]
  #     Output only. Accuracy of the model. Measures the percentage of correct
  #     answers the model gave on the test set.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the tuning operation for the question. Will only be set if a
  # scorecard containing this question has been tuned.
  # @!attribute [rw] total_valid_label_count
  #   @return [::Integer]
  #     Total number of valid labels provided for the question at the time of
  #     tuining.
  # @!attribute [rw] dataset_validation_warnings
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::DatasetValidationWarning>]
  #     A list of any applicable data validation warnings about the question's
  #     feedback labels.
  # @!attribute [rw] tuning_error
  #   @return [::String]
  #     Error status of the tuning operation for the question. Will only be set
  #     if the tuning operation failed.
  class TuningMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

Class: Google::Cloud::ContactCenterInsights::V1::QaQuestion

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#abbreviation ⇒ ::String

#answer_choices ⇒ ::Array<::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice>

#answer_instructions ⇒ ::String

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#metrics ⇒ ::Google::Cloud::ContactCenterInsights::V1::QaQuestion::Metrics

#name ⇒ ::String

#order ⇒ ::Integer

#question_body ⇒ ::String

#tags ⇒ ::Array<::String>

#tuning_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::QaQuestion::TuningMetadata

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#abbreviation ⇒ `::String`

#answer_choices ⇒ `::Array<::Google::Cloud::ContactCenterInsights::V1::QaQuestion::AnswerChoice>`

#answer_instructions ⇒ `::String`

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#metrics ⇒ `::Google::Cloud::ContactCenterInsights::V1::QaQuestion::Metrics`

#name ⇒ `::String`

#order ⇒ `::Integer`

#question_body ⇒ `::String`

#tags ⇒ `::Array<::String>`

#tuning_metadata ⇒ `::Google::Cloud::ContactCenterInsights::V1::QaQuestion::TuningMetadata`

#update_time ⇒ `::Google::Protobuf::Timestamp` (readonly)