Class: Google::Apis::LanguageV1beta1::Sentiment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/language_v1beta1/classes.rb,
generated/google/apis/language_v1beta1/representations.rb,
generated/google/apis/language_v1beta1/representations.rb

Overview

Represents the feeling associated with the entire text or entities in the text.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Sentiment

Returns a new instance of Sentiment.



611
612
613
 
# File 'generated/google/apis/language_v1beta1/classes.rb', line 611

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#magnitude ⇒ Float

A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative). Corresponds to the JSON property magnitude

Returns:

  • (Float) 


596
597
598
 
# File 'generated/google/apis/language_v1beta1/classes.rb', line 596

def magnitude
  @magnitude
end

#polarity ⇒ Float

DEPRECATED FIELD - This field is being deprecated in favor of score. Please refer to our documentation at https://cloud.google.com/natural-language/docs for more information. Corresponds to the JSON property polarity

Returns:

  • (Float) 


603
604
605
 
# File 'generated/google/apis/language_v1beta1/classes.rb', line 603

def polarity
  @polarity
end

#score ⇒ Float

Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). Corresponds to the JSON property score

Returns:

  • (Float) 


609
610
611
 
# File 'generated/google/apis/language_v1beta1/classes.rb', line 609

def score
  @score
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



616
617
618
619
620
 
# File 'generated/google/apis/language_v1beta1/classes.rb', line 616

def update!(**args)
  @magnitude = args[:magnitude] if args.key?(:magnitude)
  @polarity = args[:polarity] if args.key?(:polarity)
  @score = args[:score] if args.key?(:score)
end