google-apis-documentai_v1beta3 0.1.0 → 0.2.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: d732f134d760f46cf704df59bd073d93c73c401eb4d6148b092f581aab9d188f
4
- data.tar.gz: ef0f01e6e3ccb6925414e5ff90520ccb3529a98630bb884e258d94173156aefa
3
+ metadata.gz: 96667553bcc60c6fe33341950d8320ae8290e2093fab44ffb3aae076830c6670
4
+ data.tar.gz: 8f08c0f4930b7ce280794ac2ac515e82b439ba22026da28169c02a522abb224b
5
5
  SHA512:
6
- metadata.gz: ffe18d676e0a45ccffb502e4fe957d4c3b88792d3080baed00ac1309b6263d1c2014a1d6d11653dd6226167d8495ff2bca80041c53557cb66271ff62991f96a3
7
- data.tar.gz: 6350dcede72de51037530ed8465c94b600ff27dcc77a7ce04d3c86c264248fe835e1b0eb1dcd6f77df0f1dc590146353107a212a5e3a3475ec98981f02cdd617
6
+ metadata.gz: eee70d1cd8310e5f66fa2a1046c4a91b2953f8c72e33008bc717a2bb886f4b010fd4329c27d3206af020799c984c42331c5bb0e09565e160564aea049fcd19ad
7
+ data.tar.gz: 67bf56b920820e484d4d01b953bdbce1fee8ff118db58231de15af6d8c73b524482ee4a58597536a2c838390fb1a894c69f567b643035d68fb6f10b6a5b944f8
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-documentai_v1beta3
2
2
 
3
+ ### v0.2.0 (2021-02-03)
4
+
5
+ * Regenerated from discovery document revision 20210201
6
+ * Regenerated using generator version 0.1.2
7
+
3
8
  ### v0.1.0 (2021-01-07)
4
9
 
5
10
  * Regenerated from discovery document revision 20201231
@@ -233,6 +233,189 @@ module Google
233
233
  end
234
234
  end
235
235
 
236
+ # Metadata of the EvaluateProcessorVersion method.
237
+ class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata
238
+ include Google::Apis::Core::Hashable
239
+
240
+ # The common metadata for long running operations.
241
+ # Corresponds to the JSON property `commonMetadata`
242
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
243
+ attr_accessor :common_metadata
244
+
245
+ def initialize(**args)
246
+ update!(**args)
247
+ end
248
+
249
+ # Update properties of this object
250
+ def update!(**args)
251
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
252
+ end
253
+ end
254
+
255
+ # Metadata of the EvaluateProcessorVersion method.
256
+ class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
257
+ include Google::Apis::Core::Hashable
258
+
259
+ # An evaluation of a ProcessorVersion's performance.
260
+ # Corresponds to the JSON property `evaluation`
261
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Evaluation]
262
+ attr_accessor :evaluation
263
+
264
+ def initialize(**args)
265
+ update!(**args)
266
+ end
267
+
268
+ # Update properties of this object
269
+ def update!(**args)
270
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
271
+ end
272
+ end
273
+
274
+ # An evaluation of a ProcessorVersion's performance.
275
+ class GoogleCloudDocumentaiUiv1beta3Evaluation
276
+ include Google::Apis::Core::Hashable
277
+
278
+ # Metrics across multiple confidence levels.
279
+ # Corresponds to the JSON property `allEntitiesMetrics`
280
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics]
281
+ attr_accessor :all_entities_metrics
282
+
283
+ # The time that the evaluation was created.
284
+ # Corresponds to the JSON property `createTime`
285
+ # @return [String]
286
+ attr_accessor :create_time
287
+
288
+ # Metrics across confidence levels, for different entities.
289
+ # Corresponds to the JSON property `entityMetrics`
290
+ # @return [Hash<String,Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics>]
291
+ attr_accessor :entity_metrics
292
+
293
+ # The resource name of the evaluation. Format: projects/`project`/locations/`
294
+ # location`/processors/`processor`/processorVersions/`processor_version`/
295
+ # evaluations/`evaluation`
296
+ # Corresponds to the JSON property `name`
297
+ # @return [String]
298
+ attr_accessor :name
299
+
300
+ def initialize(**args)
301
+ update!(**args)
302
+ end
303
+
304
+ # Update properties of this object
305
+ def update!(**args)
306
+ @all_entities_metrics = args[:all_entities_metrics] if args.key?(:all_entities_metrics)
307
+ @create_time = args[:create_time] if args.key?(:create_time)
308
+ @entity_metrics = args[:entity_metrics] if args.key?(:entity_metrics)
309
+ @name = args[:name] if args.key?(:name)
310
+ end
311
+ end
312
+
313
+ # Evaluations metrics, at a specific confidence level.
314
+ class GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics
315
+ include Google::Apis::Core::Hashable
316
+
317
+ # The confidence level.
318
+ # Corresponds to the JSON property `confidenceLevel`
319
+ # @return [Float]
320
+ attr_accessor :confidence_level
321
+
322
+ # Evaluation metrics, either in aggregate or about a specific entity.
323
+ # Corresponds to the JSON property `metrics`
324
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics]
325
+ attr_accessor :metrics
326
+
327
+ def initialize(**args)
328
+ update!(**args)
329
+ end
330
+
331
+ # Update properties of this object
332
+ def update!(**args)
333
+ @confidence_level = args[:confidence_level] if args.key?(:confidence_level)
334
+ @metrics = args[:metrics] if args.key?(:metrics)
335
+ end
336
+ end
337
+
338
+ # Evaluation metrics, either in aggregate or about a specific entity.
339
+ class GoogleCloudDocumentaiUiv1beta3EvaluationMetrics
340
+ include Google::Apis::Core::Hashable
341
+
342
+ # The calculated f1 score.
343
+ # Corresponds to the JSON property `f1Score`
344
+ # @return [Float]
345
+ attr_accessor :f1_score
346
+
347
+ # The calculated precision.
348
+ # Corresponds to the JSON property `precision`
349
+ # @return [Float]
350
+ attr_accessor :precision
351
+
352
+ # The calculated recall.
353
+ # Corresponds to the JSON property `recall`
354
+ # @return [Float]
355
+ attr_accessor :recall
356
+
357
+ def initialize(**args)
358
+ update!(**args)
359
+ end
360
+
361
+ # Update properties of this object
362
+ def update!(**args)
363
+ @f1_score = args[:f1_score] if args.key?(:f1_score)
364
+ @precision = args[:precision] if args.key?(:precision)
365
+ @recall = args[:recall] if args.key?(:recall)
366
+ end
367
+ end
368
+
369
+ # Metrics across multiple confidence levels.
370
+ class GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics
371
+ include Google::Apis::Core::Hashable
372
+
373
+ # Metrics across confidence levels.
374
+ # Corresponds to the JSON property `confidenceLevelMetrics`
375
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics>]
376
+ attr_accessor :confidence_level_metrics
377
+
378
+ def initialize(**args)
379
+ update!(**args)
380
+ end
381
+
382
+ # Update properties of this object
383
+ def update!(**args)
384
+ @confidence_level_metrics = args[:confidence_level_metrics] if args.key?(:confidence_level_metrics)
385
+ end
386
+ end
387
+
388
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
389
+ class GoogleCloudDocumentaiUiv1beta3EvaluationReference
390
+ include Google::Apis::Core::Hashable
391
+
392
+ # Evaluation metrics, either in aggregate or about a specific entity.
393
+ # Corresponds to the JSON property `aggregateMetrics`
394
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics]
395
+ attr_accessor :aggregate_metrics
396
+
397
+ # The resource name of the evaluation.
398
+ # Corresponds to the JSON property `evaluation`
399
+ # @return [String]
400
+ attr_accessor :evaluation
401
+
402
+ # The resource name of the Long Running Operation for the evaluation.
403
+ # Corresponds to the JSON property `operation`
404
+ # @return [String]
405
+ attr_accessor :operation
406
+
407
+ def initialize(**args)
408
+ update!(**args)
409
+ end
410
+
411
+ # Update properties of this object
412
+ def update!(**args)
413
+ @aggregate_metrics = args[:aggregate_metrics] if args.key?(:aggregate_metrics)
414
+ @evaluation = args[:evaluation] if args.key?(:evaluation)
415
+ @operation = args[:operation] if args.key?(:operation)
416
+ end
417
+ end
418
+
236
419
  # A processor version is an implementation of a processor. Each processor can
237
420
  # have multiple versions, pre-trained by Google internally or up-trained by the
238
421
  # customer. At a time, a processor can only have one default version version. So
@@ -251,6 +434,11 @@ module Google
251
434
  # @return [String]
252
435
  attr_accessor :display_name
253
436
 
437
+ # Gives a short summary of an evaluation, and links to the evaluation itself.
438
+ # Corresponds to the JSON property `latestEvaluation`
439
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationReference]
440
+ attr_accessor :latest_evaluation
441
+
254
442
  # The resource name of the processor version. Format: projects/`project`/
255
443
  # locations/`location`/processors/`processor`/processorVersions/`
256
444
  # processor_version`
@@ -276,6 +464,7 @@ module Google
276
464
  def update!(**args)
277
465
  @create_time = args[:create_time] if args.key?(:create_time)
278
466
  @display_name = args[:display_name] if args.key?(:display_name)
467
+ @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
279
468
  @name = args[:name] if args.key?(:name)
280
469
  @schema = args[:schema] if args.key?(:schema)
281
470
  @state = args[:state] if args.key?(:state)
@@ -532,13 +721,10 @@ module Google
532
721
  class GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus
533
722
  include Google::Apis::Core::Hashable
534
723
 
535
- # The name of the operation triggered by the processed document. If the human
536
- # review process is not triggered, this field will be empty. It has the same
537
- # response type and metadata as the long running operation returned by
538
- # ReviewDocument method.
539
- # Corresponds to the JSON property `humanReviewOperation`
540
- # @return [String]
541
- attr_accessor :human_review_operation
724
+ # The status of human review on a processed document.
725
+ # Corresponds to the JSON property `humanReviewStatus`
726
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1HumanReviewStatus]
727
+ attr_accessor :human_review_status
542
728
 
543
729
  # The source of the document, same as the [input_gcs_source] field in the
544
730
  # request when the batch process started. The batch process is started by take
@@ -570,7 +756,7 @@ module Google
570
756
 
571
757
  # Update properties of this object
572
758
  def update!(**args)
573
- @human_review_operation = args[:human_review_operation] if args.key?(:human_review_operation)
759
+ @human_review_status = args[:human_review_status] if args.key?(:human_review_status)
574
760
  @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
575
761
  @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination)
576
762
  @status = args[:status] if args.key?(:status)
@@ -627,6 +813,39 @@ module Google
627
813
  end
628
814
  end
629
815
 
816
+ # The status of human review on a processed document.
817
+ class GoogleCloudDocumentaiV1HumanReviewStatus
818
+ include Google::Apis::Core::Hashable
819
+
820
+ # The name of the operation triggered by the processed document. Non-empty only
821
+ # when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type
822
+ # and metadata as the long running operation returned by [ReviewDocument] method.
823
+ # Corresponds to the JSON property `humanReviewOperation`
824
+ # @return [String]
825
+ attr_accessor :human_review_operation
826
+
827
+ # The state of human review on the processing request.
828
+ # Corresponds to the JSON property `state`
829
+ # @return [String]
830
+ attr_accessor :state
831
+
832
+ # A message providing more details about the human review state.
833
+ # Corresponds to the JSON property `stateMessage`
834
+ # @return [String]
835
+ attr_accessor :state_message
836
+
837
+ def initialize(**args)
838
+ update!(**args)
839
+ end
840
+
841
+ # Update properties of this object
842
+ def update!(**args)
843
+ @human_review_operation = args[:human_review_operation] if args.key?(:human_review_operation)
844
+ @state = args[:state] if args.key?(:state)
845
+ @state_message = args[:state_message] if args.key?(:state_message)
846
+ end
847
+ end
848
+
630
849
  # The long running operation metadata for review document method.
631
850
  class GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata
632
851
  include Google::Apis::Core::Hashable
@@ -4149,11 +4368,16 @@ module Google
4149
4368
  # The name of the operation triggered by the processed document. If the human
4150
4369
  # review process is not triggered, this field will be empty. It has the same
4151
4370
  # response type and metadata as the long running operation returned by
4152
- # ReviewDocument method.
4371
+ # ReviewDocument method. .
4153
4372
  # Corresponds to the JSON property `humanReviewOperation`
4154
4373
  # @return [String]
4155
4374
  attr_accessor :human_review_operation
4156
4375
 
4376
+ # The status of human review on a processed document.
4377
+ # Corresponds to the JSON property `humanReviewStatus`
4378
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewStatus]
4379
+ attr_accessor :human_review_status
4380
+
4157
4381
  # The source of the document, same as the [input_gcs_source] field in the
4158
4382
  # request when the batch process started. The batch process is started by take
4159
4383
  # snapshot of that document, since a user can move or change that document
@@ -4185,6 +4409,7 @@ module Google
4185
4409
  # Update properties of this object
4186
4410
  def update!(**args)
4187
4411
  @human_review_operation = args[:human_review_operation] if args.key?(:human_review_operation)
4412
+ @human_review_status = args[:human_review_status] if args.key?(:human_review_status)
4188
4413
  @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source)
4189
4414
  @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination)
4190
4415
  @status = args[:status] if args.key?(:status)
@@ -4195,24 +4420,45 @@ module Google
4195
4420
  class GoogleCloudDocumentaiV1beta3BatchProcessRequest
4196
4421
  include Google::Apis::Core::Hashable
4197
4422
 
4423
+ # Config that controls the output of documents. All documents will be written as
4424
+ # a JSON file.
4425
+ # Corresponds to the JSON property `documentOutputConfig`
4426
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfig]
4427
+ attr_accessor :document_output_config
4428
+
4198
4429
  # The input config for each single document in the batch process.
4199
4430
  # Corresponds to the JSON property `inputConfigs`
4200
4431
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig>]
4201
4432
  attr_accessor :input_configs
4202
4433
 
4434
+ # The message for input config in batch process.
4435
+ # Corresponds to the JSON property `inputDocuments`
4436
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig]
4437
+ attr_accessor :input_documents
4438
+
4203
4439
  # The message for output config in batch process.
4204
4440
  # Corresponds to the JSON property `outputConfig`
4205
4441
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig]
4206
4442
  attr_accessor :output_config
4207
4443
 
4444
+ # Whether Human Review feature should be skipped for this request. Default to
4445
+ # false.
4446
+ # Corresponds to the JSON property `skipHumanReview`
4447
+ # @return [Boolean]
4448
+ attr_accessor :skip_human_review
4449
+ alias_method :skip_human_review?, :skip_human_review
4450
+
4208
4451
  def initialize(**args)
4209
4452
  update!(**args)
4210
4453
  end
4211
4454
 
4212
4455
  # Update properties of this object
4213
4456
  def update!(**args)
4457
+ @document_output_config = args[:document_output_config] if args.key?(:document_output_config)
4214
4458
  @input_configs = args[:input_configs] if args.key?(:input_configs)
4459
+ @input_documents = args[:input_documents] if args.key?(:input_documents)
4215
4460
  @output_config = args[:output_config] if args.key?(:output_config)
4461
+ @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
4216
4462
  end
4217
4463
  end
4218
4464
 
@@ -4643,6 +4889,45 @@ module Google
4643
4889
  end
4644
4890
  end
4645
4891
 
4892
+ # Config that controls the output of documents. All documents will be written as
4893
+ # a JSON file.
4894
+ class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
4895
+ include Google::Apis::Core::Hashable
4896
+
4897
+ # The configuration used when outputting documents.
4898
+ # Corresponds to the JSON property `gcsOutputConfig`
4899
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig]
4900
+ attr_accessor :gcs_output_config
4901
+
4902
+ def initialize(**args)
4903
+ update!(**args)
4904
+ end
4905
+
4906
+ # Update properties of this object
4907
+ def update!(**args)
4908
+ @gcs_output_config = args[:gcs_output_config] if args.key?(:gcs_output_config)
4909
+ end
4910
+ end
4911
+
4912
+ # The configuration used when outputting documents.
4913
+ class GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig
4914
+ include Google::Apis::Core::Hashable
4915
+
4916
+ # The Cloud Storage uri (a directory) of the output.
4917
+ # Corresponds to the JSON property `gcsUri`
4918
+ # @return [String]
4919
+ attr_accessor :gcs_uri
4920
+
4921
+ def initialize(**args)
4922
+ update!(**args)
4923
+ end
4924
+
4925
+ # Update properties of this object
4926
+ def update!(**args)
4927
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
4928
+ end
4929
+ end
4930
+
4646
4931
  # A page in a Document.
4647
4932
  class GoogleCloudDocumentaiV1beta3DocumentPage
4648
4933
  include Google::Apis::Core::Hashable
@@ -5769,6 +6054,39 @@ module Google
5769
6054
  end
5770
6055
  end
5771
6056
 
6057
+ # The status of human review on a processed document.
6058
+ class GoogleCloudDocumentaiV1beta3HumanReviewStatus
6059
+ include Google::Apis::Core::Hashable
6060
+
6061
+ # The name of the operation triggered by the processed document. Non-empty only
6062
+ # when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type
6063
+ # and metadata as the long running operation returned by [ReviewDocument] method.
6064
+ # Corresponds to the JSON property `humanReviewOperation`
6065
+ # @return [String]
6066
+ attr_accessor :human_review_operation
6067
+
6068
+ # The state of human review on the processing request.
6069
+ # Corresponds to the JSON property `state`
6070
+ # @return [String]
6071
+ attr_accessor :state
6072
+
6073
+ # A message providing more details about the human review state.
6074
+ # Corresponds to the JSON property `stateMessage`
6075
+ # @return [String]
6076
+ attr_accessor :state_message
6077
+
6078
+ def initialize(**args)
6079
+ update!(**args)
6080
+ end
6081
+
6082
+ # Update properties of this object
6083
+ def update!(**args)
6084
+ @human_review_operation = args[:human_review_operation] if args.key?(:human_review_operation)
6085
+ @state = args[:state] if args.key?(:state)
6086
+ @state_message = args[:state_message] if args.key?(:state_message)
6087
+ end
6088
+ end
6089
+
5772
6090
  # A vertex represents a 2D point in the image. NOTE: the normalized vertex
5773
6091
  # coordinates are relative to the original image and range from 0 to 1.
5774
6092
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
@@ -5807,6 +6125,19 @@ module Google
5807
6125
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
5808
6126
  attr_accessor :document
5809
6127
 
6128
+ # Document represents the canonical document resource in Document Understanding
6129
+ # AI. It is an interchange format that provides insights into documents and
6130
+ # allows for collaboration between users and Document Understanding AI to
6131
+ # iterate and optimize for quality.
6132
+ # Corresponds to the JSON property `inlineDocument`
6133
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
6134
+ attr_accessor :inline_document
6135
+
6136
+ # Payload message of raw document content (bytes).
6137
+ # Corresponds to the JSON property `rawDocument`
6138
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument]
6139
+ attr_accessor :raw_document
6140
+
5810
6141
  # Whether Human Review feature should be skipped for this request. Default to
5811
6142
  # false.
5812
6143
  # Corresponds to the JSON property `skipHumanReview`
@@ -5821,6 +6152,8 @@ module Google
5821
6152
  # Update properties of this object
5822
6153
  def update!(**args)
5823
6154
  @document = args[:document] if args.key?(:document)
6155
+ @inline_document = args[:inline_document] if args.key?(:inline_document)
6156
+ @raw_document = args[:raw_document] if args.key?(:raw_document)
5824
6157
  @skip_human_review = args[:skip_human_review] if args.key?(:skip_human_review)
5825
6158
  end
5826
6159
  end
@@ -5840,11 +6173,16 @@ module Google
5840
6173
  # The name of the operation triggered by the processed document. If the human
5841
6174
  # review process is not triggered, this field will be empty. It has the same
5842
6175
  # response type and metadata as the long running operation returned by
5843
- # ReviewDocument method.
6176
+ # ReviewDocument method. .
5844
6177
  # Corresponds to the JSON property `humanReviewOperation`
5845
6178
  # @return [String]
5846
6179
  attr_accessor :human_review_operation
5847
6180
 
6181
+ # The status of human review on a processed document.
6182
+ # Corresponds to the JSON property `humanReviewStatus`
6183
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewStatus]
6184
+ attr_accessor :human_review_status
6185
+
5848
6186
  def initialize(**args)
5849
6187
  update!(**args)
5850
6188
  end
@@ -5853,6 +6191,33 @@ module Google
5853
6191
  def update!(**args)
5854
6192
  @document = args[:document] if args.key?(:document)
5855
6193
  @human_review_operation = args[:human_review_operation] if args.key?(:human_review_operation)
6194
+ @human_review_status = args[:human_review_status] if args.key?(:human_review_status)
6195
+ end
6196
+ end
6197
+
6198
+ # Payload message of raw document content (bytes).
6199
+ class GoogleCloudDocumentaiV1beta3RawDocument
6200
+ include Google::Apis::Core::Hashable
6201
+
6202
+ # Inline document content.
6203
+ # Corresponds to the JSON property `content`
6204
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
6205
+ # @return [String]
6206
+ attr_accessor :content
6207
+
6208
+ # An IANA MIME type (RFC6838) indicating the nature and format of the [content].
6209
+ # Corresponds to the JSON property `mimeType`
6210
+ # @return [String]
6211
+ attr_accessor :mime_type
6212
+
6213
+ def initialize(**args)
6214
+ update!(**args)
6215
+ end
6216
+
6217
+ # Update properties of this object
6218
+ def update!(**args)
6219
+ @content = args[:content] if args.key?(:content)
6220
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
5856
6221
  end
5857
6222
  end
5858
6223
 
@@ -5912,6 +6277,14 @@ module Google
5912
6277
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
5913
6278
  attr_accessor :document
5914
6279
 
6280
+ # Document represents the canonical document resource in Document Understanding
6281
+ # AI. It is an interchange format that provides insights into documents and
6282
+ # allows for collaboration between users and Document Understanding AI to
6283
+ # iterate and optimize for quality.
6284
+ # Corresponds to the JSON property `inlineDocument`
6285
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document]
6286
+ attr_accessor :inline_document
6287
+
5915
6288
  def initialize(**args)
5916
6289
  update!(**args)
5917
6290
  end
@@ -5919,6 +6292,7 @@ module Google
5919
6292
  # Update properties of this object
5920
6293
  def update!(**args)
5921
6294
  @document = args[:document] if args.key?(:document)
6295
+ @inline_document = args[:inline_document] if args.key?(:inline_document)
5922
6296
  end
5923
6297
  end
5924
6298
 
@@ -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.1.0"
19
+ GEM_VERSION = "0.2.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.1"
22
+ GENERATOR_VERSION = "0.1.2"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20201231"
25
+ REVISION = "20210201"
26
26
  end
27
27
  end
28
28
  end
@@ -88,6 +88,48 @@ module Google
88
88
  include Google::Apis::Core::JsonObjectSupport
89
89
  end
90
90
 
91
+ class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
103
+ class GoogleCloudDocumentaiUiv1beta3Evaluation
104
+ class Representation < Google::Apis::Core::JsonRepresentation; end
105
+
106
+ include Google::Apis::Core::JsonObjectSupport
107
+ end
108
+
109
+ class GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics
110
+ class Representation < Google::Apis::Core::JsonRepresentation; end
111
+
112
+ include Google::Apis::Core::JsonObjectSupport
113
+ end
114
+
115
+ class GoogleCloudDocumentaiUiv1beta3EvaluationMetrics
116
+ class Representation < Google::Apis::Core::JsonRepresentation; end
117
+
118
+ include Google::Apis::Core::JsonObjectSupport
119
+ end
120
+
121
+ class GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
127
+ class GoogleCloudDocumentaiUiv1beta3EvaluationReference
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
91
133
  class GoogleCloudDocumentaiUiv1beta3ProcessorVersion
92
134
  class Representation < Google::Apis::Core::JsonRepresentation; end
93
135
 
@@ -166,6 +208,12 @@ module Google
166
208
  include Google::Apis::Core::JsonObjectSupport
167
209
  end
168
210
 
211
+ class GoogleCloudDocumentaiV1HumanReviewStatus
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
169
217
  class GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata
170
218
  class Representation < Google::Apis::Core::JsonRepresentation; end
171
219
 
@@ -772,6 +820,18 @@ module Google
772
820
  include Google::Apis::Core::JsonObjectSupport
773
821
  end
774
822
 
823
+ class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
824
+ class Representation < Google::Apis::Core::JsonRepresentation; end
825
+
826
+ include Google::Apis::Core::JsonObjectSupport
827
+ end
828
+
829
+ class GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig
830
+ class Representation < Google::Apis::Core::JsonRepresentation; end
831
+
832
+ include Google::Apis::Core::JsonObjectSupport
833
+ end
834
+
775
835
  class GoogleCloudDocumentaiV1beta3DocumentPage
776
836
  class Representation < Google::Apis::Core::JsonRepresentation; end
777
837
 
@@ -946,6 +1006,12 @@ module Google
946
1006
  include Google::Apis::Core::JsonObjectSupport
947
1007
  end
948
1008
 
1009
+ class GoogleCloudDocumentaiV1beta3HumanReviewStatus
1010
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1011
+
1012
+ include Google::Apis::Core::JsonObjectSupport
1013
+ end
1014
+
949
1015
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
950
1016
  class Representation < Google::Apis::Core::JsonRepresentation; end
951
1017
 
@@ -964,6 +1030,12 @@ module Google
964
1030
  include Google::Apis::Core::JsonObjectSupport
965
1031
  end
966
1032
 
1033
+ class GoogleCloudDocumentaiV1beta3RawDocument
1034
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1035
+
1036
+ include Google::Apis::Core::JsonObjectSupport
1037
+ end
1038
+
967
1039
  class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
968
1040
  class Representation < Google::Apis::Core::JsonRepresentation; end
969
1041
 
@@ -1138,11 +1210,77 @@ module Google
1138
1210
  end
1139
1211
  end
1140
1212
 
1213
+ class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata
1214
+ # @private
1215
+ class Representation < Google::Apis::Core::JsonRepresentation
1216
+ property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation
1217
+
1218
+ end
1219
+ end
1220
+
1221
+ class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
1222
+ # @private
1223
+ class Representation < Google::Apis::Core::JsonRepresentation
1224
+ property :evaluation, as: 'evaluation', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Evaluation, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Evaluation::Representation
1225
+
1226
+ end
1227
+ end
1228
+
1229
+ class GoogleCloudDocumentaiUiv1beta3Evaluation
1230
+ # @private
1231
+ class Representation < Google::Apis::Core::JsonRepresentation
1232
+ property :all_entities_metrics, as: 'allEntitiesMetrics', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics::Representation
1233
+
1234
+ property :create_time, as: 'createTime'
1235
+ hash :entity_metrics, as: 'entityMetrics', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics::Representation
1236
+
1237
+ property :name, as: 'name'
1238
+ end
1239
+ end
1240
+
1241
+ class GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics
1242
+ # @private
1243
+ class Representation < Google::Apis::Core::JsonRepresentation
1244
+ property :confidence_level, as: 'confidenceLevel'
1245
+ property :metrics, as: 'metrics', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics::Representation
1246
+
1247
+ end
1248
+ end
1249
+
1250
+ class GoogleCloudDocumentaiUiv1beta3EvaluationMetrics
1251
+ # @private
1252
+ class Representation < Google::Apis::Core::JsonRepresentation
1253
+ property :f1_score, as: 'f1Score'
1254
+ property :precision, as: 'precision'
1255
+ property :recall, as: 'recall'
1256
+ end
1257
+ end
1258
+
1259
+ class GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics
1260
+ # @private
1261
+ class Representation < Google::Apis::Core::JsonRepresentation
1262
+ collection :confidence_level_metrics, as: 'confidenceLevelMetrics', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics::Representation
1263
+
1264
+ end
1265
+ end
1266
+
1267
+ class GoogleCloudDocumentaiUiv1beta3EvaluationReference
1268
+ # @private
1269
+ class Representation < Google::Apis::Core::JsonRepresentation
1270
+ property :aggregate_metrics, as: 'aggregateMetrics', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationMetrics::Representation
1271
+
1272
+ property :evaluation, as: 'evaluation'
1273
+ property :operation, as: 'operation'
1274
+ end
1275
+ end
1276
+
1141
1277
  class GoogleCloudDocumentaiUiv1beta3ProcessorVersion
1142
1278
  # @private
1143
1279
  class Representation < Google::Apis::Core::JsonRepresentation
1144
1280
  property :create_time, as: 'createTime'
1145
1281
  property :display_name, as: 'displayName'
1282
+ property :latest_evaluation, as: 'latestEvaluation', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationReference, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3EvaluationReference::Representation
1283
+
1146
1284
  property :name, as: 'name'
1147
1285
  property :schema, as: 'schema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Schema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Schema::Representation
1148
1286
 
@@ -1234,7 +1372,8 @@ module Google
1234
1372
  class GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus
1235
1373
  # @private
1236
1374
  class Representation < Google::Apis::Core::JsonRepresentation
1237
- property :human_review_operation, as: 'humanReviewOperation'
1375
+ property :human_review_status, as: 'humanReviewStatus', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1HumanReviewStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1HumanReviewStatus::Representation
1376
+
1238
1377
  property :input_gcs_source, as: 'inputGcsSource'
1239
1378
  property :output_gcs_destination, as: 'outputGcsDestination'
1240
1379
  property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
@@ -1258,6 +1397,15 @@ module Google
1258
1397
  end
1259
1398
  end
1260
1399
 
1400
+ class GoogleCloudDocumentaiV1HumanReviewStatus
1401
+ # @private
1402
+ class Representation < Google::Apis::Core::JsonRepresentation
1403
+ property :human_review_operation, as: 'humanReviewOperation'
1404
+ property :state, as: 'state'
1405
+ property :state_message, as: 'stateMessage'
1406
+ end
1407
+ end
1408
+
1261
1409
  class GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata
1262
1410
  # @private
1263
1411
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2281,6 +2429,8 @@ module Google
2281
2429
  # @private
2282
2430
  class Representation < Google::Apis::Core::JsonRepresentation
2283
2431
  property :human_review_operation, as: 'humanReviewOperation'
2432
+ property :human_review_status, as: 'humanReviewStatus', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewStatus::Representation
2433
+
2284
2434
  property :input_gcs_source, as: 'inputGcsSource'
2285
2435
  property :output_gcs_destination, as: 'outputGcsDestination'
2286
2436
  property :status, as: 'status', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
@@ -2291,10 +2441,15 @@ module Google
2291
2441
  class GoogleCloudDocumentaiV1beta3BatchProcessRequest
2292
2442
  # @private
2293
2443
  class Representation < Google::Apis::Core::JsonRepresentation
2444
+ property :document_output_config, as: 'documentOutputConfig', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfig::Representation
2445
+
2294
2446
  collection :input_configs, as: 'inputConfigs', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig::Representation
2295
2447
 
2448
+ property :input_documents, as: 'inputDocuments', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig::Representation
2449
+
2296
2450
  property :output_config, as: 'outputConfig', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig::Representation
2297
2451
 
2452
+ property :skip_human_review, as: 'skipHumanReview'
2298
2453
  end
2299
2454
  end
2300
2455
 
@@ -2413,6 +2568,21 @@ module Google
2413
2568
  end
2414
2569
  end
2415
2570
 
2571
+ class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
2572
+ # @private
2573
+ class Representation < Google::Apis::Core::JsonRepresentation
2574
+ property :gcs_output_config, as: 'gcsOutputConfig', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig::Representation
2575
+
2576
+ end
2577
+ end
2578
+
2579
+ class GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig
2580
+ # @private
2581
+ class Representation < Google::Apis::Core::JsonRepresentation
2582
+ property :gcs_uri, as: 'gcsUri'
2583
+ end
2584
+ end
2585
+
2416
2586
  class GoogleCloudDocumentaiV1beta3DocumentPage
2417
2587
  # @private
2418
2588
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2743,6 +2913,15 @@ module Google
2743
2913
  end
2744
2914
  end
2745
2915
 
2916
+ class GoogleCloudDocumentaiV1beta3HumanReviewStatus
2917
+ # @private
2918
+ class Representation < Google::Apis::Core::JsonRepresentation
2919
+ property :human_review_operation, as: 'humanReviewOperation'
2920
+ property :state, as: 'state'
2921
+ property :state_message, as: 'stateMessage'
2922
+ end
2923
+ end
2924
+
2746
2925
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
2747
2926
  # @private
2748
2927
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2756,6 +2935,10 @@ module Google
2756
2935
  class Representation < Google::Apis::Core::JsonRepresentation
2757
2936
  property :document, as: 'document', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
2758
2937
 
2938
+ property :inline_document, as: 'inlineDocument', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
2939
+
2940
+ property :raw_document, as: 'rawDocument', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3RawDocument::Representation
2941
+
2759
2942
  property :skip_human_review, as: 'skipHumanReview'
2760
2943
  end
2761
2944
  end
@@ -2766,6 +2949,16 @@ module Google
2766
2949
  property :document, as: 'document', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
2767
2950
 
2768
2951
  property :human_review_operation, as: 'humanReviewOperation'
2952
+ property :human_review_status, as: 'humanReviewStatus', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3HumanReviewStatus::Representation
2953
+
2954
+ end
2955
+ end
2956
+
2957
+ class GoogleCloudDocumentaiV1beta3RawDocument
2958
+ # @private
2959
+ class Representation < Google::Apis::Core::JsonRepresentation
2960
+ property :content, :base64 => true, as: 'content'
2961
+ property :mime_type, as: 'mimeType'
2769
2962
  end
2770
2963
  end
2771
2964
 
@@ -2786,6 +2979,8 @@ module Google
2786
2979
  class Representation < Google::Apis::Core::JsonRepresentation
2787
2980
  property :document, as: 'document', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
2788
2981
 
2982
+ property :inline_document, as: 'inlineDocument', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document::Representation
2983
+
2789
2984
  end
2790
2985
  end
2791
2986
 
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.1.0
4
+ version: 0.2.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-01-08 00:00:00.000000000 Z
11
+ date: 2021-02-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -52,7 +52,7 @@ licenses:
52
52
  metadata:
53
53
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
54
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-documentai_v1beta3/CHANGELOG.md
55
- documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.1.0
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.2.0
56
56
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-documentai_v1beta3
57
57
  post_install_message:
58
58
  rdoc_options: []
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
69
69
  - !ruby/object:Gem::Version
70
70
  version: '0'
71
71
  requirements: []
72
- rubygems_version: 3.1.4
72
+ rubygems_version: 3.2.6
73
73
  signing_key:
74
74
  specification_version: 4
75
75
  summary: Simple REST client for Cloud Document AI API V1beta3