google-apis-documentai_v1beta3 0.2.0 → 0.7.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: 96667553bcc60c6fe33341950d8320ae8290e2093fab44ffb3aae076830c6670
4
- data.tar.gz: 8f08c0f4930b7ce280794ac2ac515e82b439ba22026da28169c02a522abb224b
3
+ metadata.gz: 782356333b965be82cf19edb3077d5cf58a3d4e6f05e2faebdfa0205b6a98328
4
+ data.tar.gz: 50d2aac50fa4a6f1b74c6751b5dd32216764e93e76db178e8f641fafd25bfc45
5
5
  SHA512:
6
- metadata.gz: eee70d1cd8310e5f66fa2a1046c4a91b2953f8c72e33008bc717a2bb886f4b010fd4329c27d3206af020799c984c42331c5bb0e09565e160564aea049fcd19ad
7
- data.tar.gz: 67bf56b920820e484d4d01b953bdbce1fee8ff118db58231de15af6d8c73b524482ee4a58597536a2c838390fb1a894c69f567b643035d68fb6f10b6a5b944f8
6
+ metadata.gz: 7f3c83c131238fe83290a716450a5f32aa6f01653ba9cd74c50f3b446b321de9da73a1c6dbb0d361b77701fae4da999a2cf3d50c2d92a26f2adbdcb59e5b0da1
7
+ data.tar.gz: 657769597637b094fa66f93dbe4debcae842bafca1ebe8fbcc79f2acbf8d8be32b7ddca1c196f805be7ddcdf956df311b5a14728c4483476eb7eef4715fa54e3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Release history for google-apis-documentai_v1beta3
2
2
 
3
+ ### v0.7.0 (2021-03-16)
4
+
5
+ * Regenerated from discovery document revision 20210312
6
+
7
+ ### v0.6.0 (2021-03-09)
8
+
9
+ * Regenerated from discovery document revision 20210308
10
+ * Regenerated using generator version 0.2.0
11
+
12
+ ### v0.5.0 (2021-03-04)
13
+
14
+ * Regenerated from discovery document revision 20210226
15
+
16
+ ### v0.4.0 (2021-02-24)
17
+
18
+ * Regenerated from discovery document revision 20210222
19
+
20
+ ### v0.3.0 (2021-02-12)
21
+
22
+ * Regenerated from discovery document revision 20210211
23
+
3
24
  ### v0.2.0 (2021-02-03)
4
25
 
5
26
  * Regenerated from discovery document revision 20210201
@@ -256,9 +256,9 @@ module Google
256
256
  class GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
257
257
  include Google::Apis::Core::Hashable
258
258
 
259
- # An evaluation of a ProcessorVersion's performance.
259
+ # The resource name of the created evaluation.
260
260
  # Corresponds to the JSON property `evaluation`
261
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Evaluation]
261
+ # @return [String]
262
262
  attr_accessor :evaluation
263
263
 
264
264
  def initialize(**args)
@@ -271,109 +271,14 @@ module Google
271
271
  end
272
272
  end
273
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
274
+ # The long running operation metadata for SampleDataset.
275
+ class GoogleCloudDocumentaiUiv1beta3SampleDatasetMetadata
371
276
  include Google::Apis::Core::Hashable
372
277
 
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
278
+ # The common metadata for long running operations.
279
+ # Corresponds to the JSON property `commonMetadata`
280
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
281
+ attr_accessor :common_metadata
377
282
 
378
283
  def initialize(**args)
379
284
  update!(**args)
@@ -381,28 +286,18 @@ module Google
381
286
 
382
287
  # Update properties of this object
383
288
  def update!(**args)
384
- @confidence_level_metrics = args[:confidence_level_metrics] if args.key?(:confidence_level_metrics)
289
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
385
290
  end
386
291
  end
387
292
 
388
- # Gives a short summary of an evaluation, and links to the evaluation itself.
389
- class GoogleCloudDocumentaiUiv1beta3EvaluationReference
293
+ # The long running operation metadata for set default processor version method.
294
+ class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
390
295
  include Google::Apis::Core::Hashable
391
296
 
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
297
+ # The common metadata for long running operations.
298
+ # Corresponds to the JSON property `commonMetadata`
299
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
300
+ attr_accessor :common_metadata
406
301
 
407
302
  def initialize(**args)
408
303
  update!(**args)
@@ -410,85 +305,43 @@ module Google
410
305
 
411
306
  # Update properties of this object
412
307
  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)
308
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
416
309
  end
417
310
  end
418
311
 
419
- # A processor version is an implementation of a processor. Each processor can
420
- # have multiple versions, pre-trained by Google internally or up-trained by the
421
- # customer. At a time, a processor can only have one default version version. So
422
- # the processor's behavior (when processing documents) is defined by a default
423
- # version.
424
- class GoogleCloudDocumentaiUiv1beta3ProcessorVersion
312
+ # Response message for set default processor version method.
313
+ class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse
425
314
  include Google::Apis::Core::Hashable
426
315
 
427
- # The time the processor version was created.
428
- # Corresponds to the JSON property `createTime`
429
- # @return [String]
430
- attr_accessor :create_time
431
-
432
- # The display name of the processor version.
433
- # Corresponds to the JSON property `displayName`
434
- # @return [String]
435
- attr_accessor :display_name
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
-
442
- # The resource name of the processor version. Format: projects/`project`/
443
- # locations/`location`/processors/`processor`/processorVersions/`
444
- # processor_version`
445
- # Corresponds to the JSON property `name`
446
- # @return [String]
447
- attr_accessor :name
448
-
449
- # The schema defines the output of the processed document by a processor.
450
- # Corresponds to the JSON property `schema`
451
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3Schema]
452
- attr_accessor :schema
453
-
454
- # The state of the processor version.
455
- # Corresponds to the JSON property `state`
456
- # @return [String]
457
- attr_accessor :state
458
-
459
316
  def initialize(**args)
460
317
  update!(**args)
461
318
  end
462
319
 
463
320
  # Update properties of this object
464
321
  def update!(**args)
465
- @create_time = args[:create_time] if args.key?(:create_time)
466
- @display_name = args[:display_name] if args.key?(:display_name)
467
- @latest_evaluation = args[:latest_evaluation] if args.key?(:latest_evaluation)
468
- @name = args[:name] if args.key?(:name)
469
- @schema = args[:schema] if args.key?(:schema)
470
- @state = args[:state] if args.key?(:state)
471
322
  end
472
323
  end
473
324
 
474
- # The schema defines the output of the processed document by a processor.
475
- class GoogleCloudDocumentaiUiv1beta3Schema
325
+ # The metadata that represents a processor version being created.
326
+ class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata
476
327
  include Google::Apis::Core::Hashable
477
328
 
478
- # Description of the schema.
479
- # Corresponds to the JSON property `description`
480
- # @return [String]
481
- attr_accessor :description
329
+ # The common metadata for long running operations.
330
+ # Corresponds to the JSON property `commonMetadata`
331
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
332
+ attr_accessor :common_metadata
482
333
 
483
- # Display name to show to users.
484
- # Corresponds to the JSON property `displayName`
485
- # @return [String]
486
- attr_accessor :display_name
334
+ # The dataset validation information. This includes any and all errors with
335
+ # documents and the dataset.
336
+ # Corresponds to the JSON property `testDatasetValidation`
337
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation]
338
+ attr_accessor :test_dataset_validation
487
339
 
488
- # Entity types of the schema.
489
- # Corresponds to the JSON property `entityTypes`
490
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEntityType>]
491
- attr_accessor :entity_types
340
+ # The dataset validation information. This includes any and all errors with
341
+ # documents and the dataset.
342
+ # Corresponds to the JSON property `trainingDatasetValidation`
343
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation]
344
+ attr_accessor :training_dataset_validation
492
345
 
493
346
  def initialize(**args)
494
347
  update!(**args)
@@ -496,54 +349,29 @@ module Google
496
349
 
497
350
  # Update properties of this object
498
351
  def update!(**args)
499
- @description = args[:description] if args.key?(:description)
500
- @display_name = args[:display_name] if args.key?(:display_name)
501
- @entity_types = args[:entity_types] if args.key?(:entity_types)
352
+ @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
353
+ @test_dataset_validation = args[:test_dataset_validation] if args.key?(:test_dataset_validation)
354
+ @training_dataset_validation = args[:training_dataset_validation] if args.key?(:training_dataset_validation)
502
355
  end
503
356
  end
504
357
 
505
- # EntityType is the wrapper of a label of the corresponding model with detailed
506
- # attributes and limitations for entity-based processors. Multiple types can
507
- # also compose a dependency tree to represent nested types.
508
- class GoogleCloudDocumentaiUiv1beta3SchemaEntityType
358
+ # The dataset validation information. This includes any and all errors with
359
+ # documents and the dataset.
360
+ class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
509
361
  include Google::Apis::Core::Hashable
510
362
 
511
- # Type of the entity. It can be either a value type (such as "text", "numeric", "
512
- # date" and "address"), or an object type which may contain nested entities (
513
- # such as "document" and "table").
514
- # Corresponds to the JSON property `baseType`
515
- # @return [String]
516
- attr_accessor :base_type
517
-
518
- # Description of the entity type.
519
- # Corresponds to the JSON property `description`
520
- # @return [String]
521
- attr_accessor :description
522
-
523
- # Occurrence type limits the number of times an entity type appears in the
524
- # document.
525
- # Corresponds to the JSON property `occurrenceType`
526
- # @return [String]
527
- attr_accessor :occurrence_type
363
+ # Error information for the dataset as a whole. A maximum of 10 dataset errors
364
+ # will be returned. A single dataset error is terminal for training.
365
+ # Corresponds to the JSON property `datasetErrors`
366
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleRpcStatus>]
367
+ attr_accessor :dataset_errors
528
368
 
529
- # Describing the nested structure of an entity. An EntityType may consist of
530
- # several other EntityTypes. For example, in a document there can be an
531
- # EntityType 'ID', which consists of EntityType 'name' and 'address', with
532
- # corresponding attributes, such as TEXT for both types and ONCE for occurrence
533
- # types.
534
- # Corresponds to the JSON property `properties`
535
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3SchemaEntityType>]
536
- attr_accessor :properties
537
-
538
- # Source of this entity type.
539
- # Corresponds to the JSON property `source`
540
- # @return [String]
541
- attr_accessor :source
542
-
543
- # Name of the type. It must be unique within the set of same level types.
544
- # Corresponds to the JSON property `type`
545
- # @return [String]
546
- attr_accessor :type
369
+ # Error information pertaining to specific documents. A maximum of 10 document
370
+ # errors will be returned. Any document with errors will not be used throughout
371
+ # training.
372
+ # Corresponds to the JSON property `documentErrors`
373
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleRpcStatus>]
374
+ attr_accessor :document_errors
547
375
 
548
376
  def initialize(**args)
549
377
  update!(**args)
@@ -551,31 +379,8 @@ module Google
551
379
 
552
380
  # Update properties of this object
553
381
  def update!(**args)
554
- @base_type = args[:base_type] if args.key?(:base_type)
555
- @description = args[:description] if args.key?(:description)
556
- @occurrence_type = args[:occurrence_type] if args.key?(:occurrence_type)
557
- @properties = args[:properties] if args.key?(:properties)
558
- @source = args[:source] if args.key?(:source)
559
- @type = args[:type] if args.key?(:type)
560
- end
561
- end
562
-
563
- # The metadata that represents a processor version being created.
564
- class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata
565
- include Google::Apis::Core::Hashable
566
-
567
- # The common metadata for long running operations.
568
- # Corresponds to the JSON property `commonMetadata`
569
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata]
570
- attr_accessor :common_metadata
571
-
572
- def initialize(**args)
573
- update!(**args)
574
- end
575
-
576
- # Update properties of this object
577
- def update!(**args)
578
- @common_metadata = args[:common_metadata] if args.key?(:common_metadata)
382
+ @dataset_errors = args[:dataset_errors] if args.key?(:dataset_errors)
383
+ @document_errors = args[:document_errors] if args.key?(:document_errors)
579
384
  end
580
385
  end
581
386
 
@@ -583,13 +388,9 @@ module Google
583
388
  class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse
584
389
  include Google::Apis::Core::Hashable
585
390
 
586
- # A processor version is an implementation of a processor. Each processor can
587
- # have multiple versions, pre-trained by Google internally or up-trained by the
588
- # customer. At a time, a processor can only have one default version version. So
589
- # the processor's behavior (when processing documents) is defined by a default
590
- # version.
391
+ # The resource name of the processor version produced by training.
591
392
  # Corresponds to the JSON property `processorVersion`
592
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3ProcessorVersion]
393
+ # @return [String]
593
394
  attr_accessor :processor_version
594
395
 
595
396
  def initialize(**args)
@@ -817,9 +618,10 @@ module Google
817
618
  class GoogleCloudDocumentaiV1HumanReviewStatus
818
619
  include Google::Apis::Core::Hashable
819
620
 
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.
621
+ # The name of the operation triggered by the processed document. This field is
622
+ # populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same
623
+ # response type and metadata as the long running operation returned by [
624
+ # ReviewDocument] method.
823
625
  # Corresponds to the JSON property `humanReviewOperation`
824
626
  # @return [String]
825
627
  attr_accessor :human_review_operation
@@ -936,9 +738,9 @@ module Google
936
738
  class GoogleCloudDocumentaiV1beta1Document
937
739
  include Google::Apis::Core::Hashable
938
740
 
939
- # Inline document content, represented as a stream of bytes. Note: As with all `
940
- # bytes` fields, protobuffers use a pure binary representation, whereas JSON
941
- # representations use base64.
741
+ # Optional. Inline document content, represented as a stream of bytes. Note: As
742
+ # with all `bytes` fields, protobuffers use a pure binary representation,
743
+ # whereas JSON representations use base64.
942
744
  # Corresponds to the JSON property `content`
943
745
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
944
746
  # @return [String]
@@ -988,7 +790,7 @@ module Google
988
790
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentShardInfo]
989
791
  attr_accessor :shard_info
990
792
 
991
- # UTF-8 encoded text in reading order from the document.
793
+ # Optional. UTF-8 encoded text in reading order from the document.
992
794
  # Corresponds to the JSON property `text`
993
795
  # @return [String]
994
796
  attr_accessor :text
@@ -1005,16 +807,10 @@ module Google
1005
807
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentStyle>]
1006
808
  attr_accessor :text_styles
1007
809
 
1008
- # A list of translations on Document.text. For document shards, translations in
1009
- # this list may cross shard boundaries.
1010
- # Corresponds to the JSON property `translations`
1011
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentTranslation>]
1012
- attr_accessor :translations
1013
-
1014
- # Currently supports Google Cloud Storage URI of the form `gs://bucket_name/
1015
- # object_name`. Object versioning is not supported. See [Google Cloud Storage
1016
- # Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more
1017
- # info.
810
+ # Optional. Currently supports Google Cloud Storage URI of the form `gs://
811
+ # bucket_name/object_name`. Object versioning is not supported. See [Google
812
+ # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-
813
+ # uris) for more info.
1018
814
  # Corresponds to the JSON property `uri`
1019
815
  # @return [String]
1020
816
  attr_accessor :uri
@@ -1036,7 +832,6 @@ module Google
1036
832
  @text = args[:text] if args.key?(:text)
1037
833
  @text_changes = args[:text_changes] if args.key?(:text_changes)
1038
834
  @text_styles = args[:text_styles] if args.key?(:text_styles)
1039
- @translations = args[:translations] if args.key?(:translations)
1040
835
  @uri = args[:uri] if args.key?(:uri)
1041
836
  end
1042
837
  end
@@ -1057,12 +852,12 @@ module Google
1057
852
  # @return [String]
1058
853
  attr_accessor :id
1059
854
 
1060
- # Deprecated. Use `id` field instead.
855
+ # Optional. Deprecated. Use `id` field instead.
1061
856
  # Corresponds to the JSON property `mentionId`
1062
857
  # @return [String]
1063
858
  attr_accessor :mention_id
1064
859
 
1065
- # Text value in the document e.g. `1600 Amphitheatre Pkwy`.
860
+ # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
1066
861
  # Corresponds to the JSON property `mentionText`
1067
862
  # @return [String]
1068
863
  attr_accessor :mention_text
@@ -1145,6 +940,12 @@ module Google
1145
940
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypePostalAddress]
1146
941
  attr_accessor :address_value
1147
942
 
943
+ # Boolean value. Can be used for entities with binary values, or for checkboxes.
944
+ # Corresponds to the JSON property `booleanValue`
945
+ # @return [Boolean]
946
+ attr_accessor :boolean_value
947
+ alias_method :boolean_value?, :boolean_value
948
+
1148
949
  # Represents a whole or partial calendar date, such as a birthday. The time of
1149
950
  # day and time zone are either specified elsewhere or are insignificant. The
1150
951
  # date is relative to the Gregorian Calendar. This can represent one of the
@@ -1197,6 +998,7 @@ module Google
1197
998
  # Update properties of this object
1198
999
  def update!(**args)
1199
1000
  @address_value = args[:address_value] if args.key?(:address_value)
1001
+ @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
1200
1002
  @date_value = args[:date_value] if args.key?(:date_value)
1201
1003
  @datetime_value = args[:datetime_value] if args.key?(:datetime_value)
1202
1004
  @money_value = args[:money_value] if args.key?(:money_value)
@@ -2323,44 +2125,6 @@ module Google
2323
2125
  end
2324
2126
  end
2325
2127
 
2326
- # A translation of the text segment.
2327
- class GoogleCloudDocumentaiV1beta1DocumentTranslation
2328
- include Google::Apis::Core::Hashable
2329
-
2330
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
2331
- # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
2332
- # Corresponds to the JSON property `languageCode`
2333
- # @return [String]
2334
- attr_accessor :language_code
2335
-
2336
- # The history of this annotation.
2337
- # Corresponds to the JSON property `provenance`
2338
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentProvenance>]
2339
- attr_accessor :provenance
2340
-
2341
- # Text reference indexing into the Document.text.
2342
- # Corresponds to the JSON property `textAnchor`
2343
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentTextAnchor]
2344
- attr_accessor :text_anchor
2345
-
2346
- # Text translated into the target language.
2347
- # Corresponds to the JSON property `translatedText`
2348
- # @return [String]
2349
- attr_accessor :translated_text
2350
-
2351
- def initialize(**args)
2352
- update!(**args)
2353
- end
2354
-
2355
- # Update properties of this object
2356
- def update!(**args)
2357
- @language_code = args[:language_code] if args.key?(:language_code)
2358
- @provenance = args[:provenance] if args.key?(:provenance)
2359
- @text_anchor = args[:text_anchor] if args.key?(:text_anchor)
2360
- @translated_text = args[:translated_text] if args.key?(:translated_text)
2361
- end
2362
- end
2363
-
2364
2128
  # The Google Cloud Storage location where the output file will be written to.
2365
2129
  class GoogleCloudDocumentaiV1beta1GcsDestination
2366
2130
  include Google::Apis::Core::Hashable
@@ -2626,9 +2390,9 @@ module Google
2626
2390
  class GoogleCloudDocumentaiV1beta2Document
2627
2391
  include Google::Apis::Core::Hashable
2628
2392
 
2629
- # Inline document content, represented as a stream of bytes. Note: As with all `
2630
- # bytes` fields, protobuffers use a pure binary representation, whereas JSON
2631
- # representations use base64.
2393
+ # Optional. Inline document content, represented as a stream of bytes. Note: As
2394
+ # with all `bytes` fields, protobuffers use a pure binary representation,
2395
+ # whereas JSON representations use base64.
2632
2396
  # Corresponds to the JSON property `content`
2633
2397
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
2634
2398
  # @return [String]
@@ -2683,7 +2447,7 @@ module Google
2683
2447
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentShardInfo]
2684
2448
  attr_accessor :shard_info
2685
2449
 
2686
- # UTF-8 encoded text in reading order from the document.
2450
+ # Optional. UTF-8 encoded text in reading order from the document.
2687
2451
  # Corresponds to the JSON property `text`
2688
2452
  # @return [String]
2689
2453
  attr_accessor :text
@@ -2700,16 +2464,10 @@ module Google
2700
2464
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentStyle>]
2701
2465
  attr_accessor :text_styles
2702
2466
 
2703
- # A list of translations on Document.text. For document shards, translations in
2704
- # this list may cross shard boundaries.
2705
- # Corresponds to the JSON property `translations`
2706
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTranslation>]
2707
- attr_accessor :translations
2708
-
2709
- # Currently supports Google Cloud Storage URI of the form `gs://bucket_name/
2710
- # object_name`. Object versioning is not supported. See [Google Cloud Storage
2711
- # Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more
2712
- # info.
2467
+ # Optional. Currently supports Google Cloud Storage URI of the form `gs://
2468
+ # bucket_name/object_name`. Object versioning is not supported. See [Google
2469
+ # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-
2470
+ # uris) for more info.
2713
2471
  # Corresponds to the JSON property `uri`
2714
2472
  # @return [String]
2715
2473
  attr_accessor :uri
@@ -2732,7 +2490,6 @@ module Google
2732
2490
  @text = args[:text] if args.key?(:text)
2733
2491
  @text_changes = args[:text_changes] if args.key?(:text_changes)
2734
2492
  @text_styles = args[:text_styles] if args.key?(:text_styles)
2735
- @translations = args[:translations] if args.key?(:translations)
2736
2493
  @uri = args[:uri] if args.key?(:uri)
2737
2494
  end
2738
2495
  end
@@ -2753,12 +2510,12 @@ module Google
2753
2510
  # @return [String]
2754
2511
  attr_accessor :id
2755
2512
 
2756
- # Deprecated. Use `id` field instead.
2513
+ # Optional. Deprecated. Use `id` field instead.
2757
2514
  # Corresponds to the JSON property `mentionId`
2758
2515
  # @return [String]
2759
2516
  attr_accessor :mention_id
2760
2517
 
2761
- # Text value in the document e.g. `1600 Amphitheatre Pkwy`.
2518
+ # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
2762
2519
  # Corresponds to the JSON property `mentionText`
2763
2520
  # @return [String]
2764
2521
  attr_accessor :mention_text
@@ -2841,6 +2598,12 @@ module Google
2841
2598
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypePostalAddress]
2842
2599
  attr_accessor :address_value
2843
2600
 
2601
+ # Boolean value. Can be used for entities with binary values, or for checkboxes.
2602
+ # Corresponds to the JSON property `booleanValue`
2603
+ # @return [Boolean]
2604
+ attr_accessor :boolean_value
2605
+ alias_method :boolean_value?, :boolean_value
2606
+
2844
2607
  # Represents a whole or partial calendar date, such as a birthday. The time of
2845
2608
  # day and time zone are either specified elsewhere or are insignificant. The
2846
2609
  # date is relative to the Gregorian Calendar. This can represent one of the
@@ -2893,6 +2656,7 @@ module Google
2893
2656
  # Update properties of this object
2894
2657
  def update!(**args)
2895
2658
  @address_value = args[:address_value] if args.key?(:address_value)
2659
+ @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
2896
2660
  @date_value = args[:date_value] if args.key?(:date_value)
2897
2661
  @datetime_value = args[:datetime_value] if args.key?(:datetime_value)
2898
2662
  @money_value = args[:money_value] if args.key?(:money_value)
@@ -4056,44 +3820,6 @@ module Google
4056
3820
  end
4057
3821
  end
4058
3822
 
4059
- # A translation of the text segment.
4060
- class GoogleCloudDocumentaiV1beta2DocumentTranslation
4061
- include Google::Apis::Core::Hashable
4062
-
4063
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
4064
- # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
4065
- # Corresponds to the JSON property `languageCode`
4066
- # @return [String]
4067
- attr_accessor :language_code
4068
-
4069
- # The history of this annotation.
4070
- # Corresponds to the JSON property `provenance`
4071
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance>]
4072
- attr_accessor :provenance
4073
-
4074
- # Text reference indexing into the Document.text.
4075
- # Corresponds to the JSON property `textAnchor`
4076
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTextAnchor]
4077
- attr_accessor :text_anchor
4078
-
4079
- # Text translated into the target language.
4080
- # Corresponds to the JSON property `translatedText`
4081
- # @return [String]
4082
- attr_accessor :translated_text
4083
-
4084
- def initialize(**args)
4085
- update!(**args)
4086
- end
4087
-
4088
- # Update properties of this object
4089
- def update!(**args)
4090
- @language_code = args[:language_code] if args.key?(:language_code)
4091
- @provenance = args[:provenance] if args.key?(:provenance)
4092
- @text_anchor = args[:text_anchor] if args.key?(:text_anchor)
4093
- @translated_text = args[:translated_text] if args.key?(:translated_text)
4094
- end
4095
- end
4096
-
4097
3823
  # The Google Cloud Storage location where the output file will be written to.
4098
3824
  class GoogleCloudDocumentaiV1beta2GcsDestination
4099
3825
  include Google::Apis::Core::Hashable
@@ -4317,6 +4043,31 @@ module Google
4317
4043
  end
4318
4044
  end
4319
4045
 
4046
+ # The common config to specify a set of documents used as input.
4047
+ class GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig
4048
+ include Google::Apis::Core::Hashable
4049
+
4050
+ # Specifies a set of documents on Cloud Storage.
4051
+ # Corresponds to the JSON property `gcsDocuments`
4052
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocuments]
4053
+ attr_accessor :gcs_documents
4054
+
4055
+ # Specifies all documents on Cloud Storage with a common prefix.
4056
+ # Corresponds to the JSON property `gcsPrefix`
4057
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsPrefix]
4058
+ attr_accessor :gcs_prefix
4059
+
4060
+ def initialize(**args)
4061
+ update!(**args)
4062
+ end
4063
+
4064
+ # Update properties of this object
4065
+ def update!(**args)
4066
+ @gcs_documents = args[:gcs_documents] if args.key?(:gcs_documents)
4067
+ @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
4068
+ end
4069
+ end
4070
+
4320
4071
  # The long running operation metadata for batch process method.
4321
4072
  class GoogleCloudDocumentaiV1beta3BatchProcessMetadata
4322
4073
  include Google::Apis::Core::Hashable
@@ -4368,7 +4119,7 @@ module Google
4368
4119
  # The name of the operation triggered by the processed document. If the human
4369
4120
  # review process is not triggered, this field will be empty. It has the same
4370
4121
  # response type and metadata as the long running operation returned by
4371
- # ReviewDocument method. .
4122
+ # ReviewDocument method.
4372
4123
  # Corresponds to the JSON property `humanReviewOperation`
4373
4124
  # @return [String]
4374
4125
  attr_accessor :human_review_operation
@@ -4431,9 +4182,9 @@ module Google
4431
4182
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig>]
4432
4183
  attr_accessor :input_configs
4433
4184
 
4434
- # The message for input config in batch process.
4185
+ # The common config to specify a set of documents used as input.
4435
4186
  # Corresponds to the JSON property `inputDocuments`
4436
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig]
4187
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig]
4437
4188
  attr_accessor :input_documents
4438
4189
 
4439
4190
  # The message for output config in batch process.
@@ -4590,9 +4341,9 @@ module Google
4590
4341
  class GoogleCloudDocumentaiV1beta3Document
4591
4342
  include Google::Apis::Core::Hashable
4592
4343
 
4593
- # Inline document content, represented as a stream of bytes. Note: As with all `
4594
- # bytes` fields, protobuffers use a pure binary representation, whereas JSON
4595
- # representations use base64.
4344
+ # Optional. Inline document content, represented as a stream of bytes. Note: As
4345
+ # with all `bytes` fields, protobuffers use a pure binary representation,
4346
+ # whereas JSON representations use base64.
4596
4347
  # Corresponds to the JSON property `content`
4597
4348
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
4598
4349
  # @return [String]
@@ -4642,7 +4393,7 @@ module Google
4642
4393
  # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentShardInfo]
4643
4394
  attr_accessor :shard_info
4644
4395
 
4645
- # UTF-8 encoded text in reading order from the document.
4396
+ # Optional. UTF-8 encoded text in reading order from the document.
4646
4397
  # Corresponds to the JSON property `text`
4647
4398
  # @return [String]
4648
4399
  attr_accessor :text
@@ -4659,16 +4410,10 @@ module Google
4659
4410
  # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentStyle>]
4660
4411
  attr_accessor :text_styles
4661
4412
 
4662
- # A list of translations on Document.text. For document shards, translations in
4663
- # this list may cross shard boundaries.
4664
- # Corresponds to the JSON property `translations`
4665
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTranslation>]
4666
- attr_accessor :translations
4667
-
4668
- # Currently supports Google Cloud Storage URI of the form `gs://bucket_name/
4669
- # object_name`. Object versioning is not supported. See [Google Cloud Storage
4670
- # Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more
4671
- # info.
4413
+ # Optional. Currently supports Google Cloud Storage URI of the form `gs://
4414
+ # bucket_name/object_name`. Object versioning is not supported. See [Google
4415
+ # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-
4416
+ # uris) for more info.
4672
4417
  # Corresponds to the JSON property `uri`
4673
4418
  # @return [String]
4674
4419
  attr_accessor :uri
@@ -4690,7 +4435,6 @@ module Google
4690
4435
  @text = args[:text] if args.key?(:text)
4691
4436
  @text_changes = args[:text_changes] if args.key?(:text_changes)
4692
4437
  @text_styles = args[:text_styles] if args.key?(:text_styles)
4693
- @translations = args[:translations] if args.key?(:translations)
4694
4438
  @uri = args[:uri] if args.key?(:uri)
4695
4439
  end
4696
4440
  end
@@ -4711,12 +4455,12 @@ module Google
4711
4455
  # @return [String]
4712
4456
  attr_accessor :id
4713
4457
 
4714
- # Deprecated. Use `id` field instead.
4458
+ # Optional. Deprecated. Use `id` field instead.
4715
4459
  # Corresponds to the JSON property `mentionId`
4716
4460
  # @return [String]
4717
4461
  attr_accessor :mention_id
4718
4462
 
4719
- # Text value in the document e.g. `1600 Amphitheatre Pkwy`.
4463
+ # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
4720
4464
  # Corresponds to the JSON property `mentionText`
4721
4465
  # @return [String]
4722
4466
  attr_accessor :mention_text
@@ -4799,6 +4543,12 @@ module Google
4799
4543
  # @return [Google::Apis::DocumentaiV1beta3::GoogleTypePostalAddress]
4800
4544
  attr_accessor :address_value
4801
4545
 
4546
+ # Boolean value. Can be used for entities with binary values, or for checkboxes.
4547
+ # Corresponds to the JSON property `booleanValue`
4548
+ # @return [Boolean]
4549
+ attr_accessor :boolean_value
4550
+ alias_method :boolean_value?, :boolean_value
4551
+
4802
4552
  # Represents a whole or partial calendar date, such as a birthday. The time of
4803
4553
  # day and time zone are either specified elsewhere or are insignificant. The
4804
4554
  # date is relative to the Gregorian Calendar. This can represent one of the
@@ -4851,6 +4601,7 @@ module Google
4851
4601
  # Update properties of this object
4852
4602
  def update!(**args)
4853
4603
  @address_value = args[:address_value] if args.key?(:address_value)
4604
+ @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
4854
4605
  @date_value = args[:date_value] if args.key?(:date_value)
4855
4606
  @datetime_value = args[:datetime_value] if args.key?(:datetime_value)
4856
4607
  @money_value = args[:money_value] if args.key?(:money_value)
@@ -6016,30 +5767,58 @@ module Google
6016
5767
  end
6017
5768
  end
6018
5769
 
6019
- # A translation of the text segment.
6020
- class GoogleCloudDocumentaiV1beta3DocumentTranslation
5770
+ # Specifies a document stored on Cloud Storage.
5771
+ class GoogleCloudDocumentaiV1beta3GcsDocument
6021
5772
  include Google::Apis::Core::Hashable
6022
5773
 
6023
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
6024
- # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
6025
- # Corresponds to the JSON property `languageCode`
5774
+ # The Cloud Storage object uri.
5775
+ # Corresponds to the JSON property `gcsUri`
6026
5776
  # @return [String]
6027
- attr_accessor :language_code
5777
+ attr_accessor :gcs_uri
6028
5778
 
6029
- # The history of this annotation.
6030
- # Corresponds to the JSON property `provenance`
6031
- # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance>]
6032
- attr_accessor :provenance
5779
+ # An IANA MIME type (RFC6838) of the content.
5780
+ # Corresponds to the JSON property `mimeType`
5781
+ # @return [String]
5782
+ attr_accessor :mime_type
6033
5783
 
6034
- # Text reference indexing into the Document.text.
6035
- # Corresponds to the JSON property `textAnchor`
6036
- # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextAnchor]
6037
- attr_accessor :text_anchor
5784
+ def initialize(**args)
5785
+ update!(**args)
5786
+ end
6038
5787
 
6039
- # Text translated into the target language.
6040
- # Corresponds to the JSON property `translatedText`
5788
+ # Update properties of this object
5789
+ def update!(**args)
5790
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
5791
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
5792
+ end
5793
+ end
5794
+
5795
+ # Specifies a set of documents on Cloud Storage.
5796
+ class GoogleCloudDocumentaiV1beta3GcsDocuments
5797
+ include Google::Apis::Core::Hashable
5798
+
5799
+ # The list of documents.
5800
+ # Corresponds to the JSON property `documents`
5801
+ # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3GcsDocument>]
5802
+ attr_accessor :documents
5803
+
5804
+ def initialize(**args)
5805
+ update!(**args)
5806
+ end
5807
+
5808
+ # Update properties of this object
5809
+ def update!(**args)
5810
+ @documents = args[:documents] if args.key?(:documents)
5811
+ end
5812
+ end
5813
+
5814
+ # Specifies all documents on Cloud Storage with a common prefix.
5815
+ class GoogleCloudDocumentaiV1beta3GcsPrefix
5816
+ include Google::Apis::Core::Hashable
5817
+
5818
+ # The URI prefix.
5819
+ # Corresponds to the JSON property `gcsUriPrefix`
6041
5820
  # @return [String]
6042
- attr_accessor :translated_text
5821
+ attr_accessor :gcs_uri_prefix
6043
5822
 
6044
5823
  def initialize(**args)
6045
5824
  update!(**args)
@@ -6047,10 +5826,7 @@ module Google
6047
5826
 
6048
5827
  # Update properties of this object
6049
5828
  def update!(**args)
6050
- @language_code = args[:language_code] if args.key?(:language_code)
6051
- @provenance = args[:provenance] if args.key?(:provenance)
6052
- @text_anchor = args[:text_anchor] if args.key?(:text_anchor)
6053
- @translated_text = args[:translated_text] if args.key?(:translated_text)
5829
+ @gcs_uri_prefix = args[:gcs_uri_prefix] if args.key?(:gcs_uri_prefix)
6054
5830
  end
6055
5831
  end
6056
5832
 
@@ -6058,9 +5834,10 @@ module Google
6058
5834
  class GoogleCloudDocumentaiV1beta3HumanReviewStatus
6059
5835
  include Google::Apis::Core::Hashable
6060
5836
 
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.
5837
+ # The name of the operation triggered by the processed document. This field is
5838
+ # populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same
5839
+ # response type and metadata as the long running operation returned by [
5840
+ # ReviewDocument] method.
6064
5841
  # Corresponds to the JSON property `humanReviewOperation`
6065
5842
  # @return [String]
6066
5843
  attr_accessor :human_review_operation
@@ -6173,7 +5950,7 @@ module Google
6173
5950
  # The name of the operation triggered by the processed document. If the human
6174
5951
  # review process is not triggered, this field will be empty. It has the same
6175
5952
  # response type and metadata as the long running operation returned by
6176
- # ReviewDocument method. .
5953
+ # ReviewDocument method.
6177
5954
  # Corresponds to the JSON property `humanReviewOperation`
6178
5955
  # @return [String]
6179
5956
  attr_accessor :human_review_operation