From 9f09fab2a51c907c5c8ed93e603c762b57c1e520 Mon Sep 17 00:00:00 2001 From: sr-remsha Date: Wed, 20 May 2026 17:20:41 +0200 Subject: [PATCH] style review --- docs/tutorials/0.user-guide.md | 197 +++++++++++++++++---------------- 1 file changed, 101 insertions(+), 96 deletions(-) diff --git a/docs/tutorials/0.user-guide.md b/docs/tutorials/0.user-guide.md index ba0b4ef5e..f8633999a 100644 --- a/docs/tutorials/0.user-guide.md +++ b/docs/tutorials/0.user-guide.md @@ -2,10 +2,10 @@ ## 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. +DIAL Chat is an enterprise-grade application that serves as a default Web interface for DIAL, providing access to the complete set of the platform's features. -> - Watch a [demo video](/docs/video%20demos/1.Chat/1.dial-ui-basics.md) with introduction to DIAL Chat UI. -> - Refer to [Quick Start](/docs/quick-start.md) to learn how to launch DIAL Chat in a few clicks. +> - Watch a [Demo Video](/docs/video%20demos/1.Chat/1.dial-ui-basics.md) with introduction to DIAL Chat UI. +> - Refer to [Quick Start](/docs/quick-start.md) to learn how to launch DIAL Chat locally with a sample Echo application in a few clicks. ### Additional Documentation @@ -19,44 +19,44 @@ Refer to [DIAL Chat repository](https://github.com/epam/ai-dial-chat) to view th You can also refer to other topics in this documentation: - Chat localization [instruction](/docs/tutorials/1.developers/3.chat/1.localization.md). -- List of [supported LLMs](/docs/platform/2.supported-models.md). +- List of [supported AI models](/docs/platform/2.supported-models.md). - Chat UI design [guidelines](/docs/tutorials/1.developers/3.chat/3.chat-design.md). - Authentication [guidelines](/docs/platform/3.core/1.auth-intro.md). ## Standard Chat Interface Components -> **Note**: this user guide covers the functionality of a standard DIAL Chat UI. +> **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](#conversations): Here, you can access and manage your conversations. You can collapse and expand the panel by clicking the **Hide panel** icon above it. +1. [Conversations](#conversations): In this section, you can access and manage your conversations. You can collapse and expand the panel by clicking the **Hide panel** icon above it. 2. [Prompts](#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](#chat): Use this section to enter a prompt, view results, and interact with conversational agents. +3. [Chat](#chat): In this section, you can enter a prompt, view results, and interact with conversational agents. 4. [User Settings](#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](#agents): you can view and change conversational agent before or during a conversation. -6. [Conversation settings](#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. +5. [Agents](#agents): In this section, you can view and change the conversational agent before or during a conversation. +6. [Conversation settings](#conversation-settings): By default, this section displays the last conversational agent you have used. Here, you can modify settings of the selected agent or change the agent. 7. [DIAL Marketplace](#marketplace): Marketplace displays all conversational agents (applications and language models) available on your DIAL environment. 8. [My Workspace](#my-workspace): In My workspace, you can create applications and add agents from the Marketplace. -9. [Files](#files): Manager of files. +9. [Files](#files): In Files, you can access and manage all your private, shared with you and file available across the organization. -![](./img/home.png) +![DIAL Chat UI](./img/home.png) ## 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. +The standard DIAL Chat UI meets the needs of typical conversational applications. +However, to accommodate the requirements of applications that exceed the standard chat UI functionality, you can create new application types that implement a fully custom UI (even not chat-like UI). The standard chat UI will be replaced with the custom one during interactions with such applications. For example, [Mind Map](#mind-maps) applications implement fully custom UI that overrides the standard chat UI. -![](./img/mindmap2.png) +![Custom UI](./img/mindmap2.png) ## 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. -![](./img/chat.png) +![DIAL Chat](./img/chat.png) ### Actions @@ -73,7 +73,7 @@ The chat occupies the central part of the main screen, allowing you to input mes You can enter your prompts in the text box. In [User Settings](#user-settings), you can configure the keyboard combination that will send the message. -![](./img/caht-box.png) +![Chat box](./img/caht-box.png) You can enter a prompt manually or select one of [existing prompts](#prompts). Enter `/` in the chat text box to select one of the available prompts. You can also click [Use](#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. @@ -94,7 +94,7 @@ During a conversation, you can access several tools to work with prompts. ##### Copying responses -> **TIP**: You can set the response format in [conversation settings](#response-format). +> **Tip**: You can set the response format in [conversation settings](#response-format). You can copy answers to reuse them some place else. @@ -188,7 +188,7 @@ On the top bar you can view and manage agent and conversation settings. 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: +For instance, to open chat with GPT-4 model, go to `https://DIAL Chat URL/models/gpt-4` and access a user interface enabling interaction with the predefined agent: ![](./img/isolated_view_mode.png) @@ -210,9 +210,9 @@ In the user area on the top bar, click the user profile icon to access additiona ## 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. +In DIAL, a conversation is your dialogue with a conversational agent, such as a language model or application. The agent uses natural language to interact with you 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. +> All your conversations are stored in DIAL file storage in your private folder, and you can access them from any device you use. ### Agents @@ -222,7 +222,7 @@ In DIAL Chat you can have a conversation with agents: [language models](#models) ##### 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: +By default, the main window displays the last agent you have used. 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. @@ -232,11 +232,11 @@ In the middle of a conversation, you can view information about the current agen ![](./img/change-agent2.png) -> **TIP**: You can also set the **default agent** you want to start a conversation with in your [User Settings](#user-settings). +> **Tip**: You can also set the **default agent** you want to start a conversation with in your [User Settings](#user-settings). ### 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. +> **Note**: The conversation settings can vary based on the selected agent. Not all agents have configurable settings. In the Conversation Settings, you can access and modify the following components depending on the selected agent: @@ -264,7 +264,7 @@ In the conversation header menu you also can: #### System Prompt -> **Note**, there are language models that do not support this feature. In such cases system prompt is disabled. +> **Note**: System prompt is disabled for agents that do not support it. 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. @@ -292,7 +292,7 @@ Click a **...** icon to open a conversation menu. There, you can view a list of ![](./img/conversation-menu.png) -> **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. +> **Note**: The available actions can vary depending on the selected conversation. For example, the Unpublish action is not available if the conversation hasn't been published yet. This is the list of all the supported actions: @@ -346,14 +346,14 @@ Use the **Search** box to search conversations by their names. If you have any s There are several ways to initiate a dialog with a [conversational agent](#agents): -- 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. +- To communicate with the current conversational agent (by default, the last one you have used), 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](#use-1) 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](/docs/tutorials/1.developers/4.apps-development/1.custom-buttons.md) to see tutorials for developers on how to include custom buttons in applications. ![](./img/start-conv.png) -**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. +> **Tip:** New conversations will appear in the conversations panel. 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 @@ -374,18 +374,18 @@ The following symbols in the conversation names are prohibited: tab, `"`, `:`, ` You can share a personal 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 [Files](#files). +**Note**: When a conversation is shared, all its attachments are shared as well and become available in [Files](#files). > - Watch [Collaboration](/docs/video%20demos/1.Chat/3.dial-collaboration.md) demo video to learn more about sharing and other collaboration features in DIAL. > - Refer to [Collaboration](/docs/platform/7.collaboration-intro.md#sharing) to learn more about sharing. ##### 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. +If a conversation has been shared with you, you can find it in the **Shared with me** section in the panel with your conversations. ![](./img/shared-with-me.png) -> **Important**: you cannot change a conversation that has been shared with you. To be able to work with it, [duplicate it](#duplicate). +> **Tip**: To change a conversation that has been shared with you, you need to [duplicate it](#duplicate) it. ##### To share a conversation @@ -395,7 +395,9 @@ If you want to share a conversation or a folder, click on **Share** in the conte ![](./img/share_conv.png) -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. +After the recipient has opened your link, the arrow icon appears near its name. + +> **Tip**: Reload the page to update the status of the shared conversation. ![](./img/shared.png) @@ -434,9 +436,9 @@ You can also export all your conversations at once without attachments in a JSON ##### Export a single conversation with attachments 1. On the left panel, in the conversation contextual menu, point to **Export**. -2. Click **With attachments**. +2. Click **With attachments** to export conversations as a ZIP archive. -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. +> **Tip**: The name of the ZIP archive follows the format `file_name.dial`. You can manage it just like a normal ZIP archive. ![](./img/export-with-att.png) @@ -504,7 +506,7 @@ Also, you can use a _selection_ mode to choose conversation(s) you want to delet ### 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. +You can use **Replay** to reproduce conversations but with different settings (e.g. a different model). Use replayed conversation to compare responses to the same questions from different agents and with different conversation settings. ![](./img/replay-conversation.png) @@ -526,16 +528,16 @@ The replayed conversation is displayed as a new conversation with the `[Replay]` ### 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. +You can use Parameterized Replay to create 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, enabling a personalized experience. ##### 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. +Let's create a simple Travel Guide conversation, which will take you 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 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. +2. To use your parametrized prompt, enter `/` 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. @@ -563,16 +565,17 @@ You can create a parametrized conversation from any message in your chat. This s ### 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. +Use Playback mode to simulate the current conversation without any engagement with AI models. This mode accurately reproduces the conversation like a recording. + +> **Tip**: It is important to differentiate Playback from [Replay](#replay), where the prompts are resubmitted to the chosen model and the outcomes may differ from the initial conversation. -> - **Note**, that this differs from [Replay](#replay), where the prompts are resubmitted to the chosen model and the outcomes may differ from the initial conversation. -> - **Note**: playback support in [schema-rich applications](/docs/platform/3.core/7.apps.md#schema-rich-applications) can be enabled/disabled in the application's JSON schema using `dial:applicationTypePlaybackSupport` property. +> **Note**: You can enable or disable Playback in [schema-rich applications](/docs/platform/3.core/7.apps.md#schema-rich-applications) using `dial:applicationTypePlaybackSupport` property in JSON schema. -![](./img/playback-conversation.png) +![Playback conversation](./img/playback-conversation.png) -During playback, you have the ability to rewind, fast forward, or halt the process. +During playback, you can rewind, fast forward, or stop the process. -![](./img/playback-controls.png) +![Playback controls](./img/playback-controls.png) ### Compare @@ -592,7 +595,7 @@ Once you initiate a conversation in this mode, the system creates two new conver ##### 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. +> **Note**: The Compare mode works only with conversations with the same amount of prompts. 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. @@ -605,18 +608,18 @@ Once you initiate a conversation in this mode, the system creates two new conver You can publish conversations to make them available for all users or a specific group of users. -**Important**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. +**Note**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. > * Refer to [Publications](#publications) section of this guide to learn more about publications. > * Watch [Publications](/docs/video%20demos/1.Chat/4.dial-publications.md) demo video to learn more about collaboration features in DIAL. ##### To publish a conversation -**Note**: to publish a shared conversation, [duplicate](#duplicate) it and then publish. +**Tip**: To publish a shared conversation, [duplicate](#duplicate) it and then publish. 1. Click **Publish** in the conversation menu. - ![](./img/publish-conversation.png) + ![Publish conversation](./img/publish-conversation.png) 2. In the pop-up window: @@ -656,7 +659,7 @@ When you open a published conversation, you can view and switch between its vers You can unpublish conversations to withdraw them from public use entirely or for the selected user groups. -> **Important**: All unpublish requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. +> **Note**: All unpublish requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. > * Refer to [Publications](#publications) section of this guide to learn more about publications. > * Watch [Publications](/docs/video%20demos/1.Chat/4.dial-publications.md) demo video to learn more about collaboration features in DIAL. @@ -680,7 +683,7 @@ You can unpublish conversations to withdraw them from public use entirely or for ## 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. +A prompt is an instruction, a question, or a message that you provide to a language model to receive a response. Prompts can also contain constraints or requirements. They help the AI 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. @@ -688,15 +691,15 @@ Prompts can be applied to one message or a whole conversation. Refer to the [Sys 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. +> All your prompts are stored in DIAL file storage in your private folder, 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. +To access prompt actions, click the three-dot icon (**...**) next to the selected prompt to open a menu with all available actions. ![](./img/prompt-menu.png) -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. +> **Note**: Available actions can differ depending on the selected prompt. For instance, the Unpublish action will not be available if the prompt has not been published. - [Use](#use): click to populate the selected prompt in the chat box. - [View](#view): click to view the details of the selected prompt. @@ -839,7 +842,7 @@ You can share a prompt or a folder with several prompts with other users. ##### 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. +To accept a prompt from another user (receive a shared prompt), accept 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](#duplicate-1). When you receive a shared prompt, a pop-up window opens up, where you can preview a prompt and duplicate it if needed. @@ -896,9 +899,11 @@ Click **Export prompts** at the bottom of the right panel. All your prompts will ##### To import prompts -Click **Import prompts** at the bottom of the right panel. Only valid JSON files can be imported. +Click **Import prompts** at the bottom of the right panel to import prompts. -![](./img/import-prompt.png) +> **Tip**: You can import prompts only as valid JSON files. + +![Import prompts](./img/import-prompt.png) When importing a **duplicate** of an existing prompt, you will be asked to select one of the proceeding options: @@ -912,14 +917,14 @@ When importing a **duplicate** of an existing prompt, you will be asked to selec You can publish prompts to make them available for all users or a specific group of users. -**Important**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. +**Note**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. > * Refer to [Publications](#publications) section of this guide to learn more about publications. > * Watch [Publications](/docs/video%20demos/1.Chat/4.dial-publications.md) demo video to learn more about collaboration features in DIAL. ##### To publish a prompt -**Note**: to publish a shared prompt, [duplicate](#duplicate-1) it and then publish. +**Tip**: To publish a shared prompt, [duplicate](#duplicate-1) it and then publish. 1. Click **Publish** in the prompt menu. @@ -930,7 +935,7 @@ You can publish prompts to make them available for all users or a specific group - Enter **publication request name** in the upper area. - Enter the name of the author of the publication request. - In **Publish to**, you can select (or create) a sub-folder in the Organization folder where the published asset will be placed. - - In **Allow access if all match**, specify access rules. Note, that access rules can be applied only to sub-folders. Assets published in the root folder can be accessed by all authorized users. Refer to [Access Rules](#access-rules) to learn how to define them in the publication request. + - In **Allow access if all match**, specify access rules. Note, that access rules can be applied only to sub-folders. All authorized users can access assets published in the root folder. Refer to [Access Rules](#access-rules) to learn how to define them in the publication request. - In **Prompts**, you can choose what prompts you want to publish (if you have selected a folder with several prompts). - Assign a version to your request. Refer to [Versioning](#versioning-1) to learn more. - Click **Send request** to send your publish request to the administrator. @@ -959,7 +964,7 @@ If you try to publish this prompt again, you will be able to view the last versi You can unpublish prompts to withdraw them from public use entirely or for the selected user groups. -> **Important**: All unpublish requests undergo review by administrators, who can modify or decline the +> **Note**: All unpublish requests undergo review by administrators, who can modify or decline them. ##### To unpublish a prompt @@ -984,7 +989,7 @@ You can unpublish prompts to withdraw them from public use entirely or for the s > Watch [Marketplace](/docs/video%20demos/1.Chat/2.marketplace.md) demo video to see it in action. -DIAL Marketplace is a single-entry point for all applications, agents, tools, and models available to DIAL Chat users according to their roles and permissions. +In DIAL Marketplace you can access all agents and toolsets available on your DIAL environment according to your access permissions. > Refer to [Access Control Introduction](/docs/platform/0.architecture-and-concepts/6.access-control.md#roles) to learn more about access control and role-based access to resources in DIAL. @@ -992,7 +997,7 @@ DIAL Marketplace is a single-entry point for all applications, agents, tools, an ##### Navigation -You can navigate to Marketplace form the main DIAL Chat screen: +You can navigate to Marketplace from the main DIAL Chat screen: ![](./img/dial-marketplace1.png) @@ -1009,7 +1014,7 @@ From the Marketplace, you can navigate to your workspace: - Use the **Type** filters to view specific conversational agents and AI models, or to display all of them. By default, all agents are shown—simply apply the Type filter to narrow down your selection. - An 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 agents (e.g. you can filter just the apps shared with you or display only published agents). -- The **Search** allows you to swiftly locate any item by its name. +- The **Search** allows you to search items by their names. - Use the view toggle to switch between the table and the card view. ![](./img/dial-marketplace5.png) @@ -1029,7 +1034,7 @@ You can also add an agent to your workspace by initiating a conversation with it ![](./img/marketplace-home-select.png) -> **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 with this agent. A call-to-action button will appear in place of the chat text box. Simply click this button to return the item to your workspace and resume the conversation. +> **Tip**: If you start a conversation and then remove the associated agent from My workspace, you will need to reinstate it to continue the conversation with this agent. A call-to-action button will appear in place of the chat text box. Click this button to return the agent to your workspace and resume the conversation. ![](./img/add-to-continue.png) @@ -1068,7 +1073,7 @@ You can remove models from your workspace at any time using the bookmark button #### Model Link -For AI models that are available organization-wide, you can copy and share a link that directs users straight to the models's card in the DIAL Marketplace, facilitating quick and easy navigation. +For AI models that are available organization-wide, you can copy and share a link that takes users directly to the model's card in the DIAL Marketplace. ![](./img/model-link.png) @@ -1088,7 +1093,7 @@ Applications that follow the DIAL Unified protocol are known as DIAL-native apps > Refer to [DIAL-Native Apps](/docs/platform/3.core/7.apps.md) to see a more in-depth information about applications and application types. -:cloud: 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](#application-builder) for end users to be able to create applications +:cloud: 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](#application-builder) to create applications. :floppy_disk: 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. @@ -1134,7 +1139,7 @@ Quick Apps can be used to simplify a workflow or carry out a specific task. For 3. In the preview screen, you can test your solution. 4. When ready, click **Save and exit** to register the application in DIAL. -> **Access Quick App**: Your Quick App will appear only in [My workspace](#my-workspace). To enable others to use it, [share](#share-2) or [publish](#publish-2) your application. +> **Tip**: Your Quick App will appear only in [My workspace](#my-workspace). To enable others to use it, [share](#share-2) or [publish](#publish-2) your application. ![](./img/register-quick-app.png) @@ -1168,7 +1173,7 @@ Quick Apps 2.0 is a composer for building applications from reusable components. 3. In the preview screen, you can test your solution. 4. When ready, click **Save and exit** to register the application in DIAL. -> **Access Quick App 2.0**: Your Quick App 2.0 will appear only in [My workspace](#my-workspace). To enable others to use it, [share](#share-2) or [publish](#publish-2) your application. +> **Tip**: Your Quick App 2.0 will appear only in [My workspace](#my-workspace). To enable others to use it, [share](#share-2) or [publish](#publish-2) your application. ![](./img/register-quick-app-2.png) @@ -1239,7 +1244,7 @@ In this section you can define buttons shown near the chat input that suggest ex #### 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. +DIAL Code Apps allow you to develop, deploy and run your Python applications directly in the DIAL UI. Use Code Apps to quickly create POCs, deploy them and share with the target audience. In DIAL Chat Application Builder for Code apps you can: @@ -1306,12 +1311,12 @@ Use **Redeploy** in the context menu or directly in the application builder UI t If you are the application owner or have [editing rights](#sharing-with-editing-rights) you can modify the application source code or the application form parameters. -> **Important**: Changes apply with the next deployment of application. +> **Note**: Changes apply with the next deployment of application. * To change anything but application name and version, make changes and click [Redeploy](#redeploy). * To change application name and version, click [Undeploy](#undeploy), make changes and then click [Deploy](#deploy). -> **Note**, it is not allowed to modify name and version of shared with you applications. +> **Note**: Modification of name and version of the shared application by the recipient is not supported. ![](./img/edit-code-app.png) @@ -1360,7 +1365,7 @@ Mind Map enables users to access information through an interactive knowledge gr 3. You can test your solution in the preview screen. 4. When ready, click **Save and exit** to register the application in DIAL. -> **Access Mind Map**: Your Mind Map will appear only in [My workspace](#my-workspace). To enable others to use it, [share](#share-2) or [publish](#publish-2) your application. +> **Note**: Your Mind Map will appear only in [My workspace](#my-workspace). To enable others to use it, [share](#share-2) or [publish](#publish-2) your application. ![](./img/add-mindmap.png) @@ -1375,7 +1380,7 @@ Use a Custom App UI wizard to add your own GenAI application that does not belon 3. You can test your solution in the preview screen. 4. When ready, click **Save and exit** to register the application in DIAL. -> **Access Custom App**: Your app will appear only in [My workspace](#my-workspace). To enable others to use it, [share](#share-2) or [publish](#publish-2) your application. +> **Note**: Your app will appear only in [My workspace](#my-workspace). To enable others to use it, [share](#share-2) or [publish](#publish-2) your application. ![](./img/register-app.png) @@ -1397,9 +1402,9 @@ Use a Custom App UI wizard to add your own GenAI application that does not belon #### Edit -When you add a new application, it is stored in the private folder dedicated to your user. Private applications are under a complete control of the application author, who can edit or delete them anytime. +Your applications are stored in DIAL file storage in your private folder. Private applications are under your complete control as the application author, and your can edit or delete them anytime. -When you [publish an application](#publish-2), a specific version of it appears in the public folder. You cannot modify the published version of the application. But you can continue working on the application in the private space and, if needed, publish new versions of it. +When you [publish an application](#publish-2), a specific version of it appears in the public folder. You cannot modify the published version of the application. But you can continue working on the application in the private space and publish new versions of it. > Refer to [Access Control](/docs/platform/0.architecture-and-concepts/6.access-control.md) to learn more about private and public spaces. @@ -1427,14 +1432,14 @@ In this section, you can learn about: 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, unless [re-sharing](/docs/platform/7.collaboration-intro.md#sharing) rights have been explicitly granted. +> **Note**: You can share only your own applications. You cannot share an application that has been shared with you, unless [re-sharing](/docs/platform/7.collaboration-intro.md#sharing) rights have been explicitly granted. 1. Click **Share** on the application's card actions menu. ![](./img/share-app.png) -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](#sharing-with-editing-rights) outlined in this documentation. +2. If there are several versions of it, 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. **Note**: If you grant editing rights to your app, make sure you are familiar with the [main principles](#sharing-with-editing-rights) 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. @@ -1454,7 +1459,7 @@ If an application was shared with you **with editing rights** (e.g., a Code App The key distinction between sharing and [publishing](#publish-2) 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. +> **Warning**: 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. For example, users with editing rights can edit, deploy or undeploy applications. @@ -1476,7 +1481,7 @@ You can revoke access for all users with whom you have shared the application. 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. +> **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. @@ -1487,7 +1492,7 @@ Use **Unshare** to remove the shared with you application from your workspace. Until published, your application is stored in the dedicated folder of your user and cannot be accessed by anybody. You can publish your application to make it accessible to the selected audience or all authorized chat users in your organization. Published application is available on [Marketplace](#marketplace) for the target audience. -**Important**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. +**Note**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. > - Refer to [Publications](#publications) to learn more about this functionality and to [DevOps Tutorials](/docs/tutorials/2.devops/1.configuration/1.enable-publications-chat.md) to learn how to enable publications in DIAL. > - Refer to [Access Control](/docs/platform/3.core/2.access-control-intro.md) to learn more about public resources and how to restrict access to them. @@ -1497,7 +1502,7 @@ Until published, your application is stored in the dedicated folder of your user 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**, you can select (or create) a sub-folder in the Organization folder where the published asset will be placed. -4. In **Allow access if all match**, specify access rules. Note, that access rules can be applied only to sub-folders. Assets published in the root folder can be accessed by all authorized users. Refer to [Access Rules](#access-rules) to learn how to define them in the publication request. +4. In **Allow access if all match**, specify access rules. Note, that access rules can be applied only to sub-folders. All authorized users can access assets published in the root folder. Refer to [Access Rules](#access-rules) to learn how to define them in the publication request. 5. In **Applications** you can choose what applications you want to publish in case a folder with more than one asset is selected. 6. Select which **version** of the application you want to publish. 7. Enter the name of the **author** of the publication request. @@ -1546,7 +1551,7 @@ You can remove applications from your workspace at any time using the bookmark b Use Delete in the app's menu to completely delete the selected application. -> **Note** that you can delete only your own applications that have not been published. Published applications cannot be deleted - you can send an unpublish request to withdraw them from usage entrely or for a specific audience. +> **Note** that you can delete only your own applications that have not been published. Published applications cannot be deleted - you can send an unpublish request to withdraw them from usage entirely or for a specific audience. ##### To delete application @@ -1652,7 +1657,7 @@ In [your workspace](#my-workspace), you can add new toolsets. Added toolsets are 2. Fill in the required fields. 3. When ready, click **Save and exit** to register the toolset in DIAL. -> **Access toolset**: Your toolset will appear only in [your workspace](#my-workspace). To enable others to use it, share or [publish](#publish-3) your toolset. +> **Note**: Your toolset will appear only in [your workspace](#my-workspace). To enable others to use it, share or [publish](#publish-3) your toolset. | Field | Required | Description | |-------|:--------:|-------------| @@ -1693,7 +1698,7 @@ Until published, your toolset is stored in the dedicated folder of your user and ![](./img/publish-toolset.png) -**Important**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. +> **Note**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. > - Refer to [Publications](#publications) to learn more about this functionality and to [DevOps Tutorials](/docs/tutorials/2.devops/1.configuration/1.enable-publications-chat.md) to learn how to enable publications in DIAL. > - Refer to [Access Control](/docs/platform/3.core/2.access-control-intro.md) to learn more about public resources and how to restrict access to them. @@ -1724,7 +1729,7 @@ You can publish a toolset together with credentials. In this case, users will be You can unpublish toolsets to withdraw them from public use entirely or for the selected user groups. The published toolset can be unpublished by the toolset owner, DIAL administrator or other DIAL users who have access to it. When unpublished, the toolset stops being available on the Marketplace and is removed from the public folder. -> **Important**: All unpublish requests undergo review by administrators, who can modify or decline them. +> **Note**: All publication requests undergo [review by administrators](#process-publish-requests), who can modify or decline them. ![](./img/unpublish-toolset.png) @@ -1752,7 +1757,7 @@ You can remove public toolsets from your workspace at any time. Use **Delete** in the toolset's menu to completely delete the selected toolset. Applications that use this toolset will show an error when trying to communicate with it. Also, the deleted toolset is highlighted in the Quick Apps 2.0 editor in red color. -> **Note** that you can delete only your own toolsets that have not been published. Published toolsets cannot be deleted - you can send an unpublish request to withdraw them from usage entirely or for a specific audience. +> **Note**: You can delete only your own toolsets. Published toolsets cannot be deleted. To withdraw published toolsets from public usage entirely or for specific user groups, send an unpublish request. ##### To delete toolset @@ -1786,7 +1791,7 @@ To get toolset URL: ![](./img/toolset-url.png) -> **TIP**: Toolset URL is also available within the toolset info card and in the toolset editor. +> **Tip**: Toolset URL is also available within the toolset info card and in the toolset editor. ## Files @@ -1806,7 +1811,7 @@ In this tab, you can find all files that you have uploaded (manually, during con In this tab, you can add new folders, upload and remove files. -> DIAL applications can be configured to allow attaching entire folders to conversations. In this case, only folders created in the files manager can be attached to a conversation. +> **Note**: DIAL applications can be configured to allow attaching entire folders to conversations. In this case, only folders created in the files manager can be attached to a conversation. ##### Available actions @@ -1842,7 +1847,7 @@ In this tab you can view and manage files that have been shared with you by othe You can perform the following actions on shared files or folders: - **Download**: downloads the selected file or folder to your local device. -- **Delete**: 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 and delete these files. **Please note** that you cannot delete shared files without explicit permission to do so. +- **Delete**: 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 and delete these files. **Note**: You need an explicit permission from the file owner to delete a shared file. - **Unshare**: removes the shared file or folder from this section. You can also unshare folders with source files of the shared with you applications. ### Organization @@ -1887,11 +1892,11 @@ When an asset is published, it is placed in the Public folder in the file storag When making a publication request, its author can place assets in a sub-folder within a Public folder. Sub-folders serve not only to organize assets but also to apply access rules. -**Important**: The effective access rule for an object in a sub-folder includes restrictions applied to all parent sub-folders up to the root folder. Refer to [Tutorials](/docs/tutorials/1.developers/1.work-with-resources/0.work-with-publications.md#effective-rules) to learn about affective rules for folders. +**Note**: The effective access rule for an object in a sub-folder includes restrictions applied to all parent sub-folders up to the root folder. Refer to [Tutorials](/docs/tutorials/1.developers/1.work-with-resources/0.work-with-publications.md#effective-rules) to learn about affective rules for folders. ##### How to define access rules: -Access rules for objects in sub-folders can be defined using three parameters: attribute, operation and value. You can define several access rules that apply simultaneously using logical condition **OR**. +Access rules for objects in sub-folders can be defined using three parameters: `attribute`, `operation` and `value`. You can define several access rules that apply simultaneously using logical condition **OR**. * **Attribute**: To determine whether a logged-in user has access to a particular resource in sub-folders, DIAL Core matches `claims` in JWT from identity providers (IDPs) with attribute in access rules. Contact your administrators to learn more about claim values supported in your organization. * **Operation**: Matching functions for `claims` and `values`. E.g: Equals. @@ -1939,7 +1944,7 @@ Users with the admin role have access to the **Approve required** tab in convers The counter shows the number of requests to be reviewed. Each such request has a color dot attached to it. -> **TIP**: Refresh your browser to update this information. +> **Tip**: Refresh your browser to update this information. ![](./img/review3.png) @@ -1962,7 +1967,7 @@ All publication requests undergo a review process by administrators before being 5. If **Go to a review...** is displayed, click it to review 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. + > **Note**: You cannot approve the request which has not been reviewed in full. ![](./img/review-mode.png) @@ -1989,7 +1994,7 @@ Applications, conversations and prompts published via DIAL Core API or DIAL Chat > **Note**: Applications added via a direct modification of the DIAL Core config also appear in the public space and DIAL Marketplace but cannot be unpublished by DIAL administrators using DIAL Chat UI, Admin panel or DIAL Core API. Refer to [Access Control](/docs/platform/3.core/2.access-control-intro.md#objects) to learn more about such resources. -> Refer to Unpublish Conversation, Unpublish Prompt and Unpublish Application to learn how this can be done by DIAL Chat users. +> Refer to Unpublish Conversation, Unpublish Prompt, Unpublish Toolset and Unpublish Application to learn how to do this via DIAL Chat UI. ##### To unpublish a published conversation @@ -1997,7 +2002,7 @@ Applications, conversations and prompts published via DIAL Core API or DIAL Chat 2. Select a conversation and click **Unpublish** in the [actions menu](#actions) and fill in the [request form](#unpublish). 3. The conversation will be removed from the Organization folder after the unpublish request is approved by the DIAL administrator. -> **Note**, you can unpublish not only single conversations, but also published folders with conversations. In this case, you can select what conversations in the folder you want to unpublish. +> **Note**: You can unpublish not only single conversations, but also published folders with conversations. In this case, you can select what conversations in the folder you want to unpublish. ##### To unpublish a published prompts @@ -2005,7 +2010,7 @@ Applications, conversations and prompts published via DIAL Core API or DIAL Chat 2. Select a prompt and click **Unpublish** in the [actions menu](#actions-1) and fill in the [request form](#unpublish-1). 3. The prompt will be removed from the Organization folder after the unpublish request is approved by the DIAL administrator. -> **Note**, you can unpublish not only single prompts, but also published folders with prompts. In this case, you can select what prompts in the folder you want to unpublish. +> **Note**: You can unpublish not only single prompts, but also published folders with prompts. In this case, you can select what prompts in the folder you want to unpublish. ##### To unpublish a published application