Class: ContextDev::Models::BatchRetrieveResponse::Results::File

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/batch_retrieve_response.rb,
sig/context_dev/models/batch_retrieve_response.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(expires_at:, files:) ⇒ File

Download links, available once the batch reaches a final status and null before then. GET /batch/batch_id/results serves the same records as paginated JSON.

Parameters:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/context_dev/models/batch_retrieve_response.rb', line 277

class File < ContextDev::Internal::Type::BaseModel
  # @!attribute bytes
  #   Compressed file size in bytes.
  #
  #   @return [Integer]
  required :bytes, Integer

  # @!attribute items
  #   Results in this file.
  #
  #   @return [Integer]
  required :items, Integer

  # @!attribute url
  #   Temporary URL for a gzipped NDJSON file.
  #
  #   @return [String]
  required :url, String

  # @!method initialize(bytes:, items:, url:)
  #   @param bytes [Integer] Compressed file size in bytes.
  #
  #   @param items [Integer] Results in this file.
  #
  #   @param url [String] Temporary URL for a gzipped NDJSON file.
end

Instance Attribute Details

#bytes ⇒ Integer

Compressed file size in bytes.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


282
 
# File 'lib/context_dev/models/batch_retrieve_response.rb', line 282

required :bytes, Integer

#items ⇒ Integer

Results in this file.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


288
 
# File 'lib/context_dev/models/batch_retrieve_response.rb', line 288

required :items, Integer

#url ⇒ String

Temporary URL for a gzipped NDJSON file.

Parameters:

  • value (String)

Returns:

  • (String) 


294
 
# File 'lib/context_dev/models/batch_retrieve_response.rb', line 294

required :url, String

Instance Method Details

#to_hash ⇒ { bytes: Integer, items: Integer, url: String }

Returns:

  • ({ bytes: Integer, items: Integer, url: String }) 


199
 
# File 'sig/context_dev/models/batch_retrieve_response.rbs', line 199

def to_hash: -> { bytes: Integer, items: Integer, url: String }