Update Readme

Author: owndev

README.md

@@ -27,7 +27,8 @@
 
 ## Prerequisites 🔗
 
-To use these functions, ensure the following:
+> [!WARNING]
+> To use these functions, ensure the following requirements are met:
 
 1. **An Active Open WebUI Instance**: You must have [Open WebUI](https://github.com/open-webui/open-webui) installed and running.
 
@@ -40,7 +41,9 @@ To use these functions, ensure the following:
 To install and configure functions in Open WebUI, follow these steps:
 
 1. **Ensure Admin Access**:
-   - You must be an admin in Open WebUI to install functions.
+
+   > [!NOTE]
+   > You must be an admin in Open WebUI to install functions.
 
 2. **Access Admin Settings**:
    - Navigate to the **Admin Settings** section in Open WebUI.
@@ -54,7 +57,9 @@ To install and configure functions in Open WebUI, follow these steps:
 
 5. **Set Environment Variables (if required)**:
    - Some functions require API keys or specific configurations via environment variables.
-   - Set [WEBUI_SECRET_KEY](https://docs.openwebui.com/getting-started/env-configuration/#webui_secret_key) for secure encryption of sensitive API keys.
+
+   > [!IMPORTANT]
+   > Set [WEBUI_SECRET_KEY](https://docs.openwebui.com/getting-started/env-configuration/#webui_secret_key) for secure encryption of sensitive API keys. This is **required** for the encryption features to work properly.
 
 6. **Save and Activate**:
    - Save the function, and it will be available for use within Open WebUI.
@@ -72,18 +77,29 @@ The functions include a built-in encryption mechanism for sensitive information:
 
 **To enable encryption:**
 
-```bash
-# Set this in your Open WebUI environment or .env file
-WEBUI_SECRET_KEY="your-secure-random-string"
-```
+> [!CAUTION]
+> **WEBUI_SECRET_KEY is required for encryption to work!**
+>
+> ```bash
+> # Set this in your Open WebUI environment or .env file
+> WEBUI_SECRET_KEY="your-secure-random-string"
+> ```
+>
+> Without this key, API keys and sensitive data will **not** be encrypted.
 
 ## Pipelines 🧩
 
 Pipelines are processing functions that extend Open WebUI with **custom AI models**, **external integrations**, and **data manipulation logic**.
 
 ### **1. [Azure AI Foundry Pipeline](./pipelines/azure/azure_ai_foundry.py)**
 
+> [!TIP]
+> **Azure OpenAI Integration Made Easy**
+>
+> This pipeline provides seamless integration with Azure OpenAI and other Azure AI models with advanced features like Azure Search integration and multiple model support.
+
 - Enables interaction with **Azure OpenAI** and other **Azure AI** models.
+- Supports Azure Search integration for enhanced document retrieval.
 - Supports multiple Azure AI models selection via the `AZURE_AI_MODEL` environment variable (e.g. `gpt-4o;gpt-4o-mini`).
 - Filters valid parameters to ensure clean requests.
 - Handles both streaming and non-streaming responses.
@@ -98,6 +114,7 @@ Pipelines are processing functions that extend Open WebUI with **custom AI model
 ### **2. [N8N Pipeline](./pipelines/n8n/n8n.py)**
 
 - Integrates **Open WebUI** with **N8N**, an automation and workflow platform.
+- Streaming support for real-time data processing.
 - Sends messages from Open WebUI to an **N8N webhook**.
 - Supports real-time message processing with dynamic field handling.
 - Enables automation of AI-generated responses within an **N8N workflow**.
@@ -142,6 +159,11 @@ Filters allow for **preprocessing and postprocessing** of data within Open WebUI
 
 ### **1. [Time Token Tracker](./filters/time_token_tracker.py)**
 
+> [!NOTE]
+> **Performance Monitoring for AI Interactions**
+>
+> Track response times, token usage, and optionally send analytics to Azure Log Analytics for comprehensive monitoring.
+
 - Measures **response time** and **token usage** for AI interactions.
 - Supports tracking of **total token usage** and **per-message token counts**.
 - Can calculate token usage for all messages or only a subset.