feat(documentai): update the API

#### documentai:v1beta3 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3DatasetSchema.properties.satisfiesPzi.description - schemas.GoogleCloudDocumentaiV1beta3DatasetSchema.properties.satisfiesPzi.readOnly - schemas.GoogleCloudDocumentaiV1beta3DatasetSchema.properties.satisfiesPzi.type - schemas.GoogleCloudDocumentaiV1beta3DatasetSchema.properties.satisfiesPzs.description - schemas.GoogleCloudDocumentaiV1beta3DatasetSchema.properties.satisfiesPzs.readOnly - schemas.GoogleCloudDocumentaiV1beta3DatasetSchema.properties.satisfiesPzs.type - schemas.GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig.properties.returnBoundingBoxes.description - schemas.GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig.properties.returnBoundingBoxes.type - schemas.GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig.properties.returnImages.description - schemas.GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig.properties.returnImages.type The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description - schemas.GoogleTypePostalAddress.description - schemas.GoogleTypePostalAddress.properties.addressLines.description - schemas.GoogleTypePostalAddress.properties.administrativeArea.description - schemas.GoogleTypePostalAddress.properties.postalCode.description - schemas.GoogleTypePostalAddress.properties.sortingCode.description - schemas.GoogleTypeTimeZone.properties.id.description - schemas.GoogleTypeTimeZone.properties.version.description #### documentai:v1 The following keys were added: - schemas.GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig.properties.returnBoundingBoxes.description - schemas.GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig.properties.returnBoundingBoxes.type - schemas.GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig.properties.returnImages.description - schemas.GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig.properties.returnImages.type The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description - schemas.GoogleTypePostalAddress.description - schemas.GoogleTypePostalAddress.properties.addressLines.description - schemas.GoogleTypePostalAddress.properties.administrativeArea.description - schemas.GoogleTypePostalAddress.properties.postalCode.description - schemas.GoogleTypePostalAddress.properties.sortingCode.description - schemas.GoogleTypeTimeZone.properties.id.description - schemas.GoogleTypeTimeZone.properties.version.description
googleapis · Jan 29, 2025 · 2a68556 · 2a68556
1 parent 86ecb77
commit 2a68556
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 34 deletions.
diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json
@@ -234,7 +234,7 @@
             "operations": {
               "methods": {
                 "cancel": {
-                  "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
+                  "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
                   "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
                   "httpMethod": "POST",
                   "id": "documentai.projects.locations.operations.cancel",
@@ -1042,7 +1042,7 @@
       }
     }
   },
-  "revision": "20240911",
+  "revision": "20250117",
   "rootUrl": "https://documentai.googleapis.com/",
   "schemas": {
     "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
@@ -4438,6 +4438,14 @@
         "chunkingConfig": {
           "$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig",
           "description": "Optional. Config for chunking in layout parser processor."
+        },
+        "returnBoundingBoxes": {
+          "description": "Optional. Whether to include bounding boxes in layout parser processor response.",
+          "type": "boolean"
+        },
+        "returnImages": {
+          "description": "Optional. Whether to include images in layout parser processor response.",
+          "type": "boolean"
         }
       },
       "type": "object"
@@ -6188,18 +6196,18 @@
       "type": "object"
     },
     "GoogleTypePostalAddress": {
-      "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478",
+      "description": "Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478",
       "id": "GoogleTypePostalAddress",
       "properties": {
         "addressLines": {
-          "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
+          "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
           "items": {
             "type": "string"
           },
           "type": "array"
         },
         "administrativeArea": {
-          "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.",
+          "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.",
           "type": "string"
         },
         "languageCode": {
@@ -6215,7 +6223,7 @@
           "type": "string"
         },
         "postalCode": {
-          "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).",
+          "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).",
           "type": "string"
         },
         "recipients": {
@@ -6235,7 +6243,7 @@
           "type": "integer"
         },
         "sortingCode": {
-          "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).",
+          "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (For example \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (For example Côte d'Ivoire).",
           "type": "string"
         },
         "sublocality": {
@@ -6250,11 +6258,11 @@
       "id": "GoogleTypeTimeZone",
       "properties": {
         "id": {
-          "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".",
+          "description": "IANA Time Zone Database time zone. For example \"America/New_York\".",
           "type": "string"
         },
         "version": {
-          "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".",
+          "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".",
           "type": "string"
         }
       },