Struct gapi_grpc::google::cloud::documentai::v1beta2::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 bounding_poly_for_demo_frontend: Option<BoundingPoly>,
}

A phrase in the text that is a known entity type, such as a person, an organization, or location.

Fields

text_anchor: Option<TextAnchor>

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

type: String

Entity type from a schema e.g. Address.

mention_text: String

Text value in the document e.g. 1600 Amphitheatre Pkwy.

mention_id: String

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.

bounding_poly_for_demo_frontend: Option<BoundingPoly>

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy of the value.

pub 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() -> Entity

Returns the “default value” for a type.

impl Message for Entity

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<Entity> 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: &Entity) -> bool

This method tests for !=.

impl StructuralPartialEq for Entity