Class: OpenApiOpenAIClient::AssistantToolsFileSearchFileSearch

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

Overview

Overrides for the file search tool.

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

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
 
# File 'lib/openapi_openai/models/assistant_tools_file_search_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::AssistantToolsFileSearchFileSearch` 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::AssistantToolsFileSearchFileSearch`. 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_num_results')
    self.max_num_results = attributes[:'max_num_results']
  end

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

Instance Attribute Details

#max_num_results ⇒ Object

The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive. Note that the file search tool may output fewer than max_num_results results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.



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

def max_num_results
  @max_num_results
end

#ranking_options ⇒ Object

Returns the value of attribute ranking_options.



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

def ranking_options
  @ranking_options
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/openapi_openai/models/assistant_tools_file_search_file_search.rb', line 148

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

def self.openapi_types
  {
    :'max_num_results' => :'Integer',
    :'ranking_options' => :'FileSearchRankingOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      max_num_results == o.max_num_results &&
      ranking_options == o.ranking_options
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


135
136
137
 
# File 'lib/openapi_openai/models/assistant_tools_file_search_file_search.rb', line 135

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



141
142
143
 
# File 'lib/openapi_openai/models/assistant_tools_file_search_file_search.rb', line 141

def hash
  [max_num_results, ranking_options].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



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/openapi_openai/models/assistant_tools_file_search_file_search.rb', line 83

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@max_num_results.nil? && @max_num_results > 50
    invalid_properties.push('invalid value for "max_num_results", must be smaller than or equal to 50.')
  end

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



170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/openapi_openai/models/assistant_tools_file_search_file_search.rb', line 170

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



99
100
101
102
103
104
 
# File 'lib/openapi_openai/models/assistant_tools_file_search_file_search.rb', line 99

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