Class: Vellum::CompilePromptMeta

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

Overview

compilation that the request opted into with ‘expand_meta`.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model_name: OMIT, deployment_release_tag: OMIT, prompt_version_id: OMIT, additional_properties: nil) ⇒ Vellum::CompilePromptMeta

Parameters:

  • model_name (String) (defaults to: OMIT)
  • deployment_release_tag (String) (defaults to: OMIT)
  • prompt_version_id (String) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(model_name: OMIT, deployment_release_tag: OMIT, prompt_version_id: OMIT, additional_properties: nil)
  @model_name = model_name if model_name != OMIT
  @deployment_release_tag = deployment_release_tag if deployment_release_tag != OMIT
  @prompt_version_id = prompt_version_id if prompt_version_id != OMIT
  @additional_properties = additional_properties
  @_field_set = { "model_name": model_name, "deployment_release_tag": deployment_release_tag, "prompt_version_id": prompt_version_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



16
17
18
 
# File 'lib/vellum_ai/types/compile_prompt_meta.rb', line 16

def additional_properties
  @additional_properties
end

#deployment_release_tag ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/vellum_ai/types/compile_prompt_meta.rb', line 12

def deployment_release_tag
  @deployment_release_tag
end

#model_name ⇒ String (readonly)

Returns:

  • (String) 


10
11
12
 
# File 'lib/vellum_ai/types/compile_prompt_meta.rb', line 10

def model_name
  @model_name
end

#prompt_version_id ⇒ String (readonly)

Returns:

  • (String) 


14
15
16
 
# File 'lib/vellum_ai/types/compile_prompt_meta.rb', line 14

def prompt_version_id
  @prompt_version_id
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::CompilePromptMeta

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  model_name = parsed_json["model_name"]
  deployment_release_tag = parsed_json["deployment_release_tag"]
  prompt_version_id = parsed_json["prompt_version_id"]
  new(
    model_name: model_name,
    deployment_release_tag: deployment_release_tag,
    prompt_version_id: prompt_version_id,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


66
67
68
69
70
 
# File 'lib/vellum_ai/types/compile_prompt_meta.rb', line 66

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


57
58
59
 
# File 'lib/vellum_ai/types/compile_prompt_meta.rb', line 57

def to_json
  @_field_set&.to_json
end