Class DocumentProcessorServiceClient

Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

Inheritance

builtins.object > DocumentProcessorServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
DocumentProcessorServiceTransportThe transport used by the client instance.

Methods

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

.. warning:: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

batch_process_documents

batch_process_documents(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.BatchProcessRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.BatchProcessRequest, dict]

The request object. Request message for batch process document method.

name str

Required. The processor resource name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be BatchProcessResponse Response message for batch process document method.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

create_processor

create_processor(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.CreateProcessorRequest, dict]] = None, *, parent: Optional[str] = None, processor: Optional[google.cloud.documentai_v1beta3.types.processor.Processor] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.CreateProcessorRequest, dict]

The request object. Request message for create a processor. Notice this request is sent to a regionalized backend service, and if the processor type is not available on that region, the creation will fail.

parent str

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

processor google.cloud.documentai_v1beta3.types.Processor

Required. The processor to be created, requires [processor_type] and [display_name] to be set. Also, the processor is under CMEK if CMEK fields are set. This corresponds to the processor field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.documentai_v1beta3.types.ProcessorThe first-class citizen for DocumentAI. Each processor defines how to extract structural information from a document.

delete_processor

delete_processor(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.DeleteProcessorRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.DeleteProcessorRequest, dict]

The request object. Request message for the delete processor method.

name str

Required. The processor resource name to be deleted. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

disable_processor

disable_processor(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.DisableProcessorRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Disables a processor

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.DisableProcessorRequest, dict]

The request object. Request message for the disable processor method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be DisableProcessorResponse Response message for the disable processor method.

enable_processor

enable_processor(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.EnableProcessorRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Enables a processor

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.EnableProcessorRequest, dict]

The request object. Request message for the enable processor method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be EnableProcessorResponse Response message for the enable processor method.

fetch_processor_types

fetch_processor_types(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.FetchProcessorTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Fetches processor types.

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.FetchProcessorTypesRequest, dict]

The request object. Request message for fetch processor types.

parent str

Required. The project of processor type to list. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.documentai_v1beta3.types.FetchProcessorTypesResponseResponse message for fetch processor types.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
DocumentProcessorServiceClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
DocumentProcessorServiceClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
DocumentProcessorServiceClientThe constructed client.

human_review_config_path

human_review_config_path(project: str, location: str, processor: str)

Returns a fully-qualified human_review_config string.

Parameters
NameDescription
project str
location str
processor str

list_processors

list_processors(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all processors which belong to this project.

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.ListProcessorsRequest, dict]

The request object. Request message for list all processors belongs to a project.

parent str

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorsPagerResponse message for list processors. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_human_review_config_path

parse_human_review_config_path(path: str)

Parses a human_review_config path into its component segments.

Parameter
NameDescription
path str

parse_processor_path

parse_processor_path(path: str)

Parses a processor path into its component segments.

Parameter
NameDescription
path str

parse_processor_type_path

parse_processor_type_path(path: str)

Parses a processor_type path into its component segments.

Parameter
NameDescription
path str

process_document

process_document(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.ProcessRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Processes a single document.

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.ProcessRequest, dict]

The request object. Request message for the process document method.

name str

Required. The processor resource name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.documentai_v1beta3.types.ProcessResponseResponse message for the process document method.

processor_path

processor_path(project: str, location: str, processor: str)

Returns a fully-qualified processor string.

Parameters
NameDescription
project str
location str
processor str

processor_type_path

processor_type_path(project: str, location: str, processor_type: str)

Returns a fully-qualified processor_type string.

Parameters
NameDescription
project str
location str
processor_type str

review_document

review_document(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.ReviewDocumentRequest, dict]] = None, *, human_review_config: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Send a document for Human Review. The input document should be processed by the specified processor.

Parameters
NameDescription
request Union[google.cloud.documentai_v1beta3.types.ReviewDocumentRequest, dict]

The request object. Request message for review document method. Next Id: 6.

human_review_config str

Required. The resource name of the HumanReviewConfig that the document will be reviewed with. This corresponds to the human_review_config field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be ReviewDocumentResponse Response message for review document method.