Class DocumentProcessorServiceGrpc.DocumentProcessorServiceBlockingStub (2.49.0)

public static final class DocumentProcessorServiceGrpc.DocumentProcessorServiceBlockingStub extends AbstractBlockingStub<DocumentProcessorServiceGrpc.DocumentProcessorServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service DocumentProcessorService.

Service to call Document AI 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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DocumentProcessorServiceGrpc.DocumentProcessorServiceBlockingStub

Methods

batchProcessDocuments(BatchProcessRequest request)

public Operation batchProcessDocuments(BatchProcessRequest request)

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Parameter
Name Description
request BatchProcessRequest
Returns
Type Description
Operation

build(Channel channel, CallOptions callOptions)

protected DocumentProcessorServiceGrpc.DocumentProcessorServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DocumentProcessorServiceGrpc.DocumentProcessorServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createProcessor(CreateProcessorRequest request)

public Processor createProcessor(CreateProcessorRequest request)

Creates a processor from the ProcessorType provided. The processor will be at ENABLED state by default after its creation.

Parameter
Name Description
request CreateProcessorRequest
Returns
Type Description
Processor

deleteProcessor(DeleteProcessorRequest request)

public Operation deleteProcessor(DeleteProcessorRequest request)

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

Parameter
Name Description
request DeleteProcessorRequest
Returns
Type Description
Operation

deleteProcessorVersion(DeleteProcessorVersionRequest request)

public Operation deleteProcessorVersion(DeleteProcessorVersionRequest request)

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

Parameter
Name Description
request DeleteProcessorVersionRequest
Returns
Type Description
Operation

deployProcessorVersion(DeployProcessorVersionRequest request)

public Operation deployProcessorVersion(DeployProcessorVersionRequest request)

Deploys the processor version.

Parameter
Name Description
request DeployProcessorVersionRequest
Returns
Type Description
Operation

disableProcessor(DisableProcessorRequest request)

public Operation disableProcessor(DisableProcessorRequest request)

Disables a processor

Parameter
Name Description
request DisableProcessorRequest
Returns
Type Description
Operation

enableProcessor(EnableProcessorRequest request)

public Operation enableProcessor(EnableProcessorRequest request)

Enables a processor

Parameter
Name Description
request EnableProcessorRequest
Returns
Type Description
Operation

evaluateProcessorVersion(EvaluateProcessorVersionRequest request)

public Operation evaluateProcessorVersion(EvaluateProcessorVersionRequest request)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameter
Name Description
request EvaluateProcessorVersionRequest
Returns
Type Description
Operation

fetchProcessorTypes(FetchProcessorTypesRequest request)

public FetchProcessorTypesResponse fetchProcessorTypes(FetchProcessorTypesRequest request)

Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.

Parameter
Name Description
request FetchProcessorTypesRequest
Returns
Type Description
FetchProcessorTypesResponse

getEvaluation(GetEvaluationRequest request)

public Evaluation getEvaluation(GetEvaluationRequest request)

Retrieves a specific evaluation.

Parameter
Name Description
request GetEvaluationRequest
Returns
Type Description
Evaluation

getProcessor(GetProcessorRequest request)

public Processor getProcessor(GetProcessorRequest request)

Gets a processor detail.

Parameter
Name Description
request GetProcessorRequest
Returns
Type Description
Processor

getProcessorType(GetProcessorTypeRequest request)

public ProcessorType getProcessorType(GetProcessorTypeRequest request)

Gets a processor type detail.

Parameter
Name Description
request GetProcessorTypeRequest
Returns
Type Description
ProcessorType

getProcessorVersion(GetProcessorVersionRequest request)

public ProcessorVersion getProcessorVersion(GetProcessorVersionRequest request)

Gets a processor version detail.

Parameter
Name Description
request GetProcessorVersionRequest
Returns
Type Description
ProcessorVersion

listEvaluations(ListEvaluationsRequest request)

public ListEvaluationsResponse listEvaluations(ListEvaluationsRequest request)

Retrieves a set of evaluations for a given processor version.

Parameter
Name Description
request ListEvaluationsRequest
Returns
Type Description
ListEvaluationsResponse

listProcessorTypes(ListProcessorTypesRequest request)

public ListProcessorTypesResponse listProcessorTypes(ListProcessorTypesRequest request)

Lists the processor types that exist.

Parameter
Name Description
request ListProcessorTypesRequest
Returns
Type Description
ListProcessorTypesResponse

listProcessorVersions(ListProcessorVersionsRequest request)

public ListProcessorVersionsResponse listProcessorVersions(ListProcessorVersionsRequest request)

Lists all versions of a processor.

Parameter
Name Description
request ListProcessorVersionsRequest
Returns
Type Description
ListProcessorVersionsResponse

listProcessors(ListProcessorsRequest request)

public ListProcessorsResponse listProcessors(ListProcessorsRequest request)

Lists all processors which belong to this project.

Parameter
Name Description
request ListProcessorsRequest
Returns
Type Description
ListProcessorsResponse

processDocument(ProcessRequest request)

public ProcessResponse processDocument(ProcessRequest request)

Processes a single document.

Parameter
Name Description
request ProcessRequest
Returns
Type Description
ProcessResponse

reviewDocument(ReviewDocumentRequest request)

public Operation reviewDocument(ReviewDocumentRequest request)

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

Parameter
Name Description
request ReviewDocumentRequest
Returns
Type Description
Operation

setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request)

public Operation setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request)

Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.

Parameter
Name Description
request SetDefaultProcessorVersionRequest
Returns
Type Description
Operation

trainProcessorVersion(TrainProcessorVersionRequest request)

public Operation trainProcessorVersion(TrainProcessorVersionRequest request)

Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.

Parameter
Name Description
request TrainProcessorVersionRequest
Returns
Type Description
Operation

undeployProcessorVersion(UndeployProcessorVersionRequest request)

public Operation undeployProcessorVersion(UndeployProcessorVersionRequest request)

Undeploys the processor version.

Parameter
Name Description
request UndeployProcessorVersionRequest
Returns
Type Description
Operation