Class: OpenApiOpenAIClient::StaticChunkingStrategyStatic

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 58

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

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

Instance Attribute Details

#chunk_overlap_tokens ⇒ Object

The number of tokens that overlap between chunks. The default value is 400. Note that the overlap must not exceed half of max_chunk_size_tokens.



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

def chunk_overlap_tokens
  @chunk_overlap_tokens
end

#max_chunk_size_tokens ⇒ Object

The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.



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

def max_chunk_size_tokens
  @max_chunk_size_tokens
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



33
34
35
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 33

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



25
26
27
28
29
30
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 25

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



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

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



51
52
53
54
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 51

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 43

def self.openapi_types
  {
    :'max_chunk_size_tokens' => :'Integer',
    :'chunk_overlap_tokens' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      max_chunk_size_tokens == o.max_chunk_size_tokens &&
      chunk_overlap_tokens == o.chunk_overlap_tokens
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


159
160
161
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [max_chunk_size_tokens, chunk_overlap_tokens].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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 87

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @max_chunk_size_tokens.nil?
    invalid_properties.push('invalid value for "max_chunk_size_tokens", max_chunk_size_tokens cannot be nil.')
  end

  if @max_chunk_size_tokens > 4096
    invalid_properties.push('invalid value for "max_chunk_size_tokens", must be smaller than or equal to 4096.')
  end

  if @max_chunk_size_tokens < 100
    invalid_properties.push('invalid value for "max_chunk_size_tokens", must be greater than or equal to 100.')
  end

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



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 194

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



111
112
113
114
115
116
117
118
 
# File 'lib/openapi_openai/models/static_chunking_strategy_static.rb', line 111

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @max_chunk_size_tokens.nil?
  return false if @max_chunk_size_tokens > 4096
  return false if @max_chunk_size_tokens < 100
  return false if @chunk_overlap_tokens.nil?
  true
end