Class: OpenApiOpenAIClient::ChatCompletionMessageToolCallChunk

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
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/chat_completion_message_tool_call_chunk.rb', line 88

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

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

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

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

Instance Attribute Details

#function ⇒ Object

Returns the value of attribute function.



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

def function
  @function
end

#id ⇒ Object

The ID of the tool call.



21
22
23
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 21

def id
  @id
end

#index ⇒ Object

Returns the value of attribute index.



18
19
20
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 18

def index
  @index
end

#type ⇒ Object

The type of the tool. Currently, only function is supported.



24
25
26
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 24

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 51

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 189

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



81
82
83
84
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 71

def self.openapi_types
  {
    :'index' => :'Integer',
    :'id' => :'String',
    :'type' => :'String',
    :'function' => :'ChatCompletionMessageToolCallChunkFunction'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 165

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 182

def hash
  [index, id, type, function].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



123
124
125
126
127
128
129
130
131
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 123

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @index.nil?
    invalid_properties.push('invalid value for "index", index 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



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 211

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



135
136
137
138
139
140
141
 
# File 'lib/openapi_openai/models/chat_completion_message_tool_call_chunk.rb', line 135

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