Struct Entity

#[non_exhaustive]
pub struct Entity {
    pub name: String,
    pub type: Type,
    pub metadata: HashMap<String, String>,
    pub mentions: Vec<EntityMention>,
    pub sentiment: Option<Sentiment>,
}

Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as probability and mentions, with entities.

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.

name: String

The representative name for the entity.

type: Type

The entity type.

metadata: HashMap<String, String>

Metadata associated with the entity.

For the metadata associated with other entity types, see the Type table below.

mentions: Vec<EntityMention>

The mentions of this entity in the input document. The API currently supports proper noun mentions.

sentiment: Option<Sentiment>

For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.

Implementations

impl Entity

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

Sets the value of name.

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

Sets the value of r#type.

pub fn set_sentiment<T: Into<Option<Sentiment>>>(self, v: T) -> Self

Sets the value of sentiment.

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

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

Sets the value of mentions.

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

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of metadata.

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

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Entity

where Entity: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for Entity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Entity