Skip to content
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

feat: [google-cloud-documentai] Support a new Layout Processor in Document AI #12541

Merged
merged 4 commits into from
Apr 3, 2024
Merged

feat: [google-cloud-documentai] Support a new Layout Processor in Document AI #12541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51385a5
feat: Support a new Layout Processor in Document AI
gcf-owl-bot[bot] Apr 2, 2024
ab0ed74
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Apr 2, 2024
799c94c
chore: fix docs build in google-cloud-documentai (#12346)
parthea Feb 21, 2024
319b254
Merge branch 'main' into owl-bot-copy-packages-google-cloud-documentai
ohmayr Apr 3, 2024
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
325 changes: 325 additions & 0 deletions packages/google-cloud-documentai/google/cloud/documentai_v1beta3/types/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ class Document(proto.Message):
revisions (MutableSequence[google.cloud.documentai_v1beta3.types.Document.Revision]):
Placeholder. Revision history of this
document.
document_layout (google.cloud.documentai_v1beta3.types.Document.DocumentLayout):
Parsed layout of the document.
chunked_document (google.cloud.documentai_v1beta3.types.Document.ChunkedDocument):
Document chunked based on chunking config.
"""

class ShardInfo(proto.Message):
Expand Down Expand Up @@ -1811,6 +1815,317 @@ class TextChange(proto.Message):
message="Document.Provenance",
)

class DocumentLayout(proto.Message):
r"""Represents the parsed layout of a document as a collection of
blocks that the document is divided into.

Attributes:
blocks (MutableSequence[google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock]):
List of blocks in the document.
"""

class DocumentLayoutBlock(proto.Message):
r"""Represents a block. A block could be one of the various types
(text, table, list) supported.

This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes:
text_block (google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock):
Block consisting of text content.

This field is a member of `oneof`_ ``block``.
table_block (google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock):
Block consisting of table content/structure.

This field is a member of `oneof`_ ``block``.
list_block (google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock):
Block consisting of list content/structure.

This field is a member of `oneof`_ ``block``.
block_id (str):
ID of the block.
page_span (google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan):
Page span of the block.
"""

class LayoutPageSpan(proto.Message):
r"""Represents where the block starts and ends in the document.

Attributes:
page_start (int):
Page where block starts in the document.
page_end (int):
Page where block ends in the document.
"""

page_start: int = proto.Field(
proto.INT32,
number=1,
)
page_end: int = proto.Field(
proto.INT32,
number=2,
)

class LayoutTextBlock(proto.Message):
r"""Represents a text type block.

Attributes:
text (str):
Text content stored in the block.
type_ (str):
Type of the text in the block. Available options are:
``paragraph``, ``subtitle``, ``heading-1``, ``heading-2``,
``heading-3``, ``heading-4``, ``heading-5``, ``header``,
``footer``.
blocks (MutableSequence[google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock]):
A text block could further have child blocks.
Repeated blocks support further hierarchies and
nested blocks.
"""

text: str = proto.Field(
proto.STRING,
number=1,
)
type_: str = proto.Field(
proto.STRING,
number=2,
)
blocks: MutableSequence[
"Document.DocumentLayout.DocumentLayoutBlock"
] = proto.RepeatedField(
proto.MESSAGE,
number=3,
message="Document.DocumentLayout.DocumentLayoutBlock",
)

class LayoutTableBlock(proto.Message):
r"""Represents a table type block.

Attributes:
header_rows (MutableSequence[google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow]):
Header rows at the top of the table.
body_rows (MutableSequence[google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow]):
Body rows containing main table content.
caption (str):
Table caption/title.
"""

header_rows: MutableSequence[
"Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow",
)
body_rows: MutableSequence[
"Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow"
] = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow",
)
caption: str = proto.Field(
proto.STRING,
number=3,
)

class LayoutTableRow(proto.Message):
r"""Represents a row in a table.

Attributes:
cells (MutableSequence[google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableCell]):
A table row is a list of table cells.
"""

cells: MutableSequence[
"Document.DocumentLayout.DocumentLayoutBlock.LayoutTableCell"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="Document.DocumentLayout.DocumentLayoutBlock.LayoutTableCell",
)

class LayoutTableCell(proto.Message):
r"""Represents a cell in a table row.

Attributes:
blocks (MutableSequence[google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock]):
A table cell is a list of blocks.
Repeated blocks support further hierarchies and
nested blocks.
row_span (int):
How many rows this cell spans.
col_span (int):
How many columns this cell spans.
"""

blocks: MutableSequence[
"Document.DocumentLayout.DocumentLayoutBlock"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="Document.DocumentLayout.DocumentLayoutBlock",
)
row_span: int = proto.Field(
proto.INT32,
number=2,
)
col_span: int = proto.Field(
proto.INT32,
number=3,
)

class LayoutListBlock(proto.Message):
r"""Represents a list type block.

Attributes:
list_entries (MutableSequence[google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock.LayoutListEntry]):
List entries that constitute a list block.
type_ (str):
Type of the list_entries (if exist). Available options are
``ordered`` and ``unordered``.
"""

list_entries: MutableSequence[
"Document.DocumentLayout.DocumentLayoutBlock.LayoutListEntry"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="Document.DocumentLayout.DocumentLayoutBlock.LayoutListEntry",
)
type_: str = proto.Field(
proto.STRING,
number=2,
)

class LayoutListEntry(proto.Message):
r"""Represents an entry in the list.

Attributes:
blocks (MutableSequence[google.cloud.documentai_v1beta3.types.Document.DocumentLayout.DocumentLayoutBlock]):
A list entry is a list of blocks.
Repeated blocks support further hierarchies and
nested blocks.
"""

blocks: MutableSequence[
"Document.DocumentLayout.DocumentLayoutBlock"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="Document.DocumentLayout.DocumentLayoutBlock",
)

text_block: "Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock" = proto.Field(
proto.MESSAGE,
number=2,
oneof="block",
message="Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock",
)
table_block: "Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock" = proto.Field(
proto.MESSAGE,
number=3,
oneof="block",
message="Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock",
)
list_block: "Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock" = proto.Field(
proto.MESSAGE,
number=4,
oneof="block",
message="Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock",
)
block_id: str = proto.Field(
proto.STRING,
number=1,
)
page_span: "Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan" = proto.Field(
proto.MESSAGE,
number=5,
message="Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan",
)

blocks: MutableSequence[
"Document.DocumentLayout.DocumentLayoutBlock"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="Document.DocumentLayout.DocumentLayoutBlock",
)

class ChunkedDocument(proto.Message):
r"""Represents the chunks that the document is divided into.

Attributes:
chunks (MutableSequence[google.cloud.documentai_v1beta3.types.Document.ChunkedDocument.Chunk]):
List of chunks.
"""

class Chunk(proto.Message):
r"""Represents a chunk.

Attributes:
chunk_id (str):
ID of the chunk.
source_block_ids (MutableSequence[str]):
List of all parsed documents layout source
blocks used to generate the chunk.
content (str):
Text content of the chunk.
page_span (google.cloud.documentai_v1beta3.types.Document.ChunkedDocument.Chunk.ChunkPageSpan):
Page span of the chunk.
"""

class ChunkPageSpan(proto.Message):
r"""Represents where the chunk starts and ends in the document.

Attributes:
page_start (int):
Page where chunk starts in the document.
page_end (int):
Page where chunk ends in the document.
"""

page_start: int = proto.Field(
proto.INT32,
number=1,
)
page_end: int = proto.Field(
proto.INT32,
number=2,
)

chunk_id: str = proto.Field(
proto.STRING,
number=1,
)
source_block_ids: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=2,
)
content: str = proto.Field(
proto.STRING,
number=3,
)
page_span: "Document.ChunkedDocument.Chunk.ChunkPageSpan" = proto.Field(
proto.MESSAGE,
number=4,
message="Document.ChunkedDocument.Chunk.ChunkPageSpan",
)

chunks: MutableSequence["Document.ChunkedDocument.Chunk"] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="Document.ChunkedDocument.Chunk",
)

uri: str = proto.Field(
proto.STRING,
number=1,
Expand Down Expand Up @@ -1869,6 +2184,16 @@ class TextChange(proto.Message):
number=13,
message=Revision,
)
document_layout: DocumentLayout = proto.Field(
proto.MESSAGE,
number=17,
message=DocumentLayout,
)
chunked_document: ChunkedDocument = proto.Field(
proto.MESSAGE,
number=18,
message=ChunkedDocument,
)


class RevisionRef(proto.Message):
Expand Down
Loading
Loading