Struct Entity

pub struct Entity {
    pub mentions: Option<Vec<EntityMention>>,
    pub metadata: Option<HashMap<String, String>>,
    pub name: Option<String>,
    pub salience: Option<f32>,
    pub type_: Option<String>,
}

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 salience and mentions, with entities.

This type is not used in any activity, and only used as part of another schema.

Fields

mentions: Option<Vec<EntityMention>>

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

metadata: Option<HashMap<String, String>>

Metadata associated with the entity. Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if available. The associated keys are “wikipedia_url” and “mid”, respectively.

name: Option<String>

The representative name for the entity.

salience: Option<f32>

The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.

type_: Option<String>

The entity type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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