diff --git a/docs/features/plugin/migration/index.mdx b/docs/features/plugin/migration/index.mdx index 34fb457..eca9784 100644 --- a/docs/features/plugin/migration/index.mdx +++ b/docs/features/plugin/migration/index.mdx @@ -1,9 +1,9 @@ --- sidebar_position: 3 -title: "๐Ÿš€ Migrating Functions: Open WebUI 0.4 to 0.5" +title: "๐Ÿšš Migrating Functions: Open WebUI 0.4 to 0.5" --- -# ๐Ÿš€ Migration Guide: Open WebUI 0.4 to 0.5 +# ๐Ÿšš Migration Guide: Open WebUI 0.4 to 0.5 Welcome to the Open WebUI 0.5 migration guide! If you're working on existing projects or building new ones, this guide will walk you through the key changes from **version 0.4 to 0.5** and provide an easy-to-follow roadmap for upgrading your Functions. Let's make this transition as smooth as possible! ๐Ÿ˜Š @@ -58,6 +58,25 @@ Quick changes for import paths: | `open_webui.apps.retrieval` | `open_webui.routers.retrieval` | | `open_webui.apps.webui` | `open_webui.main` | + +### ๐Ÿ“œ An Important Example + +To clarify the special case of the main app (`webui`), hereโ€™s a simple rule of thumb: + +- **Was in `webui`?** Itโ€™s now in the projectโ€™s root or `open_webui.main`. +- For example: + - **Before (0.4):** + ```python + from open_webui.apps.webui.models import SomeModel + ``` + - **After (0.5):** + ```python + from open_webui.models import SomeModel + ``` + +In general, **just replace `open_webui.apps` with `open_webui.routers`โ€”except for `webui`, which is now `open_webui.main`!** + + --- ### ๐Ÿ‘ฉโ€๐Ÿ’ป 2. Updating Import Statements