Google Cloud Document Ai V1 Client - Class MultiConfidenceMetrics (1.6.0)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class MultiConfidenceMetrics.

Metrics across multiple confidence levels.

Generated from protobuf message google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics

Namespace

Google \ Cloud \ DocumentAI \ V1 \ Evaluation

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ confidence_level_metrics array<Google\Cloud\DocumentAI\V1\Evaluation\ConfidenceLevelMetrics>

Metrics across confidence levels with fuzzy matching enabled.

↳ confidence_level_metrics_exact array<Google\Cloud\DocumentAI\V1\Evaluation\ConfidenceLevelMetrics>

Metrics across confidence levels with only exact matching.

↳ auprc float

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

↳ estimated_calibration_error float

The Estimated Calibration Error (ECE) of the confidence of the predicted entities.

↳ auprc_exact float

The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.

↳ estimated_calibration_error_exact float

The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.

↳ metrics_type int

The metrics type for the label.

getConfidenceLevelMetrics

Metrics across confidence levels with fuzzy matching enabled.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setConfidenceLevelMetrics

Metrics across confidence levels with fuzzy matching enabled.

Parameter
NameDescription
var array<Google\Cloud\DocumentAI\V1\Evaluation\ConfidenceLevelMetrics>
Returns
TypeDescription
$this

getConfidenceLevelMetricsExact

Metrics across confidence levels with only exact matching.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setConfidenceLevelMetricsExact

Metrics across confidence levels with only exact matching.

Parameter
NameDescription
var array<Google\Cloud\DocumentAI\V1\Evaluation\ConfidenceLevelMetrics>
Returns
TypeDescription
$this

getAuprc

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

Returns
TypeDescription
float

setAuprc

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

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getEstimatedCalibrationError

The Estimated Calibration Error (ECE) of the confidence of the predicted entities.

Returns
TypeDescription
float

setEstimatedCalibrationError

The Estimated Calibration Error (ECE) of the confidence of the predicted entities.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getAuprcExact

The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.

Returns
TypeDescription
float

setAuprcExact

The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getEstimatedCalibrationErrorExact

The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.

Returns
TypeDescription
float

setEstimatedCalibrationErrorExact

The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getMetricsType

The metrics type for the label.

Returns
TypeDescription
int

setMetricsType

The metrics type for the label.

Parameter
NameDescription
var int
Returns
TypeDescription
$this