Class: Vellum::PromptExecConfig

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ml_model:, input_variables:, parameters:, settings: OMIT, blocks:, functions: OMIT, additional_properties: nil) ⇒ Vellum::PromptExecConfig

Parameters:



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

def initialize(ml_model:, input_variables:, parameters:, settings: OMIT, blocks:, functions: OMIT, additional_properties: nil)
  @ml_model = ml_model
  @input_variables = input_variables
  @parameters = parameters
  @settings = settings if settings != OMIT
  @blocks = blocks
  @functions = functions if functions != OMIT
  @additional_properties = additional_properties
  @_field_set = { "ml_model": ml_model, "input_variables": input_variables, "parameters": parameters, "settings": settings, "blocks": blocks, "functions": functions }.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



25
26
27
 
# File 'lib/vellum_ai/types/prompt_exec_config.rb', line 25

def additional_properties
  @additional_properties
end

#blocks ⇒ Array<Vellum::PromptBlock> (readonly)

Returns:



21
22
23
 
# File 'lib/vellum_ai/types/prompt_exec_config.rb', line 21

def blocks
  @blocks
end

#functions ⇒ Array<Vellum::FunctionDefinition> (readonly)

Returns:



23
24
25
 
# File 'lib/vellum_ai/types/prompt_exec_config.rb', line 23

def functions
  @functions
end

#input_variables ⇒ Array<Vellum::VellumVariable> (readonly)

Returns:



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

def input_variables
  @input_variables
end

#ml_model ⇒ String (readonly)

Returns:

  • (String) 


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

def ml_model
  @ml_model
end

#parameters ⇒ Vellum::PromptParameters (readonly)

Returns:



17
18
19
 
# File 'lib/vellum_ai/types/prompt_exec_config.rb', line 17

def parameters
  @parameters
end

#settings ⇒ Vellum::PromptSettings (readonly)

Returns:



19
20
21
 
# File 'lib/vellum_ai/types/prompt_exec_config.rb', line 19

def settings
  @settings
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::PromptExecConfig

Parameters:

  • json_object (String)

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/vellum_ai/types/prompt_exec_config.rb', line 56

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  ml_model = parsed_json["ml_model"]
  input_variables = parsed_json["input_variables"]&.map do | item |
  item = item.to_json
  Vellum::VellumVariable.from_json(json_object: item)
end
  unless parsed_json["parameters"].nil?
    parameters = parsed_json["parameters"].to_json
    parameters = Vellum::PromptParameters.from_json(json_object: parameters)
  else
    parameters = nil
  end
  unless parsed_json["settings"].nil?
    settings = parsed_json["settings"].to_json
    settings = Vellum::PromptSettings.from_json(json_object: settings)
  else
    settings = nil
  end
  blocks = parsed_json["blocks"]&.map do | item |
  item = item.to_json
  Vellum::PromptBlock.from_json(json_object: item)
end
  functions = parsed_json["functions"]&.map do | item |
  item = item.to_json
  Vellum::FunctionDefinition.from_json(json_object: item)
end
  new(
    ml_model: ml_model,
    input_variables: input_variables,
    parameters: parameters,
    settings: settings,
    blocks: blocks,
    functions: functions,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


106
107
108
109
110
111
112
113
 
# File 'lib/vellum_ai/types/prompt_exec_config.rb', line 106

def self.validate_raw(obj:)
  obj.ml_model.is_a?(String) != false || raise("Passed value for field obj.ml_model is not the expected type, validation failed.")
  obj.input_variables.is_a?(Array) != false || raise("Passed value for field obj.input_variables is not the expected type, validation failed.")
  Vellum::PromptParameters.validate_raw(obj: obj.parameters)
  obj.settings.nil? || Vellum::PromptSettings.validate_raw(obj: obj.settings)
  obj.blocks.is_a?(Array) != false || raise("Passed value for field obj.blocks is not the expected type, validation failed.")
  obj.functions&.is_a?(Array) != false || raise("Passed value for field obj.functions is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


97
98
99
 
# File 'lib/vellum_ai/types/prompt_exec_config.rb', line 97

def to_json
  @_field_set&.to_json
end