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/3.admin/assets-applications.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,21 +2,21 @@
2
2
3
3
## Introduction
4
4
5
-
DIAL-native applications adhere to the [unified protocol](/docs/platform/3.core/0.about-core.md#unified-api) of DIAL, a single protocol for all applications and models deployed in a specific DIAL instance.
5
+
In DIAL, applications created by users (either using DIAL Core API or UI) are stored in a private folder of a dedicated user in the file storage and are not accessible by anyone but the application author (owner). To enable other users to access them, based on explicitly defined access rules, applications can be published (or manually placed in the Public folder by administrators).
6
6
7
-
> Refer to [DIAL Core](/docs/platform/3.core/7.apps.md) to learn more about applications in DIAL.
7
+
> Refer to [Entities/Applications](/docs/tutorials/3.admin/entities-applications.md) to learn about applications in DIAL.
8
8
9
9
## Main Screen
10
10
11
-
Applications, when added via DIAL Core configuration files or published by users are placed in the Public folder. The main screen displays all the applications available in Public folder in DIAL.
11
+
The Assets/Applications screen displays all applications located in the Public folder in DIAL file storage. Applications get to the Public folder when published by users or added by administrators.
12
12
13
13
> Refer to [Access Control](/docs/platform/3.core/2.access-control-intro.md) to lean more about Private and Public logical spaces for objects storage in DIAL.
14
14
15
15
16
16
17
17
##### Folders Structure
18
18
19
-
Objects in the [Public space](/docs/platform/3.core/2.access-control-intro.md) are arranged hierarchically, similar to a file system. In this part of the screen, you can see the hierarchical structure of folders in the Public space.
19
+
Objects in the [Public folder](/docs/platform/3.core/2.access-control-intro.md) are arranged hierarchically, similar to a file system. In this part of the screen, you can see the hierarchical structure of folders in the Public folder.
Copy file name to clipboardExpand all lines: docs/tutorials/3.admin/builders-adapters.md
+45-40Lines changed: 45 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,87 +7,92 @@ In DIAL, **model adapters** unify provider-specific model APIs with the **Unifie
7
7
***Coded implementation** that talks to the AI model and implements the Unified Protocol.
8
8
***Metadata object** that you manage in **Builders/Adapters**, which establishes the relationship to the **models**.
9
9
10
-
DIAL includes adapters for [Azure OpenAI](https://github.com/epam/ai-dial-adapter-openai) models, [GCP Vertex AI](https://github.com/epam/ai-dial-adapter-vertexai/?tab=readme-ov-file#supported-models) models, and [AWS Bedrock](https://github.com/epam/ai-dial-adapter-bedrock) models. You can also create custom adapters for other AI models with [DIAL SDK](https://github.com/epam/ai-dial-sdk).
10
+
DIAL includes adapters for [Azure OpenAI](https://github.com/epam/ai-dial-adapter-openai) models, [GCP Vertex AI](https://github.com/epam/ai-dial-adapter-vertexai/?tab=readme-ov-file#supported-models) models, and [AWS Bedrock](https://github.com/epam/ai-dial-adapter-bedrock) models.
11
11
12
-
> Refer to [Adapters documentation](/docs/platform/0.architecture-and-concepts/3.components.md#model-adapters) to learn more.
12
+
Compatibility with Azure OpenAI API, makes it simple to add new adapters for language models or develop them with [DIAL SDK](https://github.com/epam/ai-dial-sdk).
13
13
14
14
## Main Screen
15
15
16
16
The main screen displays all registered adapters in your DIAL instance.
17
17
18
18
19
19
20
-
##### Adapters Grid
20
+
##### Adapters grid
21
21
22
-
| Column | Definition |
23
-
|-------------------|---------------------|
24
-
|**ID**| The adapter’s unique name (identifier). |
25
-
|**Display Name**| A user-friendly label for the adapter. Helps you pick the right adapter when creating a new model. |
26
-
|**Description**| Free-text notes about the adapter’s purpose (e.g., “Adapter for OpenAI models”). |
27
-
|**Updated time**|Timestamp of the last update to this adapter's configuration. Useful to track recent changes. |
22
+
| Column | Description |
23
+
|--------|-------------|
24
+
|**ID**| Unique identifier of the adapter. |
25
+
|**Display Name**| Name of the adapter displayed on UI. |
26
+
|**Description**| Brief description of the adapter (e.g., "Adapter for OpenAI models"). |
27
+
|**Updated time**| Timestamp of the last update to this adapter's configuration. Useful to track recent changes. |
28
+
|**Topics**| Semantic tags associated with adapter. |
28
29
29
30
## Create
30
31
31
-
On the main scree, you can add new adapters to your instance of DIAL:
32
+
On the main screen, you can add new adapters by following these steps:
32
33
33
34
1. Click **+ Create** to invoke the **Adapter** modal.
|**ID**| Yes | A unique identifier for this adapter. |
39
-
|**Display name**| No | A user-friendly name of the adapter. |
40
-
|**Description**| No | Free-text notes about what this adapter is for. |
41
-
|**Base endpoint**| Yes | The base URL of the adapter service that implements the Unified Protocol. Is the base URL part of the model completion endpoint if one created based on the adapter. |
36
+
| Field | Required |Description|
37
+
|-------|----------|------------|
38
+
|**ID**| Yes | Unique identifier.|
39
+
|**Display name**| Yes | Unique name of the adapter displayed on UI.|
40
+
|**Description**| No | Description of the adapter.|
41
+
|**Base endpoint**| Yes | Base URL of the adapter service that implements the Unified Protocol (following the format: `{ADAPTER_ORIGIN}/openai/deployments/`). |
42
42
43
43
3. Once all required fields are filled, click **Create**. The dialog closes and the new adapter's configuration screen is opened. A new adapter will appear immediately on the main screen once it is created.
44
44
45
-
45
+
46
46
47
47
## Configuration
48
48
49
49
Click any adapter on the main screen to open its configuration page.
50
50
51
51
##### Top Bar Controls
52
52
53
-
***Create Model**: Use to create a model deployment using the selected model adapter. Created models will be available in the [Entities → Models](/docs/tutorials/3.admin/entities-models.md) section.
53
+
***Create Model**: Use to create a model deployment using the selected model adapter as a source type. Created models will be available in the [Entities → Models](/docs/tutorials/3.admin/entities-models.md) section.
54
54
***Delete**: Use to remove the adapter itself and all models utilizing it. After confirmation - the adapter and all related models are deleted.
55
+
***Save**: Use to save and apply any changes.
56
+
***Discard**: Use to discard any unsaved changes. You can revert changes in the [Audit](#audit) section.
55
57
***JSON Editor** (Toggle): Switch between the form-based UI and raw [JSON view](#json-editor) of the adapter's configuration. Use JSON mode for copy-paste or advanced edits.
56
58
59
+
60
+
57
61
### Properties
58
62
59
63
In the Properties tab, you can view and define identity and metadata of the selected adapter.
|**Display name**| Yes | Yes |A user-friendly name of the adapter. |
67
-
|**Description**| No | Yes |Free-text notes about what this adapter is for. |
68
-
|**Base endpoint**| Yes | Yes |The base URL of the adapter service that implements the Unified Protocol. Is the base URL part of the model completion endpoint if created based on the adapter. |
65
+
| Field | Required | Editable | Description |
66
+
|-------|----------|----------|-------------|
67
+
|**ID**| - | No | Unique identifier. |
68
+
|**Updated Time**| - | No | Timestamp of the last update to this adapter's configuration. Useful to track recent changes. |
69
+
|**Creation Time**| - | No | Adapter creation timestamp. |
70
+
|**Display Name**| Yes | Yes | Unique name of the adapter displayed on UI. |
71
+
|**Description**| No | Yes | Brief description of the adapter. |
72
+
|**Base endpoint**| Yes | Yes | Base URL of the adapter service that implements the Unified Protocol (following the format: `{ADAPTER_ORIGIN}/openai/deployments/`). |
73
+
|**Topics**| No | Yes |Semantic tags associated with adapter. |
69
74
70
-
75
+
71
76
72
77
### Models
73
78
74
-
In the **Models** tab, you can manage all models this adapter exposes.
79
+
In the **Models** tab, you can view and add AI models exposed by the selected adapter.
|**Display Name**| A user-friendly name of the model that will be displayed on UI.|
80
-
|**Description**| A free-text description of the model|
81
+
|Field | Description |
82
+
|-------|-------------|
83
+
|**ID**| Model's identifier. |
84
+
|**Display Name**| Name of the AI model displayed on UI. |
85
+
|**Description**| Description of the model.|
81
86
82
-
87
+
83
88
84
89
#### Add
85
90
86
-
You can add new models that will be processed by the selected adapter.
91
+
You can add AI models that will be processed by the selected adapter.
87
92
88
93
1. Click **+ Add**.
89
94
2.**Select** one or more available models in the modal window. You can check all the available models in the [Entities → Models](/docs/tutorials/3.admin/entities-models.md) section. You can also use **+ Create Model** button [on this screen](#top-bar-controls) to create a new model on the fly.
90
-
3.**Confirm** to insert them into the table.
95
+
3.Click **Apply** to insert them into the table.
91
96
92
97
#### Remove
93
98
@@ -98,11 +103,11 @@ You can remove models processed by the adapter.
98
103
99
104
### Audit
100
105
101
-
In the **Audit** tab, you can monitor activities related to the selected adapter.
106
+
On this screen, you can access a detailed preview and revert any changes made to the selected AI model adapter.
102
107
103
-
#### Activities
108
+
> **TIP**: This section mimics the functionality available in the global [Audit → Activities](/docs/tutorials/3.admin/telemetry-activity-audit.md) menu, but is scoped specifically to the selected AI model adapter.
104
109
105
-
The Activities section provides detailed visibility into all changes made to the selected adapter. This section mimics the functionality available in the global [Audit → Activities](/docs/tutorials/3.admin/telemetry-activity-audit.md) menu, but is scoped specifically to the selected adapter.
0 commit comments