Skip to content

Commit 3f49454

Browse files
committed
review agentic page
1 parent a108ff7 commit 3f49454

File tree

3 files changed

+47
-30
lines changed

3 files changed

+47
-30
lines changed

docs/platform/0.architecture-and-concepts/4.agentic-platform.md

Lines changed: 36 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,79 +2,88 @@
22

33
## Introduction
44

5-
DIAL can serve as Agentic Platform, where any existing agent can be used as a building block to create a new agent. You can build simple conversational agents or powerful multi-agent and multi-modal applications solving specific business tasks.
5+
DIAL can serve as an [Agentic Platform](https://dialx.ai/agentic-platform), where any existing agent can be used as a building block to create a new agent. You can build simple conversational agents or powerful multi-agent and multi-modal applications solving specific business tasks.
66

77
##### What is agent?
88

9-
**Agents** in DIAL, are all available [language models](#model-adapter) and [DIAL-native applications](#dial-native-app).
9+
Agents in DIAL, are all available [language models](#model-adapters) and [DIAL-native applications](#create-dial-native-app).
1010

1111
## How to use agents?
1212

1313
##### End-users
14-
In [DIAL Marketplace](/docs/tutorials/0.user-guide.md#dial-marketplace), you can access all agents that are available to you based on your role and permissions. To use an agent, [select it](/docs/tutorials/0.user-guide.md#converse) and start a conversation. When using a multi-agent application, agents are selected and assigned to designated tasks automatically. If the application allows this, it is possible to switch an agent during the ongoing conversation in the [conversation settings](/docs/tutorials/0.user-guide.md#conversation-settings).
14+
In [DIAL Marketplace](/docs/platform/4.chat/1.marketplace.md), you can find all agents available to you (or any other user) based on your user's roles and permissions.
1515

16-
##### Developers
16+
> Watch a [demo video](/docs/video%20demos/1.Chat/2.marketplace.md) to learn more about DIAL Marketplace.
1717
18-
DIAL simplifies application development by allowing you to build applications using agents as modular components. This approach removes the need to duplicate existing functionalities, saving time and effort. The platform utilizes a [Unified API of DIAL](https://dialx.ai/dial_api), which provides a standardized interface (OpenAI API compatible) for interacting with all available in DIAL applications and models, simplifying the development process.
18+
![](./img/dial-marketplace.png)
1919

20-
DIAL offers a selection of pre-built agents and also enables users to access agents developed by others. These user-created agents can be shared and made available within the community, providing additional flexibility and opportunities to reuse existing solutions. This modular and collaborative approach improves development efficiency and accelerates the application-building process.
20+
To use an agent, [select it](/docs/tutorials/0.user-guide.md#converse) and start a conversation. When using a multi-agent application, agents are selected and assigned to designated tasks automatically. If the application allows this, it is possible to switch agents during the ongoing conversation in the [conversation settings](/docs/tutorials/0.user-guide.md#conversation-settings).
2121

22-
> Refer to [ChatHub video demo](/docs/video%20demos/2.Applications/3.dial-chathub.md) to see the example of a multi-agent application that can be built on the DIAL Platform.
22+
##### Developers
2323

24-
## Available agents
24+
DIAL simplifies application development by allowing you to build applications using agents as modular components. This approach removes the need to duplicate existing functionalities, saving time and effort. The platform utilizes a [Unified API of DIAL](https://dialx.ai/dial_api), which provides a standardized interface (OpenAI API compatible) for interacting with all available in DIAL applications and models, simplifying the development process.
2525

26-
All agents available to a wide audience or a specific user can be found in [DIAL Marketplace](/docs/platform/4.chat/1.marketplace.md), which gives access to specific agents based on user role and permissions.
26+
:cloud: DIAL SaaS edition includes powerful pre-built agents such as [DIAL ChatHub](/docs/video%20demos/2.Applications/3.dial-chathub.md), [DIAL RAG](/docs/video%20demos/2.Applications/1.dial-rag.md), [DIAL Web RAG](/docs/video%20demos/2.Applications/2.dial-web-rag.md) which you can reuse in your apps as building blocks following the [unified protocol](https://dialx.ai/dial_api) of DIAL. Provided you have corresponding permissions, you can access agents built by other users as well and use them as building blocks in your apps. Agents can be shared and made available within the community, providing additional flexibility and opportunities to reuse existing solutions.
2727

28-
DIAL includes powerful pre-built agents such as [DIAL ChatHub](/docs/video%20demos/2.Applications/3.dial-chathub.md), [DIAL RAG](/docs/video%20demos/2.Applications/1.dial-rag.md), [DIAL Web RAG](/docs/video%20demos/2.Applications/2.dial-web-rag.md) which you can reuse in your agents as building blocks following [DIAL API](https://dialx.ai/dial_api).
28+
> Refer to [ChatHub video demo](/docs/video%20demos/2.Applications/3.dial-chathub.md) to see the example of a multi-agent application that can be built on the DIAL Platform.
2929
3030
## Create DIAL-Native App
3131

32-
**DIAL-native apps** have API that adheres to [Unified API of DIAL](https://dialx.ai/dial_api).
32+
**DIAL-native apps** have API that adheres to the [unified protocol](https://dialx.ai/dial_api) of DIAL.
33+
34+
> Refer to [Tutorials](/docs/tutorials/1.developers/4.apps-development/3.enable-app.md#dial-native-applications) to learn more about DIAL-native applications and how to enable them in DIAL
3335
3436
##### How to create a DIAL-native application:
3537

36-
1. You can create DIAL-native apps using [DIAL SDK](https://github.com/epam/ai-dial-sdk/blob/development/README.md) following [DIAL API](https://dialx.ai/dial_api). The DIAL API supports tool calling, allowing your apps to interact with external services to perform specific actions.
38+
**Development**: You can develop DIAL-native apps using [DIAL SDK](https://github.com/epam/ai-dial-sdk/blob/development/README.md) following [DIAL API](https://dialx.ai/dial_api). The unified protocol of DIAL supports tool calling, seeds, token usage, streaming and more. Refer to [DIAL Core](/docs/platform/0.architecture-and-concepts/3.components.md#ai-dial-core) to learn more about unified protocol features.
3739

38-
> * Refer to [Tutorials](/tutorials/developers/apps-development/enable-app) to learn how to register your apps in DIAL to use them.
39-
> * Refer to [Cookbook examples](docs/tutorials/1.developers/4.apps-development/3.multimodality/dial-cookbook/examples/how_to_call_text_to_text_applications.mdx) to learn how to create apps of different modalities.
40-
> * Refer to [Demo Video](/docs/video%20demos/3.Developers/Applications/5.develop-application.md) to learn how to develop a simple application.
40+
> * Having your app running, refer to [Tutorials for developers](/tutorials/developers/apps-development/enable-app) to learn how to enable it in DIAL and allow others to use it.
41+
> * Refer to [Cookbook examples](docs/tutorials/1.developers/4.apps-development/3.multimodality/dial-cookbook/examples/how_to_call_text_to_text_applications.mdx) to learn how to create apps of different modalities.
42+
> * Refer to [Demo Video](/docs/video%20demos/3.Developers/Applications/5.develop-application.md) to learn how to develop a simple application.
43+
> * Watch a [demo video](/docs/video%20demos/3.Developers/3.dial-unified-api.md) about the unified protocol of DIAL.
4144
42-
2. DIAL SaaS edition also includes [application types](#application-types) - predefined templates to create DIAL-native apps of specific types using UI wizards.
45+
**UI Wizards**: [Schema-rich applications](/docs/tutorials/1.developers/4.apps-development/3.enable-app.md#schema-rich-applications) can support UI wizards allowing end-users to create apps of specific [application types](#application-types).
4346

44-
> * Refer to [Tutorials](/tutorials/developers/apps-development/enable-app) to learn how to enable your apps in DIAL to use them.
47+
> * Refer to [user guide](/docs/tutorials/0.user-guide.md#applications) to learn how to create applications using UI wizards.
48+
> * Refer to [Tutorials for developers](/tutorials/developers/apps-development/enable-app#enable-schema-rich-applications) to learn how to enable schema-rich apps in DIAL.
4549
4650

4751
### Application Types
4852

49-
DIAL SaaS editon includes application types: Quick app, Code app and Mindmap. Application types can be seen as templates for creating custom implementations of specific DIAL-native applications. One of the main advantages of application types, is that they allow adding [application wizards](/docs/tutorials/0.user-guide.md#application-builder) on UI for end-users to create apps in a low and no-code manner.
53+
Application types can be seen as schema-rich templates for creating custom implementations of specific application types. One of the main advantages of application types, is that they allow adding [application wizards](/docs/tutorials/0.user-guide.md#application-builder) on UI for end-users to create/edit apps in a low and no-code manner.
5054

51-
> Self-hosted deployments of DIAL allow you to add new application types that can use fully custom UI and application wizard.
55+
:cloud: DIAL SaaS edition includes application types: Quick app, Code app and Mindmap.
5256

53-
> * Refer to [Developer Tutorials](/tutorials/developers/apps-development/enable-app) to learn more.
57+
:floppy_disk: In self-hosted deployments of DIAL you can add new application types that can implement any logic, use fully custom UI (even non-conversational) and custom application wizard.
58+
59+
> Refer to [Developer Tutorials](/tutorials/developers/apps-development/enable-app) to learn how to enable DIAL-native apps.
5460
5561
#### Quick Apps
5662

57-
DIAL Quick Apps are conceptually similar to OpenAI's GPT. Quick Apps do not contain any programming code (they can include a toolset, description and instruction to the language model, attachments with documents) and enable you to rapidly build an application right within DIAL Chat, use it, and share it with others. Quick Apps can be used to simplify a workflow or carry out a specific task. For example, you can create a Quick App with a toolset allowing it to call an external API to get a real-time weather forecast for a specific location., or a RAG-like application that will genrate responses based on the provided sources.
63+
Quick apps are conceptually similar to OpenAI's GPT. Quick apps do not contain any programming code (they can include a toolset, a description and instruction to the language model, attachments with documents) and enable you to rapidly build an application right within the DIAL UI, use it, and share it with others.
64+
65+
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 will genrate responses based on the provided sources.
5866

5967
> * Watch a [Demo Video](/docs/video%20demos/2.Applications/5.quick-apps.md) with an introduction to Quick Apps.
6068
> * Refer to [User guide](/docs/tutorials/0.user-guide.md#add-quick-app) to learn how to add Quick Apps.
6169
6270
#### Code Apps
6371

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

6674
> * Watch a [Demo Video](/docs/video%20demos/2.Applications/4.code-apps.md) with an introduction to Code Apps.
6775
> * Refer to [User guide](/docs/tutorials/0.user-guide.md#add-code-app) to learn how to add Code Apps.
6876
6977
#### Mindmaps
7078

71-
Mindmap enables users to explore information through an interactive knowledge graph and using natural language. You can use this application type to create an app 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.
79+
Mindmap enables users to explore information through an interactive knowledge graph and using natural language. You can use this application type to create an app which 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. The [home page](https://dialx.ai/) of the DIALX landing website is built using this technology.
7280

73-
> Watch [Demo Video](/docs/video%20demos/2.Applications/mindmap-studio.md) to see the AI DIAL Mindmap Studio in action.
81+
> * Watch [Demo Video](/docs/video%20demos/2.Applications/mindmap-studio.md) to see DIAL Mindmap Studio in action.
82+
> * Refer to solutions to see implementations in specific industries: [Caspase-2 Article Visualization](https://dialx.ai/solutions/scientific-literature-knowledge-graph), [OMICS AI Assistant](https://dialx.ai/solutions/omics-data-assistant), [Visualization of Cinematic Universe](https://dialx.ai/solutions/lotr-universe-case)
7483
75-
## Add Model Adapter
84+
## Model Adapters
7685

77-
[Unified API of DIAL](https://dialx.ai/dial_api) is compatible with OpenAI API, making it simple to add new adapters for language models or develop them with [DIAL SDK](https://github.com/epam/ai-dial-sdk/blob/development/README.md).
86+
DIAL includes connectors to all major LLM vendors such as Amazon Bedrock, Google Vertex AI, and Azure OpenAI. You can also work with open-source and micro models, self-hosted or models listed on HuggingFace or DeepSeek.
7887

79-
> Refer to [available language models](/docs/platform/2.supported-models.md) to see the list of supported models and available adapters.
88+
> Refer to [available language models](/docs/platform/2.supported-models.md) to see the list of supported models and available model adapters.
8089
276 KB
Loading

docs/tutorials/1.developers/4.apps-development/3.enable-app.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ This goes beyond simply adjusting the basic settings of an application container
1919

2020
[Schema-rich applications](#enable-schema-rich-applications) are defined by a JSON schema that conforms to the main [meta schema](https://github.com/epam/ai-dial-core/blob/development/config/src/main/resources/custom-application-schemas/schema). Meta schema specifies the application type's structure, including properties and endpoints (completion, configuration, and other). Meta schema may also include a URL for an application editor (enabling a wizard in the UI for creating/editing applications), a URL for a custom application UI, [custom buttons](/docs/tutorials/1.developers/4.apps-development/1.custom-buttons.md) used by the application.
2121

22-
Schema-rich applications are usually associated with a specific **Application Type** - a template for creating applications of that type. DIAL SaaS edition includes application types such as Quick app, Code app and Mindmap. In self-hosted deployments of DIAL, you can add new application types, featuring custom application UI (`applicationTypeViewerUrl`) and wizards (`applicationTypeEditorUrl`) and enabling end-users to create applications of that type. Refer to [Agentic Platform](/docs/platform/0.architecture-and-concepts/4.agentic-platform.md#application-types) to learn more about available application types.
22+
Schema-rich applications are usually associated with a specific **Application Type** - a template for creating applications of that type.
23+
24+
:cloud: DIAL SaaS edition includes application types such as Quick app, Code app and Mindmap.
25+
26+
:floppy_disk: In self-hosted deployments of DIAL, you can add new application types, featuring custom application UI (`applicationTypeViewerUrl`) and wizards (`applicationTypeEditorUrl`) and enabling end-users to create applications of that type. Refer to [Agentic Platform](/docs/platform/0.architecture-and-concepts/4.agentic-platform.md#application-types) to learn more about available application types.
2327

2428
##### Applications without schemas
2529

@@ -73,7 +77,11 @@ The configuration of the enabled app is saved as a BLOB in the DIAL Core file sy
7377

7478
#### UI Wizard
7579

76-
Schemas of application types can include `applicationTypeEditorUrl` to enable users to create and edit applications using UI wizards. Self-hosted deployment of DIAL gives you an opportunity to create custom wizards for your application types. SaaS DIAL edition includes wizards for Quick app, Code app and Mindmap application types.
80+
Schemas of application types can include `applicationTypeEditorUrl` to enable users to create and edit applications using UI wizards.
81+
82+
:cloud: SaaS DIAL edition includes wizards for Quick app, Code app and Mindmap application types.
83+
84+
:floppy_disk: Self-hosted deployment of DIAL gives you an opportunity to create custom wizards for your application types.
7785

7886
> Refer to [User guide](/docs/tutorials/0.user-guide.md#applications) to learn how to create applications using wizards.
7987

@@ -245,7 +253,7 @@ In this example, the files listed in the `rag_files` field will automatically fo
245253

246254
## Enable NOT DIAL-Native Apps
247255

248-
**In self-hosted deployments of DIAL**, you can integrate your conversational (implementing a completion endpoint) or non-conversational apps into DIAL, even if they don't follow the unified protocol of DIAL.
256+
:floppy_disk: In self-hosted deployments of DIAL, you can integrate your conversational (implementing a completion endpoint) or non-conversational apps into DIAL, even if they don't follow the unified protocol of DIAL.
249257

250258
##### Custom UIs
251259

0 commit comments

Comments
 (0)