Class: OpenApiOpenAIClient::CreateThreadRequestToolResourcesFileSearch

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

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/create_thread_request_tool_resources_file_search.rb', line 58

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

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

Instance Attribute Details

#vector_store_ids ⇒ Object

The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread.



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

def vector_store_ids
  @vector_store_ids
end

#vector_stores ⇒ Object

A helper to create a [vector store](/docs/api-reference/vector-stores/object) with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.



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

def vector_stores
  @vector_stores
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



33
34
35
 
# File 'lib/openapi_openai/models/create_thread_request_tool_resources_file_search.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/create_thread_request_tool_resources_file_search.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/create_thread_request_tool_resources_file_search.rb', line 25

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/openapi_openai/models/create_thread_request_tool_resources_file_search.rb', line 162

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/create_thread_request_tool_resources_file_search.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/create_thread_request_tool_resources_file_search.rb', line 43

def self.openapi_types
  {
    :'vector_store_ids' => :'Array<String>',
    :'vector_stores' => :'Array<CreateThreadRequestToolResourcesFileSearchVectorStoresInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
 
# File 'lib/openapi_openai/models/create_thread_request_tool_resources_file_search.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      vector_store_ids == o.vector_store_ids &&
      vector_stores == o.vector_stores
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/openapi_openai/models/create_thread_request_tool_resources_file_search.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/openapi_openai/models/create_thread_request_tool_resources_file_search.rb', line 155

def hash
  [vector_store_ids, vector_stores].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
 
# File 'lib/openapi_openai/models/create_thread_request_tool_resources_file_search.rb', line 87

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@vector_store_ids.nil? && @vector_store_ids.length > 1
    invalid_properties.push('invalid value for "vector_store_ids", number of items must be less than or equal to 1.')
  end

  if !@vector_stores.nil? && @vector_stores.length > 1
    invalid_properties.push('invalid value for "vector_stores", number of items must be less 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



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/openapi_openai/models/create_thread_request_tool_resources_file_search.rb', line 184

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



103
104
105
106
107
108
 
# File 'lib/openapi_openai/models/create_thread_request_tool_resources_file_search.rb', line 103

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