Class: OpenApiOpenAIClient::RunStepDetailsToolCallsFunctionObjectFunction

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

Overview

The definition of the function that was called.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 65

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

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

Instance Attribute Details

#arguments ⇒ Object

The arguments passed to the function.



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

def arguments
  @arguments
end

#name ⇒ Object

The name of the function.



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

def name
  @name
end

#output ⇒ Object

The output of the function. This will be null if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.



26
27
28
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 26

def output
  @output
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 38

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 29

def self.attribute_map
  {
    :'name' => :'name',
    :'arguments' => :'arguments',
    :'output' => :'output'
  }
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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 168

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



57
58
59
60
61
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 57

def self.openapi_nullable
  Set.new([
    :'output'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'arguments' => :'String',
    :'output' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      arguments == o.arguments &&
      output == o.output
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



161
162
163
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 161

def hash
  [name, arguments, output].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



100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 100

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 @arguments.nil?
    invalid_properties.push('invalid value for "arguments", arguments 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



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 190

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



116
117
118
119
120
121
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_function_object_function.rb', line 116

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @arguments.nil?
  true
end