Class: OCI::AiLanguage::Models::SentimentDocumentResult
- Inherits:
-
Object
- Object
- OCI::AiLanguage::Models::SentimentDocumentResult
- Defined in:
- lib/oci/ai_language/models/sentiment_document_result.rb
Overview
The document response for sentiment detect call.
Instance Attribute Summary collapse
-
#aspects ⇒ Array<OCI::AiLanguage::Models::SentimentAspect>
[Required] List of detected aspects sentiment.
-
#document_scores ⇒ Hash<String, Float>
Scores for each sentiment.
-
#document_sentiment ⇒ String
Document level sentiment.
-
#key ⇒ String
[Required] Document unique identifier defined by the user.
-
#language_code ⇒ String
[Required] Language code supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew.
-
#sentences ⇒ Array<OCI::AiLanguage::Models::SentimentSentence>
List of detected sentences sentiment.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SentimentDocumentResult
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ SentimentDocumentResult
Initializes the object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 102 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.key = attributes[:'key'] if attributes[:'key'] self.document_sentiment = attributes[:'documentSentiment'] if attributes[:'documentSentiment'] raise 'You cannot provide both :documentSentiment and :document_sentiment' if attributes.key?(:'documentSentiment') && attributes.key?(:'document_sentiment') self.document_sentiment = attributes[:'document_sentiment'] if attributes[:'document_sentiment'] self.document_scores = attributes[:'documentScores'] if attributes[:'documentScores'] raise 'You cannot provide both :documentScores and :document_scores' if attributes.key?(:'documentScores') && attributes.key?(:'document_scores') self.document_scores = attributes[:'document_scores'] if attributes[:'document_scores'] self.aspects = attributes[:'aspects'] if attributes[:'aspects'] self.sentences = attributes[:'sentences'] if attributes[:'sentences'] self.language_code = attributes[:'languageCode'] if attributes[:'languageCode'] raise 'You cannot provide both :languageCode and :language_code' if attributes.key?(:'languageCode') && attributes.key?(:'language_code') self.language_code = attributes[:'language_code'] if attributes[:'language_code'] end |
Instance Attribute Details
#aspects ⇒ Array<OCI::AiLanguage::Models::SentimentAspect>
[Required] List of detected aspects sentiment.
27 28 29 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 27 def aspects @aspects end |
#document_scores ⇒ Hash<String, Float>
Scores for each sentiment. Example: 1.0, "negative": 0.0
23 24 25 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 23 def document_scores @document_scores end |
#document_sentiment ⇒ String
Document level sentiment.
17 18 19 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 17 def document_sentiment @document_sentiment end |
#key ⇒ String
[Required] Document unique identifier defined by the user.
13 14 15 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 13 def key @key end |
#language_code ⇒ String
[Required] Language code supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew
60 61 62 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 60 def language_code @language_code end |
#sentences ⇒ Array<OCI::AiLanguage::Models::SentimentSentence>
List of detected sentences sentiment.
31 32 33 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 31 def sentences @sentences end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 63 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'document_sentiment': :'documentSentiment', 'document_scores': :'documentScores', 'aspects': :'aspects', 'sentences': :'sentences', 'language_code': :'languageCode' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 77 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'document_sentiment': :'String', 'document_scores': :'Hash<String, Float>', 'aspects': :'Array<OCI::AiLanguage::Models::SentimentAspect>', 'sentences': :'Array<OCI::AiLanguage::Models::SentimentSentence>', 'language_code': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 140 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && document_sentiment == other.document_sentiment && document_scores == other.document_scores && aspects == other.aspects && sentences == other.sentences && language_code == other.language_code end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 175 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
155 156 157 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 155 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
164 165 166 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 164 def hash [key, document_sentiment, document_scores, aspects, sentences, language_code].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
208 209 210 211 212 213 214 215 216 217 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 208 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
202 203 204 |
# File 'lib/oci/ai_language/models/sentiment_document_result.rb', line 202 def to_s to_hash.to_s end |