Class: Vellum::TestSuiteRunDeploymentReleaseTagExecConfigData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(deployment_id:, tag: nil, additional_properties: nil) ⇒ TestSuiteRunDeploymentReleaseTagExecConfigData

Parameters:

  • deployment_id (String) —

    The ID of the Prompt Deployment to run the Test Suite against.

  • tag (String) (defaults to: nil) —

    A tag identifying which release of the Prompt Deployment to run the Test Suite against. Useful for testing past versions of the Prompt Deployment

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

def initialize(deployment_id:, tag: nil, additional_properties: nil)
  # @type [String] The ID of the Prompt Deployment to run the Test Suite against.
  @deployment_id = deployment_id
  # @type [String] A tag identifying which release of the Prompt Deployment to run the Test Suite against. Useful for testing past versions of the Prompt Deployment
  @tag = tag
  # @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/test_suite_run_deployment_release_tag_exec_config_data.rb', line 7

def additional_properties
  @additional_properties
end

#deployment_id ⇒ Object (readonly)

Returns the value of attribute deployment_id.



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

def deployment_id
  @deployment_id
end

#tag ⇒ Object (readonly)

Returns the value of attribute tag.



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

def tag
  @tag
end

Class Method Details

.from_json(json_object:) ⇒ TestSuiteRunDeploymentReleaseTagExecConfigData

Deserialize a JSON object to an instance of TestSuiteRunDeploymentReleaseTagExecConfigData

Parameters:

  • json_object (JSON)

Returns:



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

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

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of TestSuiteRunDeploymentReleaseTagExecConfigData to a JSON object

Returns:

  • (JSON) 


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

def to_json(*_args)
  { "deployment_id": @deployment_id, "tag": @tag }.to_json
end