Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb more...

Overview

Metrics across multiple confidence levels.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics

Returns a new instance of GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics.

[View source]

4235
4236
4237
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4235

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#auprc ⇒ Float

The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds. Corresponds to the JSON property auprc

Returns:

  • (Float) 

4201
4202
4203
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4201

def auprc
  @auprc
end

#auprc_exact ⇒ Float

The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only. Corresponds to the JSON property auprcExact

Returns:

  • (Float) 

4206
4207
4208
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4206

def auprc_exact
  @auprc_exact
end

#confidence_level_metrics ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics>

Metrics across confidence levels with fuzzy matching enabled. Corresponds to the JSON property confidenceLevelMetrics

Returns:


4211
4212
4213
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4211

def confidence_level_metrics
  @confidence_level_metrics
end

#confidence_level_metrics_exact ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics>

Metrics across confidence levels with only exact matching. Corresponds to the JSON property confidenceLevelMetricsExact

Returns:


4216
4217
4218
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4216

def confidence_level_metrics_exact
  @confidence_level_metrics_exact
end

#estimated_calibration_error ⇒ Float

The Estimated Calibration Error (ECE) of the confidence of the predicted entities. Corresponds to the JSON property estimatedCalibrationError

Returns:

  • (Float) 

4222
4223
4224
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4222

def estimated_calibration_error
  @estimated_calibration_error
end

#estimated_calibration_error_exact ⇒ Float

The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only. Corresponds to the JSON property estimatedCalibrationErrorExact

Returns:

  • (Float) 

4228
4229
4230
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4228

def estimated_calibration_error_exact
  @estimated_calibration_error_exact
end

#metrics_type ⇒ String

The metrics type for the label. Corresponds to the JSON property metricsType

Returns:

  • (String) 

4233
4234
4235
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4233

def metrics_type
  @metrics_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

4240
4241
4242
4243
4244
4245
4246
4247
4248
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4240

def update!(**args)
  @auprc = args[:auprc] if args.key?(:auprc)
  @auprc_exact = args[:auprc_exact] if args.key?(:auprc_exact)
  @confidence_level_metrics = args[:confidence_level_metrics] if args.key?(:confidence_level_metrics)
  @confidence_level_metrics_exact = args[:confidence_level_metrics_exact] if args.key?(:confidence_level_metrics_exact)
  @estimated_calibration_error = args[:estimated_calibration_error] if args.key?(:estimated_calibration_error)
  @estimated_calibration_error_exact = args[:estimated_calibration_error_exact] if args.key?(:estimated_calibration_error_exact)
  @metrics_type = args[:metrics_type] if args.key?(:metrics_type)
end