REST Resource: projects.locations.processorTypes

Resource: ProcessorType

A processor type is responsible for performing a certain document understanding task on a certain type of document.

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "type" 
 : 
 string 
 , 
 "category" 
 : 
 string 
 , 
 "availableLocations" 
 : 
 [ 
 { 
 object (  LocationInfo 
 
) 
 } 
 ] 
 , 
 "allowCreation" 
 : 
 boolean 
 , 
 "launchStage" 
 : 
 enum (  LaunchStage 
 
) 
 , 
 "sampleDocumentUris" 
 : 
 [ 
 string 
 ] 
 } 
Fields
name

string

The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}

type

string

The processor type, such as: OCR_PROCESSOR , INVOICE_PROCESSOR .

category

string

The processor category, used by UI to group processor types.

availableLocations[]

object ( LocationInfo )

The locations in which this processor is available.

allowCreation

boolean

Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.

launchStage

enum ( LaunchStage )

Launch stage of the processor type

sampleDocumentUris[]

string

A set of Cloud Storage URIs of sample documents for this processor.

LocationInfo

The location information about where the processor is available.

JSON representation
 { 
 "locationId" 
 : 
 string 
 } 
Fields
locationId

string

The location ID. For supported locations, refer to regional and multi-regional support .

Methods

get

Gets a processor type detail.

list

Lists the processor types that exist.
Create a Mobile Website
View Site in Mobile | Classic
Share by: