Class: Vellum::PromptTemplateBlockData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(version:, blocks:, additional_properties: nil) ⇒ PromptTemplateBlockData

Parameters:

  • version (Integer)
  • blocks (Array<PromptTemplateBlock>)
  • 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/prompt_template_block_data.rb', line 14

def initialize(version:, blocks:, additional_properties: nil)
  # @type [Integer]
  @version = version
  # @type [Array<PromptTemplateBlock>]
  @blocks = blocks
  # @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/prompt_template_block_data.rb', line 8

def additional_properties
  @additional_properties
end

#blocks ⇒ Object (readonly)

Returns the value of attribute blocks.



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

def blocks
  @blocks
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.from_json(json_object:) ⇒ PromptTemplateBlockData

Deserialize a JSON object to an instance of PromptTemplateBlockData

Parameters:

  • json_object (JSON)

Returns:



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

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


49
50
51
52
 
# File 'lib/vellum_ai/types/prompt_template_block_data.rb', line 49

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of PromptTemplateBlockData to a JSON object

Returns:

  • (JSON) 


41
42
43
 
# File 'lib/vellum_ai/types/prompt_template_block_data.rb', line 41

def to_json(*_args)
  { "version": @version, "blocks": @blocks }.to_json
end