Class DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub
- java.lang.Object
-
- io.grpc.stub.AbstractStub<S>
-
- io.grpc.stub.AbstractFutureStub<DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub>
-
- com.google.cloud.documentai.v1beta3.DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub
-
- Enclosing class:
- DocumentProcessorServiceGrpc
public static final class DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub extends io.grpc.stub.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.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
batchProcessDocuments(BatchProcessRequest request)
LRO endpoint to batch process many documents.protected DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub
build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Processor>
createProcessor(CreateProcessorRequest request)
Creates a processor from the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided.com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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.com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
deleteProcessorVersion(DeleteProcessorVersionRequest request)
Deletes the processor version, all artifacts under the processor version will be deleted.com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
deployProcessorVersion(DeployProcessorVersionRequest request)
Deploys the processor version.com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
disableProcessor(DisableProcessorRequest request)
Disables a processorcom.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
enableProcessor(EnableProcessorRequest request)
Enables a processorcom.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
evaluateProcessorVersion(EvaluateProcessorVersionRequest request)
Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.com.google.common.util.concurrent.ListenableFuture<FetchProcessorTypesResponse>
fetchProcessorTypes(FetchProcessorTypesRequest request)
Fetches processor types.com.google.common.util.concurrent.ListenableFuture<Evaluation>
getEvaluation(GetEvaluationRequest request)
Retrieves a specific evaluation.com.google.common.util.concurrent.ListenableFuture<Processor>
getProcessor(GetProcessorRequest request)
Gets a processor detail.com.google.common.util.concurrent.ListenableFuture<ProcessorType>
getProcessorType(GetProcessorTypeRequest request)
Gets a processor type detail.com.google.common.util.concurrent.ListenableFuture<ProcessorVersion>
getProcessorVersion(GetProcessorVersionRequest request)
Gets a processor version detail.com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
importProcessorVersion(ImportProcessorVersionRequest request)
Imports a processor version from source processor version.com.google.common.util.concurrent.ListenableFuture<ListEvaluationsResponse>
listEvaluations(ListEvaluationsRequest request)
Retrieves a set of evaluations for a given processor version.com.google.common.util.concurrent.ListenableFuture<ListProcessorsResponse>
listProcessors(ListProcessorsRequest request)
Lists all processors which belong to this project.com.google.common.util.concurrent.ListenableFuture<ListProcessorTypesResponse>
listProcessorTypes(ListProcessorTypesRequest request)
Lists the processor types that exist.com.google.common.util.concurrent.ListenableFuture<ListProcessorVersionsResponse>
listProcessorVersions(ListProcessorVersionsRequest request)
Lists all versions of a processor.com.google.common.util.concurrent.ListenableFuture<ProcessResponse>
processDocument(ProcessRequest request)
Processes a single document.com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
reviewDocument(ReviewDocumentRequest request)
Send a document for Human Review.com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request)
Set the default (active) version of a [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
trainProcessorVersion(TrainProcessorVersionRequest request)
Trains a new processor version.com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
undeployProcessorVersion(UndeployProcessorVersionRequest request)
Undeploys the processor version.
-
-
-
Method Detail
-
build
protected DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
- Specified by:
build
in classio.grpc.stub.AbstractStub<DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub>
-
processDocument
public com.google.common.util.concurrent.ListenableFuture<ProcessResponse> processDocument(ProcessRequest request)
Processes a single document.
-
batchProcessDocuments
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> batchProcessDocuments(BatchProcessRequest request)
LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
-
fetchProcessorTypes
public com.google.common.util.concurrent.ListenableFuture<FetchProcessorTypesResponse> fetchProcessorTypes(FetchProcessorTypesRequest request)
Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] here, because it isn't paginated.
-
listProcessorTypes
public com.google.common.util.concurrent.ListenableFuture<ListProcessorTypesResponse> listProcessorTypes(ListProcessorTypesRequest request)
Lists the processor types that exist.
-
getProcessorType
public com.google.common.util.concurrent.ListenableFuture<ProcessorType> getProcessorType(GetProcessorTypeRequest request)
Gets a processor type detail.
-
listProcessors
public com.google.common.util.concurrent.ListenableFuture<ListProcessorsResponse> listProcessors(ListProcessorsRequest request)
Lists all processors which belong to this project.
-
getProcessor
public com.google.common.util.concurrent.ListenableFuture<Processor> getProcessor(GetProcessorRequest request)
Gets a processor detail.
-
trainProcessorVersion
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> trainProcessorVersion(TrainProcessorVersionRequest request)
Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].
-
getProcessorVersion
public com.google.common.util.concurrent.ListenableFuture<ProcessorVersion> getProcessorVersion(GetProcessorVersionRequest request)
Gets a processor version detail.
-
listProcessorVersions
public com.google.common.util.concurrent.ListenableFuture<ListProcessorVersionsResponse> listProcessorVersions(ListProcessorVersionsRequest request)
Lists all versions of a processor.
-
deleteProcessorVersion
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteProcessorVersion(DeleteProcessorVersionRequest request)
Deletes the processor version, all artifacts under the processor version will be deleted.
-
deployProcessorVersion
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deployProcessorVersion(DeployProcessorVersionRequest request)
Deploys the processor version.
-
undeployProcessorVersion
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> undeployProcessorVersion(UndeployProcessorVersionRequest request)
Undeploys the processor version.
-
createProcessor
public com.google.common.util.concurrent.ListenableFuture<Processor> createProcessor(CreateProcessorRequest request)
Creates a processor from the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided. The processor will be at `ENABLED` state by default after its creation.
-
deleteProcessor
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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.
-
enableProcessor
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> enableProcessor(EnableProcessorRequest request)
Enables a processor
-
disableProcessor
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> disableProcessor(DisableProcessorRequest request)
Disables a processor
-
setDefaultProcessorVersion
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request)
Set the default (active) version of a [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].
-
reviewDocument
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> reviewDocument(ReviewDocumentRequest request)
Send a document for Human Review. The input document should be processed by the specified processor.
-
evaluateProcessorVersion
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> evaluateProcessorVersion(EvaluateProcessorVersionRequest request)
Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.
-
getEvaluation
public com.google.common.util.concurrent.ListenableFuture<Evaluation> getEvaluation(GetEvaluationRequest request)
Retrieves a specific evaluation.
-
listEvaluations
public com.google.common.util.concurrent.ListenableFuture<ListEvaluationsResponse> listEvaluations(ListEvaluationsRequest request)
Retrieves a set of evaluations for a given processor version.
-
importProcessorVersion
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> importProcessorVersion(ImportProcessorVersionRequest request)
Imports a processor version from source processor version.
-
-