Class: Google::Cloud::Language::Annotation
- Inherits:
-
Object
- Object
- Google::Cloud::Language::Annotation
- Defined in:
- lib/google/cloud/language/annotation.rb
Overview
# Annotation
The results of all requested document analysis features.
See Project#annotate and Document#annotate.
Defined Under Namespace
Classes: Entities, Entity, Sentiment, TextSpan, Token
Instance Attribute Summary collapse
Class Method Summary collapse
Instance Method Summary collapse
-
#entities ⇒ Entities
The entities returned by entity analysis.
-
#initialize ⇒ Annotation
constructor
A new instance of Annotation.
- #inspect ⇒ Object
-
#language ⇒ String
The language of the document (if not specified, the language is automatically detected).
-
#sentences ⇒ Array<TextSpan>
The sentences returned by syntactic analysis.
-
#sentiment ⇒ Sentiment
The result of sentiment analysis.
- #to_s ⇒ Object
-
#tokens ⇒ Array<Token>
The tokens returned by syntactic analysis.
Constructor Details
#initialize ⇒ Annotation
Returns a new instance of Annotation.
51 52 53 |
# File 'lib/google/cloud/language/annotation.rb', line 51 def initialize @grpc = nil end |
Instance Attribute Details
#grpc ⇒ Object
47 48 49 |
# File 'lib/google/cloud/language/annotation.rb', line 47 def grpc @grpc end |
Class Method Details
.from_grpc(grpc) ⇒ Object
204 205 206 |
# File 'lib/google/cloud/language/annotation.rb', line 204 def self.from_grpc grpc new.tap { |a| a.instance_variable_set :@grpc, grpc } end |
Instance Method Details
#entities ⇒ Entities
The entities returned by entity analysis.
138 139 140 |
# File 'lib/google/cloud/language/annotation.rb', line 138 def entities @entities ||= Entities.from_grpc @grpc end |
#inspect ⇒ Object
198 199 200 |
# File 'lib/google/cloud/language/annotation.rb', line 198 def inspect "#<#{self.class.name} #{self}>" end |
#language ⇒ String
The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are supported.
185 186 187 |
# File 'lib/google/cloud/language/annotation.rb', line 185 def language @grpc.language end |
#sentences ⇒ Array<TextSpan>
The sentences returned by syntactic analysis.
75 76 77 78 79 |
# File 'lib/google/cloud/language/annotation.rb', line 75 def sentences @sentences ||= begin Array(grpc.sentences).map { |g| TextSpan.from_grpc g.text } end end |
#sentiment ⇒ Sentiment
The result of sentiment analysis.
162 163 164 165 |
# File 'lib/google/cloud/language/annotation.rb', line 162 def sentiment return nil if @grpc.document_sentiment.nil? @sentiment ||= Sentiment.from_grpc @grpc end |
#to_s ⇒ Object
190 191 192 193 194 195 |
# File 'lib/google/cloud/language/annotation.rb', line 190 def to_s tmplt = "(sentences: %i, tokens: %i, entities: %i," \ " sentiment: %s, language: %s)" format tmplt, sentences.count, tokens.count, entities.count, !sentiment.nil?, language.inspect end |