Skip to content

docs: Regenerated REST and RPC Document AI documentation to include missing changes from September 2024 to November 2025 #32376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aandreassa merged 2 commits into from
Jan 23, 2026
Merged

docs: Regenerated REST and RPC Document AI documentation to include missing changes from September 2024 to November 2025 #32376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77b84f1
docs: Regenerated REST and RPC Document AI documentation to include m…
gcf-owl-bot[bot] Jan 22, 2026
cf92174
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 42 additions & 40 deletions google-cloud-document_ai-v1beta3/proto_docs/google/cloud/documentai/v1beta3/document.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,9 @@ module V1beta3
# @!attribute [rw] blob_assets
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::BlobAsset>]
# Optional. The blob assets in this document. This is used to store the
# content of the inline blobs in this document, e.g. image bytes, such that
# it can be referenced by other fields in the document via asset id.
# content of the inline blobs in this document, for example, image bytes,
# such that it can be referenced by other fields in the document via asset
# id.
# @!attribute [rw] entity_validation_output
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::EntityValidationOutput]
# The entity validation output for the document. This is the validation
Expand All @@ -106,10 +107,10 @@ module V1beta3
# entity extraction results at different stages of the processing.
# @!attribute [rw] entities_revision_id
# @return [::String]
# The entity revision id that `document.entities` field is based on.
# The entity revision ID that `document.entities` field is based on.
# If this field is set and `entities_revisions` is not empty, the entities in
# `document.entities` field are the entities in the entity revision with this
# id and `document.entity_validation_output` field is the
# ID and `document.entity_validation_output` field is the
# `entity_validation_output` field in this entity revision.
class Document
include ::Google::Protobuf::MessageExts
Expand Down Expand Up @@ -231,7 +232,7 @@ class FontSize
# A list of visually detected tokens on the page.
# @!attribute [rw] visual_elements
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement>]
# A list of detected non-text visual elements e.g. checkbox,
# A list of detected non-text visual elements for example, checkbox,
# signature etc. on the page.
# @!attribute [rw] tables
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table>]
Expand Down Expand Up @@ -322,9 +323,9 @@ class Matrix
# @return [::Float]
# Confidence of the current
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} within
# context of the object this layout is for. e.g. confidence can be for a
# single token, a table, a visual element, etc. depending on context.
# Range `[0, 1]`.
# context of the object this layout is for. For example, confidence can
# be for a single token, a table, a visual element, etc. depending on
# context. Range `[0, 1]`.
# @!attribute [rw] bounding_poly
# @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
# The bounding polygon for the
Expand Down Expand Up @@ -530,8 +531,8 @@ class Symbol
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# Detected non-text visual elements e.g. checkbox, signature etc. on the
# page.
# Detected non-text visual elements, for example, checkbox, signature, etc.
# on the page.
# @!attribute [rw] layout
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
Expand Down Expand Up @@ -604,7 +605,8 @@ class TableCell
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField}
# name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
# name. For example, `Address`, `Email`, `Grand total`, `Phone number`,
# etc.
# @!attribute [rw] field_value
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
# {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
Expand Down Expand Up @@ -715,10 +717,10 @@ class DetectedDefect
# {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
# @!attribute [rw] type
# @return [::String]
# Required. Entity type from a schema e.g. `Address`.
# Required. Entity type from a schema for example, `Address`.
# @!attribute [rw] mention_text
# @return [::String]
# Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
# Optional. Text value of the entity for example, `1600 Amphitheatre Pkwy`.
# @!attribute [rw] mention_id
# @return [::String]
# Optional. Deprecated. Use `id` field instead.
Expand All @@ -731,14 +733,14 @@ class DetectedDefect
# the page where it was found.
# @!attribute [rw] id
# @return [::String]
# Optional. Canonical id. This will be a unique value in the entity list
# Optional. Canonical ID. This will be a unique value in the entity list
# for this document.
# @!attribute [rw] normalized_value
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::Entity::NormalizedValue]
# Optional. Normalized entity value. Absent if the extracted value could
# not be converted or the type (e.g. address) is not supported for certain
# parsers. This field is also only populated for certain supported document
# types.
# not be converted or the type (for example, address) is not supported for
# certain parsers. This field is also only populated for certain supported
# document types.
# @!attribute [rw] properties
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
# Optional. Entities can be nested to form a hierarchical data structure
Expand Down Expand Up @@ -841,10 +843,10 @@ module Method
# {::Google::Cloud::DocumentAI::V1beta3::Document::Entity Entities}.
# @!attribute [rw] subject_id
# @return [::String]
# Subject entity id.
# Subject entity ID.
# @!attribute [rw] object_id
# @return [::String]
# Object entity id.
# Object entity ID.
# @!attribute [rw] relation
# @return [::String]
# Relationship description.
Expand Down Expand Up @@ -984,7 +986,7 @@ module LayoutType
# @!attribute [rw] id
# @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Integer]
# The Id of this operation. Needs to be unique within the scope of the
# The ID of this operation. Needs to be unique within the scope of the
# revision.
# @!attribute [rw] parents
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Provenance::Parent>]
Expand All @@ -1008,7 +1010,7 @@ class Provenance
# @!attribute [rw] id
# @deprecated This field is deprecated and may be removed in the next major version update.
# @return [::Integer]
# The id of the parent provenance.
# The ID of the parent provenance.
class Parent
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -1051,7 +1053,7 @@ module OperationType
# Contains past or forward revisions of this document.
# @!attribute [rw] agent
# @return [::String]
# If the change was made by a person specify the name or id of that
# If the change was made by a person specify the name or ID of that
# person.
#
# 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.
Expand All @@ -1063,7 +1065,7 @@ module OperationType
# 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.
# @!attribute [rw] id
# @return [::String]
# Id of the revision, internally generated by doc proto storage.
# ID of the revision, internally generated by doc proto storage.
# Unique within the context of the document.
# @!attribute [rw] parent
# @deprecated This field is deprecated and may be removed in the next major version update.
Expand All @@ -1073,7 +1075,7 @@ module OperationType
# index into the `revisions` field.
# @!attribute [rw] parent_ids
# @return [::Array<::String>]
# The revisions that this revision is based on. Must include all the ids
# The revisions that this revision is based on. Must include all the IDs
# that have anything to do with this revision - eg. there are
# `provenance.parent.revision` fields that index into this field.
# @!attribute [rw] create_time
Expand All @@ -1090,7 +1092,7 @@ class Revision
# Human Review information of the document.
# @!attribute [rw] state
# @return [::String]
# Human review state. e.g. `requested`, `succeeded`, `rejected`.
# Human review state. For example, `requested`, `succeeded`, `rejected`.
# @!attribute [rw] state_message
# @return [::String]
# A message providing more details about the current state of processing.
Expand Down Expand Up @@ -1277,22 +1279,22 @@ class LayoutListEntry
# Represents an image type block.
# @!attribute [rw] blob_asset_id
# @return [::String]
# Optional. Asset id of the inline image. If set, find the image
# Optional. Asset ID of the inline image. If set, find the image
# content in the blob_assets field.
#
# 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.
# @!attribute [rw] gcs_uri
# @return [::String]
# Optional. Google Cloud Storage uri of the image.
# Optional. Google Cloud Storage URI of the image.
#
# 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.
# @!attribute [rw] data_uri
# @return [::String]
# Optional. Data uri of the image.
# Optional. Data URI of the image.
# It is composed of four parts: a prefix (data:), a MIME type
# indicating the type of data, an optional base64 token if
# non-textual, and the data itself:
# data:[<mediatype>][;base64],<data>
# data:[<mediatype>][;base64],<data>.
#
# 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.
# @!attribute [rw] mime_type
Expand Down Expand Up @@ -1386,22 +1388,22 @@ class ChunkPageFooter
# The image chunk field in the chunk.
# @!attribute [rw] blob_asset_id
# @return [::String]
# Optional. Asset id of the inline image. If set, find the image
# Optional. Asset ID of the inline image. If set, find the image
# content in the blob_assets field.
#
# 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.
# @!attribute [rw] gcs_uri
# @return [::String]
# Optional. Google Cloud Storage uri of the image.
# Optional. Google Cloud Storage URI of the image.
#
# 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.
# @!attribute [rw] data_uri
# @return [::String]
# Optional. Data uri of the image.
# Optional. Data URI of the image.
# It is composed of four parts: a prefix (data:), a MIME type
# indicating the type of data, an optional base64 token if
# non-textual, and the data itself:
# data:[<mediatype>][;base64],<data>
# data:[<mediatype>][;base64],<data>.
#
# 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.
# @!attribute [rw] annotations
Expand All @@ -1422,7 +1424,7 @@ class TableChunkField
end

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

# Represents a blob asset. It's used to store the content of the inline blob
# in this document, e.g. image bytes, such that it can be referenced by
# other fields in the document via asset id.
# in this document, for example, image bytes, such that it can be referenced
# by other fields in the document via asset ID.
# @!attribute [rw] asset_id
# @return [::String]
# Optional. The id of the blob asset.
# Optional. The ID of the blob asset.
# @!attribute [rw] content
# @return [::String]
# Optional. The content of the blob asset, e.g. image bytes.
# Optional. The content of the blob asset, for example, image bytes.
# @!attribute [rw] mime_type
# @return [::String]
# The mime type of the blob asset.
Expand Down Expand Up @@ -1512,7 +1514,7 @@ module ValidationResultType
# Entity revision.
# @!attribute [rw] revision_id
# @return [::String]
# The revision id.
# The revision ID.
# @!attribute [rw] entities
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
# The entities in this revision.
Expand All @@ -1533,7 +1535,7 @@ class EntitiesRevision
# 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.
# @!attribute [rw] revision_id
# @return [::String]
# Reads the revision given by the id.
# Reads the revision given by the ID.
#
# 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.
# @!attribute [rw] latest_processor_version
Expand Down
6 changes: 4 additions & 2 deletions ...ument_ai-v1beta3/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,14 @@ class LayoutConfig
# @!attribute [rw] semantic_chunking_group_size
# @return [::Boolean]
# Optional. The number of tokens to group together when evaluating
# semantic similarity. THIS FIELD IS NOT YET USED.
# semantic similarity.
# **Note:** This field is not yet used.
# @!attribute [rw] breakpoint_percentile_threshold
# @return [::Integer]
# Optional. The percentile of cosine dissimilarity that must be exceeded
# between a group of tokens and the next. The smaller this number is, the
# more chunks will be generated. THIS FIELD IS NOT YET USED.
# more chunks will be generated.
# **Note:** This field is not yet used.
class ChunkingConfig
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down
Loading