- 3.0.1 (latest)
- 3.0.0
- 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
DocumentProcessorServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.documentai_v1beta3.services.document_processor_service.transports.base.DocumentProcessorServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
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 > DocumentProcessorServiceClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
DocumentProcessorServiceTransport | The transport used by the client instance. |
Methods
DocumentProcessorServiceClient
DocumentProcessorServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.documentai_v1beta3.services.document_processor_service.transports.base.DocumentProcessorServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the document processor service client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, DocumentProcessorServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
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.
from google.cloud import documentai_v1beta3
def sample_batch_process_documents():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
request = documentai_v1beta3.BatchProcessRequest(
name="name_value",
)
# Make the request
operation = client.batch_process_documents(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
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 |
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. |
Type | Description |
google.api_core.operation.Operation | An 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.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
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.
from google.cloud import documentai_v1beta3
def sample_create_processor():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
request = documentai_v1beta3.CreateProcessorRequest(
parent="parent_value",
)
# Make the request
response = client.create_processor(request=request)
# Handle the response
print(response)
Name | Description |
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 |
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 |
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. |
Type | Description |
google.cloud.documentai_v1beta3.types.Processor | The 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.
from google.cloud import documentai_v1beta3
def sample_delete_processor():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
request = documentai_v1beta3.DeleteProcessorRequest(
name="name_value",
)
# Make the request
operation = client.delete_processor(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
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 |
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. |
Type | Description |
google.api_core.operation.Operation | An 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
from google.cloud import documentai_v1beta3
def sample_disable_processor():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
request = documentai_v1beta3.DisableProcessorRequest(
name="name_value",
)
# Make the request
operation = client.disable_processor(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
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. |
Type | Description |
google.api_core.operation.Operation | An 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
from google.cloud import documentai_v1beta3
def sample_enable_processor():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
request = documentai_v1beta3.EnableProcessorRequest(
name="name_value",
)
# Make the request
operation = client.enable_processor(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
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. |
Type | Description |
google.api_core.operation.Operation | An 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.
from google.cloud import documentai_v1beta3
def sample_fetch_processor_types():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
request = documentai_v1beta3.FetchProcessorTypesRequest(
parent="parent_value",
)
# Make the request
response = client.fetch_processor_types(request=request)
# Handle the response
print(response)
Name | Description |
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 |
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. |
Type | Description |
google.cloud.documentai_v1beta3.types.FetchProcessorTypesResponse | Response 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
DocumentProcessorServiceClient | The 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
DocumentProcessorServiceClient | The 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
DocumentProcessorServiceClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
human_review_config_path
human_review_config_path(project: str, location: str, processor: str)
Returns a fully-qualified human_review_config string.
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.
from google.cloud import documentai_v1beta3
def sample_list_processors():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
request = documentai_v1beta3.ListProcessorsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_processors(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
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 |
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. |
Type | Description |
google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorsPager | Response 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.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_human_review_config_path
parse_human_review_config_path(path: str)
Parses a human_review_config path into its component segments.
parse_processor_path
parse_processor_path(path: str)
Parses a processor path into its component segments.
parse_processor_type_path
parse_processor_type_path(path: str)
Parses a processor_type path into its component segments.
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.
from google.cloud import documentai_v1beta3
def sample_process_document():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
inline_document = documentai_v1beta3.Document()
inline_document.uri = "uri_value"
request = documentai_v1beta3.ProcessRequest(
inline_document=inline_document,
name="name_value",
)
# Make the request
response = client.process_document(request=request)
# Handle the response
print(response)
Name | Description |
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 |
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. |
Type | Description |
google.cloud.documentai_v1beta3.types.ProcessResponse | Response message for the process document method. |
processor_path
processor_path(project: str, location: str, processor: str)
Returns a fully-qualified processor string.
processor_type_path
processor_type_path(project: str, location: str, processor_type: str)
Returns a fully-qualified processor_type string.
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.
from google.cloud import documentai_v1beta3
def sample_review_document():
# Create a client
client = documentai_v1beta3.DocumentProcessorServiceClient()
# Initialize request argument(s)
inline_document = documentai_v1beta3.Document()
inline_document.uri = "uri_value"
request = documentai_v1beta3.ReviewDocumentRequest(
inline_document=inline_document,
human_review_config="human_review_config_value",
)
# Make the request
operation = client.review_document(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
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 |
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. |
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be ReviewDocumentResponse Response message for review document method. |