Open WebUI Tools: A Comprehensive Guide for Beginners and Advanced Users
325 segments
hello everyone this is Professor pattern
and in the next couple of videos we'll
be covering open web UI functions
pipelines tools and all of those things
in between we'll start off with this
video by covering tools now if you are
an advanced open web UI user the only
thing that you need to know is that a
tool is a python script that your large
language model can execute that's it you
can skip to the second part which is the
implementation step if you're a complete
beginner and had no idea what I just
said and stick around for the next part
so let's imagine a scenario where you
are a boss and you have an
assistant now if you ask your assistant
a question something like hey can you
grab me the transcript from this video
now your assistant is going to click on
this video and they'll see that okay
well this is actually a 10-minute video
by Professor patterns now I love
listening to Professor patterns but do I
have to actually manually type out every
single word from this video well that's
one way in which you could do this
another way is by simply creating a
python script the goal of the script is
to first go to the video then it's to
fetch the text from the video and then
print out the
transcript so the next time you ask this
question like hey can you grab the
transcript from this video your
assistant is going to be able to Simply
execute the script which will fetch the
video and then print out all of those
things from the transcript now this
script that your assist assistant has
created is what we in open web UI call a
tool so the goal of this tool which is
get transcript is to go fetch the video
grab the transcript and print out the
transcript similar to this tool we also
have a bunch of different tools like get
transcript get stock prices send out
automatic emails summarize meetings we
have a tool to convert image to text um
to create Jura tickets from meeting
notes all of these are examples of tools
and the goal here is that any single
time that you ask a question like hey
grab me the transcript from this video
your assistant knows that okay well
looks like in this case the tool that I
need to execute is get transcript or if
your question is something like hey send
an email to my wife wishing her for
Valentine's Day your assistant knows
that the tool to execute is send
automatic
emails now in this scenario your
assistant isn't obviously your assistant
it's a large language model so for
example this could be something like
Chach BT or deep seek or Gro or mistl or
the Lama 3 Model now what you're doing
is you're providing all of these llms
access to these tools so when you ask a
question like hey send an email to my
wife wishing her for Valentine's Day the
large language model is going to be able
to execute the tool for sending
automatic emails now here is what it's
going to look like on the open web UI
platform the first time you'll say
something like hey can you transcribe
this video and Chad gbt 40 is going to
come back to you and say look look sorry
I can't really transcribe that video but
you can try turning on um captions
that's not really helpful so what we'll
do is we'll provided access to the tool
now obviously I'm I didn't write this
tool by myself we have an entire
Community which I'm going to talk about
here in a second but this is a tool or a
script that I provided and the only
thing that I'll need to do is to
activate it which is basically to say
enable this tool so next time if I was
to ask a question like hey transcribe
this video it knows that this tool is
available so it executes this tool or
this script and then based on that it's
now able to actually transcribe this
video right hello everyone this is
Professor patterns and in this video you
get the idea so this is how a tool Works
a tool is a python script that your
large language model can execute so what
does this actually look like on the open
web UI interface well from your homepage
you'll select workspace and then select
tools now here you can see that I have
this YouTube transcript provider tool
that I've downloaded from the community
page and the goal of this tool is to go
go to the YouTube video grab the
transcript and then simply print it out
for me now to make sure that the tool is
running I need to click on this plus
icon and then enable it once I do that I
can ask a question something like grab
me the transcript from this video and
you can see here that when the Tool is
running it should be blinking here so
when I ask it this question it's going
to be able to go to this video and then
based on that it will start printing out
the transcript
now if you go over to openweb ui.com I'm
going to share a link to this in the
description you can go to the new tools
section so if I select SE all you can
see that I have a bunch of different
tools that are available here there are
some for email there's one for Reddit
there's a calculator tool u a transcribe
tool a wolf from alpha tool a 11 Labs
tool um let's try one let's say that for
example I wanted to try the enhanced web
scrape tool right this looks interesting
so to actually get this tool it's pretty
easy all you will do is simply select
get and then here is going to say import
to open web UI now you want to make sure
that open webui is running or it's not
going to work once I select this it's
going to automatically show up here on
open web
UI now something that you want to be
careful um about is you want to make
sure that the tools that you're
downloading are going to have at least a
couple of people who have used it in the
past because um these are going to be
executable files so some that you might
want to do is this one's fine cuz it's
got 7,000 something downloads but just
as an extra step of precaution I would
just copy and paste the tool put it into
chat DBT and just be like hey is this
safe or something or is this going to
send my data out somewhere just to be
sure you never know so here once you do
this you will be able to see your tool
available here and I'm going to Simply
select save and again you'll get this
warning right so tools have a function
calling systems that allow code
execution so I'm going to select confirm
and let's say that for example a one of
the tools that you downloaded has an API
key that is necessary well to do that
you'll simply select the valves section
and over here we can see that it is
asking for an API key but it is optional
so it allows for a higher rate limit
when you're scraping but you don't need
to actually have this so that's great
there's also another sort of thing for
citation so the default citation is
enabled
let's just say that we disabled citation
right we can do that over here U do we
want to disable caching I don't know
let's just leave it as the default value
and then I'm going to select save so for
example if you have other tools that do
require an API this is where you would
put that API in so let's go here to the
new chat and I need to make sure that
the tool for enhanced web search is
active and then we'll say something like
transcribe
this
page and when I send this message you'll
see here that it's going to scrape that
website and then based on that it's
going to tell us what this page is about
and that's pretty much it now all of
this is fine right like we know that we
can access tools from the community but
what if you had a very specific purpose
right and you wanted to create your own
tool how do you do that well you don't
need to be a developer all you'll do is
just go to the open web UI documentation
page cop copy this entire whatever
documentation is available on tools go
here and paste it next I'm going to copy
an example tool that works like the
enhanced web script right we tried that
we know that this works so I'm going to
go in here I'm going to say this is an
example of a tool that
works and I'm going to paste it and then
I'm also going to say this is another
example of a tool that works and then
I'm going to give it the YouTube
transcript provider so let's go in here
and then paste it now I can ask it to do
whatever I want right so let's just say
that I want it to create a tool for me
so I'm going to start typing
hey can you help create a new tool for
me that
fetches the top five posts from the Wall
Street bets
subreddit so when I execute this it's
not only does it have information on the
tools documentation also has some
example code from other people's tool
that does work so here it actually wrote
this entire script for me and I'd love
to actually try it out to see if this
works so I'm going to go here and then
I'm going to copy this entire script and
then let's go to settings or workspace
tools and let's create this new tool so
let's paste this entire code that we
were provided and then let's give this a
tool a name so w Street
bets and the tool description grabs top
five posts from
WSB so first I need to see if this
actually works I'm going to select
save and
confirm so it says code formatted
successfully let's see if this actually
works so do I have any vales that I need
to put in so client ID client secret and
then Reddit user agent let's leave these
as default for now because I'm not sure
um what those things are and let's try
to activate or run this tool of course I
put a typo in that U what are the top
five posts
today so what we need to do is see if
this works or not so it says Reddit API
credentials not configured so it means
that we need to provide it some
credentials so if I wanted to I could go
to api. reddit.com and then go in here
and then register to get the API but it
seems like this is a whole thing so
instead of doing this let me just get a
different or let me create a different
tool let's just say that I wanted to
create a different tool that doesn't use
an API call anywhere which now it makes
sense what those valves were which I
just completely had ignored at the time
so here it's saying here's a simple tool
that performs text analysis without
requiring any API calls so it analyzes
the text and then provides statistics
like word count character count most
common words and some more metrics so
yeah not the most glamorous tool I will
say but I mean it's a good use case
right so for example if you had
something that you wanted to try out you
can always go in here and then have it
kind of write that out for you looks
like it is actually removing the stop
words and then building some sort of a
response so I'm really excited to see if
this actually works so let's wait for it
to get
done and then I'm going to Simply select
copy now here let's go to workspace
tools and let's create this tool word
counter and then I'm going to paste it
and this
tool counts words let's hit save and
confirm only alpha numeric characters
allowed in the title let's hit save and
then confirm it says tool um created
successfully uh there are no valves so
that is awesome so let's go back here to
our new chat enable this tool which is
word counter and say or just type a
sentence like how many or
statistics on this
sentence this is a
sentence I don't know if that's going to
work or not but let's try it out this
analysis complete and then here are the
detailed statistics so it gave us the
basic statistics um reading analysis and
then word frequency so we know that this
actually works because this is the
format that the tool is actually working
in so if you go to workspace select
tools and then the word counter tool we
can see here that it's in that same sort
of format right text analysis results so
we know that this sort of pipeline Works
um if you have some use cases please
feel free to post those in the comment
section um I'd love to try some out you
know this is really the workflow you
don't need to be a developer not to
create these tools create these
functions so I encourage you to go out
maybe try creating some of these tools
but also be careful because remember
that these are executable python files
now that's pretty much it for this video
thank you all for tuning in hopefully it
was a little bit helpful and I'll see
you in the next one goodbye
Ask follow-up questions or revisit key timestamps.
This video introduces tools within Open Web UI, defining them as Python scripts that large language models (LLMs) can execute to perform specific tasks. Using an analogy of an assistant, the speaker explains how LLMs can leverage these tools to handle requests like transcribing videos or sending emails, which they couldn't do natively. The video demonstrates how to find and enable existing tools from the Open Web UI community, while also highlighting the importance of security given that tools are executable files. Furthermore, it illustrates how users can create custom tools with the assistance of an LLM, walking through an example of building a 'Word Counter' tool.
Videos recently processed by our community