docs: add external document extraction documentation - #1350
Open
memologoped wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds missing documentation for the External document extraction engine.
While the
externalextraction method is already available in the Open WebUI admin settings, it currently has no dedicated documentation page (unlike Apache Tika, Docling, and Mistral OCR). This gap forces users to dig through GitHub issues and source code to figure out how to integrate their own extraction services.The new page (
docs/features/chat-conversations/rag/document-extraction/external.md) covers:PUTto{URL}/process)Content-Type,Authorization,X-Filename)page_content+metadata)This documentation was written by inspecting the
ExternalDocumentLoadersource code in the main repository to ensure accuracy against the actual implementation.Related issue or discussion
Checklist
Notes for reviewers
sidebar_position: 5was chosen to place the page after Docling (3) and Mistral OCR (4).@app.api_route("/process", methods=["PUT", "POST"])to be resilient to future method changes, though the current loader only usesPUT.backend/open_webui/retrieval/loaders/external_document.pyin the main repo.