Class: OpenApiOpenAIClient::FileSearchRankingOptions

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

Overview

The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 81

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

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

Instance Attribute Details

#ranker ⇒ Object

The ranker to use for the file search. If not specified will use the auto ranker.



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

def ranker
  @ranker
end

#score_threshold ⇒ Object

The score threshold for the file search. All values must be a floating point number between 0 and 1.



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

def score_threshold
  @score_threshold
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



56
57
58
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 56

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 61

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 48

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 190

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



74
75
76
77
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 66

def self.openapi_types
  {
    :'ranker' => :'String',
    :'score_threshold' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



168
169
170
171
172
173
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ranker == o.ranker &&
      score_threshold == o.score_threshold
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


177
178
179
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



183
184
185
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 183

def hash
  [ranker, score_threshold].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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 108

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

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

  if @score_threshold < 0
    invalid_properties.push('invalid value for "score_threshold", must be greater than or equal to 0.')
  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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 212

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



128
129
130
131
132
133
134
135
136
 
# File 'lib/openapi_openai/models/file_search_ranking_options.rb', line 128

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  ranker_validator = EnumAttributeValidator.new('String', ["auto", "default_2024_08_21"])
  return false unless ranker_validator.valid?(@ranker)
  return false if @score_threshold.nil?
  return false if @score_threshold > 1
  return false if @score_threshold < 0
  true
end