Skip to content

Commit

Permalink
chore: add docs (#203)
Browse files Browse the repository at this point in the history
* add docs

* review
  • Loading branch information
sr-remsha authored Oct 9, 2024
1 parent eda6c20 commit 003375e
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 7 deletions.
Binary file added docs/img/param-replay-form-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/param-replay-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/param-replay-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 25 additions & 4 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,19 +270,40 @@ The replayed conversation is displayed as a new conversation with the `[Replay]`

### Parameterized Replay

If you want to make your own chats or stories with custom variables and share them with your team, you can use a feature called Parameterized Replay. Use it to set up a chat or a story that others can follow, but provide their own details or answers to create a personalized experience. This makes chat a much more useful tool for sharing information and collaboration.
You can use Parameterized Replay to create your own chats or stories with custom variables and share them with your team. Such parametrized conversations others can follow, but with their own details or answers to create a personalized experience. This makes chat a much more useful tool for sharing information and collaboration.

How it works:
##### Prompt-based

You can create a parametrized conversation using a special prompt with variables.

Let's create a simple Travel Guide conversation, which will take a user though several steps to clarify information and provide the answer.

1. Start by [creating a special prompt](#create-1) with [variables](#variables). Use templates (this `{{VariableName|DefaultValue}}` or this `{{VariableName}}`) to add variables into your prompt with or without default values. For example: `I'd like to travel to {{country|Japan}}. Could you please suggest {{num-attractions|10}} of the best attractions? I will be there for {{num-days}}. Thank you.`
2. To use it, type `/` in the conversation text input area and select your prompt. You will be prompted to provide your inputs for variables in a pop-up window. Enter your inputs and click `Submit`. The prompt is now populated with your inputs in the conversation text box. Send message to start.
2. To use your parametrized prompt, type `/` in the conversation text input area and select your prompt. You will be asked to provide your inputs for variables in a pop-up window. Enter your inputs and click `Submit`. The prompt is now populated with your inputs in the conversation text box. Send message to start.
3. The chat will return its response to your prompt.
4. You can now click [Replay](#replay) in your conversation's menu to repeat this dialogue but with different input parameters.
5. You can [Share](#share) this conversation with someone. When a person opens the shared conversation, they will be prompted to fill in their personal input in the parameterized prompt, allowing them to have the same conversation but with their custom inputs, for example, travel to USA instead of Japan.

> Watch a [demo video](https://youtu.be/I8en0n0TQQU?si=mMUQkpKvx0xEoElF) to see it in action and check out more examples.
##### Dynamic

You can create a parametrized conversation from any message in your chat. This scenario does not require having any pre-configured prompts.

> Watch a [demo video](../video%20demos/demos/dial-parameterized-replay) to see it in action.
1. Within a conversation, you can set any message as a template for subsequent replay. Use **Set message template** to invoke the **Message template** window.

![](./img/param-replay-icon.png)

2. In the **Message template** window, you can substitute sections of your original message with [variables](#variables) under the **Set template** tab. To achieve this, copy a segment from your original message and paste it into the first input box. Then, in the second input box, introduce a variable using the format: `{{Variable name}}`. For instance, in our example, we have replaced "France" with the `{{Country}}` variable.

![](./img/param-replay-form.png)

In the **Preview** tab, you can preview your original message with variables:

![](./img/param-replay-form-preview.png)

3. Once you click save, you can return to your conversation. In the conversation menu, select [Replay](#replay) to initiate the replay of this conversation. The chat will prompt you to input values for your variable(s) to replay the conversation. You have the option to replay it as it originally was (using the same model as in your initial conversation) - select **Replay as is** in [Talk to](#talk-to), or you can alter the settings of the conversation to experiment with different models and parameters.
4. You can [Share](#share) this conversation with others. When someone opens the shared conversation, they will be prompted to provide their own inputs in the template. This allows experiencing the same conversation but with personalized inputs, such as traveling to the USA instead of France.

### Playback

Expand Down
10 changes: 7 additions & 3 deletions docs/video demos/demos/7.dial-parameterized-replay.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Parameterized Replay in DIAL Chat
# Parameterized Replay

https://youtu.be/I8en0n0TQQU
https://youtu.be/OUkxS8wu9k0

Parameterized Replay combines parameterized prompts with replay functionality to allow users to go through entire conversational flows with selected variables replaced. By combining clever prompt engineering with DIAL’s collaborative capabilities, people can now share even the most complex conversational workflows with their organization with the help of parameterized replays.
If you want to make your own chats or stories with custom variables and share them with your team, you can use a feature called **Parameterized Replay**. Use it to set up a chat or a story that others can follow, but provide their own details or answers to create a personalized experience. This makes chat a much more useful tool for sharing information and collaboration.

Furthermore, you can use Replay with any [models](../../supported-models), assistants, or applications supported in DIAL, which means you can utilize this in complex Talk-To-Your-Data Workflows as well.

When combined with DIAL's collaborative tools like [Publications](../../tutorials/enable-publications), you can use Parameterized Replay to increase efficiency with just about any business flows!

Refer to [AI DIAL Chat user guide](../../user-guide#parameterized-replay) to learn more.

0 comments on commit 003375e

Please sign in to comment.