Class: Google::Cloud::Language::Annotation::Sentence

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/language/annotation.rb

Overview

Represents a piece of text including relative location.

Examples:

require "google/cloud/language"

language = Google::Cloud::Language.new

content = "Star Wars is a great movie. The Death Star is fearsome."
document = language.document content
annotation = document.annotate

annotation.sentences.count #=> 2
sentence = annotation.sentences.first
sentence.text #=> "Star Wars is a great movie."
sentence.offset #=> 0

Defined Under Namespace

Classes: Sentiment

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#sentiment ⇒ Sentence::Sentiment (readonly)

The sentence sentiment.

Returns:



375
376
377
 
# File 'lib/google/cloud/language/annotation.rb', line 375

def sentiment
  @sentiment
end

#text_span ⇒ TextSpan (readonly)

The sentence text.

Returns:

  • (TextSpan) —

    the current value of text_span



375
376
377
 
# File 'lib/google/cloud/language/annotation.rb', line 375

def text_span
  @text_span
end

Instance Method 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). See Google::Cloud::Language::Annotation::Sentence::Sentiment#magnitude.

Returns:

  • (Float) 


440
441
442
443
 
# File 'lib/google/cloud/language/annotation.rb', line 440

def magnitude
  return nil unless sentiment?
  sentiment.magnitude
end

#offset ⇒ Integer Also known as: begin_offset

The beginning offset of the content in the original document. See TextSpan#offset.

The API calculates the beginning offset according to the client system's default encoding. In Ruby this defaults to UTF-8. To change the offset calculation you will need to change Ruby's default encoding. This is commonly done by setting Encoding.default_internal to Encoding::UTF_16 or Encoding::UTF_32. If the system is configured to use an encoding other than UTF-16 or UTF-32 the offset will be calculated using UTF-8.

Returns:

  • (Integer) 


410
411
412
 
# File 'lib/google/cloud/language/annotation.rb', line 410

def offset
  text_span.offset
end

#score ⇒ Float

Score. See Google::Cloud::Language::Annotation::Sentence::Sentiment#score.

Returns:

  • (Float) 


428
429
430
431
 
# File 'lib/google/cloud/language/annotation.rb', line 428

def score
  return nil unless sentiment?
  sentiment.score
end

#sentiment? ⇒ Boolean

Returns true if the Sentence has a Sentiment.

Returns:

  • (Boolean) 


419
420
421
 
# File 'lib/google/cloud/language/annotation.rb', line 419

def sentiment?
  !sentiment.nil?
end

#text ⇒ String Also known as: content

The content of the output text. See TextSpan#text.

Returns:

  • (String) 


390
391
392
 
# File 'lib/google/cloud/language/annotation.rb', line 390

def text
  text_span.text
end