Class: OpenApiOpenAIClient::VectorStoreFileObject

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

Overview

A list of files attached to a vector store.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 110

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

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

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

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

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

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

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

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

Instance Attribute Details

#chunking_strategy ⇒ Object

Returns the value of attribute chunking_strategy.



39
40
41
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 39

def chunking_strategy
  @chunking_strategy
end

#created_at ⇒ Object

The Unix timestamp (in seconds) for when the vector store file was created.



29
30
31
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 29

def created_at
  @created_at
end

#id ⇒ Object

The identifier, which can be referenced in API endpoints.



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

def id
  @id
end

#last_error ⇒ Object

Returns the value of attribute last_error.



37
38
39
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 37

def last_error
  @last_error
end

#object ⇒ Object

The object type, which is always vector_store.file.



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

def object
  @object
end

#status ⇒ Object

The status of the vector store file, which can be either in_progress, completed, cancelled, or failed. The status completed indicates that the vector store file is ready for use.



35
36
37
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 35

def status
  @status
end

#usage_bytes ⇒ Object

The total vector store usage in bytes. Note that this may be different from the original file size.



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

def usage_bytes
  @usage_bytes
end

#vector_store_id ⇒ Object

The ID of the [vector store](/docs/api-reference/vector-stores/object) that the [File](/docs/api-reference/files) is attached to.



32
33
34
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 32

def vector_store_id
  @vector_store_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'usage_bytes' => :'usage_bytes',
    :'created_at' => :'created_at',
    :'vector_store_id' => :'vector_store_id',
    :'status' => :'status',
    :'last_error' => :'last_error',
    :'chunking_strategy' => :'chunking_strategy'
  }
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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 310

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



102
103
104
105
106
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 88

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'usage_bytes' => :'Integer',
    :'created_at' => :'Integer',
    :'vector_store_id' => :'String',
    :'status' => :'String',
    :'last_error' => :'VectorStoreFileObjectLastError',
    :'chunking_strategy' => :'VectorStoreFileObjectChunkingStrategy'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      usage_bytes == o.usage_bytes &&
      created_at == o.created_at &&
      vector_store_id == o.vector_store_id &&
      status == o.status &&
      last_error == o.last_error &&
      chunking_strategy == o.chunking_strategy
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 303

def hash
  [id, object, usage_bytes, created_at, vector_store_id, status, last_error, chunking_strategy].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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 173

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

  if @object.nil?
    invalid_properties.push('invalid value for "object", object cannot be nil.')
  end

  if @usage_bytes.nil?
    invalid_properties.push('invalid value for "usage_bytes", usage_bytes cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @vector_store_id.nil?
    invalid_properties.push('invalid value for "vector_store_id", vector_store_id cannot be nil.')
  end

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 332

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/openapi_openai/models/vector_store_file_object.rb', line 205

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["vector_store.file"])
  return false unless object_validator.valid?(@object)
  return false if @usage_bytes.nil?
  return false if @created_at.nil?
  return false if @vector_store_id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["in_progress", "completed", "cancelled", "failed"])
  return false unless status_validator.valid?(@status)
  true
end