feat: Added EvaluationReference to evaluation.proto

Google APIs · copybara-github · commit a2cdee8aeb92 · 2023-02-06T14:06:01.000-08:00
feat: Added latest_evaluation to processor.proto
chore!: Updated TrainProcessorVersion parent to correctly be a Processor, rather than ProcessorVersion

BREAKING CHANGE: The TrainProcessorVersion parent was incorrectly annotated.

PiperOrigin-RevId: 507577968
diff --git a/google/cloud/documentai/v1beta3/document.proto b/google/cloud/documentai/v1beta3/document.proto
@@ -739,22 +739,29 @@ message Document {
       // Remove an element identified by `parent`.
       REMOVE = 2;
 
-      // Replace an element identified by `parent`.
-      REPLACE = 3;
+      // Updates any fields within the given provenance scope of the message. It
+      // 'overwrites'  the fields rather than replacing them.  This is
+      // especially relevant when we just want to update a field value of an
+      // entity without also affecting all the child properties.
+      UPDATE = 7;
 
-      // Request human review for the element identified by `parent`.
-      EVAL_REQUESTED = 4;
+      // Currently unused. Replace an element identified by `parent`.
+      REPLACE = 3 [deprecated = true];
 
-      // Element is reviewed and approved at human review, confidence will be
-      // set to 1.0.
-      EVAL_APPROVED = 5;
+      // Deprecated. Request human review for the element identified by
+      // `parent`.
+      EVAL_REQUESTED = 4 [deprecated = true];
 
-      // Element is skipped in the validation process.
-      EVAL_SKIPPED = 6;
+      // Deprecated. Element is reviewed and approved at human review,
+      // confidence will be set to 1.0.
+      EVAL_APPROVED = 5 [deprecated = true];
+
+      // Deprecated. Element is skipped in the validation process.
+      EVAL_SKIPPED = 6 [deprecated = true];
     }
 
     // The index of the revision that produced this element.
-    int32 revision = 1;
+    int32 revision = 1 [deprecated = true];
 
     // The Id of this operation.  Needs to be unique within the scope of the
     // revision.
@@ -790,7 +797,8 @@ message Document {
       string processor = 5;
     }
 
-    // Id of the revision.  Unique within the context of the document.
+    // Id of the revision, internally generated by doc proto storage.
+    // Unique within the context of the document.
     string id = 1;
 
     // The revisions that this revision is based on.  This can include one or
@@ -803,7 +811,8 @@ message Document {
     // `provenance.parent.revision` fields that index into this field.
     repeated string parent_ids = 7;
 
-    // The time that the revision was created.
+    // The time that the revision was created, internally generated by
+    // doc proto storage at the time of create.
     google.protobuf.Timestamp create_time = 3;
 
     // Human Review information of this revision.
diff --git a/google/cloud/documentai/v1beta3/document_processor_service.proto b/google/cloud/documentai/v1beta3/document_processor_service.proto
@@ -879,7 +879,7 @@ message TrainProcessorVersionRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      child_type: "documentai.googleapis.com/ProcessorVersion"
+      type: "documentai.googleapis.com/Processor"
     }
   ];
 
diff --git a/google/cloud/documentai/v1beta3/evaluation.proto b/google/cloud/documentai/v1beta3/evaluation.proto
@@ -27,6 +27,23 @@ option java_package = "com.google.cloud.documentai.v1beta3";
 option php_namespace = "Google\\Cloud\\DocumentAI\\V1beta3";
 option ruby_package = "Google::Cloud::DocumentAI::V1beta3";
 
+// Gives a short summary of an evaluation, and links to the evaluation itself.
+message EvaluationReference {
+  // The resource name of the Long Running Operation for the evaluation.
+  string operation = 1;
+
+  // The resource name of the evaluation.
+  string evaluation = 2 [(google.api.resource_reference) = {
+    type: "documentai.googleapis.com/Evaluation"
+  }];
+
+  // An aggregate of the statistics for the evaluation with fuzzy matching on.
+  Evaluation.Metrics aggregate_metrics = 4;
+
+  // An aggregate of the statistics for the evaluation with fuzzy matching off.
+  Evaluation.Metrics aggregate_metrics_exact = 5;
+}
+
 // An evaluation of a ProcessorVersion's performance.
 message Evaluation {
   option (google.api.resource) = {
diff --git a/google/cloud/documentai/v1beta3/processor.proto b/google/cloud/documentai/v1beta3/processor.proto
@@ -19,6 +19,7 @@ package google.cloud.documentai.v1beta3;
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/cloud/documentai/v1beta3/document_schema.proto";
+import "google/cloud/documentai/v1beta3/evaluation.proto";
 import "google/protobuf/timestamp.proto";
 
 option csharp_namespace = "Google.Cloud.DocumentAI.V1Beta3";
@@ -96,6 +97,9 @@ message ProcessorVersion {
   // The time the processor version was created.
   google.protobuf.Timestamp create_time = 7;
 
+  // The most recently invoked evaluation for the processor version.
+  EvaluationReference latest_evaluation = 8;
+
   // The KMS key name used for encryption.
   string kms_key_name = 9;
 

Original file line number	Diff line number	Diff line change
`@@ -879,7 +879,7 @@ message TrainProcessorVersionRequest {`
`879`	`879`	`string parent = 1 [`
`880`	`880`	`(google.api.field_behavior) = REQUIRED,`
`881`	`881`	`(google.api.resource_reference) = {`
`882`		`- child_type: "documentai.googleapis.com/ProcessorVersion"`
	`882`	`+ type: "documentai.googleapis.com/Processor"`
`883`	`883`	`}`
`884`	`884`	`];`
`885`	`885`