Class: Google::Cloud::Dialogflow::V2::SmartReplyMetrics

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/conversation_model.rb

Overview

The evaluation metrics for smart reply model.

Defined Under Namespace

Classes: TopNMetrics

Instance Attribute Summary collapse

Instance Attribute Details

#allowlist_coverage ⇒ ::Float

Returns Percentage of target participant messages in the evaluation dataset for which similar messages have appeared at least once in the allowlist. Should be [0, 1].

Returns:

  • (::Float) —

    Percentage of target participant messages in the evaluation dataset for which similar messages have appeared at least once in the allowlist. Should be [0, 1].



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 218

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

  # Evaluation metrics when retrieving `n` smart replies with the model.
  # @!attribute [rw] n
  #   @return [::Integer]
  #     Number of retrieved smart replies. For example, when `n` is 3, this
  #     evaluation contains metrics for when Dialogflow retrieves 3 smart replies
  #     with the model.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     Defined as `number of queries whose top n smart replies have at least one
  #     similar (token match similarity above the defined threshold) reply as the
  #     real reply` divided by `number of queries with at least one smart reply`.
  #     Value ranges from 0.0 to 1.0 inclusive.
  class TopNMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#conversation_count ⇒ ::Integer

Returns Total number of conversations used to generate this metric.

Returns:

  • (::Integer) —

    Total number of conversations used to generate this metric.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 218

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

  # Evaluation metrics when retrieving `n` smart replies with the model.
  # @!attribute [rw] n
  #   @return [::Integer]
  #     Number of retrieved smart replies. For example, when `n` is 3, this
  #     evaluation contains metrics for when Dialogflow retrieves 3 smart replies
  #     with the model.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     Defined as `number of queries whose top n smart replies have at least one
  #     similar (token match similarity above the defined threshold) reply as the
  #     real reply` divided by `number of queries with at least one smart reply`.
  #     Value ranges from 0.0 to 1.0 inclusive.
  class TopNMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#top_n_metrics ⇒ ::Array<::Google::Cloud::Dialogflow::V2::SmartReplyMetrics::TopNMetrics>

Returns Metrics of top n smart replies, sorted by [TopNMetric.n][].

Returns:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 218

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

  # Evaluation metrics when retrieving `n` smart replies with the model.
  # @!attribute [rw] n
  #   @return [::Integer]
  #     Number of retrieved smart replies. For example, when `n` is 3, this
  #     evaluation contains metrics for when Dialogflow retrieves 3 smart replies
  #     with the model.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     Defined as `number of queries whose top n smart replies have at least one
  #     similar (token match similarity above the defined threshold) reply as the
  #     real reply` divided by `number of queries with at least one smart reply`.
  #     Value ranges from 0.0 to 1.0 inclusive.
  class TopNMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end