Skip to content

docs: add file metadata fields documentation for knowledge base#1141

Open
IllimarR wants to merge 1 commit intoopen-webui:devfrom
IllimarR:feat/file-metadata-fields
Open

docs: add file metadata fields documentation for knowledge base#1141
IllimarR wants to merge 1 commit intoopen-webui:devfrom
IllimarR:feat/file-metadata-fields

Conversation

@IllimarR
Copy link
Copy Markdown

@IllimarR IllimarR commented Mar 16, 2026

Summary

Documentation for the new config-driven file metadata support in knowledge bases, accompanying the feature PR in the main repository.

  • New page: docs/features/ai-knowledge/file-metadata-fields.md
  • Updated: docs/features/ai-knowledge/knowledge.md with a section linking to the new page

What's documented

  • FILE_METADATA_FIELDS environment variable and admin API configuration
  • Field definition properties (key, type, embed, context, filter)
  • API endpoints: get/update/batch-update file metadata, field discovery
  • How metadata flows through the RAG pipeline (vector DB, BM25, LLM source tags)
  • Setting metadata during file upload
  • Adding custom fields at runtime

Related

Add documentation for the new config-driven file metadata support
in knowledge bases. Includes configuration options (env var, Docker,
admin API), field definition properties (embed, context, filter flags),
API endpoints for metadata CRUD, and explanation of how metadata
flows through the RAG pipeline.
@pr-validator-bot
Copy link
Copy Markdown

ℹ️ Documentation PR Guidelines

👋 Welcome! This is an automated message posted on all new documentation PRs to help guide our contributors. Just because this comment appeared doesn't mean you have done anything wrong!

Please ensure you're using the correct branches:

Target branch (where you're merging TO):

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

Source branch (where you're merging FROM):

  • If targeting dev, create your branch from your fork's dev branch
  • If targeting main, create your branch from your fork's main branch
  • ⚠️ Mismatched branches can and will result in unwanted file changes being included in your PR!

If your docs PR depends on a pending PR in open-webui/open-webui:

  • Convert this PR to DRAFT mode!
  • Link to the related main repo PR in your description for clarity
  • We'll review both together once the PR on the main repo is merged

Please adjust your PR target branch, source branch, and/or draft status accordingly if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants