View Source GoogleApi.Language.V1.Model.Entity (google_api_language v0.15.0)
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.
Attributes
-
mentions
(type:list(GoogleApi.Language.V1.Model.EntityMention.t)
, default:nil
) - The mentions of this entity in the input document. The API currently supports proper noun mentions. -
metadata
(type:map()
, default:nil
) - Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (wikipedia_url
) and Knowledge Graph MID (mid
), if they are available. For the metadata associated with other entity types, see the Type table below. -
name
(type:String.t
, default:nil
) - The representative name for the entity. -
salience
(type:number()
, default:nil
) - 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. -
sentiment
(type:GoogleApi.Language.V1.Model.Sentiment.t
, default:nil
) - For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document. -
type
(type:String.t
, default:nil
) - The entity type.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Language.V1.Model.Entity{ mentions: [GoogleApi.Language.V1.Model.EntityMention.t()] | nil, metadata: map() | nil, name: String.t() | nil, salience: number() | nil, sentiment: GoogleApi.Language.V1.Model.Sentiment.t() | nil, type: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.