Class: Vellum::StringInputRequest

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

Overview

A user input representing a string value

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, value:, additional_properties: nil) ⇒ StringInputRequest

Parameters:

  • name (String) —

    The variable’s name, as defined in the deployment.

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

    Additional properties unmapped to the current class definition



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

def initialize(name:, value:, additional_properties: nil)
  # @type [String] The variable's name, as defined in the deployment.
  @name = name
  # @type [String]
  @value = value
  # @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/string_input_request.rb', line 8

def additional_properties
  @additional_properties
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



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

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ StringInputRequest

Deserialize a JSON object to an instance of StringInputRequest

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  name = struct.name
  value = struct.value
  new(name: name, value: value, 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) 


46
47
48
49
 
# File 'lib/vellum_ai/types/string_input_request.rb', line 46

def self.validate_raw(obj:)
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name 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.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of StringInputRequest to a JSON object

Returns:

  • (JSON) 


38
39
40
 
# File 'lib/vellum_ai/types/string_input_request.rb', line 38

def to_json(*_args)
  { "name": @name, "value": @value }.to_json
end