google_api_language

v0.2.0

google_api_language v0.2.0 GoogleApi.Language.V1.Model.Entity View Source

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 ([EntityMention]): The mentions of this entity in the input document. The API currently supports proper noun mentions. Defaults to: null.
  • metadata (%{optional(String.t) => String.t}): 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. Defaults to: null.
  • name (String.t): The representative name for the entity. Defaults to: null.
  • salience (float()): 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. Defaults to: null.
  • sentiment (Sentiment): 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. Defaults to: null.

  • type (String.t): The entity type. Defaults to: null.

    • Enum - one of [UNKNOWN, PERSON, LOCATION, ORGANIZATION, EVENT, WORK_OF_ART, CONSUMER_GOOD, OTHER, PHONE_NUMBER, ADDRESS, DATE, NUMBER, PRICE]

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source 
t() :: %GoogleApi.Language.V1.Model.Entity{
  mentions: [GoogleApi.Language.V1.Model.EntityMention.t()],
  metadata: map(),
  name: any(),
  salience: any(),
  sentiment: GoogleApi.Language.V1.Model.Sentiment.t(),
  type: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source 
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.