https://github.com/edenai/yodabot

https://github.com/edenai/yodabot

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/edenai/yodabot
• Owner: edenai
• Created: 2023-11-16T11:08:23.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-13T16:06:14.000Z (3 months ago)
• Last Synced: 2025-01-13T17:22:36.993Z (3 months ago)
• Language: SCSS
• Size: 696 KB
• Stars: 14
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - edenai/yodabot - (SCSS)

README

        

**Table of Contents**

- [🌟 Custom Chatbot (RAG)](#-custom-chatbot-rag)

  - [🌐 Chatbot iframe (main branch)](#-chatbot-iframe-main-branch)

  - [💻 Chatbot embed code (embed branch)](#-chatbot-embed-code-embed-branch)

  - [🚀 Usability](#-usability)

    - [1. Create an [`Custom ChatBot RAG`](https://docs.edenai.co/docs/ask-yoda) Project:](#1-create-an-custom-chatbot-rag-project)

    - [2. Copy the Code:](#2-copy-the-code)

    - [3. Replace Parameters:](#3-replace-parameters)

    - [4. Add Optional Parameters:](#4-add-optional-parameters)

    - [5. Example URL:](#5-example-url)

    - [6. Deploy:](#6-deploy)

# 🌟 Custom Chatbot (RAG)

Welcome to the Chatbot repository! This repository contains the source code for integrating and displaying the Eden AI Custom Chatbot on your website. The repository is divided into two branches: **main** and **embed**. The **main** branch holds the `iframe` source code, while the **embed** branch contains the `embed` code for using the chatbot on your website. Let's dive into the details of each branch.

### 🌐 Chatbot iframe (main branch)

![YODA ChatBot](assets/img/yoda_chat_bot.png)

The **main** branch contains the `iframe` source code for displaying the ChatBot in the bottom right corner of your website.

### 💻 Chatbot embed code (embed branch)

The **embed** branch contains the minified JavaScript code that allows you to create and display an `iframe` holding the **Custom Chatbot** on your website for your users.

## 🚀 Usability

To use the `Eden AI Custom Chatbot`, follow these steps:

1. **Create an [`Custom ChatBot RAG`](https://docs.edenai.co/docs/ask-yoda) Project:**

   - Upload your data from a *file*, *text content*, or an *URL*.

2. **Copy the Code:**

   - Copy this code into your HTML body:

   ```html

   

   ```

3. **Replace Parameters:**

   - Replace `{project_id}` with your `project uuid` available in your *Custom ChatBot* project.

   - Optionally, provide the `llm_provider`, `llm_model`, and the parameter `k`.

4. **Add Optional Parameters:**

   - **title:** Define a title to replace the default title.

   - **message:** Define a message to appear first in the chat.

   - **color:** Change the logo’s color. You can enter “red”, “black”, “blue”, etc., or use color codes like “#FF0000”. **Note:** The color parameter must be the last parameter in the URL.

5. **Example URL:**

   ```html

   

   ```

6. **Deploy:**

   - Users accessing your website will now be able to use your trained Chatbot, ask questions, and receive responses based on the data the Chatbot has been trained on.

---

By following these steps, you can seamlessly integrate the Custom Chatbot into your website, enhancing user engagement and providing valuable insights into customer interactions. 🌟