Class: Vellum::RegisterPromptPrompt

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, label:, additional_properties: nil) ⇒ RegisterPromptPrompt

Parameters:

  • id (String) —

    The ID of the generated prompt.

  • label (String) —

    A human-friendly label for the generated prompt.

  • 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/register_prompt_prompt.rb', line 13

def initialize(id:, label:, additional_properties: nil)
  # @type [String] The ID of the generated prompt.
  @id = id
  # @type [String] A human-friendly label for the generated prompt.
  @label = label
  # @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/register_prompt_prompt.rb', line 7

def additional_properties
  @additional_properties
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



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

def label
  @label
end

Class Method Details

.from_json(json_object:) ⇒ RegisterPromptPrompt

Deserialize a JSON object to an instance of RegisterPromptPrompt

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  id = struct.id
  label = struct.label
  new(id: id, label: label, 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/register_prompt_prompt.rb', line 45

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of RegisterPromptPrompt to a JSON object

Returns:

  • (JSON) 


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

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