You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-20Lines changed: 29 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,18 +27,17 @@
27
27
28
28
## Prerequisites 🔗
29
29
30
-
> [!WARNING]
30
+
> [!IMPORTANT]
31
31
> To use these functions, ensure the following requirements are met:
32
-
33
-
1.**An Active Open WebUI Instance**: You must have [Open WebUI](https://github.com/open-webui/open-webui) installed and running.
34
-
35
-
2.**Required AI Services (if applicable)**: Some pipelines require external AI services, such as [Azure AI](https://ai.azure.com/).
36
-
37
-
3.**Admin Access**: To install functions in Open WebUI, you must have administrator privileges.
32
+
>
33
+
> 1.**An Active Open WebUI Instance**: You must have [Open WebUI](https://github.com/open-webui/open-webui) installed and running.
34
+
> 2.**Required AI Services (if applicable)**: Some pipelines require external AI services, such as [Azure AI](https://ai.azure.com/).
35
+
> 3.**Admin Access**: To install functions in Open WebUI, you must have administrator privileges.
38
36
39
37
## Installation 🚀
40
38
41
-
To install and configure functions in Open WebUI, follow these steps:
39
+
> [!TIP]
40
+
> Follow these steps to install and configure functions in Open WebUI:
42
41
43
42
1.**Ensure Admin Access**:
44
43
@@ -66,6 +65,9 @@ To install and configure functions in Open WebUI, follow these steps:
66
65
67
66
## Security Features 🛡️
68
67
68
+
> [!WARNING]
69
+
> **API Key Security**: Always use encryption for sensitive information like API keys!
70
+
69
71
### API Key Encryption
70
72
71
73
The functions include a built-in encryption mechanism for sensitive information:
@@ -75,21 +77,18 @@ The functions include a built-in encryption mechanism for sensitive information:
75
77
-**Transparent Usage**: The encryption/decryption happens automatically when values are accessed.
76
78
-**No Configuration Required**: Works out-of-the-box when [WEBUI_SECRET_KEY](https://docs.openwebui.com/getting-started/env-configuration/#webui_secret_key) is set.
77
79
78
-
**To enable encryption:**
79
-
80
-
> [!CAUTION]
81
-
> **WEBUI_SECRET_KEY is required for encryption to work!**
80
+
> [!IMPORTANT]
81
+
> **To enable encryption**, set the `WEBUI_SECRET_KEY` environment variable:
82
82
>
83
83
> ```bash
84
84
># Set this in your Open WebUI environment or .env file
85
85
> WEBUI_SECRET_KEY="your-secure-random-string"
86
86
>```
87
-
>
88
-
> Without this key, API keys and sensitive data will **not** be encrypted.
89
87
90
88
## Pipelines 🧩
91
89
92
-
Pipelines are processing functions that extend Open WebUI with **custom AI models**, **external integrations**, and **data manipulation logic**.
90
+
> [!NOTE]
91
+
> Pipelines are processing functions that extend Open WebUI with **custom AI models**, **external integrations**, and **data manipulation logic**.
93
92
94
93
### **1. [Azure AI Foundry Pipeline](./pipelines/azure/azure_ai_foundry.py)**
95
94
@@ -101,6 +100,8 @@ Pipelines are processing functions that extend Open WebUI with **custom AI model
101
100
- Enables interaction with **Azure OpenAI** and other **Azure AI** models.
102
101
- Supports Azure Search integration for enhanced document retrieval.
103
102
- Supports multiple Azure AI models selection via the `AZURE_AI_MODEL` environment variable (e.g. `gpt-4o;gpt-4o-mini`).
103
+
- Customizable pipeline display with configurable prefix via `AZURE_AI_PIPELINE_PREFIX`.
104
+
- Azure AI Search / RAG integration with enhanced collapsible citation display (Azure OpenAI only).
104
105
- Filters valid parameters to ensure clean requests.
105
106
- Handles both streaming and non-streaming responses.
106
107
- Provides configurable error handling and timeouts.
@@ -148,14 +149,19 @@ Pipelines are processing functions that extend Open WebUI with **custom AI model
148
149
- **Configurable Parameters**: Environment variables for image optimization (quality, max dimensions, format conversion).
149
150
- Grounding with Google search with [google_search_tool.py filter](./filters/google_search_tool.py)
150
151
- Native tool calling support
152
+
- Configurable API version support
151
153
152
154
🔗 [Google Gemini Pipeline in Open WebUI](https://openwebui.com/f/owndev/google_gemini)
153
155
154
156
🔗 [Learn More About Google Gemini](https://ai.google.dev/gemini-api/docs?hl=de)
155
157
158
+
> [!NOTE]
159
+
>**For LiteLLM Users**: To use Google Gemini models through LiteLLM, configure LiteLLM directly in Open WebUI's Admin Panel → Settings → Connections → OpenAI section instead of using this pipeline. For more information about LiteLLM, visit the [official LiteLLM GitHub repository](https://github.com/BerriAI/litellm).
160
+
156
161
## Filters 🔍
157
162
158
-
Filters allow for**preprocessing and postprocessing** of data within Open WebUI.
163
+
> [!NOTE]
164
+
> Filters allow for **preprocessing and postprocessing** of data within Open WebUI.
@@ -194,16 +200,19 @@ Look here for [Google Gemini Integration](./docs/google-gemini-integration.md).
194
200
195
201
## Contribute 💪
196
202
197
-
We accept different types of contributions, including some that don't require you to write a single line of code.
198
-
For detailed instructions on how to get started with our project, see [about contributing to Open-WebUI-Functions](https://own.dev/github-owndev-open-webui-functions-contributing).
203
+
> [!TIP]
204
+
> We welcome contributions of all kinds! You don't need to write code to contribute.
205
+
>
206
+
> For detailed instructions on how to get started with our project, see [about contributing to Open-WebUI-Functions](./.github/CONTRIBUTING.md).
199
207
200
208
## License 📜
201
209
202
210
This project is licensed under the [Apache License 2.0](./LICENSE) - see the [LICENSE](./LICENSE) file for details. 📄
203
211
204
212
## Support 💬
205
213
206
-
If you have any questions, suggestions, or need assistance, please open an [issue](../../issues/new/choose) to connect with us! 🤝
214
+
> [!NOTE]
215
+
> If you have any questions, suggestions, or need assistance, please open an [issue](../../issues/new/choose) to connect with us! 🤝
207
216
208
217
## Star History 💫
209
218
@@ -217,4 +226,4 @@ If you have any questions, suggestions, or need assistance, please open an [issu
217
226
218
227
---
219
228
220
-
Created by [owndev](https://own.dev/github) - Let's make Open WebUI even more amazing together! 💪
229
+
Created by [owndev](https://github.com/owndev) - Let's make Open WebUI even more amazing together! 💪
Copy file name to clipboardExpand all lines: docs/google-gemini-integration.md
+24-4Lines changed: 24 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
This integration enables **Open WebUI** to interact with **Google Gemini** models via the official Google Generative AI API (using API Keys) or through Google Cloud Vertex AI (leveraging Google Cloud's infrastructure and authentication). It provides a robust and customizable pipeline to access text and multimodal generation capabilities from Google’s latest AI models.
4
4
5
-
🔗 [Learn More About Google AI](https://own.dev/ai-google-dev)
5
+
🔗 [Learn More About Google AI](https://ai.google.dev/)
@@ -52,7 +52,10 @@ This integration enables **Open WebUI** to interact with **Google Gemini** model
52
52
-**Grounding with Google search**
53
53
Improve the accuracy and recency of Gemini responses with Google search grounding.
54
54
55
-
-**Native tool calling support**
55
+
-**Ability to forward User Headers and change gemini base url**
56
+
Forward user information headers (like Name, Id, Email and Role) to Google API or LiteLLM for better context and analytics. Also, change the base URL for the Google Generative AI API if needed.
57
+
58
+
-**Native tool calling support**
56
59
Leverage Google genai native function calling to orchestrate the use of tools
0 commit comments