Class DocumentProcessorServiceClientImpl

public sealed class DocumentProcessorServiceClientImpl : DocumentProcessorServiceClient

DocumentProcessorService client wrapper implementation, for convenient use.

Inheritance

Object > DocumentProcessorServiceClient > DocumentProcessorServiceClientImpl

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Remarks

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

Constructors

DocumentProcessorServiceClientImpl(DocumentProcessorService.DocumentProcessorServiceClient, DocumentProcessorServiceSettings)

public DocumentProcessorServiceClientImpl(DocumentProcessorService.DocumentProcessorServiceClient grpcClient, DocumentProcessorServiceSettings settings)

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

Parameters
TypeNameDescription
DocumentProcessorService.DocumentProcessorServiceClientgrpcClient

The underlying gRPC client.

DocumentProcessorServiceSettingssettings

The base DocumentProcessorServiceSettings used within this client.

Properties

BatchProcessDocumentsOperationsClient

public override OperationsClient BatchProcessDocumentsOperationsClient { get; }

The long-running operations client for BatchProcessDocuments.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override DocumentProcessorService.DocumentProcessorServiceClient GrpcClient { get; }

The underlying gRPC DocumentProcessorService client

Property Value
TypeDescription
DocumentProcessorService.DocumentProcessorServiceClient
Overrides

ReviewDocumentOperationsClient

public override OperationsClient ReviewDocumentOperationsClient { get; }

The long-running operations client for ReviewDocument.

Property Value
TypeDescription
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
TypeNameDescription
BatchProcessRequestrequest

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

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<BatchProcessResponse, BatchProcessMetadata>

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
TypeNameDescription
BatchProcessRequestrequest

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

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<BatchProcessResponse, BatchProcessMetadata>>

A Task containing the RPC response.

Overrides

ProcessDocument(ProcessRequest, CallSettings)

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

Processes a single document.

Parameters
TypeNameDescription
ProcessRequestrequest

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

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessResponse

The RPC response.

Overrides

ProcessDocumentAsync(ProcessRequest, CallSettings)

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

Processes a single document.

Parameters
TypeNameDescription
ProcessRequestrequest

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

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ProcessResponse>

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
TypeNameDescription
ReviewDocumentRequestrequest

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

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>

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
TypeNameDescription
ReviewDocumentRequestrequest

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

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>>

A Task containing the RPC response.

Overrides