Class Document (1.0.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.


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.
mime_type str
An IANA published MIME type (also referred to as media type). For more information, see types/media-types.xhtml.
text str
UTF-8 encoded text in reading order from the document.
text_styles Sequence[]
Styles for the Document.text.
pages Sequence[]
Visual page layout for the Document.
entities Sequence[]
A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
entity_relations Sequence[]
Relationship among Document.entities.
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 Sequence[]
Labels for this document.
error google.rpc.status_pb2.Status
Any error that occurred while processing this document.



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(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Relationship between Entities.


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.


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

A page in a Document. .. attribute:: page_number

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

:type: int


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

Referencing elements in Document.pages.


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(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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


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

Text reference indexing into the Document.text.