Class: Carbon::SyncOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/carbon_ruby_sdk/models/sync_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SyncOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 125

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

  if attributes.key?(:'chunk_size')
    self.chunk_size = attributes[:'chunk_size']
  else
    self.chunk_size = 1500
  end

  if attributes.key?(:'chunk_overlap')
    self.chunk_overlap = attributes[:'chunk_overlap']
  else
    self.chunk_overlap = 20
  end

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

  if attributes.key?(:'embedding_model')
    self.embedding_model = attributes[:'embedding_model']
  else
    self.embedding_model = 'OPENAI'
  end

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

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

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

  if attributes.key?(:'sync_files_on_connection')
    self.sync_files_on_connection = attributes[:'sync_files_on_connection']
  else
    self.sync_files_on_connection = true
  end

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

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

  if attributes.key?(:'enable_file_picker')
    self.enable_file_picker = attributes[:'enable_file_picker']
  else
    self.enable_file_picker = true
  end

  if attributes.key?(:'sync_source_items')
    self.sync_source_items = attributes[:'sync_source_items']
  else
    self.sync_source_items = true
  end

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

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

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

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

Instance Attribute Details

#automatically_open_file_picker ⇒ Object

Automatically open source file picker after the OAuth flow is complete. This flag is currently supported by BOX, DROPBOX, GOOGLE_DRIVE, ONEDRIVE, SHAREPOINT. It will be ignored for other data sources.



49
50
51
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 49

def automatically_open_file_picker
  @automatically_open_file_picker
end

#chunk_overlap ⇒ Object

Returns the value of attribute chunk_overlap.



18
19
20
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 18

def chunk_overlap
  @chunk_overlap
end

#chunk_size ⇒ Object

Returns the value of attribute chunk_size.



16
17
18
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 16

def chunk_size
  @chunk_size
end

#data_source_tags ⇒ Object

Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.



52
53
54
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 52

def data_source_tags
  @data_source_tags
end

#embedding_model ⇒ Object

Returns the value of attribute embedding_model.



22
23
24
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 22

def embedding_model
  @embedding_model
end

#enable_file_picker ⇒ Object

Returns the value of attribute enable_file_picker.



38
39
40
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 38

def enable_file_picker
  @enable_file_picker
end

#file_sync_config ⇒ Object

Returns the value of attribute file_sync_config.



46
47
48
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 46

def file_sync_config
  @file_sync_config
end

#generate_sparse_vectors ⇒ Object

Returns the value of attribute generate_sparse_vectors.



24
25
26
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 24

def generate_sparse_vectors
  @generate_sparse_vectors
end

#incremental_sync ⇒ Object

Only sync files if they have not already been synced or if the embedding properties have changed. This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK, ZENDESK, CONFLUENCE, NOTION, SHAREPOINT, SERVICENOW. It will be ignored for other data sources.



44
45
46
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 44

def incremental_sync
  @incremental_sync
end

#max_items_per_chunk ⇒ Object

Number of objects per chunk. For csv, tsv, xlsx, and json files only.



29
30
31
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 29

def max_items_per_chunk
  @max_items_per_chunk
end

#prepend_filename_to_chunks ⇒ Object

Returns the value of attribute prepend_filename_to_chunks.



26
27
28
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 26

def prepend_filename_to_chunks
  @prepend_filename_to_chunks
end

#request_id ⇒ Object

Returns the value of attribute request_id.



36
37
38
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 36

def request_id
  @request_id
end

#set_page_as_boundary ⇒ Object

Returns the value of attribute set_page_as_boundary.



34
35
36
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 34

def set_page_as_boundary
  @set_page_as_boundary
end

#skip_embedding_generation ⇒ Object

Returns the value of attribute skip_embedding_generation.



20
21
22
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 20

def skip_embedding_generation
  @skip_embedding_generation
end

#sync_files_on_connection ⇒ Object

Used to specify whether Carbon should attempt to sync all your files automatically when authorization is complete. This is only supported for a subset of connectors and will be ignored for the rest. Supported connectors: Intercom, Zendesk, Gitbook, Confluence, Salesforce, Freshdesk



32
33
34
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 32

def sync_files_on_connection
  @sync_files_on_connection
end

#sync_source_items ⇒ Object

Enabling this flag will fetch all available content from the source to be listed via list items endpoint



41
42
43
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 41

def sync_source_items
  @sync_source_items
end

#tags ⇒ Object

Returns the value of attribute tags.



14
15
16
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 14

def tags
  @tags
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 55

def self.attribute_map
  {
    :'tags' => :'tags',
    :'chunk_size' => :'chunk_size',
    :'chunk_overlap' => :'chunk_overlap',
    :'skip_embedding_generation' => :'skip_embedding_generation',
    :'embedding_model' => :'embedding_model',
    :'generate_sparse_vectors' => :'generate_sparse_vectors',
    :'prepend_filename_to_chunks' => :'prepend_filename_to_chunks',
    :'max_items_per_chunk' => :'max_items_per_chunk',
    :'sync_files_on_connection' => :'sync_files_on_connection',
    :'set_page_as_boundary' => :'set_page_as_boundary',
    :'request_id' => :'request_id',
    :'enable_file_picker' => :'enable_file_picker',
    :'sync_source_items' => :'sync_source_items',
    :'incremental_sync' => :'incremental_sync',
    :'file_sync_config' => :'file_sync_config',
    :'automatically_open_file_picker' => :'automatically_open_file_picker',
    :'data_source_tags' => :'data_source_tags'
  }
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



281
282
283
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 281

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 106

def self.openapi_nullable
  Set.new([
    :'tags',
    :'chunk_size',
    :'chunk_overlap',
    :'skip_embedding_generation',
    :'embedding_model',
    :'generate_sparse_vectors',
    :'prepend_filename_to_chunks',
    :'max_items_per_chunk',
    :'sync_files_on_connection',
    :'request_id',
    :'file_sync_config',
    :'automatically_open_file_picker',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'tags' => :'Object',
    :'chunk_size' => :'Integer',
    :'chunk_overlap' => :'Integer',
    :'skip_embedding_generation' => :'Boolean',
    :'embedding_model' => :'EmbeddingGeneratorsNullable',
    :'generate_sparse_vectors' => :'Boolean',
    :'prepend_filename_to_chunks' => :'Boolean',
    :'max_items_per_chunk' => :'Integer',
    :'sync_files_on_connection' => :'Boolean',
    :'set_page_as_boundary' => :'Boolean',
    :'request_id' => :'String',
    :'enable_file_picker' => :'Boolean',
    :'sync_source_items' => :'Boolean',
    :'incremental_sync' => :'Boolean',
    :'file_sync_config' => :'FileSyncConfigNullable',
    :'automatically_open_file_picker' => :'Boolean',
    :'data_source_tags' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tags == o.tags &&
      chunk_size == o.chunk_size &&
      chunk_overlap == o.chunk_overlap &&
      skip_embedding_generation == o.skip_embedding_generation &&
      embedding_model == o.embedding_model &&
      generate_sparse_vectors == o.generate_sparse_vectors &&
      prepend_filename_to_chunks == o.prepend_filename_to_chunks &&
      max_items_per_chunk == o.max_items_per_chunk &&
      sync_files_on_connection == o.sync_files_on_connection &&
      set_page_as_boundary == o.set_page_as_boundary &&
      request_id == o.request_id &&
      enable_file_picker == o.enable_file_picker &&
      sync_source_items == o.sync_source_items &&
      incremental_sync == o.incremental_sync &&
      file_sync_config == o.file_sync_config &&
      automatically_open_file_picker == o.automatically_open_file_picker &&
      data_source_tags == o.data_source_tags
end

#_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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 312

def _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 = Carbon.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 383

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

#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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 288

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


268
269
270
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



274
275
276
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 274

def hash
  [tags, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, generate_sparse_vectors, prepend_filename_to_chunks, max_items_per_chunk, sync_files_on_connection, set_page_as_boundary, request_id, enable_file_picker, sync_source_items, incremental_sync, file_sync_config, automatically_open_file_picker, data_source_tags].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



231
232
233
234
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 231

def list_invalid_properties
  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



359
360
361
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 359

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 365

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



353
354
355
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 353

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



238
239
240
 
# File 'lib/carbon_ruby_sdk/models/sync_options.rb', line 238

def valid?
  true
end