feat: Updated the exponential backoff settings for the Document AI ProcessDocument and BatchProcessDocuments methods

Google APIs · copybara-github · commit 211a72fa5cd9 · 2024-10-18T12:49:15.000-07:00
feat: Add RESOURCE_EXHAUSTED to retryable status codes for ProcessDocument method
feat: Added an url for issue reporting and api short name

PiperOrigin-RevId: 687393779
diff --git a/google/cloud/documentai/v1beta3/dataset.proto b/google/cloud/documentai/v1beta3/dataset.proto
@@ -174,6 +174,12 @@ message DatasetSchema {
 
   // Optional. Schema of the dataset.
   DocumentSchema document_schema = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. Reserved for future use.
+  bool satisfies_pzs = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Reserved for future use.
+  bool satisfies_pzi = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Dataset documents that the batch operation will be applied to.
diff --git a/google/cloud/documentai/v1beta3/document_io.proto b/google/cloud/documentai/v1beta3/document_io.proto
@@ -66,7 +66,8 @@ message GcsPrefix {
 
 // The common config to specify a set of documents used as input.
 message BatchDocumentsInputConfig {
-  // The source.
+  // The source. Make sure that the caller of the API has storage.objects.get
+  // access to the buckets.
   oneof source {
     // The set of documents that match the specified Cloud Storage `gcs_prefix`.
     GcsPrefix gcs_prefix = 1;
diff --git a/google/cloud/documentai/v1beta3/document_processor_service.proto b/google/cloud/documentai/v1beta3/document_processor_service.proto
@@ -384,8 +384,9 @@ message ProcessOptions {
   // If a page range is set, only the given pages are extracted and processed
   // from the document. In the output document,
   // [Document.Page.page_number][google.cloud.documentai.v1beta3.Document.Page.page_number]
-  // refers to the page number in the original document. This configuration
-  // only applies to sync requests.
+  // refers to the page number in the original document.
+  // This configuration only applies to online processing with
+  // [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument].
   oneof page_range {
     // Which pages to process (1-indexed).
     IndividualPageSelector individual_page_selector = 5;
diff --git a/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml b/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml
@@ -98,12 +98,29 @@ authentication:
         https://www.googleapis.com/auth/cloud-platform
 
 publishing:
+  new_issue_uri: https://issuetracker.google.com/issues/new?component=1132231&template=1639002
   documentation_uri: https://cloud.google.com/document-ai/docs
+  api_short_name: documentai
   github_label: 'api: documentai'
   organization: CLOUD
   library_settings:
   - version: google.cloud.documentai.v1beta3
+    java_settings:
+      common: {}
+    cpp_settings:
+      common: {}
+    php_settings:
+      common: {}
+    python_settings:
+      common: {}
+    node_settings:
+      common: {}
     dotnet_settings:
+      common: {}
       ignored_resources:
       - documentai.googleapis.com/Location
+    ruby_settings:
+      common: {}
+    go_settings:
+      common: {}
   proto_reference_documentation_uri: https://cloud.google.com/document-ai/docs/reference/rpc
diff --git a/google/cloud/documentai/v1beta3/documentai_v1beta3_grpc_service_config.json b/google/cloud/documentai/v1beta3/documentai_v1beta3_grpc_service_config.json
@@ -9,12 +9,14 @@
       ],
       "timeout": "300s",
       "retryPolicy": {
-        "initialBackoff": "0.100s",
-        "maxBackoff": "60s",
-        "backoffMultiplier": 1.3,
+        "maxAttempts": 5,
+        "initialBackoff": "1.000s",
+        "maxBackoff": "90s",
+        "backoffMultiplier": 9.0,
         "retryableStatusCodes": [
           "DEADLINE_EXCEEDED",
-          "UNAVAILABLE"
+          "UNAVAILABLE",
+          "RESOURCE_EXHAUSTED"
         ]
       }
     },
@@ -31,9 +33,10 @@
       ],
       "timeout": "120s",
       "retryPolicy": {
-        "initialBackoff": "0.100s",
+        "maxAttempts": 5,
+        "initialBackoff": "1.000s",
         "maxBackoff": "60s",
-        "backoffMultiplier": 1.3,
+        "backoffMultiplier": 1.5,
         "retryableStatusCodes": [
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
