You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/0.user-guide.md
+64-20Lines changed: 64 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,6 +96,9 @@ During a conversation, you can access several tools to work with prompts.
96
96
97
97
You can copy answers to reuse them some place else.
98
98
99
+
* Copy as plain text
100
+
* Copy in markdown format
101
+
99
102

100
103
101
104
##### Stop and Regenerate
@@ -163,7 +166,11 @@ The file(s) will be displayed as attachment(s) in the conversation box and becom
163
166
164
167
##### View or download attachments
165
168
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.
167
174
168
175

169
176
@@ -1153,7 +1160,7 @@ Quick Apps 2.0 is a composer for building applications from reusable components.
1153
1160
| 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). |
1154
1161
| 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). |
1155
1162
| 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. |
1157
1164
| 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. |
1158
1165
| 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. |
1159
1166
| Instructions | No | System prompt text. |
@@ -1199,35 +1206,46 @@ Limitations and security restrictions:
1199
1206
1200
1207

1201
1208
1202
-
##### To Launch Code App
1209
+
##### Deploy
1203
1210
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.
1205
1212
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.
1209
1216
1210
1217

1211
1218
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.
1213
1220
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):
1215
1222
1216
-
You can view and download logs of the deployed Code App from the application menu.
1223
+

1217
1224
1218
-
1. Click **Logs** in the deployed code app.
1225
+
##### Undeploy
1219
1226
1220
-

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.
1221
1228
1222
-
2. In the pop-up window, you can view, refresh and download file with application logs.
1229
+

1223
1230
1224
-

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
+

1225
1236
1226
1237
##### To Edit Code App
1227
1238
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.
1229
1242
1230
-

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
+

1231
1249
1232
1250
##### Add/Edit code app form
1233
1251
@@ -1243,10 +1261,23 @@ To modify the application source code or the application form parameters, you ne
1243
1261
| 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. |
1244
1262
| Runtime version | Yes | Select the environment in which Python code will be executed. |
1245
1263
| 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. |
1247
1265
1248
1266

1249
1267
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
+

1276
+
1277
+
2. In the pop-up window, you can view, refresh and download file with application logs.
1278
+
1279
+

1280
+
1250
1281
#### Mind Maps
1251
1282
1252
1283
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
1358
1389
1359
1390
**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.
1360
1391
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.
1362
1393
1363
1394

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

1483
1514
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:
1485
1516
1486
1517

1487
1518
@@ -1801,7 +1832,7 @@ All publication requests undergo a review process by administrators before being
1801
1832
In the [DIAL Marketplace](#marketplace), administrators can deploy and undeploy Code Apps of different users.
1802
1833
1803
1834
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.
1805
1836
1806
1837
### Unpublish
1807
1838
@@ -1833,6 +1864,19 @@ Applications, conversations and prompts published via DIAL Core API or DIAL Chat
1833
1864
2. Select **Unpublish** in the actions menu of the selected application and fill in the request form.
1834
1865
3. The application will be removed from Marketplace after the unpublish request is approved by the DIAL administrator.
1835
1866
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
+

1879
+
1836
1880
## Data Visualization
1837
1881
1838
1882
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.
0 commit comments