Class: TrieveRubyClient::CreateChunkGroupReqPayload

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateChunkGroupReqPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 79

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for.



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

def description
  @description
end

#metadata ⇒ Object

Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group.



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

def metadata
  @metadata
end

#name ⇒ Object

Name to assign to the chunk_group. Does not need to be unique.



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

def name
  @name
end

#tag_set ⇒ Object

Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group.



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

def tag_set
  @tag_set
end

#tracking_id ⇒ Object

Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.



31
32
33
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 31

def tracking_id
  @tracking_id
end

#upsert_by_tracking_id ⇒ Object

Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists.



34
35
36
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 34

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 186

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



49
50
51
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 37

def self.attribute_map
  {
    :'description' => :'description',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'tag_set' => :'tag_set',
    :'tracking_id' => :'tracking_id',
    :'upsert_by_tracking_id' => :'upsert_by_tracking_id'
  }
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 162

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



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 66

def self.openapi_nullable
  Set.new([
    :'description',
    :'metadata',
    :'name',
    :'tag_set',
    :'tracking_id',
    :'upsert_by_tracking_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'description' => :'String',
    :'metadata' => :'Object',
    :'name' => :'String',
    :'tag_set' => :'Array<String>',
    :'tracking_id' => :'String',
    :'upsert_by_tracking_id' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      metadata == o.metadata &&
      name == o.name &&
      tag_set == o.tag_set &&
      tracking_id == o.tracking_id &&
      upsert_by_tracking_id == o.upsert_by_tracking_id
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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 257

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


149
150
151
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 155

def hash
  [description, metadata, name, tag_set, tracking_id, upsert_by_tracking_id].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



121
122
123
124
125
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 121

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



233
234
235
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 233

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



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

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



227
228
229
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 227

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



129
130
131
132
 
# File 'lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb', line 129

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