Class: OpenApiOpenAIClient::CreateVectorStoreRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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/create_vector_store_request.rb', line 72

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

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

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

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

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

Instance Attribute Details

#chunking_strategy ⇒ Object

Returns the value of attribute chunking_strategy.



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

def chunking_strategy
  @chunking_strategy
end

#expires_after ⇒ Object

Returns the value of attribute expires_after.



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

def expires_after
  @expires_after
end

#file_ids ⇒ Object

A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like file_search that can access files.



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

def file_ids
  @file_ids
end

#metadata ⇒ Object

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.



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

def metadata
  @metadata
end

#name ⇒ Object

The name of the vector store.



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

def name
  @name
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



43
44
45
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 43

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



48
49
50
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 48

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 32

def self.attribute_map
  {
    :'file_ids' => :'file_ids',
    :'name' => :'name',
    :'expires_after' => :'expires_after',
    :'chunking_strategy' => :'chunking_strategy',
    :'metadata' => :'metadata'
  }
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



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

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



64
65
66
67
68
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 53

def self.openapi_types
  {
    :'file_ids' => :'Array<String>',
    :'name' => :'String',
    :'expires_after' => :'VectorStoreExpirationAfter',
    :'chunking_strategy' => :'CreateVectorStoreRequestChunkingStrategy',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_ids == o.file_ids &&
      name == o.name &&
      expires_after == o.expires_after &&
      chunking_strategy == o.chunking_strategy &&
      metadata == o.metadata
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 163

def hash
  [file_ids, name, expires_after, chunking_strategy, metadata].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@file_ids.nil? && @file_ids.length > 500
    invalid_properties.push('invalid value for "file_ids", number of items must be less than or equal to 500.')
  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



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 192

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



123
124
125
126
127
 
# File 'lib/openapi_openai/models/create_vector_store_request.rb', line 123

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@file_ids.nil? && @file_ids.length > 500
  true
end