google-apis-documentai_v1 0.39.0 → 0.40.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d1af260fcaeb07534ec1c40a85b1cd1b1cbc06ec39535bf7054dde3d87b6900d
4
- data.tar.gz: 6c7f6d7c237afc4386ea8a4c129c196714aadf52c842e6211124a8734a55e9fc
3
+ metadata.gz: be5ececd02b9f9dbf25b6739dce0ef884a496b1c081f3541cbf18e6d0f05aad3
4
+ data.tar.gz: 14667b36b7607697b7d8bb6b93f44aaa11f84ad9382d6bfcbb82ae08d472ea51
5
5
  SHA512:
6
- metadata.gz: 92f4199dcaea22eb3ea406ffb8ebff62205c89d84725222ee55d1d6399a61489e7846eb995bbc2574e688bdcecd698586499e49b7438afb5eda8f661f1731da7
7
- data.tar.gz: 88804bb6dc8254f0945105bbde2e9fe025e487ad21272c4cf38ecc06a894c24816018899944953872fc38b3ca468a9199f3dfaf72c75cf848580dfd9a6b9c36c
6
+ metadata.gz: 4c786b71ffc0c31a5d60514b9e820518a6a1156fca8e4e74ff00b29a6fc9b3cbaedc1554b9b4da1446f088504458df1a11336f65703ce84768f4902b738fd93f
7
+ data.tar.gz: 72f71f559ffca11f184be335b54360e782a5b24d34446e752696df69a8eefba0668f0862674dfe5065b84c9f31ff5db583dd89761f11e89f8281cda0c0f34bb8
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-documentai_v1
2
2
 
3
+ ### v0.40.0 (2022-06-18)
4
+
5
+ * Regenerated using generator version 0.7.0
6
+ * Regenerated from discovery document revision 20220610
7
+
3
8
  ### v0.39.0 (2022-06-08)
4
9
 
5
10
  * Regenerated from discovery document revision 20220602
@@ -2546,6 +2546,177 @@ module Google
2546
2546
  end
2547
2547
  end
2548
2548
 
2549
+ # The schema defines the output of the processed document by a processor.
2550
+ class GoogleCloudDocumentaiV1DocumentSchema
2551
+ include Google::Apis::Core::Hashable
2552
+
2553
+ # Description of the schema.
2554
+ # Corresponds to the JSON property `description`
2555
+ # @return [String]
2556
+ attr_accessor :description
2557
+
2558
+ # Display name to show to users.
2559
+ # Corresponds to the JSON property `displayName`
2560
+ # @return [String]
2561
+ attr_accessor :display_name
2562
+
2563
+ # Entity types of the schema.
2564
+ # Corresponds to the JSON property `entityTypes`
2565
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityType>]
2566
+ attr_accessor :entity_types
2567
+
2568
+ # Metadata for global schema behavior.
2569
+ # Corresponds to the JSON property `metadata`
2570
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaMetadata]
2571
+ attr_accessor :metadata
2572
+
2573
+ def initialize(**args)
2574
+ update!(**args)
2575
+ end
2576
+
2577
+ # Update properties of this object
2578
+ def update!(**args)
2579
+ @description = args[:description] if args.key?(:description)
2580
+ @display_name = args[:display_name] if args.key?(:display_name)
2581
+ @entity_types = args[:entity_types] if args.key?(:entity_types)
2582
+ @metadata = args[:metadata] if args.key?(:metadata)
2583
+ end
2584
+ end
2585
+
2586
+ # EntityType is the wrapper of a label of the corresponding model with detailed
2587
+ # attributes and limitations for entity-based processors. Multiple types can
2588
+ # also compose a dependency tree to represent nested types.
2589
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityType
2590
+ include Google::Apis::Core::Hashable
2591
+
2592
+ # The entity type that this type is derived from. For now, one and only one
2593
+ # should be set.
2594
+ # Corresponds to the JSON property `baseTypes`
2595
+ # @return [Array<String>]
2596
+ attr_accessor :base_types
2597
+
2598
+ # User defined name for the type.
2599
+ # Corresponds to the JSON property `displayName`
2600
+ # @return [String]
2601
+ attr_accessor :display_name
2602
+
2603
+ # Defines the a list of enum values.
2604
+ # Corresponds to the JSON property `enumValues`
2605
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues]
2606
+ attr_accessor :enum_values
2607
+
2608
+ # Name of the type. It must be unique within the schema file and cannot be a '
2609
+ # Common Type'. Besides that we use the following naming conventions: - *use
2610
+ # snake_casing* - name matching is case-insensitive - Maximum 64 characters. -
2611
+ # Must start with a letter. - Allowed characters: ASCII letters [a-z0-9_-]. (For
2612
+ # backward compatibility internal infrastructure and tooling can handle any
2613
+ # ascii character) - The '/' is sometimes used to denote a property of a type.
2614
+ # For example line_item/amount. This convention is deprecated, but will still be
2615
+ # honored for backward compatibility.
2616
+ # Corresponds to the JSON property `name`
2617
+ # @return [String]
2618
+ attr_accessor :name
2619
+
2620
+ # Describing the nested structure, or composition of an entity.
2621
+ # Corresponds to the JSON property `properties`
2622
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty>]
2623
+ attr_accessor :properties
2624
+
2625
+ def initialize(**args)
2626
+ update!(**args)
2627
+ end
2628
+
2629
+ # Update properties of this object
2630
+ def update!(**args)
2631
+ @base_types = args[:base_types] if args.key?(:base_types)
2632
+ @display_name = args[:display_name] if args.key?(:display_name)
2633
+ @enum_values = args[:enum_values] if args.key?(:enum_values)
2634
+ @name = args[:name] if args.key?(:name)
2635
+ @properties = args[:properties] if args.key?(:properties)
2636
+ end
2637
+ end
2638
+
2639
+ # Defines the a list of enum values.
2640
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues
2641
+ include Google::Apis::Core::Hashable
2642
+
2643
+ # The individual values that this enum values type can include.
2644
+ # Corresponds to the JSON property `values`
2645
+ # @return [Array<String>]
2646
+ attr_accessor :values
2647
+
2648
+ def initialize(**args)
2649
+ update!(**args)
2650
+ end
2651
+
2652
+ # Update properties of this object
2653
+ def update!(**args)
2654
+ @values = args[:values] if args.key?(:values)
2655
+ end
2656
+ end
2657
+
2658
+ # Defines properties that can be part of the entity type.
2659
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty
2660
+ include Google::Apis::Core::Hashable
2661
+
2662
+ # The name of the property. Follows the same guidelines as the EntityType name.
2663
+ # Corresponds to the JSON property `name`
2664
+ # @return [String]
2665
+ attr_accessor :name
2666
+
2667
+ # Occurrence type limits the number of instances an entity type appears in the
2668
+ # document.
2669
+ # Corresponds to the JSON property `occurrenceType`
2670
+ # @return [String]
2671
+ attr_accessor :occurrence_type
2672
+
2673
+ # A reference to the value type of the property. This type is subject to the
2674
+ # same conventions as the `Entity.base_types` field.
2675
+ # Corresponds to the JSON property `valueType`
2676
+ # @return [String]
2677
+ attr_accessor :value_type
2678
+
2679
+ def initialize(**args)
2680
+ update!(**args)
2681
+ end
2682
+
2683
+ # Update properties of this object
2684
+ def update!(**args)
2685
+ @name = args[:name] if args.key?(:name)
2686
+ @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
2687
+ @value_type = args[:value_type] if args.key?(:value_type)
2688
+ end
2689
+ end
2690
+
2691
+ # Metadata for global schema behavior.
2692
+ class GoogleCloudDocumentaiV1DocumentSchemaMetadata
2693
+ include Google::Apis::Core::Hashable
2694
+
2695
+ # If true, on a given page, there can be multiple `document` annotations
2696
+ # covering it.
2697
+ # Corresponds to the JSON property `documentAllowMultipleLabels`
2698
+ # @return [Boolean]
2699
+ attr_accessor :document_allow_multiple_labels
2700
+ alias_method :document_allow_multiple_labels?, :document_allow_multiple_labels
2701
+
2702
+ # If true, a `document` entity type can be applied to subdocument ( splitting).
2703
+ # Otherwise, it can only be applied to the entire document (classification).
2704
+ # Corresponds to the JSON property `documentSplitter`
2705
+ # @return [Boolean]
2706
+ attr_accessor :document_splitter
2707
+ alias_method :document_splitter?, :document_splitter
2708
+
2709
+ def initialize(**args)
2710
+ update!(**args)
2711
+ end
2712
+
2713
+ # Update properties of this object
2714
+ def update!(**args)
2715
+ @document_allow_multiple_labels = args[:document_allow_multiple_labels] if args.key?(:document_allow_multiple_labels)
2716
+ @document_splitter = args[:document_splitter] if args.key?(:document_splitter)
2717
+ end
2718
+ end
2719
+
2549
2720
  # For a large document, sharding may be performed to produce several document
2550
2721
  # shards. Each document shard contains this field to detail which shard it is.
2551
2722
  class GoogleCloudDocumentaiV1DocumentShardInfo
@@ -3429,6 +3600,11 @@ module Google
3429
3600
  class GoogleCloudDocumentaiV1ReviewDocumentRequest
3430
3601
  include Google::Apis::Core::Hashable
3431
3602
 
3603
+ # The schema defines the output of the processed document by a processor.
3604
+ # Corresponds to the JSON property `documentSchema`
3605
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema]
3606
+ attr_accessor :document_schema
3607
+
3432
3608
  # Whether the validation should be performed on the ad-hoc review request.
3433
3609
  # Corresponds to the JSON property `enableSchemaValidation`
3434
3610
  # @return [Boolean]
@@ -3454,6 +3630,7 @@ module Google
3454
3630
 
3455
3631
  # Update properties of this object
3456
3632
  def update!(**args)
3633
+ @document_schema = args[:document_schema] if args.key?(:document_schema)
3457
3634
  @enable_schema_validation = args[:enable_schema_validation] if args.key?(:enable_schema_validation)
3458
3635
  @inline_document = args[:inline_document] if args.key?(:inline_document)
3459
3636
  @priority = args[:priority] if args.key?(:priority)
@@ -3464,11 +3641,22 @@ module Google
3464
3641
  class GoogleCloudDocumentaiV1ReviewDocumentResponse
3465
3642
  include Google::Apis::Core::Hashable
3466
3643
 
3467
- # The Cloud Storage uri for the human reviewed document.
3644
+ # The Cloud Storage uri for the human reviewed document if the review is
3645
+ # succeeded.
3468
3646
  # Corresponds to the JSON property `gcsDestination`
3469
3647
  # @return [String]
3470
3648
  attr_accessor :gcs_destination
3471
3649
 
3650
+ # The reason why the review is rejected by reviewer.
3651
+ # Corresponds to the JSON property `rejectionReason`
3652
+ # @return [String]
3653
+ attr_accessor :rejection_reason
3654
+
3655
+ # The state of the review operation.
3656
+ # Corresponds to the JSON property `state`
3657
+ # @return [String]
3658
+ attr_accessor :state
3659
+
3472
3660
  def initialize(**args)
3473
3661
  update!(**args)
3474
3662
  end
@@ -3476,6 +3664,8 @@ module Google
3476
3664
  # Update properties of this object
3477
3665
  def update!(**args)
3478
3666
  @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
3667
+ @rejection_reason = args[:rejection_reason] if args.key?(:rejection_reason)
3668
+ @state = args[:state] if args.key?(:state)
3479
3669
  end
3480
3670
  end
3481
3671
 
@@ -7621,11 +7811,22 @@ module Google
7621
7811
  class GoogleCloudDocumentaiV1beta3ReviewDocumentResponse
7622
7812
  include Google::Apis::Core::Hashable
7623
7813
 
7624
- # The Cloud Storage uri for the human reviewed document.
7814
+ # The Cloud Storage uri for the human reviewed document if the review is
7815
+ # succeeded.
7625
7816
  # Corresponds to the JSON property `gcsDestination`
7626
7817
  # @return [String]
7627
7818
  attr_accessor :gcs_destination
7628
7819
 
7820
+ # The reason why the review is rejected by reviewer.
7821
+ # Corresponds to the JSON property `rejectionReason`
7822
+ # @return [String]
7823
+ attr_accessor :rejection_reason
7824
+
7825
+ # The state of the review operation.
7826
+ # Corresponds to the JSON property `state`
7827
+ # @return [String]
7828
+ attr_accessor :state
7829
+
7629
7830
  def initialize(**args)
7630
7831
  update!(**args)
7631
7832
  end
@@ -7633,6 +7834,8 @@ module Google
7633
7834
  # Update properties of this object
7634
7835
  def update!(**args)
7635
7836
  @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
7837
+ @rejection_reason = args[:rejection_reason] if args.key?(:rejection_reason)
7838
+ @state = args[:state] if args.key?(:state)
7636
7839
  end
7637
7840
  end
7638
7841
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DocumentaiV1
18
18
  # Version of the google-apis-documentai_v1 gem
19
- GEM_VERSION = "0.39.0"
19
+ GEM_VERSION = "0.40.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.5.0"
22
+ GENERATOR_VERSION = "0.7.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220602"
25
+ REVISION = "20220610"
26
26
  end
27
27
  end
28
28
  end
@@ -532,6 +532,36 @@ module Google
532
532
  include Google::Apis::Core::JsonObjectSupport
533
533
  end
534
534
 
535
+ class GoogleCloudDocumentaiV1DocumentSchema
536
+ class Representation < Google::Apis::Core::JsonRepresentation; end
537
+
538
+ include Google::Apis::Core::JsonObjectSupport
539
+ end
540
+
541
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityType
542
+ class Representation < Google::Apis::Core::JsonRepresentation; end
543
+
544
+ include Google::Apis::Core::JsonObjectSupport
545
+ end
546
+
547
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues
548
+ class Representation < Google::Apis::Core::JsonRepresentation; end
549
+
550
+ include Google::Apis::Core::JsonObjectSupport
551
+ end
552
+
553
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty
554
+ class Representation < Google::Apis::Core::JsonRepresentation; end
555
+
556
+ include Google::Apis::Core::JsonObjectSupport
557
+ end
558
+
559
+ class GoogleCloudDocumentaiV1DocumentSchemaMetadata
560
+ class Representation < Google::Apis::Core::JsonRepresentation; end
561
+
562
+ include Google::Apis::Core::JsonObjectSupport
563
+ end
564
+
535
565
  class GoogleCloudDocumentaiV1DocumentShardInfo
536
566
  class Representation < Google::Apis::Core::JsonRepresentation; end
537
567
 
@@ -2297,6 +2327,55 @@ module Google
2297
2327
  end
2298
2328
  end
2299
2329
 
2330
+ class GoogleCloudDocumentaiV1DocumentSchema
2331
+ # @private
2332
+ class Representation < Google::Apis::Core::JsonRepresentation
2333
+ property :description, as: 'description'
2334
+ property :display_name, as: 'displayName'
2335
+ collection :entity_types, as: 'entityTypes', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityType, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityType::Representation
2336
+
2337
+ property :metadata, as: 'metadata', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaMetadata, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaMetadata::Representation
2338
+
2339
+ end
2340
+ end
2341
+
2342
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityType
2343
+ # @private
2344
+ class Representation < Google::Apis::Core::JsonRepresentation
2345
+ collection :base_types, as: 'baseTypes'
2346
+ property :display_name, as: 'displayName'
2347
+ property :enum_values, as: 'enumValues', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues::Representation
2348
+
2349
+ property :name, as: 'name'
2350
+ collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty::Representation
2351
+
2352
+ end
2353
+ end
2354
+
2355
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues
2356
+ # @private
2357
+ class Representation < Google::Apis::Core::JsonRepresentation
2358
+ collection :values, as: 'values'
2359
+ end
2360
+ end
2361
+
2362
+ class GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty
2363
+ # @private
2364
+ class Representation < Google::Apis::Core::JsonRepresentation
2365
+ property :name, as: 'name'
2366
+ property :occurrence_type, as: 'occurrenceType'
2367
+ property :value_type, as: 'valueType'
2368
+ end
2369
+ end
2370
+
2371
+ class GoogleCloudDocumentaiV1DocumentSchemaMetadata
2372
+ # @private
2373
+ class Representation < Google::Apis::Core::JsonRepresentation
2374
+ property :document_allow_multiple_labels, as: 'documentAllowMultipleLabels'
2375
+ property :document_splitter, as: 'documentSplitter'
2376
+ end
2377
+ end
2378
+
2300
2379
  class GoogleCloudDocumentaiV1DocumentShardInfo
2301
2380
  # @private
2302
2381
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2544,6 +2623,8 @@ module Google
2544
2623
  class GoogleCloudDocumentaiV1ReviewDocumentRequest
2545
2624
  # @private
2546
2625
  class Representation < Google::Apis::Core::JsonRepresentation
2626
+ property :document_schema, as: 'documentSchema', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentSchema::Representation
2627
+
2547
2628
  property :enable_schema_validation, as: 'enableSchemaValidation'
2548
2629
  property :inline_document, as: 'inlineDocument', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Document, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Document::Representation
2549
2630
 
@@ -2555,6 +2636,8 @@ module Google
2555
2636
  # @private
2556
2637
  class Representation < Google::Apis::Core::JsonRepresentation
2557
2638
  property :gcs_destination, as: 'gcsDestination'
2639
+ property :rejection_reason, as: 'rejectionReason'
2640
+ property :state, as: 'state'
2558
2641
  end
2559
2642
  end
2560
2643
 
@@ -3766,6 +3849,8 @@ module Google
3766
3849
  # @private
3767
3850
  class Representation < Google::Apis::Core::JsonRepresentation
3768
3851
  property :gcs_destination, as: 'gcsDestination'
3852
+ property :rejection_reason, as: 'rejectionReason'
3853
+ property :state, as: 'state'
3769
3854
  end
3770
3855
  end
3771
3856
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-documentai_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.39.0
4
+ version: 0.40.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-06-13 00:00:00.000000000 Z
11
+ date: 2022-06-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.5'
19
+ version: '0.6'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.5'
29
+ version: '0.6'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.39.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.40.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1
63
63
  post_install_message:
64
64
  rdoc_options: []