Class: Vellum::VellumAudio

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/vellum_audio.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(src:, metadata: OMIT, additional_properties: nil) ⇒ Vellum::VellumAudio

Parameters:

  • src (String) —

    A valid data URL containing the audio data.

  • metadata (Hash{String => Object}) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



23
24
25
26
27
28
29
30
 
# File 'lib/vellum_ai/types/vellum_audio.rb', line 23

def initialize(src:, metadata: OMIT, additional_properties: nil)
  @src = src
  @metadata = metadata if metadata != OMIT
  @additional_properties = additional_properties
  @_field_set = { "src": src, "metadata": metadata }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



12
13
14
 
# File 'lib/vellum_ai/types/vellum_audio.rb', line 12

def additional_properties
  @additional_properties
end

#metadata ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


10
11
12
 
# File 'lib/vellum_ai/types/vellum_audio.rb', line 10

def metadata
  @metadata
end

#src ⇒ String (readonly)

Returns A valid data URL containing the audio data.

Returns:

  • (String) —

    A valid data URL containing the audio data.



8
9
10
 
# File 'lib/vellum_ai/types/vellum_audio.rb', line 8

def src
  @src
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::VellumAudio

Parameters:

  • json_object (String)

Returns:



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/vellum_ai/types/vellum_audio.rb', line 35

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  src = parsed_json["src"]
  metadata = parsed_json["metadata"]
  new(
    src: src,
    metadata: metadata,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


58
59
60
61
 
# File 'lib/vellum_ai/types/vellum_audio.rb', line 58

def self.validate_raw(obj:)
  obj.src.is_a?(String) != false || raise("Passed value for field obj.src is not the expected type, validation failed.")
  obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


49
50
51
 
# File 'lib/vellum_ai/types/vellum_audio.rb', line 49

def to_json
  @_field_set&.to_json
end