Class Document (2.10.0)

Document(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.

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
Name	Description
`uri`	`str` Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See `Google Cloud Storage Request URIs
`content`	`bytes` Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. This field is a member of `oneof`_ `source`.
`mime_type`	`str` An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.
`text`	`str` UTF-8 encoded text in reading order from the document.
`text_styles`	`MutableSequence[google.cloud.documentai_v1beta2.types.Document.Style]` Styles for the Document.text.
`pages`	`MutableSequence[google.cloud.documentai_v1beta2.types.Document.Page]` Visual page layout for the Document.
`entities`	`MutableSequence[google.cloud.documentai_v1beta2.types.Document.Entity]` A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
`entity_relations`	`MutableSequence[google.cloud.documentai_v1beta2.types.Document.EntityRelation]` Relationship among Document.entities.
`shard_info`	`google.cloud.documentai_v1beta2.types.Document.ShardInfo` Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
`labels`	`MutableSequence[google.cloud.documentai_v1beta2.types.Document.Label]` Labels for this document.
`error`	`google.rpc.status_pb2.Status` Any error that occurred while processing this document.

Classes

Entity

Entity(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A phrase in the text that is a known entity type, such as a person, an organization, or location.

EntityRelation

EntityRelation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Relationship between Entities.

Label

Label(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.

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

Page

Page(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A page in a Document.

PageAnchor

PageAnchor(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Referencing elements in Document.pages.

ShardInfo

ShardInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.

Style

Style(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Annotation for common text style attributes. This adheres to CSS conventions as much as possible.

TextAnchor

TextAnchor(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Text reference indexing into the Document.text.