Skip to content

Commit f9be51d

Browse files
authored
chore: chat userguide updates (#458)
1 parent 13abff7 commit f9be51d

File tree

9 files changed

+64
-20
lines changed

9 files changed

+64
-20
lines changed

docs/tutorials/0.user-guide.md

Lines changed: 64 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ During a conversation, you can access several tools to work with prompts.
9696

9797
You can copy answers to reuse them some place else.
9898

99+
* Copy as plain text
100+
* Copy in markdown format
101+
99102
![](./img/copy-answer.png)
100103

101104
##### Stop and Regenerate
@@ -163,7 +166,11 @@ The file(s) will be displayed as attachment(s) in the conversation box and becom
163166

164167
##### View or download attachments
165168

166-
If the response you have received includes an attachment, you can click the **Download** icon near the file name to download it or an **Expand** to preview.
169+
You can perform the following actions on attachments received in AI-generated responses:
170+
171+
- **Download**: Click the **Download** icon to save the attachment to your device.
172+
- **Preview**: Click the **Down Arrow** icon to preview the attachment inline.
173+
- **Full Screen**: Click the **Expand** icon to view graphics in full screen mode.
167174

168175
![](./img/download-file.png)
169176

@@ -1153,7 +1160,7 @@ Quick Apps 2.0 is a composer for building applications from reusable components.
11531160
| Topics | No | You can assign one of pre-defined topics to your app. Topics and their styles are defined in [DIAL Chat Themes](https://github.com/epam/ai-dial-chat-themes/blob/development/static/config.json). |
11541161
| 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 [Files](#files). |
11551162
| Model | Yes | Select one of the available language models from the dropdown list. This list includes only available models that can work with toolsets. This model will be used to reply to prompts from users and to orchestrate actions of agents. |
1156-
| Agents & Toolsets | No | Add available [toolsets](#toolsets), [apps](#applications) or [AI models](#models) that will be used as agents in your application. Advanced users can use JSON editor to define agents.<br />Hover over the added agents and toolsets to see their details and state.<br />Click any added agent or toolset to access additional actions such as deploy/undeploy for code apps or login/logout for toolsets.<br />**Note**: When using toolsets, make sure to be logged in to use them if authentication is required. |
1163+
| Agents & Toolsets | No | Add available [toolsets](#toolsets), [apps](#applications) or [AI models](#models) that will be used as agents in your application. Advanced users can use JSON editor to define agents and toolsets.<br />Hover over the added agents and toolsets to see their details and state.<br />Click any added agent or toolset to access additional actions such as deploy/undeploy for code apps or login/logout for toolsets.<br />**Note**: When using toolsets, make sure to be logged in to use them if authentication is required. |
11571164
| Attachment types | No | Types of attachments allowed for this application. Provide the types according to [MIME standard](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). E.g.: image/png and click enter. Enter `*/*` to allow all types. |
11581165
| 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. |
11591166
| Instructions | No | System prompt text. |
@@ -1199,35 +1206,46 @@ Limitations and security restrictions:
11991206
12001207
![](./img/register-code-app.png)
12011208

1202-
##### To Launch Code App
1209+
##### Deploy
12031210

1204-
> **Keep in mind**, that platform [administrators can undeploy](#deploy-and-undeploy-code-apps) any running application.
1211+
Code apps need to be deployed in order to use them. Application owners, [administrators](#administrators) and [users with editing rights](#sharing-with-editing-rights) can deploy, undeploy and redeploy applications.
12051212

1206-
After adding, your new Code App will appear in [My workspace](#my-workspace).
1207-
1208-
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 change from yellow to green - this may take a few minutes.
1213+
1. Select any Code app and open its context menu.
1214+
2. Click **Deploy**.
1215+
3. When deployed, you will get a notification on your screen and the Code App's status icon will change from yellow to green - this may take a few minutes.
12091216

12101217
![](./img/deploy-code-app.png)
12111218

1212-
2. Select the application and click **Use application** to launch it.
1219+
4. Select the deployed application and click **Use application** to launch it.
12131220

1214-
##### To Access Code App Logs
1221+
You can also deploy a Code apps when you add it as tool for [Quick Apps 2.0](#add-quick-app-20):
12151222

1216-
You can view and download logs of the deployed Code App from the application menu.
1223+
![](./img/deploy-code-app2.png)
12171224

1218-
1. Click **Logs** in the deployed code app.
1225+
##### Undeploy
12191226

1220-
![](./img/logs-code-app.png)
1227+
Code apps need to be undeployed to withdraw from usage or [make changes](#to-edit-code-app). To apply changes with less downtime use [Redeploy](#redeploy). Application owners, [administrators](#administrators) and [users with editing rights](#sharing-with-editing-rights) can deploy, undeploy and redeploy applications.
12211228

1222-
2. In the pop-up window, you can view, refresh and download file with application logs.
1229+
![](./img/undeploy-code-app.png)
12231230

1224-
![](./img/app-logs.png)
1231+
##### Redeploy
1232+
1233+
Use **Redeploy** in the context menu or directly in the application builder UI to apply changes made to the deployed application without downtime, contrary to the undeploy and deploy process. Application owners, [administrators](#administrators) and [users with editing rights](#sharing-with-editing-rights) can deploy, undeploy and redeploy applications.
1234+
1235+
![](./img/redeploy-code-app.png)
12251236

12261237
##### To Edit Code App
12271238

1228-
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:
1239+
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.
1240+
1241+
> **Important**: Changes apply with the next deployment of application.
12291242
1230-
![](./img/app-menu.png)
1243+
* To change anything but application name and version, make changes and click [Redeploy](#redeploy).
1244+
* To change application name and version, click [Undeploy](#undeploy), make changes and then click [Deploy](#deploy).
1245+
1246+
> **Note**, it is not allowed to modify name and version of shared with you applications.
1247+
1248+
![](./img/edit-code-app.png)
12311249

12321250
##### Add/Edit code app form
12331251

@@ -1243,10 +1261,23 @@ To modify the application source code or the application form parameters, you ne
12431261
| 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. |
12441262
| Runtime version | Yes | Select the environment in which Python code will be executed. |
12451263
| Endpoints | Yes | Code App must expose a chat completion endpoint. You can also add rate and configuration endpoints. Refer to [DIAL Core](https://github.com/epam/ai-dial-core/blob/development/docs/dynamic-settings/applications.md) 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. |
1246-
| Environment variables | No | You can define environment variables with values for your application. |
1264+
| Environment variables | No | Environment variables used by the application. |
12471265

12481266
![](./img/code-app-builder.png)
12491267

1268+
1269+
##### To Access Code App Logs
1270+
1271+
You can view and download logs of the deployed Code App from the application menu.
1272+
1273+
1. Click **Logs** in the deployed code app.
1274+
1275+
![](./img/logs-code-app.png)
1276+
1277+
2. In the pop-up window, you can view, refresh and download file with application logs.
1278+
1279+
![](./img/app-logs.png)
1280+
12501281
#### Mind Maps
12511282

12521283
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.
@@ -1358,7 +1389,7 @@ The key distinction between sharing and [publishing](#publish-2) is that sharing
13581389

13591390
**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.
13601391

1361-
Applications shared with and without editing rights have different scope of actions available for the target user:
1392+
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.
13621393

13631394
![](./img/share-app2.png)
13641395

@@ -1481,7 +1512,7 @@ If you are logged into your own toolset with your credentials, the card of the a
14811512

14821513
![](./img/toolset-logged-in.png)
14831514

1484-
If a toolset was [published with credentials](#to-publish-toolset-with-creds), it can be automatically logged in displaying the label ORG CREDS:
1515+
If a toolset was [published with credentials](#to-publish-toolset-with-creds), it may be automatically logged in and display the **ORG CREDS** label. DIAL administrators can also [log in with organization credentials](#manage-creds) to make a toolset available to all users within the organization:
14851516

14861517
![](./img/toolset-logged-in-with-creds.png)
14871518

@@ -1801,7 +1832,7 @@ All publication requests undergo a review process by administrators before being
18011832
In the [DIAL Marketplace](#marketplace), administrators can deploy and undeploy Code Apps of different users.
18021833

18031834
1. Go to DIAL Marketplace and apply filter by Applications. Deployed Code Apps have a green status icon.
1804-
2. Click the app you want to undeploy/deploy. Refer to [Launch Code App](#to-launch-code-app) to learn more.
1835+
2. Click the app you want to undeploy/deploy. Refer to [Code Apps/Deploy](#deploy) to learn more.
18051836

18061837
### Unpublish
18071838

@@ -1833,6 +1864,19 @@ Applications, conversations and prompts published via DIAL Core API or DIAL Chat
18331864
2. Select **Unpublish** in the actions menu of the selected application and fill in the request form.
18341865
3. The application will be removed from Marketplace after the unpublish request is approved by the DIAL administrator.
18351866

1867+
### Manage creds
1868+
1869+
DIAL administrators can view and manage the authentication status of public toolsets, including logging in and out with organization credentials on behalf of all users.
1870+
1871+
1. Navigate to the Toolsets tab in Marketplace.
1872+
2. Click any toolset (or a specific version of a toolset) that requires authentication. Refer to [Toolsets](#authentication) to learn more about toolsets authentication feature.
1873+
3. On the toolset info card, click **Manage creds**.
1874+
4. On the **Manage credentials** modal:
1875+
- **My credentials**: Log in/out using your personal credentials
1876+
- **Entire organization credentials**: Log in/out using organization credentials - this effects the login status of the selected toolset for all users in the organization
1877+
1878+
![](./img/admin-toolset-auth.png)
1879+
18361880
## Data Visualization
18371881

18381882
DIAL Chat enables data visualization for specific data types using data visualizers. It comes with built-in support for the [Plotly data visualizer](#plotly). To link any other custom visualizers, you can use the [DIAL Chat Visualizer Connector](https://github.com/epam/ai-dial-chat/blob/development/libs/chat-visualizer-connector/README.md) library.
16.8 KB
Loading
20.3 KB
Loading

docs/tutorials/img/copy-answer.png

-894 Bytes
Loading
46.3 KB
Loading
995 Bytes
Loading
4.7 KB
Loading
20.8 KB
Loading
5.13 KB
Loading

0 commit comments

Comments
 (0)