Method: processorVersions.evaluateProcessorVersion

Full name: projects.locations.processors.processorVersions.evaluateProcessorVersion

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

HTTP request

POST https://{endpoint}/v1/{processorVersion}:evaluateProcessorVersion

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters
processorVersion

string

Required. The resource name of the ProcessorVersion to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} It takes the form projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorversion}.

Authorization requires the following IAM permission on the specified resource processorVersion:

  • documentai.evaluations.create

Request body

The request body contains data with the following structure:

JSON representation 
{
  "evaluationDocuments": {
    object (BatchDocumentsInputConfig)
  }
}
Fields
evaluationDocuments

object (BatchDocumentsInputConfig)

Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the processorVersion resource:

  • documentai.evaluations.create

For more information, see the IAM documentation.