Class: Deepsearch::Engine::Steps::Summarization::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/deepsearch/engine/steps/summarization/result.rb

Overview

Represents the result of the summarization step. It holds the final, synthesized summary and any potential error message.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(summary: nil, error: nil) ⇒ Result

Returns a new instance of Result.



12
13
14
15
16
 
# File 'lib/deepsearch/engine/steps/summarization/result.rb', line 12

def initialize(summary: nil, error: nil)
  @summary = summary
  @success = error.nil?
  @error = error
end

Instance Attribute Details

#error ⇒ Object (readonly)

Returns the value of attribute error.



10
11
12
 
# File 'lib/deepsearch/engine/steps/summarization/result.rb', line 10

def error
  @error
end

#success ⇒ Object (readonly)

Returns the value of attribute success.



10
11
12
 
# File 'lib/deepsearch/engine/steps/summarization/result.rb', line 10

def success
  @success
end

#summary ⇒ Object (readonly)

Returns the value of attribute summary.



10
11
12
 
# File 'lib/deepsearch/engine/steps/summarization/result.rb', line 10

def summary
  @summary
end

Instance Method Details

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/deepsearch/engine/steps/summarization/result.rb', line 22

def failure?
  !success?
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/deepsearch/engine/steps/summarization/result.rb', line 18

def success?
  @success
end