Class: RagieRubySdk::RetrieveParams

Inherits:
Object
  • Object
show all
Defined in:
lib/ragie_ruby_sdk/models/retrieve_params.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RetrieveParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 82

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

  if attributes.key?(:'top_k')
    self.top_k = attributes[:'top_k']
  else
    self.top_k = 8
  end

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

  if attributes.key?(:'rerank')
    self.rerank = attributes[:'rerank']
  else
    self.rerank = false
  end

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

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

  if attributes.key?(:'recency_bias')
    self.recency_bias = attributes[:'recency_bias']
  else
    self.recency_bias = false
  end
end

Instance Attribute Details

#filter ⇒ Object

Returns the value of attribute filter.



24
25
26
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 24

def filter
  @filter
end

#max_chunks_per_document ⇒ Object

Maximum number of chunks to retrieve per document. Use this to increase the number of documents the final chunks are retrieved from. This feature is in beta and may change in the future.



30
31
32
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 30

def max_chunks_per_document
  @max_chunks_per_document
end

#partition ⇒ Object

The partition to scope a retrieval to. If omitted, the retrieval will be scoped to the default partition, which includes any documents that have not been created in a partition.



33
34
35
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 33

def partition
  @partition
end

#query ⇒ Object

The query to search with when retrieving document chunks.



19
20
21
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 19

def query
  @query
end

#recency_bias ⇒ Object

Enables recency bias which will favor more recent documents vs older documents. docs.ragie.ai/docs/retrievals-recency-bias



36
37
38
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 36

def recency_bias
  @recency_bias
end

#rerank ⇒ Object

Reranks the chunks for semantic relevancy post cosine similarity. Will be slower but returns a subset of highly relevant chunks. Best for reducing hallucinations and improving accuracy for LLM generation.



27
28
29
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 27

def rerank
  @rerank
end

#top_k ⇒ Object

The maximum number of chunks to return. Defaults to 8.



22
23
24
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 22

def top_k
  @top_k
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 218

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = RagieRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



52
53
54
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 52

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 57

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 39

def self.attribute_map
  {
    :'query' => :'query',
    :'top_k' => :'top_k',
    :'filter' => :'filter',
    :'rerank' => :'rerank',
    :'max_chunks_per_document' => :'max_chunks_per_document',
    :'partition' => :'partition',
    :'recency_bias' => :'recency_bias'
  }
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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 194

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



75
76
77
78
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 62

def self.openapi_types
  {
    :'query' => :'String',
    :'top_k' => :'Integer',
    :'filter' => :'Hash<String, Object>',
    :'rerank' => :'Boolean',
    :'max_chunks_per_document' => :'Integer',
    :'partition' => :'String',
    :'recency_bias' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query == o.query &&
      top_k == o.top_k &&
      filter == o.filter &&
      rerank == o.rerank &&
      max_chunks_per_document == o.max_chunks_per_document &&
      partition == o.partition &&
      recency_bias == o.recency_bias
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 289

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



187
188
189
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 187

def hash
  [query, top_k, filter, rerank, max_chunks_per_document, partition, recency_bias].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



137
138
139
140
141
142
143
144
145
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 137

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 265

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 271

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



259
260
261
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 259

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



149
150
151
152
153
 
# File 'lib/ragie_ruby_sdk/models/retrieve_params.rb', line 149

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @query.nil?
  true
end