Class: OpenApiOpenAIClient::RunStepDetailsToolCallsObject

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/run_step_details_tool_calls_object.rb

Overview

Details of the tool call.

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 = {}) ⇒ RunStepDetailsToolCallsObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 81

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::RunStepDetailsToolCallsObject` 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 `OpenApiOpenAIClient::RunStepDetailsToolCallsObject`. 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?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

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

Instance Attribute Details

#tool_calls ⇒ Object

An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.



23
24
25
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 23

def tool_calls
  @tool_calls
end

#type ⇒ Object

Always tool_calls.



20
21
22
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 20

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



56
57
58
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 56

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 61

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 48

def self.attribute_map
  {
    :'type' => :'type',
    :'tool_calls' => :'tool_calls'
  }
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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 181

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



74
75
76
77
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 66

def self.openapi_types
  {
    :'type' => :'String',
    :'tool_calls' => :'Array<RunStepDetailsToolCallsObjectToolCallsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      tool_calls == o.tool_calls
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 174

def hash
  [type, tool_calls].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



112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 112

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

  if @tool_calls.nil?
    invalid_properties.push('invalid value for "tool_calls", tool_calls cannot be nil.')
  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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 203

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



128
129
130
131
132
133
134
135
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_object.rb', line 128

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["tool_calls"])
  return false unless type_validator.valid?(@type)
  return false if @tool_calls.nil?
  true
end