google-cloud-document_ai-v1 1.11.0 → 1.12.1

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.
@@ -31,6 +31,8 @@ module Google
31
31
  # @!attribute [rw] selective_gapic_generation
32
32
  # @return [::Google::Api::SelectiveGapicGeneration]
33
33
  # Configuration for which RPCs should be generated in the GAPIC client.
34
+ #
35
+ # Note: This field should not be used in most cases.
34
36
  class CommonLanguageSettings
35
37
  include ::Google::Protobuf::MessageExts
36
38
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -141,9 +143,10 @@ module Google
141
143
  #
142
144
  # Example of a YAML configuration::
143
145
  #
144
- # publishing:
145
- # java_settings:
146
- # library_package: com.google.cloud.pubsub.v1
146
+ # publishing:
147
+ # library_settings:
148
+ # java_settings:
149
+ # library_package: com.google.cloud.pubsub.v1
147
150
  # @!attribute [rw] service_class_names
148
151
  # @return [::Google::Protobuf::Map{::String => ::String}]
149
152
  # Configure the Java class name to use instead of the service's for its
@@ -155,11 +158,11 @@ module Google
155
158
  #
156
159
  # Example of a YAML configuration::
157
160
  #
158
- # publishing:
159
- # java_settings:
160
- # service_class_names:
161
- # - google.pubsub.v1.Publisher: TopicAdmin
162
- # - google.pubsub.v1.Subscriber: SubscriptionAdmin
161
+ # publishing:
162
+ # java_settings:
163
+ # service_class_names:
164
+ # - google.pubsub.v1.Publisher: TopicAdmin
165
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
163
166
  # @!attribute [rw] common
164
167
  # @return [::Google::Api::CommonLanguageSettings]
165
168
  # Some settings.
@@ -190,6 +193,20 @@ module Google
190
193
  # @!attribute [rw] common
191
194
  # @return [::Google::Api::CommonLanguageSettings]
192
195
  # Some settings.
196
+ # @!attribute [rw] library_package
197
+ # @return [::String]
198
+ # The package name to use in Php. Clobbers the php_namespace option
199
+ # set in the protobuf. This should be used **only** by APIs
200
+ # who have already set the language_settings.php.package_name" field
201
+ # in gapic.yaml. API teams should use the protobuf php_namespace option
202
+ # where possible.
203
+ #
204
+ # Example of a YAML configuration::
205
+ #
206
+ # publishing:
207
+ # library_settings:
208
+ # php_settings:
209
+ # library_package: Google\Cloud\PubSub\V1
193
210
  class PhpSettings
194
211
  include ::Google::Protobuf::MessageExts
195
212
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -318,10 +335,12 @@ module Google
318
335
  # service names and values are the name to be used for the service client
319
336
  # and call options.
320
337
  #
321
- # publishing:
322
- # go_settings:
323
- # renamed_services:
324
- # Publisher: TopicAdmin
338
+ # Example:
339
+ #
340
+ # publishing:
341
+ # go_settings:
342
+ # renamed_services:
343
+ # Publisher: TopicAdmin
325
344
  class GoSettings
326
345
  include ::Google::Protobuf::MessageExts
327
346
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -344,10 +363,10 @@ module Google
344
363
  #
345
364
  # Example:
346
365
  #
347
- # publishing:
348
- # method_settings:
349
- # - selector: google.storage.control.v2.StorageControl.CreateFolder
350
- # # method settings for CreateFolder...
366
+ # publishing:
367
+ # method_settings:
368
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
369
+ # # method settings for CreateFolder...
351
370
  # @!attribute [rw] long_running
352
371
  # @return [::Google::Api::MethodSettings::LongRunning]
353
372
  # Describes settings to use for long-running operations when generating
@@ -356,14 +375,14 @@ module Google
356
375
  #
357
376
  # Example of a YAML configuration::
358
377
  #
359
- # publishing:
360
- # method_settings:
361
- # - selector: google.cloud.speech.v2.Speech.BatchRecognize
362
- # long_running:
363
- # initial_poll_delay: 60s # 1 minute
364
- # poll_delay_multiplier: 1.5
365
- # max_poll_delay: 360s # 6 minutes
366
- # total_poll_timeout: 54000s # 90 minutes
378
+ # publishing:
379
+ # method_settings:
380
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
381
+ # long_running:
382
+ # initial_poll_delay: 60s # 1 minute
383
+ # poll_delay_multiplier: 1.5
384
+ # max_poll_delay: 360s # 6 minutes
385
+ # total_poll_timeout: 54000s # 90 minutes
367
386
  # @!attribute [rw] auto_populated_fields
368
387
  # @return [::Array<::String>]
369
388
  # List of top-level fields of the request message, that should be
@@ -372,11 +391,24 @@ module Google
372
391
  #
373
392
  # Example of a YAML configuration:
374
393
  #
375
- # publishing:
376
- # method_settings:
377
- # - selector: google.example.v1.ExampleService.CreateExample
378
- # auto_populated_fields:
379
- # - request_id
394
+ # publishing:
395
+ # method_settings:
396
+ # - selector: google.example.v1.ExampleService.CreateExample
397
+ # auto_populated_fields:
398
+ # - request_id
399
+ # @!attribute [rw] batching
400
+ # @return [::Google::Api::BatchingConfigProto]
401
+ # Batching configuration for an API method in client libraries.
402
+ #
403
+ # Example of a YAML configuration:
404
+ #
405
+ # publishing:
406
+ # method_settings:
407
+ # - selector: google.example.v1.ExampleService.BatchCreateExample
408
+ # batching:
409
+ # element_count_threshold: 1000
410
+ # request_byte_threshold: 100000000
411
+ # delay_threshold_millis: 10
380
412
  class MethodSettings
381
413
  include ::Google::Protobuf::MessageExts
382
414
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -411,6 +443,8 @@ module Google
411
443
 
412
444
  # This message is used to configure the generation of a subset of the RPCs in
413
445
  # a service for client libraries.
446
+ #
447
+ # Note: This feature should not be used in most cases.
414
448
  # @!attribute [rw] methods
415
449
  # @return [::Array<::String>]
416
450
  # An allowlist of the fully qualified names of RPCs that should be included
@@ -428,6 +462,77 @@ module Google
428
462
  extend ::Google::Protobuf::MessageExts::ClassMethods
429
463
  end
430
464
 
465
+ # `BatchingConfigProto` defines the batching configuration for an API method.
466
+ # @!attribute [rw] thresholds
467
+ # @return [::Google::Api::BatchingSettingsProto]
468
+ # The thresholds which trigger a batched request to be sent.
469
+ # @!attribute [rw] batch_descriptor
470
+ # @return [::Google::Api::BatchingDescriptorProto]
471
+ # The request and response fields used in batching.
472
+ class BatchingConfigProto
473
+ include ::Google::Protobuf::MessageExts
474
+ extend ::Google::Protobuf::MessageExts::ClassMethods
475
+ end
476
+
477
+ # `BatchingSettingsProto` specifies a set of batching thresholds, each of
478
+ # which acts as a trigger to send a batch of messages as a request. At least
479
+ # one threshold must be positive nonzero.
480
+ # @!attribute [rw] element_count_threshold
481
+ # @return [::Integer]
482
+ # The number of elements of a field collected into a batch which, if
483
+ # exceeded, causes the batch to be sent.
484
+ # @!attribute [rw] request_byte_threshold
485
+ # @return [::Integer]
486
+ # The aggregated size of the batched field which, if exceeded, causes the
487
+ # batch to be sent. This size is computed by aggregating the sizes of the
488
+ # request field to be batched, not of the entire request message.
489
+ # @!attribute [rw] delay_threshold
490
+ # @return [::Google::Protobuf::Duration]
491
+ # The duration after which a batch should be sent, starting from the addition
492
+ # of the first message to that batch.
493
+ # @!attribute [rw] element_count_limit
494
+ # @return [::Integer]
495
+ # The maximum number of elements collected in a batch that could be accepted
496
+ # by server.
497
+ # @!attribute [rw] request_byte_limit
498
+ # @return [::Integer]
499
+ # The maximum size of the request that could be accepted by server.
500
+ # @!attribute [rw] flow_control_element_limit
501
+ # @return [::Integer]
502
+ # The maximum number of elements allowed by flow control.
503
+ # @!attribute [rw] flow_control_byte_limit
504
+ # @return [::Integer]
505
+ # The maximum size of data allowed by flow control.
506
+ # @!attribute [rw] flow_control_limit_exceeded_behavior
507
+ # @return [::Google::Api::FlowControlLimitExceededBehaviorProto]
508
+ # The behavior to take when the flow control limit is exceeded.
509
+ class BatchingSettingsProto
510
+ include ::Google::Protobuf::MessageExts
511
+ extend ::Google::Protobuf::MessageExts::ClassMethods
512
+ end
513
+
514
+ # `BatchingDescriptorProto` specifies the fields of the request message to be
515
+ # used for batching, and, optionally, the fields of the response message to be
516
+ # used for demultiplexing.
517
+ # @!attribute [rw] batched_field
518
+ # @return [::String]
519
+ # The repeated field in the request message to be aggregated by batching.
520
+ # @!attribute [rw] discriminator_fields
521
+ # @return [::Array<::String>]
522
+ # A list of the fields in the request message. Two requests will be batched
523
+ # together only if the values of every field specified in
524
+ # `request_discriminator_fields` is equal between the two requests.
525
+ # @!attribute [rw] subresponse_field
526
+ # @return [::String]
527
+ # Optional. When present, indicates the field in the response message to be
528
+ # used to demultiplex the response into multiple response messages, in
529
+ # correspondence with the multiple request messages originally batched
530
+ # together.
531
+ class BatchingDescriptorProto
532
+ include ::Google::Protobuf::MessageExts
533
+ extend ::Google::Protobuf::MessageExts::ClassMethods
534
+ end
535
+
431
536
  # The organization for which the client libraries are being published.
432
537
  # Affects the url where generated docs are published, etc.
433
538
  module ClientLibraryOrganization
@@ -469,5 +574,20 @@ module Google
469
574
  # Publish the library to package managers like nuget.org and npmjs.com.
470
575
  PACKAGE_MANAGER = 20
471
576
  end
577
+
578
+ # The behavior to take when the flow control limit is exceeded.
579
+ module FlowControlLimitExceededBehaviorProto
580
+ # Default behavior, system-defined.
581
+ UNSET_BEHAVIOR = 0
582
+
583
+ # Stop operation, raise error.
584
+ THROW_EXCEPTION = 1
585
+
586
+ # Pause operation until limit clears.
587
+ BLOCK = 2
588
+
589
+ # Continue operation, disregard limit.
590
+ IGNORE = 3
591
+ end
472
592
  end
473
593
  end
@@ -88,6 +88,12 @@ module Google
88
88
  # @!attribute [rw] chunked_document
89
89
  # @return [::Google::Cloud::DocumentAI::V1::Document::ChunkedDocument]
90
90
  # Document chunked based on chunking config.
91
+ # @!attribute [rw] blob_assets
92
+ # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::BlobAsset>]
93
+ # Optional. The blob assets in this document. This is used to store the
94
+ # content of the inline blobs in this document, for example, image bytes,
95
+ # such that it can be referenced by other fields in the document via asset
96
+ # id.
91
97
  # @!attribute [rw] entity_validation_output
92
98
  # @return [::Google::Cloud::DocumentAI::V1::Document::EntityValidationOutput]
93
99
  # The entity validation output for the document. This is the validation
@@ -102,7 +108,7 @@ module Google
102
108
  # The entity revision ID that `document.entities` field is based on.
103
109
  # If this field is set and `entities_revisions` is not empty, the entities in
104
110
  # `document.entities` field are the entities in the entity revision with this
105
- # ID and `document.entity_validation_output` field is the
111
+ # id and `document.entity_validation_output` field is the
106
112
  # `entity_validation_output` field in this entity revision.
107
113
  class Document
108
114
  include ::Google::Protobuf::MessageExts
@@ -222,7 +228,7 @@ module Google
222
228
  # A list of visually detected tokens on the page.
223
229
  # @!attribute [rw] visual_elements
224
230
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement>]
225
- # A list of detected non-text visual elements e.g. checkbox,
231
+ # A list of detected non-text visual elements, for example, checkbox,
226
232
  # signature etc. on the page.
227
233
  # @!attribute [rw] tables
228
234
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table>]
@@ -313,9 +319,9 @@ module Google
313
319
  # @return [::Float]
314
320
  # Confidence of the current
315
321
  # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within
316
- # context of the object this layout is for. e.g. confidence can be for a
317
- # single token, a table, a visual element, etc. depending on context.
318
- # Range `[0, 1]`.
322
+ # context of the object this layout is for. For example, confidence can
323
+ # be for a single token, a table, a visual element, etc. depending on
324
+ # context. Range `[0, 1]`.
319
325
  # @!attribute [rw] bounding_poly
320
326
  # @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
321
327
  # The bounding polygon for the
@@ -521,8 +527,8 @@ module Google
521
527
  extend ::Google::Protobuf::MessageExts::ClassMethods
522
528
  end
523
529
 
524
- # Detected non-text visual elements e.g. checkbox, signature etc. on the
525
- # page.
530
+ # Detected non-text visual elements, for example, checkbox, signature etc.
531
+ # on the page.
526
532
  # @!attribute [rw] layout
527
533
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
528
534
  # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
@@ -595,7 +601,7 @@ module Google
595
601
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
596
602
  # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
597
603
  # {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name.
598
- # e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
604
+ # For example, `Address`, `Email`, `Grand total`, `Phone number`, etc.
599
605
  # @!attribute [rw] field_value
600
606
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
601
607
  # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
@@ -705,10 +711,11 @@ module Google
705
711
  # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
706
712
  # @!attribute [rw] type
707
713
  # @return [::String]
708
- # Required. Entity type from a schema e.g. `Address`.
714
+ # Required. Entity type from a schema, for example, `Address`.
709
715
  # @!attribute [rw] mention_text
710
716
  # @return [::String]
711
- # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
717
+ # Optional. Text value of the entity, for example, `1600 Amphitheatre
718
+ # Pkwy`.
712
719
  # @!attribute [rw] mention_id
713
720
  # @return [::String]
714
721
  # Optional. Deprecated. Use `id` field instead.
@@ -726,9 +733,9 @@ module Google
726
733
  # @!attribute [rw] normalized_value
727
734
  # @return [::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue]
728
735
  # Optional. Normalized entity value. Absent if the extracted value could
729
- # not be converted or the type (e.g. address) is not supported for certain
730
- # parsers. This field is also only populated for certain supported document
731
- # types.
736
+ # not be converted or the type (for example, address) is not supported for
737
+ # certain parsers. This field is also only populated for certain supported
738
+ # document types.
732
739
  # @!attribute [rw] properties
733
740
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
734
741
  # Optional. Entities can be nested to form a hierarchical data structure
@@ -790,6 +797,9 @@ module Google
790
797
  # Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
791
798
  # @!attribute [rw] signature_value
792
799
  # @return [::Boolean]
800
+ # A signature - a graphical representation of a person's name,
801
+ # often used to sign a document.
802
+ #
793
803
  # Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
794
804
  # @!attribute [rw] text
795
805
  # @return [::String]
@@ -1076,7 +1086,7 @@ module Google
1076
1086
  # Human Review information of the document.
1077
1087
  # @!attribute [rw] state
1078
1088
  # @return [::String]
1079
- # Human review state. e.g. `requested`, `succeeded`, `rejected`.
1089
+ # Human review state. For example, `requested`, `succeeded`, `rejected`.
1080
1090
  # @!attribute [rw] state_message
1081
1091
  # @return [::String]
1082
1092
  # A message providing more details about the current state of processing.
@@ -1108,6 +1118,15 @@ module Google
1108
1118
  extend ::Google::Protobuf::MessageExts::ClassMethods
1109
1119
  end
1110
1120
 
1121
+ # Represents the annotation of a block or a chunk.
1122
+ # @!attribute [rw] description
1123
+ # @return [::String]
1124
+ # The description of the content with this annotation.
1125
+ class Annotations
1126
+ include ::Google::Protobuf::MessageExts
1127
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1128
+ end
1129
+
1111
1130
  # Represents the parsed layout of a document as a collection of blocks that
1112
1131
  # the document is divided into.
1113
1132
  # @!attribute [rw] blocks
@@ -1123,17 +1142,22 @@ module Google
1123
1142
  # @return [::Google::Cloud::DocumentAI::V1::Document::DocumentLayout::DocumentLayoutBlock::LayoutTextBlock]
1124
1143
  # Block consisting of text content.
1125
1144
  #
1126
- # Note: The following fields are mutually exclusive: `text_block`, `table_block`, `list_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1145
+ # Note: The following fields are mutually exclusive: `text_block`, `table_block`, `list_block`, `image_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1127
1146
  # @!attribute [rw] table_block
1128
1147
  # @return [::Google::Cloud::DocumentAI::V1::Document::DocumentLayout::DocumentLayoutBlock::LayoutTableBlock]
1129
1148
  # Block consisting of table content/structure.
1130
1149
  #
1131
- # Note: The following fields are mutually exclusive: `table_block`, `text_block`, `list_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1150
+ # Note: The following fields are mutually exclusive: `table_block`, `text_block`, `list_block`, `image_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1132
1151
  # @!attribute [rw] list_block
1133
1152
  # @return [::Google::Cloud::DocumentAI::V1::Document::DocumentLayout::DocumentLayoutBlock::LayoutListBlock]
1134
1153
  # Block consisting of list content/structure.
1135
1154
  #
1136
- # Note: The following fields are mutually exclusive: `list_block`, `text_block`, `table_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1155
+ # Note: The following fields are mutually exclusive: `list_block`, `text_block`, `table_block`, `image_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1156
+ # @!attribute [rw] image_block
1157
+ # @return [::Google::Cloud::DocumentAI::V1::Document::DocumentLayout::DocumentLayoutBlock::LayoutImageBlock]
1158
+ # Block consisting of image content.
1159
+ #
1160
+ # Note: The following fields are mutually exclusive: `image_block`, `text_block`, `table_block`, `list_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1137
1161
  # @!attribute [rw] block_id
1138
1162
  # @return [::String]
1139
1163
  # ID of the block.
@@ -1172,6 +1196,9 @@ module Google
1172
1196
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::DocumentLayout::DocumentLayoutBlock>]
1173
1197
  # A text block could further have child blocks.
1174
1198
  # Repeated blocks support further hierarchies and nested blocks.
1199
+ # @!attribute [rw] annotations
1200
+ # @return [::Google::Cloud::DocumentAI::V1::Document::Annotations]
1201
+ # Annotation of the text block.
1175
1202
  class LayoutTextBlock
1176
1203
  include ::Google::Protobuf::MessageExts
1177
1204
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1187,6 +1214,9 @@ module Google
1187
1214
  # @!attribute [rw] caption
1188
1215
  # @return [::String]
1189
1216
  # Table caption/title.
1217
+ # @!attribute [rw] annotations
1218
+ # @return [::Google::Cloud::DocumentAI::V1::Document::Annotations]
1219
+ # Annotation of the table block.
1190
1220
  class LayoutTableBlock
1191
1221
  include ::Google::Protobuf::MessageExts
1192
1222
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1239,6 +1269,43 @@ module Google
1239
1269
  include ::Google::Protobuf::MessageExts
1240
1270
  extend ::Google::Protobuf::MessageExts::ClassMethods
1241
1271
  end
1272
+
1273
+ # Represents an image type block.
1274
+ # @!attribute [rw] blob_asset_id
1275
+ # @return [::String]
1276
+ # Optional. Asset id of the inline image. If set, find the image
1277
+ # content in the blob_assets field.
1278
+ #
1279
+ # Note: The following fields are mutually exclusive: `blob_asset_id`, `gcs_uri`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1280
+ # @!attribute [rw] gcs_uri
1281
+ # @return [::String]
1282
+ # Optional. Google Cloud Storage uri of the image.
1283
+ #
1284
+ # Note: The following fields are mutually exclusive: `gcs_uri`, `blob_asset_id`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1285
+ # @!attribute [rw] data_uri
1286
+ # @return [::String]
1287
+ # Optional. Data uri of the image.
1288
+ # It is composed of four parts: a prefix (data:), a MIME type
1289
+ # indicating the type of data, an optional base64 token if
1290
+ # non-textual, and the data itself:
1291
+ # data:[<mediatype>][;base64],<data>
1292
+ #
1293
+ # Note: The following fields are mutually exclusive: `data_uri`, `blob_asset_id`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1294
+ # @!attribute [rw] mime_type
1295
+ # @return [::String]
1296
+ # Mime type of the image. An IANA published [media type (MIME type)]
1297
+ # (https://www.iana.org/assignments/media-types/media-types.xhtml).
1298
+ # @!attribute [rw] image_text
1299
+ # @return [::String]
1300
+ # Text extracted from the image using OCR or alt text describing the
1301
+ # image.
1302
+ # @!attribute [rw] annotations
1303
+ # @return [::Google::Cloud::DocumentAI::V1::Document::Annotations]
1304
+ # Annotation of the image block.
1305
+ class LayoutImageBlock
1306
+ include ::Google::Protobuf::MessageExts
1307
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1308
+ end
1242
1309
  end
1243
1310
  end
1244
1311
 
@@ -1269,6 +1336,9 @@ module Google
1269
1336
  # @!attribute [rw] page_footers
1270
1337
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::ChunkedDocument::Chunk::ChunkPageFooter>]
1271
1338
  # Page footers associated with the chunk.
1339
+ # @!attribute [rw] chunk_fields
1340
+ # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::ChunkedDocument::Chunk::ChunkField>]
1341
+ # Chunk fields inside this chunk.
1272
1342
  class Chunk
1273
1343
  include ::Google::Protobuf::MessageExts
1274
1344
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1308,9 +1378,83 @@ module Google
1308
1378
  include ::Google::Protobuf::MessageExts
1309
1379
  extend ::Google::Protobuf::MessageExts::ClassMethods
1310
1380
  end
1381
+
1382
+ # The image chunk field in the chunk.
1383
+ # @!attribute [rw] blob_asset_id
1384
+ # @return [::String]
1385
+ # Optional. Asset id of the inline image. If set, find the image
1386
+ # content in the blob_assets field.
1387
+ #
1388
+ # Note: The following fields are mutually exclusive: `blob_asset_id`, `gcs_uri`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1389
+ # @!attribute [rw] gcs_uri
1390
+ # @return [::String]
1391
+ # Optional. Google Cloud Storage uri of the image.
1392
+ #
1393
+ # Note: The following fields are mutually exclusive: `gcs_uri`, `blob_asset_id`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1394
+ # @!attribute [rw] data_uri
1395
+ # @return [::String]
1396
+ # Optional. Data uri of the image.
1397
+ # It is composed of four parts: a prefix (data:), a MIME type
1398
+ # indicating the type of data, an optional base64 token if
1399
+ # non-textual, and the data itself:
1400
+ # data:[<mediatype>][;base64],<data>
1401
+ #
1402
+ # Note: The following fields are mutually exclusive: `data_uri`, `blob_asset_id`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1403
+ # @!attribute [rw] annotations
1404
+ # @return [::Google::Cloud::DocumentAI::V1::Document::Annotations]
1405
+ # Annotation of the image chunk field.
1406
+ class ImageChunkField
1407
+ include ::Google::Protobuf::MessageExts
1408
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1409
+ end
1410
+
1411
+ # The table chunk field in the chunk.
1412
+ # @!attribute [rw] annotations
1413
+ # @return [::Google::Cloud::DocumentAI::V1::Document::Annotations]
1414
+ # Annotation of the table chunk field.
1415
+ class TableChunkField
1416
+ include ::Google::Protobuf::MessageExts
1417
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1418
+ end
1419
+
1420
+ # The chunk field in the chunk. A chunk field could be one of the various
1421
+ # types (for example, image, table) supported.
1422
+ # @!attribute [rw] image_chunk_field
1423
+ # @return [::Google::Cloud::DocumentAI::V1::Document::ChunkedDocument::Chunk::ImageChunkField]
1424
+ # The image chunk field in the chunk.
1425
+ #
1426
+ # Note: The following fields are mutually exclusive: `image_chunk_field`, `table_chunk_field`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1427
+ # @!attribute [rw] table_chunk_field
1428
+ # @return [::Google::Cloud::DocumentAI::V1::Document::ChunkedDocument::Chunk::TableChunkField]
1429
+ # The table chunk field in the chunk.
1430
+ #
1431
+ # Note: The following fields are mutually exclusive: `table_chunk_field`, `image_chunk_field`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1432
+ class ChunkField
1433
+ include ::Google::Protobuf::MessageExts
1434
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1435
+ end
1311
1436
  end
1312
1437
  end
1313
1438
 
1439
+ # Represents a blob asset. It's used to store the content of the inline blob
1440
+ # in this document, for example, image bytes, such that it can be referenced
1441
+ # by other fields in the document via asset ID.
1442
+ # @!attribute [rw] asset_id
1443
+ # @return [::String]
1444
+ # Optional. The id of the blob asset.
1445
+ # @!attribute [rw] content
1446
+ # @return [::String]
1447
+ # Optional. The content of the blob asset, for example, image bytes.
1448
+ # @!attribute [rw] mime_type
1449
+ # @return [::String]
1450
+ # The mime type of the blob asset.
1451
+ # An IANA published [media type (MIME
1452
+ # type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
1453
+ class BlobAsset
1454
+ include ::Google::Protobuf::MessageExts
1455
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1456
+ end
1457
+
1314
1458
  # The output of the validation given the document and the validation rules.
1315
1459
  # @!attribute [rw] validation_results
1316
1460
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::EntityValidationOutput::ValidationResult>]
@@ -22,6 +22,9 @@ module Google
22
22
  # Wrapper message for `double`.
23
23
  #
24
24
  # The JSON representation for `DoubleValue` is JSON number.
25
+ #
26
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
27
+ # has no plan to be removed.
25
28
  # @!attribute [rw] value
26
29
  # @return [::Float]
27
30
  # The double value.
@@ -33,6 +36,9 @@ module Google
33
36
  # Wrapper message for `float`.
34
37
  #
35
38
  # The JSON representation for `FloatValue` is JSON number.
39
+ #
40
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
41
+ # has no plan to be removed.
36
42
  # @!attribute [rw] value
37
43
  # @return [::Float]
38
44
  # The float value.
@@ -44,6 +50,9 @@ module Google
44
50
  # Wrapper message for `int64`.
45
51
  #
46
52
  # The JSON representation for `Int64Value` is JSON string.
53
+ #
54
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
55
+ # has no plan to be removed.
47
56
  # @!attribute [rw] value
48
57
  # @return [::Integer]
49
58
  # The int64 value.
@@ -55,6 +64,9 @@ module Google
55
64
  # Wrapper message for `uint64`.
56
65
  #
57
66
  # The JSON representation for `UInt64Value` is JSON string.
67
+ #
68
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
69
+ # has no plan to be removed.
58
70
  # @!attribute [rw] value
59
71
  # @return [::Integer]
60
72
  # The uint64 value.
@@ -66,6 +78,9 @@ module Google
66
78
  # Wrapper message for `int32`.
67
79
  #
68
80
  # The JSON representation for `Int32Value` is JSON number.
81
+ #
82
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
83
+ # has no plan to be removed.
69
84
  # @!attribute [rw] value
70
85
  # @return [::Integer]
71
86
  # The int32 value.
@@ -77,6 +92,9 @@ module Google
77
92
  # Wrapper message for `uint32`.
78
93
  #
79
94
  # The JSON representation for `UInt32Value` is JSON number.
95
+ #
96
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
97
+ # has no plan to be removed.
80
98
  # @!attribute [rw] value
81
99
  # @return [::Integer]
82
100
  # The uint32 value.
@@ -88,6 +106,9 @@ module Google
88
106
  # Wrapper message for `bool`.
89
107
  #
90
108
  # The JSON representation for `BoolValue` is JSON `true` and `false`.
109
+ #
110
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
111
+ # has no plan to be removed.
91
112
  # @!attribute [rw] value
92
113
  # @return [::Boolean]
93
114
  # The bool value.
@@ -99,6 +120,9 @@ module Google
99
120
  # Wrapper message for `string`.
100
121
  #
101
122
  # The JSON representation for `StringValue` is JSON string.
123
+ #
124
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
125
+ # has no plan to be removed.
102
126
  # @!attribute [rw] value
103
127
  # @return [::String]
104
128
  # The string value.
@@ -110,6 +134,9 @@ module Google
110
134
  # Wrapper message for `bytes`.
111
135
  #
112
136
  # The JSON representation for `BytesValue` is JSON string.
137
+ #
138
+ # Not recommended for use in new APIs, but still useful for legacy APIs and
139
+ # has no plan to be removed.
113
140
  # @!attribute [rw] value
114
141
  # @return [::String]
115
142
  # The bytes value.
@@ -20,22 +20,22 @@
20
20
  module Google
21
21
  module Type
22
22
  # Represents a color in the RGBA color space. This representation is designed
23
- # for simplicity of conversion to/from color representations in various
23
+ # for simplicity of conversion to and from color representations in various
24
24
  # languages over compactness. For example, the fields of this representation
25
25
  # can be trivially provided to the constructor of `java.awt.Color` in Java; it
26
26
  # can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
27
27
  # method in iOS; and, with just a little work, it can be easily formatted into
28
28
  # a CSS `rgba()` string in JavaScript.
29
29
  #
30
- # This reference page doesn't carry information about the absolute color
31
- # space
32
- # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,
33
- # DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color
30
+ # This reference page doesn't have information about the absolute color
31
+ # space that should be used to interpret the RGB value—for example, sRGB,
32
+ # Adobe RGB,
33
+ # DCI-P3, and BT.2020. By default, applications should assume the sRGB color
34
34
  # space.
35
35
  #
36
- # When color equality needs to be decided, implementations, unless
37
- # documented otherwise, treat two colors as equal if all their red,
38
- # green, blue, and alpha values each differ by at most 1e-5.
36
+ # When color equality needs to be decided, implementations, unless documented
37
+ # otherwise, treat two colors as equal if all their red, green, blue, and alpha
38
+ # values each differ by at most `1e-5`.
39
39
  #
40
40
  # Example (Java):
41
41
  #