google-apis-documentai_v1 0.13.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
@@ -1471,6 +1600,20 @@ module Google
1471
1600
  class GoogleCloudDocumentaiV1DocumentPageFormField
1472
1601
  include Google::Apis::Core::Hashable
1473
1602
 
1603
+ # Created for Labeling UI to export key text. If corrections were made to the
1604
+ # text identified by the `field_name.text_anchor`, this field will contain the
1605
+ # correction.
1606
+ # Corresponds to the JSON property `correctedKeyText`
1607
+ # @return [String]
1608
+ attr_accessor :corrected_key_text
1609
+
1610
+ # Created for Labeling UI to export value text. If corrections were made to the
1611
+ # text identified by the `field_value.text_anchor`, this field will contain the
1612
+ # correction.
1613
+ # Corresponds to the JSON property `correctedValueText`
1614
+ # @return [String]
1615
+ attr_accessor :corrected_value_text
1616
+
1474
1617
  # Visual element describing a layout unit on a page.
1475
1618
  # Corresponds to the JSON property `fieldName`
1476
1619
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageLayout]
@@ -1510,6 +1653,8 @@ module Google
1510
1653
 
1511
1654
  # Update properties of this object
1512
1655
  def update!(**args)
1656
+ @corrected_key_text = args[:corrected_key_text] if args.key?(:corrected_key_text)
1657
+ @corrected_value_text = args[:corrected_value_text] if args.key?(:corrected_value_text)
1513
1658
  @field_name = args[:field_name] if args.key?(:field_name)
1514
1659
  @field_value = args[:field_value] if args.key?(:field_value)
1515
1660
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
@@ -2322,6 +2467,169 @@ module Google
2322
2467
  end
2323
2468
  end
2324
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
+
2325
2633
  # Specifies a document stored on Cloud Storage.
2326
2634
  class GoogleCloudDocumentaiV1GcsDocument
2327
2635
  include Google::Apis::Core::Hashable
@@ -2419,6 +2727,56 @@ module Google
2419
2727
  end
2420
2728
  end
2421
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
+
2422
2780
  # A vertex represents a 2D point in the image. NOTE: the normalized vertex
2423
2781
  # coordinates are relative to the original image and range from 0 to 1.
2424
2782
  class GoogleCloudDocumentaiV1NormalizedVertex
@@ -2504,8 +2862,208 @@ module Google
2504
2862
 
2505
2863
  # Update properties of this object
2506
2864
  def update!(**args)
2507
- @document = args[:document] if args.key?(:document)
2508
- @human_review_status = args[:human_review_status] if args.key?(:human_review_status)
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: 8.
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
+ # The resource name of the processor type. Format: projects/`project`/
2972
+ # processorTypes/`processor_type`
2973
+ # Corresponds to the JSON property `name`
2974
+ # @return [String]
2975
+ attr_accessor :name
2976
+
2977
+ # The type of the processor, e.g, "invoice_parsing".
2978
+ # Corresponds to the JSON property `type`
2979
+ # @return [String]
2980
+ attr_accessor :type
2981
+
2982
+ def initialize(**args)
2983
+ update!(**args)
2984
+ end
2985
+
2986
+ # Update properties of this object
2987
+ def update!(**args)
2988
+ @allow_creation = args[:allow_creation] if args.key?(:allow_creation)
2989
+ @available_locations = args[:available_locations] if args.key?(:available_locations)
2990
+ @category = args[:category] if args.key?(:category)
2991
+ @name = args[:name] if args.key?(:name)
2992
+ @type = args[:type] if args.key?(:type)
2993
+ end
2994
+ end
2995
+
2996
+ # The location information about where the processor is available.
2997
+ class GoogleCloudDocumentaiV1ProcessorTypeLocationInfo
2998
+ include Google::Apis::Core::Hashable
2999
+
3000
+ # The location id, currently must be one of [us, eu].
3001
+ # Corresponds to the JSON property `locationId`
3002
+ # @return [String]
3003
+ attr_accessor :location_id
3004
+
3005
+ def initialize(**args)
3006
+ update!(**args)
3007
+ end
3008
+
3009
+ # Update properties of this object
3010
+ def update!(**args)
3011
+ @location_id = args[:location_id] if args.key?(:location_id)
3012
+ end
3013
+ end
3014
+
3015
+ # A processor version is an implementation of a processor. Each processor can
3016
+ # have multiple versions, pre-trained by Google internally or up-trained by the
3017
+ # customer. At a time, a processor can only have one default version version. So
3018
+ # the processor's behavior (when processing documents) is defined by a default
3019
+ # version.
3020
+ class GoogleCloudDocumentaiV1ProcessorVersion
3021
+ include Google::Apis::Core::Hashable
3022
+
3023
+ # The time the processor version was created.
3024
+ # Corresponds to the JSON property `createTime`
3025
+ # @return [String]
3026
+ attr_accessor :create_time
3027
+
3028
+ # The display name of the processor version.
3029
+ # Corresponds to the JSON property `displayName`
3030
+ # @return [String]
3031
+ attr_accessor :display_name
3032
+
3033
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
3034
+ # Corresponds to the JSON property `latestEvaluation`
3035
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationReference]
3036
+ attr_accessor :latest_evaluation
3037
+
3038
+ # The resource name of the processor version. Format: projects/`project`/
3039
+ # locations/`location`/processors/`processor`/processorVersions/`
3040
+ # processor_version`
3041
+ # Corresponds to the JSON property `name`
3042
+ # @return [String]
3043
+ attr_accessor :name
3044
+
3045
+ # The schema defines the output of the processed document by a processor.
3046
+ # Corresponds to the JSON property `schema`
3047
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Schema]
3048
+ attr_accessor :schema
3049
+
3050
+ # The state of the processor version.
3051
+ # Corresponds to the JSON property `state`
3052
+ # @return [String]
3053
+ attr_accessor :state
3054
+
3055
+ def initialize(**args)
3056
+ update!(**args)
3057
+ end
3058
+
3059
+ # Update properties of this object
3060
+ def update!(**args)
3061
+ @create_time = args[:create_time] if args.key?(:create_time)
3062
+ @display_name = args[:display_name] if args.key?(:display_name)
3063
+ @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
3064
+ @name = args[:name] if args.key?(:name)
3065
+ @schema = args[:schema] if args.key?(:schema)
3066
+ @state = args[:state] if args.key?(:state)
2509
3067
  end
2510
3068
  end
2511
3069
 
@@ -2608,6 +3166,202 @@ module Google
2608
3166
  end
2609
3167
  end
2610
3168
 
3169
+ # The schema defines the output of the processed document by a processor.
3170
+ class GoogleCloudDocumentaiV1Schema
3171
+ include Google::Apis::Core::Hashable
3172
+
3173
+ # Description of the schema.
3174
+ # Corresponds to the JSON property `description`
3175
+ # @return [String]
3176
+ attr_accessor :description
3177
+
3178
+ # Display name to show to users.
3179
+ # Corresponds to the JSON property `displayName`
3180
+ # @return [String]
3181
+ attr_accessor :display_name
3182
+
3183
+ # Entity types of the schema.
3184
+ # Corresponds to the JSON property `entityTypes`
3185
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1SchemaEntityType>]
3186
+ attr_accessor :entity_types
3187
+
3188
+ def initialize(**args)
3189
+ update!(**args)
3190
+ end
3191
+
3192
+ # Update properties of this object
3193
+ def update!(**args)
3194
+ @description = args[:description] if args.key?(:description)
3195
+ @display_name = args[:display_name] if args.key?(:display_name)
3196
+ @entity_types = args[:entity_types] if args.key?(:entity_types)
3197
+ end
3198
+ end
3199
+
3200
+ # EntityType is the wrapper of a label of the corresponding model with detailed
3201
+ # attributes and limitations for entity-based processors. Multiple types can
3202
+ # also compose a dependency tree to represent nested types.
3203
+ class GoogleCloudDocumentaiV1SchemaEntityType
3204
+ include Google::Apis::Core::Hashable
3205
+
3206
+ # Type of the entity. It must be one of the following: `document` - the entity
3207
+ # represents a classification of a logical document. `object` - if the entity
3208
+ # has properties it is likely an object (or or a document.) `datetime` - the
3209
+ # entity is a date or time value. `money` - the entity represents a money value
3210
+ # amount. `number` - the entity is a number - integer or floating point. `string`
3211
+ # - the entity is a string value. `boolean` - the entity is a boolean value. `
3212
+ # address` - the entity is a location address. `duration` - the entity is a
3213
+ # duration.
3214
+ # Corresponds to the JSON property `baseType`
3215
+ # @return [String]
3216
+ attr_accessor :base_type
3217
+
3218
+ # Description of the entity type.
3219
+ # Corresponds to the JSON property `description`
3220
+ # @return [String]
3221
+ attr_accessor :description
3222
+
3223
+ # If specified, lists all the possible values for this entity.
3224
+ # Corresponds to the JSON property `enumValues`
3225
+ # @return [Array<String>]
3226
+ attr_accessor :enum_values
3227
+
3228
+ # Occurrence type limits the number of times an entity type appears in the
3229
+ # document.
3230
+ # Corresponds to the JSON property `occurrenceType`
3231
+ # @return [String]
3232
+ attr_accessor :occurrence_type
3233
+
3234
+ # Describing the nested structure of an entity. An EntityType may consist of
3235
+ # several other EntityTypes. For example, in a document there can be an
3236
+ # EntityType 'ID', which consists of EntityType 'name' and 'address', with
3237
+ # corresponding attributes, such as TEXT for both types and ONCE for occurrence
3238
+ # types.
3239
+ # Corresponds to the JSON property `properties`
3240
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1SchemaEntityType>]
3241
+ attr_accessor :properties
3242
+
3243
+ # Source of this entity type.
3244
+ # Corresponds to the JSON property `source`
3245
+ # @return [String]
3246
+ attr_accessor :source
3247
+
3248
+ # Name of the type. It must be unique within the set of same level types.
3249
+ # Corresponds to the JSON property `type`
3250
+ # @return [String]
3251
+ attr_accessor :type
3252
+
3253
+ def initialize(**args)
3254
+ update!(**args)
3255
+ end
3256
+
3257
+ # Update properties of this object
3258
+ def update!(**args)
3259
+ @base_type = args[:base_type] if args.key?(:base_type)
3260
+ @description = args[:description] if args.key?(:description)
3261
+ @enum_values = args[:enum_values] if args.key?(:enum_values)
3262
+ @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
3263
+ @properties = args[:properties] if args.key?(:properties)
3264
+ @source = args[:source] if args.key?(:source)
3265
+ @type = args[:type] if args.key?(:type)
3266
+ end
3267
+ end
3268
+
3269
+ # The long running operation metadata for set default processor version method.
3270
+ class GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata
3271
+ include Google::Apis::Core::Hashable
3272
+
3273
+ # The common metadata for long running operations.
3274
+ # Corresponds to the JSON property `commonMetadata`
3275
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
3276
+ attr_accessor :common_metadata
3277
+
3278
+ def initialize(**args)
3279
+ update!(**args)
3280
+ end
3281
+
3282
+ # Update properties of this object
3283
+ def update!(**args)
3284
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
3285
+ end
3286
+ end
3287
+
3288
+ # Request message for the set default processor version method.
3289
+ class GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest
3290
+ include Google::Apis::Core::Hashable
3291
+
3292
+ # Required. The resource name of child ProcessorVersion to use as default.
3293
+ # Corresponds to the JSON property `defaultProcessorVersion`
3294
+ # @return [String]
3295
+ attr_accessor :default_processor_version
3296
+
3297
+ def initialize(**args)
3298
+ update!(**args)
3299
+ end
3300
+
3301
+ # Update properties of this object
3302
+ def update!(**args)
3303
+ @default_processor_version = args[:default_processor_version] if args.key?(:default_processor_version)
3304
+ end
3305
+ end
3306
+
3307
+ # Response message for set default processor version method.
3308
+ class GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse
3309
+ include Google::Apis::Core::Hashable
3310
+
3311
+ def initialize(**args)
3312
+ update!(**args)
3313
+ end
3314
+
3315
+ # Update properties of this object
3316
+ def update!(**args)
3317
+ end
3318
+ end
3319
+
3320
+ # The long running operation metadata for the undeploy processor version method.
3321
+ class GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
3322
+ include Google::Apis::Core::Hashable
3323
+
3324
+ # The common metadata for long running operations.
3325
+ # Corresponds to the JSON property `commonMetadata`
3326
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1CommonOperationMetadata]
3327
+ attr_accessor :common_metadata
3328
+
3329
+ def initialize(**args)
3330
+ update!(**args)
3331
+ end
3332
+
3333
+ # Update properties of this object
3334
+ def update!(**args)
3335
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
3336
+ end
3337
+ end
3338
+
3339
+ # Request message for the undeploy processor version method.
3340
+ class GoogleCloudDocumentaiV1UndeployProcessorVersionRequest
3341
+ include Google::Apis::Core::Hashable
3342
+
3343
+ def initialize(**args)
3344
+ update!(**args)
3345
+ end
3346
+
3347
+ # Update properties of this object
3348
+ def update!(**args)
3349
+ end
3350
+ end
3351
+
3352
+ # Response message for the undeploy processor version method.
3353
+ class GoogleCloudDocumentaiV1UndeployProcessorVersionResponse
3354
+ include Google::Apis::Core::Hashable
3355
+
3356
+ def initialize(**args)
3357
+ update!(**args)
3358
+ end
3359
+
3360
+ # Update properties of this object
3361
+ def update!(**args)
3362
+ end
3363
+ end
3364
+
2611
3365
  # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are
2612
3366
  # in the same scale as the original image.
2613
3367
  class GoogleCloudDocumentaiV1Vertex
@@ -3267,6 +4021,20 @@ module Google
3267
4021
  class GoogleCloudDocumentaiV1beta1DocumentPageFormField
3268
4022
  include Google::Apis::Core::Hashable
3269
4023
 
4024
+ # Created for Labeling UI to export key text. If corrections were made to the
4025
+ # text identified by the `field_name.text_anchor`, this field will contain the
4026
+ # correction.
4027
+ # Corresponds to the JSON property `correctedKeyText`
4028
+ # @return [String]
4029
+ attr_accessor :corrected_key_text
4030
+
4031
+ # Created for Labeling UI to export value text. If corrections were made to the
4032
+ # text identified by the `field_value.text_anchor`, this field will contain the
4033
+ # correction.
4034
+ # Corresponds to the JSON property `correctedValueText`
4035
+ # @return [String]
4036
+ attr_accessor :corrected_value_text
4037
+
3270
4038
  # Visual element describing a layout unit on a page.
3271
4039
  # Corresponds to the JSON property `fieldName`
3272
4040
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentPageLayout]
@@ -3306,6 +4074,8 @@ module Google
3306
4074
 
3307
4075
  # Update properties of this object
3308
4076
  def update!(**args)
4077
+ @corrected_key_text = args[:corrected_key_text] if args.key?(:corrected_key_text)
4078
+ @corrected_value_text = args[:corrected_value_text] if args.key?(:corrected_value_text)
3309
4079
  @field_name = args[:field_name] if args.key?(:field_name)
3310
4080
  @field_value = args[:field_value] if args.key?(:field_value)
3311
4081
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
@@ -5007,6 +5777,20 @@ module Google
5007
5777
  class GoogleCloudDocumentaiV1beta2DocumentPageFormField
5008
5778
  include Google::Apis::Core::Hashable
5009
5779
 
5780
+ # Created for Labeling UI to export key text. If corrections were made to the
5781
+ # text identified by the `field_name.text_anchor`, this field will contain the
5782
+ # correction.
5783
+ # Corresponds to the JSON property `correctedKeyText`
5784
+ # @return [String]
5785
+ attr_accessor :corrected_key_text
5786
+
5787
+ # Created for Labeling UI to export value text. If corrections were made to the
5788
+ # text identified by the `field_value.text_anchor`, this field will contain the
5789
+ # correction.
5790
+ # Corresponds to the JSON property `correctedValueText`
5791
+ # @return [String]
5792
+ attr_accessor :corrected_value_text
5793
+
5010
5794
  # Visual element describing a layout unit on a page.
5011
5795
  # Corresponds to the JSON property `fieldName`
5012
5796
  # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageLayout]
@@ -5046,6 +5830,8 @@ module Google
5046
5830
 
5047
5831
  # Update properties of this object
5048
5832
  def update!(**args)
5833
+ @corrected_key_text = args[:corrected_key_text] if args.key?(:corrected_key_text)
5834
+ @corrected_value_text = args[:corrected_value_text] if args.key?(:corrected_value_text)
5049
5835
  @field_name = args[:field_name] if args.key?(:field_name)
5050
5836
  @field_value = args[:field_value] if args.key?(:field_value)
5051
5837
  @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages)
@@ -6249,6 +7035,57 @@ module Google
6249
7035
  end
6250
7036
  end
6251
7037
 
7038
+ # The long running operation metadata for delete processor version method.
7039
+ class GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata
7040
+ include Google::Apis::Core::Hashable
7041
+
7042
+ # The common metadata for long running operations.
7043
+ # Corresponds to the JSON property `commonMetadata`
7044
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
7045
+ attr_accessor :common_metadata
7046
+
7047
+ def initialize(**args)
7048
+ update!(**args)
7049
+ end
7050
+
7051
+ # Update properties of this object
7052
+ def update!(**args)
7053
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
7054
+ end
7055
+ end
7056
+
7057
+ # The long running operation metadata for deploy processor version method.
7058
+ class GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata
7059
+ include Google::Apis::Core::Hashable
7060
+
7061
+ # The common metadata for long running operations.
7062
+ # Corresponds to the JSON property `commonMetadata`
7063
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
7064
+ attr_accessor :common_metadata
7065
+
7066
+ def initialize(**args)
7067
+ update!(**args)
7068
+ end
7069
+
7070
+ # Update properties of this object
7071
+ def update!(**args)
7072
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
7073
+ end
7074
+ end
7075
+
7076
+ # Response message for the deploy processor version method.
7077
+ class GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse
7078
+ include Google::Apis::Core::Hashable
7079
+
7080
+ def initialize(**args)
7081
+ update!(**args)
7082
+ end
7083
+
7084
+ # Update properties of this object
7085
+ def update!(**args)
7086
+ end
7087
+ end
7088
+
6252
7089
  # The long running operation metadata for disable processor method.
6253
7090
  class GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
6254
7091
  include Google::Apis::Core::Hashable
@@ -6412,6 +7249,70 @@ module Google
6412
7249
  end
6413
7250
  end
6414
7251
 
7252
+ # The long running operation metadata for set default processor version method.
7253
+ class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
7254
+ include Google::Apis::Core::Hashable
7255
+
7256
+ # The common metadata for long running operations.
7257
+ # Corresponds to the JSON property `commonMetadata`
7258
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
7259
+ attr_accessor :common_metadata
7260
+
7261
+ def initialize(**args)
7262
+ update!(**args)
7263
+ end
7264
+
7265
+ # Update properties of this object
7266
+ def update!(**args)
7267
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
7268
+ end
7269
+ end
7270
+
7271
+ # Response message for set default processor version method.
7272
+ class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse
7273
+ include Google::Apis::Core::Hashable
7274
+
7275
+ def initialize(**args)
7276
+ update!(**args)
7277
+ end
7278
+
7279
+ # Update properties of this object
7280
+ def update!(**args)
7281
+ end
7282
+ end
7283
+
7284
+ # The long running operation metadata for the undeploy processor version method.
7285
+ class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
7286
+ include Google::Apis::Core::Hashable
7287
+
7288
+ # The common metadata for long running operations.
7289
+ # Corresponds to the JSON property `commonMetadata`
7290
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta3CommonOperationMetadata]
7291
+ attr_accessor :common_metadata
7292
+
7293
+ def initialize(**args)
7294
+ update!(**args)
7295
+ end
7296
+
7297
+ # Update properties of this object
7298
+ def update!(**args)
7299
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
7300
+ end
7301
+ end
7302
+
7303
+ # Response message for the undeploy processor version method.
7304
+ class GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse
7305
+ include Google::Apis::Core::Hashable
7306
+
7307
+ def initialize(**args)
7308
+ update!(**args)
7309
+ end
7310
+
7311
+ # Update properties of this object
7312
+ def update!(**args)
7313
+ end
7314
+ end
7315
+
6415
7316
  # The response message for Locations.ListLocations.
6416
7317
  class GoogleCloudLocationListLocationsResponse
6417
7318
  include Google::Apis::Core::Hashable