paint-brush
How to Add an AI Chatbot to Your Documentation Site Using Cozeby@ileolami

How to Add an AI Chatbot to Your Documentation Site Using Coze

by IleolamiNovember 7th, 2024
Read on Terminal Reader
Read this story w/o Javascript
tldt arrow

Too Long; Didn't Read

This article provides a step-by-step guide on integrating an AI chatbot into a documentation site using Coze. It covers setting up the chatbot, adding documentation content, publishing the chatbot, and troubleshooting potential issues. The chatbot enhances user interaction by providing instant, relevant responses based on the documentation content.
featured image - How to Add an AI Chatbot to Your Documentation Site Using Coze
Ileolami HackerNoon profile picture


You’ve probably come across documentation sites with built-in AI chatbots, where users can ask questions and get answers directly from the docs. Here’s an example of what that looks like:


With Coze, you can easily set this up. This article will walk you through the steps to add it.

You can achieve this with Coze. Read on to learn how.

Setting up the Chatbot

  1. Go to Coze

  2. Click on Workspace and then click on Create Agent.

    Coze workspace interface.


  3. Enter your chatbot details and click on. Confirm.

    Chatbot details


  4. Choose a character/persona for your chatbot to embody in the  Persona & promptsection. For the best results, use the optimize feature to improve your prompt:

    Optimized prompt for building your AI agent

Add the contents of Your Doc

  1. Under Knowledge, Click on Text


  2. Click on Create Knowledge


  3. Add the details of your knowledge and click on Next


  4. You will be routed to another page, Click on Auto-collect


  5. Choose either Add One (add the doc sections one by one) or Batch Add (use the Base URL to get all the doc details) and click on Import.

Note: Not all URLs can be batch added. If you encounter any errors using batch add, switch to Add One to add each section’s URL.


  1. Allow some time for all the sections in the doc to be imported


  2. After completion, click on Confirm

  1. Let all the URLs load and click on Next

  1. Click on Automatic Segmentation & Cleaning

  1. Let the server process all the URLs into text files and click on Confirm.

  1. Click on Add to agent to add the knowledge to your chatbot.

Publish the Chatbot

You will need to publish the chatbot and get the chatbot web SDK.

  1. Click on Publish.
  2. Scroll down and select Web SDK.

  1. Click on Publish
  2. Click on installation to copy the Web SDK

  1. Copy the code and add it to your documentation code base.
  2. You will see the chatbot icon on your doc like this:

  1. Click on it and start interacting with it

The responses your users receive will be based on the information from the documentation.

Trouble Shooting

If there are any issues with the responses, go back to the knowledge section and check if all the documentation section URLs are added. If not, add the missing URLs using the Add One method.


Conclusion

Integrating an AI chatbot into your documentation site using Coze can significantly enhance user interaction by providing instant, relevant responses based on your documentation content. This tool not only improves user experience but also ensures that users have access to accurate information quickly.