evaluations

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

Overview

Name	evaluations
Type	Resource
Id	google.documentai.evaluations

Fields

The following fields are returned by SELECT queries:

projects_locations_processors_processor_versions_evaluations_get

Successful response

Name	Datatype	Description
name	string	The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}
allEntitiesMetrics	object	Metrics for all the entities in aggregate. (id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics)
createTime	string (google-datetime)	The time that the evaluation was created.
documentCounters	object	Counters for the documents used in the evaluation. (id: GoogleCloudDocumentaiV1EvaluationCounters)
entityMetrics	object	Metrics across confidence levels, for different entities.
kmsKeyName	string	The KMS key name used for encryption.
kmsKeyVersionName	string	The KMS key version with which data is encrypted.

projects_locations_processors_processor_versions_evaluations_list

Successful response

Name	Datatype	Description
name	string	The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}
allEntitiesMetrics	object	Metrics for all the entities in aggregate. (id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics)
createTime	string (google-datetime)	The time that the evaluation was created.
documentCounters	object	Counters for the documents used in the evaluation. (id: GoogleCloudDocumentaiV1EvaluationCounters)
entityMetrics	object	Metrics across confidence levels, for different entities.
kmsKeyName	string	The KMS key name used for encryption.
kmsKeyVersionName	string	The KMS key version with which data is encrypted.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_processors_processor_versions_evaluations_get	select	projectsId, locationsId, processorsId, processorVersionsId, evaluationsId		Retrieves a specific evaluation.
projects_locations_processors_processor_versions_evaluations_list	select	projectsId, locationsId, processorsId, processorVersionsId	pageSize, pageToken	Retrieves a set of evaluations for a given processor version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
evaluationsId	string
locationsId	string
processorVersionsId	string
processorsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_processors_processor_versions_evaluations_get

Retrieves a specific evaluation.

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

projects_locations_processors_processor_versions_evaluations_list

Retrieves a set of evaluations for a given processor version.

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