feat(documentai): update the api

#### documentai:v1 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3Dataset.properties.documentWarehouseConfig.deprecated (Total Keys: 1) #### documentai:v1beta2 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3Dataset.properties.documentWarehouseConfig.deprecated (Total Keys: 1) #### documentai:v1beta3 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3Dataset.properties.documentWarehouseConfig.deprecated (Total Keys: 1)
googleapis · Nov 7, 2023 · c95afbc · c95afbc
1 parent 5fb2d1c
commit c95afbc
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 30 deletions.
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html
@@ -1182,8 +1182,8 @@ <h3>Method Details</h3>
   &quot;filter&quot;: &quot;A String&quot;, # Optional. Query to filter the documents based on https://google.aip.dev/160. ## Currently support query strings are: `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED` - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED` - `DisplayName=\&quot;file_name.pdf\&quot;` - `EntityType=abc/def` - `TagName=\&quot;auto-labeling-running\&quot;|\&quot;sampled\&quot;` Note: - Only `AND`, `=` and `!=` are supported. e.g. `DisplayName=file_name AND EntityType!=abc` IS supported. - Wildcard `*` is supported only in `DisplayName` filter - No duplicate filter keys are allowed, e.g. `EntityType=a AND EntityType=b` is NOT supported. - String match is case sensitive (for filter `DisplayName` &amp; `EntityType`).
   &quot;pageSize&quot;: 42, # The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100.
   &quot;pageToken&quot;: &quot;A String&quot;, # A page token, received from a previous `ListDocuments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDocuments` must match the call that provided the page token.
-  &quot;returnTotalSize&quot;: True or False, # Optional. Controls if the ListDocuments request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false.
-  &quot;skip&quot;: 42, # Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values wil be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, `ListDocumentsResponse.document_metadata` and `ListDocumentsResponse.next_page_token` will be empty.
+  &quot;returnTotalSize&quot;: True or False, # Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false.
+  &quot;skip&quot;: 42, # Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values will be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, ListDocumentsResponse.document_metadata and ListDocumentsResponse.next_page_token will be empty.
 }
 
   x__xgafv: string, V1 error format.
@@ -1213,11 +1213,11 @@ <h3>Method Details</h3>
           &quot;docId&quot;: &quot;A String&quot;, # Required. The id of the document.
         },
       },
-      &quot;labelingState&quot;: &quot;A String&quot;, # Labelling state of the document.
+      &quot;labelingState&quot;: &quot;A String&quot;, # Labeling state of the document.
       &quot;pageCount&quot;: 42, # Number of pages in the document.
     },
   ],
-  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
   &quot;totalSize&quot;: 42, # Total count of documents queried.
 }</pre>
 </div>

diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html
@@ -3234,7 +3234,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. Document AI Warehouse-based dataset configuration.
+  &quot;documentWarehouseConfig&quot;: { # Configuration specific to the Document AI Warehouse-based implementation. # Optional. Derepcated. Warehouse-based dataset configuration is not supported today.
     &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/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json
@@ -1042,7 +1042,7 @@
       }
     }
   },
-  "revision": "20231021",
+  "revision": "20231102",
   "rootUrl": "https://documentai.googleapis.com/",
   "schemas": {
     "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
@@ -1656,15 +1656,15 @@
       "type": "object"
     },
     "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": {
-      "description": "The metadata proto of ResyncDataset method.",
+      "description": "The metadata proto of `ResyncDataset` method.",
       "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata",
       "properties": {
         "commonMetadata": {
           "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
           "description": "The basic metadata of the long-running operation."
         },
         "datasetResyncStatuses": {
-          "description": "The list of dataset resync statuses. Not checked when `dataset_documents` is specified in ResyncRequest.",
+          "description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.",
           "items": {
             "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus"
           },
@@ -1698,7 +1698,7 @@
         },
         "status": {
           "$ref": "GoogleRpcStatus",
-          "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if `validate_only` is true in the request."
+          "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
         }
       },
       "type": "object"
@@ -1729,7 +1729,7 @@
         },
         "status": {
           "$ref": "GoogleRpcStatus",
-          "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if `validate_only` is true in the request."
+          "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
         }
       },
       "type": "object"
@@ -7675,7 +7675,8 @@
       "properties": {
         "documentWarehouseConfig": {
           "$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig",
-          "description": "Optional. Document AI Warehouse-based dataset configuration."
+          "deprecated": true,
+          "description": "Optional. Derepcated. Warehouse-based dataset configuration is not supported today."
         },
         "gcsManagedConfig": {
           "$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig",

diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json
@@ -292,7 +292,7 @@
       }
     }
   },
-  "revision": "20231021",
+  "revision": "20231102",
   "rootUrl": "https://documentai.googleapis.com/",
   "schemas": {
     "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
@@ -906,15 +906,15 @@
       "type": "object"
     },
     "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": {
-      "description": "The metadata proto of ResyncDataset method.",
+      "description": "The metadata proto of `ResyncDataset` method.",
       "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata",
       "properties": {
         "commonMetadata": {
           "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
           "description": "The basic metadata of the long-running operation."
         },
         "datasetResyncStatuses": {
-          "description": "The list of dataset resync statuses. Not checked when `dataset_documents` is specified in ResyncRequest.",
+          "description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.",
           "items": {
             "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus"
           },
@@ -948,7 +948,7 @@
         },
         "status": {
           "$ref": "GoogleRpcStatus",
-          "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if `validate_only` is true in the request."
+          "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
         }
       },
       "type": "object"
@@ -979,7 +979,7 @@
         },
         "status": {
           "$ref": "GoogleRpcStatus",
-          "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if `validate_only` is true in the request."
+          "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
         }
       },
       "type": "object"
@@ -4727,7 +4727,8 @@
       "properties": {
         "documentWarehouseConfig": {
           "$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig",
-          "description": "Optional. Document AI Warehouse-based dataset configuration."
+          "deprecated": true,
+          "description": "Optional. Derepcated. Warehouse-based dataset configuration is not supported today."
         },
         "gcsManagedConfig": {
           "$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig",

diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json
@@ -1284,7 +1284,7 @@
       }
     }
   },
-  "revision": "20231021",
+  "revision": "20231102",
   "rootUrl": "https://documentai.googleapis.com/",
   "schemas": {
     "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
@@ -1898,15 +1898,15 @@
       "type": "object"
     },
     "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": {
-      "description": "The metadata proto of ResyncDataset method.",
+      "description": "The metadata proto of `ResyncDataset` method.",
       "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata",
       "properties": {
         "commonMetadata": {
           "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
           "description": "The basic metadata of the long-running operation."
         },
         "datasetResyncStatuses": {
-          "description": "The list of dataset resync statuses. Not checked when `dataset_documents` is specified in ResyncRequest.",
+          "description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.",
           "items": {
             "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus"
           },
@@ -1940,7 +1940,7 @@
         },
         "status": {
           "$ref": "GoogleRpcStatus",
-          "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if `validate_only` is true in the request."
+          "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
         }
       },
       "type": "object"
@@ -1971,7 +1971,7 @@
         },
         "status": {
           "$ref": "GoogleRpcStatus",
-          "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if `validate_only` is true in the request."
+          "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
         }
       },
       "type": "object"
@@ -5695,7 +5695,8 @@
       "properties": {
         "documentWarehouseConfig": {
           "$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig",
-          "description": "Optional. Document AI Warehouse-based dataset configuration."
+          "deprecated": true,
+          "description": "Optional. Derepcated. Warehouse-based dataset configuration is not supported today."
         },
         "gcsManagedConfig": {
           "$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig",
@@ -6120,7 +6121,7 @@
           "description": "Document identifier."
         },
         "labelingState": {
-          "description": "Labelling state of the document.",
+          "description": "Labeling state of the document.",
           "enum": [
             "DOCUMENT_LABELING_STATE_UNSPECIFIED",
             "DOCUMENT_LABELED",
@@ -6129,9 +6130,9 @@
           ],
           "enumDescriptions": [
             "Default value if the enum is not set.",
-            "Document has been labelled.",
-            "Document has not been labelled.",
-            "Document has been auto-labelled."
+            "Document has been labeled.",
+            "Document has not been labeled.",
+            "Document has been auto-labeled."
           ],
           "type": "string"
         },
@@ -7904,11 +7905,11 @@
           "type": "string"
         },
         "returnTotalSize": {
-          "description": "Optional. Controls if the ListDocuments request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false.",
+          "description": "Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false.",
           "type": "boolean"
         },
         "skip": {
-          "description": "Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values wil be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, `ListDocumentsResponse.document_metadata` and `ListDocumentsResponse.next_page_token` will be empty.",
+          "description": "Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values will be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, ListDocumentsResponse.document_metadata and ListDocumentsResponse.next_page_token will be empty.",
           "format": "int32",
           "type": "integer"
         }
@@ -7926,7 +7927,7 @@
           "type": "array"
         },
         "nextPageToken": {
-          "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+          "description": "A token, which can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
           "type": "string"
         },
         "totalSize": {