Class: TrieveRubyClient::ChunkFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/models/chunk_filter.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChunkFilter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
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
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 67

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::ChunkFilter` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::ChunkFilter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

Instance Attribute Details

#jsonb_prefilter ⇒ Object

JOSNB prefilter tells the server to perform a full scan over the metadata JSONB column instead of using the filtered HNSW. Datasets on the enterprise plan with custom metadata indices will perform better with the filtered HNSW instead. When false, the server will use the filtered HNSW index to filter chunks. When true, the server will perform a full scan over the metadata JSONB column to filter chunks. Default is true.



19
20
21
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 19

def jsonb_prefilter
  @jsonb_prefilter
end

#must ⇒ Object

All of these field conditions have to match for the chunk to be included in the result set.



22
23
24
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 22

def must
  @must
end

#must_not ⇒ Object

None of these field conditions can match for the chunk to be included in the result set.



25
26
27
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 25

def must_not
  @must_not
end

#should ⇒ Object

Only one of these field conditions has to match for the chunk to be included in the result set.



28
29
30
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 28

def should
  @should
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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 168

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 = TrieveRubyClient.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 41

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 31

def self.attribute_map
  {
    :'jsonb_prefilter' => :'jsonb_prefilter',
    :'must' => :'must',
    :'must_not' => :'must_not',
    :'should' => :'should'
  }
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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 144

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



56
57
58
59
60
61
62
63
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 56

def self.openapi_nullable
  Set.new([
    :'jsonb_prefilter',
    :'must',
    :'must_not',
    :'should'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 46

def self.openapi_types
  {
    :'jsonb_prefilter' => :'Boolean',
    :'must' => :'Array<ConditionType>',
    :'must_not' => :'Array<ConditionType>',
    :'should' => :'Array<ConditionType>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



120
121
122
123
124
125
126
127
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 120

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      jsonb_prefilter == o.jsonb_prefilter &&
      must == o.must &&
      must_not == o.must_not &&
      should == o.should
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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 239

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


131
132
133
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 131

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



137
138
139
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 137

def hash
  [jsonb_prefilter, must, must_not, should].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



105
106
107
108
109
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 105

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



215
216
217
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 215

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



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 221

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



209
210
211
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 209

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



113
114
115
116
 
# File 'lib/trieve_ruby_client/models/chunk_filter.rb', line 113

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end