Class: OpencodeClient::Agent

Inherits:
ApiModelBase show all
Defined in:
lib/opencode_client/models/agent.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Agent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/opencode_client/models/agent.rb', line 130

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpencodeClient::Agent` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpencodeClient::Agent`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'mode')
    self.mode = attributes[:'mode']
  else
    self.mode = nil
  end

  if attributes.key?(:'native')
    self.native = attributes[:'native']
  end

  if attributes.key?(:'hidden')
    self.hidden = attributes[:'hidden']
  end

  if attributes.key?(:'default')
    self.default = attributes[:'default']
  end

  if attributes.key?(:'top_p')
    self.top_p = attributes[:'top_p']
  end

  if attributes.key?(:'temperature')
    self.temperature = attributes[:'temperature']
  end

  if attributes.key?(:'color')
    self.color = attributes[:'color']
  end

  if attributes.key?(:'permission')
    self.permission = attributes[:'permission']
  else
    self.permission = nil
  end

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  end

  if attributes.key?(:'prompt')
    self.prompt = attributes[:'prompt']
  end

  if attributes.key?(:'tools')
    if (value = attributes[:'tools']).is_a?(Hash)
      self.tools = value
    end
  else
    self.tools = nil
  end

  if attributes.key?(:'options')
    if (value = attributes[:'options']).is_a?(Hash)
      self.options = value
    end
  else
    self.options = nil
  end

  if attributes.key?(:'max_steps')
    self.max_steps = attributes[:'max_steps']
  end
end

Instance Attribute Details

#color ⇒ Object

Returns the value of attribute color.



34
35
36
 
# File 'lib/opencode_client/models/agent.rb', line 34

def color
  @color
end

#default ⇒ Object

Returns the value of attribute default.



28
29
30
 
# File 'lib/opencode_client/models/agent.rb', line 28

def default
  @default
end

#description ⇒ Object

Returns the value of attribute description.



20
21
22
 
# File 'lib/opencode_client/models/agent.rb', line 20

def description
  @description
end

#hidden ⇒ Object

Returns the value of attribute hidden.



26
27
28
 
# File 'lib/opencode_client/models/agent.rb', line 26

def hidden
  @hidden
end

#max_steps ⇒ Object

Returns the value of attribute max_steps.



46
47
48
 
# File 'lib/opencode_client/models/agent.rb', line 46

def max_steps
  @max_steps
end

#mode ⇒ Object

Returns the value of attribute mode.



22
23
24
 
# File 'lib/opencode_client/models/agent.rb', line 22

def mode
  @mode
end

#model ⇒ Object

Returns the value of attribute model.



38
39
40
 
# File 'lib/opencode_client/models/agent.rb', line 38

def model
  @model
end

#name ⇒ Object

Returns the value of attribute name.



18
19
20
 
# File 'lib/opencode_client/models/agent.rb', line 18

def name
  @name
end

#native ⇒ Object

Returns the value of attribute native.



24
25
26
 
# File 'lib/opencode_client/models/agent.rb', line 24

def native
  @native
end

#options ⇒ Object

Returns the value of attribute options.



44
45
46
 
# File 'lib/opencode_client/models/agent.rb', line 44

def options
  @options
end

#permission ⇒ Object

Returns the value of attribute permission.



36
37
38
 
# File 'lib/opencode_client/models/agent.rb', line 36

def permission
  @permission
end

#prompt ⇒ Object

Returns the value of attribute prompt.



40
41
42
 
# File 'lib/opencode_client/models/agent.rb', line 40

def prompt
  @prompt
end

#temperature ⇒ Object

Returns the value of attribute temperature.



32
33
34
 
# File 'lib/opencode_client/models/agent.rb', line 32

def temperature
  @temperature
end

#tools ⇒ Object

Returns the value of attribute tools.



42
43
44
 
# File 'lib/opencode_client/models/agent.rb', line 42

def tools
  @tools
end

#top_p ⇒ Object

Returns the value of attribute top_p.



30
31
32
 
# File 'lib/opencode_client/models/agent.rb', line 30

def top_p
  @top_p
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



92
93
94
 
# File 'lib/opencode_client/models/agent.rb', line 92

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/opencode_client/models/agent.rb', line 97

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/opencode_client/models/agent.rb', line 71

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'mode' => :'mode',
    :'native' => :'native',
    :'hidden' => :'hidden',
    :'default' => :'default',
    :'top_p' => :'topP',
    :'temperature' => :'temperature',
    :'color' => :'color',
    :'permission' => :'permission',
    :'model' => :'model',
    :'prompt' => :'prompt',
    :'tools' => :'tools',
    :'options' => :'options',
    :'max_steps' => :'maxSteps'
  }
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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/opencode_client/models/agent.rb', line 367

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



123
124
125
126
 
# File 'lib/opencode_client/models/agent.rb', line 123

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/opencode_client/models/agent.rb', line 102

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'mode' => :'String',
    :'native' => :'Boolean',
    :'hidden' => :'Boolean',
    :'default' => :'Boolean',
    :'top_p' => :'Float',
    :'temperature' => :'Float',
    :'color' => :'String',
    :'permission' => :'AgentPermission',
    :'model' => :'SessionPromptRequestModel',
    :'prompt' => :'String',
    :'tools' => :'Hash<String, Boolean>',
    :'options' => :'Hash<String, Object>',
    :'max_steps' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/opencode_client/models/agent.rb', line 332

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      mode == o.mode &&
      native == o.native &&
      hidden == o.hidden &&
      default == o.default &&
      top_p == o.top_p &&
      temperature == o.temperature &&
      color == o.color &&
      permission == o.permission &&
      model == o.model &&
      prompt == o.prompt &&
      tools == o.tools &&
      options == o.options &&
      max_steps == o.max_steps
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


354
355
356
 
# File 'lib/opencode_client/models/agent.rb', line 354

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



360
361
362
 
# File 'lib/opencode_client/models/agent.rb', line 360

def hash
  [name, description, mode, native, hidden, default, top_p, temperature, color, permission, model, prompt, tools, options, max_steps].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/opencode_client/models/agent.rb', line 221

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @mode.nil?
    invalid_properties.push('invalid value for "mode", mode cannot be nil.')
  end

  if @permission.nil?
    invalid_properties.push('invalid value for "permission", permission cannot be nil.')
  end

  if @tools.nil?
    invalid_properties.push('invalid value for "tools", tools cannot be nil.')
  end

  if @options.nil?
    invalid_properties.push('invalid value for "options", options cannot be nil.')
  end

  if !@max_steps.nil? && @max_steps > 9007199254740991
    invalid_properties.push('invalid value for "max_steps", must be smaller than or equal to 9007199254740991.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/opencode_client/models/agent.rb', line 389

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/opencode_client/models/agent.rb', line 253

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @mode.nil?
  mode_validator = EnumAttributeValidator.new('String', ["subagent", "primary", "all"])
  return false unless mode_validator.valid?(@mode)
  return false if @permission.nil?
  return false if @tools.nil?
  return false if @options.nil?
  return false if !@max_steps.nil? && @max_steps > 9007199254740991
  true
end