Skip to content

Commit 9a9c2f8

Browse files
docs: Regenerated REST and RPC Document AI documentation to include missing changes from September 2024 to November 2025 (#32376)
* docs: Regenerated REST and RPC Document AI documentation to include missing changes from September 2024 to November 2025 docs: Fixed language issues in multiple message field descriptions PiperOrigin-RevId: 859310712 Source-Link: googleapis/googleapis@64f7880 Source-Link: googleapis/googleapis-gen@fb3128f Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWRvY3VtZW50X2FpLXYxYmV0YTMvLk93bEJvdC55YW1sIiwiaCI6ImZiMzEyOGY0ZTU4ODYyZDBlMzNlZjU1MTBlYjNjYzQzMzMyYmFhNWQifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent cbe397e commit 9a9c2f8

File tree

2 files changed

+46
-42
lines changed

2 files changed

+46
-42
lines changed

google-cloud-document_ai-v1beta3/proto_docs/google/cloud/documentai/v1beta3/document.rb

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,9 @@ module V1beta3
9393
# @!attribute [rw] blob_assets
9494
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::BlobAsset>]
9595
# Optional. The blob assets in this document. This is used to store the
96-
# content of the inline blobs in this document, e.g. image bytes, such that
97-
# it can be referenced by other fields in the document via asset id.
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.
9899
# @!attribute [rw] entity_validation_output
99100
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::EntityValidationOutput]
100101
# The entity validation output for the document. This is the validation
@@ -106,10 +107,10 @@ module V1beta3
106107
# entity extraction results at different stages of the processing.
107108
# @!attribute [rw] entities_revision_id
108109
# @return [::String]
109-
# The entity revision id that `document.entities` field is based on.
110+
# The entity revision ID that `document.entities` field is based on.
110111
# If this field is set and `entities_revisions` is not empty, the entities in
111112
# `document.entities` field are the entities in the entity revision with this
112-
# id and `document.entity_validation_output` field is the
113+
# ID and `document.entity_validation_output` field is the
113114
# `entity_validation_output` field in this entity revision.
114115
class Document
115116
include ::Google::Protobuf::MessageExts
@@ -231,7 +232,7 @@ class FontSize
231232
# A list of visually detected tokens on the page.
232233
# @!attribute [rw] visual_elements
233234
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement>]
234-
# A list of detected non-text visual elements e.g. checkbox,
235+
# A list of detected non-text visual elements for example, checkbox,
235236
# signature etc. on the page.
236237
# @!attribute [rw] tables
237238
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table>]
@@ -322,9 +323,9 @@ class Matrix
322323
# @return [::Float]
323324
# Confidence of the current
324325
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} within
325-
# context of the object this layout is for. e.g. confidence can be for a
326-
# single token, a table, a visual element, etc. depending on context.
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]`.
328329
# @!attribute [rw] bounding_poly
329330
# @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
330331
# The bounding polygon for the
@@ -530,8 +531,8 @@ class Symbol
530531
extend ::Google::Protobuf::MessageExts::ClassMethods
531532
end
532533

533-
# Detected non-text visual elements e.g. checkbox, signature etc. on the
534-
# page.
534+
# Detected non-text visual elements, for example, checkbox, signature, etc.
535+
# on the page.
535536
# @!attribute [rw] layout
536537
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
537538
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
@@ -604,7 +605,8 @@ class TableCell
604605
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
605606
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
606607
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField}
607-
# name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
608+
# name. For example, `Address`, `Email`, `Grand total`, `Phone number`,
609+
# etc.
608610
# @!attribute [rw] field_value
609611
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
610612
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
@@ -715,10 +717,10 @@ class DetectedDefect
715717
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
716718
# @!attribute [rw] type
717719
# @return [::String]
718-
# Required. Entity type from a schema e.g. `Address`.
720+
# Required. Entity type from a schema for example, `Address`.
719721
# @!attribute [rw] mention_text
720722
# @return [::String]
721-
# Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
723+
# Optional. Text value of the entity for example, `1600 Amphitheatre Pkwy`.
722724
# @!attribute [rw] mention_id
723725
# @return [::String]
724726
# Optional. Deprecated. Use `id` field instead.
@@ -731,14 +733,14 @@ class DetectedDefect
731733
# the page where it was found.
732734
# @!attribute [rw] id
733735
# @return [::String]
734-
# Optional. Canonical id. This will be a unique value in the entity list
736+
# Optional. Canonical ID. This will be a unique value in the entity list
735737
# for this document.
736738
# @!attribute [rw] normalized_value
737739
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Entity::NormalizedValue]
738740
# Optional. Normalized entity value. Absent if the extracted value could
739-
# not be converted or the type (e.g. address) is not supported for certain
740-
# parsers. This field is also only populated for certain supported document
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.
742744
# @!attribute [rw] properties
743745
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
744746
# Optional. Entities can be nested to form a hierarchical data structure
@@ -841,10 +843,10 @@ module Method
841843
# {::Google::Cloud::DocumentAI::V1beta3::Document::Entity Entities}.
842844
# @!attribute [rw] subject_id
843845
# @return [::String]
844-
# Subject entity id.
846+
# Subject entity ID.
845847
# @!attribute [rw] object_id
846848
# @return [::String]
847-
# Object entity id.
849+
# Object entity ID.
848850
# @!attribute [rw] relation
849851
# @return [::String]
850852
# Relationship description.
@@ -984,7 +986,7 @@ module LayoutType
984986
# @!attribute [rw] id
985987
# @deprecated This field is deprecated and may be removed in the next major version update.
986988
# @return [::Integer]
987-
# The Id of this operation. Needs to be unique within the scope of the
989+
# The ID of this operation. Needs to be unique within the scope of the
988990
# revision.
989991
# @!attribute [rw] parents
990992
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Provenance::Parent>]
@@ -1008,7 +1010,7 @@ class Provenance
10081010
# @!attribute [rw] id
10091011
# @deprecated This field is deprecated and may be removed in the next major version update.
10101012
# @return [::Integer]
1011-
# The id of the parent provenance.
1013+
# The ID of the parent provenance.
10121014
class Parent
10131015
include ::Google::Protobuf::MessageExts
10141016
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1051,7 +1053,7 @@ module OperationType
10511053
# Contains past or forward revisions of this document.
10521054
# @!attribute [rw] agent
10531055
# @return [::String]
1054-
# If the change was made by a person specify the name or id of that
1056+
# If the change was made by a person specify the name or ID of that
10551057
# person.
10561058
#
10571059
# 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 OperationType
10631065
# 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.
10641066
# @!attribute [rw] id
10651067
# @return [::String]
1066-
# Id of the revision, internally generated by doc proto storage.
1068+
# ID of the revision, internally generated by doc proto storage.
10671069
# Unique within the context of the document.
10681070
# @!attribute [rw] parent
10691071
# @deprecated This field is deprecated and may be removed in the next major version update.
@@ -1073,7 +1075,7 @@ module OperationType
10731075
# index into the `revisions` field.
10741076
# @!attribute [rw] parent_ids
10751077
# @return [::Array<::String>]
1076-
# The revisions that this revision is based on. Must include all the ids
1078+
# The revisions that this revision is based on. Must include all the IDs
10771079
# that have anything to do with this revision - eg. there are
10781080
# `provenance.parent.revision` fields that index into this field.
10791081
# @!attribute [rw] create_time
@@ -1090,7 +1092,7 @@ class Revision
10901092
# Human Review information of the document.
10911093
# @!attribute [rw] state
10921094
# @return [::String]
1093-
# Human review state. e.g. `requested`, `succeeded`, `rejected`.
1095+
# Human review state. For example, `requested`, `succeeded`, `rejected`.
10941096
# @!attribute [rw] state_message
10951097
# @return [::String]
10961098
# A message providing more details about the current state of processing.
@@ -1277,22 +1279,22 @@ class LayoutListEntry
12771279
# Represents an image type block.
12781280
# @!attribute [rw] blob_asset_id
12791281
# @return [::String]
1280-
# Optional. Asset id of the inline image. If set, find the image
1282+
# Optional. Asset ID of the inline image. If set, find the image
12811283
# content in the blob_assets field.
12821284
#
12831285
# 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.
12841286
# @!attribute [rw] gcs_uri
12851287
# @return [::String]
1286-
# Optional. Google Cloud Storage uri of the image.
1288+
# Optional. Google Cloud Storage URI of the image.
12871289
#
12881290
# 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.
12891291
# @!attribute [rw] data_uri
12901292
# @return [::String]
1291-
# Optional. Data uri of the image.
1293+
# Optional. Data URI of the image.
12921294
# It is composed of four parts: a prefix (data:), a MIME type
12931295
# indicating the type of data, an optional base64 token if
12941296
# non-textual, and the data itself:
1295-
# data:[<mediatype>][;base64],<data>
1297+
# data:[<mediatype>][;base64],<data>.
12961298
#
12971299
# 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.
12981300
# @!attribute [rw] mime_type
@@ -1386,22 +1388,22 @@ class ChunkPageFooter
13861388
# The image chunk field in the chunk.
13871389
# @!attribute [rw] blob_asset_id
13881390
# @return [::String]
1389-
# Optional. Asset id of the inline image. If set, find the image
1391+
# Optional. Asset ID of the inline image. If set, find the image
13901392
# content in the blob_assets field.
13911393
#
13921394
# 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.
13931395
# @!attribute [rw] gcs_uri
13941396
# @return [::String]
1395-
# Optional. Google Cloud Storage uri of the image.
1397+
# Optional. Google Cloud Storage URI of the image.
13961398
#
13971399
# 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.
13981400
# @!attribute [rw] data_uri
13991401
# @return [::String]
1400-
# Optional. Data uri of the image.
1402+
# Optional. Data URI of the image.
14011403
# It is composed of four parts: a prefix (data:), a MIME type
14021404
# indicating the type of data, an optional base64 token if
14031405
# non-textual, and the data itself:
1404-
# data:[<mediatype>][;base64],<data>
1406+
# data:[<mediatype>][;base64],<data>.
14051407
#
14061408
# 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.
14071409
# @!attribute [rw] annotations
@@ -1422,7 +1424,7 @@ class TableChunkField
14221424
end
14231425

14241426
# The chunk field in the chunk. A chunk field could be one of the various
1425-
# types (e.g. image, table) supported.
1427+
# types (for example, image, table) supported.
14261428
# @!attribute [rw] image_chunk_field
14271429
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ImageChunkField]
14281430
# The image chunk field in the chunk.
@@ -1441,14 +1443,14 @@ class ChunkField
14411443
end
14421444

14431445
# Represents a blob asset. It's used to store the content of the inline blob
1444-
# in this document, e.g. image bytes, such that it can be referenced by
1445-
# other fields in the document via asset id.
1446+
# in this document, for example, image bytes, such that it can be referenced
1447+
# by other fields in the document via asset ID.
14461448
# @!attribute [rw] asset_id
14471449
# @return [::String]
1448-
# Optional. The id of the blob asset.
1450+
# Optional. The ID of the blob asset.
14491451
# @!attribute [rw] content
14501452
# @return [::String]
1451-
# Optional. The content of the blob asset, e.g. image bytes.
1453+
# Optional. The content of the blob asset, for example, image bytes.
14521454
# @!attribute [rw] mime_type
14531455
# @return [::String]
14541456
# The mime type of the blob asset.
@@ -1512,7 +1514,7 @@ module ValidationResultType
15121514
# Entity revision.
15131515
# @!attribute [rw] revision_id
15141516
# @return [::String]
1515-
# The revision id.
1517+
# The revision ID.
15161518
# @!attribute [rw] entities
15171519
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
15181520
# The entities in this revision.
@@ -1533,7 +1535,7 @@ class EntitiesRevision
15331535
# 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.
15341536
# @!attribute [rw] revision_id
15351537
# @return [::String]
1536-
# Reads the revision given by the id.
1538+
# Reads the revision given by the ID.
15371539
#
15381540
# 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.
15391541
# @!attribute [rw] latest_processor_version

google-cloud-document_ai-v1beta3/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,14 @@ class LayoutConfig
9595
# @!attribute [rw] semantic_chunking_group_size
9696
# @return [::Boolean]
9797
# Optional. The number of tokens to group together when evaluating
98-
# semantic similarity. THIS FIELD IS NOT YET USED.
98+
# semantic similarity.
99+
# **Note:** This field is not yet used.
99100
# @!attribute [rw] breakpoint_percentile_threshold
100101
# @return [::Integer]
101102
# Optional. The percentile of cosine dissimilarity that must be exceeded
102103
# between a group of tokens and the next. The smaller this number is, the
103-
# more chunks will be generated. THIS FIELD IS NOT YET USED.
104+
# more chunks will be generated.
105+
# **Note:** This field is not yet used.
104106
class ChunkingConfig
105107
include ::Google::Protobuf::MessageExts
106108
extend ::Google::Protobuf::MessageExts::ClassMethods

0 commit comments

Comments
 (0)