Class Processor (3.5.0)
Stay organized with collections
Save and categorize content based on your preferences.
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, 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 |
satisfies_pzs |
bool
Output only. Reserved for future use.
|
satisfies_pzi |
bool
Output only. Reserved for future use.
|
Classes
State
The possible states of the processor.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class Processor (3.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.5.0 (latest)](/python/docs/reference/documentai/latest/google.cloud.documentai_v1.types.Processor)\n- [3.4.0](/python/docs/reference/documentai/3.4.0/google.cloud.documentai_v1.types.Processor)\n- [3.3.0](/python/docs/reference/documentai/3.3.0/google.cloud.documentai_v1.types.Processor)\n- [3.2.0](/python/docs/reference/documentai/3.2.0/google.cloud.documentai_v1.types.Processor)\n- [3.1.0](/python/docs/reference/documentai/3.1.0/google.cloud.documentai_v1.types.Processor)\n- [3.0.1](/python/docs/reference/documentai/3.0.1/google.cloud.documentai_v1.types.Processor)\n- [2.35.0](/python/docs/reference/documentai/2.35.0/google.cloud.documentai_v1.types.Processor)\n- [2.34.0](/python/docs/reference/documentai/2.34.0/google.cloud.documentai_v1.types.Processor)\n- [2.33.0](/python/docs/reference/documentai/2.33.0/google.cloud.documentai_v1.types.Processor)\n- [2.32.0](/python/docs/reference/documentai/2.32.0/google.cloud.documentai_v1.types.Processor)\n- [2.30.0](/python/docs/reference/documentai/2.30.0/google.cloud.documentai_v1.types.Processor)\n- [2.29.3](/python/docs/reference/documentai/2.29.3/google.cloud.documentai_v1.types.Processor)\n- [2.28.0](/python/docs/reference/documentai/2.28.0/google.cloud.documentai_v1.types.Processor)\n- [2.27.1](/python/docs/reference/documentai/2.27.1/google.cloud.documentai_v1.types.Processor)\n- [2.26.0](/python/docs/reference/documentai/2.26.0/google.cloud.documentai_v1.types.Processor)\n- [2.25.0](/python/docs/reference/documentai/2.25.0/google.cloud.documentai_v1.types.Processor)\n- [2.24.2](/python/docs/reference/documentai/2.24.2/google.cloud.documentai_v1.types.Processor)\n- [2.23.0](/python/docs/reference/documentai/2.23.0/google.cloud.documentai_v1.types.Processor)\n- [2.22.0](/python/docs/reference/documentai/2.22.0/google.cloud.documentai_v1.types.Processor)\n- [2.21.1](/python/docs/reference/documentai/2.21.1/google.cloud.documentai_v1.types.Processor)\n- [2.20.2](/python/docs/reference/documentai/2.20.2/google.cloud.documentai_v1.types.Processor)\n- [2.19.0](/python/docs/reference/documentai/2.19.0/google.cloud.documentai_v1.types.Processor)\n- [2.18.0](/python/docs/reference/documentai/2.18.0/google.cloud.documentai_v1.types.Processor)\n- [2.17.0](/python/docs/reference/documentai/2.17.0/google.cloud.documentai_v1.types.Processor)\n- [2.16.1](/python/docs/reference/documentai/2.16.1/google.cloud.documentai_v1.types.Processor)\n- [2.15.0](/python/docs/reference/documentai/2.15.0/google.cloud.documentai_v1.types.Processor)\n- [2.14.0](/python/docs/reference/documentai/2.14.0/google.cloud.documentai_v1.types.Processor)\n- [2.13.0](/python/docs/reference/documentai/2.13.0/google.cloud.documentai_v1.types.Processor)\n- [2.12.0](/python/docs/reference/documentai/2.12.0/google.cloud.documentai_v1.types.Processor)\n- [2.11.0](/python/docs/reference/documentai/2.11.0/google.cloud.documentai_v1.types.Processor)\n- [2.10.0](/python/docs/reference/documentai/2.10.0/google.cloud.documentai_v1.types.Processor)\n- [2.9.1](/python/docs/reference/documentai/2.9.1/google.cloud.documentai_v1.types.Processor)\n- [2.8.0](/python/docs/reference/documentai/2.8.0/google.cloud.documentai_v1.types.Processor)\n- [2.7.0](/python/docs/reference/documentai/2.7.0/google.cloud.documentai_v1.types.Processor)\n- [2.6.0](/python/docs/reference/documentai/2.6.0/google.cloud.documentai_v1.types.Processor)\n- [2.5.0](/python/docs/reference/documentai/2.5.0/google.cloud.documentai_v1.types.Processor)\n- [2.4.1](/python/docs/reference/documentai/2.4.1/google.cloud.documentai_v1.types.Processor)\n- [2.3.0](/python/docs/reference/documentai/2.3.0/google.cloud.documentai_v1.types.Processor)\n- [2.2.0](/python/docs/reference/documentai/2.2.0/google.cloud.documentai_v1.types.Processor)\n- [2.1.0](/python/docs/reference/documentai/2.1.0/google.cloud.documentai_v1.types.Processor)\n- [2.0.3](/python/docs/reference/documentai/2.0.3/google.cloud.documentai_v1.types.Processor)\n- [1.5.1](/python/docs/reference/documentai/1.5.1/google.cloud.documentai_v1.types.Processor)\n- [1.4.2](/python/docs/reference/documentai/1.4.2/google.cloud.documentai_v1.types.Processor)\n- [1.3.0](/python/docs/reference/documentai/1.3.0/google.cloud.documentai_v1.types.Processor)\n- [1.2.1](/python/docs/reference/documentai/1.2.1/google.cloud.documentai_v1.types.Processor)\n- [1.1.0](/python/docs/reference/documentai/1.1.0/google.cloud.documentai_v1.types.Processor)\n- [1.0.0](/python/docs/reference/documentai/1.0.0/google.cloud.documentai_v1.types.Processor)\n- [0.5.2](/python/docs/reference/documentai/0.5.2/google.cloud.documentai_v1.types.Processor)\n- [0.4.0](/python/docs/reference/documentai/0.4.0/google.cloud.documentai_v1.types.Processor)\n- [0.3.0](/python/docs/reference/documentai/0.3.0/google.cloud.documentai_v1.types.Processor)\n- [0.2.0](/python/docs/reference/documentai/0.2.0/google.cloud.documentai_v1.types.Processor)\n- [0.1.0](/python/docs/reference/documentai/0.1.0/google.cloud.documentai_v1.types.Processor) \n\n Processor(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe first-class citizen for Document AI. Each processor\ndefines how to extract structural information from a document.\n\nClasses\n-------\n\n### State\n\n State(value)\n\nThe possible states of the processor."]]
