Class: Vellum::TestSuiteRunExecutionMetricResult

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metric_id:, outputs:, metric_label: OMIT, metric_definition: OMIT, additional_properties: nil) ⇒ Vellum::TestSuiteRunExecutionMetricResult

Parameters:



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/vellum_ai/types/test_suite_run_execution_metric_result.rb', line 31

def initialize(metric_id:, outputs:, metric_label: OMIT, metric_definition: OMIT, additional_properties: nil)
  @metric_id = metric_id
  @outputs = outputs
  @metric_label = metric_label if metric_label != OMIT
  @metric_definition = metric_definition if metric_definition != OMIT
  @additional_properties = additional_properties
  @_field_set = { "metric_id": metric_id, "outputs": outputs, "metric_label": metric_label, "metric_definition": metric_definition }.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



18
19
20
 
# File 'lib/vellum_ai/types/test_suite_run_execution_metric_result.rb', line 18

def additional_properties
  @additional_properties
end

#metric_definition ⇒ Vellum::TestSuiteRunExecutionMetricDefinition (readonly)

Returns:



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

def metric_definition
  @metric_definition
end

#metric_id ⇒ String (readonly)

Returns:

  • (String) 


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

def metric_id
  @metric_id
end

#metric_label ⇒ String (readonly)

Returns:

  • (String) 


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

def metric_label
  @metric_label
end

#outputs ⇒ Array<Vellum::TestSuiteRunMetricOutput> (readonly)

Returns:



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

def outputs
  @outputs
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::TestSuiteRunExecutionMetricResult

Parameters:

  • json_object (String)

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/vellum_ai/types/test_suite_run_execution_metric_result.rb', line 45

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  metric_id = parsed_json["metric_id"]
  outputs = parsed_json["outputs"]&.map do | item |
  item = item.to_json
  Vellum::TestSuiteRunMetricOutput.from_json(json_object: item)
end
  metric_label = parsed_json["metric_label"]
  unless parsed_json["metric_definition"].nil?
    metric_definition = parsed_json["metric_definition"].to_json
    metric_definition = Vellum::TestSuiteRunExecutionMetricDefinition.from_json(json_object: metric_definition)
  else
    metric_definition = nil
  end
  new(
    metric_id: metric_id,
    outputs: outputs,
    metric_label: metric_label,
    metric_definition: metric_definition,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


80
81
82
83
84
85
 
# File 'lib/vellum_ai/types/test_suite_run_execution_metric_result.rb', line 80

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.")
  obj.metric_label&.is_a?(String) != false || raise("Passed value for field obj.metric_label is not the expected type, validation failed.")
  obj.metric_definition.nil? || Vellum::TestSuiteRunExecutionMetricDefinition.validate_raw(obj: obj.metric_definition)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


71
72
73
 
# File 'lib/vellum_ai/types/test_suite_run_execution_metric_result.rb', line 71

def to_json
  @_field_set&.to_json
end