From 6b99c217100ca7b58d3bc83db2b7a1d543078a2c Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 8 Aug 2025 07:52:50 -0400 Subject: [PATCH] Docs updates --- docs/configuration.md | 2 +- docs/usage.md | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 46848b5f0..b0dded52a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1836,7 +1836,7 @@ current backend. If not supplied, defaults to "gpt-3.5-turbo" for OpenAI and "ll #### [`PAPERLESS_LLM_INDEX_TASK_CRON=`](#PAPERLESS_LLM_INDEX_TASK_CRON) {#PAPERLESS_LLM_INDEX_TASK_CRON} -: Configures the schedule to update the AI embeddings for all documents. Only performed if +: Configures the schedule to update the AI embeddings of text content and metadata for all documents. Only performed if AI is enabled and the LLM embedding backend is set. Defaults to `10 2 * * *`, once per day. diff --git a/docs/usage.md b/docs/usage.md index c45692a38..2b6518c60 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -266,7 +266,7 @@ for details. ## Document Suggestions -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. +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 (non-LLM) 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 @@ -276,14 +276,16 @@ Paperless-ngx includes several features that use AI to enhance the document mana Remember that Paperless-ngx will send document content to the AI provider you have configured, so consider the privacy implications of using these features, especially if using a remote model (e.g. OpenAI), instead of the default local model. -### Document Chat - -Paperless-ngx can use an AI LLM model to answer questions about a document or across multiple documents. Again, this feature works best when RAG is enabled. The chat feature is available in the upper app toolbar and will switch between chatting across multiple documents or a single document based on the current view. +The AI features work by creating an embedding of the text content and metadata of documents, which is then used for various tasks such as similarity search and question answering. This uses the FAISS vector store. ### 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 classifier-based suggestion system. Currently, both remote (via the OpenAI API) and local (via Ollama) models are supported, see [configuration](configuration.md#ai) for details. +### Document Chat + +Paperless-ngx can use an AI LLM model to answer questions about a document or across multiple documents. Again, this feature works best when RAG is enabled. The chat feature is available in the upper app toolbar and will switch between chatting across multiple documents or a single document based on the current view. + ## Sharing documents from Paperless-ngx Paperless-ngx supports sharing documents with other users by assigning them [permissions](#object-permissions)