docs icon indicating copy to clipboard operation
docs copied to clipboard

docs: Additional (Optional) configuration for external document loader

Open TheDropZone opened this issue 2 months ago • 1 comments

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.

TheDropZone avatar Nov 12 '25 15:11 TheDropZone

ℹ️ INFO

Please ensure you're targeting the correct branch:

  • dev branch: For changes related to upcoming Open WebUI releases (new features, new environment variables, anything dependent on unreleased versions)
  • main branch: For content that can go live immediately (fixes, tutorials, documentation not dependent on unreleased features)

Please adjust your PR target branch accordingly if needed.

pr-validator-bot avatar Nov 12 '25 15:11 pr-validator-bot