public sealed class DocumentProcessorServiceClientImpl : DocumentProcessorServiceClientReference documentation and code samples for the Cloud Document AI v1 API class DocumentProcessorServiceClientImpl.
DocumentProcessorService 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 | |
DeleteProcessorOperationsClient
public override OperationsClient DeleteProcessorOperationsClient { get; }The long-running operations client for DeleteProcessor.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteProcessorVersionOperationsClient
public override OperationsClient DeleteProcessorVersionOperationsClient { get; }The long-running operations client for DeleteProcessorVersion.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeployProcessorVersionOperationsClient
public override OperationsClient DeployProcessorVersionOperationsClient { get; }The long-running operations client for DeployProcessorVersion.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DisableProcessorOperationsClient
public override OperationsClient DisableProcessorOperationsClient { get; }The long-running operations client for DisableProcessor.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
EnableProcessorOperationsClient
public override OperationsClient EnableProcessorOperationsClient { get; }The long-running operations client for EnableProcessor.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
EvaluateProcessorVersionOperationsClient
public override OperationsClient EvaluateProcessorVersionOperationsClient { get; }The long-running operations client for EvaluateProcessorVersion.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override DocumentProcessorService.DocumentProcessorServiceClient GrpcClient { get; }The underlying gRPC DocumentProcessorService client
| Property Value | |
|---|---|
| Type | Description |
DocumentProcessorService.DocumentProcessorServiceClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
ReviewDocumentOperationsClient
public override OperationsClient ReviewDocumentOperationsClient { get; }The long-running operations client for ReviewDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetDefaultProcessorVersionOperationsClient
public override OperationsClient SetDefaultProcessorVersionOperationsClient { get; }The long-running operations client for SetDefaultProcessorVersion.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
TrainProcessorVersionOperationsClient
public override OperationsClient TrainProcessorVersionOperationsClient { get; }The long-running operations client for TrainProcessorVersion.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UndeployProcessorVersionOperationsClient
public override OperationsClient UndeployProcessorVersionOperationsClient { get; }The long-running operations client for UndeployProcessorVersion.
| 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. |
CreateProcessor(CreateProcessorRequest, CallSettings)
public override Processor CreateProcessor(CreateProcessorRequest request, CallSettings callSettings = null)Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
| Parameters | |
|---|---|
| Name | Description |
request | CreateProcessorRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Processor | The RPC response. |
CreateProcessorAsync(CreateProcessorRequest, CallSettings)
public override Task<Processor> CreateProcessorAsync(CreateProcessorRequest request, CallSettings callSettings = null)Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
| Parameters | |
|---|---|
| Name | Description |
request | CreateProcessorRequestThe 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<Processor> | A Task containing the RPC response. |
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 | DeleteProcessorRequestThe 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<Empty, DeleteProcessorMetadata> | The RPC response. |
DeleteProcessorAsync(DeleteProcessorRequest, CallSettings)
public override async 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 | DeleteProcessorRequestThe 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<Empty, DeleteProcessorMetadata>> | A Task containing the RPC response. |
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 | DeleteProcessorVersionRequestThe 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<Empty, DeleteProcessorVersionMetadata> | The RPC response. |
DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, CallSettings)
public override async 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 | DeleteProcessorVersionRequestThe 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<Empty, DeleteProcessorVersionMetadata>> | A Task containing the RPC response. |
DeployProcessorVersion(DeployProcessorVersionRequest, CallSettings)
public override Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> DeployProcessorVersion(DeployProcessorVersionRequest request, CallSettings callSettings = null)Deploys the processor version.
| Parameters | |
|---|---|
| Name | Description |
request | DeployProcessorVersionRequestThe 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<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> | The RPC response. |
DeployProcessorVersionAsync(DeployProcessorVersionRequest, CallSettings)
public override async Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> DeployProcessorVersionAsync(DeployProcessorVersionRequest request, CallSettings callSettings = null)Deploys the processor version.
| Parameters | |
|---|---|
| Name | Description |
request | DeployProcessorVersionRequestThe 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<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> | A Task containing the RPC response. |
DisableProcessor(DisableProcessorRequest, CallSettings)
public override Operation<DisableProcessorResponse, DisableProcessorMetadata> DisableProcessor(DisableProcessorRequest request, CallSettings callSettings = null)Disables a processor
| Parameters | |
|---|---|
| Name | Description |
request | DisableProcessorRequestThe 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<DisableProcessorResponse, DisableProcessorMetadata> | The RPC response. |