0 Credits
Preview

HybridAI User Documentation

1. Introduction

HybridAI is an advanced AI chatbot system that integrates multiple AI models, emotional sensing, and function calls to create a seamless user experience. It supports direct chatbot interactions, website automation, and integration with various platforms like WhatsApp, Slack, and Telegram.

2. System Overview

3. Setting Up HybridAI

3.1 Embedding the Chatbot

To integrate HybridAI into your website, use the embed script:

<script>
    window.chatbotConfig = {
        chatbotId: "YOUR_CHATBOT_ID", // Your unique chatbot ID
        chatbotServer: "https://hybridai.one" // Backend server domain
    };
</script>
<script src="https://hybridai.one/hai_embed.js"></script>

This script loads the chat widget and connects it to the HybridAI server. You can find the exact script and parameters on the integration page in your admin panel.

3.2 Configuring the Chatbot

Go to Admin Panel > General Settings to:

We have support for self-hosted and specialized models like Teuken, Occiglot or Dolphin available on request.

4. AI Settings

HybridAI offers two types of AI configurations:

4.1 AI Model Selection

Users can choose from various AI models based on their needs. The settings panel provides options to:

5. Knowledge Base Enhancement

HybridAI allows you to enhance your chatbot's knowledge base through document uploads and web crawling, making your bot more informed about specific topics relevant to your business or use case.

5.1 Document Upload

In the Admin Panel > AI Settings > Chat & Knowledge section, you can upload various document types:

Uploaded documents are processed and converted into a format that allows the AI to reference and use this knowledge when answering user questions. The system automatically extracts the content, preserving the structure and relationships between different parts of the document.

5.2 Web Crawling

HybridAI provides a powerful web crawling feature that allows your chatbot to learn from website content:

  1. Navigate to Admin Panel > AI Settings > Chat & Knowledge
  2. Find the Web Crawling section
  3. Enter the base URL you want the bot to learn from (e.g., "https://yourdomain.com/knowledge/")
  4. Set the maximum number of pages to crawl (recommended: start with 10-20 pages)
  5. Click "Start Crawling" to begin the process

The system will automatically explore the website, following links from the provided URL, and extract content that will be incorporated into your chatbot's knowledge base. The crawling progress is displayed in real-time, showing which pages are being processed.

Note: For best results, point the crawler to specific sections of your website that contain the most relevant information. Avoid crawling very large websites all at once by starting with the most important sections.

5.3 Managing Knowledge

After uploading documents or crawling websites, you can manage your knowledge base:

The AI will automatically incorporate this knowledge into conversations when relevant questions are asked.

6. Image Integration

HybridAI supports image integration, allowing your chatbot to display relevant images during conversations to enhance user engagement and information delivery.

6.1 Uploading Images

To add images to your chatbot's library:

  1. Go to Admin Panel > AI Settings > Chat & Knowledge
  2. Scroll to the Upload Image section
  3. Select an image file (supported formats: PNG, JPG, JPEG, GIF, SVG, WEBP)
  4. Add a descriptive caption that explains what the image shows
  5. Click "Upload Image" to add it to your bot's library

6.2 How Image Integration Works

Images are automatically integrated into your chatbot's instruction system. The bot understands:

When a user asks a question or discusses a topic related to one of your uploaded images, the chatbot can choose to display the image alongside its text response to enhance understanding.

6.3 Managing Images

You can manage your image library through the same interface:

7. Website Commands

Website Commands allow the chatbot to interact with elements on the webpage dynamically. These can highlight sections, fill forms, navigate, or modify page content.

7.1 How Website Commands Work

When a chatbot detects a relevant action, it triggers a JavaScript event that modifies the webpage.

To get it to work you have to add this to the instruction of the bot, e.g. If you are asked for "Scope 1" insert the command [CMD:highlight=Scope1] into your answer.

Website-Commands are an integral part of the Website-Bot (the one that sits on the bottom right of the Website), you just have to activate them by making them part of the Agent-instruction (see example below).

Website Commands do target HTML elements via their id property. Please use lowercase properties. Please avoid whitespace in the id property and use underscore instead of spaces.
If a command fails to execute you can check the browser-console to see which element the system tried to adress.

7.2 Available Commands

CommandDescription
highlightElement(selector)Highlights a webpage element.
fillInput(selector, value)Fills an input field with a predefined value.
navigateTo(url)Redirects the user to a different webpage.

7.3 Example of a Chat-Bot Instruction including Website-Commands:

            

Be a friendly assistant that helps with the collection of Scope 1-3 data and CO2 footprint determination. With the commands below, you can also trigger actions on the website for specific questions. Always inform the user about what you have triggered and ask if it is okay.

Website Commands: Highlighting If the user asks you to highlight a heading, insert the string [CMD:highlight=<value>] and replace <value> with the requested heading. Insert Values If a value needs to be added, append the string [CMD:set-value=<field>;<value>] at the end of the message, replacing <field> with the field name and <value> with the specified value. Open Another Page If the user asks about data protection, insert the following string: [CMD:set-url=https://hybridai.one/privacy-policy]. If the user asks about AI settings, insert this string: [CMD:set-url=http://127.0.0.1:5000/admin_ai].

8. Human Takeover

HybridAI includes a Human Takeover feature that allows seamless intervention by a human agent when required.

8.1 Triggering a Takeover

8.2 Admin Panel for Takeover

In Admin Panel > Chat Console, administrators can:

8.3 Sensing & Triggers

In Sensing & Triggers you can adjust the threshold from which a sensing-dimension starts to activate the notification.

It is also possible to configure two custom dimensions that describe relevant events for your use-case.

9. AI Functions & API Integration

9.1 Function Calling

HybridAI supports function calling to extend chatbot capabilities. You can enable predefined functions like:

You can try the currently integrated functions that can be found on the function-calling page. Reach out to us if you want to implement your own functions. For security reasons this will be made available in self-service mode a bit later.

9.2 OpenAI-Compatible API

HybridAI now offers an OpenAI-compatible API that allows you to integrate your custom chatbots with your applications. Key features include:

Using the API

To use the API, first generate an API key in the Admin Panel > API Keys section. Then use the API with standard libraries:

import openai

# Configure with your API key and HybridAI base URL
openai.api_key = "YOUR_API_KEY"
openai.base_url = "https://hybridai.one/"

# Make a chat completion request
response = openai.chat.completions.create(
    model="gpt-3.5-turbo",  # You can use available models
    messages=[
        {"role": "user", "content": "Hello, world!"}
    ],
    chatbot_id="YOUR_BOT_ID"  # Specify which of your bots to use
)

print(response.choices[0].message.content)

10. Widget Customization

HybridAI offers several ways to customize the chat widget for optimal integration with your website.

10.1 Basic Widget Configuration

You can customize several aspects of the widget by modifying the chatbotConfig object:

<script>
    window.chatbotConfig = {
        chatbotId: "YOUR_CHATBOT_ID",
        chatbotServer: "https://hybridai.one",
        initialGreeting: "Welcome! How can I help you today?",
        widgetColor: "#3498db",
        position: "right",  // Options: "right", "left", "center"
        widgetSize: "standard"  // Options: "standard", "compact"
    };
</script>
<script src="https://hybridai.one/hai_embed.js"></script>

10.2 Demo Page

To explore different widget configurations and test appearance options, visit our Widget Demo Page. This interactive demo allows you to:

11. Integrations

HybridAI offers a variety of integration options to connect your chatbot with other platforms and systems.

11.1 Platform Integrations

HybridAI seamlessly integrates with popular messaging and social platforms:

You can try our WhatsApp integration on the homepage. Contact us if you want to use these integrations for your bot.

11.2 WordPress Plugin

Our official WordPress plugin makes it easy to add your HybridAI chatbot to any WordPress website:

Download our free WordPress plugin directly from WordPress.org or search for "HybridAI Chatbot" in your WordPress admin panel.

11.3 Automation Platforms

HybridAI integrates with popular automation and workflow platforms:

These integrations allow you to trigger actions in other systems based on chatbot interactions or feed external data into your chatbot.

12. Analytics & Logs

HybridAI provides real-time analytics and logs for chatbot interactions. Just visit the "analytics" page to access:

13. Multi-Bot Management

HybridAI allows you to create and manage multiple chatbots under one account, each with its own configuration:

14. Contact & Support

For support, contact service@hybridai.one or visit the HybridAI website.