Class: Vellum::VellumImageRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(src:, metadata: nil, additional_properties: nil) ⇒ VellumImageRequest

Parameters:

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

    Additional properties unmapped to the current class definition



13
14
15
16
17
18
19
20
 
# File 'lib/vellum_ai/types/vellum_image_request.rb', line 13

def initialize(src:, metadata: nil, additional_properties: nil)
  # @type [String]
  @src = src
  # @type [Hash{String => String}]
  @metadata = metadata
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



7
8
9
 
# File 'lib/vellum_ai/types/vellum_image_request.rb', line 7

def additional_properties
  @additional_properties
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



7
8
9
 
# File 'lib/vellum_ai/types/vellum_image_request.rb', line 7

def metadata
  @metadata
end

#src ⇒ Object (readonly)

Returns the value of attribute src.



7
8
9
 
# File 'lib/vellum_ai/types/vellum_image_request.rb', line 7

def src
  @src
end

Class Method Details

.from_json(json_object:) ⇒ VellumImageRequest

Deserialize a JSON object to an instance of VellumImageRequest

Parameters:

  • json_object (JSON)

Returns:



26
27
28
29
30
31
32
 
# File 'lib/vellum_ai/types/vellum_image_request.rb', line 26

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

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


45
46
47
48
 
# File 'lib/vellum_ai/types/vellum_image_request.rb', line 45

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(*_args) ⇒ JSON

Serialize an instance of VellumImageRequest to a JSON object

Returns:

  • (JSON) 


37
38
39
 
# File 'lib/vellum_ai/types/vellum_image_request.rb', line 37

def to_json(*_args)
  { "src": @src, "metadata": @metadata }.to_json
end