DIAL Chat

    <a href="https://dialx.ai/">
      <img src="https://dialx.ai/logo/dialx_logo.svg" alt="About DIALX">
    </a>

• Overview
• Documentations 📄
• Development 🛠️
• Install
• Build
• Serve
• Tests
• Publish
  • Dry Mode

Overview

DIAL Chat is a default UI for DIAL. DIAL can be used as headless system, but UI is recommended to learn the capability.

Originally forked from chatbot-ui and then completely reworked and published under apache 2.0 license, while code taken from original repository is still subject to original MIT license. Due to rework we introduced lots of new features such as various IDP support, model side-by-side compare, DIAL extensions support, conversation replays, branding and many more.

[!IMPORTANT] This repository is managed as monorepo by NX tools.

Documentations 📄

• DIAL Chat documentation placed here.
• DIAL Chat Theming documentation is placed here.
• DIAL Overlay documentation is placed here.
• DIAL Chat Visualizer Connector documentation is placed here.
• DIAL Visualizer Connector documentation is placed here.
• DIAL Custom Viewers documentation is placed here.
• Isolated view mode is described in documentation.

[!TIP] In DIAL repository, you can find a user guide for the DIAL Chat application.

Development 🛠️

To work with this repo we are using NX.

Note: All commands could be found in scripts section in package.json.

Install

npm i

Build

Run this command to build all projects which support this target (chat, overlay-sandbox):

npm run build

Serve

To run the project, it is recommended to use npm run nx serve with the specified project name:

npm run nx serve project-name

Tests

Run this command to run tests for the full repository:

npm run test

Publish

Run this command to initiate npm publish for all publishable libraries:

npm run publish -- --ver=*.*.* --tag=* --dry

Parameters (all optional):

ver - version to publish
tag - distribution tag to publish with (default: 'next')
dry - dry run

Dry Mode

In dry mode, nothing is published, just displayed on the screen:

npm run publish -- --dry

or

npm run publish:dry