google-apis-documentai_v1 0.106.0 → 0.107.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: c7736499869682612ac557b18990351c6836093641d1ee98857845879832b23a
4
- data.tar.gz: 94879d8bc79d9ddc5239ce3f8cf40442d6a65691c680cab0be9348d6ef9928a7
3
+ metadata.gz: 114cb23334db386a8d9b8f058c00b628415bf212301a6db8f4f0cb4107d3b109
4
+ data.tar.gz: 87cafb551095ea367ab01be43b8a3938d8bdff512af07073f468d8a9b78f726e
5
5
  SHA512:
6
- metadata.gz: b149e3dd514bc0f30451a87365461f9b98a7215df942532db059e26dc2c1952bc359fbf3b4ee65e6c355c1653e10e7c8d8c99a5f5d0ca66592d145679385eebd
7
- data.tar.gz: 790ce233dd050c84245abe5fc503d7da9bb0d95e73397678b392da3081c7be44e32825c79c3d519f0d178edbf09dc7a376e3410f5dd67ab3116f392561ad5ca3
6
+ metadata.gz: 01b67200b55af144214df422e4960cd066e03800d83d99e7b4244dc0917707cd129681ab1200d916c42638bba1481ee69fc6a12ecc8fa91f5fa5c24933d32bd6
7
+ data.tar.gz: a46f048434516e41de60940f115a9a17b57bd65a30df4bca2de6e16f29b64d04622ac965df2d88ab1910914cb2f2c8d3c753d3b4ecaae7c3859b8629a6004763
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-documentai_v1
2
2
 
3
+ ### v0.107.0 (2025-10-19)
4
+
5
+ * Regenerated from discovery document revision 20251013
6
+
3
7
  ### v0.106.0 (2025-10-05)
4
8
 
5
9
  * Regenerated from discovery document revision 20250929
@@ -2191,11 +2191,32 @@ module Google
2191
2191
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity>]
2192
2192
  attr_accessor :entities
2193
2193
 
2194
+ # The entity revision id that `document.entities` field is based on. If this
2195
+ # field is set and `entities_revisions` is not empty, the entities in `document.
2196
+ # entities` field are the entities in the entity revision with this id and `
2197
+ # document.entity_validation_output` field is the `entity_validation_output`
2198
+ # field in this entity revision.
2199
+ # Corresponds to the JSON property `entitiesRevisionId`
2200
+ # @return [String]
2201
+ attr_accessor :entities_revision_id
2202
+
2203
+ # A list of entity revisions. The entity revisions are appended to the document
2204
+ # in the processing order. This field can be used for comparing the entity
2205
+ # extraction results at different stages of the processing.
2206
+ # Corresponds to the JSON property `entitiesRevisions`
2207
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntitiesRevision>]
2208
+ attr_accessor :entities_revisions
2209
+
2194
2210
  # Placeholder. Relationship among Document.entities.
2195
2211
  # Corresponds to the JSON property `entityRelations`
2196
2212
  # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityRelation>]
2197
2213
  attr_accessor :entity_relations
2198
2214
 
2215
+ # The output of the validation given the document and the validation rules.
2216
+ # Corresponds to the JSON property `entityValidationOutput`
2217
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutput]
2218
+ attr_accessor :entity_validation_output
2219
+
2199
2220
  # The `Status` type defines a logical error model that is suitable for different
2200
2221
  # programming environments, including REST APIs and RPC APIs. It is used by [
2201
2222
  # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
@@ -2264,7 +2285,10 @@ module Google
2264
2285
  @docid = args[:docid] if args.key?(:docid)
2265
2286
  @document_layout = args[:document_layout] if args.key?(:document_layout)
2266
2287
  @entities = args[:entities] if args.key?(:entities)
2288
+ @entities_revision_id = args[:entities_revision_id] if args.key?(:entities_revision_id)
2289
+ @entities_revisions = args[:entities_revisions] if args.key?(:entities_revisions)
2267
2290
  @entity_relations = args[:entity_relations] if args.key?(:entity_relations)
2291
+ @entity_validation_output = args[:entity_validation_output] if args.key?(:entity_validation_output)
2268
2292
  @error = args[:error] if args.key?(:error)
2269
2293
  @mime_type = args[:mime_type] if args.key?(:mime_type)
2270
2294
  @pages = args[:pages] if args.key?(:pages)
@@ -2677,6 +2701,37 @@ module Google
2677
2701
  end
2678
2702
  end
2679
2703
 
2704
+ # Entity revision.
2705
+ class GoogleCloudDocumentaiV1DocumentEntitiesRevision
2706
+ include Google::Apis::Core::Hashable
2707
+
2708
+ # The entities in this revision.
2709
+ # Corresponds to the JSON property `entities`
2710
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity>]
2711
+ attr_accessor :entities
2712
+
2713
+ # The output of the validation given the document and the validation rules.
2714
+ # Corresponds to the JSON property `entityValidationOutput`
2715
+ # @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutput]
2716
+ attr_accessor :entity_validation_output
2717
+
2718
+ # The revision id.
2719
+ # Corresponds to the JSON property `revisionId`
2720
+ # @return [String]
2721
+ attr_accessor :revision_id
2722
+
2723
+ def initialize(**args)
2724
+ update!(**args)
2725
+ end
2726
+
2727
+ # Update properties of this object
2728
+ def update!(**args)
2729
+ @entities = args[:entities] if args.key?(:entities)
2730
+ @entity_validation_output = args[:entity_validation_output] if args.key?(:entity_validation_output)
2731
+ @revision_id = args[:revision_id] if args.key?(:revision_id)
2732
+ end
2733
+ end
2734
+
2680
2735
  # An entity that could be a phrase in the text or a property that belongs to the
2681
2736
  # document. It is a known entity type, such as a person, an organization, or
2682
2737
  # location.
@@ -2840,7 +2895,8 @@ module Google
2840
2895
  # @return [Google::Apis::DocumentaiV1::GoogleTypeMoney]
2841
2896
  attr_accessor :money_value
2842
2897
 
2843
- #
2898
+ # A signature - a graphical representation of a person's name, often used to
2899
+ # sign a document.
2844
2900
  # Corresponds to the JSON property `signatureValue`
2845
2901
  # @return [Boolean]
2846
2902
  attr_accessor :signature_value
@@ -2907,6 +2963,70 @@ module Google
2907
2963
  end
2908
2964
  end
2909
2965
 
2966
+ # The output of the validation given the document and the validation rules.
2967
+ class GoogleCloudDocumentaiV1DocumentEntityValidationOutput
2968
+ include Google::Apis::Core::Hashable
2969
+
2970
+ # The overall result of the validation, true if all applicable rules are valid.
2971
+ # Corresponds to the JSON property `passAllRules`
2972
+ # @return [Boolean]
2973
+ attr_accessor :pass_all_rules
2974
+ alias_method :pass_all_rules?, :pass_all_rules
2975
+
2976
+ # The result of each validation rule.
2977
+ # Corresponds to the JSON property `validationResults`
2978
+ # @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult>]
2979
+ attr_accessor :validation_results
2980
+
2981
+ def initialize(**args)
2982
+ update!(**args)
2983
+ end
2984
+
2985
+ # Update properties of this object
2986
+ def update!(**args)
2987
+ @pass_all_rules = args[:pass_all_rules] if args.key?(:pass_all_rules)
2988
+ @validation_results = args[:validation_results] if args.key?(:validation_results)
2989
+ end
2990
+ end
2991
+
2992
+ # Validation result for a single validation rule.
2993
+ class GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult
2994
+ include Google::Apis::Core::Hashable
2995
+
2996
+ # The description of the validation rule.
2997
+ # Corresponds to the JSON property `ruleDescription`
2998
+ # @return [String]
2999
+ attr_accessor :rule_description
3000
+
3001
+ # The name of the validation rule.
3002
+ # Corresponds to the JSON property `ruleName`
3003
+ # @return [String]
3004
+ attr_accessor :rule_name
3005
+
3006
+ # The detailed information of the running the validation process using the
3007
+ # entity from the document based on the validation rule.
3008
+ # Corresponds to the JSON property `validationDetails`
3009
+ # @return [String]
3010
+ attr_accessor :validation_details
3011
+
3012
+ # The result of the validation rule.
3013
+ # Corresponds to the JSON property `validationResultType`
3014
+ # @return [String]
3015
+ attr_accessor :validation_result_type
3016
+
3017
+ def initialize(**args)
3018
+ update!(**args)
3019
+ end
3020
+
3021
+ # Update properties of this object
3022
+ def update!(**args)
3023
+ @rule_description = args[:rule_description] if args.key?(:rule_description)
3024
+ @rule_name = args[:rule_name] if args.key?(:rule_name)
3025
+ @validation_details = args[:validation_details] if args.key?(:validation_details)
3026
+ @validation_result_type = args[:validation_result_type] if args.key?(:validation_result_type)
3027
+ end
3028
+ end
3029
+
2910
3030
  # Config that controls the output of documents. All documents will be written as
2911
3031
  # a JSON file.
2912
3032
  class GoogleCloudDocumentaiV1DocumentOutputConfig
@@ -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.106.0"
19
+ GEM_VERSION = "0.107.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250929"
25
+ REVISION = "20251013"
26
26
  end
27
27
  end
28
28
  end
@@ -622,6 +622,12 @@ module Google
622
622
  include Google::Apis::Core::JsonObjectSupport
623
623
  end
624
624
 
625
+ class GoogleCloudDocumentaiV1DocumentEntitiesRevision
626
+ class Representation < Google::Apis::Core::JsonRepresentation; end
627
+
628
+ include Google::Apis::Core::JsonObjectSupport
629
+ end
630
+
625
631
  class GoogleCloudDocumentaiV1DocumentEntity
626
632
  class Representation < Google::Apis::Core::JsonRepresentation; end
627
633
 
@@ -640,6 +646,18 @@ module Google
640
646
  include Google::Apis::Core::JsonObjectSupport
641
647
  end
642
648
 
649
+ class GoogleCloudDocumentaiV1DocumentEntityValidationOutput
650
+ class Representation < Google::Apis::Core::JsonRepresentation; end
651
+
652
+ include Google::Apis::Core::JsonObjectSupport
653
+ end
654
+
655
+ class GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult
656
+ class Representation < Google::Apis::Core::JsonRepresentation; end
657
+
658
+ include Google::Apis::Core::JsonObjectSupport
659
+ end
660
+
643
661
  class GoogleCloudDocumentaiV1DocumentOutputConfig
644
662
  class Representation < Google::Apis::Core::JsonRepresentation; end
645
663
 
@@ -2336,8 +2354,13 @@ module Google
2336
2354
 
2337
2355
  collection :entities, as: 'entities', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity::Representation
2338
2356
 
2357
+ property :entities_revision_id, as: 'entitiesRevisionId'
2358
+ collection :entities_revisions, as: 'entitiesRevisions', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntitiesRevision, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntitiesRevision::Representation
2359
+
2339
2360
  collection :entity_relations, as: 'entityRelations', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityRelation, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityRelation::Representation
2340
2361
 
2362
+ property :entity_validation_output, as: 'entityValidationOutput', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutput, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutput::Representation
2363
+
2341
2364
  property :error, as: 'error', class: Google::Apis::DocumentaiV1::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1::GoogleRpcStatus::Representation
2342
2365
 
2343
2366
  property :mime_type, as: 'mimeType'
@@ -2494,6 +2517,17 @@ module Google
2494
2517
  end
2495
2518
  end
2496
2519
 
2520
+ class GoogleCloudDocumentaiV1DocumentEntitiesRevision
2521
+ # @private
2522
+ class Representation < Google::Apis::Core::JsonRepresentation
2523
+ collection :entities, as: 'entities', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity::Representation
2524
+
2525
+ property :entity_validation_output, as: 'entityValidationOutput', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutput, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutput::Representation
2526
+
2527
+ property :revision_id, as: 'revisionId'
2528
+ end
2529
+ end
2530
+
2497
2531
  class GoogleCloudDocumentaiV1DocumentEntity
2498
2532
  # @private
2499
2533
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2545,6 +2579,25 @@ module Google
2545
2579
  end
2546
2580
  end
2547
2581
 
2582
+ class GoogleCloudDocumentaiV1DocumentEntityValidationOutput
2583
+ # @private
2584
+ class Representation < Google::Apis::Core::JsonRepresentation
2585
+ property :pass_all_rules, as: 'passAllRules'
2586
+ collection :validation_results, as: 'validationResults', class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult, decorator: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult::Representation
2587
+
2588
+ end
2589
+ end
2590
+
2591
+ class GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult
2592
+ # @private
2593
+ class Representation < Google::Apis::Core::JsonRepresentation
2594
+ property :rule_description, as: 'ruleDescription'
2595
+ property :rule_name, as: 'ruleName'
2596
+ property :validation_details, as: 'validationDetails'
2597
+ property :validation_result_type, as: 'validationResultType'
2598
+ end
2599
+ end
2600
+
2548
2601
  class GoogleCloudDocumentaiV1DocumentOutputConfig
2549
2602
  # @private
2550
2603
  class Representation < Google::Apis::Core::JsonRepresentation
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-documentai_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.106.0
4
+ version: 0.107.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.106.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.107.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1
62
62
  rdoc_options: []
63
63
  require_paths: