Class: Deepsearch::Engine::Steps::Rag::Values::Result

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

Overview

Represents the result of the RAG processing step. It contains the original query object and a list of text chunks deemed most relevant to the query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(query: nil, relevant_chunks: [], error: nil) ⇒ Result

Returns a new instance of Result.



14
15
16
17
18
19
 
# File 'lib/deepsearch/engine/steps/rag/values/result.rb', line 14

def initialize(query: nil, relevant_chunks: [], error: nil)
  @query = query
  @relevant_chunks = relevant_chunks
  @success = error.nil?
  @error = error
end

Instance Attribute Details

#error ⇒ Object (readonly)

Returns the value of attribute error.



12
13
14
 
# File 'lib/deepsearch/engine/steps/rag/values/result.rb', line 12

def error
  @error
end

#query ⇒ Object (readonly)

Returns the value of attribute query.



12
13
14
 
# File 'lib/deepsearch/engine/steps/rag/values/result.rb', line 12

def query
  @query
end

#relevant_chunks ⇒ Object (readonly)

Returns the value of attribute relevant_chunks.



12
13
14
 
# File 'lib/deepsearch/engine/steps/rag/values/result.rb', line 12

def relevant_chunks
  @relevant_chunks
end

#success ⇒ Object (readonly)

Returns the value of attribute success.



12
13
14
 
# File 'lib/deepsearch/engine/steps/rag/values/result.rb', line 12

def success
  @success
end

Instance Method Details

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/deepsearch/engine/steps/rag/values/result.rb', line 25

def failure?
  !success?
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/deepsearch/engine/steps/rag/values/result.rb', line 21

def success?
  @success
end