Struct google_api_proto::google::cloud::documentai::v1::document::Entity

pub struct Entity {
    pub text_anchor: Option<TextAnchor>,
    pub type: String,
    pub mention_text: String,
    pub mention_id: String,
    pub confidence: f32,
    pub page_anchor: Option<PageAnchor>,
    pub id: String,
    pub normalized_value: Option<NormalizedValue>,
    pub properties: Vec<Entity>,
    pub provenance: Option<Provenance>,
    pub redacted: bool,
}

An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.

Fields

text_anchor: Option<TextAnchor>

Optional. Provenance of the entity. Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text].

type: String

Required. Entity type from a schema e.g. Address.

mention_text: String

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

mention_id: String

Optional. Deprecated. Use id field instead.

confidence: f32

Optional. Confidence of detected Schema entity. Range \[0, 1\].

page_anchor: Option<PageAnchor>

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

id: String

Optional. Canonical id. This will be a unique value in the entity list for this document.

normalized_value: Option<NormalizedValue>

Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.

properties: Vec<Entity>

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

provenance: Option<Provenance>

Optional. The history of this annotation.

redacted: bool

Optional. Whether the entity will be redacted for de-identification purposes.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Self

Returns the “default value” for a type.

impl Message for Entity

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for Entity

fn eq(&self, other: &Entity) -> 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 Entity