add sequence diagram to README for better overview of process
Some checks are pending
Rust / build (push) Waiting to run
Some checks are pending
Rust / build (push) Waiting to run
This commit is contained in:
parent
d1bbc73478
commit
ef1a0f380b
3 changed files with 12 additions and 1 deletions
|
|
@ -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
|
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
|
`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
|
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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
As of now the following llm workflows are availible:
|
As of now the following llm workflows are availible:
|
||||||
- `/fill/custom_fields`: For all supported custom fields datatypes extract value from document content
|
- `/fill/custom_fields`: For all supported custom fields datatypes extract value from document content
|
||||||
|
|
|
||||||
8
workflow_api_sequence.mmd
Normal file
8
workflow_api_sequence.mmd
Normal file
|
|
@ -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: <br/><br/><br/><br/> update doc with filled custom fields <br/> set `finished` tag
|
||||||
|
deactivate paperless-llm-workflows
|
||||||
|
|
||||||
1
workflow_api_sequence.svg
Normal file
1
workflow_api_sequence.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 21 KiB |
Loading…
Add table
Add a link
Reference in a new issue