google-cloud-document_ai-v1beta3 0.46.1 → 0.46.2
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:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c1a368de39f48df24cfad831efe2fd53c49fd46de6052ab83339b9c0363a204d
|
|
4
|
+
data.tar.gz: '08b5d37dd299be3be1f0acd08ef01df9454ed8118f1309da867b6d5ddf40c9c1'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: dd81c63357caa3dc10a7dab67573cb385870e4fcb23130a49982e8de8036645ac6dec380e4fc56e8596981a32cb24183b7dfdf4449f6d5c529e1b4f172930388
|
|
7
|
+
data.tar.gz: 2f43ba1614f6026f28855a09fc04000890a40be73a04cb9bad0ad8531396779cec710dc66bd6a57368de1ef40451efe33655950e5605e54a40b08e94204a61dd
|
|
@@ -93,8 +93,9 @@ module Google
|
|
|
93
93
|
# @!attribute [rw] blob_assets
|
|
94
94
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::BlobAsset>]
|
|
95
95
|
# Optional. The blob assets in this document. This is used to store the
|
|
96
|
-
# content of the inline blobs in this document,
|
|
97
|
-
# it can be referenced by other fields in the document via asset
|
|
96
|
+
# content of the inline blobs in this document, for example, image bytes,
|
|
97
|
+
# such that it can be referenced by other fields in the document via asset
|
|
98
|
+
# id.
|
|
98
99
|
# @!attribute [rw] entity_validation_output
|
|
99
100
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::EntityValidationOutput]
|
|
100
101
|
# The entity validation output for the document. This is the validation
|
|
@@ -106,10 +107,10 @@ module Google
|
|
|
106
107
|
# entity extraction results at different stages of the processing.
|
|
107
108
|
# @!attribute [rw] entities_revision_id
|
|
108
109
|
# @return [::String]
|
|
109
|
-
# The entity revision
|
|
110
|
+
# The entity revision ID that `document.entities` field is based on.
|
|
110
111
|
# If this field is set and `entities_revisions` is not empty, the entities in
|
|
111
112
|
# `document.entities` field are the entities in the entity revision with this
|
|
112
|
-
#
|
|
113
|
+
# ID and `document.entity_validation_output` field is the
|
|
113
114
|
# `entity_validation_output` field in this entity revision.
|
|
114
115
|
class Document
|
|
115
116
|
include ::Google::Protobuf::MessageExts
|
|
@@ -231,7 +232,7 @@ module Google
|
|
|
231
232
|
# A list of visually detected tokens on the page.
|
|
232
233
|
# @!attribute [rw] visual_elements
|
|
233
234
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement>]
|
|
234
|
-
# A list of detected non-text visual elements
|
|
235
|
+
# A list of detected non-text visual elements for example, checkbox,
|
|
235
236
|
# signature etc. on the page.
|
|
236
237
|
# @!attribute [rw] tables
|
|
237
238
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table>]
|
|
@@ -322,9 +323,9 @@ module Google
|
|
|
322
323
|
# @return [::Float]
|
|
323
324
|
# Confidence of the current
|
|
324
325
|
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} within
|
|
325
|
-
# context of the object this layout is for.
|
|
326
|
-
# single token, a table, a visual element, etc. depending on
|
|
327
|
-
# Range `[0, 1]`.
|
|
326
|
+
# context of the object this layout is for. For example, confidence can
|
|
327
|
+
# be for a single token, a table, a visual element, etc. depending on
|
|
328
|
+
# context. Range `[0, 1]`.
|
|
328
329
|
# @!attribute [rw] bounding_poly
|
|
329
330
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
|
|
330
331
|
# The bounding polygon for the
|
|
@@ -530,8 +531,8 @@ module Google
|
|
|
530
531
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
531
532
|
end
|
|
532
533
|
|
|
533
|
-
# Detected non-text visual elements
|
|
534
|
-
# page.
|
|
534
|
+
# Detected non-text visual elements, for example, checkbox, signature, etc.
|
|
535
|
+
# on the page.
|
|
535
536
|
# @!attribute [rw] layout
|
|
536
537
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
537
538
|
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
|
|
@@ -604,7 +605,8 @@ module Google
|
|
|
604
605
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
605
606
|
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
|
|
606
607
|
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField}
|
|
607
|
-
# name.
|
|
608
|
+
# name. For example, `Address`, `Email`, `Grand total`, `Phone number`,
|
|
609
|
+
# etc.
|
|
608
610
|
# @!attribute [rw] field_value
|
|
609
611
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
|
|
610
612
|
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
|
|
@@ -715,10 +717,10 @@ module Google
|
|
|
715
717
|
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
|
|
716
718
|
# @!attribute [rw] type
|
|
717
719
|
# @return [::String]
|
|
718
|
-
# Required. Entity type from a schema
|
|
720
|
+
# Required. Entity type from a schema for example, `Address`.
|
|
719
721
|
# @!attribute [rw] mention_text
|
|
720
722
|
# @return [::String]
|
|
721
|
-
# Optional. Text value of the entity
|
|
723
|
+
# Optional. Text value of the entity for example, `1600 Amphitheatre Pkwy`.
|
|
722
724
|
# @!attribute [rw] mention_id
|
|
723
725
|
# @return [::String]
|
|
724
726
|
# Optional. Deprecated. Use `id` field instead.
|
|
@@ -731,14 +733,14 @@ module Google
|
|
|
731
733
|
# the page where it was found.
|
|
732
734
|
# @!attribute [rw] id
|
|
733
735
|
# @return [::String]
|
|
734
|
-
# Optional. Canonical
|
|
736
|
+
# Optional. Canonical ID. This will be a unique value in the entity list
|
|
735
737
|
# for this document.
|
|
736
738
|
# @!attribute [rw] normalized_value
|
|
737
739
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Entity::NormalizedValue]
|
|
738
740
|
# Optional. Normalized entity value. Absent if the extracted value could
|
|
739
|
-
# not be converted or the type (
|
|
740
|
-
# parsers. This field is also only populated for certain supported
|
|
741
|
-
# types.
|
|
741
|
+
# not be converted or the type (for example, address) is not supported for
|
|
742
|
+
# certain parsers. This field is also only populated for certain supported
|
|
743
|
+
# document types.
|
|
742
744
|
# @!attribute [rw] properties
|
|
743
745
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
|
|
744
746
|
# Optional. Entities can be nested to form a hierarchical data structure
|
|
@@ -841,10 +843,10 @@ module Google
|
|
|
841
843
|
# {::Google::Cloud::DocumentAI::V1beta3::Document::Entity Entities}.
|
|
842
844
|
# @!attribute [rw] subject_id
|
|
843
845
|
# @return [::String]
|
|
844
|
-
# Subject entity
|
|
846
|
+
# Subject entity ID.
|
|
845
847
|
# @!attribute [rw] object_id
|
|
846
848
|
# @return [::String]
|
|
847
|
-
# Object entity
|
|
849
|
+
# Object entity ID.
|
|
848
850
|
# @!attribute [rw] relation
|
|
849
851
|
# @return [::String]
|
|
850
852
|
# Relationship description.
|
|
@@ -984,7 +986,7 @@ module Google
|
|
|
984
986
|
# @!attribute [rw] id
|
|
985
987
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
986
988
|
# @return [::Integer]
|
|
987
|
-
# The
|
|
989
|
+
# The ID of this operation. Needs to be unique within the scope of the
|
|
988
990
|
# revision.
|
|
989
991
|
# @!attribute [rw] parents
|
|
990
992
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Provenance::Parent>]
|
|
@@ -1008,7 +1010,7 @@ module Google
|
|
|
1008
1010
|
# @!attribute [rw] id
|
|
1009
1011
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
1010
1012
|
# @return [::Integer]
|
|
1011
|
-
# The
|
|
1013
|
+
# The ID of the parent provenance.
|
|
1012
1014
|
class Parent
|
|
1013
1015
|
include ::Google::Protobuf::MessageExts
|
|
1014
1016
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -1051,7 +1053,7 @@ module Google
|
|
|
1051
1053
|
# Contains past or forward revisions of this document.
|
|
1052
1054
|
# @!attribute [rw] agent
|
|
1053
1055
|
# @return [::String]
|
|
1054
|
-
# If the change was made by a person specify the name or
|
|
1056
|
+
# If the change was made by a person specify the name or ID of that
|
|
1055
1057
|
# person.
|
|
1056
1058
|
#
|
|
1057
1059
|
# Note: The following fields are mutually exclusive: `agent`, `processor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
@@ -1063,7 +1065,7 @@ module Google
|
|
|
1063
1065
|
# Note: The following fields are mutually exclusive: `processor`, `agent`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
1064
1066
|
# @!attribute [rw] id
|
|
1065
1067
|
# @return [::String]
|
|
1066
|
-
#
|
|
1068
|
+
# ID of the revision, internally generated by doc proto storage.
|
|
1067
1069
|
# Unique within the context of the document.
|
|
1068
1070
|
# @!attribute [rw] parent
|
|
1069
1071
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
@@ -1073,7 +1075,7 @@ module Google
|
|
|
1073
1075
|
# index into the `revisions` field.
|
|
1074
1076
|
# @!attribute [rw] parent_ids
|
|
1075
1077
|
# @return [::Array<::String>]
|
|
1076
|
-
# The revisions that this revision is based on. Must include all the
|
|
1078
|
+
# The revisions that this revision is based on. Must include all the IDs
|
|
1077
1079
|
# that have anything to do with this revision - eg. there are
|
|
1078
1080
|
# `provenance.parent.revision` fields that index into this field.
|
|
1079
1081
|
# @!attribute [rw] create_time
|
|
@@ -1090,7 +1092,7 @@ module Google
|
|
|
1090
1092
|
# Human Review information of the document.
|
|
1091
1093
|
# @!attribute [rw] state
|
|
1092
1094
|
# @return [::String]
|
|
1093
|
-
# Human review state.
|
|
1095
|
+
# Human review state. For example, `requested`, `succeeded`, `rejected`.
|
|
1094
1096
|
# @!attribute [rw] state_message
|
|
1095
1097
|
# @return [::String]
|
|
1096
1098
|
# A message providing more details about the current state of processing.
|
|
@@ -1277,22 +1279,22 @@ module Google
|
|
|
1277
1279
|
# Represents an image type block.
|
|
1278
1280
|
# @!attribute [rw] blob_asset_id
|
|
1279
1281
|
# @return [::String]
|
|
1280
|
-
# Optional. Asset
|
|
1282
|
+
# Optional. Asset ID of the inline image. If set, find the image
|
|
1281
1283
|
# content in the blob_assets field.
|
|
1282
1284
|
#
|
|
1283
1285
|
# 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.
|
|
1284
1286
|
# @!attribute [rw] gcs_uri
|
|
1285
1287
|
# @return [::String]
|
|
1286
|
-
# Optional. Google Cloud Storage
|
|
1288
|
+
# Optional. Google Cloud Storage URI of the image.
|
|
1287
1289
|
#
|
|
1288
1290
|
# 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.
|
|
1289
1291
|
# @!attribute [rw] data_uri
|
|
1290
1292
|
# @return [::String]
|
|
1291
|
-
# Optional. Data
|
|
1293
|
+
# Optional. Data URI of the image.
|
|
1292
1294
|
# It is composed of four parts: a prefix (data:), a MIME type
|
|
1293
1295
|
# indicating the type of data, an optional base64 token if
|
|
1294
1296
|
# non-textual, and the data itself:
|
|
1295
|
-
# data:[<mediatype>][;base64],<data
|
|
1297
|
+
# data:[<mediatype>][;base64],<data>.
|
|
1296
1298
|
#
|
|
1297
1299
|
# 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.
|
|
1298
1300
|
# @!attribute [rw] mime_type
|
|
@@ -1386,22 +1388,22 @@ module Google
|
|
|
1386
1388
|
# The image chunk field in the chunk.
|
|
1387
1389
|
# @!attribute [rw] blob_asset_id
|
|
1388
1390
|
# @return [::String]
|
|
1389
|
-
# Optional. Asset
|
|
1391
|
+
# Optional. Asset ID of the inline image. If set, find the image
|
|
1390
1392
|
# content in the blob_assets field.
|
|
1391
1393
|
#
|
|
1392
1394
|
# 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.
|
|
1393
1395
|
# @!attribute [rw] gcs_uri
|
|
1394
1396
|
# @return [::String]
|
|
1395
|
-
# Optional. Google Cloud Storage
|
|
1397
|
+
# Optional. Google Cloud Storage URI of the image.
|
|
1396
1398
|
#
|
|
1397
1399
|
# 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.
|
|
1398
1400
|
# @!attribute [rw] data_uri
|
|
1399
1401
|
# @return [::String]
|
|
1400
|
-
# Optional. Data
|
|
1402
|
+
# Optional. Data URI of the image.
|
|
1401
1403
|
# It is composed of four parts: a prefix (data:), a MIME type
|
|
1402
1404
|
# indicating the type of data, an optional base64 token if
|
|
1403
1405
|
# non-textual, and the data itself:
|
|
1404
|
-
# data:[<mediatype>][;base64],<data
|
|
1406
|
+
# data:[<mediatype>][;base64],<data>.
|
|
1405
1407
|
#
|
|
1406
1408
|
# 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.
|
|
1407
1409
|
# @!attribute [rw] annotations
|
|
@@ -1422,7 +1424,7 @@ module Google
|
|
|
1422
1424
|
end
|
|
1423
1425
|
|
|
1424
1426
|
# The chunk field in the chunk. A chunk field could be one of the various
|
|
1425
|
-
# types (
|
|
1427
|
+
# types (for example, image, table) supported.
|
|
1426
1428
|
# @!attribute [rw] image_chunk_field
|
|
1427
1429
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ImageChunkField]
|
|
1428
1430
|
# The image chunk field in the chunk.
|
|
@@ -1441,14 +1443,14 @@ module Google
|
|
|
1441
1443
|
end
|
|
1442
1444
|
|
|
1443
1445
|
# Represents a blob asset. It's used to store the content of the inline blob
|
|
1444
|
-
# in this document,
|
|
1445
|
-
# other fields in the document via asset
|
|
1446
|
+
# in this document, for example, image bytes, such that it can be referenced
|
|
1447
|
+
# by other fields in the document via asset ID.
|
|
1446
1448
|
# @!attribute [rw] asset_id
|
|
1447
1449
|
# @return [::String]
|
|
1448
|
-
# Optional. The
|
|
1450
|
+
# Optional. The ID of the blob asset.
|
|
1449
1451
|
# @!attribute [rw] content
|
|
1450
1452
|
# @return [::String]
|
|
1451
|
-
# Optional. The content of the blob asset,
|
|
1453
|
+
# Optional. The content of the blob asset, for example, image bytes.
|
|
1452
1454
|
# @!attribute [rw] mime_type
|
|
1453
1455
|
# @return [::String]
|
|
1454
1456
|
# The mime type of the blob asset.
|
|
@@ -1512,7 +1514,7 @@ module Google
|
|
|
1512
1514
|
# Entity revision.
|
|
1513
1515
|
# @!attribute [rw] revision_id
|
|
1514
1516
|
# @return [::String]
|
|
1515
|
-
# The revision
|
|
1517
|
+
# The revision ID.
|
|
1516
1518
|
# @!attribute [rw] entities
|
|
1517
1519
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
|
|
1518
1520
|
# The entities in this revision.
|
|
@@ -1533,7 +1535,7 @@ module Google
|
|
|
1533
1535
|
# Note: The following fields are mutually exclusive: `revision_case`, `revision_id`, `latest_processor_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
1534
1536
|
# @!attribute [rw] revision_id
|
|
1535
1537
|
# @return [::String]
|
|
1536
|
-
# Reads the revision given by the
|
|
1538
|
+
# Reads the revision given by the ID.
|
|
1537
1539
|
#
|
|
1538
1540
|
# Note: The following fields are mutually exclusive: `revision_id`, `revision_case`, `latest_processor_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
1539
1541
|
# @!attribute [rw] latest_processor_version
|
|
@@ -95,12 +95,14 @@ module Google
|
|
|
95
95
|
# @!attribute [rw] semantic_chunking_group_size
|
|
96
96
|
# @return [::Boolean]
|
|
97
97
|
# Optional. The number of tokens to group together when evaluating
|
|
98
|
-
# semantic similarity.
|
|
98
|
+
# semantic similarity.
|
|
99
|
+
# **Note:** This field is not yet used.
|
|
99
100
|
# @!attribute [rw] breakpoint_percentile_threshold
|
|
100
101
|
# @return [::Integer]
|
|
101
102
|
# Optional. The percentile of cosine dissimilarity that must be exceeded
|
|
102
103
|
# between a group of tokens and the next. The smaller this number is, the
|
|
103
|
-
# more chunks will be generated.
|
|
104
|
+
# more chunks will be generated.
|
|
105
|
+
# **Note:** This field is not yet used.
|
|
104
106
|
class ChunkingConfig
|
|
105
107
|
include ::Google::Protobuf::MessageExts
|
|
106
108
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|