Package Methods (2.27.0)

Version 2.27.0

• 3.0.1 (latest)
• 3.0.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Summary of entries of Methods for documentai.

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient

DocumentProcessorServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.documentai_v1.services.document_processor_service.transports.base.DocumentProcessorServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the document processor service async client.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

LRO endpoint to batch process many documents.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.batch_process_documents

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.cancel_operation

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_billing_account_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_folder_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_location_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_organization_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_project_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.create_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.delete_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.delete_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

Deploys the processor version.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.deploy_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

Disables a processor.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.disable_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

Enables a processor.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.enable_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.evaluate_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.evaluation_path

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

Returns a fully-qualified evaluation string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.evaluation_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.fetch_processor_types

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_file

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_info

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_json

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_evaluation

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_location

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_operation

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor_type

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.documentai_v1.services.document_processor_service.transports.base.DocumentProcessorServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_transport_class

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.human_review_config_path

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

Returns a fully-qualified human_review_config string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.human_review_config_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.ListEvaluationsAsyncPager
)

Retrieves a set of evaluations for a given processor version.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_evaluations

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_locations

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_operations

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.ListProcessorTypesAsyncPager
)

Lists the processor types that exist.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processor_types

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.ListProcessorVersionsAsyncPager
)

Lists all versions of a processor.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processor_versions

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.ListProcessorsAsyncPager
)

Lists all processors which belong to this project.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processors

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_billing_account_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_folder_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_location_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_organization_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_project_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_evaluation_path

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

Parses a evaluation path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_evaluation_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_human_review_config_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_path

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

Parses a processor path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_type_path

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

Parses a processor_type path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_type_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_version_path

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

Parses a processor_version path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_version_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.process_document

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_path

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

Returns a fully-qualified processor string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_type_path

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

Returns a fully-qualified processor_type string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_type_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_version_path

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

Returns a fully-qualified processor_version string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_version_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

Send a document for Human Review.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.review_document

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.set_default_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

Trains a new processor version.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.train_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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_async.AsyncOperation

Undeploys the processor version.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceAsyncClient.undeploy_processor_version

google.cloud.documentai_v1.services.document_processor_service.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]] = 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 = 

Instantiates the document processor service client.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.exit

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.batch_process_documents

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.cancel_operation

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_billing_account_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_folder_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_location_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_organization_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.common_project_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.create_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.delete_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.delete_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.deploy_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.disable_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.enable_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.evaluate_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.evaluation_path

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

Returns a fully-qualified evaluation string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.evaluation_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.fetch_processor_types

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_file

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

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_file

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_info

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

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_info

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_json

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

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

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_json

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.get_evaluation

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.get_location

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.get_operation

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.get_processor

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.get_processor_type

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.get_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.human_review_config_path

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

Returns a fully-qualified human_review_config string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.human_review_config_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.list_evaluations

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.list_locations

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.list_operations

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.list_processor_types

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.list_processor_versions

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.list_processors

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_billing_account_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_folder_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_location_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_organization_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_common_project_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_evaluation_path

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

Parses a evaluation path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_evaluation_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_human_review_config_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_path

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

Parses a processor path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_type_path

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

Parses a processor_type path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_type_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_version_path

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

Parses a processor_version path into its component segments.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_version_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.process_document

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.processor_path

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

Returns a fully-qualified processor string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.processor_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.processor_type_path

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

Returns a fully-qualified processor_type string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.processor_type_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.processor_version_path

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

Returns a fully-qualified processor_version string.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.processor_version_path

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.review_document

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.set_default_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.train_processor_version

google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.undeploy_processor_version

google.cloud.documentai_v1.services.document_processor_service.pagers.ListEvaluationsAsyncPager

ListEvaluationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1.types.document_processor_service.ListEvaluationsResponse
        ],
    ],
    request: google.cloud.documentai_v1.types.document_processor_service.ListEvaluationsRequest,
    response: google.cloud.documentai_v1.types.document_processor_service.ListEvaluationsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1.services.document_processor_service.pagers.ListEvaluationsAsyncPager

google.cloud.documentai_v1.services.document_processor_service.pagers.ListEvaluationsPager

ListEvaluationsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1.types.document_processor_service.ListEvaluationsResponse,
    ],
    request: google.cloud.documentai_v1.types.document_processor_service.ListEvaluationsRequest,
    response: google.cloud.documentai_v1.types.document_processor_service.ListEvaluationsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1.services.document_processor_service.pagers.ListEvaluationsPager

google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorTypesAsyncPager

ListProcessorTypesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1.types.document_processor_service.ListProcessorTypesResponse
        ],
    ],
    request: google.cloud.documentai_v1.types.document_processor_service.ListProcessorTypesRequest,
    response: google.cloud.documentai_v1.types.document_processor_service.ListProcessorTypesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorTypesAsyncPager

google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorTypesPager

ListProcessorTypesPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1.types.document_processor_service.ListProcessorTypesResponse,
    ],
    request: google.cloud.documentai_v1.types.document_processor_service.ListProcessorTypesRequest,
    response: google.cloud.documentai_v1.types.document_processor_service.ListProcessorTypesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorTypesPager

google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorVersionsAsyncPager

ListProcessorVersionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1.types.document_processor_service.ListProcessorVersionsResponse
        ],
    ],
    request: google.cloud.documentai_v1.types.document_processor_service.ListProcessorVersionsRequest,
    response: google.cloud.documentai_v1.types.document_processor_service.ListProcessorVersionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorVersionsAsyncPager

google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorVersionsPager

ListProcessorVersionsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1.types.document_processor_service.ListProcessorVersionsResponse,
    ],
    request: google.cloud.documentai_v1.types.document_processor_service.ListProcessorVersionsRequest,
    response: google.cloud.documentai_v1.types.document_processor_service.ListProcessorVersionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorVersionsPager

google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorsAsyncPager

ListProcessorsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1.types.document_processor_service.ListProcessorsResponse
        ],
    ],
    request: google.cloud.documentai_v1.types.document_processor_service.ListProcessorsRequest,
    response: google.cloud.documentai_v1.types.document_processor_service.ListProcessorsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorsAsyncPager

google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorsPager

ListProcessorsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1.types.document_processor_service.ListProcessorsResponse,
    ],
    request: google.cloud.documentai_v1.types.document_processor_service.ListProcessorsRequest,
    response: google.cloud.documentai_v1.types.document_processor_service.ListProcessorsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1.services.document_processor_service.pagers.ListProcessorsPager

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient

DocumentUnderstandingServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.documentai_v1beta2.services.document_understanding_service.transports.base.DocumentUnderstandingServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the document understanding service async client.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.batch_process_documents

batch_process_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta2.types.document_understanding.BatchProcessDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.documentai_v1beta2.types.document_understanding.ProcessDocumentRequest
        ]
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

LRO endpoint to batch process many documents.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.batch_process_documents

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.cancel_operation

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_billing_account_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_folder_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_location_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_organization_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.common_project_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.from_service_account_file

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.from_service_account_info

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.from_service_account_json

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.get_location

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.get_operation

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.documentai_v1beta2.services.document_understanding_service.transports.base.DocumentUnderstandingServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.get_transport_class

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.list_locations

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.list_operations

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_billing_account_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_folder_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_location_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_organization_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.parse_common_project_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.process_document

process_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta2.types.document_understanding.ProcessDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta2.types.document.Document

Processes a single document.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceAsyncClient.process_document

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient

DocumentUnderstandingServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.documentai_v1beta2.services.document_understanding_service.transports.base.DocumentUnderstandingServiceTransport]] = 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 = 

Instantiates the document understanding service client.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.exit

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.batch_process_documents

batch_process_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta2.types.document_understanding.BatchProcessDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.documentai_v1beta2.types.document_understanding.ProcessDocumentRequest
        ]
    ] = 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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.batch_process_documents

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.cancel_operation

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_billing_account_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_folder_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_location_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_organization_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.common_project_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.from_service_account_file

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

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

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.from_service_account_file

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.from_service_account_info

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

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

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.from_service_account_info

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.from_service_account_json

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

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

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.from_service_account_json

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.get_location

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.get_operation

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.list_locations

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.list_operations

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.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.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_billing_account_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_folder_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_location_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_organization_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.parse_common_project_path

google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.process_document

process_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta2.types.document_understanding.ProcessDocumentRequest,
            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.cloud.documentai_v1beta2.types.document.Document

Processes a single document.

See more: google.cloud.documentai_v1beta2.services.document_understanding_service.DocumentUnderstandingServiceClient.process_document

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient

DocumentProcessorServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.documentai_v1beta3.services.document_processor_service.transports.base.DocumentProcessorServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the document processor service async client.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.batch_process_documents

batch_process_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.BatchProcessRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

LRO endpoint to batch process many documents.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.batch_process_documents

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.cancel_operation

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_billing_account_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_folder_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_location_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_organization_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.common_project_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.create_processor

create_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.CreateProcessorRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    processor: typing.Optional[
        google.cloud.documentai_v1beta3.types.processor.Processor
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.processor.Processor

Creates a processor from the xref_ProcessorType provided.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.create_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.delete_processor

delete_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.DeleteProcessorRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.delete_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.delete_processor_version

delete_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.DeleteProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.delete_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.deploy_processor_version

deploy_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.DeployProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Deploys the processor version.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.deploy_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.disable_processor

disable_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.DisableProcessorRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Disables a processor.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.disable_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.enable_processor

enable_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.EnableProcessorRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Enables a processor.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.enable_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.evaluate_processor_version

evaluate_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.EvaluateProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    processor_version: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.evaluate_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.evaluation_path

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

Returns a fully-qualified evaluation string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.evaluation_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.fetch_processor_types

fetch_processor_types(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.FetchProcessorTypesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.document_processor_service.FetchProcessorTypesResponse
)

Fetches processor types.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.fetch_processor_types

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_file

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_info

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.from_service_account_json

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_evaluation

get_evaluation(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.GetEvaluationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.evaluation.Evaluation

Retrieves a specific evaluation.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_evaluation

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_location

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_operation

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor

get_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.GetProcessorRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.processor.Processor

Gets a processor detail.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor_type

get_processor_type(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.GetProcessorTypeRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.processor_type.ProcessorType

Gets a processor type detail.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor_type

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor_version

get_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.GetProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.processor.ProcessorVersion

Gets a processor version detail.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.documentai_v1beta3.services.document_processor_service.transports.base.DocumentProcessorServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.get_transport_class

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.human_review_config_path

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

Returns a fully-qualified human_review_config string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.human_review_config_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.import_processor_version

import_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.ImportProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Imports a processor version from source processor version.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.import_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_evaluations

list_evaluations(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.ListEvaluationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.services.document_processor_service.pagers.ListEvaluationsAsyncPager
)

Retrieves a set of evaluations for a given processor version.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_evaluations

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_locations

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_operations

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processor_types

list_processor_types(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorTypesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.services.document_processor_service.pagers.ListProcessorTypesAsyncPager
)

Lists the processor types that exist.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processor_types

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processor_versions

list_processor_versions(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorVersionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.services.document_processor_service.pagers.ListProcessorVersionsAsyncPager
)

Lists all versions of a processor.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processor_versions

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processors

list_processors(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.services.document_processor_service.pagers.ListProcessorsAsyncPager
)

Lists all processors which belong to this project.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.list_processors

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_billing_account_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_folder_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_location_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_organization_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_common_project_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_evaluation_path

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

Parses a evaluation path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_evaluation_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_human_review_config_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_path

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

Parses a processor path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_type_path

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

Parses a processor_type path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_type_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_version_path

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

Parses a processor_version path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.parse_processor_version_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.process_document

process_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.ProcessRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.document_processor_service.ProcessResponse

Processes a single document.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.process_document

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_path

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

Returns a fully-qualified processor string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_type_path

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

Returns a fully-qualified processor_type string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_type_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_version_path

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

Returns a fully-qualified processor_version string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.processor_version_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.review_document

review_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_async.AsyncRetry,
            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_async.AsyncOperation

Send a document for Human Review.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.review_document

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.set_default_processor_version

set_default_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.SetDefaultProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.set_default_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.train_processor_version

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

Trains a new processor version.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.train_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.undeploy_processor_version

undeploy_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.UndeployProcessorVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Undeploys the processor version.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceAsyncClient.undeploy_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient

DocumentProcessorServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.documentai_v1beta3.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 = 

Instantiates the document processor service client.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.exit

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.batch_process_documents

batch_process_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.batch_process_documents

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.cancel_operation

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_billing_account_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_folder_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_location_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_organization_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.common_project_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.create_processor

create_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.CreateProcessorRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    processor: typing.Optional[
        google.cloud.documentai_v1beta3.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_v1beta3.types.processor.Processor

Creates a processor from the xref_ProcessorType provided.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.create_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.delete_processor

delete_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.delete_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.delete_processor_version

delete_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.delete_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.deploy_processor_version

deploy_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.deploy_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.disable_processor

disable_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.disable_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.enable_processor

enable_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.enable_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.evaluate_processor_version

evaluate_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.evaluate_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.evaluation_path

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

Returns a fully-qualified evaluation string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.evaluation_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.fetch_processor_types

fetch_processor_types(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.types.document_processor_service.FetchProcessorTypesResponse
)

Fetches processor types.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.fetch_processor_types

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_file

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

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_file

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_info

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

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_info

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_json

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

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.from_service_account_json

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_evaluation

get_evaluation(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.types.evaluation.Evaluation

Retrieves a specific evaluation.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_evaluation

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_location

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_operation

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_processor

get_processor(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.types.processor.Processor

Gets a processor detail.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_processor

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_processor_type

get_processor_type(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.types.processor_type.ProcessorType

Gets a processor type detail.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_processor_type

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_processor_version

get_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.types.processor.ProcessorVersion

Gets a processor version detail.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.get_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.human_review_config_path

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

Returns a fully-qualified human_review_config string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.human_review_config_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.import_processor_version

import_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_processor_service.ImportProcessorVersionRequest,
            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.api_core.operation.Operation

Imports a processor version from source processor version.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.import_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_evaluations

list_evaluations(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.services.document_processor_service.pagers.ListEvaluationsPager
)

Retrieves a set of evaluations for a given processor version.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_evaluations

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_locations

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_operations

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_processor_types

list_processor_types(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.services.document_processor_service.pagers.ListProcessorTypesPager
)

Lists the processor types that exist.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_processor_types

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_processor_versions

list_processor_versions(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.services.document_processor_service.pagers.ListProcessorVersionsPager
)

Lists all versions of a processor.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_processor_versions

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_processors

list_processors(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.services.document_processor_service.pagers.ListProcessorsPager
)

Lists all processors which belong to this project.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.list_processors

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_billing_account_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_folder_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_location_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_organization_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_common_project_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_evaluation_path

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

Parses a evaluation path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_evaluation_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_human_review_config_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_path

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

Parses a processor path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_type_path

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

Parses a processor_type path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_type_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_version_path

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

Parses a processor_version path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.parse_processor_version_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.process_document

process_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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_v1beta3.types.document_processor_service.ProcessResponse

Processes a single document.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.process_document

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.processor_path

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

Returns a fully-qualified processor string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.processor_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.processor_type_path

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

Returns a fully-qualified processor_type string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.processor_type_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.processor_version_path

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

Returns a fully-qualified processor_version string.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.processor_version_path

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.review_document

review_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.review_document

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.set_default_processor_version

set_default_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.set_default_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.train_processor_version

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

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.train_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.undeploy_processor_version

undeploy_processor_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.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.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.DocumentProcessorServiceClient.undeploy_processor_version

google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListEvaluationsAsyncPager

ListEvaluationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1beta3.types.document_processor_service.ListEvaluationsResponse
        ],
    ],
    request: google.cloud.documentai_v1beta3.types.document_processor_service.ListEvaluationsRequest,
    response: google.cloud.documentai_v1beta3.types.document_processor_service.ListEvaluationsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListEvaluationsAsyncPager

google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListEvaluationsPager

ListEvaluationsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1beta3.types.document_processor_service.ListEvaluationsResponse,
    ],
    request: google.cloud.documentai_v1beta3.types.document_processor_service.ListEvaluationsRequest,
    response: google.cloud.documentai_v1beta3.types.document_processor_service.ListEvaluationsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListEvaluationsPager

google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorTypesAsyncPager

ListProcessorTypesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorTypesResponse
        ],
    ],
    request: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorTypesRequest,
    response: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorTypesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorTypesAsyncPager

google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorTypesPager

ListProcessorTypesPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorTypesResponse,
    ],
    request: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorTypesRequest,
    response: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorTypesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorTypesPager

google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorVersionsAsyncPager

ListProcessorVersionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorVersionsResponse
        ],
    ],
    request: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorVersionsRequest,
    response: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorVersionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorVersionsAsyncPager

google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorVersionsPager

ListProcessorVersionsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorVersionsResponse,
    ],
    request: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorVersionsRequest,
    response: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorVersionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorVersionsPager

google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorsAsyncPager

ListProcessorsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorsResponse
        ],
    ],
    request: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorsRequest,
    response: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorsAsyncPager

google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorsPager

ListProcessorsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorsResponse,
    ],
    request: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorsRequest,
    response: google.cloud.documentai_v1beta3.types.document_processor_service.ListProcessorsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1beta3.services.document_processor_service.pagers.ListProcessorsPager

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient

DocumentServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.documentai_v1beta3.services.document_service.transports.base.DocumentServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

Instantiates the document service async client.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.batch_delete_documents

batch_delete_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.BatchDeleteDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Deletes a set of documents.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.batch_delete_documents

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.cancel_operation

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_billing_account_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_folder_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_location_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_organization_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.common_project_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.dataset_path

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

Returns a fully-qualified dataset string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.dataset_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.dataset_schema_path

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

Returns a fully-qualified dataset_schema string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.dataset_schema_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.from_service_account_file

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.from_service_account_info

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.from_service_account_json

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_dataset_schema

get_dataset_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.GetDatasetSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.dataset.DatasetSchema

Gets the DatasetSchema of a Dataset.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_dataset_schema

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.document_service.GetDocumentResponse

Returns relevant fields present in the requested document.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_document

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_location

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_operation

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.documentai_v1beta3.services.document_service.transports.base.DocumentServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.get_transport_class

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.import_documents

import_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.ImportDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Import documents into a dataset.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.import_documents

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.list_documents

list_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.ListDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.services.document_service.pagers.ListDocumentsAsyncPager
)

Returns a list of documents present in the dataset.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.list_documents

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.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_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.list_locations

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.list_operations

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_billing_account_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_folder_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_location_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_organization_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_common_project_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_dataset_path

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

Parses a dataset path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_dataset_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_dataset_schema_path

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

Parses a dataset_schema path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_dataset_schema_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_schema_path

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

Parses a schema path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.parse_schema_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.schema_path

schema_path(project: str, location: str, schema: str) -> str

Returns a fully-qualified schema string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.schema_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.update_dataset

update_dataset(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.UpdateDatasetRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: typing.Optional[
        google.cloud.documentai_v1beta3.types.dataset.Dataset
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_async.AsyncOperation

Updates metadata associated with a dataset.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.update_dataset

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.update_dataset_schema

update_dataset_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.UpdateDatasetSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    dataset_schema: typing.Optional[
        google.cloud.documentai_v1beta3.types.dataset.DatasetSchema
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_v1beta3.types.dataset.DatasetSchema

Updates a DatasetSchema.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceAsyncClient.update_dataset_schema

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient

DocumentServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.documentai_v1beta3.services.document_service.transports.base.DocumentServiceTransport]] = 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 = 

Instantiates the document service client.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.exit

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.batch_delete_documents

batch_delete_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.BatchDeleteDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: 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 a set of documents.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.batch_delete_documents

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.cancel_operation

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_billing_account_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_folder_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_location_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_organization_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.common_project_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.dataset_path

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

Returns a fully-qualified dataset string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.dataset_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.dataset_schema_path

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

Returns a fully-qualified dataset_schema string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.dataset_schema_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.from_service_account_file

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

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

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.from_service_account_file

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.from_service_account_info

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

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

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.from_service_account_info

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.from_service_account_json

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

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

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.from_service_account_json

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.get_dataset_schema

get_dataset_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.GetDatasetSchemaRequest,
            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_v1beta3.types.dataset.DatasetSchema

Gets the DatasetSchema of a Dataset.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.get_dataset_schema

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: 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_v1beta3.types.document_service.GetDocumentResponse

Returns relevant fields present in the requested document.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.get_document

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.get_location

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.get_operation

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.import_documents

import_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.ImportDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: 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

Import documents into a dataset.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.import_documents

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.list_documents

list_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.ListDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: 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_v1beta3.services.document_service.pagers.ListDocumentsPager
)

Returns a list of documents present in the dataset.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.list_documents

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.list_locations

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.list_operations

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.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.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_billing_account_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_folder_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_location_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_organization_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_common_project_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_dataset_path

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

Parses a dataset path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_dataset_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_dataset_schema_path

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

Parses a dataset_schema path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_dataset_schema_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_schema_path

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

Parses a schema path into its component segments.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.parse_schema_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.schema_path

schema_path(project: str, location: str, schema: str) -> str

Returns a fully-qualified schema string.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.schema_path

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.update_dataset

update_dataset(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.UpdateDatasetRequest,
            dict,
        ]
    ] = None,
    *,
    dataset: typing.Optional[
        google.cloud.documentai_v1beta3.types.dataset.Dataset
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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

Updates metadata associated with a dataset.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.update_dataset

google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.update_dataset_schema

update_dataset_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.documentai_v1beta3.types.document_service.UpdateDatasetSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    dataset_schema: typing.Optional[
        google.cloud.documentai_v1beta3.types.dataset.DatasetSchema
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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_v1beta3.types.dataset.DatasetSchema

Updates a DatasetSchema.

See more: google.cloud.documentai_v1beta3.services.document_service.DocumentServiceClient.update_dataset_schema

google.cloud.documentai_v1beta3.services.document_service.pagers.ListDocumentsAsyncPager

ListDocumentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.documentai_v1beta3.types.document_service.ListDocumentsResponse
        ],
    ],
    request: google.cloud.documentai_v1beta3.types.document_service.ListDocumentsRequest,
    response: google.cloud.documentai_v1beta3.types.document_service.ListDocumentsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.documentai_v1beta3.services.document_service.pagers.ListDocumentsAsyncPager

google.cloud.documentai_v1beta3.services.document_service.pagers.ListDocumentsPager

ListDocumentsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1beta3.types.document_service.ListDocumentsResponse,
    ],
    request: google.cloud.documentai_v1beta3.types.document_service.ListDocumentsRequest,
    response: google.cloud.documentai_v1beta3.types.document_service.ListDocumentsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.documentai_v1beta3.services.document_service.pagers.ListDocumentsPager