Cloud Document AI v1 API - Class DocumentProcessorService.DocumentProcessorServiceBase (3.16.0)

[BindServiceMethod(typeof(DocumentProcessorService), "BindService")]
public abstract class DocumentProcessorService.DocumentProcessorServiceBase

Reference documentation and code samples for the Cloud Document AI v1 API class DocumentProcessorService.DocumentProcessorServiceBase.

Base class for server-side implementations of DocumentProcessorService

Inheritance

object > DocumentProcessorService.DocumentProcessorServiceBase

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Methods

BatchProcessDocuments(BatchProcessRequest, ServerCallContext)

public virtual Task<Operation> BatchProcessDocuments(BatchProcessRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateProcessor(CreateProcessorRequest, ServerCallContext)

public virtual Task<Processor> CreateProcessor(CreateProcessorRequest request, ServerCallContext context)

Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. The processor will be at ENABLED state by default after its creation.

Parameters
Name Description
request CreateProcessorRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskProcessor

The response to send back to the client (wrapped by a task).

DeleteProcessor(DeleteProcessorRequest, ServerCallContext)

public virtual Task<Operation> DeleteProcessor(DeleteProcessorRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteProcessorVersion(DeleteProcessorVersionRequest, ServerCallContext)

public virtual Task<Operation> DeleteProcessorVersion(DeleteProcessorVersionRequest request, ServerCallContext context)

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

Parameters
Name Description
request DeleteProcessorVersionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeployProcessorVersion(DeployProcessorVersionRequest, ServerCallContext)

public virtual Task<Operation> DeployProcessorVersion(DeployProcessorVersionRequest request, ServerCallContext context)

Deploys the processor version.

Parameters
Name Description
request DeployProcessorVersionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DisableProcessor(DisableProcessorRequest, ServerCallContext)

public virtual Task<Operation> DisableProcessor(DisableProcessorRequest request, ServerCallContext context)

Disables a processor

Parameters
Name Description
request DisableProcessorRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

EnableProcessor(EnableProcessorRequest, ServerCallContext)

public virtual Task<Operation> EnableProcessor(EnableProcessorRequest request, ServerCallContext context)

Enables a processor

Parameters
Name Description
request EnableProcessorRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

EvaluateProcessorVersion(EvaluateProcessorVersionRequest, ServerCallContext)

public virtual Task<Operation> EvaluateProcessorVersion(EvaluateProcessorVersionRequest request, ServerCallContext context)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
Name Description
request EvaluateProcessorVersionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

FetchProcessorTypes(FetchProcessorTypesRequest, ServerCallContext)

public virtual Task<FetchProcessorTypesResponse> FetchProcessorTypes(FetchProcessorTypesRequest request, ServerCallContext context)

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

Parameters
Name Description
request FetchProcessorTypesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFetchProcessorTypesResponse

The response to send back to the client (wrapped by a task).

GetEvaluation(GetEvaluationRequest, ServerCallContext)

public virtual Task<Evaluation> GetEvaluation(GetEvaluationRequest request, ServerCallContext context)

Retrieves a specific evaluation.

Parameters
Name Description
request GetEvaluationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEvaluation

The response to send back to the client (wrapped by a task).

GetProcessor(GetProcessorRequest, ServerCallContext)

public virtual Task<Processor> GetProcessor(GetProcessorRequest request, ServerCallContext context)

Gets a processor detail.

Parameters
Name Description
request GetProcessorRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskProcessor

The response to send back to the client (wrapped by a task).

GetProcessorType(GetProcessorTypeRequest, ServerCallContext)

public virtual Task<ProcessorType> GetProcessorType(GetProcessorTypeRequest request, ServerCallContext context)

Gets a processor type detail.

Parameters
Name Description
request GetProcessorTypeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskProcessorType

The response to send back to the client (wrapped by a task).

GetProcessorVersion(GetProcessorVersionRequest, ServerCallContext)

public virtual Task<ProcessorVersion> GetProcessorVersion(GetProcessorVersionRequest request, ServerCallContext context)

Gets a processor version detail.

Parameters
Name Description
request GetProcessorVersionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskProcessorVersion

The response to send back to the client (wrapped by a task).

ListEvaluations(ListEvaluationsRequest, ServerCallContext)

public virtual Task<ListEvaluationsResponse> ListEvaluations(ListEvaluationsRequest request, ServerCallContext context)

Retrieves a set of evaluations for a given processor version.

Parameters
Name Description
request ListEvaluationsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListEvaluationsResponse

The response to send back to the client (wrapped by a task).

ListProcessorTypes(ListProcessorTypesRequest, ServerCallContext)

public virtual Task<ListProcessorTypesResponse> ListProcessorTypes(ListProcessorTypesRequest request, ServerCallContext context)

Lists the processor types that exist.

Parameters
Name Description
request ListProcessorTypesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListProcessorTypesResponse

The response to send back to the client (wrapped by a task).

ListProcessorVersions(ListProcessorVersionsRequest, ServerCallContext)

public virtual Task<ListProcessorVersionsResponse> ListProcessorVersions(ListProcessorVersionsRequest request, ServerCallContext context)

Lists all versions of a processor.

Parameters
Name Description
request ListProcessorVersionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListProcessorVersionsResponse

The response to send back to the client (wrapped by a task).

ListProcessors(ListProcessorsRequest, ServerCallContext)

public virtual Task<ListProcessorsResponse> ListProcessors(ListProcessorsRequest request, ServerCallContext context)

Lists all processors which belong to this project.

Parameters
Name Description
request ListProcessorsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListProcessorsResponse

The response to send back to the client (wrapped by a task).

ProcessDocument(ProcessRequest, ServerCallContext)

public virtual Task<ProcessResponse> ProcessDocument(ProcessRequest request, ServerCallContext context)

Processes a single document.

Parameters
Name Description
request ProcessRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskProcessResponse

The response to send back to the client (wrapped by a task).

ReviewDocument(ReviewDocumentRequest, ServerCallContext)

public virtual Task<Operation> ReviewDocument(ReviewDocumentRequest request, ServerCallContext context)

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

Parameters
Name Description
request ReviewDocumentRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, ServerCallContext)

public virtual Task<Operation> SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

TrainProcessorVersion(TrainProcessorVersionRequest, ServerCallContext)

public virtual Task<Operation> TrainProcessorVersion(TrainProcessorVersionRequest request, ServerCallContext context)

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

Parameters
Name Description
request TrainProcessorVersionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UndeployProcessorVersion(UndeployProcessorVersionRequest, ServerCallContext)

public virtual Task<Operation> UndeployProcessorVersion(UndeployProcessorVersionRequest request, ServerCallContext context)

Undeploys the processor version.

Parameters
Name Description
request UndeployProcessorVersionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).