Struct googapis::google::cloud::documentai::v1::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 source: Option<Source>,
}

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.

Fields

mime_type: String

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: String

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

text_styles: Vec<Style>

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

pages: Vec<Page>

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

entities: Vec<Entity>

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

entity_relations: Vec<EntityRelation>

Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].

text_changes: Vec<TextChange>

A list of text corrections made to [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>

Revision history of this document.

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 encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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, 

Encodes the message to a buffer.

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

Encodes the message to a newly allocated buffer.

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

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

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

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

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

Decodes an instance of the message from a buffer.

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

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

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

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, 

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

impl PartialEq<Document> 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: &Document) -> bool

This method tests for !=.

impl StructuralPartialEq for Document