Struct EntityMention

#[non_exhaustive]
pub struct EntityMention {
    pub text: Option<TextSpan>,
    pub type: Type,
    pub sentiment: Option<Sentiment>,
    pub probability: f32,
}

Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

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: Option<TextSpan>

The mention text.

type: Type

The type of the entity mention.

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 sentiment expressed for this mention of the entity in the provided document.

probability: f32

Probability score associated with the entity.

The score shows the probability of the entity mention being the entity type. The score is in (0, 1] range.

Implementations

impl EntityMention

pub fn set_text<T: Into<Option<TextSpan>>>(self, v: T) -> Self

Sets the value of text.

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_probability<T: Into<f32>>(self, v: T) -> Self

Sets the value of probability.

Trait Implementations

impl Clone for EntityMention

fn clone(&self) -> EntityMention

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityMention

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

Formats the value using the given formatter.

impl Default for EntityMention

fn default() -> EntityMention

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EntityMention

where EntityMention: 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 EntityMention

fn typename() -> &'static str

The typename of this message.

impl PartialEq for EntityMention

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

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 EntityMention