Class: Vellum::ScenarioInputStringVariableValue

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

Overview

Prompt Sandbox Scenario input value that is of type STRING

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, value: OMIT, input_variable_id:, additional_properties: nil) ⇒ Vellum::ScenarioInputStringVariableValue

Parameters:

  • type (String)
  • value (String) (defaults to: OMIT)
  • input_variable_id (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
33
34
35
 
# File 'lib/vellum_ai/types/scenario_input_string_variable_value.rb', line 27

def initialize(type:, value: OMIT, input_variable_id:, additional_properties: nil)
  @type = type
  @value = value if value != OMIT
  @input_variable_id = input_variable_id
  @additional_properties = additional_properties
  @_field_set = { "type": type, "value": value, "input_variable_id": input_variable_id }.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



15
16
17
 
# File 'lib/vellum_ai/types/scenario_input_string_variable_value.rb', line 15

def additional_properties
  @additional_properties
end

#input_variable_id ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/vellum_ai/types/scenario_input_string_variable_value.rb', line 13

def input_variable_id
  @input_variable_id
end

#type ⇒ String (readonly)

Returns:

  • (String) 


9
10
11
 
# File 'lib/vellum_ai/types/scenario_input_string_variable_value.rb', line 9

def type
  @type
end

#value ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/vellum_ai/types/scenario_input_string_variable_value.rb', line 11

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::ScenarioInputStringVariableValue

Parameters:

  • json_object (String)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/vellum_ai/types/scenario_input_string_variable_value.rb', line 40

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


65
66
67
68
69
 
# File 'lib/vellum_ai/types/scenario_input_string_variable_value.rb', line 65

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


56
57
58
 
# File 'lib/vellum_ai/types/scenario_input_string_variable_value.rb', line 56

def to_json
  @_field_set&.to_json
end