Class: Vellum::SandboxScenario

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(inputs:, id:, label: nil, additional_properties: nil) ⇒ SandboxScenario

Parameters:

  • label (String) (defaults to: nil)
  • inputs (Array<ScenarioInput>) —

    The inputs for the scenario

  • id (String) —

    The id of the scenario

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
23
24
 
# File 'lib/vellum_ai/types/sandbox_scenario.rb', line 15

def initialize(inputs:, id:, label: nil, additional_properties: nil)
  # @type [String]
  @label = label
  # @type [Array<ScenarioInput>] The inputs for the scenario
  @inputs = inputs
  # @type [String] The id of the scenario
  @id = id
  # @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.



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

def additional_properties
  @additional_properties
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#inputs ⇒ Object (readonly)

Returns the value of attribute inputs.



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

def inputs
  @inputs
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



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

def label
  @label
end

Class Method Details

.from_json(json_object:) ⇒ SandboxScenario

Deserialize a JSON object to an instance of SandboxScenario

Parameters:

  • json_object (JSON)

Returns:



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/vellum_ai/types/sandbox_scenario.rb', line 30

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  label = struct.label
  inputs = parsed_json["inputs"].map do |v|
    v = v.to_json
    ScenarioInput.from_json(json_object: v)
  end
  id = struct.id
  new(label: label, inputs: inputs, id: id, 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) 


53
54
55
56
57
 
# File 'lib/vellum_ai/types/sandbox_scenario.rb', line 53

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of SandboxScenario to a JSON object

Returns:

  • (JSON) 


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

def to_json(*_args)
  { "label": @label, "inputs": @inputs, "id": @id }.to_json
end