Skip to content

Latest commit

 

History

History
88 lines (56 loc) · 2.51 KB

README.md

File metadata and controls

88 lines (56 loc) · 2.51 KB
Raw

DIAL Chat

DIAL Chat is a default UI for AI DIAL. AI 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.

ai-dial-chat

Overview

This repository is managed as monorepo by NX tools.

Docs

  • 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.

In AI DIAL repository, you can find a user guide for the AI 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 --development

Parameters (all optional):

ver - version to publish
dry - dry run
tag - tag to publish with (default: 'next')
development - if set without a version provided, will increment a version automatically according to the current version of the global package.json version (e.g. 0.5.0-rc.1, 0.5.0-rc.2, etc.)

Dry Mode

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

npm run publish -- --dry

or

npm run publish:dry