OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 03:08:56 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #168 from Earnest-Williams/patch-1

Browse Source 
Update tools.md
This commit is contained in:
Justin Hayes 2024-08-02 07:34:11 -04:00 committed by GitHub
commit 8a42719fc8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/tutorial/tools.md
View File

@ -4,18 +4,18 @@ title: "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.
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.
## How can I use Tools?
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 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.
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.
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.
Now that Tools are enabled for the model, you can click the “+” icon when chatting with an LLM to use various Tools. Please keep in mind that enabling a Tool does not force it to be used. It 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/
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.
Please note: when using the AutoTool Filter, you will still need to take the steps above to enable the Tools per model.
## How to install Tools
The Tools import process is quite simple. You will have two options:
@ -31,13 +31,13 @@ Navigate to the community site: https://openwebui.com/tools/
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.
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.
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?
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.
- [**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.