Interface DocumentProcessorServiceGrpc.AsyncService (2.48.0)

public static interface DocumentProcessorServiceGrpc.AsyncService

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.

Methods

batchProcessDocuments(BatchProcessRequest request, StreamObserver<Operation> responseObserver)

public default void batchProcessDocuments(BatchProcessRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request BatchProcessRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createProcessor(CreateProcessorRequest request, StreamObserver<Processor> responseObserver)

public default void createProcessor(CreateProcessorRequest request, StreamObserver<Processor> responseObserver)

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

Parameters
Name Description
request CreateProcessorRequest
responseObserver io.grpc.stub.StreamObserver<Processor>

deleteProcessor(DeleteProcessorRequest request, StreamObserver<Operation> responseObserver)

public default void deleteProcessor(DeleteProcessorRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request DeleteProcessorRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteProcessorVersion(DeleteProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

public default void deleteProcessorVersion(DeleteProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request DeleteProcessorVersionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deployProcessorVersion(DeployProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

public default void deployProcessorVersion(DeployProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

Deploys the processor version.

Parameters
Name Description
request DeployProcessorVersionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

disableProcessor(DisableProcessorRequest request, StreamObserver<Operation> responseObserver)

public default void disableProcessor(DisableProcessorRequest request, StreamObserver<Operation> responseObserver)

Disables a processor

Parameters
Name Description
request DisableProcessorRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

enableProcessor(EnableProcessorRequest request, StreamObserver<Operation> responseObserver)

public default void enableProcessor(EnableProcessorRequest request, StreamObserver<Operation> responseObserver)

Enables a processor

Parameters
Name Description
request EnableProcessorRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

evaluateProcessorVersion(EvaluateProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

public default void evaluateProcessorVersion(EvaluateProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
Name Description
request EvaluateProcessorVersionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

fetchProcessorTypes(FetchProcessorTypesRequest request, StreamObserver<FetchProcessorTypesResponse> responseObserver)

public default void fetchProcessorTypes(FetchProcessorTypesRequest request, StreamObserver<FetchProcessorTypesResponse> responseObserver)

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

Parameters
Name Description
request FetchProcessorTypesRequest
responseObserver io.grpc.stub.StreamObserver<FetchProcessorTypesResponse>

getEvaluation(GetEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

public default void getEvaluation(GetEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

Retrieves a specific evaluation.

Parameters
Name Description
request GetEvaluationRequest
responseObserver io.grpc.stub.StreamObserver<Evaluation>

getProcessor(GetProcessorRequest request, StreamObserver<Processor> responseObserver)

public default void getProcessor(GetProcessorRequest request, StreamObserver<Processor> responseObserver)

Gets a processor detail.

Parameters
Name Description
request GetProcessorRequest
responseObserver io.grpc.stub.StreamObserver<Processor>

getProcessorType(GetProcessorTypeRequest request, StreamObserver<ProcessorType> responseObserver)

public default void getProcessorType(GetProcessorTypeRequest request, StreamObserver<ProcessorType> responseObserver)

Gets a processor type detail.

Parameters
Name Description
request GetProcessorTypeRequest
responseObserver io.grpc.stub.StreamObserver<ProcessorType>

getProcessorVersion(GetProcessorVersionRequest request, StreamObserver<ProcessorVersion> responseObserver)

public default void getProcessorVersion(GetProcessorVersionRequest request, StreamObserver<ProcessorVersion> responseObserver)

Gets a processor version detail.

Parameters
Name Description
request GetProcessorVersionRequest
responseObserver io.grpc.stub.StreamObserver<ProcessorVersion>

importProcessorVersion(ImportProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

public default void importProcessorVersion(ImportProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

Imports a processor version from source processor version.

Parameters
Name Description
request ImportProcessorVersionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

listEvaluations(ListEvaluationsRequest request, StreamObserver<ListEvaluationsResponse> responseObserver)

public default void listEvaluations(ListEvaluationsRequest request, StreamObserver<ListEvaluationsResponse> responseObserver)

Retrieves a set of evaluations for a given processor version.

Parameters
Name Description
request ListEvaluationsRequest
responseObserver io.grpc.stub.StreamObserver<ListEvaluationsResponse>

listProcessorTypes(ListProcessorTypesRequest request, StreamObserver<ListProcessorTypesResponse> responseObserver)

public default void listProcessorTypes(ListProcessorTypesRequest request, StreamObserver<ListProcessorTypesResponse> responseObserver)

Lists the processor types that exist.

Parameters
Name Description
request ListProcessorTypesRequest
responseObserver io.grpc.stub.StreamObserver<ListProcessorTypesResponse>

listProcessorVersions(ListProcessorVersionsRequest request, StreamObserver<ListProcessorVersionsResponse> responseObserver)

public default void listProcessorVersions(ListProcessorVersionsRequest request, StreamObserver<ListProcessorVersionsResponse> responseObserver)

Lists all versions of a processor.

Parameters
Name Description
request ListProcessorVersionsRequest
responseObserver io.grpc.stub.StreamObserver<ListProcessorVersionsResponse>

listProcessors(ListProcessorsRequest request, StreamObserver<ListProcessorsResponse> responseObserver)

public default void listProcessors(ListProcessorsRequest request, StreamObserver<ListProcessorsResponse> responseObserver)

Lists all processors which belong to this project.

Parameters
Name Description
request ListProcessorsRequest
responseObserver io.grpc.stub.StreamObserver<ListProcessorsResponse>

processDocument(ProcessRequest request, StreamObserver<ProcessResponse> responseObserver)

public default void processDocument(ProcessRequest request, StreamObserver<ProcessResponse> responseObserver)

Processes a single document.

Parameters
Name Description
request ProcessRequest
responseObserver io.grpc.stub.StreamObserver<ProcessResponse>

reviewDocument(ReviewDocumentRequest request, StreamObserver<Operation> responseObserver)

public default void reviewDocument(ReviewDocumentRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request ReviewDocumentRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

public default void setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request SetDefaultProcessorVersionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

trainProcessorVersion(TrainProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

public default void trainProcessorVersion(TrainProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request TrainProcessorVersionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

undeployProcessorVersion(UndeployProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

public default void undeployProcessorVersion(UndeployProcessorVersionRequest request, StreamObserver<Operation> responseObserver)

Undeploys the processor version.

Parameters
Name Description
request UndeployProcessorVersionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>