feat(documentai): update the api

#### documentai:v1 The following keys were added: - schemas.GoogleCloudDocumentaiV1BatchProcessRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1ProcessRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1ProcessorVersion.properties.modelType (Total Keys: 2) #### documentai:v1beta3 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3BatchProcessRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1beta3ProcessRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1beta3ProcessorVersion.properties.modelType (Total Keys: 2)
googleapis · Jan 23, 2024 · 132fea0 · 132fea0
1 parent a5ce564
commit 132fea0
Show file tree

Hide file tree

Showing 7 changed files with 109 additions and 21 deletions.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html
@@ -151,6 +151,9 @@ <h3>Method Details</h3>
       &quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
     },
   },
+  &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
+    &quot;a_key&quot;: &quot;A String&quot;,
+  },
   &quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
     &quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
     &quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -159,7 +162,7 @@ <h3>Method Details</h3>
         42,
       ],
     },
-    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
+    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
       &quot;advancedOcrOptions&quot;: [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
         &quot;A String&quot;,
       ],
@@ -1332,6 +1335,9 @@ <h3>Method Details</h3>
     ],
     &quot;uri&quot;: &quot;A String&quot;, # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
   },
+  &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
+    &quot;a_key&quot;: &quot;A String&quot;,
+  },
   &quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
     &quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
     &quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -1340,7 +1346,7 @@ <h3>Method Details</h3>
         42,
       ],
     },
-    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
+    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
       &quot;advancedOcrOptions&quot;: [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
         &quot;A String&quot;,
       ],

diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
@@ -146,6 +146,9 @@ <h3>Method Details</h3>
       &quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
     },
   },
+  &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
+    &quot;a_key&quot;: &quot;A String&quot;,
+  },
   &quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
     &quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
     &quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -154,7 +157,7 @@ <h3>Method Details</h3>
         42,
       ],
     },
-    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
+    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
       &quot;advancedOcrOptions&quot;: [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
         &quot;A String&quot;,
       ],
@@ -427,6 +430,7 @@ <h3>Method Details</h3>
     &quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
     &quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
   },
+  &quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
   &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
   &quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
 }</pre>
@@ -522,6 +526,7 @@ <h3>Method Details</h3>
         &quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
         &quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
       },
+      &quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
       &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
       &quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
     },
@@ -1404,6 +1409,9 @@ <h3>Method Details</h3>
     ],
     &quot;uri&quot;: &quot;A String&quot;, # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
   },
+  &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
+    &quot;a_key&quot;: &quot;A String&quot;,
+  },
   &quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
     &quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
     &quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -1412,7 +1420,7 @@ <h3>Method Details</h3>
         42,
       ],
     },
-    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
+    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
       &quot;advancedOcrOptions&quot;: [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
         &quot;A String&quot;,
       ],
@@ -2448,6 +2456,7 @@ <h3>Method Details</h3>
       &quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
       &quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
     },
+    &quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
     &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
     &quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
   },

diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html
@@ -165,6 +165,9 @@ <h3>Method Details</h3>
       &quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
     },
   },
+  &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
+    &quot;a_key&quot;: &quot;A String&quot;,
+  },
   &quot;outputConfig&quot;: { # The output configuration in the BatchProcessDocuments method. # The overall output config for batch process.
     &quot;gcsDestination&quot;: &quot;A String&quot;, # The output Cloud Storage directory to put the processed documents.
   },
@@ -176,7 +179,7 @@ <h3>Method Details</h3>
         42,
       ],
     },
-    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
+    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
       &quot;advancedOcrOptions&quot;: [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
         &quot;A String&quot;,
       ],
@@ -2238,6 +2241,9 @@ <h3>Method Details</h3>
     ],
     &quot;uri&quot;: &quot;A String&quot;, # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
   },
+  &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
+    &quot;a_key&quot;: &quot;A String&quot;,
+  },
   &quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
     &quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
     &quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -2246,7 +2252,7 @@ <h3>Method Details</h3>
         42,
       ],
     },
-    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
+    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
       &quot;advancedOcrOptions&quot;: [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
         &quot;A String&quot;,
       ],
@@ -3234,7 +3240,7 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # A singleton resource under a Processor which configures a collection of documents.
-  &quot;documentWarehouseConfig&quot;: { # Configuration specific to the Document AI Warehouse-based implementation. # Optional. Derepcated. Warehouse-based dataset configuration is not supported today.
+  &quot;documentWarehouseConfig&quot;: { # Configuration specific to the Document AI Warehouse-based implementation. # Optional. Deprecated. Warehouse-based dataset configuration is not supported.
     &quot;collection&quot;: &quot;A String&quot;, # Output only. The collection in Document AI Warehouse associated with the dataset.
     &quot;schema&quot;: &quot;A String&quot;, # Output only. The schema in Document AI Warehouse associated with the dataset.
   },

diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
@@ -155,6 +155,9 @@ <h3>Method Details</h3>
       &quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
     },
   },
+  &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
+    &quot;a_key&quot;: &quot;A String&quot;,
+  },
   &quot;outputConfig&quot;: { # The output configuration in the BatchProcessDocuments method. # The overall output config for batch process.
     &quot;gcsDestination&quot;: &quot;A String&quot;, # The output Cloud Storage directory to put the processed documents.
   },
@@ -166,7 +169,7 @@ <h3>Method Details</h3>
         42,
       ],
     },
-    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
+    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
       &quot;advancedOcrOptions&quot;: [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
         &quot;A String&quot;,
       ],
@@ -494,6 +497,7 @@ <h3>Method Details</h3>
     &quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
     &quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
   },
+  &quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
   &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
   &quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
 }</pre>
@@ -647,6 +651,7 @@ <h3>Method Details</h3>
         &quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
         &quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
       },
+      &quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
       &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
       &quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
     },
@@ -2375,6 +2380,9 @@ <h3>Method Details</h3>
     ],
     &quot;uri&quot;: &quot;A String&quot;, # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
   },
+  &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
+    &quot;a_key&quot;: &quot;A String&quot;,
+  },
   &quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
     &quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
     &quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -2383,7 +2391,7 @@ <h3>Method Details</h3>
         42,
       ],
     },
-    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
+    &quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
       &quot;advancedOcrOptions&quot;: [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
         &quot;A String&quot;,
       ],
@@ -3377,8 +3385,8 @@ <h3>Method Details</h3>
     },
   },
   &quot;foundationModelTuningOptions&quot;: { # Options to control foundation model tuning of the processor. # Options to control foundation model tuning of a processor.
-    &quot;learningRateMultiplier&quot;: 3.14, # Optional. The multiplier to apply to the recommended learning rate. Valid values are between [0.1, 10]. If not provided, recommended learning rate will be used.
-    &quot;trainSteps&quot;: 42, # Optional. The number of steps to run for model tuning. Valid values are between [1, 400]. If not provided, recommended steps will be used.
+    &quot;learningRateMultiplier&quot;: 3.14, # Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.
+    &quot;trainSteps&quot;: 42, # Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.
   },
   &quot;inputData&quot;: { # The input data used to train a new ProcessorVersion. # Optional. The input data used to train the ProcessorVersion.
     &quot;testDocuments&quot;: { # The common config to specify a set of documents used as input. # The documents used for testing the trained version.
@@ -3491,6 +3499,7 @@ <h3>Method Details</h3>
       &quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
       &quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
     },
+    &quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
     &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
     &quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
   },