REST Resource: projects.locations.processors.processorVersions.evaluations

Stay organized with collections Save and categorize content based on your preferences.

Resource: Evaluation

An evaluation of a ProcessorVersion's performance.

JSON representation
{
  "name": string,
  "createTime": string,
  "documentCounters": {
    object (Counters)
  },
  "allEntitiesMetrics": {
    object (MultiConfidenceMetrics)
  },
  "entityMetrics": {
    string: {
      object (MultiConfidenceMetrics)
    },
    ...
  },
  "kmsKeyName": string,
  "kmsKeyVersionName": string
}
Fields
name

string

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

createTime

string (Timestamp format)

The time that the evaluation was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

documentCounters

object (Counters)

Counters for the documents used in the evaluation.

allEntitiesMetrics

object (MultiConfidenceMetrics)

Metrics for all the entities in aggregate.

entityMetrics

map (key: string, value: object (MultiConfidenceMetrics))

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.

Counters

Evaluation counters for the documents that were used.

JSON representation
{
  "inputDocumentsCount": integer,
  "invalidDocumentsCount": integer,
  "failedDocumentsCount": integer,
  "evaluatedDocumentsCount": integer
}
Fields
inputDocumentsCount

integer

How many documents were sent for evaluation.

invalidDocumentsCount

integer

How many documents were not included in the evaluation as they didn't pass validation.

failedDocumentsCount

integer

How many documents were not included in the evaluation as Document AI failed to process them.

evaluatedDocumentsCount

integer

How many documents were used in the evaluation.

Methods

get

Retrieves a specific evaluation.

list

Retrieves a set of evaluations for a given processor version.