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