REST Resource: projects.locations.processors

Resource: Processor

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

JSON representation

JSON representation
{ "name" : string , "type" : string , "displayName" : string , "state" : enum ( `State` ) , "defaultProcessorVersion" : string , "processorVersionAliases" : [ { object ( `ProcessorVersionAlias` ) } ] , "processEndpoint" : string , "createTime" : string , "kmsKeyName" : string , "satisfiesPzs" : boolean , "satisfiesPzi" : boolean , "activeSchemaVersion" : string }

 { 
 "name" 
 : 
 string 
 , 
 "type" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "state" 
 : 
 enum ( State 
) 
 , 
 "defaultProcessorVersion" 
 : 
 string 
 , 
 "processorVersionAliases" 
 : 
 [ 
 { 
 object (  ProcessorVersionAlias 
 
) 
 } 
 ] 
 , 
 "processEndpoint" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "kmsKeyName" 
 : 
 string 
 , 
 "satisfiesPzs" 
 : 
 boolean 
 , 
 "satisfiesPzi" 
 : 
 boolean 
 , 
 "activeSchemaVersion" 
 : 
 string 
 }

Fields
`name`	`string` Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`
`type`	`string` The processor type, such as: `OCR_PROCESSOR` , `INVOICE_PROCESSOR` . To get a list of processor types, see `FetchProcessorTypes` .
`displayName`	`string` The display name of the processor.
`state`	`enum ( State )` Output only. The state of the processor.
`defaultProcessorVersion`	`string` The default processor version.
`processorVersionAliases[]`	`object ( ProcessorVersionAlias )` Output only. The processor version aliases.
`processEndpoint`	`string` Output only. Immutable. The http endpoint that can be called to invoke processing.
`createTime`	`string ( Timestamp format)` Output only. The time the processor was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"` , `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"` .
`kmsKeyName`	`string` The KMS key used for encryption and decryption in CMEK scenarios.
`satisfiesPzs`	`boolean` Output only. Reserved for future use.
`satisfiesPzi`	`boolean` Output only. Reserved for future use.
`activeSchemaVersion`	`string` Optional. SchemaVersion used by the Processor. It is the same as Processor's `DatasetSchema.schema_version` Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schemaVersion}

Methods
`batchProcess`	LRO endpoint to batch process many documents.
`create`	Creates a processor from the `ProcessorType` provided.
`delete`	Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
`disable`	Disables a processor
`enable`	Enables a processor
`get`	Gets a processor detail.
`list`	Lists all processors which belong to this project.
`process`	Processes a single document.
`setDefaultProcessorVersion`	Set the default (active) version of a `Processor` that will be used in `ProcessDocument` and `BatchProcessDocuments` .
`updateDataset`	Updates metadata associated with a dataset.

REST Resource: projects.locations.processors

Resource: Processor

Methods

`batchProcess`

`create`

`delete`

`disable`

`enable`

`get`

`list`

`process`

`setDefaultProcessorVersion`

`updateDataset`

REST Resource: projects.locations.processors Stay organized with collections Save and categorize content based on your preferences.

Resource: Processor

Methods

REST Resource: projects.locations.processors