Class: Carbon::UploadFileFromUrlInput

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UploadFileFromUrlInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 128

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

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

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

  if attributes.key?(:'chunk_overlap')
    self.chunk_overlap = attributes[:'chunk_overlap']
  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?(:'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?(:'embedding_model')
    self.embedding_model = attributes[:'embedding_model']
  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?(:'use_textract')
    self.use_textract = attributes[:'use_textract']
  else
    self.use_textract = 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?(:'parse_pdf_tables_with_ocr')
    self.parse_pdf_tables_with_ocr = attributes[:'parse_pdf_tables_with_ocr']
  else
    self.parse_pdf_tables_with_ocr = false
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#chunk_overlap ⇒ Object

Returns the value of attribute chunk_overlap.



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

def chunk_overlap
  @chunk_overlap
end

#chunk_size ⇒ Object

Returns the value of attribute chunk_size.



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

def chunk_size
  @chunk_size
end

#cold_storage_params ⇒ Object

Returns the value of attribute cold_storage_params.



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

def cold_storage_params
  @cold_storage_params
end

#detect_audio_language ⇒ Object

Returns the value of attribute detect_audio_language.



39
40
41
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 39

def detect_audio_language
  @detect_audio_language
end

#embedding_model ⇒ Object

Returns the value of attribute embedding_model.



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

def embedding_model
  @embedding_model
end

#file_name ⇒ Object

Returns the value of attribute file_name.



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

def file_name
  @file_name
end

#generate_chunks_only ⇒ Object

If this flag is enabled, the file will be chunked and stored with Carbon, but no embeddings will be generated. This overrides the skip_embedding_generation flag.



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

def generate_chunks_only
  @generate_chunks_only
end

#generate_sparse_vectors ⇒ Object

Returns the value of attribute generate_sparse_vectors.



28
29
30
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 28

def generate_sparse_vectors
  @generate_sparse_vectors
end

#include_speaker_labels ⇒ Object

Returns the value of attribute include_speaker_labels.



43
44
45
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 43

def include_speaker_labels
  @include_speaker_labels
end

#max_items_per_chunk ⇒ Object

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



35
36
37
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 35

def max_items_per_chunk
  @max_items_per_chunk
end

#media_type ⇒ Object

Returns the value of attribute media_type.



45
46
47
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 45

def media_type
  @media_type
end

#parse_pdf_tables_with_ocr ⇒ Object

Returns the value of attribute parse_pdf_tables_with_ocr.



37
38
39
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 37

def parse_pdf_tables_with_ocr
  @parse_pdf_tables_with_ocr
end

#prepend_filename_to_chunks ⇒ Object

Returns the value of attribute prepend_filename_to_chunks.



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

def prepend_filename_to_chunks
  @prepend_filename_to_chunks
end

#set_page_as_boundary ⇒ Object

Returns the value of attribute set_page_as_boundary.



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

def set_page_as_boundary
  @set_page_as_boundary
end

#skip_embedding_generation ⇒ Object

Returns the value of attribute skip_embedding_generation.



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

def skip_embedding_generation
  @skip_embedding_generation
end

#split_rows ⇒ Object

Returns the value of attribute split_rows.



47
48
49
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 47

def split_rows
  @split_rows
end

#store_file_only ⇒ Object

If this flag is enabled, the file will be stored with Carbon, but no processing will be done.



55
56
57
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 55

def store_file_only
  @store_file_only
end

#transcription_service ⇒ Object

Returns the value of attribute transcription_service.



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

def transcription_service
  @transcription_service
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#use_textract ⇒ Object

Returns the value of attribute use_textract.



30
31
32
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 30

def use_textract
  @use_textract
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 58

def self.attribute_map
  {
    :'url' => :'url',
    :'file_name' => :'file_name',
    :'chunk_size' => :'chunk_size',
    :'chunk_overlap' => :'chunk_overlap',
    :'skip_embedding_generation' => :'skip_embedding_generation',
    :'set_page_as_boundary' => :'set_page_as_boundary',
    :'embedding_model' => :'embedding_model',
    :'generate_sparse_vectors' => :'generate_sparse_vectors',
    :'use_textract' => :'use_textract',
    :'prepend_filename_to_chunks' => :'prepend_filename_to_chunks',
    :'max_items_per_chunk' => :'max_items_per_chunk',
    :'parse_pdf_tables_with_ocr' => :'parse_pdf_tables_with_ocr',
    :'detect_audio_language' => :'detect_audio_language',
    :'transcription_service' => :'transcription_service',
    :'include_speaker_labels' => :'include_speaker_labels',
    :'media_type' => :'media_type',
    :'split_rows' => :'split_rows',
    :'cold_storage_params' => :'cold_storage_params',
    :'generate_chunks_only' => :'generate_chunks_only',
    :'store_file_only' => :'store_file_only'
  }
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



304
305
306
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 304

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 115

def self.openapi_nullable
  Set.new([
    :'file_name',
    :'chunk_size',
    :'chunk_overlap',
    :'max_items_per_chunk',
    :'transcription_service',
    :'media_type',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 89

def self.openapi_types
  {
    :'url' => :'String',
    :'file_name' => :'String',
    :'chunk_size' => :'Integer',
    :'chunk_overlap' => :'Integer',
    :'skip_embedding_generation' => :'Boolean',
    :'set_page_as_boundary' => :'Boolean',
    :'embedding_model' => :'EmbeddingGenerators',
    :'generate_sparse_vectors' => :'Boolean',
    :'use_textract' => :'Boolean',
    :'prepend_filename_to_chunks' => :'Boolean',
    :'max_items_per_chunk' => :'Integer',
    :'parse_pdf_tables_with_ocr' => :'Boolean',
    :'detect_audio_language' => :'Boolean',
    :'transcription_service' => :'TranscriptionServiceNullable',
    :'include_speaker_labels' => :'Boolean',
    :'media_type' => :'FileContentTypesNullable',
    :'split_rows' => :'Boolean',
    :'cold_storage_params' => :'ColdStorageProps',
    :'generate_chunks_only' => :'Boolean',
    :'store_file_only' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      file_name == o.file_name &&
      chunk_size == o.chunk_size &&
      chunk_overlap == o.chunk_overlap &&
      skip_embedding_generation == o.skip_embedding_generation &&
      set_page_as_boundary == o.set_page_as_boundary &&
      embedding_model == o.embedding_model &&
      generate_sparse_vectors == o.generate_sparse_vectors &&
      use_textract == o.use_textract &&
      prepend_filename_to_chunks == o.prepend_filename_to_chunks &&
      max_items_per_chunk == o.max_items_per_chunk &&
      parse_pdf_tables_with_ocr == o.parse_pdf_tables_with_ocr &&
      detect_audio_language == o.detect_audio_language &&
      transcription_service == o.transcription_service &&
      include_speaker_labels == o.include_speaker_labels &&
      media_type == o.media_type &&
      split_rows == o.split_rows &&
      cold_storage_params == o.cold_storage_params &&
      generate_chunks_only == o.generate_chunks_only &&
      store_file_only == o.store_file_only
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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 335

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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 406

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 311

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


291
292
293
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 297

def hash
  [url, file_name, chunk_size, chunk_overlap, skip_embedding_generation, set_page_as_boundary, embedding_model, generate_sparse_vectors, use_textract, prepend_filename_to_chunks, max_items_per_chunk, parse_pdf_tables_with_ocr, detect_audio_language, transcription_service, include_speaker_labels, media_type, split_rows, cold_storage_params, generate_chunks_only, store_file_only].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



246
247
248
249
250
251
252
253
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 246

def list_invalid_properties
  invalid_properties = Array.new
  if @url.nil?
    invalid_properties.push('invalid value for "url", url 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



382
383
384
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 382

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 388

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



376
377
378
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 376

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



257
258
259
260
 
# File 'lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb', line 257

def valid?
  return false if @url.nil?
  true
end