Class: OCI::GenerativeAiInference::Models::CohereParameterDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb

Overview

A definition of tool parameter.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CohereParameterDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description property

  • :type (String) —

    The value to assign to the #type property

  • :is_required (BOOLEAN) —

    The value to assign to the #is_required property



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.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.description = attributes[:'description'] if attributes[:'description']

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

  self.is_required = attributes[:'isRequired'] unless attributes[:'isRequired'].nil?
  self.is_required = false if is_required.nil? && !attributes.key?(:'isRequired') # rubocop:disable Style/StringLiterals

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

  self.is_required = attributes[:'is_required'] unless attributes[:'is_required'].nil?
  self.is_required = false if is_required.nil? && !attributes.key?(:'isRequired') && !attributes.key?(:'is_required') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#description ⇒ String

The description of the parameter.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb', line 13

def description
  @description
end

#is_required ⇒ BOOLEAN

Denotes whether the parameter is always present (required) or not. Defaults to not required.

Returns:

  • (BOOLEAN) 


21
22
23
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb', line 21

def is_required
  @is_required
end

#type ⇒ String

[Required] The type of the parameter. Must be a valid Python type.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb', line 17

def type
  @type
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/generative_ai_inference/models/cohere_parameter_definition.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'type': :'type',
    'is_required': :'isRequired'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'type': :'String',
    'is_required': :'BOOLEAN'
    # 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



80
81
82
83
84
85
86
87
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb', line 80

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

  self.class == other.class &&
    description == other.description &&
    type == other.type &&
    is_required == other.is_required
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



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

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


92
93
94
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb', line 92

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



101
102
103
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb', line 101

def hash
  [description, type, is_required].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb', line 145

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



139
140
141
 
# File 'lib/oci/generative_ai_inference/models/cohere_parameter_definition.rb', line 139

def to_s
  to_hash.to_s
end