Skip to content

Commit

Permalink
S ◾ Improvements to rule readability (#9800)
Browse files Browse the repository at this point in the history 
* Improvements to rule readability

* Auto-fix Markdown files

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
@tiagov8 @github-actions
tiagov8 and github-actions[bot] authored Jan 23, 2025
1 parent 06cd0c4 commit a4d338d
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions rules/website-chatbot/rule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,36 +21,36 @@ guid: 945588b4-8053-41cf-9052-b2f871c4363d

A chatbot is a computer program that uses artificial intelligence to engage in text or voice conversations with users, often to answer questions, provide assistance, or automate tasks. In the age of generative AI, good chatbots have become a necessary part of the user experience.

::: good img-small
![Figure: Good example - A good chatbot in action](chatbot-example.png)
::: good img-medium
![Figure: Good example - A nice chatbot in action](chatbot-example.png)
:::

Choosing the right chatbot service for your website can be a challenging task. With so many options available it's essential to find the one that best fits your needs and provides a good experience for your users. But what distinguishes a good chatbot from a great one? Here are some factors to consider.

<!--endintro-->

### Factors to consider
## Factors to consider

Depending on your intended use, some factors will be more or less important to you.

* **Custom Built vs 3rd Party Service**: Custom built provides more control but incurs high development effort & cost - usually 3rd party solutions are cheaper up front
* **Pre-built/Drag-and-Drop Builders**: Simplifies creation without coding
* **Documentation & Support**: Bad documentation can make a simple product hard to use - incurring more costs
* **Performance**: Smooth and natural responses that answer questions while understanding context
* **Visual Design**: Aligns with brand aesthetics
* **Customization**: Adapts responses to fit brand voice, and is not tricked by misleading questions
* **API Support**: API integration if you might want to use it in other applications
* **Data Syncing**: How often does it refresh it data from your website?
* **Traffic Management**: Handles increasing traffic load
* **Scalability**: Manages increasing user data
* **Knowledge Base** There is usually a limit in 3rd party chatbots e.g. Chatbase provides you 11M characters, which roughly equates to ~3500 pages of text
* **Human Agent Referral**: Transfers smoothly to a human if needed
* **Custom built vs 3rd party service** - Custom built provides more control but incurs high development effort & cost - usually 3rd party solutions are cheaper up front
* **Pre-built/drag-and-drop builders** - Simplifies creation without coding
* **Documentation & support** - Bad documentation can make a simple product hard to use - incurring more costs
* **Performance** - Smooth and natural responses that answer questions while understanding context
* **Visual design** - Aligns with brand aesthetics
* **Customization** - Adapts responses to fit brand voice, and is not tricked by misleading questions
* **API support** - API integration if you might want to use it in other applications
* **Data syncing** - How often does it refresh its data from your website?
* **Traffic management** - Handles increasing traffic load
* **Scalability** - Manages increasing user data
* **Knowledge base** - There is usually a limit in 3rd party chatbots e.g. Chatbase provides you 11M characters, which roughly equates to ~3500 pages of text
* **Human agent referral** - Transfers smoothly to a human if needed

::: img-medium
![Figure: A drag and drop interface on the [Botpress](https://botpress.com) platform](botpress-interface.png)
![Figure: A drag and drop interface on the Botpress platform](botpress-interface.png)
:::

### Comparing platforms
## Comparing platforms

The first decision is to choose between using a 3rd party chatbot service (e.g. ChatBase or Botpress) vs developing your own from scratch using a large language model API (e.g. OpenAI API).

Expand All @@ -64,42 +64,42 @@ The first decision is to choose between using a 3rd party chatbot service (e.g.

Before delving deeper into the comparison it would help to first understand the steps involved in building chatbots using either technology.

### Creating a chatbot using a 3rd party service
## Creating a chatbot using a 3rd party service

After creating your account and starting a new project, you should:

1. Choose the best large language model – e.g. in 2023 you'd choose GPT-4
2. Craft a pointed prompt to give it instructions on how to respond to the user. For e.g. you can ask it to share URLs to your web pages when appropriate
1. Choose the best large language model (in 2023 you'd choose GPT-4)
2. Craft a pointed prompt to give it instructions on how to respond to the user. For example, you can ask it to share URLs to your web pages when appropriate
3. Train the bot by providing links to your web pages or by uploading docs
4. Configure the chatbot for features such as a greeting msg, company logo, chat bubble colours, etc.
4. Configure the chatbot for features such as a greeting msg, company logo, chat bubble colours, etc
5. Embed an iframe or javascript code provided by the service on your website

### Creating a chatbot using an API (e.g. OpenAI API)
## Creating a chatbot using an API (e.g. OpenAI API)

Here is a high level description of creating a chatbot from scratch using the OpenAI API. For a more in-depth explanation, see the video below.

1. Convert your knowledge base into embeddings
2. Store embeddings and their corresponding text content in a vector database
3. Set up a server that can do the following
3. Set up a server that can do the following:
1. Convert user query into an embedding
2. Lookup vector database to find embeddings that are closest to the embedding created out of user query
3. Insert the content corresponding to the matching embeddings into the OpenAI System message
4. Pass recent user chat history to the OpenAI API
5. Wait for OpenAI to generate a response. Present the response to the user.
4. Create a chatbot front-end widget

Going deeper with an in-depth explanation:
Watch an in-depth explanation:

`youtube: https://www.youtube.com/watch?v=9cUciEMUcnA&t=884s`
**Video: Exploring the Capabilities of ChatGPT | Calum Simpson | User Group (132 mins)**
**Video: Exploring the Capabilities of ChatGPT | Calum Simpson | User Group (2 hr 12 min)**

As you can see, developing a chatbot from scratch using the OpenAI API requires significant development effort and expertise. 3rd party chatbots are easier to program and embed on your website. As a rough estimate assume it will take a developer 20 days to build a custom chatbot - or $20K up front (assuming the developer costs $1000/day. Assuming a $399/month subscription of Chatbase on the other hand, it would take the custom solution over 4 years just to break even.

However, custom built chatbots provide a lot more control in how you train the AI model, what content you match the user query with, and what system message you provide the GPT engine to respond to a user’s query. You don’t get this level of control with 3rd party chatbots. The backend of custom built solutions can also be leveraged to serve multiple chatbots supporting completely different use cases. For e.g. one chatbot could provide basic company info to visitor’s on the company website, while a second chatbot could help employees find info on the company Intranet.

Cost to train the chatbot on your knowledge base is very inexpensive in both options. For example, you can train a chatbot on ~3000 pages for less than $1 USD using the OpenAI Embeddings model.

#### Chatbase vs Botpress - 2 popular solutions
### Chatbase vs Botpress - 2 popular solutions

If you go with a 3rd party service, you might be torn between 2 popular platforms: [Botpress](https://botpress.com/) and [Chatbase](https://www.chatbase.co/).

Expand All @@ -108,12 +108,12 @@ If you go with a 3rd party service, you might be torn between 2 popular platform

| | GPT Integration | Customization | Pricing |
| -------- | --------------------------------------------------------- | ----------------------------- | ---------------------------- |
| Botpress | ❌ Traditional style of workflow and steep learning curve | ✅ Wide range of integrations | ✅ Free to start |
| Chatbase | ✅ Does everything with prompt engineering | ✅ Easy customization | ❌ Limited free plan options |
| **Botpress** | ❌ Traditional style of workflow and steep learning curve | ✅ Wide range of integrations | ✅ Free to start |
| **Chatbase** | ✅ Does everything with prompt engineering | ✅ Easy customization | ❌ Limited free plan options |

##### Making the right choice
### Making the right choice

While both platforms offer unique features, Chatbase stands out as the superior choice in most instances. Here's why:
While both platforms offer unique features, **Chatbase** stands out as the superior choice in most instances:

* Easier customization and integration with various tools
* Chatbase's user-friendly interface makes it accessible to a wide range of users. A prompt engineer can setup, tweak and improve the system. No development required
Expand Down

0 comments on commit a4d338d

Please sign in to comment.