GoogleCloudDocumentaiV1Document

Struct GoogleCloudDocumentaiV1Document 

Source
pub struct GoogleCloudDocumentaiV1Document {
Show 18 fields pub chunked_document: Option<GoogleCloudDocumentaiV1DocumentChunkedDocument>, pub content: Option<Vec<u8>>, pub docid: Option<String>, pub document_layout: Option<GoogleCloudDocumentaiV1DocumentDocumentLayout>, pub entities: Option<Vec<GoogleCloudDocumentaiV1DocumentEntity>>, pub entities_revision_id: Option<String>, pub entities_revisions: Option<Vec<GoogleCloudDocumentaiV1DocumentEntitiesRevision>>, pub entity_relations: Option<Vec<GoogleCloudDocumentaiV1DocumentEntityRelation>>, pub entity_validation_output: Option<GoogleCloudDocumentaiV1DocumentEntityValidationOutput>, pub error: Option<GoogleRpcStatus>, pub mime_type: Option<String>, pub pages: Option<Vec<GoogleCloudDocumentaiV1DocumentPage>>, pub revisions: Option<Vec<GoogleCloudDocumentaiV1DocumentRevision>>, pub shard_info: Option<GoogleCloudDocumentaiV1DocumentShardInfo>, pub text: Option<String>, pub text_changes: Option<Vec<GoogleCloudDocumentaiV1DocumentTextChange>>, pub text_styles: Option<Vec<GoogleCloudDocumentaiV1DocumentStyle>>, pub uri: Option<String>,
}
Expand description

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.

This type is not used in any activity, and only used as part of another schema.

Fields§

§chunked_document: Option<GoogleCloudDocumentaiV1DocumentChunkedDocument>

Document chunked based on chunking config.

§content: Option<Vec<u8>>

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

§docid: Option<String>

Optional. An internal identifier for document. Should be loggable (no PII).

§document_layout: Option<GoogleCloudDocumentaiV1DocumentDocumentLayout>

Parsed layout of the document.

§entities: Option<Vec<GoogleCloudDocumentaiV1DocumentEntity>>

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

§entities_revision_id: Option<String>

The entity revision id that document.entities field is based on. If this field is set and entities_revisions is not empty, the entities in document.entities field are the entities in the entity revision with this id and document.entity_validation_output field is the entity_validation_output field in this entity revision.

§entities_revisions: Option<Vec<GoogleCloudDocumentaiV1DocumentEntitiesRevision>>

A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.

§entity_relations: Option<Vec<GoogleCloudDocumentaiV1DocumentEntityRelation>>

Placeholder. Relationship among Document.entities.

§entity_validation_output: Option<GoogleCloudDocumentaiV1DocumentEntityValidationOutput>

The entity validation output for the document. This is the validation output for document.entities field.

§error: Option<GoogleRpcStatus>

Any error that occurred while processing this document.

§mime_type: Option<String>

An IANA published media type (MIME type).

§pages: Option<Vec<GoogleCloudDocumentaiV1DocumentPage>>

Visual page layout for the Document.

§revisions: Option<Vec<GoogleCloudDocumentaiV1DocumentRevision>>

Placeholder. Revision history of this document.

§shard_info: Option<GoogleCloudDocumentaiV1DocumentShardInfo>

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.

§text: Option<String>

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

§text_changes: Option<Vec<GoogleCloudDocumentaiV1DocumentTextChange>>

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

§text_styles: Option<Vec<GoogleCloudDocumentaiV1DocumentStyle>>

Styles for the Document.text.

§uri: Option<String>

Optional. Currently supports Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. For more information, refer to Google Cloud Storage Request URIs.

Trait Implementations§

Source§

impl Clone for GoogleCloudDocumentaiV1Document

Source§

fn clone(&self) -> GoogleCloudDocumentaiV1Document

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GoogleCloudDocumentaiV1Document

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GoogleCloudDocumentaiV1Document

Source§

fn default() -> GoogleCloudDocumentaiV1Document

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for GoogleCloudDocumentaiV1Document

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for GoogleCloudDocumentaiV1Document

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Part for GoogleCloudDocumentaiV1Document

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,