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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The resource name of the evaluation. Format: |
↳ 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 | |
|---|---|
| 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 |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
The time that the evaluation was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDocumentCounters
Counters for the documents used in the evaluation.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\Evaluation\Counters|null | |
hasDocumentCounters
clearDocumentCounters
setDocumentCounters
Counters for the documents used in the evaluation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\Evaluation\Counters
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllEntitiesMetrics
Metrics for all the entities in aggregate.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\Evaluation\MultiConfidenceMetrics|null | |
hasAllEntitiesMetrics
clearAllEntitiesMetrics
setAllEntitiesMetrics
Metrics for all the entities in aggregate.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\Evaluation\MultiConfidenceMetrics
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntityMetrics
Metrics across confidence levels, for different entities.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setEntityMetrics
Metrics across confidence levels, for different entities.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| 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 | |