GNU ELPA - elisa

1.1.1. System dependencies

1. Sqlite extensions
   

   Then you need to download sqlite-vss. You can do it manually from https://github.com/asg017/sqlite-vss/releases or by calling M-x elisa-download-sqlite-vss.

2. Large language models
   

   You can use this package with different llm providers. By default it uses ollama provider both for embeddings and chat. If you ok with it, you need to install ollama and pull used models:

   ollama pull nomic-embed-text
   ollama pull sskostyaev/openchat:8k-rag
   

   Second model is just openchat with exactly 2 tweaks: context window extended to 8k and temperature set to 0 to better usage for RAG (Retrieval Augmented Generation). You can try other models, for example:

   • all-minilm for embeddings
   • for chat
   • other models or providers
   • create your own model

   I prefer this models:

   ollama pull gemma2:9b-instruct-q6_K
   ollama pull qwen2.5:3b
   ollama pull chatfire/bge-m3:q8_0
   

3. Complex documents
   

   For pdf, doc etc. you need to run Apache Tika service locally. You can do it using docker:

   docker run -d -p 127.0.0.1:9998:9998 apache/tika:latest-full
   

4. Reranker
   

   Reranker disabled by default to decrease number of system dependencies, but it improves quality of retrieving and answers significantly. You can find installation instructions here. Recommended.

5. Web search provider
   

   By defauld duckduckgo used for web search. But I prefer searxng. The simplest way to use searxng is docker. You need to enable json format in settings.

6. Parse info manuals
   

   Create index for builtin, external or all info manuals by one of this commands:

   • elisa-async-parse-builtin-manuals
   • elisa-async-parse-external-manuals
   • elisa-async-parse-all-manuals

   This can take some time.

1.2.1. elisa-chat

1.2.2. elisa-download-sqlite-vss

1.2.3. elisa-async-parse-builtin-manuals

1.2.4. elisa-async-parse-external-manuals

1.2.5. elisa-async-parse-all-manuals

1.2.6. elisa-web-search

1. How it works
   

   Search the web for user query. Create new collection with user query as name. Parse web pages to this new collection. Search in this collection. Add related information to context. Ask llm to answer user query based on provided context.

1.2.7. elisa-async-parse-directory

1.2.8. elisa-reparse-current-collection

1.2.9. elisa-create-empty-collection

1.2.10. elisa-add-file-to-collection

1.2.11. elisa-add-webpage-to-collection

1.2.12. elisa-enable-collection

1.2.13. elisa-enable-all-collections

1.2.14. elisa-disable-collection

1.2.15. elisa-disble-all-collections

1.2.16. elisa-remove-collection

1.3.1. ELISA Custom Variables

1. General Settings
   
   • elisa-embeddings-provider:
     • Description: LLM provider to generate embeddings for text.
     • Default: (make-llm-ollama :embedding-model "nomic-embed-text")
   • elisa-chat-provider:
     • Description: LLM provider used for chat interactions.
     • Default: (make-llm-ollama :chat-model "sskostyaev/openchat:8k-rag" :embedding-model "nomic-embed-text")
   • elisa-db-directory:
     • Type: Directory
     • Description: Specifies the directory where ELISA stores its database.
     • Default: (file-name-concat user-emacs-directory "elisa") (within your Emacs config directory)
   • elisa-limit:
     • Type: Integer
     • Description: Controls the number of quotes passed to the LLM context for generating an answer.
     • Default: 5
   • elisa-find-executable:
     • Type: String
     • Description: Path to the find command executable. Used for locating files.
     • Default: "find"
2. File System and Database Management
   
   • elisa-tar-executable:
     • Type: String
     • Description: Path to the tar command executable. Used for archiving files.
     • Default: "tar"
   • elisa-sqlite-vss-version:
     • Type: String
     • Description: Version of the SQLite VSS extension.
   • elisa-sqlite-vss-path:
     • Type: File path
     • Description: Path to the SQLite VSS extension file.
   • elisa-sqlite-vector-path:
     • Type: File path
     • Description: Path to the SQLite Vector extension file.
3. Text Processing and Semantic Splitting
   
   • elisa-semantic-split-function:
     • Type: Function
     • Description: Function used to split text into semantically meaningful chunks.
     • Default: elisa-split-by-paragraph
   • elisa-prompt-rewriting-enabled:
     • Type: Boolean
     • Description: Enables or disables prompt rewriting for better retrieving.
     • Default: t (enabled)
   • elisa-chat-prompt-template:
     • Type: String
     • Description: Template used for constructing the chat prompt.
   • elisa-rewrite-prompt-template:
     • Type: String
     • Description: Template used for rewriting prompts for better retrieval.
   • elisa-batch-embeddings-enabled:
     • Type: Boolean
     • Description: Enable batch embeddings if supported.
4. Web Search and Integration
   
   • elisa-searxng-url:
     • Type: String
     • Description: URL of your SearXNG instance.
     • Default: "http://localhost:8080/"
   • elisa-pandoc-executable:
     • Type: String
     • Description: Path to the pandoc command executable. Used for converting documents to text.
     • Default: "pandoc"
   • elisa-webpage-extraction-function:
     • Type: Function
     • Description: Function used to extract the content from a webpage.
     • Default: elisa-get-webpage-buffer
   • elisa-web-search-function:
     • Type: Function
     • Description: Function responsible for performing web searches using the provided prompt.
     • Default: elisa-search-duckduckgo
   • elisa-web-pages-limit:
     • Type: Integer
     • Description: Maximum number of web pages to parse during a search.
     • Default: 10
5. Reranking
   
   • elisa-breakpoint-threshold-amount:
     • Type: Float
     • Description: Threshold used for controlling the granularity of semantic splitting.
     • Default: 0.4
   • elisa-reranker-enabled:
     • Type: Boolean
     • Description: Enables or disables reranking, which can improve retrieval quality by ranking retrieved quotes based on relevance.
     • Default: nil (not set)
   • elisa-reranker-url:
     • Type: String
     • Description: URL of the reranking service.
     • Default: "http://127.0.0.1:8787/"
   • elisa-reranker-similarity-threshold:
     • Type: Float
     • Description: Similarity threshold for reranking. Quotes below this threshold will be filtered out. If not set all ellama-limit quotes will be added to context.
     • Default: 0
   • elisa-reranker-limit:
     • Type: Integer
     • Description: Number of quotes to send to the reranker.
     • Default: 20
6. File Parsing and Exclusion
   
   • elisa-ignore-patterns-files:
     • Type: List of strings
     • Description: List of file name patterns (e.g., .gitignore) used to ignore files during parsing.
     • Default: (".gitignore" ".ignore" ".rgignore")
   • elisa-ignore-invisible-files:
     • Type: Boolean
     • Description: Toggles whether invisible files and directories should be ignored during parsing.
     • Default: t (true)
   • elisa-tika-url:
     • Type: String
     • Description: Apache tika url for file parsing.
     • Default: "http://localhost:9998/"
   • elisa-complex-file-extraction-function:
     • Type: Function
     • Description: Function to get buffer with complex file (like pdf, odt etc.) content.
     • Default: #'elisa-parse-with-tika-buffer
   • elisa-supported-complex-document-extensions:
     • Type: List of strings
     • Description: Supported complex document file extensions.
     • Default: '("doc" "dot" "ppt" "xls" "rtf" "docx" "pptx" "xlsx" "xlsm" "pdf" "epub" "msg" "odt" "odp" "ods" "odg" "docm")
7. ELISA Chat Collections
   
   • elisa-enabled-collections:
     • Type: List of strings
     • Description: Specifies which collections are enabled for chat interactions.
     • Default: ("builtin manuals" "external manuals")