Class: OpenApiOpenAIClient::RealtimeResponseCreateParamsToolsInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/realtime_response_create_params_tools_inner.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 = {}) ⇒ RealtimeResponseCreateParamsToolsInner

Initializes the object



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 90

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

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

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

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

Instance Attribute Details

#description ⇒ Object

The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything).



25
26
27
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 25

def description
  @description
end

#name ⇒ Object

The name of the function.



22
23
24
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 22

def name
  @name
end

#parameters ⇒ Object

Parameters of the function in JSON Schema.



28
29
30
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 28

def parameters
  @parameters
end

#type ⇒ Object

The type of the tool, i.e. function.



19
20
21
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 19

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 53

def self.attribute_map
  {
    :'type' => :'type',
    :'name' => :'name',
    :'description' => :'description',
    :'parameters' => :'parameters'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 174

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



83
84
85
86
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 73

def self.openapi_types
  {
    :'type' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'parameters' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



150
151
152
153
154
155
156
157
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 150

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



167
168
169
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 167

def hash
  [type, name, description, parameters].hash
end

#list_invalid_properties ⇒ Object

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



123
124
125
126
127
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 123

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 196

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



131
132
133
134
135
136
 
# File 'lib/openapi_openai/models/realtime_response_create_params_tools_inner.rb', line 131

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