Class: Vellum::TestSuiteRunExecutionMetricResult

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metric_id:, outputs:, additional_properties: nil) ⇒ TestSuiteRunExecutionMetricResult

Parameters:

  • metric_id (String)
  • outputs (Array<TestSuiteRunMetricOutput>)
  • 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/test_suite_run_execution_metric_result.rb', line 14

def initialize(metric_id:, outputs:, additional_properties: nil)
  # @type [String]
  @metric_id = metric_id
  # @type [Array<TestSuiteRunMetricOutput>]
  @outputs = outputs
  # @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/test_suite_run_execution_metric_result.rb', line 8

def additional_properties
  @additional_properties
end

#metric_id ⇒ Object (readonly)

Returns the value of attribute metric_id.



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

def metric_id
  @metric_id
end

#outputs ⇒ Object (readonly)

Returns the value of attribute outputs.



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

def outputs
  @outputs
end

Class Method Details

.from_json(json_object:) ⇒ TestSuiteRunExecutionMetricResult

Deserialize a JSON object to an instance of TestSuiteRunExecutionMetricResult

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  metric_id = struct.metric_id
  outputs = parsed_json["outputs"].map do |v|
    v = v.to_json
    TestSuiteRunMetricOutput.from_json(json_object: v)
  end
  new(metric_id: metric_id, outputs: outputs, 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/test_suite_run_execution_metric_result.rb', line 49

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of TestSuiteRunExecutionMetricResult to a JSON object

Returns:

  • (JSON) 


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

def to_json(*_args)
  { "metric_id": @metric_id, "outputs": @outputs }.to_json
end