Class DocumentProcessorServiceAsyncClient (2.4.0)

Stay organized with collections Save and categorize content based on your preferences.
DocumentProcessorServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.documentai_v1beta3.services.document_processor_service.transports.base.DocumentProcessorServiceTransport] = 'grpc_asyncio', 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.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
DocumentProcessorServiceTransportThe transport used by the client instance.

Methods

DocumentProcessorServiceAsyncClient

DocumentProcessorServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.documentai_v1beta3.services.document_processor_service.transports.base.DocumentProcessorServiceTransport] = 'grpc_asyncio', 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.

Parameters
NameDescription
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 ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

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.

# 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_v1beta3

async def sample_batch_process_documents():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

    # 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 = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.BatchProcessRequest, dict]]

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

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be BatchProcessResponse Response message for batch process document method.

cancel_operation

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = 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]] = ())

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
NameDescription
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)

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.

# 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_v1beta3

async def sample_create_processor():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.CreateProcessorRequest, dict]]

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

parent str

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

processor Processor

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

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

Returns
TypeDescription
google.cloud.documentai_v1beta3.types.ProcessorThe first-class citizen for Document AI. 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.

# 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_v1beta3

async def sample_delete_processor():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

    # 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 = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.DeleteProcessorRequest, dict]]

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

name str

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

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.DeleteProcessorVersionRequest, 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 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_v1beta3

async def sample_delete_processor_version():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

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

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.DeleteProcessorVersionRequest, dict]]

The request object. Request message for the delete processor version 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.DeployProcessorVersionRequest, 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]] = ())

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_v1beta3

async def sample_deploy_processor_version():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

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

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.DeployProcessorVersionRequest, dict]]

The request object. Request message for the deploy processor version 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be DeployProcessorVersionResponse Response message for the deploy processor version method.

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

# 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_v1beta3

async def sample_disable_processor():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

    # 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 = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.DisableProcessorRequest, dict]]

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

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be DisableProcessorResponse Response message for the disable processor method. Intentionally empty proto for adding fields in future.

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

# 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_v1beta3

async def sample_enable_processor():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

    # 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 = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.EnableProcessorRequest, dict]]

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

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be EnableProcessorResponse Response message for the enable processor method. Intentionally empty proto for adding fields in future.

evaluate_processor_version

evaluate_processor_version(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.EvaluateProcessorVersionRequest, dict]] = None, *, processor_version: 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]] = ())

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_v1beta3

async def sample_evaluate_processor_version():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

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

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be EvaluateProcessorVersionResponse Metadata of the EvaluateProcessorVersion method.

evaluation_path

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

Returns a fully-qualified evaluation string.

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. Note that we do not use ListProcessorTypes here because it is not 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_v1beta3

async def sample_fetch_processor_types():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[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. The available processor types may depend on the allow-listing on projects. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

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

from_service_account_file

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DocumentProcessorServiceAsyncClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
DocumentProcessorServiceAsyncClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DocumentProcessorServiceAsyncClientThe constructed client.

get_evaluation

get_evaluation(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.GetEvaluationRequest, 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]] = ())

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_v1beta3

async def sample_get_evaluation():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.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
TypeDescription
google.cloud.documentai_v1beta3.types.EvaluationAn evaluation of a ProcessorVersion's performance.

get_location

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = 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]] = ())

Gets information about a location.

Parameters
NameDescription
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
TypeDescription
.location_pb2.LocationLocation object.

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.

Parameter
NameDescription
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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_operation

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = 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]] = ())

Gets the latest state of a long-running operation.

Parameters
NameDescription
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
TypeDescription
.operations_pb2.OperationAn Operation object.

get_processor

get_processor(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.GetProcessorRequest, 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]] = ())

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_v1beta3

async def sample_get_processor():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.GetProcessorRequest, dict]]

The request object. Request message for get processor.

name str

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

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

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

get_processor_version

get_processor_version(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.GetProcessorVersionRequest, 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]] = ())

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_v1beta3

async def sample_get_processor_version():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.GetProcessorVersionRequest, dict]]

The request object. Request message for get processor version.

name str

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

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

Returns
TypeDescription
google.cloud.documentai_v1beta3.types.ProcessorVersionA processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version

get_transport_class

get_transport_class()

Returns an appropriate transport class.

human_review_config_path

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

Returns a fully-qualified human_review_config string.

list_evaluations

list_evaluations(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.ListEvaluationsRequest, 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]] = ())

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_v1beta3

async def sample_list_evaluations():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.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
TypeDescription
google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListEvaluationsAsyncPagerThe response from ListEvaluations. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = 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 information about the supported locations for this service.

Parameters
NameDescription
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
TypeDescription
.location_pb2.ListLocationsResponseResponse message for ListLocations method.

list_operations

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = 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 operations that match the specified filter in the request.

Parameters
NameDescription
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
TypeDescription
.operations_pb2.ListOperationsResponseResponse message for ListOperations method.

list_processor_types

list_processor_types(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorTypesRequest, 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 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_v1beta3

async def sample_list_processor_types():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.ListProcessorTypesRequest, dict]]

The request object. Request message for list processor types.

parent str

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

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

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

list_processor_versions

list_processor_versions(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorVersionsRequest, 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 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_v1beta3

async def sample_list_processor_versions():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.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
TypeDescription
google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorVersionsAsyncPagerResponse message for list processors. Iterating over this object will yield results and resolve additional pages automatically.

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.

# 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_v1beta3

async def sample_list_processors():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.ListProcessorsRequest, dict]]

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

parent str

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

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

Returns
TypeDescription
google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorsAsyncPagerResponse 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_evaluation_path

parse_evaluation_path(path: str)

Parses a evaluation 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.

parse_processor_version_path

parse_processor_version_path(path: str)

Parses a processor_version 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.

# 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_v1beta3

async def sample_process_document():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

    # 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 = await client.process_document(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.ProcessRequest, dict]]

The request object. Request message for the process document 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.v1beta3.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
TypeDescription
google.cloud.documentai_v1beta3.types.ProcessResponseResponse message for the process document method.

processor_path

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

Returns a fully-qualified processor string.

processor_type_path

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

Returns a fully-qualified processor_type string.

processor_version_path

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

Returns a fully-qualified processor_version 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.

# 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_v1beta3

async def sample_review_document():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

    # 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 = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.ReviewDocumentRequest, dict]]

The request object. Request message for review document 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be ReviewDocumentResponse Response message for review document method.

set_default_processor_version

set_default_processor_version(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.SetDefaultProcessorVersionRequest, 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]] = ())

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_v1beta3

async def sample_set_default_processor_version():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

    # Initialize request argument(s)
    request = documentai_v1beta3.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 = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.documentai_v1beta3.types.SetDefaultProcessorVersionRequest, dict]]

The request object. Request message for the set default processor version method.

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be SetDefaultProcessorVersionResponse Response message for set default processor version method.

train_processor_version

train_processor_version(request: Optional[Union[google.cloud.documentai_v1beta3.types.document_processor_service.TrainProcessorVersionRequest, dict]] = None, *, parent: Optional[str] = None, processor_version: Optional[google.cloud.documentai_v1beta3.types.processor.ProcessorVersion] = 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]] = ())

Trains a new processor version. Operation metadata is returned as cloud_documentai_core.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_v1beta3

async def sample_train_processor_version():
    # Create a client
    client = documentai_v1beta3.DocumentProcessorServiceAsyncClient()

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

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

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

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[