Class: Raif::Evals::ExpectationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/raif/evals/expectation_result.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description:, status:, error: nil, error_message: nil, metadata: nil) ⇒ ExpectationResult

Returns a new instance of ExpectationResult.



9
10
11
12
13
14
15
 
# File 'lib/raif/evals/expectation_result.rb', line 9

def initialize(description:, status:, error: nil, error_message: nil, metadata: nil)
  @description = description
  @status = status
  @error = error
  @error_message = error_message
  @metadata = metadata
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



6
7
8
 
# File 'lib/raif/evals/expectation_result.rb', line 6

def description
  @description
end

#error ⇒ Object (readonly)

Returns the value of attribute error.



6
7
8
 
# File 'lib/raif/evals/expectation_result.rb', line 6

def error
  @error
end

#error_message ⇒ Object

Returns the value of attribute error_message.



7
8
9
 
# File 'lib/raif/evals/expectation_result.rb', line 7

def error_message
  @error_message
end

#metadata ⇒ Object

Returns the value of attribute metadata.



7
8
9
 
# File 'lib/raif/evals/expectation_result.rb', line 7

def metadata
  @metadata
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



6
7
8
 
# File 'lib/raif/evals/expectation_result.rb', line 6

def status
  @status
end

Instance Method Details

#error? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/raif/evals/expectation_result.rb', line 25

def error?
  @status == :error
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/raif/evals/expectation_result.rb', line 21

def failed?
  @status == :failed
end

#passed? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/raif/evals/expectation_result.rb', line 17

def passed?
  @status == :passed
end

#to_h ⇒ Object 



29
30
31
32
33
34
35
36
 
# File 'lib/raif/evals/expectation_result.rb', line 29

def to_h
  {
    description: description,
    status: status,
    error: error_message.presence || error&.message,
    metadata: metadata
  }.compact
end