public sealed class DocumentProcessorServiceClientImpl : DocumentProcessorServiceClientDocumentProcessorService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.DocumentAI.V1Assembly
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, 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 |
DocumentProcessorService.DocumentProcessorServiceClientThe underlying gRPC client. |
settings |
DocumentProcessorServiceSettingsThe base DocumentProcessorServiceSettings used within this client. |
logger |
ILoggerOptional 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 |
|
GrpcClient
public override DocumentProcessorService.DocumentProcessorServiceClient GrpcClient { get; }The underlying gRPC DocumentProcessorService client
| Property Value | |
|---|---|
| Type | Description |
DocumentProcessorService.DocumentProcessorServiceClient |
|
ReviewDocumentOperationsClient
public override OperationsClient ReviewDocumentOperationsClient { get; }The long-running operations client for ReviewDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
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 |
BatchProcessRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<BatchProcessResponse, BatchProcessMetadata> |
The RPC response. |
BatchProcessDocumentsAsync(BatchProcessRequest, CallSettings)
public override async 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 |
BatchProcessRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<BatchProcessResponse, BatchProcessMetadata>> |
A Task containing the RPC response. |
ProcessDocument(ProcessRequest, CallSettings)
public override ProcessResponse ProcessDocument(ProcessRequest request, CallSettings callSettings = null)Processes a single document.
| Parameters | |
|---|---|
| Name | Description |
request |
ProcessRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ProcessResponse |
The RPC response. |
ProcessDocumentAsync(ProcessRequest, CallSettings)
public override Task<ProcessResponse> ProcessDocumentAsync(ProcessRequest request, CallSettings callSettings = null)Processes a single document.
| Parameters | |
|---|---|
| Name | Description |
request |
ProcessRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ProcessResponse> |
A Task containing the RPC response. |
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 |
ReviewDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> |
The RPC response. |
ReviewDocumentAsync(ReviewDocumentRequest, CallSettings)
public override async 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 |
ReviewDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> |
A Task containing the RPC response. |