Class DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub (2.24.0)

public static final class DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub extends AbstractFutureStub<DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub

Methods

batchProcessDocuments(BatchProcessRequest request)

public ListenableFuture<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
NameDescription
requestBatchProcessRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

build(Channel channel, CallOptions callOptions)

protected DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createProcessor(CreateProcessorRequest request)

public ListenableFuture<Processor> createProcessor(CreateProcessorRequest request)

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

Parameter
NameDescription
requestCreateProcessorRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Processor>

deleteProcessor(DeleteProcessorRequest request)

public ListenableFuture<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
NameDescription
requestDeleteProcessorRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteProcessorVersion(DeleteProcessorVersionRequest request)

public ListenableFuture<Operation> deleteProcessorVersion(DeleteProcessorVersionRequest request)

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

Parameter
NameDescription
requestDeleteProcessorVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deployProcessorVersion(DeployProcessorVersionRequest request)

public ListenableFuture<Operation> deployProcessorVersion(DeployProcessorVersionRequest request)

Deploys the processor version.

Parameter
NameDescription
requestDeployProcessorVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

disableProcessor(DisableProcessorRequest request)

public ListenableFuture<Operation> disableProcessor(DisableProcessorRequest request)

Disables a processor

Parameter
NameDescription
requestDisableProcessorRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

enableProcessor(EnableProcessorRequest request)

public ListenableFuture<Operation> enableProcessor(EnableProcessorRequest request)

Enables a processor

Parameter
NameDescription
requestEnableProcessorRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

evaluateProcessorVersion(EvaluateProcessorVersionRequest request)

public ListenableFuture<Operation> evaluateProcessorVersion(EvaluateProcessorVersionRequest request)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameter
NameDescription
requestEvaluateProcessorVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

fetchProcessorTypes(FetchProcessorTypesRequest request)

public ListenableFuture<FetchProcessorTypesResponse> fetchProcessorTypes(FetchProcessorTypesRequest request)

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

Parameter
NameDescription
requestFetchProcessorTypesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<FetchProcessorTypesResponse>

getEvaluation(GetEvaluationRequest request)

public ListenableFuture<Evaluation> getEvaluation(GetEvaluationRequest request)

Retrieves a specific evaluation.

Parameter
NameDescription
requestGetEvaluationRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Evaluation>

getProcessor(GetProcessorRequest request)

public ListenableFuture<Processor> getProcessor(GetProcessorRequest request)

Gets a processor detail.

Parameter
NameDescription
requestGetProcessorRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Processor>

getProcessorType(GetProcessorTypeRequest request)

public ListenableFuture<ProcessorType> getProcessorType(GetProcessorTypeRequest request)

Gets a processor type detail.

Parameter
NameDescription
requestGetProcessorTypeRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ProcessorType>

getProcessorVersion(GetProcessorVersionRequest request)

public ListenableFuture<ProcessorVersion> getProcessorVersion(GetProcessorVersionRequest request)

Gets a processor version detail.

Parameter
NameDescription
requestGetProcessorVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ProcessorVersion>

importProcessorVersion(ImportProcessorVersionRequest request)

public ListenableFuture<Operation> importProcessorVersion(ImportProcessorVersionRequest request)

Imports a processor version from source processor version.

Parameter
NameDescription
requestImportProcessorVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

listEvaluations(ListEvaluationsRequest request)

public ListenableFuture<ListEvaluationsResponse> listEvaluations(ListEvaluationsRequest request)

Retrieves a set of evaluations for a given processor version.

Parameter
NameDescription
requestListEvaluationsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListEvaluationsResponse>

listProcessorTypes(ListProcessorTypesRequest request)

public ListenableFuture<ListProcessorTypesResponse> listProcessorTypes(ListProcessorTypesRequest request)

Lists the processor types that exist.

Parameter
NameDescription
requestListProcessorTypesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListProcessorTypesResponse>

listProcessorVersions(ListProcessorVersionsRequest request)

public ListenableFuture<ListProcessorVersionsResponse> listProcessorVersions(ListProcessorVersionsRequest request)

Lists all versions of a processor.

Parameter
NameDescription
requestListProcessorVersionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListProcessorVersionsResponse>

listProcessors(ListProcessorsRequest request)

public ListenableFuture<ListProcessorsResponse> listProcessors(ListProcessorsRequest request)

Lists all processors which belong to this project.

Parameter
NameDescription
requestListProcessorsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListProcessorsResponse>

processDocument(ProcessRequest request)

public ListenableFuture<ProcessResponse> processDocument(ProcessRequest request)

Processes a single document.

Parameter
NameDescription
requestProcessRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ProcessResponse>

reviewDocument(ReviewDocumentRequest request)

public ListenableFuture<Operation> reviewDocument(ReviewDocumentRequest request)

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

Parameter
NameDescription
requestReviewDocumentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request)

public ListenableFuture<Operation> setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request)

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

Parameter
NameDescription
requestSetDefaultProcessorVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

trainProcessorVersion(TrainProcessorVersionRequest request)

public ListenableFuture<Operation> trainProcessorVersion(TrainProcessorVersionRequest request)

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

Parameter
NameDescription
requestTrainProcessorVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

undeployProcessorVersion(UndeployProcessorVersionRequest request)

public ListenableFuture<Operation> undeployProcessorVersion(UndeployProcessorVersionRequest request)

Undeploys the processor version.

Parameter
NameDescription
requestUndeployProcessorVersionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>