google-apis-documentai_v1beta3 0.22.0 → 0.26.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/lib/google/apis/documentai_v1beta3/classes.rb +659 -4
- data/lib/google/apis/documentai_v1beta3/gem_version.rb +2 -2
- data/lib/google/apis/documentai_v1beta3/representations.rb +396 -0
- data/lib/google/apis/documentai_v1beta3/service.rb +231 -0
- metadata +3 -3
@@ -760,6 +760,142 @@ module Google
|
|
760
760
|
end
|
761
761
|
end
|
762
762
|
|
763
|
+
# The long running operation metadata for delete processor method.
|
764
|
+
class GoogleCloudDocumentaiV1DeleteProcessorMetadata
|
765
|
+
include Google::Apis::Core::Hashable
|
766
|
+
|
767
|
+
# The common metadata for long running operations.
|
768
|
+
# Corresponds to the JSON property `commonMetadata`
|
769
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
770
|
+
attr_accessor :common_metadata
|
771
|
+
|
772
|
+
def initialize(**args)
|
773
|
+
update!(**args)
|
774
|
+
end
|
775
|
+
|
776
|
+
# Update properties of this object
|
777
|
+
def update!(**args)
|
778
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
779
|
+
end
|
780
|
+
end
|
781
|
+
|
782
|
+
# The long running operation metadata for delete processor version method.
|
783
|
+
class GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata
|
784
|
+
include Google::Apis::Core::Hashable
|
785
|
+
|
786
|
+
# The common metadata for long running operations.
|
787
|
+
# Corresponds to the JSON property `commonMetadata`
|
788
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
789
|
+
attr_accessor :common_metadata
|
790
|
+
|
791
|
+
def initialize(**args)
|
792
|
+
update!(**args)
|
793
|
+
end
|
794
|
+
|
795
|
+
# Update properties of this object
|
796
|
+
def update!(**args)
|
797
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
798
|
+
end
|
799
|
+
end
|
800
|
+
|
801
|
+
# The long running operation metadata for deploy processor version method.
|
802
|
+
class GoogleCloudDocumentaiV1DeployProcessorVersionMetadata
|
803
|
+
include Google::Apis::Core::Hashable
|
804
|
+
|
805
|
+
# The common metadata for long running operations.
|
806
|
+
# Corresponds to the JSON property `commonMetadata`
|
807
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
808
|
+
attr_accessor :common_metadata
|
809
|
+
|
810
|
+
def initialize(**args)
|
811
|
+
update!(**args)
|
812
|
+
end
|
813
|
+
|
814
|
+
# Update properties of this object
|
815
|
+
def update!(**args)
|
816
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
817
|
+
end
|
818
|
+
end
|
819
|
+
|
820
|
+
# Response message for the deploy processor version method.
|
821
|
+
class GoogleCloudDocumentaiV1DeployProcessorVersionResponse
|
822
|
+
include Google::Apis::Core::Hashable
|
823
|
+
|
824
|
+
def initialize(**args)
|
825
|
+
update!(**args)
|
826
|
+
end
|
827
|
+
|
828
|
+
# Update properties of this object
|
829
|
+
def update!(**args)
|
830
|
+
end
|
831
|
+
end
|
832
|
+
|
833
|
+
# The long running operation metadata for disable processor method.
|
834
|
+
class GoogleCloudDocumentaiV1DisableProcessorMetadata
|
835
|
+
include Google::Apis::Core::Hashable
|
836
|
+
|
837
|
+
# The common metadata for long running operations.
|
838
|
+
# Corresponds to the JSON property `commonMetadata`
|
839
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
840
|
+
attr_accessor :common_metadata
|
841
|
+
|
842
|
+
def initialize(**args)
|
843
|
+
update!(**args)
|
844
|
+
end
|
845
|
+
|
846
|
+
# Update properties of this object
|
847
|
+
def update!(**args)
|
848
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
849
|
+
end
|
850
|
+
end
|
851
|
+
|
852
|
+
# Response message for the disable processor method. Intentionally empty proto
|
853
|
+
# for adding fields in future.
|
854
|
+
class GoogleCloudDocumentaiV1DisableProcessorResponse
|
855
|
+
include Google::Apis::Core::Hashable
|
856
|
+
|
857
|
+
def initialize(**args)
|
858
|
+
update!(**args)
|
859
|
+
end
|
860
|
+
|
861
|
+
# Update properties of this object
|
862
|
+
def update!(**args)
|
863
|
+
end
|
864
|
+
end
|
865
|
+
|
866
|
+
# The long running operation metadata for enable processor method.
|
867
|
+
class GoogleCloudDocumentaiV1EnableProcessorMetadata
|
868
|
+
include Google::Apis::Core::Hashable
|
869
|
+
|
870
|
+
# The common metadata for long running operations.
|
871
|
+
# Corresponds to the JSON property `commonMetadata`
|
872
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
873
|
+
attr_accessor :common_metadata
|
874
|
+
|
875
|
+
def initialize(**args)
|
876
|
+
update!(**args)
|
877
|
+
end
|
878
|
+
|
879
|
+
# Update properties of this object
|
880
|
+
def update!(**args)
|
881
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
882
|
+
end
|
883
|
+
end
|
884
|
+
|
885
|
+
# Response message for the enable processor method. Intentionally empty proto
|
886
|
+
# for adding fields in future.
|
887
|
+
class GoogleCloudDocumentaiV1EnableProcessorResponse
|
888
|
+
include Google::Apis::Core::Hashable
|
889
|
+
|
890
|
+
def initialize(**args)
|
891
|
+
update!(**args)
|
892
|
+
end
|
893
|
+
|
894
|
+
# Update properties of this object
|
895
|
+
def update!(**args)
|
896
|
+
end
|
897
|
+
end
|
898
|
+
|
763
899
|
# The status of human review on a processed document.
|
764
900
|
class GoogleCloudDocumentaiV1HumanReviewStatus
|
765
901
|
include Google::Apis::Core::Hashable
|
@@ -832,6 +968,70 @@ module Google
|
|
832
968
|
end
|
833
969
|
end
|
834
970
|
|
971
|
+
# The long running operation metadata for set default processor version method.
|
972
|
+
class GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata
|
973
|
+
include Google::Apis::Core::Hashable
|
974
|
+
|
975
|
+
# The common metadata for long running operations.
|
976
|
+
# Corresponds to the JSON property `commonMetadata`
|
977
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
978
|
+
attr_accessor :common_metadata
|
979
|
+
|
980
|
+
def initialize(**args)
|
981
|
+
update!(**args)
|
982
|
+
end
|
983
|
+
|
984
|
+
# Update properties of this object
|
985
|
+
def update!(**args)
|
986
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
987
|
+
end
|
988
|
+
end
|
989
|
+
|
990
|
+
# Response message for set default processor version method.
|
991
|
+
class GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse
|
992
|
+
include Google::Apis::Core::Hashable
|
993
|
+
|
994
|
+
def initialize(**args)
|
995
|
+
update!(**args)
|
996
|
+
end
|
997
|
+
|
998
|
+
# Update properties of this object
|
999
|
+
def update!(**args)
|
1000
|
+
end
|
1001
|
+
end
|
1002
|
+
|
1003
|
+
# The long running operation metadata for the undeploy processor version method.
|
1004
|
+
class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
|
1005
|
+
include Google::Apis::Core::Hashable
|
1006
|
+
|
1007
|
+
# The common metadata for long running operations.
|
1008
|
+
# Corresponds to the JSON property `commonMetadata`
|
1009
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
1010
|
+
attr_accessor :common_metadata
|
1011
|
+
|
1012
|
+
def initialize(**args)
|
1013
|
+
update!(**args)
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
# Update properties of this object
|
1017
|
+
def update!(**args)
|
1018
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
1019
|
+
end
|
1020
|
+
end
|
1021
|
+
|
1022
|
+
# Response message for the undeploy processor version method.
|
1023
|
+
class GoogleCloudDocumentaiV1UndeployProcessorVersionResponse
|
1024
|
+
include Google::Apis::Core::Hashable
|
1025
|
+
|
1026
|
+
def initialize(**args)
|
1027
|
+
update!(**args)
|
1028
|
+
end
|
1029
|
+
|
1030
|
+
# Update properties of this object
|
1031
|
+
def update!(**args)
|
1032
|
+
end
|
1033
|
+
end
|
1034
|
+
|
835
1035
|
# Response to an batch document processing request. This is returned in the LRO
|
836
1036
|
# Operation after the operation is complete.
|
837
1037
|
class GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse
|
@@ -4621,6 +4821,70 @@ module Google
|
|
4621
4821
|
end
|
4622
4822
|
end
|
4623
4823
|
|
4824
|
+
# The long running operation metadata for delete processor version method.
|
4825
|
+
class GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata
|
4826
|
+
include Google::Apis::Core::Hashable
|
4827
|
+
|
4828
|
+
# The common metadata for long running operations.
|
4829
|
+
# Corresponds to the JSON property `commonMetadata`
|
4830
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
4831
|
+
attr_accessor :common_metadata
|
4832
|
+
|
4833
|
+
def initialize(**args)
|
4834
|
+
update!(**args)
|
4835
|
+
end
|
4836
|
+
|
4837
|
+
# Update properties of this object
|
4838
|
+
def update!(**args)
|
4839
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
4840
|
+
end
|
4841
|
+
end
|
4842
|
+
|
4843
|
+
# The long running operation metadata for deploy processor version method.
|
4844
|
+
class GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata
|
4845
|
+
include Google::Apis::Core::Hashable
|
4846
|
+
|
4847
|
+
# The common metadata for long running operations.
|
4848
|
+
# Corresponds to the JSON property `commonMetadata`
|
4849
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
4850
|
+
attr_accessor :common_metadata
|
4851
|
+
|
4852
|
+
def initialize(**args)
|
4853
|
+
update!(**args)
|
4854
|
+
end
|
4855
|
+
|
4856
|
+
# Update properties of this object
|
4857
|
+
def update!(**args)
|
4858
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
4859
|
+
end
|
4860
|
+
end
|
4861
|
+
|
4862
|
+
# Request message for the deploy processor version method.
|
4863
|
+
class GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest
|
4864
|
+
include Google::Apis::Core::Hashable
|
4865
|
+
|
4866
|
+
def initialize(**args)
|
4867
|
+
update!(**args)
|
4868
|
+
end
|
4869
|
+
|
4870
|
+
# Update properties of this object
|
4871
|
+
def update!(**args)
|
4872
|
+
end
|
4873
|
+
end
|
4874
|
+
|
4875
|
+
# Response message for the deploy processor version method.
|
4876
|
+
class GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse
|
4877
|
+
include Google::Apis::Core::Hashable
|
4878
|
+
|
4879
|
+
def initialize(**args)
|
4880
|
+
update!(**args)
|
4881
|
+
end
|
4882
|
+
|
4883
|
+
# Update properties of this object
|
4884
|
+
def update!(**args)
|
4885
|
+
end
|
4886
|
+
end
|
4887
|
+
|
4624
4888
|
# The long running operation metadata for disable processor method.
|
4625
4889
|
class GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
|
4626
4890
|
include Google::Apis::Core::Hashable
|
@@ -6207,6 +6471,104 @@ module Google
|
|
6207
6471
|
end
|
6208
6472
|
end
|
6209
6473
|
|
6474
|
+
# Evaluation metrics, either in aggregate or about a specific entity.
|
6475
|
+
class GoogleCloudDocumentaiV1beta3EvaluationMetrics
|
6476
|
+
include Google::Apis::Core::Hashable
|
6477
|
+
|
6478
|
+
# The calculated f1 score.
|
6479
|
+
# Corresponds to the JSON property `f1Score`
|
6480
|
+
# @return [Float]
|
6481
|
+
attr_accessor :f1_score
|
6482
|
+
|
6483
|
+
# The amount of false negatives.
|
6484
|
+
# Corresponds to the JSON property `falseNegativesCount`
|
6485
|
+
# @return [Fixnum]
|
6486
|
+
attr_accessor :false_negatives_count
|
6487
|
+
|
6488
|
+
# The amount of false positives.
|
6489
|
+
# Corresponds to the JSON property `falsePositivesCount`
|
6490
|
+
# @return [Fixnum]
|
6491
|
+
attr_accessor :false_positives_count
|
6492
|
+
|
6493
|
+
# The amount of occurrences in ground truth documents.
|
6494
|
+
# Corresponds to the JSON property `groundTruthOccurrencesCount`
|
6495
|
+
# @return [Fixnum]
|
6496
|
+
attr_accessor :ground_truth_occurrences_count
|
6497
|
+
|
6498
|
+
# The calculated precision.
|
6499
|
+
# Corresponds to the JSON property `precision`
|
6500
|
+
# @return [Float]
|
6501
|
+
attr_accessor :precision
|
6502
|
+
|
6503
|
+
# The amount of occurrences in predicted documents.
|
6504
|
+
# Corresponds to the JSON property `predictedOccurrencesCount`
|
6505
|
+
# @return [Fixnum]
|
6506
|
+
attr_accessor :predicted_occurrences_count
|
6507
|
+
|
6508
|
+
# The calculated recall.
|
6509
|
+
# Corresponds to the JSON property `recall`
|
6510
|
+
# @return [Float]
|
6511
|
+
attr_accessor :recall
|
6512
|
+
|
6513
|
+
# The amount of documents that had an occurrence of this label.
|
6514
|
+
# Corresponds to the JSON property `totalDocumentsCount`
|
6515
|
+
# @return [Fixnum]
|
6516
|
+
attr_accessor :total_documents_count
|
6517
|
+
|
6518
|
+
# The amount of true positives.
|
6519
|
+
# Corresponds to the JSON property `truePositivesCount`
|
6520
|
+
# @return [Fixnum]
|
6521
|
+
attr_accessor :true_positives_count
|
6522
|
+
|
6523
|
+
def initialize(**args)
|
6524
|
+
update!(**args)
|
6525
|
+
end
|
6526
|
+
|
6527
|
+
# Update properties of this object
|
6528
|
+
def update!(**args)
|
6529
|
+
@f1_score = args[:f1_score] if args.key?(:f1_score)
|
6530
|
+
@false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
|
6531
|
+
@false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
|
6532
|
+
@ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
|
6533
|
+
@precision = args[:precision] if args.key?(:precision)
|
6534
|
+
@predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
|
6535
|
+
@recall = args[:recall] if args.key?(:recall)
|
6536
|
+
@total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
|
6537
|
+
@true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
|
6538
|
+
end
|
6539
|
+
end
|
6540
|
+
|
6541
|
+
# Gives a short summary of an evaluation, and links to the evaluation itself.
|
6542
|
+
class GoogleCloudDocumentaiV1beta3EvaluationReference
|
6543
|
+
include Google::Apis::Core::Hashable
|
6544
|
+
|
6545
|
+
# Evaluation metrics, either in aggregate or about a specific entity.
|
6546
|
+
# Corresponds to the JSON property `aggregateMetrics`
|
6547
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMetrics]
|
6548
|
+
attr_accessor :aggregate_metrics
|
6549
|
+
|
6550
|
+
# The resource name of the evaluation.
|
6551
|
+
# Corresponds to the JSON property `evaluation`
|
6552
|
+
# @return [String]
|
6553
|
+
attr_accessor :evaluation
|
6554
|
+
|
6555
|
+
# The resource name of the Long Running Operation for the evaluation.
|
6556
|
+
# Corresponds to the JSON property `operation`
|
6557
|
+
# @return [String]
|
6558
|
+
attr_accessor :operation
|
6559
|
+
|
6560
|
+
def initialize(**args)
|
6561
|
+
update!(**args)
|
6562
|
+
end
|
6563
|
+
|
6564
|
+
# Update properties of this object
|
6565
|
+
def update!(**args)
|
6566
|
+
@aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics)
|
6567
|
+
@evaluation = args[:evaluation] if args.key?(:evaluation)
|
6568
|
+
@operation = args[:operation] if args.key?(:operation)
|
6569
|
+
end
|
6570
|
+
end
|
6571
|
+
|
6210
6572
|
# Response message for fetch processor types.
|
6211
6573
|
class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
|
6212
6574
|
include Google::Apis::Core::Hashable
|
@@ -6323,6 +6685,31 @@ module Google
|
|
6323
6685
|
end
|
6324
6686
|
end
|
6325
6687
|
|
6688
|
+
# Response message for list processors.
|
6689
|
+
class GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse
|
6690
|
+
include Google::Apis::Core::Hashable
|
6691
|
+
|
6692
|
+
# Points to the next processor, otherwise empty.
|
6693
|
+
# Corresponds to the JSON property `nextPageToken`
|
6694
|
+
# @return [String]
|
6695
|
+
attr_accessor :next_page_token
|
6696
|
+
|
6697
|
+
# The list of processors.
|
6698
|
+
# Corresponds to the JSON property `processorVersions`
|
6699
|
+
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorVersion>]
|
6700
|
+
attr_accessor :processor_versions
|
6701
|
+
|
6702
|
+
def initialize(**args)
|
6703
|
+
update!(**args)
|
6704
|
+
end
|
6705
|
+
|
6706
|
+
# Update properties of this object
|
6707
|
+
def update!(**args)
|
6708
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
6709
|
+
@processor_versions = args[:processor_versions] if args.key?(:processor_versions)
|
6710
|
+
end
|
6711
|
+
end
|
6712
|
+
|
6326
6713
|
# Response message for list processors.
|
6327
6714
|
class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
|
6328
6715
|
include Google::Apis::Core::Hashable
|
@@ -6536,13 +6923,12 @@ module Google
|
|
6536
6923
|
# EU' endpoint to feach processor types. In the return, we will have an 'invoice
|
6537
6924
|
# parsing' processor with 'available_locations' field only containing 'US'. So
|
6538
6925
|
# the user can try to create an 'invoice parsing' processor under the location '
|
6539
|
-
# US'. Such attempt of creating under the location 'EU' will fail. Next ID:
|
6926
|
+
# US'. Such attempt of creating under the location 'EU' will fail. Next ID: 9.
|
6540
6927
|
class GoogleCloudDocumentaiV1beta3ProcessorType
|
6541
6928
|
include Google::Apis::Core::Hashable
|
6542
6929
|
|
6543
6930
|
# Whether the processor type allows creation. If yes, user can create a
|
6544
|
-
# processor of this processor type. Otherwise, user needs to
|
6545
|
-
# whitelisting.
|
6931
|
+
# processor of this processor type. Otherwise, user needs to request access.
|
6546
6932
|
# Corresponds to the JSON property `allowCreation`
|
6547
6933
|
# @return [Boolean]
|
6548
6934
|
attr_accessor :allow_creation
|
@@ -6558,13 +6944,18 @@ module Google
|
|
6558
6944
|
# @return [String]
|
6559
6945
|
attr_accessor :category
|
6560
6946
|
|
6947
|
+
# Launch stage of the processor type
|
6948
|
+
# Corresponds to the JSON property `launchStage`
|
6949
|
+
# @return [String]
|
6950
|
+
attr_accessor :launch_stage
|
6951
|
+
|
6561
6952
|
# The resource name of the processor type. Format: projects/`project`/
|
6562
6953
|
# processorTypes/`processor_type`
|
6563
6954
|
# Corresponds to the JSON property `name`
|
6564
6955
|
# @return [String]
|
6565
6956
|
attr_accessor :name
|
6566
6957
|
|
6567
|
-
# The type of the processor, e.g
|
6958
|
+
# The type of the processor, e.g., "invoice_parsing".
|
6568
6959
|
# Corresponds to the JSON property `type`
|
6569
6960
|
# @return [String]
|
6570
6961
|
attr_accessor :type
|
@@ -6578,6 +6969,7 @@ module Google
|
|
6578
6969
|
@allow_creation = args[:allow_creation] if args.key?(:allow_creation)
|
6579
6970
|
@available_locations = args[:available_locations] if args.key?(:available_locations)
|
6580
6971
|
@category = args[:category] if args.key?(:category)
|
6972
|
+
@launch_stage = args[:launch_stage] if args.key?(:launch_stage)
|
6581
6973
|
@name = args[:name] if args.key?(:name)
|
6582
6974
|
@type = args[:type] if args.key?(:type)
|
6583
6975
|
end
|
@@ -6602,6 +6994,61 @@ module Google
|
|
6602
6994
|
end
|
6603
6995
|
end
|
6604
6996
|
|
6997
|
+
# A processor version is an implementation of a processor. Each processor can
|
6998
|
+
# have multiple versions, pre-trained by Google internally or up-trained by the
|
6999
|
+
# customer. At a time, a processor can only have one default version version. So
|
7000
|
+
# the processor's behavior (when processing documents) is defined by a default
|
7001
|
+
# version.
|
7002
|
+
class GoogleCloudDocumentaiV1beta3ProcessorVersion
|
7003
|
+
include Google::Apis::Core::Hashable
|
7004
|
+
|
7005
|
+
# The time the processor version was created.
|
7006
|
+
# Corresponds to the JSON property `createTime`
|
7007
|
+
# @return [String]
|
7008
|
+
attr_accessor :create_time
|
7009
|
+
|
7010
|
+
# The display name of the processor version.
|
7011
|
+
# Corresponds to the JSON property `displayName`
|
7012
|
+
# @return [String]
|
7013
|
+
attr_accessor :display_name
|
7014
|
+
|
7015
|
+
# Gives a short summary of an evaluation, and links to the evaluation itself.
|
7016
|
+
# Corresponds to the JSON property `latestEvaluation`
|
7017
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationReference]
|
7018
|
+
attr_accessor :latest_evaluation
|
7019
|
+
|
7020
|
+
# The resource name of the processor version. Format: projects/`project`/
|
7021
|
+
# locations/`location`/processors/`processor`/processorVersions/`
|
7022
|
+
# processor_version`
|
7023
|
+
# Corresponds to the JSON property `name`
|
7024
|
+
# @return [String]
|
7025
|
+
attr_accessor :name
|
7026
|
+
|
7027
|
+
# The schema defines the output of the processed document by a processor.
|
7028
|
+
# Corresponds to the JSON property `schema`
|
7029
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema]
|
7030
|
+
attr_accessor :schema
|
7031
|
+
|
7032
|
+
# The state of the processor version.
|
7033
|
+
# Corresponds to the JSON property `state`
|
7034
|
+
# @return [String]
|
7035
|
+
attr_accessor :state
|
7036
|
+
|
7037
|
+
def initialize(**args)
|
7038
|
+
update!(**args)
|
7039
|
+
end
|
7040
|
+
|
7041
|
+
# Update properties of this object
|
7042
|
+
def update!(**args)
|
7043
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
7044
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
7045
|
+
@latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
|
7046
|
+
@name = args[:name] if args.key?(:name)
|
7047
|
+
@schema = args[:schema] if args.key?(:schema)
|
7048
|
+
@state = args[:state] if args.key?(:state)
|
7049
|
+
end
|
7050
|
+
end
|
7051
|
+
|
6605
7052
|
# Payload message of raw document content (bytes).
|
6606
7053
|
class GoogleCloudDocumentaiV1beta3RawDocument
|
6607
7054
|
include Google::Apis::Core::Hashable
|
@@ -6735,6 +7182,214 @@ module Google
|
|
6735
7182
|
end
|
6736
7183
|
end
|
6737
7184
|
|
7185
|
+
# The schema defines the output of the processed document by a processor.
|
7186
|
+
class GoogleCloudDocumentaiV1beta3Schema
|
7187
|
+
include Google::Apis::Core::Hashable
|
7188
|
+
|
7189
|
+
# Description of the schema.
|
7190
|
+
# Corresponds to the JSON property `description`
|
7191
|
+
# @return [String]
|
7192
|
+
attr_accessor :description
|
7193
|
+
|
7194
|
+
# Display name to show to users.
|
7195
|
+
# Corresponds to the JSON property `displayName`
|
7196
|
+
# @return [String]
|
7197
|
+
attr_accessor :display_name
|
7198
|
+
|
7199
|
+
# Entity types of the schema.
|
7200
|
+
# Corresponds to the JSON property `entityTypes`
|
7201
|
+
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]
|
7202
|
+
attr_accessor :entity_types
|
7203
|
+
|
7204
|
+
def initialize(**args)
|
7205
|
+
update!(**args)
|
7206
|
+
end
|
7207
|
+
|
7208
|
+
# Update properties of this object
|
7209
|
+
def update!(**args)
|
7210
|
+
@description = args[:description] if args.key?(:description)
|
7211
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
7212
|
+
@entity_types = args[:entity_types] if args.key?(:entity_types)
|
7213
|
+
end
|
7214
|
+
end
|
7215
|
+
|
7216
|
+
# EntityType is the wrapper of a label of the corresponding model with detailed
|
7217
|
+
# attributes and limitations for entity-based processors. Multiple types can
|
7218
|
+
# also compose a dependency tree to represent nested types.
|
7219
|
+
class GoogleCloudDocumentaiV1beta3SchemaEntityType
|
7220
|
+
include Google::Apis::Core::Hashable
|
7221
|
+
|
7222
|
+
# Type of the entity. It must be one of the following: `document` - the entity
|
7223
|
+
# represents a classification of a logical document. `object` - if the entity
|
7224
|
+
# has properties it is likely an object (or or a document.) `datetime` - the
|
7225
|
+
# entity is a date or time value. `money` - the entity represents a money value
|
7226
|
+
# amount. `number` - the entity is a number - integer or floating point. `string`
|
7227
|
+
# - the entity is a string value. `boolean` - the entity is a boolean value. `
|
7228
|
+
# address` - the entity is a location address. `duration` - the entity is a
|
7229
|
+
# duration.
|
7230
|
+
# Corresponds to the JSON property `baseType`
|
7231
|
+
# @return [String]
|
7232
|
+
attr_accessor :base_type
|
7233
|
+
|
7234
|
+
# Description of the entity type.
|
7235
|
+
# Corresponds to the JSON property `description`
|
7236
|
+
# @return [String]
|
7237
|
+
attr_accessor :description
|
7238
|
+
|
7239
|
+
# If specified, lists all the possible values for this entity.
|
7240
|
+
# Corresponds to the JSON property `enumValues`
|
7241
|
+
# @return [Array<String>]
|
7242
|
+
attr_accessor :enum_values
|
7243
|
+
|
7244
|
+
# Occurrence type limits the number of times an entity type appears in the
|
7245
|
+
# document.
|
7246
|
+
# Corresponds to the JSON property `occurrenceType`
|
7247
|
+
# @return [String]
|
7248
|
+
attr_accessor :occurrence_type
|
7249
|
+
|
7250
|
+
# Describing the nested structure of an entity. An EntityType may consist of
|
7251
|
+
# several other EntityTypes. For example, in a document there can be an
|
7252
|
+
# EntityType 'ID', which consists of EntityType 'name' and 'address', with
|
7253
|
+
# corresponding attributes, such as TEXT for both types and ONCE for occurrence
|
7254
|
+
# types.
|
7255
|
+
# Corresponds to the JSON property `properties`
|
7256
|
+
# @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]
|
7257
|
+
attr_accessor :properties
|
7258
|
+
|
7259
|
+
# Source of this entity type.
|
7260
|
+
# Corresponds to the JSON property `source`
|
7261
|
+
# @return [String]
|
7262
|
+
attr_accessor :source
|
7263
|
+
|
7264
|
+
# Name of the type. It must satisfy the following constraints: 1. Must be unique
|
7265
|
+
# within the set of same level types (with case-insensitive match). 2. Maximum
|
7266
|
+
# 50 characters. 3. Must start with a letter. 4. Allowed characters: ASCII
|
7267
|
+
# letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation
|
7268
|
+
# characters: * underscore '_' (recommended) * hyphen '-' (allowed, not
|
7269
|
+
# recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace
|
7270
|
+
# characters are not allowed. 5. Cannot end with a punctuation character. 6.
|
7271
|
+
# Cannot contain the following restricted strings: "google", "DocumentAI" (case-
|
7272
|
+
# insensitive match). 7. A slash character '/' is reserved as a separator in
|
7273
|
+
# flattened representations of nested entity types (e.g., "line_item/amount") in
|
7274
|
+
# which case each part (e.g., "line_item", "amount") must comply with the rules
|
7275
|
+
# defined above. We recommend using the snake case ("snake_case") in entity type
|
7276
|
+
# names.
|
7277
|
+
# Corresponds to the JSON property `type`
|
7278
|
+
# @return [String]
|
7279
|
+
attr_accessor :type
|
7280
|
+
|
7281
|
+
def initialize(**args)
|
7282
|
+
update!(**args)
|
7283
|
+
end
|
7284
|
+
|
7285
|
+
# Update properties of this object
|
7286
|
+
def update!(**args)
|
7287
|
+
@base_type = args[:base_type] if args.key?(:base_type)
|
7288
|
+
@description = args[:description] if args.key?(:description)
|
7289
|
+
@enum_values = args[:enum_values] if args.key?(:enum_values)
|
7290
|
+
@occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
|
7291
|
+
@properties = args[:properties] if args.key?(:properties)
|
7292
|
+
@source = args[:source] if args.key?(:source)
|
7293
|
+
@type = args[:type] if args.key?(:type)
|
7294
|
+
end
|
7295
|
+
end
|
7296
|
+
|
7297
|
+
# The long running operation metadata for set default processor version method.
|
7298
|
+
class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
|
7299
|
+
include Google::Apis::Core::Hashable
|
7300
|
+
|
7301
|
+
# The common metadata for long running operations.
|
7302
|
+
# Corresponds to the JSON property `commonMetadata`
|
7303
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
7304
|
+
attr_accessor :common_metadata
|
7305
|
+
|
7306
|
+
def initialize(**args)
|
7307
|
+
update!(**args)
|
7308
|
+
end
|
7309
|
+
|
7310
|
+
# Update properties of this object
|
7311
|
+
def update!(**args)
|
7312
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
7313
|
+
end
|
7314
|
+
end
|
7315
|
+
|
7316
|
+
# Request message for the set default processor version method.
|
7317
|
+
class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest
|
7318
|
+
include Google::Apis::Core::Hashable
|
7319
|
+
|
7320
|
+
# Required. The resource name of child ProcessorVersion to use as default.
|
7321
|
+
# Corresponds to the JSON property `defaultProcessorVersion`
|
7322
|
+
# @return [String]
|
7323
|
+
attr_accessor :default_processor_version
|
7324
|
+
|
7325
|
+
def initialize(**args)
|
7326
|
+
update!(**args)
|
7327
|
+
end
|
7328
|
+
|
7329
|
+
# Update properties of this object
|
7330
|
+
def update!(**args)
|
7331
|
+
@default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
|
7332
|
+
end
|
7333
|
+
end
|
7334
|
+
|
7335
|
+
# Response message for set default processor version method.
|
7336
|
+
class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse
|
7337
|
+
include Google::Apis::Core::Hashable
|
7338
|
+
|
7339
|
+
def initialize(**args)
|
7340
|
+
update!(**args)
|
7341
|
+
end
|
7342
|
+
|
7343
|
+
# Update properties of this object
|
7344
|
+
def update!(**args)
|
7345
|
+
end
|
7346
|
+
end
|
7347
|
+
|
7348
|
+
# The long running operation metadata for the undeploy processor version method.
|
7349
|
+
class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
|
7350
|
+
include Google::Apis::Core::Hashable
|
7351
|
+
|
7352
|
+
# The common metadata for long running operations.
|
7353
|
+
# Corresponds to the JSON property `commonMetadata`
|
7354
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
7355
|
+
attr_accessor :common_metadata
|
7356
|
+
|
7357
|
+
def initialize(**args)
|
7358
|
+
update!(**args)
|
7359
|
+
end
|
7360
|
+
|
7361
|
+
# Update properties of this object
|
7362
|
+
def update!(**args)
|
7363
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
7364
|
+
end
|
7365
|
+
end
|
7366
|
+
|
7367
|
+
# Request message for the undeploy processor version method.
|
7368
|
+
class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest
|
7369
|
+
include Google::Apis::Core::Hashable
|
7370
|
+
|
7371
|
+
def initialize(**args)
|
7372
|
+
update!(**args)
|
7373
|
+
end
|
7374
|
+
|
7375
|
+
# Update properties of this object
|
7376
|
+
def update!(**args)
|
7377
|
+
end
|
7378
|
+
end
|
7379
|
+
|
7380
|
+
# Response message for the undeploy processor version method.
|
7381
|
+
class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse
|
7382
|
+
include Google::Apis::Core::Hashable
|
7383
|
+
|
7384
|
+
def initialize(**args)
|
7385
|
+
update!(**args)
|
7386
|
+
end
|
7387
|
+
|
7388
|
+
# Update properties of this object
|
7389
|
+
def update!(**args)
|
7390
|
+
end
|
7391
|
+
end
|
7392
|
+
|
6738
7393
|
# A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
|
6739
7394
|
# in the same scale as the original image.
|
6740
7395
|
class GoogleCloudDocumentaiV1beta3Vertex
|