Skip to content

Commit 883a20a

Browse files
authored
chore: add docs (#223)
* add docs * review
1 parent ab6c7bb commit 883a20a

File tree

10 files changed

+86
-2
lines changed

10 files changed

+86
-2
lines changed

docs/img/app-link.png

45.2 KB
Loading

docs/img/dial-marketplace5.png

-153 KB
Loading

docs/img/revoke.png

32.9 KB
Loading

docs/img/share-app.png

21.2 KB
Loading

docs/img/share-app2.png

204 KB
Loading

docs/img/share-app3.png

43.8 KB
Loading

docs/img/share-app4.png

24.5 KB
Loading

docs/supported-models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can use [DIAL SDK](https://github.com/epam/ai-dial-sdk) to create custom mod
1212
| Cohere| cohere.command-text-v14 |
1313
| Databricks| databricks-bge-large-en, databricks-llama-2-70b-chat, databricks-mixtral-8x7b-instruct, databricks-dbrx-instruct |
1414
| E5| e5-large-v2 |
15-
| Google| chat-bison@001, chat-bison-32k@002, chat-bison, codechat-bison@001, codechat-bison-32k@002, codechat-bison, gemini-pro, gemini-pro-vision, gemini-1.5-pro-preview-0409, gemini-1.5-flash-001, textembedding-gecko@001, imagegeneration@005 |
15+
| Google| chat-bison@001, chat-bison-32k@002, chat-bison, codechat-bison@001, codechat-bison-32k@002, codechat-bison, gemini-pro, gemini-pro-vision, gemini-1.5-pro-preview-0409, gemini-1.5-flash-001, gemini-2.0-flash-exp, gemini-exp-1206, gemini-2.0-flash-thinking-exp-1219, textembedding-gecko@001, imagegeneration@005 |
1616
| Meta| meta.llama3-8b-instruct-v1, meta.llama3-70b-instruct-v1, meta.llama3, meta.llama2-13b-chat-v1, meta.llama2-70b-chat-v1, meta.llama2, CodeLlama-34b-Instruct-hf, Llama-3-8B-Instruct |
1717
| Mistral| Mistral-7B-Instruct, Mixtral-8x7B-Instruct-v0.1, mistral-large-azure |
1818
| OpenAI| gpt-35-turbo-0301, gpt-35-turbo-0613, gpt-35-turbo-1106, gpt-35-turbo-0125, gpt-35-turbo, gpt-35-turbo-16k, gpt-4-0613, gpt-4, gpt-4-1106-preview, gpt-4-0125-preview, gpt-4-turbo-2024-04-09, gpt-4-turbo, gpt-4-32k-0314, gpt-4-32k-0613, gpt-4-32k, gpt-4-vision-preview, gpt-4o-2024-05-13, dall-e-3, text-embedding-ada-002, text-embedding-3-large, text-embedding-3-small |

docs/user-guide.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1120,7 +1120,13 @@ From both marketplace and workspace you can click **Back to Chat** to navigate t
11201120

11211121
![](./img/dial-marketplace3.png)
11221122

1123-
Use the **Type** filters to display any or all conversational agent and categorize them by **Topic**. Additionally, the **Search** allows you to swiftly locate any item. **Note**, that all agents are displayed by default - use the Type filter to narrow down the scope of the displayed agents.
1123+
##### Filters
1124+
1125+
* Use the **Type** filters to display any or all [conversational agents](#conversational-agents). **Note**, that all agents are displayed by default - use the Type filter to narrow down the scope of the displayed agents.
1126+
* 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.
1127+
* 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).
1128+
1129+
Additionally, the **Search** allows you to swiftly locate any item by its name.
11241130

11251131
![](./img/dial-marketplace5.png)
11261132

@@ -1307,6 +1313,67 @@ Use Edit in the app's menu to modify your apps.
13071313
1. Click **Edit** to invoke the [Edit app](#addedit-application-form)/[Edit quick app](#addedit-quick-app-form)/[Edit quick app](#addedit-code-app-form)
13081314
2. Make changes and click **Save**
13091315

1316+
#### Share App
1317+
1318+
Applications (or their versions) can be shared with other users by sending a sharing link. In this section, you can learn about:
1319+
1320+
* [Sharing](#to-share-app)
1321+
* [Unsharing](#to-unshare-app)
1322+
* [Removing access](#to-remove-access)
1323+
* [Editing rights](#sharing-with-editing-rights)
1324+
1325+
##### To share app
1326+
1327+
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.
1328+
1329+
> **Note**, that you can share only your own applications. You cannot share an application that has been shared with you.
1330+
1331+
1. In My workspace, in the application menu, click **Share**.
1332+
1333+
![](./img/share-app.png)
1334+
1335+
2. If necessary, you can select a specific version of the application you want to share.
1336+
2. 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.
1337+
3. Confirm the action in the dialog window.
1338+
4. Provide the sharing link to the target user with whom you want to share your app.
1339+
1340+
A shared application (or its version if only a specific version has been shared) is labeled with the blue arrow:
1341+
1342+
![](./img/share-app3.png)
1343+
1344+
##### Sharing with editing rights
1345+
1346+
The key distinction between sharing and [publishing](#publish-app) is that sharing allows you to grant not only the rights to use but also editing access to your application.
1347+
1348+
**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.
1349+
1350+
Applications shared with and without editing rights have different scope of actions available for the target user:
1351+
1352+
![](./img/share-app2.png)
1353+
1354+
##### To remove access
1355+
1356+
> **Note**: a shared application is revoked from the shared usage when the apps's name or version is modified by the application owner.
1357+
1358+
You can revoke access for all users with whom you have share the application.
1359+
1360+
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.
1361+
2. Click **Share** in the applications menu.
1362+
3. In the open dialog window, click **Remove access for all users** and confirm the unshare action in the pop-up window.
1363+
1364+
![](./img/revoke.png)
1365+
1366+
##### To unshare app
1367+
1368+
Use **Unshare** to remove the shared with you application from your workspace.
1369+
1370+
> **TIP**: To quickly find all apps that have been shared with you, use the **Source** filter in My workspace.
1371+
1372+
1. In the shared application's menu, click **Unshare**.
1373+
2. Confirm the action in the dialog window.
1374+
1375+
![](./img/share-app4.png)
1376+
13101377
#### Publish App
13111378

13121379
You can publish your custom, quick and code applications to make them accessible to the selected audience in your organization. Refer to [Publications](#publications) to learn more about this functionality and to [Tutorials](/docs/tutorials/collaboration/2.enable-publications.md) for a more extended documentation.
@@ -1348,4 +1415,9 @@ Use Delete in the app's menu to completely delete the selected application. **No
13481415

13491416
![](./img/register-app4.png)
13501417

1418+
#### Application Link
1419+
1420+
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.
1421+
1422+
![](./img/app-link.png)
13511423

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Custom Buttons in DIAL Applications
2+
3+
https://youtu.be/J0-Wati2E_Q
4+
5+
Discover the power of DIAL Buttons, a game-changing feature that revolutionizes user interactions in AI applications. In this video, we dive deep into the world of clickable buttons that extend existing chat functionality, creating more engaging and interactive experiences for DIAL users.
6+
7+
In this video, we'll guide you through:
8+
9+
* Introduction to DIAL Buttons and their types in a short live demo
10+
* Exploration of Action Buttons and Suggestion Buttons
11+
* Insights into how buttons are defined and implemented
12+
* Brief overview of button integrations

0 commit comments

Comments
 (0)