Module: Deepsearch

Defined in:
lib/deepsearch.rb,
lib/search_adapters.rb,
lib/deepsearch/engine.rb,
lib/deepsearch/logger.rb,
lib/deepsearch/version.rb,
lib/deepsearch/configuration.rb,
lib/deepsearch/prompts_config.rb,
lib/deepsearch/engine/pipeline.rb,
lib/search_adapters/mock_adapter.rb,
lib/search_adapters/serper_adapter.rb,
lib/search_adapters/tavily_adapter.rb,
lib/deepsearch/engine/steps/rag/chunker.rb,
lib/deepsearch/engine/steps/rag/process.rb,
lib/deepsearch/engine/steps/rag/similarity.rb,
lib/deepsearch/engine/steps/rag/values/chunk.rb,
lib/deepsearch/engine/steps/rag/values/query.rb,
lib/deepsearch/engine/steps/rag/values/result.rb,
lib/deepsearch/engine/steps/summarization/result.rb,
lib/deepsearch/engine/steps/summarization/process.rb,
lib/deepsearch/engine/steps/parallel_search/result.rb,
lib/deepsearch/engine/steps/parallel_search/search.rb,
lib/deepsearch/engine/steps/data_aggregation/result.rb,
lib/deepsearch/engine/steps/parallel_search/process.rb,
lib/deepsearch/engine/steps/data_aggregation/process.rb,
lib/deepsearch/engine/steps/prepare_subqueries/result.rb,
lib/deepsearch/engine/steps/prepare_subqueries/process.rb,
lib/deepsearch/engine/steps/data_aggregation/parsed_website.rb

Overview

The main module for the Deepsearch gem. It provides the primary interface for configuration and for initiating searches.

Defined Under Namespace

Modules: SearchAdapters Classes: Configuration, Engine, Error, Logger, PromptsConfig, RubyLLMConfig

Constant Summary collapse

VERSION = 
"0.1.2"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



17
18
19
 
# File 'lib/deepsearch.rb', line 17

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



21
22
23
24
 
# File 'lib/deepsearch.rb', line 21

def configure
  yield(configuration)
  configuration.configure_llm!
end

.engine(adapter_type: nil) ⇒ Object 



35
36
37
 
# File 'lib/deepsearch.rb', line 35

def engine(adapter_type: nil)
  Engine.new(adapter_type: adapter_type)
end

.reset_configuration! ⇒ Object 



26
27
28
 
# File 'lib/deepsearch.rb', line 26

def reset_configuration!
  @configuration = Configuration.new
end

.search(query, adapter_type: nil, **options) ⇒ Object 



30
31
32
33
 
# File 'lib/deepsearch.rb', line 30

def search(query, adapter_type: nil, **options)
  engine = Engine.new(adapter_type: adapter_type)
  engine.search(query, **options)
end