From 9c967699aeb3d54317481056fe80eb18537a7588 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Sun, 2 Nov 2025 09:44:45 +0000 Subject: [PATCH] feat: Automated regeneration of documentai v1beta3 client --- api_names_out.yaml | 199 ++ .../CHANGELOG.md | 4 + .../google/apis/documentai_v1beta3/classes.rb | 1858 +++++++++++++++-- .../apis/documentai_v1beta3/gem_version.rb | 4 +- .../documentai_v1beta3/representations.rb | 782 ++++++- .../google/apis/documentai_v1beta3/service.rb | 387 ++++ 6 files changed, 2981 insertions(+), 253 deletions(-) diff --git a/api_names_out.yaml b/api_names_out.yaml index aaa6bc0c3d0..5224385618c 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -244395,6 +244395,38 @@ "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId/gcsUri": gcs_uri "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId": google_cloud_documentai_uiv1beta3_document_id_unmanaged_document_id "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId/docId": doc_id +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchema": google_cloud_documentai_uiv1beta3_document_schema +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchema/description": description +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchema/displayName": display_name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchema/entityTypes": entity_types +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchema/entityTypes/entity_type": entity_type +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchema/metadata": metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType": google_cloud_documentai_uiv1beta3_document_schema_entity_type +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/baseTypes": base_types +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/baseTypes/base_type": base_type +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/description": description +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/displayName": display_name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/entityTypeMetadata": entity_type_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/enumValues": enum_values +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/name": name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/properties": properties +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType/properties/property": property +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues": google_cloud_documentai_uiv1beta3_document_schema_entity_type_enum_values +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues/values": values +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues/values/value": value +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty": google_cloud_documentai_uiv1beta3_document_schema_entity_type_property +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty/description": description +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty/displayName": display_name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty/method": method_prop +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty/name": name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty/occurrenceType": occurrence_type +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty/propertyMetadata": property_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty/valueType": value_type +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata": google_cloud_documentai_uiv1beta3_document_schema_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata/documentAllowMultipleLabels": document_allow_multiple_labels +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata/documentSplitter": document_splitter +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata/prefixedNamingOnProperties": prefixed_naming_on_properties +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata/skipNamingValidation": skip_naming_validation "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": google_cloud_documentai_uiv1beta3_enable_processor_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/createTime": create_time @@ -244402,6 +244434,13 @@ "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/stateMessage": state_message "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/updateTime": update_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": google_cloud_documentai_uiv1beta3_enable_processor_response +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata": google_cloud_documentai_uiv1beta3_entity_type_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata/fieldTierMetadata": field_tier_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata/humanReviewLabelingMetadata": human_review_labeling_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata/humanReviewMetadata": human_review_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata/inactive": inactive +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata/schemaEditabilityMetadata": schema_editability_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata/schemaInferenceMetadata": schema_inference_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": google_cloud_documentai_uiv1beta3_evaluate_processor_version_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse": google_cloud_documentai_uiv1beta3_evaluate_processor_version_response @@ -244417,14 +244456,23 @@ "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics/metrics": metrics "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": google_cloud_documentai_uiv1beta3_evaluation_metrics "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/f1Score": f1_score +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/falseNegativesCount": false_negatives_count +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/falsePositivesCount": false_positives_count +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/groundTruthDocumentCount": ground_truth_document_count +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/groundTruthOccurrencesCount": ground_truth_occurrences_count "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/precision": precision +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/predictedDocumentCount": predicted_document_count +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/predictedOccurrencesCount": predicted_occurrences_count "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/recall": recall +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/totalDocumentsCount": total_documents_count +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMetrics/truePositivesCount": true_positives_count "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics": google_cloud_documentai_uiv1beta3_evaluation_multi_confidence_metrics "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics/confidenceLevelMetrics": confidence_level_metrics ? "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics/confidenceLevelMetrics/confidence_level_metric" : confidence_level_metric "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationReference": google_cloud_documentai_uiv1beta3_evaluation_reference "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationReference/aggregateMetrics": aggregate_metrics +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationReference/aggregateMetricsExact": aggregate_metrics_exact "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationReference/evaluation": evaluation "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EvaluationReference/operation": operation "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": google_cloud_documentai_uiv1beta3_export_documents_metadata @@ -244445,6 +244493,18 @@ "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": google_cloud_documentai_uiv1beta3_export_processor_version_response "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse/gcsUri": gcs_uri +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata": google_cloud_documentai_uiv1beta3_field_extraction_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata/entityQuery": entity_query +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata/summaryOptions": summary_options +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery": google_cloud_documentai_uiv1beta3_field_extraction_metadata_entity_query +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery/userEntityQuery": user_entity_query +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3FieldTierMetadata": google_cloud_documentai_uiv1beta3_field_tier_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3FieldTierMetadata/tierLevel": tier_level +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata": google_cloud_documentai_uiv1beta3_human_review_labeling_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata/enableNormalizationEditing": enable_normalization_editing +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata": google_cloud_documentai_uiv1beta3_human_review_validation_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata/confidenceThreshold": confidence_threshold +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata/enableValidation": enable_validation "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": google_cloud_documentai_uiv1beta3_import_documents_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata/importConfigValidationResults": import_config_validation_results @@ -244466,13 +244526,61 @@ "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse": google_cloud_documentai_uiv1beta3_import_processor_version_response "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse/processorVersion": processor_version +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor": google_cloud_documentai_uiv1beta3_processor +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/activeSchemaVersion": active_schema_version +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/createTime": create_time +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/defaultProcessorVersion": default_processor_version +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/displayName": display_name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/kmsKeyName": kms_key_name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/name": name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/processEndpoint": process_endpoint +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/processorVersionAliases": processor_version_aliases +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/processorVersionAliases/processor_version_alias": processor_version_alias +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/satisfiesPzi": satisfies_pzi +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/satisfiesPzs": satisfies_pzs +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/state": state +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Processor/type": type "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion": google_cloud_documentai_uiv1beta3_processor_version "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/createTime": create_time +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/deploymentAllowed": deployment_allowed +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/deprecationInfo": deprecation_info "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/displayName": display_name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/documentSchema": document_schema +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/genAiModelInfo": gen_ai_model_info +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/googleManaged": google_managed +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/kmsKeyName": kms_key_name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/kmsKeyVersionName": kms_key_version_name "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/latestEvaluation": latest_evaluation +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/modelType": model_type "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/name": name +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/satisfiesPzi": satisfies_pzi +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/satisfiesPzs": satisfies_pzs "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/schema": schema "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersion/state": state +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias": google_cloud_documentai_uiv1beta3_processor_version_alias +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias/alias": alias +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias/processorVersion": processor_version +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo": google_cloud_documentai_uiv1beta3_processor_version_deprecation_info +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo/deprecationTime": deprecation_time +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo/replacementProcessorVersion": replacement_processor_version +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo": google_cloud_documentai_uiv1beta3_processor_version_gen_ai_model_info +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo/customGenAiModelInfo": custom_gen_ai_model_info +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo/foundationGenAiModelInfo": foundation_gen_ai_model_info +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": google_cloud_documentai_uiv1beta3_processor_version_gen_ai_model_info_custom_gen_ai_model_info +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo/baseProcessorVersionId": base_processor_version_id +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo/customModelType": custom_model_type +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": google_cloud_documentai_uiv1beta3_processor_version_gen_ai_model_info_foundation_gen_ai_model_info +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo/finetuningAllowed": finetuning_allowed +? "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo/minTrainLabeledDocuments" +: min_train_labeled_documents +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3PropertyMetadata": google_cloud_documentai_uiv1beta3_property_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3PropertyMetadata/fieldExtractionMetadata": field_extraction_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3PropertyMetadata/fieldTierMetadata": field_tier_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3PropertyMetadata/humanReviewLabelingMetadata": human_review_labeling_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3PropertyMetadata/humanReviewMetadata": human_review_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3PropertyMetadata/inactive": inactive +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3PropertyMetadata/schemaEditabilityMetadata": schema_editability_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3PropertyMetadata/schemaInferenceMetadata": schema_inference_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": google_cloud_documentai_uiv1beta3_resync_dataset_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata/datasetResyncStatuses": dataset_resync_statuses @@ -244518,17 +244626,30 @@ "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Schema/displayName": display_name "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Schema/entityTypes": entity_types "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3Schema/entityTypes/entity_type": entity_type +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata": google_cloud_documentai_uiv1beta3_schema_editability_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata/editable": editable +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata/processorVersions": processor_versions +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata/processorVersions/processor_version": processor_version "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType": google_cloud_documentai_uiv1beta3_schema_entity_type "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/baseType": base_type "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/description": description +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/enumValues": enum_values +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/enumValues/enum_value": enum_value +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/hide": hide +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/method": method_prop "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/occurrenceType": occurrence_type "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/properties": properties "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/properties/property": property "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/source": source "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaEntityType/type": type +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata": google_cloud_documentai_uiv1beta3_schema_inference_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata/inferred": inferred "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": google_cloud_documentai_uiv1beta3_set_default_processor_version_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": google_cloud_documentai_uiv1beta3_set_default_processor_version_response +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SummaryOptions": google_cloud_documentai_uiv1beta3_summary_options +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SummaryOptions/format": format +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3SummaryOptions/length": length "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": google_cloud_documentai_uiv1beta3_train_processor_version_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata/testDatasetValidation": test_dataset_validation @@ -244555,6 +244676,8 @@ "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata/state": state "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata/stateMessage": state_message "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata/updateTime": update_time +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata": google_cloud_documentai_uiv1beta3_update_processor_version_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiV1BatchProcessMetadata": google_cloud_documentai_v1_batch_process_metadata "/documentai:v1beta3/GoogleCloudDocumentaiV1BatchProcessMetadata/createTime": create_time "/documentai:v1beta3/GoogleCloudDocumentaiV1BatchProcessMetadata/individualProcessStatuses": individual_process_statuses @@ -245601,6 +245724,7 @@ "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput/validationResults": validation_results "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput/validationResults/validation_result": validation_result "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult": google_cloud_documentai_v1beta3_document_entity_validation_output_validation_result +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult/rule": rule "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult/ruleDescription": rule_description "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult/ruleName": rule_name "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult/validationDetails": validation_details @@ -245877,6 +246001,9 @@ "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentValidationOutputValidationResult/ruleName": rule_name "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentValidationOutputValidationResult/validationDetails": validation_details "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3DocumentValidationOutputValidationResult/validationResultType": validation_result_type +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3Documents": google_cloud_documentai_v1beta3_documents +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3Documents/documents": documents +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3Documents/documents/document": document "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": google_cloud_documentai_v1beta3_enable_processor_metadata "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3EnableProcessorMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3EnableProcessorRequest": google_cloud_documentai_v1beta3_enable_processor_request @@ -245950,6 +246077,18 @@ "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GcsDocuments/documents/document": document "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GcsPrefix": google_cloud_documentai_v1beta3_gcs_prefix "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GcsPrefix/gcsUriPrefix": gcs_uri_prefix +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest": google_cloud_documentai_v1beta3_generate_schema_version_request +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest/baseSchemaVersion": base_schema_version +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest/gcsDocuments": gcs_documents +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest/gcsPrefix": gcs_prefix +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest/generateSchemaVersionParams": generate_schema_version_params +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest/inlineDocuments": inline_documents +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest/rawDocuments": raw_documents +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams": google_cloud_documentai_v1beta3_generate_schema_version_request_generate_schema_version_params +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams/history": history +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams/prompt": prompt +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse": google_cloud_documentai_v1beta3_generate_schema_version_response +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse/schemaVersion": schema_version "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GetDocumentResponse": google_cloud_documentai_v1beta3_get_document_response "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3GetDocumentResponse/document": document "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata": google_cloud_documentai_v1beta3_human_review_labeling_metadata @@ -246024,6 +246163,21 @@ "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListProcessorsResponse/nextPageToken": next_page_token "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListProcessorsResponse/processors": processors "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListProcessorsResponse/processors/processor": processor +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse": google_cloud_documentai_v1beta3_list_schema_versions_response +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse/nextPageToken": next_page_token +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse/schemaVersions": schema_versions +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse/schemaVersions/schema_version": schema_version +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListSchemasResponse": google_cloud_documentai_v1beta3_list_schemas_response +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListSchemasResponse/nextPageToken": next_page_token +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListSchemasResponse/schemas": schemas +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3ListSchemasResponse/schemas/schema": schema +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NextSchema": google_cloud_documentai_v1beta3_next_schema +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NextSchema/createTime": create_time +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NextSchema/displayName": display_name +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NextSchema/labels": labels +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NextSchema/labels/label": label +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NextSchema/name": name +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NextSchema/updateTime": update_time "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NormalizedVertex": google_cloud_documentai_v1beta3_normalized_vertex "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NormalizedVertex/x": x "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3NormalizedVertex/y": "y" @@ -246188,6 +246342,20 @@ "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaEntityType/properties/property": property "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaEntityType/source": source "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaEntityType/type": type +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaGenerationHistory": google_cloud_documentai_v1beta3_schema_generation_history +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaGenerationHistory/iterations": iterations +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaGenerationHistory/iterations/iteration": iteration +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaGenerationIteration": google_cloud_documentai_v1beta3_schema_generation_iteration +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaGenerationIteration/adjustedSchema": adjusted_schema +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaGenerationIteration/generatedSchema": generated_schema +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaGenerationIteration/prompt": prompt +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaVersion": google_cloud_documentai_v1beta3_schema_version +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaVersion/createTime": create_time +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaVersion/displayName": display_name +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaVersion/labels": labels +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaVersion/labels/label": label +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaVersion/name": name +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SchemaVersion/schema": schema "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": google_cloud_documentai_v1beta3_set_default_processor_version_metadata "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest": google_cloud_documentai_v1beta3_set_default_processor_version_request @@ -246230,6 +246398,8 @@ "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse": google_cloud_documentai_v1beta3_undeploy_processor_version_response "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata": google_cloud_documentai_v1beta3_update_dataset_operation_metadata "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata/commonMetadata": common_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata": google_cloud_documentai_v1beta3_update_processor_version_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3Vertex": google_cloud_documentai_v1beta3_vertex "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3Vertex/x": x "/documentai:v1beta3/GoogleCloudDocumentaiV1beta3Vertex/y": "y" @@ -246410,6 +246580,35 @@ "/documentai:v1beta3/documentai.projects.locations.processors.updateDataset": update_project_location_processor_dataset "/documentai:v1beta3/documentai.projects.locations.processors.updateDataset/name": name "/documentai:v1beta3/documentai.projects.locations.processors.updateDataset/updateMask": update_mask +"/documentai:v1beta3/documentai.projects.locations.schemas.create": create_project_location_schema +"/documentai:v1beta3/documentai.projects.locations.schemas.create/parent": parent +"/documentai:v1beta3/documentai.projects.locations.schemas.delete": delete_project_location_schema +"/documentai:v1beta3/documentai.projects.locations.schemas.delete/force": force +"/documentai:v1beta3/documentai.projects.locations.schemas.delete/name": name +"/documentai:v1beta3/documentai.projects.locations.schemas.get": get_project_location_schema +"/documentai:v1beta3/documentai.projects.locations.schemas.get/name": name +"/documentai:v1beta3/documentai.projects.locations.schemas.list": list_project_location_schemas +"/documentai:v1beta3/documentai.projects.locations.schemas.list/pageSize": page_size +"/documentai:v1beta3/documentai.projects.locations.schemas.list/pageToken": page_token +"/documentai:v1beta3/documentai.projects.locations.schemas.list/parent": parent +"/documentai:v1beta3/documentai.projects.locations.schemas.patch": patch_project_location_schema +"/documentai:v1beta3/documentai.projects.locations.schemas.patch/name": name +"/documentai:v1beta3/documentai.projects.locations.schemas.patch/updateMask": update_mask +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.create": create_project_location_schema_schema_version +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.create/parent": parent +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.delete": delete_project_location_schema_schema_version +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.delete/name": name +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.generate": generate_project_location_schema_schema_version +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.generate/parent": parent +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.get": get_project_location_schema_schema_version +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.get/name": name +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.list": list_project_location_schema_schema_versions +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.list/pageSize": page_size +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.list/pageToken": page_token +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.list/parent": parent +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.patch": patch_project_location_schema_schema_version +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.patch/name": name +"/documentai:v1beta3/documentai.projects.locations.schemas.schemaVersions.patch/updateMask": update_mask "/documentai:v1beta3/fields": fields "/documentai:v1beta3/key": key "/documentai:v1beta3/quotaUser": quota_user diff --git a/generated/google-apis-documentai_v1beta3/CHANGELOG.md b/generated/google-apis-documentai_v1beta3/CHANGELOG.md index 728506f0988..6a45bb6c067 100644 --- a/generated/google-apis-documentai_v1beta3/CHANGELOG.md +++ b/generated/google-apis-documentai_v1beta3/CHANGELOG.md @@ -1,5 +1,9 @@ # Release history for google-apis-documentai_v1beta3 +### v0.116.0 (2025-11-02) + +* Regenerated from discovery document revision 20251020 + ### v0.115.0 (2025-10-19) * Regenerated from discovery document revision 20251013 diff --git a/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/classes.rb b/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/classes.rb index a28f8f46729..e0ec91a7e64 100644 --- a/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/classes.rb +++ b/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/classes.rb @@ -922,29 +922,29 @@ def update!(**args) end end - # The long-running operation metadata for the EnableProcessor method. - class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + # The schema defines the output of the processed document by a processor. + class GoogleCloudDocumentaiUiv1beta3DocumentSchema include Google::Apis::Core::Hashable - # The common metadata for long running operations. - # Corresponds to the JSON property `commonMetadata` - # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] - attr_accessor :common_metadata + # Description of the schema. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description - def initialize(**args) - update!(**args) - end + # Display name to show to users. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name - # Update properties of this object - def update!(**args) - @common_metadata = args[:common_metadata] if args.key?(:common_metadata) - end - end + # Entity types of the schema. + # Corresponds to the JSON property `entityTypes` + # @return [Array] + attr_accessor :entity_types - # Response message for the EnableProcessor method. Intentionally empty proto for - # adding fields in future. - class GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse - include Google::Apis::Core::Hashable + # Metadata for global schema behavior. + # Corresponds to the JSON property `metadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata] + attr_accessor :metadata def initialize(**args) update!(**args) @@ -952,36 +952,62 @@ def initialize(**args) # Update properties of this object def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_types = args[:entity_types] if args.key?(:entity_types) + @metadata = args[:metadata] if args.key?(:metadata) end end - # Metadata of the EvaluateProcessorVersion method. - class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata + # EntityType is the wrapper of a label of the corresponding model with detailed + # attributes and limitations for entity-based processors. Multiple types can + # also compose a dependency tree to represent nested types. + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType include Google::Apis::Core::Hashable - # The common metadata for long running operations. - # Corresponds to the JSON property `commonMetadata` - # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] - attr_accessor :common_metadata + # The entity type that this type is derived from. For now, one and only one + # should be set. + # Corresponds to the JSON property `baseTypes` + # @return [Array] + attr_accessor :base_types - def initialize(**args) - update!(**args) - end + # The description of the entity type. Could be used to provide more information + # about the entity type for model calls. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description - # Update properties of this object - def update!(**args) - @common_metadata = args[:common_metadata] if args.key?(:common_metadata) - end - end + # User defined name for the type. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name - # Response of the EvaluateProcessorVersion method. - class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse - include Google::Apis::Core::Hashable + # Metadata about an entity type. + # Corresponds to the JSON property `entityTypeMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata] + attr_accessor :entity_type_metadata - # The resource name of the created evaluation. - # Corresponds to the JSON property `evaluation` + # Defines the a list of enum values. + # Corresponds to the JSON property `enumValues` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues] + attr_accessor :enum_values + + # Name of the type. It must be unique within the schema file and cannot be a " + # Common Type". The following naming conventions are used: - Use `snake_casing`. + # - Name matching is case-sensitive. - Maximum 64 characters. - Must start with + # a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward + # compatibility internal infrastructure and tooling can handle any ascii + # character.) - The `/` is sometimes used to denote a property of a type. For + # example `line_item/amount`. This convention is deprecated, but will still be + # honored for backward compatibility. + # Corresponds to the JSON property `name` # @return [String] - attr_accessor :evaluation + attr_accessor :name + + # Description the nested structure, or composition of an entity. + # Corresponds to the JSON property `properties` + # @return [Array] + attr_accessor :properties def initialize(**args) update!(**args) @@ -989,28 +1015,24 @@ def initialize(**args) # Update properties of this object def update!(**args) - @evaluation = args[:evaluation] if args.key?(:evaluation) + @base_types = args[:base_types] if args.key?(:base_types) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_type_metadata = args[:entity_type_metadata] if args.key?(:entity_type_metadata) + @enum_values = args[:enum_values] if args.key?(:enum_values) + @name = args[:name] if args.key?(:name) + @properties = args[:properties] if args.key?(:properties) end end - # Metadata of the batch export documents operation. - class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata + # Defines the a list of enum values. + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues include Google::Apis::Core::Hashable - # The common metadata for long running operations. - # Corresponds to the JSON property `commonMetadata` - # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] - attr_accessor :common_metadata - - # The list of response details of each document. - # Corresponds to the JSON property `individualExportStatuses` - # @return [Array] - attr_accessor :individual_export_statuses - - # The list of statistics for each dataset split type. - # Corresponds to the JSON property `splitExportStats` - # @return [Array] - attr_accessor :split_export_stats + # The individual values that this enum values type can include. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values def initialize(**args) update!(**args) @@ -1018,62 +1040,51 @@ def initialize(**args) # Update properties of this object def update!(**args) - @common_metadata = args[:common_metadata] if args.key?(:common_metadata) - @individual_export_statuses = args[:individual_export_statuses] if args.key?(:individual_export_statuses) - @split_export_stats = args[:split_export_stats] if args.key?(:split_export_stats) + @values = args[:values] if args.key?(:values) end end - # The status of each individual document in the export process. - class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + # Defines properties that can be part of the entity type. + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty include Google::Apis::Core::Hashable - # Document Identifier. - # Corresponds to the JSON property `documentId` - # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId] - attr_accessor :document_id + # The description of the property. Could be used to provide more information + # about the property for model calls. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description - # The output_gcs_destination of the exported document if it was successful, - # otherwise empty. - # Corresponds to the JSON property `outputGcsDestination` + # User defined name for the property. + # Corresponds to the JSON property `displayName` # @return [String] - attr_accessor :output_gcs_destination + attr_accessor :display_name - # The `Status` type defines a logical error model that is suitable for different - # programming environments, including REST APIs and RPC APIs. It is used by [ - # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of - # data: error code, error message, and error details. You can find out more - # about this error model and how to work with it in the [API Design Guide](https: - # //cloud.google.com/apis/design/errors). - # Corresponds to the JSON property `status` - # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus] - attr_accessor :status + # Specifies how the entity's value is obtained. + # Corresponds to the JSON property `method` + # @return [String] + attr_accessor :method_prop - def initialize(**args) - update!(**args) - end + # The name of the property. Follows the same guidelines as the EntityType name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name - # Update properties of this object - def update!(**args) - @document_id = args[:document_id] if args.key?(:document_id) - @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination) - @status = args[:status] if args.key?(:status) - end - end + # Occurrence type limits the number of instances an entity type appears in the + # document. + # Corresponds to the JSON property `occurrenceType` + # @return [String] + attr_accessor :occurrence_type - # The statistic representing a dataset split type for this export. - class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat - include Google::Apis::Core::Hashable + # Metadata about a property. + # Corresponds to the JSON property `propertyMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3PropertyMetadata] + attr_accessor :property_metadata - # The dataset split type. - # Corresponds to the JSON property `splitType` + # A reference to the value type of the property. This type is subject to the + # same conventions as the `Entity.base_types` field. + # Corresponds to the JSON property `valueType` # @return [String] - attr_accessor :split_type - - # Total number of documents with the given dataset split type to be exported. - # Corresponds to the JSON property `totalDocumentCount` - # @return [Fixnum] - attr_accessor :total_document_count + attr_accessor :value_type def initialize(**args) update!(**args) @@ -1081,26 +1092,63 @@ def initialize(**args) # Update properties of this object def update!(**args) - @split_type = args[:split_type] if args.key?(:split_type) - @total_document_count = args[:total_document_count] if args.key?(:total_document_count) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @method_prop = args[:method_prop] if args.key?(:method_prop) + @name = args[:name] if args.key?(:name) + @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type) + @property_metadata = args[:property_metadata] if args.key?(:property_metadata) + @value_type = args[:value_type] if args.key?(:value_type) end end - # The response proto of ExportDocuments method. - class GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse + # Metadata for global schema behavior. + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata include Google::Apis::Core::Hashable + # If true, on a given page, there can be multiple `document` annotations + # covering it. + # Corresponds to the JSON property `documentAllowMultipleLabels` + # @return [Boolean] + attr_accessor :document_allow_multiple_labels + alias_method :document_allow_multiple_labels?, :document_allow_multiple_labels + + # If true, a `document` entity type can be applied to subdocument (splitting). + # Otherwise, it can only be applied to the entire document (classification). + # Corresponds to the JSON property `documentSplitter` + # @return [Boolean] + attr_accessor :document_splitter + alias_method :document_splitter?, :document_splitter + + # If set, all the nested entities must be prefixed with the parents. + # Corresponds to the JSON property `prefixedNamingOnProperties` + # @return [Boolean] + attr_accessor :prefixed_naming_on_properties + alias_method :prefixed_naming_on_properties?, :prefixed_naming_on_properties + + # If set, we will skip the naming format validation in the schema. So the string + # values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType. + # Property.name` will not be checked. + # Corresponds to the JSON property `skipNamingValidation` + # @return [Boolean] + attr_accessor :skip_naming_validation + alias_method :skip_naming_validation?, :skip_naming_validation + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @document_allow_multiple_labels = args[:document_allow_multiple_labels] if args.key?(:document_allow_multiple_labels) + @document_splitter = args[:document_splitter] if args.key?(:document_splitter) + @prefixed_naming_on_properties = args[:prefixed_naming_on_properties] if args.key?(:prefixed_naming_on_properties) + @skip_naming_validation = args[:skip_naming_validation] if args.key?(:skip_naming_validation) end end - # Metadata message associated with the ExportProcessorVersion operation. - class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata + # The long-running operation metadata for the EnableProcessor method. + class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata include Google::Apis::Core::Hashable # The common metadata for long running operations. @@ -1118,27 +1166,74 @@ def update!(**args) end end - # Response message associated with the ExportProcessorVersion operation. - class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse + # Response message for the EnableProcessor method. Intentionally empty proto for + # adding fields in future. + class GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse include Google::Apis::Core::Hashable - # The Cloud Storage URI containing the output artifacts. - # Corresponds to the JSON property `gcsUri` - # @return [String] - attr_accessor :gcs_uri - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri) end end - # Metadata of the import document operation. - class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + # Metadata about an entity type. + class GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata + include Google::Apis::Core::Hashable + + # Metadata for the field tier of a property. + # Corresponds to the JSON property `fieldTierMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldTierMetadata] + attr_accessor :field_tier_metadata + + # Metadata for human review labeling config. + # Corresponds to the JSON property `humanReviewLabelingMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata] + attr_accessor :human_review_labeling_metadata + + # Metadata for Human Review config. + # Corresponds to the JSON property `humanReviewMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata] + attr_accessor :human_review_metadata + + # Whether the entity type should be considered inactive. + # Corresponds to the JSON property `inactive` + # @return [Boolean] + attr_accessor :inactive + alias_method :inactive?, :inactive + + # Metadata that specifies whether a label is editable and reasons why. These + # fields are read-only. Changing these fields has no impact on the backend. + # Corresponds to the JSON property `schemaEditabilityMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata] + attr_accessor :schema_editability_metadata + + # Metadata for schema inference. Only used on dataset.schema for schema + # inference, can be safely ignored elsewhere. + # Corresponds to the JSON property `schemaInferenceMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata] + attr_accessor :schema_inference_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @field_tier_metadata = args[:field_tier_metadata] if args.key?(:field_tier_metadata) + @human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata) + @human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata) + @inactive = args[:inactive] if args.key?(:inactive) + @schema_editability_metadata = args[:schema_editability_metadata] if args.key?(:schema_editability_metadata) + @schema_inference_metadata = args[:schema_inference_metadata] if args.key?(:schema_inference_metadata) + end + end + + # Metadata of the EvaluateProcessorVersion method. + class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata include Google::Apis::Core::Hashable # The common metadata for long running operations. @@ -1146,20 +1241,169 @@ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] attr_accessor :common_metadata - # Validation statuses of the batch documents import config. - # Corresponds to the JSON property `importConfigValidationResults` - # @return [Array] - attr_accessor :import_config_validation_results + def initialize(**args) + update!(**args) + end - # The list of response details of each document. - # Corresponds to the JSON property `individualImportStatuses` - # @return [Array] - attr_accessor :individual_import_statuses + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end - # Total number of the documents that are qualified for importing. - # Corresponds to the JSON property `totalDocumentCount` + # Response of the EvaluateProcessorVersion method. + class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse + include Google::Apis::Core::Hashable + + # The resource name of the created evaluation. + # Corresponds to the JSON property `evaluation` + # @return [String] + attr_accessor :evaluation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @evaluation = args[:evaluation] if args.key?(:evaluation) + end + end + + # Evaluation metrics, either in aggregate or about a specific entity. + class GoogleCloudDocumentaiUiv1beta3EvaluationMetrics + include Google::Apis::Core::Hashable + + # The calculated f1 score. + # Corresponds to the JSON property `f1Score` + # @return [Float] + attr_accessor :f1_score + + # The amount of false negatives. + # Corresponds to the JSON property `falseNegativesCount` # @return [Fixnum] - attr_accessor :total_document_count + attr_accessor :false_negatives_count + + # The amount of false positives. + # Corresponds to the JSON property `falsePositivesCount` + # @return [Fixnum] + attr_accessor :false_positives_count + + # The amount of documents with a ground truth occurrence. + # Corresponds to the JSON property `groundTruthDocumentCount` + # @return [Fixnum] + attr_accessor :ground_truth_document_count + + # The amount of occurrences in ground truth documents. + # Corresponds to the JSON property `groundTruthOccurrencesCount` + # @return [Fixnum] + attr_accessor :ground_truth_occurrences_count + + # The calculated precision. + # Corresponds to the JSON property `precision` + # @return [Float] + attr_accessor :precision + + # The amount of documents with a predicted occurrence. + # Corresponds to the JSON property `predictedDocumentCount` + # @return [Fixnum] + attr_accessor :predicted_document_count + + # The amount of occurrences in predicted documents. + # Corresponds to the JSON property `predictedOccurrencesCount` + # @return [Fixnum] + attr_accessor :predicted_occurrences_count + + # The calculated recall. + # Corresponds to the JSON property `recall` + # @return [Float] + attr_accessor :recall + + # The amount of documents that had an occurrence of this label. + # Corresponds to the JSON property `totalDocumentsCount` + # @return [Fixnum] + attr_accessor :total_documents_count + + # The amount of true positives. + # Corresponds to the JSON property `truePositivesCount` + # @return [Fixnum] + attr_accessor :true_positives_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @f1_score = args[:f1_score] if args.key?(:f1_score) + @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count) + @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count) + @ground_truth_document_count = args[:ground_truth_document_count] if args.key?(:ground_truth_document_count) + @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count) + @precision = args[:precision] if args.key?(:precision) + @predicted_document_count = args[:predicted_document_count] if args.key?(:predicted_document_count) + @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count) + @recall = args[:recall] if args.key?(:recall) + @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count) + @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count) + end + end + + # Gives a short summary of an evaluation, and links to the evaluation itself. + class GoogleCloudDocumentaiUiv1beta3EvaluationReference + include Google::Apis::Core::Hashable + + # Evaluation metrics, either in aggregate or about a specific entity. + # Corresponds to the JSON property `aggregateMetrics` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics] + attr_accessor :aggregate_metrics + + # Evaluation metrics, either in aggregate or about a specific entity. + # Corresponds to the JSON property `aggregateMetricsExact` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics] + attr_accessor :aggregate_metrics_exact + + # The resource name of the evaluation. + # Corresponds to the JSON property `evaluation` + # @return [String] + attr_accessor :evaluation + + # The resource name of the Long Running Operation for the evaluation. + # Corresponds to the JSON property `operation` + # @return [String] + attr_accessor :operation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics) + @aggregate_metrics_exact = args[:aggregate_metrics_exact] if args.key?(:aggregate_metrics_exact) + @evaluation = args[:evaluation] if args.key?(:evaluation) + @operation = args[:operation] if args.key?(:operation) + end + end + + # Metadata of the batch export documents operation. + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + # The list of response details of each document. + # Corresponds to the JSON property `individualExportStatuses` + # @return [Array] + attr_accessor :individual_export_statuses + + # The list of statistics for each dataset split type. + # Corresponds to the JSON property `splitExportStats` + # @return [Array] + attr_accessor :split_export_stats def initialize(**args) update!(**args) @@ -1168,22 +1412,25 @@ def initialize(**args) # Update properties of this object def update!(**args) @common_metadata = args[:common_metadata] if args.key?(:common_metadata) - @import_config_validation_results = args[:import_config_validation_results] if args.key?(:import_config_validation_results) - @individual_import_statuses = args[:individual_import_statuses] if args.key?(:individual_import_statuses) - @total_document_count = args[:total_document_count] if args.key?(:total_document_count) + @individual_export_statuses = args[:individual_export_statuses] if args.key?(:individual_export_statuses) + @split_export_stats = args[:split_export_stats] if args.key?(:split_export_stats) end end - # The validation status of each import config. Status is set to an error if - # there are no documents to import in the `import_config`, or `OK` if the - # operation will try to proceed with at least one document. - class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + # The status of each individual document in the export process. + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus include Google::Apis::Core::Hashable - # The source Cloud Storage URI specified in the import config. - # Corresponds to the JSON property `inputGcsSource` + # Document Identifier. + # Corresponds to the JSON property `documentId` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId] + attr_accessor :document_id + + # The output_gcs_destination of the exported document if it was successful, + # otherwise empty. + # Corresponds to the JSON property `outputGcsDestination` # @return [String] - attr_accessor :input_gcs_source + attr_accessor :output_gcs_destination # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by [ @@ -1201,40 +1448,642 @@ def initialize(**args) # Update properties of this object def update!(**args) - @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source) - @status = args[:status] if args.key?(:status) + @document_id = args[:document_id] if args.key?(:document_id) + @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination) + @status = args[:status] if args.key?(:status) + end + end + + # The statistic representing a dataset split type for this export. + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + include Google::Apis::Core::Hashable + + # The dataset split type. + # Corresponds to the JSON property `splitType` + # @return [String] + attr_accessor :split_type + + # Total number of documents with the given dataset split type to be exported. + # Corresponds to the JSON property `totalDocumentCount` + # @return [Fixnum] + attr_accessor :total_document_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @split_type = args[:split_type] if args.key?(:split_type) + @total_document_count = args[:total_document_count] if args.key?(:total_document_count) + end + end + + # The response proto of ExportDocuments method. + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Metadata message associated with the ExportProcessorVersion operation. + class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + + # Response message associated with the ExportProcessorVersion operation. + class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse + include Google::Apis::Core::Hashable + + # The Cloud Storage URI containing the output artifacts. + # Corresponds to the JSON property `gcsUri` + # @return [String] + attr_accessor :gcs_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri) + end + end + + # Metadata for how this field value is extracted. + class GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata + include Google::Apis::Core::Hashable + + # Message for entity query. + # Corresponds to the JSON property `entityQuery` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery] + attr_accessor :entity_query + + # Metadata for document summarization. + # Corresponds to the JSON property `summaryOptions` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SummaryOptions] + attr_accessor :summary_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_query = args[:entity_query] if args.key?(:entity_query) + @summary_options = args[:summary_options] if args.key?(:summary_options) + end + end + + # Message for entity query. + class GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery + include Google::Apis::Core::Hashable + + # The original entity query inputed by the user. + # Corresponds to the JSON property `userEntityQuery` + # @return [String] + attr_accessor :user_entity_query + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @user_entity_query = args[:user_entity_query] if args.key?(:user_entity_query) + end + end + + # Metadata for the field tier of a property. + class GoogleCloudDocumentaiUiv1beta3FieldTierMetadata + include Google::Apis::Core::Hashable + + # Integer that indicates the tier of a property. e.g. Invoice has entities that + # are classified as tier 1 which is the most important, while tier 2 and tier 3 + # less so. This attribute can be used to filter schema attributes before running + # eval. e.g. compute F1 score for only tier 1 entities. If not present this + # attribute should be inferred as 1. + # Corresponds to the JSON property `tierLevel` + # @return [Fixnum] + attr_accessor :tier_level + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tier_level = args[:tier_level] if args.key?(:tier_level) + end + end + + # Metadata for human review labeling config. + class GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata + include Google::Apis::Core::Hashable + + # Whether to enable normalization editing. + # Corresponds to the JSON property `enableNormalizationEditing` + # @return [Boolean] + attr_accessor :enable_normalization_editing + alias_method :enable_normalization_editing?, :enable_normalization_editing + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enable_normalization_editing = args[:enable_normalization_editing] if args.key?(:enable_normalization_editing) + end + end + + # Metadata for Human Review config. + class GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata + include Google::Apis::Core::Hashable + + # The confidence threshold if human review validation is enabled. + # Corresponds to the JSON property `confidenceThreshold` + # @return [Float] + attr_accessor :confidence_threshold + + # Whether to enable human review validation. + # Corresponds to the JSON property `enableValidation` + # @return [Boolean] + attr_accessor :enable_validation + alias_method :enable_validation?, :enable_validation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold) + @enable_validation = args[:enable_validation] if args.key?(:enable_validation) + end + end + + # Metadata of the import document operation. + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + # Validation statuses of the batch documents import config. + # Corresponds to the JSON property `importConfigValidationResults` + # @return [Array] + attr_accessor :import_config_validation_results + + # The list of response details of each document. + # Corresponds to the JSON property `individualImportStatuses` + # @return [Array] + attr_accessor :individual_import_statuses + + # Total number of the documents that are qualified for importing. + # Corresponds to the JSON property `totalDocumentCount` + # @return [Fixnum] + attr_accessor :total_document_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + @import_config_validation_results = args[:import_config_validation_results] if args.key?(:import_config_validation_results) + @individual_import_statuses = args[:individual_import_statuses] if args.key?(:individual_import_statuses) + @total_document_count = args[:total_document_count] if args.key?(:total_document_count) + end + end + + # The validation status of each import config. Status is set to an error if + # there are no documents to import in the `import_config`, or `OK` if the + # operation will try to proceed with at least one document. + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + include Google::Apis::Core::Hashable + + # The source Cloud Storage URI specified in the import config. + # Corresponds to the JSON property `inputGcsSource` + # @return [String] + attr_accessor :input_gcs_source + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `status` + # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source) + @status = args[:status] if args.key?(:status) + end + end + + # The status of each individual document in the import process. + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + include Google::Apis::Core::Hashable + + # The source Cloud Storage URI of the document. + # Corresponds to the JSON property `inputGcsSource` + # @return [String] + attr_accessor :input_gcs_source + + # Document Identifier. + # Corresponds to the JSON property `outputDocumentId` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId] + attr_accessor :output_document_id + + # The output_gcs_destination of the processed document if it was successful, + # otherwise empty. + # Corresponds to the JSON property `outputGcsDestination` + # @return [String] + attr_accessor :output_gcs_destination + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `status` + # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source) + @output_document_id = args[:output_document_id] if args.key?(:output_document_id) + @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination) + @status = args[:status] if args.key?(:status) + end + end + + # Response of the import document operation. + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The long-running operation metadata for the ImportProcessorVersion method. + class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + + # The response message for the ImportProcessorVersion method. + class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse + include Google::Apis::Core::Hashable + + # The destination processor version name. + # Corresponds to the JSON property `processorVersion` + # @return [String] + attr_accessor :processor_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @processor_version = args[:processor_version] if args.key?(:processor_version) + end + end + + # The first-class citizen for Document AI. Each processor defines how to extract + # structural information from a document. + class GoogleCloudDocumentaiUiv1beta3Processor + include Google::Apis::Core::Hashable + + # Optional. SchemaVersion used by the Processor. It is the same as Processor's + # DatasetSchema.schema_version Format is `projects/`project`/locations/`location` + # /schemas/`schema`/schemaVersions/`schema_version` + # Corresponds to the JSON property `activeSchemaVersion` + # @return [String] + attr_accessor :active_schema_version + + # Output only. The time the processor was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # The default processor version. + # Corresponds to the JSON property `defaultProcessorVersion` + # @return [String] + attr_accessor :default_processor_version + + # The display name of the processor. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The [KMS key](https://cloud.google.com/security-key-management) used for + # encryption and decryption in CMEK scenarios. + # Corresponds to the JSON property `kmsKeyName` + # @return [String] + attr_accessor :kms_key_name + + # Output only. Immutable. The resource name of the processor. Format: `projects/` + # project`/locations/`location`/processors/`processor`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Immutable. The http endpoint that can be called to invoke + # processing. + # Corresponds to the JSON property `processEndpoint` + # @return [String] + attr_accessor :process_endpoint + + # Output only. The processor version aliases. + # Corresponds to the JSON property `processorVersionAliases` + # @return [Array] + attr_accessor :processor_version_aliases + + # Output only. Reserved for future use. + # Corresponds to the JSON property `satisfiesPzi` + # @return [Boolean] + attr_accessor :satisfies_pzi + alias_method :satisfies_pzi?, :satisfies_pzi + + # Output only. Reserved for future use. + # Corresponds to the JSON property `satisfiesPzs` + # @return [Boolean] + attr_accessor :satisfies_pzs + alias_method :satisfies_pzs?, :satisfies_pzs + + # Output only. The state of the processor. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a + # list of processor types, see FetchProcessorTypes. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active_schema_version = args[:active_schema_version] if args.key?(:active_schema_version) + @create_time = args[:create_time] if args.key?(:create_time) + @default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version) + @display_name = args[:display_name] if args.key?(:display_name) + @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) + @name = args[:name] if args.key?(:name) + @process_endpoint = args[:process_endpoint] if args.key?(:process_endpoint) + @processor_version_aliases = args[:processor_version_aliases] if args.key?(:processor_version_aliases) + @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi) + @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) + @state = args[:state] if args.key?(:state) + @type = args[:type] if args.key?(:type) + end + end + + # A processor version is an implementation of a processor. Each processor can + # have multiple versions, pretrained by Google internally or uptrained by the + # customer. A processor can only have one default version at a time. Its + # document-processing behavior is defined by that version. + class GoogleCloudDocumentaiUiv1beta3ProcessorVersion + include Google::Apis::Core::Hashable + + # Output only. The time the processor version was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Output only. Denotes that this `ProcessorVersion` can be deployed and + # undeployed. + # Corresponds to the JSON property `deploymentAllowed` + # @return [Boolean] + attr_accessor :deployment_allowed + alias_method :deployment_allowed?, :deployment_allowed + + # Information about the upcoming deprecation of this processor version. + # Corresponds to the JSON property `deprecationInfo` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo] + attr_accessor :deprecation_info + + # The display name of the processor version. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The schema defines the output of the processed document by a processor. + # Corresponds to the JSON property `documentSchema` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchema] + attr_accessor :document_schema + + # Information about Generative AI model-based processor versions. + # Corresponds to the JSON property `genAiModelInfo` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo] + attr_accessor :gen_ai_model_info + + # Output only. Denotes that this `ProcessorVersion` is managed by Google. + # Corresponds to the JSON property `googleManaged` + # @return [Boolean] + attr_accessor :google_managed + alias_method :google_managed?, :google_managed + + # Output only. The KMS key name used for encryption. + # Corresponds to the JSON property `kmsKeyName` + # @return [String] + attr_accessor :kms_key_name + + # Output only. The KMS key version with which data is encrypted. + # Corresponds to the JSON property `kmsKeyVersionName` + # @return [String] + attr_accessor :kms_key_version_name + + # Gives a short summary of an evaluation, and links to the evaluation itself. + # Corresponds to the JSON property `latestEvaluation` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationReference] + attr_accessor :latest_evaluation + + # Output only. The model type of this processor version. + # Corresponds to the JSON property `modelType` + # @return [String] + attr_accessor :model_type + + # Identifier. The resource name of the processor version. Format: `projects/` + # project`/locations/`location`/processors/`processor`/processorVersions/` + # processor_version`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Reserved for future use. + # Corresponds to the JSON property `satisfiesPzi` + # @return [Boolean] + attr_accessor :satisfies_pzi + alias_method :satisfies_pzi?, :satisfies_pzi + + # Output only. Reserved for future use. + # Corresponds to the JSON property `satisfiesPzs` + # @return [Boolean] + attr_accessor :satisfies_pzs + alias_method :satisfies_pzs?, :satisfies_pzs + + # The schema defines the output of the processed document by a processor. + # Corresponds to the JSON property `schema` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Schema] + attr_accessor :schema + + # Output only. The state of the processor version. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @deployment_allowed = args[:deployment_allowed] if args.key?(:deployment_allowed) + @deprecation_info = args[:deprecation_info] if args.key?(:deprecation_info) + @display_name = args[:display_name] if args.key?(:display_name) + @document_schema = args[:document_schema] if args.key?(:document_schema) + @gen_ai_model_info = args[:gen_ai_model_info] if args.key?(:gen_ai_model_info) + @google_managed = args[:google_managed] if args.key?(:google_managed) + @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) + @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name) + @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation) + @model_type = args[:model_type] if args.key?(:model_type) + @name = args[:name] if args.key?(:name) + @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi) + @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) + @schema = args[:schema] if args.key?(:schema) + @state = args[:state] if args.key?(:state) + end + end + + # Contains the alias and the aliased resource name of processor version. + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias + include Google::Apis::Core::Hashable + + # The alias in the form of `processor_version` resource name. + # Corresponds to the JSON property `alias` + # @return [String] + attr_accessor :alias + + # The resource name of aliased processor version. + # Corresponds to the JSON property `processorVersion` + # @return [String] + attr_accessor :processor_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alias = args[:alias] if args.key?(:alias) + @processor_version = args[:processor_version] if args.key?(:processor_version) + end + end + + # Information about the upcoming deprecation of this processor version. + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo + include Google::Apis::Core::Hashable + + # The time at which this processor version will be deprecated. + # Corresponds to the JSON property `deprecationTime` + # @return [String] + attr_accessor :deprecation_time + + # If set, the processor version that will be used as a replacement. + # Corresponds to the JSON property `replacementProcessorVersion` + # @return [String] + attr_accessor :replacement_processor_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @deprecation_time = args[:deprecation_time] if args.key?(:deprecation_time) + @replacement_processor_version = args[:replacement_processor_version] if args.key?(:replacement_processor_version) end end - # The status of each individual document in the import process. - class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + # Information about Generative AI model-based processor versions. + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo include Google::Apis::Core::Hashable - # The source Cloud Storage URI of the document. - # Corresponds to the JSON property `inputGcsSource` - # @return [String] - attr_accessor :input_gcs_source - - # Document Identifier. - # Corresponds to the JSON property `outputDocumentId` - # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId] - attr_accessor :output_document_id - - # The output_gcs_destination of the processed document if it was successful, - # otherwise empty. - # Corresponds to the JSON property `outputGcsDestination` - # @return [String] - attr_accessor :output_gcs_destination + # Information for a custom Generative AI model created by the user. These are + # created with `Create New Version` in either the `Call foundation model` or ` + # Fine tuning` tabs. + # Corresponds to the JSON property `customGenAiModelInfo` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo] + attr_accessor :custom_gen_ai_model_info - # The `Status` type defines a logical error model that is suitable for different - # programming environments, including REST APIs and RPC APIs. It is used by [ - # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of - # data: error code, error message, and error details. You can find out more - # about this error model and how to work with it in the [API Design Guide](https: - # //cloud.google.com/apis/design/errors). - # Corresponds to the JSON property `status` - # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus] - attr_accessor :status + # Information for a pretrained Google-managed foundation model. + # Corresponds to the JSON property `foundationGenAiModelInfo` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo] + attr_accessor :foundation_gen_ai_model_info def initialize(**args) update!(**args) @@ -1242,34 +2091,53 @@ def initialize(**args) # Update properties of this object def update!(**args) - @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source) - @output_document_id = args[:output_document_id] if args.key?(:output_document_id) - @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination) - @status = args[:status] if args.key?(:status) + @custom_gen_ai_model_info = args[:custom_gen_ai_model_info] if args.key?(:custom_gen_ai_model_info) + @foundation_gen_ai_model_info = args[:foundation_gen_ai_model_info] if args.key?(:foundation_gen_ai_model_info) end end - # Response of the import document operation. - class GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse + # Information for a custom Generative AI model created by the user. These are + # created with `Create New Version` in either the `Call foundation model` or ` + # Fine tuning` tabs. + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo include Google::Apis::Core::Hashable + # The base processor version ID for the custom model. + # Corresponds to the JSON property `baseProcessorVersionId` + # @return [String] + attr_accessor :base_processor_version_id + + # The type of custom model created by the user. + # Corresponds to the JSON property `customModelType` + # @return [String] + attr_accessor :custom_model_type + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @base_processor_version_id = args[:base_processor_version_id] if args.key?(:base_processor_version_id) + @custom_model_type = args[:custom_model_type] if args.key?(:custom_model_type) end end - # The long-running operation metadata for the ImportProcessorVersion method. - class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + # Information for a pretrained Google-managed foundation model. + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo include Google::Apis::Core::Hashable - # The common metadata for long running operations. - # Corresponds to the JSON property `commonMetadata` - # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] - attr_accessor :common_metadata + # Whether finetuning is allowed for this base processor version. + # Corresponds to the JSON property `finetuningAllowed` + # @return [Boolean] + attr_accessor :finetuning_allowed + alias_method :finetuning_allowed?, :finetuning_allowed + + # The minimum number of labeled documents in the training dataset required for + # finetuning. + # Corresponds to the JSON property `minTrainLabeledDocuments` + # @return [Fixnum] + attr_accessor :min_train_labeled_documents def initialize(**args) update!(**args) @@ -1277,18 +2145,52 @@ def initialize(**args) # Update properties of this object def update!(**args) - @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + @finetuning_allowed = args[:finetuning_allowed] if args.key?(:finetuning_allowed) + @min_train_labeled_documents = args[:min_train_labeled_documents] if args.key?(:min_train_labeled_documents) end end - # The response message for the ImportProcessorVersion method. - class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse + # Metadata about a property. + class GoogleCloudDocumentaiUiv1beta3PropertyMetadata include Google::Apis::Core::Hashable - # The destination processor version name. - # Corresponds to the JSON property `processorVersion` - # @return [String] - attr_accessor :processor_version + # Metadata for how this field value is extracted. + # Corresponds to the JSON property `fieldExtractionMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata] + attr_accessor :field_extraction_metadata + + # Metadata for the field tier of a property. + # Corresponds to the JSON property `fieldTierMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldTierMetadata] + attr_accessor :field_tier_metadata + + # Metadata for human review labeling config. + # Corresponds to the JSON property `humanReviewLabelingMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata] + attr_accessor :human_review_labeling_metadata + + # Metadata for Human Review config. + # Corresponds to the JSON property `humanReviewMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata] + attr_accessor :human_review_metadata + + # Whether the property should be considered as "inactive". + # Corresponds to the JSON property `inactive` + # @return [Boolean] + attr_accessor :inactive + alias_method :inactive?, :inactive + + # Metadata that specifies whether a label is editable and reasons why. These + # fields are read-only. Changing these fields has no impact on the backend. + # Corresponds to the JSON property `schemaEditabilityMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata] + attr_accessor :schema_editability_metadata + + # Metadata for schema inference. Only used on dataset.schema for schema + # inference, can be safely ignored elsewhere. + # Corresponds to the JSON property `schemaInferenceMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata] + attr_accessor :schema_inference_metadata def initialize(**args) update!(**args) @@ -1296,7 +2198,13 @@ def initialize(**args) # Update properties of this object def update!(**args) - @processor_version = args[:processor_version] if args.key?(:processor_version) + @field_extraction_metadata = args[:field_extraction_metadata] if args.key?(:field_extraction_metadata) + @field_tier_metadata = args[:field_tier_metadata] if args.key?(:field_tier_metadata) + @human_review_labeling_metadata = args[:human_review_labeling_metadata] if args.key?(:human_review_labeling_metadata) + @human_review_metadata = args[:human_review_metadata] if args.key?(:human_review_metadata) + @inactive = args[:inactive] if args.key?(:inactive) + @schema_editability_metadata = args[:schema_editability_metadata] if args.key?(:schema_editability_metadata) + @schema_inference_metadata = args[:schema_inference_metadata] if args.key?(:schema_inference_metadata) end end @@ -1524,6 +2432,175 @@ def update!(**args) end end + # The schema defines the output of the processed document by a processor. + class GoogleCloudDocumentaiUiv1beta3Schema + include Google::Apis::Core::Hashable + + # Description of the schema. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Display name to show to users. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Entity types of the schema. + # Corresponds to the JSON property `entityTypes` + # @return [Array] + attr_accessor :entity_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_types = args[:entity_types] if args.key?(:entity_types) + end + end + + # Metadata that specifies whether a label is editable and reasons why. These + # fields are read-only. Changing these fields has no impact on the backend. + class GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata + include Google::Apis::Core::Hashable + + # Explicit flag that controls whether the label is editable. + # Corresponds to the JSON property `editable` + # @return [Boolean] + attr_accessor :editable + alias_method :editable?, :editable + + # Full resource name of processor versions that contain this label. e.g. ` + # projects/`project`/locations/`location`/processors/`processor`/ + # processorVersions/`processorVersion`` + # Corresponds to the JSON property `processorVersions` + # @return [Array] + attr_accessor :processor_versions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @editable = args[:editable] if args.key?(:editable) + @processor_versions = args[:processor_versions] if args.key?(:processor_versions) + end + end + + # EntityType is the wrapper of a label of the corresponding model with detailed + # attributes and limitations for entity-based processors. Multiple types can + # also compose a dependency tree to represent nested types. + class GoogleCloudDocumentaiUiv1beta3SchemaEntityType + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `baseType` + # @return [String] + attr_accessor :base_type + + # Description of the entity type. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # If specified, lists all the possible values for this entity. + # Corresponds to the JSON property `enumValues` + # @return [Array] + attr_accessor :enum_values + + # If the entity type is hidden in the schema. This provides the functionality to + # temporally "disable" an entity without deleting it. + # Corresponds to the JSON property `hide` + # @return [Boolean] + attr_accessor :hide + alias_method :hide?, :hide + + # Specifies how the entity's value is obtained. + # Corresponds to the JSON property `method` + # @return [String] + attr_accessor :method_prop + + # Occurrence type limits the number of times an entity type appears in the + # document. + # Corresponds to the JSON property `occurrenceType` + # @return [String] + attr_accessor :occurrence_type + + # Describing the nested structure of an entity. An EntityType may consist of + # several other EntityTypes. For example, in a document there can be an + # EntityType `ID`, which consists of EntityType `name` and `address`, with + # corresponding attributes, such as TEXT for both types and ONCE for occurrence + # types. + # Corresponds to the JSON property `properties` + # @return [Array] + attr_accessor :properties + + # Source of this entity type. + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + # Name of the type. It must satisfy the following constraints: 1. Must be unique + # within the set of same level types (with case-insensitive match). 2. Maximum + # 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII + # letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation + # characters: * underscore '_' (recommended) * hyphen '-' (allowed, not + # recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace + # characters are not allowed. 5. Cannot end with a punctuation character. 6. + # Cannot contain the following restricted strings: "google", "DocumentAI" (case- + # insensitive match). 7. A slash character '/' is reserved as a separator in + # flattened representations of nested entity types (e.g., "line_item/amount") in + # which case each part (e.g., "line_item", "amount") must comply with the rules + # defined above. We recommend using the snake case ("snake_case") in entity type + # names. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @base_type = args[:base_type] if args.key?(:base_type) + @description = args[:description] if args.key?(:description) + @enum_values = args[:enum_values] if args.key?(:enum_values) + @hide = args[:hide] if args.key?(:hide) + @method_prop = args[:method_prop] if args.key?(:method_prop) + @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type) + @properties = args[:properties] if args.key?(:properties) + @source = args[:source] if args.key?(:source) + @type = args[:type] if args.key?(:type) + end + end + + # Metadata for schema inference. Only used on dataset.schema for schema + # inference, can be safely ignored elsewhere. + class GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata + include Google::Apis::Core::Hashable + + # True if is inferred by schema inference. + # Corresponds to the JSON property `inferred` + # @return [Boolean] + attr_accessor :inferred + alias_method :inferred?, :inferred + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @inferred = args[:inferred] if args.key?(:inferred) + end + end + # The long-running operation metadata for the SetDefaultProcessorVersion method. class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata include Google::Apis::Core::Hashable @@ -1556,6 +2633,31 @@ def update!(**args) end end + # Metadata for document summarization. + class GoogleCloudDocumentaiUiv1beta3SummaryOptions + include Google::Apis::Core::Hashable + + # The format the summary should be in. + # Corresponds to the JSON property `format` + # @return [String] + attr_accessor :format + + # How long the summary should be. + # Corresponds to the JSON property `length` + # @return [String] + attr_accessor :length + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @format = args[:format] if args.key?(:format) + @length = args[:length] if args.key?(:length) + end + end + # The metadata that represents a processor version being created. class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata include Google::Apis::Core::Hashable @@ -1681,8 +2783,28 @@ def update!(**args) end end - # - class GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata + # + class GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + + # The long-running operation metadata for updating the human review + # configuration. + class GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata include Google::Apis::Core::Hashable # The common metadata for long running operations. @@ -1700,9 +2822,8 @@ def update!(**args) end end - # The long-running operation metadata for updating the human review - # configuration. - class GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + # The long-running operation metadata for UpdateLabelerPool. + class GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata include Google::Apis::Core::Hashable # The common metadata for long running operations. @@ -1720,8 +2841,8 @@ def update!(**args) end end - # The long-running operation metadata for UpdateLabelerPool. - class GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata + # The long-running operation metadata for the UpdateProcessorVersion method. + class GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata include Google::Apis::Core::Hashable # The common metadata for long running operations. @@ -4174,12 +5295,18 @@ def update!(**args) class GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult include Google::Apis::Core::Hashable + # Optional. The name of the rule resource that is used for validation. Format: ` + # projects/`project`/locations/`location`/rules/`rule`` + # Corresponds to the JSON property `rule` + # @return [String] + attr_accessor :rule + # The description of the validation rule. # Corresponds to the JSON property `ruleDescription` # @return [String] attr_accessor :rule_description - # The name of the validation rule. + # The display name of the validation rule. # Corresponds to the JSON property `ruleName` # @return [String] attr_accessor :rule_name @@ -4201,6 +5328,7 @@ def initialize(**args) # Update properties of this object def update!(**args) + @rule = args[:rule] if args.key?(:rule) @rule_description = args[:rule_description] if args.key?(:rule_description) @rule_name = args[:rule_name] if args.key?(:rule_name) @validation_details = args[:validation_details] if args.key?(:validation_details) @@ -6119,6 +7247,25 @@ def update!(**args) end end + # A set of inline documents. + class GoogleCloudDocumentaiV1beta3Documents + include Google::Apis::Core::Hashable + + # The list of documents. + # Corresponds to the JSON property `documents` + # @return [Array] + attr_accessor :documents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @documents = args[:documents] if args.key?(:documents) + end + end + # The long-running operation metadata for the EnableProcessor method. class GoogleCloudDocumentaiV1beta3EnableProcessorMetadata include Google::Apis::Core::Hashable @@ -6638,6 +7785,101 @@ def update!(**args) end end + # Request message for GenerateSchemaVersion. + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest + include Google::Apis::Core::Hashable + + # The base schema version name to use for the schema generation. Format: ` + # projects/`project`/locations/`location`/schemas/`schema`/schemaVersions/` + # schema_version`` + # Corresponds to the JSON property `baseSchemaVersion` + # @return [String] + attr_accessor :base_schema_version + + # Specifies a set of documents on Cloud Storage. + # Corresponds to the JSON property `gcsDocuments` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocuments] + attr_accessor :gcs_documents + + # Specifies all documents on Cloud Storage with a common prefix. + # Corresponds to the JSON property `gcsPrefix` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsPrefix] + attr_accessor :gcs_prefix + + # The parameters for the schema generation. + # Corresponds to the JSON property `generateSchemaVersionParams` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams] + attr_accessor :generate_schema_version_params + + # A set of inline documents. + # Corresponds to the JSON property `inlineDocuments` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Documents] + attr_accessor :inline_documents + + # Specifies a set of raw documents. + # Corresponds to the JSON property `rawDocuments` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocuments] + attr_accessor :raw_documents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @base_schema_version = args[:base_schema_version] if args.key?(:base_schema_version) + @gcs_documents = args[:gcs_documents] if args.key?(:gcs_documents) + @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix) + @generate_schema_version_params = args[:generate_schema_version_params] if args.key?(:generate_schema_version_params) + @inline_documents = args[:inline_documents] if args.key?(:inline_documents) + @raw_documents = args[:raw_documents] if args.key?(:raw_documents) + end + end + + # The parameters for the schema generation. + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams + include Google::Apis::Core::Hashable + + # The history of schema generation iterations. + # Corresponds to the JSON property `history` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaGenerationHistory] + attr_accessor :history + + # Optional. The prompt used for the schema generation. + # Corresponds to the JSON property `prompt` + # @return [String] + attr_accessor :prompt + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @history = args[:history] if args.key?(:history) + @prompt = args[:prompt] if args.key?(:prompt) + end + end + + # Response message for GenerateSchemaVersion. + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse + include Google::Apis::Core::Hashable + + # SchemaVersion is a version of the Schema which is created in SchemaGroup. + # Corresponds to the JSON property `schemaVersion` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] + attr_accessor :schema_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @schema_version = args[:schema_version] if args.key?(:schema_version) + end + end + # class GoogleCloudDocumentaiV1beta3GetDocumentResponse include Google::Apis::Core::Hashable @@ -7175,6 +8417,100 @@ def update!(**args) end end + # Response message for ListSchemaVersions. + class GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse + include Google::Apis::Core::Hashable + + # Points to the next SchemaVersion, otherwise empty. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of SchemaVersions. + # Corresponds to the JSON property `schemaVersions` + # @return [Array] + attr_accessor :schema_versions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @schema_versions = args[:schema_versions] if args.key?(:schema_versions) + end + end + + # Response message for ListSchemas. + class GoogleCloudDocumentaiV1beta3ListSchemasResponse + include Google::Apis::Core::Hashable + + # Points to the next Schema, otherwise empty. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of Schemas. + # Corresponds to the JSON property `schemas` + # @return [Array] + attr_accessor :schemas + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @schemas = args[:schemas] if args.key?(:schemas) + end + end + + # NextSchema is a collection of SchemaVersions. + class GoogleCloudDocumentaiV1beta3NextSchema + include Google::Apis::Core::Hashable + + # Output only. The time when the Schema was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Optional. The user-defined name of the Schema. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. The GCP labels for the Schema. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Identifier. The resource name of the Schema. Format: `projects/`project`/ + # locations/`location`/schemas/`schema`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The time when the Schema was last updated. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + # A vertex represents a 2D point in the image. NOTE: the normalized vertex # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudDocumentaiV1beta3NormalizedVertex @@ -7630,6 +8966,13 @@ def update!(**args) class GoogleCloudDocumentaiV1beta3Processor include Google::Apis::Core::Hashable + # Optional. SchemaVersion used by the Processor. It is the same as Processor's + # DatasetSchema.schema_version Format is `projects/`project`/locations/`location` + # /schemas/`schema`/schemaVersions/`schema_version` + # Corresponds to the JSON property `activeSchemaVersion` + # @return [String] + attr_accessor :active_schema_version + # Output only. The time the processor was created. # Corresponds to the JSON property `createTime` # @return [String] @@ -7697,6 +9040,7 @@ def initialize(**args) # Update properties of this object def update!(**args) + @active_schema_version = args[:active_schema_version] if args.key?(:active_schema_version) @create_time = args[:create_time] if args.key?(:create_time) @default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version) @display_name = args[:display_name] if args.key?(:display_name) @@ -8086,6 +9430,25 @@ def update!(**args) end end + # Specifies a set of raw documents. + class GoogleCloudDocumentaiV1beta3RawDocuments + include Google::Apis::Core::Hashable + + # Specifies raw document content and mime type. + # Corresponds to the JSON property `documents` + # @return [Array] + attr_accessor :documents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @documents = args[:documents] if args.key?(:documents) + end + end + # The long-running operation metadata for the ReviewDocument method. class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata include Google::Apis::Core::Hashable @@ -8251,6 +9614,100 @@ def update!(**args) end end + # The history of schema generation iterations. + class GoogleCloudDocumentaiV1beta3SchemaGenerationHistory + include Google::Apis::Core::Hashable + + # Required. Previous prompt-answers in a chronological order. + # Corresponds to the JSON property `iterations` + # @return [Array] + attr_accessor :iterations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @iterations = args[:iterations] if args.key?(:iterations) + end + end + + # A single iteration of the schema generation. + class GoogleCloudDocumentaiV1beta3SchemaGenerationIteration + include Google::Apis::Core::Hashable + + # SchemaVersion is a version of the Schema which is created in SchemaGroup. + # Corresponds to the JSON property `adjustedSchema` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] + attr_accessor :adjusted_schema + + # SchemaVersion is a version of the Schema which is created in SchemaGroup. + # Corresponds to the JSON property `generatedSchema` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] + attr_accessor :generated_schema + + # Optional. The prompt used for the iteration. + # Corresponds to the JSON property `prompt` + # @return [String] + attr_accessor :prompt + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @adjusted_schema = args[:adjusted_schema] if args.key?(:adjusted_schema) + @generated_schema = args[:generated_schema] if args.key?(:generated_schema) + @prompt = args[:prompt] if args.key?(:prompt) + end + end + + # SchemaVersion is a version of the Schema which is created in SchemaGroup. + class GoogleCloudDocumentaiV1beta3SchemaVersion + include Google::Apis::Core::Hashable + + # Output only. The time when the SchemaVersion was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Optional. The user-defined name of the SchemaVersion. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. The GCP labels for the SchemaVersion. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Identifier. The resource name of the SchemaVersion. Format: `projects/`project` + # /locations/`location`/schemas/`schema`/schemaVersions/`schema_version`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The schema defines the output of the processed document by a processor. + # Corresponds to the JSON property `schema` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema] + attr_accessor :schema + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @schema = args[:schema] if args.key?(:schema) + end + end + # The long-running operation metadata for the SetDefaultProcessorVersion method. class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata include Google::Apis::Core::Hashable @@ -8614,6 +10071,25 @@ def update!(**args) end end + # The long-running operation metadata for the UpdateProcessorVersion method. + class GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are # in the same scale as the original image. class GoogleCloudDocumentaiV1beta3Vertex diff --git a/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/gem_version.rb b/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/gem_version.rb index c1ea1c40ac5..0d69a33f27a 100644 --- a/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/gem_version.rb +++ b/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/gem_version.rb @@ -16,13 +16,13 @@ module Google module Apis module DocumentaiV1beta3 # Version of the google-apis-documentai_v1beta3 gem - GEM_VERSION = "0.115.0" + GEM_VERSION = "0.116.0" # Version of the code generator used to generate this client GENERATOR_VERSION = "0.18.0" # Revision of the discovery document this client was generated from - REVISION = "20251013" + REVISION = "20251020" end end end diff --git a/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/representations.rb b/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/representations.rb index 86176456857..b6cfbf29232 100644 --- a/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/representations.rb +++ b/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/representations.rb @@ -232,6 +232,36 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3DocumentSchema + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -244,6 +274,12 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -256,6 +292,18 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3EvaluationMetrics + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3EvaluationReference + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -292,6 +340,36 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3FieldTierMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -328,6 +406,54 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3Processor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3ProcessorVersion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3PropertyMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -376,6 +502,30 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3Schema + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3SchemaEntityType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -388,6 +538,12 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3SummaryOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -436,6 +592,12 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1BatchProcessMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1192,6 +1354,12 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta3Documents + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta3EnableProcessorMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1300,6 +1468,24 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta3GetDocumentResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1414,6 +1600,24 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta3ListSchemasResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta3NextSchema + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta3NormalizedVertex class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1540,6 +1744,12 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta3RawDocuments + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1564,6 +1774,24 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta3SchemaGenerationHistory + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta3SchemaGenerationIteration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta3SchemaVersion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1654,6 +1882,12 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta3Vertex class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2007,13 +2241,225 @@ class Representation < Google::Apis::Core::JsonRepresentation end end - class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudDocumentaiUiv1beta3DocumentId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_managed_doc_id, as: 'gcsManagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId::Representation + + property :revision_ref, as: 'revisionRef', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3RevisionRef, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3RevisionRef::Representation + + property :unmanaged_doc_id, as: 'unmanagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cw_doc_id, as: 'cwDocId' + property :gcs_uri, as: 'gcsUri' + end + end + + class GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :doc_id, as: 'docId' + end + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchema + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :entity_types, as: 'entityTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType::Representation + + property :metadata, as: 'metadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :base_types, as: 'baseTypes' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :entity_type_metadata, as: 'entityTypeMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata::Representation + + property :enum_values, as: 'enumValues', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues::Representation + + property :name, as: 'name' + collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values' + end + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :method_prop, as: 'method' + property :name, as: 'name' + property :occurrence_type, as: 'occurrenceType' + property :property_metadata, as: 'propertyMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3PropertyMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3PropertyMetadata::Representation + + property :value_type, as: 'valueType' + end + end + + class GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :document_allow_multiple_labels, as: 'documentAllowMultipleLabels' + property :document_splitter, as: 'documentSplitter' + property :prefixed_naming_on_properties, as: 'prefixedNamingOnProperties' + property :skip_naming_validation, as: 'skipNamingValidation' + end + end + + class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :field_tier_metadata, as: 'fieldTierMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldTierMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldTierMetadata::Representation + + property :human_review_labeling_metadata, as: 'humanReviewLabelingMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata::Representation + + property :human_review_metadata, as: 'humanReviewMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata::Representation + + property :inactive, as: 'inactive' + property :schema_editability_metadata, as: 'schemaEditabilityMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata::Representation + + property :schema_inference_metadata, as: 'schemaInferenceMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :evaluation, as: 'evaluation' + end + end + + class GoogleCloudDocumentaiUiv1beta3EvaluationMetrics + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :f1_score, as: 'f1Score' + property :false_negatives_count, as: 'falseNegativesCount' + property :false_positives_count, as: 'falsePositivesCount' + property :ground_truth_document_count, as: 'groundTruthDocumentCount' + property :ground_truth_occurrences_count, as: 'groundTruthOccurrencesCount' + property :precision, as: 'precision' + property :predicted_document_count, as: 'predictedDocumentCount' + property :predicted_occurrences_count, as: 'predictedOccurrencesCount' + property :recall, as: 'recall' + property :total_documents_count, as: 'totalDocumentsCount' + property :true_positives_count, as: 'truePositivesCount' + end + end + + class GoogleCloudDocumentaiUiv1beta3EvaluationReference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :aggregate_metrics, as: 'aggregateMetrics', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics::Representation + + property :aggregate_metrics_exact, as: 'aggregateMetricsExact', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics::Representation + + property :evaluation, as: 'evaluation' + property :operation, as: 'operation' + end + end + + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + collection :individual_export_statuses, as: 'individualExportStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus::Representation + + collection :split_export_stats, as: 'splitExportStats', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :document_id, as: 'documentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId::Representation + + property :output_gcs_destination, as: 'outputGcsDestination' + property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :split_type, as: 'splitType' + property :total_document_count, as: 'totalDocumentCount' + end + end + + class GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation end end - class GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata + class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation @@ -2021,84 +2467,79 @@ class Representation < Google::Apis::Core::JsonRepresentation end end - class GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse + class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_uri, as: 'gcsUri' end end - class GoogleCloudDocumentaiUiv1beta3DocumentId + class GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation - property :gcs_managed_doc_id, as: 'gcsManagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId::Representation - - property :revision_ref, as: 'revisionRef', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3RevisionRef, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3RevisionRef::Representation + property :entity_query, as: 'entityQuery', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery::Representation - property :unmanaged_doc_id, as: 'unmanagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId::Representation + property :summary_options, as: 'summaryOptions', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SummaryOptions, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SummaryOptions::Representation end end - class GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId + class GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery # @private class Representation < Google::Apis::Core::JsonRepresentation - property :cw_doc_id, as: 'cwDocId' - property :gcs_uri, as: 'gcsUri' + property :user_entity_query, as: 'userEntityQuery' end end - class GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + class GoogleCloudDocumentaiUiv1beta3FieldTierMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation - property :doc_id, as: 'docId' + property :tier_level, as: 'tierLevel' end end - class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + class GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation - property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation - + property :enable_normalization_editing, as: 'enableNormalizationEditing' end end - class GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse + class GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation + property :confidence_threshold, as: 'confidenceThreshold' + property :enable_validation, as: 'enableValidation' end end - class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation - end - end + collection :import_config_validation_results, as: 'importConfigValidationResults', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult::Representation - class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :evaluation, as: 'evaluation' + collection :individual_import_statuses, as: 'individualImportStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus::Representation + + property :total_document_count, as: 'totalDocumentCount' end end - class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult # @private class Representation < Google::Apis::Core::JsonRepresentation - property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation - - collection :individual_export_statuses, as: 'individualExportStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus::Representation - - collection :split_export_stats, as: 'splitExportStats', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat::Representation + property :input_gcs_source, as: 'inputGcsSource' + property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation end end - class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus # @private class Representation < Google::Apis::Core::JsonRepresentation - property :document_id, as: 'documentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId::Representation + property :input_gcs_source, as: 'inputGcsSource' + property :output_document_id, as: 'outputDocumentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId::Representation property :output_gcs_destination, as: 'outputGcsDestination' property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation @@ -2106,87 +2547,131 @@ class Representation < Google::Apis::Core::JsonRepresentation end end - class GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + class GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :split_type, as: 'splitType' - property :total_document_count, as: 'totalDocumentCount' end end - class GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse + class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + end end - class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata + class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation - + property :processor_version, as: 'processorVersion' end end - class GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse + class GoogleCloudDocumentaiUiv1beta3Processor # @private class Representation < Google::Apis::Core::JsonRepresentation - property :gcs_uri, as: 'gcsUri' + property :active_schema_version, as: 'activeSchemaVersion' + property :create_time, as: 'createTime' + property :default_processor_version, as: 'defaultProcessorVersion' + property :display_name, as: 'displayName' + property :kms_key_name, as: 'kmsKeyName' + property :name, as: 'name' + property :process_endpoint, as: 'processEndpoint' + collection :processor_version_aliases, as: 'processorVersionAliases', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias::Representation + + property :satisfies_pzi, as: 'satisfiesPzi' + property :satisfies_pzs, as: 'satisfiesPzs' + property :state, as: 'state' + property :type, as: 'type' end end - class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + class GoogleCloudDocumentaiUiv1beta3ProcessorVersion # @private class Representation < Google::Apis::Core::JsonRepresentation - property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + property :create_time, as: 'createTime' + property :deployment_allowed, as: 'deploymentAllowed' + property :deprecation_info, as: 'deprecationInfo', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo::Representation - collection :import_config_validation_results, as: 'importConfigValidationResults', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult::Representation + property :display_name, as: 'displayName' + property :document_schema, as: 'documentSchema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentSchema::Representation - collection :individual_import_statuses, as: 'individualImportStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus::Representation + property :gen_ai_model_info, as: 'genAiModelInfo', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo::Representation - property :total_document_count, as: 'totalDocumentCount' + property :google_managed, as: 'googleManaged' + property :kms_key_name, as: 'kmsKeyName' + property :kms_key_version_name, as: 'kmsKeyVersionName' + property :latest_evaluation, as: 'latestEvaluation', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationReference, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationReference::Representation + + property :model_type, as: 'modelType' + property :name, as: 'name' + property :satisfies_pzi, as: 'satisfiesPzi' + property :satisfies_pzs, as: 'satisfiesPzs' + property :schema, as: 'schema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Schema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Schema::Representation + + property :state, as: 'state' end end - class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias # @private class Representation < Google::Apis::Core::JsonRepresentation - property :input_gcs_source, as: 'inputGcsSource' - property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation + property :alias, as: 'alias' + property :processor_version, as: 'processorVersion' + end + end + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :deprecation_time, as: 'deprecationTime' + property :replacement_processor_version, as: 'replacementProcessorVersion' end end - class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo # @private class Representation < Google::Apis::Core::JsonRepresentation - property :input_gcs_source, as: 'inputGcsSource' - property :output_document_id, as: 'outputDocumentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId::Representation + property :custom_gen_ai_model_info, as: 'customGenAiModelInfo', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo::Representation - property :output_gcs_destination, as: 'outputGcsDestination' - property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation + property :foundation_gen_ai_model_info, as: 'foundationGenAiModelInfo', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo::Representation end end - class GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo # @private class Representation < Google::Apis::Core::JsonRepresentation + property :base_processor_version_id, as: 'baseProcessorVersionId' + property :custom_model_type, as: 'customModelType' end end - class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + class GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo # @private class Representation < Google::Apis::Core::JsonRepresentation - property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation - + property :finetuning_allowed, as: 'finetuningAllowed' + property :min_train_labeled_documents, as: 'minTrainLabeledDocuments' end end - class GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse + class GoogleCloudDocumentaiUiv1beta3PropertyMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation - property :processor_version, as: 'processorVersion' + property :field_extraction_metadata, as: 'fieldExtractionMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata::Representation + + property :field_tier_metadata, as: 'fieldTierMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldTierMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3FieldTierMetadata::Representation + + property :human_review_labeling_metadata, as: 'humanReviewLabelingMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata::Representation + + property :human_review_metadata, as: 'humanReviewMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata::Representation + + property :inactive, as: 'inactive' + property :schema_editability_metadata, as: 'schemaEditabilityMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata::Representation + + property :schema_inference_metadata, as: 'schemaInferenceMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata::Representation + end end @@ -2264,6 +2749,47 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiUiv1beta3Schema + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :entity_types, as: 'entityTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEntityType::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :editable, as: 'editable' + collection :processor_versions, as: 'processorVersions' + end + end + + class GoogleCloudDocumentaiUiv1beta3SchemaEntityType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :base_type, as: 'baseType' + property :description, as: 'description' + collection :enum_values, as: 'enumValues' + property :hide, as: 'hide' + property :method_prop, as: 'method' + property :occurrence_type, as: 'occurrenceType' + collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEntityType::Representation + + property :source, as: 'source' + property :type, as: 'type' + end + end + + class GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :inferred, as: 'inferred' + end + end + class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2278,6 +2804,14 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiUiv1beta3SummaryOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :format, as: 'format' + property :length, as: 'length' + end + end + class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2347,6 +2881,14 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + class GoogleCloudDocumentaiV1BatchProcessMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3133,6 +3675,7 @@ class Representation < Google::Apis::Core::JsonRepresentation class GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult # @private class Representation < Google::Apis::Core::JsonRepresentation + property :rule, as: 'rule' property :rule_description, as: 'ruleDescription' property :rule_name, as: 'ruleName' property :validation_details, as: 'validationDetails' @@ -3662,6 +4205,14 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiV1beta3Documents + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :documents, as: 'documents', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation + + end + end + class GoogleCloudDocumentaiV1beta3EnableProcessorMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3830,6 +4381,40 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :base_schema_version, as: 'baseSchemaVersion' + property :gcs_documents, as: 'gcsDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocuments, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocuments::Representation + + property :gcs_prefix, as: 'gcsPrefix', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsPrefix, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsPrefix::Representation + + property :generate_schema_version_params, as: 'generateSchemaVersionParams', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams::Representation + + property :inline_documents, as: 'inlineDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Documents, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Documents::Representation + + property :raw_documents, as: 'rawDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocuments, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocuments::Representation + + end + end + + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :history, as: 'history', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaGenerationHistory, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaGenerationHistory::Representation + + property :prompt, as: 'prompt' + end + end + + class GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :schema_version, as: 'schemaVersion', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + + end + end + class GoogleCloudDocumentaiV1beta3GetDocumentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -4001,6 +4586,35 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :schema_versions, as: 'schemaVersions', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + + end + end + + class GoogleCloudDocumentaiV1beta3ListSchemasResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :schemas, as: 'schemas', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema::Representation + + end + end + + class GoogleCloudDocumentaiV1beta3NextSchema + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :name, as: 'name' + property :update_time, as: 'updateTime' + end + end + class GoogleCloudDocumentaiV1beta3NormalizedVertex # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -4122,6 +4736,7 @@ class Representation < Google::Apis::Core::JsonRepresentation class GoogleCloudDocumentaiV1beta3Processor # @private class Representation < Google::Apis::Core::JsonRepresentation + property :active_schema_version, as: 'activeSchemaVersion' property :create_time, as: 'createTime' property :default_processor_version, as: 'defaultProcessorVersion' property :display_name, as: 'displayName' @@ -4242,6 +4857,14 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiV1beta3RawDocuments + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :documents, as: 'documents', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument::Representation + + end + end + class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -4287,6 +4910,37 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiV1beta3SchemaGenerationHistory + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :iterations, as: 'iterations', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaGenerationIteration, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaGenerationIteration::Representation + + end + end + + class GoogleCloudDocumentaiV1beta3SchemaGenerationIteration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :adjusted_schema, as: 'adjustedSchema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + + property :generated_schema, as: 'generatedSchema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + + property :prompt, as: 'prompt' + end + end + + class GoogleCloudDocumentaiV1beta3SchemaVersion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :name, as: 'name' + property :schema, as: 'schema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchema::Representation + + end + end + class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -4417,6 +5071,14 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata::Representation + + end + end + class GoogleCloudDocumentaiV1beta3Vertex # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/service.rb b/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/service.rb index db91d0f4fc0..7c0c9c173b3 100644 --- a/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/service.rb +++ b/generated/google-apis-documentai_v1beta3/lib/google/apis/documentai_v1beta3/service.rb @@ -1387,6 +1387,393 @@ def list_project_location_processor_processor_version_evaluations(parent, page_s command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Creates a schema. + # @param [String] parent + # Required. The parent (project and location) under which to create the Schema. + # Format: `projects/`project`/locations/`location`` + # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema] google_cloud_documentai_v1beta3_next_schema_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_schema(parent, google_cloud_documentai_v1beta3_next_schema_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta3/{+parent}/schemas', options) + command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema::Representation + command.request_object = google_cloud_documentai_v1beta3_next_schema_object + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a schema. + # @param [String] name + # Required. The name of the Schema to be deleted. Format: `projects/`project`/ + # locations/`location`/schemas/`schema`` + # @param [Boolean] force + # Optional. If set to true, any child resources of this Schema will also be + # deleted. (Otherwise, the request will only work if the Schema has no child + # resources.) + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_schema(name, force: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta3/{+name}', options) + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['force'] = force unless force.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a schema. + # @param [String] name + # Required. The name of the Schema to get. Format: `projects/`project`/locations/ + # `location`/schemas/`schema`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_schema(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta3/{+name}', options) + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Schemas. + # @param [String] parent + # Required. Format: `projects/`project`/locations/`location`` + # @param [Fixnum] page_size + # Optional. The maximum number of schema groups to return. If unspecified, at + # most `10` Schema will be returned. The maximum value is `20`. Values above `20` + # will be coerced to `20`. + # @param [String] page_token + # Optional. We will return the schema groups sorted by creation time. The page + # token will point to the next Schema. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListSchemasResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListSchemasResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta3/{+parent}/schemas', options) + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListSchemasResponse::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListSchemasResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a schema. Editable fields are: - `display_name` - `labels` + # @param [String] name + # Identifier. The resource name of the Schema. Format: `projects/`project`/ + # locations/`location`/schemas/`schema`` + # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema] google_cloud_documentai_v1beta3_next_schema_object + # @param [String] update_mask + # Optional. The update mask to apply to the resource. **Note:** Only the + # following fields can be updated: - display_name. - labels. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_schema(name, google_cloud_documentai_v1beta3_next_schema_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta3/{+name}', options) + command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema::Representation + command.request_object = google_cloud_documentai_v1beta3_next_schema_object + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3NextSchema + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a schema version. + # @param [String] parent + # Required. The parent (project and location) under which to create the + # SchemaVersion. Format: `projects/`project`/locations/`location`/schemas/` + # schema`` + # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] google_cloud_documentai_v1beta3_schema_version_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_schema_schema_version(parent, google_cloud_documentai_v1beta3_schema_version_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta3/{+parent}/schemaVersions', options) + command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + command.request_object = google_cloud_documentai_v1beta3_schema_version_object + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a schema version. + # @param [String] name + # Required. The name of the SchemaVersion to delete. Format: `projects/`project`/ + # locations/`location`/schemas/`schema`/schemaVersions/`schema_version`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_schema_schema_version(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta3/{+name}', options) + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Generates a schema version. + # @param [String] parent + # Required. The parent (project, location and schema) under which to generate + # the SchemaVersion. Format: `projects/`project`/locations/`location`/schemas/` + # schema`` + # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest] google_cloud_documentai_v1beta3_generate_schema_version_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generate_project_location_schema_schema_version(parent, google_cloud_documentai_v1beta3_generate_schema_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta3/{+parent}/schemaVersions:generate', options) + command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest::Representation + command.request_object = google_cloud_documentai_v1beta3_generate_schema_version_request_object + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a schema version. + # @param [String] name + # Required. The name of the SchemaVersion to get. Format: `projects/`project`/ + # locations/`location`/schemas/`schema`/schemaVersions/`schema_version`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_schema_schema_version(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta3/{+name}', options) + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists SchemaVersions. + # @param [String] parent + # Required. Format: `projects/`project`/locations/`location`/schemas/`schema`` + # @param [Fixnum] page_size + # Optional. The maximum number of SchemaVersion to return. If unspecified, at + # most `10` SchemaVersion will be returned. The maximum value is `20`. Values + # above `20` will be coerced to `20`. + # @param [String] page_token + # Optional. We will return the SchemaVersion sorted by creation time. The page + # token will point to the next SchemaVersion. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_schema_schema_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta3/{+parent}/schemaVersions', options) + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a schema version. Editable fields are: - `display_name` - `labels` + # @param [String] name + # Identifier. The resource name of the SchemaVersion. Format: `projects/`project` + # /locations/`location`/schemas/`schema`/schemaVersions/`schema_version`` + # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] google_cloud_documentai_v1beta3_schema_version_object + # @param [String] update_mask + # Optional. The update mask to apply to the resource. **Note:** Only the + # following fields can be updated: - display_name. - labels. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_schema_schema_version(name, google_cloud_documentai_v1beta3_schema_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta3/{+name}', options) + command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + command.request_object = google_cloud_documentai_v1beta3_schema_version_object + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaVersion + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected