Resource: Processor
The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
JSON representation |
---|
{ "name": string, "type": string, "displayName": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. Immutable. The resource name of the processor. Format: |
type |
The processor type, such as: |
displayName |
The display name of the processor. |
state |
Output only. The state of the processor. |
defaultProcessorVersion |
The default processor version. |
processorVersionAliases[] |
Output only. The processor version aliases. |
processEndpoint |
Output only. Immutable. The http endpoint that can be called to invoke processing. |
createTime |
The time the processor was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
kmsKeyName |
The KMS key used for encryption and decryption in CMEK scenarios. |
satisfiesPzs |
Output only. Reserved for future use. |
satisfiesPzi |
Output only. Reserved for future use. |
State
The possible states of the processor.
Enums | |
---|---|
STATE_UNSPECIFIED |
The processor is in an unspecified state. |
ENABLED |
The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized. |
DISABLED |
The processor is disabled. |
ENABLING |
The processor is being enabled, will become ENABLED if successful. |
DISABLING |
The processor is being disabled, will become DISABLED if successful. |
CREATING |
The processor is being created, will become either ENABLED (for successful creation) or FAILED (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet. |
FAILED |
The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled. |
DELETING |
The processor is being deleted, will be removed if successful. |
ProcessorVersionAlias
Contains the alias and the aliased resource name of processor version.
JSON representation |
---|
{ "alias": string, "processorVersion": string } |
Fields | |
---|---|
alias |
The alias in the form of |
processorVersion |
The resource name of aliased processor version. |
Methods |
|
---|---|
|
LRO endpoint to batch process many documents. |
|
Creates a processor from the ProcessorType provided. |
|
Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. |
|
Disables a processor |
|
Enables a processor |
|
Gets a processor detail. |
|
Lists all processors which belong to this project. |
|
Processes a single document. |
|
Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments . |