Skip to content

GitHub Copilot SDK Files Filter (v0.1.2)

This is a dedicated companion filter plugin designed specifically for the GitHub Copilot SDK Pipe.

Its core mission is to protect user-uploaded files from being "pre-processed" by the OpenWebUI core system, ensuring that the Copilot Agent receives the raw files for autonomous analysis.

đŸŽ¯ Why is this needed?

In OpenWebUI's default workflow, when you upload a file (e.g., PDF, Excel, Python script), OpenWebUI automatically initiates a RAG (Retrieval-Augmented Generation) process: parsing the file, vectorizing it, extracting text, and injecting it into the prompt.

While useful for standard models, this is often disruptive for a Copilot SDK Agent:

  1. Agent Needs Raw Files: The Agent may need to run Python code to read an Excel file or analyze a full directory structure, not chopped-up text fragments.
  2. Context Pollution: Large amounts of text injected by RAG consume tokens and can confuse the Agent about "where the file is."
  3. Conflicts: If you have other multimodal plugins installed (like Gemini Filter), they might compete for file processing rights.

This plugin acts as a "bodyguard" to solve these issues.

🚀 How it Works

When you select a Copilot model (name containing copilot_sdk) in OpenWebUI and send a file:

  1. Intercept: This plugin runs with high priority (Priority 0), before RAG and other filters.
  2. Relocate: Detecting a Copilot model, it moves the files list from the request to a secure custom field copilot_files.
  3. Hide: It clears the original files field.
  4. Status Update: It emits a status message "Managed X files for Copilot (RAG Bypassed)" to the UI.
  5. Pass: The OpenWebUI core sees an empty files list and does not trigger RAG.
  6. Deliver: The subsequent Copilot SDK Pipe plugin checks copilot_files, retrieves file information, and automatically copies them into the Agent's isolated workspace.

đŸ“Ļ Installation & Configuration

1. Installation

Import this plugin on the OpenWebUI Functions page.

2. Enable

Ensure this Filter is enabled globally or in chat settings.

3. Configuration (Valves)

Default settings work for most users unless you have specific needs:

Parameter Description Default
priority Execution priority of the filter. Must be lower than OpenWebUI RAG priority. 0
target_model_keyword Keyword to identify Copilot models. Only models containing this keyword will trigger file interception. copilot_sdk

⚠ī¸ Important Notes

  • Must be used with Copilot SDK Pipe: If you install this plugin without the main Pipe plugin, uploaded files will simply "disappear" (as no subsequent plugin will look for them in copilot_files).
  • Gemini Filter Compatibility: This plugin is fully compatible with the Gemini Multimodal Filter. As long as the priority is set correctly (This Plugin < Gemini Plugin), they can coexist without interference.
  • Physical File Path: Ensure the OPENWEBUI_UPLOAD_PATH is correctly set in the Pipe plugin Valves for the actual file transport to work.