mirror of
https://github.com/hexastack/hexabot
synced 2025-05-05 05:15:02 +00:00
Mohamed Marrouchi
GitHub
commit
9ce1f34200
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -10,9 +10,6 @@ import { CategoryCreateDto } from '../dto/category.dto';
|
||||
|
||||
export const categoryModels: CategoryCreateDto[] = [
|
||||
{
|
||||
label: 'category1',
|
||||
},
|
||||
{
|
||||
label: 'category2',
|
||||
label: 'Default',
|
||||
},
|
||||
];
|
||||
|
||||
@ -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
|
||||
|
||||
@ -7,4 +7,4 @@ services:
|
||||
dockerfile: Dockerfile
|
||||
pull_policy: build
|
||||
ports:
|
||||
- ${NLP_PORT}:5000
|
||||
- ${NLU_ENGINE_PORT}:5000
|
||||
|
||||
@ -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
|
||||
|
||||
@ -61,10 +61,10 @@
|
||||
"file_max_size": "File must have a size less than 25MB",
|
||||
"attachment_failure_size": "Invalid size! File must have a size less than 25MB",
|
||||
"upload_failed": "Unable to upload the file!",
|
||||
"value_is_required": "NLP Value is required",
|
||||
"nlp_entity_name_is_invalid": "NLP Entity name format is invalid! Only `A-z`, `0-9` and `_` are allowed.",
|
||||
"value_is_required": "NLU Value is required",
|
||||
"nlp_entity_name_is_invalid": "NLU Entity name format is invalid! Only `A-z`, `0-9` and `_` are allowed.",
|
||||
"nlp_unable_to_guess": "Unable to predict any meaning from the sentence.",
|
||||
"nlp_success_trained": "NLP Model has been successfully trained!",
|
||||
"nlp_success_trained": "NLU Model has been successfully trained!",
|
||||
"no_user": "There are no subscribers at the moment.",
|
||||
"no_user_assigned": "No one is assigned to you.",
|
||||
"no_user_handledby_chatbot": "No one is handled currently by the chatbot",
|
||||
@ -79,7 +79,7 @@
|
||||
"name_is_required": "Name is required",
|
||||
"context_vars_name_is_invalid": "Context Vars name format is invalid! Only `a-z`, `0-9` and `_` are allowed.",
|
||||
"subtitle_is_required": "Subtitle is required",
|
||||
"category_is_required": "Category is required",
|
||||
"category_is_required": "Flow is required",
|
||||
"attachment_is_required": "Attachment is required",
|
||||
"success_import": "Content has been successfuly imported!",
|
||||
"attachment_not_synced": "- Pending Sync. -",
|
||||
@ -116,14 +116,14 @@
|
||||
"edit_account": "Edit Account",
|
||||
"dashboard": "Dashboard",
|
||||
"visual_editor": "Visual Editor",
|
||||
"nlp": "NLP",
|
||||
"nlp_entities": "NLP Entities",
|
||||
"nlp": "NLU",
|
||||
"nlp_entities": "NLU Entities",
|
||||
"inbox": "Inbox",
|
||||
"categories": "Categories",
|
||||
"categories": "Flows",
|
||||
"context_vars": "Context Vars",
|
||||
"persistent_menu": "Persistent Menu",
|
||||
"manage_content": "Manage Content",
|
||||
"cms": "CMS",
|
||||
"cms": "Knowledge Base",
|
||||
"nodes": "Content",
|
||||
"entities": "Content types",
|
||||
"languages": "Languages",
|
||||
@ -158,16 +158,16 @@
|
||||
"regular_blocks": "Regular Blocks",
|
||||
"advanced_blocks": "Advanced blocks",
|
||||
"custom_blocks": "Custom blocks",
|
||||
"nlp": "NLP Samples",
|
||||
"nlp_train": "NLP training",
|
||||
"nlp_entities": "NLP Entities",
|
||||
"new_nlp_entity": "New NLP Entity",
|
||||
"edit_nlp_entity": "Edit NLP Entity",
|
||||
"nlp_entity_values": "NLP Values",
|
||||
"new_nlp_entity_value": "New NLP Value",
|
||||
"nlp": "NLU Samples",
|
||||
"nlp_train": "NLU training",
|
||||
"nlp_entities": "NLU Entities",
|
||||
"new_nlp_entity": "New NLU Entity",
|
||||
"edit_nlp_entity": "Edit NLU Entity",
|
||||
"nlp_entity_values": "NLU Values",
|
||||
"new_nlp_entity_value": "New NLU Value",
|
||||
"evaluation_report": "Evaluation Report",
|
||||
"edit_nlp_sample": "Edit NLP Sample",
|
||||
"edit_nlp_value": "Edit NLP Value",
|
||||
"edit_nlp_sample": "Edit NLU Sample",
|
||||
"edit_nlp_value": "Edit NLU Value",
|
||||
"context_vars": "Context Vars",
|
||||
"new_context_var": "New Context Variable",
|
||||
"edit_context_var": "Edit Context Variable",
|
||||
@ -175,9 +175,9 @@
|
||||
"add_menu_item": "Add Menu Item",
|
||||
"edit_menu_item": "Edit Menu Item",
|
||||
"content": "Content",
|
||||
"categories": "Categories",
|
||||
"new_category": "New Category",
|
||||
"edit_category": "Edit Category",
|
||||
"categories": "Flows",
|
||||
"new_category": "New Flow",
|
||||
"edit_category": "Edit Flow",
|
||||
"new_content": "New Content",
|
||||
"edit_content": "Edit Content",
|
||||
"entities": "Content Types",
|
||||
@ -223,7 +223,7 @@
|
||||
"dimelo": "Dimelo",
|
||||
"contact": "Contact Infos",
|
||||
"chatbot_settings": "Chatbot",
|
||||
"nlp_settings": "NLP Provider",
|
||||
"nlp_settings": "NLU Provider",
|
||||
"contact_infos": "Contact Infos",
|
||||
"event_log": "Events Log",
|
||||
"log_entry": "Log entry",
|
||||
@ -281,7 +281,7 @@
|
||||
"top_element_style": "Top Element Style",
|
||||
"content": "Content",
|
||||
"content_limit": "Limit",
|
||||
"content_categories": "Categories",
|
||||
"content_categories": "Flows",
|
||||
"load_more": "Enable `View More` Button?",
|
||||
"options": "Options",
|
||||
"seconds": "Seconds",
|
||||
@ -326,7 +326,7 @@
|
||||
"list": "List",
|
||||
"carousel": "Carousel",
|
||||
"custom_code": "Custom Code",
|
||||
"nlp": "NLP",
|
||||
"nlp": "NLU",
|
||||
"nlp_entity": "Entity",
|
||||
"nlp_entity_value": "Value",
|
||||
"value": "Value",
|
||||
@ -369,7 +369,7 @@
|
||||
"description": "Description",
|
||||
"status": "Status",
|
||||
"operations": "Operations",
|
||||
"category": "Category",
|
||||
"category": "Flow",
|
||||
"html_content": "HTML Content",
|
||||
"external_url": "External URL",
|
||||
"entity": "Type",
|
||||
@ -534,7 +534,7 @@
|
||||
"d_attachment_fallback_id": "Attachment Fallback ID",
|
||||
"d_url_fallback": "URL Fallback",
|
||||
"d_supported_domain_id": "Supported Domain ID",
|
||||
"d_agent_category_id": "Category IDs when handed-over",
|
||||
"d_agent_category_id": "Flow IDs when handed-over",
|
||||
"d_admin_user": "On handover, assign to (admin user ID)",
|
||||
"d_test_identities": "Identity IDs used for testing",
|
||||
"d_supported_sources": "Supported Sources",
|
||||
@ -674,7 +674,7 @@
|
||||
"greeting_text": "The greeting property of your bot's Messenger profile allows you to specify the greeting message people will see on the welcome screen of your bot. The welcome screen is displayed for people interacting with your bot for the first time.",
|
||||
"global_fallback": "Global fallback allows you to send custom messages when user entry does not match any of the block messages.",
|
||||
"fallback_message": "If no fallback block is selected, then one of these messages will be sent.",
|
||||
"endpoint": "URL to which HTTP NLP requests are posted and that depends on the type of provider.",
|
||||
"endpoint": "URL to which HTTP NLU requests are posted and that depends on the type of provider.",
|
||||
"token": "Every API request must contain an Authorize HTTP header with a token.",
|
||||
"threshold": "Threshold above which the chatbot will use its prediction (min=0 & max=1)",
|
||||
"app_id": "Mandatory only if you intend to use Facebook Analytics",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"message": {
|
||||
"duplicate_error" : "Entrée en double. Veuillez choisir une valeur unique.",
|
||||
"duplicate_error": "Entrée en double. Veuillez choisir une valeur unique.",
|
||||
"bad_request": "400 MAUVAISE REQUÊTE",
|
||||
"unable_to_process_request": "Impossible de traiter la requête",
|
||||
"not_found": "404 RESSOURCE INTROUVABLE",
|
||||
@ -61,10 +61,10 @@
|
||||
"file_max_size": "Le fichier doit avoir une taille inférieure à 25 Mo",
|
||||
"attachment_failure_size": "Taille invalide! Le fichier doit avoir une taille inférieure à 25 Mo",
|
||||
"upload_failed": "Impossible d'envoyer le fichier au serveur!",
|
||||
"value_is_required": "La valeur TALN est requise",
|
||||
"nlp_entity_name_is_invalid": "Le nom d'entité TALN n'est pas valide! Seuls `A-z`,` 0-9` et `_` sont autorisés.",
|
||||
"value_is_required": "La valeur NLU est requise",
|
||||
"nlp_entity_name_is_invalid": "Le nom d'entité NLU n'est pas valide! Seuls `A-z`,` 0-9` et `_` sont autorisés.",
|
||||
"nlp_unable_to_guess": "Impossible de prédire le sens de la phrase.",
|
||||
"nlp_success_trained": "L'apprentissage du modèle TALN a été éffectué avec succès!",
|
||||
"nlp_success_trained": "L'apprentissage du modèle NLU a été éffectué avec succès!",
|
||||
"no_user": "Il n'y a aucun abonné pour le moment",
|
||||
"no_user_assigned": "Aucun abonné n'est assigné à vous.",
|
||||
"no_user_handledby_chatbot": "Aucun abonné n'est géré actuellement par le chatbot",
|
||||
@ -116,14 +116,14 @@
|
||||
"edit_account": "Modifier le compte",
|
||||
"dashboard": "Tableau de bord",
|
||||
"visual_editor": "Editeur Visuel",
|
||||
"nlp": "TALN",
|
||||
"nlp_entities": "Entités TALN",
|
||||
"nlp": "NLU",
|
||||
"nlp_entities": "Entités NLU",
|
||||
"inbox": "Boîte de réception",
|
||||
"categories": "Catégories",
|
||||
"context_vars": "Variables contextuelles",
|
||||
"persistent_menu": "Menu persistant",
|
||||
"manage_content": "Gérer le contenu",
|
||||
"cms": "CMS",
|
||||
"cms": "Base de connaissances",
|
||||
"nodes": "Contenu",
|
||||
"entities": "Types de contenu",
|
||||
"manage_localization": "Internationalisation",
|
||||
@ -158,16 +158,16 @@
|
||||
"regular_blocks": "Blocs réguliers",
|
||||
"advanced_blocks": "Blocs avancés",
|
||||
"custom_blocks": "Blocs spécifiques",
|
||||
"nlp": "Expressions TALN",
|
||||
"nlp_train": "Apprentissage TALN",
|
||||
"nlp_entities": "Entités TALN",
|
||||
"new_nlp_entity": "Nouvelle entité TALN",
|
||||
"edit_nlp_entity": "Modifier l'entité TALN",
|
||||
"edit_nlp_value": "Modifier la valeur TALN",
|
||||
"nlp_entity_values": "Valeurs TALN",
|
||||
"new_nlp_entity_value": "Nouvelle valeur TALN",
|
||||
"nlp": "Expressions NLU",
|
||||
"nlp_train": "Apprentissage NLU",
|
||||
"nlp_entities": "Entités NLU",
|
||||
"new_nlp_entity": "Nouvelle entité NLU",
|
||||
"edit_nlp_entity": "Modifier l'entité NLU",
|
||||
"edit_nlp_value": "Modifier la valeur NLU",
|
||||
"nlp_entity_values": "Valeurs NLU",
|
||||
"new_nlp_entity_value": "Nouvelle valeur NLU",
|
||||
"evaluation_report": "Rapport d'évaluation",
|
||||
"edit_nlp_sample": "Modifier l'expression TALN",
|
||||
"edit_nlp_sample": "Modifier l'expression NLU",
|
||||
"context_vars": "Variables contextuelles",
|
||||
"new_context_var": "Nouvelle variable contextuelle",
|
||||
"edit_context_var": "Modifier la variable contextuelle",
|
||||
@ -223,7 +223,7 @@
|
||||
"dimelo": "Dimelo",
|
||||
"contact": "Contact",
|
||||
"chatbot_settings": "Paramètres du Chatbot",
|
||||
"nlp_settings": "Paramètres TALN",
|
||||
"nlp_settings": "Paramètres NLU",
|
||||
"contact_infos": "Informations de contact",
|
||||
"event_log": "Journal des événements",
|
||||
"log_entry": "Journal des entrées",
|
||||
@ -326,9 +326,9 @@
|
||||
"list": "Liste",
|
||||
"carousel": "Carrousel",
|
||||
"custom_code": "Code personnalisé",
|
||||
"nlp": "TALN",
|
||||
"nlp_entity": "Entité TALN",
|
||||
"nlp_entity_value": "Valeur TALN",
|
||||
"nlp": "NLU",
|
||||
"nlp_entity": "Entité NLU",
|
||||
"nlp_entity_value": "Valeur NLU",
|
||||
"value": "Valeur",
|
||||
"lookups": "Stratégies",
|
||||
"lookup_strategies": "Stratégie de recherche",
|
||||
@ -674,7 +674,7 @@
|
||||
"greeting_text": "Le texte de bienvenue de votre chatbot vous permet de spécifier le message d'accueil que les utilisateurs verront sur l'écran d'accueil de votre chatbot. L'écran de bienvenue s'affiche pour les personnes qui interagissent avec votre chatbot pour la première fois.",
|
||||
"global_fallback": "Le message de secours global vous permet d'envoyer des messages personnalisés lorsque le message de l'utilisateur ne déclenche aucun bloc de message.",
|
||||
"fallback_message": "Si aucun bloc de secours n'est spécifié, alors de ces messages sera envoyé.",
|
||||
"endpoint": "URL vers laquelle les requêtes de TALN HTTP sont envoyées et qui dépend du fournisseur.",
|
||||
"endpoint": "URL vers laquelle les requêtes de NLU HTTP sont envoyées et qui dépend du fournisseur.",
|
||||
"token": "Chaque requête vers l'API doit contenir un jeton d'authentification.",
|
||||
"threshold": "Seuil en dessus duquel le chatbot va utiliser sa prediction (min=0 & max=1)",
|
||||
"app_id": "Obligatoire seulement si vous comptez utiliser Facebook Analytics",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user