mirror of
https://github.com/open-webui/docs
synced 2025-06-16 11:28:36 +00:00
New Apache Tika & Artifacts Docs Pages
New Apache Tika & Artifacts Docs Pages
This commit is contained in:
Silentoplayz
67
docs/features/chat-features/chat-params.md
Normal file
67
docs/features/chat-features/chat-params.md
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: "⚙️ Chat Parameters"
|
||||
---
|
||||
|
||||
Within Open WebUI, there are three levels to setting a **System Prompt** and **Advanced Parameters**: per-chat basis, per-model basis, and per-account basis. This hierarchical system allows for flexibility while maintaining structured administration and control.
|
||||
|
||||
## System Prompt and Advanced Parameters Hierarchy Chart
|
||||
|
||||
| **Level** | **Definition** | **Modification Permissions** | **Override Capabilities** |
|
||||
| --- | --- | --- | --- |
|
||||
| **Per-Chat** | System prompt and advanced parameters for a specific chat instance | Users can modify, but cannot override model-specific settings | Restricted from overriding model-specific settings |
|
||||
| **Per-Model** | Default system prompt and advanced parameters for a specific model | Administrators can set, Users cannot modify | Admin-specific settings take precedence, User settings can be overridden |
|
||||
| **Per-Account** | Default system prompt and advanced parameters for a specific user account | Users can set, but may be overridden by model-specific settings | User settings can be overridden by model-specific settings |
|
||||
|
||||
### 1. **Per-chat basis:**
|
||||
|
||||
- **Description**: The per-chat basis setting refers to the system prompt and advanced parameters configured for a specific chat instance. These settings are only applicable to the current conversation and do not affect future chats.
|
||||
- **How to set**: Users can modify the system prompt and advanced parameters for a specific chat instance within the right-hand sidebar's **Chat Controls** section in Open WebUI.
|
||||
- **Override capabilities**: Users are restricted from overriding the **System Prompt** or specific **Advanced Parameters** already set by an administrator on a per-model basis (**#2**). This ensures consistency and adherence to model-specific settings.
|
||||
|
||||
<details>
|
||||
<summary>Example Use Case</summary>
|
||||
:::tip **Per-chat basis**:
|
||||
Suppose a user wants to set a custom system prompt for a specific conversation. They can do so by accessing the **Chat Controls** section and modifying the **System Prompt** field. These changes will only apply to the current chat session.
|
||||
:::
|
||||
</details>
|
||||
|
||||
### 2. **Per-model basis:**
|
||||
|
||||
- **Description**: The per-model basis setting refers to the default system prompt and advanced parameters configured for a specific model. These settings are applicable to all chat instances using that model.
|
||||
- **How to set**: Administrators can set the default system prompt and advanced parameters for a specific model within the **Models** section of the **Workspace** in Open WebUI.
|
||||
- **Override capabilities**: **User** accounts are restricted from modifying the **System Prompt** or specific **Advanced Parameters** on a per-model basis (**#3**). This restriction prevents users from inappropriately altering default settings.
|
||||
- **Context length preservation:** When a model's **System Prompt** or specific **Advanced Parameters** are set manually in the **Workspace** section by an Admin, said **System Prompt** or manually set **Advanced Parameters** cannot be overridden or adjusted on a per-account basis within the **General** settings or **Chat Controls** section by a **User** account. This ensures consistency and prevents excessive reloading of the model whenever a user's context length setting changes.
|
||||
- **Model precedence:** If a model's **System Prompt** or specific **Advanced Parameters** value is pre-set in the Workspace section by an Admin, any context length changes made by a **User** account in the **General** settings or **Chat Controls** section will be disregarded, maintaining the pre-configured value for that model. Be advised that parameters left untouched by an **Admin** account can still be manually adjusted by a **User** account on a per-account or per-chat basis.
|
||||
|
||||
<details>
|
||||
<summary>Example Use Case</summary>
|
||||
:::tip **Per-model basis**:
|
||||
Suppose an administrator wants to set a default system prompt for a specific model. They can do so by accessing the **Models** section and modifying the **System Prompt** field for the corresponding model. Any chat instances using this model will automatically use the model's system prompt and advanced parameters.
|
||||
:::
|
||||
</details>
|
||||
|
||||
### 3. **Per-account basis:**
|
||||
|
||||
- **Description**: The per-account basis setting refers to the default system prompt and advanced parameters configured for a specific user account. Any user-specific changes can serve as a fallback in situations where lower-level settings aren't defined.
|
||||
- **How to set**: Users can set their own system prompt and advanced parameters for their account within the **General** section of the **Settings** menu in Open WebUI.
|
||||
- **Override capabilities**: Users have the ability to set their own system prompt on their account, but they must be aware that such parameters can still be overridden if an administrator has already set the **System Prompt** or specific **Advanced Parameters** on a per-model basis for the particular model being used.
|
||||
|
||||
<details>
|
||||
<summary>Example Use Case</summary>
|
||||
:::tip **Per-account basis**:
|
||||
Suppose a user wants to set their own system prompt for their account. They can do so by accessing the **Settings** menu and modifying the **System Prompt** field.
|
||||
:::
|
||||
</details>
|
||||
|
||||
## **Optimize System Prompt Settings for Maximum Flexibility**
|
||||
|
||||
:::tip **Bonus Tips**
|
||||
**This tip applies for both administrators and user accounts. To achieve maximum flexibility with your system prompts, we recommend considering the following setup:**
|
||||
|
||||
- Assign your primary System Prompt (**i.e., to give an LLM a defining character**) you want to use in your **General** settings **System Prompt** field. This sets it on a per-account level and allows it to work as the system prompt across all your LLMs without requiring adjustments within a model from the **Workspace** section.
|
||||
|
||||
- For your secondary System Prompt (**i.e, to give an LLM a task to perform**), choose whether to place it in the **System Prompt** field within the **Chat Controls** sidebar (on a per-chat basis) or the **Models** section of the **Workspace** section (on a per-model basis) for Admins, allowing you to set them directly. This allows your account-level system prompt to work in conjunction with either the per-chat level system prompt provided by **Chat Controls**, or the per-model level system prompt provided by **Models**.
|
||||
|
||||
- As an administrator, you should assign your LLM parameters on a per-model basis using **Models** section for optimal flexibility. For both of these secondary System Prompts, ensure to set them in a manner that maximizes flexibility and minimizes required adjustments across different per-account or per-chat instances. It is essential for both your Admin account as well as all User accounts to understand the priority order by which system prompts within **Chat Controls** and the **Models** section will be applied to the **LLM**.
|
||||
:::
|
||||
106
docs/features/chat-features/chatshare.md
Normal file
106
docs/features/chat-features/chatshare.md
Normal file
@@ -0,0 +1,106 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: "🗨️ Chat Sharing"
|
||||
---
|
||||
|
||||
### Enabling Community Sharing
|
||||
|
||||
To enable community sharing, follow these steps:
|
||||
|
||||
1. Navigate to the **Admin Panel** page as an **Admin**.
|
||||
2. Click on the **Settings** tab.
|
||||
3. Toggle on **Enable Community Sharing** within the **General** settings tab.
|
||||
|
||||
:::note
|
||||
**Note:** Only Admins can toggle the **Enable Community Sharing** option. If this option is toggled off, users and Admins will not see the **Share to Open WebUI Community** option for sharing their chats. Community sharing must be enabled by an Admin for users to share chats to the Open WebUI community.
|
||||
:::
|
||||
|
||||
This will enable community sharing for all users on your Open WebUI instance.
|
||||
|
||||
### Sharing Chats
|
||||
|
||||
To share a chat:
|
||||
|
||||
1. Select the chat conversation you want to share.
|
||||
2. Click on the 3-dots that appear when hovering the mouse pointer above the desired chat.
|
||||
3. Then click on the **Share** option.
|
||||
4. Select either **Share to Open WebUI Community** (if **Enable Community Sharing** is toggled on by an **Admin**) or **Copy Link**.
|
||||
|
||||
#### Sharing to Open WebUI Community
|
||||
|
||||
When you select `Share to Open WebUI Community`:
|
||||
|
||||
* A new tab will open, allowing you to upload your chat as a snapshot to the Open WebUI community website (https://openwebui.com/chats/upload).
|
||||
* You can control who can view your uploaded chat by choosing from the following access settings:
|
||||
* **Private**: Only you can access this chat.
|
||||
* **Public**: Anyone on the internet can view the messages displayed in the chat snapshot.
|
||||
* **Public, Full History**: Anyone on the internet can view the full regeneration history of your chat.
|
||||
|
||||
:::note
|
||||
Note: You can change the permission level of your shared chats on the community platform at any time from your openwebui.com account.
|
||||
|
||||
**Currently, shared chats on the community website cannot be found through search. However, future updates are planned to allow public chats to be discoverable by the public if their permission is set to `Public` or `Public, Full History`.**
|
||||
:::
|
||||
|
||||
Example of a shared chat to the community platform website: https://openwebui.com/c/iamg30/5e3c569f-905e-4d68-a96d-8a99cc65c90f
|
||||
|
||||
#### Copying a Share Link
|
||||
|
||||
When you select `Copy Link`, a unique share link is generated that can be shared with others.
|
||||
|
||||
**Important Considerations:**
|
||||
|
||||
* The shared chat will only include messages that existed at the time the link was created. Any new messages sent within the chat after the link is generated will not be included, unless the link is deleted and updated with a new link.
|
||||
* The generated share link acts as a static snapshot of the chat at the time the link was generated.
|
||||
* To view the shared chat, users must:
|
||||
1. Have an account on the Open WebUI instance where the link was generated.
|
||||
2. Be signed in to their account on that instance.
|
||||
* If a user tries to access the shared link without being signed in, they will be redirected to the login page to log in before they can view the shared chat.
|
||||
|
||||
### Viewing Shared Chats
|
||||
|
||||
To view a shared chat:
|
||||
|
||||
1. Ensure you are signed in to an account on the Open WebUI instance where the chat was shared.
|
||||
2. Click on the shared link provided to you.
|
||||
3. The chat will be displayed in a read-only format.
|
||||
4. If the Admin of the Open WebUI instance from which the shared link was shared has Text-to-Speech set up, there may be an audio button for messages to be read aloud to you (situational).
|
||||
|
||||
### Updating Shared Chats
|
||||
|
||||
To update a shared chat:
|
||||
|
||||
1. Select the chat conversation you want to share.
|
||||
2. Click on the 3-dots that appear when hovering the mouse pointer above the desired chat.
|
||||
3. Click on the **Share** option.
|
||||
4. The **Share Chat** Modal should look different if you've shared a chat before.
|
||||
|
||||
The **Share Chat** Modal includes the following options:
|
||||
|
||||
* **before**: Opens a new tab to view the previously shared chat from the share link.
|
||||
* **delete this link**: Deletes the shared link of the chat and presents the initial share chat modal.
|
||||
* **Share to Open WebUI Community**: Opens a new tab for https://openwebui.com/chats/upload with the chat ready to be shared as a snapshot.
|
||||
* **Update and Copy Link**: Updates the snapshot of the chat of the previously shared chat link and copies it to your device's clipboard.
|
||||
|
||||
### Deleting Shared Chats
|
||||
|
||||
To delete a shared chat link:
|
||||
|
||||
1. Select the chat conversation you want to delete the shared link for.
|
||||
2. Click on the 3-dots that appear when hovering the mouse pointer above the desired chat.
|
||||
3. Click on the **Share** option.
|
||||
4. The **Share Chat** Modal should look different if you've shared a chat before.
|
||||
5. Click on **delete this link**.
|
||||
|
||||
Once deleted, the shared link will no longer be valid, and users will not be able to view the shared chat.
|
||||
|
||||
:::note
|
||||
**Note:** Chats shared to the community platform cannot be deleted. To change the access level of a chat shared to the community platform:
|
||||
:::
|
||||
|
||||
1. Log in to your Open WebUI account on openwebui.com.
|
||||
2. Click on your account username at the top right of the website.
|
||||
3. Click on **Chats**.
|
||||
4. Click on the chat you wish to change permission access for.
|
||||
5. Scroll to the bottom of the chat and update its permission level.
|
||||
6. Click the **Update Chat** button.
|
||||
6
docs/features/chat-features/controls.md
Normal file
6
docs/features/chat-features/controls.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: "🎛️ Chat Controls"
|
||||
---
|
||||
|
||||
COMING SOON!
|
||||
35
docs/features/chat-features/conversation-organization.md
Normal file
35
docs/features/chat-features/conversation-organization.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: "🗂️ Organizing Conversations"
|
||||
---
|
||||
|
||||
Open WebUI provides powerful organization features that help users manage their conversations. You can easily categorize and tag conversations, making it easier to find and retrieve them later. The two primary ways to organize conversations are through **Folders** and **Tags**.
|
||||
|
||||
## Organizing Conversations with Folders
|
||||
|
||||
Folders allow you to group related conversations together for quick access and better organization.
|
||||
|
||||
- **Creating a Folder**: You can create a new folder to store specific conversations. This is useful if you want to keep conversations of a similar topic or purpose together.
|
||||
- **Moving Conversations into Folders**: Conversations can be moved into folders by dragging and dropping them. This allows you to structure your workspace in a way that suits your workflow.
|
||||
|
||||
|
||||
|
||||
### Example Use Case
|
||||
|
||||
:::tip **Organizing by Project**
|
||||
If you are managing multiple projects, you can create separate folders for each project and move relevant conversations into these folders. This helps keep all project-related discussions in one place.
|
||||
:::
|
||||
|
||||
## Tagging Conversations
|
||||
|
||||
Tags provide an additional layer of organization by allowing you to label conversations with keywords or phrases.
|
||||
|
||||
- **Adding Tags to Conversations**: Tags can be applied to conversations based on their content or purpose. Tags are flexible and can be added or removed as needed.
|
||||
|
||||
- **Using Tags for Searching**: Tags make it easy to locate specific conversations by using the search feature. You can filter conversations by tags to quickly find those related to specific topics.
|
||||
|
||||
### Example Use Case
|
||||
|
||||
:::tip **Tagging by Topic**
|
||||
If you frequently discuss certain topics, such as "marketing" or "development," you can tag conversations with these terms. Later, when you search for a specific tag, all relevant conversations will be quickly accessible.
|
||||
:::
|
||||
6
docs/features/chat-features/export.md
Normal file
6
docs/features/chat-features/export.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: "📤 Downloading & Exporting Chats"
|
||||
---
|
||||
|
||||
COMING SOON!
|
||||
6
docs/features/chat-features/favorite.md
Normal file
6
docs/features/chat-features/favorite.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: "⭐ Favorite Response"
|
||||
---
|
||||
|
||||
COMING SOON!
|
||||
6
docs/features/chat-features/import.md
Normal file
6
docs/features/chat-features/import.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: "📥 Importing Chats"
|
||||
---
|
||||
|
||||
COMING SOON!
|
||||
6
docs/features/chat-features/index.mdx
Normal file
6
docs/features/chat-features/index.mdx
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: "😏 Chat Features"
|
||||
---
|
||||
|
||||
COMING SOON!
|
||||
94
docs/features/chat-features/url-params.md
Normal file
94
docs/features/chat-features/url-params.md
Normal file
@@ -0,0 +1,94 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: "🔗 URL Parameters"
|
||||
---
|
||||
|
||||
In Open WebUI, chat sessions can be customized through various URL parameters. These parameters allow you to set specific configurations, enable features, and define model settings on a per-chat basis. This approach provides flexibility and control over individual chat sessions directly from the URL.
|
||||
|
||||
## URL Parameter Overview
|
||||
|
||||
The following table lists the available URL parameters, their function, and example usage.
|
||||
|
||||
| **Parameter** | **Description** | **Example** |
|
||||
|-----------------------|----------------------------------------------------------------------------------|--------------------------------------------------------|
|
||||
| `models` | Specifies the models to be used, as a comma-separated list. | `/?models=model1,model2` |
|
||||
| `model` | Specifies a single model to be used for the chat session. | `/?model=model1` |
|
||||
| `youtube` | Specifies a YouTube video ID to be transcribed within the chat. | `/?youtube=VIDEO_ID` |
|
||||
| `web-search` | Enables web search functionality if set to `true`. | `/?web-search=true` |
|
||||
| `tools` or `tool-ids` | Specifies a comma-separated list of tool IDs to activate in the chat. | `/?tools=tool1,tool2` |
|
||||
| `call` | Enables a call overlay if set to `true`. | `/?call=true` |
|
||||
| `q` | Sets an initial query or prompt for the chat. | `/?q=Hello%20there` |
|
||||
| `temporary-chat` | Marks the chat as temporary if set to `true`, for one-time sessions. | `/?temporary-chat=true` |
|
||||
|
||||
### 1. **Models and Model Selection**
|
||||
|
||||
- **Description**: The `models` and `model` parameters allow you to specify which [language models](/features/workspace/models.md) should be used for a particular chat session.
|
||||
- **How to Set**: You can use either `models` for multiple models or `model` for a single model.
|
||||
- **Example**:
|
||||
- `/?models=model1,model2` – This initializes the chat with `model1` and `model2`.
|
||||
- `/?model=model1` – This sets `model1` as the sole model for the chat.
|
||||
|
||||
### 2. **YouTube Transcription**
|
||||
|
||||
- **Description**: The `youtube` parameter takes a YouTube video ID, enabling the chat to transcribe the specified video.
|
||||
- **How to Set**: Use the YouTube video ID as the value for this parameter.
|
||||
- **Example**: `/?youtube=VIDEO_ID`
|
||||
- **Behavior**: This triggers transcription functionality within the chat for the provided YouTube video.
|
||||
|
||||
### 3. **Web Search**
|
||||
|
||||
- **Description**: Enabling `web-search` allows the chat session to access [web search](/tutorials/integrations/web_search) functionality.
|
||||
- **How to Set**: Set this parameter to `true` to enable web search.
|
||||
- **Example**: `/?web-search=true`
|
||||
- **Behavior**: If enabled, the chat can retrieve web search results as part of its responses.
|
||||
|
||||
### 4. **Tool Selection**
|
||||
|
||||
- **Description**: The `tools` or `tool-ids` parameters specify which [tools](/features/plugin/tools) to activate within the chat.
|
||||
- **How to Set**: Provide a comma-separated list of tool IDs as the parameter’s value.
|
||||
- **Example**: `/?tools=tool1,tool2` or `/?tool-ids=tool1,tool2`
|
||||
- **Behavior**: Each tool ID is matched and activated within the session for user interaction.
|
||||
|
||||
### 5. **Call Overlay**
|
||||
|
||||
- **Description**: The `call` parameter enables a video or call overlay in the chat interface.
|
||||
- **How to Set**: Set the parameter to `true` to enable the call overlay.
|
||||
- **Example**: `/?call=true`
|
||||
- **Behavior**: Activates a call interface overlay, allowing features such as live transcription and video input.
|
||||
|
||||
### 6. **Initial Query Prompt**
|
||||
|
||||
- **Description**: The `q` parameter allows setting an initial query or prompt for the chat.
|
||||
- **How to Set**: Specify the query or prompt text as the parameter value.
|
||||
- **Example**: `/?q=Hello%20there`
|
||||
- **Behavior**: The chat starts with the specified prompt, automatically submitting it as the first message.
|
||||
|
||||
### 7. **Temporary Chat Sessions**
|
||||
|
||||
- **Description**: The `temporary-chat` parameter marks the chat as a temporary session. This may limit features such as saving chat history or applying persistent settings.
|
||||
- **How to Set**: Set this parameter to `true` for a temporary chat session.
|
||||
- **Example**: `/?temporary-chat=true`
|
||||
- **Behavior**: This initiates a disposable chat session without saving history or applying advanced configurations.
|
||||
|
||||
<details>
|
||||
<summary>Example Use Case</summary>
|
||||
:::tip **Temporary Chat Session**
|
||||
Suppose a user wants to initiate a quick chat session without saving the history. They can do so by setting `temporary-chat=true` in the URL. This provides a disposable chat environment ideal for one-time interactions.
|
||||
:::
|
||||
</details>
|
||||
|
||||
## Using Multiple Parameters Together
|
||||
|
||||
These URL parameters can be combined to create highly customized chat sessions. For example:
|
||||
|
||||
```bash
|
||||
/chat?models=model1,model2&youtube=VIDEO_ID&web-search=true&tools=tool1,tool2&call=true&q=Hello%20there&temporary-chat=true
|
||||
```
|
||||
|
||||
This URL will:
|
||||
|
||||
- Initialize the chat with `model1` and `model2`.
|
||||
- Enable YouTube transcription, web search, and specified tools.
|
||||
- Display a call overlay.
|
||||
- Set an initial prompt of "Hello there."
|
||||
- Mark the chat as temporary, avoiding any history saving.
|
||||
Reference in New Issue
Block a user