Class: Google::Cloud::Language::Annotation::Entity::Mention

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 = "Darth Vader is the best villain in Star Wars."
document = language.document content
annotation = document.annotate

entities = annotation.entities
entities.count #=> 2
entity = entities.first

entity.mentions.count #=> 1
entity.mentions.first.text # => "Darth Vader"
entity.mentions.first.offset # => 0
entity.mentions.first.proper? # => true

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#text_span ⇒ TextSpan (readonly)

The entity mention text.

Returns:

  • (TextSpan) —

    the current value of text_span



913
914
915
 
# File 'lib/google/cloud/language/annotation.rb', line 913

def text_span
  @text_span
end

#type ⇒ Symbol (readonly)

The type of the entity mention. The possible return values are :TYPE_UNKNOWN, :PROPER (proper name), and :COMMON (Common noun or noun compound).

Returns:

  • (Symbol) —

    the current value of type



913
914
915
 
# File 'lib/google/cloud/language/annotation.rb', line 913

def type
  @type
end

Instance Method Details

#common? ⇒ Boolean

Returns true if #type is :COMMON.

Returns:

  • (Boolean) 


960
961
962
 
# File 'lib/google/cloud/language/annotation.rb', line 960

def common?
  type == :COMMON
end

#offset ⇒ Integer Also known as: begin_offset

The API calculates the beginning offset of the content in the original document according to the encoding specified in the API request. See TextSpan#offset.

Returns:

  • (Integer) 


941
942
943
 
# File 'lib/google/cloud/language/annotation.rb', line 941

def offset
  text_span.offset
end

#proper? ⇒ Boolean

Returns true if #type is :PROPER.

Returns:

  • (Boolean) 


951
952
953
 
# File 'lib/google/cloud/language/annotation.rb', line 951

def proper?
  type == :PROPER
end

#text ⇒ String Also known as: content

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

Returns:

  • (String) 


928
929
930
 
# File 'lib/google/cloud/language/annotation.rb', line 928

def text
  text_span.text
end