google-apis-documentai_v1beta3 0.115.0 → 0.117.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -23,7 +23,7 @@ module Google
23
23
  module DocumentaiV1beta3
24
24
 
25
25
  # Definition of the validation rules. Those are the input to the validator logic
26
- # and they are used to validate a document.
26
+ # and they are used to validate a document. Next ID: 3
27
27
  class CloudAiDocumentaiLabHifiaToolsValidationValidatorInput
28
28
  include Google::Apis::Core::Hashable
29
29
 
@@ -42,7 +42,7 @@ module Google
42
42
  end
43
43
  end
44
44
 
45
- #
45
+ # Next ID: 9
46
46
  class CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule
47
47
  include Google::Apis::Core::Hashable
48
48
 
@@ -81,6 +81,11 @@ module Google
81
81
  # @return [String]
82
82
  attr_accessor :name
83
83
 
84
+ # Unique identifier of the rule. Optional.
85
+ # Corresponds to the JSON property `ruleId`
86
+ # @return [String]
87
+ attr_accessor :rule_id
88
+
84
89
  def initialize(**args)
85
90
  update!(**args)
86
91
  end
@@ -94,6 +99,7 @@ module Google
94
99
  @field_regex = args[:field_regex] if args.key?(:field_regex)
95
100
  @form_validation = args[:form_validation] if args.key?(:form_validation)
96
101
  @name = args[:name] if args.key?(:name)
102
+ @rule_id = args[:rule_id] if args.key?(:rule_id)
97
103
  end
98
104
  end
99
105
 
@@ -922,14 +928,29 @@ module Google
922
928
  end
923
929
  end
924
930
 
925
- # The long-running operation metadata for the EnableProcessor method.
926
- class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
931
+ # The schema defines the output of the processed document by a processor.
932
+ class GoogleCloudDocumentaiUiv1beta3DocumentSchema
927
933
  include Google::Apis::Core::Hashable
928
934
 
929
- # The common metadata for long running operations.
930
- # Corresponds to the JSON property `commonMetadata`
931
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
932
- attr_accessor :common_metadata
935
+ # Description of the schema.
936
+ # Corresponds to the JSON property `description`
937
+ # @return [String]
938
+ attr_accessor :description
939
+
940
+ # Display name to show to users.
941
+ # Corresponds to the JSON property `displayName`
942
+ # @return [String]
943
+ attr_accessor :display_name
944
+
945
+ # Entity types of the schema.
946
+ # Corresponds to the JSON property `entityTypes`
947
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType>]
948
+ attr_accessor :entity_types
949
+
950
+ # Metadata for global schema behavior.
951
+ # Corresponds to the JSON property `metadata`
952
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata]
953
+ attr_accessor :metadata
933
954
 
934
955
  def initialize(**args)
935
956
  update!(**args)
@@ -937,32 +958,87 @@ module Google
937
958
 
938
959
  # Update properties of this object
939
960
  def update!(**args)
940
- @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
961
+ @description = args[:description] if args.key?(:description)
962
+ @display_name = args[:display_name] if args.key?(:display_name)
963
+ @entity_types = args[:entity_types] if args.key?(:entity_types)
964
+ @metadata = args[:metadata] if args.key?(:metadata)
941
965
  end
942
966
  end
943
967
 
944
- # Response message for the EnableProcessor method. Intentionally empty proto for
945
- # adding fields in future.
946
- class GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse
968
+ # EntityType is the wrapper of a label of the corresponding model with detailed
969
+ # attributes and limitations for entity-based processors. Multiple types can
970
+ # also compose a dependency tree to represent nested types.
971
+ class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType
947
972
  include Google::Apis::Core::Hashable
948
973
 
974
+ # The entity type that this type is derived from. For now, one and only one
975
+ # should be set.
976
+ # Corresponds to the JSON property `baseTypes`
977
+ # @return [Array<String>]
978
+ attr_accessor :base_types
979
+
980
+ # The description of the entity type. Could be used to provide more information
981
+ # about the entity type for model calls.
982
+ # Corresponds to the JSON property `description`
983
+ # @return [String]
984
+ attr_accessor :description
985
+
986
+ # User defined name for the type.
987
+ # Corresponds to the JSON property `displayName`
988
+ # @return [String]
989
+ attr_accessor :display_name
990
+
991
+ # Metadata about an entity type.
992
+ # Corresponds to the JSON property `entityTypeMetadata`
993
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata]
994
+ attr_accessor :entity_type_metadata
995
+
996
+ # Defines the a list of enum values.
997
+ # Corresponds to the JSON property `enumValues`
998
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues]
999
+ attr_accessor :enum_values
1000
+
1001
+ # Name of the type. It must be unique within the schema file and cannot be a "
1002
+ # Common Type". The following naming conventions are used: - Use `snake_casing`.
1003
+ # - Name matching is case-sensitive. - Maximum 64 characters. - Must start with
1004
+ # a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
1005
+ # compatibility internal infrastructure and tooling can handle any ascii
1006
+ # character.) - The `/` is sometimes used to denote a property of a type. For
1007
+ # example `line_item/amount`. This convention is deprecated, but will still be
1008
+ # honored for backward compatibility.
1009
+ # Corresponds to the JSON property `name`
1010
+ # @return [String]
1011
+ attr_accessor :name
1012
+
1013
+ # Description the nested structure, or composition of an entity.
1014
+ # Corresponds to the JSON property `properties`
1015
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty>]
1016
+ attr_accessor :properties
1017
+
949
1018
  def initialize(**args)
950
1019
  update!(**args)
951
1020
  end
952
1021
 
953
1022
  # Update properties of this object
954
1023
  def update!(**args)
1024
+ @base_types = args[:base_types] if args.key?(:base_types)
1025
+ @description = args[:description] if args.key?(:description)
1026
+ @display_name = args[:display_name] if args.key?(:display_name)
1027
+ @entity_type_metadata = args[:entity_type_metadata] if args.key?(:entity_type_metadata)
1028
+ @enum_values = args[:enum_values] if args.key?(:enum_values)
1029
+ @name = args[:name] if args.key?(:name)
1030
+ @properties = args[:properties] if args.key?(:properties)
955
1031
  end
956
1032
  end
957
1033
 
958
- # Metadata of the EvaluateProcessorVersion method.
959
- class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata
1034
+ # Defines the a list of enum values.
1035
+ class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues
960
1036
  include Google::Apis::Core::Hashable
961
1037
 
962
- # The common metadata for long running operations.
963
- # Corresponds to the JSON property `commonMetadata`
964
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
965
- attr_accessor :common_metadata
1038
+ # The individual values that this enum values type can include.
1039
+ # Corresponds to the JSON property `values`
1040
+ # @return [Array<String>]
1041
+ attr_accessor :values
966
1042
 
967
1043
  def initialize(**args)
968
1044
  update!(**args)
@@ -970,47 +1046,51 @@ module Google
970
1046
 
971
1047
  # Update properties of this object
972
1048
  def update!(**args)
973
- @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1049
+ @values = args[:values] if args.key?(:values)
974
1050
  end
975
1051
  end
976
1052
 
977
- # Response of the EvaluateProcessorVersion method.
978
- class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
1053
+ # Defines properties that can be part of the entity type.
1054
+ class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty
979
1055
  include Google::Apis::Core::Hashable
980
1056
 
981
- # The resource name of the created evaluation.
982
- # Corresponds to the JSON property `evaluation`
1057
+ # The description of the property. Could be used to provide more information
1058
+ # about the property for model calls.
1059
+ # Corresponds to the JSON property `description`
983
1060
  # @return [String]
984
- attr_accessor :evaluation
1061
+ attr_accessor :description
985
1062
 
986
- def initialize(**args)
987
- update!(**args)
988
- end
1063
+ # User defined name for the property.
1064
+ # Corresponds to the JSON property `displayName`
1065
+ # @return [String]
1066
+ attr_accessor :display_name
989
1067
 
990
- # Update properties of this object
991
- def update!(**args)
992
- @evaluation = args[:evaluation] if args.key?(:evaluation)
993
- end
994
- end
1068
+ # Specifies how the entity's value is obtained.
1069
+ # Corresponds to the JSON property `method`
1070
+ # @return [String]
1071
+ attr_accessor :method_prop
995
1072
 
996
- # Metadata of the batch export documents operation.
997
- class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata
998
- include Google::Apis::Core::Hashable
1073
+ # The name of the property. Follows the same guidelines as the EntityType name.
1074
+ # Corresponds to the JSON property `name`
1075
+ # @return [String]
1076
+ attr_accessor :name
999
1077
 
1000
- # The common metadata for long running operations.
1001
- # Corresponds to the JSON property `commonMetadata`
1002
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1003
- attr_accessor :common_metadata
1078
+ # Occurrence type limits the number of instances an entity type appears in the
1079
+ # document.
1080
+ # Corresponds to the JSON property `occurrenceType`
1081
+ # @return [String]
1082
+ attr_accessor :occurrence_type
1004
1083
 
1005
- # The list of response details of each document.
1006
- # Corresponds to the JSON property `individualExportStatuses`
1007
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus>]
1008
- attr_accessor :individual_export_statuses
1084
+ # Metadata about a property.
1085
+ # Corresponds to the JSON property `propertyMetadata`
1086
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3PropertyMetadata]
1087
+ attr_accessor :property_metadata
1009
1088
 
1010
- # The list of statistics for each dataset split type.
1011
- # Corresponds to the JSON property `splitExportStats`
1012
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat>]
1013
- attr_accessor :split_export_stats
1089
+ # A reference to the value type of the property. This type is subject to the
1090
+ # same conventions as the `Entity.base_types` field.
1091
+ # Corresponds to the JSON property `valueType`
1092
+ # @return [String]
1093
+ attr_accessor :value_type
1014
1094
 
1015
1095
  def initialize(**args)
1016
1096
  update!(**args)
@@ -1018,36 +1098,47 @@ module Google
1018
1098
 
1019
1099
  # Update properties of this object
1020
1100
  def update!(**args)
1021
- @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1022
- @individual_export_statuses = args[:individual_export_statuses] if args.key?(:individual_export_statuses)
1023
- @split_export_stats = args[:split_export_stats] if args.key?(:split_export_stats)
1101
+ @description = args[:description] if args.key?(:description)
1102
+ @display_name = args[:display_name] if args.key?(:display_name)
1103
+ @method_prop = args[:method_prop] if args.key?(:method_prop)
1104
+ @name = args[:name] if args.key?(:name)
1105
+ @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
1106
+ @property_metadata = args[:property_metadata] if args.key?(:property_metadata)
1107
+ @value_type = args[:value_type] if args.key?(:value_type)
1024
1108
  end
1025
1109
  end
1026
1110
 
1027
- # The status of each individual document in the export process.
1028
- class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus
1111
+ # Metadata for global schema behavior.
1112
+ class GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata
1029
1113
  include Google::Apis::Core::Hashable
1030
1114
 
1031
- # Document Identifier.
1032
- # Corresponds to the JSON property `documentId`
1033
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId]
1034
- attr_accessor :document_id
1115
+ # If true, on a given page, there can be multiple `document` annotations
1116
+ # covering it.
1117
+ # Corresponds to the JSON property `documentAllowMultipleLabels`
1118
+ # @return [Boolean]
1119
+ attr_accessor :document_allow_multiple_labels
1120
+ alias_method :document_allow_multiple_labels?, :document_allow_multiple_labels
1035
1121
 
1036
- # The output_gcs_destination of the exported document if it was successful,
1037
- # otherwise empty.
1038
- # Corresponds to the JSON property `outputGcsDestination`
1039
- # @return [String]
1040
- attr_accessor :output_gcs_destination
1122
+ # If true, a `document` entity type can be applied to subdocument (splitting).
1123
+ # Otherwise, it can only be applied to the entire document (classification).
1124
+ # Corresponds to the JSON property `documentSplitter`
1125
+ # @return [Boolean]
1126
+ attr_accessor :document_splitter
1127
+ alias_method :document_splitter?, :document_splitter
1041
1128
 
1042
- # The `Status` type defines a logical error model that is suitable for different
1043
- # programming environments, including REST APIs and RPC APIs. It is used by [
1044
- # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1045
- # data: error code, error message, and error details. You can find out more
1046
- # about this error model and how to work with it in the [API Design Guide](https:
1047
- # //cloud.google.com/apis/design/errors).
1048
- # Corresponds to the JSON property `status`
1049
- # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
1050
- attr_accessor :status
1129
+ # If set, all the nested entities must be prefixed with the parents.
1130
+ # Corresponds to the JSON property `prefixedNamingOnProperties`
1131
+ # @return [Boolean]
1132
+ attr_accessor :prefixed_naming_on_properties
1133
+ alias_method :prefixed_naming_on_properties?, :prefixed_naming_on_properties
1134
+
1135
+ # If set, we will skip the naming format validation in the schema. So the string
1136
+ # values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.
1137
+ # Property.name` will not be checked.
1138
+ # Corresponds to the JSON property `skipNamingValidation`
1139
+ # @return [Boolean]
1140
+ attr_accessor :skip_naming_validation
1141
+ alias_method :skip_naming_validation?, :skip_naming_validation
1051
1142
 
1052
1143
  def initialize(**args)
1053
1144
  update!(**args)
@@ -1055,25 +1146,21 @@ module Google
1055
1146
 
1056
1147
  # Update properties of this object
1057
1148
  def update!(**args)
1058
- @document_id = args[:document_id] if args.key?(:document_id)
1059
- @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination)
1060
- @status = args[:status] if args.key?(:status)
1149
+ @document_allow_multiple_labels = args[:document_allow_multiple_labels] if args.key?(:document_allow_multiple_labels)
1150
+ @document_splitter = args[:document_splitter] if args.key?(:document_splitter)
1151
+ @prefixed_naming_on_properties = args[:prefixed_naming_on_properties] if args.key?(:prefixed_naming_on_properties)
1152
+ @skip_naming_validation = args[:skip_naming_validation] if args.key?(:skip_naming_validation)
1061
1153
  end
1062
1154
  end
1063
1155
 
1064
- # The statistic representing a dataset split type for this export.
1065
- class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat
1156
+ # The long-running operation metadata for the EnableProcessor method.
1157
+ class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
1066
1158
  include Google::Apis::Core::Hashable
1067
1159
 
1068
- # The dataset split type.
1069
- # Corresponds to the JSON property `splitType`
1070
- # @return [String]
1071
- attr_accessor :split_type
1072
-
1073
- # Total number of documents with the given dataset split type to be exported.
1074
- # Corresponds to the JSON property `totalDocumentCount`
1075
- # @return [Fixnum]
1076
- attr_accessor :total_document_count
1160
+ # The common metadata for long running operations.
1161
+ # Corresponds to the JSON property `commonMetadata`
1162
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1163
+ attr_accessor :common_metadata
1077
1164
 
1078
1165
  def initialize(**args)
1079
1166
  update!(**args)
@@ -1081,13 +1168,13 @@ module Google
1081
1168
 
1082
1169
  # Update properties of this object
1083
1170
  def update!(**args)
1084
- @split_type = args[:split_type] if args.key?(:split_type)
1085
- @total_document_count = args[:total_document_count] if args.key?(:total_document_count)
1171
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1086
1172
  end
1087
1173
  end
1088
1174
 
1089
- # The response proto of ExportDocuments method.
1090
- class GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse
1175
+ # Response message for the EnableProcessor method. Intentionally empty proto for
1176
+ # adding fields in future.
1177
+ class GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse
1091
1178
  include Google::Apis::Core::Hashable
1092
1179
 
1093
1180
  def initialize(**args)
@@ -1099,33 +1186,85 @@ module Google
1099
1186
  end
1100
1187
  end
1101
1188
 
1102
- # Metadata message associated with the ExportProcessorVersion operation.
1103
- class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata
1189
+ # Metadata about an entity type.
1190
+ class GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata
1104
1191
  include Google::Apis::Core::Hashable
1105
1192
 
1106
- # The common metadata for long running operations.
1107
- # Corresponds to the JSON property `commonMetadata`
1108
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1109
- attr_accessor :common_metadata
1193
+ # Metadata for the field tier of a property.
1194
+ # Corresponds to the JSON property `fieldTierMetadata`
1195
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldTierMetadata]
1196
+ attr_accessor :field_tier_metadata
1110
1197
 
1111
- def initialize(**args)
1112
- update!(**args)
1113
- end
1198
+ # Metadata for human review labeling config.
1199
+ # Corresponds to the JSON property `humanReviewLabelingMetadata`
1200
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata]
1201
+ attr_accessor :human_review_labeling_metadata
1114
1202
 
1115
- # Update properties of this object
1203
+ # Metadata for Human Review config.
1204
+ # Corresponds to the JSON property `humanReviewMetadata`
1205
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata]
1206
+ attr_accessor :human_review_metadata
1207
+
1208
+ # Whether the entity type should be considered inactive.
1209
+ # Corresponds to the JSON property `inactive`
1210
+ # @return [Boolean]
1211
+ attr_accessor :inactive
1212
+ alias_method :inactive?, :inactive
1213
+
1214
+ # Metadata that specifies whether a label is editable and reasons why. These
1215
+ # fields are read-only. Changing these fields has no impact on the backend.
1216
+ # Corresponds to the JSON property `schemaEditabilityMetadata`
1217
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata]
1218
+ attr_accessor :schema_editability_metadata
1219
+
1220
+ # Metadata for schema inference. Only used on dataset.schema for schema
1221
+ # inference, can be safely ignored elsewhere.
1222
+ # Corresponds to the JSON property `schemaInferenceMetadata`
1223
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata]
1224
+ attr_accessor :schema_inference_metadata
1225
+
1226
+ def initialize(**args)
1227
+ update!(**args)
1228
+ end
1229
+
1230
+ # Update properties of this object
1231
+ def update!(**args)
1232
+ @field_tier_metadata = args[:field_tier_metadata] if args.key?(:field_tier_metadata)
1233
+ @human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata)
1234
+ @human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata)
1235
+ @inactive = args[:inactive] if args.key?(:inactive)
1236
+ @schema_editability_metadata = args[:schema_editability_metadata] if args.key?(:schema_editability_metadata)
1237
+ @schema_inference_metadata = args[:schema_inference_metadata] if args.key?(:schema_inference_metadata)
1238
+ end
1239
+ end
1240
+
1241
+ # Metadata of the EvaluateProcessorVersion method.
1242
+ class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata
1243
+ include Google::Apis::Core::Hashable
1244
+
1245
+ # The common metadata for long running operations.
1246
+ # Corresponds to the JSON property `commonMetadata`
1247
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1248
+ attr_accessor :common_metadata
1249
+
1250
+ def initialize(**args)
1251
+ update!(**args)
1252
+ end
1253
+
1254
+ # Update properties of this object
1116
1255
  def update!(**args)
1117
1256
  @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1118
1257
  end
1119
1258
  end
1120
1259
 
1121
- # Response message associated with the ExportProcessorVersion operation.
1122
- class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse
1260
+ # Response of the EvaluateProcessorVersion method.
1261
+ class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
1123
1262
  include Google::Apis::Core::Hashable
1124
1263
 
1125
- # The Cloud Storage URI containing the output artifacts.
1126
- # Corresponds to the JSON property `gcsUri`
1264
+ # The resource name of the created evaluation.
1265
+ # Corresponds to the JSON property `evaluation`
1127
1266
  # @return [String]
1128
- attr_accessor :gcs_uri
1267
+ attr_accessor :evaluation
1129
1268
 
1130
1269
  def initialize(**args)
1131
1270
  update!(**args)
@@ -1133,12 +1272,128 @@ module Google
1133
1272
 
1134
1273
  # Update properties of this object
1135
1274
  def update!(**args)
1136
- @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
1275
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
1137
1276
  end
1138
1277
  end
1139
1278
 
1140
- # Metadata of the import document operation.
1141
- class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata
1279
+ # Evaluation metrics, either in aggregate or about a specific entity.
1280
+ class GoogleCloudDocumentaiUiv1beta3EvaluationMetrics
1281
+ include Google::Apis::Core::Hashable
1282
+
1283
+ # The calculated f1 score.
1284
+ # Corresponds to the JSON property `f1Score`
1285
+ # @return [Float]
1286
+ attr_accessor :f1_score
1287
+
1288
+ # The amount of false negatives.
1289
+ # Corresponds to the JSON property `falseNegativesCount`
1290
+ # @return [Fixnum]
1291
+ attr_accessor :false_negatives_count
1292
+
1293
+ # The amount of false positives.
1294
+ # Corresponds to the JSON property `falsePositivesCount`
1295
+ # @return [Fixnum]
1296
+ attr_accessor :false_positives_count
1297
+
1298
+ # The amount of documents with a ground truth occurrence.
1299
+ # Corresponds to the JSON property `groundTruthDocumentCount`
1300
+ # @return [Fixnum]
1301
+ attr_accessor :ground_truth_document_count
1302
+
1303
+ # The amount of occurrences in ground truth documents.
1304
+ # Corresponds to the JSON property `groundTruthOccurrencesCount`
1305
+ # @return [Fixnum]
1306
+ attr_accessor :ground_truth_occurrences_count
1307
+
1308
+ # The calculated precision.
1309
+ # Corresponds to the JSON property `precision`
1310
+ # @return [Float]
1311
+ attr_accessor :precision
1312
+
1313
+ # The amount of documents with a predicted occurrence.
1314
+ # Corresponds to the JSON property `predictedDocumentCount`
1315
+ # @return [Fixnum]
1316
+ attr_accessor :predicted_document_count
1317
+
1318
+ # The amount of occurrences in predicted documents.
1319
+ # Corresponds to the JSON property `predictedOccurrencesCount`
1320
+ # @return [Fixnum]
1321
+ attr_accessor :predicted_occurrences_count
1322
+
1323
+ # The calculated recall.
1324
+ # Corresponds to the JSON property `recall`
1325
+ # @return [Float]
1326
+ attr_accessor :recall
1327
+
1328
+ # The amount of documents that had an occurrence of this label.
1329
+ # Corresponds to the JSON property `totalDocumentsCount`
1330
+ # @return [Fixnum]
1331
+ attr_accessor :total_documents_count
1332
+
1333
+ # The amount of true positives.
1334
+ # Corresponds to the JSON property `truePositivesCount`
1335
+ # @return [Fixnum]
1336
+ attr_accessor :true_positives_count
1337
+
1338
+ def initialize(**args)
1339
+ update!(**args)
1340
+ end
1341
+
1342
+ # Update properties of this object
1343
+ def update!(**args)
1344
+ @f1_score = args[:f1_score] if args.key?(:f1_score)
1345
+ @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
1346
+ @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
1347
+ @ground_truth_document_count = args[:ground_truth_document_count] if args.key?(:ground_truth_document_count)
1348
+ @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
1349
+ @precision = args[:precision] if args.key?(:precision)
1350
+ @predicted_document_count = args[:predicted_document_count] if args.key?(:predicted_document_count)
1351
+ @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
1352
+ @recall = args[:recall] if args.key?(:recall)
1353
+ @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
1354
+ @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
1355
+ end
1356
+ end
1357
+
1358
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
1359
+ class GoogleCloudDocumentaiUiv1beta3EvaluationReference
1360
+ include Google::Apis::Core::Hashable
1361
+
1362
+ # Evaluation metrics, either in aggregate or about a specific entity.
1363
+ # Corresponds to the JSON property `aggregateMetrics`
1364
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics]
1365
+ attr_accessor :aggregate_metrics
1366
+
1367
+ # Evaluation metrics, either in aggregate or about a specific entity.
1368
+ # Corresponds to the JSON property `aggregateMetricsExact`
1369
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics]
1370
+ attr_accessor :aggregate_metrics_exact
1371
+
1372
+ # The resource name of the evaluation.
1373
+ # Corresponds to the JSON property `evaluation`
1374
+ # @return [String]
1375
+ attr_accessor :evaluation
1376
+
1377
+ # The resource name of the Long Running Operation for the evaluation.
1378
+ # Corresponds to the JSON property `operation`
1379
+ # @return [String]
1380
+ attr_accessor :operation
1381
+
1382
+ def initialize(**args)
1383
+ update!(**args)
1384
+ end
1385
+
1386
+ # Update properties of this object
1387
+ def update!(**args)
1388
+ @aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics)
1389
+ @aggregate_metrics_exact = args[:aggregate_metrics_exact] if args.key?(:aggregate_metrics_exact)
1390
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
1391
+ @operation = args[:operation] if args.key?(:operation)
1392
+ end
1393
+ end
1394
+
1395
+ # Metadata of the batch export documents operation.
1396
+ class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata
1142
1397
  include Google::Apis::Core::Hashable
1143
1398
 
1144
1399
  # The common metadata for long running operations.
@@ -1146,20 +1401,15 @@ module Google
1146
1401
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1147
1402
  attr_accessor :common_metadata
1148
1403
 
1149
- # Validation statuses of the batch documents import config.
1150
- # Corresponds to the JSON property `importConfigValidationResults`
1151
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult>]
1152
- attr_accessor :import_config_validation_results
1153
-
1154
1404
  # The list of response details of each document.
1155
- # Corresponds to the JSON property `individualImportStatuses`
1156
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus>]
1157
- attr_accessor :individual_import_statuses
1405
+ # Corresponds to the JSON property `individualExportStatuses`
1406
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus>]
1407
+ attr_accessor :individual_export_statuses
1158
1408
 
1159
- # Total number of the documents that are qualified for importing.
1160
- # Corresponds to the JSON property `totalDocumentCount`
1161
- # @return [Fixnum]
1162
- attr_accessor :total_document_count
1409
+ # The list of statistics for each dataset split type.
1410
+ # Corresponds to the JSON property `splitExportStats`
1411
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat>]
1412
+ attr_accessor :split_export_stats
1163
1413
 
1164
1414
  def initialize(**args)
1165
1415
  update!(**args)
@@ -1168,22 +1418,25 @@ module Google
1168
1418
  # Update properties of this object
1169
1419
  def update!(**args)
1170
1420
  @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1171
- @import_config_validation_results = args[:import_config_validation_results] if args.key?(:import_config_validation_results)
1172
- @individual_import_statuses = args[:individual_import_statuses] if args.key?(:individual_import_statuses)
1173
- @total_document_count = args[:total_document_count] if args.key?(:total_document_count)
1421
+ @individual_export_statuses = args[:individual_export_statuses] if args.key?(:individual_export_statuses)
1422
+ @split_export_stats = args[:split_export_stats] if args.key?(:split_export_stats)
1174
1423
  end
1175
1424
  end
1176
1425
 
1177
- # The validation status of each import config. Status is set to an error if
1178
- # there are no documents to import in the `import_config`, or `OK` if the
1179
- # operation will try to proceed with at least one document.
1180
- class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult
1426
+ # The status of each individual document in the export process.
1427
+ class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus
1181
1428
  include Google::Apis::Core::Hashable
1182
1429
 
1183
- # The source Cloud Storage URI specified in the import config.
1184
- # Corresponds to the JSON property `inputGcsSource`
1430
+ # Document Identifier.
1431
+ # Corresponds to the JSON property `documentId`
1432
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId]
1433
+ attr_accessor :document_id
1434
+
1435
+ # The output_gcs_destination of the exported document if it was successful,
1436
+ # otherwise empty.
1437
+ # Corresponds to the JSON property `outputGcsDestination`
1185
1438
  # @return [String]
1186
- attr_accessor :input_gcs_source
1439
+ attr_accessor :output_gcs_destination
1187
1440
 
1188
1441
  # The `Status` type defines a logical error model that is suitable for different
1189
1442
  # programming environments, including REST APIs and RPC APIs. It is used by [
@@ -1201,40 +1454,642 @@ module Google
1201
1454
 
1202
1455
  # Update properties of this object
1203
1456
  def update!(**args)
1204
- @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
1205
- @status = args[:status] if args.key?(:status)
1457
+ @document_id = args[:document_id] if args.key?(:document_id)
1458
+ @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination)
1459
+ @status = args[:status] if args.key?(:status)
1460
+ end
1461
+ end
1462
+
1463
+ # The statistic representing a dataset split type for this export.
1464
+ class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat
1465
+ include Google::Apis::Core::Hashable
1466
+
1467
+ # The dataset split type.
1468
+ # Corresponds to the JSON property `splitType`
1469
+ # @return [String]
1470
+ attr_accessor :split_type
1471
+
1472
+ # Total number of documents with the given dataset split type to be exported.
1473
+ # Corresponds to the JSON property `totalDocumentCount`
1474
+ # @return [Fixnum]
1475
+ attr_accessor :total_document_count
1476
+
1477
+ def initialize(**args)
1478
+ update!(**args)
1479
+ end
1480
+
1481
+ # Update properties of this object
1482
+ def update!(**args)
1483
+ @split_type = args[:split_type] if args.key?(:split_type)
1484
+ @total_document_count = args[:total_document_count] if args.key?(:total_document_count)
1485
+ end
1486
+ end
1487
+
1488
+ # The response proto of ExportDocuments method.
1489
+ class GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse
1490
+ include Google::Apis::Core::Hashable
1491
+
1492
+ def initialize(**args)
1493
+ update!(**args)
1494
+ end
1495
+
1496
+ # Update properties of this object
1497
+ def update!(**args)
1498
+ end
1499
+ end
1500
+
1501
+ # Metadata message associated with the ExportProcessorVersion operation.
1502
+ class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata
1503
+ include Google::Apis::Core::Hashable
1504
+
1505
+ # The common metadata for long running operations.
1506
+ # Corresponds to the JSON property `commonMetadata`
1507
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1508
+ attr_accessor :common_metadata
1509
+
1510
+ def initialize(**args)
1511
+ update!(**args)
1512
+ end
1513
+
1514
+ # Update properties of this object
1515
+ def update!(**args)
1516
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1517
+ end
1518
+ end
1519
+
1520
+ # Response message associated with the ExportProcessorVersion operation.
1521
+ class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse
1522
+ include Google::Apis::Core::Hashable
1523
+
1524
+ # The Cloud Storage URI containing the output artifacts.
1525
+ # Corresponds to the JSON property `gcsUri`
1526
+ # @return [String]
1527
+ attr_accessor :gcs_uri
1528
+
1529
+ def initialize(**args)
1530
+ update!(**args)
1531
+ end
1532
+
1533
+ # Update properties of this object
1534
+ def update!(**args)
1535
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
1536
+ end
1537
+ end
1538
+
1539
+ # Metadata for how this field value is extracted.
1540
+ class GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata
1541
+ include Google::Apis::Core::Hashable
1542
+
1543
+ # Message for entity query.
1544
+ # Corresponds to the JSON property `entityQuery`
1545
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery]
1546
+ attr_accessor :entity_query
1547
+
1548
+ # Metadata for document summarization.
1549
+ # Corresponds to the JSON property `summaryOptions`
1550
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SummaryOptions]
1551
+ attr_accessor :summary_options
1552
+
1553
+ def initialize(**args)
1554
+ update!(**args)
1555
+ end
1556
+
1557
+ # Update properties of this object
1558
+ def update!(**args)
1559
+ @entity_query = args[:entity_query] if args.key?(:entity_query)
1560
+ @summary_options = args[:summary_options] if args.key?(:summary_options)
1561
+ end
1562
+ end
1563
+
1564
+ # Message for entity query.
1565
+ class GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery
1566
+ include Google::Apis::Core::Hashable
1567
+
1568
+ # The original entity query inputed by the user.
1569
+ # Corresponds to the JSON property `userEntityQuery`
1570
+ # @return [String]
1571
+ attr_accessor :user_entity_query
1572
+
1573
+ def initialize(**args)
1574
+ update!(**args)
1575
+ end
1576
+
1577
+ # Update properties of this object
1578
+ def update!(**args)
1579
+ @user_entity_query = args[:user_entity_query] if args.key?(:user_entity_query)
1580
+ end
1581
+ end
1582
+
1583
+ # Metadata for the field tier of a property.
1584
+ class GoogleCloudDocumentaiUiv1beta3FieldTierMetadata
1585
+ include Google::Apis::Core::Hashable
1586
+
1587
+ # Integer that indicates the tier of a property. e.g. Invoice has entities that
1588
+ # are classified as tier 1 which is the most important, while tier 2 and tier 3
1589
+ # less so. This attribute can be used to filter schema attributes before running
1590
+ # eval. e.g. compute F1 score for only tier 1 entities. If not present this
1591
+ # attribute should be inferred as 1.
1592
+ # Corresponds to the JSON property `tierLevel`
1593
+ # @return [Fixnum]
1594
+ attr_accessor :tier_level
1595
+
1596
+ def initialize(**args)
1597
+ update!(**args)
1598
+ end
1599
+
1600
+ # Update properties of this object
1601
+ def update!(**args)
1602
+ @tier_level = args[:tier_level] if args.key?(:tier_level)
1603
+ end
1604
+ end
1605
+
1606
+ # Metadata for human review labeling config.
1607
+ class GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata
1608
+ include Google::Apis::Core::Hashable
1609
+
1610
+ # Whether to enable normalization editing.
1611
+ # Corresponds to the JSON property `enableNormalizationEditing`
1612
+ # @return [Boolean]
1613
+ attr_accessor :enable_normalization_editing
1614
+ alias_method :enable_normalization_editing?, :enable_normalization_editing
1615
+
1616
+ def initialize(**args)
1617
+ update!(**args)
1618
+ end
1619
+
1620
+ # Update properties of this object
1621
+ def update!(**args)
1622
+ @enable_normalization_editing = args[:enable_normalization_editing] if args.key?(:enable_normalization_editing)
1623
+ end
1624
+ end
1625
+
1626
+ # Metadata for Human Review config.
1627
+ class GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata
1628
+ include Google::Apis::Core::Hashable
1629
+
1630
+ # The confidence threshold if human review validation is enabled.
1631
+ # Corresponds to the JSON property `confidenceThreshold`
1632
+ # @return [Float]
1633
+ attr_accessor :confidence_threshold
1634
+
1635
+ # Whether to enable human review validation.
1636
+ # Corresponds to the JSON property `enableValidation`
1637
+ # @return [Boolean]
1638
+ attr_accessor :enable_validation
1639
+ alias_method :enable_validation?, :enable_validation
1640
+
1641
+ def initialize(**args)
1642
+ update!(**args)
1643
+ end
1644
+
1645
+ # Update properties of this object
1646
+ def update!(**args)
1647
+ @confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold)
1648
+ @enable_validation = args[:enable_validation] if args.key?(:enable_validation)
1649
+ end
1650
+ end
1651
+
1652
+ # Metadata of the import document operation.
1653
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata
1654
+ include Google::Apis::Core::Hashable
1655
+
1656
+ # The common metadata for long running operations.
1657
+ # Corresponds to the JSON property `commonMetadata`
1658
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1659
+ attr_accessor :common_metadata
1660
+
1661
+ # Validation statuses of the batch documents import config.
1662
+ # Corresponds to the JSON property `importConfigValidationResults`
1663
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult>]
1664
+ attr_accessor :import_config_validation_results
1665
+
1666
+ # The list of response details of each document.
1667
+ # Corresponds to the JSON property `individualImportStatuses`
1668
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus>]
1669
+ attr_accessor :individual_import_statuses
1670
+
1671
+ # Total number of the documents that are qualified for importing.
1672
+ # Corresponds to the JSON property `totalDocumentCount`
1673
+ # @return [Fixnum]
1674
+ attr_accessor :total_document_count
1675
+
1676
+ def initialize(**args)
1677
+ update!(**args)
1678
+ end
1679
+
1680
+ # Update properties of this object
1681
+ def update!(**args)
1682
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1683
+ @import_config_validation_results = args[:import_config_validation_results] if args.key?(:import_config_validation_results)
1684
+ @individual_import_statuses = args[:individual_import_statuses] if args.key?(:individual_import_statuses)
1685
+ @total_document_count = args[:total_document_count] if args.key?(:total_document_count)
1686
+ end
1687
+ end
1688
+
1689
+ # The validation status of each import config. Status is set to an error if
1690
+ # there are no documents to import in the `import_config`, or `OK` if the
1691
+ # operation will try to proceed with at least one document.
1692
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult
1693
+ include Google::Apis::Core::Hashable
1694
+
1695
+ # The source Cloud Storage URI specified in the import config.
1696
+ # Corresponds to the JSON property `inputGcsSource`
1697
+ # @return [String]
1698
+ attr_accessor :input_gcs_source
1699
+
1700
+ # The `Status` type defines a logical error model that is suitable for different
1701
+ # programming environments, including REST APIs and RPC APIs. It is used by [
1702
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1703
+ # data: error code, error message, and error details. You can find out more
1704
+ # about this error model and how to work with it in the [API Design Guide](https:
1705
+ # //cloud.google.com/apis/design/errors).
1706
+ # Corresponds to the JSON property `status`
1707
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
1708
+ attr_accessor :status
1709
+
1710
+ def initialize(**args)
1711
+ update!(**args)
1712
+ end
1713
+
1714
+ # Update properties of this object
1715
+ def update!(**args)
1716
+ @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
1717
+ @status = args[:status] if args.key?(:status)
1718
+ end
1719
+ end
1720
+
1721
+ # The status of each individual document in the import process.
1722
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus
1723
+ include Google::Apis::Core::Hashable
1724
+
1725
+ # The source Cloud Storage URI of the document.
1726
+ # Corresponds to the JSON property `inputGcsSource`
1727
+ # @return [String]
1728
+ attr_accessor :input_gcs_source
1729
+
1730
+ # Document Identifier.
1731
+ # Corresponds to the JSON property `outputDocumentId`
1732
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId]
1733
+ attr_accessor :output_document_id
1734
+
1735
+ # The output_gcs_destination of the processed document if it was successful,
1736
+ # otherwise empty.
1737
+ # Corresponds to the JSON property `outputGcsDestination`
1738
+ # @return [String]
1739
+ attr_accessor :output_gcs_destination
1740
+
1741
+ # The `Status` type defines a logical error model that is suitable for different
1742
+ # programming environments, including REST APIs and RPC APIs. It is used by [
1743
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1744
+ # data: error code, error message, and error details. You can find out more
1745
+ # about this error model and how to work with it in the [API Design Guide](https:
1746
+ # //cloud.google.com/apis/design/errors).
1747
+ # Corresponds to the JSON property `status`
1748
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
1749
+ attr_accessor :status
1750
+
1751
+ def initialize(**args)
1752
+ update!(**args)
1753
+ end
1754
+
1755
+ # Update properties of this object
1756
+ def update!(**args)
1757
+ @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
1758
+ @output_document_id = args[:output_document_id] if args.key?(:output_document_id)
1759
+ @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination)
1760
+ @status = args[:status] if args.key?(:status)
1761
+ end
1762
+ end
1763
+
1764
+ # Response of the import document operation.
1765
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse
1766
+ include Google::Apis::Core::Hashable
1767
+
1768
+ def initialize(**args)
1769
+ update!(**args)
1770
+ end
1771
+
1772
+ # Update properties of this object
1773
+ def update!(**args)
1774
+ end
1775
+ end
1776
+
1777
+ # The long-running operation metadata for the ImportProcessorVersion method.
1778
+ class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata
1779
+ include Google::Apis::Core::Hashable
1780
+
1781
+ # The common metadata for long running operations.
1782
+ # Corresponds to the JSON property `commonMetadata`
1783
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1784
+ attr_accessor :common_metadata
1785
+
1786
+ def initialize(**args)
1787
+ update!(**args)
1788
+ end
1789
+
1790
+ # Update properties of this object
1791
+ def update!(**args)
1792
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
1793
+ end
1794
+ end
1795
+
1796
+ # The response message for the ImportProcessorVersion method.
1797
+ class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse
1798
+ include Google::Apis::Core::Hashable
1799
+
1800
+ # The destination processor version name.
1801
+ # Corresponds to the JSON property `processorVersion`
1802
+ # @return [String]
1803
+ attr_accessor :processor_version
1804
+
1805
+ def initialize(**args)
1806
+ update!(**args)
1807
+ end
1808
+
1809
+ # Update properties of this object
1810
+ def update!(**args)
1811
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
1812
+ end
1813
+ end
1814
+
1815
+ # The first-class citizen for Document AI. Each processor defines how to extract
1816
+ # structural information from a document.
1817
+ class GoogleCloudDocumentaiUiv1beta3Processor
1818
+ include Google::Apis::Core::Hashable
1819
+
1820
+ # Optional. SchemaVersion used by the Processor. It is the same as Processor's
1821
+ # DatasetSchema.schema_version Format is `projects/`project`/locations/`location`
1822
+ # /schemas/`schema`/schemaVersions/`schema_version`
1823
+ # Corresponds to the JSON property `activeSchemaVersion`
1824
+ # @return [String]
1825
+ attr_accessor :active_schema_version
1826
+
1827
+ # Output only. The time the processor was created.
1828
+ # Corresponds to the JSON property `createTime`
1829
+ # @return [String]
1830
+ attr_accessor :create_time
1831
+
1832
+ # The default processor version.
1833
+ # Corresponds to the JSON property `defaultProcessorVersion`
1834
+ # @return [String]
1835
+ attr_accessor :default_processor_version
1836
+
1837
+ # The display name of the processor.
1838
+ # Corresponds to the JSON property `displayName`
1839
+ # @return [String]
1840
+ attr_accessor :display_name
1841
+
1842
+ # The [KMS key](https://cloud.google.com/security-key-management) used for
1843
+ # encryption and decryption in CMEK scenarios.
1844
+ # Corresponds to the JSON property `kmsKeyName`
1845
+ # @return [String]
1846
+ attr_accessor :kms_key_name
1847
+
1848
+ # Output only. Immutable. The resource name of the processor. Format: `projects/`
1849
+ # project`/locations/`location`/processors/`processor``
1850
+ # Corresponds to the JSON property `name`
1851
+ # @return [String]
1852
+ attr_accessor :name
1853
+
1854
+ # Output only. Immutable. The http endpoint that can be called to invoke
1855
+ # processing.
1856
+ # Corresponds to the JSON property `processEndpoint`
1857
+ # @return [String]
1858
+ attr_accessor :process_endpoint
1859
+
1860
+ # Output only. The processor version aliases.
1861
+ # Corresponds to the JSON property `processorVersionAliases`
1862
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias>]
1863
+ attr_accessor :processor_version_aliases
1864
+
1865
+ # Output only. Reserved for future use.
1866
+ # Corresponds to the JSON property `satisfiesPzi`
1867
+ # @return [Boolean]
1868
+ attr_accessor :satisfies_pzi
1869
+ alias_method :satisfies_pzi?, :satisfies_pzi
1870
+
1871
+ # Output only. Reserved for future use.
1872
+ # Corresponds to the JSON property `satisfiesPzs`
1873
+ # @return [Boolean]
1874
+ attr_accessor :satisfies_pzs
1875
+ alias_method :satisfies_pzs?, :satisfies_pzs
1876
+
1877
+ # Output only. The state of the processor.
1878
+ # Corresponds to the JSON property `state`
1879
+ # @return [String]
1880
+ attr_accessor :state
1881
+
1882
+ # The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a
1883
+ # list of processor types, see FetchProcessorTypes.
1884
+ # Corresponds to the JSON property `type`
1885
+ # @return [String]
1886
+ attr_accessor :type
1887
+
1888
+ def initialize(**args)
1889
+ update!(**args)
1890
+ end
1891
+
1892
+ # Update properties of this object
1893
+ def update!(**args)
1894
+ @active_schema_version = args[:active_schema_version] if args.key?(:active_schema_version)
1895
+ @create_time = args[:create_time] if args.key?(:create_time)
1896
+ @default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
1897
+ @display_name = args[:display_name] if args.key?(:display_name)
1898
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
1899
+ @name = args[:name] if args.key?(:name)
1900
+ @process_endpoint = args[:process_endpoint] if args.key?(:process_endpoint)
1901
+ @processor_version_aliases = args[:processor_version_aliases] if args.key?(:processor_version_aliases)
1902
+ @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
1903
+ @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
1904
+ @state = args[:state] if args.key?(:state)
1905
+ @type = args[:type] if args.key?(:type)
1906
+ end
1907
+ end
1908
+
1909
+ # A processor version is an implementation of a processor. Each processor can
1910
+ # have multiple versions, pretrained by Google internally or uptrained by the
1911
+ # customer. A processor can only have one default version at a time. Its
1912
+ # document-processing behavior is defined by that version.
1913
+ class GoogleCloudDocumentaiUiv1beta3ProcessorVersion
1914
+ include Google::Apis::Core::Hashable
1915
+
1916
+ # Output only. The time the processor version was created.
1917
+ # Corresponds to the JSON property `createTime`
1918
+ # @return [String]
1919
+ attr_accessor :create_time
1920
+
1921
+ # Output only. Denotes that this `ProcessorVersion` can be deployed and
1922
+ # undeployed.
1923
+ # Corresponds to the JSON property `deploymentAllowed`
1924
+ # @return [Boolean]
1925
+ attr_accessor :deployment_allowed
1926
+ alias_method :deployment_allowed?, :deployment_allowed
1927
+
1928
+ # Information about the upcoming deprecation of this processor version.
1929
+ # Corresponds to the JSON property `deprecationInfo`
1930
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo]
1931
+ attr_accessor :deprecation_info
1932
+
1933
+ # The display name of the processor version.
1934
+ # Corresponds to the JSON property `displayName`
1935
+ # @return [String]
1936
+ attr_accessor :display_name
1937
+
1938
+ # The schema defines the output of the processed document by a processor.
1939
+ # Corresponds to the JSON property `documentSchema`
1940
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchema]
1941
+ attr_accessor :document_schema
1942
+
1943
+ # Information about Generative AI model-based processor versions.
1944
+ # Corresponds to the JSON property `genAiModelInfo`
1945
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo]
1946
+ attr_accessor :gen_ai_model_info
1947
+
1948
+ # Output only. Denotes that this `ProcessorVersion` is managed by Google.
1949
+ # Corresponds to the JSON property `googleManaged`
1950
+ # @return [Boolean]
1951
+ attr_accessor :google_managed
1952
+ alias_method :google_managed?, :google_managed
1953
+
1954
+ # Output only. The KMS key name used for encryption.
1955
+ # Corresponds to the JSON property `kmsKeyName`
1956
+ # @return [String]
1957
+ attr_accessor :kms_key_name
1958
+
1959
+ # Output only. The KMS key version with which data is encrypted.
1960
+ # Corresponds to the JSON property `kmsKeyVersionName`
1961
+ # @return [String]
1962
+ attr_accessor :kms_key_version_name
1963
+
1964
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
1965
+ # Corresponds to the JSON property `latestEvaluation`
1966
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationReference]
1967
+ attr_accessor :latest_evaluation
1968
+
1969
+ # Output only. The model type of this processor version.
1970
+ # Corresponds to the JSON property `modelType`
1971
+ # @return [String]
1972
+ attr_accessor :model_type
1973
+
1974
+ # Identifier. The resource name of the processor version. Format: `projects/`
1975
+ # project`/locations/`location`/processors/`processor`/processorVersions/`
1976
+ # processor_version``
1977
+ # Corresponds to the JSON property `name`
1978
+ # @return [String]
1979
+ attr_accessor :name
1980
+
1981
+ # Output only. Reserved for future use.
1982
+ # Corresponds to the JSON property `satisfiesPzi`
1983
+ # @return [Boolean]
1984
+ attr_accessor :satisfies_pzi
1985
+ alias_method :satisfies_pzi?, :satisfies_pzi
1986
+
1987
+ # Output only. Reserved for future use.
1988
+ # Corresponds to the JSON property `satisfiesPzs`
1989
+ # @return [Boolean]
1990
+ attr_accessor :satisfies_pzs
1991
+ alias_method :satisfies_pzs?, :satisfies_pzs
1992
+
1993
+ # The schema defines the output of the processed document by a processor.
1994
+ # Corresponds to the JSON property `schema`
1995
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Schema]
1996
+ attr_accessor :schema
1997
+
1998
+ # Output only. The state of the processor version.
1999
+ # Corresponds to the JSON property `state`
2000
+ # @return [String]
2001
+ attr_accessor :state
2002
+
2003
+ def initialize(**args)
2004
+ update!(**args)
2005
+ end
2006
+
2007
+ # Update properties of this object
2008
+ def update!(**args)
2009
+ @create_time = args[:create_time] if args.key?(:create_time)
2010
+ @deployment_allowed = args[:deployment_allowed] if args.key?(:deployment_allowed)
2011
+ @deprecation_info = args[:deprecation_info] if args.key?(:deprecation_info)
2012
+ @display_name = args[:display_name] if args.key?(:display_name)
2013
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
2014
+ @gen_ai_model_info = args[:gen_ai_model_info] if args.key?(:gen_ai_model_info)
2015
+ @google_managed = args[:google_managed] if args.key?(:google_managed)
2016
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
2017
+ @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
2018
+ @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
2019
+ @model_type = args[:model_type] if args.key?(:model_type)
2020
+ @name = args[:name] if args.key?(:name)
2021
+ @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
2022
+ @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
2023
+ @schema = args[:schema] if args.key?(:schema)
2024
+ @state = args[:state] if args.key?(:state)
2025
+ end
2026
+ end
2027
+
2028
+ # Contains the alias and the aliased resource name of processor version.
2029
+ class GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias
2030
+ include Google::Apis::Core::Hashable
2031
+
2032
+ # The alias in the form of `processor_version` resource name.
2033
+ # Corresponds to the JSON property `alias`
2034
+ # @return [String]
2035
+ attr_accessor :alias
2036
+
2037
+ # The resource name of aliased processor version.
2038
+ # Corresponds to the JSON property `processorVersion`
2039
+ # @return [String]
2040
+ attr_accessor :processor_version
2041
+
2042
+ def initialize(**args)
2043
+ update!(**args)
2044
+ end
2045
+
2046
+ # Update properties of this object
2047
+ def update!(**args)
2048
+ @alias = args[:alias] if args.key?(:alias)
2049
+ @processor_version = args[:processor_version] if args.key?(:processor_version)
2050
+ end
2051
+ end
2052
+
2053
+ # Information about the upcoming deprecation of this processor version.
2054
+ class GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo
2055
+ include Google::Apis::Core::Hashable
2056
+
2057
+ # The time at which this processor version will be deprecated.
2058
+ # Corresponds to the JSON property `deprecationTime`
2059
+ # @return [String]
2060
+ attr_accessor :deprecation_time
2061
+
2062
+ # If set, the processor version that will be used as a replacement.
2063
+ # Corresponds to the JSON property `replacementProcessorVersion`
2064
+ # @return [String]
2065
+ attr_accessor :replacement_processor_version
2066
+
2067
+ def initialize(**args)
2068
+ update!(**args)
2069
+ end
2070
+
2071
+ # Update properties of this object
2072
+ def update!(**args)
2073
+ @deprecation_time = args[:deprecation_time] if args.key?(:deprecation_time)
2074
+ @replacement_processor_version = args[:replacement_processor_version] if args.key?(:replacement_processor_version)
1206
2075
  end
1207
2076
  end
1208
2077
 
1209
- # The status of each individual document in the import process.
1210
- class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus
2078
+ # Information about Generative AI model-based processor versions.
2079
+ class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo
1211
2080
  include Google::Apis::Core::Hashable
1212
2081
 
1213
- # The source Cloud Storage URI of the document.
1214
- # Corresponds to the JSON property `inputGcsSource`
1215
- # @return [String]
1216
- attr_accessor :input_gcs_source
1217
-
1218
- # Document Identifier.
1219
- # Corresponds to the JSON property `outputDocumentId`
1220
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId]
1221
- attr_accessor :output_document_id
1222
-
1223
- # The output_gcs_destination of the processed document if it was successful,
1224
- # otherwise empty.
1225
- # Corresponds to the JSON property `outputGcsDestination`
1226
- # @return [String]
1227
- attr_accessor :output_gcs_destination
2082
+ # Information for a custom Generative AI model created by the user. These are
2083
+ # created with `Create New Version` in either the `Call foundation model` or `
2084
+ # Fine tuning` tabs.
2085
+ # Corresponds to the JSON property `customGenAiModelInfo`
2086
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo]
2087
+ attr_accessor :custom_gen_ai_model_info
1228
2088
 
1229
- # The `Status` type defines a logical error model that is suitable for different
1230
- # programming environments, including REST APIs and RPC APIs. It is used by [
1231
- # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1232
- # data: error code, error message, and error details. You can find out more
1233
- # about this error model and how to work with it in the [API Design Guide](https:
1234
- # //cloud.google.com/apis/design/errors).
1235
- # Corresponds to the JSON property `status`
1236
- # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
1237
- attr_accessor :status
2089
+ # Information for a pretrained Google-managed foundation model.
2090
+ # Corresponds to the JSON property `foundationGenAiModelInfo`
2091
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo]
2092
+ attr_accessor :foundation_gen_ai_model_info
1238
2093
 
1239
2094
  def initialize(**args)
1240
2095
  update!(**args)
@@ -1242,34 +2097,53 @@ module Google
1242
2097
 
1243
2098
  # Update properties of this object
1244
2099
  def update!(**args)
1245
- @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
1246
- @output_document_id = args[:output_document_id] if args.key?(:output_document_id)
1247
- @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination)
1248
- @status = args[:status] if args.key?(:status)
2100
+ @custom_gen_ai_model_info = args[:custom_gen_ai_model_info] if args.key?(:custom_gen_ai_model_info)
2101
+ @foundation_gen_ai_model_info = args[:foundation_gen_ai_model_info] if args.key?(:foundation_gen_ai_model_info)
1249
2102
  end
1250
2103
  end
1251
2104
 
1252
- # Response of the import document operation.
1253
- class GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse
2105
+ # Information for a custom Generative AI model created by the user. These are
2106
+ # created with `Create New Version` in either the `Call foundation model` or `
2107
+ # Fine tuning` tabs.
2108
+ class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo
1254
2109
  include Google::Apis::Core::Hashable
1255
2110
 
2111
+ # The base processor version ID for the custom model.
2112
+ # Corresponds to the JSON property `baseProcessorVersionId`
2113
+ # @return [String]
2114
+ attr_accessor :base_processor_version_id
2115
+
2116
+ # The type of custom model created by the user.
2117
+ # Corresponds to the JSON property `customModelType`
2118
+ # @return [String]
2119
+ attr_accessor :custom_model_type
2120
+
1256
2121
  def initialize(**args)
1257
2122
  update!(**args)
1258
2123
  end
1259
2124
 
1260
2125
  # Update properties of this object
1261
2126
  def update!(**args)
2127
+ @base_processor_version_id = args[:base_processor_version_id] if args.key?(:base_processor_version_id)
2128
+ @custom_model_type = args[:custom_model_type] if args.key?(:custom_model_type)
1262
2129
  end
1263
2130
  end
1264
2131
 
1265
- # The long-running operation metadata for the ImportProcessorVersion method.
1266
- class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata
2132
+ # Information for a pretrained Google-managed foundation model.
2133
+ class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo
1267
2134
  include Google::Apis::Core::Hashable
1268
2135
 
1269
- # The common metadata for long running operations.
1270
- # Corresponds to the JSON property `commonMetadata`
1271
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
1272
- attr_accessor :common_metadata
2136
+ # Whether finetuning is allowed for this base processor version.
2137
+ # Corresponds to the JSON property `finetuningAllowed`
2138
+ # @return [Boolean]
2139
+ attr_accessor :finetuning_allowed
2140
+ alias_method :finetuning_allowed?, :finetuning_allowed
2141
+
2142
+ # The minimum number of labeled documents in the training dataset required for
2143
+ # finetuning.
2144
+ # Corresponds to the JSON property `minTrainLabeledDocuments`
2145
+ # @return [Fixnum]
2146
+ attr_accessor :min_train_labeled_documents
1273
2147
 
1274
2148
  def initialize(**args)
1275
2149
  update!(**args)
@@ -1277,18 +2151,52 @@ module Google
1277
2151
 
1278
2152
  # Update properties of this object
1279
2153
  def update!(**args)
1280
- @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
2154
+ @finetuning_allowed = args[:finetuning_allowed] if args.key?(:finetuning_allowed)
2155
+ @min_train_labeled_documents = args[:min_train_labeled_documents] if args.key?(:min_train_labeled_documents)
1281
2156
  end
1282
2157
  end
1283
2158
 
1284
- # The response message for the ImportProcessorVersion method.
1285
- class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse
2159
+ # Metadata about a property.
2160
+ class GoogleCloudDocumentaiUiv1beta3PropertyMetadata
1286
2161
  include Google::Apis::Core::Hashable
1287
2162
 
1288
- # The destination processor version name.
1289
- # Corresponds to the JSON property `processorVersion`
1290
- # @return [String]
1291
- attr_accessor :processor_version
2163
+ # Metadata for how this field value is extracted.
2164
+ # Corresponds to the JSON property `fieldExtractionMetadata`
2165
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata]
2166
+ attr_accessor :field_extraction_metadata
2167
+
2168
+ # Metadata for the field tier of a property.
2169
+ # Corresponds to the JSON property `fieldTierMetadata`
2170
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldTierMetadata]
2171
+ attr_accessor :field_tier_metadata
2172
+
2173
+ # Metadata for human review labeling config.
2174
+ # Corresponds to the JSON property `humanReviewLabelingMetadata`
2175
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata]
2176
+ attr_accessor :human_review_labeling_metadata
2177
+
2178
+ # Metadata for Human Review config.
2179
+ # Corresponds to the JSON property `humanReviewMetadata`
2180
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata]
2181
+ attr_accessor :human_review_metadata
2182
+
2183
+ # Whether the property should be considered as "inactive".
2184
+ # Corresponds to the JSON property `inactive`
2185
+ # @return [Boolean]
2186
+ attr_accessor :inactive
2187
+ alias_method :inactive?, :inactive
2188
+
2189
+ # Metadata that specifies whether a label is editable and reasons why. These
2190
+ # fields are read-only. Changing these fields has no impact on the backend.
2191
+ # Corresponds to the JSON property `schemaEditabilityMetadata`
2192
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata]
2193
+ attr_accessor :schema_editability_metadata
2194
+
2195
+ # Metadata for schema inference. Only used on dataset.schema for schema
2196
+ # inference, can be safely ignored elsewhere.
2197
+ # Corresponds to the JSON property `schemaInferenceMetadata`
2198
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata]
2199
+ attr_accessor :schema_inference_metadata
1292
2200
 
1293
2201
  def initialize(**args)
1294
2202
  update!(**args)
@@ -1296,7 +2204,13 @@ module Google
1296
2204
 
1297
2205
  # Update properties of this object
1298
2206
  def update!(**args)
1299
- @processor_version = args[:processor_version] if args.key?(:processor_version)
2207
+ @field_extraction_metadata = args[:field_extraction_metadata] if args.key?(:field_extraction_metadata)
2208
+ @field_tier_metadata = args[:field_tier_metadata] if args.key?(:field_tier_metadata)
2209
+ @human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata)
2210
+ @human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata)
2211
+ @inactive = args[:inactive] if args.key?(:inactive)
2212
+ @schema_editability_metadata = args[:schema_editability_metadata] if args.key?(:schema_editability_metadata)
2213
+ @schema_inference_metadata = args[:schema_inference_metadata] if args.key?(:schema_inference_metadata)
1300
2214
  end
1301
2215
  end
1302
2216
 
@@ -1524,6 +2438,175 @@ module Google
1524
2438
  end
1525
2439
  end
1526
2440
 
2441
+ # The schema defines the output of the processed document by a processor.
2442
+ class GoogleCloudDocumentaiUiv1beta3Schema
2443
+ include Google::Apis::Core::Hashable
2444
+
2445
+ # Description of the schema.
2446
+ # Corresponds to the JSON property `description`
2447
+ # @return [String]
2448
+ attr_accessor :description
2449
+
2450
+ # Display name to show to users.
2451
+ # Corresponds to the JSON property `displayName`
2452
+ # @return [String]
2453
+ attr_accessor :display_name
2454
+
2455
+ # Entity types of the schema.
2456
+ # Corresponds to the JSON property `entityTypes`
2457
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEntityType>]
2458
+ attr_accessor :entity_types
2459
+
2460
+ def initialize(**args)
2461
+ update!(**args)
2462
+ end
2463
+
2464
+ # Update properties of this object
2465
+ def update!(**args)
2466
+ @description = args[:description] if args.key?(:description)
2467
+ @display_name = args[:display_name] if args.key?(:display_name)
2468
+ @entity_types = args[:entity_types] if args.key?(:entity_types)
2469
+ end
2470
+ end
2471
+
2472
+ # Metadata that specifies whether a label is editable and reasons why. These
2473
+ # fields are read-only. Changing these fields has no impact on the backend.
2474
+ class GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata
2475
+ include Google::Apis::Core::Hashable
2476
+
2477
+ # Explicit flag that controls whether the label is editable.
2478
+ # Corresponds to the JSON property `editable`
2479
+ # @return [Boolean]
2480
+ attr_accessor :editable
2481
+ alias_method :editable?, :editable
2482
+
2483
+ # Full resource name of processor versions that contain this label. e.g. `
2484
+ # projects/`project`/locations/`location`/processors/`processor`/
2485
+ # processorVersions/`processorVersion``
2486
+ # Corresponds to the JSON property `processorVersions`
2487
+ # @return [Array<String>]
2488
+ attr_accessor :processor_versions
2489
+
2490
+ def initialize(**args)
2491
+ update!(**args)
2492
+ end
2493
+
2494
+ # Update properties of this object
2495
+ def update!(**args)
2496
+ @editable = args[:editable] if args.key?(:editable)
2497
+ @processor_versions = args[:processor_versions] if args.key?(:processor_versions)
2498
+ end
2499
+ end
2500
+
2501
+ # EntityType is the wrapper of a label of the corresponding model with detailed
2502
+ # attributes and limitations for entity-based processors. Multiple types can
2503
+ # also compose a dependency tree to represent nested types.
2504
+ class GoogleCloudDocumentaiUiv1beta3SchemaEntityType
2505
+ include Google::Apis::Core::Hashable
2506
+
2507
+ #
2508
+ # Corresponds to the JSON property `baseType`
2509
+ # @return [String]
2510
+ attr_accessor :base_type
2511
+
2512
+ # Description of the entity type.
2513
+ # Corresponds to the JSON property `description`
2514
+ # @return [String]
2515
+ attr_accessor :description
2516
+
2517
+ # If specified, lists all the possible values for this entity.
2518
+ # Corresponds to the JSON property `enumValues`
2519
+ # @return [Array<String>]
2520
+ attr_accessor :enum_values
2521
+
2522
+ # If the entity type is hidden in the schema. This provides the functionality to
2523
+ # temporally "disable" an entity without deleting it.
2524
+ # Corresponds to the JSON property `hide`
2525
+ # @return [Boolean]
2526
+ attr_accessor :hide
2527
+ alias_method :hide?, :hide
2528
+
2529
+ # Specifies how the entity's value is obtained.
2530
+ # Corresponds to the JSON property `method`
2531
+ # @return [String]
2532
+ attr_accessor :method_prop
2533
+
2534
+ # Occurrence type limits the number of times an entity type appears in the
2535
+ # document.
2536
+ # Corresponds to the JSON property `occurrenceType`
2537
+ # @return [String]
2538
+ attr_accessor :occurrence_type
2539
+
2540
+ # Describing the nested structure of an entity. An EntityType may consist of
2541
+ # several other EntityTypes. For example, in a document there can be an
2542
+ # EntityType `ID`, which consists of EntityType `name` and `address`, with
2543
+ # corresponding attributes, such as TEXT for both types and ONCE for occurrence
2544
+ # types.
2545
+ # Corresponds to the JSON property `properties`
2546
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEntityType>]
2547
+ attr_accessor :properties
2548
+
2549
+ # Source of this entity type.
2550
+ # Corresponds to the JSON property `source`
2551
+ # @return [String]
2552
+ attr_accessor :source
2553
+
2554
+ # Name of the type. It must satisfy the following constraints: 1. Must be unique
2555
+ # within the set of same level types (with case-insensitive match). 2. Maximum
2556
+ # 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII
2557
+ # letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation
2558
+ # characters: * underscore '_' (recommended) * hyphen '-' (allowed, not
2559
+ # recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace
2560
+ # characters are not allowed. 5. Cannot end with a punctuation character. 6.
2561
+ # Cannot contain the following restricted strings: "google", "DocumentAI" (case-
2562
+ # insensitive match). 7. A slash character '/' is reserved as a separator in
2563
+ # flattened representations of nested entity types (e.g., "line_item/amount") in
2564
+ # which case each part (e.g., "line_item", "amount") must comply with the rules
2565
+ # defined above. We recommend using the snake case ("snake_case") in entity type
2566
+ # names.
2567
+ # Corresponds to the JSON property `type`
2568
+ # @return [String]
2569
+ attr_accessor :type
2570
+
2571
+ def initialize(**args)
2572
+ update!(**args)
2573
+ end
2574
+
2575
+ # Update properties of this object
2576
+ def update!(**args)
2577
+ @base_type = args[:base_type] if args.key?(:base_type)
2578
+ @description = args[:description] if args.key?(:description)
2579
+ @enum_values = args[:enum_values] if args.key?(:enum_values)
2580
+ @hide = args[:hide] if args.key?(:hide)
2581
+ @method_prop = args[:method_prop] if args.key?(:method_prop)
2582
+ @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
2583
+ @properties = args[:properties] if args.key?(:properties)
2584
+ @source = args[:source] if args.key?(:source)
2585
+ @type = args[:type] if args.key?(:type)
2586
+ end
2587
+ end
2588
+
2589
+ # Metadata for schema inference. Only used on dataset.schema for schema
2590
+ # inference, can be safely ignored elsewhere.
2591
+ class GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata
2592
+ include Google::Apis::Core::Hashable
2593
+
2594
+ # True if is inferred by schema inference.
2595
+ # Corresponds to the JSON property `inferred`
2596
+ # @return [Boolean]
2597
+ attr_accessor :inferred
2598
+ alias_method :inferred?, :inferred
2599
+
2600
+ def initialize(**args)
2601
+ update!(**args)
2602
+ end
2603
+
2604
+ # Update properties of this object
2605
+ def update!(**args)
2606
+ @inferred = args[:inferred] if args.key?(:inferred)
2607
+ end
2608
+ end
2609
+
1527
2610
  # The long-running operation metadata for the SetDefaultProcessorVersion method.
1528
2611
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
1529
2612
  include Google::Apis::Core::Hashable
@@ -1556,6 +2639,31 @@ module Google
1556
2639
  end
1557
2640
  end
1558
2641
 
2642
+ # Metadata for document summarization.
2643
+ class GoogleCloudDocumentaiUiv1beta3SummaryOptions
2644
+ include Google::Apis::Core::Hashable
2645
+
2646
+ # The format the summary should be in.
2647
+ # Corresponds to the JSON property `format`
2648
+ # @return [String]
2649
+ attr_accessor :format
2650
+
2651
+ # How long the summary should be.
2652
+ # Corresponds to the JSON property `length`
2653
+ # @return [String]
2654
+ attr_accessor :length
2655
+
2656
+ def initialize(**args)
2657
+ update!(**args)
2658
+ end
2659
+
2660
+ # Update properties of this object
2661
+ def update!(**args)
2662
+ @format = args[:format] if args.key?(:format)
2663
+ @length = args[:length] if args.key?(:length)
2664
+ end
2665
+ end
2666
+
1559
2667
  # The metadata that represents a processor version being created.
1560
2668
  class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata
1561
2669
  include Google::Apis::Core::Hashable
@@ -1681,8 +2789,28 @@ module Google
1681
2789
  end
1682
2790
  end
1683
2791
 
1684
- #
1685
- class GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata
2792
+ #
2793
+ class GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata
2794
+ include Google::Apis::Core::Hashable
2795
+
2796
+ # The common metadata for long running operations.
2797
+ # Corresponds to the JSON property `commonMetadata`
2798
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
2799
+ attr_accessor :common_metadata
2800
+
2801
+ def initialize(**args)
2802
+ update!(**args)
2803
+ end
2804
+
2805
+ # Update properties of this object
2806
+ def update!(**args)
2807
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
2808
+ end
2809
+ end
2810
+
2811
+ # The long-running operation metadata for updating the human review
2812
+ # configuration.
2813
+ class GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata
1686
2814
  include Google::Apis::Core::Hashable
1687
2815
 
1688
2816
  # The common metadata for long running operations.
@@ -1700,9 +2828,8 @@ module Google
1700
2828
  end
1701
2829
  end
1702
2830
 
1703
- # The long-running operation metadata for updating the human review
1704
- # configuration.
1705
- class GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata
2831
+ # The long-running operation metadata for UpdateLabelerPool.
2832
+ class GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata
1706
2833
  include Google::Apis::Core::Hashable
1707
2834
 
1708
2835
  # The common metadata for long running operations.
@@ -1720,8 +2847,8 @@ module Google
1720
2847
  end
1721
2848
  end
1722
2849
 
1723
- # The long-running operation metadata for UpdateLabelerPool.
1724
- class GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata
2850
+ # The long-running operation metadata for the UpdateProcessorVersion method.
2851
+ class GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata
1725
2852
  include Google::Apis::Core::Hashable
1726
2853
 
1727
2854
  # The common metadata for long running operations.
@@ -4174,12 +5301,18 @@ module Google
4174
5301
  class GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult
4175
5302
  include Google::Apis::Core::Hashable
4176
5303
 
5304
+ # Optional. The name of the rule resource that is used for validation. Format: `
5305
+ # projects/`project`/locations/`location`/rules/`rule``
5306
+ # Corresponds to the JSON property `rule`
5307
+ # @return [String]
5308
+ attr_accessor :rule
5309
+
4177
5310
  # The description of the validation rule.
4178
5311
  # Corresponds to the JSON property `ruleDescription`
4179
5312
  # @return [String]
4180
5313
  attr_accessor :rule_description
4181
5314
 
4182
- # The name of the validation rule.
5315
+ # The display name of the validation rule.
4183
5316
  # Corresponds to the JSON property `ruleName`
4184
5317
  # @return [String]
4185
5318
  attr_accessor :rule_name
@@ -4201,6 +5334,7 @@ module Google
4201
5334
 
4202
5335
  # Update properties of this object
4203
5336
  def update!(**args)
5337
+ @rule = args[:rule] if args.key?(:rule)
4204
5338
  @rule_description = args[:rule_description] if args.key?(:rule_description)
4205
5339
  @rule_name = args[:rule_name] if args.key?(:rule_name)
4206
5340
  @validation_details = args[:validation_details] if args.key?(:validation_details)
@@ -6119,6 +7253,25 @@ module Google
6119
7253
  end
6120
7254
  end
6121
7255
 
7256
+ # A set of inline documents.
7257
+ class GoogleCloudDocumentaiV1beta3Documents
7258
+ include Google::Apis::Core::Hashable
7259
+
7260
+ # The list of documents.
7261
+ # Corresponds to the JSON property `documents`
7262
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document>]
7263
+ attr_accessor :documents
7264
+
7265
+ def initialize(**args)
7266
+ update!(**args)
7267
+ end
7268
+
7269
+ # Update properties of this object
7270
+ def update!(**args)
7271
+ @documents = args[:documents] if args.key?(:documents)
7272
+ end
7273
+ end
7274
+
6122
7275
  # The long-running operation metadata for the EnableProcessor method.
6123
7276
  class GoogleCloudDocumentaiV1beta3EnableProcessorMetadata
6124
7277
  include Google::Apis::Core::Hashable
@@ -6638,6 +7791,101 @@ module Google
6638
7791
  end
6639
7792
  end
6640
7793
 
7794
+ # Request message for GenerateSchemaVersion.
7795
+ class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest
7796
+ include Google::Apis::Core::Hashable
7797
+
7798
+ # The base schema version name to use for the schema generation. Format: `
7799
+ # projects/`project`/locations/`location`/schemas/`schema`/schemaVersions/`
7800
+ # schema_version``
7801
+ # Corresponds to the JSON property `baseSchemaVersion`
7802
+ # @return [String]
7803
+ attr_accessor :base_schema_version
7804
+
7805
+ # Specifies a set of documents on Cloud Storage.
7806
+ # Corresponds to the JSON property `gcsDocuments`
7807
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocuments]
7808
+ attr_accessor :gcs_documents
7809
+
7810
+ # Specifies all documents on Cloud Storage with a common prefix.
7811
+ # Corresponds to the JSON property `gcsPrefix`
7812
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsPrefix]
7813
+ attr_accessor :gcs_prefix
7814
+
7815
+ # The parameters for the schema generation.
7816
+ # Corresponds to the JSON property `generateSchemaVersionParams`
7817
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams]
7818
+ attr_accessor :generate_schema_version_params
7819
+
7820
+ # A set of inline documents.
7821
+ # Corresponds to the JSON property `inlineDocuments`
7822
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Documents]
7823
+ attr_accessor :inline_documents
7824
+
7825
+ # Specifies a set of raw documents.
7826
+ # Corresponds to the JSON property `rawDocuments`
7827
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocuments]
7828
+ attr_accessor :raw_documents
7829
+
7830
+ def initialize(**args)
7831
+ update!(**args)
7832
+ end
7833
+
7834
+ # Update properties of this object
7835
+ def update!(**args)
7836
+ @base_schema_version = args[:base_schema_version] if args.key?(:base_schema_version)
7837
+ @gcs_documents = args[:gcs_documents] if args.key?(:gcs_documents)
7838
+ @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
7839
+ @generate_schema_version_params = args[:generate_schema_version_params] if args.key?(:generate_schema_version_params)
7840
+ @inline_documents = args[:inline_documents] if args.key?(:inline_documents)
7841
+ @raw_documents = args[:raw_documents] if args.key?(:raw_documents)
7842
+ end
7843
+ end
7844
+
7845
+ # The parameters for the schema generation.
7846
+ class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams
7847
+ include Google::Apis::Core::Hashable
7848
+
7849
+ # The history of schema generation iterations.
7850
+ # Corresponds to the JSON property `history`
7851
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaGenerationHistory]
7852
+ attr_accessor :history
7853
+
7854
+ # Optional. The prompt used for the schema generation.
7855
+ # Corresponds to the JSON property `prompt`
7856
+ # @return [String]
7857
+ attr_accessor :prompt
7858
+
7859
+ def initialize(**args)
7860
+ update!(**args)
7861
+ end
7862
+
7863
+ # Update properties of this object
7864
+ def update!(**args)
7865
+ @history = args[:history] if args.key?(:history)
7866
+ @prompt = args[:prompt] if args.key?(:prompt)
7867
+ end
7868
+ end
7869
+
7870
+ # Response message for GenerateSchemaVersion.
7871
+ class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse
7872
+ include Google::Apis::Core::Hashable
7873
+
7874
+ # SchemaVersion is a version of the Schema which is created in SchemaGroup.
7875
+ # Corresponds to the JSON property `schemaVersion`
7876
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion]
7877
+ attr_accessor :schema_version
7878
+
7879
+ def initialize(**args)
7880
+ update!(**args)
7881
+ end
7882
+
7883
+ # Update properties of this object
7884
+ def update!(**args)
7885
+ @schema_version = args[:schema_version] if args.key?(:schema_version)
7886
+ end
7887
+ end
7888
+
6641
7889
  #
6642
7890
  class GoogleCloudDocumentaiV1beta3GetDocumentResponse
6643
7891
  include Google::Apis::Core::Hashable
@@ -7175,6 +8423,100 @@ module Google
7175
8423
  end
7176
8424
  end
7177
8425
 
8426
+ # Response message for ListSchemaVersions.
8427
+ class GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse
8428
+ include Google::Apis::Core::Hashable
8429
+
8430
+ # Points to the next SchemaVersion, otherwise empty.
8431
+ # Corresponds to the JSON property `nextPageToken`
8432
+ # @return [String]
8433
+ attr_accessor :next_page_token
8434
+
8435
+ # The list of SchemaVersions.
8436
+ # Corresponds to the JSON property `schemaVersions`
8437
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion>]
8438
+ attr_accessor :schema_versions
8439
+
8440
+ def initialize(**args)
8441
+ update!(**args)
8442
+ end
8443
+
8444
+ # Update properties of this object
8445
+ def update!(**args)
8446
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8447
+ @schema_versions = args[:schema_versions] if args.key?(:schema_versions)
8448
+ end
8449
+ end
8450
+
8451
+ # Response message for ListSchemas.
8452
+ class GoogleCloudDocumentaiV1beta3ListSchemasResponse
8453
+ include Google::Apis::Core::Hashable
8454
+
8455
+ # Points to the next Schema, otherwise empty.
8456
+ # Corresponds to the JSON property `nextPageToken`
8457
+ # @return [String]
8458
+ attr_accessor :next_page_token
8459
+
8460
+ # The list of Schemas.
8461
+ # Corresponds to the JSON property `schemas`
8462
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema>]
8463
+ attr_accessor :schemas
8464
+
8465
+ def initialize(**args)
8466
+ update!(**args)
8467
+ end
8468
+
8469
+ # Update properties of this object
8470
+ def update!(**args)
8471
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
8472
+ @schemas = args[:schemas] if args.key?(:schemas)
8473
+ end
8474
+ end
8475
+
8476
+ # NextSchema is a collection of SchemaVersions.
8477
+ class GoogleCloudDocumentaiV1beta3NextSchema
8478
+ include Google::Apis::Core::Hashable
8479
+
8480
+ # Output only. The time when the Schema was created.
8481
+ # Corresponds to the JSON property `createTime`
8482
+ # @return [String]
8483
+ attr_accessor :create_time
8484
+
8485
+ # Optional. The user-defined name of the Schema.
8486
+ # Corresponds to the JSON property `displayName`
8487
+ # @return [String]
8488
+ attr_accessor :display_name
8489
+
8490
+ # Optional. The GCP labels for the Schema.
8491
+ # Corresponds to the JSON property `labels`
8492
+ # @return [Hash<String,String>]
8493
+ attr_accessor :labels
8494
+
8495
+ # Identifier. The resource name of the Schema. Format: `projects/`project`/
8496
+ # locations/`location`/schemas/`schema``
8497
+ # Corresponds to the JSON property `name`
8498
+ # @return [String]
8499
+ attr_accessor :name
8500
+
8501
+ # Output only. The time when the Schema was last updated.
8502
+ # Corresponds to the JSON property `updateTime`
8503
+ # @return [String]
8504
+ attr_accessor :update_time
8505
+
8506
+ def initialize(**args)
8507
+ update!(**args)
8508
+ end
8509
+
8510
+ # Update properties of this object
8511
+ def update!(**args)
8512
+ @create_time = args[:create_time] if args.key?(:create_time)
8513
+ @display_name = args[:display_name] if args.key?(:display_name)
8514
+ @labels = args[:labels] if args.key?(:labels)
8515
+ @name = args[:name] if args.key?(:name)
8516
+ @update_time = args[:update_time] if args.key?(:update_time)
8517
+ end
8518
+ end
8519
+
7178
8520
  # A vertex represents a 2D point in the image. NOTE: the normalized vertex
7179
8521
  # coordinates are relative to the original image and range from 0 to 1.
7180
8522
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
@@ -7630,6 +8972,13 @@ module Google
7630
8972
  class GoogleCloudDocumentaiV1beta3Processor
7631
8973
  include Google::Apis::Core::Hashable
7632
8974
 
8975
+ # Optional. SchemaVersion used by the Processor. It is the same as Processor's
8976
+ # DatasetSchema.schema_version Format is `projects/`project`/locations/`location`
8977
+ # /schemas/`schema`/schemaVersions/`schema_version`
8978
+ # Corresponds to the JSON property `activeSchemaVersion`
8979
+ # @return [String]
8980
+ attr_accessor :active_schema_version
8981
+
7633
8982
  # Output only. The time the processor was created.
7634
8983
  # Corresponds to the JSON property `createTime`
7635
8984
  # @return [String]
@@ -7697,6 +9046,7 @@ module Google
7697
9046
 
7698
9047
  # Update properties of this object
7699
9048
  def update!(**args)
9049
+ @active_schema_version = args[:active_schema_version] if args.key?(:active_schema_version)
7700
9050
  @create_time = args[:create_time] if args.key?(:create_time)
7701
9051
  @default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
7702
9052
  @display_name = args[:display_name] if args.key?(:display_name)
@@ -8086,6 +9436,25 @@ module Google
8086
9436
  end
8087
9437
  end
8088
9438
 
9439
+ # Specifies a set of raw documents.
9440
+ class GoogleCloudDocumentaiV1beta3RawDocuments
9441
+ include Google::Apis::Core::Hashable
9442
+
9443
+ # Specifies raw document content and mime type.
9444
+ # Corresponds to the JSON property `documents`
9445
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument>]
9446
+ attr_accessor :documents
9447
+
9448
+ def initialize(**args)
9449
+ update!(**args)
9450
+ end
9451
+
9452
+ # Update properties of this object
9453
+ def update!(**args)
9454
+ @documents = args[:documents] if args.key?(:documents)
9455
+ end
9456
+ end
9457
+
8089
9458
  # The long-running operation metadata for the ReviewDocument method.
8090
9459
  class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
8091
9460
  include Google::Apis::Core::Hashable
@@ -8251,6 +9620,100 @@ module Google
8251
9620
  end
8252
9621
  end
8253
9622
 
9623
+ # The history of schema generation iterations.
9624
+ class GoogleCloudDocumentaiV1beta3SchemaGenerationHistory
9625
+ include Google::Apis::Core::Hashable
9626
+
9627
+ # Required. Previous prompt-answers in a chronological order.
9628
+ # Corresponds to the JSON property `iterations`
9629
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaGenerationIteration>]
9630
+ attr_accessor :iterations
9631
+
9632
+ def initialize(**args)
9633
+ update!(**args)
9634
+ end
9635
+
9636
+ # Update properties of this object
9637
+ def update!(**args)
9638
+ @iterations = args[:iterations] if args.key?(:iterations)
9639
+ end
9640
+ end
9641
+
9642
+ # A single iteration of the schema generation.
9643
+ class GoogleCloudDocumentaiV1beta3SchemaGenerationIteration
9644
+ include Google::Apis::Core::Hashable
9645
+
9646
+ # SchemaVersion is a version of the Schema which is created in SchemaGroup.
9647
+ # Corresponds to the JSON property `adjustedSchema`
9648
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion]
9649
+ attr_accessor :adjusted_schema
9650
+
9651
+ # SchemaVersion is a version of the Schema which is created in SchemaGroup.
9652
+ # Corresponds to the JSON property `generatedSchema`
9653
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion]
9654
+ attr_accessor :generated_schema
9655
+
9656
+ # Optional. The prompt used for the iteration.
9657
+ # Corresponds to the JSON property `prompt`
9658
+ # @return [String]
9659
+ attr_accessor :prompt
9660
+
9661
+ def initialize(**args)
9662
+ update!(**args)
9663
+ end
9664
+
9665
+ # Update properties of this object
9666
+ def update!(**args)
9667
+ @adjusted_schema = args[:adjusted_schema] if args.key?(:adjusted_schema)
9668
+ @generated_schema = args[:generated_schema] if args.key?(:generated_schema)
9669
+ @prompt = args[:prompt] if args.key?(:prompt)
9670
+ end
9671
+ end
9672
+
9673
+ # SchemaVersion is a version of the Schema which is created in SchemaGroup.
9674
+ class GoogleCloudDocumentaiV1beta3SchemaVersion
9675
+ include Google::Apis::Core::Hashable
9676
+
9677
+ # Output only. The time when the SchemaVersion was created.
9678
+ # Corresponds to the JSON property `createTime`
9679
+ # @return [String]
9680
+ attr_accessor :create_time
9681
+
9682
+ # Optional. The user-defined name of the SchemaVersion.
9683
+ # Corresponds to the JSON property `displayName`
9684
+ # @return [String]
9685
+ attr_accessor :display_name
9686
+
9687
+ # Optional. The GCP labels for the SchemaVersion.
9688
+ # Corresponds to the JSON property `labels`
9689
+ # @return [Hash<String,String>]
9690
+ attr_accessor :labels
9691
+
9692
+ # Identifier. The resource name of the SchemaVersion. Format: `projects/`project`
9693
+ # /locations/`location`/schemas/`schema`/schemaVersions/`schema_version``
9694
+ # Corresponds to the JSON property `name`
9695
+ # @return [String]
9696
+ attr_accessor :name
9697
+
9698
+ # The schema defines the output of the processed document by a processor.
9699
+ # Corresponds to the JSON property `schema`
9700
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema]
9701
+ attr_accessor :schema
9702
+
9703
+ def initialize(**args)
9704
+ update!(**args)
9705
+ end
9706
+
9707
+ # Update properties of this object
9708
+ def update!(**args)
9709
+ @create_time = args[:create_time] if args.key?(:create_time)
9710
+ @display_name = args[:display_name] if args.key?(:display_name)
9711
+ @labels = args[:labels] if args.key?(:labels)
9712
+ @name = args[:name] if args.key?(:name)
9713
+ @schema = args[:schema] if args.key?(:schema)
9714
+ end
9715
+ end
9716
+
8254
9717
  # The long-running operation metadata for the SetDefaultProcessorVersion method.
8255
9718
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
8256
9719
  include Google::Apis::Core::Hashable
@@ -8614,6 +10077,25 @@ module Google
8614
10077
  end
8615
10078
  end
8616
10079
 
10080
+ # The long-running operation metadata for the UpdateProcessorVersion method.
10081
+ class GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata
10082
+ include Google::Apis::Core::Hashable
10083
+
10084
+ # The common metadata for long running operations.
10085
+ # Corresponds to the JSON property `commonMetadata`
10086
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
10087
+ attr_accessor :common_metadata
10088
+
10089
+ def initialize(**args)
10090
+ update!(**args)
10091
+ end
10092
+
10093
+ # Update properties of this object
10094
+ def update!(**args)
10095
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
10096
+ end
10097
+ end
10098
+
8617
10099
  # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
8618
10100
  # in the same scale as the original image.
8619
10101
  class GoogleCloudDocumentaiV1beta3Vertex