Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Evaluation::Metrics (v0.10.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Evaluation::Metrics.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#f1_score

def f1_score() -> ::Float
Returns
  • (::Float) — The calculated f1 score.

#f1_score=

def f1_score=(value) -> ::Float
Parameter
  • value (::Float) — The calculated f1 score.
Returns
  • (::Float) — The calculated f1 score.

#false_negatives_count

def false_negatives_count() -> ::Integer
Returns
  • (::Integer) — The amount of false negatives.

#false_negatives_count=

def false_negatives_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The amount of false negatives.
Returns
  • (::Integer) — The amount of false negatives.

#false_positives_count

def false_positives_count() -> ::Integer
Returns
  • (::Integer) — The amount of false positives.

#false_positives_count=

def false_positives_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The amount of false positives.
Returns
  • (::Integer) — The amount of false positives.

#ground_truth_document_count

def ground_truth_document_count() -> ::Integer
Returns
  • (::Integer) — The amount of documents with a ground truth occurrence.

#ground_truth_document_count=

def ground_truth_document_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The amount of documents with a ground truth occurrence.
Returns
  • (::Integer) — The amount of documents with a ground truth occurrence.

#ground_truth_occurrences_count

def ground_truth_occurrences_count() -> ::Integer
Returns
  • (::Integer) — The amount of occurrences in ground truth documents.

#ground_truth_occurrences_count=

def ground_truth_occurrences_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The amount of occurrences in ground truth documents.
Returns
  • (::Integer) — The amount of occurrences in ground truth documents.

#precision

def precision() -> ::Float
Returns
  • (::Float) — The calculated precision.

#precision=

def precision=(value) -> ::Float
Parameter
  • value (::Float) — The calculated precision.
Returns
  • (::Float) — The calculated precision.

#predicted_document_count

def predicted_document_count() -> ::Integer
Returns
  • (::Integer) — The amount of documents with a predicted occurrence.

#predicted_document_count=

def predicted_document_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The amount of documents with a predicted occurrence.
Returns
  • (::Integer) — The amount of documents with a predicted occurrence.

#predicted_occurrences_count

def predicted_occurrences_count() -> ::Integer
Returns
  • (::Integer) — The amount of occurrences in predicted documents.

#predicted_occurrences_count=

def predicted_occurrences_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The amount of occurrences in predicted documents.
Returns
  • (::Integer) — The amount of occurrences in predicted documents.

#recall

def recall() -> ::Float
Returns
  • (::Float) — The calculated recall.

#recall=

def recall=(value) -> ::Float
Parameter
  • value (::Float) — The calculated recall.
Returns
  • (::Float) — The calculated recall.

#total_documents_count

def total_documents_count() -> ::Integer
Returns
  • (::Integer) — The amount of documents that had an occurrence of this label.

#total_documents_count=

def total_documents_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The amount of documents that had an occurrence of this label.
Returns
  • (::Integer) — The amount of documents that had an occurrence of this label.

#true_positives_count

def true_positives_count() -> ::Integer
Returns
  • (::Integer) — The amount of true positives.

#true_positives_count=

def true_positives_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The amount of true positives.
Returns
  • (::Integer) — The amount of true positives.