]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Just some docs
authorshamoon <4887959+shamoon@users.noreply.github.com>
Fri, 25 Apr 2025 07:29:23 +0000 (00:29 -0700)
committershamoon <4887959+shamoon@users.noreply.github.com>
Wed, 2 Jul 2025 18:01:56 +0000 (11:01 -0700)
[ci skip]

docs/configuration.md
docs/usage.md

index 944753f5ebee9dee9b5dfb3238bcdb83e8b76865..f0fad94cb3122177f57ba736f1190d26c099833e 100644 (file)
@@ -1769,6 +1769,18 @@ suggestions. This setting is required to be set to true in order to use the AI f
 
     Defaults to false.
 
+#### [`PAPERLESS_LLM_EMBEDDING_BACKEND=<str>`](#PAPERLESS_LLM_EMBEDDING_BACKEND) {#PAPERLESS_LLM_EMBEDDING_BACKEND}
+
+: The embedding backend to use for RAG. This can be either "openai" or "local".
+
+    Defaults to "local".
+
+#### [`PAPERLESS_LLM_EMBEDDING_MODEL=<str>`](#PAPERLESS_LLM_EMBEDDING_MODEL) {#PAPERLESS_LLM_EMBEDDING_MODEL}
+
+: The model to use for the embedding backend for RAG. This can be either "text-embedding-3-small" or any of the models supported by the current embedding backend.
+
+    Defaults to None.
+
 #### [`PAPERLESS_AI_BACKEND=<str>`](#PAPERLESS_AI_BACKEND) {#PAPERLESS_AI_BACKEND}
 
 : The AI backend to use. This can be either "openai" or "ollama". If set to "ollama", the AI
index fef9b1f2be08d766a4a83185a2b727971f6719ec..68a1b3ca6c1f502a16183e1ea1862d371a226986 100644 (file)
@@ -265,6 +265,14 @@ for details.
 
 Paperless-ngx can suggest tags, correspondents, document types and storage paths for documents based on the content of the document. This is done using a machine learning model that is trained on the documents in your database. The suggestions are shown in the document detail page and can be accepted or rejected by the user.
 
+## AI Features
+
+Paperless-ngx includes several features that use AI to enhance the document management experience. These features are optional and can be enabled or disabled in the settings. If you are using the AI features, you may want to also enable the "LLM index" feature, which supports Retrieval-Augmented Generation (RAG) which significantly improves the quality of the AI features. The LLM index feature is not enabled by default and requires additional configuration.
+
+### Document Chat
+
+Paperless-ngx can use an AI LLM model to answer questions about a document or across multiple documents. <<add more details here>>
+
 ### AI-Enhanced Suggestions
 
 If enabled, Paperless-ngx can use an AI LLM model to suggest document titles, dates, tags, correspondents and document types for documents. This feature will always be "opt-in" and does not disable the existing suggestion system. Currently, both remote (via the OpenAI API) and local (via Ollama) models are supported, see [configuration](configuration.md#ai) for details.