View details about a processor

Gets details about an existing Processor

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' 
 def 
  
 get_processor_sample 
 ( 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 processor_id 
 : 
 str 
 ) 
 - 
> None 
 : 
 # You must set the api_endpoint if you use a location other than 'us'. 
 opts 
 = 
 ClientOptions 
 ( 
 api_endpoint 
 = 
 f 
 " 
 { 
 location 
 } 
 -documentai.googleapis.com" 
 ) 
 client 
 = 
 documentai 
 . 
  DocumentProcessorServiceClient 
 
 ( 
 client_options 
 = 
 opts 
 ) 
 # The full resource name of the processor, e.g.: 
 # projects/{project_id}/locations/{location}/processors/{processor_id} 
 name 
 = 
 client 
 . 
  processor_path 
 
 ( 
 project_id 
 , 
 location 
 , 
 processor_id 
 ) 
 # Make GetProcessor request 
 processor 
 = 
 client 
 . 
  get_processor 
 
 ( 
 name 
 = 
 name 
 ) 
 # Print the processor information 
 print 
 ( 
 f 
 "Processor Name: 
 { 
 processor 
 . 
 name 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "Processor Display Name: 
 { 
 processor 
 . 
 display_name 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "Processor Type: 
 { 
 processor 
 . 
 type_ 
 } 
 " 
 ) 
 

What's next

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

Create a Mobile Website
View Site in Mobile | Classic
Share by: