Chat User Guide

Introduction

DIAL Chat is a powerful enterprise-grade application that serves as a default web interface for DIAL users, providing access to the full set of DIAL features.

• Watch a demo video with introduction to DIAL Chat UI.
• Refer to Quick Start to learn how to launch DIAL Chat in a few clicks.

Additional Documentation

Refer to DIAL Chat repository to view the project source code and documentation for additional components:

• DIAL Chat documentation.
• DIAL Chat Theming documentation.
• Chat Overlay documentation.
• DIAL Chat Visualizer Connector documentation.

You can also refer to other topics in this documentation:

• Chat localization instruction.
• List of supported LLMs.
• Chat UI design guidelines.
• Authentication guidelines.

Standard Chat Interface Components

NOTE: this user guide covers the functionality of a standard DIAL Chat UI.

The DIAL Chat application user interface has several main sections:

1. Conversations: Here, you can access and manage your conversations. You can collapse and expand the panel by clicking the Hide panel icon above it.
2. Prompts: In this section, you can work with prompts: create new templates, update them, and organize them in folders. You can collapse and expand the panel by clicking the Hide panel icon above it.
3. Chat: Use this section to enter a prompt, view results, and interact with conversational agents.
4. User Settings: In your user settings, you can customize the color theme (dark or light), replace the standard logo and access other UI customization options.
5. Agents: you can view and change conversational agent before or during a conversation.
6. Conversation settings: By default, this section displays the last conversational agent used by the user. In this section, you can modify settings of the selected agent or change the agent.
7. DIAL Marketplace: Marketplace displays all conversational agents (applications and language models) available on your DIAL environment. In My workspace, you can gather conversational agents that you want to be at hand and add custom applications.

Custom UI

NOTE: this user guide covers the functionality of a standard DIAL Chat UI.

The standard DIAL Chat UI is designed to meet the needs of typical conversational applications. However, to accommodate the requirements of applications that exceed the standard chat UI functionality, new application types can be introduced to implement a fully custom UI (even not chat-like UI), which can completely replace the standard chat interface during interactions with a specific application.

Conversations

In DIAL, a conversation is a dialogue between a conversational agent, such as a language model or application, and a human user. The agent uses natural language to interact with a human and receive/give a feedback. Within one conversation, you can refer to previous questions and answers. But different conversations don't share context.

All your conversations are stored on the server, and you can access them from any device you use.

Agents

In DIAL Chat you can have a conversation with agents: language models and applications. You can access all the available agents in DIAL Marketplace and add them to My workspace. Refer to Conversational Agents to learn more about them.

Refer to Agentic Platform to learn more about agents.

To change agent

By default, the main window displays the last agent used by the user. You can proceed and have a dialog with this agent or change it before starting a conversation or switch to a different one during the conversation:

Before you begin a conversation, click Change agent to invoke the Select an agent for conversation window. Here, you can choose among the added agents or navigate to My workspace section.

In the middle of a conversation, you can view information about the current agent and change it by clicking the agent icon.

Conversation Settings

Note: The conversation settings can vary based on the agent selected. It's possible that some agents might not have any configurable settings.

In the Conversation Settings, you can access and modify the following components depending on the selected agent:

• System prompt
• Temperature

You can modify the conversation settings before or during the conversation:

Before you begin a new conversation, click Configure settings in the main chat area to invoke the Conversation settings window.

During the conversation, in the conversation header you can view and modify conversation settings by clicking the gear icon.

In the conversation header menu you also can:

• View and change the current agent: you can view information about the current agent and change it by clicking the agent icon. Refer to Agents to learn more.
• Access conversation action menu: click the three-dot menu icon to access the standard conversation actions menu.
• Clear conversation history: click the eraser icon to clear the conversation history and start from scratch.

System Prompt

Note, there are language models that do not support this feature. In such cases system prompt is disabled.

The system prompt in DIAL acts as the initial set of instructions provided to the model. It serves as a compass for the model, guiding it through the conversational landscape to ensure it remains on track and stays aligned with the intended purpose and desired outcome of the conversation.

Type / in the text box to select any previously created prompt as a system prompt (for details, refer to the Create in Prompts), and it will set the context and tone for the whole conversation.

Temperature

The temperature parameter controls the creativity and randomness of the model's output. A higher temperature (e.g., 1.0) makes the output more diverse and creative, while a lower temperature (e.g., 0.1) makes the output more focused and deterministic.

Adjusting the temperature allows you to balance creativity and consistency in the generated response.

Actions

Click a ... icon to open a conversation menu. There, you can view a list of all possible actions for the chosen conversation.

Note, that the available actions can vary depending on the selected conversation. For example, the Unpublish action will not be available if the conversation hasn't been published yet.

This is the list of all the supported actions:

• Select: use to select conversations you want to delete.
• Rename - use to rename a conversation.
• Compare: use to compare conversations with different settings.
• Duplicate: use to duplicate a shared conversation.
• Replay: use to reproduce conversations but with different settings.
• Playback: use to simulate the current conversation without any engagement with models.
• Export: use to export a conversation.
• Move to: use to relocate conversations.
• Share: use to share a conversation by providing a link or QR code.
• Remove access: use to remove access to a shared by you conversation for all users.
• Unshare: use to remove a shared with you conversation from the list.
• Publish: use to publish conversations.
• Unpublish: use to revoke public access from published conversations.
• Info: use to view metadata of a selected conversation.
• Delete: use to delete a single conversation.

Arrange

You can organize your conversations into folders. To create a new folder, simply click on the folder icon located in the bottom menu:

You can also create a new folder or move a conversation to the existing folder from the Move to context menu of the selected conversation. New folders will automatically be arranged in the Pinned conversations tab in the Conversations panel.

Hierarchy

You can create a hierarchy of folders with three nesting levels. Just create a folder and drag-n-drop it in the other folder to create a nesting level. The same way, you can either drag-n-drop a conversation into a folder or use Move to in the context menu of a conversation to move it to a parent folder.

Note: empty folders are deleted after refreshing the page.

Naming conventions

The following symbols in the folders names are prohibited: tab, ", :, ;, /, \, ,, =, {, }, %, & and will be excluded. Note that you can use the . symbol at the start or inside a name, but the dot at the end will be automatically removed.

The MAX length of the folder name is limited to 160 symbols. Everything beyond is cut off.

Search and Filter

Use the Search box to search conversations by their names. If you have any shared conversations, you can apply Shared by me filter to sort them out.

Create

There are several ways to initiate a dialog with a conversational agent:

• To communicate with the current conversational agent (by default, the last one used by the user), simply begin typing in the text box located in the chat area.
• In My Workspace or Marketplace, select an agent and click Use ... button to initiate a conversation. Refer to Converse to learn more.
• On the main chat screen, click the Plus icon to select agent and start a conversation.
• Applications can include starter buttons. You can use them to select a starting prompt for a new conversation. Refer to Custom Buttons in Apps to see tutorials for developers on how to include custom buttons in applications.

Please be aware that new conversations will show up in the conversations panel located to the left of the main chat area. However, if you start a conversation and close it while it is still empty, it will neither be displayed on the panel nor saved in your conversations.

Rename

When you create a new conversation, it is automatically named after the first line in your first prompt. For instance, if your prompt consists of several sentences divided by a tab, the first sentence will be used as the conversation's name. Moreover, the MAX length of the conversation name is limited to 160 symbols. Everything beyond is cut off. After a conversation is created, you can rename it.

To rename a conversation

1. Click Rename in the context menu of the selected conversation.
2. Enter a new name and submit.

Naming conventions

The following symbols in the conversation names are prohibited: tab, ", :, ;, /, \, ,, =, {, }, %, & and will be excluded. Note that you can use the . symbol at the start or inside a name, but the dot at the end will be automatically removed.

Share

You can share a conversation or a folder with several conversations with other users. You can also receive a shared conversation.

Important: When a conversation is shared, all its attachments are shared as well and become available in the Attachments Manager.

Watch Collaboration demo video to learn more about sharing and other collaboration features in DIAL.

To receive a shared conversation

If a conversation has been shared with you, it can be located in the Shared with me section in the left panel.

Important: you cannot change a conversation that has been shared with you. To be able to work with it, duplicate it.

To share a conversation

Note: You can share entire folders with conversations. When you share a folder, all its folders and attachments will be shared as well.

If you want to share a conversation or a folder, click on Share in the contextual menu and send the link (or the QR code) to the intended recipient.

After the recipient has opened your link, the arrow icon appears near its name. Note, it may be required to reload the page to update the status of the shared conversation.

To filter and view only the conversations that you have shared, click on the Shared by me checkbox in the filter:

Remove access

To revoke access from all users you have shared with, click Share in the contextual menu and then click Remove access for all users.

Unshare

In the Shared with me section, you can find all conversations that were shared with you. Use Unshare in the conversations actions menu to remove selected conversations from this list.

Duplicate

Duplicate a shared with you conversation to be able to change it. To duplicate a conversation, click Duplicate in the contextual menu.

This feature is available only for conversations shared with you.

Export

You can export conversations. If a conversation includes attachments, you can export it with or without attachments.

You can also export all your conversations at once without attachments in a JSON format.

Exported conversations are named by the following pattern: prefix "epam_ai_dial_chat", then "with_attachments" if the conversation was exported with attachments, then "month_day". However, the naming convention is configurable in the chat config.

Export a single conversation with attachments

1. On the left panel, in the conversation contextual menu, point to Export.
2. Click With attachments.

The conversation will be exported as a ZIP archive. Please note that the name of the ZIP archive follows the format file_name.dial. You can manage it just like a normal ZIP archive.

Export a single conversation without attachments

1. On the left panel, in the conversation contextual menu, point to Export.
2. Click Without attachments.

The conversation will be exported as a JSON file.

Export all conversations

To export all conversations, at the bottom of the left panel, click the Export conversations icon.

Conversations will be exported without attachments.

Import

Exported conversations can be imported.

To import a JSON file with a conversation or a ZIP archive with several conversations (may include attachments as well), click the Import conversations icon at the bottom of the left panel and then select a file with conversations.

When you import a conversation with attachments, the attachments will be available in the parent of the root folder in the Attachments Manager.

When importing a duplicate of an existing conversation, you will be prompted to select one of the proceeding options for both the conversation and each of the attachments:

• Replace - replace the original conversation/attachment
• Ignore - do nothing
• Postfix - add a postfix to the imported conversation/attachment. For example: my-conversation 1 , where 1 is added postfix to the name of the duplicated imported conversation.

Info

Click Info in the conversation menu to view the conversation metadata: the date it was updated and the creation date.

Delete

You can delete a single conversation, selected conversations or all conversations.

• To delete a single conversation, on the left panel, in the conversation contextual menu, select Delete and confirm your action.
• To delete all conversations, at the bottom of the left panel, click the Delete all conversations icon.

Select to Delete

Also, you can use a selection mode to choose conversation(s) you want to delete:

• Click Select all button in the bottom panel. When you do this, all conversations get preselected and you can unselect the ones you want to keep. You can also click Unselect all in the bottom panel to clear the selection.

• Click Select in the conversation menu to enter into a selection mode. In this mode, you can hover over any conversation and use checkboxes to select/unselect conversations you want to delete. You can also click Unselect all in the bottom panel to clear the selection.

Replay

You can use Replay to reproduce conversations but with different settings (e.g. a different model). A replayed conversation can be used to compare responses to the same questions from different models and with different settings of the conversation.

Use Replay as is to reproduce the conversation with the original settings. You can find Replay as is if you click Change agent or an agent icon in the conversation header menu.

To replay a conversation

1. Click Replay in the conversation menu.
2. Click Start replay.
3. In the process of replaying, you can stop and resume the replay process using controls in the text box Stop generating and Continue replay respectively.

The replayed conversation is displayed as a new conversation with the [Replay] tag in the list of your conversations.

Parameterized Replay

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.

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 with 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 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 in your conversation's menu to repeat this dialogue but with different input parameters.
5. You can 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.

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

   

2. In the Message template window, you can substitute sections of your original message with 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.

   

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

   

3. Once you click save, you can return to your conversation. In the conversation menu, select 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 (you can find it if you click Change agent), or you can alter the settings of the conversation to experiment with different models and parameters.

4. You can 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

The Playback mode can be used to simulate the current conversation without any engagement with models. This mode accurately reproduces the conversation like a recording. Note, that this differs from the Replay mode, where the prompts are resubmitted to the chosen model and the outcomes may differ from the initial conversation.

During playback, you have the ability to rewind, fast forward, or halt the process.

Compare

Use the Compare mode to compare two new (or two existing) conversations with different setting (e.g. different models or temperature).

To compare two NEW conversations

1. Click the Compare icon in the menu at the bottom of the left panel.
2. Define settings for both conversations. To do that, click Configure settings for any conversation to open a dialog window.
3. Type your question (prompt) in the chat box to begin.

Once you initiate a conversation in this mode, the system creates two new conversations with the same name but adds numbers to them. If you have chosen different language models, the conversations icons will differ accordingly.

To compare two EXISTING conversations

Important: this Compare mode works only with conversations with the same amount of prompts from a user. The application will not allow comparing two conversations with different amounts of prompts.

1. On the left panel, in the conversation menu of a conversation, select Compare.
2. In the main section, under Select conversation to compare with, select the second conversation from the drop box.
3. By default, only conversations with the same name are available in the drop box. Select Show all conversations to see the full list of conversations.
4. Type your question (prompt) in the chat box.

Publish

You can publish conversations to make them available for the target audience. Refer to Publications section of this guide to learn more about publications.

Note: to publish a shared conversation, duplicate it and then publish.

Watch Publications demo video to learn more about collaboration features in DIAL.

To publish a conversation

1. Click Publish in the conversation menu.

2. In the pop-up window:

   • Enter publication request name in the upper area.
   • In Publish to, you can select the target destination. You can also create a dedicated folder to publish your conversation into.
   • Enter the name of the author of the publication request.
   • In Allow access.., specify access rules and the target audience. For example Role-Equals-Admin. Note: the available roles are configured for each organization individually. Contact your support to find out the rules are applicable in your organization.
   • In Conversations, you can choose what conversations you want to publish (if you have selected a folder with several conversations). If conversations include attachments, you can also select them in the Files section.
   • Assign a version to your request.
   • Click Send request to send your publish request to the administrator.

3. When your request is approved, the published conversation or a folder with conversation(s) will become available in the Organization tab.

Versioning

When you make a publication request, it is required to assign it a unique version number. A version must follow format: 0.0.0. With each request you must provide a new version - the system will not accept two identical versions.

Versioning helps you create specific publications for different groups of people, run experiments, and keep track of your conversations easily.

You can add a version of your publication request next to the conversation check box:

If you try to publish this conversation again, you will be able to view the last version or a drop-down with versions:

When you open a published conversation, you can view and switch between its versions in the conversation settings:

Unpublish

You can unpublish conversations to withdraw them from public use.

To unpublish a conversation

1. Click Unpublish in the conversation menu.

   

2. In the pop-up window:

   • Enter unpublish request name in the upper area.
   • In Conversations, if you have selected a folder, you can choose what conversations you want to unpublish. If conversation(s) include attachment(s), you can also select them in the Files section.
   • Click Send request to send your unpublish request to the administrator.

   

3. When your request is approved by the administrator, the unpublished conversation or a folder with conversation(s) will become unavailable in the Organization tab.

Prompts

A prompt is an instruction, a question, or a message that a user provides to a language model to receive an answer. Prompts can also contain constraints or requirements. They help the model understand the task at hand and the types of responses that are expected. You can use prompts as templates for your messages, instructions to the model, or to encourage the model to generate specific types of content. In DIAL, you can create prompts beforehand and reuse them in one or several conversations.

Prompts can be applied to one message or a whole conversation. Refer to the System prompt section of this guide for details.

The section with your prompts is located in the right-hand area of the screen. In this section, you can work with saved prompts: create new templates, update them, and organize them with folders.

All your prompts are stored on the server, and you can access them from any device you use.

Actions

Click a ... icon to open a prompt menu. There, you can find a list of all the available actions for the selected prompt.

This is the list of all the supported actions. Please note that the available actions can differ depending on the selected prompt. For instance, the Unpublish action won't be available if the prompt hasn't been published yet.

• Use: click to populate the selected prompt in the chat box.
• View: click to view the details of the selected prompt.
• Select: use to select prompts you want to delete.
• Edit: use to edit prompts.
• Duplicate: use to duplicate a shared prompt.
• Export: use to export prompts in JSON format.
• Import: use to import prompts in JSON format.
• Move to: use to organize a prompts in folders.
• Share: use to share a prompt or a folder with several prompts with other users.
• Unshare: use to remove a shared with you prompt from the list.
• Remove access: use to remove access to a shared by you prompt for all users.
• Publish: use to publish prompts within the organization.
• Unpublish: use to withdraw prompts from public use.
• Info: use to view the prompt metadata.
• Delete: you can delete a single prompt, all prompts or selected prompts.

Arrange

You can organize your prompts in folders. To create a new folder, click on the folder icon in the bottom menu:

You can also create a new folder or move a prompt to the existing folder from the Move to context menu of the selected prompt:

New folders will automatically be arranged in the Pinned prompts tab in the Prompts panel.

Hierarchy

You can create a hierarchy of folders with three nesting levels. Just create a folder and drag-n-drop it in the other folder to create a nesting level. The same way, you can either drag-n-drop a prompt into a folder or use Move to in the context menu of a prompt to move it to a parent folder.

Note: empty folders are deleted after refreshing the page.

Naming conventions

The following symbols in the folders names are prohibited: tab, ", :, ;, /, \, ,, =, {, }, %, & and will be excluded. Note that you can use the . symbol at the start or inside a name, but the dot at the end will be automatically removed.

The MAX length of the folder name is limited to 160 symbols. Everything beyond is cut off.

Search and Filter

Use the Search box to search prompts by their names. If you have any shared prompts, you can apply Shared by me filter to sort them out.

Use

Click Use in the prompt menu to populate the selected prompt in the chat box or open a pop-up window where you can enter values for prompt variables.

Refer to Chat to learn more.

View

Click View in the prompt menu to preview the selected prompt. In the View prompt window, you can perform various actions and proceed to use the prompt.

Create

To create a new prompt

1. On the right panel, select New prompt.
2. Fill in the Name, Description, and Prompt boxes. The following symbols in the prompt names are prohibited: tab, :, ;, /, \, ,, =, {, }, %, &. Note that you can use the . symbol at the start or inside a name, but the dot at the end will be automatically removed. The MAX length of the prompt name is limited to 160 symbols. Everything beyond is cut off.
3. Click Save.

While both the Name and Description fields are required to create a prompt, they do not serve as instructions for the language model. They simply help you differentiate this prompt from others. The language model will only utilize instructions from the Prompt box.

Variables

You can use prompts as templates for your instructions to a language model. You can also add variables in your prompts. Use notation such as {{variableName}} or {{variableName|Default Value}} to add variables.

Refer to Parameterized Replay to view a use case when prompts are used to create parametrized conversations.

For example, you need to calculate an equation a + b/c, round up the answer, and then divide it by 4.

Create the following prompt:

{{a}}+{{b}}/{{c}}=

Round up the answer to three digits and divide by four

Here, a, b, and c are variables. In the prompt body, they are denoted by double curly brackets: {{ }}.

You can combine mathematical expressions and natural language in your prompts.

After you have created the prompt, you can use it by typing a slash / in the chat box and selecting the name of a prompt (it is Math in our example). You’ll see the following form where you can enter any numbers:

When you submit the form, your message will look like on the illustration below:

Generally, variables can be anything, not only numbers. For example, you can create a prompt with the following body: Who played {{character}} in {{movie}}? or What is a Latin name of {{plant common name}}?

Info

Click Info in the prompt menu to view the prompt metadata: the date it was updated and the creation date.

Delete

You can delete a single prompt, selected prompts or all prompts.

• To delete a single prompt, in the menu of each prompt, select Delete and confirm your action.
• To delete all prompts, at the bottom of the right panel, click the Delete all prompts icon.

Select to Delete

Also, you can use a selection mode to choose prompt(s) you want to delete:

Click Select all button in the bottom panel. In this case, all prompts are preselected and you can unselect the ones you want to keep. You can also click Unselect all in the bottom panel to clear the selection.

Click Select in the prompts menu. In this case, you can hover over any prompt and use checkboxes to select/unselect prompts you want to delete. You can also click Unselect all in the bottom panel to clear the selection.

Share

You can share a prompt or a folder with several prompts with other users.

Watch Collaboration demo video to learn more about sharing and other collaboration features in DIAL.

To receive a shared prompt

To obtain a prompt from someone else (receive a shared prompt), you must get a link or a QR code from them. By following the shared link or scanning a QR code, you will import the prompt into your chat.

When someone shares a prompt with you, you can find it in the Shared with me section on the right panel. Important: you cannot change a prompt that has been shared with you. To be able to work with it, duplicate it. When you receive a shared prompt, a pop-up window opens up, where you can preview a prompt and duplicate it if needed.

You can always view prompts that have been shared with you in the Shared with me section and perform various actions on them such as:

• View: opens a pop-up window with a prompt preview.
• Duplicate: use to duplicate a shared with you prompt to be able to modify it.
• Unshare: remove from the list.
• Export: download in a JSON format.

To share a prompt

If you want to share a prompt or a folder, click on Share in the contextual menu, copy the link or the QR code and pass it to the recipient. All shared prompts can then be located by selecting the Shared by me checkbox in the filter.

Once the recipient opens your link, an arrow icon will appear next to its name.

When you share a folder, all folders and prompts in this folders will be shared.

Remove access

If you want to remove access to a prompt that you have shared, select Share in the prompt's context menu and click Remove access for all users.

Unshare

To remove a shared with prompt from the Shared with me section, click Unshare in the contextual menu and then confirm actions in the dialog window.

Duplicate

You can duplicate a prompt to be able to change a prompt that was shared with you. To duplicate a prompt, click Duplicate in the contextual menu.

You can duplicate only prompt shared with you.

Export Import

You can export and import prompts.

To export a single prompt

Select Export in the prompt's menu. The prompt will be exported as a JSON file.

To export all prompts

Click Export prompts at the bottom of the right panel. All your prompts will be exported as a JSON file.

To import prompts

Click Import prompts at the bottom of the right panel. Only valid JSON files can be imported.

When importing a duplicate of an existing prompt, you will be asked to select one of the proceeding options:

• Replace - replace the original prompt
• Ignore - do nothing
• Postfix - add a postfix to the imported prompt. For example: my-prompt 1 , where 1 is added postfix to the name of the duplicated imported prompt.

Publish

You can publish prompts to make them available for the target audience. Refer to Publications section of this guide to learn more about publications.

Note: to publish a shared prompt, duplicate it and then publish.

Watch Publications demo video to learn more about collaboration features in DIAL.

To publish a prompt

1. Click Publish in the prompt's menu.

   

2. In the pop-up window:

   • Enter publication request name in the upper area.
   • In Publish to, select the target destination or a folder to publish your prompt into.
   • Enter the name of the author of the publication request.
   • In Allow access..., specify access rules and the target audience. For example Role-Equals-Admin. Note: the available roles are defined in each organization individually. Contact your support to find out the rules are applicable in your organization.
   • In Prompts, if you have selected a folder, you can choose what prompts you want to publish.
   • Assign a version to your publication request.
   • Click Send request to send your publication request to the administrator.

   

3. When your request is approved by the administrator, the published prompt or a folder with prompt(s) will become available in the Organization tab.

   

Versioning

When you make a publication request, it is required to assign it a unique version number. A version must follow format: 0.0.0. With each request you must provide a new version - the system will not accept two identical versions.

Versioning helps you create specific publications for different groups of people, run experiments, and keep track of your prompts easily.

You can add a version of your publication request next to the prompt check box:

If you try to publish this prompt again, you will be able to view the last version or a drop-down with versions:

Unpublish

You can unpublish prompts to withdraw them from the public use.

To unpublish a prompt

1. Click Unpublish in the prompt's menu.

   

2. In the pop-up window:

   • Enter unpublish request name in the upper area.
   • In Prompts, if you have selected a folder, you can choose what prompts you want to unpublish.
   • Click Send request to send your unpublish request to the administrator.

   

3. When your request is approved by the administrator, the unpublished prompt or a folder with prompt(s) will become unavailable in the Organization tab.

Chat

The chat occupies the central part of the main screen, allowing you to input messages, see replies, and execute various supported tasks based on the application and chat settings.

Actions

During a conversation, you can perform various actions:

Entering messages

You can enter your prompts in the text box at the bottom and generate answers by pressing Enter on your keyboard or clicking the Send button.

You can enter a prompt manually or select one of existing prompts.

Enter / in the chat text box to select one of the available prompts. You can also click Use in the prompt's menu to populate it in the text box or invoke a pop-up window where you can enter prompt variables.

Copying responses

You can copy answers to reuse them some place else.

Stop and Regenerate

In the process of generating the response, you can stop it by clicking a Stop icon in the text box.

When the response generation has been stopped, you can regenerate it. Important: If you encounter a server error or click the Stop Generating button and receive an empty response, the Send button will be disabled. To continue the conversation, you'll need to generate the answer again. If you receive a partial response (a combination of text and an error), the model can still proceed, while for Assistants/Applications, you'll need to generate the response again.

Working with prompts

During a conversation, you can work with prompts in the conversation.

• Edit: You can edit an existing prompt in the ongoing conversation. When editing, you can also edit the attached files if needed using drag-and-drop, CTRL+V or by selecting files in the Attachments Manager. After a prompt has been edited, the response is regenerated, and all your prompts after the edited one will be deleted.

  

• Delete: You can delete an existing prompt in the ongoing conversation. When you delete your prompt, the response will be deleted, too.

• Set message template: Use it to create a parametrized conversation using any message in your conversation as a template.

Working with attachments in responses

If in the response you have received an attachment, you can click the Download icon near the file name to download it or an Expand to preview.

Attach files to requests

Some models and applications (e.g. DIAL RAG) support adding attachments (files, links, folders) to conversations. In this case, you'll see the Attachments icon available in the chat box. Click it to upload a file from your device or select an already uploaded file. You can also drag-and-drop files or use CTRL+V.

Refer to the Manage attachments section for details.

Like/Dislike

You can like and dislike responses in a conversation. Use likes to highlight important responses and dislikes to mark the responses you don't find helpful or that are incorrect.

View and change current conversation settings

On the top bar you can view and manage agent and conversation settings.

Refer to Conversation Settings to learn more.

Isolated View Mode

In the Isolated View Mode, you can access the DIAL Chat in a simplified view mode with the predefined conversational agent. To access this mode, follow a specific URL https://server/models/modelID or https://server/models/applicationID. Conversation and prompt panels are not shown in this mode. All conversations that are created in this mode, will also be displayed in the standard chat view mode.

For instance, to open chat with GPT-4 model, go to https://DIAL Chat URL/models/gpt-4 and access a streamlined user interface that only contains a chat input with GPT-4:

Although this mode offers a simplified view, you can access Conversation settings the usual way.

User Settings

In the user area on the top bar, you can click the down arrow to access additional settings or to log out. Here you can choose the chat theme (dark or light), change the logo, and switch to full-width chat mode.

Attachments

DIAL applications (e.g. DIAL RAG) can support attaching files, links or folders to a conversation and generate responses considering the attached resources.

Folders

If the selected application supports this, you can click the attachment icon in the conversation box and select Attach folders.

Note, that you can attach only folders from the Attachments Manager and cannot upload folders from an external source.

In the pop-up window, select a checkbox for the folder you want to add to add it. The attached folder will appear in the conversation box and become available for the application to work with.

Links

If the selected application supports this, you can attach a link to a conversation to use it to generate responses:

1. Click the attachment icon in the conversation box and select Attach link.

   

2. Specify a valid URL and click Attach. The link will be displayed as attachment in the conversation box and become available for the application to work with.

   

Files

If the selected agent supports this, you can click the attachment icon in the conversation box and select Attach uploaded files or Upload from device. You can also drag-and-drop files or use CTRL+V to paste files into the conversation box.

• Attach uploaded files: If you have already uploaded the necessary files, you can select them in the attachments manager.
• Upload from device: Select files you want to upload. Uploaded files you will be able to find in the attachments manager.

The file(s) will be displayed as attachment(s) in the conversation box and become available for the application to work with.

Attachments Manager

Files that have been attached, uploaded, published or shared are available in the attachments manager. To manage attachments, click the Attachments icon at the bottom of the left panel.

In the Attachments Manager, resources are split into three sections:

• Organization - published files and/or files of published applications.
• Shared with me - shared files and/or files of shared applications.
• All files - files that you have uploaded or attached to conversations.

To create a folder

You can create folders and then upload files into them. Note, the only way to add a file into a folder is to upload it - you cannot move files between folders.

DIAL applications can be configured to allow attaching entire folders to conversations. In this case, only folders created in the attachments manager can be attached to a conversation.

1. Click a folder icon to create a new folder.
2. Give your folder a name.
3. Click submit to apply.

You can as well perform several actions on your folders:

• Rename
• Upload files
• Add subfolders

To upload a file

To add a file into a folder it is necessary to upload it.

1. In the Manage attachments dialog window, select Upload from device.
2. Select one or several files you want to upload and click Open.
3. Under Upload to, select Change to pick a folder, in which the files will be uploaded.
4. Under Files, change their names or delete them, if necessary. The following symbols in the file names are prohibited: tab, ", :, ;, /, \, ,, =, {, }, %, &. Note that you can use the . symbol at the start or inside a name, but the dot at the end will be automatically removed.
5. Click Upload and attach files.

To unshare a file

In the Shared with me section, you can find all files attached to shared with you conversations or shared together with applications.

To remove a file form this list, click Unshare in the file menu.

You can also unshare folders with source files of the shared with you applications.

To delete a file

You can delete files that you have personally attached or uploaded.

If an application was shared with you with editing rights, you can delete its files. For example, if a Code App was shared with you with the rights to edit its source files, you can open the folder containing them in the Attachments Manager/Shared with me and delete these files.

Please note that you cannot delete shared files without explicit permission to do so.

To download attachments

Click a folder to expand it.

1. In the Manage attachments dialog, point to a file and select it. You can select several files.
2. Click the Download icon below the files tree.

To delete attachments

You won't be able to preview or download a deleted file in a conversation, but you still will see its name.

1. In the Manage attachments dialog, point to a file and select it. You can select several files.
2. Click the Delete icon below the files tree.

Publications

You can publish/unpublish your applications, conversations and prompts, or even a collection of those, making them accessible within your organization and on DIAL Marketplace. Additionally, you can manage access to the published resources, ensuring that the right information is accessible to the right individuals or teams.

• Watch Publications demo video to learn more about publication and collaboration features in DIAL.
• Refer to Collaboration to learn more about collaboration features in DIAL.
• Refer to Tutorials for DevOps to learn how to enable publications in DIAL.

Flow

This is the high level overview of the publication workflow:

1. A chat user sends a publication request for the selected resource(s) (conversation, prompt, application).
2. An admin receives the publication request, reviews it and either approves or declines. Refer to Process Publish Requests to learn more.
3. In case the publication request has been approved, the published resources (conversations and prompts) become available for the target audience in the Organization section in the chat application. Published applications can be found in DIAL Marketplace. If the published conversation or application includes attachments or other resources (e.g. Quick apps can include documents for RAG), they will be available in the Attachments Manager under the Organization section.
4. Resource owner can unpublish the published resource.

Refer to Conversations, Prompts and Publish App to view step-by-step instructions.

Administrators

Administrators are chat users that can perform additional actions. Chat interface for administrators includes extra components (for example the Approve required tab in conversations and prompts sections)

Process Publish Requests

Users with the admin role have access to the Approve required tab in conversations and prompts sections, where they can view all publish and unpublish requests from users.

Note, publication requests for applications appear in the Prompts section.

The counter shows the number of requests to be reviewed. Each such request has a color dot attached to it. The refresh of a browser updates this information.

To review:

1. Click on any conversation or prompt request to open the review window.
2. In the review window, you can preview the details of the request and download attached files, if present. Note, that a request can include both publish and unpublish requests. The latter is highlighted in red color in the list of conversations or prompts. Such mixed requests can be currently realized exclusively using DIAL API.
3. If Go to a review... is displayed, click it to review conversation(s) or prompt(s) in the request. For the unfinished review, this button changes to Continue review.... Note, you cannot approve the request which has not been reviewed in full.

4. In the review mode, you can use arrows to navigate between conversations/prompts and click Back to publication request when finished reviewing.

5. Once the review is completed, the Approve button is enabled. Note, you can approve or reject only the entire request.

Deploy and Undeploy Code Apps

In the DIAL Marketplace, administrators can deploy and undeploy Code Apps of different users.

1. Go to DIAL Marketplace and apply filter by Applications. Deployed Code Apps have a green status icon.
2. Click the app you want to undeploy/deploy. Refer to Launch Code App to learn more.

Data Visualization

DIAL Chat enables data visualization for specific data types using data visualizers. It comes with built-in support for the Plotly data visualizer. To link any other custom visualizers, you can use the DIAL Chat Visualizer Connector library.

Refer to Data Visualization to learn more about visualizing data in chat and custom visualization apps.

Plotly

Plotly is an open-source JavaScript library that enables the creation of diverse data visualizations, including charts, 3D graphs, and more.

• Refer to Plotly to learn more.
• Watch Animated Scatterplot demo video to see how statistical data can be visualized in DIAL Chat using a Plotly animated scatterplot.
• Watch Omics AI Assistant demo video to see how protein structures can be visualized with Plotly.

DIAL Chat integrates with Plotly, offering robust data visualization capabilities. To utilize Plotly, choose an DIAL application that supports this feature. These applications must be capable of querying data (either from a URL or directly from the Chat application) based on user input and returning it in a format compatible with Plotly. Chat automatically detects attachments in this format and uses Plotly to visualize the data.

The visualizations come with standard Plotly controls for easy manipulation.

Refer to Plotly GitHub to learn more.

Conversational Agents

In DIAL Chat, you can have a dialog with agents: language models and applications.

Language Models

Available Models

In the DIAL Marketplace section, you can view all language models available on your DIAL environment. There, you can select models to add them to My workspace.

Refer to Supported Models to view all the models supported in DIAL.

To talk to a model

1. In the DIAL Marketplace section, you can view all models available in your DIAL environment. There, you can select models and add them to My workspace. To display models, select only Models in the Types filter.
2. Click any of the available models in Marketplace or My workspace to select it.
3. Click Use model to navigate back to the main screen with this model pre-selected for a conversation.

Refer to Agents to learn how to change conversational agents prior or during a conversation.

Applications

In the DIAL Marketplace section, you can view all applications available in your DIAL environment. There, you can select applications and add them to My workspace.

Refer to DIAL-Native Apps to see a more in-depth information about applications and application types.

In DIAL Marketplace, you can not only access and use applications, but also add your own applications of specific types.

Refer to App Builder to learn more.

To talk to an application

DIAL Chat users can engage with applications via standard or fully customized interfaces.

1. In the DIAL Marketplace section, you can view all applications available in your DIAL environment. There, you can select applications and add them to My workspace. To display applications, select only Applications in the Types filter.
2. Click any of the available applications in Marketplace or My workspace to select it.
3. Click Use application to navigate back to the main screen with this application pre-selected for a conversation. In case the app you have selected uses a non-standard UI, it will be opened instead of the standard Chat UI.

Refer to Agents to learn how to change conversational agents prior or during a conversation.

Application Types

DIAL functions as an application server offering tools to develop, deploy, host and manage different types of GenAI applications. It supports GenAI applications developed on the DIAL platform as well as non-conversational apps created with other technologies, including any LLM framework, LlamaIndex, LangChain, Semantic Kernel, vector databases, and more.

Conversational applications that follow the DIAL Unified protocol are known as DIAL-native apps. The standard DIAL Chat UI is designed to meet the needs of these apps. However, your DIAL environment can also include non-conversational apps that use custom UIs, which override the standard DIAL Chat UI. Such cases are not covered in this user guide.

Refer to DIAL-Native Apps to see a more in-depth information about applications and application types.

☁️ DIAL SaaS version includes several predefined application types: Quick Apps, Code Apps and Mind Maps. Application types serve as templates for creating applications of predefined types. Application types included in SaaS edition, also provide low and no-code Application Wizards for end users to be able to create applications

💾 Self-hosted DIAL setups can include custom application types with fully custom UIs overriding the standard DIAL Chat UI and custom UIs for application wizards. Custom UIs are out of scope of this user guide.

Quick Apps

Quick apps are code-less and conceptually similar to OpenAI's GPTs. They can include tools to perform different tasks: communicate with external services, use web resources, use other apps and models deployed in DIAL as tools and implement RAG functionality.

Quick Apps can be used to simplify a workflow or carry out a specific task. For example, you can create an app with a toolset allowing it to call an external API to get a real-time weather forecast for a specific location. Another example is a RAG-like application that can generate responses based on predefined sources.

• Watch a Demo Video with an introduction to Quick Apps.
• Refer to My workspace to learn how to add Quick Apps using UI wizard.
• Refer to Quick App Configuration Guide to see configuration and deployment guidelines for developers and DevOps.

Code Apps

DIAL Code Apps allow you to develop, deploy and run your Python applications directly in the DIAL UI. It is a useful tool if you need to quickly create an application for the POC, deploy it and share with the selected audience.

In DIAL Chat Application Builder for Code apps you can:

• Create and customize Code Apps using the built-in Python code editor directly in DIAL Chat.
• Deploy Code Apps without worrying about hosting or scalability.
• Implement essential endpoints for DIAL compatibility.
• Manage environment variables.
• Edit and publish Code Apps.

Limitations and security restrictions:

• Code Apps are deployed and maintained exclusively by DIAL platform, similarly, to handling lambda function by cloud providers.
• Code Apps do not have access to internet.
• Code Apps do not have state outside of DIAL APIs.
• You can use only Python libraries, databases, and models that are supported by DIAL.
• Code Apps cannot call each other or any external endpoints with the exception of DIAL Core, if it is allowed.
• All traffic is encrypted, and Code Apps are run in an isolated network.

• Watch a Demo Video with an introduction to Code Apps.
• Refer to My workspace to learn how to add Code Apps.

Mind Maps

Mind Map enables users to access information through an interactive knowledge graph and natural language. The application pulls data from various sources, including documents, URLs, and other data inputs and then presents it on UI as a interactive knowledge graph, facilitating intuitive and engaging user interactions with information.

• Watch demo video to see the DIAL Mind Map Studio in action.
• Refer to Add Mind Map to learn how to add a Mind Map application using a UI wizard.

Marketplace

Overview

Watch Marketplace demo video to see it in action.

In DIAL Marketplace you can find all applications and language models available on your DIAL environment.

Navigation

You can navigate to this section form the main chat screen:

In DIAL Marketplace, there are two sections:

• DIAL Marketplace: the main screen of DIAL Marketplace which includes all conversational agents available on your DIAL environment.
• My workspace: this screen includes all conversational agents that you have selected in DIAL Marketplace. In this section, you can also add and manage your custom applications.

From both marketplace and workspace you can click Back to Chat to navigate to the main chat screen.

Filters & Views

• Use the Type filters to display any or all conversational agents. Note, that all agents are displayed by default - use the Type filter to narrow down the scope of the displayed agents.
• A conversational agent can be associated with a specific topic describing the area of its application. Use the Topics filter to refine the output by specific topics.
• Use the Source filter to apply additional filtering criteria related to the source of conversational agents (e.g. you can filter just the apps shared with you).
• The Search allows you to swiftly locate any item by its name.
• Use view toggle to switch between the table and the card view.

DIAL Marketplace

Click DIAL Marketplace to navigate to the home page of DIAL Marketplace where you can find all applications and language models available on your DIAL environment. Here, you can also find all applications published in your organization.

Add to My workspace

In the DIAL Marketplace main screen, you can view details of any conversational agent and add it to My workspace.

To simply add/remove an item to/from My workspace, click Add/Remove to/from My workspace label:

You can also add a conversational agent to My workspace by initiating a conversation with it. For example, to add a model:

1. In the DIAL Marketplace section, you can view all the models available on your DIAL environment. There, you can select models to add them to My workspace.
2. To display models, select just Models in Types.
3. To select a model, click any of the available models in Marketplace or My workspace, click Use model to navigate back to the main screen with this model pre-selected for conversation.

Refer to Agents to learn how to change conversational agents prior or during a conversation.

Please note, that if you start a conversation and then remove the associated item from My workspace, you will need to reinstate the item to continue the conversation. A button will appear in place of the chat text box. Simply click this button to return the item to My workspace and resume the conversation.

My workspace

In My workspace, you can access and manage all conversational agents that you have created or added in DIAL Marketplace. Here you can also access UI wizards to add applications of available types.

Refer to Enable Apps to see tutorials for developers on how to enable applications using DIAL API and DIAL Core configuration.

Converse

In My workspace, you can select which conversational agent you want to have a dialog with.

1. In My workspace, click any conversational agent.
2. Click Use.. to start a new conversation with the selected agent.

Refer to Agents to learn how to change conversational agents prior or during a conversation.

Edit App

Use Edit in the app's menu to modify your apps.

Note: you can edit only your own apps. To Edit a Code App, undeploy it first.

To edit application

1. Click Edit to invoke the Edit app/Edit quick app/Edit quick app
2. Make changes and click Save

Share App

Applications (or their versions) can be shared with other users by sending a sharing link. In this section, you can learn about:

• Sharing
• Unsharing
• Removing access
• Editing rights

To share app

Use Share to grant other users rights to use your application. You can repeat the procedure described in this section more than once to share with different users.

Note, that you can share only your own applications. You cannot share an application that has been shared with you.

1. In My workspace, in the application menu, click Share.

2. If necessary, you can select a specific version of the application you want to share.
3. In the pop-up dialog window, select whether you want to give editing rights with the sharing link. Important: if you grant editing rights to your app, make sure you are familiar with the main principles outlined in this documentation.
4. Confirm the action in the dialog window.
5. Provide the sharing link (or a QR code) to the user with whom you want to share your app.

A shared application (or its version if only a specific version has been shared) is labeled with the blue arrow:

Access to application files

Applications can rely on resources like documents and files to operate. When the application is shared, the resources it includes are shared as well. You can see files that have been shared along with applications in the Attachments Manager under the "Shared with me" section. You can Unshare shared files to remove them from this list.

If an application was shared with you with editing rights (e.g., a Code App with its source code files), you can access its files in the Attachments Manager under the "Shared with me" section. With editing rights, you can delete specific source files via the actions menu.

Refer to Access to Application Files to see a more in-depth and technical description of a logic that handles access to files of shared applications.

Sharing with editing rights

The key distinction between sharing and publishing is that sharing allows you to grant not only the rights to use but also editing access to your application.

Important: when an application (or its specific version) is shared, any updates made to the app become immediately available to the users with whom the application has been shared, but it's important to note that conflict resolution for simultaneous edits by multiple users is not supported, so the changes submitted first will be applied to the shared application for all users immediately.

Applications shared with and without editing rights have different scope of actions available for the target user:

To remove access

Note: a shared application is revoked from the shared usage when the apps's name or version is modified by the application owner.

You can revoke access for all users with whom you have shared the application.

1. Select the shared application for which you want to revoke access. You can identify the shared apps by the blue arrow pinned to the icon of the shared application.
2. Click Share in the applications menu.
3. In the open dialog window, click Remove access for all users and confirm the action in the pop-up window.

To unshare app

Use Unshare to remove the shared with you application from your workspace.

TIP: To quickly find all apps that have been shared with you, use the Source filter in My workspace.

1. In the shared application's menu, click Unshare.
2. Confirm the action in the dialog window.

Publish App

You can publish your applications to make them accessible to the selected audience in your organization. Refer to Publications to learn more about this functionality and to DevOps Tutorials to learn how to enable publications in DIAL.

Note: all published applications within your organization will appear in DIAL Marketplace for the corresponding audience.

To publish application

1. In the application menu (you can also find a Publish icon in the Edit application form), click Publish
2. Enter publication request name in the upper area.
3. In Publish to, select the target destination or a folder to publish your prompt into.
4. In Allow access..., specify access rules and the target audience. For example Role-Equals-Admin. Note: the available roles are defined in each organization individually. Contact your support to find out the rules are applicable in your organization.
5. In Applications you can choose what applications you want to publish.
6. Assign a version to the published application.
7. Enter the name of the author of the publication request.
8. Click Send request to send your publication request to the administrator.

Note, when your request is approved by the administrator, the published application will become available in the DIAL Marketplace for the target audience.

Keep in mind, that after publishing, another instance of the application is created. In the Marketplace, you can find both of them: the original and the published one. The original has the editor icon on it - meaning that your can continue modifying this app. Bookmark the published version to add to your workspace to use it.

Access to application files

Applications can rely on resources like documents and files to operate. When the application is published, the resources it includes are published as well. You can access the resources of the published application in the Attachments Manager under the "Organization" section.

Refer to Access to Application Files to see a more in-depth and technical description of a logic that handles access to files of published applications.

Remove from Workspace

You can remove any conversational agent from My workspaces:

1. Navigate to the My workspace section.
2. In the agent's tile, click Remove.
3. Confirm your action in the dialog window.

Delete App

Use Delete in the app's menu to completely delete the selected application. Note that you can delete only your own apps.

To delete application

1. Navigate to the My workspace section.
2. In the application menu, click Delete.
3. Confirm your action in the dialog window.

Application Link

For applications that are available organization-wide, you can copy and share a link that directs users straight to the application's card in the DIAL Marketplace, facilitating quick and easy navigation.

Application Builder

DIAL acts as application server offering tools to develop, deploy, host and manage different types of GenAI applications. We take care of scalability, availability and resource optimization issues, as well as integration with existing systems and data sources.

Refer to DIAL-Native Apps to see a more in-depth information for application developers.

☁️ In My workspace of the SaaS DIAL edition, you can use Application Builders (it is also known as application wizard) to create/edit applications of available Application Types. It is a useful feature, allowing users quickly build applications in a no-code fashion.

Application Builder interface can very depending on the application type. You can use it to not only configure and launch applications but also test them before going live.

💾 Self-hosted DIAL setups can include custom application types with fully custom UIs overriding the standard DIAL Chat UI and custom UIs for application wizards. Custom UIs are out of scope of this user guide.

• Refer to DIAL-Native Apps to see a more in-depth information about applications and application types.
• Watch demo video to see the Mind Map Studio in action.

Add Quick App

Refer to Quick Apps to learn about this application type.

To Add Quick App

1. In My workspace, click Add app and select Quick App to launch the Application Builder.
2. Follow the steps to configure application. Refer to Add application form to see the description of parameters.
3. When you configure all the required parameters, click Save and exit. Your Quick App will appear in My workspace. You can now use it, share or publish.

Add/Edit Quick app form

Field	Required	Description
Name	Yes	Quick app name.
Version	Yes	Quick app version, following the format x.y.z and contain only numbers and dots.
Icon	No	The icon that will be rendered in the chat UI for this Quick app.
Description	No	A short description that will be rendered in the chat UI. Tip: Add two line breaks and provide an addition description if needed.
Topics	No	You can assign one of pre-defined topics to your Quick app. Topics and their styles are defined in DIAL Chat Themes.
Document relative URLs	No	If your application includes an instruction in the Toolset to query a document(s) in order to generate a response, use this parameter to select document(s) in the Attachments Manager.
Model	Yes	Select one of the available language models from the dropdown list.
Configure toolset	No	Enter a valid Json with a toolset configuration that will be used when making requests. E.g. this toolset can define how to make calls to external API. Refer to Tutorials to see a full configuration example.
Instructions	No	Instructions to the language model.
Temperature	Yes	The temperature controls the creativity and randomness of the model's output.

Add Code App

Refer to Code Apps to learn about this application type.

Add Code App is Unavailable: Note, that adding new Code Apps can be disabled for specific user roles. In case this feature is unavailable for your user on UI, contact your system administrator for details.

To Add Code App

1. In My workspace, click Add app and select Code App to launch Application Builder.
2. Follow the steps to configure application. Refer to Add code app form to see the description of parameters.
3. When you configure all the required parameters, click Save and exit. Your Quick App will appear in My workspace. You can now use it, share or publish.

To Launch Code App

Keep in mind, that platform administrators can undeploy any running application.

After adding, your new Code App will appear in My workspace.

1. Click Deploy in the Code App menu to run it. When deployed, you will get a notification on your screen and the Code App's status icon will turn from yellow to green - this may take a few minutes.

2. Select the application and click Use application to launch it.

To Access Code App Logs

You can view and download logs of the deployed Code App from the application menu.

1. Click Logs in the deployed code app.

2. In the pop-up window, you can view, refresh and download file with application logs.

To Edit Code App

To modify the application source code or the application form parameters, you need to undeploy it. Both Edit and Undeploy buttons are located in the application's menu:

Add/Edit code app form

Field	Required	Description
Name	Yes	Code app name.
Version	Yes	Code app version, following the format x.y.z and contain only numbers and dots.
Icon	No	The icon that will be rendered in the chat UI for this Code app.
Topics	No	You can assign one of pre-defined topics to your Code app. Topics and their styles are defined in DIAL Chat Themes.
Description	No	A short description that will be rendered in the chat UI. Add two line breaks and provide an addition description if needed.
Attachments type	No	Types of attachments allowed for this application. Provide the types according to MIME standard. E.g.: image/png and click enter. Enter */* to allow all types.
Max. attachments number	No	The maximal number of attachments the application is allowed to accept. Skip to apply the max integer number. Enter 0 to disable attachments.
Select folder with source files	Yes	Use this to define the file structure of your application and enter into the built-in fully functional Python code editor. Here, you can write your app from scratch or upload the existing source code files.
Runtime version	Yes	Select the environment in which Python code will be executed.
Endpoints	Yes	Code App must expose a chat completion endpoint. You can also add rate and configuration endpoints. Refer to DIAL Core to learn about endpoints. Note: Code Apps cannot call each other or any external endpoints with the exception of DIAL Core, if it is allowed.
Environment variables	No	You can define environment variables with values for your application.

Add Mind Map

• Refer to Mind Maps to learn about this application type.
• Watch a video demo describing the Mind Map Application Studio.

To Add Mind Map

1. In My workspace, click Add app and select Mind Map to launch Application Builder.
2. Follow Application Builder to configure application.
3. When you configure all the required parameters, click Save. Your Mind Map will appear in My workspace. You can now use it, share or publish.

Step 1: General info

Once you launch the Mind Map Application Builder, on the first screen you will be able to enter general info parameters. This information will be rendered on the application's card in DIAL Marketplace.

Field	Required	Description
Name	Yes	Application name.
Version	Yes	Application version, following the format x.y.z and contain only numbers and dots.
Icon	No	The icon that will be rendered in the chat UI for this application.
Description	No	A short description that will be rendered in the chat UI. Add two line breaks and provide an addition description if needed.
Topics	No	You can assign one of pre-defined topics to your app. Topics and their styles are defined in DIAL Chat Themes.

Step 2: App settings

Click Next to proceed with App settings. In the App settings, you define the data source for your application, generate knowledge graph, view, test and edit nodes.

1. In the Sources list, select Add link to provide a web page URL or Upload file to provide a file as a source and click Generate Graph.

   

2. In the Sources list, you can view, edit and add new sources. Here, you can also regenerate the graph form scratch with new sources if needed.

   

3. Once the graph is generated, you can view it in the Content tab. In this tab, you can view and test the graph, use toolbar to work with nodes.

   

Available actions to work with the graph content:

• View modes: Use the View Mode to switch between the Table and the Graph view.
• Edges: Edges are logical connections between nodes.
  • Generate complement edges: Additional complement edges are generated automatically for a new graph. You can delete them and generate again if needed.
  • Show complement edges: You can show/hide complement edges on the graph.
  • Delete complement edges: You can delete all complement edges.
• Generate node: Click Generate node to enter a node question and auto-generate a new node.
• Edit node: Click on any node (in either table or graph view mode) to enter into editing mode.
  • Label: The text label that will appear on the graph. The text of the label is auto generated and can be manually edited.
  • Questions: Formulate the text of the question which will be answered by the node description. The text of the question is auto generated and can be manually edited. The purpose of the question is to provide a context for a user about the content of a particular node.
  • Description: Enter the description text. This text should logically provide the answer to the Question. The text of the description is auto generated and can be manually edited. The description editor provides a variety of text formatting options, supports images, tables, code blocks and more. Refer to markdown guide for general guidelines.
  • Status: Before going live, you can review the nodes of your graph and collaborate with other users in the sharing mode. You can use Status to label the progress when working on nodes. This feature is especially useful in collaboration with other users. Different statuses are also color-coded in the graph view mode.
  • Icon: You can add icons to selected nodes.
  • Neon: You can highlight selected nodes with a neon effect to make them stand out visually.
  • Connections: Inbound and outbound connection are auto-generated for all nodes. You can manually edit connections.
  • Set as a root node: In the overflow menu of the node you can find a button to set the node as a root node of the graph. Root node is the central node of the graph.
  • Delete: In the overflow menu of the node you can find a button to delete the node.
• Shuffle graph: When working on a graph, you can manually move nodes around, add and remove connection. But you also may want to reshuffle the whole graph to automatically regroup all nodes to improve the readability.

Step 3: Preview and Save

1. Before saving your application, you can preview and test the generated knowledge graph. Click Preview sidebar to open a preview mode.

   

2. When done, click Save. Your Mind Map application will appear in My workspace. You can now use it, edit, share or publish.

   

Editing and Collaboration

In My workspace, you can access your Mind Map application and edit it if needed.

Also, you can share your application with other users and grant editing rights to collaborate on the application development.

Add Custom App

You can also add custom applications using DIAL API.

☁️ In DIAL SaaS edition, you can use a UI wizard to add your own GenAI app that does not belong to any available application types provided it has a chat completion endpoint available for DIAL Core and its API adheres to the Unified API of DIAL.

To Add Custom App

1. In My workspace, click Add app and select Custom App to launch Application Builder.
2. Follow the steps to configure application. Refer to Add application form to see the description of parameters.
3. When you configure all the required parameters, click Save and exit. Your new application will appear in My workspace.

Add/Edit application form

Field	Required	Description
Name	Yes	Application name.
Version	Yes	Application version, following the format x.y.z and contain only numbers and dots.
Icon	Yes	The icon that will be rendered in the chat UI for this application.
Topics	No	You can assign one of pre-defined topics to your custom application. Topics and their styles are defined in DIAL Chat Themes. You can also add custom applications using DIAL API. In this case, you can add any custom topic to your application by including this parameter in the application configuration JSON file: "description_keywords": ["My custom topic"]
Description	No	A short description that will be rendered in the chat UI. Add two line breaks and provide an addition description if needed.
Features data	No	Application features are specific configurations of applications specified in JSON format. Currently, only two are supported: rate and configuration endpoints: rateEndpoint is the endpoint for rate requests. configurationEndpoint is the endpoint to request application configuration parameters as JSON schema. Refer to DIAL Core documentation to view the full set of available application features.
Attachments type	No	Types of attachments allowed for this application. Provide the types according to MIME standard. E.g.: image/png and click enter. Enter */* to allow all types.
Max. attachments number	No	The maximal number of attachments the application is allowed to accept. Skip to apply the max integer number. Enter 0 to disable attachments.
Completion URL	Yes	A chat completion URL exposed by your application and used by DIAL Core to send chat completion requests.