Class: Google::Apis::LanguageV1::AnnotateTextRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/language_v1/classes.rb,
generated/google/apis/language_v1/representations.rb,
generated/google/apis/language_v1/representations.rb

Overview

The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AnnotateTextRequest

Returns a new instance of AnnotateTextRequest.



271
272
273
 
# File 'generated/google/apis/language_v1/classes.rb', line 271

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#document ⇒ Google::Apis::LanguageV1::Document

########################################################## # Represents

the input to API methods. Corresponds to the JSON property document

Returns:



258
259
260
 
# File 'generated/google/apis/language_v1/classes.rb', line 258

def document
  @document
end

#encoding_type ⇒ String

The encoding type used by the API to calculate offsets. Corresponds to the JSON property encodingType

Returns:

  • (String) 


263
264
265
 
# File 'generated/google/apis/language_v1/classes.rb', line 263

def encoding_type
  @encoding_type
end

#features ⇒ Google::Apis::LanguageV1::Features

All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Corresponds to the JSON property features

Returns:



269
270
271
 
# File 'generated/google/apis/language_v1/classes.rb', line 269

def features
  @features
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



276
277
278
279
280
 
# File 'generated/google/apis/language_v1/classes.rb', line 276

def update!(**args)
  @document = args[:document] if args.key?(:document)
  @encoding_type = args[:encoding_type] if args.key?(:encoding_type)
  @features = args[:features] if args.key?(:features)
end