Cloud Natural Language V2 API - Class Google::Cloud::Language::V2::EntityMention (v1.2.1)

Reference documentation and code samples for the Cloud Natural Language V2 API class Google::Cloud::Language::V2::EntityMention.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#probability

def probability() -> ::Float
Returns
  • (::Float) — 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.

#probability=

def probability=(value) -> ::Float
Parameter
  • value (::Float) — 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.

Returns
  • (::Float) — 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.

#sentiment

def sentiment() -> ::Google::Cloud::Language::V2::Sentiment
Returns
  • (::Google::Cloud::Language::V2::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.

#sentiment=

def sentiment=(value) -> ::Google::Cloud::Language::V2::Sentiment
Parameter
  • value (::Google::Cloud::Language::V2::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.
Returns
  • (::Google::Cloud::Language::V2::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.

#text

def text() -> ::Google::Cloud::Language::V2::TextSpan
Returns

#text=

def text=(value) -> ::Google::Cloud::Language::V2::TextSpan
Parameter
Returns

#type

def type() -> ::Google::Cloud::Language::V2::EntityMention::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Language::V2::EntityMention::Type
Parameter
Returns