Class: Google::Cloud::Language::Annotation::TextSpan

Inherits:

Object

• Object
• Google::Cloud::Language::Annotation::TextSpan

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 = "I love dogs. I hate cats."
document = language.document content
annotation = document.annotate

text_span = annotation.sentences.last
text_span.text #=> "I hate cats."
text_span.offset #=> 13

Instance Attribute Summary

• #offset ⇒ Integer (also: #begin_offset) readonly

  The API calculates the beginning offset of the content in the original document according to the ‘encoding` specified in the API request.

• #text ⇒ String (also: #content) readonly

  The content of the output text.

Class Method Summary

• .from_grpc(grpc) ⇒ Object

Instance Method Summary

• #initialize(text, offset) ⇒ TextSpan constructor

  A new instance of TextSpan.

Constructor Details

#initialize(text, offset) ⇒ TextSpan

Returns a new instance of TextSpan.

# File 'lib/google/cloud/language/annotation.rb', line 230

def initialize text, offset
  @text   = text
  @offset = offset
end

Instance Attribute Details

#offset ⇒ Integer (readonly) 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.

Returns:

• (Integer) —

  the current value of offset

# File 'lib/google/cloud/language/annotation.rb', line 223

def offset
  @offset
end

#text ⇒ String (readonly) Also known as: content

The content of the output text.

Returns:

• (String) —

  the current value of text

# File 'lib/google/cloud/language/annotation.rb', line 223

def text
  @text
end

Class Method Details

.from_grpc(grpc) ⇒ Object

# File 'lib/google/cloud/language/annotation.rb', line 237

def self.from_grpc grpc
  new grpc.content, grpc.begin_offset
end