public sealed class DocumentProcessorServiceClientImpl : DocumentProcessorServiceClient
Reference 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.DocumentProcessorServiceClient 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 |
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 | 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 |
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 | 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 |
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 | 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. |
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 | 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 |
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 | 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 |
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 | 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 |
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 | 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 |
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 | 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 |
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 | 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 |
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 | 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 |
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 | 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 |
Operation<DisableProcessorResponse, DisableProcessorMetadata> | The RPC response. |
DisableProcessorAsync(DisableProcessorRequest, CallSettings)
public override async 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 |
Task<Operation<DisableProcessorResponse, DisableProcessorMetadata>> | A Task containing the RPC response. |
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 |
Operation<EnableProcessorResponse, EnableProcessorMetadata> | The RPC response. |
EnableProcessorAsync(EnableProcessorRequest, CallSettings)
public override async 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 |
Task<Operation<EnableProcessorResponse, EnableProcessorMetadata>> | A Task containing the RPC response. |
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 |
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> | The RPC response. |
EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest, CallSettings)
public override async 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 |
Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> | A Task containing the RPC response. |
FetchProcessorTypes(FetchProcessorTypesRequest, CallSettings)
public override FetchProcessorTypesResponse FetchProcessorTypes(FetchProcessorTypesRequest request, CallSettings callSettings = null)
Fetches processor types. Note that we do not use ListProcessorTypes here because it is not 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. |
FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallSettings)
public override Task<FetchProcessorTypesResponse> FetchProcessorTypesAsync(FetchProcessorTypesRequest request, CallSettings callSettings = null)
Fetches processor types. Note that we do not use ListProcessorTypes here because it is not 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 |
Task<FetchProcessorTypesResponse> | A Task containing the RPC response. |
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. |
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 |
Task<Evaluation> | A Task containing the RPC response. |
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. |
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 |
Task<Processor> | A Task containing the RPC response. |
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. |
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 |
Task<ProcessorType> | A Task containing the RPC response. |
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. |
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 |
Task<ProcessorVersion> | A Task containing the RPC response. |
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 |
PagedEnumerable<ListEvaluationsResponse, Evaluation> | A pageable sequence of Evaluation resources. |
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 |
PagedAsyncEnumerable<ListEvaluationsResponse, Evaluation> | A pageable asynchronous sequence of Evaluation resources. |
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 |
PagedEnumerable<ListProcessorsResponse, Processor> | A pageable sequence of Processor resources. |
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 |
PagedAsyncEnumerable<ListProcessorsResponse, Processor> | A pageable asynchronous sequence of Processor resources. |
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 |
PagedEnumerable<ListProcessorTypesResponse, ProcessorType> | A pageable sequence of ProcessorType resources. |
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 |
PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType> | A pageable asynchronous sequence of ProcessorType resources. |
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 |
PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion> | A pageable sequence of ProcessorVersion resources. |
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 |
PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion> | A pageable asynchronous sequence of ProcessorVersion resources. |
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. |
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 |
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 | 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 |
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 | 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 |
Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> | A Task containing the RPC response. |
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.v1.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1.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 |
Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata> | The RPC response. |
SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, CallSettings)
public override async Task<Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>> SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest request, CallSettings callSettings = null)
Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1.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 |
Task<Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>> | A Task containing the RPC response. |
TrainProcessorVersion(TrainProcessorVersionRequest, CallSettings)
public override Operation<TrainProcessorVersionResponse, TrainProcessorVersionMetadata> TrainProcessorVersion(TrainProcessorVersionRequest request, CallSettings callSettings = null)
Trains a new processor version. Operation metadata is returned as cloud_documentai_core.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 |
Operation<TrainProcessorVersionResponse, TrainProcessorVersionMetadata> | The RPC response. |
TrainProcessorVersionAsync(TrainProcessorVersionRequest, CallSettings)
public override async Task<Operation<TrainProcessorVersionResponse, TrainProcessorVersionMetadata>> TrainProcessorVersionAsync(TrainProcessorVersionRequest request, CallSettings callSettings = null)
Trains a new processor version. Operation metadata is returned as cloud_documentai_core.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 |
Task<Operation<TrainProcessorVersionResponse, TrainProcessorVersionMetadata>> | A Task containing the RPC response. |
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 |
Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata> | The RPC response. |
UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, CallSettings)
public override async 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 |
Task<Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata>> | A Task containing the RPC response. |