Class Processor (2.13.0)

Version 2.13.0

• 3.1.0 (latest)
• 3.0.1
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.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
Name	Description
name	str Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
type_	str The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. To get a list of processors 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.
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 used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.

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.