Skip to main content

evaluations

Creates, updates, deletes, gets or lists a evaluations resource.

Overview

Nameevaluations
TypeResource
Idgoogle.documentai.evaluations

Fields

NameDatatypeDescription
namestringThe resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}
allEntitiesMetricsobjectMetrics across multiple confidence levels.
createTimestringThe time that the evaluation was created.
documentCountersobjectEvaluation counters for the documents that were used.
entityMetricsobjectMetrics across confidence levels, for different entities.
kmsKeyNamestringThe KMS key name used for encryption.
kmsKeyVersionNamestringThe KMS key version with which data is encrypted.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_processors_processor_versions_evaluations_getSELECTevaluationsId, locationsId, processorVersionsId, processorsId, projectsIdRetrieves a specific evaluation.
projects_locations_processors_processor_versions_evaluations_listSELECTlocationsId, processorVersionsId, processorsId, projectsIdRetrieves a set of evaluations for a given processor version.

SELECT examples

Retrieves a set of evaluations for a given processor version.

SELECT
name,
allEntitiesMetrics,
createTime,
documentCounters,
entityMetrics,
kmsKeyName,
kmsKeyVersionName
FROM google.documentai.evaluations
WHERE locationsId = '{{ locationsId }}'
AND processorVersionsId = '{{ processorVersionsId }}'
AND processorsId = '{{ processorsId }}'
AND projectsId = '{{ projectsId }}';