feat: [google-cloud-documentai] Add API fields for the descriptions of entity type and property in the document schema (googleapis#13067)

gcf-owl-bot[bot] · parthea · web-flow · commit 1a2b325c0da9 · 2024-09-06T19:17:09.000-04:00
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 671472365 Source-Link: googleapis/googleapis@003e626 Source-Link: https://github.com/googleapis/googleapis-gen/commit/bf0196fe2004e1fbb1edf5aa8d8ada653e10d62c Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRvY3VtZW50YWkvLk93bEJvdC55YW1sIiwiaCI6ImJmMDE5NmZlMjAwNGUxZmJiMWVkZjVhYThkOGFkYTY1M2UxMGQ2MmMifQ== --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
diff --git a/packages/google-cloud-documentai/google/cloud/documentai_v1beta3/types/document_schema.py b/packages/google-cloud-documentai/google/cloud/documentai_v1beta3/types/document_schema.py
@@ -189,6 +189,10 @@ class EntityType(proto.Message):
                    type. For example ``line_item/amount``. This convention
                    is deprecated, but will still be honored for backward
                    compatibility.
+            description (str):
+                The description of the entity type. Could be
+                used to provide more information about the
+                entity type for model calls.
             base_types (MutableSequence[str]):
                 The entity type that this type is derived
                 from.  For now, one and only one should be set.
@@ -220,6 +224,10 @@ class Property(proto.Message):
                 name (str):
                     The name of the property.  Follows the same
                     guidelines as the EntityType name.
+                description (str):
+                    The description of the property. Could be
+                    used to provide more information about the
+                    property for model calls.
                 display_name (str):
                     User defined name for the property.
                 value_type (str):
@@ -274,6 +282,10 @@ class OccurrenceType(proto.Enum):
                 proto.STRING,
                 number=1,
             )
+            description: str = proto.Field(
+                proto.STRING,
+                number=7,
+            )
             display_name: str = proto.Field(
                 proto.STRING,
                 number=6,
@@ -309,6 +321,10 @@ class OccurrenceType(proto.Enum):
             proto.STRING,
             number=1,
         )
+        description: str = proto.Field(
+            proto.STRING,
+            number=15,
+        )
         base_types: MutableSequence[str] = proto.RepeatedField(
             proto.STRING,
             number=2,
diff --git a/packages/google-cloud-documentai/google/cloud/documentai_v1beta3/types/document_service.py b/packages/google-cloud-documentai/google/cloud/documentai_v1beta3/types/document_service.py
@@ -396,10 +396,8 @@ class ListDocumentsRequest(proto.Message):
             https://google.aip.dev/160.
 
             Currently support query strings are:
-            ------------------------------------
-
-            ``SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED``
 
+            - ``SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED``
             -  ``LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED``
             -  ``DisplayName=\"file_name.pdf\"``
             -  ``EntityType=abc/def``
diff --git a/packages/google-cloud-documentai/scripts/client-post-processing/doc-formatting.yaml b/packages/google-cloud-documentai/scripts/client-post-processing/doc-formatting.yaml
@@ -0,0 +1 @@
+../../../../scripts/client-post-processing/doc-formatting.yaml
diff --git a/packages/google-cloud-documentai/tests/unit/gapic/documentai_v1beta3/test_document_service.py b/packages/google-cloud-documentai/tests/unit/gapic/documentai_v1beta3/test_document_service.py
@@ -6117,10 +6117,12 @@ def test_update_dataset_schema_rest(request_type):
                     "enum_values": {"values": ["values_value1", "values_value2"]},
                     "display_name": "display_name_value",
                     "name": "name_value",
+                    "description": "description_value",
                     "base_types": ["base_types_value1", "base_types_value2"],
                     "properties": [
                         {
                             "name": "name_value",
+                            "description": "description_value",
                             "display_name": "display_name_value",
                             "value_type": "value_type_value",
                             "occurrence_type": 1,
diff --git a/scripts/client-post-processing/doc-formatting.yaml b/scripts/client-post-processing/doc-formatting.yaml
@@ -161,9 +161,20 @@ replacements:
     after: "                  'ingestionTime': DOUBLE; (UNIX timestamp)\n                  'application': STRING;\n"
     count: 2
   - paths: [
-    packages/google-cloud-visionai/google/cloud/visionai_v1/types/platform.py,
+      packages/google-cloud-visionai/google/cloud/visionai_v1/types/platform.py,
     ]
     before: "'processor': STRING;\n             }\n        dynamic_config_input_topic "
     after:  "'processor': STRING;\n\n             }\n\n        dynamic_config_input_topic "
     count: 1
-
+  - paths: [
+      packages/google-cloud-documentai/google/cloud/documentai_v1beta3/types/document_service.py,
+    ]
+    before: |
+      \n            Currently support query strings are:
+      \            ------------------------------------
+      \
+      \            ``SplitType=DATASET_SPLIT_TEST\|DATASET_SPLIT_TRAIN\|DATASET_SPLIT_UNASSIGNED``
+      \
+      \            -  ``LabelingState=DOCUMENT_LABELED\|DOCUMENT_UNLABELED\|DOCUMENT_AUTO_LABELED``
+    after:  "\n            Currently support query strings are:\n\n            - ``SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED``\n            -  ``LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED``\n"
+    count: 1

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+../../../../scripts/client-post-processing/doc-formatting.yaml`