Struct Entity 

#[non_exhaustive]
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,
    pub method: Method,
    /* private fields */
}

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 (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text_anchor: Option<TextAnchor>

Optional. Provenance of the entity. Text anchor indexing into the 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.

method: Method

Optional. Specifies how the entity’s value is obtained.

Implementations

impl Entity

pub fn new() -> Self

pub fn set_text_anchor<T>(self, v: T) -> Self

where T: Into<TextAnchor>,

Sets the value of text_anchor.

Example

use google_cloud_documentai_v1::model::document::TextAnchor;
let x = Entity::new().set_text_anchor(TextAnchor::default()/* use setters */);

pub fn set_or_clear_text_anchor<T>(self, v: Option<T>) -> Self

where T: Into<TextAnchor>,

Sets or clears the value of text_anchor.

Example

use google_cloud_documentai_v1::model::document::TextAnchor;
let x = Entity::new().set_or_clear_text_anchor(Some(TextAnchor::default()/* use setters */));
let x = Entity::new().set_or_clear_text_anchor(None::<TextAnchor>);

pub fn set_type<T: Into<String>>(self, v: T) -> Self

Sets the value of r#type.

Example

let x = Entity::new().set_type("example");

pub fn set_mention_text<T: Into<String>>(self, v: T) -> Self

Sets the value of mention_text.

Example

let x = Entity::new().set_mention_text("example");

pub fn set_mention_id<T: Into<String>>(self, v: T) -> Self

Sets the value of mention_id.

Example

let x = Entity::new().set_mention_id("example");

pub fn set_confidence<T: Into<f32>>(self, v: T) -> Self

Sets the value of confidence.

Example

let x = Entity::new().set_confidence(42.0);

pub fn set_page_anchor<T>(self, v: T) -> Self

where T: Into<PageAnchor>,

Sets the value of page_anchor.

Example

use google_cloud_documentai_v1::model::document::PageAnchor;
let x = Entity::new().set_page_anchor(PageAnchor::default()/* use setters */);

pub fn set_or_clear_page_anchor<T>(self, v: Option<T>) -> Self

where T: Into<PageAnchor>,

Sets or clears the value of page_anchor.

Example

use google_cloud_documentai_v1::model::document::PageAnchor;
let x = Entity::new().set_or_clear_page_anchor(Some(PageAnchor::default()/* use setters */));
let x = Entity::new().set_or_clear_page_anchor(None::<PageAnchor>);

pub fn set_id<T: Into<String>>(self, v: T) -> Self

Sets the value of id.

Example

let x = Entity::new().set_id("example");

pub fn set_normalized_value<T>(self, v: T) -> Self

where T: Into<NormalizedValue>,

Sets the value of normalized_value.

Example

use google_cloud_documentai_v1::model::document::entity::NormalizedValue;
let x = Entity::new().set_normalized_value(NormalizedValue::default()/* use setters */);

pub fn set_or_clear_normalized_value<T>(self, v: Option<T>) -> Self

where T: Into<NormalizedValue>,

Sets or clears the value of normalized_value.

Example

use google_cloud_documentai_v1::model::document::entity::NormalizedValue;
let x = Entity::new().set_or_clear_normalized_value(Some(NormalizedValue::default()/* use setters */));
let x = Entity::new().set_or_clear_normalized_value(None::<NormalizedValue>);

pub fn set_properties<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Entity>,

Sets the value of properties.

Example

let x = Entity::new()
    .set_properties([
        Entity::default()/* use setters */,
        Entity::default()/* use (different) setters */,
    ]);

pub fn set_provenance<T>(self, v: T) -> Self

where T: Into<Provenance>,

Sets the value of provenance.

Example

use google_cloud_documentai_v1::model::document::Provenance;
let x = Entity::new().set_provenance(Provenance::default()/* use setters */);

pub fn set_or_clear_provenance<T>(self, v: Option<T>) -> Self

where T: Into<Provenance>,

Sets or clears the value of provenance.

Example

use google_cloud_documentai_v1::model::document::Provenance;
let x = Entity::new().set_or_clear_provenance(Some(Provenance::default()/* use setters */));
let x = Entity::new().set_or_clear_provenance(None::<Provenance>);

pub fn set_redacted<T: Into<bool>>(self, v: T) -> Self

Sets the value of redacted.

Example

let x = Entity::new().set_redacted(true);

pub fn set_method<T: Into<Method>>(self, v: T) -> Self

Sets the value of method.

Example

use google_cloud_documentai_v1::model::document::entity::Method;
let x0 = Entity::new().set_method(Method::Extract);
let x1 = Entity::new().set_method(Method::Derive);

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate 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() -> Entity

Returns the “default value” for a type.

impl Message for Entity

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Entity

fn eq(&self, other: &Entity) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Entity