Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMetrics

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

Overview

Evaluation metrics, either in aggregate or about a specific entity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3EvaluationMetrics

Returns a new instance of GoogleCloudDocumentaiV1beta3EvaluationMetrics.



8196
8197
8198
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8196

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

Instance Attribute Details

#f1_score ⇒ Float

The calculated f1 score. Corresponds to the JSON property f1Score

Returns:

  • (Float) 


8144
8145
8146
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8144

def f1_score
  @f1_score
end

#false_negatives_count ⇒ Fixnum

The amount of false negatives. Corresponds to the JSON property falseNegativesCount

Returns:

  • (Fixnum) 


8149
8150
8151
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8149

def false_negatives_count
  @false_negatives_count
end

#false_positives_count ⇒ Fixnum

The amount of false positives. Corresponds to the JSON property falsePositivesCount

Returns:

  • (Fixnum) 


8154
8155
8156
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8154

def false_positives_count
  @false_positives_count
end

#ground_truth_document_count ⇒ Fixnum

The amount of documents with a ground truth occurrence. Corresponds to the JSON property groundTruthDocumentCount

Returns:

  • (Fixnum) 


8159
8160
8161
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8159

def ground_truth_document_count
  @ground_truth_document_count
end

#ground_truth_occurrences_count ⇒ Fixnum

The amount of occurrences in ground truth documents. Corresponds to the JSON property groundTruthOccurrencesCount

Returns:

  • (Fixnum) 


8164
8165
8166
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8164

def ground_truth_occurrences_count
  @ground_truth_occurrences_count
end

#precision ⇒ Float

The calculated precision. Corresponds to the JSON property precision

Returns:

  • (Float) 


8169
8170
8171
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8169

def precision
  @precision
end

#predicted_document_count ⇒ Fixnum

The amount of documents with a predicted occurrence. Corresponds to the JSON property predictedDocumentCount

Returns:

  • (Fixnum) 


8174
8175
8176
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8174

def predicted_document_count
  @predicted_document_count
end

#predicted_occurrences_count ⇒ Fixnum

The amount of occurrences in predicted documents. Corresponds to the JSON property predictedOccurrencesCount

Returns:

  • (Fixnum) 


8179
8180
8181
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8179

def predicted_occurrences_count
  @predicted_occurrences_count
end

#recall ⇒ Float

The calculated recall. Corresponds to the JSON property recall

Returns:

  • (Float) 


8184
8185
8186
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8184

def recall
  @recall
end

#total_documents_count ⇒ Fixnum

The amount of documents that had an occurrence of this label. Corresponds to the JSON property totalDocumentsCount

Returns:

  • (Fixnum) 


8189
8190
8191
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8189

def total_documents_count
  @total_documents_count
end

#true_positives_count ⇒ Fixnum

The amount of true positives. Corresponds to the JSON property truePositivesCount

Returns:

  • (Fixnum) 


8194
8195
8196
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8194

def true_positives_count
  @true_positives_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8201

def update!(**args)
  @f1_score = args[:f1_score] if args.key?(:f1_score)
  @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
  @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
  @ground_truth_document_count = args[:ground_truth_document_count] if args.key?(:ground_truth_document_count)
  @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
  @precision = args[:precision] if args.key?(:precision)
  @predicted_document_count = args[:predicted_document_count] if args.key?(:predicted_document_count)
  @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
  @recall = args[:recall] if args.key?(:recall)
  @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
  @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
end