Class: OCI::GenerativeAiAgentRuntime::Models::ModelParams

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent_runtime/models/model_params.rb

Overview

Details of model parameters.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :max_tokens (Integer) —

    The value to assign to the #max_tokens property

  • :temperature (Float) —

    The value to assign to the #temperature property

  • :top_p (Float) —

    The value to assign to the #top_p property

  • :top_k (Integer) —

    The value to assign to the #top_k property

  • :frequency_penalty (Float) —

    The value to assign to the #frequency_penalty property

  • :presence_penalty (Float) —

    The value to assign to the #presence_penalty property

  • :seed (Integer) —

    The value to assign to the #seed property

  • :reasoning_effort (String) —

    The value to assign to the #reasoning_effort property

  • :verbosity (String) —

    The value to assign to the #verbosity property



96
97
98
99
100
101
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
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 96

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

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

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

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

  self.top_p = attributes[:'topP'] if attributes[:'topP']

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

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

  self.top_k = attributes[:'topK'] if attributes[:'topK']

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

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

  self.frequency_penalty = attributes[:'frequencyPenalty'] if attributes[:'frequencyPenalty']

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

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

  self.presence_penalty = attributes[:'presencePenalty'] if attributes[:'presencePenalty']

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

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

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

  self.reasoning_effort = attributes[:'reasoningEffort'] if attributes[:'reasoningEffort']

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

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

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

Instance Attribute Details

#frequency_penalty ⇒ Float

Frequency penalty to reduce repeating tokens.

Returns:

  • (Float) 


29
30
31
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 29

def frequency_penalty
  @frequency_penalty
end

#max_tokens ⇒ Integer

Maximum number of tokens.

Returns:

  • (Integer) 


13
14
15
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 13

def max_tokens
  @max_tokens
end

#presence_penalty ⇒ Float

Presence penalty to encourage new topics.

Returns:

  • (Float) 


33
34
35
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 33

def presence_penalty
  @presence_penalty
end

#reasoning_effort ⇒ String

Constrains effort on reasoning for reasoning models.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 41

def reasoning_effort
  @reasoning_effort
end

#seed ⇒ Integer

Seed makes best effort to sample tokens deterministically.

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 37

def seed
  @seed
end

#temperature ⇒ Float

Sampling temperature.

Returns:

  • (Float) 


17
18
19
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 17

def temperature
  @temperature
end

#top_k ⇒ Integer

Top-K sampling parameter.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 25

def top_k
  @top_k
end

#top_p ⇒ Float

Nucleus sampling probability.

Returns:

  • (Float) 


21
22
23
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 21

def top_p
  @top_p
end

#verbosity ⇒ String

Constrains the verbosity of the model's response.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 45

def verbosity
  @verbosity
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 48

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'max_tokens': :'maxTokens',
    'temperature': :'temperature',
    'top_p': :'topP',
    'top_k': :'topK',
    'frequency_penalty': :'frequencyPenalty',
    'presence_penalty': :'presencePenalty',
    'seed': :'seed',
    'reasoning_effort': :'reasoningEffort',
    'verbosity': :'verbosity'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'max_tokens': :'Integer',
    'temperature': :'Float',
    'top_p': :'Float',
    'top_k': :'Integer',
    'frequency_penalty': :'Float',
    'presence_penalty': :'Float',
    'seed': :'Integer',
    'reasoning_effort': :'String',
    'verbosity': :'String'
    # 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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 152

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

  self.class == other.class &&
    max_tokens == other.max_tokens &&
    temperature == other.temperature &&
    top_p == other.top_p &&
    top_k == other.top_k &&
    frequency_penalty == other.frequency_penalty &&
    presence_penalty == other.presence_penalty &&
    seed == other.seed &&
    reasoning_effort == other.reasoning_effort &&
    verbosity == other.verbosity
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 190

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


170
171
172
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 170

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 179

def hash
  [max_tokens, temperature, top_p, top_k, frequency_penalty, presence_penalty, seed, reasoning_effort, verbosity].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 223

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



217
218
219
 
# File 'lib/oci/generative_ai_agent_runtime/models/model_params.rb', line 217

def to_s
  to_hash.to_s
end