Struct google_api_proto::google::cloud::documentai::v1beta3::Document

pub struct Document {

    pub mime_type: String,
    pub text: String,
    pub text_styles: Vec<Style>,
    pub pages: Vec<Page>,
    pub entities: Vec<Entity>,
    pub entity_relations: Vec<EntityRelation>,
    pub text_changes: Vec<TextChange>,
    pub shard_info: Option<ShardInfo>,
    pub error: Option<Status>,
    pub revisions: Vec<Revision>,
    pub document_layout: Option<DocumentLayout>,
    pub chunked_document: Option<ChunkedDocument>,
    pub source: Option<Source>,
}

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

Fields

mime_type: String

An IANA published media type (MIME type).

text: String

Optional. UTF-8 encoded text in reading order from the document.

text_styles: Vec<Style>

👎Deprecated

Styles for the [Document.text][google.cloud.documentai.v1beta3.Document.text].

pages: Vec<Page>

Visual page layout for the [Document][google.cloud.documentai.v1beta3.Document].

entities: Vec<Entity>

A list of entities detected on [Document.text][google.cloud.documentai.v1beta3.Document.text]. For document shards, entities in this list may cross shard boundaries.

entity_relations: Vec<EntityRelation>

Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1beta3.Document.entities].

text_changes: Vec<TextChange>

Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.

shard_info: Option<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.

error: Option<Status>

Any error that occurred while processing this document.

revisions: Vec<Revision>

Placeholder. Revision history of this document.

document_layout: Option<DocumentLayout>

Parsed layout of the document.

chunked_document: Option<ChunkedDocument>

Document chunked based on chunking config.

source: Option<Source>

Original source document from the user.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl Message for Document

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Document