Doc:Tools #292

parniantaghipour · 2024-11-19T04:43:18Z

Doc: The tool user and development manual

The tool user and development manual

Doc:Tools

Tools usar guide

docs/features/plugin/tools/getting-started.md

docs/features/plugin/tools/index.mdx

Doc: The tool user and development manual The tool user and development manual Doc:Tools Tools usar guide Some of the suggestions

Updated tool doc

tjbck · 2024-11-21T03:59:56Z

docs/features/plugin/tools/getting-started.md

+title: "🔧📖  Tool Development Guide"
+---
+# 🔧📖 Tool Development Guide
+This documentation provides a complete guide for developers to create tools compatible with Open WebUI. By following these guidelines, you can ensure that your tools are efficient, user-friendly, and integrate well with the platform.


efficient, user-friendly is misleading

tjbck · 2024-11-21T04:02:09Z

docs/features/plugin/tools/getting-started.md

+    def __init__(self):
+        pass
+```
+### file_handler:


Add a heading above this to mention these two are reserved instance attributes

tjbck · 2024-11-21T04:02:40Z

docs/features/plugin/tools/getting-started.md

+``` -->
+<!-- --- -->
+## Frontmatter Requirements
+Each tool should define its requirements and parameters in the frontmatter. The frontmatter must:


parameters?

tjbck · 2024-11-21T04:03:11Z

docs/features/plugin/tools/getting-started.md

+
+1. Begin and end with triple backticks (""").
+
+2. Start with a description (optional), followed by key-value pairs for parameters.


Be more detailed here

tjbck · 2024-11-21T04:03:40Z

docs/features/plugin/tools/getting-started.md

+```python
+requirements: numpy, pandas
+```
+### Versioning:


term Versioning is misleading.

tjbck · 2024-11-21T04:03:58Z

docs/features/plugin/tools/getting-started.md

+### Versioning:
+Information about the required version of Open WebUI for compatibility. This ensures that the tool runs on the appropriate version of the platform. Example:
+
+```python


Provide full frontmatter.

tjbck · 2024-11-21T04:04:36Z

docs/features/plugin/tools/getting-started.md

+```
+---
+## Function Documentation
+All functions must use [**Sphinx-style docstrings**](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html) for documentation. This ensures clarity, consistency, and compatibility for generating tool specifications. The docstring will be used to communicate to the model about the tool.


rm

This ensures clarity, consistency, and compatibility for generating tool specifications.

tjbck · 2024-11-21T04:05:31Z

docs/features/plugin/tools/getting-started.md

+Guidelines:
+1. Use Sphinx-style Format: The docstrings should include parameter and return type information.
+2. Description: Begin with a brief description of the function.
+3. Parameters: Document each parameter with its name and description (except for __user__)


Not true, not just __user__, it's all reversed params

and 3. should really be merged

tjbck · 2024-11-21T04:06:11Z

docs/features/plugin/tools/getting-started.md

+:::info
+Guidelines:
+1. Use Sphinx-style Format: The docstrings should include parameter and return type information.
+2. Description: Begin with a brief description of the function.


explicitly mention "function docstring"

tjbck · 2024-11-21T04:06:59Z

docs/features/plugin/tools/getting-started.md

+:::tip
+ Reserved params do not require type hints.
+:::
+### Some of the supported types for tool parameters: String, Integer, Number, Boolean, Array, Object, Null, Literal, Optional.


Unnecessary

tjbck · 2024-11-21T04:07:34Z

docs/features/plugin/tools/getting-started.md

+
+
+## Valves and User Valves
+Valves are optional configurations that control a tool's behavior. The key difference is that valves can only be configured by admins, whereas user valves can be set by any user to suit their individual needs.


capitalise Valves

tjbck · 2024-11-21T04:08:05Z

docs/features/plugin/tools/getting-started.md

+
+They can be defined as follows:
+
+```python


visual aids would be helpful here.

tjbck · 2024-11-21T04:08:22Z

docs/features/plugin/tools/getting-started.md

+        self.valves = self.Valves()
+        pass
+```
+> **Note:** As you can see, you can give default value to valves and user valves.


tjbck · 2024-11-21T04:09:09Z

docs/features/plugin/tools/getting-started.md

+
+![Event_emitter Demo](/img/demo-event-emit.gif)
+
+You can pass event emitter directly to your function as input, and use it as follow:


should be a parameter

tjbck · 2024-11-21T04:10:16Z

docs/features/plugin/tools/getting-started.md

+            {
+                "type": "status", # We set the type here
+                "data": {"description": "Message that shows up in the chat", "done": False}, 
+                # Note done is False here indicating we are still emitting statuses


misleading, "done": False is used to display loading indicator from the frontend.

tjbck · 2024-11-21T04:10:28Z

docs/features/plugin/tools/getting-started.md

+            {
+                "type": "status",
+                "data": {"description": "Completed a task message", "done": True},
+                # Note done is True here indicating we are done emitting statuses


again misleading

tjbck · 2024-11-21T04:11:00Z

docs/features/plugin/tools/getting-started.md

+            return f"Tell the user: {e}"
+```
+
+### Sending messages:


there are many different sub types for this.

tjbck · 2024-11-21T04:11:25Z

docs/features/plugin/tools/getting-started.md

+
+### Citation
+
+It is possible also to sent citations using event emitter with **citation** type:


tjbck · 2024-11-21T04:12:01Z

docs/features/plugin/tools/getting-started.md

+
+
+## Event Calls
+Event Calls are a powerful way to communicate with users while your tool is running. They let you share messages, update progress, handle errors, and even gather user feedback in real time, making your workflows more interactive and adaptable.


They let you share messages, update progress, handle errors ?

tjbck · 2024-11-21T04:12:19Z

docs/features/plugin/tools/getting-started.md

+
+![Even_call Demo](/img/demo-event-call.gif)
+
+You can pass event call directly to your function as input, and use it as follow:


same here a parameter

tjbck · 2024-11-21T04:13:36Z

docs/features/plugin/tools/index.mdx

-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/
+## What sorts of things can Tools do?


What can you do with Tools?

tjbck · 2024-11-21T04:14:06Z

docs/features/plugin/tools/index.mdx

 ---

 ## 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 are Python scripts provided to a LLM, during a request, enabling the LLM to perform specific actions or access additional context. To use Tools, the LLM must support **function calling**.


To use Tools, the LLM must support **function calling**. misleading.

tjbck · 2024-11-21T04:14:29Z

docs/features/plugin/tools/index.mdx

-
-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/
+## What sorts of things can Tools do?
+Tools empower LLMs with diverse functionalities to enrich interactive conversations, such as:


tjbck · 2024-11-21T04:14:55Z

docs/features/plugin/tools/index.mdx

+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.


IP address -> Url

tjbck · 2024-11-21T04:15:17Z

docs/features/plugin/tools/index.mdx


-Please note: when using the AutoTool Filter, you will still need to take the steps above to enable the Tools per model.
+- [**Web Search**](https://openwebui.com/t/constliakos/web_search/): Fetch live, real-time information from the web.
+- [**Image Generation**](https://openwebui.com/t/justinrahb/image_gen/): Create images based on user prompts.



Add How to get started section here.

tjbck · 2024-11-21T04:15:59Z

docs/features/plugin/tools/index.mdx

+## How to set Valves and User Valves
+Valves and User Valves are configuration options that allow admins and users to customize how Tools behave.
+
+### Valves


Not needed here anymore.

tjbck · 2024-11-21T04:16:35Z

Feel free to reopen after addressing all the comments and squashing your commits. Appreciate the effort.

tjbck · 2024-11-21T04:19:23Z

docs/features/plugin/tools/getting-started.md

+---
+
+## Introduction
+Open WebUI allows developers to extend its functionality by building custom tools using **pure python**. To maintain consistency and usability across the platform, it is essential to follow the development standards outlined in this guide.


To maintain consistency and usability? Misleading here.

tjbck · 2024-11-21T04:21:04Z

docs/features/plugin/tools/getting-started.md

at the end add one example and start analyzing the code and let the readers know how they all work in tandem

tjbck reviewed Nov 19, 2024

View reviewed changes

docs/features/plugin/tools/getting-started.md Outdated Show resolved Hide resolved

tjbck reviewed Nov 19, 2024

View reviewed changes

docs/features/plugin/tools/getting-started.md Show resolved Hide resolved

tjbck reviewed Nov 19, 2024

View reviewed changes

docs/features/plugin/tools/getting-started.md Show resolved Hide resolved

tjbck reviewed Nov 19, 2024

View reviewed changes

docs/features/plugin/tools/getting-started.md Outdated Show resolved Hide resolved

tjbck reviewed Nov 19, 2024

View reviewed changes

docs/features/plugin/tools/getting-started.md Show resolved Hide resolved

tjbck reviewed Nov 19, 2024

View reviewed changes

docs/features/plugin/tools/index.mdx Outdated Show resolved Hide resolved

Doc:Tools

e9ab658

Doc: The tool user and development manual The tool user and development manual Doc:Tools Tools usar guide Some of the suggestions

parniantaghipour force-pushed the tool_pull branch from 5264e32 to e9ab658 Compare November 19, 2024 08:01

to be continued

997fa28

Updated tool doc

tjbck reviewed Nov 21, 2024

View reviewed changes

docs/features/plugin/tools/getting-started.md

They can be defined as follows:

```python

Copy link

Contributor

tjbck Nov 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

visual aids would be helpful here.

tjbck reviewed Nov 21, 2024

View reviewed changes

tjbck closed this Nov 21, 2024

tjbck reviewed Nov 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc:Tools #292

Doc:Tools #292

parniantaghipour commented Nov 19, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024 •

edited

Loading

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024 •

edited

Loading

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024

tjbck commented Nov 21, 2024

tjbck Nov 21, 2024

tjbck Nov 21, 2024


		1. Begin and end with triple backticks (""").

		2. Start with a description (optional), followed by key-value pairs for parameters.



		## Valves and User Valves
		Valves are optional configurations that control a tool's behavior. The key difference is that valves can only be configured by admins, whereas user valves can be set by any user to suit their individual needs.


		![Event_emitter Demo](/img/demo-event-emit.gif)

		You can pass event emitter directly to your function as input, and use it as follow:


		### Citation

		It is possible also to sent citations using event emitter with citation type:



		## Event Calls
		Event Calls are a powerful way to communicate with users while your tool is running. They let you share messages, update progress, handle errors, and even gather user feedback in real time, making your workflows more interactive and adaptable.


		![Even_call Demo](/img/demo-event-call.gif)

		You can pass event call directly to your function as input, and use it as follow:

Doc:Tools #292

Doc:Tools #292

Conversation

parniantaghipour commented Nov 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tjbck Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tjbck Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tjbck commented Nov 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tjbck Nov 21, 2024 •

edited

Loading

tjbck Nov 21, 2024 •

edited

Loading