Get evaluation details for a processor version

Get evaluation details for a completed evaluation.

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

Python

For more information, see the Document AI Python API reference documentation .

To authenticate to Document AI, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  from 
  
 google.api_core.client_options 
  
 import 
 ClientOptions 
 from 
  
 google.cloud 
  
 import 
 documentai 
 # type: ignore 
 # TODO(developer): Uncomment these variables before running the sample. 
 # project_id = 'YOUR_PROJECT_ID' 
 # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu' 
 # processor_id = 'YOUR_PROCESSOR_ID' # Create processor before running sample 
 # processor_version_id = 'YOUR_PROCESSOR_VERSION_ID' 
 # evaluation_id = 'YOUR_EVALUATION_ID' 
 def 
  
 get_evaluation_sample 
 ( 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 processor_id 
 : 
 str 
 , 
 processor_version_id 
 : 
 str 
 , 
 evaluation_id 
 : 
 str 
 , 
 ) 
 - 
> None 
 : 
 # You must set the api_endpoint if you use a location other than 'us', e.g.: 
 opts 
 = 
 ClientOptions 
 ( 
 api_endpoint 
 = 
 f 
 " 
 { 
 location 
 } 
 -documentai.googleapis.com" 
 ) 
 client 
 = 
 documentai 
 . 
  DocumentProcessorServiceClient 
 
 ( 
 client_options 
 = 
 opts 
 ) 
 # The full resource name of the evaluation 
 # e.g. `projects/{project_id}/locations/{location}/processors/{processor_id}/processorVersions/{processor_version_id}` 
 evaluation_name 
 = 
 client 
 . 
  evaluation_path 
 
 ( 
 project_id 
 , 
 location 
 , 
 processor_id 
 , 
 processor_version_id 
 , 
 evaluation_id 
 ) 
 # Make GetEvaluation request 
 evaluation 
 = 
 client 
 . 
  get_evaluation 
 
 ( 
 name 
 = 
 evaluation_name 
 ) 
 create_time 
 = 
 evaluation 
 . 
 create_time 
 document_counters 
 = 
 evaluation 
 . 
 document_counters 
 # Print the Evaluation Information 
 # Refer to https://cloud.google.com/document-ai/docs/reference/rest/v1beta3/projects.locations.processors.processorVersions.evaluations 
 # for more information on the available evaluation data 
 print 
 ( 
 f 
 "Create Time: 
 { 
 create_time 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "Input Documents: 
 { 
 document_counters 
 . 
 input_documents_count 
 } 
 " 
 ) 
 print 
 ( 
 f 
 " 
 \t 
 Invalid Documents: 
 { 
 document_counters 
 . 
 invalid_documents_count 
 } 
 " 
 ) 
 print 
 ( 
 f 
 " 
 \t 
 Failed Documents: 
 { 
 document_counters 
 . 
 failed_documents_count 
 } 
 " 
 ) 
 print 
 ( 
 f 
 " 
 \t 
 Evaluated Documents: 
 { 
 document_counters 
 . 
 evaluated_documents_count 
 } 
 " 
 ) 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Design a Mobile Site
View Site in Mobile | Classic
Share by: