Google Cloud Document Ai V1 Client - Class EvaluationReference (1.12.2)

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

Gives a short summary of an evaluation, and links to the evaluation itself.

Generated from protobuf message google.cloud.documentai.v1.EvaluationReference

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ operation string

The resource name of the Long Running Operation for the evaluation.

↳ evaluation string

The resource name of the evaluation.

↳ aggregate_metrics Google\Cloud\DocumentAI\V1\Evaluation\Metrics

An aggregate of the statistics for the evaluation with fuzzy matching on.

↳ aggregate_metrics_exact Google\Cloud\DocumentAI\V1\Evaluation\Metrics

An aggregate of the statistics for the evaluation with fuzzy matching off.

getOperation

The resource name of the Long Running Operation for the evaluation.

Returns
Type Description
string

setOperation

The resource name of the Long Running Operation for the evaluation.

Parameter
Name Description
var string
Returns
Type Description
$this

getEvaluation

The resource name of the evaluation.

Returns
Type Description
string

setEvaluation

The resource name of the evaluation.

Parameter
Name Description
var string
Returns
Type Description
$this

getAggregateMetrics

An aggregate of the statistics for the evaluation with fuzzy matching on.

Returns
Type Description
Google\Cloud\DocumentAI\V1\Evaluation\Metrics|null

hasAggregateMetrics

clearAggregateMetrics

setAggregateMetrics

An aggregate of the statistics for the evaluation with fuzzy matching on.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\Evaluation\Metrics
Returns
Type Description
$this

getAggregateMetricsExact

An aggregate of the statistics for the evaluation with fuzzy matching off.

Returns
Type Description
Google\Cloud\DocumentAI\V1\Evaluation\Metrics|null

hasAggregateMetricsExact

clearAggregateMetricsExact

setAggregateMetricsExact

An aggregate of the statistics for the evaluation with fuzzy matching off.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\Evaluation\Metrics
Returns
Type Description
$this