Struct gapi_grpc::google::cloud::documentai::v1beta1::Document

[+] Show declaration

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 shard_info: Option<ShardInfo>,
    pub error: Option<Status>,
    pub source: Option<Source>,
}

[−] Expand description

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

[−] Expand description

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

[−] Expand description

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

text_styles: Vec<Style>

[−] Expand description

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

pages: Vec<Page>

[−] Expand description

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

entities: Vec<Entity>

[−] Expand description

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

entity_relations: Vec<EntityRelation>

[−] Expand description

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

shard_info: Option<ShardInfo>

[−] Expand description

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>

[−] Expand description

Any error that occurred while processing this document.

source: Option<Source>

[−] Expand description

Original source document from the user.

Trait Implementations

impl Clone for Document[+]

[+] Show hidden undocumented items

fn clone(&self) -> Document[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Document[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for Document[+]

[+] Show hidden undocumented items

fn default() -> Document[−]

Returns the “default value” for a type.

impl Message for Document[+]

[+] Show hidden undocumented items

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

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

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

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

Decodes an instance of the message from a buffer.

pub 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.

pub 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.

pub 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[+]

[+] Show hidden undocumented items

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