Google Cloud Document Ai V1 Client - Class Evaluation (2.3.0)

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

An evaluation of a ProcessorVersion's performance.

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

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

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

↳ create_time
Google\Protobuf\Timestamp

The time that the evaluation was created.

↳ document_counters
Evaluation\Counters

Counters for the documents used in the evaluation.

↳ all_entities_metrics
Evaluation\MultiConfidenceMetrics

Metrics for all the entities in aggregate.

↳ entity_metrics
array| Google\Protobuf\Internal\MapField

Metrics across confidence levels, for different entities.

↳ kms_key_name
string

The KMS key name used for encryption.

↳ kms_key_version_name
string

The KMS key version with which data is encrypted.

getName

The resource name of the evaluation.

Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

Returns
Type
Description
string

setName

The resource name of the evaluation.

Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

The time that the evaluation was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

The time that the evaluation was created.

Parameter
Name
Description
Returns
Type
Description
$this

getDocumentCounters

Counters for the documents used in the evaluation.

Returns
Type
Description

hasDocumentCounters

clearDocumentCounters

setDocumentCounters

Counters for the documents used in the evaluation.

Parameter
Name
Description
Returns
Type
Description
$this

getAllEntitiesMetrics

Metrics for all the entities in aggregate.

Returns
Type
Description

hasAllEntitiesMetrics

clearAllEntitiesMetrics

setAllEntitiesMetrics

Metrics for all the entities in aggregate.

Parameter
Name
Description
Returns
Type
Description
$this

getEntityMetrics

Metrics across confidence levels, for different entities.

Returns
Type
Description

setEntityMetrics

Metrics across confidence levels, for different entities.

Parameter
Name
Description
Returns
Type
Description
$this

getKmsKeyName

The KMS key name used for encryption.

Returns
Type
Description
string

setKmsKeyName

The KMS key name used for encryption.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getKmsKeyVersionName

The KMS key version with which data is encrypted.

Returns
Type
Description
string

setKmsKeyVersionName

The KMS key version with which data is encrypted.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: