feat(documentai): update the api

#### documentai:v1 The following keys were added: - schemas.GoogleCloudDocumentaiV1DocumentPageTable.properties.provenance.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta1DocumentPageTable.properties.provenance.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta2DocumentPageTable.properties.provenance.$ref (Total Keys: 1) #### documentai:v1beta2 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta1DocumentPageTable.properties.provenance.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta2DocumentPageTable.properties.provenance.$ref (Total Keys: 1) #### documentai:v1beta3 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta1DocumentPageTable.properties.provenance.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta2DocumentPageTable.properties.provenance.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta3DocumentPageTable.properties.provenance.$ref (Total Keys: 1)
googleapis · Oct 25, 2022 · 4a93526 · 4a93526
1 parent 421f03b
commit 4a93526
Show file tree

Hide file tree

Showing 11 changed files with 227 additions and 15 deletions.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html
@@ -130,7 +130,7 @@ <h3>Method Details</h3>
 { # Request message for batch process document method.
   &quot;documentOutputConfig&quot;: { # Config that controls the output of documents. All documents will be written as a JSON file. # The overall output config for batch process.
     &quot;gcsOutputConfig&quot;: { # The configuration used when outputting documents. # Output config to write the results to Cloud Storage.
-      &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in the output documents.
+      &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.
       &quot;gcsUri&quot;: &quot;A String&quot;, # The Cloud Storage uri (a directory) of the output.
     },
   },
@@ -424,7 +424,7 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # Request message for the process document method.
-  &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in ProcessResponse&#x27;s document.
+  &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in ProcessResponse&#x27;s document. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.
   &quot;inlineDocument&quot;: { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto.
     &quot;content&quot;: &quot;A String&quot;, # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
     &quot;entities&quot;: [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
@@ -1043,6 +1043,18 @@ <h3>Method Details</h3>
                 ],
               },
             },
+            &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+              &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              &quot;parents&quot;: [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  &quot;id&quot;: 42, # The id of the parent provenance.
+                  &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+                },
+              ],
+              &quot;revision&quot;: 42, # The index of the revision that produced this element.
+              &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+            },
           },
         ],
         &quot;tokens&quot;: [ # A list of visually detected tokens on the page.
@@ -1866,6 +1878,18 @@ <h3>Method Details</h3>
                 ],
               },
             },
+            &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+              &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              &quot;parents&quot;: [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  &quot;id&quot;: 42, # The id of the parent provenance.
+                  &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+                },
+              ],
+              &quot;revision&quot;: 42, # The index of the revision that produced this element.
+              &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+            },
           },
         ],
         &quot;tokens&quot;: [ # A list of visually detected tokens on the page.

diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html
@@ -766,6 +766,18 @@ <h3>Method Details</h3>
                 ],
               },
             },
+            &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+              &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              &quot;parents&quot;: [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  &quot;id&quot;: 42, # The id of the parent provenance.
+                  &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+                },
+              ],
+              &quot;revision&quot;: 42, # The index of the revision that produced this element.
+              &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+            },
           },
         ],
         &quot;tokens&quot;: [ # A list of visually detected tokens on the page.

diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
@@ -114,7 +114,7 @@ <h3>Method Details</h3>
 { # Request message for batch process document method.
   &quot;documentOutputConfig&quot;: { # Config that controls the output of documents. All documents will be written as a JSON file. # The overall output config for batch process.
     &quot;gcsOutputConfig&quot;: { # The configuration used when outputting documents. # Output config to write the results to Cloud Storage.
-      &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in the output documents.
+      &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.
       &quot;gcsUri&quot;: &quot;A String&quot;, # The Cloud Storage uri (a directory) of the output.
     },
   },
@@ -333,7 +333,7 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # Request message for the process document method.
-  &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in ProcessResponse&#x27;s document.
+  &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in ProcessResponse&#x27;s document. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.
   &quot;inlineDocument&quot;: { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto.
     &quot;content&quot;: &quot;A String&quot;, # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
     &quot;entities&quot;: [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
@@ -952,6 +952,18 @@ <h3>Method Details</h3>
                 ],
               },
             },
+            &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+              &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              &quot;parents&quot;: [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  &quot;id&quot;: 42, # The id of the parent provenance.
+                  &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+                },
+              ],
+              &quot;revision&quot;: 42, # The index of the revision that produced this element.
+              &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+            },
           },
         ],
         &quot;tokens&quot;: [ # A list of visually detected tokens on the page.
@@ -1775,6 +1787,18 @@ <h3>Method Details</h3>
                 ],
               },
             },
+            &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+              &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              &quot;parents&quot;: [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  &quot;id&quot;: 42, # The id of the parent provenance.
+                  &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+                },
+              ],
+              &quot;revision&quot;: 42, # The index of the revision that produced this element.
+              &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+            },
           },
         ],
         &quot;tokens&quot;: [ # A list of visually detected tokens on the page.

diff --git a/docs/dyn/documentai_v1beta2.projects.documents.html b/docs/dyn/documentai_v1beta2.projects.documents.html
@@ -909,6 +909,18 @@ <h3>Method Details</h3>
               ],
             },
           },
+          &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+            &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+            &quot;parents&quot;: [ # References to the original elements that are replaced.
+              { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                &quot;id&quot;: 42, # The id of the parent provenance.
+                &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+              },
+            ],
+            &quot;revision&quot;: 42, # The index of the revision that produced this element.
+            &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+          },
         },
       ],
       &quot;tokens&quot;: [ # A list of visually detected tokens on the page.

diff --git a/docs/dyn/documentai_v1beta2.projects.locations.documents.html b/docs/dyn/documentai_v1beta2.projects.locations.documents.html
@@ -909,6 +909,18 @@ <h3>Method Details</h3>
               ],
             },
           },
+          &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+            &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+            &quot;parents&quot;: [ # References to the original elements that are replaced.
+              { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                &quot;id&quot;: 42, # The id of the parent provenance.
+                &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+              },
+            ],
+            &quot;revision&quot;: 42, # The index of the revision that produced this element.
+            &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+          },
         },
       ],
       &quot;tokens&quot;: [ # A list of visually detected tokens on the page.

diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html
@@ -130,7 +130,7 @@ <h3>Method Details</h3>
 { # Request message for batch process document method.
   &quot;documentOutputConfig&quot;: { # Config that controls the output of documents. All documents will be written as a JSON file. # The overall output config for batch process.
     &quot;gcsOutputConfig&quot;: { # The configuration used when outputting documents. # Output config to write the results to Cloud Storage.
-      &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in the output documents.
+      &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.
       &quot;gcsUri&quot;: &quot;A String&quot;, # The Cloud Storage uri (a directory) of the output.
     },
   },
@@ -1051,6 +1051,18 @@ <h3>Method Details</h3>
                 ],
               },
             },
+            &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+              &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              &quot;parents&quot;: [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  &quot;id&quot;: 42, # The id of the parent provenance.
+                  &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+                },
+              ],
+              &quot;revision&quot;: 42, # The index of the revision that produced this element.
+              &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+            },
           },
         ],
         &quot;tokens&quot;: [ # A list of visually detected tokens on the page.
@@ -1240,7 +1252,7 @@ <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. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
   },
-  &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in ProcessResponse&#x27;s document.
+  &quot;fieldMask&quot;: &quot;A String&quot;, # Specifies which fields to include in ProcessResponse&#x27;s document. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.
   &quot;inlineDocument&quot;: { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto.
     &quot;content&quot;: &quot;A String&quot;, # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
     &quot;entities&quot;: [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
@@ -1859,6 +1871,18 @@ <h3>Method Details</h3>
                 ],
               },
             },
+            &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+              &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              &quot;parents&quot;: [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  &quot;id&quot;: 42, # The id of the parent provenance.
+                  &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+                },
+              ],
+              &quot;revision&quot;: 42, # The index of the revision that produced this element.
+              &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+            },
           },
         ],
         &quot;tokens&quot;: [ # A list of visually detected tokens on the page.
@@ -2682,6 +2706,18 @@ <h3>Method Details</h3>
                 ],
               },
             },
+            &quot;provenance&quot;: { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+              &quot;id&quot;: 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              &quot;parents&quot;: [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  &quot;id&quot;: 42, # The id of the parent provenance.
+                  &quot;index&quot;: 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  &quot;revision&quot;: 42, # The index of the index into current revision&#x27;s parent_ids list.
+                },
+              ],
+              &quot;revision&quot;: 42, # The index of the revision that produced this element.
+              &quot;type&quot;: &quot;A String&quot;, # The type of provenance operation.
+            },
           },
         ],
         &quot;tokens&quot;: [ # A list of visually detected tokens on the page.