From 862c2e12ebeda7e025eede41b7f8f27e22c19d96 Mon Sep 17 00:00:00 2001 From: Mohamed Marrouchi Date: Sat, 5 Oct 2024 06:20:59 +0100 Subject: [PATCH] fix: additional replacements --- README.md | 4 ++-- api/README.md | 6 +++--- api/src/chat/seeds/category.seed-model.ts | 5 +---- docker/.env.example | 2 +- docker/docker-compose.nlu.dev.yml | 2 +- frontend/README.md | 6 +++--- 6 files changed, 11 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c8f8371e..bae9be05 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,9 @@ - **Multi-Channel Support:** Create consistent chatbot experiences across multiple channels like web, mobile, and social media platforms. - **Visual Editor:** Design and manage chatbot flows with an intuitive drag-and-drop interface. Supports text messages, quick replies, carousels, and more. - **Plugin System:** Extend Hexabot's functionality by developing custom plugins. Enable features like text-to-action responses, 3rd party system integrations, and more. -- **NLP/NLU Management:** Manage training datasets for machine learning models that detect user intent and language, providing intelligent responses. +- **NLU (Natural Language Understanding) Management:** Manage training datasets for machine learning models that detect user intent and language, providing intelligent responses. - **Multi-lingual Support:** Define multiple languages, allowing the chatbot to interact with users in their preferred language. -- **CMS Integration:** Seamlessly integrate and manage dynamic content such as product catalogs and store lists for more engaging conversations. +- **Knowledge Base:** Seamlessly integrate and manage dynamic content such as product catalogs and store lists for more engaging conversations. - **User Roles & Permissions:** Granular access control to manage user roles and permissions for different parts of the system. - **Contextual Data:** Define variables to collect and leverage relevant information about end-users to deliver personalized responses. - **Subscribers & Labels:** Organize users by assigning labels and customize their chat experience based on defined segments. diff --git a/api/README.md b/api/README.md index 67c1454d..b9904611 100644 --- a/api/README.md +++ b/api/README.md @@ -1,6 +1,6 @@ # Hexabot API -[Hexabot](https://hexabot.ai/)'s API is a RESTful API built with NestJS, designed to handle requests from both the UI admin panel and various communication channels. The API powers core functionalities such as chatbot management, message flow, NLP (Natural Language Processing), and plugin integrations. +[Hexabot](https://hexabot.ai/)'s API is a RESTful API built with NestJS, designed to handle requests from both the UI admin panel and various communication channels. The API powers core functionalities such as chatbot management, message flow, NLU (Natural Language Understanding), and plugin integrations. ## Key Features - **RESTful Architecture:** Simple, standardized API architecture following REST principles. @@ -16,8 +16,8 @@ The API is divided into several key modules, each responsible for specific funct - **Attachment:** Manages file uploads and downloads, enabling attachment handling across the chatbot. - **Channel:** Manages different communication channels through which the chatbot operates (e.g., web, mobile apps, etc.). - **Chat:** The core module for handling incoming channel requests and managing the chat flow as defined by the visual editor in the UI. -- **CMS:** Content management module for defining content types, managing content, and configuring menus for chatbot interactions. -- **NLP:** Manages NLP entities such as intents, languages, and values used to detect and process user inputs intelligently. +- **Knowledge Base:** Content management module for defining content types, managing content, and configuring menus for chatbot interactions. +- **NLU:** Manages NLU (Natural Language Understanding) entities such as intents, languages, and values used to detect and process user inputs intelligently. - **Plugins:** Manages extensions and plugins that integrate additional features and functionalities into the chatbot. - **User:** Manages user authentication, roles, and permissions, ensuring secure access to different parts of the system. - **Extensions:** A container for all types of extensions (channels, plugins, helpers) that can be added to expand the chatbot's functionality. diff --git a/api/src/chat/seeds/category.seed-model.ts b/api/src/chat/seeds/category.seed-model.ts index 476b421d..ce27f848 100644 --- a/api/src/chat/seeds/category.seed-model.ts +++ b/api/src/chat/seeds/category.seed-model.ts @@ -10,9 +10,6 @@ import { CategoryCreateDto } from '../dto/category.dto'; export const categoryModels: CategoryCreateDto[] = [ { - label: 'category1', - }, - { - label: 'category2', + label: 'Default', }, ]; diff --git a/docker/.env.example b/docker/.env.example index 2a967b37..71a3effb 100644 --- a/docker/.env.example +++ b/docker/.env.example @@ -47,7 +47,7 @@ INTENT_CLASSIFIERS=en,fr TFLC_REPO_ID=Hexastack/tflc INTENT_CLASSIFIER_REPO_ID=Hexastack/intent-classifier SLOT_FILLER_REPO_ID=Hexastack/slot-filler -NLP_PORT=5000 +NLU_ENGINE_PORT=5000 # Frontend (Next.js) APP_FRONTEND_PORT=8080 diff --git a/docker/docker-compose.nlu.dev.yml b/docker/docker-compose.nlu.dev.yml index c5768bff..f4649846 100644 --- a/docker/docker-compose.nlu.dev.yml +++ b/docker/docker-compose.nlu.dev.yml @@ -7,4 +7,4 @@ services: dockerfile: Dockerfile pull_policy: build ports: - - ${NLP_PORT}:5000 + - ${NLU_ENGINE_PORT}:5000 diff --git a/frontend/README.md b/frontend/README.md index 5fda174c..febd4a5f 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,14 +1,14 @@ # Hexabot UI Admin Panel -The [Hexabot](https://hexabot.ai/) UI Admin Panel is a React/Next.js application that serves as the admin interface for managing chatbot configurations, workflows, and interactions. The admin panel allows users to easily create and manage chat flows, monitor analytics, manage content, handle NLP datasets, and configure system settings. +The [Hexabot](https://hexabot.ai/) UI Admin Panel is a React/Next.js application that serves as the admin interface for managing chatbot configurations, workflows, and interactions. The admin panel allows users to easily create and manage chat flows, monitor analytics, manage content, handle NLU (Natural Language Understanding) datasets, and configure system settings. ## Key Features - **Visual Editor:** An intuitive drag-and-drop interface for managing chat flows, including text messages, quick replies, carousels, and more. - **Multi-Channel Management:** Configure and manage multiple communication channels (e.g., web, mobile, social media) from a single interface. - **Analytics Dashboard:** Track user interactions, messages sent, and retention rates through detailed analytics. -- **NLP Management:** Manage datasets for training machine learning models for intent detection and language recognition. -- **Content Management (CMS):** Seamlessly integrate and manage content such as product catalogs, lists of stores, or any dynamic content needed by the chatbot. +- **NLU (Natural Language Understanding) Management:** Manage datasets for training machine learning models for intent detection and language recognition. +- **Knowledge Base:** Seamlessly integrate and manage content such as product catalogs, lists of stores, or any dynamic content needed by the chatbot. - **User, Roles, and Permissions:** Administer user access controls, roles, and permissions to ensure secure and appropriate access to different parts of the system. ## Directory Structure