feat(documentai): update the api

#### documentai:v1 The following keys were added: - schemas.GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty.properties.displayName.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1ProcessOptions.properties.schemaOverride.$ref (Total Keys: 1) #### documentai:v1beta3 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty.properties.displayName.type (Total Keys: 1)
googleapis · Mar 5, 2024 · 69f5b8b · 69f5b8b
1 parent 40cb6b1
commit 69f5b8b
Show file tree

Hide file tree

Showing 12 changed files with 184 additions and 27 deletions.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html
@@ -182,6 +182,38 @@ <h3>Method Details</h3>
         &quot;enableSelectionMarkDetection&quot;: True or False, # Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors.
       },
     },
+    &quot;schemaOverride&quot;: { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn&#x27;t support schema override.
+      &quot;description&quot;: &quot;A String&quot;, # Description of the schema.
+      &quot;displayName&quot;: &quot;A String&quot;, # Display name to show to users.
+      &quot;entityTypes&quot;: [ # Entity types of the schema.
+        { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+          &quot;baseTypes&quot;: [ # The entity type that this type is derived from. For now, one and only one should be set.
+            &quot;A String&quot;,
+          ],
+          &quot;displayName&quot;: &quot;A String&quot;, # User defined name for the type.
+          &quot;enumValues&quot;: { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is &gt;10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+            &quot;values&quot;: [ # The individual values that this enum values type can include.
+              &quot;A String&quot;,
+            ],
+          },
+          &quot;name&quot;: &quot;A String&quot;, # Name of the type. It must be unique within the schema file and cannot be a &quot;Common Type&quot;. The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+          &quot;properties&quot;: [ # Description the nested structure, or composition of an entity.
+            { # Defines properties that can be part of the entity type.
+              &quot;displayName&quot;: &quot;A String&quot;, # User defined name for the property.
+              &quot;name&quot;: &quot;A String&quot;, # The name of the property. Follows the same guidelines as the EntityType name.
+              &quot;occurrenceType&quot;: &quot;A String&quot;, # Occurrence type limits the number of instances an entity type appears in the document.
+              &quot;valueType&quot;: &quot;A String&quot;, # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+            },
+          ],
+        },
+      ],
+      &quot;metadata&quot;: { # Metadata for global schema behavior. # Metadata of the schema.
+        &quot;documentAllowMultipleLabels&quot;: True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+        &quot;documentSplitter&quot;: True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+        &quot;prefixedNamingOnProperties&quot;: True or False, # If set, all the nested entities must be prefixed with the parents.
+        &quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+      },
+    },
   },
   &quot;skipHumanReview&quot;: True or False, # Whether human review should be skipped for this request. Default to `false`.
 }
@@ -547,7 +579,7 @@ <h3>Method Details</h3>
         &quot;pageAnchor&quot;: { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
           &quot;pageRefs&quot;: [ # One or more references to visual page elements
             { # Represents a weak reference to a page element within a document.
-              &quot;boundingPoly&quot;: { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page.
+              &quot;boundingPoly&quot;: { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it&#x27;s referring to.
                 &quot;normalizedVertices&quot;: [ # The bounding polygon normalized vertices.
                   { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                     &quot;x&quot;: 3.14, # X coordinate.
@@ -1366,6 +1398,38 @@ <h3>Method Details</h3>
         &quot;enableSelectionMarkDetection&quot;: True or False, # Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors.
       },
     },
+    &quot;schemaOverride&quot;: { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn&#x27;t support schema override.
+      &quot;description&quot;: &quot;A String&quot;, # Description of the schema.
+      &quot;displayName&quot;: &quot;A String&quot;, # Display name to show to users.
+      &quot;entityTypes&quot;: [ # Entity types of the schema.
+        { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+          &quot;baseTypes&quot;: [ # The entity type that this type is derived from. For now, one and only one should be set.
+            &quot;A String&quot;,
+          ],
+          &quot;displayName&quot;: &quot;A String&quot;, # User defined name for the type.
+          &quot;enumValues&quot;: { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is &gt;10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+            &quot;values&quot;: [ # The individual values that this enum values type can include.
+              &quot;A String&quot;,
+            ],
+          },
+          &quot;name&quot;: &quot;A String&quot;, # Name of the type. It must be unique within the schema file and cannot be a &quot;Common Type&quot;. The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+          &quot;properties&quot;: [ # Description the nested structure, or composition of an entity.
+            { # Defines properties that can be part of the entity type.
+              &quot;displayName&quot;: &quot;A String&quot;, # User defined name for the property.
+              &quot;name&quot;: &quot;A String&quot;, # The name of the property. Follows the same guidelines as the EntityType name.
+              &quot;occurrenceType&quot;: &quot;A String&quot;, # Occurrence type limits the number of instances an entity type appears in the document.
+              &quot;valueType&quot;: &quot;A String&quot;, # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+            },
+          ],
+        },
+      ],
+      &quot;metadata&quot;: { # Metadata for global schema behavior. # Metadata of the schema.
+        &quot;documentAllowMultipleLabels&quot;: True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+        &quot;documentSplitter&quot;: True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+        &quot;prefixedNamingOnProperties&quot;: True or False, # If set, all the nested entities must be prefixed with the parents.
+        &quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+      },
+    },
   },
   &quot;rawDocument&quot;: { # Payload message of raw document content (bytes). # A raw document content (bytes).
     &quot;content&quot;: &quot;A String&quot;, # Inline document content.
@@ -1442,7 +1506,7 @@ <h3>Method Details</h3>
         &quot;pageAnchor&quot;: { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
           &quot;pageRefs&quot;: [ # One or more references to visual page elements
             { # Represents a weak reference to a page element within a document.
-              &quot;boundingPoly&quot;: { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page.
+              &quot;boundingPoly&quot;: { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it&#x27;s referring to.
                 &quot;normalizedVertices&quot;: [ # The bounding polygon normalized vertices.
                   { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                     &quot;x&quot;: 3.14, # X coordinate.

diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html
@@ -113,6 +113,7 @@ <h3>Method Details</h3>
         &quot;name&quot;: &quot;A String&quot;, # Name of the type. It must be unique within the schema file and cannot be a &quot;Common Type&quot;. The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
         &quot;properties&quot;: [ # Description the nested structure, or composition of an entity.
           { # Defines properties that can be part of the entity type.
+            &quot;displayName&quot;: &quot;A String&quot;, # User defined name for the property.
             &quot;name&quot;: &quot;A String&quot;, # The name of the property. Follows the same guidelines as the EntityType name.
             &quot;occurrenceType&quot;: &quot;A String&quot;, # Occurrence type limits the number of instances an entity type appears in the document.
             &quot;valueType&quot;: &quot;A String&quot;, # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
@@ -186,7 +187,7 @@ <h3>Method Details</h3>
         &quot;pageAnchor&quot;: { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
           &quot;pageRefs&quot;: [ # One or more references to visual page elements
             { # Represents a weak reference to a page element within a document.
-              &quot;boundingPoly&quot;: { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page.
+              &quot;boundingPoly&quot;: { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it&#x27;s referring to.
                 &quot;normalizedVertices&quot;: [ # The bounding polygon normalized vertices.
                   { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                     &quot;x&quot;: 3.14, # X coordinate.