Class: OpenApiOpenAIClient::TruncationObject

Inherits:
ApiModelBase show all
Defined in:
lib/openapi_openai/models/truncation_object.rb

Overview

Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

Instance Attribute Details

#last_messages ⇒ Object

The number of most recent messages from the thread when constructing the context for the run.



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

def last_messages
  @last_messages
end

#type ⇒ Object

The truncation strategy to use for the thread. The default is auto. If set to last_messages, the thread will be truncated to the n most recent messages in the thread. When set to auto, messages in the middle of the thread will be dropped to fit the context length of the model, max_prompt_tokens.



20
21
22
 
# File 'lib/openapi_openai/models/truncation_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/truncation_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/truncation_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/truncation_object.rb', line 48

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/openapi_openai/models/truncation_object.rb', line 178

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
78
 
# File 'lib/openapi_openai/models/truncation_object.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'type' => :'String',
    :'last_messages' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
 
# File 'lib/openapi_openai/models/truncation_object.rb', line 156

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
 
# File 'lib/openapi_openai/models/truncation_object.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



171
172
173
 
# File 'lib/openapi_openai/models/truncation_object.rb', line 171

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



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/openapi_openai/models/truncation_object.rb', line 109

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 !@last_messages.nil? && @last_messages < 1
    invalid_properties.push('invalid value for "last_messages", must be greater than or equal to 1.')
  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



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/openapi_openai/models/truncation_object.rb', line 200

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



125
126
127
128
129
130
131
132
 
# File 'lib/openapi_openai/models/truncation_object.rb', line 125

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