Package com.google.cloud.documentai.v1

Interface DocumentProcessorServiceGrpc.AsyncService

  • All Known Implementing Classes:
    DocumentProcessorServiceGrpc.DocumentProcessorServiceImplBase
    Enclosing class:
    DocumentProcessorServiceGrpc
    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.

    • Method Detail

      • processDocument

        default void processDocument​(ProcessRequest request,
                             io.grpc.stub.StreamObserver<ProcessResponse> responseObserver)
         Processes a single document.

      • batchProcessDocuments

        default void batchProcessDocuments​(BatchProcessRequest request,
                                   io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         LRO endpoint to batch process many documents. The output is written
 to Cloud Storage as JSON in the [Document] format.

      • fetchProcessorTypes

        default void fetchProcessorTypes​(FetchProcessorTypesRequest request,
                                 io.grpc.stub.StreamObserver<FetchProcessorTypesResponse> responseObserver)
         Fetches processor types. Note that we don't use
 [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
 here, because it isn't paginated.

      • getProcessor

        default void getProcessor​(GetProcessorRequest request,
                          io.grpc.stub.StreamObserver<Processor> responseObserver)
         Gets a processor detail.

      • trainProcessorVersion

        default void trainProcessorVersion​(TrainProcessorVersionRequest request,
                                   io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Trains a new processor version.
 Operation metadata is returned as
 [TrainProcessorVersionMetadata][google.cloud.documentai.v1.TrainProcessorVersionMetadata].

      • deleteProcessorVersion

        default void deleteProcessorVersion​(DeleteProcessorVersionRequest request,
                                    io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Deletes the processor version, all artifacts under the processor version
 will be deleted.

      • deployProcessorVersion

        default void deployProcessorVersion​(DeployProcessorVersionRequest request,
                                    io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Deploys the processor version.

      • undeployProcessorVersion

        default void undeployProcessorVersion​(UndeployProcessorVersionRequest request,
                                      io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Undeploys the processor version.

      • createProcessor

        default void createProcessor​(CreateProcessorRequest request,
                             io.grpc.stub.StreamObserver<Processor> responseObserver)
         Creates a processor from the
 [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. The
 processor will be at `ENABLED` state by default after its creation.

      • deleteProcessor

        default void deleteProcessor​(DeleteProcessorRequest request,
                             io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Deletes the processor, unloads all deployed model artifacts if it was
 enabled and then deletes all artifacts associated with this processor.

      • enableProcessor

        default void enableProcessor​(EnableProcessorRequest request,
                             io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Enables a processor

      • disableProcessor

        default void disableProcessor​(DisableProcessorRequest request,
                              io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Disables a processor

      • setDefaultProcessorVersion

        default void setDefaultProcessorVersion​(SetDefaultProcessorVersionRequest request,
                                        io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Set the default (active) version of a
 [Processor][google.cloud.documentai.v1.Processor] that will be used in
 [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument]
 and
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].

      • reviewDocument

        default void reviewDocument​(ReviewDocumentRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Send a document for Human Review. The input document should be processed by
 the specified processor.

      • evaluateProcessorVersion

        default void evaluateProcessorVersion​(EvaluateProcessorVersionRequest request,
                                      io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Evaluates a ProcessorVersion against annotated documents, producing an
 Evaluation.

      • getEvaluation

        default void getEvaluation​(GetEvaluationRequest request,
                           io.grpc.stub.StreamObserver<Evaluation> responseObserver)
         Retrieves a specific evaluation.