Class: OpenApiOpenAIClient::ChatCompletionStreamResponseDelta

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

Overview

A chat completion delta generated by streamed model responses.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 96

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

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

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

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

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

Instance Attribute Details

#content ⇒ Object

The contents of the chunk message.



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

def content
  @content
end

#function_call ⇒ Object

Returns the value of attribute function_call.



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

def function_call
  @function_call
end

#refusal ⇒ Object

The refusal message generated by the model.



30
31
32
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 30

def refusal
  @refusal
end

#role ⇒ Object

The role of the author of this message.



27
28
29
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 27

def role
  @role
end

#tool_calls ⇒ Object

Returns the value of attribute tool_calls.



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

def tool_calls
  @tool_calls
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 55

def self.attribute_map
  {
    :'content' => :'content',
    :'function_call' => :'function_call',
    :'tool_calls' => :'tool_calls',
    :'role' => :'role',
    :'refusal' => :'refusal'
  }
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



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

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



87
88
89
90
91
92
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 87

def self.openapi_nullable
  Set.new([
    :'content',
    :'refusal'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 76

def self.openapi_types
  {
    :'content' => :'String',
    :'function_call' => :'ChatCompletionStreamResponseDeltaFunctionCall',
    :'tool_calls' => :'Array<ChatCompletionMessageToolCallChunk>',
    :'role' => :'String',
    :'refusal' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content == o.content &&
      function_call == o.function_call &&
      tool_calls == o.tool_calls &&
      role == o.role &&
      refusal == o.refusal
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 180

def hash
  [content, function_call, tool_calls, role, refusal].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



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

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

Returns:

  • (Hash) —

    Returns the object in the form of hash



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 209

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



143
144
145
146
147
148
 
# File 'lib/openapi_openai/models/chat_completion_stream_response_delta.rb', line 143

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  role_validator = EnumAttributeValidator.new('String', ["system", "user", "assistant", "tool"])
  return false unless role_validator.valid?(@role)
  true
end