Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 2.88 KB

File metadata and controls

61 lines (35 loc) · 2.88 KB

OpenDialog's ChatUI SDK

ChatUI is a software development kit (SDK) developed by OpenDialog designed to help developers create custom chat components and enhance Conversational AI applications. It allows for interactive chat interfaces, handles events, and supports functionalities like sending messages and managing user interactions.

The ChatUI SDK can be used in any website or browser-based application and requires a basic understanding of Javascript to set up and, ideally, a little typescript.

If you want to learn more about the ChatUI SDK, check out our docs site. If you are looking for more advanced information regarding creating Conversational AI Agents, check out our OpenDialog platform tutorials.

Choose Your Own Adventure

The Choose Your Own Adventure app is a highly customised implementation of ChatUI that combines conversation design, SDK events and methods, ChatUI settings and external CSS to create an experience that feels unlike most chat interfaces.

Components

Getting started

Recommended IDE Setup

VSCode + Volar (and disable Vetur).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need Volar to make the TypeScript language service aware of .vue types.

Customize configuration

See Vite Configuration Reference.

Project Setup

yarn

Compile and Hot-Reload for Development

yarn dev

Type-Check, Compile and Minify for Production

yarn build

Use ChatUI SDK in combination with:

OpenDialog AI : Create your own custom Conversational AI agent with OpenDialog’s all-in-one Conversational AI Agent Management system. Adapt the Choose Your Own Adventure application to your use case, by adapting the conversation design to suit your needs.

Additional resources