Class: Google::Cloud::Language::Annotation::Token

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

Overview

Represents the smallest syntactic building block of the text. Returned by syntactic analysis.

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

annotation.tokens.count #=> 10
token = annotation.tokens.first

token.text_span.text #=> "Darth"
token.text_span.offset #=> 0
token.part_of_speech.tag #=> :NOUN
token.part_of_speech.gender #=> :MASCULINE
token.head_token_index #=> 1
token.label #=> :NN
token.lemma #=> "Darth"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#head_token_index ⇒ Integer (readonly)

Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the headTokenIndex is its own index.

Returns:

  • (Integer) —

    the current value of head_token_index



518
519
520
 
# File 'lib/google/cloud/language/annotation.rb', line 518

def head_token_index
  @head_token_index
end

#label ⇒ Symbol (readonly)

The parse label for the token.

Returns:

  • (Symbol) —

    the current value of label



518
519
520
 
# File 'lib/google/cloud/language/annotation.rb', line 518

def label
  @label
end

#lemma ⇒ String (readonly)

Lemma of the token.

Returns:

  • (String) —

    the current value of lemma



518
519
520
 
# File 'lib/google/cloud/language/annotation.rb', line 518

def lemma
  @lemma
end

#part_of_speech ⇒ PartOfSpeech (readonly)

Represents part of speech information for a token.

Returns:



518
519
520
 
# File 'lib/google/cloud/language/annotation.rb', line 518

def part_of_speech
  @part_of_speech
end

#text_span ⇒ TextSpan (readonly)

The token text.

Returns:

  • (TextSpan) —

    the current value of text_span



518
519
520
 
# File 'lib/google/cloud/language/annotation.rb', line 518

def text_span
  @text_span
end

Instance Method Details

#offset ⇒ Object Also known as: begin_offset 



538
539
540
 
# File 'lib/google/cloud/language/annotation.rb', line 538

def offset
  @text_span.offset
end

#text ⇒ Object Also known as: content 



533
534
535
 
# File 'lib/google/cloud/language/annotation.rb', line 533

def text
  @text_span.text
end