google-apis-documentai_v1beta3 0.26.0 → 0.30.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2cb2ee2bccc701a73e88d16f580b3468a3ecc943131d3a0169008ecd02d0146f
4
- data.tar.gz: 7a527f5e6c253881a61693fcccb8aebc40c81f8a62e40f1f028d11afc8eca353
3
+ metadata.gz: 54881d713ec3072ff77587cb0ad006bedf24609dcd3426ab80f20927af272e99
4
+ data.tar.gz: b72e127a17eef359c96e69b8b6b8490b1050e40abf79f23bb9715d4dd0f83eb3
5
5
  SHA512:
6
- metadata.gz: e6ce11a369ec5db9a310fc9aacbd65e70425642aafd42e9d4c76b4e3346df53035809b283751adbdac5d229bbfc584d823102bd0738ad283d9a8d32e7c499060
7
- data.tar.gz: dc098011c447b76a0fc56452849b23cd14ee2e30753381a4e2850db7075ea7c8f151ff73eb10e388572714c07abde65a9dc61459e44d2ca9c279ca7f57ee456d
6
+ metadata.gz: 4eeb81c79c8ec2f94dce1c20f85235a8af04b0e5b2c5db5cd07c5a3e53a519db31bde7748bd09cb873ccb6ec82c80a58b8c421225c40294d55d07961f135acc2
7
+ data.tar.gz: b335e5b8c50cd9872b28628bada6ebf32c740f3d3c0dd328f3676387a5d1ccebcd616d4f641427a3984ed76be0d78d517a73d9b262e391717877d24d49f946c4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # Release history for google-apis-documentai_v1beta3
2
2
 
3
+ ### v0.30.0 (2022-01-06)
4
+
5
+ * Regenerated from discovery document revision 20211230
6
+ * Unspecified changes
7
+
8
+ ### v0.29.0 (2021-12-07)
9
+
10
+ * Regenerated from discovery document revision 20211203
11
+
12
+ ### v0.28.0 (2021-11-09)
13
+
14
+ * Regenerated from discovery document revision 20211105
15
+
16
+ ### v0.27.0 (2021-10-26)
17
+
18
+ * Regenerated from discovery document revision 20211022
19
+ * Unspecified changes
20
+
3
21
  ### v0.26.0 (2021-10-14)
4
22
 
5
23
  * Regenerated from discovery document revision 20211012
data/OVERVIEW.md CHANGED
@@ -51,7 +51,7 @@ require "google/apis/documentai_v1beta3"
51
51
  client = Google::Apis::DocumentaiV1beta3::DocumentService.new
52
52
 
53
53
  # Authenticate calls
54
- client.authentication = # ... use the googleauth gem to create credentials
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
55
  ```
56
56
 
57
57
  See the class reference docs for information on the methods you can call from a client.
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
60
60
 
61
61
  More detailed descriptions of the Google simple REST clients are available in two documents.
62
62
 
63
- * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
- * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Documentai service in particular.)
67
67
 
@@ -63,6 +63,16 @@ module Google
63
63
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
64
64
  attr_accessor :common_metadata
65
65
 
66
+ # The destination dataset split type.
67
+ # Corresponds to the JSON property `destDatasetType`
68
+ # @return [String]
69
+ attr_accessor :dest_dataset_type
70
+
71
+ # The list of response details of each document.
72
+ # Corresponds to the JSON property `individualBatchMoveStatuses`
73
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus>]
74
+ attr_accessor :individual_batch_move_statuses
75
+
66
76
  def initialize(**args)
67
77
  update!(**args)
68
78
  end
@@ -70,6 +80,38 @@ module Google
70
80
  # Update properties of this object
71
81
  def update!(**args)
72
82
  @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
83
+ @dest_dataset_type = args[:dest_dataset_type] if args.key?(:dest_dataset_type)
84
+ @individual_batch_move_statuses = args[:individual_batch_move_statuses] if args.key?(:individual_batch_move_statuses)
85
+ end
86
+ end
87
+
88
+ # The status of each individual document in the batch move process.
89
+ class GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus
90
+ include Google::Apis::Core::Hashable
91
+
92
+ # Document Identifier.
93
+ # Corresponds to the JSON property `documentId`
94
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId]
95
+ attr_accessor :document_id
96
+
97
+ # The `Status` type defines a logical error model that is suitable for different
98
+ # programming environments, including REST APIs and RPC APIs. It is used by [
99
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
100
+ # data: error code, error message, and error details. You can find out more
101
+ # about this error model and how to work with it in the [API Design Guide](https:
102
+ # //cloud.google.com/apis/design/errors).
103
+ # Corresponds to the JSON property `status`
104
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
105
+ attr_accessor :status
106
+
107
+ def initialize(**args)
108
+ update!(**args)
109
+ end
110
+
111
+ # Update properties of this object
112
+ def update!(**args)
113
+ @document_id = args[:document_id] if args.key?(:document_id)
114
+ @status = args[:status] if args.key?(:status)
73
115
  end
74
116
  end
75
117
 
@@ -95,6 +137,11 @@ module Google
95
137
  # @return [String]
96
138
  attr_accessor :create_time
97
139
 
140
+ # A related resource to this operation.
141
+ # Corresponds to the JSON property `resource`
142
+ # @return [String]
143
+ attr_accessor :resource
144
+
98
145
  # The state of the operation.
99
146
  # Corresponds to the JSON property `state`
100
147
  # @return [String]
@@ -117,6 +164,7 @@ module Google
117
164
  # Update properties of this object
118
165
  def update!(**args)
119
166
  @create_time = args[:create_time] if args.key?(:create_time)
167
+ @resource = args[:resource] if args.key?(:resource)
120
168
  @state = args[:state] if args.key?(:state)
121
169
  @state_message = args[:state_message] if args.key?(:state_message)
122
170
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -264,6 +312,58 @@ module Google
264
312
  end
265
313
  end
266
314
 
315
+ # Document Identifier.
316
+ class GoogleCloudDocumentaiUiv1beta3DocumentId
317
+ include Google::Apis::Core::Hashable
318
+
319
+ # Identifies a document uniquely within the scope of a dataset in the GCS-based
320
+ # option.
321
+ # Corresponds to the JSON property `gcsManagedDocId`
322
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId]
323
+ attr_accessor :gcs_managed_doc_id
324
+
325
+ # The revision reference specifies which revision on the document to read.
326
+ # Corresponds to the JSON property `revisionReference`
327
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3RevisionReference]
328
+ attr_accessor :revision_reference
329
+
330
+ def initialize(**args)
331
+ update!(**args)
332
+ end
333
+
334
+ # Update properties of this object
335
+ def update!(**args)
336
+ @gcs_managed_doc_id = args[:gcs_managed_doc_id] if args.key?(:gcs_managed_doc_id)
337
+ @revision_reference = args[:revision_reference] if args.key?(:revision_reference)
338
+ end
339
+ end
340
+
341
+ # Identifies a document uniquely within the scope of a dataset in the GCS-based
342
+ # option.
343
+ class GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId
344
+ include Google::Apis::Core::Hashable
345
+
346
+ # Optional. Id of the document (indexed) managed by Content Warehouse.
347
+ # Corresponds to the JSON property `cwDocId`
348
+ # @return [String]
349
+ attr_accessor :cw_doc_id
350
+
351
+ # Required. The Cloud Storage uri where the actual document is stored.
352
+ # Corresponds to the JSON property `gcsUri`
353
+ # @return [String]
354
+ attr_accessor :gcs_uri
355
+
356
+ def initialize(**args)
357
+ update!(**args)
358
+ end
359
+
360
+ # Update properties of this object
361
+ def update!(**args)
362
+ @cw_doc_id = args[:cw_doc_id] if args.key?(:cw_doc_id)
363
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
364
+ end
365
+ end
366
+
267
367
  # The long running operation metadata for enable processor method.
268
368
  class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
269
369
  include Google::Apis::Core::Hashable
@@ -382,6 +482,11 @@ module Google
382
482
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
383
483
  attr_accessor :common_metadata
384
484
 
485
+ # The list of response details of each document.
486
+ # Corresponds to the JSON property `individualImportStatuses`
487
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus>]
488
+ attr_accessor :individual_import_statuses
489
+
385
490
  def initialize(**args)
386
491
  update!(**args)
387
492
  end
@@ -389,6 +494,44 @@ module Google
389
494
  # Update properties of this object
390
495
  def update!(**args)
391
496
  @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
497
+ @individual_import_statuses = args[:individual_import_statuses] if args.key?(:individual_import_statuses)
498
+ end
499
+ end
500
+
501
+ # The status of each individual document in the import process.
502
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus
503
+ include Google::Apis::Core::Hashable
504
+
505
+ # The source Cloud Storage URI of the document.
506
+ # Corresponds to the JSON property `inputGcsSource`
507
+ # @return [String]
508
+ attr_accessor :input_gcs_source
509
+
510
+ # The output_gcs_destination of the processed document if it was successful,
511
+ # otherwise empty.
512
+ # Corresponds to the JSON property `outputGcsDestination`
513
+ # @return [String]
514
+ attr_accessor :output_gcs_destination
515
+
516
+ # The `Status` type defines a logical error model that is suitable for different
517
+ # programming environments, including REST APIs and RPC APIs. It is used by [
518
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
519
+ # data: error code, error message, and error details. You can find out more
520
+ # about this error model and how to work with it in the [API Design Guide](https:
521
+ # //cloud.google.com/apis/design/errors).
522
+ # Corresponds to the JSON property `status`
523
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleRpcStatus]
524
+ attr_accessor :status
525
+
526
+ def initialize(**args)
527
+ update!(**args)
528
+ end
529
+
530
+ # Update properties of this object
531
+ def update!(**args)
532
+ @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
533
+ @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination)
534
+ @status = args[:status] if args.key?(:status)
392
535
  end
393
536
  end
394
537
 
@@ -405,6 +548,38 @@ module Google
405
548
  end
406
549
  end
407
550
 
551
+ # The revision reference specifies which revision on the document to read.
552
+ class GoogleCloudDocumentaiUiv1beta3RevisionReference
553
+ include Google::Apis::Core::Hashable
554
+
555
+ # Read the revision generated by the processor version, returns error if it does
556
+ # not exist.
557
+ # Corresponds to the JSON property `latestProcessorVersion`
558
+ # @return [String]
559
+ attr_accessor :latest_processor_version
560
+
561
+ # Read the revision by the predefined case.
562
+ # Corresponds to the JSON property `revisionCase`
563
+ # @return [String]
564
+ attr_accessor :revision_case
565
+
566
+ # Read the revision given by the id, returns error if it does not exist.
567
+ # Corresponds to the JSON property `revisionId`
568
+ # @return [String]
569
+ attr_accessor :revision_id
570
+
571
+ def initialize(**args)
572
+ update!(**args)
573
+ end
574
+
575
+ # Update properties of this object
576
+ def update!(**args)
577
+ @latest_processor_version = args[:latest_processor_version] if args.key?(:latest_processor_version)
578
+ @revision_case = args[:revision_case] if args.key?(:revision_case)
579
+ @revision_id = args[:revision_id] if args.key?(:revision_id)
580
+ end
581
+ end
582
+
408
583
  # The long running operation metadata for set default processor version method.
409
584
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
410
585
  include Google::Apis::Core::Hashable
@@ -681,7 +856,7 @@ module Google
681
856
  # @return [String]
682
857
  attr_accessor :input_gcs_source
683
858
 
684
- # The output_gcs_destination (in the request as 'output_gcs_destination') of the
859
+ # The output_gcs_destination (in the request as `output_gcs_destination`) of the
685
860
  # processed document if it was successful, otherwise empty.
686
861
  # Corresponds to the JSON property `outputGcsDestination`
687
862
  # @return [String]
@@ -732,6 +907,11 @@ module Google
732
907
  # @return [String]
733
908
  attr_accessor :create_time
734
909
 
910
+ # A related resource to this operation.
911
+ # Corresponds to the JSON property `resource`
912
+ # @return [String]
913
+ attr_accessor :resource
914
+
735
915
  # The state of the operation.
736
916
  # Corresponds to the JSON property `state`
737
917
  # @return [String]
@@ -754,6 +934,7 @@ module Google
754
934
  # Update properties of this object
755
935
  def update!(**args)
756
936
  @create_time = args[:create_time] if args.key?(:create_time)
937
+ @resource = args[:resource] if args.key?(:resource)
757
938
  @state = args[:state] if args.key?(:state)
758
939
  @state_message = args[:state_message] if args.key?(:state_message)
759
940
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -1182,7 +1363,7 @@ module Google
1182
1363
  end
1183
1364
  end
1184
1365
 
1185
- # An entity that could be a phrase in the text or a property belongs to the
1366
+ # An entity that could be a phrase in the text or a property that belongs to the
1186
1367
  # document. It is a known entity type, such as a person, an organization, or
1187
1368
  # location.
1188
1369
  class GoogleCloudDocumentaiV1beta1DocumentEntity
@@ -1340,8 +1521,8 @@ module Google
1340
1521
  attr_accessor :money_value
1341
1522
 
1342
1523
  # Optional. An optional field to store a normalized string. For some entity
1343
- # types, one of respective 'structured_value' fields may also be populated. Also
1344
- # not all the types of 'structured_value' will be normalized. For example, some
1524
+ # types, one of respective `structured_value` fields may also be populated. Also
1525
+ # not all the types of `structured_value` will be normalized. For example, some
1345
1526
  # processors may not generate float or int normalized text by default. Below are
1346
1527
  # sample formats mapped to structured values. - Money/Currency type (`
1347
1528
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
@@ -2132,8 +2313,8 @@ module Google
2132
2313
  end
2133
2314
  end
2134
2315
 
2135
- # Structure for referencing parent provenances. When an element replaces one of
2136
- # more other elements parent references identify the elements that are replaced.
2316
+ # The parent element the current element is based on. Used for referencing/
2317
+ # aligning, removal and replacement operations.
2137
2318
  class GoogleCloudDocumentaiV1beta1DocumentProvenanceParent
2138
2319
  include Google::Apis::Core::Hashable
2139
2320
 
@@ -2143,12 +2324,12 @@ module Google
2143
2324
  attr_accessor :id
2144
2325
 
2145
2326
  # The index of the parent item in the corresponding item list (eg. list of
2146
- # entities, properties within entities, etc.) on parent revision.
2327
+ # entities, properties within entities, etc.) in the parent revision.
2147
2328
  # Corresponds to the JSON property `index`
2148
2329
  # @return [Fixnum]
2149
2330
  attr_accessor :index
2150
2331
 
2151
- # The index of the [Document.revisions] identifying the parent revision.
2332
+ # The index of the index into current revision's parent_ids list.
2152
2333
  # Corresponds to the JSON property `revision`
2153
2334
  # @return [Fixnum]
2154
2335
  attr_accessor :revision
@@ -2196,6 +2377,13 @@ module Google
2196
2377
  # @return [Array<Fixnum>]
2197
2378
  attr_accessor :parent
2198
2379
 
2380
+ # The revisions that this revision is based on. Must include all the ids that
2381
+ # have anything to do with this revision - eg. there are `provenance.parent.
2382
+ # revision` fields that index into this field.
2383
+ # Corresponds to the JSON property `parentIds`
2384
+ # @return [Array<String>]
2385
+ attr_accessor :parent_ids
2386
+
2199
2387
  # If the annotation was made by processor identify the processor by its resource
2200
2388
  # name.
2201
2389
  # Corresponds to the JSON property `processor`
@@ -2213,6 +2401,7 @@ module Google
2213
2401
  @human_review = args[:human_review] if args.key?(:human_review)
2214
2402
  @id = args[:id] if args.key?(:id)
2215
2403
  @parent = args[:parent] if args.key?(:parent)
2404
+ @parent_ids = args[:parent_ids] if args.key?(:parent_ids)
2216
2405
  @processor = args[:processor] if args.key?(:processor)
2217
2406
  end
2218
2407
  end
@@ -2901,7 +3090,7 @@ module Google
2901
3090
  end
2902
3091
  end
2903
3092
 
2904
- # An entity that could be a phrase in the text or a property belongs to the
3093
+ # An entity that could be a phrase in the text or a property that belongs to the
2905
3094
  # document. It is a known entity type, such as a person, an organization, or
2906
3095
  # location.
2907
3096
  class GoogleCloudDocumentaiV1beta2DocumentEntity
@@ -3059,8 +3248,8 @@ module Google
3059
3248
  attr_accessor :money_value
3060
3249
 
3061
3250
  # Optional. An optional field to store a normalized string. For some entity
3062
- # types, one of respective 'structured_value' fields may also be populated. Also
3063
- # not all the types of 'structured_value' will be normalized. For example, some
3251
+ # types, one of respective `structured_value` fields may also be populated. Also
3252
+ # not all the types of `structured_value` will be normalized. For example, some
3064
3253
  # processors may not generate float or int normalized text by default. Below are
3065
3254
  # sample formats mapped to structured values. - Money/Currency type (`
3066
3255
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
@@ -3888,8 +4077,8 @@ module Google
3888
4077
  end
3889
4078
  end
3890
4079
 
3891
- # Structure for referencing parent provenances. When an element replaces one of
3892
- # more other elements parent references identify the elements that are replaced.
4080
+ # The parent element the current element is based on. Used for referencing/
4081
+ # aligning, removal and replacement operations.
3893
4082
  class GoogleCloudDocumentaiV1beta2DocumentProvenanceParent
3894
4083
  include Google::Apis::Core::Hashable
3895
4084
 
@@ -3899,12 +4088,12 @@ module Google
3899
4088
  attr_accessor :id
3900
4089
 
3901
4090
  # The index of the parent item in the corresponding item list (eg. list of
3902
- # entities, properties within entities, etc.) on parent revision.
4091
+ # entities, properties within entities, etc.) in the parent revision.
3903
4092
  # Corresponds to the JSON property `index`
3904
4093
  # @return [Fixnum]
3905
4094
  attr_accessor :index
3906
4095
 
3907
- # The index of the [Document.revisions] identifying the parent revision.
4096
+ # The index of the index into current revision's parent_ids list.
3908
4097
  # Corresponds to the JSON property `revision`
3909
4098
  # @return [Fixnum]
3910
4099
  attr_accessor :revision
@@ -3952,6 +4141,13 @@ module Google
3952
4141
  # @return [Array<Fixnum>]
3953
4142
  attr_accessor :parent
3954
4143
 
4144
+ # The revisions that this revision is based on. Must include all the ids that
4145
+ # have anything to do with this revision - eg. there are `provenance.parent.
4146
+ # revision` fields that index into this field.
4147
+ # Corresponds to the JSON property `parentIds`
4148
+ # @return [Array<String>]
4149
+ attr_accessor :parent_ids
4150
+
3955
4151
  # If the annotation was made by processor identify the processor by its resource
3956
4152
  # name.
3957
4153
  # Corresponds to the JSON property `processor`
@@ -3969,6 +4165,7 @@ module Google
3969
4165
  @human_review = args[:human_review] if args.key?(:human_review)
3970
4166
  @id = args[:id] if args.key?(:id)
3971
4167
  @parent = args[:parent] if args.key?(:parent)
4168
+ @parent_ids = args[:parent_ids] if args.key?(:parent_ids)
3972
4169
  @processor = args[:processor] if args.key?(:processor)
3973
4170
  end
3974
4171
  end
@@ -4605,7 +4802,7 @@ module Google
4605
4802
  # @return [String]
4606
4803
  attr_accessor :input_gcs_source
4607
4804
 
4608
- # The output_gcs_destination (in the request as 'output_gcs_destination') of the
4805
+ # The output_gcs_destination (in the request as `output_gcs_destination`) of the
4609
4806
  # processed document if it was successful, otherwise empty.
4610
4807
  # Corresponds to the JSON property `outputGcsDestination`
4611
4808
  # @return [String]
@@ -4774,6 +4971,11 @@ module Google
4774
4971
  # @return [String]
4775
4972
  attr_accessor :create_time
4776
4973
 
4974
+ # A related resource to this operation.
4975
+ # Corresponds to the JSON property `resource`
4976
+ # @return [String]
4977
+ attr_accessor :resource
4978
+
4777
4979
  # The state of the operation.
4778
4980
  # Corresponds to the JSON property `state`
4779
4981
  # @return [String]
@@ -4796,6 +4998,7 @@ module Google
4796
4998
  # Update properties of this object
4797
4999
  def update!(**args)
4798
5000
  @create_time = args[:create_time] if args.key?(:create_time)
5001
+ @resource = args[:resource] if args.key?(:resource)
4799
5002
  @state = args[:state] if args.key?(:state)
4800
5003
  @state_message = args[:state_message] if args.key?(:state_message)
4801
5004
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -5036,7 +5239,7 @@ module Google
5036
5239
  end
5037
5240
  end
5038
5241
 
5039
- # An entity that could be a phrase in the text or a property belongs to the
5242
+ # An entity that could be a phrase in the text or a property that belongs to the
5040
5243
  # document. It is a known entity type, such as a person, an organization, or
5041
5244
  # location.
5042
5245
  class GoogleCloudDocumentaiV1beta3DocumentEntity
@@ -5194,8 +5397,8 @@ module Google
5194
5397
  attr_accessor :money_value
5195
5398
 
5196
5399
  # Optional. An optional field to store a normalized string. For some entity
5197
- # types, one of respective 'structured_value' fields may also be populated. Also
5198
- # not all the types of 'structured_value' will be normalized. For example, some
5400
+ # types, one of respective `structured_value` fields may also be populated. Also
5401
+ # not all the types of `structured_value` will be normalized. For example, some
5199
5402
  # processors may not generate float or int normalized text by default. Below are
5200
5403
  # sample formats mapped to structured values. - Money/Currency type (`
5201
5404
  # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
@@ -6025,8 +6228,8 @@ module Google
6025
6228
  end
6026
6229
  end
6027
6230
 
6028
- # Structure for referencing parent provenances. When an element replaces one of
6029
- # more other elements parent references identify the elements that are replaced.
6231
+ # The parent element the current element is based on. Used for referencing/
6232
+ # aligning, removal and replacement operations.
6030
6233
  class GoogleCloudDocumentaiV1beta3DocumentProvenanceParent
6031
6234
  include Google::Apis::Core::Hashable
6032
6235
 
@@ -6036,12 +6239,12 @@ module Google
6036
6239
  attr_accessor :id
6037
6240
 
6038
6241
  # The index of the parent item in the corresponding item list (eg. list of
6039
- # entities, properties within entities, etc.) on parent revision.
6242
+ # entities, properties within entities, etc.) in the parent revision.
6040
6243
  # Corresponds to the JSON property `index`
6041
6244
  # @return [Fixnum]
6042
6245
  attr_accessor :index
6043
6246
 
6044
- # The index of the [Document.revisions] identifying the parent revision.
6247
+ # The index of the index into current revision's parent_ids list.
6045
6248
  # Corresponds to the JSON property `revision`
6046
6249
  # @return [Fixnum]
6047
6250
  attr_accessor :revision
@@ -6089,6 +6292,13 @@ module Google
6089
6292
  # @return [Array<Fixnum>]
6090
6293
  attr_accessor :parent
6091
6294
 
6295
+ # The revisions that this revision is based on. Must include all the ids that
6296
+ # have anything to do with this revision - eg. there are `provenance.parent.
6297
+ # revision` fields that index into this field.
6298
+ # Corresponds to the JSON property `parentIds`
6299
+ # @return [Array<String>]
6300
+ attr_accessor :parent_ids
6301
+
6092
6302
  # If the annotation was made by processor identify the processor by its resource
6093
6303
  # name.
6094
6304
  # Corresponds to the JSON property `processor`
@@ -6106,6 +6316,7 @@ module Google
6106
6316
  @human_review = args[:human_review] if args.key?(:human_review)
6107
6317
  @id = args[:id] if args.key?(:id)
6108
6318
  @parent = args[:parent] if args.key?(:parent)
6319
+ @parent_ids = args[:parent_ids] if args.key?(:parent_ids)
6109
6320
  @processor = args[:processor] if args.key?(:processor)
6110
6321
  end
6111
6322
  end
@@ -6471,104 +6682,6 @@ module Google
6471
6682
  end
6472
6683
  end
6473
6684
 
6474
- # Evaluation metrics, either in aggregate or about a specific entity.
6475
- class GoogleCloudDocumentaiV1beta3EvaluationMetrics
6476
- include Google::Apis::Core::Hashable
6477
-
6478
- # The calculated f1 score.
6479
- # Corresponds to the JSON property `f1Score`
6480
- # @return [Float]
6481
- attr_accessor :f1_score
6482
-
6483
- # The amount of false negatives.
6484
- # Corresponds to the JSON property `falseNegativesCount`
6485
- # @return [Fixnum]
6486
- attr_accessor :false_negatives_count
6487
-
6488
- # The amount of false positives.
6489
- # Corresponds to the JSON property `falsePositivesCount`
6490
- # @return [Fixnum]
6491
- attr_accessor :false_positives_count
6492
-
6493
- # The amount of occurrences in ground truth documents.
6494
- # Corresponds to the JSON property `groundTruthOccurrencesCount`
6495
- # @return [Fixnum]
6496
- attr_accessor :ground_truth_occurrences_count
6497
-
6498
- # The calculated precision.
6499
- # Corresponds to the JSON property `precision`
6500
- # @return [Float]
6501
- attr_accessor :precision
6502
-
6503
- # The amount of occurrences in predicted documents.
6504
- # Corresponds to the JSON property `predictedOccurrencesCount`
6505
- # @return [Fixnum]
6506
- attr_accessor :predicted_occurrences_count
6507
-
6508
- # The calculated recall.
6509
- # Corresponds to the JSON property `recall`
6510
- # @return [Float]
6511
- attr_accessor :recall
6512
-
6513
- # The amount of documents that had an occurrence of this label.
6514
- # Corresponds to the JSON property `totalDocumentsCount`
6515
- # @return [Fixnum]
6516
- attr_accessor :total_documents_count
6517
-
6518
- # The amount of true positives.
6519
- # Corresponds to the JSON property `truePositivesCount`
6520
- # @return [Fixnum]
6521
- attr_accessor :true_positives_count
6522
-
6523
- def initialize(**args)
6524
- update!(**args)
6525
- end
6526
-
6527
- # Update properties of this object
6528
- def update!(**args)
6529
- @f1_score = args[:f1_score] if args.key?(:f1_score)
6530
- @false_negatives_count = args[:false_negatives_count] if args.key?(:false_negatives_count)
6531
- @false_positives_count = args[:false_positives_count] if args.key?(:false_positives_count)
6532
- @ground_truth_occurrences_count = args[:ground_truth_occurrences_count] if args.key?(:ground_truth_occurrences_count)
6533
- @precision = args[:precision] if args.key?(:precision)
6534
- @predicted_occurrences_count = args[:predicted_occurrences_count] if args.key?(:predicted_occurrences_count)
6535
- @recall = args[:recall] if args.key?(:recall)
6536
- @total_documents_count = args[:total_documents_count] if args.key?(:total_documents_count)
6537
- @true_positives_count = args[:true_positives_count] if args.key?(:true_positives_count)
6538
- end
6539
- end
6540
-
6541
- # Gives a short summary of an evaluation, and links to the evaluation itself.
6542
- class GoogleCloudDocumentaiV1beta3EvaluationReference
6543
- include Google::Apis::Core::Hashable
6544
-
6545
- # Evaluation metrics, either in aggregate or about a specific entity.
6546
- # Corresponds to the JSON property `aggregateMetrics`
6547
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMetrics]
6548
- attr_accessor :aggregate_metrics
6549
-
6550
- # The resource name of the evaluation.
6551
- # Corresponds to the JSON property `evaluation`
6552
- # @return [String]
6553
- attr_accessor :evaluation
6554
-
6555
- # The resource name of the Long Running Operation for the evaluation.
6556
- # Corresponds to the JSON property `operation`
6557
- # @return [String]
6558
- attr_accessor :operation
6559
-
6560
- def initialize(**args)
6561
- update!(**args)
6562
- end
6563
-
6564
- # Update properties of this object
6565
- def update!(**args)
6566
- @aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics)
6567
- @evaluation = args[:evaluation] if args.key?(:evaluation)
6568
- @operation = args[:operation] if args.key?(:operation)
6569
- end
6570
- end
6571
-
6572
6685
  # Response message for fetch processor types.
6573
6686
  class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
6574
6687
  include Google::Apis::Core::Hashable
@@ -6843,7 +6956,7 @@ module Google
6843
6956
  end
6844
6957
  end
6845
6958
 
6846
- # The first-class citizen for DAI. Each processor defines how to extract
6959
+ # The first-class citizen for Document AI. Each processor defines how to extract
6847
6960
  # structural information from a document.
6848
6961
  class GoogleCloudDocumentaiV1beta3Processor
6849
6962
  include Google::Apis::Core::Hashable
@@ -6869,8 +6982,8 @@ module Google
6869
6982
  # @return [String]
6870
6983
  attr_accessor :kms_key_name
6871
6984
 
6872
- # Output only. Immutable. The resource name of the processor. Format: projects/`
6873
- # project`/locations/`location`/processors/`processor`
6985
+ # Output only. Immutable. The resource name of the processor. Format: `projects/`
6986
+ # project`/locations/`location`/processors/`processor``
6874
6987
  # Corresponds to the JSON property `name`
6875
6988
  # @return [String]
6876
6989
  attr_accessor :name
@@ -6909,26 +7022,12 @@ module Google
6909
7022
  end
6910
7023
 
6911
7024
  # A processor type is responsible for performing a certain document
6912
- # understanding task on a certain type of document. All processor types are
6913
- # created by the documentai service internally. User will only list all
6914
- # available processor types via UI. For different users (projects), the
6915
- # available processor types may be different since we'll expose the access of
6916
- # some types via EAP whitelisting. We make the ProcessorType a resource under
6917
- # location so we have a unified API and keep the possibility that UI will load
6918
- # different available processor types from different regions. But for alpha the
6919
- # behavior is that the user will always get the union of all available processor
6920
- # types among all regions no matter which regionalized endpoint is called, and
6921
- # then we use the 'available_locations' field to show under which regions a
6922
- # processor type is available. For example, users can call either the 'US' or '
6923
- # EU' endpoint to feach processor types. In the return, we will have an 'invoice
6924
- # parsing' processor with 'available_locations' field only containing 'US'. So
6925
- # the user can try to create an 'invoice parsing' processor under the location '
6926
- # US'. Such attempt of creating under the location 'EU' will fail. Next ID: 9.
7025
+ # understanding task on a certain type of document.
6927
7026
  class GoogleCloudDocumentaiV1beta3ProcessorType
6928
7027
  include Google::Apis::Core::Hashable
6929
7028
 
6930
- # Whether the processor type allows creation. If yes, user can create a
6931
- # processor of this processor type. Otherwise, user needs to request access.
7029
+ # Whether the processor type allows creation. If true, users can create a
7030
+ # processor of this processor type. Otherwise, users need to request access.
6932
7031
  # Corresponds to the JSON property `allowCreation`
6933
7032
  # @return [Boolean]
6934
7033
  attr_accessor :allow_creation
@@ -7012,23 +7111,13 @@ module Google
7012
7111
  # @return [String]
7013
7112
  attr_accessor :display_name
7014
7113
 
7015
- # Gives a short summary of an evaluation, and links to the evaluation itself.
7016
- # Corresponds to the JSON property `latestEvaluation`
7017
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationReference]
7018
- attr_accessor :latest_evaluation
7019
-
7020
- # The resource name of the processor version. Format: projects/`project`/
7114
+ # The resource name of the processor version. Format: `projects/`project`/
7021
7115
  # locations/`location`/processors/`processor`/processorVersions/`
7022
- # processor_version`
7116
+ # processor_version``
7023
7117
  # Corresponds to the JSON property `name`
7024
7118
  # @return [String]
7025
7119
  attr_accessor :name
7026
7120
 
7027
- # The schema defines the output of the processed document by a processor.
7028
- # Corresponds to the JSON property `schema`
7029
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema]
7030
- attr_accessor :schema
7031
-
7032
7121
  # The state of the processor version.
7033
7122
  # Corresponds to the JSON property `state`
7034
7123
  # @return [String]
@@ -7042,9 +7131,7 @@ module Google
7042
7131
  def update!(**args)
7043
7132
  @create_time = args[:create_time] if args.key?(:create_time)
7044
7133
  @display_name = args[:display_name] if args.key?(:display_name)
7045
- @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
7046
7134
  @name = args[:name] if args.key?(:name)
7047
- @schema = args[:schema] if args.key?(:schema)
7048
7135
  @state = args[:state] if args.key?(:state)
7049
7136
  end
7050
7137
  end
@@ -7119,7 +7206,7 @@ module Google
7119
7206
  end
7120
7207
  end
7121
7208
 
7122
- # Request message for review document method. Next Id: 6.
7209
+ # Request message for review document method.
7123
7210
  class GoogleCloudDocumentaiV1beta3ReviewDocumentRequest
7124
7211
  include Google::Apis::Core::Hashable
7125
7212
 
@@ -7182,118 +7269,6 @@ module Google
7182
7269
  end
7183
7270
  end
7184
7271
 
7185
- # The schema defines the output of the processed document by a processor.
7186
- class GoogleCloudDocumentaiV1beta3Schema
7187
- include Google::Apis::Core::Hashable
7188
-
7189
- # Description of the schema.
7190
- # Corresponds to the JSON property `description`
7191
- # @return [String]
7192
- attr_accessor :description
7193
-
7194
- # Display name to show to users.
7195
- # Corresponds to the JSON property `displayName`
7196
- # @return [String]
7197
- attr_accessor :display_name
7198
-
7199
- # Entity types of the schema.
7200
- # Corresponds to the JSON property `entityTypes`
7201
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]
7202
- attr_accessor :entity_types
7203
-
7204
- def initialize(**args)
7205
- update!(**args)
7206
- end
7207
-
7208
- # Update properties of this object
7209
- def update!(**args)
7210
- @description = args[:description] if args.key?(:description)
7211
- @display_name = args[:display_name] if args.key?(:display_name)
7212
- @entity_types = args[:entity_types] if args.key?(:entity_types)
7213
- end
7214
- end
7215
-
7216
- # EntityType is the wrapper of a label of the corresponding model with detailed
7217
- # attributes and limitations for entity-based processors. Multiple types can
7218
- # also compose a dependency tree to represent nested types.
7219
- class GoogleCloudDocumentaiV1beta3SchemaEntityType
7220
- include Google::Apis::Core::Hashable
7221
-
7222
- # Type of the entity. It must be one of the following: `document` - the entity
7223
- # represents a classification of a logical document. `object` - if the entity
7224
- # has properties it is likely an object (or or a document.) `datetime` - the
7225
- # entity is a date or time value. `money` - the entity represents a money value
7226
- # amount. `number` - the entity is a number - integer or floating point. `string`
7227
- # - the entity is a string value. `boolean` - the entity is a boolean value. `
7228
- # address` - the entity is a location address. `duration` - the entity is a
7229
- # duration.
7230
- # Corresponds to the JSON property `baseType`
7231
- # @return [String]
7232
- attr_accessor :base_type
7233
-
7234
- # Description of the entity type.
7235
- # Corresponds to the JSON property `description`
7236
- # @return [String]
7237
- attr_accessor :description
7238
-
7239
- # If specified, lists all the possible values for this entity.
7240
- # Corresponds to the JSON property `enumValues`
7241
- # @return [Array<String>]
7242
- attr_accessor :enum_values
7243
-
7244
- # Occurrence type limits the number of times an entity type appears in the
7245
- # document.
7246
- # Corresponds to the JSON property `occurrenceType`
7247
- # @return [String]
7248
- attr_accessor :occurrence_type
7249
-
7250
- # Describing the nested structure of an entity. An EntityType may consist of
7251
- # several other EntityTypes. For example, in a document there can be an
7252
- # EntityType 'ID', which consists of EntityType 'name' and 'address', with
7253
- # corresponding attributes, such as TEXT for both types and ONCE for occurrence
7254
- # types.
7255
- # Corresponds to the JSON property `properties`
7256
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType>]
7257
- attr_accessor :properties
7258
-
7259
- # Source of this entity type.
7260
- # Corresponds to the JSON property `source`
7261
- # @return [String]
7262
- attr_accessor :source
7263
-
7264
- # Name of the type. It must satisfy the following constraints: 1. Must be unique
7265
- # within the set of same level types (with case-insensitive match). 2. Maximum
7266
- # 50 characters. 3. Must start with a letter. 4. Allowed characters: ASCII
7267
- # letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation
7268
- # characters: * underscore '_' (recommended) * hyphen '-' (allowed, not
7269
- # recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace
7270
- # characters are not allowed. 5. Cannot end with a punctuation character. 6.
7271
- # Cannot contain the following restricted strings: "google", "DocumentAI" (case-
7272
- # insensitive match). 7. A slash character '/' is reserved as a separator in
7273
- # flattened representations of nested entity types (e.g., "line_item/amount") in
7274
- # which case each part (e.g., "line_item", "amount") must comply with the rules
7275
- # defined above. We recommend using the snake case ("snake_case") in entity type
7276
- # names.
7277
- # Corresponds to the JSON property `type`
7278
- # @return [String]
7279
- attr_accessor :type
7280
-
7281
- def initialize(**args)
7282
- update!(**args)
7283
- end
7284
-
7285
- # Update properties of this object
7286
- def update!(**args)
7287
- @base_type = args[:base_type] if args.key?(:base_type)
7288
- @description = args[:description] if args.key?(:description)
7289
- @enum_values = args[:enum_values] if args.key?(:enum_values)
7290
- @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
7291
- @properties = args[:properties] if args.key?(:properties)
7292
- @source = args[:source] if args.key?(:source)
7293
- @type = args[:type] if args.key?(:type)
7294
- end
7295
- end
7296
-
7297
7272
  # The long running operation metadata for set default processor version method.
7298
7273
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
7299
7274
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DocumentaiV1beta3
18
18
  # Version of the google-apis-documentai_v1beta3 gem
19
- GEM_VERSION = "0.26.0"
19
+ GEM_VERSION = "0.30.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211012"
25
+ REVISION = "20211230"
26
26
  end
27
27
  end
28
28
  end
@@ -40,6 +40,12 @@ module Google
40
40
  include Google::Apis::Core::JsonObjectSupport
41
41
  end
42
42
 
43
+ class GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
43
49
  class GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse
44
50
  class Representation < Google::Apis::Core::JsonRepresentation; end
45
51
 
@@ -100,6 +106,18 @@ module Google
100
106
  include Google::Apis::Core::JsonObjectSupport
101
107
  end
102
108
 
109
+ class GoogleCloudDocumentaiUiv1beta3DocumentId
110
+ class Representation < Google::Apis::Core::JsonRepresentation; end
111
+
112
+ include Google::Apis::Core::JsonObjectSupport
113
+ end
114
+
115
+ class GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId
116
+ class Representation < Google::Apis::Core::JsonRepresentation; end
117
+
118
+ include Google::Apis::Core::JsonObjectSupport
119
+ end
120
+
103
121
  class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
104
122
  class Representation < Google::Apis::Core::JsonRepresentation; end
105
123
 
@@ -142,12 +160,24 @@ module Google
142
160
  include Google::Apis::Core::JsonObjectSupport
143
161
  end
144
162
 
163
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
145
169
  class GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse
146
170
  class Representation < Google::Apis::Core::JsonRepresentation; end
147
171
 
148
172
  include Google::Apis::Core::JsonObjectSupport
149
173
  end
150
174
 
175
+ class GoogleCloudDocumentaiUiv1beta3RevisionReference
176
+ class Representation < Google::Apis::Core::JsonRepresentation; end
177
+
178
+ include Google::Apis::Core::JsonObjectSupport
179
+ end
180
+
151
181
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
152
182
  class Representation < Google::Apis::Core::JsonRepresentation; end
153
183
 
@@ -1156,18 +1186,6 @@ module Google
1156
1186
  include Google::Apis::Core::JsonObjectSupport
1157
1187
  end
1158
1188
 
1159
- class GoogleCloudDocumentaiV1beta3EvaluationMetrics
1160
- class Representation < Google::Apis::Core::JsonRepresentation; end
1161
-
1162
- include Google::Apis::Core::JsonObjectSupport
1163
- end
1164
-
1165
- class GoogleCloudDocumentaiV1beta3EvaluationReference
1166
- class Representation < Google::Apis::Core::JsonRepresentation; end
1167
-
1168
- include Google::Apis::Core::JsonObjectSupport
1169
- end
1170
-
1171
1189
  class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
1172
1190
  class Representation < Google::Apis::Core::JsonRepresentation; end
1173
1191
 
@@ -1276,18 +1294,6 @@ module Google
1276
1294
  include Google::Apis::Core::JsonObjectSupport
1277
1295
  end
1278
1296
 
1279
- class GoogleCloudDocumentaiV1beta3Schema
1280
- class Representation < Google::Apis::Core::JsonRepresentation; end
1281
-
1282
- include Google::Apis::Core::JsonObjectSupport
1283
- end
1284
-
1285
- class GoogleCloudDocumentaiV1beta3SchemaEntityType
1286
- class Representation < Google::Apis::Core::JsonRepresentation; end
1287
-
1288
- include Google::Apis::Core::JsonObjectSupport
1289
- end
1290
-
1291
1297
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
1292
1298
  class Representation < Google::Apis::Core::JsonRepresentation; end
1293
1299
 
@@ -1421,6 +1427,19 @@ module Google
1421
1427
  class Representation < Google::Apis::Core::JsonRepresentation
1422
1428
  property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation
1423
1429
 
1430
+ property :dest_dataset_type, as: 'destDatasetType'
1431
+ collection :individual_batch_move_statuses, as: 'individualBatchMoveStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus::Representation
1432
+
1433
+ end
1434
+ end
1435
+
1436
+ class GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus
1437
+ # @private
1438
+ class Representation < Google::Apis::Core::JsonRepresentation
1439
+ property :document_id, as: 'documentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentId::Representation
1440
+
1441
+ property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
1442
+
1424
1443
  end
1425
1444
  end
1426
1445
 
@@ -1434,6 +1453,7 @@ module Google
1434
1453
  # @private
1435
1454
  class Representation < Google::Apis::Core::JsonRepresentation
1436
1455
  property :create_time, as: 'createTime'
1456
+ property :resource, as: 'resource'
1437
1457
  property :state, as: 'state'
1438
1458
  property :state_message, as: 'stateMessage'
1439
1459
  property :update_time, as: 'updateTime'
@@ -1500,6 +1520,24 @@ module Google
1500
1520
  end
1501
1521
  end
1502
1522
 
1523
+ class GoogleCloudDocumentaiUiv1beta3DocumentId
1524
+ # @private
1525
+ class Representation < Google::Apis::Core::JsonRepresentation
1526
+ property :gcs_managed_doc_id, as: 'gcsManagedDocId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId::Representation
1527
+
1528
+ property :revision_reference, as: 'revisionReference', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3RevisionReference, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3RevisionReference::Representation
1529
+
1530
+ end
1531
+ end
1532
+
1533
+ class GoogleCloudDocumentaiUiv1beta3DocumentIdGcsManagedDocumentId
1534
+ # @private
1535
+ class Representation < Google::Apis::Core::JsonRepresentation
1536
+ property :cw_doc_id, as: 'cwDocId'
1537
+ property :gcs_uri, as: 'gcsUri'
1538
+ end
1539
+ end
1540
+
1503
1541
  class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
1504
1542
  # @private
1505
1543
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1549,6 +1587,18 @@ module Google
1549
1587
  class Representation < Google::Apis::Core::JsonRepresentation
1550
1588
  property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation
1551
1589
 
1590
+ collection :individual_import_statuses, as: 'individualImportStatuses', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus::Representation
1591
+
1592
+ end
1593
+ end
1594
+
1595
+ class GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus
1596
+ # @private
1597
+ class Representation < Google::Apis::Core::JsonRepresentation
1598
+ property :input_gcs_source, as: 'inputGcsSource'
1599
+ property :output_gcs_destination, as: 'outputGcsDestination'
1600
+ property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
1601
+
1552
1602
  end
1553
1603
  end
1554
1604
 
@@ -1558,6 +1608,15 @@ module Google
1558
1608
  end
1559
1609
  end
1560
1610
 
1611
+ class GoogleCloudDocumentaiUiv1beta3RevisionReference
1612
+ # @private
1613
+ class Representation < Google::Apis::Core::JsonRepresentation
1614
+ property :latest_processor_version, as: 'latestProcessorVersion'
1615
+ property :revision_case, as: 'revisionCase'
1616
+ property :revision_id, as: 'revisionId'
1617
+ end
1618
+ end
1619
+
1561
1620
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
1562
1621
  # @private
1563
1622
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1675,6 +1734,7 @@ module Google
1675
1734
  # @private
1676
1735
  class Representation < Google::Apis::Core::JsonRepresentation
1677
1736
  property :create_time, as: 'createTime'
1737
+ property :resource, as: 'resource'
1678
1738
  property :state, as: 'state'
1679
1739
  property :state_message, as: 'stateMessage'
1680
1740
  property :update_time, as: 'updateTime'
@@ -2136,6 +2196,7 @@ module Google
2136
2196
 
2137
2197
  property :id, as: 'id'
2138
2198
  collection :parent, as: 'parent'
2199
+ collection :parent_ids, as: 'parentIds'
2139
2200
  property :processor, as: 'processor'
2140
2201
  end
2141
2202
  end
@@ -2634,6 +2695,7 @@ module Google
2634
2695
 
2635
2696
  property :id, as: 'id'
2636
2697
  collection :parent, as: 'parent'
2698
+ collection :parent_ids, as: 'parentIds'
2637
2699
  property :processor, as: 'processor'
2638
2700
  end
2639
2701
  end
@@ -2862,6 +2924,7 @@ module Google
2862
2924
  # @private
2863
2925
  class Representation < Google::Apis::Core::JsonRepresentation
2864
2926
  property :create_time, as: 'createTime'
2927
+ property :resource, as: 'resource'
2865
2928
  property :state, as: 'state'
2866
2929
  property :state_message, as: 'stateMessage'
2867
2930
  property :update_time, as: 'updateTime'
@@ -3266,6 +3329,7 @@ module Google
3266
3329
 
3267
3330
  property :id, as: 'id'
3268
3331
  collection :parent, as: 'parent'
3332
+ collection :parent_ids, as: 'parentIds'
3269
3333
  property :processor, as: 'processor'
3270
3334
  end
3271
3335
  end
@@ -3360,31 +3424,6 @@ module Google
3360
3424
  end
3361
3425
  end
3362
3426
 
3363
- class GoogleCloudDocumentaiV1beta3EvaluationMetrics
3364
- # @private
3365
- class Representation < Google::Apis::Core::JsonRepresentation
3366
- property :f1_score, as: 'f1Score'
3367
- property :false_negatives_count, as: 'falseNegativesCount'
3368
- property :false_positives_count, as: 'falsePositivesCount'
3369
- property :ground_truth_occurrences_count, as: 'groundTruthOccurrencesCount'
3370
- property :precision, as: 'precision'
3371
- property :predicted_occurrences_count, as: 'predictedOccurrencesCount'
3372
- property :recall, as: 'recall'
3373
- property :total_documents_count, as: 'totalDocumentsCount'
3374
- property :true_positives_count, as: 'truePositivesCount'
3375
- end
3376
- end
3377
-
3378
- class GoogleCloudDocumentaiV1beta3EvaluationReference
3379
- # @private
3380
- class Representation < Google::Apis::Core::JsonRepresentation
3381
- property :aggregate_metrics, as: 'aggregateMetrics', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMetrics, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationMetrics::Representation
3382
-
3383
- property :evaluation, as: 'evaluation'
3384
- property :operation, as: 'operation'
3385
- end
3386
- end
3387
-
3388
3427
  class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
3389
3428
  # @private
3390
3429
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3514,11 +3553,7 @@ module Google
3514
3553
  class Representation < Google::Apis::Core::JsonRepresentation
3515
3554
  property :create_time, as: 'createTime'
3516
3555
  property :display_name, as: 'displayName'
3517
- property :latest_evaluation, as: 'latestEvaluation', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationReference, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluationReference::Representation
3518
-
3519
3556
  property :name, as: 'name'
3520
- property :schema, as: 'schema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema::Representation
3521
-
3522
3557
  property :state, as: 'state'
3523
3558
  end
3524
3559
  end
@@ -3562,30 +3597,6 @@ module Google
3562
3597
  end
3563
3598
  end
3564
3599
 
3565
- class GoogleCloudDocumentaiV1beta3Schema
3566
- # @private
3567
- class Representation < Google::Apis::Core::JsonRepresentation
3568
- property :description, as: 'description'
3569
- property :display_name, as: 'displayName'
3570
- collection :entity_types, as: 'entityTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType::Representation
3571
-
3572
- end
3573
- end
3574
-
3575
- class GoogleCloudDocumentaiV1beta3SchemaEntityType
3576
- # @private
3577
- class Representation < Google::Apis::Core::JsonRepresentation
3578
- property :base_type, as: 'baseType'
3579
- property :description, as: 'description'
3580
- collection :enum_values, as: 'enumValues'
3581
- property :occurrence_type, as: 'occurrenceType'
3582
- collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType::Representation
3583
-
3584
- property :source, as: 'source'
3585
- property :type, as: 'type'
3586
- end
3587
- end
3588
-
3589
3600
  class GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
3590
3601
  # @private
3591
3602
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -51,11 +51,12 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
- # Fetches processor types.
54
+ # Fetches processor types. Note that we do not use ListProcessorTypes here
55
+ # because it is not paginated.
55
56
  # @param [String] parent
56
57
  # Required. The project of processor type to list. The available processor types
57
- # may depend on the whitelisting on projects. Format: projects/`project`/
58
- # locations/`location`
58
+ # may depend on the allow-listing on projects. Format: `projects/`project`/
59
+ # locations/`location``
59
60
  # @param [String] fields
60
61
  # Selector specifying which fields to include in a partial response.
61
62
  # @param [String] quota_user
@@ -273,10 +274,10 @@ module Google
273
274
  # LRO endpoint to batch process many documents. The output is written to Cloud
274
275
  # Storage as JSON in the [Document] format.
275
276
  # @param [String] name
276
- # Required. The resource name of Processor or ProcessorVersion. Format: projects/
277
- # `project`/locations/`location`/processors/`processor`, or projects/`project`/
278
- # locations/`location`/processors/`processor`/processorVersions/`
279
- # processorVersion`
277
+ # Required. The resource name of Processor or ProcessorVersion. Format: `
278
+ # projects/`project`/locations/`location`/processors/`processor``, or `projects/`
279
+ # project`/locations/`location`/processors/`processor`/processorVersions/`
280
+ # processorVersion``
280
281
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest] google_cloud_documentai_v1beta3_batch_process_request_object
281
282
  # @param [String] fields
282
283
  # Selector specifying which fields to include in a partial response.
@@ -311,7 +312,7 @@ module Google
311
312
  # will be at "ENABLED" state by default after its creation.
312
313
  # @param [String] parent
313
314
  # Required. The parent (project and location) under which to create the
314
- # processor. Format: projects/`project`/locations/`location`
315
+ # processor. Format: `projects/`project`/locations/`location``
315
316
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] google_cloud_documentai_v1beta3_processor_object
316
317
  # @param [String] fields
317
318
  # Selector specifying which fields to include in a partial response.
@@ -472,7 +473,7 @@ module Google
472
473
  # Lists all processors which belong to this project.
473
474
  # @param [String] parent
474
475
  # Required. The parent (project and location) which owns this collection of
475
- # Processors. Format: projects/`project`/locations/`location`
476
+ # Processors. Format: `projects/`project`/locations/`location``
476
477
  # @param [Fixnum] page_size
477
478
  # The maximum number of processors to return. If unspecified, at most 50
478
479
  # processors will be returned. The maximum value is 100; values above 100 will
@@ -513,9 +514,9 @@ module Google
513
514
  # @param [String] name
514
515
  # Required. The resource name of the Processor or ProcessorVersion to use for
515
516
  # processing. If a Processor is specified, the server will use its default
516
- # version. Format: projects/`project`/locations/`location`/processors/`processor`
517
- # , or projects/`project`/locations/`location`/processors/`processor`/
518
- # processorVersions/`processorVersion`
517
+ # version. Format: `projects/`project`/locations/`location`/processors/`
518
+ # processor``, or `projects/`project`/locations/`location`/processors/`processor`
519
+ # /processorVersions/`processorVersion``
519
520
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest] google_cloud_documentai_v1beta3_process_request_object
520
521
  # @param [String] fields
521
522
  # Selector specifying which fields to include in a partial response.
@@ -618,10 +619,10 @@ module Google
618
619
  # LRO endpoint to batch process many documents. The output is written to Cloud
619
620
  # Storage as JSON in the [Document] format.
620
621
  # @param [String] name
621
- # Required. The resource name of Processor or ProcessorVersion. Format: projects/
622
- # `project`/locations/`location`/processors/`processor`, or projects/`project`/
623
- # locations/`location`/processors/`processor`/processorVersions/`
624
- # processorVersion`
622
+ # Required. The resource name of Processor or ProcessorVersion. Format: `
623
+ # projects/`project`/locations/`location`/processors/`processor``, or `projects/`
624
+ # project`/locations/`location`/processors/`processor`/processorVersions/`
625
+ # processorVersion``
625
626
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest] google_cloud_documentai_v1beta3_batch_process_request_object
626
627
  # @param [String] fields
627
628
  # Selector specifying which fields to include in a partial response.
@@ -749,7 +750,7 @@ module Google
749
750
  # Lists all versions of a processor.
750
751
  # @param [String] parent
751
752
  # Required. The parent (project, location and processor) to list all versions.
752
- # Format: projects/`project`/locations/`location`/processors/`processor`
753
+ # Format: `projects/`project`/locations/`location`/processors/`processor``
753
754
  # @param [Fixnum] page_size
754
755
  # The maximum number of processor versions to return. If unspecified, at most 10
755
756
  # processor versions will be returned. The maximum value is 20; values above 20
@@ -790,9 +791,9 @@ module Google
790
791
  # @param [String] name
791
792
  # Required. The resource name of the Processor or ProcessorVersion to use for
792
793
  # processing. If a Processor is specified, the server will use its default
793
- # version. Format: projects/`project`/locations/`location`/processors/`processor`
794
- # , or projects/`project`/locations/`location`/processors/`processor`/
795
- # processorVersions/`processorVersion`
794
+ # version. Format: `projects/`project`/locations/`location`/processors/`
795
+ # processor``, or `projects/`project`/locations/`location`/processors/`processor`
796
+ # /processorVersions/`processorVersion``
796
797
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest] google_cloud_documentai_v1beta3_process_request_object
797
798
  # @param [String] fields
798
799
  # Selector specifying which fields to include in a partial response.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-documentai_v1beta3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.26.0
4
+ version: 0.30.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: 2021-10-18 00:00:00.000000000 Z
11
+ date: 2022-01-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-documentai_v1beta3/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.26.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-documentai_v1beta3
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1beta3/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.30.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1beta3
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths:
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.4
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Cloud Document AI API V1beta3