From ad0fa550d648baa3e76f49da4823f67b7fe9ac41 Mon Sep 17 00:00:00 2001 From: Andrew Tait Gehrhardt Date: Thu, 1 Aug 2024 14:00:04 -0400 Subject: [PATCH 1/3] Added Tools documentation first pass. --- docs/tutorial/tools.md | 59 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 51 insertions(+), 8 deletions(-) diff --git a/docs/tutorial/tools.md b/docs/tutorial/tools.md index 6d67557..cf490a7 100644 --- a/docs/tutorial/tools.md +++ b/docs/tutorial/tools.md @@ -1,14 +1,57 @@ --- -sidebar_position: 1 +sidebar_position: 5 title: "Tools" --- -# Tools +## What are Tools? +Tools are scripts, written in python, 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. -## WIP 🚧 +## How can I use Tools? +
+Click to find out -

- - Under Construction - -

+Tools can be used, [once installed](#how-to-install-tools), by assigning them to any LLM that supports function calling and then enabling that tool. To assign a tool to a model, you simply need to navigate to Workspace => Models. Here you can select the model for which you’d like to enable any tools. + +Once you click the pencil icon to edit the model settings, scroll down to the tools section and check any tools you wish to enable. Once done you must click save. + +Now that tools are enabled, you can click the “+” icon when chatting with an LLM to enable various tools. Please keep in mind that enabling a tool does not force it to be used. It simply means the LLM will be provided the option to call this tool. + +Lastly, we do provide a filter function on the community site that allows LLMs to autoselect tools without you needing to enable them in the “+” icon menu: https://openwebui.com/f/hub/autotool_filter/ + +Please note, that when using the AutoTool Filter, you will still need to take the steps above to enable the tools per model. +
+ +## How to install Tools +
+Installation Instructions + +Screenshots/Video of getting tool from community, importing or copying, activating, enabling for models, etc + +The Tools import process is quite simple. You will have two options: + +### Download and import manually +Navigate to the community site: https://openwebui.com/tools/ +1) Click on the Tool you wish to import +2) Click the blue “Get” button in the top right-hand corner of the page +3) Click “Download as JSON export” +4) You can now upload the Tool into OpenWebUI by navigating to Workspace => Tools and clicking “Import Tools” + +### Import via your OpenWebUI URL +1) Navigate to the community site: https://openwebui.com/tools/ +2) Click on the Tool you wish to import +3) Click the blue “Get” button in the top right-hand corner of the page +4) Enter the IP address of your OpenWebUI instance and click “Import to WebUI” which will automatically open your instance and allow you to import the tool. + +Note: You can install your own Tools and other Tools not tracked on the community site using the manual import method. Please do not import tools you do not understand or are not from a trustworthy source. Running unknown code is ALWAYS a risk. +
+ +## What sorts of things can Tools do? +
+Use Cases and Examples + +Tools enable diverse use cases for interactive conversations by providing a wide range of functionality such as: + +- [**Web Search**](https://openwebui.com/t/constliakos/web_search/): Perform live web searches to fetch real-time information. +- [**Image Generation**](https://openwebui.com/t/justinrahb/image_gen/): Generate images based on the user prompt +- [**External Voice Synthesis**](https://openwebui.com/t/justinrahb/elevenlabs_tts/): Make API requests within the chat to integrate external voice synthesis service ElevenLabs and generate audio based on the LLM output. +
\ No newline at end of file From 94bb4040b93de1c31207c3b0e313e175917bcf09 Mon Sep 17 00:00:00 2001 From: Andrew Tait Gehrhardt Date: Thu, 1 Aug 2024 14:07:30 -0400 Subject: [PATCH 2/3] Removed placeholder for video --- docs/tutorial/tools.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/tutorial/tools.md b/docs/tutorial/tools.md index cf490a7..fd1a7bf 100644 --- a/docs/tutorial/tools.md +++ b/docs/tutorial/tools.md @@ -25,8 +25,6 @@ Please note, that when using the AutoTool Filter, you will still need to take th
Installation Instructions -Screenshots/Video of getting tool from community, importing or copying, activating, enabling for models, etc - The Tools import process is quite simple. You will have two options: ### Download and import manually From 031b062a89618009f449e118f2310c68f07506a7 Mon Sep 17 00:00:00 2001 From: Andrew Tait Gehrhardt Date: Thu, 1 Aug 2024 14:16:04 -0400 Subject: [PATCH 3/3] Removed expandable sections per feedback --- docs/tutorial/tools.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/docs/tutorial/tools.md b/docs/tutorial/tools.md index fd1a7bf..72f02c2 100644 --- a/docs/tutorial/tools.md +++ b/docs/tutorial/tools.md @@ -7,9 +7,6 @@ title: "Tools" Tools are scripts, written in python, 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. ## How can I use Tools? -
-Click to find out - Tools can be used, [once installed](#how-to-install-tools), by assigning them to any LLM that supports function calling and then enabling that tool. To assign a tool to a model, you simply need to navigate to Workspace => Models. Here you can select the model for which you’d like to enable any tools. Once you click the pencil icon to edit the model settings, scroll down to the tools section and check any tools you wish to enable. Once done you must click save. @@ -19,12 +16,8 @@ Now that tools are enabled, you can click the “+” icon when chatting with an Lastly, we do provide a filter function on the community site that allows LLMs to autoselect tools without you needing to enable them in the “+” icon menu: https://openwebui.com/f/hub/autotool_filter/ Please note, that when using the AutoTool Filter, you will still need to take the steps above to enable the tools per model. -
## How to install Tools -
-Installation Instructions - The Tools import process is quite simple. You will have two options: ### Download and import manually @@ -41,15 +34,10 @@ Navigate to the community site: https://openwebui.com/tools/ 4) Enter the IP address of your OpenWebUI instance and click “Import to WebUI” which will automatically open your instance and allow you to import the tool. Note: You can install your own Tools and other Tools not tracked on the community site using the manual import method. Please do not import tools you do not understand or are not from a trustworthy source. Running unknown code is ALWAYS a risk. -
## What sorts of things can Tools do? -
-Use Cases and Examples - Tools enable diverse use cases for interactive conversations by providing a wide range of functionality such as: - [**Web Search**](https://openwebui.com/t/constliakos/web_search/): Perform live web searches to fetch real-time information. - [**Image Generation**](https://openwebui.com/t/justinrahb/image_gen/): Generate images based on the user prompt -- [**External Voice Synthesis**](https://openwebui.com/t/justinrahb/elevenlabs_tts/): Make API requests within the chat to integrate external voice synthesis service ElevenLabs and generate audio based on the LLM output. -
\ No newline at end of file +- [**External Voice Synthesis**](https://openwebui.com/t/justinrahb/elevenlabs_tts/): Make API requests within the chat to integrate external voice synthesis service ElevenLabs and generate audio based on the LLM output. \ No newline at end of file