Skip to content

Commit

Permalink
Create prompts.md
Browse files Browse the repository at this point in the history
Prompt presets added

Update prompts.md

Update prompts.md
  • Loading branch information
parniantaghipour committed Nov 15, 2024
1 parent f5713be commit 083a5d2
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions docs/features/workspace/prompts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
sidebar_position: 3
title: "📜 Prompt Presets"
---

# 📜 Prompt Presets

Imagine you’ve just started exploring Open WebUI, or maybe you've been using it but find yourself wondering what "Prompt Prsets" are about. Is it just tech lingo? Not really! Let's break it down step-by-step so you'll fully understand how they work, what makes them useful, and why using them is easier than it seems.

**Prompt Presets** are predefined templates or examples designed to guide or standardize the types of responses generated by AI language models. They provide a quick way to reuse commonly used prompts without having to type them out every time.

By leveraging prompt presets, you can save time, maintain consistency, and streamline your workflow, whether you're creating structured queries, generating content, or experimenting with the capabilities of Open WebUI. Simply select or customize a preset to get started and enjoy a faster, more convenient experience with your prompts!

## How to Create Custom Prompts

Creating a custom prompt involves deciding on the specific instructions you want to give the AI. The prompt creation feature in Open WebUI allows you to:
1. Add a title for your prompt (e.g., "Professional Email").
2. Add a command for your prompt that can be use later to autofil the message.
3. Define the prompt content with customizable placeholders.
4. You can save and reuse prompts as needed by using a `/` command.

Admins can add prompts to the workspace, which users can access and use; however, users do not have direct access to the workspace itself.

# Prompt Variables

You can use variables by placing text within `{{ }}`, like `{{YOUR_VARIABLE}}`, which will be highlighted in your prompt for easy identification. These variables act as placeholders, allowing you to create adaptable prompts that can be quickly customized. When using a prompt with these placeholders, you can easily tab between them using the Tab key to move to the next variable and fill it in.

# Reserved Variables Support

If you want to write your own prompt, these are the variables that can help you. Open WebUI provides a range of dynamic prompt variables that allow you to create interactive and context-aware prompts. Below is a chart of the available variables and their descriptions:

| **Reserved Variable** | **Description** | **Requirements** |
|------------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
| `{{CLIPBOARD}}` | Inserts the content of your device's clipboard into the prompt. | Requires access to your device's clipboard. |
| `{{CURRENT_DATE}}` | Inserts the current date in the format `YYYY-MM-DD`. | None |
| `{{CURRENT_DATETIME}}`| Inserts the current date and time in the format `YYYY-MM-DD HH:MM:SS`. | None |
| `{{CURRENT_TIME}}` | Inserts the current time in the format `HH:MM:SS`. | None |
| `{{CURRENT_TIMEZONE}}`| Inserts the user's current timezone. | None |
| `{{CURRENT_WEEKDAY}}` | Inserts the current day of the week (e.g., Monday, Tuesday). | None |
| `{{USER_NAME}}` | Inserts the user's name. | None |
| `{{USER_LANGUAGE}}` | Inserts the user's language setting. | None |
| `{{USER_LOCATION}}` | Inserts the user's geographic location (city, country, etc.). | Requires HTTPS and must be enabled via `Settings > Interface`. |

Using these variables, you can create personalized prompts or automate workflows that adapt to real-time data. For example, you can generate location-specific responses, use clipboard content for quick context integration, or adapt prompts based on the current time and date. Enable these variables in the settings menu to unlock their full potential!

## Using Community Prompts

Open WebUI offers a [collection of prompts](https://openwebui.com/prompts)contributed by other users. You can browse and download prompts like “Code Expert,” “Grammar Check and Rewrite” or “Image Description Assistant,” to quickly enhance your experience with minimal setup.

0 comments on commit 083a5d2

Please sign in to comment.