From a4e1fa502e01e7dc993d65f4c76e720683bf6fe8 Mon Sep 17 00:00:00 2001 From: "Timothy J. Baek" Date: Wed, 25 Sep 2024 01:56:52 +0200 Subject: [PATCH] refac --- docs/pipelines/functions.md | 17 ----------------- docs/pipelines/index.mdx | 7 ++++--- docs/pipelines/tools.md | 9 --------- .../plugin/functions}/actions.md | 0 .../functions/index.mdx} | 2 +- docs/tutorial/plugin/index.mdx | 4 ++++ .../{tools.md => plugin/tools/index.mdx} | 6 +++++- 7 files changed, 14 insertions(+), 31 deletions(-) delete mode 100644 docs/pipelines/functions.md delete mode 100644 docs/pipelines/tools.md rename docs/{pipelines => tutorial/plugin/functions}/actions.md (100%) rename docs/tutorial/{functions.md => plugin/functions/index.mdx} (99%) create mode 100644 docs/tutorial/plugin/index.mdx rename docs/tutorial/{tools.md => plugin/tools/index.mdx} (96%) diff --git a/docs/pipelines/functions.md b/docs/pipelines/functions.md deleted file mode 100644 index 8afa2f6..0000000 --- a/docs/pipelines/functions.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -sidebar_position: 4 -title: "Functions" ---- - -# Functions -Functions enable you to utilize filters (middleware) and pipe (model) functions directly within the WebUI. While largely compatible with Pipelines, these native functions can be executed easily within Open WebUI. Example use cases for filter functions include usage monitoring, real-time translation, moderation, and automemory. For pipe functions, the scope ranges from Cohere and Anthropic integration directly within Open WebUI, enabling "Valves" for per-user OpenAI API key usage, and much more. - -Many Functions are available to use on the [Community Website](https://openwebui.com/functions) and can easily be imported into your Open WebUI instance. - -

- - Community Functions - -

- -While many Pipes and Filters that run on a Pipelines server can be executed as Functions, the main limitation is that Functions are unable to install new Python dependencies that are not already packaged into Open WebUI. As a result, Pipelines are more extensible than Functions, while Functions have the added benefit of executing directly on the Open WebUI server without needing a separate Pipelines server for execution. \ No newline at end of file diff --git a/docs/pipelines/index.mdx b/docs/pipelines/index.mdx index b2772c2..300e798 100644 --- a/docs/pipelines/index.mdx +++ b/docs/pipelines/index.mdx @@ -1,6 +1,7 @@ -import { TopBanners } from "@site/src/components/TopBanners"; - - +--- +sidebar_position: 1 +title: "⚡ Pipelines" +---

diff --git a/docs/pipelines/tools.md b/docs/pipelines/tools.md deleted file mode 100644 index 77b3a63..0000000 --- a/docs/pipelines/tools.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 5 -title: "Tools" ---- - -# Tools -Tools enable many use cases for chats, including web search, web scraping, and API interactions within the chat. - -Many Tools are available to use on the [Community Website](https://openwebui.com/tools) and can easily be imported into your Open WebUI instance. \ No newline at end of file diff --git a/docs/pipelines/actions.md b/docs/tutorial/plugin/functions/actions.md similarity index 100% rename from docs/pipelines/actions.md rename to docs/tutorial/plugin/functions/actions.md diff --git a/docs/tutorial/functions.md b/docs/tutorial/plugin/functions/index.mdx similarity index 99% rename from docs/tutorial/functions.md rename to docs/tutorial/plugin/functions/index.mdx index fd4ae35..5a69e0f 100644 --- a/docs/tutorial/functions.md +++ b/docs/tutorial/plugin/functions/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 1 title: "Functions" --- diff --git a/docs/tutorial/plugin/index.mdx b/docs/tutorial/plugin/index.mdx new file mode 100644 index 0000000..ee40294 --- /dev/null +++ b/docs/tutorial/plugin/index.mdx @@ -0,0 +1,4 @@ +--- +sidebar_position: 0 +title: "Tools & Fuctions" +--- \ No newline at end of file diff --git a/docs/tutorial/tools.md b/docs/tutorial/plugin/tools/index.mdx similarity index 96% rename from docs/tutorial/tools.md rename to docs/tutorial/plugin/tools/index.mdx index b4d2f2d..340da23 100644 --- a/docs/tutorial/tools.md +++ b/docs/tutorial/plugin/tools/index.mdx @@ -1,11 +1,15 @@ --- -sidebar_position: 5 +sidebar_position: 0 title: "Tools" --- ## What are Tools? Tools are python scripts that are provided to an LLM at the time of the request. Tools allow LLMs to perform actions and receive additional context as a result. Generally speaking, your LLM of choice will need to support function calling for tools to be reliably utilized. +Tools enable many use cases for chats, including web search, web scraping, and API interactions within the chat. + +Many Tools are available to use on the [Community Website](https://openwebui.com/tools) and can easily be imported into your Open WebUI instance. + ## How can I use Tools? [Once installed](#how-to-install-tools), Tools can be used by assigning them to any LLM that supports function calling and then enabling that Tool. To assign a Tool to a model, you need to navigate to Workspace => Models. Here you can select the model for which you’d like to enable any Tools.