Class DocumentProcessorService.DocumentProcessorServiceBase

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

Base class for server-side implementations of DocumentProcessorService

Inheritance

Object > DocumentProcessorService.DocumentProcessorServiceBase

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.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
TypeNameDescription
BatchProcessRequestrequest

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<Operation>

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 type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

Parameters
TypeNameDescription
CreateProcessorRequestrequest

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<Processor>

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

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<Operation>

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

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<Operation>

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

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<Operation>

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.

Parameters
TypeNameDescription
FetchProcessorTypesRequestrequest

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<FetchProcessorTypesResponse>

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

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<ListProcessorsResponse>

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

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<ProcessResponse>

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

The request received from the client.

ServerCallContextcontext

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

Returns
TypeDescription
Task<Operation>

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