Cloud Document AI v1beta3 API - Class DocumentProcessorServiceClientImpl (2.0.0-beta22) 

public sealed class DocumentProcessorServiceClientImpl : DocumentProcessorServiceClient

Reference documentation and code samples for the Cloud Document AI v1beta3 API class DocumentProcessorServiceClientImpl.

DocumentProcessorService client wrapper implementation, for convenient use.

Inheritance

object > DocumentProcessorServiceClient > DocumentProcessorServiceClientImpl

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Remarks

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

Constructors

DocumentProcessorServiceClientImpl(DocumentProcessorServiceClient, DocumentProcessorServiceSettings, ILogger)

public DocumentProcessorServiceClientImpl(DocumentProcessorService.DocumentProcessorServiceClient grpcClient, DocumentProcessorServiceSettings settings, ILogger logger)

Constructs a client wrapper for the DocumentProcessorService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient DocumentProcessorServiceDocumentProcessorServiceClient

The underlying gRPC client.
settings DocumentProcessorServiceSettings

The base DocumentProcessorServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

BatchProcessDocumentsOperationsClient

public override OperationsClient BatchProcessDocumentsOperationsClient { get; }

The long-running operations client for BatchProcessDocuments.

Property Value
Type Description
OperationsClient
Overrides

DeleteProcessorOperationsClient

public override OperationsClient DeleteProcessorOperationsClient { get; }

The long-running operations client for DeleteProcessor.

Property Value
Type Description
OperationsClient
Overrides

DeleteProcessorVersionOperationsClient

public override OperationsClient DeleteProcessorVersionOperationsClient { get; }

The long-running operations client for DeleteProcessorVersion.

Property Value
Type Description
OperationsClient
Overrides

DeployProcessorVersionOperationsClient

public override OperationsClient DeployProcessorVersionOperationsClient { get; }

The long-running operations client for DeployProcessorVersion.

Property Value
Type Description
OperationsClient
Overrides

DisableProcessorOperationsClient

public override OperationsClient DisableProcessorOperationsClient { get; }

The long-running operations client for DisableProcessor.

Property Value
Type Description
OperationsClient
Overrides

EnableProcessorOperationsClient

public override OperationsClient EnableProcessorOperationsClient { get; }

The long-running operations client for EnableProcessor.

Property Value
Type Description
OperationsClient
Overrides

EvaluateProcessorVersionOperationsClient

public override OperationsClient EvaluateProcessorVersionOperationsClient { get; }

The long-running operations client for EvaluateProcessorVersion.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override DocumentProcessorService.DocumentProcessorServiceClient GrpcClient { get; }

The underlying gRPC DocumentProcessorService client

Property Value
Type Description
DocumentProcessorServiceDocumentProcessorServiceClient
Overrides

ImportProcessorVersionOperationsClient

public override OperationsClient ImportProcessorVersionOperationsClient { get; }

The long-running operations client for ImportProcessorVersion.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

ReviewDocumentOperationsClient

public override OperationsClient ReviewDocumentOperationsClient { get; }

The long-running operations client for ReviewDocument.

Property Value
Type Description
OperationsClient
Overrides

SetDefaultProcessorVersionOperationsClient

public override OperationsClient SetDefaultProcessorVersionOperationsClient { get; }

The long-running operations client for SetDefaultProcessorVersion.

Property Value
Type Description
OperationsClient
Overrides

TrainProcessorVersionOperationsClient

public override OperationsClient TrainProcessorVersionOperationsClient { get; }

The long-running operations client for TrainProcessorVersion.

Property Value
Type Description
OperationsClient
Overrides

UndeployProcessorVersionOperationsClient

public override OperationsClient UndeployProcessorVersionOperationsClient { get; }

The long-running operations client for UndeployProcessorVersion.

Property Value
Type Description
OperationsClient
Overrides

Methods

BatchProcessDocuments(BatchProcessRequest, CallSettings)

public override Operation<BatchProcessResponse, BatchProcessMetadata> BatchProcessDocuments(BatchProcessRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request BatchProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchProcessResponseBatchProcessMetadata

The RPC response.
Overrides

BatchProcessDocumentsAsync(BatchProcessRequest, CallSettings)

public override Task<Operation<BatchProcessResponse, BatchProcessMetadata>> BatchProcessDocumentsAsync(BatchProcessRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request BatchProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchProcessResponseBatchProcessMetadata

A Task containing the RPC response.
Overrides

CreateProcessor(CreateProcessorRequest, CallSettings)

public override Processor CreateProcessor(CreateProcessorRequest request, CallSettings callSettings = null)

Creates a processor from the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided. The processor will be at ENABLED state by default after its creation. Note that this method requires the documentai.processors.create permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

Parameters
Name Description
request CreateProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Processor

The RPC response.
Overrides

CreateProcessorAsync(CreateProcessorRequest, CallSettings)

public override Task<Processor> CreateProcessorAsync(CreateProcessorRequest request, CallSettings callSettings = null)

Creates a processor from the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided. The processor will be at ENABLED state by default after its creation. Note that this method requires the documentai.processors.create permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

Parameters
Name Description
request CreateProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcessor

A Task containing the RPC response.
Overrides

DeleteProcessor(DeleteProcessorRequest, CallSettings)

public override Operation<Empty, DeleteProcessorMetadata> DeleteProcessor(DeleteProcessorRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteProcessorMetadata

The RPC response.
Overrides

DeleteProcessorAsync(DeleteProcessorRequest, CallSettings)

public override Task<Operation<Empty, DeleteProcessorMetadata>> DeleteProcessorAsync(DeleteProcessorRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteProcessorMetadata

A Task containing the RPC response.
Overrides

DeleteProcessorVersion(DeleteProcessorVersionRequest, CallSettings)

public override Operation<Empty, DeleteProcessorVersionMetadata> DeleteProcessorVersion(DeleteProcessorVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteProcessorVersionMetadata

The RPC response.
Overrides

DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, CallSettings)

public override Task<Operation<Empty, DeleteProcessorVersionMetadata>> DeleteProcessorVersionAsync(DeleteProcessorVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteProcessorVersionMetadata

A Task containing the RPC response.
Overrides

DeployProcessorVersion(DeployProcessorVersionRequest, CallSettings)

public override Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> DeployProcessorVersion(DeployProcessorVersionRequest request, CallSettings callSettings = null)

Deploys the processor version.

Parameters
Name Description
request DeployProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

The RPC response.
Overrides

DeployProcessorVersionAsync(DeployProcessorVersionRequest, CallSettings)

public override Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> DeployProcessorVersionAsync(DeployProcessorVersionRequest request, CallSettings callSettings = null)

Deploys the processor version.

Parameters
Name Description
request DeployProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

A Task containing the RPC response.
Overrides

DisableProcessor(DisableProcessorRequest, CallSettings)

public override Operation<DisableProcessorResponse, DisableProcessorMetadata> DisableProcessor(DisableProcessorRequest request, CallSettings callSettings = null)

Disables a processor

Parameters
Name Description
request DisableProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDisableProcessorResponseDisableProcessorMetadata

The RPC response.
Overrides

DisableProcessorAsync(DisableProcessorRequest, CallSettings)

public override Task<Operation<DisableProcessorResponse, DisableProcessorMetadata>> DisableProcessorAsync(DisableProcessorRequest request, CallSettings callSettings = null)

Disables a processor

Parameters
Name Description
request DisableProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDisableProcessorResponseDisableProcessorMetadata

A Task containing the RPC response.
Overrides

EnableProcessor(EnableProcessorRequest, CallSettings)

public override Operation<EnableProcessorResponse, EnableProcessorMetadata> EnableProcessor(EnableProcessorRequest request, CallSettings callSettings = null)

Enables a processor

Parameters
Name Description
request EnableProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEnableProcessorResponseEnableProcessorMetadata

The RPC response.
Overrides

EnableProcessorAsync(EnableProcessorRequest, CallSettings)

public override Task<Operation<EnableProcessorResponse, EnableProcessorMetadata>> EnableProcessorAsync(EnableProcessorRequest request, CallSettings callSettings = null)

Enables a processor

Parameters
Name Description
request EnableProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEnableProcessorResponseEnableProcessorMetadata

A Task containing the RPC response.
Overrides

EvaluateProcessorVersion(EvaluateProcessorVersionRequest, CallSettings)

public override Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> EvaluateProcessorVersion(EvaluateProcessorVersionRequest request, CallSettings callSettings = null)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
Name Description
request EvaluateProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

The RPC response.
Overrides

EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest, CallSettings)

public override Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest request, CallSettings callSettings = null)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
Name Description
request EvaluateProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

A Task containing the RPC response.
Overrides

FetchProcessorTypes(FetchProcessorTypesRequest, CallSettings)

public override FetchProcessorTypesResponse FetchProcessorTypes(FetchProcessorTypesRequest request, CallSettings callSettings = null)

Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] here, because it isn't paginated.

Parameters
Name Description
request FetchProcessorTypesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FetchProcessorTypesResponse

The RPC response.
Overrides

FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallSettings)

public override Task<FetchProcessorTypesResponse> FetchProcessorTypesAsync(FetchProcessorTypesRequest request, CallSettings callSettings = null)

Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] here, because it isn't paginated.

Parameters
Name Description
request FetchProcessorTypesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFetchProcessorTypesResponse

A Task containing the RPC response.
Overrides

GetEvaluation(GetEvaluationRequest, CallSettings)

public override Evaluation GetEvaluation(GetEvaluationRequest request, CallSettings callSettings = null)

Retrieves a specific evaluation.

Parameters
Name Description
request GetEvaluationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Evaluation

The RPC response.
Overrides

GetEvaluationAsync(GetEvaluationRequest, CallSettings)

public override Task<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CallSettings callSettings = null)

Retrieves a specific evaluation.

Parameters
Name Description
request GetEvaluationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEvaluation

A Task containing the RPC response.
Overrides

GetProcessor(GetProcessorRequest, CallSettings)

public override Processor GetProcessor(GetProcessorRequest request, CallSettings callSettings = null)

Gets a processor detail.

Parameters
Name Description
request GetProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Processor

The RPC response.
Overrides

GetProcessorAsync(GetProcessorRequest, CallSettings)

public override Task<Processor> GetProcessorAsync(GetProcessorRequest request, CallSettings callSettings = null)

Gets a processor detail.

Parameters
Name Description
request GetProcessorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcessor

A Task containing the RPC response.
Overrides

GetProcessorType(GetProcessorTypeRequest, CallSettings)

public override ProcessorType GetProcessorType(GetProcessorTypeRequest request, CallSettings callSettings = null)

Gets a processor type detail.

Parameters
Name Description
request GetProcessorTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ProcessorType

The RPC response.
Overrides

GetProcessorTypeAsync(GetProcessorTypeRequest, CallSettings)

public override Task<ProcessorType> GetProcessorTypeAsync(GetProcessorTypeRequest request, CallSettings callSettings = null)

Gets a processor type detail.

Parameters
Name Description
request GetProcessorTypeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcessorType

A Task containing the RPC response.
Overrides

GetProcessorVersion(GetProcessorVersionRequest, CallSettings)

public override ProcessorVersion GetProcessorVersion(GetProcessorVersionRequest request, CallSettings callSettings = null)

Gets a processor version detail.

Parameters
Name Description
request GetProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ProcessorVersion

The RPC response.
Overrides

GetProcessorVersionAsync(GetProcessorVersionRequest, CallSettings)

public override Task<ProcessorVersion> GetProcessorVersionAsync(GetProcessorVersionRequest request, CallSettings callSettings = null)

Gets a processor version detail.

Parameters
Name Description
request GetProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcessorVersion

A Task containing the RPC response.
Overrides

ImportProcessorVersion(ImportProcessorVersionRequest, CallSettings)

public override Operation<ImportProcessorVersionResponse, ImportProcessorVersionMetadata> ImportProcessorVersion(ImportProcessorVersionRequest request, CallSettings callSettings = null)

Imports a processor version from source processor version.

Parameters
Name Description
request ImportProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationImportProcessorVersionResponseImportProcessorVersionMetadata

The RPC response.
Overrides

ImportProcessorVersionAsync(ImportProcessorVersionRequest, CallSettings)

public override Task<Operation<ImportProcessorVersionResponse, ImportProcessorVersionMetadata>> ImportProcessorVersionAsync(ImportProcessorVersionRequest request, CallSettings callSettings = null)

Imports a processor version from source processor version.

Parameters
Name Description
request ImportProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationImportProcessorVersionResponseImportProcessorVersionMetadata

A Task containing the RPC response.
Overrides

ListEvaluations(ListEvaluationsRequest, CallSettings)

public override PagedEnumerable<ListEvaluationsResponse, Evaluation> ListEvaluations(ListEvaluationsRequest request, CallSettings callSettings = null)

Retrieves a set of evaluations for a given processor version.

Parameters
Name Description
request ListEvaluationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListEvaluationsResponseEvaluation

A pageable sequence of Evaluation resources.
Overrides

ListEvaluationsAsync(ListEvaluationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEvaluationsResponse, Evaluation> ListEvaluationsAsync(ListEvaluationsRequest request, CallSettings callSettings = null)

Retrieves a set of evaluations for a given processor version.

Parameters
Name Description
request ListEvaluationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListEvaluationsResponseEvaluation

A pageable asynchronous sequence of Evaluation resources.
Overrides

ListProcessorTypes(ListProcessorTypesRequest, CallSettings)

public override PagedEnumerable<ListProcessorTypesResponse, ProcessorType> ListProcessorTypes(ListProcessorTypesRequest request, CallSettings callSettings = null)

Lists the processor types that exist.

Parameters
Name Description
request ListProcessorTypesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListProcessorTypesResponseProcessorType

A pageable sequence of ProcessorType resources.
Overrides

ListProcessorTypesAsync(ListProcessorTypesRequest, CallSettings)

public override PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType> ListProcessorTypesAsync(ListProcessorTypesRequest request, CallSettings callSettings = null)

Lists the processor types that exist.

Parameters
Name Description
request ListProcessorTypesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListProcessorTypesResponseProcessorType

A pageable asynchronous sequence of ProcessorType resources.
Overrides

ListProcessorVersions(ListProcessorVersionsRequest, CallSettings)

public override PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion> ListProcessorVersions(ListProcessorVersionsRequest request, CallSettings callSettings = null)

Lists all versions of a processor.

Parameters
Name Description
request ListProcessorVersionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListProcessorVersionsResponseProcessorVersion

A pageable sequence of ProcessorVersion resources.
Overrides

ListProcessorVersionsAsync(ListProcessorVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion> ListProcessorVersionsAsync(ListProcessorVersionsRequest request, CallSettings callSettings = null)

Lists all versions of a processor.

Parameters
Name Description
request ListProcessorVersionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListProcessorVersionsResponseProcessorVersion

A pageable asynchronous sequence of ProcessorVersion resources.
Overrides

ListProcessors(ListProcessorsRequest, CallSettings)

public override PagedEnumerable<ListProcessorsResponse, Processor> ListProcessors(ListProcessorsRequest request, CallSettings callSettings = null)

Lists all processors which belong to this project.

Parameters
Name Description
request ListProcessorsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListProcessorsResponseProcessor

A pageable sequence of Processor resources.
Overrides

ListProcessorsAsync(ListProcessorsRequest, CallSettings)

public override PagedAsyncEnumerable<ListProcessorsResponse, Processor> ListProcessorsAsync(ListProcessorsRequest request, CallSettings callSettings = null)

Lists all processors which belong to this project.

Parameters
Name Description
request ListProcessorsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListProcessorsResponseProcessor

A pageable asynchronous sequence of Processor resources.
Overrides

ProcessDocument(ProcessRequest, CallSettings)

public override ProcessResponse ProcessDocument(ProcessRequest request, CallSettings callSettings = null)

Processes a single document.

Parameters
Name Description
request ProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ProcessResponse

The RPC response.
Overrides

ProcessDocumentAsync(ProcessRequest, CallSettings)

public override Task<ProcessResponse> ProcessDocumentAsync(ProcessRequest request, CallSettings callSettings = null)

Processes a single document.

Parameters
Name Description
request ProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcessResponse

A Task containing the RPC response.
Overrides

ReviewDocument(ReviewDocumentRequest, CallSettings)

public override Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> ReviewDocument(ReviewDocumentRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ReviewDocumentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationReviewDocumentResponseReviewDocumentOperationMetadata

The RPC response.
Overrides

ReviewDocumentAsync(ReviewDocumentRequest, CallSettings)

public override Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> ReviewDocumentAsync(ReviewDocumentRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ReviewDocumentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationReviewDocumentResponseReviewDocumentOperationMetadata

A Task containing the RPC response.
Overrides

SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, CallSettings)

public override Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata> SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest request, CallSettings callSettings = null)

Set the default (active) version of a [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

Parameters
Name Description
request SetDefaultProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationSetDefaultProcessorVersionResponseSetDefaultProcessorVersionMetadata

The RPC response.
Overrides

SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, CallSettings)

public override Task<Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>> SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest request, CallSettings callSettings = null)

Set the default (active) version of a [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

Parameters
Name Description
request SetDefaultProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationSetDefaultProcessorVersionResponseSetDefaultProcessorVersionMetadata

A Task containing the RPC response.
Overrides

TrainProcessorVersion(TrainProcessorVersionRequest, CallSettings)

public override Operation<TrainProcessorVersionResponse, TrainProcessorVersionMetadata> TrainProcessorVersion(TrainProcessorVersionRequest request, CallSettings callSettings = null)

Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].

Parameters
Name Description
request TrainProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationTrainProcessorVersionResponseTrainProcessorVersionMetadata

The RPC response.
Overrides

TrainProcessorVersionAsync(TrainProcessorVersionRequest, CallSettings)

public override Task<Operation<TrainProcessorVersionResponse, TrainProcessorVersionMetadata>> TrainProcessorVersionAsync(TrainProcessorVersionRequest request, CallSettings callSettings = null)

Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].

Parameters
Name Description
request TrainProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationTrainProcessorVersionResponseTrainProcessorVersionMetadata

A Task containing the RPC response.
Overrides

UndeployProcessorVersion(UndeployProcessorVersionRequest, CallSettings)

public override Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata> UndeployProcessorVersion(UndeployProcessorVersionRequest request, CallSettings callSettings = null)

Undeploys the processor version.

Parameters
Name Description
request UndeployProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationUndeployProcessorVersionResponseUndeployProcessorVersionMetadata

The RPC response.
Overrides

UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, CallSettings)

public override Task<Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata>> UndeployProcessorVersionAsync(UndeployProcessorVersionRequest request, CallSettings callSettings = null)

Undeploys the processor version.

Parameters
Name Description
request UndeployProcessorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationUndeployProcessorVersionResponseUndeployProcessorVersionMetadata

A Task containing the RPC response.
Overrides