google-apis-documentai_v1 0.14.0 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -844,6 +844,135 @@ module Google
|
|
844
844
|
end
|
845
845
|
end
|
846
846
|
|
847
|
+
# The long running operation metadata for delete processor method.
|
848
|
+
class GoogleCloudDocumentaiV1DeleteProcessorMetadata
|
849
|
+
include Google::Apis::Core::Hashable
|
850
|
+
|
851
|
+
# The common metadata for long running operations.
|
852
|
+
# Corresponds to the JSON property `commonMetadata`
|
853
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
854
|
+
attr_accessor :common_metadata
|
855
|
+
|
856
|
+
def initialize(**args)
|
857
|
+
update!(**args)
|
858
|
+
end
|
859
|
+
|
860
|
+
# Update properties of this object
|
861
|
+
def update!(**args)
|
862
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
863
|
+
end
|
864
|
+
end
|
865
|
+
|
866
|
+
# The long running operation metadata for delete processor version method.
|
867
|
+
class GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata
|
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::DocumentaiV1::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
|
+
# The long running operation metadata for deploy processor version method.
|
886
|
+
class GoogleCloudDocumentaiV1DeployProcessorVersionMetadata
|
887
|
+
include Google::Apis::Core::Hashable
|
888
|
+
|
889
|
+
# The common metadata for long running operations.
|
890
|
+
# Corresponds to the JSON property `commonMetadata`
|
891
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
892
|
+
attr_accessor :common_metadata
|
893
|
+
|
894
|
+
def initialize(**args)
|
895
|
+
update!(**args)
|
896
|
+
end
|
897
|
+
|
898
|
+
# Update properties of this object
|
899
|
+
def update!(**args)
|
900
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
901
|
+
end
|
902
|
+
end
|
903
|
+
|
904
|
+
# Request message for the deploy processor version method.
|
905
|
+
class GoogleCloudDocumentaiV1DeployProcessorVersionRequest
|
906
|
+
include Google::Apis::Core::Hashable
|
907
|
+
|
908
|
+
def initialize(**args)
|
909
|
+
update!(**args)
|
910
|
+
end
|
911
|
+
|
912
|
+
# Update properties of this object
|
913
|
+
def update!(**args)
|
914
|
+
end
|
915
|
+
end
|
916
|
+
|
917
|
+
# Response message for the deploy processor version method.
|
918
|
+
class GoogleCloudDocumentaiV1DeployProcessorVersionResponse
|
919
|
+
include Google::Apis::Core::Hashable
|
920
|
+
|
921
|
+
def initialize(**args)
|
922
|
+
update!(**args)
|
923
|
+
end
|
924
|
+
|
925
|
+
# Update properties of this object
|
926
|
+
def update!(**args)
|
927
|
+
end
|
928
|
+
end
|
929
|
+
|
930
|
+
# The long running operation metadata for disable processor method.
|
931
|
+
class GoogleCloudDocumentaiV1DisableProcessorMetadata
|
932
|
+
include Google::Apis::Core::Hashable
|
933
|
+
|
934
|
+
# The common metadata for long running operations.
|
935
|
+
# Corresponds to the JSON property `commonMetadata`
|
936
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
937
|
+
attr_accessor :common_metadata
|
938
|
+
|
939
|
+
def initialize(**args)
|
940
|
+
update!(**args)
|
941
|
+
end
|
942
|
+
|
943
|
+
# Update properties of this object
|
944
|
+
def update!(**args)
|
945
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
946
|
+
end
|
947
|
+
end
|
948
|
+
|
949
|
+
# Request message for the disable processor method.
|
950
|
+
class GoogleCloudDocumentaiV1DisableProcessorRequest
|
951
|
+
include Google::Apis::Core::Hashable
|
952
|
+
|
953
|
+
def initialize(**args)
|
954
|
+
update!(**args)
|
955
|
+
end
|
956
|
+
|
957
|
+
# Update properties of this object
|
958
|
+
def update!(**args)
|
959
|
+
end
|
960
|
+
end
|
961
|
+
|
962
|
+
# Response message for the disable processor method. Intentionally empty proto
|
963
|
+
# for adding fields in future.
|
964
|
+
class GoogleCloudDocumentaiV1DisableProcessorResponse
|
965
|
+
include Google::Apis::Core::Hashable
|
966
|
+
|
967
|
+
def initialize(**args)
|
968
|
+
update!(**args)
|
969
|
+
end
|
970
|
+
|
971
|
+
# Update properties of this object
|
972
|
+
def update!(**args)
|
973
|
+
end
|
974
|
+
end
|
975
|
+
|
847
976
|
# Document represents the canonical document resource in Document Understanding
|
848
977
|
# AI. It is an interchange format that provides insights into documents and
|
849
978
|
# allows for collaboration between users and Document Understanding AI to
|
@@ -2338,6 +2467,169 @@ module Google
|
|
2338
2467
|
end
|
2339
2468
|
end
|
2340
2469
|
|
2470
|
+
# The long running operation metadata for enable processor method.
|
2471
|
+
class GoogleCloudDocumentaiV1EnableProcessorMetadata
|
2472
|
+
include Google::Apis::Core::Hashable
|
2473
|
+
|
2474
|
+
# The common metadata for long running operations.
|
2475
|
+
# Corresponds to the JSON property `commonMetadata`
|
2476
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
2477
|
+
attr_accessor :common_metadata
|
2478
|
+
|
2479
|
+
def initialize(**args)
|
2480
|
+
update!(**args)
|
2481
|
+
end
|
2482
|
+
|
2483
|
+
# Update properties of this object
|
2484
|
+
def update!(**args)
|
2485
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
2486
|
+
end
|
2487
|
+
end
|
2488
|
+
|
2489
|
+
# Request message for the enable processor method.
|
2490
|
+
class GoogleCloudDocumentaiV1EnableProcessorRequest
|
2491
|
+
include Google::Apis::Core::Hashable
|
2492
|
+
|
2493
|
+
def initialize(**args)
|
2494
|
+
update!(**args)
|
2495
|
+
end
|
2496
|
+
|
2497
|
+
# Update properties of this object
|
2498
|
+
def update!(**args)
|
2499
|
+
end
|
2500
|
+
end
|
2501
|
+
|
2502
|
+
# Response message for the enable processor method. Intentionally empty proto
|
2503
|
+
# for adding fields in future.
|
2504
|
+
class GoogleCloudDocumentaiV1EnableProcessorResponse
|
2505
|
+
include Google::Apis::Core::Hashable
|
2506
|
+
|
2507
|
+
def initialize(**args)
|
2508
|
+
update!(**args)
|
2509
|
+
end
|
2510
|
+
|
2511
|
+
# Update properties of this object
|
2512
|
+
def update!(**args)
|
2513
|
+
end
|
2514
|
+
end
|
2515
|
+
|
2516
|
+
# Evaluation metrics, either in aggregate or about a specific entity.
|
2517
|
+
class GoogleCloudDocumentaiV1EvaluationMetrics
|
2518
|
+
include Google::Apis::Core::Hashable
|
2519
|
+
|
2520
|
+
# The calculated f1 score.
|
2521
|
+
# Corresponds to the JSON property `f1Score`
|
2522
|
+
# @return [Float]
|
2523
|
+
attr_accessor :f1_score
|
2524
|
+
|
2525
|
+
# The amount of false negatives.
|
2526
|
+
# Corresponds to the JSON property `falseNegativesCount`
|
2527
|
+
# @return [Fixnum]
|
2528
|
+
attr_accessor :false_negatives_count
|
2529
|
+
|
2530
|
+
# The amount of false positives.
|
2531
|
+
# Corresponds to the JSON property `falsePositivesCount`
|
2532
|
+
# @return [Fixnum]
|
2533
|
+
attr_accessor :false_positives_count
|
2534
|
+
|
2535
|
+
# The amount of occurrences in ground truth documents.
|
2536
|
+
# Corresponds to the JSON property `groundTruthOccurrencesCount`
|
2537
|
+
# @return [Fixnum]
|
2538
|
+
attr_accessor :ground_truth_occurrences_count
|
2539
|
+
|
2540
|
+
# The calculated precision.
|
2541
|
+
# Corresponds to the JSON property `precision`
|
2542
|
+
# @return [Float]
|
2543
|
+
attr_accessor :precision
|
2544
|
+
|
2545
|
+
# The amount of occurrences in predicted documents.
|
2546
|
+
# Corresponds to the JSON property `predictedOccurrencesCount`
|
2547
|
+
# @return [Fixnum]
|
2548
|
+
attr_accessor :predicted_occurrences_count
|
2549
|
+
|
2550
|
+
# The calculated recall.
|
2551
|
+
# Corresponds to the JSON property `recall`
|
2552
|
+
# @return [Float]
|
2553
|
+
attr_accessor :recall
|
2554
|
+
|
2555
|
+
# The amount of documents that had an occurrence of this label.
|
2556
|
+
# Corresponds to the JSON property `totalDocumentsCount`
|
2557
|
+
# @return [Fixnum]
|
2558
|
+
attr_accessor :total_documents_count
|
2559
|
+
|
2560
|
+
# The amount of true positives.
|
2561
|
+
# Corresponds to the JSON property `truePositivesCount`
|
2562
|
+
# @return [Fixnum]
|
2563
|
+
attr_accessor :true_positives_count
|
2564
|
+
|
2565
|
+
def initialize(**args)
|
2566
|
+
update!(**args)
|
2567
|
+
end
|
2568
|
+
|
2569
|
+
# Update properties of this object
|
2570
|
+
def update!(**args)
|
2571
|
+
@f1_score = args[:f1_score] if args.key?(:f1_score)
|
2572
|
+
@false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
|
2573
|
+
@false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
|
2574
|
+
@ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
|
2575
|
+
@precision = args[:precision] if args.key?(:precision)
|
2576
|
+
@predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
|
2577
|
+
@recall = args[:recall] if args.key?(:recall)
|
2578
|
+
@total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
|
2579
|
+
@true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
|
2580
|
+
end
|
2581
|
+
end
|
2582
|
+
|
2583
|
+
# Gives a short summary of an evaluation, and links to the evaluation itself.
|
2584
|
+
class GoogleCloudDocumentaiV1EvaluationReference
|
2585
|
+
include Google::Apis::Core::Hashable
|
2586
|
+
|
2587
|
+
# Evaluation metrics, either in aggregate or about a specific entity.
|
2588
|
+
# Corresponds to the JSON property `aggregateMetrics`
|
2589
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMetrics]
|
2590
|
+
attr_accessor :aggregate_metrics
|
2591
|
+
|
2592
|
+
# The resource name of the evaluation.
|
2593
|
+
# Corresponds to the JSON property `evaluation`
|
2594
|
+
# @return [String]
|
2595
|
+
attr_accessor :evaluation
|
2596
|
+
|
2597
|
+
# The resource name of the Long Running Operation for the evaluation.
|
2598
|
+
# Corresponds to the JSON property `operation`
|
2599
|
+
# @return [String]
|
2600
|
+
attr_accessor :operation
|
2601
|
+
|
2602
|
+
def initialize(**args)
|
2603
|
+
update!(**args)
|
2604
|
+
end
|
2605
|
+
|
2606
|
+
# Update properties of this object
|
2607
|
+
def update!(**args)
|
2608
|
+
@aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics)
|
2609
|
+
@evaluation = args[:evaluation] if args.key?(:evaluation)
|
2610
|
+
@operation = args[:operation] if args.key?(:operation)
|
2611
|
+
end
|
2612
|
+
end
|
2613
|
+
|
2614
|
+
# Response message for fetch processor types.
|
2615
|
+
class GoogleCloudDocumentaiV1FetchProcessorTypesResponse
|
2616
|
+
include Google::Apis::Core::Hashable
|
2617
|
+
|
2618
|
+
# The list of processor types.
|
2619
|
+
# Corresponds to the JSON property `processorTypes`
|
2620
|
+
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorType>]
|
2621
|
+
attr_accessor :processor_types
|
2622
|
+
|
2623
|
+
def initialize(**args)
|
2624
|
+
update!(**args)
|
2625
|
+
end
|
2626
|
+
|
2627
|
+
# Update properties of this object
|
2628
|
+
def update!(**args)
|
2629
|
+
@processor_types = args[:processor_types] if args.key?(:processor_types)
|
2630
|
+
end
|
2631
|
+
end
|
2632
|
+
|
2341
2633
|
# Specifies a document stored on Cloud Storage.
|
2342
2634
|
class GoogleCloudDocumentaiV1GcsDocument
|
2343
2635
|
include Google::Apis::Core::Hashable
|
@@ -2435,6 +2727,56 @@ module Google
|
|
2435
2727
|
end
|
2436
2728
|
end
|
2437
2729
|
|
2730
|
+
# Response message for list processors.
|
2731
|
+
class GoogleCloudDocumentaiV1ListProcessorVersionsResponse
|
2732
|
+
include Google::Apis::Core::Hashable
|
2733
|
+
|
2734
|
+
# Points to the next processor, otherwise empty.
|
2735
|
+
# Corresponds to the JSON property `nextPageToken`
|
2736
|
+
# @return [String]
|
2737
|
+
attr_accessor :next_page_token
|
2738
|
+
|
2739
|
+
# The list of processors.
|
2740
|
+
# Corresponds to the JSON property `processorVersions`
|
2741
|
+
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorVersion>]
|
2742
|
+
attr_accessor :processor_versions
|
2743
|
+
|
2744
|
+
def initialize(**args)
|
2745
|
+
update!(**args)
|
2746
|
+
end
|
2747
|
+
|
2748
|
+
# Update properties of this object
|
2749
|
+
def update!(**args)
|
2750
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2751
|
+
@processor_versions = args[:processor_versions] if args.key?(:processor_versions)
|
2752
|
+
end
|
2753
|
+
end
|
2754
|
+
|
2755
|
+
# Response message for list processors.
|
2756
|
+
class GoogleCloudDocumentaiV1ListProcessorsResponse
|
2757
|
+
include Google::Apis::Core::Hashable
|
2758
|
+
|
2759
|
+
# Points to the next processor, otherwise empty.
|
2760
|
+
# Corresponds to the JSON property `nextPageToken`
|
2761
|
+
# @return [String]
|
2762
|
+
attr_accessor :next_page_token
|
2763
|
+
|
2764
|
+
# The list of processors.
|
2765
|
+
# Corresponds to the JSON property `processors`
|
2766
|
+
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Processor>]
|
2767
|
+
attr_accessor :processors
|
2768
|
+
|
2769
|
+
def initialize(**args)
|
2770
|
+
update!(**args)
|
2771
|
+
end
|
2772
|
+
|
2773
|
+
# Update properties of this object
|
2774
|
+
def update!(**args)
|
2775
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2776
|
+
@processors = args[:processors] if args.key?(:processors)
|
2777
|
+
end
|
2778
|
+
end
|
2779
|
+
|
2438
2780
|
# A vertex represents a 2D point in the image. NOTE: the normalized vertex
|
2439
2781
|
# coordinates are relative to the original image and range from 0 to 1.
|
2440
2782
|
class GoogleCloudDocumentaiV1NormalizedVertex
|
@@ -2509,10 +2851,212 @@ module Google
|
|
2509
2851
|
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Document]
|
2510
2852
|
attr_accessor :document
|
2511
2853
|
|
2512
|
-
# The status of human review on a processed document.
|
2513
|
-
# Corresponds to the JSON property `humanReviewStatus`
|
2514
|
-
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1HumanReviewStatus]
|
2515
|
-
attr_accessor :human_review_status
|
2854
|
+
# The status of human review on a processed document.
|
2855
|
+
# Corresponds to the JSON property `humanReviewStatus`
|
2856
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1HumanReviewStatus]
|
2857
|
+
attr_accessor :human_review_status
|
2858
|
+
|
2859
|
+
def initialize(**args)
|
2860
|
+
update!(**args)
|
2861
|
+
end
|
2862
|
+
|
2863
|
+
# Update properties of this object
|
2864
|
+
def update!(**args)
|
2865
|
+
@document = args[:document] if args.key?(:document)
|
2866
|
+
@human_review_status = args[:human_review_status] if args.key?(:human_review_status)
|
2867
|
+
end
|
2868
|
+
end
|
2869
|
+
|
2870
|
+
# The first-class citizen for DAI. Each processor defines how to extract
|
2871
|
+
# structural information from a document.
|
2872
|
+
class GoogleCloudDocumentaiV1Processor
|
2873
|
+
include Google::Apis::Core::Hashable
|
2874
|
+
|
2875
|
+
# The time the processor was created.
|
2876
|
+
# Corresponds to the JSON property `createTime`
|
2877
|
+
# @return [String]
|
2878
|
+
attr_accessor :create_time
|
2879
|
+
|
2880
|
+
# The default processor version.
|
2881
|
+
# Corresponds to the JSON property `defaultProcessorVersion`
|
2882
|
+
# @return [String]
|
2883
|
+
attr_accessor :default_processor_version
|
2884
|
+
|
2885
|
+
# The display name of the processor.
|
2886
|
+
# Corresponds to the JSON property `displayName`
|
2887
|
+
# @return [String]
|
2888
|
+
attr_accessor :display_name
|
2889
|
+
|
2890
|
+
# The KMS key used for encryption/decryption in CMEK scenarios. See https://
|
2891
|
+
# cloud.google.com/security-key-management.
|
2892
|
+
# Corresponds to the JSON property `kmsKeyName`
|
2893
|
+
# @return [String]
|
2894
|
+
attr_accessor :kms_key_name
|
2895
|
+
|
2896
|
+
# Output only. Immutable. The resource name of the processor. Format: projects/`
|
2897
|
+
# project`/locations/`location`/processors/`processor`
|
2898
|
+
# Corresponds to the JSON property `name`
|
2899
|
+
# @return [String]
|
2900
|
+
attr_accessor :name
|
2901
|
+
|
2902
|
+
# Output only. Immutable. The http endpoint that can be called to invoke
|
2903
|
+
# processing.
|
2904
|
+
# Corresponds to the JSON property `processEndpoint`
|
2905
|
+
# @return [String]
|
2906
|
+
attr_accessor :process_endpoint
|
2907
|
+
|
2908
|
+
# Output only. The state of the processor.
|
2909
|
+
# Corresponds to the JSON property `state`
|
2910
|
+
# @return [String]
|
2911
|
+
attr_accessor :state
|
2912
|
+
|
2913
|
+
# The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
|
2914
|
+
# Corresponds to the JSON property `type`
|
2915
|
+
# @return [String]
|
2916
|
+
attr_accessor :type
|
2917
|
+
|
2918
|
+
def initialize(**args)
|
2919
|
+
update!(**args)
|
2920
|
+
end
|
2921
|
+
|
2922
|
+
# Update properties of this object
|
2923
|
+
def update!(**args)
|
2924
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
2925
|
+
@default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
|
2926
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
2927
|
+
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
|
2928
|
+
@name = args[:name] if args.key?(:name)
|
2929
|
+
@process_endpoint = args[:process_endpoint] if args.key?(:process_endpoint)
|
2930
|
+
@state = args[:state] if args.key?(:state)
|
2931
|
+
@type = args[:type] if args.key?(:type)
|
2932
|
+
end
|
2933
|
+
end
|
2934
|
+
|
2935
|
+
# A processor type is responsible for performing a certain document
|
2936
|
+
# understanding task on a certain type of document. All processor types are
|
2937
|
+
# created by the documentai service internally. User will only list all
|
2938
|
+
# available processor types via UI. For different users (projects), the
|
2939
|
+
# available processor types may be different since we'll expose the access of
|
2940
|
+
# some types via EAP whitelisting. We make the ProcessorType a resource under
|
2941
|
+
# location so we have a unified API and keep the possibility that UI will load
|
2942
|
+
# different available processor types from different regions. But for alpha the
|
2943
|
+
# behavior is that the user will always get the union of all available processor
|
2944
|
+
# types among all regions no matter which regionalized endpoint is called, and
|
2945
|
+
# then we use the 'available_locations' field to show under which regions a
|
2946
|
+
# processor type is available. For example, users can call either the 'US' or '
|
2947
|
+
# EU' endpoint to feach processor types. In the return, we will have an 'invoice
|
2948
|
+
# parsing' processor with 'available_locations' field only containing 'US'. So
|
2949
|
+
# the user can try to create an 'invoice parsing' processor under the location '
|
2950
|
+
# US'. Such attempt of creating under the location 'EU' will fail. Next ID: 9.
|
2951
|
+
class GoogleCloudDocumentaiV1ProcessorType
|
2952
|
+
include Google::Apis::Core::Hashable
|
2953
|
+
|
2954
|
+
# Whether the processor type allows creation. If yes, user can create a
|
2955
|
+
# processor of this processor type. Otherwise, user needs to request access.
|
2956
|
+
# Corresponds to the JSON property `allowCreation`
|
2957
|
+
# @return [Boolean]
|
2958
|
+
attr_accessor :allow_creation
|
2959
|
+
alias_method :allow_creation?, :allow_creation
|
2960
|
+
|
2961
|
+
# The locations in which this processor is available.
|
2962
|
+
# Corresponds to the JSON property `availableLocations`
|
2963
|
+
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessorTypeLocationInfo>]
|
2964
|
+
attr_accessor :available_locations
|
2965
|
+
|
2966
|
+
# The processor category, used by UI to group processor types.
|
2967
|
+
# Corresponds to the JSON property `category`
|
2968
|
+
# @return [String]
|
2969
|
+
attr_accessor :category
|
2970
|
+
|
2971
|
+
# Launch stage of the processor type
|
2972
|
+
# Corresponds to the JSON property `launchStage`
|
2973
|
+
# @return [String]
|
2974
|
+
attr_accessor :launch_stage
|
2975
|
+
|
2976
|
+
# The resource name of the processor type. Format: projects/`project`/
|
2977
|
+
# processorTypes/`processor_type`
|
2978
|
+
# Corresponds to the JSON property `name`
|
2979
|
+
# @return [String]
|
2980
|
+
attr_accessor :name
|
2981
|
+
|
2982
|
+
# The type of the processor, e.g., "invoice_parsing".
|
2983
|
+
# Corresponds to the JSON property `type`
|
2984
|
+
# @return [String]
|
2985
|
+
attr_accessor :type
|
2986
|
+
|
2987
|
+
def initialize(**args)
|
2988
|
+
update!(**args)
|
2989
|
+
end
|
2990
|
+
|
2991
|
+
# Update properties of this object
|
2992
|
+
def update!(**args)
|
2993
|
+
@allow_creation = args[:allow_creation] if args.key?(:allow_creation)
|
2994
|
+
@available_locations = args[:available_locations] if args.key?(:available_locations)
|
2995
|
+
@category = args[:category] if args.key?(:category)
|
2996
|
+
@launch_stage = args[:launch_stage] if args.key?(:launch_stage)
|
2997
|
+
@name = args[:name] if args.key?(:name)
|
2998
|
+
@type = args[:type] if args.key?(:type)
|
2999
|
+
end
|
3000
|
+
end
|
3001
|
+
|
3002
|
+
# The location information about where the processor is available.
|
3003
|
+
class GoogleCloudDocumentaiV1ProcessorTypeLocationInfo
|
3004
|
+
include Google::Apis::Core::Hashable
|
3005
|
+
|
3006
|
+
# The location id, currently must be one of [us, eu].
|
3007
|
+
# Corresponds to the JSON property `locationId`
|
3008
|
+
# @return [String]
|
3009
|
+
attr_accessor :location_id
|
3010
|
+
|
3011
|
+
def initialize(**args)
|
3012
|
+
update!(**args)
|
3013
|
+
end
|
3014
|
+
|
3015
|
+
# Update properties of this object
|
3016
|
+
def update!(**args)
|
3017
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
3018
|
+
end
|
3019
|
+
end
|
3020
|
+
|
3021
|
+
# A processor version is an implementation of a processor. Each processor can
|
3022
|
+
# have multiple versions, pre-trained by Google internally or up-trained by the
|
3023
|
+
# customer. At a time, a processor can only have one default version version. So
|
3024
|
+
# the processor's behavior (when processing documents) is defined by a default
|
3025
|
+
# version.
|
3026
|
+
class GoogleCloudDocumentaiV1ProcessorVersion
|
3027
|
+
include Google::Apis::Core::Hashable
|
3028
|
+
|
3029
|
+
# The time the processor version was created.
|
3030
|
+
# Corresponds to the JSON property `createTime`
|
3031
|
+
# @return [String]
|
3032
|
+
attr_accessor :create_time
|
3033
|
+
|
3034
|
+
# The display name of the processor version.
|
3035
|
+
# Corresponds to the JSON property `displayName`
|
3036
|
+
# @return [String]
|
3037
|
+
attr_accessor :display_name
|
3038
|
+
|
3039
|
+
# Gives a short summary of an evaluation, and links to the evaluation itself.
|
3040
|
+
# Corresponds to the JSON property `latestEvaluation`
|
3041
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference]
|
3042
|
+
attr_accessor :latest_evaluation
|
3043
|
+
|
3044
|
+
# The resource name of the processor version. Format: projects/`project`/
|
3045
|
+
# locations/`location`/processors/`processor`/processorVersions/`
|
3046
|
+
# processor_version`
|
3047
|
+
# Corresponds to the JSON property `name`
|
3048
|
+
# @return [String]
|
3049
|
+
attr_accessor :name
|
3050
|
+
|
3051
|
+
# The schema defines the output of the processed document by a processor.
|
3052
|
+
# Corresponds to the JSON property `schema`
|
3053
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Schema]
|
3054
|
+
attr_accessor :schema
|
3055
|
+
|
3056
|
+
# The state of the processor version.
|
3057
|
+
# Corresponds to the JSON property `state`
|
3058
|
+
# @return [String]
|
3059
|
+
attr_accessor :state
|
2516
3060
|
|
2517
3061
|
def initialize(**args)
|
2518
3062
|
update!(**args)
|
@@ -2520,8 +3064,12 @@ module Google
|
|
2520
3064
|
|
2521
3065
|
# Update properties of this object
|
2522
3066
|
def update!(**args)
|
2523
|
-
@
|
2524
|
-
@
|
3067
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
3068
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
3069
|
+
@latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
|
3070
|
+
@name = args[:name] if args.key?(:name)
|
3071
|
+
@schema = args[:schema] if args.key?(:schema)
|
3072
|
+
@state = args[:state] if args.key?(:state)
|
2525
3073
|
end
|
2526
3074
|
end
|
2527
3075
|
|
@@ -2624,6 +3172,202 @@ module Google
|
|
2624
3172
|
end
|
2625
3173
|
end
|
2626
3174
|
|
3175
|
+
# The schema defines the output of the processed document by a processor.
|
3176
|
+
class GoogleCloudDocumentaiV1Schema
|
3177
|
+
include Google::Apis::Core::Hashable
|
3178
|
+
|
3179
|
+
# Description of the schema.
|
3180
|
+
# Corresponds to the JSON property `description`
|
3181
|
+
# @return [String]
|
3182
|
+
attr_accessor :description
|
3183
|
+
|
3184
|
+
# Display name to show to users.
|
3185
|
+
# Corresponds to the JSON property `displayName`
|
3186
|
+
# @return [String]
|
3187
|
+
attr_accessor :display_name
|
3188
|
+
|
3189
|
+
# Entity types of the schema.
|
3190
|
+
# Corresponds to the JSON property `entityTypes`
|
3191
|
+
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1SchemaEntityType>]
|
3192
|
+
attr_accessor :entity_types
|
3193
|
+
|
3194
|
+
def initialize(**args)
|
3195
|
+
update!(**args)
|
3196
|
+
end
|
3197
|
+
|
3198
|
+
# Update properties of this object
|
3199
|
+
def update!(**args)
|
3200
|
+
@description = args[:description] if args.key?(:description)
|
3201
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
3202
|
+
@entity_types = args[:entity_types] if args.key?(:entity_types)
|
3203
|
+
end
|
3204
|
+
end
|
3205
|
+
|
3206
|
+
# EntityType is the wrapper of a label of the corresponding model with detailed
|
3207
|
+
# attributes and limitations for entity-based processors. Multiple types can
|
3208
|
+
# also compose a dependency tree to represent nested types.
|
3209
|
+
class GoogleCloudDocumentaiV1SchemaEntityType
|
3210
|
+
include Google::Apis::Core::Hashable
|
3211
|
+
|
3212
|
+
# Type of the entity. It must be one of the following: `document` - the entity
|
3213
|
+
# represents a classification of a logical document. `object` - if the entity
|
3214
|
+
# has properties it is likely an object (or or a document.) `datetime` - the
|
3215
|
+
# entity is a date or time value. `money` - the entity represents a money value
|
3216
|
+
# amount. `number` - the entity is a number - integer or floating point. `string`
|
3217
|
+
# - the entity is a string value. `boolean` - the entity is a boolean value. `
|
3218
|
+
# address` - the entity is a location address. `duration` - the entity is a
|
3219
|
+
# duration.
|
3220
|
+
# Corresponds to the JSON property `baseType`
|
3221
|
+
# @return [String]
|
3222
|
+
attr_accessor :base_type
|
3223
|
+
|
3224
|
+
# Description of the entity type.
|
3225
|
+
# Corresponds to the JSON property `description`
|
3226
|
+
# @return [String]
|
3227
|
+
attr_accessor :description
|
3228
|
+
|
3229
|
+
# If specified, lists all the possible values for this entity.
|
3230
|
+
# Corresponds to the JSON property `enumValues`
|
3231
|
+
# @return [Array<String>]
|
3232
|
+
attr_accessor :enum_values
|
3233
|
+
|
3234
|
+
# Occurrence type limits the number of times an entity type appears in the
|
3235
|
+
# document.
|
3236
|
+
# Corresponds to the JSON property `occurrenceType`
|
3237
|
+
# @return [String]
|
3238
|
+
attr_accessor :occurrence_type
|
3239
|
+
|
3240
|
+
# Describing the nested structure of an entity. An EntityType may consist of
|
3241
|
+
# several other EntityTypes. For example, in a document there can be an
|
3242
|
+
# EntityType 'ID', which consists of EntityType 'name' and 'address', with
|
3243
|
+
# corresponding attributes, such as TEXT for both types and ONCE for occurrence
|
3244
|
+
# types.
|
3245
|
+
# Corresponds to the JSON property `properties`
|
3246
|
+
# @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1SchemaEntityType>]
|
3247
|
+
attr_accessor :properties
|
3248
|
+
|
3249
|
+
# Source of this entity type.
|
3250
|
+
# Corresponds to the JSON property `source`
|
3251
|
+
# @return [String]
|
3252
|
+
attr_accessor :source
|
3253
|
+
|
3254
|
+
# Name of the type. It must be unique within the set of same level types.
|
3255
|
+
# Corresponds to the JSON property `type`
|
3256
|
+
# @return [String]
|
3257
|
+
attr_accessor :type
|
3258
|
+
|
3259
|
+
def initialize(**args)
|
3260
|
+
update!(**args)
|
3261
|
+
end
|
3262
|
+
|
3263
|
+
# Update properties of this object
|
3264
|
+
def update!(**args)
|
3265
|
+
@base_type = args[:base_type] if args.key?(:base_type)
|
3266
|
+
@description = args[:description] if args.key?(:description)
|
3267
|
+
@enum_values = args[:enum_values] if args.key?(:enum_values)
|
3268
|
+
@occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
|
3269
|
+
@properties = args[:properties] if args.key?(:properties)
|
3270
|
+
@source = args[:source] if args.key?(:source)
|
3271
|
+
@type = args[:type] if args.key?(:type)
|
3272
|
+
end
|
3273
|
+
end
|
3274
|
+
|
3275
|
+
# The long running operation metadata for set default processor version method.
|
3276
|
+
class GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata
|
3277
|
+
include Google::Apis::Core::Hashable
|
3278
|
+
|
3279
|
+
# The common metadata for long running operations.
|
3280
|
+
# Corresponds to the JSON property `commonMetadata`
|
3281
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
3282
|
+
attr_accessor :common_metadata
|
3283
|
+
|
3284
|
+
def initialize(**args)
|
3285
|
+
update!(**args)
|
3286
|
+
end
|
3287
|
+
|
3288
|
+
# Update properties of this object
|
3289
|
+
def update!(**args)
|
3290
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
3291
|
+
end
|
3292
|
+
end
|
3293
|
+
|
3294
|
+
# Request message for the set default processor version method.
|
3295
|
+
class GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest
|
3296
|
+
include Google::Apis::Core::Hashable
|
3297
|
+
|
3298
|
+
# Required. The resource name of child ProcessorVersion to use as default.
|
3299
|
+
# Corresponds to the JSON property `defaultProcessorVersion`
|
3300
|
+
# @return [String]
|
3301
|
+
attr_accessor :default_processor_version
|
3302
|
+
|
3303
|
+
def initialize(**args)
|
3304
|
+
update!(**args)
|
3305
|
+
end
|
3306
|
+
|
3307
|
+
# Update properties of this object
|
3308
|
+
def update!(**args)
|
3309
|
+
@default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
|
3310
|
+
end
|
3311
|
+
end
|
3312
|
+
|
3313
|
+
# Response message for set default processor version method.
|
3314
|
+
class GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse
|
3315
|
+
include Google::Apis::Core::Hashable
|
3316
|
+
|
3317
|
+
def initialize(**args)
|
3318
|
+
update!(**args)
|
3319
|
+
end
|
3320
|
+
|
3321
|
+
# Update properties of this object
|
3322
|
+
def update!(**args)
|
3323
|
+
end
|
3324
|
+
end
|
3325
|
+
|
3326
|
+
# The long running operation metadata for the undeploy processor version method.
|
3327
|
+
class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
|
3328
|
+
include Google::Apis::Core::Hashable
|
3329
|
+
|
3330
|
+
# The common metadata for long running operations.
|
3331
|
+
# Corresponds to the JSON property `commonMetadata`
|
3332
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
|
3333
|
+
attr_accessor :common_metadata
|
3334
|
+
|
3335
|
+
def initialize(**args)
|
3336
|
+
update!(**args)
|
3337
|
+
end
|
3338
|
+
|
3339
|
+
# Update properties of this object
|
3340
|
+
def update!(**args)
|
3341
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
3342
|
+
end
|
3343
|
+
end
|
3344
|
+
|
3345
|
+
# Request message for the undeploy processor version method.
|
3346
|
+
class GoogleCloudDocumentaiV1UndeployProcessorVersionRequest
|
3347
|
+
include Google::Apis::Core::Hashable
|
3348
|
+
|
3349
|
+
def initialize(**args)
|
3350
|
+
update!(**args)
|
3351
|
+
end
|
3352
|
+
|
3353
|
+
# Update properties of this object
|
3354
|
+
def update!(**args)
|
3355
|
+
end
|
3356
|
+
end
|
3357
|
+
|
3358
|
+
# Response message for the undeploy processor version method.
|
3359
|
+
class GoogleCloudDocumentaiV1UndeployProcessorVersionResponse
|
3360
|
+
include Google::Apis::Core::Hashable
|
3361
|
+
|
3362
|
+
def initialize(**args)
|
3363
|
+
update!(**args)
|
3364
|
+
end
|
3365
|
+
|
3366
|
+
# Update properties of this object
|
3367
|
+
def update!(**args)
|
3368
|
+
end
|
3369
|
+
end
|
3370
|
+
|
2627
3371
|
# A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
|
2628
3372
|
# in the same scale as the original image.
|
2629
3373
|
class GoogleCloudDocumentaiV1Vertex
|
@@ -6297,6 +7041,57 @@ module Google
|
|
6297
7041
|
end
|
6298
7042
|
end
|
6299
7043
|
|
7044
|
+
# The long running operation metadata for delete processor version method.
|
7045
|
+
class GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata
|
7046
|
+
include Google::Apis::Core::Hashable
|
7047
|
+
|
7048
|
+
# The common metadata for long running operations.
|
7049
|
+
# Corresponds to the JSON property `commonMetadata`
|
7050
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
7051
|
+
attr_accessor :common_metadata
|
7052
|
+
|
7053
|
+
def initialize(**args)
|
7054
|
+
update!(**args)
|
7055
|
+
end
|
7056
|
+
|
7057
|
+
# Update properties of this object
|
7058
|
+
def update!(**args)
|
7059
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
7060
|
+
end
|
7061
|
+
end
|
7062
|
+
|
7063
|
+
# The long running operation metadata for deploy processor version method.
|
7064
|
+
class GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata
|
7065
|
+
include Google::Apis::Core::Hashable
|
7066
|
+
|
7067
|
+
# The common metadata for long running operations.
|
7068
|
+
# Corresponds to the JSON property `commonMetadata`
|
7069
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
7070
|
+
attr_accessor :common_metadata
|
7071
|
+
|
7072
|
+
def initialize(**args)
|
7073
|
+
update!(**args)
|
7074
|
+
end
|
7075
|
+
|
7076
|
+
# Update properties of this object
|
7077
|
+
def update!(**args)
|
7078
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
7079
|
+
end
|
7080
|
+
end
|
7081
|
+
|
7082
|
+
# Response message for the deploy processor version method.
|
7083
|
+
class GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse
|
7084
|
+
include Google::Apis::Core::Hashable
|
7085
|
+
|
7086
|
+
def initialize(**args)
|
7087
|
+
update!(**args)
|
7088
|
+
end
|
7089
|
+
|
7090
|
+
# Update properties of this object
|
7091
|
+
def update!(**args)
|
7092
|
+
end
|
7093
|
+
end
|
7094
|
+
|
6300
7095
|
# The long running operation metadata for disable processor method.
|
6301
7096
|
class GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
|
6302
7097
|
include Google::Apis::Core::Hashable
|
@@ -6460,6 +7255,70 @@ module Google
|
|
6460
7255
|
end
|
6461
7256
|
end
|
6462
7257
|
|
7258
|
+
# The long running operation metadata for set default processor version method.
|
7259
|
+
class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
|
7260
|
+
include Google::Apis::Core::Hashable
|
7261
|
+
|
7262
|
+
# The common metadata for long running operations.
|
7263
|
+
# Corresponds to the JSON property `commonMetadata`
|
7264
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
7265
|
+
attr_accessor :common_metadata
|
7266
|
+
|
7267
|
+
def initialize(**args)
|
7268
|
+
update!(**args)
|
7269
|
+
end
|
7270
|
+
|
7271
|
+
# Update properties of this object
|
7272
|
+
def update!(**args)
|
7273
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
7274
|
+
end
|
7275
|
+
end
|
7276
|
+
|
7277
|
+
# Response message for set default processor version method.
|
7278
|
+
class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse
|
7279
|
+
include Google::Apis::Core::Hashable
|
7280
|
+
|
7281
|
+
def initialize(**args)
|
7282
|
+
update!(**args)
|
7283
|
+
end
|
7284
|
+
|
7285
|
+
# Update properties of this object
|
7286
|
+
def update!(**args)
|
7287
|
+
end
|
7288
|
+
end
|
7289
|
+
|
7290
|
+
# The long running operation metadata for the undeploy processor version method.
|
7291
|
+
class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
|
7292
|
+
include Google::Apis::Core::Hashable
|
7293
|
+
|
7294
|
+
# The common metadata for long running operations.
|
7295
|
+
# Corresponds to the JSON property `commonMetadata`
|
7296
|
+
# @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
|
7297
|
+
attr_accessor :common_metadata
|
7298
|
+
|
7299
|
+
def initialize(**args)
|
7300
|
+
update!(**args)
|
7301
|
+
end
|
7302
|
+
|
7303
|
+
# Update properties of this object
|
7304
|
+
def update!(**args)
|
7305
|
+
@common_metadata = args[:common_metadata] if args.key?(:common_metadata)
|
7306
|
+
end
|
7307
|
+
end
|
7308
|
+
|
7309
|
+
# Response message for the undeploy processor version method.
|
7310
|
+
class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse
|
7311
|
+
include Google::Apis::Core::Hashable
|
7312
|
+
|
7313
|
+
def initialize(**args)
|
7314
|
+
update!(**args)
|
7315
|
+
end
|
7316
|
+
|
7317
|
+
# Update properties of this object
|
7318
|
+
def update!(**args)
|
7319
|
+
end
|
7320
|
+
end
|
7321
|
+
|
6463
7322
|
# The response message for Locations.ListLocations.
|
6464
7323
|
class GoogleCloudLocationListLocationsResponse
|
6465
7324
|
include Google::Apis::Core::Hashable
|