Class: OCI::AiLanguage::Models::BatchDetectLanguageSentimentsDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb

Overview

The documents details for sentiment call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchDetectLanguageSentimentsDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 54

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.endpoint_id = attributes[:'endpointId'] if attributes[:'endpointId']

  raise 'You cannot provide both :endpointId and :endpoint_id' if attributes.key?(:'endpointId') && attributes.key?(:'endpoint_id')

  self.endpoint_id = attributes[:'endpoint_id'] if attributes[:'endpoint_id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.documents = attributes[:'documents'] if attributes[:'documents']
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment that calls the API, inference will be served from pre trained model

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 17

def compartment_id
  @compartment_id
end

#documents ⇒ Array<OCI::AiLanguage::Models::TextDocument>

[Required] List of Documents for detect sentiments.

Returns:



21
22
23
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 21

def documents
  @documents
end

#endpoint_id ⇒ String

The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 13

def endpoint_id
  @endpoint_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'endpoint_id': :'endpointId',
    'compartment_id': :'compartmentId',
    'documents': :'documents'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'endpoint_id': :'String',
    'compartment_id': :'String',
    'documents': :'Array<OCI::AiLanguage::Models::TextDocument>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



82
83
84
85
86
87
88
89
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 82

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    endpoint_id == other.endpoint_id &&
    compartment_id == other.compartment_id &&
    documents == other.documents
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 114

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


94
95
96
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 94

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



103
104
105
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 103

def hash
  [endpoint_id, compartment_id, documents].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 147

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

Returns:

  • (String) —

    String presentation of the object



141
142
143
 
# File 'lib/oci/ai_language/models/batch_detect_language_sentiments_details.rb', line 141

def to_s
  to_hash.to_s
end