Class: Google::Cloud::Dialogflow::CX::V3::Experiment::Result

Inherits:

Object

Object
Google::Cloud::Dialogflow::CX::V3::Experiment::Result

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb

Overview

The inference result which includes an objective metric to optimize and the confidence interval.

Defined Under Namespace

Modules: CountType, MetricType Classes: ConfidenceInterval, Metric, VersionMetrics

Instance Attribute Summary collapse

#last_update_time ⇒ ::Google::Protobuf::Timestamp
The last time the experiment's stats data was updated.
#version_metrics ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>
Version variants and metrics.

Instance Attribute Details

#last_update_time ⇒ `::Google::Protobuf::Timestamp`

Returns The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

Returns:

(::Google::Protobuf::Timestamp) —
The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 112

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

  # A confidence interval is a range of possible values for the experiment
  # objective you are trying to measure.
  # @!attribute [rw] confidence_level
  #   @return [::Float]
  #     The confidence level used to construct the interval, i.e. there is X%
  #     chance that the true value is within this interval.
  # @!attribute [rw] ratio
  #   @return [::Float]
  #     The percent change between an experiment metric's value and the value
  #     for its control.
  # @!attribute [rw] lower_bound
  #   @return [::Float]
  #     Lower bound of the interval.
  # @!attribute [rw] upper_bound
  #   @return [::Float]
  #     Upper bound of the interval.
  class ConfidenceInterval
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metric and corresponding confidence intervals.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
  #     Ratio-based metric type. Only one of type or count_type is specified in
  #     each Metric.
  # @!attribute [rw] count_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
  #     Count-based metric type. Only one of type or count_type is specified in
  #     each Metric.
  # @!attribute [rw] ratio
  #   @return [::Float]
  #     Ratio value of a metric.
  # @!attribute [rw] count
  #   @return [::Float]
  #     Count value of a metric.
  # @!attribute [rw] confidence_interval
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
  #     The probability that the treatment is better than all other treatments
  #     in the experiment
  class Metric
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Version variant and associated metrics.
  # @!attribute [rw] version
  #   @return [::String]
  #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
  # @!attribute [rw] metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
  #     The metrics and corresponding confidence intervals in the inference
  #     result.
  # @!attribute [rw] session_count
  #   @return [::Integer]
  #     Number of sessions that were allocated to this version.
  class VersionMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Types of ratio-based metric for Dialogflow experiment.
  module MetricType
    # Metric unspecified.
    METRIC_UNSPECIFIED = 0

    # Percentage of contained sessions without user calling back in 24 hours.
    CONTAINED_SESSION_NO_CALLBACK_RATE = 1

    # Percentage of sessions that were handed to a human agent.
    LIVE_AGENT_HANDOFF_RATE = 2

    # Percentage of sessions with the same user calling back.
    CALLBACK_SESSION_RATE = 3

    # Percentage of sessions where user hung up.
    ABANDONED_SESSION_RATE = 4

    # Percentage of sessions reached Dialogflow 'END_PAGE' or
    # 'END_SESSION'.
    SESSION_END_RATE = 5
  end

  # Types of count-based metric for Dialogflow experiment.
  module CountType
    # Count type unspecified.
    COUNT_TYPE_UNSPECIFIED = 0

    # Total number of occurrences of a 'NO_MATCH'.
    TOTAL_NO_MATCH_COUNT = 1

    # Total number of turn counts.
    TOTAL_TURN_COUNT = 2

    # Average turn count in a session.
    AVERAGE_TURN_COUNT = 3
  end
end

#version_metrics ⇒ `::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>`

Returns Version variants and metrics.