From ef1a0f380b7b447489c1e8a68b0d425394f68c60 Mon Sep 17 00:00:00 2001 From: ju6ge Date: Sat, 22 Nov 2025 15:12:51 +0100 Subject: [PATCH] add sequence diagram to README for better overview of process --- README.md | 4 +++- workflow_api_sequence.mmd | 8 ++++++++ workflow_api_sequence.svg | 1 + 3 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 workflow_api_sequence.mmd create mode 100644 workflow_api_sequence.svg diff --git a/README.md b/README.md index fb02513..14a921d 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,9 @@ To integrate a functionality into paperless you need add it as webhook trigger i When a webhook gets triggered the document will be added to the processing queue of `paperless-llm-workflows` with the corresponding action. The document will be given a `processing` tag to make paperless users aware that the document still has pending updates. Once all processing requests for a document have been completed the document will be updated with the results and is given a `finished` tag. If you wish to assign a specific tag on process completion there is an extra parameter too the webhook which you -can use to overwrite what tag will be assigned once the processing step has completed. +can use to overwrite what tag will be assigned once the processing step has completed. This process is shown in the following sequence diagram. + +![LLM Workflow Sequence](./workflow_api_sequence.svg) As of now the following llm workflows are availible: - `/fill/custom_fields`: For all supported custom fields datatypes extract value from document content diff --git a/workflow_api_sequence.mmd b/workflow_api_sequence.mmd new file mode 100644 index 0000000..5d30988 --- /dev/null +++ b/workflow_api_sequence.mmd @@ -0,0 +1,8 @@ +sequenceDiagram + paperless-ngx->>paperless-llm-workflows: /fill/custom_fields { doc_url: "link" } + activate paperless-llm-workflows + paperless-llm-workflows->>paperless-ngx: set `procssing` tag for document + + paperless-llm-workflows->>paperless-ngx:



update doc with filled custom fields
set `finished` tag + deactivate paperless-llm-workflows + diff --git a/workflow_api_sequence.svg b/workflow_api_sequence.svg new file mode 100644 index 0000000..21c85b9 --- /dev/null +++ b/workflow_api_sequence.svg @@ -0,0 +1 @@ +paperless-llm-workflowspaperless-ngxpaperless-llm-workflowspaperless-ngx/fill/custom_fields { doc_url: "link" }set `procssing` tag for document​​​​ update doc with filled custom fields set `finished` tag \ No newline at end of file