Skip to content

Commit ed08e4d

Browse files
yoshi-automationyoshi-automation
committed
feat(documentai): update the api
#### documentai:v1 The following keys were deleted: - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.newlyAddedDocuments (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument (Total Keys: 5) The following keys were added: - schemas.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata.properties.errorDocumentCount (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1DocumentSchemaEntityType.properties.entityTypeMetadata.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty.properties.propertyMetadata.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1EntityTypeMetadata (Total Keys: 6) - schemas.GoogleCloudDocumentaiV1HumanReviewLabelingMetadata (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1HumanReviewValidationMetadata (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1PropertyMetadata (Total Keys: 5) #### documentai:v1beta2 The following keys were deleted: - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.newlyAddedDocuments (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument (Total Keys: 5) The following keys were added: - schemas.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata.properties.errorDocumentCount (Total Keys: 2) #### documentai:v1beta3 The following keys were deleted: - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.newlyAddedDocuments (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument (Total Keys: 5) The following keys were added: - schemas.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata.properties.errorDocumentCount (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType.properties.entityTypeMetadata.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty.properties.propertyMetadata.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta3EntityTypeMetadata (Total Keys: 6) - schemas.GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1beta3PropertyMetadata (Total Keys: 5)
1 parent df97345 commit ed08e4d

File tree

5 files changed

+217
-84
lines changed

5 files changed

+217
-84
lines changed

‎docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,17 @@ <h3>Method Details</h3>
105105
&quot;A String&quot;,
106106
],
107107
&quot;displayName&quot;: &quot;A String&quot;, # User defined name for the type.
108+
&quot;entityTypeMetadata&quot;: { # Metadata about an entity type. # Metadata for the entity type.
109+
&quot;humanReviewLabelingMetadata&quot;: { # Metadata for human review labeling config. # Human review labeling config on the property.
110+
&quot;enableNormalizationEditing&quot;: True or False, # Whether to enable normalization editing.
111+
},
112+
&quot;humanReviewMetadata&quot;: { # Metadata for Human Review config. # Human review config on the entity type.
113+
&quot;confidenceThreshold&quot;: 3.14, # The confidence threshold if human review validation is enabled.
114+
&quot;enableValidation&quot;: True or False, # Whether to enable human review validation.
115+
},
116+
&quot;inactive&quot;: True or False, # Whether the entity type should be considered as &quot;inactive&quot;.
117+
&quot;prefixedNamingOnProperties&quot;: True or False, # If set, the properties of this entity type must be prefixed with the parents.
118+
},
108119
&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.
109120
&quot;values&quot;: [ # The individual values that this enum values type can include.
110121
&quot;A String&quot;,
@@ -115,6 +126,16 @@ <h3>Method Details</h3>
115126
{ # Defines properties that can be part of the entity type.
116127
&quot;name&quot;: &quot;A String&quot;, # The name of the property. Follows the same guidelines as the EntityType name.
117128
&quot;occurrenceType&quot;: &quot;A String&quot;, # Occurrence type limits the number of instances an entity type appears in the document.
129+
&quot;propertyMetadata&quot;: { # Metadata about a property. # Any additional metadata about the property can be added here.
130+
&quot;humanReviewLabelingMetadata&quot;: { # Metadata for human review labeling config. # Human review labeling config on the property.
131+
&quot;enableNormalizationEditing&quot;: True or False, # Whether to enable normalization editing.
132+
},
133+
&quot;humanReviewMetadata&quot;: { # Metadata for Human Review config. # Human review validation config on the property.
134+
&quot;confidenceThreshold&quot;: 3.14, # The confidence threshold if human review validation is enabled.
135+
&quot;enableValidation&quot;: True or False, # Whether to enable human review validation.
136+
},
137+
&quot;inactive&quot;: True or False, # Whether the property should be considered as &quot;inactive&quot;.
138+
},
118139
&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.
119140
},
120141
],

‎docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -902,6 +902,17 @@ <h3>Method Details</h3>
902902
&quot;A String&quot;,
903903
],
904904
&quot;displayName&quot;: &quot;A String&quot;, # User defined name for the type.
905+
&quot;entityTypeMetadata&quot;: { # Metadata about an entity type. # Metadata for the entity type.
906+
&quot;humanReviewLabelingMetadata&quot;: { # Metadata for human review labeling config. # Human review labeling config on the property.
907+
&quot;enableNormalizationEditing&quot;: True or False, # Whether to enable normalization editing.
908+
},
909+
&quot;humanReviewMetadata&quot;: { # Metadata for Human Review config. # Human review config on the entity type.
910+
&quot;confidenceThreshold&quot;: 3.14, # The confidence threshold if human review validation is enabled.
911+
&quot;enableValidation&quot;: True or False, # Whether to enable human review validation.
912+
},
913+
&quot;inactive&quot;: True or False, # Whether the entity type should be considered as &quot;inactive&quot;.
914+
&quot;prefixedNamingOnProperties&quot;: True or False, # If set, the properties of this entity type must be prefixed with the parents.
915+
},
905916
&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.
906917
&quot;values&quot;: [ # The individual values that this enum values type can include.
907918
&quot;A String&quot;,
@@ -912,6 +923,16 @@ <h3>Method Details</h3>
912923
{ # Defines properties that can be part of the entity type.
913924
&quot;name&quot;: &quot;A String&quot;, # The name of the property. Follows the same guidelines as the EntityType name.
914925
&quot;occurrenceType&quot;: &quot;A String&quot;, # Occurrence type limits the number of instances an entity type appears in the document.
926+
&quot;propertyMetadata&quot;: { # Metadata about a property. # Any additional metadata about the property can be added here.
927+
&quot;humanReviewLabelingMetadata&quot;: { # Metadata for human review labeling config. # Human review labeling config on the property.
928+
&quot;enableNormalizationEditing&quot;: True or False, # Whether to enable normalization editing.
929+
},
930+
&quot;humanReviewMetadata&quot;: { # Metadata for Human Review config. # Human review validation config on the property.
931+
&quot;confidenceThreshold&quot;: 3.14, # The confidence threshold if human review validation is enabled.
932+
&quot;enableValidation&quot;: True or False, # Whether to enable human review validation.
933+
},
934+
&quot;inactive&quot;: True or False, # Whether the property should be considered as &quot;inactive&quot;.
935+
},
915936
&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.
916937
},
917938
],

‎googleapiclient/discovery_cache/documents/documentai.v1.json

Lines changed: 84 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1069,7 +1069,7 @@
10691069
}
10701070
}
10711071
},
1072-
"revision": "20220815",
1072+
"revision": "20220821",
10731073
"rootUrl": "https://documentai.googleapis.com/",
10741074
"schemas": {
10751075
"GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": {
@@ -1079,6 +1079,11 @@
10791079
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
10801080
"description": "The basic metadata of the long running operation."
10811081
},
1082+
"errorDocumentCount": {
1083+
"description": "Total number of documents that failed to be deleted in storage.",
1084+
"format": "int32",
1085+
"type": "integer"
1086+
},
10821087
"individualBatchDeleteStatuses": {
10831088
"description": "The list of response details of each document.",
10841089
"items": {
@@ -1440,7 +1445,7 @@
14401445
"type": "object"
14411446
},
14421447
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": {
1443-
"description": "The validation status of each import config. Status is ok if the configuration is valid and the specified documents are valid for importing. Otherwise status will be set as errors.",
1448+
"description": "The validation status of each import config. Status is set to errors if there is no documents to import in the import_config, or OK if the operation will try to proceed at least one document.",
14441449
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult",
14451450
"properties": {
14461451
"inputGcsSource": {
@@ -1500,13 +1505,6 @@
15001505
"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus"
15011506
},
15021507
"type": "array"
1503-
},
1504-
"newlyAddedDocuments": {
1505-
"description": "Returns the newly added document Cloud Storage prefix if the documents are founded in Cloud Storage while not in Document Service storage.",
1506-
"items": {
1507-
"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument"
1508-
},
1509-
"type": "array"
15101508
}
15111509
},
15121510
"type": "object"
@@ -1565,25 +1563,6 @@
15651563
},
15661564
"type": "object"
15671565
},
1568-
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument": {
1569-
"description": "The proto for updated document in resync pipeline.",
1570-
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument",
1571-
"properties": {
1572-
"destinationPrefix": {
1573-
"description": "The prefix of cloud storage, identifies the destination document which should be updated by resync pipeline.",
1574-
"type": "string"
1575-
},
1576-
"sourcePrefix": {
1577-
"description": "The prefix of cloud storage, identifies the original document which should be updated by resync pipeline.",
1578-
"type": "string"
1579-
},
1580-
"status": {
1581-
"$ref": "GoogleRpcStatus",
1582-
"description": "The final status of the documents which should be updated by resync pipeline."
1583-
}
1584-
},
1585-
"type": "object"
1586-
},
15871566
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": {
15881567
"description": "The response proto of ResyncDataset method.",
15891568
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse",
@@ -2975,6 +2954,10 @@
29752954
"description": "User defined name for the type.",
29762955
"type": "string"
29772956
},
2957+
"entityTypeMetadata": {
2958+
"$ref": "GoogleCloudDocumentaiV1EntityTypeMetadata",
2959+
"description": "Metadata for the entity type."
2960+
},
29782961
"enumValues": {
29792962
"$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues",
29802963
"description": "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 >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
@@ -3033,6 +3016,10 @@
30333016
],
30343017
"type": "string"
30353018
},
3019+
"propertyMetadata": {
3020+
"$ref": "GoogleCloudDocumentaiV1PropertyMetadata",
3021+
"description": "Any additional metadata about the property can be added here."
3022+
},
30363023
"valueType": {
30373024
"description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.",
30383025
"type": "string"
@@ -3216,6 +3203,29 @@
32163203
"properties": {},
32173204
"type": "object"
32183205
},
3206+
"GoogleCloudDocumentaiV1EntityTypeMetadata": {
3207+
"description": "Metadata about an entity type.",
3208+
"id": "GoogleCloudDocumentaiV1EntityTypeMetadata",
3209+
"properties": {
3210+
"humanReviewLabelingMetadata": {
3211+
"$ref": "GoogleCloudDocumentaiV1HumanReviewLabelingMetadata",
3212+
"description": "Human review labeling config on the property."
3213+
},
3214+
"humanReviewMetadata": {
3215+
"$ref": "GoogleCloudDocumentaiV1HumanReviewValidationMetadata",
3216+
"description": "Human review config on the entity type."
3217+
},
3218+
"inactive": {
3219+
"description": "Whether the entity type should be considered as \"inactive\".",
3220+
"type": "boolean"
3221+
},
3222+
"prefixedNamingOnProperties": {
3223+
"description": "If set, the properties of this entity type must be prefixed with the parents.",
3224+
"type": "boolean"
3225+
}
3226+
},
3227+
"type": "object"
3228+
},
32193229
"GoogleCloudDocumentaiV1FetchProcessorTypesResponse": {
32203230
"description": "Response message for fetch processor types.",
32213231
"id": "GoogleCloudDocumentaiV1FetchProcessorTypesResponse",
@@ -3270,6 +3280,17 @@
32703280
},
32713281
"type": "object"
32723282
},
3283+
"GoogleCloudDocumentaiV1HumanReviewLabelingMetadata": {
3284+
"description": "Metadata for human review labeling config.",
3285+
"id": "GoogleCloudDocumentaiV1HumanReviewLabelingMetadata",
3286+
"properties": {
3287+
"enableNormalizationEditing": {
3288+
"description": "Whether to enable normalization editing.",
3289+
"type": "boolean"
3290+
}
3291+
},
3292+
"type": "object"
3293+
},
32733294
"GoogleCloudDocumentaiV1HumanReviewStatus": {
32743295
"description": "The status of human review on a processed document.",
32753296
"id": "GoogleCloudDocumentaiV1HumanReviewStatus",
@@ -3303,6 +3324,22 @@
33033324
},
33043325
"type": "object"
33053326
},
3327+
"GoogleCloudDocumentaiV1HumanReviewValidationMetadata": {
3328+
"description": "Metadata for Human Review config.",
3329+
"id": "GoogleCloudDocumentaiV1HumanReviewValidationMetadata",
3330+
"properties": {
3331+
"confidenceThreshold": {
3332+
"description": "The confidence threshold if human review validation is enabled.",
3333+
"format": "float",
3334+
"type": "number"
3335+
},
3336+
"enableValidation": {
3337+
"description": "Whether to enable human review validation.",
3338+
"type": "boolean"
3339+
}
3340+
},
3341+
"type": "object"
3342+
},
33063343
"GoogleCloudDocumentaiV1ListProcessorTypesResponse": {
33073344
"description": "Response message for list processor types.",
33083345
"id": "GoogleCloudDocumentaiV1ListProcessorTypesResponse",
@@ -3617,6 +3654,25 @@
36173654
},
36183655
"type": "object"
36193656
},
3657+
"GoogleCloudDocumentaiV1PropertyMetadata": {
3658+
"description": "Metadata about a property.",
3659+
"id": "GoogleCloudDocumentaiV1PropertyMetadata",
3660+
"properties": {
3661+
"humanReviewLabelingMetadata": {
3662+
"$ref": "GoogleCloudDocumentaiV1HumanReviewLabelingMetadata",
3663+
"description": "Human review labeling config on the property."
3664+
},
3665+
"humanReviewMetadata": {
3666+
"$ref": "GoogleCloudDocumentaiV1HumanReviewValidationMetadata",
3667+
"description": "Human review validation config on the property."
3668+
},
3669+
"inactive": {
3670+
"description": "Whether the property should be considered as \"inactive\".",
3671+
"type": "boolean"
3672+
}
3673+
},
3674+
"type": "object"
3675+
},
36203676
"GoogleCloudDocumentaiV1RawDocument": {
36213677
"description": "Payload message of raw document content (bytes).",
36223678
"id": "GoogleCloudDocumentaiV1RawDocument",

‎googleapiclient/discovery_cache/documents/documentai.v1beta2.json

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@
292292
}
293293
}
294294
},
295-
"revision": "20220815",
295+
"revision": "20220821",
296296
"rootUrl": "https://documentai.googleapis.com/",
297297
"schemas": {
298298
"GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": {
@@ -302,6 +302,11 @@
302302
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
303303
"description": "The basic metadata of the long running operation."
304304
},
305+
"errorDocumentCount": {
306+
"description": "Total number of documents that failed to be deleted in storage.",
307+
"format": "int32",
308+
"type": "integer"
309+
},
305310
"individualBatchDeleteStatuses": {
306311
"description": "The list of response details of each document.",
307312
"items": {
@@ -663,7 +668,7 @@
663668
"type": "object"
664669
},
665670
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": {
666-
"description": "The validation status of each import config. Status is ok if the configuration is valid and the specified documents are valid for importing. Otherwise status will be set as errors.",
671+
"description": "The validation status of each import config. Status is set to errors if there is no documents to import in the import_config, or OK if the operation will try to proceed at least one document.",
667672
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult",
668673
"properties": {
669674
"inputGcsSource": {
@@ -723,13 +728,6 @@
723728
"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus"
724729
},
725730
"type": "array"
726-
},
727-
"newlyAddedDocuments": {
728-
"description": "Returns the newly added document Cloud Storage prefix if the documents are founded in Cloud Storage while not in Document Service storage.",
729-
"items": {
730-
"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument"
731-
},
732-
"type": "array"
733731
}
734732
},
735733
"type": "object"
@@ -788,25 +786,6 @@
788786
},
789787
"type": "object"
790788
},
791-
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument": {
792-
"description": "The proto for updated document in resync pipeline.",
793-
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument",
794-
"properties": {
795-
"destinationPrefix": {
796-
"description": "The prefix of cloud storage, identifies the destination document which should be updated by resync pipeline.",
797-
"type": "string"
798-
},
799-
"sourcePrefix": {
800-
"description": "The prefix of cloud storage, identifies the original document which should be updated by resync pipeline.",
801-
"type": "string"
802-
},
803-
"status": {
804-
"$ref": "GoogleRpcStatus",
805-
"description": "The final status of the documents which should be updated by resync pipeline."
806-
}
807-
},
808-
"type": "object"
809-
},
810789
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": {
811790
"description": "The response proto of ResyncDataset method.",
812791
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse",

0 commit comments

Comments
 (0)