Class: Vellum::RegisteredPromptDeployment

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, name:, label:, additional_properties: nil) ⇒ RegisteredPromptDeployment

Parameters:

  • id (String) —

    The ID of the generated deployment.

  • name (String) —

    A uniquely-identifying name for generated deployment.

  • label (String) —

    A human-friendly label for the generated deployment.

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

    Additional properties unmapped to the current class definition



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

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

def id
  @id
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



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

def label
  @label
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

Class Method Details

.from_json(json_object:) ⇒ RegisteredPromptDeployment

Deserialize a JSON object to an instance of RegisteredPromptDeployment

Parameters:

  • json_object (JSON)

Returns:



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

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


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

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.name.is_a?(String) != false || raise("Passed value for field obj.name 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 RegisteredPromptDeployment to a JSON object

Returns:

  • (JSON) 


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

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