Struct EntityMention 

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

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 new() -> Self

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

where T: Into<TextSpan>,

Sets the value of text.

Example

use google_cloud_language_v2::model::TextSpan;
let x = EntityMention::new().set_text(TextSpan::default()/* use setters */);

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

where T: Into<TextSpan>,

Sets or clears the value of text.

Example

use google_cloud_language_v2::model::TextSpan;
let x = EntityMention::new().set_or_clear_text(Some(TextSpan::default()/* use setters */));
let x = EntityMention::new().set_or_clear_text(None::<TextSpan>);

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

Sets the value of r#type.

Example

use google_cloud_language_v2::model::entity_mention::Type;
let x0 = EntityMention::new().set_type(Type::Proper);
let x1 = EntityMention::new().set_type(Type::Common);

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

where T: Into<Sentiment>,

Sets the value of sentiment.

Example

use google_cloud_language_v2::model::Sentiment;
let x = EntityMention::new().set_sentiment(Sentiment::default()/* use setters */);

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

where T: Into<Sentiment>,

Sets or clears the value of sentiment.

Example

use google_cloud_language_v2::model::Sentiment;
let x = EntityMention::new().set_or_clear_sentiment(Some(Sentiment::default()/* use setters */));
let x = EntityMention::new().set_or_clear_sentiment(None::<Sentiment>);

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

Sets the value of probability.

Example

let x = EntityMention::new().set_probability(42.0);

Trait Implementations

impl Clone for EntityMention

fn clone(&self) -> EntityMention

Returns a duplicate 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 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 StructuralPartialEq for EntityMention