Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1EvaluationMetrics

Returns a new instance of GoogleCloudDocumentaiV1EvaluationMetrics.



6527
6528
6529
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6527

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

Instance Attribute Details

#f1_score ⇒ Float

The calculated F1 score. Corresponds to the JSON property f1Score

Returns:

  • (Float) 


6475
6476
6477
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6475

def f1_score
  @f1_score
end

#false_negatives_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


6480
6481
6482
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6480

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) 


6485
6486
6487
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6485

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) 


6490
6491
6492
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6490

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) 


6495
6496
6497
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6495

def ground_truth_occurrences_count
  @ground_truth_occurrences_count
end

#precision ⇒ Float

The calculated precision. Corresponds to the JSON property precision

Returns:

  • (Float) 


6500
6501
6502
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6500

def precision
  @precision
end

#predicted_document_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


6505
6506
6507
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6505

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) 


6510
6511
6512
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6510

def predicted_occurrences_count
  @predicted_occurrences_count
end

#recall ⇒ Float

The calculated recall. Corresponds to the JSON property recall

Returns:

  • (Float) 


6515
6516
6517
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6515

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) 


6520
6521
6522
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6520

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) 


6525
6526
6527
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6525

def true_positives_count
  @true_positives_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6532

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