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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\DocumentAI\V1\Evaluation\Counters

Counters for the documents used in the evaluation.

↳ all_entities_metrics Google\Cloud\DocumentAI\V1\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
TypeDescription
string

setName

The resource name of the evaluation.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

The time that the evaluation was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time that the evaluation was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDocumentCounters

Counters for the documents used in the evaluation.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\Evaluation\Counters|null

hasDocumentCounters

clearDocumentCounters

setDocumentCounters

Counters for the documents used in the evaluation.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\Evaluation\Counters
Returns
TypeDescription
$this

getAllEntitiesMetrics

Metrics for all the entities in aggregate.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\Evaluation\MultiConfidenceMetrics|null

hasAllEntitiesMetrics

clearAllEntitiesMetrics

setAllEntitiesMetrics

Metrics for all the entities in aggregate.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\Evaluation\MultiConfidenceMetrics
Returns
TypeDescription
$this

getEntityMetrics

Metrics across confidence levels, for different entities.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setEntityMetrics

Metrics across confidence levels, for different entities.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getKmsKeyName

The KMS key name used for encryption.

Returns
TypeDescription
string

setKmsKeyName

The KMS key name used for encryption.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKmsKeyVersionName

The KMS key version with which data is encrypted.

Returns
TypeDescription
string

setKmsKeyVersionName

The KMS key version with which data is encrypted.

Parameter
NameDescription
var string
Returns
TypeDescription
$this