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
Inherited Members
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Operation> |
|
build(Channel channel, CallOptions callOptions)
protected DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters |
Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
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.
Note that this method requires the documentai.processors.create
permission on the project, which is highly privileged. A user or service
account with this permission can create new processors that can interact
with any gcs bucket in your project.
Returns |
Type |
Description |
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.
Returns |
Type |
Description |
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Operation> |
|
deployProcessorVersion(DeployProcessorVersionRequest request)
public ListenableFuture<Operation> deployProcessorVersion(DeployProcessorVersionRequest request)
Deploys the processor version.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Operation> |
|
disableProcessor(DisableProcessorRequest request)
public ListenableFuture<Operation> disableProcessor(DisableProcessorRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Operation> |
|
enableProcessor(EnableProcessorRequest request)
public ListenableFuture<Operation> enableProcessor(EnableProcessorRequest request)
Returns |
Type |
Description |
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.
Returns |
Type |
Description |
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.
getEvaluation(GetEvaluationRequest request)
public ListenableFuture<Evaluation> getEvaluation(GetEvaluationRequest request)
Retrieves a specific evaluation.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Evaluation> |
|
getProcessor(GetProcessorRequest request)
public ListenableFuture<Processor> getProcessor(GetProcessorRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Processor> |
|
getProcessorType(GetProcessorTypeRequest request)
public ListenableFuture<ProcessorType> getProcessorType(GetProcessorTypeRequest request)
Gets a processor type detail.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<ProcessorType> |
|
getProcessorVersion(GetProcessorVersionRequest request)
public ListenableFuture<ProcessorVersion> getProcessorVersion(GetProcessorVersionRequest request)
Gets a processor version detail.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<ProcessorVersion> |
|
importProcessorVersion(ImportProcessorVersionRequest request)
public ListenableFuture<Operation> importProcessorVersion(ImportProcessorVersionRequest request)
Imports a processor version from source processor version.
Returns |
Type |
Description |
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.
listProcessorTypes(ListProcessorTypesRequest request)
public ListenableFuture<ListProcessorTypesResponse> listProcessorTypes(ListProcessorTypesRequest request)
Lists the processor types that exist.
listProcessorVersions(ListProcessorVersionsRequest request)
public ListenableFuture<ListProcessorVersionsResponse> listProcessorVersions(ListProcessorVersionsRequest request)
Lists all versions of a processor.
listProcessors(ListProcessorsRequest request)
public ListenableFuture<ListProcessorsResponse> listProcessors(ListProcessorsRequest request)
Lists all processors which belong to this project.
processDocument(ProcessRequest request)
public ListenableFuture<ProcessResponse> processDocument(ProcessRequest request)
Processes a single document.
Returns |
Type |
Description |
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.
Returns |
Type |
Description |
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.
Returns |
Type |
Description |
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Operation> |
|
undeployProcessorVersion(UndeployProcessorVersionRequest request)
public ListenableFuture<Operation> undeployProcessorVersion(UndeployProcessorVersionRequest request)
Undeploys the processor version.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Operation> |
|