Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/tutorials/3.admin/assets-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

## Introduction

Files in DIAL are arbitrary binary or text assets (JSON, CSV, PDF, images, etc.) your models and applications can reference at runtime.
Files in DIAL are arbitrary binary or text assets (JSON, CSV, PDF, images, etc.) which AI models and/or applications can reference at runtime. Files in DIAL can be stored in BLOB storage or a local file system.

Files are considered to be a protected resource. Refer to [Access Control](/docs/platform/3.core/2.access-control-intro.md) to learn how protected resources are handled in DIAL.

## Main Screen

In Files, you can manage all files in the Public folder.
In Files, you can view and manage all files located the **Public** folder in the DIAL's file system. Files in the Public folder are files published with applications by end users or manually uploaded by administrators.

> 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.
> **Note**: This screen, does not give access to private files of users.

![ ](img/img_35.png)

Expand Down
10 changes: 5 additions & 5 deletions docs/tutorials/3.admin/assets-prompts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## About Prompts

A prompt is an instruction, a question, or a message that a user provides to a language model to receive an answer. Prompts can also contain constraints or requirements. They help the model understand the task at hand and the types of responses that are expected. You can use prompts as templates for your messages, instructions to the model, or to encourage the model to generate specific types of content. In DIAL, you can create prompts beforehand and reuse them in one or several conversations.
Prompts in DIAL can be stored in BLOB storage or a local file system.

> Refer to [DIAL Chat User Guide](/docs/tutorials/0.user-guide.md#prompts) to learn more about prompts and DIAL Chat features.
Prompts are considered to be a protected resource. Refer to [Access Control](/docs/platform/3.core/2.access-control-intro.md) to learn how protected resources are handled in DIAL.

## Main Screen
> Refer to [DIAL Chat User Guide](/docs/tutorials/0.user-guide.md#prompts) to learn more about prompts.

All prompts published by users get into the Public folder. In the Prompts section, you can manage all system and user prompt templates available in the Public folder. All Here, you can also arrange prompts into folders, version them, and then use them in applications or chats.
## Main Screen

> 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.
In Prompts, you can access and manage all prompts in the Public folder. Prompts get to the Public folder if published by users or added by administrators.

![ ](img/img_32.png)

Expand Down
10 changes: 4 additions & 6 deletions docs/tutorials/3.admin/assets-toolsets.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@

## Introduction

Toolsets in DIAL are connections with MCP servers that you can use as tools in [Quick Apps 2.0](/docs/video%20demos/2.Applications/5.quick-apps.md).
Toolsets in DIAL are connections with MCP servers that can be used as tools by any internal or external application to perform specific actions. Refer to [Video Demo](/docs/video%20demos/2.Applications/5.quick-apps.md) to watch how tools are used in [DIAL Quick Apps 2.0](/docs/platform/3.core/7.apps.md#quick-apps-20).

## Main Screen

On the main screen, you can find all publicly-available Toolsets that have either been published by DIAL users or added via a direct modification to [DIAL Core's dynamic settings](https://github.com/epam/ai-dial-core/blob/development/docs/dynamic-settings/toolsets.md).
Toolsets are considered to be a protected resource. Refer to [Access Control](/docs/platform/3.core/2.access-control-intro.md) to learn how protected resources are handled in DIAL.

Publicly-available toolsets can be accessed via [DIAL Core API](https://dialx.ai/dial_api#tag/Deployment-listing/operation/getToolSets) or [DIAL Marketplace](/docs/platform/4.chat/1.marketplace.md) by all authorized users and apps.
## Main Screen

> 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.
On the main screen, you can find all Toolsets located in the Public folder. Such toolsets have either been published by DIAL users or added by administrators.

![ ](img/131.png)

Expand Down
129 changes: 77 additions & 52 deletions docs/tutorials/3.admin/deployments-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ On the main screen, you can see all the available and add new images for MCP Ser

![](img/deployment_images.png)

##### Images Grid

| Column | Description |
|----------------|--------------------------------------------------------------|
| ID | Unique identifier of the image. |
| Version | Version of the image. |
| Name | Name of the image. |
| Description | Brief description of the image. |
| Type | Type of the image (MCP or Interceptor). |
| Source | Image or a Source code.|
| Status | Current status of the image. |
| Update time | Date and time when the image was last updated. |
| Create time | Date and time when the image was created. |
| Topics | List of topics associated with the image. |
| Transport type | Transport type used by the MCP image:<br />- **Remote** (HTTP/SSE)<br />- **Local** (STDIO).|
| Actions | Buttons to manage the selected image:<br/>- **Delete**: click to remove the image.<br/>- **Duplicate**: click to create a copy of the image.<br/>- **Open in a new tab**: click to open image properties in a new tab in your browser. |
##### Images grid

| Column | Description |
|--------|-------------|
| ID | Unique identifier of the image. |
| Version | Version of the image. |
| Name | Name of the image. |
| Description | Brief description of the image. |
| Type | Type of the image (MCP or Interceptor). |
| Source | Image or a Source code. |
| Status | Current status of the image. |
| Update time | Date and time when the image was last updated. |
| Create time | Date and time when the image was created. |
| Topics | List of topics associated with the image. |
| Transport type | Transport type used by the MCP image:<br />- **Remote** (HTTP/SSE)<br />- **Local** (STDIO). |
| Actions | Buttons to manage the selected image:<br/>- **Delete**: Use to remove the image.<br/>- **Duplicate**: Use to create a copy of the image.<br/>- **Open in a new tab**: Use to open image properties in a new tab in your browser. |

## Add Image

Expand All @@ -36,19 +36,27 @@ On the main screen, you can add new images for MCP Servers and Interceptors.
1. Click the **+Add** button on the main screen to open the **Adding Image** form.
2. Populate the required fields and click **Add** to add the image.

| Field | Required |Description |
|----------------|-----------|---------------------------------------------------|
| Name | Yes | Name of the image. |
| Description | No | Brief description of the image. |
|Version | Yes |Version of the image. |
| Type | Yes |Type of the image (MCP or Interceptor). |
|Source type| Conditional | **Note**: Required for MCP type.<br />The source type of the Docker image:<br />- **Docker Image**<br />- **Source Code**|
|Docker image URI| Conditional| URI of the Docker image.<br/>Applies to both MCP (if Source type = Docker image) and Interceptor types.|
|Source code repository parameters| Conditional |Applies if Type = MCP Image and Source type = Source code .<br/>- **Repo URL**: a source code repository URL. **Required**<br />- **Branch name**: the name of the branch in the source code repository.<br />- **SHA**: the SHA in the source code repository.|
| Field | Required | Description |
|-------|----------|-------------|
| Name | Yes | Name of the image. |
| Description | No | Brief description of the image. |
| Version | Yes | Version of the image. |
| Type | Yes | Type of the image (MCP or Interceptor). |
| Source type | Conditional | **Note**: Required for MCP type.<br />The source type of the Docker image:<br />- **Docker Image**<br />- **Source Code** |
| Docker image URI | Conditional | URI of the Docker image.<br/>Applies to both MCP (if Source type = Docker image) and Interceptor types. |
| Source code repository parameters | Conditional | Applies if Type = MCP Image and Source type = Source code .<br/>- **Repo URL**: a source code repository URL. **Required**<br />- **Branch name**: the name of the branch in the source code repository.<br />- **SHA**: the SHA in the source code repository. |

![ ](img/add_image.png)

## Configuration Screen
## Global firewall

On the main screen, click **Global firewall** to define a list of domain names allowed to access all deployed images. This is a security feature that restricts incoming requests, so only trusted domains (such as your company’s website or specific client applications) have access.

**Domain name requirements**: Enter the domain name without protocol, e.g., github.com. Each domain must have at least one dot, labels can include letters, numbers, and hyphens (1–63 chars, not starting or ending with a hyphen), and the top-level domain must be at least 2 letters.

![ ](img/images_global_firewall.png)

## Configuration

Click any image from the main screen to open its configuration screen.

Expand All @@ -58,55 +66,72 @@ On the configuration screen, you can view and edit the selected image settings.

In the header of the Configuration screen, you can find the following action buttons:

| Action | Description |
|----------------|--------------------------------------------------------------|
| Version| Click to create a new image version or display configuration of a selected version.|
| Create Interceptor/MCP Container | Enabled for the installed images.<br />Click to create a new [MCP](/docs/tutorials/3.admin/deployments-mcp.md) or [Interceptor](/docs/tutorials/3.admin/deployments-interceptors.md) container based on the selected image. |
| Install | Enabled for not installed images.<br />Click to install the selected version of an image. |
| Delete | Click to delete the selected image. |
| Action | Description |
|--------|-------------|
| Version | Click to create a new image version or display configuration of a selected version. |
| Create Interceptor/MCP Container | Enabled for the installed images.<br />Click to create a new [MCP](/docs/tutorials/3.admin/deployments-mcp.md) or [Interceptor](/docs/tutorials/3.admin/deployments-interceptors.md) container based on the selected image. |
| Install | Enabled for not installed images.<br />Click to install the selected version of an image. |
| Delete | Click to delete the selected image. **Note**: Deleted image will effect the related containers. |

![ ](img/image_actions.png)

### Properties

In the Properties tab, you can preview and modify selected image's basic properties.

| Field | Required | Editable | Description |
|----------------|-----------|---------|---------------|
| ID | - | No | Unique identifier of the image. |
|Type| - | No | Type of the image (MCP or Interceptor). |
|Creation Time| - | No | Date and time when the image was created. |
|Updated Time| - | No | Date and time when the image was last updated. |
|Source type|-| No | Source type of the Docker image:<br />- **Docker Image**<br />- **Source Code**|
|Status| - | No | Current status of the image. |
| Name | Yes | Yes | Name of the image. |
| Description | No | Yes | Brief description of the image. |
|Maintainer | No | Yes | The maintainer of the image. |
|Topics | No | Yes | List of topics associated with the image. |
|Source type| Conditional | Yes | **Note**: Required for MCP type of image.<br />The source type of the Docker image:<br />- **Docker Image**<br />- **Source Code**|
|Docker image URI| Conditional| Yes| URI of the Docker image.<br/>Applies to both MCP (if Source type = Docker image) and Interceptor types.|
|Source code repository parameters| Conditional | Yes |Applies if Type = MCP Image and Source type = Source code .<br/>- **Repo URL** (required): a source code repository URL.<br />- **Branch name**: the name of the branch in the source code repository.<br />- **SHA**: the SHA in the source code repository.<br />- **Base directory**: the directory path with the Docker file. |
|MCP transport type|Conditional| Yes |Applies only to MCP type of image.<br/>The transport type used by the MCP image:<br />- **Remote** (HTTP/SSE)<br />- **Local** (STDIO).|
| Field | Required | Editable | Description |
|-------|----------|----------|-------------|
| ID | - | No | Unique identifier of the image. |
| Type | - | No | Type of the image (MCP or Interceptor). |
| Creation Time | - | No | Date and time when the image was created. |
| Updated Time | - | No | Date and time when the image was last updated. |
| Source type | - | No | Source type of the Docker image:<br />- **Docker Image**<br />- **Source Code** |
| Status | - | No | Current status of the image. |
| Name | Yes | Yes | Name of the image. |
| Description | No | Yes | Brief description of the image. |
| Maintainer | No | Yes | The maintainer of the image. |
| Topics | No | Yes | List of topics associated with the image. |
| Source type | Conditional | Yes | **Note**: Required for MCP type of image.<br />The source type of the Docker image:<br />- **Docker Image**<br />- **Source Code** |
| Docker image URI | Conditional | Yes | URI of the Docker image.<br/>Applies to both MCP (if Source type = Docker image) and Interceptor types. |
| Source code repository parameters | Conditional | Yes | Applies if Type = MCP Image and Source type = Source code .<br/>- **Repo URL** (required): a source code repository URL.<br />- **Branch name**: the name of the branch in the source code repository.<br />- **SHA**: the SHA in the source code repository.<br />- **Base directory**: the directory path with the Docker file. |
| MCP transport type | Conditional | Yes | Applies only to MCP type of image.<br/>The transport type used by the MCP image:<br />- **Remote** (HTTP/SSE)<br />- **Local** (STDIO). |

![ ](img/image_properties.png)

**Advanced users with technical expertise** can work with image properties in the table or a JSON editor view modes. It is useful for advanced scenarios of bulk updates, copy/paste between environments, or tweaking settings not exposed on UI.

![ ](img/image_json_editor.png)

### Build log
### Firewall settings

> This tab is enabled for installed images.
In this section, you can define a list of authorized domain names for the selected image and preview a list of [globally-authorized](#global-firewall) domain names.

The Build Log tab displays the complete output generated during the image build process. Here you can view the step-by-step execution of build instructions, including command outputs, warnings, and errors that occurred during image creation.
**Domain name requirements**: Enter the domain name without protocol, e.g., github.com. Each domain must have at least one dot, labels can include letters, numbers, and hyphens (1–63 chars, not starting or ending with a hyphen), and the top-level domain must be at least 2 letters.

![ ](img/image_build_log.png)
![ ](img/image-firewall.png)

### Related Containers

> This tab is enabled for installed images.

The Related Containers tab displays all [MCP](/docs/tutorials/3.admin/deployments-mcp.md) or [Interceptor](/docs/tutorials/3.admin/deployments-interceptors.md) containers related to the selected version of the image.

##### Add containers

You can link containers to this image or a specific version of it. When you add a container here, it will automatically use the selected image version in its configuration.

**Note**: Every container must be linked to an image or image version. Once linked, you cannot remove the container from this list—you can only change which image it uses.

1. Click **Add** to invoke the adding modal.
2. In the modal, you can enable/disable the **Show containers related to this image** toggle to display containers related to this particular image or not.
3. Select one or several containers and click **Apply**. **Important**: Running containers will be restarted with the new image.

![ ](img/image_related_containers.png)

### Installation log

> This tab is enabled for installed images.

The Build Log tab displays the complete output generated during the image build process. Here you can view the step-by-step execution of build instructions, including command outputs, warnings, and errors that occurred during image creation.

![ ](img/image_build_log.png)
Loading