[PR #812] docs: Additional (Optional) configuration for external document loader #830

Open
opened 2026-02-15 18:16:19 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/812
Author: @TheDropZone
Created: 11/12/2025
Status: 🔄 Open

Base: devHead: dev


📝 Commits (1)

  • 3e71a75 Adding External document loader configuration options

📊 Changes

1 file changed (+77 additions, -0 deletions)

View changed files

📝 docs/getting-started/env-configuration.mdx (+77 -0)

📄 Description

Based on feature MR: https://github.com/open-webui/open-webui/pull/19137

To make External Document Engine more powerful for a given generic document processing api, the external document loader can be enabled with default settings (ensuring backwards compatibility), or fully configured with the following settings

  • url + api key
  • http_method: HTTP method to use (PUT, POST, PATCH)
  • endpoint: API endpoint path
  • request_format: Format for sending the file (binary, form-data, json-base64)
and more advanced settings
  • file_field_name: Name of the file field in form-data or JSON
  • filename_field_name: Name of the filename field (optional)
  • params: Additional parameters to send with the request
  • query_params: Query parameters to append to URL
  • custom_headers: Custom headers to include in request
  • response_content_path: Dot notation path to content in response
  • response_metadata_path: Dot notation path to metadata in response
  • response_type: Type of response (object, array, text)

This optional configuration enables you to point open-webui at almost any document processing api out there, including custom ones. This enables quick and easy testing of open source document projects, or the ability to easily integrate your own custom api with more configuration.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/812 **Author:** [@TheDropZone](https://github.com/TheDropZone) **Created:** 11/12/2025 **Status:** 🔄 Open **Base:** `dev` ← **Head:** `dev` --- ### 📝 Commits (1) - [`3e71a75`](https://github.com/open-webui/docs/commit/3e71a75041ee66771e44705c0de46886ea362045) Adding External document loader configuration options ### 📊 Changes **1 file changed** (+77 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/getting-started/env-configuration.mdx` (+77 -0) </details> ### 📄 Description Based on feature MR: https://github.com/open-webui/open-webui/pull/19137 To make External Document Engine more powerful for a given generic document processing api, the external document loader can be enabled with default settings (ensuring backwards compatibility), or fully configured with the following settings - url + api key - http_method: HTTP method to use (PUT, POST, PATCH) - endpoint: API endpoint path - request_format: Format for sending the file (binary, form-data, json-base64) <details> <summary>and more advanced settings</summary> - file_field_name: Name of the file field in form-data or JSON - filename_field_name: Name of the filename field (optional) - params: Additional parameters to send with the request - query_params: Query parameters to append to URL - custom_headers: Custom headers to include in request - response_content_path: Dot notation path to content in response - response_metadata_path: Dot notation path to metadata in response - response_type: Type of response (object, array, text) </details> This optional configuration enables you to point open-webui at almost any document processing api out there, including custom ones. This enables quick and easy testing of open source document projects, or the ability to easily integrate your own custom api with more configuration. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-15 18:16:19 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: open-webui/docs#830