Class DocumentProcessorServiceClient (2.29.0) 

DocumentProcessorServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.documentai_v1.services.document_processor_service.transports.base.DocumentProcessorServiceTransport, typing.Callable[[...], google.cloud.documentai_v1.services.document_processor_service.transports.base.DocumentProcessorServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service to call Document AI 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.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
DocumentProcessorServiceTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

DocumentProcessorServiceClient

DocumentProcessorServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.documentai_v1.services.document_processor_service.transports.base.DocumentProcessorServiceTransport, typing.Callable[[...], google.cloud.documentai_v1.services.document_processor_service.transports.base.DocumentProcessorServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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.

Parameters
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 Optional[Union[str,DocumentProcessorServiceTransport,Callable[..., DocumentProcessorServiceTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the DocumentProcessorServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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 None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
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: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.BatchProcessRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_batch_process_documents():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.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)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.BatchProcessRequest, dict]

The request object. Request message for BatchProcessDocuments.
name str

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} 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
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 BatchProcessDocuments.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation 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.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_processor

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

Creates a processor from the xref_ProcessorType provided. The processor will be at ENABLED state by default after its creation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_create_processor():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.CreateProcessorRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_processor(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.CreateProcessorRequest, dict]

The request object. Request message for the CreateProcessor method. Notice this request is sent to a regionalized backend service. If the ProcessorType isn't available in that region, the creation fails.
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_v1.types.Processor

Required. The processor to be created, requires Processor.type and Processor.display_name to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK. 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
Type Description
google.cloud.documentai_v1.types.Processor The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

delete_processor

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_delete_processor():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.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)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.DeleteProcessorRequest, dict]

The request object. Request message for the DeleteProcessor 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
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); }

delete_processor_version

delete_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.DeleteProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes the processor version, all artifacts under the processor version will be deleted.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_delete_processor_version():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.DeleteProcessorVersionRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_processor_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.DeleteProcessorVersionRequest, dict]

The request object. Request message for the DeleteProcessorVersion method.
name str

Required. The processor version 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
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); }

deploy_processor_version

deploy_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.DeployProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deploys the processor version.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_deploy_processor_version():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.DeployProcessorVersionRequest(
        name="name_value",
    )

    # Make the request
    operation = client.deploy_processor_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.DeployProcessorVersionRequest, dict]

The request object. Request message for the DeployProcessorVersion method.
name str

Required. The processor version resource name to be deployed. 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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be DeployProcessorVersionResponse Response message for the DeployProcessorVersion method.

disable_processor

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

Disables a processor

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_disable_processor():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.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)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.DisableProcessorRequest, dict]

The request object. Request message for the DisableProcessor 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
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 DisableProcessor method. Intentionally empty proto for adding fields in future.

enable_processor

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

Enables a processor

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_enable_processor():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.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)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.EnableProcessorRequest, dict]

The request object. Request message for the EnableProcessor 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
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 EnableProcessor method. Intentionally empty proto for adding fields in future.

evaluate_processor_version

evaluate_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.EvaluateProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    processor_version: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_evaluate_processor_version():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.EvaluateProcessorVersionRequest(
        processor_version="processor_version_value",
    )

    # Make the request
    operation = client.evaluate_processor_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.EvaluateProcessorVersionRequest, dict]

The request object. Evaluates the given ProcessorVersion against the supplied documents.
processor_version str

Required. The resource name of the ProcessorVersion to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} This corresponds to the processor_version 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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be EvaluateProcessorVersionResponse Response of the EvaluateProcessorVersion method.

evaluation_path

evaluation_path(
    project: str, location: str, processor: str, processor_version: str, evaluation: str
) -> str

Returns a fully-qualified evaluation string.

fetch_processor_types

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

Fetches processor types. Note that we don't use xref_ListProcessorTypes here, because it isn't paginated.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_fetch_processor_types():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.FetchProcessorTypesRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.fetch_processor_types(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.FetchProcessorTypesRequest, dict]

The request object. Request message for the FetchProcessorTypes method. Some processor types may require the project be added to an allowlist.
parent str

Required. The location of processor types 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
Type Description
google.cloud.documentai_v1.types.FetchProcessorTypesResponse Response message for the FetchProcessorTypes method.

from_service_account_file

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
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.

Parameter
Name Description
info dict

The service account private key info.
Returns
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.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
DocumentProcessorServiceClient The constructed client.

get_evaluation

get_evaluation(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.GetEvaluationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.documentai_v1.types.evaluation.Evaluation

Retrieves a specific evaluation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_get_evaluation():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.GetEvaluationRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_evaluation(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.GetEvaluationRequest, dict]

The request object. Retrieves a specific Evaluation.
name str

Required. The resource name of the Evaluation to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation} 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
Type Description
google.cloud.documentai_v1.types.Evaluation An evaluation of a ProcessorVersion's performance.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation 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
Type Description
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. 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 variable 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.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation 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
Type Description
.operations_pb2.Operation An Operation object.

get_processor

get_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.GetProcessorRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.documentai_v1.types.processor.Processor

Gets a processor detail.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_get_processor():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.GetProcessorRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_processor(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.GetProcessorRequest, dict]

The request object. Request message for the GetProcessor 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
Type Description
google.cloud.documentai_v1.types.Processor The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

get_processor_type

get_processor_type(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.GetProcessorTypeRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.documentai_v1.types.processor_type.ProcessorType

Gets a processor type detail.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_get_processor_type():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.GetProcessorTypeRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_processor_type(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.GetProcessorTypeRequest, dict]

The request object. Request message for the GetProcessorType method.
name str

Required. The processor type 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
Type Description
google.cloud.documentai_v1.types.ProcessorType A processor type is responsible for performing a certain document understanding task on a certain type of document.

get_processor_version

get_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.GetProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.documentai_v1.types.processor.ProcessorVersion

Gets a processor version detail.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_get_processor_version():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.GetProcessorVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_processor_version(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.GetProcessorVersionRequest, dict]

The request object. Request message for the GetProcessorVersion 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
Type Description
google.cloud.documentai_v1.types.ProcessorVersion A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.

human_review_config_path

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

Returns a fully-qualified human_review_config string.

list_evaluations

list_evaluations(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.ListEvaluationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.documentai_v1.services.document_processor_service.pagers.ListEvaluationsPager
)

Retrieves a set of evaluations for a given processor version.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_list_evaluations():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.ListEvaluationsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_evaluations(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.ListEvaluationsRequest, dict]

The request object. Retrieves a list of evaluations for a given ProcessorVersion.
parent str

Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} 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
Type Description
google.cloud.documentai_v1.services.document_processor_service.pagers.ListEvaluationsPager The response from ListEvaluations. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations 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
Type Description
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations 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
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_processor_types

list_processor_types(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.ListProcessorTypesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorTypesPager
)

Lists the processor types that exist.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_list_processor_types():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.ListProcessorTypesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_processor_types(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.ListProcessorTypesRequest, dict]

The request object. Request message for the ListProcessorTypes method. Some processor types may require the project be added to an allowlist.
parent str

Required. The location of processor types 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
Type Description
google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorTypesPager Response message for the ListProcessorTypes method. Iterating over this object will yield results and resolve additional pages automatically.

list_processor_versions

list_processor_versions(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.ListProcessorVersionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorVersionsPager
)

Lists all versions of a processor.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_list_processor_versions():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.ListProcessorVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_processor_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.ListProcessorVersionsRequest, dict]

The request object. Request message for list all processor versions belongs to a processor.
parent str

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor} 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
Type Description
google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorVersionsPager Response message for the ListProcessorVersions method. Iterating over this object will yield results and resolve additional pages automatically.

list_processors

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

Lists all processors which belong to this project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_list_processors():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.ListProcessorsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_processors(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.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
Type Description
google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorsPager Response message for the ListProcessors method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_evaluation_path

parse_evaluation_path(path: str) -> typing.Dict[str, str]

Parses a evaluation path into its component segments.

parse_human_review_config_path

parse_human_review_config_path(path: str) -> typing.Dict[str, str]

Parses a human_review_config path into its component segments.

parse_processor_path

parse_processor_path(path: str) -> typing.Dict[str, str]

Parses a processor path into its component segments.

parse_processor_type_path

parse_processor_type_path(path: str) -> typing.Dict[str, str]

Parses a processor_type path into its component segments.

parse_processor_version_path

parse_processor_version_path(path: str) -> typing.Dict[str, str]

Parses a processor_version path into its component segments.

process_document

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

Processes a single document.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_process_document():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    inline_document = documentai_v1.Document()
    inline_document.uri = "uri_value"

    request = documentai_v1.ProcessRequest(
        inline_document=inline_document,
        name="name_value",
    )

    # Make the request
    response = client.process_document(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.ProcessRequest, dict]

The request object. Request message for the ProcessDocument method.
name str

Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} 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
Type Description
google.cloud.documentai_v1.types.ProcessResponse Response message for the ProcessDocument method.

processor_path

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

Returns a fully-qualified processor string.

processor_type_path

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

Returns a fully-qualified processor_type string.

processor_version_path

processor_version_path(
    project: str, location: str, processor: str, processor_version: str
) -> str

Returns a fully-qualified processor_version string.

review_document

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_review_document():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    inline_document = documentai_v1.Document()
    inline_document.uri = "uri_value"

    request = documentai_v1.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)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.ReviewDocumentRequest, dict]

The request object. Request message for the ReviewDocument method.
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
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 the ReviewDocument method.

set_default_processor_version

set_default_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.SetDefaultProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Set the default (active) version of a xref_Processor that will be used in xref_ProcessDocument and xref_BatchProcessDocuments.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_set_default_processor_version():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.SetDefaultProcessorVersionRequest(
        processor="processor_value",
        default_processor_version="default_processor_version_value",
    )

    # Make the request
    operation = client.set_default_processor_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.SetDefaultProcessorVersionRequest, dict]

The request object. Request message for the SetDefaultProcessorVersion 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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be SetDefaultProcessorVersionResponse Response message for the SetDefaultProcessorVersion method.

train_processor_version

train_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.TrainProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    processor_version: typing.Optional[
        google.cloud.documentai_v1.types.processor.ProcessorVersion
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Trains a new processor version. Operation metadata is returned as xref_TrainProcessorVersionMetadata.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_train_processor_version():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.TrainProcessorVersionRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.train_processor_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.TrainProcessorVersionRequest, dict]

The request object. Request message for the TrainProcessorVersion method.
parent str

Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
processor_version google.cloud.documentai_v1.types.ProcessorVersion

Required. The processor version to be created. This corresponds to the processor_version 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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be TrainProcessorVersionResponse The response for TrainProcessorVersion.

undeploy_processor_version

undeploy_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1.types.document_processor_service.UndeployProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Undeploys the processor version.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import documentai_v1

def sample_undeploy_processor_version():
    # Create a client
    client = documentai_v1.DocumentProcessorServiceClient()

    # Initialize request argument(s)
    request = documentai_v1.UndeployProcessorVersionRequest(
        name="name_value",
    )

    # Make the request
    operation = client.undeploy_processor_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.documentai_v1.types.UndeployProcessorVersionRequest, dict]

The request object. Request message for the UndeployProcessorVersion method.
name str

Required. The processor version resource name to be undeployed. 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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be UndeployProcessorVersionResponse Response message for the UndeployProcessorVersion method.