feat: update document.proto, add the processor management methods.

Google APIs · copybara-github · commit 19906f9fc5f2 · 2021-06-15T17:06:19.000-07:00
PiperOrigin-RevId: 379607978
diff --git a/google/cloud/documentai/v1beta3/BUILD.bazel b/google/cloud/documentai/v1beta3/BUILD.bazel
@@ -25,6 +25,8 @@ proto_library(
         "document_io.proto",
         "document_processor_service.proto",
         "geometry.proto",
+        "processor.proto",
+        "processor_type.proto",
         "operation_metadata.proto",
     ],
     deps = [
diff --git a/google/cloud/documentai/v1beta3/document.proto b/google/cloud/documentai/v1beta3/document.proto
@@ -324,6 +324,9 @@ message Document {
       // - "unfilled_checkbox"
       // - "filled_checkbox"
       string value_type = 5;
+
+      // The history of this annotation.
+      Provenance provenance = 8;
     }
 
     // Detected language for a structural component.
@@ -385,6 +388,9 @@ message Document {
 
     // A list of visually detected form fields on the page.
     repeated FormField form_fields = 11;
+
+    // The history of this page.
+    Provenance provenance = 16;
   }
 
   // A phrase in the text that is a known entity type, such as a person, an
@@ -536,6 +542,8 @@ message Document {
 
       // Required. Index into the [Document.pages][google.cloud.documentai.v1beta3.Document.pages] element, for example using
       // [Document.pages][page_refs.page] to locate the related page element.
+      // This field is skipped when its value is the default 0. See
+      // https://developers.google.com/protocol-buffers/docs/proto3#json.
       int64 page = 1 [(google.api.field_behavior) = REQUIRED];
 
       // Optional. The type of the layout element that is being referenced if any.
@@ -568,8 +576,12 @@ message Document {
       // The index of the [Document.revisions] identifying the parent revision.
       int32 revision = 1;
 
+      // The index of the parent revisions corresponding collection of items
+      // (eg. list of entities, properties within entities, etc.)
+      int32 index = 3;
+
       // The id of the parent provenance.
-      int32 id = 2;
+      int32 id = 2 [deprecated = true];
     }
 
     // If a processor or agent does an explicit operation on existing elements.
@@ -602,7 +614,7 @@ message Document {
 
     // The Id of this operation.  Needs to be unique within the scope of the
     // revision.
-    int32 id = 2;
+    int32 id = 2 [deprecated = true];
 
     // References to the original elements that are replaced.
     repeated Parent parents = 3;
diff --git a/google/cloud/documentai/v1beta3/document_processor_service.proto b/google/cloud/documentai/v1beta3/document_processor_service.proto
@@ -23,6 +23,8 @@ import "google/api/resource.proto";
 import "google/cloud/documentai/v1beta3/document.proto";
 import "google/cloud/documentai/v1beta3/document_io.proto";
 import "google/cloud/documentai/v1beta3/operation_metadata.proto";
+import "google/cloud/documentai/v1beta3/processor.proto";
+import "google/cloud/documentai/v1beta3/processor_type.proto";
 import "google/longrunning/operations.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
@@ -44,10 +46,6 @@ option (google.api.resource_definition) = {
   type: "documentai.googleapis.com/Location"
   pattern: "projects/{project}/locations/{location}"
 };
-option (google.api.resource_definition) = {
-  type: "documentai.googleapis.com/Processor"
-  pattern: "projects/{project}/locations/{location}/processors/{processor}"
-};
 option (google.api.resource_definition) = {
   type: "documentai.googleapis.com/HumanReviewConfig"
   pattern: "projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig"
@@ -84,6 +82,69 @@ service DocumentProcessorService {
     };
   }
 
+  // Fetches processor types.
+  rpc FetchProcessorTypes(FetchProcessorTypesRequest) returns (FetchProcessorTypesResponse) {
+    option (google.api.http) = {
+      get: "/v1beta3/{parent=projects/*/locations/*}:fetchProcessorTypes"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Lists all processors which belong to this project.
+  rpc ListProcessors(ListProcessorsRequest) returns (ListProcessorsResponse) {
+    option (google.api.http) = {
+      get: "/v1beta3/{parent=projects/*/locations/*}/processors"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Creates a processor from the type processor that the user chose.
+  // The processor will be at "ENABLED" state by default after its creation.
+  rpc CreateProcessor(CreateProcessorRequest) returns (Processor) {
+    option (google.api.http) = {
+      post: "/v1beta3/{parent=projects/*/locations/*}/processors"
+      body: "processor"
+    };
+    option (google.api.method_signature) = "parent,processor";
+  }
+
+  // Deletes the processor, unloads all deployed model artifacts if it was
+  // enabled and then deletes all artifacts associated with this processor.
+  rpc DeleteProcessor(DeleteProcessorRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v1beta3/{name=projects/*/locations/*/processors/*}"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.protobuf.Empty"
+      metadata_type: "DeleteProcessorMetadata"
+    };
+  }
+
+  // Enables a processor
+  rpc EnableProcessor(EnableProcessorRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta3/{name=projects/*/locations/*/processors/*}:enable"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "EnableProcessorResponse"
+      metadata_type: "EnableProcessorMetadata"
+    };
+  }
+
+  // Disables a processor
+  rpc DisableProcessor(DisableProcessorRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta3/{name=projects/*/locations/*/processors/*}:disable"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "DisableProcessorResponse"
+      metadata_type: "DisableProcessorMetadata"
+    };
+  }
+
   // Send a document for Human Review. The input document should be processed by
   // the specified processor.
   rpc ReviewDocument(ReviewDocumentRequest) returns (google.longrunning.Operation) {
@@ -299,8 +360,146 @@ message BatchProcessMetadata {
   repeated IndividualProcessStatus individual_process_statuses = 5;
 }
 
+// Request message for fetch processor types.
+message FetchProcessorTypesRequest {
+  // Required. The project of processor type to list.
+  // Format: projects/{project}/locations/{location}
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "documentai.googleapis.com/ProcessorType"
+    }
+  ];
+}
+
+// Response message for fetch processor types.
+message FetchProcessorTypesResponse {
+  // The list of processor types.
+  repeated ProcessorType processor_types = 1;
+}
+
+// Request message for list all processors belongs to a project.
+message ListProcessorsRequest {
+  // Required. The parent (project and location) which owns this collection of Processors.
+  // Format: projects/{project}/locations/{location}
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "documentai.googleapis.com/Processor"
+    }
+  ];
+
+  // The maximum number of processors to return.
+  // If unspecified, at most 50 processors will be returned.
+  // The maximum value is 100; values above 100 will be coerced to 100.
+  int32 page_size = 2;
+
+  // We will return the processors sorted by creation time. The page token
+  // will point to the next processor.
+  string page_token = 3;
+}
+
+// Response message for list processors.
+message ListProcessorsResponse {
+  // The list of processors.
+  repeated Processor processors = 1;
+
+  // Points to the next processor, otherwise empty.
+  string next_page_token = 2;
+}
+
+// Request message for create a processor. Notice this request is sent to
+// a regionalized backend service, and if the processor type is not available
+// on that region, the creation will fail.
+message CreateProcessorRequest {
+  // Required. The parent (project and location) under which to create the processor.
+  // Format: projects/{project}/locations/{location}
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "documentai.googleapis.com/Processor"
+    }
+  ];
+
+  // Required. The processor to be created, requires [processor_type] and [display_name]
+  // to be set. Also, the processor is under CMEK if CMEK fields are set.
+  Processor processor = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for the delete processor method.
+message DeleteProcessorRequest {
+  // Required. The processor resource name to be deleted.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "documentai.googleapis.com/Processor"
+    }
+  ];
+}
+
+// The long running operation metadata for delete processor method.
+message DeleteProcessorMetadata {
+  // The basic metadata of the long running operation.
+  CommonOperationMetadata common_metadata = 5;
+}
+
+// Request message for the enable processor method.
+message EnableProcessorRequest {
+  // Required. The processor resource name to be enabled.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "documentai.googleapis.com/Processor"
+    }
+  ];
+}
+
+// Response message for the enable processor method.
+message EnableProcessorResponse {
+
+}
+
+// The long running operation metadata for enable processor method.
+message EnableProcessorMetadata {
+  // The basic metadata of the long running operation.
+  CommonOperationMetadata common_metadata = 5;
+}
+
+// Request message for the disable processor method.
+message DisableProcessorRequest {
+  // Required. The processor resource name to be disabled.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "documentai.googleapis.com/Processor"
+    }
+  ];
+}
+
+// Response message for the disable processor method.
+message DisableProcessorResponse {
+
+}
+
+// The long running operation metadata for disable processor method.
+message DisableProcessorMetadata {
+  // The basic metadata of the long running operation.
+  CommonOperationMetadata common_metadata = 5;
+}
+
 // Request message for review document method.
+// Next Id: 6.
 message ReviewDocumentRequest {
+  // The priority level of the human review task.
+  enum Priority {
+    // The default priority level.
+    DEFAULT = 0;
+
+    // The urgent priority level. The labeling manager should allocate labeler
+    // resource to the urgent task queue to respect this priority level.
+    URGENT = 1;
+  }
+
   // The document payload.
   oneof source {
     // An inline document proto.
@@ -318,6 +517,12 @@ message ReviewDocumentRequest {
 
   // The document that needs human review.
   Document document = 2 [deprecated = true];
+
+  // Whether the validation should be performed on the ad-hoc review request.
+  bool enable_schema_validation = 3;
+
+  // The priority of the human review task.
+  Priority priority = 5;
 }
 
 // Response message for review document method.
diff --git a/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml b/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml
@@ -9,6 +9,11 @@ apis:
 types:
 - name: google.cloud.documentai.v1beta3.BatchProcessMetadata
 - name: google.cloud.documentai.v1beta3.BatchProcessResponse
+- name: google.cloud.documentai.v1beta3.DeleteProcessorMetadata
+- name: google.cloud.documentai.v1beta3.DisableProcessorMetadata
+- name: google.cloud.documentai.v1beta3.DisableProcessorResponse
+- name: google.cloud.documentai.v1beta3.EnableProcessorMetadata
+- name: google.cloud.documentai.v1beta3.EnableProcessorResponse
 - name: google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata
 - name: google.cloud.documentai.v1beta3.ReviewDocumentResponse
 
diff --git a/google/cloud/documentai/v1beta3/processor.proto b/google/cloud/documentai/v1beta3/processor.proto
diff --git a/google/cloud/documentai/v1beta3/processor_type.proto b/google/cloud/documentai/v1beta3/processor_type.proto
