Class: Desiru::Modules::Backend

Inherits:
Object
  • Object
show all
Defined in:
lib/desiru/modules/retrieve.rb

Overview

Abstract base class for retrieval backends

Direct Known Subclasses

InMemoryBackend

Instance Method Summary collapse

Instance Method Details

#add(_documents, embeddings: nil) ⇒ Object

Raises:

  • (NotImplementedError) 


67
68
69
 
# File 'lib/desiru/modules/retrieve.rb', line 67

def add(_documents, embeddings: nil)
  raise NotImplementedError, 'Subclasses must implement #add'
end

#clear ⇒ Object

Raises:

  • (NotImplementedError) 


75
76
77
 
# File 'lib/desiru/modules/retrieve.rb', line 75

def clear
  raise NotImplementedError, 'Subclasses must implement #clear'
end

#search(_query, k: 5) ⇒ Object

rubocop:disable Naming/MethodParameterName

Raises:

  • (NotImplementedError) 


71
72
73
 
# File 'lib/desiru/modules/retrieve.rb', line 71

def search(_query, k: 5) # rubocop:disable Naming/MethodParameterName
  raise NotImplementedError, 'Subclasses must implement #search'
end

#size ⇒ Object

Raises:

  • (NotImplementedError) 


79
80
81
 
# File 'lib/desiru/modules/retrieve.rb', line 79

def size
  raise NotImplementedError, 'Subclasses must implement #size'
end