Class Processor (2.22.0) 

Processor(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

NameDescription
name str
Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
type_ str
The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.
display_name str
The display name of the processor.
state google.cloud.documentai_v1.types.Processor.State
Output only. The state of the processor.
default_processor_version str
The default processor version.
processor_version_aliases MutableSequence[google.cloud.documentai_v1.types.ProcessorVersionAlias]
Output only. The processor version aliases.
process_endpoint str
Output only. Immutable. The http endpoint that can be called to invoke processing.
create_time google.protobuf.timestamp_pb2.Timestamp
The time the processor was created.
kms_key_name str
The `KMS key

Classes

State

State(value)

The possible states of the processor.

Values: STATE_UNSPECIFIED (0): The processor is in an unspecified state. ENABLED (1): 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 (2): The processor is disabled. ENABLING (3): The processor is being enabled, will become ENABLED if successful. DISABLING (4): The processor is being disabled, will become DISABLED if successful. CREATING (5): 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 (6): 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 (7): The processor is being deleted, will be removed if successful.