Class: OpenApiOpenAIClient::RunStepDetailsToolCallsFileSearchResultObject

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

Overview

A result instance of the file search.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
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
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 69

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

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

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

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

Instance Attribute Details

#content ⇒ Object

The content of the result that was found. The content is only included if requested via the include query parameter.



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

def content
  @content
end

#file_id ⇒ Object

The ID of the file that result was found in.



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

def file_id
  @file_id
end

#file_name ⇒ Object

The name of the file that result was found in.



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

def file_name
  @file_name
end

#score ⇒ Object

The score of the result. All values must be a floating point number between 0 and 1.



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

def score
  @score
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 47

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
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 32

def self.attribute_map
  {
    :'file_id' => :'file_id',
    :'file_name' => :'file_name',
    :'score' => :'score',
    :'content' => :'content'
  }
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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 212

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



62
63
64
65
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 52

def self.openapi_types
  {
    :'file_id' => :'String',
    :'file_name' => :'String',
    :'score' => :'Float',
    :'content' => :'Array<RunStepDetailsToolCallsFileSearchResultObjectContentInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_id == o.file_id &&
      file_name == o.file_name &&
      score == o.score &&
      content == o.content
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 205

def hash
  [file_id, file_name, score, content].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



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
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 110

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

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

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

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

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 234

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



138
139
140
141
142
143
144
145
146
 
# File 'lib/openapi_openai/models/run_step_details_tool_calls_file_search_result_object.rb', line 138

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @file_id.nil?
  return false if @file_name.nil?
  return false if @score.nil?
  return false if @score > 1
  return false if @score < 0
  true
end