Class: Google::Cloud::DocumentAI::V1beta3::Evaluation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/evaluation.rb

Overview

An evaluation of a ProcessorVersion's performance.

Defined Under Namespace

Classes: ConfidenceLevelMetrics, Counters, EntityMetricsEntry, Metrics, MultiConfidenceMetrics

Instance Attribute Summary collapse

Instance Attribute Details

#all_entities_metrics ⇒ ::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics

Returns Metrics for all the entities in aggregate.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 66

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

  # Evaluation counters for the documents that were used.
  # @!attribute [rw] input_documents_count
  #   @return [::Integer]
  #     How many documents were sent for evaluation.
  # @!attribute [rw] invalid_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as they didn't
  #     pass validation.
  # @!attribute [rw] failed_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as Document AI
  #     failed to process them.
  # @!attribute [rw] evaluated_documents_count
  #   @return [::Integer]
  #     How many documents were used in the evaluation.
  class Counters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluation metrics, either in aggregate or about a specific entity.
  # @!attribute [rw] precision
  #   @return [::Float]
  #     The calculated precision.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     The calculated recall.
  # @!attribute [rw] f1_score
  #   @return [::Float]
  #     The calculated f1 score.
  # @!attribute [rw] predicted_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in predicted documents.
  # @!attribute [rw] ground_truth_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in ground truth documents.
  # @!attribute [rw] predicted_document_count
  #   @return [::Integer]
  #     The amount of documents with a predicted occurrence.
  # @!attribute [rw] ground_truth_document_count
  #   @return [::Integer]
  #     The amount of documents with a ground truth occurrence.
  # @!attribute [rw] true_positives_count
  #   @return [::Integer]
  #     The amount of true positives.
  # @!attribute [rw] false_positives_count
  #   @return [::Integer]
  #     The amount of false positives.
  # @!attribute [rw] false_negatives_count
  #   @return [::Integer]
  #     The amount of false negatives.
  # @!attribute [rw] total_documents_count
  #   @return [::Integer]
  #     The amount of documents that had an occurrence of this label.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluations metrics, at a specific confidence level.
  # @!attribute [rw] confidence_level
  #   @return [::Float]
  #     The confidence level.
  # @!attribute [rw] metrics
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Metrics]
  #     The metrics at the specific confidence level.
  class ConfidenceLevelMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metrics across multiple confidence levels.
  # @!attribute [rw] confidence_level_metrics
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with fuzzy matching enabled.
  # @!attribute [rw] confidence_level_metrics_exact
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with only exact matching.
  # @!attribute [rw] auprc
  #   @return [::Float]
  #     The calculated area under the precision recall curve (AUPRC), computed by
  #     integrating over all confidence thresholds.
  # @!attribute [rw] estimated_calibration_error
  #   @return [::Float]
  #     The Estimated Calibration Error (ECE) of the confidence of the predicted
  #     entities.
  # @!attribute [rw] auprc_exact
  #   @return [::Float]
  #     The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
  #     only.
  # @!attribute [rw] estimated_calibration_error_exact
  #   @return [::Float]
  #     The ECE for the predicted entities with fuzzy matching disabled, i.e.,
  #     exact matching only.
  # @!attribute [rw] metrics_type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType]
  #     The metrics type for the label.
  class MultiConfidenceMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A type that determines how metrics should be interpreted.
    module MetricsType
      # The metrics type is unspecified. By default, metrics without a
      # particular specification are for leaf entity types (i.e., top-level
      # entity types without child types, or child types which are not
      # parent types themselves).
      METRICS_TYPE_UNSPECIFIED = 0

      # Indicates whether metrics for this particular label type represent an
      # aggregate of metrics for other types instead of being based on actual
      # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
      # entity types are an aggregate of metrics for their children.
      AGGREGATE = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
  class EntityMetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The time that the evaluation was created.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 66

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

  # Evaluation counters for the documents that were used.
  # @!attribute [rw] input_documents_count
  #   @return [::Integer]
  #     How many documents were sent for evaluation.
  # @!attribute [rw] invalid_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as they didn't
  #     pass validation.
  # @!attribute [rw] failed_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as Document AI
  #     failed to process them.
  # @!attribute [rw] evaluated_documents_count
  #   @return [::Integer]
  #     How many documents were used in the evaluation.
  class Counters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluation metrics, either in aggregate or about a specific entity.
  # @!attribute [rw] precision
  #   @return [::Float]
  #     The calculated precision.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     The calculated recall.
  # @!attribute [rw] f1_score
  #   @return [::Float]
  #     The calculated f1 score.
  # @!attribute [rw] predicted_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in predicted documents.
  # @!attribute [rw] ground_truth_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in ground truth documents.
  # @!attribute [rw] predicted_document_count
  #   @return [::Integer]
  #     The amount of documents with a predicted occurrence.
  # @!attribute [rw] ground_truth_document_count
  #   @return [::Integer]
  #     The amount of documents with a ground truth occurrence.
  # @!attribute [rw] true_positives_count
  #   @return [::Integer]
  #     The amount of true positives.
  # @!attribute [rw] false_positives_count
  #   @return [::Integer]
  #     The amount of false positives.
  # @!attribute [rw] false_negatives_count
  #   @return [::Integer]
  #     The amount of false negatives.
  # @!attribute [rw] total_documents_count
  #   @return [::Integer]
  #     The amount of documents that had an occurrence of this label.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluations metrics, at a specific confidence level.
  # @!attribute [rw] confidence_level
  #   @return [::Float]
  #     The confidence level.
  # @!attribute [rw] metrics
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Metrics]
  #     The metrics at the specific confidence level.
  class ConfidenceLevelMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metrics across multiple confidence levels.
  # @!attribute [rw] confidence_level_metrics
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with fuzzy matching enabled.
  # @!attribute [rw] confidence_level_metrics_exact
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with only exact matching.
  # @!attribute [rw] auprc
  #   @return [::Float]
  #     The calculated area under the precision recall curve (AUPRC), computed by
  #     integrating over all confidence thresholds.
  # @!attribute [rw] estimated_calibration_error
  #   @return [::Float]
  #     The Estimated Calibration Error (ECE) of the confidence of the predicted
  #     entities.
  # @!attribute [rw] auprc_exact
  #   @return [::Float]
  #     The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
  #     only.
  # @!attribute [rw] estimated_calibration_error_exact
  #   @return [::Float]
  #     The ECE for the predicted entities with fuzzy matching disabled, i.e.,
  #     exact matching only.
  # @!attribute [rw] metrics_type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType]
  #     The metrics type for the label.
  class MultiConfidenceMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A type that determines how metrics should be interpreted.
    module MetricsType
      # The metrics type is unspecified. By default, metrics without a
      # particular specification are for leaf entity types (i.e., top-level
      # entity types without child types, or child types which are not
      # parent types themselves).
      METRICS_TYPE_UNSPECIFIED = 0

      # Indicates whether metrics for this particular label type represent an
      # aggregate of metrics for other types instead of being based on actual
      # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
      # entity types are an aggregate of metrics for their children.
      AGGREGATE = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
  class EntityMetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#document_counters ⇒ ::Google::Cloud::DocumentAI::V1beta3::Evaluation::Counters

Returns Counters for the documents used in the evaluation.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 66

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

  # Evaluation counters for the documents that were used.
  # @!attribute [rw] input_documents_count
  #   @return [::Integer]
  #     How many documents were sent for evaluation.
  # @!attribute [rw] invalid_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as they didn't
  #     pass validation.
  # @!attribute [rw] failed_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as Document AI
  #     failed to process them.
  # @!attribute [rw] evaluated_documents_count
  #   @return [::Integer]
  #     How many documents were used in the evaluation.
  class Counters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluation metrics, either in aggregate or about a specific entity.
  # @!attribute [rw] precision
  #   @return [::Float]
  #     The calculated precision.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     The calculated recall.
  # @!attribute [rw] f1_score
  #   @return [::Float]
  #     The calculated f1 score.
  # @!attribute [rw] predicted_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in predicted documents.
  # @!attribute [rw] ground_truth_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in ground truth documents.
  # @!attribute [rw] predicted_document_count
  #   @return [::Integer]
  #     The amount of documents with a predicted occurrence.
  # @!attribute [rw] ground_truth_document_count
  #   @return [::Integer]
  #     The amount of documents with a ground truth occurrence.
  # @!attribute [rw] true_positives_count
  #   @return [::Integer]
  #     The amount of true positives.
  # @!attribute [rw] false_positives_count
  #   @return [::Integer]
  #     The amount of false positives.
  # @!attribute [rw] false_negatives_count
  #   @return [::Integer]
  #     The amount of false negatives.
  # @!attribute [rw] total_documents_count
  #   @return [::Integer]
  #     The amount of documents that had an occurrence of this label.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluations metrics, at a specific confidence level.
  # @!attribute [rw] confidence_level
  #   @return [::Float]
  #     The confidence level.
  # @!attribute [rw] metrics
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Metrics]
  #     The metrics at the specific confidence level.
  class ConfidenceLevelMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metrics across multiple confidence levels.
  # @!attribute [rw] confidence_level_metrics
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with fuzzy matching enabled.
  # @!attribute [rw] confidence_level_metrics_exact
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with only exact matching.
  # @!attribute [rw] auprc
  #   @return [::Float]
  #     The calculated area under the precision recall curve (AUPRC), computed by
  #     integrating over all confidence thresholds.
  # @!attribute [rw] estimated_calibration_error
  #   @return [::Float]
  #     The Estimated Calibration Error (ECE) of the confidence of the predicted
  #     entities.
  # @!attribute [rw] auprc_exact
  #   @return [::Float]
  #     The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
  #     only.
  # @!attribute [rw] estimated_calibration_error_exact
  #   @return [::Float]
  #     The ECE for the predicted entities with fuzzy matching disabled, i.e.,
  #     exact matching only.
  # @!attribute [rw] metrics_type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType]
  #     The metrics type for the label.
  class MultiConfidenceMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A type that determines how metrics should be interpreted.
    module MetricsType
      # The metrics type is unspecified. By default, metrics without a
      # particular specification are for leaf entity types (i.e., top-level
      # entity types without child types, or child types which are not
      # parent types themselves).
      METRICS_TYPE_UNSPECIFIED = 0

      # Indicates whether metrics for this particular label type represent an
      # aggregate of metrics for other types instead of being based on actual
      # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
      # entity types are an aggregate of metrics for their children.
      AGGREGATE = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
  class EntityMetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#entity_metrics ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics}

Returns Metrics across confidence levels, for different entities.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 66

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

  # Evaluation counters for the documents that were used.
  # @!attribute [rw] input_documents_count
  #   @return [::Integer]
  #     How many documents were sent for evaluation.
  # @!attribute [rw] invalid_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as they didn't
  #     pass validation.
  # @!attribute [rw] failed_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as Document AI
  #     failed to process them.
  # @!attribute [rw] evaluated_documents_count
  #   @return [::Integer]
  #     How many documents were used in the evaluation.
  class Counters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluation metrics, either in aggregate or about a specific entity.
  # @!attribute [rw] precision
  #   @return [::Float]
  #     The calculated precision.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     The calculated recall.
  # @!attribute [rw] f1_score
  #   @return [::Float]
  #     The calculated f1 score.
  # @!attribute [rw] predicted_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in predicted documents.
  # @!attribute [rw] ground_truth_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in ground truth documents.
  # @!attribute [rw] predicted_document_count
  #   @return [::Integer]
  #     The amount of documents with a predicted occurrence.
  # @!attribute [rw] ground_truth_document_count
  #   @return [::Integer]
  #     The amount of documents with a ground truth occurrence.
  # @!attribute [rw] true_positives_count
  #   @return [::Integer]
  #     The amount of true positives.
  # @!attribute [rw] false_positives_count
  #   @return [::Integer]
  #     The amount of false positives.
  # @!attribute [rw] false_negatives_count
  #   @return [::Integer]
  #     The amount of false negatives.
  # @!attribute [rw] total_documents_count
  #   @return [::Integer]
  #     The amount of documents that had an occurrence of this label.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluations metrics, at a specific confidence level.
  # @!attribute [rw] confidence_level
  #   @return [::Float]
  #     The confidence level.
  # @!attribute [rw] metrics
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Metrics]
  #     The metrics at the specific confidence level.
  class ConfidenceLevelMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metrics across multiple confidence levels.
  # @!attribute [rw] confidence_level_metrics
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with fuzzy matching enabled.
  # @!attribute [rw] confidence_level_metrics_exact
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with only exact matching.
  # @!attribute [rw] auprc
  #   @return [::Float]
  #     The calculated area under the precision recall curve (AUPRC), computed by
  #     integrating over all confidence thresholds.
  # @!attribute [rw] estimated_calibration_error
  #   @return [::Float]
  #     The Estimated Calibration Error (ECE) of the confidence of the predicted
  #     entities.
  # @!attribute [rw] auprc_exact
  #   @return [::Float]
  #     The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
  #     only.
  # @!attribute [rw] estimated_calibration_error_exact
  #   @return [::Float]
  #     The ECE for the predicted entities with fuzzy matching disabled, i.e.,
  #     exact matching only.
  # @!attribute [rw] metrics_type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType]
  #     The metrics type for the label.
  class MultiConfidenceMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A type that determines how metrics should be interpreted.
    module MetricsType
      # The metrics type is unspecified. By default, metrics without a
      # particular specification are for leaf entity types (i.e., top-level
      # entity types without child types, or child types which are not
      # parent types themselves).
      METRICS_TYPE_UNSPECIFIED = 0

      # Indicates whether metrics for this particular label type represent an
      # aggregate of metrics for other types instead of being based on actual
      # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
      # entity types are an aggregate of metrics for their children.
      AGGREGATE = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
  class EntityMetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kms_key_name ⇒ ::String

Returns The KMS key name used for encryption.

Returns:

  • (::String) —

    The KMS key name used for encryption.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 66

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

  # Evaluation counters for the documents that were used.
  # @!attribute [rw] input_documents_count
  #   @return [::Integer]
  #     How many documents were sent for evaluation.
  # @!attribute [rw] invalid_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as they didn't
  #     pass validation.
  # @!attribute [rw] failed_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as Document AI
  #     failed to process them.
  # @!attribute [rw] evaluated_documents_count
  #   @return [::Integer]
  #     How many documents were used in the evaluation.
  class Counters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluation metrics, either in aggregate or about a specific entity.
  # @!attribute [rw] precision
  #   @return [::Float]
  #     The calculated precision.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     The calculated recall.
  # @!attribute [rw] f1_score
  #   @return [::Float]
  #     The calculated f1 score.
  # @!attribute [rw] predicted_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in predicted documents.
  # @!attribute [rw] ground_truth_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in ground truth documents.
  # @!attribute [rw] predicted_document_count
  #   @return [::Integer]
  #     The amount of documents with a predicted occurrence.
  # @!attribute [rw] ground_truth_document_count
  #   @return [::Integer]
  #     The amount of documents with a ground truth occurrence.
  # @!attribute [rw] true_positives_count
  #   @return [::Integer]
  #     The amount of true positives.
  # @!attribute [rw] false_positives_count
  #   @return [::Integer]
  #     The amount of false positives.
  # @!attribute [rw] false_negatives_count
  #   @return [::Integer]
  #     The amount of false negatives.
  # @!attribute [rw] total_documents_count
  #   @return [::Integer]
  #     The amount of documents that had an occurrence of this label.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluations metrics, at a specific confidence level.
  # @!attribute [rw] confidence_level
  #   @return [::Float]
  #     The confidence level.
  # @!attribute [rw] metrics
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Metrics]
  #     The metrics at the specific confidence level.
  class ConfidenceLevelMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metrics across multiple confidence levels.
  # @!attribute [rw] confidence_level_metrics
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with fuzzy matching enabled.
  # @!attribute [rw] confidence_level_metrics_exact
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with only exact matching.
  # @!attribute [rw] auprc
  #   @return [::Float]
  #     The calculated area under the precision recall curve (AUPRC), computed by
  #     integrating over all confidence thresholds.
  # @!attribute [rw] estimated_calibration_error
  #   @return [::Float]
  #     The Estimated Calibration Error (ECE) of the confidence of the predicted
  #     entities.
  # @!attribute [rw] auprc_exact
  #   @return [::Float]
  #     The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
  #     only.
  # @!attribute [rw] estimated_calibration_error_exact
  #   @return [::Float]
  #     The ECE for the predicted entities with fuzzy matching disabled, i.e.,
  #     exact matching only.
  # @!attribute [rw] metrics_type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType]
  #     The metrics type for the label.
  class MultiConfidenceMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A type that determines how metrics should be interpreted.
    module MetricsType
      # The metrics type is unspecified. By default, metrics without a
      # particular specification are for leaf entity types (i.e., top-level
      # entity types without child types, or child types which are not
      # parent types themselves).
      METRICS_TYPE_UNSPECIFIED = 0

      # Indicates whether metrics for this particular label type represent an
      # aggregate of metrics for other types instead of being based on actual
      # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
      # entity types are an aggregate of metrics for their children.
      AGGREGATE = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
  class EntityMetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kms_key_version_name ⇒ ::String

Returns The KMS key version with which data is encrypted.

Returns:

  • (::String) —

    The KMS key version with which data is encrypted.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 66

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

  # Evaluation counters for the documents that were used.
  # @!attribute [rw] input_documents_count
  #   @return [::Integer]
  #     How many documents were sent for evaluation.
  # @!attribute [rw] invalid_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as they didn't
  #     pass validation.
  # @!attribute [rw] failed_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as Document AI
  #     failed to process them.
  # @!attribute [rw] evaluated_documents_count
  #   @return [::Integer]
  #     How many documents were used in the evaluation.
  class Counters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluation metrics, either in aggregate or about a specific entity.
  # @!attribute [rw] precision
  #   @return [::Float]
  #     The calculated precision.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     The calculated recall.
  # @!attribute [rw] f1_score
  #   @return [::Float]
  #     The calculated f1 score.
  # @!attribute [rw] predicted_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in predicted documents.
  # @!attribute [rw] ground_truth_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in ground truth documents.
  # @!attribute [rw] predicted_document_count
  #   @return [::Integer]
  #     The amount of documents with a predicted occurrence.
  # @!attribute [rw] ground_truth_document_count
  #   @return [::Integer]
  #     The amount of documents with a ground truth occurrence.
  # @!attribute [rw] true_positives_count
  #   @return [::Integer]
  #     The amount of true positives.
  # @!attribute [rw] false_positives_count
  #   @return [::Integer]
  #     The amount of false positives.
  # @!attribute [rw] false_negatives_count
  #   @return [::Integer]
  #     The amount of false negatives.
  # @!attribute [rw] total_documents_count
  #   @return [::Integer]
  #     The amount of documents that had an occurrence of this label.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluations metrics, at a specific confidence level.
  # @!attribute [rw] confidence_level
  #   @return [::Float]
  #     The confidence level.
  # @!attribute [rw] metrics
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Metrics]
  #     The metrics at the specific confidence level.
  class ConfidenceLevelMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metrics across multiple confidence levels.
  # @!attribute [rw] confidence_level_metrics
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with fuzzy matching enabled.
  # @!attribute [rw] confidence_level_metrics_exact
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with only exact matching.
  # @!attribute [rw] auprc
  #   @return [::Float]
  #     The calculated area under the precision recall curve (AUPRC), computed by
  #     integrating over all confidence thresholds.
  # @!attribute [rw] estimated_calibration_error
  #   @return [::Float]
  #     The Estimated Calibration Error (ECE) of the confidence of the predicted
  #     entities.
  # @!attribute [rw] auprc_exact
  #   @return [::Float]
  #     The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
  #     only.
  # @!attribute [rw] estimated_calibration_error_exact
  #   @return [::Float]
  #     The ECE for the predicted entities with fuzzy matching disabled, i.e.,
  #     exact matching only.
  # @!attribute [rw] metrics_type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType]
  #     The metrics type for the label.
  class MultiConfidenceMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A type that determines how metrics should be interpreted.
    module MetricsType
      # The metrics type is unspecified. By default, metrics without a
      # particular specification are for leaf entity types (i.e., top-level
      # entity types without child types, or child types which are not
      # parent types themselves).
      METRICS_TYPE_UNSPECIFIED = 0

      # Indicates whether metrics for this particular label type represent an
      # aggregate of metrics for other types instead of being based on actual
      # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
      # entity types are an aggregate of metrics for their children.
      AGGREGATE = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
  class EntityMetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}.

Returns:

  • (::String) —

    The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 66

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

  # Evaluation counters for the documents that were used.
  # @!attribute [rw] input_documents_count
  #   @return [::Integer]
  #     How many documents were sent for evaluation.
  # @!attribute [rw] invalid_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as they didn't
  #     pass validation.
  # @!attribute [rw] failed_documents_count
  #   @return [::Integer]
  #     How many documents were not included in the evaluation as Document AI
  #     failed to process them.
  # @!attribute [rw] evaluated_documents_count
  #   @return [::Integer]
  #     How many documents were used in the evaluation.
  class Counters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluation metrics, either in aggregate or about a specific entity.
  # @!attribute [rw] precision
  #   @return [::Float]
  #     The calculated precision.
  # @!attribute [rw] recall
  #   @return [::Float]
  #     The calculated recall.
  # @!attribute [rw] f1_score
  #   @return [::Float]
  #     The calculated f1 score.
  # @!attribute [rw] predicted_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in predicted documents.
  # @!attribute [rw] ground_truth_occurrences_count
  #   @return [::Integer]
  #     The amount of occurrences in ground truth documents.
  # @!attribute [rw] predicted_document_count
  #   @return [::Integer]
  #     The amount of documents with a predicted occurrence.
  # @!attribute [rw] ground_truth_document_count
  #   @return [::Integer]
  #     The amount of documents with a ground truth occurrence.
  # @!attribute [rw] true_positives_count
  #   @return [::Integer]
  #     The amount of true positives.
  # @!attribute [rw] false_positives_count
  #   @return [::Integer]
  #     The amount of false positives.
  # @!attribute [rw] false_negatives_count
  #   @return [::Integer]
  #     The amount of false negatives.
  # @!attribute [rw] total_documents_count
  #   @return [::Integer]
  #     The amount of documents that had an occurrence of this label.
  class Metrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Evaluations metrics, at a specific confidence level.
  # @!attribute [rw] confidence_level
  #   @return [::Float]
  #     The confidence level.
  # @!attribute [rw] metrics
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Metrics]
  #     The metrics at the specific confidence level.
  class ConfidenceLevelMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metrics across multiple confidence levels.
  # @!attribute [rw] confidence_level_metrics
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with fuzzy matching enabled.
  # @!attribute [rw] confidence_level_metrics_exact
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
  #     Metrics across confidence levels with only exact matching.
  # @!attribute [rw] auprc
  #   @return [::Float]
  #     The calculated area under the precision recall curve (AUPRC), computed by
  #     integrating over all confidence thresholds.
  # @!attribute [rw] estimated_calibration_error
  #   @return [::Float]
  #     The Estimated Calibration Error (ECE) of the confidence of the predicted
  #     entities.
  # @!attribute [rw] auprc_exact
  #   @return [::Float]
  #     The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
  #     only.
  # @!attribute [rw] estimated_calibration_error_exact
  #   @return [::Float]
  #     The ECE for the predicted entities with fuzzy matching disabled, i.e.,
  #     exact matching only.
  # @!attribute [rw] metrics_type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType]
  #     The metrics type for the label.
  class MultiConfidenceMetrics
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A type that determines how metrics should be interpreted.
    module MetricsType
      # The metrics type is unspecified. By default, metrics without a
      # particular specification are for leaf entity types (i.e., top-level
      # entity types without child types, or child types which are not
      # parent types themselves).
      METRICS_TYPE_UNSPECIFIED = 0

      # Indicates whether metrics for this particular label type represent an
      # aggregate of metrics for other types instead of being based on actual
      # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
      # entity types are an aggregate of metrics for their children.
      AGGREGATE = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
  class EntityMetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end